OnAboutToChangeWorkflowState.LST script file

<< Click to Display Table of Contents >>

Navigation:  Programming Mechworks PDM > DBWCommandShell > Event Scripts > Workflow >

OnAboutToChangeWorkflowState.LST script file

Description

This script can contain conditions on workflow actions to inhibit them before they actually take place.

It is called before a state transition in the DBWorkFlow module: input is equal to that passed for the OnChangeWorkflowState.LST post-event script.

Activation

Options→Environment→Workflow

Input

@DOCUMENT_UNIQUE_ID

the document unique id

@ECO_ID

the ECO_ID

@PROCESS

the Workflow Process name assigned to the document

@FROM_STATE

the state from which the process comes from

@TO_STATE

the state to which the process goes to

@FROM_STATE_INDEX

the index ( 0..N ) of the state from which the process comes from

@TO_STATE_INDEX

the index ( 0..N ) of the state to which the process goes to

@SILENT

0/1 ( 1 if no input should be required )

@IS_LAST_DOC

0/1 ( 1 if TRUE )

Output

@OKSTATECHANGE <0/1>

if 0, inhibits the state change (default: 1)

@TO_STATE <state name>

Optional: if @OKSTATECHANGE=1 it permits to reassign the state where to jump

@EVENT_LOG_NOTES

Optional.

@EVENT_LOG_FILE_ATTACHMENT

Optional.