Creating RA Oracle Retail Agent Jobs

To create an RA Oracle Retail Agent Job:

Create a JOBS > ORACLERETAILAGENT > RETAILJOB object in a local (i.e. non-zero) client as described in your Automation Engine documentation. Make sure that you select your AGENT object in the Host field on the Attributes tab.
Click the Oracle Retail tab in the navigation pane.

This is where you specify general and additional parameters for the Job.

Defining General Parameters

Define general parameters by responding to the fields in the General Parameters box, which are described below.

Field	Description
Program Login	The RA Oracle Retail Agent Program Connection object to use when running the program. To determine the Program Login Connection object by user or other variable setting, use an object variable in this field.
Program	The Oracle Retail program to run. The program can be selected from a list using the browse icon.
Number of Threads	The number of threads for this program to run.
Allow Recovery	If ‘Yes', the program supports restart on failure and also displays the number of running, completed, and aborted program threads for tasks in the ‘Remote status' column of the Process Monitoring perspective.
Append File Extension	If ‘Yes', the thread number will be appended to all input files.
Starting Thread Number	The thread number to start with.
Threads to Run	Upon restart, specifies which threads should be restarted. If left blank all threads will be restarted.

Defining Additional Parameters

To add row to the table, click Add and edit the row.

Overriding Agent Settings with Job Overrides

Fields in the Job Overrides box allow you to override default Agent settings for individual Jobs.

Field	Description
Environment Source File Override	To override the default environment source file specified in the Environment Source File field for the Agent, enter a path and file name. This field allows you to type in command line parameters if they are required for the source file script. For example, if the script is run from the command line like the following: /home/retek/internal/bin/chgenv.ksh csrms 13.2 uc4lin You can use the browse icon to select a file. If the file you select requires additional arguments, you can select the file and type in the arguments. The MMHOME variable sets the Oracle Retail home directory. It is required in the RA Oracle Retail Agent's environment and must be set in the environment source file.
Executable Directory Override	To override the directory specified in the Execution Directory field for the Agent, enter the directory where the Oracle Retail executable program for this Job resides. You can use the browse icon to select a directory.
Output Directory Override	To override the directory specified in the Output Directory field for the Agent, enter a directory where the Oracle Retail program output for this Job will be created. You can use the browse icon to select a directory.

Field

Description

Environment Source File Override

To override the default environment source file specified in the Environment Source File field for the Agent, enter a path and file name. This field allows you to type in command line parameters if they are required for the source file script. For example, if the script is run from the command line like the following:

/home/retek/internal/bin/chgenv.ksh csrms 13.2 uc4lin

You can use the browse icon to select a file. If the file you select requires additional arguments, you can select the file and type in the arguments.

The MMHOME variable sets the Oracle Retail home directory. It is required in the RA Oracle Retail Agent's environment and must be set in the environment source file.

Executable Directory Override

To override the directory specified in the Execution Directory field for the Agent, enter the directory where the Oracle Retail executable program for this Job resides. You can use the browse icon to select a directory.

Output Directory Override

To override the directory specified in the Output Directory field for the Agent, enter a directory where the Oracle Retail program output for this Job will be created. You can use the browse icon to select a directory.

Defining Output Settings

Define output settings by responding to the fields in the Oracle Retail Output box, which are described below.

Field	Description
Search Pattern	Allows you to specify how to search for output files. This field allows the following replacement values: {PROGRAM}: The Oracle Retail program run by the Job. {DATE-<Java date format>}: The date, the format in this replacement must be prefixed by DATE- and date format can be any valid Java date format. For example, {DATE-Mon-DD}. The search default pattern is *err.{PROGRAM}.{DATE-Mon-DD}. To reload the default search pattern, click Reset Default**. If this field is empty, the Agent does not search for or register output files.
Move File to Database	By default, Oracle Retail output is registered in files on the file system instead of being stored in the database. You can override that behavior and instead move the contents of the file to the database by checking this box. When this box is checked, you should also uncheck the Database checkbox on the Rapid Automation navigation tab. Otherwise the file will be removed from the file system when it is moved into the database.

Field

Description

Search Pattern

Allows you to specify how to search for output files. This field allows the following replacement values:

{PROGRAM}: The Oracle Retail program run by the Job.
{DATE-<Java date format>}: The date, the format in this replacement must be prefixed by DATE- and date format can be any valid Java date format. For example, {DATE-Mon-DD}.

The search default pattern is err.{PROGRAM}.*{DATE-Mon-DD}. To reload the default search pattern, click Reset Default.

If this field is empty, the Agent does not search for or register output files.

Move File to Database

By default, Oracle Retail output is registered in files on the file system instead of being stored in the database. You can override that behavior and instead move the contents of the file to the database by checking this box.

When this box is checked, you should also uncheck the Database checkbox on the Rapid Automation navigation tab. Otherwise the file will be removed from the file system when it is moved into the database.

Setting Additional Options

Define output settings by responding to the fields in the Oracle Retail Output box, which are described below.

Field	Description
Check Completion Status	By default when a Job completes there is SQL that is run to query the database to ensure the Job has a successful completion status, and fail the Job if not. Sometimes a Job is successful even though its completion status in the database is incorrect. When the Check Completion Status box is unchecked, the database check is not performed for the Job.
SQL Trace Level	To enable SQL trace, enter the level number for the trace.
Program Thread Refresh	Allows you to determine whether to force thread refresh. There are two options: no enforced refresh (default): Refresh is not forced. enforce refresh (deletes Retek bookmark data): The Retek bookmark information is removed regardless of the state of the Job. This is dangerous and should be used with caution.

Field

Description

Check Completion Status

By default when a Job completes there is SQL that is run to query the database to ensure the Job has a successful completion status, and fail the Job if not. Sometimes a Job is successful even though its completion status in the database is incorrect. When the Check Completion Status box is unchecked, the database check is not performed for the Job.

SQL Trace Level

To enable SQL trace, enter the level number for the trace.

Program Thread Refresh

Allows you to determine whether to force thread refresh. There are two options:

no enforced refresh (default): Refresh is not forced.
enforce refresh (deletes Retek bookmark data): The Retek bookmark information is removed regardless of the state of the Job. This is dangerous and should be used with caution.