To load relationship data into SmartPlant Foundation, the relationship definition edge name is used as the Relation Type when defining the object type. Relationship data uses specific keywords to define each object.
.DEVDocumentTag
..Name1|DocABC
..Name2|CW503
..OrderValue|9
..IsRequired|True
..DomainUID1|Value1
..DomainUID2|Value2
If the end objects of the relationship exist in multiple domains, then you must specify
the DomainUID and the Name to relate to the specific domain object.
|
Format |
Description |
Example |
|---|---|---|
|
DomainUID|Value |
The DomainUID must be specified with the Name to get to the specific domain object. |
..DomainUID|SPF |
|
.RelDef Name |
Defines the name of the relationship definition. |
..DEVDocumentTag The direction of the relationship should always be specified. |
|
..Name1|value |
Defines the name of the left (first) object. There is a special case for relationship relations that is defined below. |
..Name1|DocABC |
|
..Name2|value |
Defines the name of the right (second) object. |
..Name2|CW503 |
|
..<propertyName>|Value |
Define any other property that belongs on the relationship. |
..OrderValue|9 |
|
..UniqueKey1|Value |
As an alternative to Name1, the unique key can be specified. |
..UniqueKey1|DM_DocABC_A_1_1 |
|
..UniqueKey2|Value |
As an alternative to Name2, the unique key can be specified. |
..UniqueKey2|TG_CW503 |
|
UID1|Value |
As an alternative to Name1, the UID1 can be specified. |
..UID1|{4fytj1664x56) |
|
UID2|Value |
As an alternative to Name2, the UID2 can be specified. |
..UID2|{45516dyyt66) |
|
..Action|Value|Arg1 |
See NLF load format for documents for details. |
..Action|Terminate |
|
..<interface name> |
Defines an optional interface that can be added onto the relationship. |
..SPFClaimableItem |
|
..<Classdef>|Name|reldef |
Defines a relationship relation. If the cardinality is set to max =1 and the object is being updated, then the existing relationship is terminated. |
..SPFCondition|IsConfigMerged|SPFClassDefAccessGroupCondition_12 |
For a relationship, the following instructions are supported:
-
Terminate
-
Delete
-
Claim
-
Merge
The following example demonstrates terminating a relation:
.DEVDocumentTag
..Name1|DocABC
..Name2|CW503
..Action|Terminate