The following applies if you are using a version of the software before Update 24. For the latest information, see Reference data mappings.
Before Update 6
Documents (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 (SDx) method to load new or revised documents.
The below table mentions the column header removed from the mapping:
Column name |
Mapping |
Type |
Example |
Required |
Validation |
Explanation |
---|---|---|---|---|---|---|
Is Sharable |
Document - SCLBIsOKToShareWithOtherOrgs |
String True/False |
No |
Based on this flag, a company user can set the collaboration organization. The Is Shareable column header has been removed for use from the SDx system. However, systems that are upgraded from an earlier update will still have the Is Shareable column header. |
Between Update 6 and Update 24
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 |
Hexagon |
Yes |
<30 characters |
A Name used to uniquely identify the Company. Usually extracted from the Maintenance Management system. |
manufacturer |
Organization - Manufacturer |
Yes/no Enumlist |
no |
No |
value is either "yes"or "no" |
If set to Yes, indicates that the company is manufacturing the model part. |
supplier |
Organization - Supplier |
Yes/no Enumlist |
no |
No |
value is either "yes"or "no" |
If set to Yes, indicates that the company is supplying the model part. |
contact person |
Organization - Contact person |
String |
Nick Fury |
No |
<40 characters |
Indicates the name of the primary contact person in the company. |
function contact person |
Organization - Function contact person |
String |
Head of Document management |
No |
<40 characters |
Indicates the role of the contact person within the organization of the company. |
address line 1 |
Organization - Address line 1 |
String |
305 Intergraph Way |
No |
<40 characters |
Indicates the first line of the address of the company. |
address line 2 |
Organization - Address line 2 |
String |
AL 35758 |
No |
<40 characters |
Indicates the second line of the address of the company. |
address line 3 |
Organization - Address line 3 |
String |
Madison |
No |
<40 characters |
Indicates the third line of the address of the company. |
country |
Organization - Country |
String |
USA |
No |
<128 characters |
Indicates the country where the company is located. |
telephone |
Organization - Telephone number |
String |
+18007667701 |
No |
<20 characters |
Indicates the official telephone number of the company. |
fax number |
Organization - Fax number |
String |
+12567303300 |
No |
<20 characters |
Indicates the official fax number of the company. |
email address |
Organization - Email address |
String |
crm@hexagon.com |
No |
<225 characters |
Indicates the official email address of the company. |
contractor |
Organization - Contractor |
Yes/no Enumlist |
no |
No |
value is either "yes"or "no" |
Non-CFIHOS column to indicate if the organization is a contractor or not. |
internal |
Organization - Internal organization |
Yes/no 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 |
Yes/no Enumlist |
no |
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 |
Hexagon |
Yes |
Must exist in the system |
Identifies the company issuing the purchase order. |
purchase order code |
Purchase order - Name |
Relation |
PO-001 |
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 |
No |
Must be a valid date, in the correct format |
Date of issuing the purchase order. |
purchase order description |
Purchase order - Description |
Relation |
Revamp project 01 |
No |
<50 characters |
Description of the purchase order. |
purchase order receiver company name |
Organization - Name |
String |
Collab Org A |
Yes |
Must exist in the system |
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 |
Manufacturer A |
Yes |
Must exist in the system |
Identifies the company manufacturer for a particular model part. |
model part name |
Model- Name |
String |
MOD-100001 |
Yes |
<100 characters |
A unique name to identify the model part of the Manufacturer. This name is unique per manufacturer, not cross-manufacturers. |
model description |
Model- Description |
String |
NRA valve type AB/CD |
Yes |
<255 characters |
Description of the main function of the model. |
equipment class name |
Material Classification - Name |
Relation |
NRA choke valve |
Yes |
Must exist in the system |
Classifies the model with a material classification. |
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 |
Manufacturer A |
Yes |
Must exist in the system |
Identifies the company manufacturer of a particular model part. |
model part name |
Model- Name |
String |
MOD-100003 |
Yes |
Must exist in the system |
Identifies the model part having this property value. |
property name |
Model- [provided property name] |
String |
nominal diameter |
Yes |
Property must exist for models |
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 |
1.0 |
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 |
Mode - [provided property UoM] |
Depends on the provided property name |
m |
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 |
Unit of measure. |