| Property Name |
Description |
| Gizmo Properties |
Defines high-level characteristics of the gizmo:
| Property Name | Description | | title | title of the gizmo. | | Tab Id | If using tabs, specify an identifier for the tab. If not using tabs,
leave this blank. If you leave this blank and you are using tabs,
the gizmo will not be displayed. | | Show Gizmo | Yes/No shows/hides the gizmo. | | Width | Width of the gizmo in pixels. | | Height | Height of the gizmo in pixels. | | Enable Resize | Yes/No allows/prevents resizing of the gizmo. | | Refresh on Timer Every (sec) | Time (in seconds) between window refreshes. | | Options | Details concerning properties that appear on options dialogs:
| Property Name | Description | | Property Id | Identifier of the property that appears on an options dialog.
If this is in a collection or property list, include the full
path using the dot character (.) as a separator. | | Editable | No disables editing of the property, but it will still be
visible. |
|
|
| Meter title |
title of the meter. |
| Query Type |
Determines the Query Mode. Which properties to use when building the query in order to run the Gizmo. If not provided defaults to SQL.
| Property Name | Description | | SDI List | An SDI List Query runs a basic one dimensional query on the SDC specified. It uses the same SDIRequest API as used in the List page/element. Full SDI level Security and ActiveFlag are considered. However this query type cannot be used to run groupbys or or complex aggregate queries. | | SDI Aggregate | This query type combines the powers of the SQL query with the security and simplicity of the SDI List query. It allows property driven queries to be built but runs it through the LabVantage security layer so that rows returned are only returned if the user has access to them. The ActiveFlag is also considered. | | SQL | SQL Query. A simple query that returns two columns, Measurecategory and Mesurevalue.
Example: select s_productid as measurecategory, count(s_sample.s_samplid) measurevalue from s_product, s_sample where s_product.productid=s_sample.productid You can also use parameters in the SQL: select s_productid as measurecategory, count(s_sample.s_samplid) measurevalue from s_product, s_sample where s_product.productid=s_sample.productid AND s_sample.sampletypeid='[sampletype]' | | Monitor | Optionally choose a monitor SDI set up. You can use a scheduled task to update a value which will be used to render the meter.
This is not a recommended way to monitor for changes in the system but has been left for backward compatibility. |
|
| Monitor ID |
Define a Monitor Id for the Monitor SDI. |
| or SQL |
Enter a SQL statement returning 1 column called "measurevalue":
select count(s_sample.s_samplid) measurevalue from s_sample where s_product.productid='Environment' You can also use parameters in the SQL: select count(s_sample.s_samplid) measurevalue from s_sample where s_product.productid='[product]' |
| SDI Aggregate |
Properties used to define the SDI Aggregate Query Type.
| Property Name | Description | | SDC Id | The SDC Id for the primary query. For example, Product | | Query From | The secondary aggregate table to query from (where to join will occur). For example, s_sample | | Query Where | The filter clause for the query which creates the join.
For example: s_sample.productid=s_product.s_productid in parameter form: s_sample.productid=s_product.s_productid AND s_sampleid!='[test]' | | Category String | Properties for defining the Category (label) column.
| Property | Description | | Category Type | Can be a specific column or a custom SQL statement (a nested query for example). This is required and forms the groupby for the query. | | Column Id | The column to use for the Category.
For example: s_productid | | Custom String | The custom column definition (nested SQL) to use. |
| | Value String | Properties for defining the value column used when plotting data.
| Property Id | Description | | Value Type | The type of Value string to render.
| Property Id | Description | | Column | Must be a number column which returns the value to plot. | | Count | Performs a count on the aggregate. | | Average | Performs an average on the aggregate. | | Sum | Performs a sum on the aggregate. | | Custom | Allows a custom nested SQL. |
| | Column ID | The column Id for the Value Column, Count, Average or Sum. | | Custom String | If the Value Type is Custom enter the custom nested SQL. |
|
|
| SDI List |
Properties used to define the SDI List Query Type.
| Property Name | Description | | SDC Id | The SDC Id for the primary query. For example, LV_WorkflowDef | | Query Id | The Query Id from the list of queries. This will then be used to filter the SDI list returned. You cannot use a Query Id and a querywhere together. | | Query Params | A Collection of Parameters to use with Query Id.
| Property Id | Description | | Identifier | Unique identifier for this item, rendered as an ID attribute
in the HTML tag. | | Column ID | Value of the parameter. |
| | Query From | The additional From Clause. Cannot be used if using a Query Id. | | Query Where | Filter clause which can only be used if not using a Query Id. | | Column Id | The column to use for the plot value. This must be a number. You can also use inner sub queries to join tables. However this is less efficient than using the SDI Aggregate query mode.
s_sampleid for example. | | Count | Yes performs a count on the column returned. This will perform an in-code count on the rows returned rather than a database count. For a true database count use the SDI Aggregate. | | Distinct | Yes performs a distinct on the values returned. This is an in-code distinct and will be performed after the data is retrieved. |
|
| style |
style of the analog meter (Panel gauge, Circular gauge, Thermometer, Numeric or HTML). |
| Meter Category |
Optional category defined for the meter. |
| Units |
Units of measurement used by the meter. |
| Meter Minimum |
Lowest value displayed on the meter. |
| Meter Maximum |
Highest value displayed on the meter. |
| Meter Range Warning |
Level at which the Meter is Warning.
The Thermometer and Numeric types have ranges (critical, warning and normal). When the Meter Range Warning property is set, and the value defined in is met, the gizmo will change color to illustrate the condition. |
| Meter Range Critical |
Level at which the Meter is Critical.
The Thermometer and Numeric types have ranges (critical, warning and normal). When the Meter Range Critical property is set, and the value defined is met, the gizmo will change color to illustrate the condition. |
| Show Ranges |
Determines whether Meter Warning and Critical Range is displayed. If Yes Ranges are displayed. |
| Image URL |
Image available to enhance the appearance of the meter. |
| Color Scheme |
Color scheme for the meter (Dark or Light). |
| Custom HTML |
An HTML Text editor is provided, create a custom meter using [parameters] and [value] to display the information. |
| Text Size |
When using the Numeric style, defines the text size of the number displayed. |
