SDAImpactAnalysis client API - HxGN SDx - Update 63 - Administration & Configuration

Administration and Configuration of HxGN SDx

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

The SDAImpactAnalysis client API is used to view the impacts of requested changes to a plant and any conflicts resulting from those changes.

Argument

Description

Parameter 1

IsViewOnly

Parameter 1 description

Controls whether impacted items can be added or removed from the item under change

Parameter 1 type

Boolean

Parameter 1 default

None

Parameter 2

RelDef to documents from the item under analysis

Parameter 2 description

Relationship definition from the item under analysis to documents (prefixed +/- to the relationship)

Parameter 2 type

String

Parameter default

None

Parameter 3

Impacted items

Parameter 3 description

Relationship definition from documents to impacted items, each separated by tildes (prefixed +/- to the relationship)

Parameter 3 type

String

Parameter 3 default

None

Parameter 4

RelDefs to tags from item under analysis

Parameter 4 description

Relationship definition from the item under analysis to the related tags, each separated by tildes (prefixed +/- to the relationship)

Parameter 4 type

String

Parameter 4 default

None

Parameter 5

RelDefs from a tag to impacted items

Parameter 5 description

Relationship definition from a tag to impacted items, each separated by tildes (prefixed +/- to the relationship)

Parameter 5 type

String

Parameter 5 default

None

Parameter 6

RelDefs from a document to conflicting objects

Parameter 6 description

Relationship definition from a document to conflicting objects, each separated by tildes (prefixed +/- to the relationship)

Parameter 6 type

String

Parameter 6 default

None

Parameter 7

RelDefs from a tag to conflicting objects

Parameter 7 description

Relationship definition from a tag to conflicting objects, each separated by tildes (prefixed +/- to the relationship)

Parameter 7 type

String

Parameter 7 default

None

Parameter 8

Impact analysis column set

Parameter 8 description

The column set used to display the item under impact analysis

Parameter 8 type

String

Parameter 8 default

None

Parameter 9

Menu options for APIs

Parameter 9 description

Menu options for APIs to the impacted items each separated by (,), and to the filters each separated by tildes (~)

Parameter 9 type

String

Parameter 9 default

None

Parameter 10

RelDefs to change requests from item under analysis

Parameter 10 description

Relationship definitions from the item under analysis to the change requests

Parameter 10 type

String

Parameter 10 default

None

Parameter 11

RelDefs from change request to impacted items

Parameter 11 description

Relationship definitions from the change request to the impacted items, each separated by tildes (prefixed +/- to the relationship)

Parameter 11 type

String

Parameter 11 default

None

Parameter 13

ShowImpactsConflictsMode

Parameter 13 description

When set, users will see only certain features enabled on the Impact Analysis page. This can be set to:

  • IMPACTSONLY

  • CONFLICTSONLY

  • EVERYTHING

Parameter 13 type

String

Parameter 13 default

EVERYTHING

The following methods use this client API to view the impacts of requested changes to a plant and any conflicts resulting from those changes.

  • SCLBActionImpactAnalysis

  • SCLBViewActionImpactAnalysis

  • SCLBViewTQImpactAnalysis

  • SDAChangeImpactAnalysis

  • SDAChangeImpactAnalysisView

  • SOPSInspectionWorkPackageImpactAnalysis

  • SOPSMaintenanceWorkPackageImpactAnalysis

  • SOPSPABShowChangeConflicts (3D Project As-Built databases only)

  • SOPSPABShowChangeImpacts (3D Project As-Built databases only)

  • SOPSWorkPackageImpactAnalysisView