D Creating Orchestrations with Orchestrator Studio 3.0.1 (Release 9.2.1)

Note:

This appendix describes how to use Orchestrator Studio 3.0.1 that was available starting with EnterpriseOne Tools 9.2.1.

To use Orchestrator Studio 7.0.x.0, the latest version available with EnterpriseOne Tools 9.2.3, see:

This appendix contains the following topics:

D.1 Understanding the Orchestrator Studio and Orchestrations

The Orchestrator Studio is a web-based application for creating orchestrations and the components that comprise an orchestration. The Orchestrator uses these components to process a single orchestration instance on the AIS Server.

Use the Orchestrator Studio to create the following components:

  • Orchestrations. An orchestration is the master component that provides a unique name for an orchestration process. The orchestration is where you define the inputs for the orchestration, the expected incoming data from a device. The orchestration also includes orchestration steps, which are invocations to the other components described in this list. When the Orchestrator invokes an orchestration, it processes the steps defined in the orchestration to enable the transfer of data from third-party systems to EnterpriseOne.

  • Service Requests. A service request contains a sequence of actions to perform a particular process in EnterpriseOne. The Orchestrator uses the service request as an invocation of a JD Edwards EnterpriseOne interactive application or a Java application via a REST service call to the AIS Server.

  • Rules. A set of conditions that the input to the orchestration is evaluated against to produce a true or false state. With rules, a false outcome or true outcome can invoke further orchestration steps. You can also nest rules, in which an outcome of one rule can invoke a different rule, to produce complex evaluations. You can also use custom Java to define rules.

  • Cross References. A set of data relationships that map third-party values to EnterpriseOne values. For example, a device's serial number can be cross-referenced to a JD Edwards EnterpriseOne Equipment Number for use in service requests.

  • White Lists. A white list contains an inclusive list of values permitted in the orchestration and terminates the orchestration process if the data is not recognized.

A simple orchestration requires at a minimum an orchestration and a service request to run.

Figure D-1 shows the drop-down list of steps (or components) that you can add to an orchestration. Each step in an orchestration is simply a reference to a cross reference, rule, service request, or white list component.

Figure D-1 Orchestration Steps in the Orchestrator Studio

Description of Figure D-1 follows
Description of ''Figure D-1 Orchestration Steps in the Orchestrator Studio''

D.1.1 Reusable Orchestration Components

Orchestration components are reusable. A single component, such as a rule or cross reference, can be included as a step in more than one orchestration. If a component is used as a step in more than one orchestration, you should evaluate how it is used in other orchestrations before modifying it. To determine if a component is used by other orchestrations, select the component and then click the "i" button to display a pop-up window with a list of orchestrations where the component is used.

When in doubt, use the "Save As" button to create a new component from an existing one. This enables you to give it a new name and modify it as necessary, and eliminates the risk of breaking other orchestrations where the component is used.

D.1.2 Orchestrations as User Defined Objects

All orchestration components that you create in the Orchestrator Studio are stored as user defined objects (UDOs) in EnterpriseOne. The Orchestrator Studio includes UDO features for creating, sharing, and modifying orchestration components as UDOs. See User Defined Object (UDO) Features for a description of the UDO features.

D.2 Accessing the Orchestrator Studio

The Orchestrator Studio is a web application that runs in a web browser. Ask your system administrator for the URL to the Orchestrator Studio.

Important:

Before users can access the Orchestrator Studio, an administrator must set up security to authorize access to the Orchestrator Studio design pages and determine the actions Orchestrator Studio users can perform. See Chapter 11, "Administering the Orchestrator Studio and Orchestrations" for more information.

To access the Orchestrator Studio:

  1. In a web browser, enter the URL to the Orchestrator Studio:

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

  2. On the Orchestrator Studio Sign In screen, enter your EnterpriseOne User credentials, environment, and role.

    Note:

    It is highly recommended that you enter an EnterpriseOne environment used for testing, not a production environment.
  3. Click the Login button.

In the Orchestrator Studio, click the drop-down menu in the upper-right corner to view the path to the AIS Server. The drop-down menu also provides a link to log out of the Orchestrator Studio.

D.3 Navigating the Orchestrator Studio

The first page that appears after you log in to the Orchestrator Studio is the Home page. The orchestration component icons on the Home page take you to the design pages for creating and modifying each orchestration component. You can click the Home icon at the top left of the Home page to display a side panel, which provides another way to access the orchestration component design pages. You can also access this side panel within the component design pages for easy navigation between the different design pages. Figure D-2 shows the side panel enabled on the Home page.

Figure D-2 Orchestrator Studio Home

This image is described in surrounding text.

The Tools link in the upper-right corner of the Home page provides access to the Orchestrator Studio Tools page. This page provides links to the Orchestrator Client for testing orchestrations, the Import tool for importing orchestration files, and the JD Edwards EnterpriseOne web client. For more information, see the following topics:

D.4 Working with the Orchestrator Studio Design Pages

This section describes:

D.4.1 Design Page Features

The Orchestrator Studio design pages contain the following features, which are highlighted in Figure D-3:

  • Component list. Displays a list of existing components.

    You can use the vertical divider next to the component list to adjust the size of the list. Or you can click the raised tab on the divider to hide or show the component list.

  • Group Filter drop-down list. Enables you to display components in the component list by UDO status: Personal, Pending Approval, Rework, Reserved, Shared, or All.

  • Search field. Search for an existing component in the list.

  • New <Component> button. Create a new component.

  • i (About). Takes you to the About page which provides the Status, Detail, Description, and Object Name of the selected component. It also shows a list of the orchestrations where the component is used.

  • Restore All or Restore <Component>. Restore a component to its original state if you made a mistake and do not want to save your changes.

  • Export File. Export a component file to your local machine, which you should use only to inspect the XML of the component. See Exporting Orchestration Components from the Orchestrator Studio in this guide for more information.

  • Close. Exit the design page.

Figure D-3 Orchestrator Studio Design Page Features

Description of Figure D-3 follows
Description of ''Figure D-3 Orchestrator Studio Design Page Features''

D.4.2 User Defined Object (UDO) Features

Orchestration components are saved and managed as UDOs in EnterpriseOne, which enables administrators to use EnterpriseOne administration tools to manage the life cycle of orchestration components. See Chapter 11, "Administering the Orchestrator Studio and Orchestrations" in this guide for more information.

The Orchestrator Studio includes UDO features that enable you to create orchestration components for your own personal use, publish or "share" orchestration component UDOs with other Orchestrator Studio users, and modify shared UDOs created by others. The actions yhou can perform, or the UDO features you can use, depends on UDO permissions granted to you by a system administrator. See Setting Up UDO Security for Orchestrator Studio Users (Release 9.2.1) for more information

Table D-1 describes the UDO buttons in the Orchestrator Studio design pages and the life cycle status enacted by each UDO action.

Table D-1 UDO Buttons in Orchestrator Studio Design Pages

UDO Button Description

Save and Save As

Saves the orchestration component to a status of "Personal." This means that the component has not been shared. Components with a status of "Personal" are components that you are developing and have not been shared for publishing to the AIS Server.

Request to Publish

Sends the orchestration component for approval for sharing. An administrator or approver must approve it in order for the UDO to be shared. The component status changes to "Pending Approval" in the component list and then changes to "Shared" once it is approved. If rejected, that status changes to "Rework." At that point, you can edit the component and then use the Request to Publish button to send it for approval again.

Reserve

Reserves a shared UDO so you can modify it. When reserved, no other users can make changes to it. The component status changes to "Reserved."

Unreserve

Cancels the reserved component, which returns the status of the component to "Shared."

Delete

Deletes a "Personal" UDO. You cannot use this button to delete a shared UDO. Shared UDOs can only be deleted by an administrator.

Notes

Available when the component is in the "Pending Approval" status, this button enables you to add an additional note to send to the approver of the UDO. The Notes button is active only if there was a note added the first time the UDO was sent for approval using the "Request to Publish" button. This feature enables you to add an addendum to the original note.


Figure D-4 highlights the UDO features.

Figure D-4 Design Page UDO Features

Description of Figure D-4 follows
Description of ''Figure D-4 Design Page UDO Features''

D.4.3 Working with the Graphical Representation of an Orchestration

The initial Orchestrations design page shows a graphical representation of a selected orchestration with all its components, as shown in the example in Figure D-5.

Figure D-5 Initial Orchestrations Design Page

Description of Figure D-5 follows
Description of ''Figure D-5 Initial Orchestrations Design Page''

Use the following features in the graphic area to work with a graphical representation of the orchestration:

  • Navigation toolbox

    In the upper-left corner of the graphic area, click the raised tab to display a toolbox for navigating the graphic. Use the directional controls in the toolbox to pan left, right, up, and down, as well as zoom in or zoom out. Or you can click the "Zoom to Fit" button to display the entire graphical representation in the window. Use the layout buttons to change the layout to vertical, horizontal, tree, radial, or circle. Changing the layout can help with viewing more complex orchestrations that contain multiple components.

  • Informational hover help

    You can hover your mouse over a component in the graphical area to view an enlarged image of the component. Hovering over the labels on the lines between a rule component and its child components magnify the "True" or "False" label. A "True" label indicates that the child component will be invoked if the conditions in the rule are met. A "False" label indicates that the child component will be invoked when the condition of the rule is not met.

  • Isolate and Restore buttons

    The left side of each component contains an Isolate button that you can click to show only that component in the graphic area. You can then click the Restore button to display the entire graphical representation of the orchestration.

  • Access to the design page for editing the component

    When you click a box representing a component, the Orchestrator Studio takes you to the design page for modifying that particular component.

D.5 Creating Service Requests

This section contains the following topics:

D.5.1 Understanding Service Requests

At a minimum, an orchestration requires an orchestration component with inputs and a service request component to run. The service request provides the instructions that the Orchestrator uses to invoke and perform a particular task in EnterpriseOne. The service request provides the instructions on how to process the data from the orchestration inputs.

Before you create a service request, you must first identify the EnterpriseOne task or business process that you want the service request to perform. See the Identifying the Service Request Information for the Orchestration section in this guide for more information.

Use the Service Request design page in the Orchestrator Studio to define a service request, which involves:

  • Specifying the EnterpriseOne buttons, fields, columns, menu items, and so forth that are involved in performing a task in EnterpriseOne.

    In the Service Request design page, you can search on an EnterpriseOne application form and view all of the controls and fields for a form.

  • Determining the order of execution in which the controls and fields are used to perform the desired task in EnterpriseOne.

Note:

You can also use custom Java to execute a custom process or to route data into another database. See Chapter 8, "Creating Custom Java for Orchestrations".

D.5.1.1 Understanding the Application Stack Option

The Application Stack option in the Service Request design page enables you to create a service request that establishes a session for a specific application and maintains that session across calls. With application stack processing, the service request can invoke multiple forms in different applications to complete a business process. Without the application stack processing, each form in the service request is opened independently.

If you use the Application Stack option, the service request must include instructions for navigating between forms. Without the navigation, additional forms will not be called.

Only values from the last form in the application stack can be returned; return controls specified for any form except the last form are ignored.

D.5.2 Understanding the Service Request Design Page

The Service Request design page contains two areas: the "Order of Execution" area and the "Available Actions" area. The Available Actions area serves as the workspace for finding and configuring all of the EnterpriseOne controls and fields that make up the sequence of actions in the Order of Execution area. You locate and configure the controls and fields in the Available Actions area, and then move each item to the Order of Execution and place them in the proper sequence.

Available Actions Area

In the Available Actions area, you can search on an EnterpriseOne form to load all of the available controls (menu items, buttons, check boxes, and so forth) and fields for that form. If the service request needs to invoke more than one application to complete the task, you can load the controls and fields of additional application forms as needed. You can select the Application Stack check box to enable application stack processing as described in the Understanding the Application Stack Option section.

Figure D-6 shows the results of loading an EnterpriseOne application form in the Available Actions grid.

Figure D-6 Available Actions Area in the Service Request Design Page

Description of Figure D-6 follows
Description of ''Figure D-6 Available Actions Area in the Service Request Design Page''

The columns in the Available Actions grid provide interactive features for configuring the controls and fields before you add them to the Order of Execution area. The following list describes how to use each column:

  • Description

    This column displays the controls and fields for each form in a collapsible/expandable parent node named after the EnterpriseOne form. Child nodes categorize other items, and include a Buttons and Exits node, a node for displaying the available Query by Example (QBE) fields in a grid (if applicable), and a node for displaying all of the available columns in a grid.

  • Mapped Value

    Use this column to define the input variable name. Later, when you add the service request to an orchestration, you map the orchestration input to this name. You can only map inputs to a field if 1) the EnterpriseOne field is an editable field and 2) you defined the inputs in the orchestration as described in Adding Inputs to an Orchestration.

  • Default Value

    Enter a default, hard-coded value if there is no mapped value. You can also add a hard-coded value to use if the mapped value returns a null.

  • "Text substitution" check box column

    This check box enables you to add text substitution for an input. Text substitution enables you to combine input values into a text string for input into an EnterpriseOne field. For example, you might have a string with "Temp was {0} at {1}" that contains a temperature input value and a time input value.

  • ID

    This column displays the ID of the control or field in EnterpriseOne. This is for informational purposes only.

  • Form Mode

    If a form mode was selected, this column indicates if a field or control is only available in the selected form mode.

  • Return

    You can specify any values that you want returned in the orchestration response after EnterpriseOne actions are invoked. If you do not specify any return values, all values on the form will be returned. Return values may be used by customized third-party gateway programs or devices to do further processing based on the values returned from EnterpriseOne applications.

  • Return Name

    This field is automatically enabled when the Return check box is selected. When enabled, you can manually enter a name in this column, which makes this value available for mapping in subsequent orchestration steps when the service request is added to an orchestration.

  • Select First Row

    Move this action to the Order of Execution if the service request tasks involves selecting the first row in the grid.

After you configure each applicable control or field in the Available Actions area, you click the Add Action button in the last column to add each item as an action in the Order of Execution area at the top of the design page.

Order of Execution Area

When actions are added to the Order of Execution grid, you can reorder them using the up and down arrow buttons to the right of each row. You can also delete any actions using the Delete (X) button. Figure D-7 shows the Order of Execution area.

Figure D-7 Order of Execution in the Service Request Design Page

Description of Figure D-7 follows
Description of ''Figure D-7 Order of Execution in the Service Request Design Page''

D.5.3 Creating a Service Request

The first time a new service request is saved, it is saved as a "Personal" UDO. Thereafter, you can use the UDO buttons described in the User Defined Object (UDO) Features section to move the service request to the appropriate status.

To create a service request:

  1. Access the Service Request design page:

    • On the Orchestrator Home page, click the Service Requests icon.

      OR

    • After adding a Service Request step to an orchestration, click the Service Request step row.

    The Orchestrator Studio displays the initial Service Requests design page.

  2. On this page, click the New Service Request button.

  3. On the Service Request design page, enter a name for the service request in the Service Request field.

    Do NOT include any spaces in the service request name.

  4. In the space provided, enter a short description with a maximum of 200 characters. This description appears below the service request name in the component list.

  5. Click the Edit Long Description button to add a long description to provide more detail about the purpose of the component.

  6. At this point, click the Save button, which saves the service request as a "Personal" UDO.

  7. Proceed to configure the actions in the service request as described in the Configuring the Actions in the Service Request section.

D.5.4 Configuring the Actions in the Service Request

In the Service Request design page, use the Available Actions area to define actions that you want the service request to perform. After you define the actions, you can place the actions in the proper order in the Order of Execution area as described in Defining the Order of Execution in the Service Request.

To configure the actions for the service request:

  1. In the Available Actions area, complete the following fields to specify the EnterpriseOne form that contains the controls you want to load:

    • Application. Enter the ID of the EnterpriseOne application.

    • Form. Enter the form ID.

    • Version. Enter the version of the EnterpriseOne application.

    • Form Mode. (Available with Release 9.2.0.3) Click the drop-down menu and select the appropriate form mode: Add, Update, or Inquiry.

      The form mode determines the controls that are displayed for the form. At runtime, the controls that appear on an EnterpriseOne form are dependent on the form mode as specified in Form Design Aid (FDA). This ensures that you can see all of the form controls in the Orchestrator Studio that are available in the form at runtime.

    • Application Stack. Click this check box if you want to use application stack processing. See Understanding the Application Stack Option for more information.

  2. Click the Load Form button.

    The Orchestrator Studio loads the controls and fields for the form in the grid.

    If the action involves more than one form, you can search on another form and the Orchestrator Studio will load the controls for the form in a collapsible node at the end of the grid.

  3. To map service request inputs to EnterpriseOne fields:

    1. Select the row with the field in which you want to be mapped.

    2. In the Mapped Value column, enter a variable name to use for the mapping.

      When a service request is added to an orchestration, the inputs in the orchestration should match the inputs defined in the service request. You can also use the "Transformations" feature to map non-matching input names. See Adding Inputs to an Orchestration and Configuring Transformations for more information.

  4. If the service request task involves selecting the first grid row in the EnterpriseOne form, in the "Select First Row" row, click the Add Action button to move it to the "Order of Execution" area.

  5. If the service request task requires updating a particular row in an input capable grid, then map the appropriate input value containing the row number to the "Row Number for Update" row, or specify the row number in the Default Value column.

  6. In the Default Value column, you can perform the following actions to configure the default values for the controls:

    1. If the control is a check box or a radio button, you can select it to include it. If there are multiple radio buttons on a form, select only one. If you select more than one, only the last radio button in the Order of Execution list will be used.

    2. If the control is a combo box (a list of items in a drop-down menu), then the Studio displays a drop-down menu in the Default Value column in which you can select the appropriate item from the list.

    3. If the field is editable, you can enter a hard-coded value to map for the input. You can also enter a value to be used if the mapped value returns a null.

    Fields that are grayed out in this column are not editable.

  7. Select the Return check box next to the fields that contain values that you want returned in the orchestration response. If you do not specify any return values, all values on the form will be returned.

    Important:

    If using the Application Stack option:
    • Only values from the last form in the application stack can be returned; return controls specified for any form except the last form are ignored.

    • If you use a form to add or update a value that upon saving exits to another form (such as a Find/Browse form), the return values will come from the last form that appears after the save. In this scenario, you need to add the last form to the application stack and select the return controls from the last form.

  8. To use text substitution to combine input values into a text string for input into an EnterpriseOne field, perform these steps:

    Note:

    If you use text substitution for the input, the field cannot contain a mapped value. The substituted text string becomes the default value for the field when you add it to the Order of Execution list.
    1. In the field that you want to substitute the input with text, click the Add Text Substitution button (plus symbol).

    2. In the pop-up dialog box, in the Text Substitution field, enter the following variable (with brackets) to use for the first input:

      {0}

    3. In the Variable field, enter the input variable name.

    4. Click the Add button (plus symbol) to add the variable for the text substitution.

    5. Add the next variable, {1}, and then in the next blank row below the Variable field, enter the input variable name.

      If you add a variable by mistake, click the Remove Variable button.

    6. Click the Add button to add it to the text substitution.

    7. Click the OK button to save the variables for the text substitution.

      The following image shows an example of variables added for a temperature input value and a date input value:

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

  9. As you finish configuring the applicable rows in the Available Actions area, in the right-most column, click the Add Action button to move the configured rows to the "Order of Execution" area.

    Next, order the actions as appropriate as described in Defining the Order of Execution in the Service Request.

D.5.5 Defining the Order of Execution in the Service Request

After you move the actions from the Available Actions area to the Order of Execution area, you arrange the actions in the order required to perform the task in EnterpriseOne.

To define the order of execution:

  1. Click the action that you want to move up or down in the order.

  2. Click the "up arrow" or "down arrow" buttons at the end of the row with the action until the action is in the proper order.

  3. Continue until the order of the actions reflects how the task is performed in EnterpriseOne.

  4. If you added an action that is not needed, click the Delete (X) button at the end of the row to delete the action.

  5. If you make a mistake when modifying a service request, click the Restore Service Request button to restore the service request to its last saved version.

  6. Click the Save button to save your changes.

  7. Use the UDO buttons described in the User Defined Object (UDO) Features section to move the service request to the appropriate status.

D.5.6 Creating a Custom Java Service Request

You can create a service request that uses custom Java to execute a custom process or to route data into another database. Before you can create a custom Java service request, you must create the custom Java as described in Chapter 8, "Creating Custom Java for Orchestrations".

  1. Access the Service Requests design page from the Orchestrator Studio Home page.

  2. On the Service Requests design page, click the New Custom Java button.

  3. On the Service Request design page, enter a name for the custom Java service request.

    Do NOT include spaces in the name.

  4. Click the Edit Description button to enter a description for the custom Java service request.

  5. In the Class field, enter the Java class.

    This is the custom Java class that you created to use for the service request. See Chapter 8, "Creating Custom Java for Orchestrations".

  6. Complete the following fields:

    • Attribute. Enter the name of the field in the class.

    • Input Value. Enter the input variable name. If the attribute is a boolean and you pass in "true", then you could use a default value.

    • Default Value. Enter a default, hard-coded value if there is no mapped value. You can also add a hard-coded value to use if the mapped value returns a null.

  7. If you make a mistake, you can click the Restore Custom Java button which refreshes the custom Java rule to its last saved state.

  8. Click the Save button.

    The Orchestrator Studio saves the custom Java request. You can then access the orchestration in the Orchestration design page and add this custom Java service request as a step in the orchestration.

D.6 Creating Rules

This section contains the following topics:

D.6.1 Understanding Rules

A rule contains conditional logic that the Orchestrator uses to evaluate conditions, such as true or false conditions that determine how the orchestration processes the incoming data. You can define a rule with a list of conditions or you can define a more complex rule using a custom Java class. See Chapter 8, "Creating Custom Java for Orchestrations" for more information about using a custom Java class for rules,

An orchestration rule functions similar to an EnterpriseOne query in that each rule has:

  • A "Match Any" or "Match All" setting.

  • One or more conditions defined, each being a binary operation on two values.

After creating a rule and adding it to an orchestration, you use the Action column in the Orchestration design page to determine the orchestration step that is invoked when the conditions in the rule are met. See Defining the Actions Between a Rule and Dependent Components for more information.

D.6.2 Creating a Rule

Create a rule component to define the conditions for an orchestration.

The first time a new rule is saved, it is saved as a "Personal" UDO. Thereafter, you can use the UDO buttons described in the User Defined Object (UDO) Features section to move the rule to the appropriate status.

To create a rule:

  1. Access the Rules design page:

    • On the Orchestrator Home page, click the Rules icon. And then on the Rules design page, click the New Rule button.

      OR

    • After adding a Rule step to the grid in the Orchestration design page, click the Edit button next to the step.

    The Orchestrator Studio displays the Rule design page.

  2. In the Rule field, enter a name for the rule.

    Do NOT include any spaces in the rule name.

  3. In the space provided, enter a short description with a maximum of 200 characters. This description appears below the rule name in the component list.

  4. Click the Edit Long Description button to add a long description to provide more detail about the purpose of the component.

  5. Select the Match Value drop-down menu and select one of the following values:

    • Match All. Select this option if all conditions in the rule must be met.

    • Match Any. Select this option if any conditions in the rule can be met.

  6. In the first row in the grid, complete the following columns to add a condition:

    • Rule Type. Click the drop-down menu and select String, Numeric, or Date depending on the format of the input.

    • Value 1. Enter a variable for the input name.

    • Operator. In the drop-down menu, select from the list of operands which include: >, <, >=, <=, =, !=, startsWith, endWith, contains, between, inList.

    • Literal. Click this check box to indicate a literal value.

    • Value 2. If you selected the Literal check box, manually enter a value.

    • Literal Value Type. If you selected the Literal check box, click the drop-down menu and select the format of the literal value: string, numeric, data.

  7. Add additional conditions to the rule as needed. If you add a condition by mistake, you can delete it by clicking the Remove button at the end of the row with the condition.

  8. Click the Save button, which saves the rule as "Personal" UDO.

  9. Use the UDO buttons described in the User Defined Object (UDO) Features section to move the rule to the appropriate status.

    After adding a rule and a service request to an orchestration, in the Orchestration design page, you must define the action for the rule to invoke the service request. See Defining the Actions Between a Rule and Dependent Components for more information.

D.6.3 Adding a Custom Java Rule

You can create custom Java for a rule and then add it to an orchestration as a rule, which is referred to as a custom Java rule. Before you can add a custom Java rule to an orchestration, you must create the custom Java as described in Chapter 8, "Creating Custom Java for Orchestrations".

To add a new custom Java rule:

  1. Access the Rules design page from the Orchestrator Studio Home page.

  2. On the Rules design page, click the New Custom Java button.

  3. In the Rule field, enter a name for the custom Java rule.

    Do NOT include spaces in the custom Java rule name.

  4. In the Class field, enter the path to the Java class, which includes the name of the Java class.

    This is the custom Java class that you created to use for the rule.

  5. Complete the following fields in the grid:

    • Attribute. Enter the name of the field in the class.

    • Input Value. Enter a variable for the input name. If the attribute is a boolean and you pass in "true", then you could enter a hard-coded default value.

    • Default Value. Enter a hard-coded value if there is no mapped value. You can also add a hard-coded value to use if the mapped value returns a null.

  6. If you make a mistake while configuring any of the fields, you can click the Restore Rule button which refreshes the custom Java rule to its last saved state.

  7. Click the Save button.

D.7 Creating Cross References

This section contains the following topics:

D.7.1 Understanding Cross References

The Orchestrator uses a cross reference component to map incoming data (third-party data) to an EnterpriseOne value. The EnterpriseOne value identified in the cross reference is considered the output of the cross reference. The output from the cross reference becomes the data passed to another orchestration step.

For each cross reference that you create in the Orchestrator Studio, you have to create a cross reference record in P952000 in EnterpriseOne. When defining cross reference records for orchestrations in P952000, you must use the "AIS" cross reference type. For more information on how to create these cross reference records in P952000, see Chapter 5, "Setting Up Cross References and White Lists in EnterpriseOne (P952000)" in this guide.

Note:

If a cross reference lookup fails in an orchestration, the orchestration is terminated.

D.7.2 Creating a Cross Reference

You must define the orchestration inputs before you can create a cross reference. See Adding Inputs to an Orchestration for more information.

To create a cross reference:

  1. Access the Cross Reference design page:

    • On the Orchestrator Home page, click the Cross References icon. And then on the Cross References design page, click the New Cross Reference button.

      OR

    • After adding a Cross Reference step to the grid in the Orchestration design page, click the Edit button next to the step.

    The Orchestrator Studio displays the Cross Reference design page.

  2. In the Cross Reference field, enter a name for the cross reference.

    Do NOT include spaces in the cross reference name.

  3. In the space provided, enter a short description with a maximum of 200 characters. This description appears below the cross reference name in the component list.

  4. Click the Edit Long Description button to add a long description to provide more detail about the purpose of the component.

  5. In the Object Type field, enter a name for the object type.

    This is the object type used to categorize the orchestration cross references in EnterpriseOne. See "Adding Orchestration Cross References" in the JD Edwards EnterpriseOne Tools Interoperability Guide for more information.

  6. Complete the Input Key and Output Key columns to map the inputs to EnterpriseOne fields:

  7. If you enter any values by mistake, you can click the X button next to the field to delete the entry.

  8. Click the Save button, which saves the white list as a "Personal" UDO.

    The output values in the cross reference are now available for mapping in subsequent orchestration steps.

  9. Use the UDO buttons described in the User Defined Object (UDO) Features section to move the cross reference to the appropriate status.

D.8 Creating White Lists

This section contains the following topics:

D.8.1 Understanding White Lists

A white list contains a list of IDs permitted in the Orchestrator. By adding a white list to an orchestration, only inputs with IDs listed in the white list are permitted for processing by the Orchestrator. You add a white list component as a step in the orchestration.

In addition to specifying the permitted IDs in the white list, you must also specify the white list IDs in P952000 in EnterpriseOne. This is the same application that you use to set up and store orchestration cross references. As with cross references, use the "AIS" cross reference type in P952000 for a white list. In P952000, the Third Party App ID should have a value of WHITELIST. The EnterpriseOne value is not used for white lists and will default to NA.

If a white list lookup fails in an orchestration, the orchestration is terminated.

D.8.2 Creating a White List

The first time a new white list is saved, it is saved as a "Personal" UDO. Thereafter, you can use the UDO buttons described in the User Defined Object (UDO) Features section to move the cross reference to the appropriate status.

  1. Access the White List design page:

    • On the Orchestrator Home page, click the White Lists icon. And then on the White Lists design page, click the New White List button.

      OR

    • After adding a White List step to the grid in the Orchestration design page, click the Edit button next to the step.

    The Orchestrator Studio displays the White Lists design page.

  2. In the White Lists design page, click the New White List button.

  3. In the White List, enter a name for the white list.

    Do NOT include spaces in the white list name.

  4. In the space provided, enter a short description with a maximum of 200 characters. This description appears below the white list name in the component list.

  5. Click the Edit Long Description button to add a long description to provide more detail about the purpose of the component.

  6. In the Object Type field, enter a name for the object type.

    The value you enter in the Object Type field must match a cross reference object type in the EnterpriseOne Business Services Cross Reference application (P952000).

    The cross reference object type is a named group of records in P952000. For example, you may have thousands of records in P952000. You can use cross reference object types, for example "Equipment" or "Alert_Notification_Recipients" to group cross reference records into manageable categories. You define the cross reference object types as needed. See Chapter 5, "Setting Up Cross References and White Lists in EnterpriseOne (P952000)" for more information.

  7. In the Input Key column, enter the input that you want to add as a permitted input.

  8. Click the Save button.

  9. Use the UDO buttons described in the User Defined Object (UDO) Features section to move the white list to the appropriate status.

D.9 Creating Orchestrations

This section contains the following topics:

D.9.1 Understanding Orchestrations

Creating an orchestration in the Orchestrator Studio involves:

  • Naming the orchestration and specifying the input format for the orchestration.

    The input format can be JDE Standard, Oracle Cloud IoT, or Generic. See Supported Input Message Formats for more information about which input format to use.

  • Adding inputs to the orchestration.

    The inputs define the data passed from the device to the orchestration. This may include an ID that identifies the device as well as other data that the orchestration will receive from a device, such as temperature, date, or any other data you want to capture. Each input has a name and a type which can be string, numeric, or various date formats.

  • Adding steps to the orchestration.

    Each step is a component of the orchestration: a service request, rule, cross reference, or white list. At a minimum, an orchestration requires only a service request step, which provides the actions or the instructions to perform a particular task in EnterpriseOne.

  • Configuring transformations.

    You use transformations to map orchestration inputs to inputs defined in each orchestration step, such as inputs in a rule, cross reference, white list, or service request component.

Important:

Remember that when you are ready to "request to publish" an orchestration, you need to make sure that you also request to publish all components associated with the orchestration. This enables an administrator to save all required components to the proper directory on the AIS Server for processing by the Orchestrator. If a component is missing, the orchestration process will end in error.

D.9.2 Creating an Orchestration

To create an orchestration:

  1. On the Orchestrator Studio Home page, click the Orchestrations icon.

  2. On the Orchestrations page, click the New Orchestration button.

  3. On the Orchestration design page, enter a unique name for the orchestration in the Orchestration field.

    Do NOT use spaces when naming the orchestration.

  4. In the space provided, enter a short description with a maximum of 200 characters. This description appears below the orchestration name in the component list.

  5. Click the Edit Long Description button to provide more detail about the component.

    Use this field to describe the purpose of the orchestration and any details that differentiate the orchestration from other orchestrations that you create.

  6. Click the Input Format drop-down menu and select the appropriate format:

    • JDE Standard (default)

    • Oracle Cloud IoT

    • Generic

    See Supported Input Message Formats for more information about which input format to use.

  7. At this point, you can click Save before defining inputs or steps for the orchestration.

    The Orchestrator Studio saves the orchestration as a "Personal" UDO. Next, add inputs to the orchestration as described in the Adding Inputs to an Orchestration section.

You can also use the Save As button to create a new orchestration by copying an existing one and renaming it.

Caution:

If you create a copy of an orchestration, only the orchestration is copied. The Orchestrator Studio does NOT create a copy of the components that are associated with the orchestration's steps. That is, both the original orchestration and the new orchestration use the same components that comprise the orchestration. Therefore, in the new orchestration, do NOT modify the components in any way that would break other orchestrations that use the same components.

D.9.3 Adding Inputs to an Orchestration

Orchestration inputs identify the data an orchestration consumes from external devices. In the orchestration, you enter names for the inputs. For example you can enter "SensorID" to pass a sensor ID value to an orchestration and you can enter "TemperatureReading" to pass a temperature value to the orchestration.

You also use these orchestration inputs to configure other components used by the orchestration, such as a service request, rule, white list, or cross reference. For example, if the orchestration requires a rule, you use the orchestration inputs to define the conditions for the rule. If an incoming value from the device does not match an EnterpriseOne value, you can create a cross reference that uses the orchestration input to map third-party data to data in EnterpriseOne.

To add the orchestration inputs:

  1. In the first empty row in the Orchestration grid, enter the name of the input in the Input column.

  2. In the Value Type column, select the input value type. Valid values are:

    • String

    • Numeric

    If the input is a date, you can use any of the following date formats:

    • dd/MM/yyyy

    • dd/MM/yy

    • yyyy/MM/dd

    • MM/dd/yyyy

    • MM/dd/yy

    • yy/MM/dd

    You can also use the following date formats, which create additional inputs derived from the passed value:

    • Milliseconds

    • yyyy-MM-dd'T'HH:mm:ss.SSSZ

  3. Click Save to save your changes.

D.9.4 Adding Steps to an Orchestration

When you add a service request, rule, cross reference, or white list to an orchestration, you add it as a step in the orchestration. It is recommended that you create the component before adding it as a step in an orchestration.

The Orchestrator Studio provides "Insert Step Before" and "Insert Step After" buttons so you can add a step before or after another step in the orchestration. Therefore, you do not have to determine whether or not you need to add a particular step, such as a white list, to an orchestration before you add other steps.

Figure D-8 shows an orchestration that contains multiple rules, cross references, and service requests, which are displayed in the grid on the Orchestration design page:

Figure D-8 Steps in the AddConditionBased Alert Sample Orchestration in the Orchestrator Studio

Description of Figure D-8 follows
Description of ''Figure D-8 Steps in the AddConditionBased Alert Sample Orchestration in the Orchestrator Studio''

In the grid, the Type column shows the type of step and the Name column shows the name of the component for the orchestration step. The "True" or "False" values in the Action column determine the actions the orchestration performs based on the conditions set in the rules. See Defining the Actions Between a Rule and Dependent Components for information about defining the actions in an orchestration.

To add steps to an orchestration:

  1. To add the initial step to an orchestration, click the Add Step button (+ symbol).

  2. In the "Enter Type of Step" pop-up field, select one of the following steps to add to the orchestration, and then click the Ok button.

    • Cross Reference

    • Rule

    • Service Request

    • White List

    The Orchestrator Studio displays the first step in the grid.

  3. Add a component to the step:

    1. To use an existing component for the new step, click the drop-down menu in the Name column and select a component.

    2. To create a new component for the step, click the Edit button (pencil icon) at the end of the row to access the design page for creating the new component.

      After creating the component, when you return to the Orchestration design page, you will need to select the component from the drop-down menu in the orchestration steps grid to add it.

    See the appropriate topics in this chapter on how to create each type of orchestration component.

  4. In the Transformations area on the right side of the page, configure the transformations for each orchestration step as described in the Configuring Transformations section.

  5. To add additional steps to an orchestration:

    1. Select a step in the grid, and then click either the Insert Step Before or Insert Step After button to add an additional step before or after the selected step.

    2. In the "Enter Type of Step" pop-up dialog box, select the step that you want to add.

    3. Click the Ok button.

To remove a step from an orchestration:

Caution:

Before you delete a step, make sure the step is not used by any other component in the orchestration.
  1. Select the step that you want to remove.

  2. Above the grid with the steps, click the Remove Step button (the X button).

If you make a mistake when updating an orchestration, click the Restore All button in the upper-right corner of the design page to restore the orchestration to its last saved version, which erases any changes made since the last save.

D.9.4.1 Defining the Actions Between a Rule and Dependent Components

The Orchestration design page contains an Action column for defining the actions between a Rule step and other orchestration steps in an orchestration. After you create a rule with conditions and add it as a step to an orchestration, you need to define the action the orchestration takes if the condition in the rule is met. For example, if a rule contains a condition that when met should invoke a Service Request step, then in the Service Request step row, you need to set the Action column to True.

You can also define a False action to invoke a different orchestration step when a condition in the initial rule is NOT met. A False action can invoke a different Service Request step or another Rule step that contains additional conditions for which the incoming data is evaluated against. Thus, you can design an orchestration with as many rules and service requests as your business requirements necessitate.

Figure D-9 shows an example of an orchestration with two Rule steps and two Service Request steps, with the following defined actions:

  • For the first Service Request step, the action is set to True to instruct the orchestration to invoke this Service Request step when the condition in the first Rule step is met.

  • The action for the second (nested) Rule step is set to False to instruct the orchestration to invoke this rule when the condition in the first rule is NOT met.

  • The action for the second Service Request step is set to True to instruct the orchestration to invoke this service request when the condition in the second rule is met.

Figure D-9 Defining the Orchestration Actions

Description of Figure D-9 follows
Description of ''Figure D-9 Defining the Orchestration Actions''

To set the Action column to True or False:

  1. In the Orchestration design page, in the appropriate Rule or Service Request step row, click in the Action column.

  2. Select either True or False as appropriate.

  3. Click the Save button.

    After completing the orchestration, you can use the Orchestrator Client to test the orchestration in a test environment. You can access the Orchestrator Client from the drop-down menu in the upper-right corner of the Orchestrator Studio. See Chapter 10, "Testing Orchestrations in the EnterpriseOne Orchestrator Client" for more information.

D.9.5 Configuring Transformations

Use the Transformations area on the Orchestration design page to map orchestration inputs to inputs defined in an orchestration step, such as inputs in a rule, cross reference, white list, or service request component. The Transformations area includes an Auto Map button that automatically maps any matching inputs in the orchestration and orchestration step.

If an orchestration and an orchestration component use different input names to identify the same data, you can use the grid in the Transformations area to map the inputs. This facilitates the reuse of components, so you can avoid having to create a new component simply to match the input names (input from a device) in a new orchestration.

To better understand how you use transformations, consider the following scenario which is depicted in Figure D-10:

  • You have an existing service request that creates alerts in the EnterpriseOne Condition-Based Alerts Revisions application (P1311). This service request includes an input called EquipmentNumber that is mapped to the Asset Number field in P1311.

  • You want to reuse this service request as a step in a new orchestration, but the new orchestration will consume data from devices that supply the EquipmentNumber as "SerialNumber."

  • To reuse the existing service request designed to consume data labeled as EquipmentNumber, in the new orchestration, you can create a transformation to pass the SerialNumber input to the EquipmentNumber input in the service request.

  • Create the new orchestration with SerialNumber as one of the inputs, and then add the existing service request as a step.

  • When you click the Service Request step in the orchestration steps grid, the Service Request column in the Transformations table displays all of the inputs defined in the service request. Notice in Figure D-10 that EquipmentNumber, not SerialNumber, is defined as an input in the Service Request Input column.

  • Next, you click the Transformations Auto Map button, which automatically maps the matching inputs. Figure D-10 shows the SiteNumber, Latitude, and Longitude inputs in the Orchestration Input column, which were populated automatically after the Auto Map button was selected.

  • Finally, to map the SerialNumber input in the orchestration to the EquipmentNumber input in the service request, you click the drop-down menu in the Orchestration Input column and select SerialNumber, as shown in Figure D-10.

Figure D-10 Transformations Example

Description of Figure D-10 follows
Description of ''Figure D-10 Transformations Example''

Initially, when you have a small number of orchestrations in your system, it is recommended to keep all input names consistent among the orchestration and all components (orchestration steps) used by orchestration. But as your library of orchestrations and orchestration components increases, instead of creating new components with input names that match the orchestration inputs, you can use transformations to map the orchestration inputs to an existing component.

To create transformations:

  1. In the Orchestration design page, select an orchestration step for which you want to configure transformations.

  2. Click the Transformations Auto Map button to map matching input names. Matching inputs automatically appear in the Orchestration Input column next to the matching input in the "<orchestration step> Input" column.

  3. To map an orchestration input name to a non-matching input name in an orchestration step:

    1. In the Transformations table, select the drop-down menu in the appropriate Orchestration Input row.

    2. Select the orchestration input to map to the input name for the orchestration step.

    For example, in Figure D-10, SerialNumber is mapped to EquipmentNumber in the Service Request Input.

D.10 Reloading Orchestrations and Orchestration Components

The Reload Files feature enables you to reload orchestrations and orchestration components to the state in which they were last saved in the Orchestrator Studio. Use the Reload Files feature if you do not want to save any modifications that you made.

To reload all files, click the drop-down menu in the upper-right corner of the Orchestrator Studio and then click the Reload Files link.

Each individual orchestration component panel also contains a Restore button that you can use to restore an individual component.

D.11 Supported Input Message Formats

The Orchestrator supports three input message formats for orchestrations: a standard JD Edwards EnterpriseOne format, a generic format, and Oracle Cloud IoT format. Example D-1 and Example D-2 show an example of the code for each format.

Example D-1 Standard JD Edwards EnterpriseOne Input Message Format

{
     "inputs": [
         {
             "name": "equipmentNumber",
             "value": "41419"
         },
         {
             "name": "description",
             "value": "test"
         },
         {
             "name": "date",
             "value": "1427774400000"
         },
         {
             "name": "time",
             "value": "12:15:15"
         },
         {
             "name": "temperature",
             "value": "99"
         }
     ]
}

Example D-2 Generic or Oracle Cloud IoT Input Message Format

{
      "equipmentNumber": "41419",
      "description": "test",
      "date": "1427774400000",
      "time": "12:15:15",
      "temperature": "99"
}

D.11.1 Additional Supported Input Message Formats for the Generic Input Format

Additional formats are supported when using the generic input format, as long as the orchestration input values are defined using the full path to the elements used. You may have a deeper JSON structure like this.

{
    "equipmentNumber": "41419",
    "equipementDetail": {
        "type": "thermometer",
        "readingDetail": {
            "temperature": 200,
            "units": "F"
        }
    }
}

To reference the temperature within the orchestration, you can use the full path delimited by periods, for example:

equipmentDetail.readingDetail.temperature

D.11.2 Differences Between Input Message Formats

The following list describes the differences between the input message formats:

  • The iterateOver attribute for the orchestrationStep element is supported only by the standard JD Edwards EnterpriseOne input message format.

  • When using the "detail" form action type with the standard format, it will automatically iterate over all detailInputs and repeatingInputs in order to add multiple rows to a grid. If the generic format is used, only a single grid row can be added.

As shown in Example D-3, "detailInputs" would correspond to grid data; "repeatingInputs" would correspond to individual rows that contain "inputs" that correspond to columns.

If you have a power form with two grids, you could populate both grids using two "detailInputs" structures with different "name" values that correspond to the different grids. "repeatingInputs" would contain a list of rows and for each row you would define a list of "inputs".

You could also define a CrossReference orchestration step with iterateOver="GridData" that converts the item value into an EnterpriseOne specific item number. For example, if A123=220 and A124=230, the single orchestration step would convert both.

Example D-3

{
    "inputs": [
        {
            "name": "BranchPlant",
            "value": "30"
        },
        {
            "name": "customer",
            "value": "4242"
        }
    ],
    "detailInputs": [
        {
            "name": "GridData",
            "repeatingInputs": [
                {
                    "inputs": [
                        {
                            "name": "item",
                            "value": "A123"
                        },
                        {
                            "name": "Quantity",
                            "value": "3"
                        }
                    ]
                },
                {
                    "inputs": [
                        {
                            "name": "item",
                            "value": "A124"
                        }
                    ]
                }
            ]
        }
    ]
}

D.12 Setting Up Orchestration Security

Before the EnterpriseOne Orchestrator can process an orchestration, authentication of the JD Edwards EnterpriseOne user ID and password must take place. It is the responsibility of the originator of the service request to tell the orchestration about the user. The user's credentials must be supplied in a basic authorization header or in the JSON body of the request. The user must also have authorized access to the EnterpriseOne application in which the resulting transaction takes place. The following code is an example of credentials in the JSON body of the request:

{
                "username":"JDE",
                "password":"JDE",
                "environment":"JDV900",
                "role":"*ALL"
}

The AIS service used with orchestrations is stateless; each call passes credentials to establish a separate EnterpriseOne session. After the transaction is complete, the session closes.

In addition to passing credentials for authentication, you can employ a second level of security for the Orchestrator through whitelisting. Whitelisting enables an initial rudimentary pass/fail check of the incoming device signature against a predefined list of signatures. A white list provides an additional layer of security to the Orchestrator security. If a value passed to the Orchestrator is not a valid value included in the orchestration's white list, the Orchestrator rejects the input. For more information, see Creating White Lists in this guide.

D.12.1 Restricting Access to Exposed Orchestrations

If you expose orchestrations for business partners or customers to invoke, it is recommended to use an http proxy to allow access to only the endpoints required to execute the orchestration. Configure the proxy to restrict all endpoints except /orchestrator, /discover, /tokenrequest, and /tokenrequest/logout. This allows external users set up with the proper UDO security to discover and call orchestrations.

D.13 Exporting Orchestration Components from the Orchestrator Studio

Caution:

Do not use the Export and Import tools to share orchestration component files with other users. With orchestration components stored as UDOs in EnterpriseOne, the management of orchestration components, including the sharing and modifying of shared orchestration components and promoting of orchestration components to the appropriate AIS Server directory for test or production purposes, is administered through the life cycle management tools in EnterpriseOne.

You can export any of the orchestration component types from the Orchestrator Studio to view the source XML files of the components. This is only recommended for advanced users for troubleshooting purposes or for making manual customizations. The Orchestrator Studio exports the source XML files in a zip file.

To export an orchestration component, the Orchestrator Studio gives you the option to export only the selected orchestration component or to export the orchestration component and all components associated with it. For example, if an orchestration has a service request component and a rule component associated with it, if you export all components, the zip file will contain XML files for the orchestration, service request, and rule.

To export orchestration components:

  1. On a component design page, select the component to export and then click the Export File button in the upper-right corner.

    If you are exporting an orchestration, a dialog box appears in which you can click All or Orchestration Only.

  2. Follow the instructions in the browser to save the zip file to a location on your local machine.

D.14 Importing Orchestration Files in the Orchestrator Studio

Caution:

Do not use the Export and Import tools to share orchestration component files with other users. With orchestration components stored as UDOs in EnterpriseOne, the sharing and modifying of shared orchestration components, as well as the promoting of orchestration components to the appropriate AIS Server directory for test or production purposes, is administered through the life cycle management tools in EnterpriseOne.

You might need to import orchestration component XML files that were exported from the Orchestrator Studio for advanced troubleshooting or customization purposes. The Orchestrator Studio Import tool enables you to import individual orchestration XML files or a zip file containing XML files.

Caution:

You cannot import orchestration component files that were exported from the EnterpriseOne Object Management Workbench - Web application. The zip file created from an OMW - Web export stores the XML files in a structure that cannot be read by the Orchestrator Studio Import tool.

If importing a zip file that contains orchestration XML files and dependent orchestration component XML files, the zip should contain the following folders with each of the XML files stored in the appropriate folder:

Surrounding text describes importzip_folders.png.

If you import an XML file that has the same name as a current orchestration component (UDO) in the Orchestrator Studio, you have the following options:

  • If the UDO is at a status of "Personal" or "Reserved," you can overwrite the UDO with the XML file.

  • If the UDO is in a "Shared" status, you cannot overwrite it. But you are given the option to import it as a new UDO with a status of "Personal."

To import files:

  1. On the Orchestrator Studio Home page, click the Tools link in the upper-right corner.

  2. On the Tools page, click the Import Files icon.

  3. On Import Files, click the Choose File button.

  4. Locate the orchestration component XML files or zip file that contains the orchestration component files that you want to import.

    After selecting the files to import, the Import tool checks the XML files that you selected against the current UDOs in the Orchestrator Studio and displays the options that are available for importing the files, as shown in the example in Figure D-11.

    Figure D-11 Orchestrator Studio Import Tool

    Surrounding text describes Figure D-11 .
  5. Review the import option for each file to determine how to proceed with the import. The options are:

    • No update allowed at current status.

      The XML file name is the same as an existing component, which has a status of "Pending Approval," so it cannot be overwritten.

    • Select to add or else reserve record and re-import to update.

      A component with the same name exists in the Orchestrator Studio in a "Shared" status. Click the check box if you want to import the file as a new UDO. A new name will be generated for the new component upon import.

      If you want to overwrite the current component in the Orchestrator Studio, clear the check box. And then change the status of the current component to "Reserved" and reimport the XML file to overwrite the component.

    • File already exists.

      The XML file matches a component that is in a "Personal" or "Reserved" status. Click the check box to import it and overwrite the current component.

    • File is ready to submit.

      The XML file is unique and does not already exist in the Orchestrator Studio. Click the check box to import it.

  6. You can also click the Select All check box to import all XML files that are available for importing.

  7. Click the Submit button.

    The Orchestrator Studio imports the selected components into the components list on the respective design page.