This functionality was modified in an update. For more information, see Document mappings (modified in an update).
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 |
T-10000001 |
Yes |
<=40 characters |
The unique identifier for the document according to the Owner/Operator document numbering scheme. |
document revision code |
Document – Revision code/Major Revision/Minor Revision |
String |
1 |
Yes |
Revision code must be supported by the revision scheme as defined in your HxGN SDx system <=3 characters |
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 Non CFIHOS column - this is on the doc master register in CFIHOS |
String |
PEFS Crude Oil Booster Pumps |
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. |
document revision date |
Document – Contractor’s issue date / Sign Off Date (SPFRevIssueDate) |
dd-MM-yyyy |
01-01-2019 |
yes |
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 |
Engineering and co Ltd |
Yes |
Must exist in the system <=40 characters |
Identifies the name of the Company who has generated the Document. |
document revision author |
Document- Author |
String |
Chris Redfield |
No |
<=70 characters |
Name of the person who created the document content. |
document revision approver |
Document - Approved by |
Wille E. Coyote |
No |
<=50 characters |
Name or UserID of the person who has approved the Document. |
|
document revision file name |
Relation between the document and the physical file |
Relation |
\6000\6000-P-36-03-D-8120-01-D-01.pdf |
Yes |
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. <=255 characters |
The name of the electronic file (including the file extension) with the full path. The file name shall consist of the document number, Document revision and a sequence number followed by the file extension. When this field is populated the field PHYSICAL_STORAGE_LOCATION shall be left empty. |
originator document number |
Document- Originator's document name |
String |
ECO-001-0045-978 |
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 |
String |
001 |
No |
<=5 characters |
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. |
originator file name |
Document- Originator's file name |
String |
org filename-A |
No |
<=255 characters |
The name of the file (including the file extension) with the full path of the document as provided by a manufacturer. This document shall not contain any project specific cover page, but only the manufacturer cover page. The file name shall consist of the document number, document revision, and a sequence number followed by the file extension. Contains the full path file name. |
document status code |
Document- Revision status |
Enumlist |
as built |
Yes |
Value must be a part of the revision status enumlist <=400 characters |
A code used to indicate the life cycle status of the document. |
ISO language code |
Document- Language code |
Enumlist |
English |
No |
Value must be a part of the revision language enumlist <=40 characters |
Indicates the primary language that the document is written in. |
discipline document type short code |
Relation |
PX2365 |
No |
<=6 characters |
Classifies the Document with a Discipline_Document_Type. |
|
project name |
not applicable |
FPS0 B23 |
No |
<=50 characters |
A unique name used to identify the Project. |
|
document revision comment |
Document - Originator's comments |
String |
Does not include package A-1001 |
No |
<=255 characters |
Indicates any additional Comment / Explanation for a document revision. |
plant code |
not applicable |
String |
6000 |
Yes |
Must exist in the system <=40 characters |
Identifies the Plant that the document is related to. This is a very "high level" grouping of documents used to segregate documents dealing with different Plants. "Low level" document references shall also be provided for the Document |
export control classification |
Document - Export control class |
Enumlist |
controlled content |
No |
Value must be a part of the controlled content enumlist <=40 characters |
Indicates the Export Control Rule applicable for the Document (for example, ECCN, EAR). |
transmittal number |
Document - Transmittal number |
String |
FFDF-2007-0071-TE-SH-KW-01149 |
No |
<=100 characters |
A unique transmittal identifier generated by the document control system of the company sending the transmittal. |
document revision recipient |
Document - Recipient |
String |
recipient X |
No |
<=70 characters |
The full name of the recipient of the document. |
actual review date |
Document - Review Due Date |
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. |
|
actual approval date |
dd-MM-yyyy |
No |
If provided, must be a valid date, in the correct format |
The date at which the document has been issued for approval. |
||
actual approved for design date |
dd-MM-yyyy |
No |
If provided, must be a valid date, in the correct format |
The date at which the document has been issued approved for design. |
||
actual approved for construction date |
dd-MM-yyyy |
No |
If provided, must be a valid date, in the correct format |
The date at which the document has been issued approved for construction. |
||
actual as built date |
dd-MM-yyyy |
No |
If provided, must be a valid date, in the correct format |
The date at which the document has been issued as-built. |
||
document revision physical storage location |
Document - Physical storage location |
String |
Box1523 |
No |
<=40 characters |
The location of a media when not stored as an electronic file. When this field is populated the field FILE_NAME shall be left empty, e.g., Box number 20 |
storage media |
Document - Storage media |
Enumlist |
Paper |
No |
Value must be a part of the storage media enumlist <=20 characters |
Indicate the media type used for storing the content. |
project stage |
Document - Project stage code |
Enumlist |
C |
No |
Value must be a part of the project stage code enumlist 1 character |
A code used to identify the project stage in which the document is created/modified. |
regulatory required indicator |
Document - Regulatory Indicator |
Boolean Yes or no |
No |
An indication whether this document is to be developed to meet regulatory compliance requirements. |
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 |
T-10000001 |
Yes |
Must exist in the system <=40 characters |
The unique identifier for the Document according to the Owner/Operator Document numbering scheme. |
document revision code |
Document – Revision code |
Relation |
1 |
Yes |
A specific revision for the document number must exist <=3 characters |
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. |
file title |
File – Description |
String |
PEFS Crude Oil Booster Pumps (Native) |
Yes |
Not applicable <=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. The FILE_TITLE shall be unique within a particular document revision. Refer to the DEP EIS chapter "Set of Files" in order to allocate a correct FILE_TITLE. |
file name |
File - Name |
String |
T-10000001_001_001.dwg |
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. <=255 characters |
The name of the electronic file (including the file extension) with the full path. The file name shall consist of the document number, Document revision and a sequence number followed by the file extension. When this field is populated the field PHYSICAL_STORAGE_LOCATION shall be left empty. |
storage media |
not applicable Map the property & picklist on the File object to specify the storage media |
Paper |
No |
<=20 characters |
Indicates the media type used for storing the content. |
|
ISO language code |
not applicable |
English |
No |
<=40 characters |
Indicates the primary language that the document is written in. |
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 |
T-10000001 |
Yes |
Must exist in the system <=40 characters |
The unique identifier for the Document according to the Owner/Operator Document numbering scheme. |
revision code |
Document – Revision code |
Relation |
1 |
Yes |
A specific revision for the document number must exist in the selected create scope <=3 characters |
Identify the references made by a Document to a Tag |
plant code |
Relation to HxGN SDx plant or plant code of the tag |
Relation |
6000 |
Yes |
Must exist in the system <=40 characters |
A Plant contains many tags. A tag is part of one Plant. |
tag name |
Tag - Name |
Relation |
A4 V726 PN 40 |
Yes |
Must exist in the system <=40 characters |
Identify the references made by a Document to a Tag. |
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 |
T-10000001 |
Yes |
Must exist in the system <=40 characters |
The unique identifier for the Document according to the Owner/Operator Document numbering scheme. |
revision code |
Document – Revision code |
Relation |
1 |
Yes |
A specific revision for the document number must exist in the selected create scope <=3 characters |
Identify the references made by a Document to Equipment |
equipment identifier |
Equipment - Name |
Relation |
A4 V726 PN 40 |
Yes |
Must exist in the system <=40 characters |
Identify the references made by a Document to Equipment |
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 |
T-10000001 |
Yes |
Must exist in the system <=40 characters |
The unique identifier for the Document according to the Owner/Operator Document numbering scheme. |
revision code |
Document – Revision code |
Relation |
1 |
Yes |
A specific revision for the document number must exist in the selected create scope <=3 characters |
Identify the references made by a Document to a Model |
manufacturer company name |
Relation to HxGN SDx plant or plant code of the model |
Relation |
Flowserve |
Yes |
Must exist in the system <=40 characters |
Identify the company manufacturer for a particular model part |
model part name |
Model - Name |
Relation |
MOD-100001 |
Yes |
Must exist in the system <=40 characters |
Identify the references made by a Document to a Tag.. |
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 |
T-10000001 |
Yes |
Must exist in the system <=40 characters |
The unique identifier for the Document according to the Owner/Operator Document numbering scheme. |
revision code |
Document – Revision code |
String |
1 |
Yes |
A specific revision for the document number must exist in the selected create scope <=3 characters |
Identify the references made by a Document to a document |
referenced document number |
Referenced Document - Name |
Relation |
T-10000501 |
Yes |
Must exist in the system <=40 characters |
The unique identifier for the Document according to the Owner/Operator Document numbering scheme. |
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 |
T-10000001 |
Yes |
Must exist in the system <=40 characters |
The unique identifier for the Document according to the Owner/Operator Document numbering scheme. |
revision code |
Document – Revision code |
Relation |
1 |
Yes |
A specific revision for the document number must exist in the selected create scope <=3 characters |
Identify the references made by a Document to a Purchase_Order. |
po issuer company name |
Organization - Name |
Relation |
Engineering and co Ltd |
Yes |
Must exist in the system <=30 characters |
Identify the Company issuing the Purchase_Order. |
po code |
Purchase Order - Name |
Relation |
58 |
Yes |
Must exist in the system <=50 characters |
Identify the references made by a Document to a Purchase_Order. |
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 |
T-10000001 |
Yes |
Must exist in the system <=40 characters |
The unique identifier for the Document according to the Owner/Operator Document numbering scheme. |
revision code |
Document – Revision code |
Relation |
1 |
Yes |
A specific revision for the document number must exist in the selected create scope <=3 characters |
Identify the references made by a Document to a Process_Unit. |
plant code |
Relation to HxGN SDx plant or plant code of the unit |
Relation |
6000 |
Yes |
Must exist in the system <=40 characters |
A Plant is decomposed in process units. A process unit is part of one Plant. |
process unit code |
Unit - Name |
Relation |
36 |
Yes |
Must exist in the system <=40 characters |
Identify the references made by a Document to a Process_Unit. |
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 |
T-10000001 |
Yes |
Must exist in the system <=40 characters |
The unique identifier for the Document according to the Owner/Operator Document numbering scheme. |
revision code |
Document – Revision code |
Relation |
1 |
Yes |
A specific revision for the document number must exist in the selected create scope <=3 characters |
Identify the references made by a Document to an Area |
plant code |
Relation to HxGN SDx plant or plant code of the unit |
Relation |
6000 |
Yes |
Must exist in the system <=40 characters |
A Plant is decomposed in geographical Areas. An Area belongs to one Plant. |
area code |
Location - Name |
Relation |
36 |
Yes |
Must exist in the system <=40 characters |
Identify the references made by a Document to an Area. |