MergeStructureSummary client API - SmartPlant Foundation - Help - Hexagon PPM

SmartPlant Foundation Web Client Help

PPMProductFamily
Asset Information Management
PPMProduct
SmartPlant Foundation
PPMCategory
Help
SPFVersion_custom
2019 (10.0)
Version_SDAConnectorforTruView
(none)

The following section provides information about the MergeStructureSummary client API, which is used to create a summary of the items in a defined structure using a merge by grouping objects being merged, terminated, or deleted from a lower configuration, such as a project, and merged to a higher configuration, such as the plant.

For more information on using the merge structure summary, see Generate a mergeable item summary.

Argument

Description

Parameter 1

Column set to present data

Parameter 1 default

CompareColumnSet

Parameter 1 description

The column set that will be used to display the returned 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

Expansion Graph Definition UID

Parameter 3 default

None

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

String

Parameter 4

Allow merge outside of structure for mandatory rels

Parameter 4 default

False

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

Boolean

Parameter 5

Show any validation errors before the summary?

Parameter 5 default

True

Parameter 5 description

If set to True, validation messages encountered when creating the summary are displayed before the summary. If set to False, these validation messages are not included.

Parameter 5 type

Boolean

Parameter 6

Export at Property Level?

Parameter 6 default

False

Parameter 6 description

If set to True, exports the mergeable items report at property level.

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 behaviour for that relationship is set to required.

Parameter 7 type

Boolean

No delivered methods use this client API.