11 Administering the Orchestrator Studio and Orchestrations

This chapter contains the following topics:

11.1 Understanding Orchestration Life Cycle Management (Release 9.2.1)

Starting with EnterpriseOne Tools 9.2.1 and Orchestrator Studio 3.0.1, orchestration components created in the Orchestrator Studio are stored as user defined objects (UDOs) in EnterpriseOne. Each orchestration component type—orchestration, service request, rule, cross reference, white list—is a separate UDO type in EnterpriseOne. Orchestrator Studio 6.0.x provides the capability to create notification and schedule components, which are also stored and managed as UDOs in EnterpriseOne.

Important:

If you created orchestrations in a release prior to Orchestrator Studio 3.0.1 and EnterpriseOne Tools 9.2.1, you need to convert your orchestration components to user defined objects. See Upgrading Orchestration Components to User Defined Objects (Release 9.2.1) for more information.

Storing orchestration components as UDOs enables you to use the following EnterpriseOne administration tools to manage the life cycle and security for orchestration UDOs:

  • Object Management Workbench - Web (P98220W)

    Use this application to move orchestration UDOs between projects, check out and check in objects, and transfer objects between path codes. After Orchestrator Studio users create and test orchestrations in a test environment, use P98220W to transfer the objects to an AIS Server in a production environment. See the JD Edwards EnterpriseOne Tools Object Management Workbench for the Web Guide for more information.

  • User Defined Object Administration (P98220U)

    An administrator or person in a supervisor role uses this application to approve or reject orchestration UDOs for sharing. Typically, you can inspect UDOs in P98220U before approving them or rejecting them. However, you can only inspect orchestration component UDOs in the Orchestrator Studio. See the JD Edwards EnterpriseOne Tools Using and Approving User Defined Objects Guide for more information on how to use P98220U.

  • Security Workbench (P00950)

    Use Security Workbench to set up UDO feature, UDO action, and UDO view security, which authorizes access to the Orchestrator Studio design pages and determines the actions users can perform in the design pages. See Setting Up UDO Security for Orchestrator Studio Users (Release 9.2.1) in this guide for more information.

It is recommended to set up different instances of the AIS Server: one instance for designing and testing orchestrations and another instance for production. Running two instances can also help with troubleshooting orchestration issues in a production environment. In the Object Management Workbench - Web application, you can move an orchestration from a production environment to a test environment for troubleshooting.

11.2 Setting Up User Access to the Orchestrator Studio

Setting up user access to the Orchestrator Studio involves:

11.2.1 Setting Up Allowed Users

Use Server Manager to grant EnterpriseOne users access to the Orchestrator Studio.

  1. In Server Manager, access the General section of the AIS Server Configuration Group settings.

  2. In the "List of Allowed Admin Service Users" field, enter a comma delimited list of EnterpriseOne user IDs, for example:

    List of Allowed Admin Service Users: USR10,USR22, USR12

    When added to this list, the EnterpriseOne users can use their user ID and password to sign in to the Orchestrator Studio.

    Note:

    These group settings in Server Manager also include an option to activate the AIS Admin Service, which enables administrators to clear orchestration cache on the AIS Server. See Clearing Orchestration Cache on the AIS Server for more information.

11.2.2 Setting Up UDO Security for Orchestrator Studio Users (Release 9.2.1)

Out of the box, Orchestrator Studio users do not have access to Orchestrator Studio design pages or permission to create, publish, or modify orchestration UDOs. Access to the design pages and authorization to work with orchestration UDOs is controlled through UDO security in the EnterpriseOne Security Workbench (P00950).

Each orchestration component type is managed as a separate UDO type in EnterpriseOne. Therefor, you have to set up UDO security for each orchestration UDO type.

Before setting up UDO security for orchestration UDO types, each orchestration UDO type must be set up with the proper "Allowed Actions" in the OMW Configuration System (P98230) application. See "Define Allowed Actions for UDO Types" in the JD Edwards EnterpriseOne Tools Security Administration Guide for more information.

The following sections provide details and recommendations for setting up UDO feature, UDO action, and UDO view security for orchestration UDOs.

UDO Feature Security for the Orchestrator Studio

Each orchestration component design page in the Orchestrator Studio is considered a feature of the Orchestrator Studio. You must use UDO feature security to activate each design page. Out of the box, the design pages are not activated.

UDO feature security is NOT set up by user, role, or *PUBLIC. It is a system setting for activating or deactivating each component design page in the Orchestrator Studio.

Because development of an orchestration can include all five types of orchestration components (orchestration, service request, rule, cross reference, and white list), you must activate all five component design pages through UDO feature security. If you do not activate all five through UDO feature security, users cannot access any of the component design pages.

Starting with Orchestrator Studio 6.1.0 and EnterpriseOne Tools 9.2.2.4, users can use the Process Recorder in EnterpriseOne to create a form request. The Process Recorder is not available by default. You must enable the RECORDER feature in UDO feature security for users to access it.

See "Managing UDO Feature Security" in the JD Edwards EnterpriseOne Tools Security Administration Guide.

UDO Action Security for Orchestrator Studio Users

UDO action security controls the actions users can perform in the Orchestrator Studio. You must set up UDO action security for each orchestration component type. The three UDO action security options are:

  • Create. Enables users to create UDOs for personal use. Without this permission, users can only view shared UDOs to which they have been granted access through UDO view security.

  • Create and Publish. Enables users to create and "Request to Publish" UDOs to share UDOs with other users.

    With this permission, a user can select the "Request to Publish" button to share a UDO. However, the UDO must be approved before it can be shared with other users.

  • Modify. Enables users to modify shared UDOs. "Modify" action security inherits "Create" and "Create and Publish" permissions.

Recommendation: To simplify UDO action security for Orchestrator Studio users, it is recommended that you grant "Create, Publish, Modify" permissions to all Orchestrator Studio users for each orchestration component type. Also, users must assign a product code to each orchestration component that they create. This gives you the option to set up UDO action security by product code so that all users can work with orchestration components associated with a particular product code.

See "Managing UDO Action Security" in the JD Edwards EnterpriseOne Tools Security Administration Guide.

UDO View Security for Orchestrator Studio Users

UDO view security authorizes Orchestrator Studio users to view UDOs that have been shared. UDO view security is set up by user, role, or *PUBLIC. You can set up UDO view security for each shared UDO or for all shared UDOs of a particular UDO type.

Recommendation: To simplify administration, you can set up UDO view security for users by orchestration UDO type, instead of setting it up for each individual shared orchestration UDO. This enables Orchestrator Studio users to view all published ("shared") orchestration component UDOs. This eliminates a system administrator from having to set up UDO view security each time an orchestration component is shared. Also, users must assign a product code to each orchestration component that they create. This gives you the option to set up UDO view security by product code so that all users can view orchestration components associated with a particular product code.

See "Managing UDO View Security" in the JD Edwards EnterpriseOne Tools Security Administration Guide.

11.3 Upgrading Orchestration Components to User Defined Objects (Release 9.2.1)

Upgrade orchestration components to UDOs if you meet the following criteria:

  • You installed a minimum of Orchestrator Studio 3.01 and EnterpriseOne Tools 9.2.1.

    AND

  • You have legacy orchestration components on the AIS Server that were created with either a previous version of the Orchestrator Studio or through manually configured XML files (pre-Orchestrator Studio).

Before you can upgrade orchestration objects to UDOs, you must have permissions to access all orchestration component design pages through UDO feature security. See Setting Up UDO Security for Orchestrator Studio Users (Release 9.2.1).

To upgrade orchestration components to UDOs:

  1. Locate the directory on the AIS Server that contains the five orchestration component folders.

  2. Add the five folders to a zip file. Do NOT include the parent folder in the zip.

  3. Sign in to the Orchestrator Studio.

  4. In the Orchestrator Studio Home page, click the Tools button in the upper right corner.

  5. On the Tools page, click the Import Tool icon.

  6. Locate the zip file with the orchestration files and click the Upload button.

For more information, see Importing Orchestration Files in the Orchestrator Studio.

11.4 Clearing Orchestration Cache on the AIS Server

The AIS Server caches all orchestration files processed by the Orchestrator. If Orchestrator Studio users modify orchestration components that are currently in use, an administrator must clear the AIS Server cache for the modifications to take effect. Clearing the cache forces the AIS Server to reload files from disk to cache.

Note:

Clearing the cache is not necessary to run new orchestration files.

You can clear the cache using either of the following methods:

  • Use the AIS Administration Service to clear the AIS Server cache (recommended). The AIS Administration Service is a REST service on the AIS Server that is exposed like any other service on the AIS Server.

  • Restart the AIS Server. This method is not recommended because:

    • If the Orchestrator is currently running an orchestration, it will result in invalid processing of that orchestration.

    • It results in server downtime, which might impact other applications that use the AIS Server.

Regardless of the method you use, Oracle recommends that you clear the cache only on an AIS Server instance used for developing and testing orchestrations. Either method clears the file cache for all orchestrations; you cannot clear the cache for individual orchestrations.

11.4.1 Activating the AIS Administration Service

Before you can use the AIS Administration Service, in Server Manager, you must set up the AIS Administration Service users and activate the AIS Administration Service.

  1. In Server Manager, locate the AIS Server instance, and then access the General section of the AIS Server Configuration Group settings.

  2. In the "List of Allowed Admin Service Users" field, enter a comma delimited list of EnterpriseOne user IDs, for example:

    List of Allowed Admin Service Users: USR10,USR22, USR12

  3. Click the Enable Admin Service option.

    This enables the allowed Admin Service users to run the AIS Administration Service.

11.4.2 Using the AIS Administration Service to Clear Cache

Run the AIS Administration Service by placing a URL in a browser with valid EnterpriseOne credentials. The AIS Administration Service takes an EnterpriseOne username and password as input. You can invoke the service using either a GET or a POST HTTP method.

The URI is:

http://<ais_server>:<port>//jderest/adminservice

The AIS Administrator Service is able to take credentials in several forms.

For the GET call, you can either use basic authorization or you can provide the username and password as URL parameters, for example:

http://<ais_server>:<port>/jderest/adminservice?username=<userid>&password=<pwd>

For the POST operation you can use basic authorization, provide username and password as parameters, or provide username and password as JSON input, for example:

{
        "username":"user",
        "password":"pwd"
} 

If the service succeeds, the response looks like this:

{"message":"All XML File Caches and X-Ref/Whitelist Caches have been cleared and refreshed.","timeStamp":"2015-04-30:14.26.58"}

If the service fails, these are the possible reasons:

  • Invalid credentials, which is indicated by the following response:

    {"message":"Error: Authorization Failure Server returned HTTP response code: 403 for URL: http://<jas_server>:<port>/jde/FormServiceRequest","exception":"com.oracle.e1.rest.session.E1LoginException","timeStamp":"2015-04-30:14.28.59"}

  • Service disabled in settings, which is indicated by the following response:

    {"message":"Error: Admin Service is disabled in configuration. No action has been taken. ","timeStamp":"2015-04-30:14.31.41"}

  • User has not been added to the AIS Server's AdminServiceUserList setting in Server Manager, which is indicated by the following response:

    {"message":"User is not authorized to use the Admin Service","timeStamp":"2015-07-07:14.23.25"}

11.5 Creating Connection Soft Coding Records for Connector Service Requests

This section contains the following topics:

11.5.1 Understanding Connection Soft Coding Records

Connector creates soft coding records to provide a secure access to external resources, such as a REST service, database, or an orchestration or notification on another EnterpriseOne system. A system administrator can set up a soft coding record for a single connection, and a business analyst can create one or more connectors that use this connection to access resources on an external system.

You can create soft coding records for the following connections:

  • Orchestrator connection. A connection to an AIS Server Orchestrator where orchestrations or notifications reside.

  • Open API Endpoint. A connection to an external system where the documentation of external REST services (Open API - 2.0) reside. (Release 9.2.3.4)

  • REST connection. A connection to an external system where a REST service resides. A REST connection supports Oauth 2.0 authorization which allows orchestrations to exchange REST calls and data with Oracle Cloud services and other third-party systems. Starting with Orchestrator Studio 6.1.0, REST connections also support the transferring of files to an external REST service.

  • Database connection. A connection to an external database using a JDBC driver.

    For a database connection, the JDBC driver for the database must be in the AIS Server classpath.

  • (Orchestrator Studio 6.1.0). A connection to an external server for transferring files through FTP/SFTP. Note that you can also use a REST connection to transfer a connector to an external system through a REST connector or a connector that uses FTP or SFTP.

When you create a connection soft coding record, you associate it with an EnterpriseOne user, role, or *PUBLIC. This enables the Orchestrator Studio user who is creating a connector service request to see a list of orchestrations, a REST service, or a database that is available through the connection. The user must be authorized to run the originating orchestration, which is the orchestration on the local system that will call the external orchestration, REST service, or database.

A soft coding record also includes credentials of the user who is authorized to invoke the external resource, such as an orchestration, REST service, database, or directory on the external system.

11.5.2 Creating a Soft Coding Record for an Orchestrator Connection

  1. On the Tools page in the Orchestrator Studio, click the Connections icon.

  2. On the Connections page, click New Connection.

  3. On Connection Information, complete these fields:

    • Name. Enter a unique name for the Orchestrator connection.

    • Description. Enter a description to identify the connection. For example, if you are creating more than one soft coding record to connect to different locations, you should include the location in the description.

    • Type. Select Orchestrator.

    • User/Role. Enter the user authorized to run the originating orchestration–the orchestration on the local system that will call the external orchestration. The user can be an EnterpriseOne user, role, or *PUBLIC.

    • Environment. Enter the environment where the local orchestrations reside.

  4. On the Service Information tab, in the Endpoint field, enter the URL to the Orchestrator directory on the AIS Server where orchestrations are stored, for example:

    https://<aisserverdomain>:<port>/jderest/orchestrator

    Important:

    Oracle strongly recommends that all external calls use the SSL protocol (https) with a certificate from a reputable certificate authority.
  5. On the Security tab, enter the credentials for accessing the external system.

    • Security Policy

      Select the authentication type used by the external AIS Server: Basic Authorization or User/Password Authorization.

    • User

    • Password

    • Override Environment. Use this field and the Override Role field to override the environment and role configured for the external AIS Server. For example, if you enter JDV920C1 and ADMIN in these fields for the soft coding record, when the external orchestration call is made (during the execution of an orchestration), the system will sign on to the external AIS Server with environment JDV920C1 and role ADMIN.

    • Override Role

  6. If the connection is to an external server, on the Proxy tab, specify a proxy server for accessing the external server:

    • Proxy Host. Enter the URL of the proxy server.

    • Proxy Port. Enter the port number of the proxy server.

    • Use Proxy. Toggle right to enable the proxy.

  7. When complete, click Save at the top of the Connections page.

11.5.3 Creating an Open API Connection (Release 9.2.3.4)

  1. On the Tools page in the Orchestrator Studio, click the Connections icon.

  2. On the Connections page, click New Connection.

  3. On Connection Information, complete these fields:

    • Name. Enter a unique name for the Open API connection.

    • Description. Enter a description to identify the connection.

    • Type. Select Open API.

    • User/Role. Enter the user authorized to access the connection. The user can be an EnterpriseOne user, role, or *PUBLIC.

    • Environment. Enter the environment where the connections reside.

  4. On the Service Information tab, in the Endpoint field, enter the URL for accessing the Open API - 2.0 documentation through which you can access the Server Manager REST services.

    For example: https://<server_manager_console_host:port/ manage/mgmtrestservice/v1/open-api-catalog>

  5. On the Security tab, enter the credentials for accessing the external REST services.

    • Security Policy

      Select the authentication type as Basic Authorization accessing the Server Manager Console.

    • User

    • Password

  6. When a proxy server is present, connection is made through that server. On the Proxy tab, specify a proxy server for accessing the external server:

    • Proxy Host. Enter the URL of the proxy server.

    • Proxy Port. Enter the port number of the proxy server.

    • Use Proxy. Toggle right to enable the proxy.

  7. When complete, click Save at the top of the Connections page.

    Notes:

    • Server Manager REST services can be hosted on the same server as the SMC or on a different server.

    • The credentials used for accessing the REST services and the Open API documentation is same as mentioned in the Security section.

11.5.4 Creating a Soft Coding Record for a REST Connection

This section has been updated in support of OAuth 2.0, which is supported starting with EnterpriseOne Tools 9.2.2. This type of security allows orchestrations to exchange REST calls and data with Oracle Cloud services and other third-party systems.

  1. On the Tools page in the Orchestrator Studio, click the Connections icon.

  2. On the Connections page, click New Connection.

  3. On Connection Information, complete these fields:

    • Name. Enter a unique name for the connection.

    • Descriptions. Enter a description to identify the connection. For example, if you are creating more than one soft coding record to connect to different locations, you should include the location in the description.

    • Type. Select External Rest.

    • User/Role. Enter the user authorized to run the originating orchestration–the orchestration on the local system that will call the external REST service. The user can be an EnterpriseOne user, role, or *PUBLIC.

    • Environment. Enter the environment where the local orchestrations reside.

  4. On the Service Information tab, enter the URL for accessing the REST services in the Endpoint field.

    Important:

    Oracle strongly recommends that all external calls use the SSL protocol (https) with a certificate from a reputable certificate authority.
  5. Click the Security tab and from the Security Policy drop-down list, select the type of security you want to use and then follow the appropriate steps:

    • For Basic Authorization, complete these fields:

      • User

      • Password

    • For OAuth 2.0 Client Credential (starting with EnterpriseOne Tools 9.2.2):

      1. In the Token Endpoint URL field, enter the address of the server that will provide the OAuth token.

      2. In the Client Id field, enter ID of the client.

      3. In the Client Secret field, enter the value for client secret you have received after registering the application.

      4. If the client requires additional header parameters, in the OAuth Parameters area, click Add.

        The system adds a new row in the OAuth Parameters table.

      5. Enter a name for the parameter and its value in the table.

  6. If the connection is to an external server, on the Proxy tab, specify a proxy server for accessing the external server:

    • Proxy Host. Enter the URL of the proxy server.

    • Proxy Port. Enter the port number of the proxy server.

    • Use Proxy. Toggle right to enable the proxy.

  7. On the HTTP Headers tab, perform the following steps to add a header record that will be used in the HTTP request to execute the external REST service:

    1. Click the Add button.

    2. In the pop-up box, complete these fields:

      Name.

      Value.

    3. Slide the Encrypt toggle to the right to enable encryption.

    4. Click Add.

      The Orchestrator Studio adds a row to the grid in the HTTP Headers tab.

    5. Add additional header records as necessary.

  8. When complete, click Save at the top of the Connections page.

11.5.5 Creating a Soft Coding Record for a Database Connection

Important:

For a database connection to work, the JDBC driver for the database must be accessible in the AIS Server classpath.
  1. On the Tools page in the Orchestrator Studio, click the Connections icon.

  2. On the Connections page, click New Connection.

  3. In the Connection Information area, complete these fields:

    • Name. Enter a unique name for the connection.

    • Descriptions. Enter a description to identify the connection. For example, if you are creating more than one soft coding record to connect to different locations, you should include the location in the description.

    • Type. Select Database.

    • User/Role. Enter the user authorized to run the originating orchestration–the orchestration on the local system that will call the external database. The user can be an EnterpriseOne user, role, or *PUBLIC.

    • Environment. Enter the environment where the local orchestrations reside.

  4. In the Database Connection Details area, complete these fields:

    • Connection. Enter the URL to the database.

      Important:

      Oracle strongly recommends that all external calls use the SSL protocol (https) with a certificate from a reputable certificate authority.
    • User. Enter the database user.

    • Password. Enter the database user password.

    • Driver. Enter the driver for the type of database you are accessing. You need to make sure the driver is specified on the AIS Server classpath.

  5. When complete, click Save at the top of the Connections page.

11.5.6 Creating a Soft Coding Record for an FTP Server Connection (Orchestrator Studio 6.1.0)

Create a soft coding record for a connection to a server that supports FTP or SFTP. This enables a business administrator to create connector service requests for transferring files to an FTP server.

  1. On the Tools page in the Orchestrator Studio, click the Connections icon.

  2. On the Connections page, click New Connection.

  3. On Connection Information, complete these fields:

    • Name. Enter a unique name for the connection.

    • Description. Enter a description to identify the connection. For example, if you are creating more than one soft coding record to connect to different locations, you should include the location in the description.

    • Type. Select FTP File Transfer.

    • User/Role. Enter the user authorized to run the originating orchestration–the orchestration on the local system that will use the FTP connection. The user can be an EnterpriseOne user, role, or *PUBLIC.

    • Environment. Enter the environment where the local orchestrations reside.

  4. In the FTP Connection Details area, complete the following fields:

    • FTP Host. Enter the URL of the FTP server.

    • FTP Port. Enter the port number of the FTP host server.

    • Connection Type. (Orchestrator Studio 7.2.0.0) Choose the connection type. Valid values are Anonymous, Username/Password, and SSH Key.

    • User. Enter the user authorized to access the directory on the FTP server.

    • Password. Enter the password of the user authorized to access the directory on the FTP server.

    • Use Secure FTP (SFTP). Enable this toggle if the server uses secure FTP.

    • FTP File Path. Enter the path to the directory on the FTP server where you want the file transferred.

    • Passphrase. (Orchestrator Studio 7.2.0.0) If you chose SSH Key as the connection type, this field appears. If the associated .ppk file requires a passphrase, enter it here.

    • SSH File. (Orchestrator Studio 7.2.0.0) If you chose SSH Key as the connection type, this field appears. You can drop a .ppk file in OpenSSH format into the box to upload it.

  5. Click Save.

11.6 Setting Up Orchestration Error and Exception Tracking (Release 9.2.2.4)

Important:

With EnterpriseOne Tools 9.2.3, the instructions in Setting Up Orchestrator Health and Exception Monitoring (Release 9.2.3) replace the information in this section.

In Server Manager, you can enable error and exception handling for orchestrations. When enabled, each exception in an orchestration is saved as a single serialized JSON object and stored in a directory on the AIS Server. In addition to storing these files, the directory serves as a buffer for storing orchestration requests if the EnterpriseOne system is down.

When an orchestration exception occurs, the AIS Server log states that the exception was saved to a file and provides the file location. For information on how to enable logging on the AIS Server, see Enable Debugging on the AIS Server.

The following list identifies the types of default errors and exceptions that can occur during orchestration processing:

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

  • Invalid form service 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.

In addition, you can specify error level handling for form service request responses when you set up exception handling in Server Manager.

To enable exception handling for orchestrations:

  1. In Server Manager, under the Advanced configuration settings for the AIS Server, locate the General settings section.

  2. In the General settings, click the Save Orchestration Exceptions check box.

    This enables exception handling. If desired, perform the following steps to set up additional exception handling features.

  3. In the "Full path to exceptions directory" fields, you can include a path to a directory on the AIS Server.

    If you do not complete this field, files will be saved to a temporary directory on the AIS Server.

  4. If you want to specify the level of error handling for form service requests, enter either or both of the following values in the Exception Scenario List field:

    • FSR_ERROR

      Enter if you want errors returned by a form request to be handled as a failure.

    • FSR_WARNING

      Enter if you want warnings returned by a form request to be handled as a failure. This level of error handling works only for form requests configured with the "Stop on Warnings" option selected in the Orchestrator Studio.

11.6.1 Understanding Orchestration Error Files

The following table describes the attributes in an orchestration error file. The attributes contain details about the orchestration and the error:

Attribute Description
jsonRequest A string representation of the incoming JSON request for the orchestration that failed.
requestingAddress IP address of the host requesting the orchestration.
requestingHost Host name of the machine requesting the orchestration.
aisURL AIS URL used to request the orchestration.
errorStatusCode The HTTP status code returned to the caller when the orchestration failed.
httpMethod HTTP method sent by caller.
orchestrationName The name of the orchestration requested.
inputs The inputs passed to the orchestration (assuming properly formed inputs were passed).
detailInputs If the inputs are an array, a detailed list of the inputs passed in the array.
errorDetails An object containing details about the error encountered: the name of the exception, a timestamp, and the exception message.
requestedDateString A date/time string of when the orchestration request was received.
environment The EnterpriseOne environment specified in the request.
role The EnterpriseOne role specified in the request.
jasserver The EnterpriseOne HTML Server specified in the request.
token The token included in the request.
deviceName The name of the device included in the request.
username The username included in the request.

11.7 Setting Up Orchestrator Health and Exception Monitoring (Release 9.2.3)

This section describes the tasks that you need to perform before users can use the Orchestrator Monitor. It contains the following topics:

11.7.1 Downloading and Installing the Orchestrator Monitor

To access the Orchestrator Monitor download, use the Update Center or Change Assistant to search on the bug number for your release:

  • 28186193 - ORCHESTRATOR MONITOR ENHANCEMENT 9.2

  • 28389735 - ORCHESTRATOR MONITOR ENHANCEMENT 9.1

The download contains the following files:

  • Orchestrator Monitor.

    This is delivered as an EnterpriseOne page which is referenced by an external form (P980060X|W980060XB). For the system to properly render the Orchestrator Monitor application, you must publish this page.

  • Health Summary (optional).

    This provides another way to view Orchestrator health details outside of the Orchestrator Monitor; it does not contain exception information. It can be published as a composed page in EnterpriseOne, but can also be made available within the My Work List composed page (recommended). For more information, see "My Work List" in the JD Edwards EnterpriseOne Tools Foundation Guide.

  • Exceptions Since Yesterday watchlist (optional).

    Implement this watchlist and the following query so users can be alerted to Orchestrator exceptions in EnterpriseOne. For more information, see Managing Orchestrator Health and Exception Records in EnterpriseOne.

  • Exceptions Since Yesterday query (optional).

11.7.2 Enabling Orchestrator Health and Exception Tracking in Server Manager

An administrator must enable performance and exception tracking in the AIS Server configuration settings in Server Manager. When enabled, the system stores health and exception records in the Health (F980061) and Exception (F980060) tables in EnterpriseOne. Data from these records is used to display health and exception details in the Orchestrator Monitor (P980060X).

The AIS Server contains an additional setting to enable management of health and exception records stored in the aforementioned tables through the EnterpriseOne Orchestrator Health and Exceptions program (P980060). Access to these records in P980060 requires providing the credentials of an EnterpriseOne user who has read-write access to these tables.

In addition, in the AIS Server configuration settings, you can specify how the system processes errors and warnings returned from form requests within orchestrations.

Note:

If debugging is enabled on the AIS Server, the AIS Server log will indicate that an exception was saved to the database each time the Orchestrator generates an exception. See Enable Debugging on the AIS Server.

Caution:

Based on the number of sessions, exception records in the database have the potential to grow rapidly.

To enable exception tracking:

  1. In Server Manager, under the Advanced configuration settings for the AIS Server, locate the General Settings section.

  2. In the General settings, click the Save Orchestration Exceptions check box to enable Orchestrator health and exception tracking.

  3. In the "Full path to exceptions directory" field, enter a path to a directory on the AIS Server where exceptions are saved if the system temporarily goes offline.

    When the system resumes, exceptions in the file system are automatically written to the F980060 table.

    If you do not complete this field, files will be saved to a temporary directory on the AIS Server.

  4. To enable access to health and exception records in P980060, enter the credentials of an EnterpriseOne user who has read-write access to F980061 and F980060 tables:

    • Exception/Health Monitor User

    • Exception/Health Monitor Password

    This makes these records accessible through the EnterpriseOne Orchestrator Health and Orchestrator Exceptions program (P980060).

  5. In the Exception Scenario field, enter either or both of the following values if you want errors and warnings returned from form requests to be processed as failures:

    • FSR_ERROR

      Enter if you want errors returned by a form request to be processed as a failure.

    • FSR_WARNING

      Enter if you want warnings returned by a form request to be processed as a failure. This level of error handling works only for form requests configured with the "Stop on Warnings" setting in the Orchestrator Studio.

11.7.3 Set Up User Access to the Orchestrator Monitor and Orchestrator Health and Exceptions Program

An administrator must use EnterpriseOne application security to enable user access to the Orchestrator Monitor (P980060X) and the Orchestrator Health and Exceptions program (P980060). See "Managing Application Security" in the JD Edwards EnterpriseOne Tools Security Administration Guide.

11.7.4 Enable UDO View Security to Monitor Orchestrations, Notifications, and Schedules

Users must have UDO view security access to the orchestrations, notifications, and schedules that they want to monitor in the Orchestrator Monitor. For more information about UDO view security, see "Managing UDO View Security" in the JD Edwards EnterpriseOne Tools Security Administration Guide.