Batch Process Definitions and Descriptions

When the model is generated, an XML file called <ProjectName>_batch.xml will be generated which contains the definitions of your batch processes. In order for users to issue batch process requests, this information must be loaded into the database using the Data Manager.

Once the information has been loaded it is possible to use the Administration interface to add further details about the batch processes and their parameters. The information that should be added is as follows:

• A description of each of the batch processes;
• The type of each batch process;
• A description of each of the parameters to each of the batch process. These are actually the fields of the respective batch operations struct fields;
• A default value for each of the parameters to each of the batch processes. This value should represent a valid input.

This information is contained in a number of database tables as shown in the following diagram. These tables are described in more detail below.

Figure 1. Batch database tables

• BatchProcDef

  The Batch Process Definition table contains the definitions of the batch processes as output from the model generators. The information in this table is loaded from the SQL file mentioned above. The fields in this table include:

  • processDefName - The name of the batch process.
  • appName - The name of your application. This is required to enable the fully qualified name of the batch operation to be determined.¹
  • className - The name of the class containing the batch processing operation.
  • opName - The name of the operation that performs the batch processing.
• BatchParamDef

  The Batch Parameter Definition table contains the definitions of the parameters associated with the different batch processes. The information on this table is loaded from the SQL file mentioned above. The fields on this table include:

  • paramName - The name of the parameter.
  • processDefName - The name of the batch process.
  • paramType - The datatype of the parameter.
• BatchProcDesc

  The Batch Process Description table contains a user friendly description of the batch process. The information should be added using the Batch Administration interface. The fields on this table include:

  • processDefName - The name of the batch process.
  • processLongName - The descriptive name of the batch process.
  • description - A description of the batch process.
  • batchType - The type of batch process.
• BatchParamDesc

  The Batch Parameter Description table contains a user friendly description of the parameters associated with a batch process. The information should be added using the Batch Administration interface. The fields on this table include:

  • paramName - The name of the parameter.
  • processDefName - The name of the batch process.
  • description - The description of the parameter.
  • defaultValue - The default value for the parameter.