Creating an Upper Interface

The upper form of an integration interface collects the upper form information of a business process (BP). Use the integration upper form to choose the form that verifies the required fields. Include all the required fields from the selected form.

Note:

When using query-based data elements (QBDEs), query elements round to two decimal places, even when the Base Currency and defined currency fields differ.

To create an upper integration interface

1. Go to the Company Workspace tab, and switch to Admin mode.
2. In the left Navigator, select uDesigner, and then select Business Processes.
3. Open the business process.
4. In the left Navigator, select Integration, and then select Upper.
5. Select New.
6. In the Upper Design window, complete the following steps:
   1. Enter a Name and Description for the interface.
   2. In the Validation Form field, select the upper form that you want to use to verify the required fields for the interface.

      The list shows only the action forms that were created for the BP.

      Note:

      • Images are not supported for import through CSV, Microsoft Excel, and web services. Ensure that the validation form used to create the record does not include image picker fields.
      • Required fields in a hidden block do not appear in the Import template. If hidden fields are part of the validation form, the import fails. Design the validation form carefully to prevent import errors.
   3. Select the Data Elements tab.
   4. To add a field to the interface, select Add.
   5. In the Add Data Element window, enter the following information:
      1. In the Element Label field, select the field that you want to add to the interface. The Data Element field shows the actual name of the selected DE.
      2. In the Direction field, select how the interface directs data for this field:
         • Select Input to receive data into Unifier in Excel, CSV, or XML formats to create records or line items.
         • Select Output to send data from Unifier in XML format by using Web Services.
         • Select Both to send and receive data between Unifier and an external application in XML format by using Web Services.

         Note:

         • QBDEs can be included only as read-only fields in the Upper form design. If you modify an existing BP design in Draft mode and it already includes QBDEs with Direction set to Input or Both in the Integration tab, the system displays errors during error check. To resolve these errors, set the QBDE Direction to Output in the Integration tab.
         • Unifier ignores direct QBDE value updates if the "refresh" condition is not defined or the "trigger element" is not updated through the input request.
         • When you use multiple DEs with the same field label, ensure that the applicable DEs use the same direction value, either Input, Output, or Both. Do not use the combinations of Both and Output or Input and Output.
      3. To include the DE in the template used to create BP records from CSV or Excel files, select Import.
      4. To include the DE in the template used to support the Bulk Edit and Bulk Update features to modify existing BP records from CSV or Excel files, select Update. This feature is supported only in the Unifier web application. It is not supported through REST web service calls or when updating line items in Classic Payment Application BP Records.
   6. Rearrange the DEs using either of the following actions:
      • Select Move Up and Move Down to reorder the DEs.
      • Select Update Order to change the order of the rows in the Row column.
7. Select OK.