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

SmartPlant Foundation Web Client Help

Language
English
Product
SmartPlant Foundation
Search by Category
Help
SmartPlant Foundation / SDx Version
10

The MergeObj client API is used to merge a claimed object into a higher configuration, the plant.

Argument

Description

Parameter 1

Column set to present the data

Parameter 1 default

None

Parameter 1 description

The name of the column set to be used to display the data.

Parameter 1 type

String

Parameter 2

Allow Working Reference files

Parameter 2 default

None

Parameter 2 description

Indicates whether documents being merged are allowed to have reference files remain at the working project level.

Parameter 2 type

Boolean

Parameter 3

Run in asynchronous mode

Parameter 3 default

False

Parameter 3 description

The Merge Progress Notification is created when using asynchronous mode, which allows a user to continue working during a merge action.

Parameter 3 type

Boolean

Parameter 4

Commit frequency

Parameter 4 default

50

Parameter 4 description

The number of merged items between commits. Can be used for performance tuning and setting the frequency of notification updates when running asynchronously.

You can set the value to -1 to commit the merge to a single large transaction and avoid partial merges.

Parameter 4 type

String

Parameter 5

Ignore Required Rel If Terminated

Parameter 5 default

False

Parameter 5 description

Consider items on the other end of the termination relationship definition as "out of scope" of the merge, even if the claim behavior for that relationship is set to required.

Parameter 5 type

Boolean

Parameter 6

Property to be set after successful merge

Parameter 6 default

None

Parameter 6 description

You can set the property value on all claimed objects after a successful merge using the format: <Interface>~<Property>~<Value>.

If multiple property values need to be set, use commas to separate them.

Parameter applies to Web Client only.

Parameter 6 type

String

The MergeObj method uses the MergeObj client API to merge an object into the parent configuration.