MergeableItemSummary 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 MergeableItemSummary client API is used to create a summary of the items being merged, terminated, or deleted from a lower configuration, such as a project, and merged to a higher configuration, such as the plant.

  • The MergeableItemSummaryObj method of the CompareObjsToHigherConfig API provides a summary report of merge impact for a set of selected items.

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

Argument

Description

Parameter 1

Mode

Parameter 1 default

SummaryCompare

Parameter 1 description

Use SummaryCompare to distinguish from conflict resolution and individual comparison

Parameter 1 type

String

Parameter 2

ColumnSet

Parameter 2 default

CompareColumnSet

Parameter 2 description

The column set that will be used for the comparison results.

Parameter 2 type

String

Parameter 3

Export at Property Level?

Parameter 3 default

False

Parameter 3 description

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

Parameter 3 type

Boolean

The MergableItemSummary method uses the MergableItemSummary client API to create a summary of items that differ between the higher and lower configurations.