Before You Begin

The Orchestrator Assertion Framework is a means to test the output generated by your orchestrations. In this way, Orchestrator can act as a framework to test your EnterpriseOne applications. Not only can you verify that an application ran without generating errors, but you can also verify that the application created the output values that you expect.  “Assertion” is the name we give to test a value that an orchestration produces against an expected value. An assertion is simply an operator (equal, greater than, less than or equal to, and so on.) and optional test values. If the value generated during execution passes the assertion, the test is successful. You can define assertions on any data returned from any step of an orchestration in addition to orchestration inputs and variables. Note that the execution of the orchestration and the testing against assertions are two distinct outcomes. It is possible that an orchestration completes successfully (that is, with a “200” HTTP response), but the assertion still fails because the orchestration did not produce one or more asserted values.

This 30-minute tutorial shows you how to build an orchestration and use it to validate the sales order.

In this tutorial:

1. You will use Process Recorder to capture the process of entering a sales order and returning certain data that you want to validate along with the expected values.
2. Using the generated form request, you will create an orchestration and add the assertion test values captured during the recording.
3. You will add additional assertions to test other data returned.
4. Finally, you will learn how to use variables for the test values instead of the values included in the orchestration. During the process, you will execute the orchestration and view the assertion results.

Creating an Orchestration to Test the Data Generated During Sales Order Creation

You want to build an orchestration used to validate a sales order and that the sales order generates the expected output, for example, the order total and volume discounts.

Note: This task relies on EnterpriseOne demo data. You can use other data available in your system to enter a sales order to perform this task.

You should have access to the Process Recorder through the user-defined object feature security and action security.

Recording the Sales Order Creation Process and Capturing Assertions for Test Values

1. Sign in to the EnterpriseOne web client.
   You can access the EnterpriseOne web client from the Orchestrator Studio home page or the Tools drop-down menu on any of the pages.
2. On the EnterpriseOne page, click the drop-down menu next to your user name and select Record a Process.
   
3. In Process Recorder, click the Start button.
4. Access the Sales Order Entry (P42101) application using Fast Path or open the application from the Navigator menu.
5. Click Add.
6. Complete these header fields:
   • Sold To = 4243
   • Branch/Plant = 30
7. Enter the following lines and enter these values:
   • Line 1
     • Quantity Ordered = 1
     • Item Number = 21001
   • Line 2
     • Quantity Ordered = 250
     • Item Number = 21001
     Note: Using two different quantities should result in a different unit price for each line that helps in the validation of advanced pricing.
8. Navigate to the Order Summary tab in the order header.
9. Click Return Values in the Process Recorder window.
10. Enable the Capture Assertions switch to capture the data in each field.
11. Click Order Total, Tax, and INVOICE TOTAL in the Order Summary tab.
12. Click the column headers for Quantity Ordered, Item Number, Unit Price, and Extended Price in the Sales Order Detail grid.
13. Click Resume in the Process Recorder window.
14. Click Cancel to cancel the order and click Yes in the confirm cancel window (it is not necessary to save the order for these validations).
15. Click Stop in the Process Recorder window and enter a name:
    • Name = Assert SO Entry
16. Click Save.

Creating an Orchestration from the Form request and Testing the Assertions Values

1. Login to Orchestrator Studio.
2. Click Orchestrations.
3. Click New.
4. Enter Assert SO Entry in the Name field.
5. Click the plus icon in the diagram to add a step.
6. Click Form Request.
7. Search and select Assert SO Entry.
8. Click the Transformations icon.



9. In the Transformations window, click the Add Inputs to Orchestration icon to add all the inputs of the form request to the orchestration.
10. Click the Auto Map button on the top-left corner to map the transformations.
11. Delete the P42101_Version mapping from the Available Values drop-down menu so that the default version can be used.
12. Click Save.
13. Click outside the Transformations window to close it.
14. Click the Start icon of the orchestration and then click the Inputs and Values icon.



15. Click the X icon in the P42101_Version row to delete the row from the inputs.
16. Click Save.
17. Click the End node and click Outputs and Assertions to edit the outputs.
18. Enable the Select All toggle in the Define Outputs tab to select all the available output.
19. Click Save.
20. Click the Define Assertions tab.
21. Click the Load Assertions from step icon in the Assert SO Entry step.



Note: The assertion values that you captured in Process Recorder are loaded into the Test Value column. The three values from the sales order header are displayed in the fields. The four values from the sales order detail are represented by the number 1, indicating that values for 1 row of data are loaded.
You will learn how to test for values in multiple rows in the next task.

Important Concept: Although you captured the assertion values while using Process Recorder, and those values are currently stored in the Assert SO Entry form request, the values on this Define Assertions page are the values that Orchestrator will actually evaluate against. By clicking Load Assertions from Step icon you copied the assertions that are stored in the form request and loaded them into this page. You can manually add or edit values on this page instead of loading them from a service request.

22. Click Save.
23. Double-click the Start icon.
24. On the Run Orchestrations window, click the Raw button to choose the raw option for input.
25. Enter the following input to create the same order entered during the recording:

{
 "Long_Address_Number_Sold_To": "4243",
 "HdrBusinessUnit": "30",
 "GridData_188_20": [
  {
   "Item_Number": "21001",
   "Quantity_Ordered": "1"
  },
  {
   "Item_Number": "21001",
   "Quantity_Ordered": "250"
  }
 ]
}
26. Enable the Evaluate Assertions toggle and click Run to execute the orchestration.
27. Verify that you can see 7 out of 7 passed message and then expand the Assert SO Entry step to review the seven tests.



28. Click Save Assertions to export the assertion results to a local file. This file is useful as a record of the results of the assertion test.
29. Close the Run Orchestrations window.

Adding Assertions for a Second Detail Row

In the previous exercise you used Process Recorder to capture assertion values for header fields and one detail row of a sales order. Then you ran the orchestration to evaluate the results against those values. In this exercise you will manually add assertions for a second detail row. You will intentionally add incorrect values to see how an assertion fails and then change the values so that the assertion succeeds.


1. Click the End node and click Outputs and Assertions to edit the outputs.
2. Click the Define Assertions tab to add assertions for the second row of the grid.
3. Click the Define Row Assertions icon to add additional assertions for Quantity Ordered.



4. Click Add to add another row for assertion, select the Operator value as = and enter 250 in the Test Value field.



5. Click anywhere outside the window and click Save.
6. Verify that the assertion count for Quantity Ordered is updated to 2.
7. Disable the Select toggle of Item Number to exclude that assertion from being processed.
8. Similar to step 4, add additional assertions for Unit Price and Extended Price, set the Operator to = and enter a Test Value as 1 for each to ensure they fail.
9. Save the orchestration.
10. Click the Start icon and click Run Orchestrations.
11. Enable the Evaluate Assertions toggle.
12. Click the Raw button and enter the following input to create the same order entered during the recording:

{
 "Long_Address_Number_Sold_To": "4243",
 "HdrBusinessUnit": "30",
 "GridData_188_20": [
  {
   "Item_Number": "21001",
   "Quantity_Ordered": "1"
  },
  {
   "Item_Number": "21001",
   "Quantity_Ordered": "250"
  }
 ]
}
    
    
13. Click Run.
You should see 7 out of 9 passed and the step expanded showing the failure message of the assertions for Unit Price and Extended Price that were added in Row 2.



14. Note the values displayed in the Unit Price and Extended Price fields in Row 2.
15. To test your knowledge, update the orchestration assertions for Unit Price and Extended Price to match the actual values and save. Again test the orchestration and verify that all the nine tests are passed.

Using Values from CSV to Test the Orchestration

In this exercise, you will add test values to a CSV file and use them in the orchestration instead of hard coded values saved in the orchestration.

Users need to update the test values of an assertion orchestration to accommodate the changes that are made to the data over time without modifying the orchestration directly.

You must have an FTP server available to your AIS server running the Orchestrator Studio and you must have a working connection to that FTP server. You must also set up a connection to that FTP server in Orchestrator Studio, which will include the address and security credentials.

If you do not have access to an FTP server on your system, you can learn how to pass assertion values dynamically into an orchestration using orchestration inputs. Skip to the exercise Passing Assertion Values as Orchestration Inputs.

Creating a One-Line CSV File with Test Data.

1. Copy the following two lines into any text editor and save the file with a .csv extension to create a CSV file with one row of test values:
   Note:
   To ensure that the text is converted into a valid CSV file, enter the descriptions in one row, followed by a new line, with all the values on the second row.
   
   Row 1 Unit Price,Row 2 Unit Price,Tax Total,Order Total,Invoice Total 798,718.2,6853.22,180348,187201.22
2. Save the file with .csv extension and copy the file to your FTP server.
3. From the Orchestrator Studio Home page, click the Connectors icon, then click New, then click FTP to create a new FTP connector step.
4. Enter Get Assert SO Entry Test Values in the Name field.
5. Select the connection to your FTP server from the FTP drop-down menu.
6. Change the first option to File.
7. Change Type to Receive.
8. Enable the Import CSV option.
9. Enable the Import First Row Only option. This option enables the system to read the first row of values into top-level variables instead of reading all rows into an array variable. An array will not work for this use case.
10. Enable the CSV Has Headers option.
11. In the Source File Name field, enter the name of the CSV file as you saved it in step 2. Modify the path extension if necessary to ensure that the path matches the location where you saved the CSV file on the FTP server in step 2.
12. Disable the Remove Source File option.
13. Click Sample File and then find and select a local copy of your CSV file to load the names of the columns.
    
    Note: Confirm that the source file name matches the name of the file copied on the FTP server.
    
    Orchestrator Studio reads your CSV file as a template of the variable names. Each column header in the CSV file becomes the name of an orchestration variable. In a later exercise you will use these orchestration variables as the assertion test values instead of the hard-coded values you used in the previous task.
14. Save the connector and click Close to return to the Orchestrator Studio Home page.

Adding the Connector to the Orchestration and Registering the Data as Variables

1. From the Orchestrator Studio Home page, open the Assert SO Entry orchestration.
2. Click Design Mode, and click the + icon.
3. To edit the Assert SO Entry orchestration created in the previous task, click Design Mode .
4. Click the + icon to the left of the Assert SO Entry step to insert a new step.
5. In the New Step Type window, click Connector.
6. Search and find the Get Assert SO Entry Test Values connector created in the previous task.
7. Click the Start node, and then click the Inputs and Values icon.
8. Click the Variables tab.
9. Enter the five variables from the CSV file. Enter each column header from CSV into the Variable Name column. 
   
   This step is necessary to map variables to assertion test values, as the Values From Steps option is not available for assertion test values
10. Click Save.
11. Click the End node and click the Outputs and Assertions icon.
12. Click the Define Assertions tab.
13. Find INVOICE TOTAL in the Order Summary section. Click in the Test Value column next to INVOICE TOTAL to see the list of available variables.
14. Choose Invoice Total from the list to use the value from the CSV file.
15. Repeat the preceding step for Tax and Order Total.



16. Find Unit Price in the Sales Order Detail section.
17. Click the list icon next to the Unit Price to open the grid row assertions.
18. Click the Test Value drop-down menu and select the row Unit Price for each row:
     
     - For Row 1 choose Row 1 Unit Price
     - For Row 2 choose Row 2 Unit Price



19. Save the orchestration and run it again using the following input you used in the previous task, with the Evaluate Assertions toggle enabled.
    {
 "Long_Address_Number_Sold_To": "4243",
 "HdrBusinessUnit": "30",
 "GridData_188_20": [
  {
   "Item_Number": "21001",
   "Quantity_Ordered": "1"
  },
  {
   "Item_Number": "21001",
   "Quantity_Ordered": "250"
  }
 ]
}
20. Validate that the assertions have passed.
21. To test your knowledge, modify the values in the CSV file that you copied on the FTP server and then run the orchestration again. Verify that the new test values entered in the CSV are used while evaluating the assertions.
    
    You should expect the assertions to fail any time the values in the CSV file do not match the values that the orchestration is actually producing.

Passing Assertion Values as Orchestration Inputs

In this exercise, you will create orchestration inputs for five of the assertion values instead of hard-coded values saved in the orchestration.

Scenario

Users need to update the test values of an assertion orchestration to accommodate the changes that are made to the data over time without modifying the orchestration directly. In this scenario, the assertion values are defined as orchestration inputs and are passed into the orchestration along with the other inputs.

Prerequisites

None.

Defining Orchestration Inputs for the Assertion Values

1. From the Orchestrator Studio Home page, open the Assert SO Entry orchestration.
2. Click the Start node, and then click the Inputs and Values icon.
3. On the Orchestration Inputs tab, add the following 5 inputs. Leave the Value Type as String.
   
   
   • Row 1 Unit Price
   • Row 2 Unit Price
   • Tax Total
   • Order Total
   • Invoice Total
4. Click Save.
5. Click the End node and click the Outputs and Assertions icon.
6. Click the Define Assertions tab.
7. Find INVOICE TOTAL in the Order Summary section. Click in the Test Value column next to INVOICE TOTAL to see the list of available orchestration inputs.
8. Choose Invoice Total from the list to use the value from the CSV file.
9. Repeat the preceding step for Tax and Order Total.



10. Find Unit Price in the Sales Order Detail section.
11. Click the Define Row Assertions icon next to the Unit Price to open the grid row assertions.
12. Click the Test Value drop-down menu and select the row Unit Price for each row.
    • For Row 1 choose Row 1 Unit Price
    • For Row 2 choose Row 2 Unit Price

    

13. Save the orchestration.
14. Run the orchestration again with the Evaluate Assertions toggle enabled. Use the following input.
    
    Note that the input is the same as what you used in the previous exercise, except that you need to add the 5 inputs for the 5 assertion values at the bottom.
    
    {
  "Long_Address_Number_Sold_To": "4243",
  "HdrBusinessUnit": "30",
  "GridData_188_20": [
    {
      "Item_Number": "21001",
      "Quantity_Ordered": "1"
    },
    {
      "Item_Number": "21001",
      "Quantity_Ordered": "250"
    }
  ],
"Row 1 Unit Price": "798",
"Row 2 Unit Price": "718.2",
"Tax Total": "6853.22",
"Order Total": "180348",
"Invoice Total": "187201.22"
}

15. Validate that the assertions have passed.
16. To test your knowledge, modify the values in the orchestration inputs for the 5 assertion values, then run the orchestration again. You should expect the assertions to fail any time the values in the orchestration inputs do not match the values that the orchestration is actually producing.