Managing the Work of Oracle Enterprise Scheduler Jobs (2024)

SYS_EXT_cmdLine.Unix

For a process job type, this specifies a string representing the command line command on Unix.

If the SYS_cmdLine property is defined, this property is ignored.

SYS_EXT_cmdLine.Windows

For a process job type, this specifies a string representing the command line command on Windows.

If the SYS_cmdLine property is defined, this property is ignored.

SYS_EXT_ejbOperationName

[EJB_OPERATION_NAME]

Optional for EJB jobs. Specifies a pass-through parameter used by the EJB implementation to branch to the appropriate business methods.

Example: manageFileAdapter

SYS_EXT_executableDir.Unix

For a process job, this specifies the directory where the process executable is located on Unix.

SYS_EXT_executableDir.Windows

For a process job, this specifies the directory where the process executable is located on Windows.

SYS_EXT_executableName

For a process job, this specifies the name of the process executable.

SYS_EXT_executableSuffix.Unix

Specifies the suffix for SYS_EXT_executableName on Unix. The default is ".sh".

SYS_EXT_executableSuffix.Windows

Specifies the suffix for SYS_EXT_executableName on Windows. The default is ".cmd".

SYS_EXT_executeAutoExport

For process and Java job types, this specifies a value that prompts Oracle Enterprise Scheduler to automatically export any previously imported output files to the request's output directory at the start of the execute stage. Using this property assumes that the request sets the SYS_EXT_supportOutputFiles property to "output" and the SYS_EXT_executeAutoExport property to "true".

This can be useful in the case that RequestFileDirectory is a local directory and the execute stage requires access to output files that were created in the pre-processor or during a previous execution attempt, in case of retry.

SYS_EXT_fusionJob

Set this to "true" to specify that the current job is Fusion Applications CP job type.

SYS_EXT_invokeMessage

The XML submit message used to invoke the web service.

SYS_EXT_essAsyncRequestJndiMappedName

[ESS_ASYNC_REQUEST_JNDI_MAPPED_NAME]

For EJB jobs, specifies the JNDI mapped name of Oracle Enterprise Scheduler's AsyncRequest bean defined in the hosting application and bound to Oracle Enterprise Scheduler server's JNDI tree.

This property is required only if:

  • The EJB invocation is asynchronous

  • You use a hosting application other than EssNativeHostingApp is used

  • The remote bean has to call back to Oracle Enterprise Scheduler beans (for example, an asynchronous callback).

SYS_EXT_essJndiCsfKey

[ESS_JNDI_CSF_KEY_NAME]

Optional for EJB jobs. Specifies the CSF key alias of the authenticated Oracle Enterprise Scheduler server. This property is required only if the Oracle Enterprise Scheduler JNDI tree is authenticated.

Example: ess-jndi-csf-key

SYS_EXT_essMetadataJndiMappedName

[ESS_METADATA_JNDI_MAPPED_NAME]

For EJB jobs, specifies the JNDI mapped name of Oracle Enterprise Scheduler's MetadataService bean defined in the hosting application and bound to the Oracle Enterprise Scheduler server's JNDI tree.

This property is required only if you use a hosting application other than EssNativeHostingApp and the remote bean requires access to Oracle Enterprise Scheduler's metadata bean

SYS_EXT_essRuntimeJndiMappedName

[ESS_RUNTIME_JNDI_MAPPED_NAME]

For EJB jobs, specifies the JNDI mapped name of Oracle Enterprise Scheduler's RuntimeService bean that is defined in the hosting application and bound to the Oracle Enterprise Scheduler server's JNDI tree.

This property is required only if you use a hosting application other than EssNativeHostingApp and the remote bean has to call the Oracle Enterprise Scheduler runtime bean (for example, to write output or log information, submit requests or operate on requests).

SYS_EXT_jndiCSFKey

[JNDI_CSF_KEY]

Required for EJB jobs only if the JNDI tree of the EJB server is secured. Points to the CSF alias that is mapped to the user name and password in the keystore. This specific user name/password pair is the credential required to access the secured JNDI for JndiMappedName lookup.

This property can be added to either the RequestParameters object or to the Oracle Enterprise Scheduler configuration of the hosting application.

SYS_EXT_jndiProviderUrl

[JNDI_PROVIDER_URL]

Optional for EJB jobs. Specifies the URL of the remote server. Required only if the EJB is remotely located.

SYS_EXT_jndiMappedName

[JNDI_MAPPED_NAME]

Required for EJB jobs. Specifies the JNDI lookup name of a remote EJB implementation.

Example: ejb/fileAdapter

SYS_EXT_processArguments

For a process job, this specifies the arguments.

SYS_EXT_requestLogLevel

Specifies the log level for Java and PL/SQL request loggers. The default is "INFO".

SYS_EXT_resolvedCmdLine

For a process job type, after the job is successfully started, this property provides a place for Oracle Enterprise Scheduler to save the actual command line (with substitution performed). This property is for diagnostic purposes only. It is for use by Oracle Enterprise Scheduler and other values might be overwritten by the service.

SYS_EXT_supportOutputFiles

Specifies a string indicating whether the job creates files in the file system. The following values are supported:

  • "work" to create a temporary file rather than an output file.

  • "output" to use the file system to create output files.

  • "none" (or no value) to not create any files in the file system.

SYS_EXT_uploadContentToRepository

Set this to "copy" to have Oracle Enterprise Scheduler upload request log and output files from its content store to a separate repository (UCM). The request log and output content remain in the content store, but are also available to user interfaces and tools that expect log/output in UCM.

SYS_EXT_useAlternateEnvironment

Set this to "true" to get environment properties from Fusion Applications-style files. The default is "false".

SYS_EXT_useExtendedSetup

Set this to "true" to have Oracle Enterprise Scheduler set up extended functionality, such as ApplSession, for each stage of the request if that functionality is available.

SYS_EXT_userFileDirShared

For process and Java job types that may create files in the file system, this prompts Oracle Enterprise Scheduler to save in the request the configured RequestFileDirectory and RequestFileDirectoryShared from the ess-config.xml file. These values are saved as the properties SYS_userFileDir and SYS_EXT_userFileDirShared, respectively. Oracle Enterprise Scheduler uses these properties to create the request work and output directories, depending on SYS_EXT_supportOutputFiles.

This for use by Oracle Enterprise Scheduler and other values might be overwritten by the service.

SYS_EXT_wsCancelMessage

Optional. The XML message for the web service cancel operation.

SYS_EXT_wsCancelOperationName

Optional. The cancel operation name.

SYS_EXT_wsWsdlBaseUrl

The base URL part of WSDL URL.

SYS_EXT_wsWsdlUrl

The relative part of the web service WSDL URL (must be a concrete WSDL URL). Either the SYS_EXT_wsEndpointUrl property or the SYS_EXT_wsWsdlUrl property must be completely specified. For example, either wsWsdlBaseUrl and wsWsdlUrl are both configured, or wsEndpointBaseUrl and wsEndpointUrl are both configured.

SYS_EXT_wsEndpointBaseUrl

The base URL part of endpoint URL.

SYS_EXT_wsEndpointUrl

The endpoint URL for the web service. Either the SYS_EXT_wsEndpointUrl property or the SYS_EXT_wsWsdlUrl property must also be specified.

SYS_EXT_wsOperationName

The operation name.

SYS_EXT_wsPortName

The port name.

SYS_EXT_wsServiceName

The service name.

SYS_EXT_wsTargetNamespace

The target name space.

SYS_allowMultPending

Specifies whether multiple pending requests for the same job definition is allowed. This property has no meaning for a job set step. True or false.

SYS_application

Specifies the logical name of the J2EE application used for request processing. This property is automatically set by Oracle Enterprise Scheduler during request submission.

SYS_bizErrorExitCode

Specifies the process exit code for a process job request that denotes an execution business error. If this property is not specified, the system treats a process exit code of 4 as an execution business error.

This property is optional for a process job type. It is not used for other job types.

For more information about business errors, see Searching for a Job Request Using the Advanced Search Feature

SYS_className

Specifies the Java executable for a Java job request. This should be the name of a Java class that implements the oracle.as.scheduler.Executable interface. This property is required for a Java job type. It is not used for other job types.

SYS_cmdLine

Specifies the command line used to invoke an external program for a process job request.

This property is required for a Process job type. It is not used for other job types.

SYS_effectiveApplication

Specifies the logical name of the J2EE application that is the effective application used to process the request. A job definition, job type, or a job set step can be associated with a different application by defining the EFFECTIVE_APPLICATION system property. This property can only be specified using metadata and cannot be specified as a submission parameter.

SYS_environmentVariables

Specifies the environment variables to be set for the spawned process of a process job request. The property value should be a comma separated list of name value pairs (name=value) representing the environment variables to be set.

This property is optional for a Process job type. It is not used for other job types.

SYS_executePast

Specifies whether instances of a repeating request with an execution time in the past should be generated. Instances are never generated before the requested start time or after the requested end time. To cause past instances to be generated, you must set this property to TRUE and specify the requested start time as the initial time from which instances should be generated. Note that a null requested start time defaults to the current time.

Values for this property are:

  • TRUE: All instances specified by a schedule are generated regardless of the time of generation.

  • FALSE: Instances with a scheduled execution time in the past (that is, before the time of generation) are not generated.

If this property is not specified, the system defaults to TRUE.

SYS_extensionListener

For internal use only.

SYS_external_id

Specifies an identifier for an external portion of an asynchronous Java job. For example, an asynchronous Java job usually invokes some remote process and then returns control to Oracle Enterprise Scheduler. This property can be used to identify the remote process. This property should be set by the job implementation of asynchronous Java jobs when the identifier is known. It is never set by Oracle Enterprise Scheduler.

SYS_external_JobType

Optional. The supported values are “ADFBC", “OSB" or “SOA". Any other value is invalid.

SYS_groupName

Specifies the name of the Oracle Enterprise Scheduler isolation group to which this request is bound. This property is automatically set by Oracle Enterprise Scheduler during request submission.

SYS_inputList

Specifies input to a job request. The input to a serial job set is forwarded as input to the first step only. The input to a parallel job set is forwarded as input to all the parallel steps.

Oracle Enterprise Scheduler imposes no format on the value of this property.

SYS_inputWorkDirectory

Specifies the working directory used during job request processing for input files. Oracle Enterprise Scheduler sets the value of this property during job request processing.

SYS_listener

Specifies the event listener class associated with the request. This should be the name of a Java class that implements the oracle.as.scheduler.EventListener interface.

SYS_locale

Specifies a language code to apply to the job.

SYS_logicalClusterName

Oracle Enterprise Scheduler provides the means by which EJB and web service jobs can define an abstract job location. The job location is specified by the Oracle Enterprise Scheduler SYS_logicalClusterName system property and specifies a logical cluster name (LCN). If the job definition for an EJB or web service job specifies a value for an LCN, certain environment-specific properties are specified using Oracle Enterprise Manager Fusion Middleware Control at the hosting application level rather than in the job definition. All job definitions with the same LCN share the value of the properties entered in the hosting application configuration properties using Oracle Enterprise Manager Fusion Middleware Control.

In the Job Definitions > Job Definition Details page, set the SYS_logicalClusterName system property to a name that you use to define the set of location related properties (LCN) in the Configuration > Application Properties page. For more information, see Job Location Properties.

Note that the terms "logical cluster" and "job location" can be used interchangeably.

SYS_logWorkDirectory

Specifies the logging working directory. This is for use by Oracle Enterprise Scheduler and other values might be overwritten by the service.

SYS_outputList

Specifies output from a request.

The output of a serial job set is the OUTPUT_LIST of the last step. The output of a parallel job set is the concatenation of the OUTPUT_LIST of all the steps, in no guaranteed order, with oracle.as.scheduler.SystemProperty.OUTPUT_LIST_DELIMITER as a separator.

SYS_outputWorkDirectory

Specifies the working directory used during job request processing for output files. Oracle Enterprise Scheduler sets the value of this property during job request processing. This is for use by Oracle Enterprise Scheduler and other values might be overwritten by the service.

SYS_postProcess

Specifies the post-process callout handler class. This should be the name of a Java class that implements the oracle.as.scheduler.PostProcessHandler interface.

SYS_preProcess

Specifies the pre-process callout handler class. This should be the name of a Java class that implements the oracle.as.scheduler.PreProcessHandler interface.

SYS_priority

Specifies the request processing priority. The priority interval is [0...9] with 0 as the lowest priority and 9 as the highest.

Default: If this property is not specified, the system default value used is 4.

SYS_procedureName

Specifies the name of the PL/SQL stored procedure to be called for a SQL job request. The stored procedure should be specified using schema.name format.

The property is required for a SQL job type. It is not used for other job types.

SYS_product

Specifies the product within the application that submitted the request.

SYS_redirectedOutputFile

Specifies the file where standard output and error streams are redirected for a process job request. This represents the full path of the log file where the standard output and error streams are redirected for the process when the request is executed.

This is for use by Oracle Enterprise Scheduler and other values might be overwritten by the service.

SYS_reprocessDelay

Specifies the callout handler processing delay time. This represents the time, in minutes, to delay request processing when a delay is requested by a callback handler.

Default: If this property is not specified, the system default used is 5. Integer type.

SYS_EXT_requestEffectiveEncoding

Specifies the effective encoding associated with a process job request.

SpawnLauncher determines the locale setting for a spawned job request in the following precedence order:

  1. LC_ALL/LANG specified in the environment properties (SystemProperty.ENVIRONMENT_VARIABLES) for the request

  2. LC_ALL/LANG specified in the hosting application's ess-config.xml file

  3. WebLogic server LC_ALL/LANG

The effective encoding is computed before the process is spawned and is stored in this property. This is later used to determine the encoding for the request log and output.

SYS_request_timeout

Specifies that job request can time out.

SYS_requestCategory

Specifies an application-specific label for a request. The label, defined by an application or system administrator, allows administrators to group job requests according to their own specific requirements.

SYS_requestedProcessor

Specifies the request processor node on which the request should be processed. This allows processor affinity to be specified for a job request. If this property is not specified, the request can run on any available request processor node. In general, this property should not be specified.

If this property is specified for a request, the request processor's work assignments oracle.as.scheduler.WorkAssignment (specialization) must allow the execution of such requests, otherwise the request never executes. If the specified node is not running, the request remains in the READY state and does not execute until the node is restarted.

SYS_requestExpiration

Specifies the expiration time for a request. This represents the time, in minutes, that a request expires after its scheduled execution time. An expiration value of zero (0) means that the request never expires. If this property is not specified, the system default value used is 0.

Request expiration only applies to requests that are waiting to run. If a request waits longer than the specified expiration period, it does not run. After a request starts running the request expiration no longer applies.

SYS_retries

Specifies the retry limit for a failed request. If request execution fails, the request retries up to the number of times specified by this property until the request succeeds. If retry limit is zero (0), a failed request is not retried.

If this property is not specified, the system default used is 0.

SYS_runasApplicationID

This property enables elevating access privileges for completing a scheduled job.

Normally, a request runs as the submitting user. However, if this property is set in the metadata of the job associated with the request, then the request executes under the user identified by this property. This property can only be specified using metadata and cannot be specified as a submission parameter.

SYS_selectState

Specifies whether the result state of a job set step affects the eventual state of its parent job set. In order for the state of a job set step to be considered when determining the state of the job set, the SELECT_STATE must be set to true. If SELECT_STATE is not specified on a job set step, the state of the step is included in the determination of the state of the job set. Boolean type.

SYS_sqlJobClass

Specifies an Oracle Enterprise Scheduler job class to be assigned to the Oracle Enterprise Scheduler job used to execute a SQL job request. This property need not be specified unless the job used for a job request is associated with a particular Oracle Database resource consumer group or has affinity to a database service.

If this property is not specified, a default Oracle Enterprise Scheduler job class is used for the job that executes the SQL request. That job class is associated with the default resource consumer group. It belongs to the default service, such that it has no service affinity and, in an Oracle RAC environment, any one of the database instances within the cluster might run the job. No additional privilege or grant is required for an Oracle Enterprise Scheduler SQL job request to use that default job class.

This property is optional for a SQL job type. It is not used for other job types.

SYS_submittingApplication

Specifies the logical name of the J2EE application for the submitted (absolute parent) request. This property is automatically set by Oracle Enterprise Scheduler during request submission.

SYS_substitutionHandlers

This property has been deprecated.

SYS_successExitCode

Specifies the process exit code for a process job request that denotes an execution success. If this property is not specified the system treats a process exit code of 0 as execution success.

This property is optional for a process job type. It is not used for other job types.

SYS_userFileDir

Specifies a base directory in the file system where files, such as input and output files, may be stored for use by the request executable.

Oracle Enterprise Scheduler supports a configuration parameter that specifies a file directory where requests may store files. At request submission, a USER_FILE_DIR property is automatically added for the request if the configuration parameter is currently set and USER_FILE_DIR property was not specified for the request. If the property is added, it is initialized to the value of the configuration parameter. The property is not added if the configuration parameter is not set at the time of request submission.

This is for use by Oracle Enterprise Scheduler and other values might be overwritten by the service. Note that if this property is deleted, its value defaults to a system-defined value of <server log path>/ess_request/ and the value of the SYS_EXT_userFileDirShared property is assumed to be false.

SYS_userName

Specifies the name of the user used to execute the request. Normally, this is the submitting user unless the RUNAS_APPLICATIONID property was set in the job metadata. This property is automatically set by Oracle Enterprise Scheduler during request submission.

SYS_warningExitCode

Specifies the process exit code for a process job request that denotes an execution warning. If this property is not specified, the system treats a process exit code of 3 as execution warning.

This property is optional for a process job type. It is not used for other job types.

SYS_workDirectoryRoot

Specifies the working directory for the process of a process job request.

This is for use by Oracle Enterprise Scheduler and other values might be overwritten by the service.

Managing the Work of Oracle Enterprise Scheduler Jobs (2024)

References

Top Articles
Latest Posts
Article information

Author: Tyson Zemlak

Last Updated:

Views: 6311

Rating: 4.2 / 5 (43 voted)

Reviews: 90% of readers found this page helpful

Author information

Name: Tyson Zemlak

Birthday: 1992-03-17

Address: Apt. 662 96191 Quigley Dam, Kubview, MA 42013

Phone: +441678032891

Job: Community-Services Orchestrator

Hobby: Coffee roasting, Calligraphy, Metalworking, Fashion, Vehicle restoration, Shopping, Photography

Introduction: My name is Tyson Zemlak, I am a excited, light, sparkling, super, open, fair, magnificent person who loves writing and wants to share my knowledge and understanding with you.