SignOffWithForm 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 SignOffWIthForm client API is used to issue a document using a dialog box where additional notes can be added. Sign off changes the status of a document revision from Working to Current, and locks the version to prevent users from checking it out or creating a new version of the associated revision.

Argument

Description

Parameter 1

Allow working references

Parameter 1 default

False

Parameter 1 description

When set to True, all files references by files attached to this document are automatically signed off, too. When set to False, the references files are not signed off.

Parameter 1 type

Boolean

Parameter 2

Purge superseded versions

Parameter 2 default

False

Parameter 2 description

If set to True, the system will automatically purge earlier versions for this revision that have been superseded. If set to False, the superseded versions are maintained.

Parameter 2 type

Boolean

Parameter 15

Allow signoff references

Parameter 15 default

True

Parameter 15 description

Allow signoff reference files during signoffwithform operation. By default it is set to True, which means references files will be shown during signoffwithform.

Parameter 15 type

Boolean

The SignOffWithForm method uses the SignOffWithForm client API to change the status of a document version using a dialog box where you can add additional notes.