http://docs.optrix.com.au/ Wed, 27 May 2026 01:28:00 +0000 FeedCreator 1.8 http://docs.optrix.com.au/_media/wiki:dokuwiki.svg http://docs.optrix.com.au/ http://docs.optrix.com.au/functions:admin 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 anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 http://docs.optrix.com.au/functions:api-style_ui API-Style View The page below is an example of the API-style documentation for ARDI API functions. This shows the functions, parameters and usage examples that can help guide people using the API functions. [400] Testing To test the API function(s), go to the 'Testing' section - you'll be taken to the anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 http://docs.optrix.com.au/functions:ardi-style_ui API Function Testing You can test API functions directly from the ARDI web interface. [300] The controls allow you to enter values for each of the function parameters. If available, the Load Current Values button will load live values from ARDI to fill in applicable parameters. anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 http://docs.optrix.com.au/functions:bulk_calculation_functions Bulk Calculations in Python Models By default, Python Models have a single 'calculation' function that is run on every 'sample' of data. However, ML models in particular work much better working on bulk data. For this reason, the framework also includes the option of using a anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 http://docs.optrix.com.au/functions:creating_a_custom_function Creating Custom Functions Custom functions are created using the same framework as our Report and Infographic addons. Each custom function is placed in its own folder, along with configuration files and any other files that are required for the function to execute. anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 http://docs.optrix.com.au/functions:formatting_scripts Formatting Scripts Formatting Scripts are completely optional, and are used to inject code either before your API request is processed or after the results are returned based on the format of output requested by the user. Pre-execution formatting scripts usually set up the request to include extra parameters that control the style of the output (for example, adding a 'format' parameter to the request). anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 http://docs.optrix.com.au/functions:python Python (Method) The python method is a function method that launches a Python script in response to an API request and returns any information that the script writes to the console. Additional Info.json Parameters This method requires a path parameter - this is the path to the Python script. This path can include anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 http://docs.optrix.com.au/functions:pythonmodel Python Model (Method) The python model method is a function method that launches a Python script with a calling convention specifically designed to run calculations or machine learning models as an API. Additional Info.json Parameters This method requires a path anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 http://docs.optrix.com.au/functions:redirect Redirect (Method) The redirect method is a function method that is used to re-direct the user to another, existing API function. Unlike the URL method, it suggests that people should use the original API point, rather than acting as a go-between. It's generally used when documenting existing anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 http://docs.optrix.com.au/functions:style Function Methods There are several different methods used to turn a user request into output data. The most basic are the Python (used to call a Python function and return its output) and the Redirect (used to call an existing API method elsewhere) methods. The lowercase method name is used in the 'method' property of your anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 http://docs.optrix.com.au/functions:substitutions Substitutions You can use substitutions to use variable values (such as information about the server, folders, or parameters to the API function) in your settings. To substitute, place the name of a variable between square brackets. For example, '[ROOT]' becomes the name of the folder where your function keeps its data files. anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 http://docs.optrix.com.au/functions:url URL (Method) The url method is a function method that is used to act as a 'proxy' for another API. Unlike the Redirect method, this endpoint hides the URL of the eventual destination. It's generally used when there is something blocking network traffic between the end user and an existing anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 http://docs.optrix.com.au/functions:user Function List The Function List addon provides a list of API functions available from ARDI, it's addons, and custom API points you can offer via the ARDI system. Currently, you access the addon through a web link - there's no UI control to access it. anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 http://docs.optrix.com.au/functions:welcome Functions Addon The Function List addon gives users access to a range of API functions, including custom APIs that provide a range of functionality. This ranges from simple business logic, to the ability to run machine learning models on-demand. These functions are intended for anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000