Configuring Form Request Actions

The Available Actions area is where you specify the EnterpriseOne fields and controls that are used to perform the desired business transaction in EnterpriseOne.

Use the following features to configure the actions in the form request. After configuring each action, click the Add Action button at the end of each row to add the action to the Order of Execution area.

• Description (informational only)

  This column displays the controls and the fields for each form in a collapsible or expandable parent that is 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 available columns in a grid.

• ID (informational only)

  This column displays the ID of the control or the field in EnterpriseOne.

• Return

  Enable Return for 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. Return values may be used by customized third-party gateway programs or devices to perform further processing based on the values that are returned from EnterpriseOne applications.

  When you select a value to be returned, a Return Form Data action is added to the order of execution. Ensure that this action follows the steps that are needed to populate the returned fields in the form, and make sure that this action occurs before an action that clears the data or moves to another page.

  Only one Return action is allowed per form when configuring a form request in the Orchestrator Studio. If you need the orchestration to return more than one value at different times on the same form, add the same form twice to the form request, configuring the additional return values in the second form. In this scenario, it is recommended to use the Process Recorder, where you can select multiple values to return from any form in the process.

  Starting with Release 9.2.5, you can enable the Return toggle for the Include Count field in Form request to include the row count as a variable. You can also enable the Return toggle for the Include Count field to count the number of records in the grid.

  Starting with Tools Release 9.2.8.2, you can reorder the outputs of a form request by clicking the Edit Returns icon on the Return Form Data action and by dragging and dropping the rows. The system preserves the order that you set when you Save the changes and reflects this order in Orchestration Outputs when the Form Request is added to an orchestration. This feature improves readability and enables orchestrations to easily integrate with user interfaces or third-party systems that might be sensitive to the order of outputs.

  Note: Order of name-value pairs in JSON is not important or guaranteed but in most cases, the orchestration output reflects the order set at design time. If you use Output Array to File to create a CSV, XML, or JSON file, the system reflects the order of grid data specified at design time.

• Variable

  In each row, the Variable column is editable only if Return is enabled. Use this column to enter a variable name for the return value. When you add the form request to an orchestration, the variable name appears in the orchestration inputs grid. As a result, the returned value is available for mapping to the subsequent steps in the orchestration.

  You can also use this field to retrieve a data set from an application grid. See Retrieving and Passing Data Sets in an Orchestration for more information.

• Select All Rows (row)

  Add this action to select all rows in a grid. Use this action if the form has a button to perform an action on all the selected grid grows. For example, if you want to update the PO status for all rows in a grid, add this action to the Order of Execution area and then configure the next action to update the PO status.

• Select Row (row)

  Add this action if the form requires selecting a row in a grid to perform a particular action.

  In the Order of Execution table, you can enter a variable in the Input column of this row. This action enables you to map an orchestration input to this variable. Alternatively, you can enter a value in the Default Value column to select a specific row. To select the first row in the grid, add Select Row and leave these columns blank or set the Default Value to 1 when adding this action to the Order of Execution.

  (Release 9.2.5.2) You can enter a comma delimited list of row numbers such as 1,2,4 as value for Select Row. In the previous releases it was possible to pass a single row number only. You can enter the row numbers as a Default Value or pass them into the Form Request through the variable defined for the Select Row action.

  If the grid has columns that do not have a QBE, you will see the Filter check box in the Description column when you add a Select Row action or add a Row Number for Update action.

  If you select this check box, a Filter button appears in the Input column in place of the variable name and the Default Value field is cleared and disabled.

  When you click the Filter button, a popup window is displayed showing all the columns in the grid that do not have a QBE.

  Note: To filter columns with a QBE, continue to use the SetQBEValue action.

  You can then enter the filter criteria on one or more columns to find the rows you want to select or to update.

  This enhancement eliminates the need to use custom logic to update rows in a grid with no QBE.

  For example, if you are on a previous release, to update all the sales order lines on an order that are at a certain status, you have to fetch and return the sales order lines as a step. You then have to pass the. output variable from that step to a custom step that will parse the .output response and apply filters through custom looping logic to find the rows that have to be updated and build an array. Finally, you have to run Sales Order Entry using the array to update the appropriate rows.

  As of Tools Release 9.2.5.2, all these steps can be completed using the Filter option in the description column.

• Row Number for Update (row)

  If the task requires updating a particular row in an editable grid, then map the appropriate input value that contains the row number to the Row Number for Update row, or specify the row number in the Default Value column.

  (Release 9.2.5.2) The Filter option as described in the Select Row section is available for columns from the grid that do not have a QBE.

  Do not use this action if the transaction involves adding rows to a grid.