Working with Batch Definitions

A batch definition is used to define the batch jobs and parameters, and the type of rules included in the batch. A batch can contain one type of rule only. Valid types of rules are:

  • data

  • batch

  • open batch

Note:

Only an administrator can create batch definitions.

You can create a batch definition that includes data load rules from a different target applications. This enables you to use a batch that loads both metadata and data, or to create a batch of batches with one batch for metadata and another batch for data.

If you want to work with data load rules that have been associated with a metadata application, Data Management supports the loading of metadata from a flat file. For more information, see

The Batch Definition features consist of three regions:

  • Batch Definition detail—Enables you to add and delete a batch definition. If adding or modifying a definition, specify the definition name, target application, process method, return control method, and wait parameters.

  • Batch Definition parameters—Enables you to derive period parameters based on the Import to Source, Export to Target, POV period, and to indicate data extract parameters. The parameter definition is unavailable for the batch types "batch."

  • Batch Definition jobs—Enables you to add and delete jobs in a batch. Based on the type of batch, specific types of rules are allowed.

To add a batch definition:

  1. On the Setup tab, under Batch, select Batch Definition.

  2. In the Batch Definition summary section, click Add.

    Use the blank Name and Target Application fields in the Batch Definition summary grid to enter a batch name or target application on which to search.

  3. In Batch Definition detail section, select the Definition tab.

  4. In Name, specify the name of the batch definition.

    The name must contain only alpha, numeric or underscore characters. Do not enter spaces or any other character.

  5. From Target Application, select the name of the target application.

  6. From Type, select the type of rule for the definition.

    Available types are:

    • data

    • batch

    • open batch

    • open batch multi-Period file-based data sources that include starting and ending periods.

    If you are including multiple target applications, make sure the "type" of rule is consistent by type. For example, a batch of type "batch" cannot include a data rule. It can include only batches. A batch of type "data" cannot include batches.

    The Open Batch type is used only for file-based data sources and does not contain any batch jobs. When you run this type of batch, the process reads the files automatically from the openbatch directory and imports them into the appropriate POV based on the file name. When the open batch is run, the master folder is emptied.

  7. From Execution Mode, select the batch process method.

    • Serial—Processes files sequentially, requiring that one file complete its process before the next file starts its process.

    • Parallel—Processes files simultaneously.

      Note:

      Files are not grouped by location in parallel mode.
  8. For batch processing run in parallel mode, complete the following fields

    • Wait for Completion—Select Wait to return control only when the batch has finished processed.

      Select No Wait to run the batch in the background. In this case, control is returned immediately.

    • Timeout—Specify the maximum time the job can run. Data Management waits for the job to complete before returning control.

      The Timeout can be in seconds or minutes. Enter a number followed by a S for seconds or M for minutes.

  9. In Open Batch Directory for an open batch type, specify the folder under Home\inbox\batches openbatch where the files to be imported are copied. If this field is blank or null, all files under Home\inbox\batches\openbatch are processed.

  10. In File Name Separator for an open batch, select the character to use when separating the five segments of an open batch file name.

    Options:

    • ~

    • @

    • ;

    • _

  11. Select Auto Create Data Rule to create the data rule automatically for file-based data loads.

    Note:

    The Auto Create Data Rule option is available when the rule type is "open batch".

    When Data Management assigns the data rule name, it checks whether a data rule with the name "Location_Category" exists. If this name does not exist, Data Management creates the data rule using the following file naming conventions:

    • Rule Name—Location_Category

    • Description—"Auto created data rule"

    • Category—Category

    • File Name—Null

    • Mode—Replace

  12. Optional: In the Description field, enter a description of the batch definition.

  13. Click Save.

  14. Optional: In Batch Group, select the batch group to associate with the batch.

    For more information, see Adding a Batch Group.

  15. Optional: In Number of Parallel Jobs, specify the maximum number of parallel processes submitted by a batch at any time.

    This option is used in conjunction with the Wait for Completion and Timeout fields.

    If Wait for Completion and a time-out period options are set, but the number of parallel jobs is not, then Data Management waits for all batch jobs to complete and then returns control.

    When the number of parallel jobs count is set, and the Wait for Completion/time-out modes are enabled, the system submits the specified number of jobs for processing at one time. If the wait time is reached before all the jobs are complete, the system exits the batch processing procedure.

    The Wait for Completion setting is not for each subset, but for the whole batch. For example, let's suppose you have 20 jobs where the number of parallel jobs is set to 4 and the time-out period is 10 M. If only 15 jobs are completed in 10 M, the system still exits.

    If No Wait is specified, the system submits all jobs and returns control submitted immediately without waiting for any running processes to finish.

  16. Click Save.

To add batch definition parameters:

  1. On the Setup tab, under Batch, select Batch Definition.

  2. In Batch Definition, under Batch Definition Detail, select the Parameter tab.

  3. In Parameters, select Import From Source to import the data from the source system, perform the necessary transformations, and export the data to the Data Management staging table.

  4. Select Export To Target to export the data to the target application.

  5. Select POV Period to derive the period parameters based on POV settings.

    If the POV period is selected, the period key start and end period fields are disabled.

    This field is only available for a data load batch.

    When setting up a batch, you can choose the POV to drive the period, or enter the periods explicitly. If you select the POV, it is pulled from the Default POV Period setting in System/Application, or User settings.

  6. Specify dates in the Start Period and End Period to derive period parameters through which the data is processed.

    Use the date format based on the locale settings for your locale. For example, in the United States, enter the date using the format MM/DD/YY format.

    If the Start Period and End Period fields are selected, the POV Period field is disabled.

    This field is only available for a data load batch.

  7. In the Import Mode drop-down, select the mode to extract data all at once for an entire period or incrementally during the period.

    Options are:

    • Append—Existing rows for the POV remain the same, but new rows are appended to the POV. For example, a first-time load has 100 rows and second load has 50 rows. In this case, Data Management appends the 50 rows. After this load, the row total for the POV is 150.
    • Replace— Replaces the rows in the POV with the rows in the load file (that is, replaces the rows in TDATASEG). For example, a first time load has 100 rows, and a second load has 70 rows. In this case, Data Management first removes the 100 rows, and loads the 70 rows to TDATASSEG. After this load, the row total for the POV is 70.

      For a Planning application, Replace Data clears data for the Year, Period, Scenario, Version, and Entity dimensions that you are loading, and then loads the data from the source or file. Note when you have a year of data in your Planning application but are only loading a single month, this option clears the entire year before performing the load.

    This field is only available for a data load batch.

  8. Select Extract Exchange Rate to extract the exchange rate. (This option is not applicable for file-based source systems).

  9. In the Export Mode drop-down, select the mode of exporting data.

    For Planning applications, in the Export Mode drop-down, select the mode of exporting data.

    Options are:

    • Store Data—Inserts the value from the source or file into the target application, replacing any value that currently exists.

    • Replace Data—Clears data for the Year, Period, Scenario, Version, and Entity dimensions that you are loading, and then loads the data from the source or file. Note when you have a year of data in your Planning application but are only loading a single month, this option clears the entire year before performing the load.

    • Add Data—Adds the value from the source or file to the value in the target application. For example, when you have 100 in the source, and 200 in the target, then the result is 300.

    • Subtract Data—Subtracts the value in the source or file from the value in the target application. For example, when you have 300 in the target, and 100 in the source, then the result is 200.

    This field is only available for a data load batch.

    For Financial Consolidation and Close, the modes of exporting data are:

    • Replace—First deletes all values based on the scenario, year, period, entity, and data source before it submits the load.

    • Merge—If data already existed in the application, the system simply adds values from the load file to the existing data. No existing data is deleted. If data does not exist, the new data is created.

    • Accumulate—Accumulate the data in the application with the data in the load file. For each unique point of view in the data file, the value from the load file is added to the value in the application.

  10. For Essbase or Planning, from the Plan Type drop-down, select the plan type of the application.

  11. Click Save.

To add a batch job:

  1. On the Setup tab, under Batch, select Batch Definition.

  2. In Batch Definition, under Batch Jobs, click Add.

    In Rule Name, specify the rule name associated with the batch job.

    You can also select the Search button. to navigate to and select the rule name.

  3. In Job Sequence, specify the order in which to sequence the batch.

  4. Click Save.