https://docs.optrix.com.au/ Wed, 27 May 2026 01:25:46 +0000 FeedCreator 1.8 https://docs.optrix.com.au/_media/wiki:dokuwiki.svg https://docs.optrix.com.au/ https://docs.optrix.com.au/analyst:a_multi-page_report_with_individual_graphs Multi-Section & Multi-Page Reports When creating a report, we found that there were simply too many channels of data to display everything on a single line chart. One way of resolving this is by splitting our individual channels up into their own charts. But since there are so many, we'll also need to split these charts across anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 https://docs.optrix.com.au/analyst:agency_examples Agency Examples The Analytics Example Bundle includes a sample Agency deployment. In the Agency folder, you'll find a file called runagency.bat. After modifying the file, you should be able to double-click it on Windows platforms to start the Agency service. This creates a number of alerts that monitor our anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 https://docs.optrix.com.au/analyst:agency Alerts Alerts can be created by the ARDI Agency framework. This is used to connect live ARDI data to both simple logic and complex AI. One of the key advantages to using Agency is its adaptability. Cross-Site Alerts You can create a single alert in Agency that works across a variety of different sites, as long as their assets have similar names, types or properties. anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 https://docs.optrix.com.au/analyst:analytics_example_bundle Analytics Example Bundle To walk you through the process of making visualisations and analytics powered by ARDI data, we offer a bundle of samples you can use. This is a ZIP file - we suggest extracting it to an empty folder on your system. Inside are a number of folders, such as anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 https://docs.optrix.com.au/analyst:aql_language_introduction AQL Language Introduction The ARDI Query Language is a simple concatenative language. It allows you to write your queries as 'programs' that run to produce the results you need. For those used to traditional languages, the biggest difference is that the parameters to a function appear anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 https://docs.optrix.com.au/analyst:aql_tabular_data AQL Tabular Data When requesting points of data (ie. live values or history), you can also request tables of data instead of individual raw channels. There are a few advantages of data tables if you're using data for analytics... Data For Every Index In tables, you have values for anonymous@undisclosed.example.com (Anonymous) Mon, 27 Apr 2026 22:59:33 +0000 https://docs.optrix.com.au/analyst:aql ARDI Query Language Although there are a variety of API functions available, most queries you'll make to ARDI use the ARDI Query Language (AQL). Although the name is similar, AQL is not based on the SQL language that you might be familiar with from traditional relational databases. anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 https://docs.optrix.com.au/analyst:assetlist ASSETLIST An ASSETLIST is an AQL list of assets. Creating The most common way of creating a list of assets is using the ASSET function. 'Wind Turbine' ASSET The above function will return an asset list that contains all of the assets with 'Wind Turbine' in its name anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 https://docs.optrix.com.au/analyst:assets Assets If you’re thinking about accessing information from ARDI, you’ll need to know about assets. Assets represent things of interest in the organisation. Often these are physical pieces of equipment (such as sensors, machines, network switches etc.), but an asset can also represent shifts, crews, departments, people and virtual infrastructure. anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 https://docs.optrix.com.au/analyst:bound Binding Properties can optionally be bound to an external source of data. As an analyst, you don't need to be concerned about where these come from, since ARDI takes care of sourcing the data for you. anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 https://docs.optrix.com.au/analyst:building_a_query Creating a Query for Wind Turbine Power In this example, we're going to look at some of the ways we can ask for the data we need for the Using ARDI Data in Excel task. We'll go through the initial step to find the assets and data, then a few different options for building our query. anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 https://docs.optrix.com.au/analyst:clients ARDI Clients ARDIs clients are tools that different people across the organisation can use to access ARDI data. This includes clients such as ARDI-360, ARDI-AR and ARDI-VE and the Data Explorer. These are designed specifically to provide information to particular user groups. anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 https://docs.optrix.com.au/analyst:complex_query_examples Complex AQL Queries Getting Assets of a Type 'Gearbox' OFTYPE Gets a list of assets that have the Gearbox type - Sample Getting History for All Assets of a Type 'Gearbox' OFTYPE 'Temperature' PROPERTY VALUES {"range": "10 minutes"} GETHISTORY Gets a list of assets located inside the Southern Zone - anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 https://docs.optrix.com.au/analyst:constlist CONSTLIST A CONSTLIST in AQL is a list of constant values. These are usually strings (encased in single-quotes) or numbers. Constants are usually used as parameters to FUNCTION. A single constant by itself is converted into a CONSTLIST. You can also create your own list by placing several comma-delimited constants inside brackets. anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 https://docs.optrix.com.au/analyst:creating_a_powerpoint_report_file Creating a PowerPoint Report File NOTE: Running this example requires installing the pptx Python module To create a PowerPoint file, we will use the PPTX python module, which is made specifically for manipulating and creating PowerPoint files. Instead of pages in a PDF, this report is going to show individual slides for each of the anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 https://docs.optrix.com.au/analyst:creating_a_traditional_report Creating a Traditional Report In this example, we're going to create a traditional PDF report that can be emailed or printed to our users. Our Task Our users need to see a daily line-graph showing how much vibration we're getting on our wind turbines. anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 https://docs.optrix.com.au/analyst:creating_infographics Web-Based Dashboards and Reports Traditional reports are often pre-generated, and usually non-interactive. ARDI allows you to use Javascript to create dynamic and interactive web-based visualisations that use live, historical, event and hybrid data. Why Infographics anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 https://docs.optrix.com.au/analyst:creating_live_models Creating Live Models In some cases, customers have existing models that describe how their system works - but they are usually offline models that are done by hand or in spreadsheets. With the rise of Machine-Learning, they may also have predictive, simulation or analytic models that can be used to improve how people operate equipment. anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 https://docs.optrix.com.au/analyst:demo_data Demo Data In this documentation, we'll be guiding you through several different examples that you can run on your own machine and experiment with. But before we can make a data-driven tool, you're going to need some actual data. Our example data will mostly come from our anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 https://docs.optrix.com.au/analyst:discrete_data Discrete Data in ARDI Queries Discrete data - such as integer and boolean (ie 'on'/'off') values are treated differently in ARDI. It is important for ARDI to understand the status of a system at any time. This means that when we request history, we need values that make sense. anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 https://docs.optrix.com.au/analyst:drawings Live Drawings With ARDI, it's possible to create live-data-powered SVG drawings. SVG graphics can be opened on all modern web browsers, scale to any screen or printer size, and can be animated to provide users interactive displays that work in a similar way to HMI screens. anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 https://docs.optrix.com.au/analyst:example_aql_statements Example AQL Statements Getting Asset Information 'Wind Turbine #1' ASSET Gets asset information about Wind Turbine #1 - Sample Getting Property Information 'Speed - Blade' PROPERTY Gets property information about Rotation Speed - Sample Getting Relationship Information anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 https://docs.optrix.com.au/analyst:example_batch_files Modifying BAT Files The Analytics Example Bundle includes several different examples. To make launching them easier, most will also include a BAT file to start the example in Python. These batch files are created with hard-coded paths to the Python that is included on ARDI servers. However, if you're running these tools on another server, you might need to edit these files to point to your specific version of Python. anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 https://docs.optrix.com.au/analyst:excel_and_powerquery Using ARDI Data in Excel For our first exercise, we'll bring some ARDI data into Excel. Our Task In this case, we want to create a bar-chart showing the average amount of power each of our wind turbines has generated over the last hour. Step 1: Identify the Assets & Build a Query anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 https://docs.optrix.com.au/analyst:expected_value Expected Range Many ARDI API functions return minimum and maximum ranges in their metadata. It's important to note that these are simply provided as a guide. ARDI will not limit the range of the value, so it's not unusual to find that measurements may go above or under the given range. anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 https://docs.optrix.com.au/analyst:full_cycle Full Cycle Integration ARDI encourages what we call full cycle integration. This means that if your ARDI-powered analytics calculate any new values - such as detecting events, producing totals or KPIs - we encourage developers to push these values back to ARDI anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 https://docs.optrix.com.au/analyst:function FUNCTION An AQL function will normally consume one or more other items from the stack as parameters and will optionally write one or more items back onto the stack as output. For example, the ASSET function consumes a CONSTLIST off the stack, and returns a ASSETLIST. anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 https://docs.optrix.com.au/analyst:gethistory_method Methods (GetHistory) When requesting history from ARDI, there are two key parameters that control the output. The first is the Grain, which dictates the resolution of the data. The other is the mode, which is used to change how the query works. Note that anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 https://docs.optrix.com.au/analyst:grain Grain (GetHistory) When requesting history from ARDI, there are two key parameters that control the output. The first is the method, which is used to change how the query works. The second is the Grain, which dictates the resolution of the data. Negative Grain anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 https://docs.optrix.com.au/analyst:heatmap Heatmap Reports When creating a report, we found that there were simply too many channels of data to display everything on a single line chart. One way of resolving this is by splitting our individual channels up into their own charts. This is ideal if you're looking for issues along individual assets. But if you're looking for patterns or inconsistencies anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 https://docs.optrix.com.au/analyst:infographic_building Building Our Infographic This is second half of our discussion of creating infographics The example code you downloaded includes an HTML file in the Infographics folder. Each Infographic is generated with Javascript. Like in our Python-driven reports, Javascript offers a range of different libraries you can use when creating web-based content. While this Infographic demonstrates 2D displays using D3.js, you can use other libraries such as THREE.js (3D graphics) or pure Javascript. anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 https://docs.optrix.com.au/analyst:installpython Installing Python Many of ARDIs tools are Python-based. While Python is installed along-side ARDI, there's a good chance you'll be working on your personal computer rather than directly on the ARDI server. If you'd like to follow along with these exercises or experiment on your own, you'll need to install Python 3.10 or higher. anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 https://docs.optrix.com.au/analyst:main_ardi_web_interface Navigating ARDI Here's a quick crash-course in navigating through the ARDI web UI. When you first arrive, you'll normally be looking at a diagram page. This shows a selected asset and a number of other, connected assets. At first, you'll be looking at the anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 https://docs.optrix.com.au/analyst:non-traditional_reports Non-Traditional Reports The reporting engine can be used to produce any type of output that needs to be prepared on a schedule or requires analytics to be performed. This isn't limited to PDF pages - you can output any kind of file you would like. anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 https://docs.optrix.com.au/analyst:optrix_wind_farm Optrix Wind Farm The Optrix Wind Farm is one of the Small Example demos available online. It's a relatively simple system, but should help us get an idea of how to build off ARDI data. Available Assets Below you'll find a diagram of the assets available from the server anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 https://docs.optrix.com.au/analyst:pointlist POINTLIST A POINTLIST is a list of points - combinations of both an asset and a property. Pointlists are required if you want to read live or historical values out of an ARDI system. Creating From Properties You can create a list of points from a property anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 https://docs.optrix.com.au/analyst:points Points (AQL) In an AQL query, a point is a combination of both an asset and a property. Simply having a PROPLIST or an ASSETLIST can't get you any actual values, since you can only read values from a property that is on an asset. See Also POINTLIST anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 https://docs.optrix.com.au/analyst:properties Properties Properties are the individual pieces of information about an asset. An asset can have any number of properties. Property Types There are several different types of property. Analogue properties contain continuous numbers – they are normally used for measurements or numeric figures. anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 https://docs.optrix.com.au/analyst:propertylist PROPERTYLIST An PROPERTYLIST is an AQL list of properties. Creating The most common way of creating a list of properties is using the PROPERTY function. 'Speed' PROPERTY The above function will return a property list that contains all properties with the word 'Speed' in their name anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 https://docs.optrix.com.au/analyst:python_modules Additional Modules One of the reasons Python was chosen as a platform for many of ARDIs tools is its versatility - there's a huge range of modules out there to help you perform tasks and connect to other systems. Some of our examples will use these extra modules, such as anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 https://docs.optrix.com.au/analyst:relationshiplist RELATIONSHIPLIST An RELATIONSHIPLIST is an AQL list of relationships. Creating The most common way of creating a list of assets is using the RELATIONSHIP function. 'Location' RELATIONSHIP The above function will return a list of all relationships with 'Location' in their name. anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 https://docs.optrix.com.au/analyst:relationships Relationships Relationships describe how your assets are connected to one-another. Relationship Types There are a few different types of ARDI relationship: Hierarchical: These describe how your system is organised. Physical: Describing a direct physical connection, or an exchange of product and information (pipe, cable, Wi-Fi) anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 https://docs.optrix.com.au/analyst:sidebar Navigation Documentation Introduction Main Page Assets Demo Data Query Language Exercises/Samples Excel / PowerQuery Traditional Reports Non-Traditional Reports Web Displays Alerts Live Drawings Live Models Triggering Code Full Cycle Integration anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 https://docs.optrix.com.au/analyst:triggering_code Triggering Code The Trigger library is used to execute code when specific events are detected in your live data. This can be very useful for producing event, batch or production-run reports. Unlike shift and daily reports or analytics, triggered events often have erratic timing. anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 https://docs.optrix.com.au/analyst:types Types An asset can have any number of types associated with it. Types group assets in different ways. A type might represent the assets function (ie. a door, a motor, a switch etc.). They can also represent attributes of that asset, giving people additional information about what it is and how it works. For example, an asset that needs air to work might have the type ‘Air Operated’. anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 https://docs.optrix.com.au/analyst:using_ua_explorer OPC-UA Example OPC-UA is an industrial protocol, designed to make a unified method of exchanging industrial data between systems. Most industrial recording systems support OPC-UA, along with a number of SCADA systems and HMIs. It isn't often supported directly in a sites PLCs, but protocol converters such as those provided by RedLion allow you to read OPC-UA data and write it into a huge range of PLCs and other pieces of industrial hardware. anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000 https://docs.optrix.com.au/analyst:welcome Using ARDI As A Platform While ARDI has a number of ARDI Clients targeted at a range of users, ARDI is also extremely useful as a platform to develop data-driven tools and visualisations. While the Site Builders Guide covers the basics of setting up a new ARDI system, this guide is intended for users that want to use ARDI to perform analytics, visualisations and develop AI and machine-learning solutions. anonymous@undisclosed.example.com (Anonymous) Thu, 18 Dec 2025 22:50:17 +0000