Creating a Simple Orchestration 

Before You Begin

This 20-minute tutorial 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 tutorial employs the following scenario to show you how to create a simple orchestration. When there is some reason to put a customer on credit hold, for example, if a customer exceeds their credit limit, you want an orchestration that will automatically:

• Use the Customer Master Revision form to place a hold on the customer’s credit
• Send a message about the customer’s credit hold to the account representative

In this tutorial, you will perform the following tasks:

1. Use the Orchestrator Process Recorder to record the steps to set a credit hold on the Customer Master Revision form
2. View and update the form request that was created by the Process Recorder
3. Create a message request that sends a credit message to Work Center to your own Address Book number
4. Add the Set Credit Hold and Send Credit Message requests to an orchestration
5. Test the orchestration
6. Modify the orchestration outputs and test the orchestration again

What Do You Need?

• Orchestrator Studio 9.2.4 or higher deployed in a JD Edwards EnterpriseOne test environment with a minimum of EnterpriseOne Tools 9.2.2.4
• A user ID that has access to Orchestrator Studio
• An Address Book record for your user ID

Recording 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. Follow the steps below to access EnterpriseOne and use the Process Recorder to record the steps required to place a credit hold on a customer.

Tip: Because Process Recorder will record every click and action you take, you might want to rehearse these steps before you start recording the process. That will help to eliminate errors and unnecessary extra steps. If you make a mistake during the recording, simply stop the recorder, discard the recording, and start again.

1. Sign in to the Orchestrator Studio.
2. Click the Tools link in the upper right corner and click the JD Edwards EnterpriseOne option.
3. Sign in to EnterpriseOne.
4. On the EnterpriseOne home page, click the user drop-down menu in the upper-right corner and select Record a Process.
5. In the Process Recorder pop-up box, click Start to start the recording.
6. Click Navigator    and enter P01012 in the Fast Path to access Work With Addresses.
7. In the Address Number Query By Example (QBE) field, enter the customer number that you will place on a credit hold and click Find.

Note: In the standard EnterpriseOne demo data, a common customer number is 4242, “Capital System.”


8. Click the box to select the row, then click Select .
9. In the Process Recorder pop-up box, click Return Values and then click on the following fields:
   • Address Number
   • Alpha Name

Notice how Process Recorder adds these fields to the Return Columns box. These fields will be returned by the form request so that they can be used in the credit message later.



10. Click Resume to continue recording.
11. Click Cancel to return to the Work With Addresses Form.
12. With the row still selected in the grid, click the Row menu and then select A/R.
13. 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.
    
    Note: If the customer number you have chosen already has a 7 in the Credit Message field, enter a different valid value, for example “B” and press Tab.
    
    
14. 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
15. Click Save.
    
    The Process Recorder has just save the actions you took as a form request. You will edit this form request in Orchestrator Studio in the next exercise.


16. Click Cancel on the Customer Master Revision form to cancel without saving.
17. Click Close on Work With Addresses.

In the next task you will use the Form Requests 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 Form Requests icon.
3. On the Form Requests page, use the Filter field to search for your "Set Credit Hold" service request.
   
   Note: If your “Set Credit Hold” form request doesn’t appear in the list, click the Refresh icon.


4. Select the "Set Credit Hold" form request.
   
   The Form Requests page shows your Set Credit Hold form request and a “train” of the four forms you used when you recorded the process.



The Order of Execution grid shows the four steps you took on the first form, Work With Addresses. Verify that the actions are in the following order:



5. For the Address Number mapped variable in the first row, delete the default value (4242) that appears. This is the value you used when you recorded the process, but in this case you do not want to use a default value because you will be passing a customer number to the orchestration as an input later.
6. For the Select Row value, leave the default value as 1 because after performing the Find for a specific address number you will still want Orchestrator to choose the first row.
7. Click on the number 2 in the train to show the Order of Execution for the second form, Address Book Revision.
   
   The Return Form Data row appears because you chose to return values on this form while you were recording the process in the previous section.


8. Click the Edit Returns (arrow) icon.
   
   The pop-up form shows the two values you chose to return: Address Number and Alpha Name.
9. In the Variable column, change the value from Alpha_Name to Customer_Name. Click anywhere outside the form to close it.
10. Click on the number 3 in the train to show the Order of Execution for the third form, Work With Addresses.
    
    The Order of Execution grid shows the steps you took on this form, which was only to select A/R from the Row Exit.
11. Click on the number 4 in the train to show the Order of Execution for the fourth form, Customer Master Revision.
    
    The Order of Execution grid shows the steps you took on that form, which were to click the Credit tab and to enter 7 in the Credit Message field.
    
    Note: When you were recording the process, if the Credit Message field already had a value of 7, you might have entered a different valid value, such as “B.” If so, change the value to 7 now. When you were recording the process you exited the form without clicking the OK button to complete the transaction. However, when you run this orchestration you do want Orchestrator to include the OK action and complete the transaction, so you can add it in the following steps.
12. In the Available Actions grid, click the triangle to expand Buttons and Exits.
13. Scroll down until you find the OK action and click the Add Action button.
    
    The Orchestrator Studio adds the OK step to the end of the Order of Execution grid.
14. Click Save .
15. Click the Home link in the top left corner to return to the Home page.

Creating a Message Service Request to Send a Credit Message

In this exercise you will 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 Orchestrator Studio Home page, click the Messages icon.
2. On the Messages page, click the New button and then complete the following fields:
   
   Name = Send Credit Message
   
   Description = Send credit hold message when customer exceeds credit limit
3. Verify that the value of Product Code is 55.
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 tutorial.
   
   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:
   
   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. Click the Add button next to Application Link to open the field. Complete the following fields to include a shortcut to the Customer Master Revision form in the message:
   

Field Name	Description
Application	Enter: P03013
Form	Select: W03013B - Customer Master Revision from the drop-down menu
Version	Select: ZJDE0001 - Customer Master -Redesign from the drop-down menu
Pre Text	Enter: Review the customer's record in the
Link Text	Do nothing. The value for the link text “Customer Master Revision” is displayed automatically.
Post Test	Enter: program.


Leave the remaining fields blank.


8. 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.
9. In the 8 - Company row, enter the following value for the Form Interconnect Value:
   00000
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.
10. Click Save .
11. Click the Home link in the top left corner to return to the Home page.

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

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. Access the Orchestrator Studio.
2. On the Orchestrator Studio home page, click the Orchestrations icon, and then click the New button on the Orchestrations page.
3. Complete the following fields:
• Name = Credit Hold
• Description = Set credit hold and send credit hold message
• Verify that the value 55 is selected in the Product Code drop-down list.
4. Click the "+" icon and choose Form Request to get a list of all available form requests.
5. Choose the Set Credit Hold form request that you created in the previous exercise.
6. Click the Start icon and then click the Inputs and Values icon.
7. On the Inputs and Values form, click in the first cell under Input and enter "Customer" to add it as an orchestration input.
8. Click Save.
9. Click the Set Credit Hold service request, then click the Transformations icon.
10. On the Transformations form, on the Address_Number row, click the drop-down to show a list of Available Values. Under Orchestration Inputs, choose "Customer."

This is the orchestration input you just added in Step 7. Now the orchestration input "Customer" is mapped to the form request input "Address_Number". When you run the orchestration you will provide a customer number for the orchestration input "Customer". Orchestrator will then transform that input into the Address_Number input that the form request expects. Because of transformations, the inputs to the orchestration and the inputs to the steps are not required to have the same name.

Leave the Available Values for the rest of the rows blank.


11. Click Save.

Next, in the same way, you will add the "Send Credit Message" message you created as a step following the Set Credit Hold step.


12. Click Design Mode.
13. Click the "+" icon to the right of the Set Credit Hold step and choose Message to get a list of all available Message requests.
14. Choose the Send Credit Message message that you created in the previous exercise.
15. Click the Send Credit Message step, and then click the Transformations icon.

Similar to the form request step, you must provide transformations for the inputs for the message request.


16. On the Customer Name row, click the drop-down to see a list of Available Values. Under Set Credit Hold choose the "Customer_Name" value.

This value is not coming from an orchestration input, but rather as a return value from the previous form request step. In this way you can build a chain of orchestration steps. For any step, the return values of all previous steps are available.


17. On the ABNum row, click the drop-down to see a list of Available Values. Under Set Credit Hold, choose "Address_Number." This Address Number is also a return value from the previous step.
18. Click Save.

Testing the Orchestration 

1. In the Orchestrator Studio, click the Tools link in the upper right corner.
2. In the Tools menu, click the Run Orchestrations option.
3. In the Inputs area, enter the following input:
• Customer = Enter a valid customer number, such as 4242.

You don’t have to use the same customer number that you used when you recorded the process; however, make sure that you are using a customer number that is available in your system.
4. 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.

   

   
   Note that the orchestration output here is long and complicated. This is because we did not choose outputs for the orchestration, so the output contains all output from all steps. The next exercise explains how to choose outputs for your orchestration.

1. Return to the EnterpriseOne web client tab in your browser. If it timed out, you might have to sign in again.
2. Click the Navigator  and enter P01012 in the Fast Path.
3. In the Address Number QBE field, enter the customer number that you placed on a credit hold and click Find.
4. In the grid, select the customer row, then click the Row menu and select A/R.
5. 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.

Choosing Orchestration Outputs

In this exercise you will choose specific outputs for the orchestration to simplify the output.

1. Return to the Orchestrator Studio tab in your browser. If it timed out, you might have to sign in again.
2. Click the Orchestrations icon and then select the Credit Hold orchestration.
3. In the Credit Hold orchestration, click the End icon and then click Outputs.
4. On the Address Number row, enable the Select option.
5. On the Alpha Name row, enable the Select option, and then change the Output from Alpha Name to Customer Name.
6. Click Save.
7. Return to the Run Orchestrations tab in your browser.
8. In the Inputs area, enter the following input:
• Customer = Enter a valid customer number, such as 4242.

You don’t have to use the same customer number that you used when you recorded the process; however, make sure that you are using a customer number that is available in your system.


9. Click Run.

Compare the output with the output from the previous exercise. Note that the output is simpler when you run the orchestration by choosing the outputs.