TerminateWorkflow client API - SmartPlant Foundation - IM Update 46 - Help - Hexagon

SmartPlant Foundation Help

Language
English
Product
SmartPlant Foundation
Search by Category
Help
SmartPlant Foundation / SDx Version
10
SmartPlant Markup Plus Version
10.0 (2019)
Smart Review Version
2020 (15.0)

The TerminateWorkflow client API is used to terminate the relationship between a document or transmittal and an instance of a workflow definition. All history pertaining to work already completed is retained in the database. However, the relationship is marked terminated and is therefore no longer valid from the point of termination forward.

Argument

Description

Parameter 1

Comments mandatory

Parameter 1 default

False

Parameter 1 description

Specifies whether comments must be provided in the dialog box provided to the user before they can complete the terminate operation.

Parameter 1 type

Boolean

The TerminateWorkflow method uses the TerminateWorkflow client API to terminate the relationship between the selected document or transmittal and an attached instance of a workflow definition.