Setting up an API Extension adding data fields to a Trace Object Description section

  1. Select System Administration > Panel Settings.
  2. Click the Plus sign in front of Trace Object Description to expand the list.
  3. Click Edit to select Trace Object Description section, for example Customer.
  4. Click the Add new configuration button.
  5. Select API Extension in Type for an API Extension adding fields in the Trace Object Description section.
  6. Click Next to continue or Cancel to close the dialog box.
    Note: When you click Next, you go to the API Interface Configuration details panel.

    Step field contains the feature object name of the Panel Settings tab, and it is not editable.

    Use as input field contains the Step type and the feature object name of the Panel Settings tab, and it is not editable.

  7. In the API program field, specify the name of the API program, for example: OIS100MI-Customer order interface.
  8. In the Transaction field, specify the name of the Transaction, for example: GetOrderHead-Retrieve customer order head information.
    Note: Only the Get-transactions are available.

    If more than one record is returned by the API, the API Extension call will only use the first record.

  9. In the Name field, specify the name of the API Extension.
  10. On the API Input Configuration tab, specify the name(s) of the GLT Field(s).
  11. On the API Output Configuration tab, select the fields to be included on the Trace Object Description section.
  12. Click Save.
  13. Rearrange API Extension fields.
  14. Click Save.

    The selected fields on the API Output Configuration tab are available as data fields on the Trace Object Description section.

    Note: All fields included in the Trace Object Description section can be rearranged in Panel Settings.

    New API Extensions can be edited in Panel Settings.

    The API Extension name is added to the System Administration > Application Localization list for the user to translate to the other languages.

    When you select the Panel Settings > Reset to Default, you can exclude API Extension from being deleted.