WorkflowEdit client API - SmartPlant Foundation - IM Update 48 - 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 WorkflowEdit client API provides the functionality to view or edit the details of a workflow definition. Methods that use this client API open the dialog box that displays information about the workflow, such as names, durations, and recipients of each step and the accept and reject paths. The information on the dialog box may be editable depending on the Mode parameter setting on the method used to open it.

Argument

Description

Parameter 1

Mode

Parameter 1 description

Specifies whether the dialog box that appears to the user will be editable or read-only. The available options are Edit, which indicates that the dialog box will be editable, and Info, which indicates that the information in the dialog box will be displayed in a read-only format.

Parameter 1 type

String

Parameter 1 default

Info

The following delivered methods use this client API to open the dialog box for viewing or editing information about the attached workflow definition instance.

  • CreateWorkflowTemplate

  • ObjectWorkflowDetail

  • ObjectWorkflowEdit

  • StepWorkflowDetail

  • StepWorkflowEdit

  • WorkflowEditShortcut

  • WorkflowEdit

  • WorkflowDetail