Package oracle.as.scheduler

Class SystemProperty

java.lang.Object
oracle.as.scheduler.SystemProperty
public class SystemProperty extends 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 by 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.

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static enum 
    SystemProperty.ExternalJobType
    Enum of external job types.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    ALLOW_MULT_PENDING
    Property that specifies whether multiple pending requests for the same JobDefinition shall be allowed.
    static final String
    APPLICATION
    Property that specifies the name of the J2EE application that is used for request processing.
    static final 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 final String
    BIZ_ERROR_EXIT_CODE
    Property that specifies the process exit code for a Process job request that denotes an execution business error.
    static final String
    CANCEL_EXIT_CODE
    Property that specifies the process exit code for a Process job request that denotes an execution cancellation.
    static final String
    CANCEL_UPDATE_TIME
    Property that specifies the time a cancel operation was initiated for a request or the last time the job for the request checked in after cancel was initiated.
    static final String
    CLASS_NAME
    Property that specifies the Java executable for a Java job request.
    static final String
    CMDLINE
    Property that specifies the command line used to invoke an external program for a Process job request.
    static final String
    CMDLINE_PREFIX
    Prefix for extended OS-specific command line system properties.
    static final String
    CMDLINE_UNIX
    Indicates the full command line for executing a Process type request executable on a Unix or Unix-like operating system.
    static final String
    CMDLINE_WINDOWS
    Indicates the full command line for executing a Process type request executable on a Windows operating system.
    static final String
    DEFAULT_EFFECTIVE_APPLICATION
     
    static final String
    EFFECTIVE_APPLICATION
    Property that specifies the name of the J2EE application that will be the effective application for the request.
    static final String
    EJB_OPERATION_NAME
    Property that specifies the operation name of the EJB.
    static final String
    ENVIRONMENT_VARIABLES
    Property that specifies the environment variables to be set for the spawned process of a Process job request.
    static final String
    ESS_ASYNC_REQUEST_JNDI_MAPPED_NAME
    Property that specifies the mapped name of AsyncRequest EJB of ESS bound to JNDI of ESS server.
    static final String
    ESS_BASE_URL
    Property to store the base URL of the ESS APIs.
    static final String
    ESS_JNDI_CSF_KEY_NAME
    Name that denotes CSF KEY name of Jndi provider of the underlying ESS server.
    static final String
    ESS_JNDI_PROVIDER_URL_NAME
    Name that denotes property of the Jndi provider URL of the underlying ESS server.
    static final String
    ESS_METADATA_JNDI_MAPPED_NAME
    Property that specifies the mapped name of MetadataService EJB of ESS bound to JNDI of ESS server.
    static final String
    ESS_RUNTIME_JNDI_MAPPED_NAME
    Property that specifies the mapped name of RuntimeService EJB of ESS bound to JNDI of ESS server.
    static final String
    EXECUTABLE_DIR_PREFIX
    Prefix for extended OS-specific executable directory system properties.
    static final 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 final String
    EXECUTABLE_DIR_WINDOWS
    Property that indicates the directory where the executable resides for a Process type request on a Windows operating system.
    static final String
    EXECUTABLE_NAME
    The name of the executable for a Process type request.
    static final 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 final 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 final String
    EXECUTE_AUTO_EXPORT
    Property that specifies whether the previously imported output content for the request shall be automatically exported to the request output directory before the job execute stage runs.
    static final String
    EXECUTE_PAST
    Property that specifies whether instances of a repeating request with an execution time in the past should be generated.
    static final String
    EXECUTE_PAST_SKIP_ALL_BUT_ONE
    Property that specifies whether all or only one past instance of a repeating request with an execution time in the past be generated.
    static final String
    EXTENSION_LISTENER
    Property that specifies the extension event listener class associated with the request.
    static final String
    EXTERNAL_ID
    Property that specifies an identifier for an external portion of an Enterprise Scheduler asynchronous Java job.
    static final String
    EXTERNAL_JOB_TYPE
    Property that specifies an indicator of the type of the remote component of the job.
    static final String
    FUSION_JOB
    Property that indicates whether the job associated with this request is a Fusion job.
    static final String
    GROUP_NAME
    Property that specifies the name of the ESS configuration group to which this request is bound.
    static final String
    INPUT_LIST
    Property that specifies input to a request.
    static final String
    INPUT_WORK_DIR
    Property that specifies the work directory used during request processing for input files.
    static final String
    INVOKE_MESSAGE
    Property that holds the xml message payload used as the input for invoking the remote webservice.
    static final String
    JNDI_CSF_KEY
    Property that pointing to the CSF alias that is mapped to the username and password in keystore.
    static final String
    JNDI_MAPPED_NAME
    Property that specifies the mapped name of an EJB that is bound to JNDI of a local/remote server.
    static final String
    JNDI_PROVIDER_URL
    Property that specifies the Url of Jndi provider pertaining to a remote server.
    static final String
    JOB_INFO_CLASS
    This optional property specifies an interface that a job can implement to dynamically provide information about itself in the context of a given request for the job.
    static final String
    LISTENER
    Property that specifies the event listener class associated with the request.
    static final String
    LOCALE
    Property that specifies the locale associated with the request.
    static final String
    LOG_WORK_DIR
    Property that specifies the work directory used during request processing for log files.
    static final String
    LOGICAL_CLUSTER_NAME
    Property that specifies the name of a logical cluster.
    static final String
    NATIVE_HOSTING_APP_LOGICAL_NAME
    Logical application name for the ESS native hosting app.
    static final String
    NATIVE_HOSTING_APP_STRIPE_NAME
    Application stripe name for for the ESS native hosting app.
    static final String
    OUTPUT_LIST
    Property that specifies output from a request.
    static final String
    OUTPUT_LIST_DELIMITER
    Delimiter to be used when building an OUTPUT_LIST value.
    static final String
    OUTPUT_WORK_DIR
    Property that specifies the work directory used during request processing for output files.
    static final String
    POST_PROCESS
    Property that specifies the post-process callout handler class.
    static final String
    PRE_PROCESS
    Property that specifies the pre-process callout handler class.
    static final String
    PRIORITY
    Property that specifies the request processing priority.
    static final String
    PROCEDURE_NAME
    Property that specifies the name of the PLSQL stored procedure to be called for a SQL job request.
    static final String
    PROCESS_ARGUMENTS
    Property that indicates the arguments passed to the executable of a Process type spawned process.
    static final String
    PRODUCT
    Property that specifies the product within the application that submitted the request.
    static final String
    REDIRECTED_OUTPUT_FILE
    Property that specifies the file where standard output and error streams are redirected for a Process job request.
    static final String
    REPROCESS_DELAY
    Property that specifies the callout handler processing delay time.
    static final String
    REQUEST_CATEGORY
    Property that specifies an application-specific label for a request.
    static final String
    REQUEST_EFFECTIVE_ENCODING
    Property that stores the effective encoding associated with a spawned job request.
    static final String
    REQUEST_EXPIRATION
    Property that specifies the expiration time for a request.
    static final String
    REQUEST_LOG_LEVEL
    Property that specifies the log level for request logging.
    static final String
    REQUESTED_PROCESSOR
    Property that specifies the request processor node on which the request should be processed.
    static final String
    RESOLVED_CMDLINE
    Property that specifies the command line used for a Process type job request.
    static final String
    RESUME_PAUSED_REQUEST_ON_ANY_NODE
    Property that specifies whether a paused request can be resumed on any node (instead of restricting it to the node where the request paused).
    static final String
    RETRIES
    Property that specifies the retry limit for a failed request.
    static final String
    RS_ACCEPT
    Property that specifies the MIME/media type desired for REST response.
    static final String
    RS_CUSTOM_HTTP_HEADERS
    Property that specifies custom HTTP Headers for REST operation.
    static final String
    RS_ENTITY_STRING
    Property that specifies the payload for REST operation.
    static final String
    RS_HTTP_METHOD
    Property that specifies the HTTP method or verb to use on the REST Resource.
    static final String
    RS_MEDIA_TYPE
    Property that specifies the MIME/media type of the REST operation payload.
    static final String
    RS_PATH
    Property that specifies the relative Path for REST Resource.
    static final String
    RS_QUERY_STRING
    Property that specifies an optional Query string for REST Resource.
    static final String
    RS_RESOURCE_URL
    Property that specifies the base URL of a REST Resource that can be used in conjunction with RS_PATH property to provide a full URL for the resource
    static final String
    RS_USE_PROXY
     
    static final String
    RUNAS_APPLICATIONID
    Property that specifies a job runas ApplicaitonId.
    static final 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 final 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 final String
    SUBMITTING_APPLICATION
    Property that specifies the name of the J2EE application for the submitted (absolute parent) request.
    static final String
    SUBSTITUTION_HANDLERS
    Deprecated.
    Property that specifies a substitution handler class or list of classes that should be used for parameter substitution.
    static final String
    SUCCESS_EXIT_CODE
    Property that specifies the process exit code for a Process job request that denotes an execution success.
    static final String
    SUPPORT_OUTPUT_FILES
    Property that specifies whether the request will create temporary or output files.
    static final String
    SUPPORT_OUTPUT_FILES_NONE
    Mode for SUPPORT_OUTPUT_FILES property that indicates no request directories shall be created.
    static final String
    SUPPORT_OUTPUT_FILES_OUTPUT
    Mode for SUPPORT_OUTPUT_FILES property that indicates both the request work and output directories shall be created.
    static final String
    SUPPORT_OUTPUT_FILES_WORK
    Mode for SUPPORT_OUTPUT_FILES property that indicates only the work directory shall be created.
    static final String
    SUPPORTS_GRACEFUL_CANCEL
    Property that specifies whether the job definition supports a graceful cancel.
    static final String
    SUPPORTS_GRACEFUL_QUIESCE
    Property that specifies whether the job definition supports a graceful quiesce.
    static final String
    SUSPEND_EXIT_CODE
    Property that specifies the process exit code for a Process job request that denotes an execution cancellation.
    static final String
    SYS_PROPERTY_PREFIX
    Property name prefix for Enterprise Scheduler system properties.
    static final String
    SYSEXT_PROPERTY_PREFIX
     
    static final 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 final String
    UPLOAD_CONTENT_TO_REPOSITORY_COPY
    Mode for UPLOAD_CONTENT_TO_REPOSITORY property that indicates copying the content from the content store to the repository, while retaining the content in the content store.
    static final String
    USE_ALTERNATE_ENV
    Property that indicates whether to use an alternative environment from a callout rather than the normal application environment.
    static final 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 final 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 final String
    USER_FILE_DIR_SHARED
    Property that specifies whether the request's USER_FILE_DIR (configured RequestFileDir) directory is shared.
    static final String
    USER_NAME
    Property that specifies the name of the user who submitted the request.
    static final String
    WARNING_EXIT_CODE
    Property that specifies the process exit code for a Process job request that denotes an execution warning.
    static final String
    WORK_DIR_ROOT
    Property that specifies the working directory for the spawned process of a Process job request.
    static final String
    WS_CANCEL_MESSAGE
    Property that holds the xml message payload used as the input for invoking Cancel on remote webservice.
    static final String
    WS_CANCEL_OPERATION_NAME
    Property that specifies the wsdl Operation name for webservice cancel operation.
    static final String
    WS_ENDPOINT_BASE_URL
    Property that specifies a base URL that can be used in conjunction with WS_ENDPOINT_URL to provide a full URL for the web service endpoint.
    static final String
    WS_ENDPOINT_URL
    Property that specifies the relative URL for webservice Endpoint.
    static final String
    WS_OPERATION_NAME
    Property that specifies the wsdl Operation name for webservice operation.
    static final String
    WS_PORT_NAME
    Property that specifies the wsdl Port name for webservice operation.
    static final String
    WS_SERVICE_NAME
    Property that specifies the wsdl Service name for webservice operation.
    static final String
    WS_TARGET_NS
    Property that specifies the Target Namespace for the webservice.
    static final String
    WS_WSDL_BASE_URL
    Property that specifies a base URL that can be used in conjunction with WS_WSDL_URL property to provide a full URL for the web service wdl.
    static final String
    WS_WSDL_URL
    Property that specifies the relative URL for webservice WSDL.

  • Constructor Summary

    Constructors
    Constructor
    Description
    SystemProperty()
     

  • Method Summary

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

    Methods inherited from class java.lang.Object

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

  • Field Details

    • DEFAULT_EFFECTIVE_APPLICATION

      public static final String DEFAULT_EFFECTIVE_APPLICATION
      See Also:

    • SYS_PROPERTY_PREFIX

      public static final 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:

    • SYSEXT_PROPERTY_PREFIX

      public static final String SYSEXT_PROPERTY_PREFIX
      See Also:

    • OUTPUT_LIST_DELIMITER

      public static final 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:

    • CMDLINE_PREFIX

      public static final String CMDLINE_PREFIX
      Prefix for extended OS-specific command line system properties.
      See Also:

    • EXECUTABLE_DIR_PREFIX

      public static final String EXECUTABLE_DIR_PREFIX
      Prefix for extended OS-specific executable directory system properties.
      See Also:

    • UPLOAD_CONTENT_TO_REPOSITORY_COPY

      public static final String UPLOAD_CONTENT_TO_REPOSITORY_COPY
      Mode for UPLOAD_CONTENT_TO_REPOSITORY property that indicates copying the content from the content store to the repository, while retaining the content in the content store.
      See Also:

    • SUPPORT_OUTPUT_FILES_NONE

      public static final String SUPPORT_OUTPUT_FILES_NONE
      Mode for SUPPORT_OUTPUT_FILES property 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:

    • SUPPORT_OUTPUT_FILES_WORK

      public static final String SUPPORT_OUTPUT_FILES_WORK
      Mode for SUPPORT_OUTPUT_FILES property that indicates only the work directory shall be created. This is appropriate for a job that creates temporary files and not output files.
      See Also:

    • SUPPORT_OUTPUT_FILES_OUTPUT

      public static final String SUPPORT_OUTPUT_FILES_OUTPUT
      Mode for SUPPORT_OUTPUT_FILES property 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:

    • APPLICATION

      public static final String APPLICATION
      Property that specifies the name of the J2EE application that is used for request processing. This property is set by Enterprise Scheduler.

      The property datatype is STRING.

      See Also:

    • EFFECTIVE_APPLICATION

      public static final 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 job set 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 job set, then at runtime, this value is used to set the APPLICATION property of that JobSet request and all step requests of that job set, 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:

    • SUBMITTING_APPLICATION

      public static final String SUBMITTING_APPLICATION
      Property that specifies the name of the J2EE application for the submitted (absolute parent) request. This property is set by Enterprise Scheduler.

      The property datatype is STRING.

      See Also:

    • PRODUCT

      public static final String PRODUCT
      Property that specifies the product within the application that submitted the request.

      The property datatype is STRING.

      See Also:

    • USER_NAME

      public static final String USER_NAME
      Property that specifies the name of the user who submitted the request.

      The property datatype is STRING.

      See Also:

    • REQUEST_CATEGORY

      public static final 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:

    • GROUP_NAME

      public static final 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:

    • CLASS_NAME

      public static final 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:

    • PROCEDURE_NAME

      public static final 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:

    • SQL_JOB_CLASS

      public static final 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:

    • CMDLINE

      public static final 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:

    • INPUT_LIST

      public static final 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:

    • OUTPUT_LIST

      public static final 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:

    • LOCALE

      public static final String LOCALE
      Property that specifies the locale associated with the request.

      The property datatype is STRING.

      See Also:

    • PRIORITY

      public static final 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:

    • RETRIES

      public static final 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:

    • PRE_PROCESS

      public static final 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:

    • POST_PROCESS

      public static final 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:

    • REPROCESS_DELAY

      public static final 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:

    • LISTENER

      public static final 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:

    • EXTENSION_LISTENER

      public static final 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:

    • REQUEST_EXPIRATION

      public static final 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:

    • ENVIRONMENT_VARIABLES

      public static final 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:

    • WORK_DIR_ROOT

      public static final 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:

    • LOG_WORK_DIR

      public static final String LOG_WORK_DIR
      Property that specifies the work directory used during request processing for log files.

      The property datatype is STRING.

      See Also:

    • INPUT_WORK_DIR

      public static final String INPUT_WORK_DIR
      Property that specifies the work directory used during request processing for input files.

      The property datatype is STRING.

      See Also:

    • OUTPUT_WORK_DIR

      public static final String OUTPUT_WORK_DIR
      Property that specifies the work directory used during request processing for output files.

      The property datatype is STRING.

      See Also:

    • REDIRECTED_OUTPUT_FILE

      public static final 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:

    • REQUESTED_PROCESSOR

      public static final 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:

    • SUCCESS_EXIT_CODE

      public static final 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:

    • WARNING_EXIT_CODE

      public static final 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:

    • BIZ_ERROR_EXIT_CODE

      public static final 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:

    • EXECUTE_PAST

      public static final 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:

      • 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:

    • USER_FILE_DIR

      public static final 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:

    • ALLOW_MULT_PENDING

      public static final 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 job set 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:

    • SELECT_STATE

      public static final 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:

    • SUBSTITUTION_HANDLERS

      @Deprecated public static final 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:

    • RUNAS_APPLICATIONID

      public static final String RUNAS_APPLICATIONID
      Property that specifies a job runas ApplicaitonId.
      See Also:

    • ASYNC_REQUEST_TIMEOUT

      public static final 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 time elapses, the request will be timed out.

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

      The property datatype is LONG.

      See Also:

    • EXTERNAL_ID

      public static final 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:

    • REQUEST_LOG_LEVEL

      public static final 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:

    • EXECUTE_AUTO_EXPORT

      public static final String EXECUTE_AUTO_EXPORT
      Property that specifies whether the previously imported output content for the request shall be automatically exported to the request output directory before the job 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 and does not apply to PL/SQL job types.

      Valid values for this property are:

      • true All previously imported output content will be exported to files in the request's output directory before the job 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:

    • SUPPORT_OUTPUT_FILES

      public static final 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.

      Valid values are:

      Non-valid values will be treated as though the property were not specified.

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

      The property datatype is STRING.

      See Also:

    • CMDLINE_UNIX

      public static final 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, EXECUTABLE_DIR_UNIX, EXECUTABLE_SUFFIX_UNIX, PROCESS_ARGUMENTS.

      The property datatype is STRING.

      See Also:

    • CMDLINE_WINDOWS

      public static final 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, EXECUTABLE_DIR_WINDOWS, EXECUTABLE_SUFFIX_WINDOWS, PROCESS_ARGUMENTS.

      The property datatype is STRING.

      See Also:

    • EXECUTABLE_NAME

      public static final 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:

    • EXECUTABLE_DIR_UNIX

      public static final 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:

    • EXECUTABLE_DIR_WINDOWS

      public static final 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:

    • EXECUTABLE_SUFFIX_UNIX

      public static final 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:

    • EXECUTABLE_SUFFIX_WINDOWS

      public static final 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:

    • PROCESS_ARGUMENTS

      public static final 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:

    • RESOLVED_CMDLINE

      public static final String RESOLVED_CMDLINE
      Property that specifies the command line used for a Process type job request. This property is set by Enterprise Scheduler. It is meant for diagnostic purposes only.

      The property datatype is STRING.

      See Also:

    • FUSION_JOB

      public static final String FUSION_JOB
      Property that indicates whether the job associated with this request is a Fusion job.

      Valid values for this property are:

      • true the job is a Fusion job
      • false the job is not a Fusion job

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

      The property datatype is BOOLEAN.

      See Also:

    • USER_FILE_DIR_SHARED

      public static final 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:

      • 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:

    • UPLOAD_CONTENT_TO_REPOSITORY

      public static final 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.

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

      Valid values are:

      • #UPLOAD_CONTENT_TO_REPOSITORY_COPY
      Non-valid values will be treated as though the property were not specified.

      The property datatype is STRING.

      See Also:

    • USE_EXTENDED_SETUP

      public static final 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:

    • USE_ALTERNATE_ENV

      public static final String USE_ALTERNATE_ENV
      Property that 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:

    • JNDI_PROVIDER_URL

      public static final String JNDI_PROVIDER_URL
      Property that specifies the Url of Jndi provider pertaining to a remote server. This property is optional, needed only if the EJB and ESS are remotely located.

      If this property is not specified, the job will be executed in local server.

      The property datatype is STRING.

      See Also:

    • JNDI_MAPPED_NAME

      public static final String JNDI_MAPPED_NAME
      Property that specifies the mapped name of an EJB that is bound to JNDI of a local/remote server.

      The property datatype is STRING.

      See Also:

    • EJB_OPERATION_NAME

      public static final String EJB_OPERATION_NAME
      Property that specifies the operation name of the EJB. This can be used by the Bean implementation to branch to appropriate business methods.

      The property datatype is STRING.

      See Also:

    • JNDI_CSF_KEY

      public static final String JNDI_CSF_KEY
      Property that pointing to the CSF alias that is mapped to the username and password in keystore. This specific username/password is the credential needed to access the secured JNDI for 'JndiMappedName' lookup.

      This property is needed only if the JNDI tree is secured.

      The property datatype is STRING.

      See Also:

    • INVOKE_MESSAGE

      public static final String INVOKE_MESSAGE
      Property that holds the xml message payload used as the input for invoking the remote webservice.

      This property is a pass through parameter for EJB jobtype

      The property datatype is STRING.

      See Also:

    • WS_WSDL_URL

      public static final String WS_WSDL_URL
      Property that specifies the relative URL for webservice WSDL.

      The base URL is given by the WS_WSDL_BASE_URL property.

      The property datatype is STRING.

      See Also:

    • WS_WSDL_BASE_URL

      public static final String WS_WSDL_BASE_URL
      Property that specifies a base URL that can be used in conjunction with WS_WSDL_URL property to provide a full URL for the web service wdl.

      The property is usually used in conjunction with LOGICAL_CLUSTER_NAME. It is meant to be a generic base URL that is common for all webservice wsdls in the cluster.

      This property is optional. If it is not specified, equivalent information may be retrieved from the information associated with the LOGICAL_CLUSTER_NAME property of the request if it is configured in the hosting application's configuration.

      The property datatype is STRING.

      See Also:

    • WS_TARGET_NS

      public static final String WS_TARGET_NS
      Property that specifies the Target Namespace for the webservice.

      The property datatype is STRING.

      See Also:

    • WS_ENDPOINT_URL

      public static final String WS_ENDPOINT_URL
      Property that specifies the relative URL for webservice Endpoint.

      The base URL is given by WS_ENDPOINT_BASE_URL.

      The property datatype is STRING.

      See Also:

    • WS_ENDPOINT_BASE_URL

      public static final String WS_ENDPOINT_BASE_URL
      Property that specifies a base URL that can be used in conjunction with WS_ENDPOINT_URL to provide a full URL for the web service endpoint.

      The property is usually used in conjunction with LOGICAL_CLUSTER_NAME. It is meant to be a generic base URL that is common for all webservice endpoints in the cluster.

      This property is optional. If it is not specified, equivalent information may be retrieved from the information associated with the LOGICAL_CLUSTER_NAME property of the request if it is configured in the hosting application's configuration.

      The property datatype is STRING.

      See Also:

    • WS_SERVICE_NAME

      public static final String WS_SERVICE_NAME
      Property that specifies the wsdl Service name for webservice operation.

      The property datatype is STRING.

      See Also:

    • WS_PORT_NAME

      public static final String WS_PORT_NAME
      Property that specifies the wsdl Port name for webservice operation.

      The property datatype is STRING.

      See Also:

    • WS_OPERATION_NAME

      public static final String WS_OPERATION_NAME
      Property that specifies the wsdl Operation name for webservice operation.

      The property datatype is STRING.

      See Also:

    • WS_CANCEL_OPERATION_NAME

      public static final String WS_CANCEL_OPERATION_NAME
      Property that specifies the wsdl Operation name for webservice cancel operation.

      The property datatype is STRING.

      See Also:

    • WS_CANCEL_MESSAGE

      public static final String WS_CANCEL_MESSAGE
      Property that holds the xml message payload used as the input for invoking Cancel on remote webservice.

      The property datatype is STRING.

      See Also:

    • ESS_RUNTIME_JNDI_MAPPED_NAME

      public static final String ESS_RUNTIME_JNDI_MAPPED_NAME
      Property that specifies the mapped name of RuntimeService EJB of ESS bound to JNDI of ESS server.

      The property datatype is STRING.

      See Also:

    • ESS_METADATA_JNDI_MAPPED_NAME

      public static final String ESS_METADATA_JNDI_MAPPED_NAME
      Property that specifies the mapped name of MetadataService EJB of ESS bound to JNDI of ESS server.

      The property datatype is STRING.

      See Also:

    • ESS_ASYNC_REQUEST_JNDI_MAPPED_NAME

      public static final String ESS_ASYNC_REQUEST_JNDI_MAPPED_NAME
      Property that specifies the mapped name of AsyncRequest EJB of ESS bound to JNDI of ESS server.

      The property datatype is STRING.

      See Also:

    • ESS_JNDI_CSF_KEY_NAME

      public static final String ESS_JNDI_CSF_KEY_NAME
      Name that denotes CSF KEY name of Jndi provider of the underlying ESS server. This property can be set in EssConfig of a hosting application.

      The property datatype is STRING.

      See Also:

    • LOGICAL_CLUSTER_NAME

      public static final String LOGICAL_CLUSTER_NAME
      Property that specifies the name of a logical cluster. A logical cluster consists of information related to a physical cluster and is usually stored in the hosting application's configuration. The logical cluster name is a reference to a set of physical cluster information in the application's configuration.

      If the property is not specified, no logical cluster will be associated with the request.

      The property datatype is STRING.

      See Also:

    • EXTERNAL_JOB_TYPE

      public static final String EXTERNAL_JOB_TYPE
      Property that specifies an indicator of the type of the remote component of the job. For requests that have a remote component such as asynchronous Java jobs, webservice jobs, or EJB jobs this property specifies the nature of the remote job. Currently supported external job types are the names of the elements in SystemProperty.ExternalJobType.

      The supported values are "SOA", "OSB", "ADFBC".

      This property is optional. If it is not specified, Enterprise Scheduler will not associate the request with an external job type, regardless of how the job is actually implemented.

      The property datatype is STRING.

      See Also:

    • REQUEST_EFFECTIVE_ENCODING

      public static final String REQUEST_EFFECTIVE_ENCODING
      Property that stores the effective encoding associated with a spawned job request.

      SpawnLauncher determines the Locale setting for a spawned job request in the following precedence order:
      a. LC_ALL/LANG specified in environment properties (ENVIRONMENT_VARIABLES) for the request
      b. LC_ALL/LANG specified in HostingApp ess-config.xml
      c. 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 to use for the request log and output.

      The property datatype is STRING.

      See Also:

    • RS_HTTP_METHOD

      public static final String RS_HTTP_METHOD
      Property that specifies the HTTP method or verb to use on the REST Resource.

      The property datatype is STRING.

      See Also:

    • RS_RESOURCE_URL

      public static final String RS_RESOURCE_URL
      Property that specifies the base URL of a REST Resource that can be used in conjunction with RS_PATH property to provide a full URL for the resource

      The property datatype is STRING.

      See Also:

    • RS_PATH

      public static final String RS_PATH
      Property that specifies the relative Path for REST Resource.

      The base Resource URL is given by the RS_RESOURCE_URL property.

      The property datatype is STRING.

      See Also:

    • RS_QUERY_STRING

      public static final String RS_QUERY_STRING
      Property that specifies an optional Query string for REST Resource.

      The Query string is used as a suffix for URL after concatenating RS_RESOURCE_URL RS_RESOURCE_URL and RS_PATH RS_PATH property.

      The property datatype is STRING.

      See Also:

    • RS_ACCEPT

      public static final String RS_ACCEPT
      Property that specifies the MIME/media type desired for REST response.

      The property datatype is STRING.

      See Also:

    • RS_MEDIA_TYPE

      public static final String RS_MEDIA_TYPE
      Property that specifies the MIME/media type of the REST operation payload. This is optional and used if the REST operation includes a payload.

      The property datatype is STRING.

      See Also:

    • RS_ENTITY_STRING

      public static final String RS_ENTITY_STRING
      Property that specifies the payload for REST operation. This is a required property for some HTTP operations like PUT, POST or PATCH.

      The property datatype is STRING.

      See Also:

    • RS_CUSTOM_HTTP_HEADERS

      public static final String RS_CUSTOM_HTTP_HEADERS
      Property that specifies custom HTTP Headers for REST operation. This is an optional property for REST operations.

      The property datatype is STRING.

      See Also:

    • RS_USE_PROXY

      public static final String RS_USE_PROXY
      See Also:

    • ESS_BASE_URL

      public static final String ESS_BASE_URL
      Property to store the base URL of the ESS APIs. It is stored with the request, because it could be different depending on the routing of original message.

      The property datatype is STRING.
      See Also:

    • CANCEL_UPDATE_TIME

      public static final String CANCEL_UPDATE_TIME
      Property that specifies the time a cancel operation was initiated for a request or the last time the job for the request checked in after cancel was initiated.

      The property datatype is DATETIME.

      See Also:

    • JOB_INFO_CLASS

      public static final String JOB_INFO_CLASS
      This optional property specifies an interface that a job can implement to dynamically provide information about itself in the context of a given request for the job. For example, it could indicate how long the current request is expected to run.

      The property datatype is BOOLEAN.

      See Also:

    • CANCEL_EXIT_CODE

      public static final String CANCEL_EXIT_CODE
      Property that specifies the process exit code for a Process job request that denotes an execution cancellation. If this property is not specified, the system treats a process exit code of 5 as execution cancelled condition.

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

      The property datatype is STRING.

      See Also:

    • SUSPEND_EXIT_CODE

      public static final String SUSPEND_EXIT_CODE
      Property that specifies the process exit code for a Process job request that denotes an execution cancellation. If this property is not specified, the system treats a process exit code of 6 as execution suspended condition.

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

      The property datatype is STRING.

      See Also:

    • SUPPORTS_GRACEFUL_CANCEL

      public static final String SUPPORTS_GRACEFUL_CANCEL
      Property that specifies whether the job definition supports a graceful cancel.

      This property is application only for PL/SQL and Process execution types. The property has no effect for jobs with different execution types.

      The property datatype is BOOLEAN

      See Also:

    • SUPPORTS_GRACEFUL_QUIESCE

      public static final String SUPPORTS_GRACEFUL_QUIESCE
      Property that specifies whether the job definition supports a graceful quiesce.

      This property is applicable only for PL/SQL and Process execution types. The property has no effect for jobs with other execution types.

      The property datatype is BOOLEAN

      See Also:

    • EXECUTE_PAST_SKIP_ALL_BUT_ONE

      public static final String EXECUTE_PAST_SKIP_ALL_BUT_ONE
      Property that specifies whether all or only one past instance of a repeating request with an execution time in the past be generated. This property is relevant only for jobs where SYS_executePast=True.

      Valid values for this property are:

      • true Only one past instance (the last past instance) is generated.
      • false All past instances will be generated.

      If this property is not specified, the default is true.

      The property datatype is BOOLEAN.

      See Also:

    • ESS_JNDI_PROVIDER_URL_NAME

      public static final String ESS_JNDI_PROVIDER_URL_NAME
      Name that denotes property of the Jndi provider URL of the underlying ESS server. This property is internal and will be set by Enterprise Scheduler framework.
      See Also:

    • NATIVE_HOSTING_APP_LOGICAL_NAME

      public static final String NATIVE_HOSTING_APP_LOGICAL_NAME
      Logical application name for the ESS native hosting app.
      See Also:

    • NATIVE_HOSTING_APP_STRIPE_NAME

      public static final String NATIVE_HOSTING_APP_STRIPE_NAME
      Application stripe name for for the ESS native hosting app.
      See Also:

    • RESUME_PAUSED_REQUEST_ON_ANY_NODE

      public static final String RESUME_PAUSED_REQUEST_ON_ANY_NODE
      Property that specifies whether a paused request can be resumed on any node (instead of restricting it to the node where the request paused).

      Valid values for this property are:

      • true allows the request to be resumed on any Node.
      • false restricts the request to be resumed on the same Node,
      • where the request paused

      If this property is not specified, the default is true.

      The property datatype is BOOLEAN.

      See Also:

  • Constructor Details

    • SystemProperty

      public SystemProperty()

  • Method Details

    • getNames

      public static Enumeration<String> getNames()
      Get the names of the system properties.
      Returns:
      Enumeration<String> of the names of the system properties.

    • getCorePropNames

      public static Set<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<String> of the names of the core system properties.

    • getExtendedPropNames

      public static Set<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<String> of the names of the extended system properties.

    • isCoreSystemProp

      public static boolean isCoreSystemProp(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(String name)
      Get 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 Set<String> getReadOnlySysProps()
      Get the set of system properties that cannot be updated after submission through normal channels.
      Returns:
      Set<String> of system properties that cannot be updated after submission.

    • getInternalOnlyProps

      public static Set<String> getInternalOnlyProps()
      Get the set of system properties that should not be set except by ESS internals.
      Returns:
      Set<String> of system properties that should not be set except by ESS internals.

    • getMetadataOnlyProps

      public static Set<String> getMetadataOnlyProps()
      Get the set of system properties that can be set in meta-data but should not be set at submission.
      Returns:
      Set<String> of system properties that can be set in metadata but should not be set at submission.

    • isInternalOnly

      public static boolean isInternalOnly(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(String name)
      Indicates if the given system property can be set in metadata 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.