Skip navigation links

oracle.as.scheduler
Class SystemProperty

java.lang.Object
oracle.as.scheduler.SystemProperty

public class SystemProperty

extends java.lang.Object

Enterprise Scheduler system properties. System properties represent request parameters that are known to and used by the Enterprise Scheduler system in some manner.

System properties can be specified for application metadata and for request parameters when a request is submitted. Certain system properties are set Enterprise Scheduler when a request is submitted or at some point in the lifecycle of the request.

Most system properties are common to all job types while some system properties are specific to a particular job type. Unless indicated otherwise, assume that system properties defined by this class are common to all job types.

Enterprise Scheduler reserves "SYS_" (case-insensitive) propery name prefix for Enterprise Scheduler defined properties.

Field Summary

static java.lang.String	ALLOW_MULT_PENDING Property that specifies whether multiple pending requests for the same JobDefinition shall be allowed.
static java.lang.String	APPLICATION Property that specifies the name of the J2EE application that is used for request processing.
static java.lang.String	ASYNC_REQUEST_TIMEOUT Property that specifies the time in minutes that the processor will wait for an asynchronous after it has begun execution.
static java.lang.String	BIZ_ERROR_EXIT_CODE Property that specifies the process exit code for a Process job request that denotes an execution business error.
static java.lang.String	CLASS_NAME Property that specifies the Java executable for a Java job request.
static java.lang.String	CMDLINE Property that specifies the command line used to invoke an external program for a Process job request.
static java.lang.String	CMDLINE_PREFIX Prefix for extended OS-specific command line SystemProperties
static java.lang.String	CMDLINE_UNIX Indicates the full command line for executing a Process type request executable on a Unix or Unix-like operating system.
static java.lang.String	CMDLINE_WINDOWS Indicates the full command line for executing a Process type request executable on a Windows operating system.
static java.lang.String	DEFAULT_EFFECTIVE_APPLICATION
static java.lang.String	EFFECTIVE_APPLICATION Property that specifies the name of the J2EE application that will be the effective application for the request.
static java.lang.String	ENVIRONMENT_VARIABLES Property that specifies the environment variables to be set for the spawned process of a Process job request.
static java.lang.String	EXECUTABLE_DIR_PREFIX Prefix for extended OS-specific executable directory SystemProperties
static java.lang.String	EXECUTABLE_DIR_UNIX Property that indicates the directory where the executable resides for a Process type request on a Unix or Unix-like operating system.
static java.lang.String	EXECUTABLE_DIR_WINDOWS Property that indicates the directory where the executable resides for a Process type request on a Windows operating system.
static java.lang.String	EXECUTABLE_NAME The name of the executable for a Process type request.
static java.lang.String	EXECUTABLE_SUFFIX_UNIX Property that indicates the file extension of the executable for a Process type request if executed on a generic Unix or Unix-like operating system.
static java.lang.String	EXECUTABLE_SUFFIX_WINDOWS Property that indicates the file extension of the executable for a Process type request if executed on a Windows operating system.
static java.lang.String	EXECUTE_AUTO_EXPORT Property that specifies whether the request's previously imported output content shall be automatically exported to the request's output directory before the job's execute stage runs.
static java.lang.String	EXECUTE_PAST Property that specifies whether instances of a repeating request with an execution time in the past should be generated.
static java.lang.String	EXTENSION_LISTENER Property that specifies the extension event listener class associated with the request.
static java.lang.String	EXTERNAL_ID Property that specifies an identifier for an external portion of an Enterprise Scheduler asynchronous Java job.
static java.lang.String	FUSION_JOB Property that indicates whether the job associated with this request is a Fusion job.
static java.lang.String	GROUP_NAME Property that specifies the name of the ESS configuration group to which this request is bound.
static java.lang.String	INPUT_LIST Property that specifies input to a request.
static java.lang.String	INPUT_WORK_DIR Property that specifies the work directory used during request processing for input files.
static java.lang.String	LISTENER Property that specifies the event listener class associated with the request.
static java.lang.String	LOCALE Property that specifies the locale associated with the request.
static java.lang.String	LOG_WORK_DIR Property that specifies the work directory used during request processing for log files.
static java.lang.String	OUTPUT_LIST Property that specifies output from a request.
static java.lang.String	OUTPUT_LIST_DELIMITER Delimiter to be used when building an OUTPUT_LIST value.
static java.lang.String	OUTPUT_WORK_DIR Property that specifies the work directory used during request processing for output files.
static java.lang.String	POST_PROCESS Property that specifies the post-process callout handler class.
static java.lang.String	PRE_PROCESS Property that specifies the pre-process callout handler class.
static java.lang.String	PRIORITY Property that specifies the request processing priority.
static java.lang.String	PROCEDURE_NAME Property that specifies the name of the PLSQL stored procedure to be called for a SQL job request.
static java.lang.String	PROCESS_ARGUMENTS Property that indicates the arguments passed to the executable of a Process type spawned process.
static java.lang.String	PRODUCT Property that specifies the product within the application that submitted the request.
static java.lang.String	REDIRECTED_OUTPUT_FILE Property that specifies the file where standard output and error streams are redirected for a Process job request.
static java.lang.String	REPROCESS_DELAY Property that specifies the callout handler processing delay time.
static java.lang.String	REQUEST_CATEGORY Property that specifies an application-specific label for a request.
static java.lang.String	REQUEST_EXPIRATION Property that specifies the expiration time for a request.
static java.lang.String	REQUEST_LOG_LEVEL Property that specifies the log level for request logging.
static java.lang.String	REQUESTED_PROCESSOR Property that specifies the request processor node on which the request should be processed.
static java.lang.String	RESOLVED_CMDLINE Property that specifies the command line used for a Process type job request.
static java.lang.String	RETRIES Property that specifies the retry limit for a failed request.
static java.lang.String	RUNAS_APPLICATIONID Property that specifies a job runas ApplicaitonId.
static java.lang.String	SELECT_STATE Property that specifies whether the result state of a JobSet step should be included when determining the state of the JobSet.
static java.lang.String	SQL_JOB_CLASS Property that specifies an Oracle Scheduler job class to be assigned to the Oracle Scheduler job used to execute an SQL job request.
static java.lang.String	SUBMITTING_APPLICATION Property that specifies the name of the J2EE application for the submitted (absolute parent) request.
static java.lang.String	SUBSTITUTION_HANDLERS Deprecated. Property that specifies a substitution handler class or list of classes that should be used for parameter substitution. The property value can specify a single Java class name, or it specify a comma-seperated set of Java class names. The Java class must implement the SubstitutionHandler interface. Enterprise Scheduler will use this property when executing a Process job type to provide substition support for the CMDLINE and ENVIRONMENT_VARIABLES system properties. The property datatype is STRING.
static java.lang.String	SUCCESS_EXIT_CODE Property that specifies the process exit code for a Process job request that denotes an execution success.
static java.lang.String	SUPPORT_OUTPUT_FILES Property that specifies whether the request will create temporary or output files.
static java.lang.String	SUPPORT_OUTPUT_FILES_NONE Mode for SUPPORT_OUTPUT_FILES that indicates no request directories shall be created.
static java.lang.String	SUPPORT_OUTPUT_FILES_OUTPUT Mode for SUPPORT_OUTPUT_FILES that indicates both the request work and output directories shall be created.
static java.lang.String	SUPPORT_OUTPUT_FILES_WORK Mode for SUPPORT_OUTPUT_FILES that indicates only the work directory shall be created.
static java.lang.String	SYS_PROPERTY_PREFIX Property name prefix for Enterprise Scheduler system properties.
static java.lang.String	SYSEXT_PROPERTY_PREFIX
static java.lang.String	UPLOAD_CONTENT_TO_REPOSITORY Property that indicates whether to upload request log and output files to a separate repository, such as Universal Content Management (UCM), from the internal repository when the request execution completes.
static java.lang.String	UPLOAD_CONTENT_TO_REPOSITORY_COPY Mode for UPLOAD_CONTENT_TO_REPOSITORY that indicates copying the content from the content store to the repository, while retaining the content in the content store.
static java.lang.String	USE_ALTERNATE_ENV This property indicates whether to use an alternative environment from a callout rather than the normal application environment.
static java.lang.String	USE_EXTENDED_SETUP Property that indicates whether to initiate capabilities, like ApplSessions, prior to invoking the job-related code such as the job executable or preprocess handler, postprocess handler.
static java.lang.String	USER_FILE_DIR Property that 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.
static java.lang.String	USER_FILE_DIR_SHARED Property that specifies whether the request's USER_FILE_DIR (configured RequestFileDir) directory is shared.
static java.lang.String	USER_NAME Property that specifies the name of the user who submitted the request.
static java.lang.String	WARNING_EXIT_CODE Property that specifies the process exit code for a Process job request that denotes an execution warning.
static java.lang.String	WORK_DIR_ROOT Property that specifies the working directory for the spawned process of a Process job request.

Constructor Summary

SystemProperty()

Method Summary

static java.util.Set<java.lang.String>	getCorePropNames() Get the core system properties.
static java.util.Set<java.lang.String>	getExtendedPropNames() Get the extended system properties.
static java.util.Set<java.lang.String>	getInternalOnlyProps() Return the set of system properties that should not be set except by ESS internals.
static java.util.Set<java.lang.String>	getMetadataOnlyProps() Return the set of system properties that can be set in meta-data but should not be set at submission.
static java.util.Enumeration<java.lang.String>	getNames() Returns the names of the system properties.
static java.util.Set<java.lang.String>	getReadOnlySysProps() Return the set of system properties that cannot be updated after submission through normal channels.
static ParameterInfo	getSysPropInfo(java.lang.String name) Returns the information for the system property identified by the given name.
static boolean	isCoreSystemProp(java.lang.String name) Indicates whether the given system property is a core system property.
static boolean	isInternalOnly(java.lang.String name) Determine if the given system property that should not be set except by ESS internals.
static boolean	isMetadataOnly(java.lang.String name) Determine if the given system property can be set in meta-data but not at submission.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DEFAULT_EFFECTIVE_APPLICATION

public static final java.lang.String DEFAULT_EFFECTIVE_APPLICATION

See Also:

Constant Field Values

SYS_PROPERTY_PREFIX

public static final java.lang.String SYS_PROPERTY_PREFIX

Property name prefix for Enterprise Scheduler system properties. Enterprise Scheduler reserves this property name prefix (case-insensitive) for defined system properties.

See Also:

Constant Field Values

SYSEXT_PROPERTY_PREFIX

public static final java.lang.String SYSEXT_PROPERTY_PREFIX

See Also:

Constant Field Values

OUTPUT_LIST_DELIMITER

public static final java.lang.String OUTPUT_LIST_DELIMITER

Delimiter to be used when building an OUTPUT_LIST value.

This constant does not represent a system property name. It is simply the delimiter used to build the value for the OUTPUT_LIST property.

See Also:

Constant Field Values

CMDLINE_PREFIX

public static final java.lang.String CMDLINE_PREFIX

Prefix for extended OS-specific command line SystemProperties

See Also:

Constant Field Values

EXECUTABLE_DIR_PREFIX

public static final java.lang.String EXECUTABLE_DIR_PREFIX

Prefix for extended OS-specific executable directory SystemProperties

See Also:

Constant Field Values

UPLOAD_CONTENT_TO_REPOSITORY_COPY

public static final java.lang.String UPLOAD_CONTENT_TO_REPOSITORY_COPY

Mode for UPLOAD_CONTENT_TO_REPOSITORY that indicates copying the content from the content store to the repository, while retaining the content in the content store.

See Also:

Constant Field Values

SUPPORT_OUTPUT_FILES_NONE

public static final java.lang.String SUPPORT_OUTPUT_FILES_NONE

Mode for SUPPORT_OUTPUT_FILES that indicates no request directories shall be created. This is appropriate for a job that does not create any files in the file system, whether temporary or output.

See Also:

Constant Field Values

SUPPORT_OUTPUT_FILES_WORK

public static final java.lang.String SUPPORT_OUTPUT_FILES_WORK

Mode for SUPPORT_OUTPUT_FILES that indicates only the work directory shall be created. This is appropriate for a job that creates temporary files ant not output files.

See Also:

Constant Field Values

SUPPORT_OUTPUT_FILES_OUTPUT

public static final java.lang.String SUPPORT_OUTPUT_FILES_OUTPUT

Mode for SUPPORT_OUTPUT_FILES that indicates both the request work and output directories shall be created. This is appropriate for a job that creates output files and may or may not create temporary files.

See Also:

Constant Field Values

APPLICATION

public static final java.lang.String APPLICATION

Property that specifies the name of the J2EE application that is used for request processing. This property is set by ESS.

The property datatype is STRING.

See Also:

Constant Field Values

EFFECTIVE_APPLICATION

public static final java.lang.String EFFECTIVE_APPLICATION

Property that specifies the name of the J2EE application that will be the effective application for the request.

This property is valid only for metadata of a job or jobset definition. It can be used to specify the J2EE application that should be used for a request for that definition. At runtime request validation, the value of this property is used to set the APPLICATION system property for that request if it is present in the definition metadata.

If this property is set in the metadata for a jobset, then at runtime, this value is used to set the APPLICATION property of that JobSet request and all step requests of that jobset, unless the EFFECTIVE_APPLICATION property is set in the definiton for a given step in which case the value from the definition for that step has precedence.

The property datatype is STRING.

See Also:

Constant Field Values

SUBMITTING_APPLICATION

public static final java.lang.String SUBMITTING_APPLICATION

Property that specifies the name of the J2EE application for the submitted (absolute parent) request. This property is set by ESS.

The property datatype is STRING.

See Also:

Constant Field Values

PRODUCT

public static final java.lang.String PRODUCT

Property that specifies the product within the application that submitted the request.

The property datatype is STRING.

See Also:

Constant Field Values

USER_NAME

public static final java.lang.String USER_NAME

Property that specifies the name of the user who submitted the request.

The property datatype is STRING.

See Also:

Constant Field Values

REQUEST_CATEGORY

public static final java.lang.String REQUEST_CATEGORY

Property that 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 needs.

The property datatype is STRING.

See Also:

Constant Field Values

GROUP_NAME

public static final java.lang.String GROUP_NAME

Property that specifies the name of the ESS configuration group to which this request is bound.

The property datatype is STRING.

See Also:

Constant Field Values

CLASS_NAME

public static final java.lang.String CLASS_NAME

Property that specifies the Java executable for a Java job request. This should be the name of a Java class that implements the Executable interface.

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

The property datatype is STRING.

See Also:

Constant Field Values

PROCEDURE_NAME

public static final java.lang.String PROCEDURE_NAME

Property that specifies the name of the PLSQL 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.

The property datatype is STRING.

See Also:

Constant Field Values

SQL_JOB_CLASS

public static final java.lang.String SQL_JOB_CLASS

Property that specifies an Oracle Scheduler job class to be assigned to the Oracle Scheduler job used to execute an SQL job request. This property does not need to be specified unless the Oracle Scheduler job used for a request should be associated with a particular Oracle Database resource consumer group or have affinity to a database service.

Enterprise Scheduler uses an Oracle Scheduler job to execute the PLSQL stored procedure for a SQL job request. An Oracle Scheduler job class can be associated with the Scheduler job when that job needs to have affinity to a database service or is to be associated with an Oracle Database resource consumer group. The Oracle Scheduler job owner must have EXECUTE privilege on the Oracle Scheduler job class in order to successfully create a Scheduler job using that job class.

If this property is not specified,a default Oracle Scheduler job class is used for the Oracle Scheduler job. That job class is associated with the default resource consumer group. It will belong to the default service, which means it will have no service affinity and, in an Oracle RAC enviroment, any one of the database instances within the cluster might run the Scheduler job. No additional privilege grant is needed for an Enterprise Scheduler SQL request to use that default job class.

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

The property datatype is STRING.

See Also:

Constant Field Values

CMDLINE

public static final java.lang.String CMDLINE

Property that specifies the command line used to invoke an external program for a Process job request.

NOTE: This property is not the standard way to set the command line. See EXECUTABLE_DIR_UNIX, EXECUTABLE_DIR_WINDOWS, EXECUTABLE_SUFFIX_UNIX, EXECUTABLE_SUFFIX_WINDOWS.

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

Enterprise Scheduler will perform substitution when evaluating the value of this property using the default substitution handlers.

The property datatype is STRING.

See Also:

Constant Field Values

INPUT_LIST

public static final java.lang.String INPUT_LIST

Property that specifies input to a request. The input to a serial JobSet is forwarded as input to the first step only. The input to a parallel JobSet is forwarded as input to all the parallel steps.

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

The property datatype is STRING.

See Also:

Constant Field Values

OUTPUT_LIST

public static final java.lang.String OUTPUT_LIST

Property that specifies output from a request. The output of a serial JobSet is the OUTPUT_LIST of the last step. The output of a parallel JobSet is the concatenation of the OUTPUT_LIST of all the steps, in no guaranteed order, with OUTPUT_LIST_DELIMITER as a separator.

The property datatype is STRING.

See Also:

Constant Field Values

LOCALE

public static final java.lang.String LOCALE

Property that specifies the locale associated with the request.

The property datatype is STRING.

See Also:

Constant Field Values

PRIORITY

public static final java.lang.String PRIORITY

Property that specifies the request processing priority. The priority interval is [0..9] with 0 as the lowest priority and 9 as the highest. If this property is not specified, the system default value used is 4.

The property datatype is INTEGER.

See Also:

Constant Field Values

RETRIES

public static final java.lang.String RETRIES

Property that specifies the retry limit for a failed request. If request execution fails, the request will retried up to the number of times specified by this property until the request succeeds. If retry limit is zero (0), a failed request will not be retried. If this property is not specified, the system default used is 0.

The property datatype is INTEGER.

See Also:

Constant Field Values

PRE_PROCESS

public static final java.lang.String PRE_PROCESS

Property that specifies the pre-process callout handler class. This should be the name of a Java class that implements the PreProcessHandler interface.

The property datatype is STRING.

See Also:

Constant Field Values

POST_PROCESS

public static final java.lang.String POST_PROCESS

Property that specifies the post-process callout handler class. This should be the name of a Java class that implements the PostProcessHandler interface.

The property datatype is STRING.

See Also:

Constant Field Values

REPROCESS_DELAY

public static final java.lang.String REPROCESS_DELAY

Property that 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. If this property is not specified, the system default used is 5.

The property datatype is INTEGER.

See Also:

PreProcessHandler, PostProcessHandler, Constant Field Values

LISTENER

public static final java.lang.String LISTENER

Property that specifies the event listener class associated with the request. This should be the name of a Java class that implements the EventListener interface.

The property datatype is STRING.

See Also:

Constant Field Values

EXTENSION_LISTENER

public static final java.lang.String EXTENSION_LISTENER

Property that specifies the extension event listener class associated with the request. This must be the name of a Java class that implements the EventListener interface.

The property datatype is STRING.

See Also:

Constant Field Values

REQUEST_EXPIRATION

public static final java.lang.String REQUEST_EXPIRATION

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

The property datatype is INTEGER.

See Also:

Constant Field Values

ENVIRONMENT_VARIABLES

public static final java.lang.String ENVIRONMENT_VARIABLES

Property that 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.

NOTE: This property is not the standard way to set environment variables. It is usually done through the application's ESS configuration file.

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

Enterprise Scheduler will perform substitution when evaluating the value of this property using the default substitution handlers.

The property datatype is STRING.

See Also:

Constant Field Values

WORK_DIR_ROOT

public static final java.lang.String WORK_DIR_ROOT

Property that specifies the working directory for the spawned process of a Process job request.

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

The property datatype is STRING.

See Also:

Constant Field Values

LOG_WORK_DIR

public static final java.lang.String LOG_WORK_DIR

Property that specifies the work directory used during request processing for log files.

See Also:

Constant Field Values

INPUT_WORK_DIR

public static final java.lang.String INPUT_WORK_DIR

Property that specifies the work directory used during request processing for input files.

See Also:

Constant Field Values

OUTPUT_WORK_DIR

public static final java.lang.String OUTPUT_WORK_DIR

Property that specifies the work directory used during request processing for output files.

See Also:

Constant Field Values

REDIRECTED_OUTPUT_FILE

public static final java.lang.String REDIRECTED_OUTPUT_FILE

Property that 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 spawned process when the request is executed.

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

The property datatype is STRING.

See Also:

Constant Field Values

REQUESTED_PROCESSOR

public static final java.lang.String REQUESTED_PROCESSOR

Property that specifies the request processor node on which the request should be processed. This allows processor affinity to be specified for a 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 WorkAssignments (specialization) must allow the execution of such requests, otherwise the request will never be executed. If the specified node is not running, the request will remain in WAIT state and will not be executed until the node is restarted.

The property datatype is STRING.

See Also:

Constant Field Values

SUCCESS_EXIT_CODE

public static final java.lang.String SUCCESS_EXIT_CODE

Property that 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.

The property datatype is STRING.

See Also:

Constant Field Values

WARNING_EXIT_CODE

public static final java.lang.String WARNING_EXIT_CODE

Property that 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.

The property datatype is STRING.

See Also:

Constant Field Values

BIZ_ERROR_EXIT_CODE

public static final java.lang.String BIZ_ERROR_EXIT_CODE

Property that 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 execution business error.

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

The property datatype is STRING.

See Also:

Constant Field Values

EXECUTE_PAST

public static final java.lang.String EXECUTE_PAST

Property that specifies whether instances of a repeating request with an execution time in the past should be generated. Instances will never be generated before the requested start time nor after the requested end time.

Note that a null requested start time defaults to the current 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.

Valid values for this property are:

• {code true} All instances specified by a schedule that are within the range specified by requested start time to requested end time will be generated regardless of the time of generation.
• false Instances with a scheduled execution time in the past (that is, before the time of generation) will not be generated.

If this property is not specified, system default used is true.

The property datatype is BOOLEAN.

See Also:

Constant Field Values

USER_FILE_DIR

public static final java.lang.String USER_FILE_DIR

Property that 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.

Enterprise Scheduler supports a configuration parameter that specifies a file directory where requests may store files. At request submission, a USER_FILE_DIR property will automatically be 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 will be initialized to the value of the configuration parameter. The property will not be added if the configuration parameter is not set at time of request submission.

The property datatype is STRING.

See Also:

Constant Field Values

ALLOW_MULT_PENDING

public static final java.lang.String ALLOW_MULT_PENDING

Property that specifies whether multiple pending requests for the same JobDefinition shall be allowed. This property has no meaning for a jobset step.

Valid values for this property are:

• true Multiple pending requests are allowed.
• false Multiple pending requests are not allowed.

If this property is not specified, system default used is true.

The property datatype is BOOLEAN.

See Also:

Constant Field Values

SELECT_STATE

public static final java.lang.String SELECT_STATE

Property that specifies whether the result state of a JobSet step should be included when determining the state of the JobSet.

Valid values for this property are:

• true Include the step's state as part of the JobSet state.
• false Do not include the step's state as part of the JobSet state.

If this property is not specified, system default used is true.

The property datatype is BOOLEAN.

See Also:

Constant Field Values

SUBSTITUTION_HANDLERS

@Deprecated
public static final java.lang.String SUBSTITUTION_HANDLERS

Deprecated. Property that specifies a substitution handler class or list of classes that should be used for parameter substitution. The property value can specify a single Java class name, or it specify a comma-seperated set of Java class names.

The Java class must implement the SubstitutionHandler interface.

Enterprise Scheduler will use this property when executing a Process job type to provide substition support for the CMDLINE and ENVIRONMENT_VARIABLES system properties.

The property datatype is STRING.

See Also:

Constant Field Values

RUNAS_APPLICATIONID

public static final java.lang.String RUNAS_APPLICATIONID

Property that specifies a job runas ApplicaitonId.

See Also:

Constant Field Values

ASYNC_REQUEST_TIMEOUT

public static final java.lang.String ASYNC_REQUEST_TIMEOUT

Property that specifies the time in minutes that the processor will wait for an asynchronous after it has begun execution. After the elapses, the request will be timed out.

The property datatype is LONG.

See Also:

Constant Field Values

EXTERNAL_ID

public static final java.lang.String EXTERNAL_ID

Property that specifies an identifier for an external portion of an Enterprise Scheduler asynchronous Java job.

For example, a Java asynchronous job usually invokes some remote process and then returns control to the 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 the Enterprise Scheduler.

The property datatype is STRING.

See Also:

Constant Field Values

REQUEST_LOG_LEVEL

public static final java.lang.String REQUEST_LOG_LEVEL

Property that specifies the log level for request logging. Valid values for log level are the String representations of levels defined in java.util.logging.Level obtained via Level.getName(). The default log level is "INFO".

The property datatype is STRING.

See Also:

Constant Field Values

EXECUTE_AUTO_EXPORT

public static final java.lang.String EXECUTE_AUTO_EXPORT

Property that specifies whether the request's previously imported output content shall be automatically exported to the request's output directory before the job's execute stage runs.

This property is applicable to the execute stage for spawned, synchronous Java, and asynchronous Java job types. It does not apply to the update stage of asynchronous Java job types not PL/SQL job types.

Valid values for this property are:

• {code true} All previously imported output content will be exported to files in the request's output directory before the job's execute stage.
• false No output content is automatically exported. The job may choose to manually export output content.

If this property is not specified, system default used is false.

The property datatype is BOOLEAN.

See Also:

Constant Field Values

SUPPORT_OUTPUT_FILES

public static final java.lang.String SUPPORT_OUTPUT_FILES

Property that specifies whether the request will create temporary or output files. The property applies during these stages: pre-processing, execution, async update, and post-processing.

The request can always use the API to create output content directly in the content store.

Property value specifies the action to take.

If this property is not specified, no directories will be created.

The property datatype is STRING. Valid values are "none", "work", "output". Non-valid values will be treated as though the property were not specified.

See Also:

Constant Field Values

CMDLINE_UNIX

public static final java.lang.String CMDLINE_UNIX

Indicates the full command line for executing a Process type request executable on a Unix or Unix-like operating system.

Typically, this property is specified in the job type and the executable name, path, and arguments are used to indicate values to be substituted at runtime.

See EXECUTABLE_NAME See EXECUTABLE_DIR_UNIX See EXECUTABLE_SUFFIX_UNIX See PROCESS_ARGUMENTS

See Also:

Constant Field Values

CMDLINE_WINDOWS

public static final java.lang.String CMDLINE_WINDOWS

Indicates the full command line for executing a Process type request executable on a Windows operating system.

Typically, this property is specified in the job type and the executable name, path, and arguments are used to indicate values to be substituted at runtime.

See EXECUTABLE_NAME See EXECUTABLE_DIR_WINDOWS See EXECUTABLE_SUFFIX_WINDOWS See PROCESS_ARGUMENTS

See Also:

Constant Field Values

EXECUTABLE_NAME

public static final java.lang.String EXECUTABLE_NAME

The name of the executable for a Process type request. The value should not include the path to the executable. See EXECUTABLE_DIR_UNIX and EXECUTABLE_DIR_WINDOWS.

The property datatype is STRING.

See Also:

Constant Field Values

EXECUTABLE_DIR_UNIX

public static final java.lang.String EXECUTABLE_DIR_UNIX

Property that indicates the directory where the executable resides for a Process type request on a Unix or Unix-like operating system.

The property datatype is STRING.

See Also:

Constant Field Values

EXECUTABLE_DIR_WINDOWS

public static final java.lang.String EXECUTABLE_DIR_WINDOWS

Property that indicates the directory where the executable resides for a Process type request on a Windows operating system.

The property datatype is STRING.

See Also:

Constant Field Values

EXECUTABLE_SUFFIX_UNIX

public static final java.lang.String EXECUTABLE_SUFFIX_UNIX

Property that indicates the file extension of the executable for a Process type request if executed on a generic Unix or Unix-like operating system.

The default is no extension.

The property datatype is STRING.

See Also:

Constant Field Values

EXECUTABLE_SUFFIX_WINDOWS

public static final java.lang.String EXECUTABLE_SUFFIX_WINDOWS

Property that indicates the file extension of the executable for a Process type request if executed on a Windows operating system.

The default is no extension.

The property datatype is STRING.

See Also:

Constant Field Values

PROCESS_ARGUMENTS

public static final java.lang.String PROCESS_ARGUMENTS

Property that indicates the arguments passed to the executable of a Process type spawned process.

The property datatype is STRING.

See Also:

Constant Field Values

RESOLVED_CMDLINE

public static final java.lang.String RESOLVED_CMDLINE

Property that specifies the command line used for a Process type job request. This property is only set by ESS. It is meant for diagnostic purposes only.

The property datatype is STRING.

See Also:

Constant Field Values

FUSION_JOB

public static final java.lang.String FUSION_JOB

Property that indicates whether the job associated with this request is a Fusion job.

Valid values for this property are:

• {code true} the job is a Fusion job
• false the job is not a Fusion job

If this property is not specified, system default used is false.

The property datatype is BOOLEAN.

See Also:

Constant Field Values

USER_FILE_DIR_SHARED

public static final java.lang.String USER_FILE_DIR_SHARED

Property that specifies whether the request's USER_FILE_DIR (configured RequestFileDir) directory is shared. This property represents the value of RequestFileDirShared.

This property is valid for a request in standard or extended request mode.

Valid values for this property are:

• {code true} USER_FILE_DIR is a shared directory.
• false USER_FILE_DIR is a local directory.

If this property is not specified, system default used is false.

The property datatype is BOOLEAN.

See Also:

Constant Field Values

UPLOAD_CONTENT_TO_REPOSITORY

public static final java.lang.String UPLOAD_CONTENT_TO_REPOSITORY

Property that indicates whether to upload request log and output files to a separate repository, such as Universal Content Management (UCM), from the internal repository when the request execution completes. Property value specifies the action to take.

If this property is not specified, content will not be uploaded.

The property datatype is STRING. Valid values are "copy". Non-valid values will be treated as though the property were not specified.

See Also:

Constant Field Values

USE_EXTENDED_SETUP

public static final java.lang.String USE_EXTENDED_SETUP

Property that indicates whether to initiate capabilities, like ApplSessions, prior to invoking the job-related code such as the job executable or preprocess handler, postprocess handler.

Extended functionality will be invoked only in environments where it is available.

If this property is not specified, no extended functionality will be set up prior to job execution.

The property datatype is BOOLEAN.

See Also:

Constant Field Values

USE_ALTERNATE_ENV

public static final java.lang.String USE_ALTERNATE_ENV

This property indicates whether to use an alternative environment from a callout rather than the normal application environment.

If this property is not specified, the normal application environment will be used.

The property datatype is BOOLEAN.

See Also:

Constant Field Values

Constructor Detail

SystemProperty

public SystemProperty()

Method Detail

getNames

public static java.util.Enumeration<java.lang.String> getNames()

Returns the names of the system properties.

Returns:

Enumeration of the names of the system properties.

getCorePropNames

public static java.util.Set<java.lang.String> getCorePropNames()

Get the core system properties.

The distinction between core and extended system properties is internal to ESS, and relates to when and how frequently they are used, and may indicate how they will be stored.

Returns:

Set of the names of the core system properties.

getExtendedPropNames

public static java.util.Set<java.lang.String> getExtendedPropNames()

Get the extended system properties.

The distinction between core and extended system properties is internal to ESS, and relates to when and how frequently they are used, and may indicate how they will be stored.

Returns:

Set of the names of the extended system properties.

isCoreSystemProp

public static boolean isCoreSystemProp(java.lang.String name)

Indicates whether the given system property is a core system property.

Parameters:

name - the name of the system property

Returns:

true if it is a core system property, false otherwise.

getSysPropInfo

public static ParameterInfo getSysPropInfo(java.lang.String name)

Returns the information for the system property identified by the given name.

Parameters:

name - the name of the system property. If null, this method returns null.

Returns:

the information about the property. This will be null if no such system property exists.

getReadOnlySysProps

public static java.util.Set<java.lang.String> getReadOnlySysProps()

Return the set of system properties that cannot be updated after submission through normal channels.

Returns:

the set of system properties that cannot be updated after submission.

getInternalOnlyProps

public static java.util.Set<java.lang.String> getInternalOnlyProps()

Return the set of system properties that should not be set except by ESS internals.

Returns:

the set of system properties that should not be set except by ESS internals.

getMetadataOnlyProps

public static java.util.Set<java.lang.String> getMetadataOnlyProps()

Return the set of system properties that can be set in meta-data but should not be set at submission.

Returns:

the set of system properties that can be set in meta-data but should not be set at submission.

isInternalOnly

public static boolean isInternalOnly(java.lang.String name)

Determine if the given system property that should not be set except by ESS internals.

Returns:

true if not should not be set, false otherwise.

isMetadataOnly

public static boolean isMetadataOnly(java.lang.String name)

Determine if the given system property can be set in meta-data but not at submission.

Parameters:

name - the name of the system property

Returns:

true if this system property can be set when defining metadata, but should not be set in RequestParameters at request submission. Returns false otherwise.

Skip navigation links