Enforcing uniqueness through the Plant Code attribute - HxGN SDx - Update 56 - Reference

HxGN SDx Schema Overview

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

The Plant Code attribute ensures objects are unique within their plant, whether that is the SPFPlant or the level underneath. This new property definition is stored on the SDAArea class definition and is used in various UID definitions and UniqueKey definitions of other class definitions. See Class Definition Overview for a full overview.

The Plant Code attribute on the SDAArea class definition is used in uniqueness checks of objects, such as tags. For this purpose, a Key word parameter enables you to look at the Plant Code attribute or ignore it if you don’t have it or need it, in the case of a custom PBS setup.

The Key word is setup with the following syntax in UID definitions or UniqueKey definitions:

EXP?<+/- RelDef>.<PropDef>:<Fallback clause>

For example, the UID definition setup for FDWTags is as follows:

FTG,ConfigLevel1,EXP?+FDWTagArea.SDAPlantCode:ConfigLevel1,Name

  • If the FDWTag has a FDWTagArea relationship, the SDAPlantCode property value is included in the UID definition and UniqueKey definition.

  • If the FDWTag does not have an FDWTagArea relationship, the FallbackKeyword, the name of ConfigLevel1, is evaluated and included in the UID definition and UniqueKey definition.

  • If the FDWTag has a FDWTagArea relationship, but no SDAPlantCode property value, an exception is thrown.

The following information explains how the Plant Code attribute enforces uniqueness in each PBS mode without you having to change the UID definitions and UniqueKey definitions in schema and includes some examples. The side-by-side view below shows the difference in how the Plants are setup in each mode and with what values the Plant Code attribute is populated:

Enforcing uniqueness

Uniqueness examples for a Hexagon default plant structure

SPFPlant

Area

Tag Name

Tag Uniqueness

1

A

P-100

FTG_1_1_P-100

1

A

P-100

This tag name is not allowed to be re-used in the same plant.

1

B

P-100

This tag name is not allowed to be re-used in the same plant.

1

A

P-101

FTG_1_1_P-101

1

B

P-102

FTG_1_1_P-102

2

C

P-100

FTG_2_2_P-100

2

C

P-100

This tag name is not allowed to be re-used in the same plant.

2

C

P-101

FTG_2_2_P-101

Uniqueness examples for a cross-plant plant structure

SPFPlant

Plant

Tag Name

Tag Uniqueness

PDA

1

P-100

FTG_PDA_1_P-100

PDA

1

P-100

This tag name is not allowed to be re-used in the same plant.

PDA

2

P-100

FTG_PDA_2_P-100

PDA

1

P-101

FTG_PDA_1_P-101

PDA

1

P-102

FTG_PDA_1_P-102

PDA

2

P-102

FTG_PDA_2_P-102

PDA

2

P-102

This tag name is not allowed to be re-used in the same plant.