1. Orchestrator Guide
  2. Testing an Orchestration

Testing an Orchestration

To test an orchestration:

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

    You can also open an orchestration, click the Start icon, and select Run Orchestrations.

  2. In the Run Orchestrations side panel, select an orchestration from personal orchestrations or the shared orchestrations to which you have access.

    The Run Orchestrations page displays a sample request and a response for the selected orchestration in the Input and Output sections.

    The Run Orchestrations page displays the inputs or the name-value pairs, which should be defined in the orchestration as the expected inputs to the orchestration. If the inputs do not appear, return to the corresponding orchestration design page and define the inputs for the orchestration before continuing. An input displayed in italics indicates that it is a required input.

    Starting with Tools Release 9.2.6.2, you can use the Array Inputs icon to define inputs for an array. Click the Load Defaults icon to populate the default values of the array. You can enable the Raw option to edit the values in the JSON format.

    All orchestrations that are created in Orchestrator Studio 9.2.4 or later are saved as version 3 orchestrations. You cannot change this value. If you want to update a version 3 orchestration that was created in a previous version of the Orchestrator Studio, see Updating to Version 3 Orchestrations.

  3. In the Input section, in the Content-Type down-drop list, select one for the following to display the input request in either JSON or XML format:

    • application/json

    • application/xml

  4. In the Output section, in the Accept down-drop list, select one for the following to display the output response in either JSON or XML format:

    • application/json

    • application/xml

    • application/octet-stream (Release 9.2.6)

      (Release 9.2.8.3) The system displays the default value as application/octet-stream in the Accept Type drop-down list when the orchestration is configured to return a file.

  5. Select the Send Blank Values check box to send inputs with blank values to the orchestration.

    By default, the Send Blank Values check box in deselected. Therefore, only the inputs for which you have entered the values are passed on to the orchestration and the default values are not be applied to the orchestration.

  6. In the Value column, enter a value for each input.

    These are the values that the orchestration will pass to EnterpriseOne.

  7. If needed, you can click the Add icon (+) to add and define additional inputs.

    For an orchestration that contains an array input, the Name column displays the input as array name[index].array input. This enables you to identify the input as an array. To add multiple array inputs to the same orchestration, add multiple rows to the input grid, copy the array input, paste the array input in the Name column for the multiple rows, and update the index number.

    You can click the Clear button to restore the inputs to its original state and undo any changes that you made in the input area.

  8. Click Run to test the orchestration.

    Depending on the Content-Type and Accept drop-down menu selection, the Run Orchestrations page displays the orchestration input and response in the Input and Output sections, respectively, in JSON or XML format.

    If the test is successful, a green check mark is displayed next to the Output section. If desired, you can access EnterpriseOne and confirm that the transaction was completed by the orchestration.

    If the test is unsuccessful, an "x" symbol is displayed and the Output area displays the error response in the format that you have selected. If the orchestration fails, modify the orchestration and test it again.

    You can use the Refresh Cache button on the Run Orchestrations page to access the components (such as service requests, orchestrations, and so on) that are created outside of your current session. To access the objects that were shared while the session was open, you have to close the session and sign in again.

    Starting with Tools release 9.2.4.3, you can click the New Window button to launch the Run Orchestrations page in a new window. This functionality enables you to switch between the orchestration design page and the Run Orchestrations page. Therefore, you can make changes to the orchestration on the design page while retaining the values that you have entered for the inputs on the Run Orchestration page. Only a single Run Orchestrations child window is launched at any time.

    Starting with Tools release 9.2.4.4, you can override the queues while testing the orchestrations. Select the values in the Job Queue and the Job Queue Scope drop-down menus as required and click Run to test the orchestration with the new values.

    To navigate back to the design page of the parent orchestration, click the Back button on the menu bar of the Run Orchestrations child window.

  9. To test another orchestration or start over, click the Clear button to reset, which clears all the values in the form.

To use JSON input for the orchestration test:

  1. In the Input section, select application/json from the Content -Type drop-down list.

  2. In the Output section, select application/json from the Accept drop-down list.

  3. Click the Raw button.

  4. Enter the input in JSON format directly in the input grid.

    You can click the Raw button again to enter the inputs in the Name-Value input grid.

    The views between the JSON format and Name-Value grid are in sync. The input you enter in the JSON format reflects in the input area in the Name-Value grid or vice versa. If you delete any of the inputs in the JSON format, the deleted inputs are not visible in the Name-Value grid

  5. Click the Format button to verify that the syntax of the JSON is correct.

    If the JSON input is not formatted correctly, the system displays an error message about the JSON.

  6. Click Run to test the orchestration.

    The Input and Output sections display the input and response, respectively, in the JSON format.

To use XML input for the orchestration test:

  1. In the Input section, select application/xml from the Content -Type drop-down list.

  2. In the Output section, select application/xml from the Accept drop-down list.

  3. Click the Raw button.

  4. Enter the input in XML format directly in the input grid.

    You can click the Raw button again to enter the inputs in the Name-Value input grid. The input you enter in the XML format is in sync with input entered in the Name-Value pair or vice versa. Similarly, if you delete any of the inputs in the XML format, the deleted inputs are not visible in the Name-Value grid.

  5. Click the Format button to verify that the syntax of the XML input is correct.

    If not formatted correctly, a dialog box displays an error message.

  6. Click Run to test the orchestration.

    The Input and Output section displays the input and response, respectively, in the XML format.