API Interface Configuration

When enabled, the API Interface Configuration panel is visible as an option under the System Administration menu.

The API Interface Configuration enables the administrator to add and configure customized tabs to run M3 API programs for Get, List, Sel (select) or Search Transactions.

  1. The customized tab is created and based on M3 API programs, M3 API transactions fields, API Input Configuration and API Output Configuration tabs.
  2. A customized tab content and layout can be configured by ticking the check boxes in the Selected column and Reorder Rows column on the API Output Configuration tab.
  3. When a new customized tab is created and saved, the tab is displayed and searchable in the API Interface Configuration panel.
  4. When a new customized tab is created and saved, the tab is displayed on the Trace Panel. The tab is defaulted to show a maximum of 100 records. The GLT administrator can change the value between 1-9999 records using the .CONFIG:MI_TAB_RECORDS application setting.
  5. When a customized tab is added to the API Interface Configuration panel, a new application key is generated in the Application Settings panel. The generated application key is named .INTERFACE:TABS_<Step>_<Tab_Name>. In the Application Settings panel, access to the customized tab is set per user group. See Application Settings panel.
  6. When a customized tab is added to the API Interface Configuration panel, a new language key is added to the Application Localization panel. The generated key is named <Step>_<Tab_Name> and the key value is set to <Tab_Name>. By modifying the text in the key Value column, the customized tab display text can be configured. The key value is displayed as the customized tab header in the Trace Panel. See Application Localization panel.
  7. When enabled, the customized tab is displayed in the lower section of the Trace panel.
    Three pre-configured tabs are displayed in the API Interface Configuration panel. These tabs are examples based on Get and List transactions. The pre-configured tabs are read only. To make the tabs visible in the Trace panel, check the Enabled/Disabled check box in the Application Settings panel.