Creating a Simple Orchestration in the JD Edwards Orchestrator Studio

Before You Begin

This Oracle By Example (OBE) shows you how to use the Orchestrator Process Recorder and Orchestrator Studio to create a simple orchestration that performs a transaction in EnterpriseOne and sends a message about the transaction to a recipient.

Background

This OBE employs the following scenario to show you how to create a simple orchestration.

When a customer exceeds their credit limit, you want an orchestration that will 1) place a hold on the customer’s credit and 2) send a message about the customer’s credit hold to the account representative. In this OBE, you will perform the following tasks:

• Use the Orchestrator Process Recorder to record the steps to set a credit hold in EnterpriseOne
• View and update the form request (service request) created by the Process Recorder
• Configure a message service request to send a credit message
• Add the Set Credit Hold and Send Credit Message service requests to an orchestration
• Test the orchestration in the Orchestrator Client

What Do You Need?

• Orchestrator Studio 7.1.0 or higher deployed in a JD Edwards EnterpriseOne test environment with a minimum of EnterpriseOne Tools 9.2.3.2.
-OR-
• The latest JD Edwards EnterpriseOne Trial Edition.

Using the Orchestrator Process Recorder to Record the Steps to Set a Credit Hold in EnterpriseOne

The JD Edwards EnterpriseOne Orchestrator Process Recorder enables you to record a series of actions in EnterpriseOne and save those actions as a new form request. This simplified method to create a form request is an alternative to manually creating a form request in the Orchestrator Studio. To access EnterpriseOne and use the Process Recorder to record the steps or “order of execution” required to place a credit hold on a customer in EnterpriseOne:

1. Sign in to the Orchestrator Studio. (You can access EnterpriseOne from the Tools page in the Studio.)
2. Click the Tools link in the upper right corner.
3. On the Tools page, click the JD Edwards EnterpriseOne icon.
4. Sign in to EnterpriseOne.
5. On the EnterpriseOne home page, click the user drop-down menu in the upper-right corner and select Record a Process.
6. In the Process Recorder pop-up box, click Start to start the recording.
7. Click Navigator    and enter P01012 in the Fast Path to access Work With Addresses.
8. In the Address Number QBE field, enter the customer number that you will place on a credit hold and click Find.
9. In the Process Recorder pop-up box, click Return Values and then click on the Alpha Name column of the customer row. Alpha Name is added to the Return Columns box and will be returned by the form request so that it can be used in the credit message later.
10. Click Resume to continue recording.
11. In the grid, select the customer row, then click the Row menu and select A/R.
12. Click the Credit tab and enter 7 in the Credit Message field and press Tab.
Notice that the “7 – On Credit Hold per Accounting” label appears next to the field.


13. Click Stop in the Process Recorder pop-up box and complete the following fields:
    
    Name = Set Credit Hold
    
    Description = Set credit hold when customer exceeds credit limit

Product Code = 55
14. Click Save.
15. Cancel the form without saving and close the application.
In the next task, you will use the Form Request design page in the Orchestrator Studio to view and update the steps for setting a credit hold. 

Updating the Form Request Created by the Process Recorder

1.  Return to the Orchestrator Studio Home page. You might have to sign in again if your previous session timed out.
2. On the Orchestrator Studio Home page, click the Service Requests icon.
3. On the Service Requests page, use the Filter field to search for your "Set Credit Hold" service request.
4. Select the "Set Credit Hold" service request and click Edit Service Request.
5. In the Available Actions section, highlight Work With Addresses and note that the Order of Execution section reflects the steps you took on that form. Verify that the actions are in the following order:



6. For the Address Number mapped variable in the first row, remove the default value that appears. You do not want to use a default value because you will be passing a customer number to the orchestration as an input later.
7. For the Select Row mapped value, leave the default value as 1 because after performing the Find for a specific address number, you will still want to choose the first row.
8. In the Available Actions section, expand Work With Addresses, and then expand Work with Addresses – Grid.
9. In the Alpha Name row, note that the check box in the Return column is checked. This is because we selected it as a return value in the previous section. In the adjacent field, in the Variable Name column, enter Customer Name.
10. Click Save .
11. In the Available Actions section, select Customer Master Revision and notice the Order of Execution section changes to reflect the step we took on that form to enter 7 in the Credit Message field.
12. Add a second step to click OK by performing the following steps:
1. Under Customer Master Revision, open Buttons and Exits.
2. Select OK and click Add Action  .
   
   The Orchestrator Studio adds another step to the Order of Execution grid.





13. Click Save .
14. Click the Service Requests link in the top left corner to return to the Service Requests page.
15. Select the Set Credit Hold form request that you just created. Notice that the graphical representation of the form request shows each of the forms in the order of execution, which should look like this:

Configuring a Message Service Request to Send a Credit Message

Create a message service request to enable the orchestration to send a message about the customer exceeding their credit limit. You will include variables in the message service request to pass the customer name and customer address book number from the orchestration to the message service request.

1. On the Service Requests page, click Create Service Request and then select Message from the drop-down list.
2. On the Message page, complete the following fields:
   
   Service Request = Send Credit Message
   
   Enter Short Description = Send credit hold message when customer exceeds credit limit
3. Click the Product Code drop-down list and select 55 for a customer product code.
4. In the To field, select Address Book from the drop-down list and then enter the address book number associated with your user ID.
   
   Using your own address book number will enable you to verify that a message was sent to the EnterpriseOne Work Center, which you will do later in this OBE.
   
   As an alternative, if your EnterpriseOne environment has an SMTP server configured with EnterpriseOne to send messages to external email systems, you can select Email from the To field and enter a valid email address.
5. In the Subject field, enter a subject that includes a variable for the customer name as shown:
   
   ${Customer Name} Over Credit Limit
6. In the body area, enter the following message, right-clicking to include two variables to hold the address book number and name of the customer:
   
   Customer ${ABNum}: ${Customer Name} is over their credit limit.
   
   When you add this message request to the orchestration in the next task, you will map the orchestration inputs Customer and Customer Name to the message request variables ABNum and Customer Name accordingly.
7. Expand the Shortcuts area and perform the following steps to include a shortcut to the Customer Master Revision form in the message:
   
   
   1. Click Add.
      
   2. Complete the following fields.
      
      Application = P03013
      
      Form = W03013B
      
      Version = ZJDE0001
      
      Pre Text = Review the customer's record in the
      
      Link Text = Customer Master Revision

Post Text = program.
      
      
      Leave the remaining fields blank.
   3. In the 7 - Address Number (AN8) row in the grid, manually enter the following value for the Form Interconnect Value:
      
      ${ABNum}
      
      The shortcut uses the value passed to this variable to access the customer’s record in the Customer Master Revision program.
   4. In the 8 - Company row, enter 00000 for the Form Interconnect Value.
      
      This value is required for the shortcut to access the customer record. It is the default Company code used for all customer records in the EnterpriseOne test environment.
8. Click Save .

Adding the Set Credit Hold and Send Credit Message Service Requests to an Orchestration

In this task, you will:


• Create a new “Credit Hold” orchestration that includes Customer as an input.
• Add the form request and message request components as “steps” in the orchestration.
• Map the orchestration inputs to the orchestration steps.
1.  In the upper left corner of the Orchestrator Studio, click the   icon twice and then click the Orchestrations icon in the side panel.
2. On the Orchestrations page, click New Orchestration.
3. Complete the following fields:
   
   Orchestration = Credit Hold
   
   Enter Short Description = Set credit hold and send credit hold message
4. Click the Product Code drop-down list and select 55 for a customer product code.
5. Expand Orchestration Inputs and in the first row in the Input grid, enter Customer for the Input and then in the Value Type drop-down list, select Numeric.
   You will use this input to pass in a customer number to the orchestration.
6. Click Save  .
7. Add the Set Credit Hold form request as the first step in the orchestration:
   
   1.  Next to Orchestration Steps, click Add Step .
   2. In the Enter Type of Step pop-up, click the drop-down list and select Service Request, and then click OK .
      
      The Service Request step appears in the grid.
   3. At the end of the Service Request row, click the down arrow and then find and select Set Credit Hold from the drop-down list. To select using Chrome, carefully hover over the down arrow until the cursor appears.

   

8. Add the Send Credit Message service request as the next step in the orchestration:
   

   

   
   
   1. With the first Service Request row selected, click Insert Step After .
   2. In the Enter Type of Step pop-up, click the drop-down list and select Service Request, and then click OK .
   3. At the end of the new Service Request row, click the down arrow, and then find and select Send Credit Message from the drop-down list.
   4. Click Save again.
      
      
9. Use the Transformations area to map the service request inputs to the values defined in each orchestration step:
   
   
   1.  Select the Set Credit Hold step in the grid.
      
      The Transformations grid displays the service request inputs for this form request.
   2. In the Address Number row, click the Available Values drop-down list and select Customer.
      
      

   

   3. Select the Send Credit Message step in the grid.
      
      Notice in the Transformations grid, the Service Request Input displays the variables entered for the inputs in the Send Credit Message service request.
   4. In the ${Customer Name} row, click the Available Values drop-down list and select Customer Name.
   5. In the ${ABNum} row, click the Available Values drop-down list and select Customer.
10. Click Save .
11. In the upper left corner, click the Orchestrations link and then from the list of orchestrations, find and select Credit Hold.
    
    The Orchestrator Studio displays a graphical representation of the orchestration with all its components, which should look like this:
    

    

Testing the Orchestration in the Orchestrator Client 

1. In the Orchestrator Studio, click the Tools link in the upper right corner.
2. On the Tools page, click the Orchestrator Client icon.
3. Sign in using your user ID for both the User and Password.
4. Click XML Cache Refresh. If a dialog box appears, click OK.
   
   Before you test an orchestration, you should click XML Cache Refresh to ensure that you are not using cached data for the test.
5. Click the Orchestration Name drop-down list and select the Credit Hold orchestration.
6. In the Inputs area, enter the following input:
   
   Customer = Enter the customer number.
   
   Make sure that you are using a customer number that is available in the data pack demo data.
7. Click Run.
   
   If a green check mark or a yellow caution symbol appears next to the Input and Output areas that display the request and response in JSON code, then congratulations! You successfully configured the Credit Hold orchestration.
   

1. Return to the Orchestrator Studio. If it timed out, you might have to sign in again.
2. Select the Tools menu in the upper right corner, and then click the Oracle JD Edwards EnterpriseOne icon.
3. Sign in to EnterpriseOne.
4. Click the Navigator  and enter P01012 in the Fast Path.
5. In the Address Number QBE field, enter the customer number that you placed on a credit hold and click Find.
6. In the grid, select the customer row, then click the Row menu and select A/R.
7. Click the Credit tab to verify the Credit Message is at status “7 – On Credit Hold per Accounting.” Congrats! It worked!
   

1.  On the EnterpriseOne home page, click the Navigator menu and in the Fast Path, enter P012503 to access the Employee Work Center.
2. In the Work Center, click Find.
3. Expand the Personal In Basket queue, where you should see the “Over Credit Limit” message for your customer.
4. Select the message to view it.
5. Click the Message Text drop-down list, select Customer Master Revision.jde, and then click the shortcut displayed in the message.
   
   This shortcut should take you to the customer’s record in Customer Master Revisions, where you can click the Credit tab and see the “7 – On Credit Hold per Accounting” status.

Next OBE

Proceed to “Creating a Complex Orchestration in the Orchestration Studio” OBE to create a multifaceted orchestration that retrieves and evaluates customer data from EnterpriseOne and invokes the orchestration you just created in this OBE orchestration if certain criteria is met.

Want to Learn More?

• JD Edwards EnterpriseOne Orchestrator Guide
• JD Edwards EnterpriseOne Orchestrator Page on LearnJDE