Column Name | Data Type | Req | Description |
batch_code | Text | ■ | Valid batch control |
user_id | Text | ■ | Valid product user defined in user object. The email address specified on the user object is used to send any configured notifications. Value can be inherited from configured parameters. |
thread_count | Number | Override for thread count on batch control. | |
business_date | Date | Process date to be used for batch job. Value can be inherited from configured parameters. Value can be set using the to_date function. If no value is provided, the current date will be used. The format of the date must be in a recognizable format. For example, DD-MMM-YYYY is supported. It is recommended to use the to_date function to avoid confusion. | |
max_timeout_mins | Number | Maximum timeout, in minutes, for transactions to avoid ORA-01555 Snapshot too old errors. Default is 15. | |
rerun_number | Number | Used for rerunning specific extracts. Default is: 0 (zero) for current extract. | |
thread_pool | Text | Valid Threadpool name to execute this batch job. This corresponds to the DIST-THD-POOL parameter. If not provided at all, the value of DEFAULT is assumed. | |
min_run_status | Number | Minimum Run Status that will cause this procedure to exit. The default is RUN_STAT_COMPLETED (40). Other values supported: • 10 - RUN_STAT_PENDING • 20 - RUN_STAT_IN_PROGRESS • 30 - RUN_STAT_ERROR • 40 - RUN_STAT_COMPLETED | |
raise_error | Boolean | If the min_run_status is set a value less than 40, this parameter is set to true and the job status matches the value of the min_run_status then raise an application error. This allows the chain to support conditional branches or stop chains on conditions. Default is false. | |
thread_notifications | Boolean | Whether an error in any thread should trigger a notification event. Default is true. See Notification Options for more information. | |
single_submitter | Boolean | Whether multiple threads should be submitted as separate jobs. Set this to false to enable separate job submissions for each thread. | |
soft_parm_map | Array | Associate array of soft parameters. Refer to Specifying Job Parameters for more details. | |
soft_parm_list | Array | Table array of soft parameters. Refer to Specifying Job Parameters for more details. |
Column Name | Data Type | Req | Description |
---|---|---|---|
thread_number | Number | ■ | Thread Number to restart. For single threaded jobs, this should be set to 1. |
Column Name | Data Type | Description |
batch_code | Text | Valid batch control |
job_id | Number | Allocated job identifier from batch daemon (on ci_batch_job table). |
<scope> | Scope of the parameter. The valid values are GLOBAL for global settings or a valid Batch Control for a specific Batch Control. Settings at the Batch Control level override the GLOBAL scope. |
<parmname> | The parameter name from the list below. This setting can be overridden on the command line. |
<parmvalue> | The value of the parameter designated by <parmname> to be used for the scope designated by <scope>. |
Parameter Name | Description |
---|---|
business_date | The default business date is the database’s current system date, but this can provide an alternative default. It is typically useful in the case of jobs that run past midnight to make it maintain the same date for all the submissions. The date format is ISO format: YYYY-MM-DD. |
user_id | The user id is required for every submission but to avoid having to specify it on every Submit_Job call, this will define a default either globally or for specific batch codes. The user must be defined as a user object within the product. |
poll_seconds | By default, the batch tables are checked every 1 second for updates. This provides for very responsive job handling, but if it is too taxing on the database, the frequency can be modified with this setting. The value must be between 1 and 60. |
notify_job_name | Oracle Scheduler job OUAF_NOTIFY is the default thread notification job. That is defined out of the box to send emails for every failed thread. If that behavior is undesired, a custom thread notification, Oracle Scheduler job can be created, and it defined as the default handler with this option. The new notify Oracle Scheduler job must exist. |
thread_notifications | Set to false to suppress thread notifications for failed threads. The default is true. |
thread_pool | The default threadpool to use. The installation default threadpool is DEFAULT. |
discard_queue | Set to true to delete all unused online job queue entries (CI_BATCH_JOB rows) created by OUAF_BATCH. The default is false. OUAF_BATCH uses individual CI_BATCH_JOB rows for the threads so it may become quite voluminous, and the job queue entries are typically not useful once a thread has started executing as the Batch Run Tree entries are used to track the job. This option can be used to clean up the unused entries. |
debug | Set to true to see internally generated DBMS_OUTPUT debug messages. The default is false. Used for development purposes. |
single_submitter | Set to true to submit a separate job for each thread of batch job. Default behavior is to submit a single job for multiple threads of batch job. |
<scope> | Scope of the parameter to reset. The valid values are GLOBAL for global settings or a valid Batch Control for a specific Batch Control. |
<parmname> | The parameter name to reset. Refer to the Set Option (see Set_Option - Set a Global or Job Option) procedure for the valid list. |
Segment | Format |
---|---|
Declaration of array | declare <arrayname> OUAF_BATCH.parm_map_t; |
Definition of value | <arrayname>('<parmname>') := '<parmvalue>'; |
Use of map | soft_parm_map => <arrayname> |
<arrayname> | Name of associative array to be used as the soft_parm_map. |
<parmname> | Name of the parameter to be set. |
<parmvalue> | Value of parameter. |
<parmname> | Name of the parameter to be set |
<parmvalue> | Value of parameter |