Shows command usage.

Shows extended help.

Generates configuration from the template and exits immediately. The configuration file name may be specified explicitly or implicitly as described under Mutually Exclusive Arguments below.

Template to use. Examples: wka for Well-Known-Addresses; mc for Multicast; ss for Single Server. This is optional. The default is determined from be.prefs, be.properties or be.default.properties, in that order.

Configures batch code specific properties files. Maintains job.<arg>.properties files.

Configures general submitter mode properties files. Supports THIN and LOCAL execution mode. Maintains submitbatch.<arg>.properties files.

Configures threadpool label specific properties files. Maintains threadpoolworker.<arg>.properties files.

Configures the cluster configuration. Shortcut name for tangosol-coherence-override.xml

Configures the base submitter configuration. Shortcut name for submitbatch.properties.

Configures the base threadpoolworker configuration. Shortcut name for threadpoolworker.properties.

The properties file to edit. This must be a valid batch properties or Coherence XML configuration override file. May be used instead of the shortcut forms above and must be the last argument if specified.

Generates ALL the base configuration files and exit. Combines -c, -w and -s option. Option -A must be the only option if specified.

Generates javadocs and update SPLWeb EAR file.

Shows usage.

Generates javadocs but skip EAR update.

blank

Configures basic configuration options.

Configures advanced configuration options.

Calculates variables only through silent mode. This refreshes ENVIRON.INI from individual changes.

Configures all configuration options (basic and advanced).

Shows usage.

Configures Installation options (used for initial installation)

blank

Performs complete extraction in default location $SPLEBASE/tools/dbstandalone.

Shows usage.

Outputs jar file to the location <location>. If you do not specify a location then it will default to the blank action.

Shows usage.

Version identifier for custom build. This is the build number that is used for CMVERSION.TXT. This parameter is required.

Directory location for files to be housed. applyCM will be run against this location in future steps. This parameter is required.

blank

Process Templates, Build WAR/EAR files and Deploy to JEE Web Application Server in one process.

Shows the usage.

Processes templates only.

Builds WAR/EAR files only.

Displays the version.

Imports Key Store from external location (KS_IMPORT_KEYSTORE_FOLDER).

Generates Key store.

Forces Task, skipping any warnings (used for silent installs only).

Fills path of list of single fixes to install. This can be generated from PatchDeployUtility (see PatchDeployUtility.sh - Create and Deploy Patch Rollups), included in a service pack, included in a fix or manually created.

Location of single fixes downloaded from My Oracle Support. These must be unzipped.

Product Name for patch file (this is the prefix of the file) (optional).

Version number of files (optional).

Environment Name to apply fixes to. Defaults to current SPLENVIRON environment variable if not specified.

Root location of software for environment. Must match value in /etc/cistab (see cistab - Global Configuration Files). Defaults to current SPLEBASE environment variable if not specified.

Name of log file to output. Defaults to install.log if not specified.

Specifies that active threads should be canceled. Can be used with –f option to cancel only batch processes matching the regular expression provided.

 

Note: Canceled threads are marked with the date, time, userid and IP address of the user who initiated the cancel command.

Displays the details of the currently active threads.

If a large number of threads are currently active, a filter can be supplied to only display or cancel threads that match the regex based pattern.

 

For example the threadpool be filtered to show only the BAT1 with the option:

 

-f .*BAT1.* as follows:

 

 

Display the available options and their descriptions.

JMX URL to perform the action against (Required).

This should match the spl.runtime.management.connector.url.default property specified in the threadpoolworker.properties.

Specifying this option will result in the cancellation of all currently running threads and the stoppage of the threadpoolworker process.

 

Note: Active threads within a canceled threadpoolworker are marked with the date, time, userid and IP address of the user who initiated the kill command.

By default, all logging information is displayed and logged using log4j2. Supplying this option will result in only select information being displayed to the system output.

Display the summary of the currently active threads is a listing format.

Amount of time, in ms, to wait as expressed in <wait> for active jobs to cancel.

Display the cache details. Must be used in conjunction with -j option.

Shows usage for patch.

Shows usage of command.

Displays version of patch.

Database Password for applying patch.

Location of tools bin directory.

Additional parameters passed to utility (in accordance with patch documentation). This must be the last parameter on the command line. This is primarily used by the Application Management Pack for Oracle Utilities.

The full path and file name to the patchdependency.txt file of the patch to use as a reference point. This parameter is used by the REPORT mode only and is required for that mode.

Mode. Supported values: REPORT, DOWNLOAD or ROLLUP.

Full path and file name for output for REPORT mode. This file will contain the list of fixes that have not been downloaded. This parameter is used by the REPORT mode only and is required for that mode.

Full path to location where any missing patches will be downloaded to when using the DOWNLOAD mode. This is also used by the ROLLUP mode as a source directory.

Fills to location where the rollup files will be generated. This is the location used by the installSFGroup (see installSFGroup.sh - Install Software Patches) and ouafDatabasePatch (see ouafDatabasePatch.sh - Install Database Patches)utilities will be executed from. This parameter is by the ROLLUP mode only and is required for that mode.

Full patch and file name of the missing patches generated by the REPORT mode. This parameter is used by DOWNLOAD and ROLLUP modes.

blank

Finds all of the WebLogic servers running on the machine.

Filters the output by environment name. If it is found then output a 1 return code.

Do not put output on screen. Useful for custom scripting.

<environment> is the environment id as installed in the cistab file.

Runs <command> after running splenviron.sh. Command must be enclosed in double quotes (""). Default is shell (for example: ksh).

Quiet Mode. Do not show output from command. Any output from the –c command will be shown.

Shows usage.

blank

Runs the [threadpoolworker options] in the background (nohup).

Shows usage.

Runs the [threadpoolworker options] in the foreground.

Batch control of the batch process to submit. When submitting a batch process, a batch code is always required. The parameters are defaulted from the batch control. Override parameters can be provided using the -x option. This is the only mandatory parameter for calling this script.

Previous rerun number of the batch that needs re-submission.

Batch submission user. Defaults to the user used for login.

Email ID to which notification should be sent on batch completion.

Language to be used for batch process.

Desired batch job execution start date time. Defaults to current date time.

Number of threads to be used for running the batch. Defaults to the value from corresponding batch control.

Batch thread number that needs re-submission

Batch business date in YYYY-MM-DD format. Defaults to current date.

Maximum commit records to override commit interval. Defaults to 1.

Maximum timeout in minutes, to override program's timeout.

To trace the start of program for troubleshooting purposes. Defaults to false.

To trace exit of program for troubleshooting purposes. Defaults to false.

To trace SQL executions for trouble shooting purposes.

To trace standard out of background processes for troubleshooting purposes.

Batch job extra parameters can be set as comma delimted list of parameter & value. Any parameter passed must already be defined on the batch control. Defaults to batch control configuration.

Login details can be provided in the format UserID:Password. If not provided, environment variables SUBMITREST_USER and SUBMITREST_PWD must be set.

Complete REST URI for batch job submission. If not provided, either the environment variables WEB_HOST, WEB_SSLPORT/WEB_PORT and WEB_CONTEXT_ROOT must be set (OR) SPLEBASE must be set to get the environment details WEB_WLHOST, WEB_WLSSLPORT/WEB_WLPORT and WEB_CONTEXT_ROOT from ENVIRON.INI.

Interval time in seconds, to wait between polling of batch job status. Default value is 10 seconds, which is also the minimum value that can be provided. Provide larger values for long running batches to save resource usage.

Batch code of the batch process to submit. When submitting a batch process, a batch code is always required. Either this option or –P may be specified, not both.

 

If this option is specified, submitjob will use the supplied batch code to look for a default properties file for that batch code (for example: VAL-SA.properties or VAL-SA.properties.xml as discussed above) and use those properties if found.

Concurrent number of threads in which to run the process.

Process / business date.

Format is YYYY-MM-DD

Execution mode for this submission. If execution mode THIN is selected, the JVM will create a full application context and run the batch process inside the JVM – that is, it will not be submitted to a thread pool for a worker JVM to pick up and run. This is analogous to running the batch process using the existing SPLBATCH.sh utility.

 

THIN mode is for development purposes only.

 

If CLUSTERED is selected, the batch process will be submitted to run in the specified distributed thread pool (option –p). It is also possible to have the submitter JVM be a worker JVM and run the batch process (like THIN mode, but in parallel threads). See option –L.

Record commits frequency count.

Positional tracing switches:

For example, NNYN will trace all SQL statements. Value of NNNN disables all tracing.

Shows help information. Displays the available options and their descriptions. The information is not logged.

Port number of RMI Registry to start and/or reference. If specified with -R, this number will be used only to substitute applicable URL {port} references. This option will not add any new RMI/JMX properties - it can only be used to override existing ones. See note below.

Do not start JMX connector. This option disables JMX monitoring for this JVM. As far as submitjob is concerned, options –i, -R and –J are only applicable to batch processes submitted in THIN mode, or CLUSTERED mode to the LOCAL thread pool.

 

For each property prefixed by spl.runtime.management.connector.url that is defined with the default set of properties (for example: in the submitbatch.properties file), the framework will start a JMX Connector for the specified URL.

 

This activates JMX monitoring inside the worker node so that a client JMX console can be used to monitor and manage active threads. If this option is specified, the framework will not start any JMX connectors.

-l <ENG|FRA|etc.>

Language code. Relevant language pack must be installed.

Submit this batch to the LOCAL thread pool (this JVM). Only applicable for CLUSTERED mode. If specified, any default thread pool property is ignored. This option and -p are mutually exclusive.

 

By specifying option –L, the batch process is submitted to the LOCAL thread pool that every submitter JVM offers by default. This option is only applicable in a CLUSTERED mode execution (-e). This is like submitting the batch process in THIN mode (that is, a worker JVM is not needed to run the batch process), except thread pool LOCAL can run multiple batch threads concurrently.

 

For example, the following command will run batch process VAL-SA inside this submitter JVM (LOCAL thread pool) in 8 threads concurrently: submitjob.sh –b VAL-SA –c 8 –L –e CLUSTERED

Send a notification email when a batch process has ended to <email address>. See Sending Emails at the Conclusion of Batch Processes for more information.

Distributed thread pool in which to run the batch process. This option and -L are mutually exclusive.

Issue console prompts for the standard batch process parameters. When submitting a batch process, a batch code is always required. Either this option or –b may be specified, not both. If –P is specified, the submitter JVM will prompt for the batch code and other run parameters. If a batch-specific properties file exists for the batch code entered at the prompt, it will NOT be used; the only defaults in effect would be the ones specified in submitbatch.properties.

Preview of the properties that would be in use for the run without running the application. Specify other options along with this option to show how they would override or substitute the default properties. The information is not logged.

Do not start a local RMI registry. As far as submitjob is concerned, options –i, -R and –J are only applicable to batch processes submitted in THIN mode, or CLUSTERED mode to the LOCAL thread pool. If property spl.runtime.management.rmi.port is defined as a default property (for example: in the submitbatch.properties file), the batch framework will attempt to start an RMI registry on the given port number.

This option can be used to suppress the automatic RMI registry startup. It may be required if an externally started RMI registry is already running. Note that if this option is used, the RMI port number supplied through the –i option is only used for substitution in the JMX Connector URLs.

Runs the number of batch process to rerun.

Space name for hard partition of workers. Default is MAIN. Used for development only.

Number of individual threads for this submission. Specify 0 to automatically submit all threads.

Application user id used for batch process

name=value pairs of INDIVIDUAL soft parameters expected by the batch program. Value portion may be enclosed in quotes. These parameters will be merged with any existing (defaulted) soft parameters. This option and -X are mutually exclusive.

name=value pairs of ALL soft parameters expected by the batch program. Value portion may be enclosed in quotes. These parameters will replace all existing (defaulted) soft parameters. This option and -x are mutually exclusive.

Java options to use for submitter.

This utility returns two return codes:

Zero (0) - The job or thread was successful.

Non-Zero - The job or thread was NOT successful.

Whether the node is acting as a scheduler daemon. Specify N for No and Y for Yes. If you are already using a scheduler daemon in the online system or are not using online submission, then set this to N. Default is N.

Execution mode for this threadpool. If CLUSTERED is the threadpool will join the cluster specified in the threadpoolworker.properties file.

Shows command line help. Lists the available options and their descriptions. It is formatted for a 121-column width display. The information is not logged.

Overrides port number for JMX. If specified with -R, this number will be used only to substitute applicable URL {port} references. This option will not add any new RMI/JMX properties - it can only be used to override existing ones. This option specifies the port number to:

Use this command when the framework starts an RMI Registry and

Substitute in all JMX Connector URL {port} references.

Do not start JMX monitoring. For each property prefixed by spl.runtime.management.connector.url that is defined with the default set of properties (for example: in the threadpoolworker.properties file), the framework will start a JMX Connector for the specified URL. This activates JMX monitoring inside the worker node so that a client JMX console can be used to monitor and manage active threads. If this option is specified, the framework will not start any JMX connectors.

Enables or disables batch caching.

 

Default: READ_WRITE, OFF and READ_ONLY are reserved for specific processes.

 

The value of OFF is used for selected utilities such as Content Migration Assistant and deployment utilities.

Thread pools offered by this worker node. Consists of one or more name=value pairs, where "name" is the name of the pool and "value" the number of threads offered in the pool. For example, DEFAULT=5,ONLINE=3

Preview of the properties that would be active for this run. Used for testing. Preview of the properties that would be in use for the run without running the application. Specify other options along with this option to show how they would merge with, override or substitute the default properties. The information is not logged.

Do not start a local RMI registry. If property spl.runtime.management.rmi.port is defined as a default property (for example: in the threadpoolworker.properties file), the batch framework will attempt to start an RMI registry on the given port number. This option can be used to suppress the automatic RMI registry startup. It may be required if an externally started RMI registry is already running.

 

Note: If this option is used, the RMI port number supplied through the –i option is only used for substitution in the JMX Connector URLs.

Space name for "hard partition" of workers. Default is MAIN. Reserved for internal use only.

Generates or appends command to a script. Reserved for system use.

Adds line to script reference. Reserved for system use.

Adds or override JVM options for threadpool.