A key feature of Data Validator is that the validation of data imported into the staging area and the export of objects to one or more target systems are configured in a workflow run using Data Validator Job Management. Data Validator is delivered with three out-of-the-box workflow templates:
-
Import Validate Export
-
Import Validate Implicit Delete Export
-
Import Validate Export Delete Job
The workflow drives the behavior of Data Validator by bringing each component together as a separate process step, each of which is approved as the data progresses through the workflow:
-
The import of information is defined using mapped column headers that can be defined from a specified target system configuration.
-
Rule sets are defined for the validation of the imported data, both locally in the staging area and against a target system.
-
Data is validated with or without a step that produces an error report.
-
Implicit delete functionality is configured by setting up rules that determine what data is deleted or terminated. The deleted and terminated objects are included in an optional deletes report before you actually delete the objects during the export process.
-
Export data is filtered and mapped to the intended target system (or systems) with or without a report or a confirmation step.
-
A workflow can be attached to the exported objects using a process step, SDVAttachWorkflowStep, when the staging and target systems are configured on the same site. For example, if you want to attach a review workflow to a large number of documents, it is easy and automatic using the process step, instead of manually attaching the workflow to each document.
-
A workflow can be attached to an exported document object in the target system by configuring a property, SPFTargetWorkflowName, on the document revision object during import mapping. The staging and target systems can be configured on the same site or on different sites when attaching a workflow in this way.
Data Validator does not support reviving an object after it has been terminated. This includes reviving
any data that was created as the result of a claim.
If you do not have a SmartPlant Foundation target system to drive the import mapping
and validation, the imported data can be mapped to the staging area using free text
or by using existing schema items in the staging area. The validation can then be
run against the staging area. For more information on customizing the workflow, see
Customizing Workflows.
Auto-generation of export mapping
When defining import mapping, Data Validator can automatically generate the export mapping required to transfer data from the staging area columns to the target system columns. This is possible only if a target system is selected on the import mapping. The export mapping is used during the export process, where the imported data has been mapped to match the existing architecture of the target system.
Auto-generation of rules for validation
Rule sets are used to enforce levels of quality. Some properties may be missing or have values outside of the standard operational scope. Data Validator manages the validation of this data and lets you determine if the issue is serious enough to prevent the export of the data or not. Rules are automatically generated when you define your import mapping and saves you time when creating rules. This allows the automatic definition and execution of any rules, for example, ensuring that a check exists for an object in the target system or asking the target system and definitions for the type of property and its set of valid property values.
Attaching a workflow to exported objects
There are two ways to attach a workflow to an exported object in the target system.
Configuring a process step in a workflow
A workflow can be attached to the exported objects in the target system by configuring a process step, SDVAttachWorkflowStep, in any of the three delivered workflows. This step uses two arguments: the name of the workflow you are attaching to the exported objects, and the relationship definitions that relate the objects with the Data Validator job. Example: SDVAttachWorkflowStep, Document_Review_And_Sign_Off,SCLBSubmittalDocumentVersions,VTLJobForObjAbstract. The relationship definitions must be mapped using the environment variable, JOBNAME, as a computed column type while creating the import definition. For example, if you are attaching a workflow to a document, then you must create a relationship definition using JOBNAME at one end and the document name at the other end.
-
The staging and target systems must be configured on the same site.
-
It is not required to model the relationship definitions if they are already available in the schema.
Configuring a property during import mapping
A workflow can be attached to an exported document object in the target system by configuring the SPFTargetWorkflowName property on the document revision object during import mapping. The staging and target systems can be configured on the same site or on different sites when attaching a workflow in this way.
Two sample XML files are delivered on Smart Community. For more information, see Find sample data on Smart Community. You can use these two sample XML files to configure the SPFTargetWorkflowName property during import mapping:
-
ADMIN_AutoCorrelateWithExchangeData.xml
-
WORKFLOW_AutoCorrelateWithExchangeData.xml
-
This is supported for document revision objects only.
-
If any errors occur in the workflow attached to a document object, an error message is stamped for traceability on the SPFWorkflowStatusErrorMessage property, present on the ISPFWorkflowItem interface definition of the object. The process of attaching workflows continues for the remaining document objects.