Control Module Class
Control Module objects are hierarchical elements of the business structure in the KPI Model Panel.
In the KPI Model Control Modules are elements of an Equipment Module.
There are no child objects for Control Module objects in the KPI Model.
Quick Configuration
-
In the KPI Model panel, right-click on a Equipment Module object and select from the context menu.
-
In the Create Object Wizard, give a name to the object and click Create to create the object in the KPI Model.
Object Properties
The user-modifiable object name. This name overrides the name which has been supplied by the external system. It must be unique within the collection of objects of the parent object. This is the user-modifiable object description. This text overrides the description which has been supplied by the external system. The corresponding Visual KPI object class. The Group ID which gets assigned by VisualKPI. Table for translations of property values to various languages. File attachments stored in MongoDB file store.Common
Compound holding the group options for the KPI visualization. Show this group in the VisualKPI dashboard. Numeric value that overrides the default alphanumeric order of KPIs. KPIs without explicit display order will be sorted alphanumerically and displayed below KPIs with display order values explicitly set. Primary contact for this group. Can be individuals, separated by semicolons, or AD distribution lists. Group info settings. Additional relevant information (can be hyperlinked). If the Info field is a hyperlinked value, then this will be the tooltip or mouseover text for the link. If only a URL is used, then this will be the text displayed in Info. Info display format. Number only: For actual value visualization, only the number part will be used. Number, followed by Engineering Unit: For actual value visualization, the number will be displayed followed by the engineering unit. Engineering Unit, followed by Number: For actual value visualization, the number will be displayed following the engineering unit. The numeric formatting code (.NET) used to modify how numbers are displayed. Unit of measure for the info value (applicable if value is numeric). URL link for the Info field (creates a hyperlink in the Info field). Compound holding the sparkline options for the KPI visualization. Controls whether or not sparklines are shown for KPIs and charts in this group (Sparklines feature must be enabled). Start time of the sparkline (absolute or relative). End time of the sparkline (absolute or relative). Compound holding the geographical map options for the KPI visualization. Specific to groups (0-21) default Google zooming level. Overrides what is displayed for an object on a geo map. Default: Name: Name: Info: Compound holding the column display options for the KPI visualization. Overrides the default actual column name (header) for KPIs in this group. Overwrite the name of the KPI target display. Overwrite the name of the group info. Hide/show group info column. Overwrite the name of the info display. Hide/show KPI Info. Overrides the default info column name (header) for charts in this group. Hide/Show the chart information. Overwrite the name of the table information. Hide/show table information. Default group settings. Overrides the default tab selection (Groups, KPIs, Charts, etc.) when the Group is selected. Default: System: Groups: KPIs: Charts: Tables: Group Map settings. Group Map KPI cell count. Group Map header priority. Default: Default. Overall: Overall. Recently Changed: Recently Changed. List of associated links or URLs (semicolon separated, limit 10) for the object. List of associated Link or URL descriptions (semicolon separated, limit 10) for the object. These are used to both shorten and give better meaning to links (e.g., instead of www.xyz.com?x=5&type=2, the user could see SOPs or Shift Report).Options
Group Info Settings
Info Display Format
Sparkline Options
Geo Map Options
Geo Label Format
Column Display Options
Default Group Settings
Default Tab
Group Map Settings
Group Map Header Priority
The location of the object. Definition of the location strategy. No location: This object is not interpreted in a location context. Static (or manually changed) location: You may set the location data manually, by Engineering Script or by selecting the location visually using the Location Finder feature. Inherited location: The object inherits the location from the owning object in the system hierarchy. Dynamic location: The object location is supplied by other I/O Items. You may drop other I/O items into the location fields of this object. Location properties: The endpoint server has distinct properties for I/O item location data. Please note, that this option works only for I/O items . The optional name of a location. The north-south position of a point on the Earth’s surface. The east-west position of a point on the Earth’s surface. The height above sea level of the location. Enables historization of Location data.Location
Strategy
Compound to hold various structures to customize the object and to be read and written to by Lua-Script code or external interfaces. A generic string buffer to be used programmatically for custom purposes. This is an extensible set of named strings which can be used programmatically for custom purposes. A custom property name which can be used programmatically. The value of the custom property which can be read and written programmatically. This is an extensible set of named tables which can be used programmatically for custom purposes. A custom table name which can be used programmatically. Handles an entire table organized in columns and rows. The data can easily (cut, copy and paste) be exchanged with table-oriented data of other software products, e.g. MS Excel.Custom Options
Custom Properties
Custom Tables