The XmtlCancel client API is used to cancel the transmittals attached to the workflow.
Argument |
Description |
---|---|
Parameter 1 |
Not used |
Parameter 2 |
Not used |
Parameter 3 |
Not used |
Parameter 4 |
Name of cancel workflow |
Parameter 4 default |
None |
Parameter 4 description |
Name of the workflow the cancelled transmittal is attached to. |
Parameter 4 type |
String |
Parameter 5 |
Issue states to cancel and revise |
Parameter 5 default |
None |
Parameter 5 description |
This argument takes list of transmittal issue states to cancel and revise with a new workflow. Multiple issue states can be specified by comma separated values, such as ISSUED,COMPLETED. Transmittals with other issue states that are not specified will only be cancelled. |
Parameter 5 type |
String |
Parameter 6 |
Workflow Step Definition Name |
Parameter 6 default |
None |
Parameter 6 description |
Specifies the workflow step definition to identify the workflow step in the current workflow. The canceled workflow is added to this workflow step. |
Parameter 6 type |
String |
The following methods use the XmtlCancel client API to cancel the workflow an object is attached to.
-
XmtlCancelExt
-
XmtlCancelInt
-
SCLBCancelIntAction