2 Implementing the Orchestrator Studio

This chapter describes how to implement the Orchestrator Studio. It contains the following topics:

Important:

This chapter has been updated in support of Orchestrator Studio 8, which requires a minimum of EnterpriseOne Tools 9.2.4.

2.1 Downloading and Installing Orchestrator Studio

Install the Orchestrator Studio through Server Manager. See "Installing an EnterpriseOne Orchestrator Studio" in the JD Edwards EnterpriseOne Tools Server Manager Guide, which contains prerequisites and instructions for downloading and installing the Orchestrator Studio.

API and JAR Files for Developing Custom Java for Orchestrations

In addition to files for installing the Orchestrator Studio, the Orchestrator download includes files that developers can use to create custom Java for orchestrations. This is an advanced activity that is not required to create orchestrations. The files include:

Sample Orchestration Files

Oracle provides sample orchestration files that you can use to test your Orchestrator Studio implementation or use as a template for creating your own orchestrations. After you install Orchestrator Studio, you can download Orchestration_Samples_1.1.1 from the Update Center on My Oracle Support (https://updatecenter.oracle.com/). In the Update Center, select EnterpriseOne IoT Orchestrator in the Type field to locate the download.

The download includes:

  • Sample orchestration files:

    • Add Condition Based Maintenance Alert

    • Update Equipment Locations

    • Update Meter Readings

  • Data Pack for EnterpriseOne Applications. This is required for running the sample orchestration files in an EnterpriseOne test environment.

See Test the EnterpriseOne Orchestrator Implementation for how to use these sample orchestrations to test running orchestrations in an EnterpriseOne environment with pristine data.

You can also use them as a template for creating your own orchestrations. See Appendix G, "Sample Orchestrations" for more information.

Prebuilt EnterpriseOne Orchestrations

Oracle also provides prebuilt EnterpriseOne orchestrations that are available for download from the Update Center. You can use these prebuilt orchestrations as examples for designing your own orchestrations based on your business requirements. For more information, see "JD Edwards EnterpriseOne Orchestrations" in the JD Edwards EnterpriseOne Applications Business Interfaces Implementation Guide.

2.2 Setting Up the Orchestrator Studio

Perform the tasks in the following sections to set up the Orchestrator Studio:

2.2.1 Before You Begin

Orchestrator Studio access requires a separate sign-in with a valid EnterpriseOne user ID and password. Before users can sign in to Orchestrator Studio, an administrator must add each EnterpriseOne user to a list of allowed users in Server Manager. See Setting Up Allowed Users in this guide.

Also, orchestrations and orchestration components created in the Orchestrator Studio are saved and managed as user defined objects (UDOs) in EnterpriseOne. Therefore, an administrator must set up Orchestrator Studio users with the proper UDO security to access and use the Orchestrator Studio. See Setting Up UDO Security for Orchestrator Studio Users (Release 9.2.1) in this guide.

Note:

Setting up users with access to the Orchestrator Studio automatically provides users with access to the Orchestrator Client, a standalone web application for testing orchestrations. You can access the Orchestrator Client from the Orchestrator Studio.

2.2.2 Define the Path to the AIS Server in the Orchestrator Studio

To use the Orchestrator Studio, you must first launch the Orchestrator Studio and define the path to the AIS Server.

  1. Open a browser and enter the following URL to access the Orchestrator Studio configuration page:

    http://<ADFServerHost>:<port>/OrchestratorStudio/faces/index.jsf

    You can locate the domain and port number for the Orchestrator Studio in WebLogic Admin Console, inside the Studio deployment settings, under Test.

  2. On the Orchestrator Studio configuration page, enter a URL to the AIS Server in a format that includes the AIS Server name and port number, for example:

    http://<aisserver>:<port>

    If the AIS Server uses an SSL configuration, then use the https protocol for the URL.

2.2.3 Test the EnterpriseOne Orchestrator Implementation

Use the Orchestrator Client, a standalone web application that you can access from the Orchestrator Studio, to test your EnterpriseOne implementation.

Note:

The Orchestrator Client is also used for testing custom orchestrations that you create before deploying them in a production environment. See Chapter 10, "Testing Orchestrations in the EnterpriseOne Orchestrator Client" in this guide for more information.

Before you can test the implementation, you must use the Change Assistant in EnterpriseOne to apply the data pack included in the Orchestration Samples download. See "Working with Packages" in the JD Edwards EnterpriseOne Tools Software Updates Guide on how to apply updates through the Change Assistant.

The steps in this section use the JDE_ORCH_Sample_UpdateMeterReadings sample orchestration in the JDE_IOT_Orchestrator_XML directory to test your implementation. The JDE_ORCH_Sample_UpdateMeterReadings sample orchestration is designed to update a meter reading record in the Meter Readings program (P12120) in EnterpriseOne.

Before you test the implementation, review the current equipment number record in EnterpriseOne:

  1. Access P12120 in EnterpriseOne.

  2. In the Skip to Equipment field, enter 34665.

  3. Select the Fuel Meter and Hour Meter check boxes.

  4. Click the Find button.

    In the record for equipment number 34665, notice the values in the Fuel Meter Current Reading and Hour Meter Current Reading.

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

Next, test the Orchestrator implementation by running the JDE_ORCH_Sample_UpdateMeterReadings sample orchestration in the Orchestrator Client, which if successful, updates the Fuel Meter and Hour Meter with inputs sent through the sample orchestration.

Caution:

You must perform this test in an environment with EnterpriseOne pristine data because sample orchestrations are designed to work with pristine data only.

To test your EnterpriseOne Orchestrator implementation:

Note:

The Orchestrator Client is not available with the Orchestrator Studio 8. To test an orchestration, click the Run Orchestrations icon on the Orchestrator Studio 9.2.4 home page. (Release 9.2.4)
  1. In the Orchestrator Studio, click the Tools link and then click the Orchestrator Client icon.

    You can also access the Orchestrator Client directly using this URL:

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

  2. On the Orchestrator Client Sign In screen, enter your EnterpriseOne user credentials, environment, and role. It is highly recommended that you enter an EnterpriseOne environment used for testing, not a production environment.

  3. Click the Login button.

  4. In the Orchestrator Client, in the Orchestration Name drop-down, select JDE_ORCH_Sample_UpdateMeterReadings. The following name-value pair inputs appear in the Name and Value columns:

    Name Value
    EquipmentNumber 34665
    NewFuelMeterReading 11.2
    NewHourMeterReading 110.15

  5. Click the Run button to test the orchestration.

    The Input area shows the input message in JSON format.

    The Output area shows the result of the orchestration. If successful, it displays the resulting forms from each form service call in JSON format. If unsuccessful, it shows an error response in JSON format. A warning may appear even if the update is successful.

To verify that the orchestration invoked the transaction in EnterpriseOne:

  1. Access the Meter Readings program (P12120)

  2. Search for equipment number 34665. Make sure to select the Fuel Meter and Hour Meter check boxes.

    If the results in the grid show the record with the new values as shown in the following image, then your EnterpriseOne Orchestrator implementation is successful.

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

    If the orchestration fails, verify that you properly followed the prerequisites and installation steps in this chapter. Also, make sure the test was performed in an environment with pristine data. In this environment, the equipment number 34665 that is referenced by the white list entry in P952000 should be in the database.

2.2.4 Set Up a Temporary Directory on the AIS Server for File Transfers

In the Orchestrator Studio, you can create a connector service request to transfer files in and out of EnterpriseOne. When the Orchestrator executes this type of service request, as part of the process, files are saved to a temporary directory on the AIS Server. You must use Server Manager to set up this directory. In Server Manager, access the basic configuration settings for the AIS Server, and use the Temporary Directory setting to establish this directory.

2.2.5 Upgrade Orchestration Components

If you have legacy orchestration components on the AIS Server that were created in the Orchestrator Studio prior to release 3.0.1 or through manually configured XML files (pre-Orchestrator Studio), you must upgrade these components to user defined objects. See Upgrading Orchestration Components to User Defined Objects (Release 9.2.1) in this guide for more information.