https://docs.optrix.com.au/ Wed, 27 May 2026 01:24:17 +0000 FeedCreator 1.8 https://docs.optrix.com.au/_media/wiki:dokuwiki.svg https://docs.optrix.com.au/ https://docs.optrix.com.au/ardiextra:addons Addons This section contains documentation for individual ARDI addons. Agency AI Framework ARDI Query Language Calibrator Checklist Grafana Data Injection Infographics Network Diagrams OData Protocol Remote Control Report List Scheduled SAML Selector Single Vision SQL Utiliser General Topics ARDI User Content Framework anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 https://docs.optrix.com.au/ardiextra:amqp AMQP Driver Information Loads information from AMQP services such as RabbitMQ. Driver InfoDetailDriver Type:LivePlatforms:All Driver Settings OptionDescriptionServer NameThe IP address or host-name of the AMQP serverPortThe port to connect toTopicThe AMQP topic to monitor (can include wildcards) anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 https://docs.optrix.com.au/ardiextra:ardi_user_content_framework ARDI User Content Framework The User Content Framework (or UCF) is a common pattern found in a number of ARDI addons, including our Reporting, Infographics and Function addons. It's a very basic method of providing custom content in an ARDI addon. anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 https://docs.optrix.com.au/ardiextra:awslora LoRA on AWS Driver Information Loads live information from MQTT and LoRA devices via Amazon Web Services IoT Core. This driver has specific extensions to handle LoRA payload decoding and disconnected-device detection. Driver InfoDetailDriver Type: anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 https://docs.optrix.com.au/ardiextra:bad BAD Data Driver Information Sets all channels as 'bad' to simulate the behaviour of ARDI in a major data source failure. Driver InfoDetailDriver Type:Live OnlyPlatforms:All Settings This driver does not require any settings. All data bound to this driver simply returns a 'Bad Data' signal. anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 https://docs.optrix.com.au/ardiextra:calc Calculation Driver Information This allows you to perform simple calculations on ARDI data. Driver InfoDetailDriver Type:Live and HistoricalPlatforms:All Driver Settings This driver doesn't require any configuration. Point Settings The only setting the point needs is the calculation you'd like to perform. anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 https://docs.optrix.com.au/ardiextra:canary Canary Driver Information The Canary driver allows you to connect to Canary time-series databases to retrieve historical data. Driver InfoDetailDriver Type:History OnlyPlatforms:All Driver Settings OptionDescriptionHostThe IP address or name of the Canary system anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 https://docs.optrix.com.au/ardiextra:checklist Checklist Driver Information This driver allows you to use live data and history that have been entered by people in the field using the Checklist and Checkmate ARDI addons. Driver InfoDetailDriver Type:Live and HistoricalPlatforms:All Overview When creating a checklist, you can create steps that ask users for data. These are recorded when the checklist is completed, allowing you to read that information back into your ARDI server. anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 https://docs.optrix.com.au/ardiextra:citect Citect Driver Information Loads live data from Citect via the CtAPI, and historical information from Citect Historian. Driver InfoDetailDriver Type:Live and HistoryPlatforms:Windows Only Performance Warning While live performance using this driver is excellent, accessing the SQL-server based Citect Historian is relatively slow. Modern systems are moving to the faster-performing anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 https://docs.optrix.com.au/ardiextra:clock Clock Driver Information Brings simple time-based information into ARDI, such as the hour, day-of-the-week, season etc. Driver InfoDetailDriver Type:Live and HistoricalPlatforms:All Driver Settings This driver has two options. OptionDescriptionHemisphere anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 https://docs.optrix.com.au/ardiextra:controllogix ControlLogix PLC Driver Information Loads information directly from ControlLogix PLCs using the Ethernet/IP protocol. Note that this is not a generic Ethernet/IP driver - it requires extensions to the standard that are currently specific to Allen Bradley ControlLogix devices. anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 https://docs.optrix.com.au/ardiextra:driver_list Driver List Testing / Debugging Drivers Bad Data Driver Random Driver Sine-Wave Driver Text Cycle Driver Basic Data Sources Clock Driver Text File Driver Microsoft Excel Driver Webhook Driver SCADA/Protocol Drivers Citect Driver OPC-DA Driver OPC-UA Driver Historian/Time-Series DB Drivers Aspentech IP21 Canary Driver Wonderware eDNA Driver IBA Driver Influx DB Driver PI Asset Framework Driver Prometheus Driver Relational Database Drivers MySQL / Mari… anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 https://docs.optrix.com.au/ardiextra:driver Driver Driver Information Returns information about the status of your ARDI drivers. This is an introspective driver (a driver that looks back at the status of your ARDI system), and is usually used if you'd like to raise alarms or send alerts if connections to your data sources fail. anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 https://docs.optrix.com.au/ardiextra:drivers Driver Documentation This section discusses the various ARDI drivers available and how to configure them. Most drivers are fairly self-explainatory, but certain drivers for generic data management systems (such as SQL databases) can have some additional options that need explaination. anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 https://docs.optrix.com.au/ardiextra:edna OSI Pi Driver Note that AB FactoryTalk uses a re-badged version of OSI Pi as its historian - this is the correct driver to use for FactoryTalk applications Information Loads both live and historical point-data from the Wonderware eDNA historian. Driver Info anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 https://docs.optrix.com.au/ardiextra:excel Excel File Data Driver Information Loads data directly from an open Excel spreadsheet to allow easy simulation of data. Driver InfoDetailDriver Type:Live OnlyPlatforms:Windows Only Driver Settings This driver has a single option. OptionDescription anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 https://docs.optrix.com.au/ardiextra:googleps Google PubSub Driver Information Loads information from Google PubSub. Driver InfoDetailDriver Type:LivePlatforms:All Driver Settings OptionDescriptionProjectThe name of the PubSub ProjectTopicThe topic to monitor (can include wildcards)Subscription anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 https://docs.optrix.com.au/ardiextra:grafana Grafana Annotation Events Information Turns any annotations made in Grafana into Events in ARDI. Driver InfoDetailDriver Type:EventPlatforms:All Driver Settings OptionDescriptionGrafana ServerThe IP or DNS address of your Grafana server, including the port number anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 https://docs.optrix.com.au/ardiextra:iba IBA Driver Information The iba driver allows you to connect to iba HDServer systems to retrieve historical data. We usually suggest using OPC-UA to connect to live data, as this provides the best performance while also having the smallest impact on your server. anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 https://docs.optrix.com.au/ardiextra:icalendar iCalendar Events Information Reads entries from an iCalendar file as ARDI events. iCalendar files (which usually have the file extension ICS) are a common format of file used to share and distribute calendar events. Driver InfoDetailDriver Type:Event anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 https://docs.optrix.com.au/ardiextra:influxdb InfluxDB Driver Information Loads information from InfluxDB databases. Driver InfoDetailDriver Type:HistoricalPlatforms:All Performance Note Although InfluxDB has an extremely impressive ingestion rate (meaning it can record very large numbers of properties quickly), it has a critical flaw when being used for industrial data - it can't show instantaneous values. anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 https://docs.optrix.com.au/ardiextra:ip21 IP21 Driver Information The IP21 driver allows you to connect to Aspentech IP21 systems to retrieve historical data. We usually suggest using OPC-UA to connect to live data, as this provides the best performance while also having the smallest impact on your server. anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 https://docs.optrix.com.au/ardiextra:json_path JSON Paths Some drivers need to find information in JSON objects. You can use JSON paths to tell ARDI how to find data in JSON payloads. anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 https://docs.optrix.com.au/ardiextra:logfile Log File Events Information Turns log files into source of ARDI events. Driver InfoDetailDriver Type:EventPlatforms:All Driver Settings OptionDescriptionLog FileThe full path to the log file. Must be accessible from the ARDI serverRegexThe Python-style regular expression used to extract information from each line of the log anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 https://docs.optrix.com.au/ardiextra:memcache Memcache Driver Information Loads live information from MEMCACHED servers Driver InfoDetailDriver Type:LivePlatforms:All Driver Settings OptionDescriptionHostThe IP or DNS address of your Memcache server (include port if non-standard). Performance Note anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 https://docs.optrix.com.au/ardiextra:meteostat Meteostat Driver Information Loads live weather information from Meteostat.com Driver InfoDetailDriver Type:HistoryPlatforms:All Meteostat Meteostat offers very inexpensive access to historical weather data for locations around the world. Unfortunately, it doesn't offer live weather information - we suggest using the anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 https://docs.optrix.com.au/ardiextra:modbustcp Modbus TCP Driver Information Loads information directly from field devices or gateways using the Modbus TCP protocol Driver InfoDetailDriver Type:LivePlatforms:All Driver Settings OptionDescriptionIP AddressThe IP address or host-name of the Modbus TCP device anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 https://docs.optrix.com.au/ardiextra:mos Modular Output System Driver Information Provides live information being written to the Modular Output System. Driver InfoDetailDriver Type:LivePlatforms:All Usage The Modular Output System allows you to take the output of an script or service and make it available through a variety of mechanisms. anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 https://docs.optrix.com.au/ardiextra:moving_to_opc_ua Moving from OPC-DA to OPC-UA The OPC-DA standard was very progressive for its time, but in the modern era it has a few significant problems. This is why the OPC Foundation has replaced the old standard with OPC-UA, a more modern equivalent. There are several significant advantages of UA over DA, including anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 https://docs.optrix.com.au/ardiextra:mqtt MQTT Driver Information Loads live information from MQTT servers Driver InfoDetailDriver Type:LivePlatforms:All Driver Settings OptionDescriptionServer NameThe IP or DNS address of your MQTT serverPortThe TCP port to connect onClientThe MQTT client name anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 https://docs.optrix.com.au/ardiextra:msocalendar Office365 Calendar Events Information Reads entries from a cloud-based Office365 calendar as a list of events. Driver InfoDetailDriver Type:EventPlatforms:All Preparing You'll need to create a new Application in your Azure/Entra AD configuration, so that your ARDI system can access a users calendar. anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 https://docs.optrix.com.au/ardiextra:mssql Microsoft SQL Server Data Driver Information Loads point-data from mssql databases. The database is expected to be in a one-value-per-row format, as shown in the examples below. Driver InfoDetailDriver Type:Live and HistoryPlatforms:All Performance Notes anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 https://docs.optrix.com.au/ardiextra:mssqlev Microsoft SQL Server Events Information Reads entries from a Microsoft SQL Server database table as events. Driver InfoDetailDriver Type:EventPlatforms:All Driver Settings OptionDescriptionHostThe IP or DNS name of your MS SQL serverPortThe port number the server is running on anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 https://docs.optrix.com.au/ardiextra:mysql MySQL / MariaDB Data Driver Information Loads point-data from mysql databases. This driver is a row-based database driver. The database is expected to be in a one-value-per-row format, as shown in the examples below. Driver InfoDetailDriver Type:Live and History anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 https://docs.optrix.com.au/ardiextra:mysqlev MySQL/MariaDB Events Information Reads entries from a MySQL/MariaDB database table as events. Driver InfoDetailDriver Type:EventPlatforms:All Driver Settings OptionDescriptionHostThe IP or DNS name of your MySQL/MariaDB serverPortThe port number the server is running on anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 https://docs.optrix.com.au/ardiextra:odata ODATA Addon The ODATA addon allows you to query ARDI asset information using the ODATA protocol. This gives you a simple method of querying information, particularly in Microsoft applications such as PowerBI and Excel. OData Endpoint Once you've installed your addin, the OData endpoint will be available at anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 https://docs.optrix.com.au/ardiextra:opcda OPC-DA Driver Information OPC-DA is an older standard for communicating live industrial data between systems. Although we suggest upgrading your systems to the newer OPC-UA whever possible (this can be done using OPC-UA wrappers, leaving your existing infrastructure in place), we continue to support DA for legacy applications. anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 https://docs.optrix.com.au/ardiextra:opcua OPC-UA Driver Information OPC-UA is the replacement for the older OPC-DA standard. Driver InfoDetailDriver Type:Live OnlyPlatforms:All Driver Settings This driver has two options. OptionDescriptionAddressThe address of the OPC-UA host machine, including the port number anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 https://docs.optrix.com.au/ardiextra:pgsql PostGRESQL Data Driver Information Loads point-data from Postgres databases. The database is expected to be in a one-value-per-row format, as shown in the examples below. Driver InfoDetailDriver Type:HistoryPlatforms:All Performance Notes We suggest you anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 https://docs.optrix.com.au/ardiextra:piaf PI Asset Framework Driver Information Loads live and historical data data from PI Historian via the Asset Framework. Driver InfoDetailDriver Type:Live and HistoryPlatforms:Windows Only Driver Settings OptionDescriptionServerThe PI Asset Framework server to connect to anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 https://docs.optrix.com.au/ardiextra:prometheus Prometheus Driver Information Loads information from a Prometheus time-series historian. Note that there is also a Prometheus addon for ARDI, and a similar module for the Modular Output System, meaning that ARDI can both read and write to Prometheus servers. anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 https://docs.optrix.com.au/ardiextra:redis REDIS Driver Information Loads live information from REDIS servers Driver InfoDetailDriver Type:LivePlatforms:All Driver Settings OptionDescriptionHostsA comma-separated list of REDIS hosts. ARDIs REDIS driver uses subscriptions to be notified of changes to key points. For this reason, you should make sure that anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 https://docs.optrix.com.au/ardiextra:relational_databases Relational Databases & High Speed Data Relational databases are ideal for summary data, such as... * Daily Totals, * Shift Summaries, * KPIs, and * Events But when being used for high-speed sensor data, they very quickly start to suffer from degraded performance. They become quite slow both to read and write to, and this is for several reasons. anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 https://docs.optrix.com.au/ardiextra:rnd RANDOM Data Driver Information Randomly changes all channels to floating-point values between 0 and 100. Driver InfoDetailDriver Type:Live and HistoryPlatforms:All Settings This driver does not require any settings. Installation Windows: Available on the anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 https://docs.optrix.com.au/ardiextra:row-based Row Based vs Column Based Drivers Some data sources have the option of performing either row based or column based lookups. Row Based Drivers A row-based driver is designed for the situation where all of your information is stored in a single table, and one column contains an identifier for that information. Each row will have a minimum of anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 https://docs.optrix.com.au/ardiextra:scattered_vs_synchronised_data_sources Scattered vs Synchronised Data Sources There are two ways that dates and times tend to be stored in databases. They can be synchronised, meaning that every measurement is performed at the same effective time - for example, every point will be recorded every 10 seconds, and each point in that sample pass will have the same timestamp. anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 https://docs.optrix.com.au/ardiextra:shifty Shifty Event Driver Information Used to create events that describe your different teams and the shift structure they follow. This allows for simple crew and shift-based reporting and analytics. Driver InfoDetailDriver Type:EventPlatforms:All Driver Settings anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 https://docs.optrix.com.au/ardiextra:sin SINE-WAVE Data Driver Information The values returned from this driver ramp slowly between 0 and 100 according to a sine-wave. Note that each channel is slightly out-of-phase with the channel next to it, to ensure that you see cascades of values rather than having every property in the scene with the same value at the same time. anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 https://docs.optrix.com.au/ardiextra:snmp Simple Network Management Protocol (SNMP) Driver Information Loads information from SNMP devices on your network. This driver is usually used to capture information from network hardware and servers, but may also be useful in reading details from PLCs, converters and other network-connected equipment that support the SNMP protocol. anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 https://docs.optrix.com.au/ardiextra:sos Sensor Information Service Driver Information Loads live information from a Sensor Observation Service data store. Driver InfoDetailDriver Type:AllPlatforms:All SOS SOS services are used to deliver sensor data for geo-technical applications. They're often used to distribute environmental information about large areas, such as cities, towns, states or countries. anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 https://docs.optrix.com.au/ardiextra:text Text-File Data Driver Information Loads point-data from text files (such as CSV or Tab Delimited text files). The files must conform to the expected format, shown below in the File Format section. Driver InfoDetailDriver Type:Live and HistoryPlatforms: anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 https://docs.optrix.com.au/ardiextra:textcycle Text-Cycle Data Driver Information Loads point-data from text (such as CSV or Tab Delimited) and Excel files, and plays them over-and-over. The files must conform to the expected format, shown below in the File Format section. Driver InfoDetailDriver Type: anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 https://docs.optrix.com.au/ardiextra:weatherapi WeatherAPI Driver Information Loads live weather information from WeatherAPI.com Driver InfoDetailDriver Type:LivePlatforms:All WeatherAPI WeatherAPI.com offers very inexpensive access to live weather data for locations around the world. You'll need to sign up for a free anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 https://docs.optrix.com.au/ardiextra:webhook Webhook Driver Information Accepts data delivered from the web via REST webhooks. Driver InfoDetailDriver Type:Live OnlyPlatforms:All Driver Settings This driver has a couple of options. OptionDescriptionPort NumberThe HTTP port that requests will be sent to anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 https://docs.optrix.com.au/ardiextra:zero ZERO Data Driver Information The Zero data driver is specifically designed for situations where you want to control your I/O via addons such as the Injector Addon or Remote Addon. It allows your data to be considered dynamic, but the value from the driver will always be 'zero' and will only ever be updated on driver restart. anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000