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 export the objects to the target system.
The following information describes the Incoming Submittal Workflow template. It explains what can and cannot be changed.
Remodel the work process
Work process remodeling, including creating new steps, requires changes to the underlying workflow template. For more information, see the rules for work process remodeling in Configure workflows and the detailed procedures in How to Configure the Workflow Model.
Details of internal process steps
To troubleshoot the issues that may arise during the submittals process, see Submittals processing errors.
The steps that make up the workflow are described in the following table.
If you choose to edit the workflow, do not remove any steps marked as mandatory.
For information on how to upgrade a workflow template, and the changes that have
been made in various updates, see Upgrading workflow templates.
|
Step name |
Description |
Mandatory? |
Comments |
|---|---|---|---|
|
SDVJobConversionStep |
Converts a HxGN SDx object to a Data Validator job object. If the conversion is successful, the next step is SDVUnzipStep. Otherwise, the next step is An Error Has Occurred while converting object to SDV Job. |
Yes |
This step is needed to ensure that when a new system is being set up, the administrator can control the type of data entering the system and its integrity. |
|
SDVUnzipStep |
Reads all the file references in an MDR submittal, and unzips any zipped files that are not referenced. If the unzipping process is successful, the next step is SDVSplitCSVFileStep. Otherwise, the next step is An Error Has Occurred while unzipping the attached zip files. |
Yes |
This step is needed to unzip any zipped files. |
|
SDVSplitCSVFileStep |
Splits the input CSV file using properties defined in the SDV Job Details dialog box. If the splitting process is successful, the next step is Submit For Import. Otherwise, the next step is An Error Has Occurred while splitting CSV file. |
Yes |
This step is needed to split the input CSV file using the properties defined in the Job Details dialog box. |
|
Submit For Import |
Submits the submittal for the import process. The next step is Import. |
Yes |
This step is needed to import files in CSV format into the staging system. |
|
Import |
Runs the import of the supplied data to the staging area database using a defined job definition. If the process is successful, the next step is Validation. Otherwise, the next step is An Import Error Has Occurred. |
Yes |
This step is needed to import files in CSV format into the staging system where the validation takes place. |
|
Validation |
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. If the report is approved, the next step is Validation Error Check. Otherwise, the next step is A Validation Error Has Occurred. |
Yes |
This step is needed to validate the data that is imported into the staging area. Validation ensures the imported objects meet the criteria mentioned in the selected rule sets. |
|
Validation Error Check |
Checks for any errors during the validation process. If there are no errors, the next step is Export. Otherwise, the next step is Review Validation Report. |
Yes |
This step is needed to identify issues in the data and stop it from being loaded if issues are found. |
|
Review Validation Report |
Allows the submitter to review the validation report for possible import failures. If the submitter accepts the report, the next step is Export. Otherwise, the next step is StageCleanUp. |
Yes |
This step is needed to identify the error. |
|
Export |
Transfers the data to the target system, and loads the data to the database. This step starts automatically if there are no validation errors. If the export is successful, the next step is SDVMDRProcessStep. Otherwise, the next step is Correct and Re-Export. |
Yes |
This step is needed to manage loading data into the target system. |
|
SDVMDRProcessStep |
Creates relationships between the MDR Document Master and other document masters in the submittal using the FDWMDRDocMasters relationship definition. If the process is successful, the next step is SDVSubmittalNeedReview. Otherwise, the next step is An Error Has Occurred during SDVMDRProcessStep. |
Yes |
This step is needed to avoid duplicate relationships. If you submitted the MDR document master, this step is mandatory. Otherwise, it is optional. |
|
SDVSubmittalNeedReview |
Checks whether the submittal needs a document controller review. If a review is needed, the next step is SDVSetSubmittalToSubmitted. Otherwise, the next step is SDVAttachWorkflowStep. |
Yes |
This step is needed to honor the Grouped Review flag enabled on the project. |
|
SDVSetSubmittalToSubmitted |
Sets the submittal state to SUBMITTED. If this step is removed, the submittal object status will not be modified. The next step is Review Submittal Data. |
Yes |
This step is needed if the Grouped Review flag is enabled on the project. Otherwise, it is optional. The documents cannot be queried if they are not approved by a document controller. |
|
Review Submittal Data |
Allows the user with a document controller role to review the submittal data. If the user approves the data, the next step is SDVSetDocumentToCurrentonApproval. Otherwise, the next step is SDVSetSubmittalToRejected. |
Yes |
This step is needed to review the submittal data and approve or reject the submittal. |
|
SDVSetDocumentToCurrentonApproval |
Signs off the document, and sets the submittal state to CURRENT. The next step is Submittal Approval Notification. |
Yes |
This step is needed to sign off the document after approval. |
|
Submittal Approval Notification |
Informs the submitter that the submittal has been approved by the document controller. The next step is SDVAttachWorkflowStep. This is a notification step. |
Yes |
This step is needed so that the submitter knows the data is in the system and there is nothing outstanding. This step also completes the submittal task. |
|
SDVSetSubmittalToRejected |
Sets the submittal state to Rejected. If this step is removed, the status will not be modified. The next step is SDVSetPreviousRejectedRevisionsToRJSuperseded. |
No |
|
|
SDVSetPreviousRejectedRevisionsToRJSuperseded |
Sets the previously rejected revisions to Reject Superseded. If this step is removed, the status will not be modified. The next step is SDVSetDocumentsToRejected. |
No |
|
|
SDVSetDocumentsToRejected |
Sets the documents state to Rejected Submitted (RJSubmitted). If this step is removed, the status will not be modified. The next step is SDVSetDocumentVersionToRejected. |
Yes |
This step is needed to resubmit the same revision, if the Grouped Review flag is enabled on the project. Otherwise, it is optional. |
|
SDVSetDocumentVersionToRejected |
Sets the document version to Rejected. SDXIsVersionRejected property is enabled. If this step is removed, the status will not be modified. The next step is SDVCopyStepcommentsToSubmittal. |
Yes |
This step is needed if the Grouped Review flag is enabled on the project. Otherwise, it is optional. |
|
SDVCopyStepcommentsToSubmittal |
Copies the rejected step comments to the submittal. The next step is Submittal Reject Notification. |
Yes |
This step is needed to ensure the reasons for rejection are passed on. |
|
Submittal Reject Notification |
Informs the submitter that the submittal has been rejected. The next step is StageCleanUp. This is a notification step. |
Yes |
This step is needed so that the submitter can take corrective actions. |
|
SDVAttachWorkflowStep |
Attaches a workflow to the HxGN SDx object. If the process is successful, the next step is SCLBSetSubmittalToCOMPLETED. Otherwise, the next step is An Attach Workflow Error Has Occurred. |
Yes |
This step is needed to ensure the documents are attached to the workflow and loaded into the system. |
|
SCLBSetSubmittalToCOMPLETED |
Sets the issue status to Completed on the submittal. If this step is removed, the status will not be modified. The next step is StageCleanUp. |
No |
|
|
Correct and Re-Export |
Allows the submitter to correct and re-export the data. These errors result in the failure to load the data from the staging area into the project. If the submitter retries, the next step is Export. If the submitter rejects, the next step is TargetCleanUp. |
Yes |
This step is needed to identify the error and fix it. |
|
TargetCleanUp |
Deletes the landing tables for the failed jobs from the database, which were created as part of the SDV job. The next step is StageCleanUp. |
Yes |
This step is needed to ensure better performance during logon and a healthy database over time. |
|
StageCleanUp |
Deletes the staging tables for the failed jobs from the database, which were created as part of the SDV job. This is the last step in the workflow. |
Yes |
This step is needed to ensure better performance during logon and a healthy database over time. |
|
An Import Error Has Occurred |
An error notification step that informs the submitter that an error has occurred during import and the possible reasons why. These errors result in the failure of the system to load the submittal data into the staging area and prevent the submittal from starting the load job. The next step is StageCleanUp. This is a notification step. |
Yes |
This step is needed to identify the error and fix it. These errors are usually associated with initial setup and configuration. For example, an incorrectly defined target system. |
|
A Validation Error Has Occurred |
An error notification step that informs the submitter that an error has occurred during validation and the possible reasons why. The next step is StageCleanUp. This is a notification step. |
Yes |
This step is needed to identify the error and fix it. Typical errors would be a reference to a missing related item, such as a unit or discipline. The user can choose to either delete the submittal, correct and re-issue it, or continue to load the data without that relationship and correct it in a future submittal. |
|
An Error Has Occurred while converting object to SDV Job |
An error notification step that informs the submitter that the submittal has failed and the possible reasons why. |
Yes |
This step is needed to know the reasons for failure. The submitter then updates the csv file and creates a new submittal. |
|
An Attach Workflow Error Has Occurred |
An error notification step that informs the submitter that the submittal has failed and the possible reasons why. |
Yes |
This step is needed to know the reasons for failure. The submitter then updates the csv file and creates a new submittal. |
|
An Error Has Occurred while splitting CSV file |
An error notification step that informs the submitter that the submittal has failed and the possible reasons why. |
Yes |
This step is needed to know the reasons for failure. The submitter then updates the csv file and creates a new submittal. |
|
An Error Has Occurred while unzipping the attached zip files |
An error notification step that informs the submitter that the submittal has failed and the possible reasons why. |
Yes |
This step is needed to know the reasons for failure. The submitter then checks the attached zip files and creates a new submittal. |
|
An Error Has Occurred during SDVMDRProcessStep |
An error notification step that informs the submitter that the submittal has failed and the possible reasons why. |
Yes |
This step is needed to know the reasons for failure. The submitter then updates the csv file and creates a new submittal. |