Function List Administration

The Function List addon is used to publish API functions.

There are three places these API functions come from…

  • Built-in ARDI functions,
  • ARDI addons, and
  • Custom API endpoints

Built-In and Addon Functions

These functions are loaded dynamically by the ARDI system and don't need any configuration by the system administrator.

As an example, the reporting addon publishes several functions that allow you to list and access the various reports it offers.

Custom Functions

Custom functions can be created by ARDI administrators.

There are several types of custom function, but one of the most common is a Python-powered function. These allow you to execute custom Python scripts and return data back to the user.

The primary use-case for these functions is to capture or begin some specific business logic - for example,

  • Capturing phases, batches or session times,
  • Synchronising manual and automated measurements,
  • Execute machine learning models,
  • Triggering back-end events and responses, etc.

Creating

For more details, see Creating a Custom Function.