Programming Mechworks PDM > DBWCommandShell > Event Scripts > Workflow

Description

It is placed under the DBWorks\LST foder.
It must be programmed so to handle the logic of the assignment of the ECO_ID to the document being submitted to the Workflow Module.

Input

@DOCUMENT_UNIQUE_IDS	It is a string of the form uid1 uid2 uid3 ... containing the list of the unique ids of all the documents being submitted to the Workflow Module; the unique ids are separated by blank spaces.
@WORKFLOW_ACTION	if invoked before submitting the documents for a change request or for the approval it allows to know the action of the workflow process. Possible values are: •RAISE_ECR •ECR •ECA

@DOCUMENT_UNIQUE_IDS

It is a string of the form
uid1 uid2 uid3 ...
containing the list of the unique ids of all the documents being submitted to the Workflow Module; the unique ids are separated by blank spaces.

@WORKFLOW_ACTION

if invoked before submitting the documents for a change request or for the approval it allows to know the action of the workflow process.
Possible values are:

•RAISE_ECR

•ECR

•ECA

Output

@OK	0: failed 1: success
@ECO_ID	A string containing the ECO identifier ( may be a number or an alphanumeric string )

Optional output

@EVENT_LOG_NOTES	A note to be associated in the workflow event log to this event @DOCUMENT_UNIQUE_IDS "uid1 uid2 uid3 …" A string containing the list of the unique ids of all the documents being submitted to the Workflow Module; the unique ids are separated by blank spaces. Returning the set of unique ids alters the set that was previously passed to the script as an input parameter. In the altered list the programmer can change the logic by which the documents are managed by the workflow module. Typically the initial set passed as @DOCUMENT_UNIQUE_UIDS is the "related documents set" as calculated by the Link Mode logic, and available through a call to the DBWShell("GetUniqueIdFromRelatedDocuments") The list of unique ids is normally ouput with a command DBWOutput,"@DOCUMENT_UNIQUE_IDS",myAlteredUidList,ForWriting
@EVENT_LOG_FILE_UID	Pairs of outputs, with the UID always preceding the ATTACHMENT, for assigning files as attachment to the workflow event log records for this submission action; the standard sample provided in this document implements the creation of eDrawings when the submission is executed
@EVENT_LOG_FILE_ATTACHMENT

@EVENT_LOG_NOTES

A note to be associated in the workflow event log to this event @DOCUMENT_UNIQUE_IDS "uid1 uid2 uid3 …"

A string containing the list of the unique ids of all the documents being submitted to the Workflow Module; the unique ids are separated by blank spaces.

Returning the set of unique ids alters the set that was previously passed to the script as an input parameter. In the altered list the programmer can change the logic by which the documents are managed by the workflow module. Typically the initial set passed as @DOCUMENT_UNIQUE_UIDS is the "related documents set" as calculated by the Link Mode logic, and available through a call to the DBWShell("GetUniqueIdFromRelatedDocuments")

The list of unique ids is normally ouput with a command

DBWOutput,"@DOCUMENT_UNIQUE_IDS",myAlteredUidList,ForWriting

@EVENT_LOG_FILE_UID

Pairs of outputs, with the UID always preceding the ATTACHMENT, for assigning files as attachment to the workflow event log records for this submission action; the standard sample provided in this document implements the creation of eDrawings when the submission is executed

@EVENT_LOG_FILE_ATTACHMENT

Example