SDARelationshipBuilder 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 SDARelationshipBuilder client API is used to create and manage relationships and support the termination of relationships.

Argument

Description

Parameter 1

Title

Parameter 1 default

Relationship Builder

Parameter 1 description

Title to be displayed on the main Relationship Builder view

Parameter 1 type

String

Parameter 2

Enable Terminate

Parameter 2 default

False

Parameter 2 description

Enable the termination of relationships in the Relationship Builder view

Parameter 2 type

Boolean

Parameter 3

Security Rule Definition

Parameter 3 default

Parameter 3 description

Common criteria to apply on all the entry points

Parameter 3 type

String

Parameter 4

Switch Off Paging

Parameter 4 default

<blank>

Parameter 4 description

Leaving blank (or setting to False) loads the existing relations of an object up to the page size defined in the Web Client site settings.

SHARED Tip We recommend the above setting to enhance the performance.

Setting to True loads all the existing relations of an object.

Parameter 4 type

Boolean

The following methods use the SDARelationshipBuilder client API to create and manage relationships and support the termination of relationships.

  • SDARelationshipBuilder

  • FDWAssetRelationshipBuilder

  • FDWDocumentRelationshipBuilder

  • FDWTagRelationshipBuilder

  • SDAActionRelationshipBuilder

  • SDADocumentRelationshipBuilder

  • SDAObservationRelationshipBuilder

  • SDATQRelationshipBuilder

  • SDATransmittalRelationshipBuilder

  • SDAWorkPackageRelationshipBuilder

  • PrepareSchemaChangeRequestRelBuilder