submitbatch.properties

The submitbatch.properties controls the behavior of individual batch job threads within the batch architecture. This configuration file exists in two forms:

  • A global submitbatch.properties that defines global defaults for the implementation.
  • A set of submitbatch.properties files for individual jobs that defines any configuration overrides or specific configuration settings for an individual job.

This section outlines each setting for the configuration file.

Note:

It is recommended to use the Configuring Batch Using Bedit configuration utility to maintain this configuration file.

coherence.management.remote - Enable/Disable Remote Management of Cluster Members

Parameter coherence.management.remote
Description Property of Oracle Coherence. Enables/Disables remote management.

Note: The coherence parameter: tangosol.coherence.management may be set to none in submitbatchjob.properties, in conjunction with coherence.management.remote property set to false, to improve performance with JMX client console.

Ordinality Optional
Valid Values [true|false]
Source Maintained by product templates.
Applicability Background Processing
Example: Coherence.management.remote=false

com.ouaf.batch.jvmoptions - JVM Options

Parameter com.ouaf.batch.jvmoptions
Description Custom JVM Options for submitter.

Note: This setting can be overridden using the -z option on the submitjob.sh - Submit Batch Threads (Legacy Method of Batch Submission) command line.

Ordinality Mandatory
Valid Values Valid JVM Options for the Java version used
Source Maintained by product templates. Use Configuring Batch Using Bedit to implement a different value.
Applicability Background Processing
Example: com.ouaf.batch.jvmoptions=-Xms1024k -Xmx2048k -XX:MaxPermSize=512m

com.splwg.grid.executionMode - Mode of Execution

Parameter com.splwg.grid.executionMode
Description Execution Mode used by process.

Note: This setting can be overridden using the -e option on the submitjob.sh - Submit Batch Threads (Legacy Method of Batch Submission) command line.

Ordinality Mandatory
Valid Values [ CLUSTERED | THIN ]

Note: The THIN mode is used by the Oracle Utilities SDK and should not be used outside that tool.

Source Maintained by product templates. Use Implementing Custom Templates to implement a different value.
Applicability Background Processing
Example: com.splwg.grid.executionMode=CLUSTERED

com.splwg.batch.submitter - THIN Submitter

Parameter com.splwg.batch.submitter
Description Whether this execution can run without a threadpoolworker. Reserved for development of batch using the Oracle Utilities SDK. If set to true then, com.splwg.grid.executionMode - Online Execution Mode must be set to THIN.
Ordinality Mandatory
Valid Values [false|true]
Source Maintained by product templates for LOCAL submission.
Applicability Background Processing
Example: com.splwg.batch.submitter=true

com.splwg.batch.submitter.batchCd - Batch Code

Parameter com.splwg.batch.submitter.batchCd
Description Batch Code for bbatch specific configuration. This setting should not be set in the global submitbatch.properties file.

Note: This setting should only be set in configuration files for testing purposes. In other situations the -b option on the submitjob.sh - Submit Batch Threads (Legacy Method of Batch Submission) command line should be used.

Ordinality Mandatory
Valid Values Batch Code
Source Maintained by product templates for submission.
Applicability Background Processing
Example: com.splwg.batch.submitter.batchCd=QABATCH

com.splwg.batch.submitter.distThreadPool - Threadpool

Parameter com.splwg.batch.submitter.distThreadPool
Description Name of pool to be used for batch process. If threadpoolworker not used then LOCAL must be specified.

This can be set globally and at the individual batch job level.

Note: This setting can be overridden using the -p option on the submitjob.sh - Submit Batch Threads (Legacy Method of Batch Submission) command line.

Ordinality Mandatory
Valid Values Default: DEFAULT
Source Maintained by product templates. Use Implementing Custom Templates to implement a different value.
Applicability Background Processing
Example: com.splwg.batch.submitter.distThreadPool=DEFAULT

com.splwg.batch.submitter.languageCd - Language Code

Parameter com.splwg.batch.submitter.languageCd
Description Language code used for messages for execution of background process. Relevant language pack must be installed.

Note: This setting can be overridden using the -l option on the submitjob.sh - Submit Batch Threads (Legacy Method of Batch Submission) command line.

Ordinality Mandatory
Valid Values Default: ENG
Source Maintained by product templates. Use Implementing Custom Templates to implement a different value.
Applicability Background Processing
Example: com.splwg.batch.submitter.languageCd=ENG

com.splwg.batch.submitter.maximumCommitRecords - Commit Interval

Parameter com.splwg.batch.submitter.maximumCommitRecords
Description Commit Interval used for execution. This is the number of objects processed per work unit.

Note: This setting can be overridden using the -f option on the submitjob.sh - Submit Batch Threads (Legacy Method of Batch Submission) command line.

Ordinality Mandatory
Valid Values Job specific
Source Maintained by product templates. Use Implementing Custom Templates to implement a different value.
Applicability Background Processing
Example: com.splwg.batch.submitter.maximumCommitRecords=200

com.splwg.batch.submitter.promptForValues - Prompt for Values

Parameter com.splwg.batch.submitter.promptForValues
Description Prompt for value when running in interactive mode. This is primarily used for developers who are testing their job manually.

Note: Implementers should only use the true value if executing jobs from the Oracle Utilities SDK.

Ordinality Mandatory
Valid Values [true|false]
Source Maintained by product templates. Use Implementing Custom Templates to implement a different value.
Applicability Background Processing
Example: com.splwg.batch.submitter.promptForValues=false

com.splwg.batch.submitter.processDate - Business Date

Parameter com.splwg.batch.submitter.processDate
Description Business Date for batch process. This setting should not be set in the global submitbatch.properties file.

Note: This setting should only be set in configuration files for testing purposes. In other situations the -d option on the submitjob.sh - Submit Batch Threads (Legacy Method of Batch Submission) command line should be used.

Ordinality Mandatory
Valid Values Business Date in ISO YYYY-MM-DD format
Source Maintained by product templates for submission.
Applicability Background Processing
Example: com.splwg.batch.submitter.processDate=2015-03-08

com.splwg.batch.submitter.rerunNumber - Re Run Number

Parameter com.splwg.batch.submitter.rerunNumber
Description Rerun Number to be used for execution.

Note: Only batch controls that support rerun numbers are supported with this configuration setting.

Note: This setting can be overridden using the -r option on the submitjob.sh - Submit Batch Threads (Legacy Method of Batch Submission) command line.

Ordinality Optional
Valid Values Valid run number. A value of zero (0) denotes disables this setting.
Source Maintained by product templates. Use Implementing Custom Templates to implement a different value.
Applicability Background Processing
Example: com.splwg.batch.submitter.rerunNumber=56

com.splwg.batch.submitter.softParameter - Job Parameters

Parameter com.splwg.batch.submitter.softParameter
Description For any program-specific parameters, use this form of property specification in the format: 

com.splwg.batch.submitter.softParameter.<parmname>=<value>

The <parmname> denotes the name of the parameter. For example, to specify a number of rows to skip in <value> when submitting a validation program:

com.splwg.batch.submitter.softParameter.SKIP-ROWS=1000

Multiple soft parameters may be specified.

Note: This setting can be overridden using the -x or -X options on the submitjob.sh - Submit Batch Threads (Legacy Method of Batch Submission) command line.

Ordinality Mandatory
Valid Values Valid value for parameter
Source Maintained by product templates for submission.
Applicability Background Processing
Example: com.splwg.batch.submitter.softParameter.SKIP-ROWS=1000

com.splwg.batch.submitter.threadCount - Thread Limit

Parameter com.splwg.batch.submitter.threadCount
Description Thread limit used for execution.

Note: Only batch controls that support multithreaded are supported with this configuration setting.

Note: This setting can be overridden using the -c option on the submitjob.sh - Submit Batch Threads (Legacy Method of Batch Submission) command line.

Ordinality Mandatory
Valid Values Valid thread limit. A value of one (1) is used for single threaded jobs. Default: 1
Source Maintained by product templates. Use Implementing Custom Templates to implement a different value.
Applicability Background Processing
Example: com.splwg.batch.submitter.threadCount=1

com.splwg.batch.submitter.threadNumber - Thread Number

Parameter com.splwg.batch.submitter.threadNumber
Description Individual thread number used for execution.

Note: This setting can be overridden using the -t option on the submitjob.sh - Submit Batch Threads (Legacy Method of Batch Submission) command line.

Ordinality Mandatory
Valid Values Valid thread number. The value must be less than or equal to the com.splwg.batch.submitter.threadCount - Thread Limit. A value of zero (0) spawns multiple threads up to the limit expressed in com.splwg.batch.submitter.threadCount - Thread Limit. Default: 0
Source Maintained by product templates. Use Implementing Custom Templates to implement a different value.
Applicability Background Processing
Example: com.splwg.batch.submitter.threadNumber=0

com.splwg.batch.submitter.traceProgramEnd - Trace Program End

Parameter com.splwg.batch.submitter.traceProgramEnd
Description Enables or disables tracing for the end of the program.

Note: This setting is designed for developers and for support purposes.

Note: This setting can be overridden using the -g option on the submitjob.sh - Submit Batch Threads (Legacy Method of Batch Submission) command line.

Ordinality Mandatory
Valid Values [true|false]
Source Maintained by product templates for submission.
Applicability Background Processing
Example: com.splwg.batch.submitter.traceProgramEnd=false

com.splwg.batch.submitter.traceProgramStart - Trace Program Start

Parameter com.splwg.batch.submitter.traceProgramStart
Description Enables or disables tracing for the start of the program.

Note: This setting is designed for developers and for support purposes.

Note: This setting can be overridden using the -g option on the submitjob.sh - Submit Batch Threads (Legacy Method of Batch Submission) command line.

Ordinality Mandatory
Valid Values [true|false]
Source Maintained by product templates for submission.
Applicability Background Processing
Example: com.splwg.batch.submitter.traceProgramStart=false

com.splwg.batch.submitter.traceSQL - Trace SQL Statements

Parameter com.splwg.batch.submitter.traceSQL
Description Enables or disables tracing of ALL SQL statements executed by the program.

Note: This setting is designed for developers and for support purposes.

Note: This setting can be overridden using the -g option on the submitjob.sh - Submit Batch Threads (Legacy Method of Batch Submission) command line.

Ordinality Mandatory
Valid Values [true|false]
Source Maintained by product templates for submission.
Applicability Background Processing
Example: com.splwg.batch.submitter.traceSQL=false

com.splwg.batch.submitter.traceStandardOut - Trace Output Statements

Parameter com.splwg.batch.submitter.traceStandardOut
Description Enables or disables tracing of ALL in-program debug statements executed by the program.

Note: This setting is designed for developers and for support purposes.

Note: This setting can be overridden using the -g option on the submitjob.sh - Submit Batch Threads (Legacy Method of Batch Submission) command line.

Ordinality Mandatory
Valid Values [true|false]
Source Maintained by product templates for submission.
Applicability Background Processing
Example: com.splwg.batch.submitter.traceStandardOut=false

com.splwg.batch.submitter.userId - Security User

Parameter com.splwg.batch.submitter.userId
Description Userid used by job to check authorization to underlying application services.

Note: This setting can be overridden using the -u option on the submitjob.sh - Submit Batch Threads (Legacy Method of Batch Submission) command line.

Ordinality Mandatory
Valid Values Valid userid.

Note: The SYSUSER account should not be used for non-demonstration environments.

Source Maintained by product templates. Use Implementing Custom Templates to implement a different value.
Applicability Background Processing
Example: com.splwg.batch.submitter.userId=USER01

spl.runtime.batch.L2CacheMode - L2 Cache Control

Parameter spl.runtime.batch.L2CacheMode
Description Defines the 2nd-level cache mode. Valid values are READ_ONLY (default), READ_WRITE or OFF.  

READ_ONLY is for performance as it loads the configuration entities into the 2nd-level (JVM-level) cache and accesses them from there only. In READ_ONLY mode, the cached entities may not be updated.

READ_WRITE also loads them into the L2 cache, but they can be updated. The drawback is that an update of a cached entity hits both the database and cache as it gets updated in both places.

In OFF mode the 2nd-level cache is completely disabled. Some jobs, for example LDAP import (F1-LDAP), need to update some of these entities (e.g. User), so it requires the L2 cache to be either OFF or READ_WRITE. The choice between OFF and READ_WRITE depends on requirement; the effect is the same.

Note: This setting can be overridden using the -l2 option on the submitjob.sh - Submit Batch Threads (Legacy Method of Batch Submission) command line.

Ordinality Mandatory
Valid Values [READ_ONLY|READ_WRITE|OFF]
Source Maintained by product templates for submission.
Applicability Background Processing
Example: spl.runtime.batch.L2CacheMode=READ_ONLY

tangosol.coherence.distributed.localstorage - Cache Mode

Parameter tangosol.coherence.distributed.localstorage
Description Sets whether data is cached local or not. This is used to optimize large networks of submitters and threadpools with cache nodes.
Ordinality Mandatory
Valid Values [true|false]
Source Maintained by product templates. Use Implementing Custom Templates to implement a different value.
Applicability Background Processing
Example: tangosol.coherence.distributed.localstorage=false

tangosol.coherence.role - Submitter Role

Parameter tangosol.coherence.role
Description Sets role of Submitter. Informational information on JVM used for monitoring purposes only.
Ordinality Optional
Valid Values Generated with the name OUAF_<batchcode>_Submitter where <batchcode> is the Batch Control identifier for the batch job.
Source Maintained by product templates. Use Implementing Custom Templates to implement a different value.
Applicability Background Processing
Example tangosol.coherence.role=OUAF_QABATCH_Submitter