CheckIn 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 CheckIn client API is used to change the status of a document from checked-out to checked-in and to add any attached files to the vault.

Argument

Description

Parameter 1

Replace

Parameter 1 default

False

Parameter 1 description

When set to True, replaces previous file versions in the vault with the new file. When set to False, the previous file is maintained and the new file is added and related to the latest version of the file,

Parameter 1 type

Boolean

Parameter 2

Reference file not found action

Parameter 2 default

PROMPT

Parameter 2 description

Indicates what the system will do if the file being placed in the vault has references to other files that are not already stored in the system. The options are CONTINUE, PROMPT, or ABORT.

Parameter 2 type

String

Parameter 3

Get checked out versions

Parameter 3 default

True

Parameter 3 description

If True, allows the updated of nested references to the latest version. If False, nested references will keep their relationship to the version currently related.

Parameter 3 type

Boolean

Parameter 4

Column set to present results

Parameter 4 default

None

Parameter 4 description

Name of the column set that is used to display files to check in on the Check In dialog box.

Parameter 4 type

String

Parameter 6

Extract Content

Parameter 6 default

None

Parameter 6 description

Content Extractions will be enabled during replace files

Parameter 6 type

Boolean

Parameter 15

Allow references

Parameter 15 default

True

Parameter 15 description

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

Parameter 15 type

Boolean

The following methods use the CheckIn client API to check in documents and to add their attached files to the vault.

  • VersionCheckIn

  • VersionCheckInReplace