This functionality was modified in an update. For more information, see Reference data mappings (modified in an update).
Examples of reference data 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..
Organizations
This mapping is intended to create an organization.
This mapping can be used only when the Create and Query scopes are not selected.
-
Use the Load Organizations method to load the organizations.
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 |
|---|---|---|---|---|---|---|
|
company name |
Organization - Name |
String |
Flowserve |
Yes |
<=30 characters |
A Name used to uniquely identify the Company. Usually extracted from the Maintenance Management system. |
|
manufacturer indicator |
Organization - Manufacturer |
Boolean Enumlist |
Yes |
Yes |
value is either "yes"or "no" |
If set to Yes, indicates that the company is manufacturing the model part. |
|
supplier indicator |
Organization - Supplier |
Boolean Enumlist |
Yes |
Yes |
value is either "yes"or "no" |
If set to Yes, indicates that the company is supplying the model part. |
|
Company contact person |
Organization - Contact person |
String |
Mr.K.Uchida |
Yes |
<=40 characters |
Indicates the name of the contact person in the company. |
|
Company contact person function |
Organization - Function contact person |
String |
Project Manager |
No |
<=40 characters |
Indicates the role of the contact person within the organization of the company. |
|
Company address line 1 |
Organization - Address line 1 |
String |
6, Water side Business Park Eastways |
Yes |
<=40 characters |
Indicates the first line of the address of the company. |
|
Company address line 2 |
Organization - Address line 2 |
String |
New Braunfels |
No |
<=40 characters |
Indicates the second line of the address of the company. |
|
Company address line 3 |
Organization - Address line 3 |
String |
Tokyo 105-0004 |
No |
<=40 characters |
Indicates the third line of the address of the company. |
|
ISO country code |
Organization - Country |
Relation |
JP |
Yes |
Must be country or enum <=128 characters |
Indicates the country where the company is located. |
|
Company telephone number |
Organization - Telephone number |
String |
+44 (0)1932 249866 |
No |
<=20 characters |
Indicates the official telephone number of the company. |
|
Company fax number |
Organization - Fax number |
String |
+7 095 230 62 44 |
No |
<=20 characters |
Indicates the official fax number of the company. |
|
Company email address |
Organization - Email address |
String |
projectjapanmachinery.com |
No |
<=225 characters |
Indicates the official email address of the company. |
|
contractor |
Organization - Contractor |
Boolean Enumlist |
Yes |
No |
value is either "yes"or "no" |
Non-CFIHOS column to indicate if the organization is a contractor or not. |
|
internal |
Organization - Internal organization |
Boolean Enumlist |
Yes |
No |
value is either "yes"or "no" |
Non-CFIHOS column to indicate if the organization is internal or not. |
|
external |
Organization - External organization |
Boolean Enumlist |
Yes |
No |
value is either "yes"or "no" |
Non-CFIHOS column to indicate if the organization is external or not. |
Purchase orders
This mapping is intended to create a purchase order.
This mapping can be used only when the Create and Query scopes are not selected.
-
Use the Load Purchase Orders method to load the purchase orders.
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 |
|---|---|---|---|---|---|---|
|
purchase order issuer company name |
Organization - Name |
String |
Engineering and co Ltd |
Yes |
Must exist in the system <=30 characters |
Identifies the company issuing the purchase order. |
|
purchase order number |
Purchase order - Name |
Relation |
58 |
Yes |
<=50 characters |
A unique code used to identify the purchase order within the company issuing the purchase order. |
|
purchase order date |
Purchase order - Issue date |
dd-MM-yyyy |
11-01-2019 |
Yes |
Must be a valid date, in the correct format (DD-MM-YYYY) |
Date of issuing the purchase order. |
|
purchase order description |
Purchase order - Description |
Relation |
Revamp project 01 |
Yes |
<=50 characters |
Description of the purchase order. |
|
purchase order receiver company name |
Organization - Name |
String |
Collab Org A |
Yes |
Must exist in the system <=30 characters |
Identifies the company to which the purchase order has been issued. |
Models
This mapping is intended to create a model, which is a catalog item.
This mapping can be used only when the Create and Query scopes are not selected.
-
Use the Load Models method to load the models.
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 |
|---|---|---|---|---|---|---|
|
manufacturer company name |
Organization - Name |
Relation |
Flowserve |
Yes |
<=30 characters |
Identifies the company manufacturer for a particular model part. |
|
model part name |
Model- Name |
String |
A4 V726 PN 40 |
Yes |
<=100 characters |
A unique name to identify the Model Part of the Manufacturer. If the manufacturer creates a new generation of an existing model that affects the properties of it, and if the manufacturer does not change its "model part name", then the "EIS model part name" (for this new generation) should be suffixed with the model date (in order to be able to capture the properties of the "new generation" model). |
|
model description |
Model- Description |
String |
Control valve (Fieldbus) |
Yes |
<=255 characters |
Description of the main function of the model part. |
|
equipment class name |
Material Classification - Name |
Relation |
RA globe valve |
Yes |
<=100 characters |
Classifies the model part with an equipment class. |
Model properties
This mapping is intended to update already existing models (catalog item) with design properties.
This mapping can be used only when the Create and Query scopes are not selected.
-
Use the Load Model Properties method to load the properties on top of existing models.
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 |
|---|---|---|---|---|---|---|
|
manufacturer company name |
Organization - Name |
Relation |
Flowserve |
Yes |
Must exist in the system <=30 characters |
Identifies the company manufacturer of a particular model part. |
|
model part name |
Model- Name |
String |
Mark One |
Yes |
Must exist in the system <=100 characters |
Identifies the model part having this property value. |
|
property name |
Model- [provided property name] |
String |
normal operating pressure |
Yes |
Property must exist for models <=100 characters |
Identifies the property for which a value is provided for this model part. |
|
property value |
Model - [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 |
Model - [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 |
Unit of measure. |
Documents (HxGN SDx)
This mapping is intended to create or revise a document.
This mapping can be used only if the Create and Query scope is set to an SDx plant or project.
-
Use Load Documents (HxGN SDx) method to load new or revised documents.
-
You can load multiple revisions of the same document using a single CSV file. Data Validator creates the revisions in the target system as per the issue date for each revision mentioned in the CSV file.
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 |
|---|---|---|---|---|---|---|
|
Document Number |
Document - Name |
String |
C-INGR.HSV-AB-001-DS-0051 |
Yes |
<=128 characters |
The unique identifier for the document according to the Owner/Operator document numbering scheme. |
|
Revision |
Document – SPFExternalRevision |
String |
01C |
No |
<=128 characters |
The specific revision for which the additional file is intended. |
|
Issue Date |
Document – Contractor’s issue date |
dd-MMM-yy |
25-Jan-18 |
No |
If provided, must be a valid date, in the correct format |
The date of issue of the Document by the author. A collaboration rule checks that this is populated. |
|
Document Title |
Document – Description |
String |
DATASHEET FOR 230-FC-4501-00 |
No |
<=128 characters |
Describes in a short and concise manner the content of the document. The title of the document usually appears on the front page of the document. |
|
Classification |
Relation between Classification and Document Number |
Relation |
Reference |
Yes |
Must exist in the system |
Name of the document's primary classification. |
|
WBSCode |
Relation between Document Number and WBSCode |
Relation |
0 |
No |
Must exist in the system |
Identifies the WBS work package. |
|
FEEDCode |
Relation between Document Number and FEEDCode |
Relation |
0 |
No |
Must exist in the system |
Identifies the FEED work package. |
|
Vendor Package |
Relation between Document Number and Vendor Package |
Relation |
No |
|||
|
Alternate Document Number |
Document - SDAOriginatorsDocName |
String |
No |
<=128 characters |
||
|
Alternate Revision Number |
Document - SDAOriginatorsDocRev |
String |
No |
<=128 characters |
||
|
Discipline |
Relation between Document Number and Discipline |
Relation |
MECH-V |
No |
Must exist in the system |
A code used to uniquely identify the discipline. |
|
Contract |
Relation between Vendor Package and Contract |
Relation |
No |
Must exist in the system |
This is the name of the contract. |
|
|
Area |
Relation between DocRevision and Area |
Relation |
20 |
Yes |
Must exist in the system |
This is the name of your area. |
|
Unit |
Relation between DocRevision and Unit |
Relation |
No |
Must exist in the system |
This is the name of your unit. |
|
|
Issue Purpose |
Relation between DocRevision and Issue Purpose |
Relation |
IFC |
No |
Must exist in the system |
The type of the issue purpose that shall be related to the document revision. |
|
File Name |
Relation between document and the physical file |
Relation |
C-INGR.HSV-AB-001-DS-002.doc |
No |
File name including file extension for the physical/electronic file that shall be attached as primary file to the document revision. |
Tags (HxGN SDx)
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 (HxGN SDx) 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 |
|---|---|---|---|---|---|---|
|
Name |
Tag - Name |
String |
230-4501-111 |
Yes |
<=128 characters |
The name of your tag. |
|
Description |
Tag - Description |
String |
SILENCER |
No |
<=128 characters |
The description of the tag. |
|
Type |
Tag - Type |
Relation |
Tool |
Yes |
Must exist in the system |
The primary classification of the tag. |
|
CriticalityRating |
Tag - CriticalityRating |
Enumlist I/II/III/IV |
I |
No |
Identifies the enum type property on the tag object. |
|
|
Contractor |
Relation between Name and Contractor |
Relation |
No |
Must exist in the system |
The name of the originating organization. |
|
|
Contract |
Relation between Name and Contract |
Relation |
C-INGR.HSV-AB-000 |
No |
Must exist in the system |
Identifies the contract. |
|
Area |
Relation between Name and Area |
Relation |
20 |
Yes |
Must exist in the system |
This is the name of your area. |
|
Unit |
Relation between Name and Unit |
Relation |
230 |
Yes |
Must exist in the system |
This is the name of your unit |
Work package
This mapping is intended to create a work package.
This mapping can be used only if the Create and Query scope is set to an SDx plant or project.
-
Use Load Workpackages method to load the work packages.
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 |
|---|---|---|---|---|---|---|
|
Name |
Workpackage - Name |
String |
1000 |
Yes |
<=128 characters |
The name of your work package. |
|
Description |
Workpackage - Description |
String |
Materials Handling |
No |
<=128 characters |
The description of the work package. |
|
Classification |
Relation between Classification and Name |
Relation |
WBS |
Yes |
Must exist in the system |
The primary classification of the work package. |
|
Contract |
Relation between Name and Contract |
Relation |
C-INGR.HSV-AB-000 |
No |
Must exist in the system |
Identifies the contract. |
|
Discipline |
Relation between Name and Discipline |
Relation |
No |
Must exist in the system |
A code used to uniquely identify the discipline. |
|
|
Parent Workpackage |
Relation between Parent Workpackage and Name |
Relation |
0 |
No |
Must exist in the system |
Name of the work package which shall be set as the parent for the current child work package. |