This functionality was modified in an update. For more information, see Deliverable submittal (modified in an update).
eLearning is available for this topic. Check it out here: HxGN SDx® | Deliverable Submittal
A deliverable submittal contains documents that are ready to be delivered to the company.
The submittal uploads all files to a "safe" area, creates new revisions of the documents,
and attaches the files.
The delivered revisions are routed to a document review workflow which automatically
assigns documents to the reviewers and a consolidator.
MDR deliverable submittal
You can use this to submit the documents and route them to a document review workflow.
Steps
|
Description
|
MDR deliverable submittal
|
The MDR deliverable submittal templates are stored on Smart Community and available
for download.
|
Populate the MDR CSV file
|
Populate the CSV file with the deliverables and their associated filenames. The MDR
document is listed as the first row of the file, though this is optional.
|
Create the deliverable submittal
|
The submittal is created, and the document controllers get a step to review the metadata
information of documents. The document controllers then approve or reject the submittal.
|
Review the submittal progress
|
A progress screen is used to view the upload, validation, and creation of the deliverables.
|
Correct validation/export stage errors
|
Any errors reported by the validation or export stages are addressed prior to re-submission.
|
Review submitted documents
|
The MDR and the deliverables can be reviewed in the system. You can also search for
some of the submitted tags and review their attribution and relationships. You can
query by date to get the full list.
|
Review the document metadata
|
If the Grouped Review flag is enabled on the project, the submittal process pushes a review step to the
document controller for reviewing the metadata information of documents. At this stage,
other reviewers cannot see any of these documents.
You cannot submit a historical revision if the Grouped Review flag is enabled. However, the historical revisions can still be loaded using the
loader workflow. For more information, see Loading documents and data.
|
MTR/TDR submittal
You can use this to load the tags and create the document to tag relationships.
Steps
|
Description
|
Tag MTR
|
The tag MTR templates are stored on Smart Community and available for download.
|
Populate the MTR CSV files
|
Populate the two CSV files; one for the tag list and one for its attribution.
|
Create the MTR submittal
|
The submittal is created, and the tags loaded into SDx.
|
Tag TDR
|
The tag TDR templates are stored on Smart Community and available for download.
|
Populate the TDR CSV files
|
Populate the CSV file to build the relationships between the documents and tags.
|
Create the TDR submittal
|
The submittal is created and the documents to tag relationships are created.
|
Review submittal progress
|
A progress screen is used to view the upload, validation, and creation of the deliverables.
|
Correct validation/export stage errors
|
Any errors reported by the validation or export stages are addressed prior to re-submission.
|
What can be done on a deliverable submittal?
While processing the MDR planning submittal, if one or more issue purposes in the
attached file are not related to the current plant or project, the validation rules
stop the processing, and the user must relate the issue purpose to the current plant
or project to process the submittal.
-
Create the first revision of the MDR with attached deliverable documents.
-
The first row usually contains the MDR document, though this is optional.
-
The MDR document name, title, revision, issue date (dd-mmm-yyyy), and area must be
supplied.
-
The MDR document classification must be set to MDR.
-
The MDR filename is optional though the submittal create process will still request
one.
-
The subsequent rows contain the deliverable documents.
-
The document name, title, revision, issue date, classification, and area must be supplied.
-
The filename is defined to link the correct updated file to the document.
-
The issue purpose is optional but is required if the planning submittals and the review
plans are being used to manage the review process. This is also required for any form
of progress measurement or reporting.
-
All other information is optional.
-
Update the current revision of the MDR to update the deliverable revisions or add
new ones.
-
The first row usually contains the MDR document, though this is optional.
-
MDR document name, revision, issue date (dd-mmm-yyyy), and file name must be supplied.
-
The MDR title can be updated.
-
The MDR filename must be left blank.
-
New deliverable documents or new revisions of the existing documents can be added.
-
Create a new revision of the MDR document to submit new or updated deliverable documents.
-
The MDR revision must be later in the revision sequence than the current revision
and the issue date including the time stamp must be later than or equal to that of
the current revision. A time stamp is automatically added to the issue date.
-
New deliverable documents or new revisions of existing documents can be added.
-
Submit new revisions of the existing deliverables.
-
The submitted deliverable revisions require a name, revision, classification and area
that matches that of the current revision of that deliverable, and an issue date though
the issue date is ignored.
-
A new revision must be later in the revision sequence than the current revision and
the issue date including the time stamp must be later than or equal to that of the
current revision. A time stamp is automatically added to the issue date.
-
The title can be updated.
-
The document filename is usually supplied.
-
The issue purpose is optional but is required if the planning submittals and the review
plans are being used to manage the review process.
Learn more about the preconfigured mappings for deliverable submittal
Deliverable submittals are used to issue documents and their associated files to the
company. The MDR is used to identify which documents are expected or issued by the
contractor for a review.
Pre-requisites
All submittals require the following information created in advance. This information
is used when processing the submittal. The submittal will create or update the MDR
and all related documents.
-
All issue purposes, classifications, and disciplines referenced in the submittal must
be related to the current project or its parent plant. If you relate an issue purpose,
a classification, or a discipline at the plant level to a project, it disables its
inheritance from the plant.
-
A contract must exist between the contracting organization submitting the deliverables
and the organization hosting the SDx system.
-
The contract must have a related review matrix that defines the consolidator for the
document review work process.
This mapping is used to submit the deliverable documents along with the files. One
row must contain the MDR document, which is usually the first row. Two examples of
content are shown below, one for the MDR row and one for the deliverables.
All the columns listed below must be included in the CSV file.
Column name
|
Mapping
|
Type
|
Example (MDR)
|
Example (deliverables)
|
Required
|
Validation
|
Explanation
|
Action
|
Defines action Create or Delete or Update
|
|
U
|
U
|
Yes
|
|
Set to D to delete a document with a reserved status from the MDR.
|
Document Number
|
Document Name
|
String
|
C-INGR.HSV-AB-001-MDR-01
|
C-INGR.HSV-AB-001-DS-000
|
Yes
|
|
|
Revision
|
Document Revision
|
String
|
02A
|
01C
|
Yes
|
|
|
Issue Date
|
Issue date of this deliverable
|
dd-mmm-yyyy
|
25-Jan-2018
|
25-Jan-2018
|
Yes
|
Must be in this format and the current time is appended
|
The current time is appended on new revisions but the issue date is unchanged when
updating existing revisions.
|
Document Title
|
Drawing title
|
String
|
MASTER DOCUMENT REGISTER
|
DATASHEET FOR 230-FC-4501-00
|
Yes
|
|
|
Classification
|
Relationship to document typing
|
Relation
|
MDR
|
DS
|
Yes
|
Must exist in the system
|
|
WBSCode
|
Relationship to work package of type WBS
|
Relation
|
|
6100
|
Yes
|
Must exist in the system
|
|
FEEDCode
|
Relationship to work package of type FEED
|
Relation
|
|
02.06
|
Yes
|
Must exist in the system
|
|
Vendor Package
|
Relationship to work package of type Vendor
|
Relation
|
|
CN-001-02
|
Yes
|
Must exist in the system
|
|
Alternate Document Number
|
|
String
|
|
230-FC-4501-00
|
|
|
Can be used to support the contractor's internal document number.
|
Alternate Revision Number
|
|
String
|
|
1b
|
|
|
Can be used to support the contractor's internal revision number.
|
Is Shareable
|
|
True/False
|
|
True
|
|
|
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.
|
Discipline
|
Relationship to project discipline
|
Relation
|
|
MECH-PR
|
Yes
|
Must exist and be related to the project or plant
|
Must be related to the project or the plant.
|
Area
|
Relationship to plant area
|
Relation
|
20
|
20
|
Yes
|
Must exist in the system
|
|
Unit
|
Relationship to unit in the area
|
Relation
|
|
|
Yes
|
Must exist in the system
|
|
Status
|
NOT USED
|
|
|
|
|
|
NOT USED
|
Issue Purpose
|
Issue purpose of this deliverable
|
Relation
|
|
AB
|
|
|
|
File Name
|
Name of file to be uploaded and attached
|
String
|
C-INGR.HSV-AB-001-MDR-01.doc
|
C-INGR.HSV-AB-001-DS-000.doc
|
|
|
|
What can be done on an MTR submittal?
The MTR submittal process allows you to create, update, and delete tags with classification
and properties.
Depending on the requirements of the contract, SDx Projects provides two options for
managing tag numbering.
-
If the owning company wants to maintain control of the tag numbering, it creates and
allocates the tag numbers to the contractor to use when submitting the MTR.
-
The tag numbering is provided by the contractor as part of their MTR submittal. Allowing
the contractors to provide the tag numbers prevents duplicates in the system.
The tag status can be set as part of the submittal. Delivered values are NoValue,
Reserved, Planned, and As-built. Your administrator can modify these values as part
of the project setup.
What information must be supplied?
The MTR submittal process allows you to load two types of CSV file formats. The basic
format contains the tag data and must have the tag name, type, area, and unit. The
classification should be specified as MTR to create an MTR submittal. The inverted format contains the tag properties and must
have the tag name.
Learn more about the preconfigured mappings for MTR submittal
MTR submittals are used to load tags and their properties into the system. There are
two files, one for the basic tag information and the other for its properties.
This mapping is used to submit the tags and their base data.
Column name
|
Mapping
|
Type
|
Example
|
Required
|
Validation
|
Explanation
|
Action
|
Defines action Create or Delete or Update
|
|
C
|
Yes
|
|
|
Tag_Name
|
Name of the tag
|
String
|
230-AC-4501-01
|
Yes
|
|
|
Description
|
Description of the tag
|
String
|
aerator
|
Yes
|
|
|
Type
|
Relation to classification
|
Relation
|
aerator
|
Yes
|
|
|
CriticalityRating
|
Criticality rating property
|
I / II / III / IV Enum
|
II
|
|
|
|
Project
|
Relation to project that supplied it
|
Relation
|
|
Yes
|
Must exist in the system
|
Used when loading into the plant
|
Contractor
|
Relationship to the supplier
|
Relation
|
AB
|
Yes
|
Must exist in the system
|
|
Area
|
Relationship to the plant area
|
Relation
|
20
|
Yes
|
Must exist in the system
|
|
Unit
|
Relationship to the unit in the area
|
Relation
|
230
|
Yes
|
Must exist in the system
|
|
This mapping is used to submit the tag properties. It uses the inverted format to
load the name and the value of any property.
Column name
|
Mapping
|
Type
|
Example
|
Required
|
Validation
|
Explanation
|
Action
|
Defines action Create or Delete or Update
|
|
C
|
Yes
|
|
|
Tag_Name
|
Name of the tag
|
String
|
230-AC-4501-01
|
Yes
|
|
|
Property_Name
|
Tag – [provided property name]
|
String
|
SPF_normal_operating_pressure
|
Yes
|
Must exist for tags
|
Identify the property for which a value is provided for this model part.
|
Property_Value
|
Tag – [provided property value]
|
Depends on the provided property name
|
0
|
Yes
|
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 picklist defined
for this property name.
|
Property_Value_EoM
|
Tag – [provided property UoM]
|
Depends on the provided property name
|
barg
|
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
|
The unit of measure.
|
What can be done on a TDR submittal?
The TDR submittal process allows you to:
-
Relate tags to the planned revision to indicate the planned deliverables. For example,
major equipment.
-
Relate tags to the delivered revisions to indicate the actual deliverable.
What information must be supplied?
The tag document must have a tag name, document, and revision. The classification
should be specified as TDR in the csv file to create a TDR submittal.
Learn more about the preconfigured mappings for TDR submittal
TDR submittals are used to relate tags and their either reserved or deliverable documents.
This mapping is used to relate tags and their deliverable documents.
Column name
|
Mapping
|
Type
|
Example
|
Required
|
Validation
|
Explanation
|
Action
|
Defines action Create or Delete or Update
|
|
C
|
Yes
|
|
|
Tag_Name
|
Name of the tag to be related
|
String
|
230-AC-4501-01
|
Yes
|
Must exist in the system
|
|
Area
|
Relation to the plant area
|
Relation
|
20
|
Yes
|
Must exist in the system
|
Used to define the uniqueness of the document and tag in the plant.
|
Document
|
Name of document to be related
|
String
|
C-INGR.HSV-AB-001-DS-001
|
Yes
|
Must exist in the system
|
|
Revision
|
Revision of the document to be related
|
String
|
A1
|
Yes
|
Must match the document above
|
The tags are related to a specific revision of a document. This can be a planned revision
to manage the planned major equipment tags or deliverable revision with their contents.
|