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:
metadata
write-back
data
batch
open batch
Note: | Only an administrator can create batch definitions. |
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 not available for the batch types “batch” and “metadata (rules)”.
Batch Definition jobs—Enables you to add and delete jobs to a batch. Based on the type of batch, a specific types of rules are allowed.
To add a batch definition:
From the Setup tab, and then under Batch, select Batch Definition.
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.
In Batch Definition detail section, select the Definition tab.
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.
From the Target Application drop-down, select the name of the target application.
In the Type drop-down, select the type of rule for the definition.
Available types are:
metadata
data
batch
open batch
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 appropriate POV based on the file name. When the open batch is run, the master folder is emptied.
In the Execution Mode drop-down, 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.
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. FDMEE waits for the job to complete before returning control.
The Timeout can be in seconds or minutes. Enter a number and followed by a S for seconds or M for minutes.
In Open Batch Directory for an open batch type, specify the folder under inbox\batches openbatch where the files to be imported are copied. If this field is blank or null, all files underinbox\batches\openbatch are processed.
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:
~
@
:
;
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 FDMEE assigns the data rule name, it checks when a data rule with name the“ Location_Category ” exists. If this name does not exist, FDMEE creates the data rule using the file name convention:
Rule Name—Location_Category
Description—“Auto created data rule”
Category—Category
File Name—Null
Mode—Replace
Optional: In the Description field, enter a description of the batch definition.
Optional: From the Batch Group drop down, select the batch group to associate with the batch.
Optional: In Before Batch Script, enter the name of the custom script to run before the batch.
You can browse and select, or upload a custom script on the Select screen by clicking
The custom script can be written in either Jython or Visual Basic script.
Optional: In After Batch Script, enter the name of the custom script to run after the batch.
You can browse and select, or upload a custom script on the Select screen by clicking
The custom script can be written in either Jython or Visual Basic script.
Note:
Before and After batch scripts are not executed for a batch or batches. You must add the script to the individual batches with the master batch script.
To add batch definition parameters:
From the Setup tab, and then under Batch, select Batch Definition.
Note:
Batch parameters are not available for a “batch” type.
In Batch Definition, and then under Batch Definition Detail, select the Parameter tab.
In Parameters, select Import From Source to import the data from the source system, perform the necessary transformations, and export the data to the FDMEE staging table.
Select Export To Target to export the data to the target application.
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 either 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.
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, enter the date using the format MM/DD/YY.
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.
In the Import Mode drop-down, select the mode to extract data all at once for an entire period or incrementally during the period.
Option are:
Snapshot—Extracts everything for the selected source set for an entire period.
Note the following behavior of Snapshot mode:
When the source data for the selected period has never been run, data is extracted from the source.
When the source data for the selected period has been run, data is extracted from the FDMEE staging table, and not from the source. This means that if a user has two locations that extract from the same ERP source, data is extracted from the source only once.
For example, if you load data to Financial Management from the EBS for a selected period, but you run the integration to ARM for the same source and period, use what is in the interface tables since data is only extracted the first time from the source. This result in a significant performance gain for any subsequent data loads. The first extraction take the longest, but any other subsequent extractions are fast.
Incremental—Extracts those records that were added after the prior data extract.
Full Refresh—Performs a clean extraction from the source system, thereby clearing any existing data rows in the appropriate FDMEE staging tables for a given source Business Unit and source period.
Append—(File-based source systems) Existing rows for the POV remain the same, but new rows are appended to the POV (that is, appends the new rows in TDATASEG)
Replace—(File-based source systems) Replaces the rows in the POV with the rows in the load file (that is, replaces the rows in TDATASEG).
Note:
The import mode options (Snapshot, Incremental and Full Refresh) are only applicable to Data Rules in a Location using a Standard Import Format. Data Rules in a Location with a Source Adapter Import format always perform a full data extraction (similar to Full Refresh) directly into the TDATASEG_T table.
This field is only available for a data load batch.
Select Extract Exchange Rate to extract the exchange rate.
This field is not applicable for a file-based source systems
For more information on extracting exchange rates, see How Currencies are Processed.
For Essbase and Planning applications, 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 for Essbase and Planning applications are:
STORE_DATA
ADD_DATA
SUBTRACT_DATA
OVERRIDE_ALL_DATA
Options for the Financial Management applications:
Accumulate
Replace
Merge
This field is only available for a data load batch.
to navigate to and select the rule name.