Configuring a Custom Business Function Service Request (Release 9.2.4.3)

To create a custom service request to call a business function.

  1. Click the Custom Requests icon on the Orchestrator Studio home page.

  2. On the Custom Requests side panel, click the New drop-down menu and select Business Function.

  3. Create and name the custom request by following the steps described in Creating a Component.

  4. On the Custom Requests design page, in the Function Object Name field, enter the name of the business function object.

  5. From the Function Name drop-down list, select a business function.

    The Orchestrator Studio loads all the fields included in the template for the selected business function into the grid.

  6. Enable the Fire and Forget toggle if you want the business function to execute without waiting for a response. If the Fire and Forget toggle is enabled, the output columns are not editable.

    (Release 9.2.4.4) The Number of Threads option is displayed when you enable the Fire and Forget toggle. This option enables you to select the number of threads for an iterated step.

  7. Use the following columns and toggle options in the grid to configure the business function service request:

    • ID, Name, and Description (informational only)

      This column displays the ID, name, and description of the field in the business function.

    • Required (informational only)

      This column indicates if the field is set as a required field.

    • Input

      Enable the Input toggle to mark the field as the input to the business function service request.

    • Input Variable

      For each field to which you want to map an orchestration input, enter a variable name in the Input Variable column. When you add this custom request to an orchestration, you map the orchestration input to this variable.

    • Default Value

      Use this column to enter a literal value as the input.

    • Return

      Enable the Return toggle for the fields that contain values that you want returned in the orchestration response.

      Note: The Return toggle is available only for the fields that allow output.
    • Output Variable

      Use this column to enter a variable name for the return value. When you add the business function custom 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.

      In each row, the Output Variable column is editable only if the Return toggle is enabled.

  8. Click the Save button.

The Orchestrator Studio saves the business function service request. You can then add this custom service request as a step in the orchestration to call a business function directly from the orchestration.