Create a job definition - HxGN SDx - Update 64 - Administration & Configuration

Administration and Configuration of HxGN SDx

Language
English
Product
HxGN SDx
Search by Category
Administration & Configuration
SmartPlant Foundation / SDx Version
10

The creation of a job definition and the dialog boxes that appear are based on the workflow selected. The following example shows creating a job definition using the workflow Import Validate Delete Export, which includes adding delete rules for the implicit delete functionality. For more information on implicit delete, see Define Implicit Delete Rules.

  1. Click Create Job Definition on the Job Definition toolbar.

  2. On the Basic Details page, type the name and optional description for the job definition.

  3. Select the workflow to be used as the basis for the job definition from the Workflow list box. For example, Import Validate Delete Export.

    The workflow selected changes the pages that appear in the Create Job Definition dialog box for you to use defining the properties.

  4. Select the Run Inconsistency Property Values option to ensure that the inconsistency check is always run when the workflow selected contains the validation process step. The inconsistency check processes all objects in the staging area, and when any two instances of the same property on the same object are found with differing values, an error message is flagged in the validation report. You can then decide whether to propagate the error to the object.

    If you clear this option, you stop the inconsistency check from running during validation, and you may get results that are not expected.

  5. Select the Report Invalid Action Combinations option to report the number of invalid action combinations on an object by looking at the data from combined mappings. For example, if an object is mapped for terminate, then there should not be any properties mapped on the object for create update. If any properties for create update are found to be mapped to the object, an error is propagated.

    If you clear this option, you stop the ability to report the number of invalid action combinations running during validation, and you may get results that are not expected.

  6. Select the Report Multiple Action Conflicts option that checks for multiple actions on a single object. If multiple actions are found, the user is warned about which action is being taken forward. For example, if an object is found to have both an update and a create update action, then the user is informed that the object is being taken forward with the create update action.

    • If you clear this option, you stop the system from reporting on multiple actions running during validation, and you may get results that are not expected.

    • The user cannot choose the action that is taken forward.

    The previous three options do not appear if the workflow does not contain a validation process step.

  7. Select the Is Enabled option to activate the job definition for use in creating jobs in Data Validator Job Management.

    SHARED Tip If you clear this option, this job definition cannot be used to create jobs in Data Validator Job Management.

    A job definition can only be deleted when there are no jobs using the job definition in Data Validator Job Management. For more information, see Delete job definitions using the Desktop Client.

  8. Select the Record Job Details option to store the job information, such as import details, validation, export details, and so on.

  9. Select the Allow Blank CSV With Column Header option to attach blank CSV files that only contain column headers and no data when creating a Data Validator job. For example, there may be multiple CSV files to be exported and some of them may not have any data. In such cases, selecting this option ensures that the job is still processed successfully.

  10. Click Next.

  11. On the Target Systems page, select the target system or systems to validate against and export to.

    SHARED Tip You must set at least one target system as the validation destination, and at least one target system as the export destination. They can be different target systems.

  12. Click Next.

  13. On the Export Configuration page,

    • Set the default options for new document version creation in the Document Version Configurations section:

      • Allow Version Creation - Select this option to create a new document version if the same file is available in the input CSV file during subsequent imports.

      • Copy files from the Previous Version - Select this option to copy files from the previous version of a document while creating a new version.

      • Do Not Upload Attached Files - Select this option if you do not want to upload the attached files into the target system.

        When should I select the Do Not Upload Attached Files check box?

        You can select the Do not upload Attached Files check box when you are planning to export or migrate files in bulk from the source system to the target system and manually copy the files from the source system vault into the target system vault.

        In the import definition, ensure that the SPFLocalFileName and SPFRemoteFileName properties for the file object is mapped with the Create/Update action. For more information on creating import definitions, see Create an import definition.

    • Set the default options for general configuration in the General Configurations section:

      • Suppress Notifications - Select this option to suppress all notifications related to the job definition. This option is enabled only when the Suppress notifications for all jobs check box is not selected in the Data Validator System Options. For more information, see Set Data Validator default options.

        When should I select the Suppress Notifications check box?

        When notification subscriptions are configured for events (like create or update) on any class definition and large amounts of data for that class definition has to be loaded using Data Validator, the system generates a huge number of notifications, which can slow down the job process. In such cases, select the Suppress Notifications check box to suppress all the notifications.

        What happens if I make changes to the Suppress notifications for all jobs check box in the Data Validator System Options?

        If the Suppress notifications for all jobs check box in the Data Validator System Options is selected, all the notifications are suppressed, irrespective of the option specified in the Suppress Notifications check box in the job definition. The various scenarios are explained below:

        Suppress all notifications in Data Validator System Options

        Suppress Notifications in Create Job Definition

        What happens

        Selected

        Selected

        All notifications are suppressed

        Not selected

        Selected

        All notifications are suppressed

        Selected

        Not selected

        All notifications are suppressed

        Not selected

        Not selected

        Notifications are not suppressed

      • Authoring Design Component - Select an authoring design component from the list to ensure that the data in the CSV files is loaded into the authoring domain specified in the design component. The list displays only those design components that are specified as authoring design components. For more information, see Create a design component.

  14. Using the remaining pages of the Create Job Definition dialog box, select an Import Definition to add to the job definition, and then add one or more of the Delete Rules, Rule Sets, Validation Report Definitions, and Access Groups to use by clicking the left add arrow to add them to the appropriate list to apply them to the job definition.

    SHARED Tip You can remove any of the selected objects from the list by selecting it and clicking the right remove arrow .

  15. Click Next.

  16. On the Summary page, check the details for all the components selected in the job definition. All completed component pages are displayed with a check mark.

    SHARED Tip To update a setting in a previous component page, click on the page and update the setting, as necessary.

    If you change a setting that affects other pages, for example by changing the workflow, then all subsequent pages must be completed again.

  17. Click Finish to save the job definition.

SHARED Tip Toggle Show Master Job Definitions ShowMasterIcon to view or hide the delivered master job definitions.