UpdateReferences client API - HxGN SDx - Update 63 - Administration & Configuration

Administration and Configuration of HxGN SDx

Language
English
Product
HxGN SDx
Search by Category
Administration & Configuration
SmartPlant Foundation / SDx Version
10

The UpdateReferences client API is used to manage the version of referenced files.

Argument

Description

Parameter 1

Column set to present data

Parameter 1 default

CS_UpdateRefsColumnSet

Parameter 1 description

Column set used to display items in the Update References dialog box.

Parameter 1 type

String

Parameter 2

Column item for target references

Parameter 2 default

CI_TargetReferencesRev

Parameter 2 description

The editable column item for selecting the target reference document. Allows you to specify whether you want to maintain a relationship to the latest working version of a reference file, the current version, or the original version to which the relationship was initially created.

Parameter 2 type

String

Parameter 3

Skip Max Nested Level Validation

Parameter 3 default

False

Parameter 3 description

When set to True, the maximum nested reference level validation is skipped.

Parameter 3 type

Boolean

The following methods use the UpdateReferences client API to manage what version of references file a document is related to.

  • FileUpdateReferences

  • UpdateReferences