MergeStructure client API - SmartPlant Foundation - IM Update 48 - Help - Hexagon

Parameter 1

Column set to present the data

Parameter 1 default

None

Parameter 1 description

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

Integer

Parameter 5

Expansion Graph Definition UID

Parameter 5 default

None

Parameter 5 description

The UID of the graph definition to use to expand a path to select items to be merged. This expansion is represented by a simple or a complex graph definition.

Parameter 5 type

String

Parameter 6

Allow merge outside of structure for mandatory rels

Parameter 6 default

False

Parameter 6 description

If True, allows additional items outside the defined structure to be merged when they are needed for mandatory relationships. If False, objects outside the defined structure will not be merged.

Parameter 6 type

Boolean

Parameter 7

Ignore Required Rel If Terminated

Parameter 7 default

False

Parameter 7 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 7 type

Boolean

Parameter 8

Property to be set after successful merge

Parameter 8 default

None

Parameter 8 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 8 type

String

Parameter 9

Transfer Workflow to plant

Parameter 9 default

False

Parameter 9 description

Transfer workflow to plant on user selection

Parameter 9 type

Boolean

Parameter 10

Merge Mode

Parameter 10 default

EVERYTHING

Parameter 10 description

When set, users can only view certain features on the Merge Summary page.

• EVERYTHING - Allows user to review, resolve conflicts and merge.

• CONFLICTSFLAG - Allows user to review and resolve conflicts with the Project values only, but not merge.

• CONFLICTSFLAGANDMERGE - Allows user to review and resolve conflicts with the Project values only, and merge.

• CONFLICTSONLY - Allows user to review and resolve conflicts, but not merge.

• MERGEONLY - Allows user to review and merge, but not resolve conflicts.

Parameter 10 type

String

Parameter 12

Merge condition name

Parameter 12 default

None

Parameter 12 description

Merge is allowed only if the object passes this condition

Parameter 12 type

String