Manage Runs

A run is a way to combine and organize a group of tasks into a process flow in order to perform a function. Runs contain tasks for the system to perform and can be run manually or automatically.

Manual runs are launched through the dialog boxes in the Manage Runs data table Automated runs are scheduled as a background process on the application server.

On this page:

Run Fields

The top section of the Manage Runs page allows you to find existing runs matching criteria in the fields.

Run ID: Run system-assigned, unique identifier.
Run Type Code: Search by the run type. Valid values are STD (standard) and DYNAMIC, but the system currently disregards this setting and all runs are processed as STD.
Run Name: The run "friendly" name.
Run Lookup: A variation on the run name, which does not include spaces and is uppercase. (This field is case sensitive.)
Status: Search by the run status (Active, Inactive).

Data Table

The data table contains the following fields:

ID: The run system-generated, unique identifier.
Run Type Code: The type code that was assigned to the run when it was added.
Run Name: The run name as designated when the run was added.
Run Lookup: A variation on the run name, which does not include spaces and is uppercase.
Run Graph: Provides a link to open a graphical view of the run, which is a flowchart that shows the tasks that make up the run in the order they are processed.
Status: Run status (Active/Inactive).
Create Time: Date and time when the run was created.
Update Time: Date and time when the run was updated.
View : Opens the View Runs dialog box, which displays the same data as provided in the data table row. In addition, it includes whether the run is locked or not. This dialog box also provides links that allow you to edit or process the run.
Edit: Opens the Manage Runs dialog box, which provides the same fields as the View Runs dialog box. In addition, it allows you to edit the Locked Flag and Status.
XML: Displays the Run Definition dialog box, which shows the configuration XML for the run.
Run Log: Navigates to the Manage Run Logs page and displays the current context to provide further information.
XML Editor: Displays the Run XML Editor.

Adding Runs

Runs are added from the Manage Runs page.

To add a run:

Click Add Run on the Manage Runs page. The Create Runs dialog box opens.
In the Create Runs dialog box, do the following:

From the Run Type Code drop-down list, select STD.
Click Save. The Create Runs dialog box will close and the new run will be added to the Manage Runs data table.
In the Name field, enter a descriptive name.
In the Run Lookup field, enter a value for run lookup, which can be any unique, alphanumeric value without spaces. A common practice is to use the run name with all capital letters and without spaces.
(Optional) In the Run Description field, enter a short description of the run’s function.

Click the Status drop-down list and select Active or Inactive.

Viewing Run Information

The View link in the Manage Runs data table row launches the View Runs dialog box. This dialog box displays run information and allows you to view the run definition XML, edit the run information, and process the run.

Fields

Run information fields include the following:

Run ID: Run system-generated, unique identifier.
Run Type Code: Type code that was assigned to the run when it was added.
Run Name: Secondary run name, or nickname, that was given to the run when it was added.
Run Lookup: Variation of the run name, which does not include spaces and is uppercase.
Run Desc: Short explanation of the run’s purpose or function.
Locked Flag: Indicates whether changes to the run are allowed to be made (Unlocked) or not (Locked).
Status: Defines whether the run can be processed (Active) or not (Inactive).
Create Time: Date and time that the run was added.
Update Time: Date and time of the most recent change.

Buttons and Links

XML link: Opens the Run Definition dialog box.
Execute Now: Opens the Execute Runs Details dialog box.
Edit: Opens the Manage Runs dialog box.
Cancel: Closes the dialog box.

Managing Run Information

The Manage Runs dialog box opens when you click the Edit link on the run data table row or the Edit button on the View Runs dialog box.

Fields

Run ID: Run system-generated, unique identifier.
Run Type Code: Type code that was assigned to the run when it was added.
Run Name: Run name as designated when the run was added.
Run Lookup: Secondary run name given to the run when it was added.
Run Desc: A short explanation of the run’s purpose or function.
Locked Flag: Define whether changes to the run are allowed (Unlocked) or not allowed (Locked).
Status: Define whether the run can be processed (Active) or not (Inactive). Inactivating a run is a way to prevent it from processing without removing the run from the system.
Create Time: Date and time that the run was added.
Update Time: Date and time of the most recent change.

Buttons and Links

XML link: Opens the Run Definition dialog box.
Execute Now link: Processes the run.
Save: Save any changes that have been made; the button is disabled until a field is modified.
Cancel: Closes the dialog box.

Editing Run XML

The XML that defines a run may be edited as text or by using the Run XML Editor. Both options allow you to create, view, and edit a run. The text option gives you the additional feature to copy an existing run definition into a new run. The following sections describe how to work with the Run Definition XML as text or with the Run XML Editor.

Viewing and Editing the Run Definition XML

XML is typically created and edited with the Run XML Editor, but the Run Definition dialog box allows you to quickly modify XML parameters or define a run using XML from a similar run. From the Run Definition dialog box, you can view or edit the raw XML code that specifies the run parameters. Duplicating the Run Definition XML

Editing Runs with the Run XML Editor

The Runs XML Editor provides a user interface to define and organize procedures to be run. The procedures, called nodes, are connected with edges that define the flow for the run.

Buttons

The Runs XML Editor has the following buttons:

Save: Save the run in its current state. If the run is structurally invalid, it will show a warning indicating that the run was saved, but it will fail processing. The Runs XML Editor will close when you click Save.
Validate: Validate the run to make sure it is syntactically valid and shows validation errors, if any exist.
Preview: View an image of the run graph based on the nodes and connectivity defined in the edges.
Close: Close the Runs XML Editor without saving changes.

Graph Components

The Runs XML Editor uses graph terminology to describe the structure of the run. The run configuration is defined by Graph Type, which contains the Graph Header, Time Windows, Nodes, and Edges. Complete the tasks outlined in the following sections to define the run.

Creating the Graph Header

To create a graph header:

Select Graph Header in the Runs XML Editor tree-view.
Complete the following fields:
- Expected Duration Mins: The anticipated time, in minutes, that the run should take.
- Graph Name: The graph name is a user-friendly name for the Run Graph.
- Graph Desc (Optional): The graph description allows you to add information describing the run.
- Graph Processing Basis: The graph processing basis comes into play when a task is run repeatedly for an extended period of time. For example, if a run with a processing basis of daily is ran over a week or a month, it will be run once for every day of the week or month, respectively.

Creating Time Windows

Time windows are created using the Runs XML Editor. Time windows can be either static or offset. Static time windows have defined start and end date. Offset time windows are offset from the start and end dates and are inputted when the filter is processed.

The Offset Time Windows allow you to create a time window that is offset from the start and/or end dates, which are input when the run is processed. An Offset Time Window settings include the Start Offset, End Offset, and Time Basis. Offset time can be set with either a Start Offset or End Offset.

Start Offset: The start date may be offset using one of two methods: simple offset or directional snapping. Simple offset offsets the start date by a selected time basis (day or month) and how many (Value of) of those units. Snapping sets whether the start offset will expand backward in time or forward (snap direction).
End Offset: The End Offset is similar to the Start Offset with the exception that the resulting date must be later than the Start Offset date.
Time Basis: The Time Basis field allows you to interpret your data over a different time frame (for example, daily data over a month).

To create time windows:

Select Time Windows in the Runs XML Editor tree-view, then click Create New Time Windows.
Select the newly created time window in the tree view.
Note: You may edit the name to something meaningful.
Click the Type drop-down and do one of the following:

Select the Static Time window and edit the parameters:

Name: Populates with the name from the tree view.
Description: (Optional)Enter a description for the time window.
Start Date: Start date for the filter criteria.
End Date: End date for the filter criteria.

Select the Offset Time window.

Creating Nodes

Nodes perform a task. The tasks may be an analytic operation, such as aggregating data, or it may be checking a condition to see if it is true or not true. There are several types of nodes:

Start Node: A "dummy" node that denotes the starting point of a run.
Decision Node: Allows the run operation to be branched by evaluating a condition. The condition is created in the Expression field by adding custom code that will dictate branching of the run logic. A decision node should always return a Boolean value (True/False). Based on the output of the decision node, children node will either be skipped or processed.
Union Node: Allows the run to continue even if there is a failure condition in a previous node. Because the union joins the result set of two nodes, the failing node would not contribute to the outcome.

To create a node:

Select Nodes in the Runs XML Editor tree-view.
Click Create New Nodes.
Select the new node in the tree view.
Select one of the node type from the drop-down list:
- Name: The name given to the node.
- Desc: Description of the node.
Note: The Union node appears as an orange oval in the run graph.
- Start Node. The start node contains the following fields:
  - Name: The name given to the node.
  - Desc (optional): Description of the node.
  Note: The Start Node appears as a blue oval in the run graph.
- Decision Node: The Decision node fields include:
  - Name: Name given to the node.
  - Desc: Description of the node.
  - Expression: Contains free form code that determines whether the decision criteria have been met.
  Note: The decision node appears as a red rhombus in the run graph.

Creating Edges

Edges, like the arrows in a flowchart, connect two nodes together to create a sequence for node processing.

To create edges:

Select Edges in the Runs XML Editor tree-view.
Click Create New Edges and select the new edge in the tree view.
Click the Type drop-down and select the edge type:

Edge: Connects two non-decision nodes.
Decision Edge: Connects a decision node to another node. If Yes is selected, the edge will be traversed when the decision is true; if Yes is not selected, the edge will be traversed when the decision is false.

Select the starting node and the ending node from the Source Name and Target Name fields, respectively.

Duplicating the Run Definition XML

You can duplicate an existing run and customize it to your needs.

To copy a run:

Search for and select the run that you wish to use as the starting point in the Manage Runs page.
Click the XML link to open the Run Definition dialog box, then copy the Definition XML and close the dialog box.
On the Manage Runs page, click Add Run.
Do the following in to complete the Create Runs dialog box:
1. Click the Run Type Code drop-down list and select STD.
2. Enter a descriptive name in the Name field.
3. Enter a value for run lookup in the Run Lookup field.
  Note: This value can be any unique, alphanumeric value without spaces. A common practice is to use the run name with all capital letters and without spaces
4. (Optional) Enter a short description of the run’s function In the Run Description field.
5. Click the Status drop-down and select either Active or Inactive.
6. Paste the definition XML from the copied run in the Run Definition pane.
Click Save. The Create Runs dialog box will close and the new run will be added to the Manage Runs data table.

Processing Runs

Runs can be processed manually or on schedule. The Execute Runs Details dialog box can be accessed from the Execute Now link found in the Manage Runs' View Runs or Edit Runs dialog boxes.

To process a run:

From the Manage Runs page, click either the View or Edit link to display the corresponding dialog box, then click the Execute Now link.
In the Execute Runs Details dialog box, do the following:
1. Verify the Name field (display only). This is the name assigned to the run when it was added.
2. Enter the starting date for the run in the Start Date field
3. Enter the date when the run should end in the End Date field. This will be the same as the start date for single instances of a manual run.
4. Click the Priority drop-down and select the run’s priority on the node. Base values include Highest, Default, Lowest.
(Optional) In the Failure Email field, enter an email address to send a message to if the run ends unexpectedly.
Verify the lookup field (display only). This is the run’s lookup name as designated when the run was added.
Select the MANUAL processing method in the Type drop-down.
Select the Standard mode form the Run Mode drop-down
(Optional) Enter an email address to send a message to if the task completes successfully in the Success Email field.
Click OK.