Relationship properties - HxGN SDx - Update 56 - Reference

HxGN SDx Schema Overview

Language
English
Product
HxGN SDx
Search by Category
Reference
SmartPlant Foundation / SDx Version
10

There are many different aspects to the behavior of a relationship definition. Where these can all be separately configured, there are many soft dependencies between them. This section describes the following aspects of relationship definition behavior:

  • Relationship cardinality that controls how many objects can be related to each other.

  • Delete flags that control what happens to an object when the object at the other end of the relationship is deleted.

  • Copy flags that control what happens to an object when the object at the other end of the relationship is copied.

  • Relationship ownership that is used to build up parent-child ownership between the related objects.

  • Force Null Config flag that identifies the relationship as always configuration independent and is also expanded assuming all related objects are configuration independent.

  • Claims that control what happens when an object at one end of the relationship is claimed.

  • Code writing support.

The first four behaviors often work together with the claim functionality optionally layered on top.

The following properties can be set to configure the behavior of a relationship definition.

Property

Description

Max1 and Max2

These properties identify the maximum number of objects that can participate at each end of the relationship. For more information, see Max1 and Max2.

Min1 and Min2

These properties determine if a relationship is required or not. A value of 0 means that the relationship is optional, whereas a value of 1 means the relationship is required. For more information, see Min1 and Min2.

Delete12 and Delete21

These properties control what happens when the object at each end of the relationship is deleted. For more information, see Delete12 and Delete21.

Copy12 and Copy21

These properties control what happens when the object at each end of the relationship is copied. For more information, see Copy12 and Copy21.

Owner12 and Owner21

These properties define the object at one end of the relationship as the owner of the relationship such that, when these relationships are created or deleted, the owner of the relationship is considered to be updated just as if some of its properties have been changed. For more information, see Owner12 and Owner21.

ForceNullConfig

This property forces the relationship to exist outside of configuration control. For more information, see ForceNullConfig.

Claim12 and Claim21

These properties are used to control what happens to related objects when an object is claimed into a lower configuration. For more information, see Claim12 and Claim21.

SPFCascade12 and SPFCascade21

These properties define the cascade name for the relationship. It supports #nnnn (where nnnn is the value in the client resource file). If set, there will be a cascade menu on the object's Actions menu that has the relationship, for example, master relationships and revision relationships.

ExcludeFromMerge

This property prevents items from being merged to the plant (or any higher configuration). For more information, see ExcludeFromMerge.

End1PropertyForEnd2Name and End2PropertyForEnd1Name

These properties are used to propagate data between the objects on either end. End1PropertyForEnd2Name stores the name of the object on End2 for use as a property on the End1 object. The End2PropertyForEnd1Name stores the name of the object on End1 for use as a property on the End2 object. For more information, see Conditions.

HideEdgeInInfoMap

This property prevents the relationship from being displayed in the InfoMap in the Web Client. If this is not set, HideEdgeInSPF will be set.

HideEdgeInSPF

This property prevents the relationship from being displayed in the right-hand mouse menu in the Desktop Client.

HideNavigationCount

HideNavigationCount12

HideNavigationCount21

These properties prevent the lookahead count from being displayed in the Actions menu for selected expansions in the Web Client.

  • The relationship definitions can be configured with independent values for each navigation direction using the HideNavigationCount12 and HideNavigationCount21 properties.

  • The edge definitions can be configured using the HideNavigationCount property.

Includes12 and Includes21

These properties define what makes up a complex object. For example, documents are complex objects, and these would be set on the master-revision and revision-version relationships.

IsAbstract

This property indicates whether the relationship definition is abstract.

Abstract relationships are not stored in the database, there will be a number of concrete specializations. For example, Recipient User and Recipient Role are both abstracts of Recipient Participant.

LinkInterfaces

Identifies link interfaces for the relationship definition.

Link interfaces are relationships with type specific interfaces to carry properties or other relationships.

Role1 and Role2

These properties identify the role at each end of the relationship.

Role1DisplayName and Role2DisplayName

The display name of the role is shown in the Actions menu.

SPFAllowRelReassignment

This property indicates that the relationship can be reassigned. For more information, see Transfer ownership of items from one user to another.

SPFRelDefIsExposed

This property indicates whether the relationship definition is exposed to services.

SPFSecurityRuleExecution12 and SPFSecurityRuleExecution21

These properties control the security rules that are applied during a relationship expansion, when a security rule is configured on a class definition. For more information, see Configure security rules.

SpecOfUID

This property names an abstract relationship which indicates the specialization of the relationship definition.

UID1 and UID2

A unique identifier for the object at end1 and end2.