The following applies if you are using a version of the CFIHOS mappings prior to Version 1.4. For the latest information, see Document mappings.
Examples of document mapping CSV files in CFIHOS or non-CFIHOS format (and any related physical files) are available for you to use and modify on Smart Community. For more information, see Find sample data on Smart Community.
Documents (CFIHOS)
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 (CFIHOS) method to load new or revised documents.
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 |
77-EA-EMS-P-7701A |
Yes |
<40 characters |
The unique identifier for the document according to the Owner/Operator document numbering scheme. |
revision code |
Document – Revision code/Major Revision/Minor Revision |
String |
01A |
Yes |
Revision code must be supported by the revision scheme as defined in your SDx system |
A code used to identify the content of a document at a certain point in time. It is used to track the evolution of a document during its lifecycle. |
document title |
Document – Description |
String |
Single line diagram 7701A |
No |
<255 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. |
issue date |
Document – Contractor’s issue date / Sign Off Date (SPFRevIssueDate) |
dd-MM-yyyy |
01-01-2019 |
No |
If provided, must be a valid date, in the correct format |
The date of issue of the Document by the author. |
originator company |
Relation to Organization |
Relation |
Collab Org A |
Yes |
Must exist in the system |
Identifies the name of the Company who has generated the Document. |
author |
Document- Author |
String |
Chris Redfield |
No |
<70 characters |
Name of the person who created the document content. |
approved by |
Document - Approved by |
Wille E. Coyote |
No |
<50 characters |
Name or UserID of the person who has approved the Document. |
|
file name |
Relation between the document and the physical file |
Relation |
77-EA-EMS-P-7701A.pdf |
No |
File must be available for upload along with the document metadata. Filename+extension of the electronic file must be fully specified in the input file. |
File name including file extension for the physical/electronic file tat shall be attached as primary file to the Document revision. |
originator document number |
Document- Originator's document name |
org-doc-001 |
No |
<40 characters |
The unique identifier for the Document according to the Originator document numbering scheme. |
|
originator document revision code |
Document- Originator's document revision |
001 |
No |
<5 characters |
The revision code as per the Originator document revision scheme. |
|
originator file name |
Document- Originator's file name |
org filename-A |
No |
<255 characters |
The file name as the electronic file has on the originator document’s end. |
|
document status code |
Document- Revision status |
Enumlist |
approved for construction |
No |
Value must be a part of the revision status enumlist |
A code used to indicate the life cycle status of the document. |
language |
Document- Language code |
Enumlist |
English |
No |
Value must be a part of the revision language enumlist |
Indicates the primary language that the document is written in. |
discipline document type short code |
Relation to discipline and to document classification |
Relation |
EA 2384 or EA~2365 |
Yes |
Discipline must exist and document class must exist. If the first 2 characters are found as discipline, the remaining part is assumed to be the document class. In case of non-2-digit disciplines, the split is done based on a "~" separator symbol between the discipline and document class. |
Classifies the document with a document classification and relating the originating discipline. The concatenated value is split out into a separate discipline and document classification. |
project name |
not applicable |
No |
||||
document comment |
Document - Originator's comments |
String |
comment X |
No |
<255 characters |
Indicates any additional Comment / Explanation for a document revision. |
plant code |
not applicable |
No |
||||
export control classification |
Document - Export control class |
Enumlist |
controlled content |
No |
Value must be a part of the controlled content enumlist |
Indicates the Export Control Rule applicable for the Document (for example, ECCN, EAR). |
transmittal number |
Document - Transmittal number |
String |
XMTL-001 |
No |
<100 characters |
A unique transmittal identifier generated by the document control system of the company sending the transmittal. |
security classification |
Document - Security class |
Enumlist |
confidential |
No |
Value must be a part of the security class enumlist |
Indicates the security classification applicable for the document. |
valid from |
Document - Valid from |
dd-MM-yyyy |
18-01-2018 |
No |
If provided, must be a valid date, in the correct format |
Indicates the date from which the document is valid for usage. |
valid until |
Document - Valid until |
dd-MM-yyyy |
17-01-2019 |
No |
If provided, must be a valid date, in the correct format |
Indicates the date on which the document validity expires. |
recipient |
Document - Recipient |
String |
recipient X |
No |
<70 characters |
The full name of the recipient of the document. |
review date |
not applicable |
dd-MM-yyyy |
No |
If provided, must be a valid date, in the correct format |
The date on which the document has to be reviewed. |
|
physical storage location |
Document - Physical storage location |
String |
Cabinet X shelf 1 |
No |
<40 characters |
The location of a media when not stored as, or stored in addition to an electronic file. When this field is populated the field FILE_NAME shall be left empty, for example, Box number 20. |
storage media |
Document - Storage media |
Enumlist |
DVD |
No |
Value must be a part of the storage media enumlist |
Indicate the media type used for storing the content. |
project stage code |
Document - Project stage code |
Enumlist |
C |
No |
Value must be a part of the project stage code enumlist |
A code used to identify the project stage in which the document is created/modified. |
Document set of files
This mapping is intended to add additional files to an existing document, that is a revision.
This mapping can be used only if the Create and Query scope is set to an SDx plant or project.
-
Use Load Document Set of files method to load additional files for existing document revisions.
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 |
Relation |
77-EA-EMS-P-7701A |
Yes |
Must exist in the system |
The document number for which the additional file is intended. |
revision code |
Document – Revision code |
Relation |
01A |
Yes |
A specific revision for the document number must exist |
The specific revision for which the additional file is intended. |
file title |
File – Description |
String |
Maintenance of Shut-Off-Valve dummy file |
No |
Not applicable |
Describes in a short and concise manner the content of the document. |
file name |
File - Name |
String |
1011-M-002-Maintenance of Shut-Off-Valve dummy file.pdf |
Yes |
A file must be available for upload along with the document metadata. Filename+extension of the electronic file must be fully specified in the input file. |
File name including the file extension for the physical or electronic file that shall attached as an additional file to the document revision. |
storage media |
not applicable |
No |
||||
language |
not applicable |
No |
Doc-Tag references
This mapping is intended to create document revision references tag relations between document revisions and tags.
This mapping can be used only if the Create and Query scope is set to an SDx plant or project.
-
Use Load Doc-tag references method to load the relations between existing document revisions and 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 |
---|---|---|---|---|---|---|
document number |
Document - Name |
Relation |
77-EA-EMS-P-7701A |
Yes |
Must exist in the system |
Identifies the document number for which the tag reference is intended. |
revision code |
Document – Revision code |
Relation |
01A |
Yes |
A specific revision for the document number must exist in the selected create scope |
The specific revision for which the tag reference is intended. |
plant code |
Relation to SDx plant or plant code of the tag |
Relation |
CEX |
Yes |
Must exist in the system |
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 |
The name of the tag that is referenced by the document revision. |
Doc-Asset references
This mapping is intended to create document revision references asset relations between document revisions and assets, that is physical or installed items.
This mapping can be used only if the Create and Query scope is set to an SDx plant or project.
-
Use Load Doc-asset references method to load the relations between existing document revisions and 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 |
---|---|---|---|---|---|---|
document number |
Document - Name |
Relation |
77-EA-EMS-P-7701A |
Yes |
Must exist in the system |
Identifies the document number for which the asset reference is intended. |
revision code |
Document – Revision code |
Relation |
01A |
Yes |
A specific revision for the document number must exist in the selected create scope |
The specific revision for which the asset reference is intended. |
equipment identifier |
Asset - Name |
Relation |
qp-234401 |
Yes |
Must exist in the system |
The name of the asset that is referenced by the document revision. |
Doc-Model references
This mapping is intended to create document revision references model relations between document revisions and models, that is catalog items.
This mapping can be used only if the Create and Query scope is set to an SDx plant or project.
-
Use Load Doc-model references method to load the relations between existing document revisions and 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 |
---|---|---|---|---|---|---|
document number |
Document - Name |
Relation |
77-EA-EMS-P-7701A |
Yes |
Must exist in the system |
Identifies the document number for which the tag reference is intended. |
revision code |
Document – Revision code |
Relation |
01A |
Yes |
A specific revision for the document number must exist in the selected create scope |
The specific revision for which the tag reference is intended. |
manufacturer company name |
Relation to SDx plant or plant code of the model |
Relation |
Manufacturer A |
Yes |
Must exist in the system |
Identifies the company manufacturer for a particular model part. |
model part name |
Model - Name |
Relation |
MOD-100001 |
Yes |
Must exist in the system |
The name of the model part that is referenced by the document revision. |
Doc-Doc references
This mapping is intended to create document revision references document revision relations between document revisions and other document revisions.
This mapping can be used only if the Create and Query scope is set to an SDx plant or project.
-
Use Load Doc-Doc references method to load the relations between existing document revisions and other existing document revisions.
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 |
Relation |
77-EA-EMS-P-7701A |
Yes |
Must exist in the system |
Identifies the document number for which the tag reference is intended. |
revision code |
Document – Revision code |
Relation |
01A |
Yes |
A specific revision for the document number must exist in the selected create scope |
The specific revision for which the tag reference is intended. |
referenced document number |
Referenced Document - Name |
Relation |
1211-ENG-PID-M-0001 |
Yes |
Must exist in the system |
Identifies the referenced document number. |
referenced revision code |
Referenced Document- Revision code |
Relation |
01A |
Yes |
A specific revision for the referenced document number must exist in the selected create scope |
The specific revision for the referenced document revision. |
Doc-PO references
This mapping is intended to create document revision references purchase order relations between document revisions and purchase orders.
This mapping can be used only if the Create and Query scope is set to an SDx plant or project.
-
Use Load Doc-PO references method to load the relations between existing document revisions and 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 |
---|---|---|---|---|---|---|
document number |
Document - Name |
Relation |
77-EA-EMS-P-7701A |
Yes |
Must exist in the system |
Identifies the document number for which the tag reference is intended. |
revision code |
Document – Revision code |
Relation |
01A |
Yes |
A specific revision for the document number must exist in the selected create scope |
The specific revision for which the tag reference is intended. |
po issuer company name |
Organization - Name |
Relation |
Hexagon |
Yes |
Must exist in the system |
Identifies the company issuing the purchase order. |
po code |
Purchase Order - Name |
Relation |
PO-001 |
Yes |
Must exist in the system |
The name of the purchase order that is referenced by the document revision. |
Doc-Unit references
This mapping is intended to create document revision references unit relations between document revisions and units.
This mapping can be used only if the Create and Query scope is set to an SDx plant or project.
-
Use Load Doc-unit references method to load the relations between existing document revisions and units.
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 |
Relation |
77-EA-EMS-P-7701A |
Yes |
Must exist in the system |
Identifies the document number for which the tag reference is intended. |
revision code |
Document – Revision code |
Relation |
01A |
Yes |
A specific revision for the document number must exist in the selected create scope |
The specific revision for which the tag reference is intended. |
plant code |
Relation to SDx plant or plant code of the unit |
Relation |
CEX |
Yes |
Must exist in the system |
Specifies which SDx plant or plant code the unit is a part of. |
process unit code |
Unit - Name |
Relation |
CT |
Yes |
Must exist in the system |
The name of the unit that is referenced by the document revision. |
Doc-Location references
This mapping is intended to create document revision references location relations between document revisions and locations.
This mapping can be used only if the Create and Query scope is set to an SDx plant or project.
-
Use Load Doc-Location references method to load the relations between existing document revisions and locations.
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 |
Relation |
77-EA-EMS-P-7701A |
Yes |
Must exist in the system |
Identifies the document number for which the tag reference is intended. |
revision code |
Document – Revision code |
Relation |
01A |
Yes |
A specific revision for the document number must exist in the selected create scope |
The specific revision for which the tag reference is intended. |
plant code |
Relation to SDx plant or plant code of the unit |
Relation |
CEX |
Yes |
Must exist in the system |
Specifies which SDx plant or plant code the location is a part of. |
area code |
Location - Name |
Relation |
CEX-SGRN |
Yes |
Must exist in the system |
The name of the location that is referenced by the document revision. |