dspTrack

Register Work List Event Rules

Work List Event rules can be registered at the Work List, Plan, Plan Task and tag level, and can be set to run when work on a task starts or completes.

The event rule is triggered when a user clicks the Next Action button on the Work List to indicate that work on the task has started or finished.

Before registering the rule, it must be written and stored in a data source that is registered in Common. Refer to Register a Data Source in Common for more information. The rule can only use parameters that can be passed in from the Work List. Refer to Parameters for Work List Event Rules  for more information.

This topic contains the following sections:

• View and Edit All Event Rules
• Parameters for Work List Event Rules

View and Edit All Event Rules

dspTrack™ displays all of the Event Rules for all Work List Items, plans, Plan Tasks, and tags on the Event Rules All page.

To access this page, select Configuration > Event Rules.

To edit a Work List Event Rule on this page:

1. Select Configuration > Event > Rules - All  from the Navigation pane.

2. Click Edit.

   View the field descriptions for the Event Rules All page

3. Enter a value in the PRIORITY field.

   NOTE: The rule runs in this order if multiple rules are assigned to the plan, Plan Task, Work List Item or tag.

4. Select the data source that contains the rule from the DATA SOURCE ID list box.

   NOTE: These options are data sources registered in the Stewardship Tier.

5. Select the rule in the RULE list box.

6. Select the event that triggers the rule to run in the WORK LIST EVENT ID list box.

   NOTE: Values are:

   • Finish – The rule runs when a user completes the Work List Item of Plan Task. To complete the Work List Item or Plan Task, on the Work List, click Next Action when the item’s status is In Progress.
   • Start – The rule runs when a user starts work on the Work List Item or Plan Task. To start work, on the Work List, click Next Action when the item’s status is Ready.

7. Click the ACTIVE check box to disable it, if necessary.

   NOTE: If a rule is inactive, the rule does not run.

8. Enter a comment about the rule in COMMENT field.
9. Click Save.

The rule will run for the Work List Item or Plan Task depending on the option selected in the WORK LIST EVENT ID list box.

Parameters for Work List Event Rules

The Work List Event Rule Execution engine supports the following parameters for use in the rules:

Parameter	Description
WorkListItemID	The primary key in ttWorkList table.
ItemReferenceID	The primary key in ttProjectTask table.
Name	Task name entered on the Work List Setup or the PlanTask page.
Item Description	Description entered on the Work List Setup or the PlanTask page.
PlannedStartDate	Task's planned start date entered on the Vertical View of the Work List Setup or the PlanTask page.
PlannedFinishDate	Task's planned finish date entered on the Vertical View of the Work List Setup or the PlanTask page.
WebAppID	ID for the task's WebApp (dspTrack™).
ItemStatus	Numeric representation of task status from ztTaskStatus table.
boaUserID	User ID who performed the action.
Comment	Comment entered on the Vertical View of the Work List or the PlanTask page.