Agenda

ESS Administration Pages ESS Home Page Verifying the Oracle Enterprise Scheduler Installation ESSAPP Application ESS Wiring ESS Roles ESS Job Definitions ESS Job States Request Jobs Log and Output files ESS Database Schema ESS Database Schema Version System Properties ESS Server Logging References Demo

Oracle Corporation Proprietary and Confidential

ESS Administration Pages

To navigate to Oracle Enterprise Scheduler administrative tasks:

Connect to EM using an administrator username and password From the navigation pane, expand the farm and then Scheduling Services, and select the ESSAPP Oracle Enterprise Scheduler component

Oracle Corporation Proprietary and Confidential

ESS Administration Pages

Select the Scheduling Service menu The Scheduling Service menu displays the following options:
Home Control Logs Request Search Submit Job Request Performance Request Processor Request Dispatcher Purge Policies Work Allocation Job Metadata Web Services Security General Information

Oracle Corporation Proprietary and Confidential

ESSAPP Home Page

You can use this page as a starting point for monitoring and administering Oracle Enterprise Scheduler These pages contain the following regions:
Top Ten Long Running Requests/Top 10 Ready Requests Scheduler Components Completed Requests - Last One Hour Response and Load Region Performance

Oracle Corporation Proprietary and Confidential

ESS Administration Pages

To access ESS Server Administration page, expand the farm and then Weblogic Domain <YourDomain> ESSCluster , and select the ESS Server component (ess_server1)

Oracle Corporation Proprietary and Confidential

ESS Administration Pages

Select the WebLogic Server menu The WebLogic Server menu displays the following options:
Home Control Logs Performance Summary JVM Performance Port Usage Application Deployment System Mbean Browser Web Services WebLogic Server Administration Console General Information

Oracle Corporation Proprietary and Confidential

ESS Server Home Page

You can use this page as a starting point for monitoring and administering ESS Server These pages contain the following regions:
Summary Information Deployments Response and Load Region Most Requested: Servlets and JSPs Web Services

Oracle Corporation Proprietary and Confidential

Verifying the Oracle Enterprise Scheduler Installation

The Oracle Enterprise Scheduler health check enables verifying the Oracle Enterprise Scheduler installation using a web browser The health check web page submits a simple scheduled job so as to verify that Oracle Enterprise Scheduler works as it should Access to the health check page is available only to users with administrator privileges

Oracle Corporation Proprietary and Confidential

Verifying the Oracle Enterprise Scheduler Installation

To verify the Oracle Enterprise Scheduler installation:
In a web browser, enter the following URL: http://<hostName>:<port>/EssHealthCheck/checkHealth.jsp where hostName is the server to which Oracle Enterprise Scheduler is installed and port is the port number Login to the diagnostic servlet using an Oracle WebLogic Server administrator username and password (Ex: weblogic)

Click the Check Health button to verify the installation

Oracle Corporation Proprietary and Confidential

Verifying the Oracle Enterprise Scheduler Installation

The health check mechanism consists of a servlet (ESSHealthcheck) Metadata services are used to retrieve metadata objects such as job type and job definition. The required metadata files are EssHealthcheckJobType.xml and EssHealthcheckJobDefn.xml These are packaged as ess-app-meta.mar, which must itself be packaged with the file ess-app.ear How the Oracle Enterprise Scheduler Installation is Verified:
The servlet waits for the job to either reach a terminal state, or run for 10 seconds, whichever occurs first If the job reaches a terminal state in less than 10 seconds, the job results in a state of success If the job's terminal state does not change within 10 seconds, the job results in a state of success. However, the job is listed as not having been executed. This is because the system may be overloaded such that executing the job may take some time If any problems occur when submitting or executing the job, the job results in a state of failure

Oracle Corporation Proprietary and Confidential

Verifying the Oracle Enterprise Scheduler Installation

If everything goes well you should get the following output:

Oracle Corporation Proprietary and Confidential

ESSAPP Application

Enterprise Scheduler Service will be deployed using a J2EE application named ESSAPP EAR file for ESSAPPJ2EE application located at <Middleware Home>/atgpf/ess/archives/ess-app.ear Structure of the ess-app.ear (ESSAPP J2EE Application):
ess-app.ear |__adf | |__adf-config.xml | |__connections.xml |__APP-INF/classes/META-INF/wsdl/ESSWebService.wsdl |__config/logmetadata.xml |__ess-app-meta.mar |__ess-async-ws.war |__ess-ejb.jar |__ess-mbeans.war |__ess-ws.war |__ess-ra.rar |__ess-health-check.war | |__checkHealth.jsp | |__WEB-INF | |__web.xml | |__weblogic.xml | |__classes/oracle/ess/healthcheck/view/EssHealthcheckServlet.class |__META-INF |__application.xml |__jazn-data.xml |__mbeans.xml |__oracle-archive.xml |__weblogic-application.xml

Oracle Corporation Proprietary and Confidential

ESS Wiring

Wiring properties file can be located at <Middleware Home>/atgpf/ess/archives/essapp.ear.wire.properties (Example: /ds08/app1000/junerun/install/fmw1/atgpf/ess/archives/ess-app.ear.wire.properties) ess-app.ear -> adf -> META-INF -> adf-config.xml and connections.xml

All the different Pillar UIApplications will also contain a file called adf-config.xml that will include ESS wiring setup. This files can be located at: $APPL_TOP/<PILLAR>/deploy/<EARApplication>/adf/META-INF/adf-config.xml

Oracle Corporation Proprietary and Confidential

ESS Roles

Ess-app.ear -> META-INF -> jazn-data.xml Available ESS Roles:

ESSAdmin
ESS admin role, has full privilege for performing any operations including security related

ESSOperator
ESS operator, for common operational tasks like start, stop, monitor, backups

ESSMonitor
ESS monitor role, has read-only privileges for monitoring

ESSAuditAdmin
ESS audit administrator role, can perform audit configuration and administration

ESSAuditViewer
ESS audit viewer role, can view audit records

Oracle Corporation Proprietary and Confidential

ESS Roles

Available ESS Roles in APM (Authorization Policy Manager)

Oracle Corporation Proprietary and Confidential

ESS Job Definitions

To view Job Definitions:

Connect to EM using an administrator username and password From the navigation pane, expand the farm and then Scheduling Services, and click on the ESSAPP Oracle Enterprise Scheduler component Once the ESSAPP Home Page is opened, expand the Scheduling Service menu and select

Oracle Corporation Proprietary and Confidential

ESS Job Definitions

Job Definitions screen will be opened containing all the available Job Definitions for the selected application Click on any of them to open the Job Definition

Oracle Corporation Proprietary and Confidential

ESS Job Definitions

Oracle Corporation Proprietary and Confidential

ESS Job Definitions

enableTrace parameter can have the following values: N when not activated Or a numerical value that indicates the level of tracing control for the job Possible values are as follows:
1: Database trace 5: Database trace with bind 9: Database trace with wait 13: Database trace with bind and wait 16: PL/SQL profile 17: Database trace and PL/SQL profile 21: Database trace with bind and PL/SQL profile 25: Database trace with wait and PL/SQL profile 29: Database trace with bind, wait and PL/SQL profile

Oracle Corporation Proprietary and Confidential

ESS Job States

There are 19 possible states for a job request, each with a corresponding number value. These are shown in the following table:
Job State Number
1 2 3 4 5 6 7 8 9 10

Job State Request

WAIT READY RUNNING COMPLETED BLOCKED HOLD CANCELLING EXPIRED CANCELLED ERROR

Job State Number

11 12 13 14 15 16 17 18 19

Job State Request

WARNING SUCCEEDED PAUSED PENDING_VALIDATION VALIDATION_FAILED SCHEDULE_ENDED FINISHED ERROR_AUTO_RETRY ERROR_MANUAL_RECOVERY

Oracle Corporation Proprietary and Confidential

Request Jobs Log and Output Files

The location of the request jobs log and output files will be determined by parameters called FilePersistenceMode and RequestFileDirectory contained in connections.xml file Request log/output files will be in file system if FilePersistanceMode is set to file. This is the default mode When set to file, parameter RequestFileDirectory will contain the full path to the jobs log and output files in the file system If FilePersistenceMode is set to 'content' then files will be stored as an attachment in UCM (Universal Content Management). In that case files will be removed from the file system and uploaded to the UCM server under default folder "/Contribution Folders/Attachments/ESS_REQUEST_HISTORY/<REQUEST_ID> File connections.xml can be found at: ess-app.ear -> adf -> META-INF -> connections.xml Modifications to this file should be done using EM. Never modify this file manually To view how to modify ESSAPP connections information use the following link: http://aseng-wiki.us.oracle.com/asengwiki/display/ATG/Modifying+ESSAPP+connections+information

Oracle Corporation Proprietary and Confidential

Request Jobs Log and Output Files

If we navigate to the path contained in RequestFileDirectory parameter we will see one directory for each Job request ids Inside the Job request directories we will see:
Input directory Log directory Out directory

Oracle Corporation Proprietary and Confidential

ESS Database Schema

ESS schema name FUSION_ORA_ESS

Oracle Corporation Proprietary and Confidential

ESS Database Schema

Table
ESS_CONFIG REQUEST_HISTORY REQUEST_METADATA JOB_INCOMPATIBILITY INCOMPATIBILITY_LOCK REQUEST_INCOMPATIBILITY REQUEST_PROPERTY REQUEST_CONSTRAINT EVENT_FILTER REQUEST_SEC_PRINCIPAL

Description
Table for general ESS configuration parameters for the ESS schema. This table should have one and only one row. ESS request history table. ESS runtime metadata store. Incompatibilities referenced by a job/jobset definition. Incompatibility lock table. Incompatibilities used (acquired/released) during lifetime of a request. Application-specified request parameters. May also contain scoped system parameters for jobsets. Request parameters that have been flagged as read-only. Event filter information used for trigger-based requests. Table for security principals used for execution of a request. This information is used by CP for PLSQL runAs and possibly other CP tasks. Table for storing miscellaneous information used by CP. Note: CP access this information via the ESS_CP package. ESS wait queue.

REQUEST_CP WAIT_QUEUE

Oracle Corporation Proprietary and Confidential

ESS Database Schema

Table
ESS_COORD ESS_APP_REGISTRATION

Description
Table for basic coordination between ESS instances. Table that lists applications with active endpoints in a given instance. Work assignment to processor bindings for all ESS instances using this schema. This table is the source of truth for bindings, which are no longer stored in the config file. These bindings are managed by EM. Bindings that are in effect for all ESS instances using this schema. If an instance is down, it will not have any rows in this table. For each instance, this table provides a cache of the configured bindings it last read, plus state on those bindings. Each type of async job (plsql, asyncjava) can be limited for a (work assignment, workshift) within a process group. This table contains the limit and current allocation for work assignments that are so limited. The limit is the maximum number of jobs that can be executing, meaning within initialize to finalize stages. A limit of -1 means no limit. The allocation is the number of jobs that are currently executing. Contains for each instance, Metadata ids of work assignment metadata that have changed and may need to be reloaded.

CONFIGURED_BINDINGS

OPERATIVE_BINDINGS

ASYNC_THROTTLE

CHANGED_WA_METADATA

Oracle Corporation Proprietary and Confidential

ESS Database Schema

Table
ESS_WS_ASYNC_INFO SCRATCH_QUERY_PRINCIPAL COMMAND_WORK WORK_UNITS EVENT_WORK

Description
Table that stores information used for webservice asynchronous callbacks. Table used for security principal information for query request operation Table for async commands/operations issued from PLSQL interface. Used to track work, usually relating to request processing. It is the cornerstone of ESS processing. Work is checked out from this table, stages are tracked for optimal recovery, etc. ESS events table.

NOTIFY_REGISTRATION

Notification support for work units, events.

ESS failed execution history table. Contains history of failed past execution attempts for requests that are being or have been retried (automatically or manually). Each row contains information copied from request_history before the request_history row is reset for retry. Note that dispatcher and processor are the servername, not the instance id. Stores information for manual recovery scenarios when deleting instances. E.g. removal of entire process group.

FAILED_EXECUTION_HISTORY

RECOVERY_DELETE

Oracle Corporation Proprietary and Confidential

ESS Database Schema Version

FUSION_ORA_ESS.ESS_VERSION database package will contain the following important constant values:
ESS_SCHEMA_VERSION RELEASE_VERSION

Oracle Corporation Proprietary and Confidential

System Properties

Oracle Enterprise Scheduler sets certain system properties when a request is submitted or at some point in the lifecycle of a request You can specify system properties as parameter names in the application metadata and using request parameters when a request is submitted Oracle Enterprise Scheduler represents parameter names that are known to and used by the system in the SystemProperty class The following table lists the available system properties, as defined in oracle.as.scheduler.SystemProperty
NAME
ALLOW_MULT_PENDING

DESCRIPTION
Specifies whether multiple pending requests for the same JobDefinition shall be allowed. Type: BOOLEAN Specifies the name of the J2EE application that submitted the request. Type: STRING

APPLICATION

CLASS_NAME

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

Oracle Corporation Proprietary and Confidential

System Properties

NAME

DESCRIPTION
Specifies the command line used to invoke an external program for a Process job request. This property is required for a Process job type. It is not used for other job types. Oracle Enterprise Scheduler uses the substitution handlers specified with the system property SUBSTITUTION_HANDLERS along with a default handler when evaluating the value for this property. For more information on substitution handlers, see Section 6.5, "Performing Request Parameter Substitution". Type: STRING Specifies the name of the J2EE application that is effective for a request. A Job Defintion, Job Type, or a job set step can be associated with a different application by defining the EFFECTIVE_APPLICATION system property. Type: STRING Specifies the environment variables to be set for the spawned process of a Process job request.The property value should be a comma separated list of name value pairs (name=value) representing the environment variables to be set. This property is optional for a Process job type. It is not used for other job types. Oracle Enterprise Scheduler uses the substitution handlers specified with the system property SUBSTITUTION_HANDLERS along with a default handler when evaluating the value for this property. For more information on substitution handlers, see Section 6.5, "Performing Request Parameter Substitution". Type: STRING

CMDLINE

EFFECTIVE_APPLICATION

ENVIRONMENT_VARIABLES

Oracle Corporation Proprietary and Confidential

System Properties

NAME
EXECUTE_PAST

DESCRIPTION
Specifies whether instances of a repeating request with an execution time in the past should be generated. Instances are never be generated before the requested start time nor after the requested end time. To cause past instances to be generated, you must set this property to TRUE and specify the requested start time as the initial time from which instances should be generated. Note that a null requested start time defaults to the current time. Valid values for this property are: TRUE: All instances specified by a schedule are generated regardless of the time of generation. FALSE: Instances with a scheduled execution time in the past (that is, before the time of generation) will not be generated. If this property is not specified, system default used is TRUE. Type: BOOLEAN Specifies an additional event listener for a request. This should be the name of a Java class that implements the oracle.as.scheduler.EventListenerinterface. Note: this property is intended for internal use only. Type: STRING Specifies the name of the Oracle Enterprise Scheduler configuration group to which this request is bound. Type: STRING

EXTENSION_LISTENER

GROUP_NAME

INPUT_LIST

Specifies input to a request. The input to a serial job set is forwarded as input to the first step only. The input to a parallel job set is forwarded as input to all the parallel steps. Oracle Enterprise Scheduler imposes no format on the value of this property. Type: STRING

Oracle Corporation Proprietary and Confidential

System Properties

NAME
LISTENER

DESCRIPTION
Specifies the event listener class associated with the request. This should be the name of a Java class that implements theoracle.as.scheduler.EventListener interface. For more information on using the LISTENER system property, see Section 12.5, "Handling Events for Triggers". Type: STRING Specifies the locale associated with the request. Type: STRING Specifies output from a request. The output of a serial job set is the OUTPUT_LIST of the last step. The output of a parallel job set is the concatenation of the OUTPUT_LIST of all the steps, in no guaranteed order, with oracle.as.scheduler.SystemProperty.OUTPUT_LIST_DELIMITER as a separator. Type: STRING Specifies the post-process callout handler class. This should be the name of a Java class that implements theoracle.as.scheduler.PostProcessHandler interface. Type: STRING Specifies the pre-process callout handler class. This should be the name of a Java class that implements the oracle.as.scheduler.PreProcessHandlerinterface. Type: STRING

LOCALE OUTPUT_LIST

POST_PROCESS

PRE_PROCESS

Oracle Corporation Proprietary and Confidential

System Properties

NAME
PRIORITY

DESCRIPTION
Specifies the request processing priority. The priority interval is [0..9] with 0 as the lowest priority and 9 as the highest. Default: If this property is not specified, the system default value used is 4. Type: INTEGER 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. Type: STRING Specifies the product within the application that submitted the request. Type: STRING 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. Type: STRING Specifies the callout handler processing delay time. This represents the time, in minutes, to delay request processing when a delay is requested by a callback handler. Default: If this property is not specified, the system default used is 5. Type: INTEGER

PROCEDURE_NAME

PRODUCT REDIRECTED_OUTPUT_FILE

REPROCESS_DELAY

Oracle Corporation Proprietary and Confidential

System Properties

NAME
REQUEST_CATEGORY

DESCRIPTION
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. Default: Type: STRING Specifies the expiration time for a request. This represents the time, in minutes, a request will expire after its materialization. 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. Request expiration only applies to requests that are waiting to run (in the wait queue). If a request waits longer than the specified expiration period, it does not run. After a request starts running the request expiration no longer applies. Type: INTEGER 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 oracle.as.scheduler.WorkAssignment (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. Type: STRING

REQUEST_EXPIRATION

REQUESTED_PROCESSOR

Oracle Corporation Proprietary and Confidential

System Properties

NAME
RETRIES

DESCRIPTION
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. Default: If this property is not specified, the system default used is 0. Type: INTEGER Specifies whether the result state of a job set step should be included when determining the state of the job set. Specifies whether the execution state of the step affects the eventual state of entire job set. In order for the state of a job set step to be included in the determination of the state of the job set, the SELECT_STATE must be set to true. Also when SELECT_STATE is not specified on a job set step, the state of the step will be included in the determination of the state of the job set. Type: BOOLEAN Specifies an Oracle Scheduler job class to be assigned to the Oracle Scheduler job used to execute an SQL job request. Type: STRING Specifies the name of the J2EE application where the absolute parent request was submitted. Type: STRING

SELECT_STATE

SQL_JOB_CLASS

SUBMITTING_APPLICATION

Oracle Corporation Proprietary and Confidential

System Properties

NAME
SUBSTITUTION_HANDLERS

DESCRIPTION
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 can specify a comma-separated set of Java class names. The Java class must implement the oracle.as.scheduler.substitution.SubstitutionHandler interface. Oracle Enterprise Scheduler will use this property when executing a Process job type to provide substitution support for the CMDLINE andENVIRONMENT_VARIABLES system properties. Type: STRING 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. Type: STRING Specifies a base directory in the file system where files, such as input and output files, may be stored for use by the request executable. Oracle Enterprise Scheduler supports a configuration parameter that specifies a file directory where requests may store files. At request submission, a USER_FILE_DIR property 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. Type: STRING

SUCCESS_EXIT_CODE

USER_FILE_DIR

Oracle Corporation Proprietary and Confidential

System Properties

NAME
USER_NAME WARNING_EXIT_CODE

DESCRIPTION
Specifies the name of the user who submitted the request. Type: STRING 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. Type: STRING 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. Type: STRING

WORK_DIR_ROOT

Most system properties are common to all job types while some system properties are specific to a particular job type, as indicated in the descriptions from the table When you use parameters, note that Oracle Enterprise Scheduler reserves the parameter names starting with "SYS_" (case-insensitive) for Oracle Enterprise Scheduler defined properties

Oracle Corporation Proprietary and Confidential

ESS Server Logging

To navigate to the ESS Server log settings open the ESS server (ess_server1) menu and select Logs -> Log Configuration

Oracle Corporation Proprietary and Confidential

ESS Server Logging

This will open the Log Configuration screen: ESS loggers: oracle.apps.fnd.applcp oracle.as.ess oracle.as.scheduler.* oracle.ess.*

Oracle Corporation Proprietary and Confidential

ESS Server Logging

To navigate and view the ESSAPP log files open the Scheduling Service menu (ESSAPP) and select Logs -> View Log Messages

Oracle Corporation Proprietary and Confidential

ESS Server Logging

Once in the Log Messages window click on the Target Log Files button

You will be taken to the Log Files screen containing all the ESSAPP log files

Oracle Corporation Proprietary and Confidential