Validate comments when a step is rejected - HxGN SDx - Update 63 - Administration & Configuration

Administration and Configuration of HxGN SDx

Language
English
Product
HxGN SDx
Search by Category
Administration & Configuration
SmartPlant Foundation / SDx Version
10

This process step is used in workflows for the Web Client.

This process step is used to automatically verify that comments were provided when a workflow step is rejected. Comments are required if the step is rejected. This process step is used with the PropagateProperty process step in the collaboration workflows and can only be used on a reject step.

Process class name: ValidateProperty, Args

Syntax: ValidateProperty, Arg1, Arg2, Arg3, Arg4

Example: ValidateProperty,ISDAManagedLifecycleDetails,SDAProjComsRejectReason,Rejected ( ),False

Where:

Arg1: Defines the interface that exposes the property. In the example above, ISDAManagedLifecycleDetails is the interface.

Arg2: Defines the property definition name where the comments are stored. In the example above, SDAProjComsRejectReason is the property definition name.

Arg3: The Rejected ( ) string is required for workflow steps that can be rejected. It is used to pass and store the comment on the property definition. The argument displays as Rejected (comment) on the property definition defined in Arg 2. If a comment is not provided, a message appears requiring the comment to be provided before proceeding. The display of the message depends on Arg4.

Arg4: This string must be set to False for a message to appear. The False string validates the Rejected ( ) string in Arg3 and results in a message to the user when a comment is not provided. If set to True, no error message is given, and the reject step will proceed.