Tags and Assets mappings - 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

This functionality was modified in an update. For more information, see For more information, see Tags and Assets mappings (modified in an update).

Examples of tags and assets mapping CSV files in CFIHOS or non-CFIHOS format are available for you to use and modify on Smart Community. For more information, see Find sample data on Smart Community..

Tags (CFIHOS)

This mapping is intended to create a tag (design item).

This mapping can be used only if the Create and Query scope is set to an SDx plant or project.

  • Use Load Tags (CFIHOS) method to load the tags.

The below table explains the input formats required, including an example and explanation of each column's purpose and validation and mapping required:

Column name

Mapping

Type

Example

Required

Validation

Explanation

plant code

Relation to HxGN SDx Plant or Plant Code

Relation

6000

Yes

Must be the same as the HxGN SDx plant into which you are loading

<=40 characters

A Plant contains many tags. A tag is part of one Plant.

tag name

Tag - Name

String

600-036FV001

Yes

<=33 characters

The full name of the Tag as per Tag naming convention. A Tag name shall be unique within a Plant.

tag description

Tag - Description

String

Control Valve P3601A

Yes

<=255 characters

Functional description of the Tag.

parent tag name

Relation to parent tag

Relation

600-036F001

No

If provided, must exist

<=33 characters

Identify parentage of Tags. The Parent Tag (also called MAIN TAG) can be a package, an Instrument Loop or an electrical circuit.

process unit code

Relation to unit

Relation

36

Yes

If provided, must exist

<=40 characters

Decomposes a Process_Unit in Tags. This is a functional decomposition consisting of decomposing a "main function" (the process unit) in sub-functions (Tags).

area code

Relation to location

Relation

29

No

If provided, must exist

<=10 characters

Identifies the geographical location of the tags.

construction assembly code

Relation to construction assembly

Relation

No

If provided, must exist.

The construction assembly of a plant where the tag resides.

commissioning unit code

Relation to the commissioning unit

Relation

No

If provided, must exist.

<=10 characters

Identify the commissioning unit to which the commissioning system belongs.

maintenance unit code

Used to identify the maintenance system

Relation

KZ.KAS.H01.B02

No

Must exist as the parent unit for the maintenance system

<=10 characters

Identify the Maintenance unit to which the Maintenance system belongs.

maintenance system code

Relation to the maintenance system.

Relation

No

If provided, must exist

<=10 characters

Identify the Tags part of a Maintenance_System.

corrosion loop code

Relation to the corrosion loop

Relation

CL1101

No

If provided, must exist

<=40 characters

Identify the Tags part of a Corrosion_Loop.

tag class name

Relation to the tag classification

Relation

RA globe valve

Yes

Must exist in the system

<100 characters

Classifies the Tag with a Tag_Class.

tag status

Tag - Status

Relation

Enumlist

ASB

Yes

Value must be part of the Tag status enumlist

<=40 characters

Identifies in which engineering phase the tag is in.

tag requisition number

Tag - Requisition Code

String

1234567

No

<=50 characters

A code used to uniquely identify the requisition.

designed by company name

Relation to the originator organization

Relation

KWAC

Yes

Must exist in the system

<=30 characters

Identify the company responsible for the design of the tag.

production critical item indicator

Tag - Production critical

Boolean

Yes/no Enumlist

no

Yes

value is either "yes" or "no"

<=3 characters

Identifies if the loss of the tag function would immediately have a cost impact (for example, loss of production).

safety critical item indicator

Tag - Safety critical item

Boolean

Yes/no Enumlist

yes

Yes

value is either "yes" or "no"

<=3 characters

Identifies a Safety Critical Element (as per International Std). Safety Critical Elements (SCEs) are those elements of risk barriers, including equipment, hardware, and related control systems:

- the failure of which could lead to a Major Accident or Event, or

- that mitigate the consequences of a Major Accident or Event.

The basis for the selection of SCEs is the assessment of Major Accidents identified in each Asset HSE Case or those documents that support the Case.

safety critical item group code

Tag - Safety critical item group

Relation

Enumlist

DS001

No

Value must be part of the safety critical elements enumlist

<=5 characters

The Safety Critical Group identified according to International Std. This is only required if safety critical item=Yes.

safety critical item reason awarded

Tag - Safety critical item reason awarded

String

from Safety Case

No

<=30 characters

Captures the outcome of the SCE Identification. It is populated according to International Std. This is only required if safety critical item=Yes.

purchase order issuer company name

Engineering and co Ltd

No

via relation to PO

<=30 characters

Identify the Company issuing the Purchase_Order.

purchase order number

Related to the purchase order

Relation

58

No

If provided, must exist

<=50 characters

Identify the Purchase_Order that contains all the specification for this Tag. This information is captured to ensure that the original design for a Tag (usually copied into the purchase order) can be found back, in case of loss of Tag design information (e.g., data-sheet).

Tags properties

This mapping is intended to update already existing tags, that is design item, with design properties.

This mapping can be used only if the Create and Query scope is set to an SDx plant or project.

  • Use Load Tag properties method to load the properties on top of existing tags.

The below table explains the input formats required, including an example and explanation of each column's purpose and validation and mapping required:

Column name

Mapping

Type

Example

Required

Validation

Explanation

plant code

Relation to HxGN SDx Plant or Plant Code

Relation

6000

Yes

Must exist as or within the selected create scope

<=40 characters

A Plant contains many tags. A tag is part of one Plant.

tag name

Tag - Name

Relation

6000-CP-002

Yes

Must exist in the system

<=33 characters

Identifies the tag having this property value.

property name

Tag - [provided property name]

String

rated voltage

Yes

Property must exist for the tag

<=100 characters

Identify the property for which a value is provided for this tag.

property value

Tag - [provided property value]

Depends on the provided property name

220

No

Value must comply to the type of the provided property name

<=15 characters

The value of the property name. The value should meet the data type or pick list defined for this property name.

property value uom

Tag - [provided property UoM]

Depends on the provided property name

V

No

In case the type of the provided property name is UoM, the unit of measure must be provided and must be a valid unit of measure in the UoM list

<=100 characters

The unit of measure.

Tags connections

This mapping is intended to create tag connected to tag relations, that is physical relations, between existing tags.

This mapping can be used only if the Create and Query scope is set to an SDx plant or project.

  • Use Load Tag Connections method to load the relations between existing tags.

The below table explains the input formats required, including an example and explanation of each column's purpose and validation and mapping required:

Column name

Mapping

Type

Example

Required

Validation

Explanation

from plant code

Relation to HxGN SDx Plant or Plant Code of the From Tag

Relation

6000

Yes

Must exist as or within the selected create scope

<=40 characters

A Plant contains many tags. A tag is part of one Plant.

from tag name

From Tag - Name

Relation

6000-12mm-PL360015-91300X

Yes

Must exist in the system

<=33 characters

Identify the physical connections between Tags. This information is primarily used for mechanical completions. For piping this information can be generated from 3D models. For electrical and instrumentation, this information can be generated from design tools. For pipes, the direction "From" "To" represents the direction of the flow within the pipe. For electrical cables, the direction "From" "To" represents the direction of the electrical current. For an instrument having only one connection, the "From" is the Tag the instrument is mounted on (e.g., the vessel). For a valve, not causing a "line break", the "From" is the line the valve is mounted on. For drivers (e.g., electrical motor), the "From" is the driven equipment (e.g., the pump). For auxiliary equipment (e.g., a filter), the "From" is the Tag where the auxiliary equipment is mounted on.

to plant code

Relation to HxGN SDx Plant or Plant Code of the To Tag

Relation

6000

Yes

Must exist as or within the selected create scope

<=40 characters

A Plant contains many tags. A tag is part of one Plant.

to tag name

To Tag - Name

Relation

600-036FV001

Yes

Must exist in the system

<=33 characters

Identify the physical connections between Tags. This information is primarily used for mechanical completions. For piping this information can be generated from 3D models. For electrical and instrumentation this information can be generated from design tools. For pipes, the direction "From" "To" represents the direction of the flow within the pipe. For electrical cables, the direction "From" "To" represents the direction of the electrical current. For an instrument having only one connection, the "From" is the Tag the instrument is mounted on (e.g., the vessel). For a valve, not causing a "line break", the "From" is the line the valve is mounted on. For drivers (e.g., electrical motor), the "From" is the driven equipment (e.g., the pump). For auxiliary equipment (e.g., a filter), the "From" is the Tag where the auxiliary equipment is mounted on.

Assets

This mapping is intended to create an asset (physical or installed item).

This mapping can be used only if the Create and Query scope is set to an SDx plant or project.

  • Use Load Assets method to load the assets.

The below table explains the input formats required, including an example and explanation of each column's purpose and validation and mapping required:

Column name

Mapping

Type

Example

Required

Validation

Explanation

equipment code

Asset - Name

String

31000465212

Yes

<=40 characters

A number used to identify uniquely the Equipment. The number is usually generated by the COMPANY maintenance management system. When not known, the equipment number can be set to Equip_<Plant_Code>_<Tag_Name>, where Plant_Code/Tag_Name represents the Tag where the equipment is installed.

plant code

HxGN SDx plant or plant code

String

6000

Yes

If provided, must be the HxGN SDx plant or plant code for the provided tag name

<=40 characters

A Plant contains many tags. A tag is part of one Plant.

tag name

Relation to Tag

Relation

600-036FV001

No

<=33 characters

Identifies the tag where the equipment has been installed.

equipment class name

Relation to Material classification

Relation

RA globe valve

Yes

<=100 characters

Classifies the Equipment with an Equipment_Class.

equipment description

Asset - Description

String

L.V.F; GLOBE VALVE

<=255 characters

Description of the main function of the Equipment.

manufacturer company name

String

Flowserve

No

<=30 characters

Identifies the company manufacturer of a particular model part.

model part name

Relation to Model

Relation

A4 V726 PN 40

No

<=100 characters

Identifies the model part of the equipment..

Equipment manufacturer serial number

Asset - Serial number

String

AFKD34562837

No

<=50 characters

A unique identification number for the equipment as prescribed by the manufacturer. If the equipment is a custom item designed specifically for this project, the contractor shall likewise assign a unique serial number. During the project this field may not be provided as the equipment is not received.

Equipment actual purchase date

Asset - Purchase date

dd-MM-yyyy

10-01-2020

No

Must be a valid date, in the correct format

Date (DD-MM-YYYY)

Identifies the Date on which the Equipment was purchased.

vendor company name

Relation to vendor organization

Relation

Valves and co Ltd

No

<=30 characters

Identifies the company supplying the equipment (vendor)

Equipment actual installation date

Asset - Installation date

dd-MM-yyyy

11-01-2020

No

Must be a valid date, in the correct format

Date (DD-MM-YYYY)

The date of installation of the equipment.

Equipment actual startup date

Asset - Start up date

dd-MM-yyyy

12-02-2020

No

Must be a valid date, in the correct format

Date (DD-MM-YYYY)

The date when the equipment has started to operate.

Equipment price

Asset - Price

String

1500 USD

No

<=15 characters

The price of the equipment for accounting, excluding freight, shipping, and insurance costs. The value given shall include the currency used.

Note: it is a free text field where both price and currency can be mentioned.

Equipment warranty end date

Asset - Warranty end date

dd-MM-yyyy

11-01-2029

No

Must be a valid date, in the correct format

Date (DD-MM-YYYY)

The date on which the warranty provided by the manufacturer ends.

Asset properties

This mapping is intended to update the already existing assets (physical or installed item) with design properties.

This mapping can be used only if the Create and Query scope is set to an SDx plant or project.

  • Use Load Asset properties method to load the properties on top of the existing assets.

The below table explains the input formats required, including an example and explanation of each column's purpose and validation and mapping required:

Column name

Mapping

Type

Example

Required

Validation

Explanation

equipment identifier

Asset - Name

Relation

31000465212

<=40 characters

Identifies the equipment having this property value.

property name

Asset - [provided property name]

String

normal operating pressure

Yes

Property must exist for the asset

<=100 characters

Identify the property for which a value is provided for this equipment

property value

Asset - [provided property value]

Depends on the provided property name

20

No

Value must comply to the type of the provided property name

<=15 characters

The value of the property name. The value should meet the data type or pick list defined for this property name.

property value uom

Asset - [provided property UoM]

Depends on the provided property name

bar

No

In case the type of the provided property name is UoM, the unit of measure must be provided and must be a valid unit of measure in the UoM list

<=100 characters

The unit of measure.

Reason for deviating from standard unit of measure

Size of the value

No