API Interface Configuration

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

The API Interface Configuration panel enables two data customization functions.

  1. The administrator can add and configure customized tabs to run M3 API programs for Get, List, Sel (select) or Search Transactions.
    Note: When an administrator creates a customized tab, a new key associated to that tab is generated in the Application Settings list. The format for it is .INTERFACE:TABS_<trace step>_<tab name> and the key is set to Enabled by default.
  2. When a customized tab is created, the administrator can add and configure a customized link to appear on the customized tab. This link is set to open additional trace details.

    The API Interface Configuration panel overview displays the names of customized tabs, and API links created within customized tabs.

    • The first column contains a drill down that opens tab or link details.
    • The second column contains locks which indicate three pre-configured tabs in M3 Graphical Lot Tracker. These pre-configured tabs are populated with M3 API data, and they serve as examples for creating customized tabs. If enabled in the Application Settings, the tabs are available in the Trace panel.
    • Step column indicates where in the trace chain, the tab or link is located (for example 'Customer').
    • Tab name column displays customized tabs, grouped per step.
    • Link name column displays customized API links, grouped per tab.
    • Transaction column displays M3 API program and transaction.
    These are the options available in the upper right part of the panel:
    • The Search icon opens the overview if positioned on the details page.
    • The Add new configuration icon is used when adding a new customized tab
    • The Add link field icon is used when adding a new customized link.
    • The Delete icon is used when deleting tab or link on the details page.
    • The Refresh icon is used to refresh the overview page.

    • The Save icon is used when saving customized tab or link.