Variables - Lookup
From VersaVision Support
Variables can be setup on Widgets or Dashboards. Each Variable has a specific purpose or data it gathers.
This page is dedicated to the Lookup Variable which allows the user to execute a Command that will return information from a custom source.
This page explains how to Add and Edit a Variable.
With a new or existing widget or dashboard opened, click on the Variables button at the top-right position above the layout.
|
On the Variables window click on the Add New button.
Each New Variable will have 4 property fields available. Depending on the Type selected, these fields may change. Select the Variable Name field.
Enter a Name for the Variable being created. Ensure the name is recognizable for use in creating the Dashboard or Widget cell.
- NOTE - a name must be uppercase letters or numbers. When a space is required, the user must use and underscore "_".
After entering a Variable Name, select the down arrow in the Type field.
Select Lookup from the list.
The Variable Properties will change to show the following fields and options.
- Polled - select how often the Lookup runs.
- Command (Single Value Lookup) - select the specific command for the Variable.
- Result Type - select how the Lookup result will be shown.
The Polled switch will be disabled by default - click on the toggle to enable it.
- Disabled - this setting will only run the Command selected when the parameter provided is changed.
- Example: if the Widget/Dashboard is looking up an Employee name based on the ID entered at the location, the only time the name would be looked up is when someone new logs in.
- Enabled - this setting allows the user to tell the system when/how often to run the Lookup.
- Example: if the Widget/Dashboard is looking up the total pieces for all of the stations in a line, the user would want to have the lookup run every X seconds. The time/seconds would depend on the production rate in this scenario.
- Disabled - this setting will only run the Command selected when the parameter provided is changed.
When Polling is enabled, there will be an additional Polling Interval (s) field. The (s) is indicating that the time entered into the field will be Seconds.
By default, this field will be set to 5 Seconds. To change the default simply click in the cell and type in the new value.
Click on the down arrow in the Command field.
A list of all the Commands setup in the system, that are Single Value Lookups, will show. Select the Command needed for the Variable being created.
All Single Value Lookup Commands will have at least 1 parameter others may have multiple parameters. The total number of Parameter fields will load under the Command field.
A Parameter will generally be an existing Variable. In our example of looking up the employee name using the entered employee ID, would require a Variable that gets the employee ID value.
Click on the down arrow in the Parameter field.
A list of all Variables setup on the Widget/Dashboard will show - select the appropriate one for the Command being used.
For our example, the EMPLOYEE_ID Variable will be selected.
Click on the down arrow in the Result Type field.
The Result Type field will have 3 options available - select the best option for the Command being run.
- Text - selecting this option will return the Lookup result as Text.
- Number - selecting this option will return the Lookup result as an Integer.
- Time Span - selecting this option will return the Lookup result as a Time Stamp.
When Number is selected as the Result Type, a Decimal Place field will load. Click on the down arrow in the Decimal Places field.
There will be 4 options available - select the best option for the Variable being created.
- 0 - this option will only return a whole number. Example: 3
- 1 - this option will return a number with 1 decimal place. Example: 3.5
- 2 - this option will return a number with 2 decimal place. Example: 3.58
- 3 - this option will return a number with 3 decimal place. Example: 3.586
|
|
 |
|
|