Adding columns or data fields – API Extension
In Panel Settings, the configuration type API Extension will extend a report results list, a report export, or a Trace Object Description section with more columns or data fields.
- When a new configuration of this type is added, the result of an M3 API call will be appended to the end of each row in the report result list, the report export file or at the end of the Trace Object Description section. Like other columns or fields, it can be moved to any position in the report, or report results columns list, or on the Trace Object Description section.
- The process of creating an API Extension starts by adding a new configuration in Panel Settings. The Add new configuration-wizard then continues in API Interface Configuration panel. Finally, the new configuration is saved and editable in Panel Settings.
- When a report, a report export file, or a Trace Object Description section is executed in a trace object context, it will expand and include the individual columns or fields, as selected in the API Output configuration.
Limitation of executed API calls
Reports result lists and report export files can be very large. Adding columns based on API calls will potentially create performance issues. To prevent this, the API Extension configuration is defaulted to execute a maximum of 5000 API calls when running a report or creating a report export file. The GLT administrator can change the Max limit value between 1-9999 API calls using the .M3REPORT:MAX_TOTAL_API_EXTEND_CALLS application setting.
To determine whether some or all of the API Extensions can be run, we multiply the actual number of rows on the report, or on the report export file, by the number of API Extensions.
Max limit value = (total number of report rows) x (number of API Extension calls).
When running a report or creating a report export file, the Max limit value is calculated and compared to the value set in Application Setting .M3REPORT:MAX_TOTAL_API_EXTEND_CALLS. If the calculated Max limit value exceeds the application setting value, M3 Graphical Lot Tracker will not execute all API Extension calls, and thus not display all expected data.
If API Extension calls cannot be executed, the column cells will have the double question mark value () to denote the issue with exceeding the upper limit for number of API calls.
When hovering over the column header, a Tooltip shows the message, "Maximum limit exceeded".
On a Report Export file, the sign will also appear in the spreadsheet cells for the column.
Max limit value - examples
Example 1: Default max limit (5000) is used.
If total number of rows in a report result list is 1000 and there are 3 API Extension calls created, the product becomes 1000 x 3 = 3000. The calculated Max limit value would be below the application setting Max limit value of 5000 executed API calls. When running the report of this example, M3 Graphical Lot Tracker would execute all three API Extension calls.
Example 2: Max limit is set to 2000.
If total number of rows in a report result list is 1000 and there are 3 API Extension calls created, the product becomes 1000 x 3 = 3000. This would exceed the max limit of 2000 executed API calls. When running the report of this example, to prevent performance issues, M3 Graphical Lot Tracker would only execute the first two API Extension calls.
In this example, the cells of the columns belonging to the third API Extension call, will have the double question mark value () to denote the issue with exceeding the new upper limit for number of API calls.
When hovering over the column header, a Tooltip shows the message, ''Maximum limit exceeded''.
On a Report Export file, the sign will also appear in the spreadsheet cells for the column.