dspTrack

Register Work List Event Validations

Work List Event Validations can also be set at the Plan Task level, Work List Item level, the tag level, and  the plan level, and can be set to run when work on a Plan Task or Work List Item starts or completes.

Validations are stored procedures or views that have been written and saved in a data source that is registered in the DSP®. A validation executes when an event occurs and confirms that a process is valid. If the validation fails, processing stops. For example, a validation is registered to a Receive Email event. The validation confirms that an email received at a designated address has an attachment in a specified format. If the attachment is in a valid format, the validation passes and processing can continue. However, if the attachment is in an invalid format, the validation fails, and processing stops.

If a validation fails:

• dspTrack™ displays an error message.

  NOTE: That message was entered in the Validation Message field when the validation was added.

• The event the validation was registered to does not run.

The validation is triggered when a user clicks the Next Action button on the Work List to indicate that work on the Plan Task or Work List Item has started or finished.

NOTE: Before registering the validation, 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 validation can only use parameters that can be passed in from the Work List. Refer to Parameters for Work List Event Validation for more information.

This topic contains the following sections:

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

View and Edit All Event Validations

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

To access this page, select Configuration > Event Validations.

To edit an Event Validation on this page:

1. Select Configuration > Events > ValidationsAll from the Navigation pane.

2. Click Edit; Vertical View displays.

   View the field descriptions for the Event Validations All page

3. Enter a value in PRIORITY field.

   NOTE: This value determines the order the validation runs.

4. Select the data source that stores the view or stored procedure in the Data Source ID list box.

   NOTE: This data source must be registered in Common. Refer to Register a Data Source in Common for more information.

5. Select the name of the stored procedure or view from the Procedure/View list box.

   NOTE: The name that displays for this field depends on the selection made in the VALIDATION TYPE list box on the Horizontal View.

6. Select whether the validation runs when the Work List Item starts or ends in the Work List Event ID list box.

   NOTE: Values are:

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

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

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

8. Enter a brief message in the Validation Message box that will display to the user if the validation fails for the Work List Item.

   NOTE: The message should provide information about what may have caused the error and potential solutions if applicable.

9. Enter a detailed description of the validation in the Description box.

   NOTE: This description should contain notes about the validation that serve as a summary of the SQL code so that another user does not have to review the SQL code to understand the validation.

10. Click Save.

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

Parameters for Work List Event Validations

The validation can only use parameters that can be passed in from the Work List.

The following parameters can be used in validations.

Parameters	Descriptions
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 Plan Task page.
Item Description	Description entered on the Work List Setup or the Plan Task page.
PlannedStartDate	Task's planned start date entered on the Vertical View of the Work List Setup or the Plan Task page.
PlannedFinishDate	Task's planned finish date entered on the Vertical View of the Work List Setup or the Plan Task 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 the Plan Task page.