This functionality was modified in an update. For more information, see Learn about the Incoming Submittal workflow (modified in an update).
When you create an Incoming Submittal, the submittal is automatically attached to the Incoming Submittal workflow. The workflow uses the existing and new process steps to convert the object into a Data Validator job. The Import, Validate, and Export steps validate the data imported into the staging area and exports the objects to the target system.
The following table provides the process steps used by the Incoming Submittal workflow:
Process step name |
Description |
Arguments |
---|---|---|
SDVJobConversionStep |
Converts a HxGN SDx object to a Data Validator job object. |
None |
SDVUnzipStep |
Reads all the file references in an MDR submittal and unzips any zipped files that are not referenced. |
None |
SDVSplitCSVFileStep |
Splits input CSV file using properties defined in the SDV Job Details dialog box. |
None |
Import step |
Runs the import of the supplied data to the staging area database using a defined job definition. |
None |
Validate step |
Runs the validation rules on the imported data and generates a validation report. If there are validation errors, the validation report must be approved before the workflow can continue. |
Arg1: VTLValidationReportFile |
Export step |
Transfers the data to the target system and loads the data to the database. This step starts automatically if there are no validation errors. |
None |
SDVMDRProcessStep |
Creates relationships between the MDR Document Master and other document masters in the submittal using the FDWMDRDocMasters relationship definition. |
Arg1: SDA document type Arg2: FDWMDRDocMasters relationship definition between the MDR document master and other document masters. |
SDVAttachWorkflowStep |
Attaches a workflow to the HxGN SDx object. |
Arg1: EDG_SubmittalToRevision - edge definition between the objects in the workflow and the target objects. Arg2: WD_SCLBQAReviewVerification - the name of the workflow. |
SetSubmittalStateToCOMPLETED |
Sets the issue status to completed on the submittal. |
Arg1: ISPFTransmittal - Interface definition name. Arg2: SPFXmtlIssueState Arg3: e1XmtlIssueStateCOMPLETED |
SDVCopyStepcommentsToSubmittal |
Copy rejected step comments to submittal. |
Arg1: OBJ.SDAProjComsRejectReason Arg2: PREVIOUSINTERACTIVECLAIMED.SPFStepComments |
SDVSetDocumentToCurrentonApproval |
Sign off the document. |
Arg1: SCLBSubmittalDocumentVersions_12 Arg2: FALSE Arg3: EDG_AllReleasedRevisions |
SDVSetDocumentVersionToRejected |
Set the document version to Rejected. |
Arg1: Obj->SCLBSubmittalDocumentVersions_12.SDxIsVersionRejected Arg2: TRUE |
SDVSetDocumentsToRejected |
Set the documents state to Rejected. |
Arg1: EDG_SubmittalToSubmittedRevision_12.SPFRevState - edge definition between the objects in the workflow and the target objects. Arg2: SPFStepComments is the step where comments are provided from the source. |
SDVSetPreviousRejectedRevisionsToRJSuperseded |
Set the previously rejected revisions to Reject Superseded. |
Arg1: Obj->EDG_SubmittalToSubmittedRevision_12.SPFRevState - edge definition between the objects in the workflow and the target objects. Arg2: e1RJSUPERSEDED |
SDVSetSubmittalToRejected |
Set the submittal state to Rejected. |
Arg1: ISPFTransmittal - Interface definition name. Arg2: SPFXmtlIssueState Arg3: e1XmtlIssueStateREJECTED |
SDVSetSubmittalToSubmitted |
Set the submittal state to SUBMITTED. |
Arg1: ISPFTransmittal - Interface definition name. Arg2: SPFXmtlIssueState Arg3: e1XmtlIssueStateSUBMITTED |
SDVSubmittalNeedReview |
Checks whether the submittal needs a document controller review. |
SDxAnySubmittedDocuments: Condition to check whether the submittal needs a document controller review. |
Submit For Import |
Submits the submittal for import process. |
None |
Validation Error Check |
Checks for any errors during the validation process. |
None |
-
If a submittal contains a deliverable for an issue purpose that is not related to the current plant or the current project, the validation rules do not allow the submittal to process further, and an error is logged in the validation report. The system checks the issue purpose relationship with the parent configuration and processes the submittal accordingly.
-
In an upgraded environment, if you enable Grouped Review flag on the project, you must use the latest version of the Incoming Submittal workflow template. Otherwise, the documents go into the submitted state and may not appear in the search results. For information on how to include the changes, see Upgrading workflow templates.
-
If the same document revision is reissued, to create a new version, you must enable Allow version creation flag on the job definition of your mapping.