Customizing Workflows - SmartPlant Foundation - IM Update 44 - Customization & Programming - Hexagon

SmartPlant Foundation Customization

Language
English
Product
SmartPlant Foundation
Search by Category
Customization & Programming
SmartPlant Foundation / SDx Version
10

Data Validator is delivered with three out-of-the-box workflow templates. Each of these workflows includes the basic steps for importing, validating, and exporting data. Additionally, they automate the removal of database tables in the staging area and landing tables in the target system, where data is temporarily stored during export before it is loaded into the database. These workflows can be used as delivered or customized to meet your specific work processes.

  • Import Validate Export - This basic workflow imports information into the staging area, validates the data, exports the data to the target system, and removes the temporary staging data.

  • Import Validate Implicit Delete Export - This workflow imports, validates, and exports data, and removes the temporary staging data. It also creates an implicit deletes report that must be approved before the export operation can be completed.

  • Import Validate Export Delete Job - This workflow imports, validates, and exports data, and removes the temporary staging data. It also removes the job from the user interface once it is complete.

Additionally, Data Validator includes a number of process steps that you can use to customize the delivered workflow templates or to create custom workflow templates. You can use the workflow functionality in SmartPlant Foundation to modify the delivered workflow templates or create new ones for use in Data Validator. To use a custom workflow in Data Validator, use SmartPlant Foundation to relate the workflow template to the IVTLJob interface.

Workflow process steps

The following process steps are delivered in the Data Validator layer, and can be used to help customize the workflows to fit your own business requirements.

  • Import - Runs the import of the supplied data to the staging area database using a defined job definition.

  • Validation - Runs the validation rules on the imported data and generates a validation report. The validation report must be approved before the workflow can continue.

  • Implicit Delete Report - Indicates progress of the implicit delete report creation by SmartPlant Foundation by displaying the percentage complete. Once the implicit delete report is complete, it must be approved before the workflow can continue.

  • Implicit Delete - Runs the implicit delete functionality on the data export from the staging area to the target system database.

  • Export - Transfers the data to the target system and loads the data to the database.

  • JobStatusUpdate - When implemented, provides a mechanism to change the workflow status of the job between steps. For example, see the initial step in each of the out-of-the-box workflows.

  • StageCleanUp - Deletes all the tables that the import created in the Data Validator staging database and can be included at the end of each delivered workflow. The job is still visible in the user interface after the tables have been cleaned.

  • StageCleanUpDeleteJob - Deletes all the tables from the staging database and also deletes the job itself, so it disappears from the user interface. This step can be included at the end of a workflow template in the place of the StageCleanUp step.

  • TargetCleanUp - When an export to SmartPlant Foundation is completed without any errors, this step removes the scheduled task and delete the landing tables used to hold the exported data before it was loaded into the database. However, if the export fails, then the task and data are left in the target system. In that case, this step can be run to remove the data.

Using the TargetCleanUp step in a retry path could cause unwanted results when a SmartPlant Foundation target system is involved. For more information on retry, see Retry a failed implicit delete process or Retry a failed export process.

For more information on creating or modifying workflows in SmartPlant Foundation, see Workflows and the To Do List and Workflow Model Configuration Overview.