Understanding the control file format - SmartPlant Foundation - IM Update 46 - Help - Hexagon

SmartPlant Foundation Help

Language
English
Product
SmartPlant Foundation
Search by Category
Help
SmartPlant Foundation / SDx Version
10
SmartPlant Markup Plus Version
10.0 (2019)
Smart Review Version
2020 (15.0)

The XML control file is used to define the job information and process the definitions in Data Validator Job Management.

As seen in the following example, the XML file has some pre-defined XML tags, which are described in the table below.

ImageSDV

1

<User_Name> - Allows you to provide the user name for logging into SmartPlant Foundation.

2

<StartDateTime> - Allows you to provide the date and time value, date format, and the time zone for the date for the job to be picked up by the scheduler.

3

<Jobs> - Allows you to list all the jobs that you want to run using the same control file.

4

<Target_System> - Holds the information of the target system elements that are used to process the data at each stage.

  • <Target_System_for_Validation> - Defines the target system where the validation of data takes place.

  • <Target_System_for_Export> - Lists all the target systems.

  • <Target_System> - Defines the target system name for exporting data. You can define more than one target system for exporting the data.

  • <Suppress_ENS> - Defines whether to suppress the creation of objects with ENS in the target system for the data exported in this job. For example, if the value is set to True then the objects are created with ENS in the target system after export.

  • <Target_System_Configuration> - Defines the target system configuration for exporting the data. For example, ConfigurationTop~PlantA~Project1.

5

<Import_Definition_And_Files> - Allows you to define the import definition name, file path for the input files, and prompted column information.

The following table defines the XML tags that are available in the control file:

XML tag

Description

Job_Creation_Information

This consists of all the information required to trigger one or more jobs.

System_Name

Contains the name of the application server where the control file exists and the job is initiated

User_Name

Contains the username for logging into SmartPlant Foundation.

StartDateTime

Contains the date and time value, date format, and time zone.

Jobs

Contains job information for one or more jobs in it.

Job

Contains all the information required for a job.

Job_Description

Defines the job description used to identify the job in Data Validator Job Management.

Job_Definition_Name

Defines the name of the job definition used for the job.

Target_System_for_Validation

Defines the name of the target system where the data validation takes place.

Target_System_for_Export

Contains one or more target system name for the data export.

Target_System

Defines the name of the target system required for data export.

Suppress_ENS

Defines whether to suppress the creation of objects with ENS in the target system for the data exported in this job.

Target_System_Configuration

Defines the target system configuration for the exported data.

Import_Definitions_And_Files

Contains the import definition name, input file path, and prompted column information. This can also contain the information for one or more import definitions.

Import_Definition

Contains the import definition information.

Name

Defines the name of the import definition that is used for the job.

Files_to_Import

Contains file information for one or more input files.

File

Contains the input file and the prompted column information.

File_Path

Defines the file path for the input file.

Has_Headers

Defines if the input files have headers and accepts the values: True or False.

Prompted_Values

Contains information for one or more prompted columns.

Prompted_Value

Contains the prompted column information.

Column_Name

Defines the name of the prompted column.

Value

Defines the value that is used for the prompted column at runtime.