Difference between revisions of "Templates"

From eMMS Help
Jump to navigation Jump to search
imported>Dpltech
(Values)
imported>Dpltech
(Values)
Line 39: Line 39:
 
:;D. Description: Leave empty to use the datatag description.
 
:;D. Description: Leave empty to use the datatag description.
 
:;E. Optional Formula: Pre-defined formulas to convert the raw data to a particular unit.   
 
:;E. Optional Formula: Pre-defined formulas to convert the raw data to a particular unit.   
:;F. Extra Formula: .
+
:;F. Extra Formula: Exactly as said, add a extra formula. When there is a optional formula, the extra formula will be added after executing the optional formula.  
 
:;G. Alert Contact: If you would like the contact assigned to the device to be notified.
 
:;G. Alert Contact: If you would like the contact assigned to the device to be notified.
 
:;H. IsCounter: If you would like the value to increment on each time it gets triggered.
 
:;H. IsCounter: If you would like the value to increment on each time it gets triggered.
 
:;I. No Fix: Prevents Fixing Data. For furthur details, see [[Advanced Equipment Configuration#Fix Data Screen|Fix Data]].
 
:;I. No Fix: Prevents Fixing Data. For furthur details, see [[Advanced Equipment Configuration#Fix Data Screen|Fix Data]].
 
:;J. Use Formula to enter initial value: Exactly as said, utilizes a formula for the initial value.
 
:;J. Use Formula to enter initial value: Exactly as said, utilizes a formula for the initial value.
:;K. Resets on Power Cycle:..
+
:;K. Resets on Power Cycle: ??? Exactly as said, the data will be reset on power cycle if this is checked.
:;L. Ignore Zeros:..
+
:;L. Ignore Zeros
:;M. Admin Only:..
+
:;M. Admin Only
:;N. Location Special Data Type: ..
+
:;N. Location Special Data Type: ???
  
 
== Alarms ==
 
== Alarms ==

Revision as of 14:04, 9 June 2015

__NOTITLE__

Templates

Templates allow you to define which set of parameters the device will listen for and report on. This includes; Values, Alarms, Locations and Actions.

To navigate to the Templates section, under Admin, select Templates.

This will display all available templates that you have created. To configure/edit any of the existing templates, click the Config button next the to template you wish to modify.

TemplateOverview.png

A. Modify Button
This will allow you to change values such as the templates' name, description, DataTag, etc. Click on the green check mark to save your changes or the red X to cancel.
B. Messaging(Enable)
C. Messaging(Alert Contact)
D. AppClass
E. Toggle View Button
Switch the view to Tab view or Stacked view.
F. Expandable Menu
Contains New Parameter.
G. Edit Parameter Icon
This will allow you to change particular parameters of the device as below.
EditParameter.png
Click the green check mark or red X buttons to enable/disable the item, respectively. You can change its name, description, options, etc. You can also delete the parameter by clicking the red trash icon on the far right.
H. Swap Parameter Position Icon
Changes the display position of parameters on the equipment management page.
I. Datatag management
This will allow you to manage the name and the description of a datatag as below.
DatatagManagement.png

Values

In order to add a Value Parameter, click the New button from the expandable menu of the Values tab.This brings you to the Enter Value Params screen as below.

NewValue.png

You have a number of configurable options you can set:

A. Value #
The corresponding number that you wish to reference.
B. Name
Leave empty to use the datatag name.
C. Tag
A datatag. Only allows the uppercase alphabets, number, '_' or '%'.
D. Description
Leave empty to use the datatag description.
E. Optional Formula
Pre-defined formulas to convert the raw data to a particular unit.
F. Extra Formula
Exactly as said, add a extra formula. When there is a optional formula, the extra formula will be added after executing the optional formula.
G. Alert Contact
If you would like the contact assigned to the device to be notified.
H. IsCounter
If you would like the value to increment on each time it gets triggered.
I. No Fix
Prevents Fixing Data. For furthur details, see Fix Data.
J. Use Formula to enter initial value
Exactly as said, utilizes a formula for the initial value.
K. Resets on Power Cycle
 ??? Exactly as said, the data will be reset on power cycle if this is checked.
L. Ignore Zeros
M. Admin Only
N. Location Special Data Type
 ???

Alarms

In order to add an Alarm Parameter, click the New button from the expandable menu of the Alarms tab. This brings you to the Enter Alarm Parameter screen. Enter the corresponding number(#) that you wish to reference and provide a name for your new alarm parameter. Select the 'Alert Contact' check box if you want to alert the contact when the parameter is triggered, provide the new Value param with a Datatag and description, choose display level and alarm level and you're done!

Locations

In order to add a Location Parameter, click the New button from the expandable menu of the Locations tab. This brings you to the Enter Location Parameters screen. Enter the corresponding number(#) that you wish to reference and provide a name for your new location parameter Select the 'Alert Contact' check box if you want to alert the contact when the parameter is triggered, provide the new value param with a datatag and description and you're done!

Actions

In order to add a Action Parameter, click the New button from the expandable menu of the Actions tab. This brings you to the Enter Action Parameters screen. Enter the corresponding number(#) that you wish to reference and provide a name for your new action parameter. Select the 'Alert Contact' check box if you want to alert the contact when the parameter is triggered, provide the new action parameter with a datatag and description and you're done!

Settings

In order to add a Setting Parameter, click the New Setting button from the expandable menu of the Setting tab. This brings you to the Enter Setting Parameters screen. Provide a name and description and you're done!