7 Orchestrator Health and Exception Monitoring

This chapter contains the following topics:

7.1 Understanding the EnterpriseOne Orchestrator Monitor

The EnterpriseOne Orchestrator Monitor (P980060X) is an EnterpriseOne application that enables you to perform a health check of your EnterpriseOne Orchestrator environment. It provides information about which objects are performing well and which ones might need fine tuning, as well as details about exceptions so that you can take corrective actions to resolve any issues.

With the Orchestrator Monitor, you can monitor the following user defined objects (UDO) processed by the EnterpriseOne Orchestrator:

  • Orchestrations

  • Notifications

  • Schedules

    For schedules, the Orchestrator Monitor displays only exception information; it does not provide health details.

Orchestrator Health Pane in My Worklist

Oracle provides a downloadable My Worklist composed page, which includes a Watchlist pane, Message Center, and the Orchestrator Health pane. The Orchestrator Health pane in My Worklist provides another way to monitor the health of your orchestrations and notifications without having to access the Orchestrator Monitor. However, it does not provide exception information. For information on how to download and access My Worklist, see "My Worklist" in the JD Edwards EnterpriseOne Tools Foundation Guide.

7.2 Prerequisites

Before users can monitor UDOs, an administrator must install the Orchestrator Monitor and enable Orchestrator health and exception tracking in Server Manager. See Setting Up Orchestrator Health and Exception Monitoring.

7.3 Accessing the Orchestrator Monitor

You can access the Orchestrator Monitor from EnterpriseOne or from the Orchestrator Studio.

In EnterpriseOne, click Navigator, EnterpriseOne Menus, EnterpriseOne Life Cycle Tools, Orchestrator Management, Orchestrator Monitor (P980060X).From the Orchestrator Studio, click the Tools link, and then click the Orchestration Monitor icon. Use your EnterpriseOne credentials to sign in.

If the Orchestrator Monitor does not display health or exception information, contact your system administrator and request UDO view security access to the orchestrations, notifications, and schedules you want to monitor.

7.4 Monitoring UDOs Based on Different EnterpriseOne User, Environment, or Role

The Orchestrator Monitor displays health and exception details of the UDOs (orchestrations, notifications, and schedules) based on the EnterpriseOne credentials, environment, and role that you signed in with. If you have UDOs running in a different environment or under a different user name or role, you can change the data displayed in the Orchestrator Monitor based on this criteria. You can also display results based on the product code assigned to UDOs when they were created.

To change the UDOs displayed in the Orchestrator Monitor:

  1. Click the triple bar icon to access the Search Criteria panel.

  2. Complete any or all fields as necessary to display information about objects deployed under a different user, environment, role, or product code.

  3. Click Search.

7.5 Refreshing the Data Displayed in the Orchestrator Monitor

Orchestrations and notifications can run intermittently or at scheduled intervals. As a result, health and exception data can change frequently. On the Health tab, you can click Refresh or press F5 to refresh the data. On the Exceptions tab, the Orchestrator Monitor refreshes the data each time you perform any of the following actions:

  • Press F5.

  • Switch between the Health tab and the Exceptions tab.

  • Switch between the Exception Chart view and the Exceptions List view.

  • After you enter a custom date range and click Search.

  • Change your search criteria or filter results.

  • After you use the additional search field and click Search.

  • Click or expand an exception record.

7.6 Resetting the Data Displayed in the Orchestrator Monitor

The data displayed in the Orchestrator Monitor is based on records saved to the EnterpriseOne Health (F980061) and Exception (F980060) tables. An administrator can use the Orchestrator Health and Exceptions program (P980060) in EnterpriseOne to view or delete historical records that contain data that you no longer want to monitor in your current environment.

By deleting health and exception records, you are essentially resetting the data displayed in the Orchestrator Monitor.

See Managing Orchestrator Health and Exception Records in EnterpriseOne for information on how to view and delete health and exception records in EnterpriseOne.

7.7 Monitoring Orchestrator Health

The Health tab in the Orchestrator Monitor provides statistics about the health of orchestration and notification UDOs. It lists only the UDOs that you are authorized to monitor through UDO view security.

The top right of the Health tab displays the overall successes and failures of your orchestrations and notifications.

The Health grid displays 10 records at a time. Use the controls at the bottom of the page to access any additional records.

7.7.1 Filtering the UDOs Displayed in the Health Tab

To view one or a refined set of UDOs in the Health tab, click the Name field at the top of the grid and select a UDO from the drop-down list. Click it again to add additional UDOs. You can also use the Show All, Failures, or Successes options to change the data displayed based on the option selected.

7.7.2 Understanding Orchestrator Health Data

The default view in the Health tab displays high-level information about the performance of each UDO. Expand each row to find additional performance details.

The data shown is based on records stored in the EnterpriseOne Health (F980061) table. An administrator can reset the data in these tables. See Resetting the Data Displayed in the Orchestrator Monitor for more information.

High-Level Health Information

Note:

In most columns, you can click the column heading to sort data by a particular column.
  • Name

    This is the name of the UDO as given by the creator of the UDO. The icon next to it indicates if it is an orchestration A symbol that represents an orchestration. or notification A symbol that represents a notification..

  • Health - Last 10

    Description of healthchart.png follows
    Description of the illustration ''healthchart.png''

    This bar chart shows up to the last 10 instances that the UDO was executed, with each bar representing a single instance. The instances are listed earliest to latest, from left to right. A red bar indicates a failure. A green bar indicates a success. The height of each bar indicates the length of time taken to process the UDO. Move your cursor over each bar to display the date and time the instance was executed and the time in seconds it took to complete.

  • Success Rate

    The success rate of ALL instances of the UDO, not just the last 10 instances shown in the bar chart.

  • Shortest

    The shortest time it took an instance to complete, measured in seconds.

  • Longest

    The longest time it took an instance to complete, measured in seconds.

  • Last Success

    The last time the instance ran successfully.

  • Last Fail

    If there was a failure, the date and time of the last failure.

  • Runs Per Day

    The average number of times the UDO is executed each day.

Detailed Performance Information

Expand a row to view the following additional details:

  • UDO Name

    This is the ID of the UDO in EnterpriseOne.

  • Environment

    The environment in which the UDO was executed.

  • Product Code

    The product code associated with the UDO.

  • First Run

    The date and time that the first instance of the UDO was run.

  • Successes

    The total number of successes.

  • Failures

    The total number of failures.

  • Average Success

    The average time in seconds to successfully process all instances of the UDO.

  • Average Failure

    The average time in seconds of instance failures.

  • Last Run

    The time in seconds for the last instance to complete.

  • Health - Last 10

    This section provides the same details presented by the hover help in the Health - Last 10 bar chart.

7.8 Monitoring Orchestrator Exceptions

The Exceptions tab in the Orchestrator Monitor displays details about exceptions that occur when the Orchestrator processes orchestration, notification, and schedule UDOs. Use the Chart option to view exceptions graphically in a chart. Use the List option to view exceptions in a list.

You can view exception records only for UDOs to which you have been granted access through UDO view security.

The data shown is based on records stored in the EnterpriseOne Exceptions (F980060) table. An administrator can reset the data in these tables. See Resetting the Data Displayed in the Orchestrator Monitor for more information.

7.8.1 Possible Causes of Orchestrator Exceptions

The following list describes the types of exceptions that can occur:

  • JSON payload parse failure.

  • Any non 200 status response from the HTML Server, which includes connection failures and security errors.

  • Any non 200 status response from external REST calls (includes connection failures).

  • Any failure to connect to an external database.

  • Any failure to find orchestration components due to security errors.

  • Invalid orchestration inputs, including data type conversion errors.

  • Invalid form request, data request, or cross reference request due to failure to execute.

  • Cross reference or whitelist not found when an orchestration is terminated.

  • Any exception thrown from a Groovy script in a rule or service request.

For schedules, the following circumstances can generate an exception:

7.8.2 Viewing and Changing Exceptions Displayed in the List View

The List view displays 10 exception records at a time. Use the controls at the bottom of the page to view additional records. Each record contains general information about the exception, which you can expand to view detailed exception information.

The Orchestrator Monitor can access a maximum of 1000 exception records and displays a message if this amount is exceeded. You can change the search criteria or filter the results to refine the list of exceptions. If you exit and then return to the Orchestrator Monitor, the Orchestrator Monitor refreshes the results based on your previous search criteria.

To change the search criteria:

  1. Click the Select Range drop-down list and select a preset range.

    You can also select Custom Range from the list and click the date fields to manually set the date and time for the range.

  2. Click Search.

  3. You can enter a value in the "additional search criteria" field to display exception records based on Name, Exception, UDO Name, Host Address, or Host Name. This search is case sensitive.

  4. To display exceptions for a particular UDO type, click the Type drop-down list and select Orchestration, Notification, or Schedule. Or select All to view all exceptions.

    The Orchestrator Monitor automatically refreshes the list based on the search criteria.

To filter over the search results:

In the Filter Results field, enter a value to filter on any of the values in the exception record header (information in the collapsed exception record). For example, you can enter the name of a UDO, a status code, user, or other values displayed in the exception record header. The filter criteria is not case sensitive.

You cannot use the Filter Results field to filter on exception record details.

7.8.3 Reviewing General Exception Information in the List View

The List view displays the following general information about orchestration, notification, and schedule exceptions:

  • Request Received

    The date and time the request to the orchestration, notification, or schedule on the AIS Server was received.

  • Name

    The name of the UDO. The icon next to it indicates if it is an orchestration A symbol that represents an orchestration., notification A symbol that represents a notification., or schedule A symbol that represents a schedule..

  • Exception

    The name and details of the exception.

  • Status Code

    The HTTP status that was returned when the orchestration or notification was called.

  • User

    The user who invoked the orchestration or notification. In the case of a scheduled object, the user who initiated the schedule start.

  • Environment

    This is the environment that the user who invoked the UDO signed in to. In other words, it is the environment in which the UDO was executed. To view the performance of UDOs deployed to a particular environment, see Monitoring UDOs Based on Different EnterpriseOne User, Environment, or Role for more information.

  • Product Code

    The product code associated with the UDO when it was created.

7.8.4 Reviewing Detailed Exception Information in the List View

Expand an exception row to find additional details about the exception, which include:

  • UDO Name

    The ID of the UDO in EnterpriseOne.

  • URL

    The URL to the orchestration or notification on the AIS Server.

  • Host Address

    The IP address of the requesting host, that is, the IP address of the machine that made the request to the AIS Server. If invoked by the scheduler, this is the IP address of the AIS Server.

  • Host Name

    The name of the host requesting the service. If invoked by the scheduler, this is the name of the AIS Server.

  • Role

    The role of the user who originated the request to the service (orchestration or notification).

  • Processing Time

    The processing time before the exception occurred.

  • Schedule Name

    If the service was invoked by the scheduler, the UDO ID of the schedule (for example SCH_1807120003CUST) used by the scheduler is displayed here.

  • HTTP Method

    The HTTP method used to invoke the service.

  • Step Trace (orchestrations only)

    If step trace is enabled for an orchestration, click this button to view details about each step in the orchestration. See Understanding Orchestration Step Trace Details for more information.

  • Input JSON (orchestrations and notifications only)

    Click this button to view the JSON input that was sent to this UDO when invoked.

  • Trouble Shooting (schedules only)

    Click this button to view additional details to help with troubleshooting the issue.

  • Exception Message

    Click this button to view the exception message.

  • Application Errors

    If the exception occurred as a result of an EnterpriseOne application error, click this button to view the details of the error, which include errors displayed on the EnterpriseOne form that was executed.

  • Group (icon)

    If an exception occurs with an orchestration or notification that calls or is called by another orchestration or notification UDO, click the Group icon to view a list of all associated UDOs that had exceptions during the execution of that request.

  • Object Name

    For notifications that call an orchestration, when the failure is due to the orchestration, this field displays the orchestration object name.

7.8.5 Understanding Orchestration Step Trace Details

If an orchestration configured for step tracing generates an exception, the Orchestrator Monitor includes step trace details in the exception record.

Step trace details include the orchestration or notification name, inputs and outputs, the start time and end time, duration, the status, and the orchestration response.

For an orchestration exception, the step trace lists all successfully completed steps of an orchestration. The step trace details do no include the step that failed. If the orchestration calls another orchestration, it lists the successfully completed steps in the called orchestration. When you know the last step that completed successfully, you can open the orchestration in the Orchestrator Studio and identify the step that follows to identify where the exception occurred.

Note:

An administrator can access the same step trace details through the AIS Server log file in Server Manager.

7.8.6 Viewing Exceptions in the Chart View

Use the Chart view to display exception data visually in a chart. The bottom of the page provides options to display the data in a pie chart or a vertical, horizontal, stacked, or unstacked bar chart.

In the Chart view, you can display information by UDO name, exception, or application error. The key to the right of the chart changes to identify the data represented in the chart. Figure 7-1 shows an example of exceptions displayed in a vertical bar chart.

Figure 7-1 Chart View in the Orchestrator Monitor

Description of Figure 7-1 follows
Description of ''Figure 7-1 Chart View in the Orchestrator Monitor''

Each bar or section in a pie chart displays a number related to the data you selected to display. If grouping data by UDO name, the number represents the number of exceptions for the UDO. If grouping data by exception, the number represents the number of times the exception occurred. If grouping data by application error, the number represents the number of times the application error occurred.

7.8.7 Changing How Exceptions Are Displayed in the Chart View

In the Chart view, you can select a different date range, change how you want the data grouped by, or display exceptions for a particular UDO type.

To change the exception information displayed in the Chart view:

  1. Click the Select Range drop-down list and select a preset range.

    You can also select Custom Range from the list and click the date fields to manually set the date and time for the range.

  2. Click Search.

  3. Use the two Group By fields to display data with a combination of Name (UDO name), Exception, or Application Error and Day, Month, or Year.

  4. In addition to the date range, you can enter a value in the "additional search criteria" field to display exception data based on these exception record details: Name, Exception, UDO Name, Host Address, or Host Name.

  5. To display data based on a particular UDO type, click the Type drop-down list and select Orchestration, Notification, or Schedule. Or select All to view data for all UDOs.

    The chart automatically refreshes based on your selection.

7.8.8 Accessing Detailed Information from the Chart

Click any bar or section in a chart to access more detailed information about that selection. For example, if you click a bar representing the number of exceptions for a particular UDO in one month, the Orchestrator Monitor displays details about exceptions that occurred for that UDO in that month. Descriptions of the details provided can be found in the Reviewing Detailed Exception Information in the List View section.

7.9 Managing Orchestrator Health and Exception Records in EnterpriseOne

Important:

Before managing health and exception records in EnterpriseOne, make sure an administrator has enabled access to the Orchestrator Health and Orchestrator Exceptions program (P980060). See

EnterpriseOne stores Orchestrator health and exception records in the Health (F980061) and Exception (F980060) tables. EnterpriseOne provides the Orchestrator Health and Orchestrator Exceptions program (P980060) so you can access these records outside of the Orchestrator Monitor. This program enables you to:

"Exceptions Since Yesterday" UDOs

Oracle provides downloadable "Exceptions Since Yesterday" query and watchlist UDOs for P980060 so you can be alerted to Orchestrator exceptions in EnterpriseOne. You can also create a notification based on these UDOs. If you do not have access to these UDOs, contact your system administrator or see in this guide for download instructions.

7.9.1 Managing Health Records in EnterpriseOne

To view health records in EnterpriseOne:

  1. From the EnterpriseOne Navigator, select EnterpriseOne Life Cycle Tools, Orchestrator Management, Orchestrator Health (P980060_W980060B).

  2. Click Find to load all records.

  3. You can also search for health records based on values that you enter in the following fields:

    • Object Type

      To find records based on a particular UDO type, enter ORCH (for orchestrations) or NTF (for notifications). EnterpriseOne does not monitor or store health information for schedules.

    • UDO Name

      This is the object ID of the UDO in EnterpriseOne. Before filtering results, load all records and then look in the "UDO Name" column to identify this value.

    • Product Code

      Enter a product code to search for UDOs associated with a particular product code.

To delete health records:

  1. In the Orchestrator Health form, click the check box next to the records you want to delete.

  2. Click Delete.

7.9.2 Managing Exception Records in EnterpriseOne

To view exception records, you must have UDO view security enabled for the orchestration, notification, and schedule UDOs that you want to view.

To view exception records in EnterpriseOne:

  1. From the EnterpriseOne Navigator, select EnterpriseOne Life Cycle Tools, Orchestrator Management, Orchestrator Exceptions (P980060_W980060A).

  2. Click Find to load.

    The Orchestrator Exceptions form displays exception records only for the UDOs to which you have UDO view security access.

  3. You can also search for exception records based on values that you enter in the following fields:

    • Object Type

      To find records based on a particular UDO type, enter ORCH, NTF (for notifications), or SCHEDULE.

    • UDO Name

      This is the object ID of the UDO in EnterpriseOne. Before filtering results, load all records and then look in the "UDO Name" column to identify this value.

    • Product Code

      Enter a product code to search for UDOs associated with a particular product code.

To delete exception records:

  1. In the Orchestrator Exceptions form, click the check box next to the records you want to delete.

  2. Click Delete.