The following applies if you are using a version of the CFIHOS mappings prior to Version 1.4. For the latest information, see System setup mappings.
Examples of system setup 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. Sample CSV files with pre-defined content of the CFIHOS RDL v1.3 can also be found in the 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 |
Valve instrument |
Yes |
must exist in the system or is part of the same load |
|
tag class name |
Tag Class - Name |
String |
NRA choke valve |
Yes |
<100 characters |
This is the code or name of your tag class. |
tag class definition |
Tag Class - Description |
String |
A valve not designed to regulate the flow, that is on or off. A valve which obstructs the fluid passing inside and has the ability to reduce the pressure from the inlet port to the outlet port. Includes an actuator that needs auxiliary power to operate. |
No |
<1026 characters |
This is the description or human readable name of the tag class. |
abstract class flag |
Tag Class - Abstract Class |
Yes/No Enumlist |
No |
No |
value is either "yes" or "no" |
To indicate if this is a leaf node (non-abstract class) or a parent node (abstract class). |
ISO15926 part4 unique number |
Tag Class - ISO15926 part4 unique number |
String |
1905 |
No |
<40 characters |
If applicable, the identifier used in ISO15926-4 to identify this class uniquely. |
CFIHOS unique id |
Tag Class - CFIHOS unique id |
String |
CFIHOS-30000143 |
No |
<40 characters |
If applicable, a unique id number assigned by the CFIHOS project. |
unique id STEPLIB |
Tag Class - Unique id STEPLIB |
String |
820037 |
No |
<40 characters |
If applicable, the identifier used in Steplib to identify this class uniquely. |
unique id POSC CAESAR |
Tag Class - Unique id POSC CAESAR |
String |
RDS292364 |
No |
<40 characters |
If applicable, the identifier used in POSC Caesar to identify this class uniquely. |
referenced standard |
Tag Class - Referenced standard |
String |
[The standard name] |
No |
<256 characters |
If 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 |
Yes/No Enumlist |
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 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. |
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. |
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 |
must exist in the system or is part of the same load |
Specifies the parent of the Material class in the hierarchy. In case there is no parent, this field shall be left empty which will relate it to the "Material Types" Top grouping level in SDx. |
equipment class name |
Material Class - Name |
String |
NRA choke valve |
Yes |
<100 characters |
This is the code or name of your Material Class. |
equipment class definition |
Material Class - Description |
String |
A valve not designed to regulate the flow, that is on or off. A valve which obstructs the fluid passing inside and has the ability to reduce the pressure from the inlet port to the outlet port. Includes an actuator that needs auxiliary power to operate. |
No |
<1026 characters |
This is the description or human readable name of the Material Class. |
abstract class flag |
Material Class - Abstract Class |
Yes/No Enumlist |
No |
No |
Value is either "yes" or "no" |
To indicate if this is a leaf node (non-abstract class) or a parent node (abstract class). |
ISO15926 part4 unique number |
Material Class - ISO15926 part4 unique number |
String |
1905 |
No |
<40 characters |
If applicable, the identifier used in ISO15926-4 to identify this class uniquely. |
CFIHOS unique id |
Material Class - CFIHOS unique id |
String |
CFIHOS-30000143 |
No |
<40 characters |
If applicable, a unique id number assigned by the CFIHOS project. |
unique id STEPLIB |
Material Class - Unique id STEPLIB |
String |
820037 |
No |
<40 characters |
If applicable, the identifier used in Steplib to identify this class uniquely. |
unique id POSC CAESAR |
Material Class - Unique id POSC CAESAR |
String |
RDS292364 |
No |
<40 characters |
If applicable, the identifier used in POSC-CAESAR to identify this class uniquely. |
referenced standard |
Material Class - Referenced standard |
String |
[The standard name] |
No |
<255 characters |
If applicable, International or Industry Standard that requirement is sourced from. |
spare part info required |
Material Class - Spare part info required |
Yes/No Enumlist |
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 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. |
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. |
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 13705:2006 |
not applicable |
not applicable |
International or industry standard that the requirement is sourced from. |
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 |
CG |
Yes |
<2 characters |
A code used to uniquely identify the discipline. |
discipline name |
Discipline - Description |
String |
Geotechnical/Foundation |
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. |
No |
<255 characters |
Description of the discipline. |
ISO15926 part4 unique number |
Discipline - ISO15926 part4 unique number |
String |
[ISO15926 Part4 Number] |
No |
<40 characters |
If applicable, the identifier used in ISO15926-4 to identify this property uniquely. |
CFIHOS unique id |
Tag Class - CFIHOS unique id |
String |
CFIHOS-30000143 |
No |
<40 characters |
If applicable, a unique id number assigned by the CFIHOS project. |
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 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.
-
This mapping demands a relation to a discipline, which is CFIHOS specific, and not required when setting up your system in non-CFIHOS mode.
-
This mapping can only create a 1 tier document classification tree, so it cannot create the sub-document classes.
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 |
CG |
Yes |
must exist in the system |
Identify the discipline to which the discipline document type belongs to. |
discipline document type short code |
Document classification - CFIHOS key |
Yes |
A code used to uniquely identify the discipline document class. This is the key that needs to be used in the CFIHOS document handover registers to indicate the classification of documents. |
|||
document type name |
Document classification - Name |
Yes |
The name of the document class. |
|||
discipline document type description |
Not mapped, ignored during loading |
not applicable |
not applicable |
not applicable |
not applicable |
|
asset type reference |
Not mapped, ignored during loading |
N/A |
not applicable |
not applicable |
not applicable |
|
required for conceptual design |
Not mapped, ignored during loading |
not applicable |
not applicable |
not applicable |
not applicable |
|
required for project specification |
Not mapped, ignored during loading |
not applicable |
not applicable |
not applicable |
not applicable |
|
required for detailed design |
Not mapped, ignored during loading |
not applicable |
not applicable |
not applicable |
not applicable |
|
required handover status |
Not mapped, ignored during loading |
not applicable |
not applicable |
not applicable |
not applicable |
|
required for commissioning |
Not mapped, ignored during loading |
not applicable |
not applicable |
not applicable |
not applicable |
|
required for commissioning status |
Not mapped, ignored during loading |
not applicable |
not applicable |
not applicable |
not applicable |
|
required for startup |
Not mapped, ignored during loading |
not applicable |
not applicable |
not applicable |
not applicable |
|
required for startup status |
Not mapped, ignored during loading |
not applicable |
not applicable |
not applicable |
not applicable |
|
required for offshore |
Not mapped, ignored during loading |
not applicable |
not applicable |
not applicable |
not applicable |
|
required for onshore |
Not mapped, ignored during loading |
not applicable |
not applicable |
not applicable |
not applicable |
|
representation type code |
Not mapped, ignored during loading |
not applicable |
not applicable |
not applicable |
not applicable |
|
storage type code |
Not mapped, ignored during loading |
not applicable |
not applicable |
not applicable |
not applicable |
|
security classification |
Not mapped, ignored during loading |
not applicable |
not applicable |
not applicable |
not applicable |
|
retention period |
Not mapped, ignored during loading |
not applicable |
not applicable |
not applicable |
not applicable |
|
during project format |
Not mapped, ignored during loading |
not applicable |
not applicable |
not applicable |
not applicable |
|
during project whyhaveit |
Not mapped, ignored during loading |
not applicable |
not applicable |
not applicable |
not applicable |
|
after project livenonlive |
Not mapped, ignored during loading |
not applicable |
not applicable |
not applicable |
not applicable |
|
after project format |
Not mapped, ignored during loading |
not applicable |
not applicable |
not applicable |
not applicable |
|
after project whyhaveit |
Not mapped, ignored during loading |
not applicable |
not applicable |
not applicable |
not applicable |
|
review type |
Not mapped, ignored during loading |
not applicable |
not applicable |
not applicable |
not applicable |
|
internal standard reference |
Not mapped, ignored during loading |
not applicable |
not applicable |
not applicable |
not applicable |
|
document type comment |
Not mapped, ignored during loading |
not applicable |
not applicable |
not applicable |
not applicable |
|
hardcopy document required |
Not mapped, ignored during loading |
not applicable |
not applicable |
not applicable |
not applicable |
|
translated document required |
Not mapped, ignored during loading |
not applicable |
not applicable |
not applicable |
not applicable |
|
as built document required |
Not mapped, ignored during loading |
not applicable |
not applicable |
not applicable |
not applicable |
|
iso15926 part4 unique number |
Not mapped, ignored during loading |
not applicable |
not applicable |
not applicable |
not applicable |
|
CFIHOS unique id |
Not mapped, ignored during loading |
not applicable |
not applicable |
not applicable |
not applicable |
|
unique id Steplib |
Not mapped, ignored during loading |
not applicable |
not applicable |
not applicable |
not applicable |
Relationship mappings for tag, asset, and model classification column sets
You can configure your HEX mappings to map the below relationship attribute mappings to the SPFColumnDisplayAs, SPFColumnSize, Order Value, and SPFSortOrder properties on columnset column items.
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. |