Tags and Assets mappings (modified in an update) - HxGN SDx - HxGN SDx - Reference - Hexagon

HxGN SDx Modified and Retired Functionality

Language
English
Product
HxGN SDx
Search by Category
Reference
SmartPlant Foundation / SDx Version
10
SmartPlant Markup Plus Version
10.0 (2019)

The following applies if you are using a version of the CFIHOS mappings prior to Version 1.4. For the latest information, see Tags and Assets mappings.

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 SDx Plant or Plant Code

Relation

CEX

Yes

Must exist as or within the selected create scope

Specifies which SDx plant or plant code the tag is a part of.

tag name

Tag - Name

String

1011-NRA-0015

Yes

<33 characters

The name of your tag.

tag description

Tag - Description

String

NRA choke valve 1

No

<255 characters

The description of the tag.

parent tag name

Relation to parent tag

Relation

[Parent tag name]

No

If provided, must exist

Identifies the parent tag, if any.

area code

Relation to location

Relation

CEX-SGRN

No

If provided, must exist

Identifies the geographical location of the tags.

process unit code

Relation to the unit

Relation

CT

Yes

Must exist in the system

The unit the tag belongs to.

tag class name

Relation to the tag classification

Relation

NRA choke valve

Yes

Must exist in the system

Classifies the tag with a tag classification.

tag status

Tag - Status

Enumlist

approved for construction

No

Value must be part of the Tag status enumlist

Identifies in which engineering phase the tag is in.

requisition code

Tag - Requisition Code

String

RQ-000122

No

<50 characters

A code used to uniquely identify the requisition.

designed by company name

Relation to the originator organization

Relation

Collab Org A

Yes

Must exist in the system

Identify the company responsible for the design of the tag, also the creator or the last updater of the tag.

purchase order issuer company name

Not a direct relation, but is needed to identify the purchase order issuer

not applicable

Hexagon

No

Must exist as the Issuer organization of the purchase order

Not a direct reference to the tag, but used to identify the purchase order issuer.

purchase order code

Related to the purchase order

Relation

PO-001

No

If provided, must exist

Related purchase order of the tag.

production critical item

Tag - Production critical

Yes/no Enumlist

no

No

value is either "yes" or "no"

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

safety critical item

Tag - Safety critical item

Yes/no Enumlist

yes

No

value is either "yes" or "no"

Identifies if the tag is a safety critical element.

safety critical item group

Tag - Safety critical item group

Enumlist

PS001

No

Value must be part of the safety critical elements enumlist

Identifies the safety critical element group in case the tag was flagged up as Safety Critical Item = yes

safety critical item reason awarded

Tag - Safety critical item reason awarded

String

Suffocation risk if gas escapes

No

<30 characters

Provides the main reason for flagging the tag as Safety critical item = yes

corrosion loop code

Relation to the corrosion loop

Relation

CL1101

No

If provided, must exist

The corrosion loop the tag is a part of.

maintenance unit code

Used to identify the maintenance system

Relation

11.B01

No

Must exist as the parent unit for the maintenance system

Is needed to identify the maintenance system.

maintenance system code

Relation to the maintenance system.

Relation

11.B01.01

No

If provided, must exist

The maintenance system the tag is a part of.

commissioning unit code

Used to identify the commissioning system

Relation

H2RG0300253

No

Must exist as the parent unit for the commissioning system

Is needed to identify the commissioning system.

commissioning system code

Relation to the commissioning system

Relation

01

No

If provided, must exist

The commissioning system the tag is a part of.

module code

Used to identify the module system

Relation

H01

No

Must exist as the parent for the module system

Is needed to identify the module system.

module system code

Relation to the module system

Relation

A01

No

If provided, must exist

The module system the tag is a part of.

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 SDx Plant or Plant Code

Relation

CEX

Yes

Must exist as or within the selected create scope

Specifies which SDx plant or plant code the tag is a part of.

tag name

Tag - Name

Relation

1011-NRA-0015

Yes

Must exist in the system

Identifies the tag having this property value.

property name

Tag - [provided property name]

String

normal operating pressure

Yes

Property must exist for the tag

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

property value

Tag - [provided property value]

Depends on the provided property name

5

No

Value must comply to the type of the provided property name

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

barg

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

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 SDx Plant or Plant Code of the From Tag

Relation

CEX

Yes

Must exist as or within the selected create scope

Specifies which SDx plant or plant code the From Tag is a part of.

from tag name

From Tag - Name

Relation

1011-G-226-CT-9SD0B01-N

Yes

Must exist in the system

The name of your From Tag.

to plant code

Relation to SDx Plant or Plant Code of the To Tag

Relation

CEX

Yes

Must exist as or within the selected create scope

Specifies which SDx plant or plant code the To Tag is a part of.

to tag name

To Tag - Name

Relation

1011-NRA-0015

Yes

Must exist in the system

The name of your To Tag.

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 (CFIHOS) 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 identifier

Asset - Name

String

eqp-234401

Yes

<40 characters

A number used to identify the asset uniquely.

plant code

SDx plant or plant code

not applicable

CEX

No

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

Not a direct relation to assets, but needed to identify the tag.

tag name

Relation to Tag

Relation

1011-NRA-0015

No

If provided, must exist

Identifies the tag where the equipment has been installed.

equipment class name

Relation to Material classification

Relation

NRA choke valve

Yes

Must exist in the system

Classifies the asset with a material classification.

equipment description

Asset - Description

String

Choke Valve 1

Yes

<255 characters

Description of the main function of the equipment.

manufacturer company name

Organization name

not applicable

Manufacturer A

No

If provided, must be the manufacturer organization of the model part

Identifies the company manufacturer of a particular model part.

model part name

Relation to Model

Relation

MOD-100001

No

If provided, must exist

Identifies the model part of the equipment..

manufacturer serial number

Asset - Serial number

String

45536

No

<100 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.

purchase date

Asset - Purchase date

dd-MM-yyyy

10-01-2019

No

Must be a valid date, in the correct format

Identifies the Date on which the Equipment was purchased.

vendor company name

Relation to vendor organization

Relation

Collab Org A

No

If provided, must exist

Identifies the company supplying the equipment (vendor)

installation date

Asset - Installation date

dd-MM-yyyy

11-01-2019

No

Must be a valid date, in the correct format

The date of installation of the equipment.

startup date

Asset - Start up date

dd-MM-yyyy

12-02-2019

No

Must be a valid date, in the correct format

The date when the equipment has started to operate.

price

Asset - Price

String

1200 EUR

No

<15 characters

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

warranty end date

Asset - Warranty end date

dd-MM-yyyy

11-01-2029

No

Must be a valid date, in the correct format

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

eqp-234401

Yes

Must exist in the system

Identifies the asset having this property value.

property name

Asset - [provided property name]

String

nominal diameter

Yes

Property must exist for the asset

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

property value

Asset - [provided property value]

Depends on the provided property name

50

No

Value must comply to the type of the provided property name

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

mm

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

The unit of measure.