References
References are a powerful way to access data sources in the Intelligence Hub.
Populating
To populate a Reference simply drag and drop references from the Reference Panel on the right side of the screen.
Modes
Simple
By default, References are set to “Simple” mode.
In Simple mode the Reference Name will hotlink (if applicable) to that element, and a list of Parameters will auto-populate if that reference supports parameters.
In this example, this reference is to a Machine Input on an OPCUA connection. Since that connection has a index
parameter that field is shown below the path, and in this case, an index is being dynamically provided using a parameter in an Instance.
Advanced
A Reference can be changed to “Advanced” mode by clicking the “Advanced” button in the top left corner.
A Reference can be returned to Simple mode by clicking the “Simple” button, but the reference must be in a valid state. (dynamic names are not supported in Simple mode)
In Advanced mode references can by dynamically driven by parameters, event values, and system variables.
In this example, this reference is to a Machine Input on an OPCUA connection, and the Input name for the Machine is being dynamically driven by the event value in a Pipeline. The user knows that these Inputs all have an index
parameter and that parameter is also being populated using the event value from a Pipeline.
Using Event Value as Parameters
Instead of building out an object for Parameters, since event.value
produces an object, this could also be injected directly in to the parameters field.
Path
A “Path” can be added to extract specific data from the data source. For example:
- If the data source produces an array, a path of
[0]
would return the first element from that data source. - If the data source produces an object with the property “temperature”, then a path of
.temperature
would return the value of that property - If the data source produces an arrays and objects then the path can be a combination of the two. For instance
[0].temperature
would return the temperature property of the first element in the array.
Copy/Paste
Reference can be Copied using the copy button in the top right of the reference.
If a Reference is copied it will be remembered inside of the current browser tab, and can be pasted in to another Reference field anywhere in the Intelligence Hub.
Paste will not work if the reference type is not supported in that location.
For example, Namespaces do not support Advanced reference.