Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 5 Current »

Overview

The Temporary trigger allows you to set up a one-time trigger for a task, based on a single date and time. You will use this trigger if you want to set up a task to run once at some time in the future.

Creating a Temporary Trigger

Step 1

From the Automation Center navigation pane, select Triggers > Temporary Triggers. The Temporary Triggers list displays.
 
To the right of the list, Temporary Trigger Details for a new Temporary trigger displays.
 

Step 2

Enter/select Details for a new Temporary trigger, using the field descriptions below as a guide.

  • Required fields display an asterisk ( * ) after the field name.
  • Default values for fields, if available, display automatically.

To display more of the Details fields on the screen, you can either:

  • Use the scroll bar.
  • Temporarily hide the list above the Details.
  • Click the  button above the list to display a pop-up version of the Details.

Step 3

Click a button. The trigger is added to the database, and all buttons and tabs in the Trigger Details are enabled.

Step 4

Enable the trigger(s) as desired.

Note

To open an existing record on the list, either:

  • Click a record in the list to display its record Details below the list. (To clear record Details below the list, click the New button that displays above and below the Details.)
  • Clicking the Details icon next to a record name in the list, or right-click a record in the list and then click Open in the Action menu that displays, to display a pop-up version of the record Details.
  • Right-click a record in the a list, or open a record and right-click in the record Details, and then click Open In Tab in the Action menu that displays, to display the record Details under a new tab on the record list page (see Record Details as Tabs).

Temporary Trigger Details

The following Temporary Trigger Details is for an existing Temporary trigger. See the field descriptions, below, for a description of the fields that display in the Temporary Trigger Details.



 

Temporary Trigger Details Field Descriptions

The following table describes the fields, buttons, and tabs that display in the Temporary Trigger Details.
 

Field Name

Description

General

This section contains general information about the trigger.

Name


Name used within the Controller to identify this trigger. It can contain a maximum of 255 alphanumerics. It is the responsibility of the user to develop a workable naming scheme for triggers.

Version

System-supplied; version number of the current record, which is incremented by the system every time a user updates a record. Click the Versions tab to view previous versions. For details, see Record Versioning.

Description

Description of this record. Maximum length is 255 characters.

Member of Business Services

User-defined; Allows you to select one or more Business Services that this record belongs to.  (You also can Check All or Uncheck All Business Services for this record.)

You can select up to 62 Business Services for any record type, and enter a maximum of 2048 characters for each Business Service.

If the Business Service Visibility Restricted Universal Controller system property is set to true, depending on your assigned (or inherited) Permissions or Roles, Business Services available for selection may be restricted.

Calendar


Calendar that defines the business days, holidays, and other special days that determine the run dates for the task(s) specified in the trigger.

Select a Calendar from the drop-down list of all existing Calendars. To display detailed information about a selected calendar, click the Details icon next to the Calendar field.


Time Zone

User-defined; allows you to specify the time zone that will be applied to the time(s) specified in the trigger. For example, if you specify 23:00 and a time zone of Canada/Central, the task will run at 11:00 p.m. Central Canada time.

Task(s)

Name of the task(s) being triggered when this trigger is satisfied. When selecting tasks from the Details, click on the lock icon to unlock the field and select tasks.

Simulate

Specifies if the instances generated by this trigger should execute under simulation mode, in which none of the tasks execute. Alternatively, simulation mode can be enabled from the Trigger Now… command (see Triggering with Variables and Triggering by Date and Time).

Purge By Retention Duration


Specification for whether triggered task instances can be purged by retention duration.

Exclude Backup

If Purge By Retention Duration is selected; Specification for whether qualifying task instances can be excluded from the backup when being purged by retention duration.

Retention Duration

If Purge By Retention Duration is selected; Minimum retention duration for the selected Retention Duration Unit before triggered task instances can qualify for purge.

If Retention Duration Unit = Days, valid values are 1 to 366.

If Retention Duration Unit = Hours, valid values are 1 to 24.

Retention Duration Unit

If Purge By Retention Duration is selected; Retention duration unit.
 
Options:

  • Hours
  • Days

Execution User


Read-only; Execution user that has been selected (via the Assign Execution User action) to override the execution user of task instances being launched by the trigger.

Forecast


If checked, the Controller calculates the date and time when this trigger will be satisfied for the next number of days, as specified in the Forecast Period In Days Universal Controller system property.

The Controller writes the forecasting entries to the Forecasts List.
 

Note

If this field is checked on a trigger and the trigger is promoted, it will not be checked for that trigger on the target system.


Simulate Forecast

Enables the override of the System Default Trigger Simulate Forecast Universal Controller system property specification for whether or not to simulate forecasting of a trigger.
By enabling trigger forecast simulation, it allows you to enable a trigger to generate forecast records without the trigger launching the specified task(s) at the next scheduled time.
 
Options:
  • -- System Default --
    • Use the system default for enabling / disabling trigger forecast simulation as specified by System Default Trigger Simulate Forecast.
  • True
    • Enable trigger forecast simulation.
  • False
    • Disable trigger forecast simulation.
At the next scheduled time the controller will only log a message similar to the following.
Trigger simulation: Trigger [Time] "trigger-name" with id trigger-uuidlaunching task "task-name" with id task-uuid using trigger variables {...}. Next scheduled trigger time "Sat Apr 01 11:02:00 EDT 2023".

Status

This section contains information about the current status of the trigger.

Status

System-defined; Specification for whether the trigger is Enabled or Disabled. The user enables and disables the trigger by clicking the Enable / Disable buttons. Only enabled triggers are processed by the Controller.

Next Scheduled Time

System-supplied; for time-based triggers. If Status = Enabled, the next date and time this trigger will be satisfied. See Displaying Trigger Forecast Information.

Enabled By

System-supplied. If Status = Enabled, ID of the user who most recently enabled this trigger.

Disabled By

System-supplied; If Status = Disabled, ID of the user who most recently disabled this trigger. (By default, all new triggers are disabled.)

Enabled Time

System-supplied. If Status = Enabled, Date and time that the trigger was enabled.

Disabled Time

System-supplied. If Status = Disabled, Date and time that the trigger was disabled.

Skip DetailsThis section contains detailed information about skipping the trigger.

Task Launch Skip Condition

User-defined; Controls when launching a task for the trigger will be skipped.

Default is the value of the Trigger Task Launch Skip Condition Default Universal Controller system property.

Options:

  • -- None --
    Do not skip the task launch.
  • Active
    Skip the task launch if a previous instance is still active.
  • Active By Trigger
    Skip the task launch if a previous instance launched by the trigger is still active.

Task Launch Skip Condition is not applicable when using the Trigger Now... command and will be ignored.

Temporary Details

This section contains assorted detailed information about the trigger.

Date

Date you want the trigger to be satisfied.

Time (hh.mm)

Required. Specifies the time of the trigger in hours and minutes. For example, 01:45 means trigger the task at 1:45 a.m.; 13:45 means trigger the task at 1:45 p.m.

Keep Trigger

If checked, indication that the Temporary Trigger should be Disabled, rather than Deleted, after the Next Scheduled Time.
Self-Service Options This section contains Self-Service specifications for the trigger.
Enforce Variables

Specifies whether or not to enforce Override Trigger Variables when using Trigger Now... from the User Interface.

Lock Variables

Specifies whether or not to prevent editing variables when using Trigger Now... from the User Interface.

Metadata

This section contains Metadata information about this record.

UUID

Universally Unique Identifier of this record.

Updated By

Name of the user that last updated this record.

Updated

Date and time that this record was last updated.

Created By

Name of the user that created this record.

Created

Date and time that this record was created.

Buttons

This section identifies the buttons displayed above and below the Trigger Details that let you perform various actions.

Save

Saves a new task record in the Controller database.

Save & New

Saves a new record in the Controller database and redisplays empty Details so that you can create another new record.

Save & View

Saves a new record in the Controller database and continues to display that record.

New

Displays empty (except for default values) Details for creating a new record.

Update

Saves updates to the record.

Enable

Activates this trigger and writes your User ID to the Enabled By field.

Disable

Deactivates this trigger.

Trigger Now...

Opens a Trigger Now... dialog to immediately trigger all tasks specified in this trigger.


Optionally, you also can select to:

  • Launch the task(s) specified in the trigger under simulation mode; you can only enable simulation mode from the Trigger Now... command, you cannot disable it when it is already enabled in the Trigger Details.
  • Launch the task(s) specified in the trigger with one or more variables.
  • Launch the task(s) specified in the trigger by a specified date and time.
  • Launch the task(s) specified in the trigger but place them in Held status; they will not run until they are released.
  • For Triggers that launch a single Workflow, specify if Workflow should run with only specific path(s) and/or specific vertices included. See Launching/Triggering a Workflow to Run on Specific Paths/Vertices.


Note

If you click Trigger Now... for an Enabled trigger that does not have an assigned Execution User, the trigger will launch its task(s) under the context of the Enabled By user.
 
If you click Trigger Now... for a Disabled trigger that does not have an assigned Execution User, the trigger will launch its task(s) under the context of your user name and ID.
 
If you click Trigger Now... for an Enabled or Disabled trigger that has an assigned Execution User, the trigger will launch its task(s) under the context of the assigned Execution User.

Copy

Creates a copy of this trigger, which you are prompted to rename.

Delete

Deletes the current record.

Refresh

Refreshes any dynamic data displayed in the Details.

Close

For pop-up view only; closes the pop-up view of this trigger.

Tabs

This section identifies the tabs across the top of the Trigger Details that provide access to additional information about the trigger.

Variables


Lists all user-defined variables associated with this record; that is, variables that have been defined for this specific record.

Instances

Lists all task instances that were triggered directly by this trigger.

Notes


Lists all notes associated with this record.

Versions


Stores copies of all previous versions of the current record. See Record Versioning.

  • No labels