Custom Batch Jobs

Navigate: Closed Info Center > Custom Batch Jobs

Description

Use this task to execute user-specific generic batch jobs to perform common tasks.

Steps

In the Schedule Custom Batch Job screen, make selections from the drop-down lists in the header area.
In the Schedule Batch Job panel, click the Date Picker icon to specify a date and time, or click the Recurring schedule checkbox to schedule daily or monthly batch jobs.

In the Schedule Batch Job panel, make a selection from the Occurs drop-down list to specify daily or monthly jobs.

Click Finish.

Configuration, Prerequisites, and Setup

IMPORTANT: Implementation must specify a name for the batch job and create the query to identify the data set against which the common task for each generic batch job will execute. For example, adding a flag type would require information such as flag type, expiration date, etc. Here are the configuration parameters.

Add Flag

Takes a stored procedure name when defining the batch.

Requirements for parameters (this is a 0 relative - captured in the SortOrder column in GenericBatchJobParam table):
Object type id that this process is expected to add a flag to (select * from systype where systypecatid = 7000)
Flag Header Id from the Aumentum table: FlagHeader (select * from FlagHeader)
Flag Value – systype id from the FlagValue systype category (select * from systype where systypecatid = 80016)
Start date of the flag
Termination date of flag

NOTE: Custom Batch Job recognizes the setting you define for Non workday moves to on the Maintain a Flag screen for certain batch jobs.

Remove Flag

Takes a stored procedure name when defining the batch.

Object type id that this process is expected to add a flag to (select * from systype where systypecatid = 7000)
Flag Header Id from the Aumentum table: FlagHeader (select * from FlagHeader)
Flag Value – systype id from the FlagValue systype category (select * from systype where systypecatid = 80016). This value may be left blank if the flag that is to be removed should be removed without regard of the flag’s value attribute.
Termination date of flag – If left blank the application will default to today’s date.

Add to Revenue Object List

Takes a stored procedure name when defining the batch.

The name of the Revenue Object list to add revenue object ids to.

Remove from Revenue Object List

Takes a stored procedure name when defining the batch.

The name of the Revenue Object list to remove revenue object ids from.

Start Correspondence

The id of the report setup.
Once a Correspondence Batch is run, the report correspondence output is available via the Report and Interfaces > Correspondence > Outbound Document Queue menu.

NOTE: Data sources and correspondence must be set up first via Reports and Interfaces > Data Sources and Reports and Interfaces > Correspondence, respectively.