System setup mappings - HxGN SDx - Update 63 - 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 System setup mappings (modified in an update).

Examples of system setup mapping CSV files in CFIHOS or non-CFIHOS format are available on Smart Community. For more information, see Find sample data on Smart Community. Sample CSV files with pre-defined content of the CFIHOS RDL v1.4 can also be found in the HxGN SDx system as a template document. For more information, see Edit template documents.

Tag classifications

This mapping is intended to create tag classifications which are used to classify tags as per their function, like pipeline or centrifugal pump, motor valve, and so on.

This mapping can be used only if the Create and Query scope is not selected.

  • Use Load Tag Classifications method to load the tag classifications.

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

parent tag class name

Relation to parent Tag Class - Name

Relation

electrical equipment

Yes

must exist in the system or is part of the same load

<=100 characters

Identify the parent class of a Tag_Class, in order to build a hierarchy of Classes.

tag class name

Tag Class - Name

String

control panel

Yes

<=100 characters

The full name of the tag class.

tag class definition

Tag Class - Description

String

A panel containing full set of indicating devices and remote control units required for operation of a system or part of it.

No

<=1026 characters

Definition of the Tag_Class.

abstract class flag

Tag Class - Abstract Class

Boolean

Yes/No

No

No

value is either "yes" or "no"

When set to No, indicates that the Class can be used for classifying Tag, Equipment or Model_Part. If set to Yes, indicates that the Class can only be used for building a class hierarchy.

ISO15926 part4 unique number

Not mapped, ignored during loading

not applicable

not applicable

not applicable

The identifier used in ISO 15926-4 to identify this class uniquely.

CFIHOS unique id

Tag Class - CFIHOS unique id

String

CFIHOS-10000146

No

<=40 characters

If applicable, a unique id number assigned by the CFIHOS project.

unique id STEPLIB

Not mapped, ignored during loading

not applicable

70066

not applicable

not applicable

The identifier used in Steplib to identify this class uniquely.

unique id POSC CAESAR

Not mapped, ignored during loading

not applicable

874124

not applicable

not applicable

The identifier used in POSC-CAESAR to identify this class uniquely.

referenced standard

Not mapped, ignored during loading

not applicable

not applicable

not applicable

International or Industry Standard that requirement is sourced from.

tag number format

Tag Class - Tag number format

String

####-P-####[A-Z]

No

<=33 characters

If applicable, a regular expression that represents the tag class format according to the tagging specification principles.

equipment installed

Tag Class - Expect asset installed

Boolean

Yes/No

Yes

No

value is either "yes" or "no"

Indicate if equipment is expected to be installed for this type of tag.

reason for having class

Tag Class - Reason for having class

String

[reason for having the class]

No

<=255 character

To provide the reason for having the class.

Tag classification column sets

This mapping is intended to create the column sets which are used to expose the tag class specific properties on the applicable forms. This will make the pipe-specific properties to appear on the form for pipe tags and so on.

This mapping can be used only if the Create and Query scope is not selected.

  • Use Load Tag Classification Column Sets method to load the tag classification column sets.

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

tag class name

Relation to parent Tag Class - Name

Relation

NRA choke valve

Yes

must exist in the system

Specifies the tag class to which the property applies.

tag class CFIHOS unique id

Not mapped, ignored during loading

not applicable

not applicable

not applicable

not applicable

alternative field for relationship joins

tag property name

Column Item - Referenced property

Relation

upper limit design pressure

Yes

must exist in the system

This is either the internal name or the CFIHOS name of the property, if applicable.

tag property CFIHOS unique id

Not mapped, ignored during loading

not applicable

not applicable

not applicable

not applicable

alternative field for relationship joins

referenced standard

Not mapped, ignored during loading

not applicable

ISO 14224

not applicable

not applicable

International or industry standard that the requirement is sourced from.

As part of CFIHOS mapping enhancements, the delivered MSR mappings are configured to set Display As, Column Size, Order Value, and Sort Order values for the column items and their name/description properties. For more information on how to copy the MSR mappings, see Copy Data Validator master mappings.

You can use the below table to update your HEX mappings with the Display As, Column Size, Order Value, and Sort Order values for the column items and their name/description properties.

  • Update the mappings by mapping the column headers to the SPFColumnDisplayAs property on the SPFColumnSetColumnItem relationship to show the column set column items with Display As information on the dynamic forms.

  • Update the mappings by mapping the column headers to the SPFColumnSize property on the SPFColumnSetColumnItem relationship to set the column size on the column set column items.

  • Update the mappings by mapping the column headers to the Order Value property on the SPFColumnSetColumnItem relationship to set the order value on the column set column items.

  • Update the mappings by mapping the column headers to the SPFSortOrder property on the SPFColumnSetColumnItem relationship to set the sort order to Ascending on the column set column items.

Column header

Column type

Relationship property mappings

Parent relationship

Explanation

COMP_SPFColumnDisplayAs

Computed

HEXSPFColumnDisplayAs

HEXSPFColumnSetColumnItem

Maps to all the properties of the column item

CST_NameCISPFColumnDisplayAs

Constant

HEXSPFColumnDisplayAs

HEX1SPFColumnSetColumnItem

Maps to the name property of the column item

CST_DescrCISPFColumnDisplayAs

Constant

HEXSPFColumnDisplayAs

HEX2SPFColumnSetColumnItem

Maps to the description property of the column item

COMP_SPFColumnSize

Computed

HEXSPFColumnSize

HEXSPFColumnSetColumnItem

Maps to all the properties of the column item

CST_NameCISPFColumnSize

Constant

HEXSPFColumnSize

HEX1SPFColumnSetColumnItem

Maps to the name property of the column item

CST_DescrCISPFColumnSize

Constant

HEXSPFColumnSize

HEX2SPFColumnSetColumnItem

Maps to the description property of the column item

CST_NameCIOrderValue

Constant

HEXOrderValue

HEX1SPFColumnSetColumnItem

Maps to the name property of the column item. Order value provided is 1.

CST_DescrCIOrderValue

Constant

HEXOrderValue

HEX2SPFColumnSetColumnItem

Maps to the description property of the column item. Order value provided is 2.

COMP_DefaultOrderValue

Computed

HEXOrderValue

HEXSPFColumnSetColumnItem

Maps to all the properties of the column item. Order value provided is 20.

CST_NameSortOrder

Constant

HEXSPFSortOrder

HEX1SPFColumnSetColumnItem

Maps to the name property of the column item. SPFSortOrder - e1SortAscending.

Material classifications

This mapping is intended to create material classifications, which are used to classify the assets and models as per their function, like pipeline or centrifugal pump, motor valve, and so on.

This mapping can be used only if the Create and Query scope is not selected.

  • Use Load Material Classifications method to load the material classifications.

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

parent equipment class name

Relation to parent Material Class - Name

Relation

Valve instrument

Yes

<=100 characters

Identifies the parent class of an Equipment_Class, in order to build a hierarchy of Classes.

equipment class name

Material Class - Name

String

RA globe valve

Yes

<=100 characters

The full name of the Equipment_Class.

equipment class definition

Material Class - Description

String

A valve designed to regulate flow. A valve where the closure member is a disk or piston operating with linear motion normal to the flat or shaped seat. Includes an actuator that needs auxiliary power to operate.

No

<=1026 characters

Definition of the Equipment_Class.

abstract class flag

Material Class - Abstract Class

Boolean

Yes/No

No

No

Value is either "yes" or "no"

When set to No, indicates that the Class can be used for classifying Tag, Equipment or Model_Part. If set to Yes, indicates that the Class can only be used for building a class hierarchy.

iso15926 part4 unique number

Not mapped, ignored during loading

not applicable

not applicable

not applicable

not applicable

The identifier used in ISO 15926-4 to identify this class uniquely.

CFIHOS unique id

Material Class - CFIHOS unique id

String

CFIHOS-10000146

No

<=40 characters

If applicable, a unique id number assigned by the CFIHOS project.

unique id steplib

Not mapped, ignored during loading

not applicable

70545

not applicable

not applicable

The identifier used in Steplib to identify this class uniquely.

unique id posc caesar

Not mapped, ignored during loading

not applicable

5767330

not applicable

not applicable

The identifier used in POSC-CAESAR to identify this class uniquely.

referenced standard

Not mapped, ignored during loading

not applicable

not applicable

not applicable

not applicable

International or Industry Standard that requirement is sourced from.

spare part info req

Material Class - Spare part info required

Boolean

Yes/No

Yes

No

Value is either "yes" or "no"

Indicate if some spare part information is required for this type of Equipment.

reason for having class

Material Class - Reason for having class

String

[reason for having class]

No

<=255 characters

To provide the Reason for having the Class.

Asset classification column sets

This mapping is intended to create the column sets which are used to expose the asset class specific properties on the applicable forms. This will make the pipe-specific properties to appear on the form for pipe assets and so on.

This mapping can be used only if the Create and Query scope is not selected.

  • Use Load Asset Classification Column Sets method to load the asset classification column sets.

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 class name

Relation to parent Material Class - Name

Relation

pipeline

Yes

must exist in the system

Specifies the material class to which the property applies.

equipment class CFIHOS unique id

Not mapped, ignored during loading

not applicable

not applicable

not applicable

not applicable

alternative field for relationship joins

equipment property name

Column Item - Referenced property

Relation

nominal pipe diameter

Yes

must exist in the system

This is either the internal name or the CFIHOS name of the property, if applicable.

equipment property CFIHOS unique id

Not mapped, ignored during loading

not applicable

not applicable

not applicable

not applicable

alternative field for relationship joins

referenced standard

Not mapped, ignored during loading

not applicable

ISO 14224

not applicable

not applicable

International or industry standard that the requirement is sourced from.

As part of CFIHOS mapping enhancements, the delivered MSR mappings are configured to set Display As, Column Size, Order Value, and Sort Order values for the column items and their name/description properties. For more information on how to copy the MSR mappings, see Copy Data Validator master mappings.

You can use the below table to update your HEX mappings with the Display As, Column Size, Order Value, and Sort Order values for the column items and their name/description properties.

  • Update the mappings by mapping the column headers to the SPFColumnDisplayAs property on the SPFColumnSetColumnItem relationship to show the column set column items with Display As information on the dynamic forms.

  • Update the mappings by mapping the column headers to the SPFColumnSize property on the SPFColumnSetColumnItem relationship to set the column size on the column set column items.

  • Update the mappings by mapping the column headers to the Order Value property on the SPFColumnSetColumnItem relationship to set the order value on the column set column items.

  • Update the mappings by mapping the column headers to the SPFSortOrder property on the SPFColumnSetColumnItem relationship to set the sort order to Ascending on the column set column items.

Column header

Column type

Relationship property mappings

Parent relationship

Explanation

COMP_SPFColumnDisplayAs

Computed

HEXSPFColumnDisplayAs

HEXSPFColumnSetColumnItem

Maps to all the properties of the column item

CST_NameCISPFColumnDisplayAs

Constant

HEXSPFColumnDisplayAs

HEX1SPFColumnSetColumnItem

Maps to the name property of the column item

CST_DescrCISPFColumnDisplayAs

Constant

HEXSPFColumnDisplayAs

HEX2SPFColumnSetColumnItem

Maps to the description property of the column item

COMP_SPFColumnSize

Computed

HEXSPFColumnSize

HEXSPFColumnSetColumnItem

Maps to all the properties of the column item

CST_NameCISPFColumnSize

Constant

HEXSPFColumnSize

HEX1SPFColumnSetColumnItem

Maps to the name property of the column item

CST_DescrCISPFColumnSize

Constant

HEXSPFColumnSize

HEX2SPFColumnSetColumnItem

Maps to the description property of the column item

CST_NameCIOrderValue

Constant

HEXOrderValue

HEX1SPFColumnSetColumnItem

Maps to the name property of the column item. Order value provided is 1.

CST_DescrCIOrderValue

Constant

HEXOrderValue

HEX2SPFColumnSetColumnItem

Maps to the description property of the column item. Order value provided is 2.

COMP_DefaultOrderValue

Computed

HEXOrderValue

HEXSPFColumnSetColumnItem

Maps to all the properties of the column item. Order value provided is 20.

CST_NameSortOrder

Constant

HEXSPFSortOrder

HEX1SPFColumnSetColumnItem

Maps to the name property of the column item. SPFSortOrder - e1SortAscending.

Model classification column sets

This mapping is intended to create the column sets which are used to expose the model class specific properties on the applicable forms. This will make the pipe-specific properties to appear on the form for pipe models and so on.

This mapping can be used only if the Create and Query scope is not selected.

  • Use the Load Model Classification Column Sets method to load the model classification column sets.

The below table explain 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 class name

Relation to parent Material Class - Name

Relation

NRA choke valve

Yes

must exist in the system

Specifies the material class to which the property applies.

model part property name

Column Item - Referenced property

Relation

body material specification

Yes

must exist in the system

This is either the internal name or the CFIHOS name of the property, if applicable.

referenced standard

Not mapped, ignored during loading

not applicable

ISO 14224

not applicable

not applicable

International or industry standard that the requirement is sourced from.

As part of CFIHOS mapping enhancements, the delivered MSR mappings are configured to set Display As, Column Size, Order Value, and Sort Order values for the column items and their name/description properties. For more information on how to copy the MSR mappings, see Copy Data Validator master mappings.

You can use the below table to update your HEX mappings with the Display As, Column Size, Order Value, and Sort Order values for the column items and their name/description properties.

  • Update the mappings by mapping the column headers to the SPFColumnDisplayAs property on the SPFColumnSetColumnItem relationship to show the column set column items with Display As information on the dynamic forms.

  • Update the mappings by mapping the column headers to the SPFColumnSize property on the SPFColumnSetColumnItem relationship to set the column size on the column set column items.

  • Update the mappings by mapping the column headers to the Order Value property on the SPFColumnSetColumnItem relationship to set the order value on the column set column items.

  • Update the mappings by mapping the column headers to the SPFSortOrder property on the SPFColumnSetColumnItem relationship to set the sort order to Ascending on the column set column items.

Column header

Column type

Relationship property mappings

Parent relationship

Explanation

COMP_SPFColumnDisplayAs

Computed

HEXSPFColumnDisplayAs

HEXSPFColumnSetColumnItem

Maps to all the properties of the column item

CST_NameCISPFColumnDisplayAs

Constant

HEXSPFColumnDisplayAs

HEX1SPFColumnSetColumnItem

Maps to the name property of the column item

CST_DescrCISPFColumnDisplayAs

Constant

HEXSPFColumnDisplayAs

HEX2SPFColumnSetColumnItem

Maps to the description property of the column item

COMP_SPFColumnSize

Computed

HEXSPFColumnSize

HEXSPFColumnSetColumnItem

Maps to all the properties of the column item

CST_NameCISPFColumnSize

Constant

HEXSPFColumnSize

HEX1SPFColumnSetColumnItem

Maps to the name property of the column item

CST_DescrCISPFColumnSize

Constant

HEXSPFColumnSize

HEX2SPFColumnSetColumnItem

Maps to the description property of the column item

CST_NameCIOrderValue

Constant

HEXOrderValue

HEX1SPFColumnSetColumnItem

Maps to the name property of the column item. Order value provided is 1.

CST_DescrCIOrderValue

Constant

HEXOrderValue

HEX2SPFColumnSetColumnItem

Maps to the description property of the column item. Order value provided is 2.

COMP_DefaultOrderValue

Computed

HEXOrderValue

HEXSPFColumnSetColumnItem

Maps to all the properties of the column item. Order value provided is 20.

CST_NameSortOrder

Constant

HEXSPFSortOrder

HEX1SPFColumnSetColumnItem

Maps to the name property of the column item. SPFSortOrder - e1SortAscending.

Disciplines

This mapping is intended to create document disciplines, which are used to define the owning discipline of documents or to assign the collaborating or reviewing disciplines on documents.

This mapping can be used only if the Create and Query scope is not selected.

  • Use the Load Disciplines method to load the disciplines.

After loading, you must select the disciplines that are to be used on the plant or project. See Manage the plant configuration details and Manage the project configuration details.

The below table explain 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

discipline code

Discipline - Name

Relation

MS

Yes

<=2 characters

A code used to uniquely identify the discipline.

discipline name

Discipline - Description

String

MS Mechanical - Static

No

<=50 characters

The full name of the discipline.

discipline description

Discipline - Long Description

String

Geotechnical is the discipline concerned with the engineering behavior of earth materials.

Yes

<=255 characters

Description of the discipline.

iso15926 part4 unique number

Not mapped, ignored during loading

not applicable

not applicable

not applicable

not applicable

The identifier used in ISO 15926-4 to identify this class uniquely.

CFIHOS unique id

Tag Class - CFIHOS unique id

String

CFIHOS-10000146

No

<=40 characters

If applicable, a unique id number assigned by the CFIHOS project.

Document types and Discipline Document types

  • The document types discipline as per CFIHOS is not loaded as the combined discipline document types. It is loaded as document classifications with a relation to their owning disciplines. As a result, most of the template CSVs are ignored and a split is made to derive the document classes from the document type code discipline.

  • These mappings demands a relation to a discipline, which is CFIHOS specific, and not required when setting up your system in non-CFIHOS mode.

  • These mappings can only create a 1 tier document classification tree, so it cannot create the sub-document classes.

Document types

This mapping is intended to create document classifications which are used to classify documents to indicate the sort of content, such as process engineering flow scheme or isometric drawing.

This mapping can be used only if the Create and Query scope is not selected.

  • Use the Load Document Classifications method to load the document classifications.

The below table explain 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

document type short code

DocumentClassification-CFIHOSPrimKey

Relation

6067

Yes

<=4 characters

the type code that makes up the DDT code

document type name

DocumentClassification-Name

String

Process Engineering Flow Scheme

Yes

<=100 characters

The Name of the Document_Type.

document type description

DocumentClassification-Description

String

Includes P&IDs and Utility Engineering Flow Schemes UEFS.

Yes

<=1026 characters

Description of the Document_Type.

document type classification code

Not mapped, ignored during loading

not applicable

not applicable

not applicable

not applicable

CFIHOS unique id

DocumentClassification-CFIHOSNumber

String

CFIHOS-10000146

<=40 characters

A unique id number assigned by the CFIHOS project.

Discipline Document types

This mapping is intended to establish the relationship between document classifications and disciplines.

This mapping can be used only if the Create and Query scope is not selected.

  • Use the Load Discipline-DocType References method to load the document classifications.

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

discipline code

Discipline - Name

Relation

PX

Yes

<=2 characters

Identify the Discipline to which the Discipline_Document_Type belongs to.

document type short code

DocumentClassification-CFIHOSPrimkey

2365

Yes

<=4 characters

the type code that makes up the DDT code

discipline document type short code

PX2365

<=6 characters

A code used to uniquely identify the Discipline Document_Type.

discipline document type description

Not mapped, ignored during loading

Includes P&IDs and Utility Engineering Flow Schemes UEFS.

<=1026 characters

Description of the Discipline Document_Type.

asset type reference

Not mapped, ignored during loading

N/A

Tag

<=40 characters

Indicate the object type (e.g., Tag, Equipment, Plant) to which a document classified with this document type is making reference to.

required for conceptual design

Not mapped, ignored during loading

not applicable

Yes

<=3 characters

Indicates if the document type is required during the CONCEPTUAL DESIGN phase (Select).

required for project specification

Not mapped, ignored during loading

not applicable

No

<=3 characters

Indicates if the document type is required during the project SPECIFICATION phase (Define).

required for detailed design

Not mapped, ignored during loading

not applicable

No

<=3 characters

Indicates if the document type is required during the DETAILED DESIGN phase (Execute)

required handover status

Not mapped, ignored during loading

not applicable

AFC

<=40 characters

Indicates the required status of the Document at handover time.

required for commissioning

Not mapped, ignored during loading

not applicable

No

<=3 characters

Indicates if the document type is required during the COMMISSIONING phase

required for startup

Not mapped, ignored during loading

not applicable

Yes

<=3 characters

Indicates if the document type is required during STARTUP phase

required for offshore

Not mapped, ignored during loading

not applicable

Yes

<=3 characters

Indicates if this Document Type is required for Off- Shore facilities.

required for onshore

Not mapped, ignored during loading

not applicable

No

<=3 characters

Indicates this Document Type is required for On- Shore facilities.

representation type code

Not mapped, ignored during loading

not applicable

x

<=40 characters

A code used to identify how the Document content should be represented

retention period

Not mapped, ignored during loading

not applicable

Life of Asset

<=10 characters

Indicates the period that the document should be retained regardless the status of the document.

during project transmittal format

Not mapped, ignored during loading

not applicable

AutoCAD

<=40 characters

Indicates the format required during the project.

after project electronic transmittal format

Not mapped, ignored during loading

not applicable

AutoCAD

<=40 characters

Indicates the format required after the project.

review type

Not mapped, ignored during loading

not applicable

N

<=20 characters

Indicates the type of review to be conducted for the documents classified with this document type.

discipline document type comment

Not mapped, ignored during loading

not applicable

21stApril09 update DEP references

<=255 characters

Can be used for notes.

hardcopy document required

Not mapped, ignored during loading

not applicable

Yes

<=3 characters

Specifies if documents classified with this document type require a paper hardcopy.

translated document required

Not mapped, ignored during loading

not applicable

Yes

<=3 characters

Specifies if documents classified with this document type have to be translated in another language.

CFIHOS unique id

Not mapped, ignored during loading

not applicable

CFIHOS-10000146

<=40 characters

A unique id number assigned by the CFIHOS project.