MergeConfig client API - HxGN SDx - Update 64 - Administration & Configuration

Administration and Configuration of HxGN SDx

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

The MergeConfig client API is used to merge a lower configuration, such as a project, into a higher configuration, such as the plant.

Argument

Description

Parameter 1

Column set to present 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

Show Confirmation Dialog

Parameter 2 default

False

Parameter 2 description

If True, presents an optional dialog box with commands to cancel or continue before executing the method. If False, the method is executed without confirmation.

Parameter 2 type

Boolean

Parameter 3

Run in asynchronous mode

Parameter 3 default

False

Parameter 3 description

Merge Progress Notification is created 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 tuning of performance and setting the frequency of updates to notification 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

Merge Screen Mode

Parameter 5 default

EVERYTHING

Parameter 5 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.

  • 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 5 type

String

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 MergeConfig method uses the MergeConfig client API to commit all the changes in a project to the parent configuration.