InteliSCADA 2 1 0 Global Guide
InteliSCADA 2 1 0 Global Guide
Monitoring tool
for ComAp devices
SW version 2.1.0
1 Document information 6
2 Getting started 9
3 Designer 22
4 Runtime 50
5 Security 60
6 Instruments 61
7 Automatically generated screen 110
8 Troubleshooting 122
2 Getting started 9
2.1 Welcome 9
2.2 Requirements 9
2.3 Installation 10
2.3.1 Installation 10
2.3.2 Start Runtime or Designer 10
2.3.3 Custom branding 10
2.3.3.1 Custom global guide 11
2.3.3.2 Custom company logo 11
2.3.4 InteliSCADA as service 11
2.4 Licenses 12
2.4.1 License activation 15
2.4.2 Clients limitation 16
2.4.3 Site limitation 16
2.5 Supported ComAp devices 17
2.5.1 Controllers 17
2.5.2 Communication modules 18
2.6 Backup & restore 19
2.6.1 How to back up the data 19
2.6.2 How to restore the backed up data 19
2.6.3 Automatic site backup 20
2.7 Uninstallation 21
3 Designer 22
3.1 Sites 25
3.1.1 Add site 26
3.1.2 Edit site 27
3.1.3 Import site 28
3.2 Devices 28
3.2.1 Add device 29
3.2.2 Setting up controller username and password 31
4 Runtime 50
4.1 Navigation in Runtime 50
4.1.1 Runtime toolbar 50
4.2 Sites 52
4.3 Setpoints 52
4.3.1 Edit setpoint 53
4.4 Values 55
4.5 History 55
4.5.1 History filters 58
4.5.2 History columns 58
4.5.3 Exporting history 59
4.6 In-progress indication 59
5 Security 60
6 Instruments 61
6.1 Instruments specific properties 62
6.1.1 Warning limits 62
8 Troubleshooting 122
8.1 Connection to server 122
IMPORTANT: This type of paragraph highlights a procedure, adjustment etc., which can cause a
damage or improper function of the equipment if not performed correctly and may not be clear at
first sight.
Example: This type of paragraph contains information that is used to illustrate how a specific function
works.
2.1 Welcome
Welcome to ComAp's InteliSCADA global guide. InteliSCADA is a monitoring tool for ComAp devices (see
Supported ComAp devices on page 17) and runs on Microsoft Windows operating system (see
Installation on page 10 for details). It supports both online and offline device connections. Devices can be
connected either via the Ethernet connection, AirGate connection, direct connection (using USB or RS232) or
offline connection (device connected to the offline archive only). Devices are managed in sites. There are two
applications accessible via pre-installed Windows Desktop shortcuts:
Designer (page 22) - Used to manage sites, devices and custom screens
Sites (page 25) tab - Add, edit or delete a site
Devices (page 28) tab - Add, edit or delete a device of the particular site
Editor (page 34) tab - Add, edit, delete or design a screen of the particular site
Preview (page 47) tab - Preview the automatically generated screen or the custom screen, for long-
term monitoring use the Runtime (page 50) instead
Runtime (page 50) - used for long-term site monitoring:
Sites (page 52) tab - Lists all sites available on the server
Opens particular site for monitoring (the site password is required)
Is used to monitor and control all devices of the particular site
2.2 Requirements
Microsoft Windows 10 64-bit or Windows 10 IoT 64-bit. Keep your SW updated (e.g. Windows operation
system, drivers, ...)
Web browser Google Chrome or Mozilla Firefox if running InteliSCADA in the browser
The latest firmware versions for all ComAp devices and other modules (e.g. CM-Ethernet, IB-COM etc.)
which will be connected to InteliSCADA.
2.3 Installation
2.3.1 Installation
1. Get the latest InteliSCADA installation package
2. Run it and follow the on-screen instructions
3. Read and accept terms in the license agreement to continue installation
4. Select components to install. It is recommended to use the default installation
5. Enter the port number used by InteliSCADA server to listen on, except for the reserved ports from the TCP
and UDP list (Default = 8801)
6. If InteliSCADA is already installed on the computer, backup of user data is created automatically (see
Backup & restore (page 19))
7. Once the installation is finished, InteliSCADA service is started and following desktop shortcuts are
created:
a. InteliSCADA Designer
b. InteliSCADA Runtime
2.4 Licenses
Runtime (page 50) supports 3 license types according to your data requirements (Designer (page 22)
doesn't require any license activation). Currently available license types and their limits are listed in the table
below.
License Type
Maximum number per site
Lite Pro Pro+
Data Points 100 400 10000
Devices 32 32 32
Communication Gateway Unsupported Supported Supported
Note: One data point from one device used on multiple instruments and/or screens counts as one data point.
To see information about licenses go to Designer and open the License Details dialog from the Settings
section available in the Device tab, Editor tab or Preview tab.
The site doesn't comply with the current license (any limit of currently used license exceeded)
If the number of data points exceeds the limits of Pro+ license, the required license will be of type
'Unavailable' and the site will not be possible to open in Runtime. To open it in Runtime, please modify the site
in Designer to meet the requirements of available licenses.
or using extended License Activation dialog, which can be opened from Sites of Runtime by clicking on
the red dollar button of particular site
Copy the Hardware ID( ) and send it, including required type of license, to your distributor (e.g. by
email)
Distributor will send back the activation code. Copy and paste it to the Activation Code input field
Click on the Activate License button to activate the license
There will be a notification in the dialog about the activation result and the Current License field will
change accordingly
IMPORTANT: Activation Code is generated based on the Hardware ID, i.e. for the specified PC
hardware, where InteliSCADA is installed. If any part of the hardware is changed, a new license
activation code might be required.
2.5.1 Controllers
ComAp controller Application
SPtM
InteliGen NT/NTC BaseBox MINT
SPI
SPtM
InteliGen NT/NTC BaseBox GeCon Marine MINT
SPI
SPtM
InteliGen NT/NTC BaseBox GeCon LandBased MINT
SPI
SPtM
InteliGen NT/NTC MINT
SPI
SPtM
InteliGen GSC/GSC-C MINT
SPI
SPtM
InteliSys NTC BaseBox MINT
SPI
SPtM
InteliSys NTC BaseBox GeCon Marine MINT
SPI
SPtM
InteliSys NTC BaseBox GeCon LandBased MINT
SPI
SPtM
InteliSys GSC-C MINT
SPI
SPtM
InteliSys Gas MINT
SPI
InteliSys NTC Hybrid MCB
A size of backup files depends on the sites configuration. Consider available free disk space for the new
backup. It is also possible to back up the data manually, see the chapter How to back up the data (page
19).
Files cs-data.db and cs-archives.db can be deleted to save disk space - these files contain cache for faster
loading and will be generated again automatically.
It is also possible to backup automatically exported sites stored in C:\ProgramData\ComAp PC
Suite\InteliSCADA-Backup\Sites\. For more information see Automatic site backup on page 20.
4. If there are any data in the destination folder, consider to make a backup before overwriting
5. Run InteliSCADA service again (see InteliSCADA as service (page 11))
"Import Site" button – Imports the site from the selected file (*.isx)
Preview link – Opens the Preview tab with the default monitoring screen of the site
Editor link Link to the Editor tab with the default screen of the site
Preview link Link to the Preview tab with the default screen of the site
"Lock/Unlock Locks / unlocks the particular site. If the site is locked, it opens the dialog to
Site" button unlock it, otherwise it locks the site
"Site Runtime
Shows the Runtime URL link to the default screen for the site
Link" button
"Edit Site" button Opens the dialog for editing the site details (site name, password)
"Clone Site"
Creates a copy of the site with the same site password
button
Required fields:
"Enter Password" – User defined password, see password requirements and its purpose in
Security (page 60)
Required fields:
File Name – Click the Browse button to browse the file to be imported
3.2 Devices
List of devices for the particular site can be accessed by:
Device order in the list of devices. It also defines device template order
# on Automatically generated screen (page 110) (template for device
# 1 is placed as first from the left side of the screen)
Device User defined device name entered when creating or updating device
Device (Controller)
Device CAN bus address
Address
Move Up/Down button Drag & drop to change the device order in the list of devices
Import data points Once the device is added into the site it will try to connect to that device
from this device and import data points from it automatically (checked by default)
The controller usernames are defined using InteliConfig (User management) or InteliMonitor (Admin
users) based on the controller type.
The list of usernames is also available in InteliMonitor in the Login (Enter password…) dialog for online
connection . List of usernames are not available for Archives .
InteliLite 4
Connecting – At least one device is still connecting while others may be already
connected
Status Detail – Device detail connection status or connection error description, see also
Communication error notifications: (page 129)
3.3 Editor
Editor provides tools to:
Manage screens (by default every site contains one Automatically generated screen (page 110) and
one custom screen)
Place the instruments on the screen canvas, see How to add instrument on the screen (page 42)
Edit the properties of the screens and the instruments using the Properties panel (page 40)
To check how the edited screen looks and works online, see Preview (page 47)
IMPORTANT: If any error occurred during the data point import, the error notification is displayed
(see Error and warning notifications (page 128)
Tab Description
Tab Description
Saves changes in the screen (changes are also automatically
Save
saved every 3 seconds)
Fit To Screen Sets the zoom value so the screen fits to canvas
Tab Description
Auto-screen
It is always the first screen in the list
It is read only and cannot be deleted
"Add Screen" button – Adds a new screen right below the active screen
"Clone Screen" button – Creates copy of the active screen below the active screen
Search field
by the left mouse button on the instrument in the canvas or in the "Screen Content" list
Displays properties either for the selected screen or the selected instrument
Screen properties:
General
Default Screen – Sets the screen as default for the particular site
Design
Contains images, which can be placed on the canvas and used as a part of the scheme or as a
background of the screen. User images are also automatically added into this collection from any imported
site.
Predefined images can be filtered by the "Default" filter button
User images can be filtered by the "User" filter button
The panel provides following functionality:
"Filter" buttons
All - No filter applied
Default – Filters only predefined images
User – Filters only user images
Search by name or tags – Searches images with the name or tag containing the entered text. The
result is filtered by the Filter
Drag & drop the image from the panel onto the canvas
3. Go to the Editor tab, click on the Screens button in the Sidebar and select one of the available custom
screens
Note: Enable Snap To Grid feature to arrange instruments easily, see Snap To Grid on page 36
6. Select the instrument on the canvas (or in the "Screen Content" panel) and choose a device for this
instrument in the "Instrument Properties" panel (property Source / Device)
7. Open the "Data Point Selection" dialog (Properties / Data Source / Data Point)
8. Select the data point type in the "TYPES" column. Then select the data point group in the "GROUPS"
column. Finally select the specific data point in the "DATA POINTS" column.
The list of data points is filtered only to the data types supported by the selected instrument. If there are no
data points in the dialog, the import of the data points may not have been successful, see Importing data
9. Click on the Preview tab to see the result. Check also Instrument non-standard states (page 124).
Device property is available only if there is at least one instrument with Device property in the
selection
Moving the instrument
Activate Single instruments selection or Multiple instruments selection
Drag and drop the selection to move it to new position
Or use arrow keys to move selection to new position
Shortcut Action
Delete Deletes selected instruments
Confirms the opened dialog or the property value in the
Enter
Properties panel (page 40)l
Esc Cancels the opened dialog without any changes
Arrow key Moves selected instruments by 1 point in arrow direction
Shift + Arrow key Moves selected instruments by 5 points in arrow direction
Ctrl + Mouse down Selects / unselects the instrument clicked by the left mouse button
Ctrl + A Selects all instruments on the canvas
Ctrl + C Copies selected instruments
Saves all changes made on the current screen (changes are also
Ctrl + S
saved automatically every 3 seconds)
Ctrl + V Pastes instruments which were previously copied or cut
Ctrl + X Cuts selected instruments
Ctrl + Y Redoes changes on the current screen
Ctrl + Z Undoes changes on the current screen
To keep the instrument's current aspect ratio when resizing, press
the key SHIFT
Draw selection area
Mouse down -> Mouse move
after mouse up all instruments in the area will be selected
press and hold the SHIFT key to start drawing the selection
area over any instrument
Shortcut Action
Selects / unselects the instrument clicked by the left mouse button
Ctrl + Mouse down
3.4 Preview
The Preview tab is used mainly for the custom screen content validation, i.e. to check how the edited custom
screen looks and works when online. It helps with designing complex screens and with instruments
configuration. The content of the Automatically generated screen (page 110) can be also checked in the
Preview tab even it is not editable. When in the Preview tab, any instrument on the screen can indicate
special states, see Instrument non-standard states (page 124)
Setpoints button – Opens the dialog to monitor and edit setpoints of any device in the particular site,
see Setpoints (page 52)
Values button – Opens the dialog to monitor values of any device in the particular site, see Values
(page 55)
History button – Opens the dialog with history records from all devices in the particular site, see
History (page 55)
"Fit To Screen" button – Zooms the screen so the whole screen is visible and fits the screen size
Fit to screen option is kept when screens are switching or when browser window is re-sized
"Zoom 100%" button – Zooms the screen to the original screen size
6 back to Designer
Welcome screen to Runtime is theSites (page 25) tab. Alternatively it is possible to open the default screen
in Runtime directly using URL link in the browser, see "Site Runtime Link" button (page 25)
6 back to Runtime
List of sites
Runtime link – Link to the default screen of a site. To use this link the particular site has to be
unlocked
Lock/Unlock Site button - If a site is locked, it opens the dialog to unlock it, otherwise it locks the
site
License Activation button – It is disabled if the site complies with the current license. Otherwise it
opens the "License Activation" dialog.
4.3 Setpoints
The dialog is used for monitoring and editing of any setpoint of any device configured in a site.
The dialog is divided into 3 columns:
Devices column
Lists all devices configured in a site
Click on the desired device to list its groups in the Groups column
A device, which is not connected, is disabled and cannot be selected
The first connected device is pre-selected by default, when the dialog is opened
Groups column
Lists all groups of the selected device
Click on the desired group to see its data points in the "Data Points" column
Disabled – the setpoint cannot be edited because the currently logged in user doesn't have the
required permission or "Edit Value" dialog for this type of a setpoint is not supported yet
Hidden (Forcing icon visible) – the setpoint cannot be edited because it is actively forced
Current value of the setpoint with the possibility to change the value
Confirms and writes the new value to the device and closes the dialog
4.5 History
The dialog shows the overview of history records for multiple devices configured in a site.
It is possible to open the History dialog:
from the Preview tab in Designer, see Preview on page 47
from Runtime, see Runtime on page 50
Once the dialog is opened, the history is loaded in parts by infinite scroll.
History records are ordered chronologically by the date and time from the most recent history record to the
oldest one. Make sure to set the correct date & time setpoints in each ComAp controller to have records
ordered chronologically.
The history table is automatically updated when:
the most recent history record (with No. 0) is visible and a new record arrives
the History dialog is opened
the table is scrolled up to the most recent history record and the page is not yet loaded in the cache
the table is scrolled down to the oldest history record and the page is not yet loaded in the cache, new
records should be loaded by infinite scroll
Recorded values are divided into columns by values or grouped into one column in case of
the text record
Note: The number of history records is limited. The maximum number of records is 25.000 in total for all
sites. The oldest records beyond this limit will be automatically removed.
Click on any of the rows in the table to set focus. The row with focus is highlighted and when the history table
is updated (and the table still contains the focused row) the table is scrolled, so the focused row is always
visible. Sometimes it can happen that the focused row is not loaded on the table update. In that case all the
rows lose their focus and the table is not scrolled anywhere.
The history toolbar indicates connection status of used devices. History records that belong to disconnected
devices display indication on the Device column. Be aware that the history records from disconnected
devices are most likely not complete.
Filter icon - Opens the filter options. Green icon indicates an active filter.
Filter options
Export History - Exports history. It shows In-progress indication (page 59) while the
export is in progress in the background.
Once the history export is completed and ready to download, a notification message with the Download
button will be displayed. The file will be either downloaded automatically to the destination folder or the "Save
as" dialog will appear depending on your browser settings. The notification message can be manually closed
once downloaded, otherwise it will be closed automatically in 10 minutes.
IMPORTANT: It is not possible to recover the site password, therefore it is recommended to take
precautions against the loss of the password.
6.1.2 Scale
Settings of Scale are supported for instruments:
Analog Meter
Bar Graph
Trend
There is possible to configure Type of source for Warning limit value as:
Data point
Analog Meter and Bar Graph only
Constant
Default
Default button Reset the color configuration values to the default values.
Close the configuration for the color parameters and saves the
Save button
configuration.
Close the configuration for the color parameters. The
Cancel button
configuration is not saved after being closed.
The Alarm list instrument is used to display alarms on a selected device. Alarm List contains following
information:
Number of alarm records Active / unconfirmed (alarms marked with asterisk) / total
Editor properties
Category Name Note Input type Range Default
1 .. 64
Name User name of the instrument Text UNICODE *)
chars
0 .. screen
width –
X Number
instrument
[X, Y] coordinates of top left width
corner 0 .. screen
height –
General Y Number
instrument
height
200 ..
Width Number 320
screen width
Width and height of the
100 ..
instrument
Height Number screen 320
height
Keep Aspect Keeps aspect ratio during
Checkbox Unchecked
Ratio resizing
Device that instrument is List of
Device Select
connected to devices
Alarm List source
Some devices have standard Standard
Source Data point
and ECU alarms in 2 separate alarm
Data Point selection
lists, others have just 1 alarm list list/ECU
(page 63)
(the Standard one), which alarm list
displays all alarm types together.
Background color of the header.
Color
Background The transparent color can be set
Header picker #3B415B
Color to make the background
(page 65)
invisible.
Design Border Color Border color of the instrument. Color #3B415B
Note: *)
{Instrument Type} * {Last number +1 of instruments according type}
Name
Value
Unit
Analog meter is a rounded meter with a pointer. It displays the current value of the selected data point
graphically. Warning / Shutdown limits can be indicated on the analog meter with yellow (warning) / red
(shutdown) scale color by setting up the warning limits.
In case the value (pointer) is out of the scale range the pointer stops 15 degrees below / above the scale
limit.
Upper scale limit (Scale 100%) can be expanded to 125% of its original value using the Expand Scale
option configured in the Scale dialog.
Based on Scale 0%
type:
Enter a
Scale 0% Scale (page
constant
Value 62)
Select a data
point
(not available
Note: *)
{Instrument Type} * {Last number +1 of instruments according type}
Editor properties
Category Name Note Input type Range Default
User name of the
Name Text 1 .. 64 UNICODE char *)
instrument
0 .. screen width –
X Number
[X, Y] coordinates instrument width
of top left corner 0 .. screen height –
General Y Number
instrument height
(expanded)
100 .. screen height –
Width Number 200
Width and height of instrument height
the instrument 100 .. screen height –
Height Number 200
instrument height
Keep Aspect Keeps aspect ratio Checkbox Unchecked
Note: *)
{Instrument Type} * {Last number +1 of instruments according type}
6.5 Breaker
Instrument that indicates the status of a generator/mains/bus circuit breaker.
Device is synchronizing
Breaker's arm is flashing a configurated active and inactive
color as well as regularly closing and opening at the same
Synchronizing time.
*The image is for illustrative purposes only and may differ
from the actual visualization based on the current state of
the device and the configuration of breaker's properties.
Breaker mode required by device does not match the current
breaker state
Unsafe open – breaker is open, but the device requires
Unsafe
breaker to be closed
Unsafe closed – breaker is closed, but the device requires
breaker to be open
Note: *)
{Instrument Type} * {Last number +1 of instruments according type}
This button is used to open or close a breaker. The breaker type depends on the selected Source.
Note: *)
{Instrument Type} * {Last number +1 of instruments according type}
6.7 Bus
Note: The color reflects the status of the respective LEDs of the controller (yellow = green + red) and
depends on the controller type.
Note: *)
{Instrument Type} * {Last number +1 of instruments according type}
6.8 Busbar
Busbar instrument is used in wiring diagrams. It can be linked to a LED type data point to indicate its status in
color.
Note: *)
{Instrument Type} * {Last number +1 of instruments according type}
Shortcut Action
Keeps horizontal or vertical orientation of the busbar when drag &
drop.
Shift + Mouse down -> Mouse move
Flips the busbar orientation according to the mouse moving to
horizontal or vertical.
Keeps aspect
Keep Aspect
ratio during Checkbox Unchecked
Ratio
resizing
Device that
Device instrument is Select List of devices
connected to
List of all
commands
Source
supported by Data point
Data Point the selected selection List of commands
device (e.g. (page 63)
UserButton 2 –
ON/OFF)
Note: *)
{Instrument Type} * {Last number +1 of instruments according type}
The Data Row instrument is used to display a value of a data point (device value or setpoint) in a text form.
Data Row can be configured as editable if its Data Point property is set to a setpoint.
Data point name, value and unit can be displayed or just some of them.
Different data types are supported:
Number – eg. generator frequency value
Text – eg. engine state ("not ready")
Editor properties
Category Name Note Input type Range Default
1 .. 64
Name User name of the instrument Text UNICODE *)
chars
0 .. screen
width –
X Number 0
instrument
[X, Y] coordinates of top left width
corner 0 .. screen
General height –
Y Number 0
instrument
height
15 .. screen
Width Number 320
Width and height of the width
instrument 15 .. screen
Height Number 48
height
Keep Aspect Keeps aspect ratio during
Checkbox Unchecked
Ratio resizing
Device that instrument is List of
Device Select
connected to devices
Data source that instrument is
Source Data point
connected to (e.g. Nominal
Data Point selection
Power setpoint, Generator
(page 63)
frequency value, etc.)
Label Font Font size of the label shown in
Number 6-200 px 14 px
Size compact mode.
Font Size Font size of the text Number 6-200 px 18 px
Text
Color
Text Color Color of the text picker #FFFFFF
(page 65)
Enables or disables possibility to
Editable edit value. Visible only for Checkbox 0/1 1
setpoint data points.
Compact mode on / off.
Compact The Compact mode has a tile (2 Checkbox 0/1 0
Design
rows) design.
Data point name displayed on /
Label Checkbox 0/1 1
off
Data point value displayed on /
Value Checkbox 0/1 1
off
Note: *)
{Instrument Type} * {Last number +1 of instruments according type}
6.11 Engine
The Engine instrument represents the status of an engine, which is indicated by color:
Green – OK
Yellow – warning
Red – shutdown
Grey – inactive
Note: The color reflects the status of the respective LEDs of the controller (yellow = green + red) and
depends on the controller type.
Editor properties
Category Name Note Input type Range Default
1 .. 64 UNICODE
Name User name of the instrument Text *)
char
0 .. screen width –
X Number 0
instrument width
General [X, Y] coordinates of top left corner
0 .. screen height –
Y Number 0
instrument height
Width Number 10 .. screen width 40
Width and height of the instrument
Height Number 10 .. screen height 40
Source Device Device that instrument is Select List of devices
Note: *)
{Instrument Type} * {Last number +1 of instruments according type}
Editor properties
Category Name Note Input type Range Default
{Instrument Type} * {Last
1 .. 64
User name of the number +1 of
Name Text UNICODE
instrument in*)struments according
chars
type}
0 .. screen
width –
X Number 0
instrument
[X, Y] coordinates of top width
General
left corner 0 .. screen
height –
Y Number 0
instrument
height
10 .. screen
Width Number 40
Width and height of the width
instrument 10 .. screen
Height Number 40
height
Device that instrument is List of
Device Select
connected to devices
Source Engine – Fault Reset Data point
Data
command (if available), selection
Point
the property is read-only (page 63)
6.13 Generator
The Generator instrument represents the status of a generator which is indicated by color:
Green – OK
Yellow – warning
Red – shutdown
Grey – inactive
Note: The color reflects the status of the respective LEDs of the controller (yellow = green + red) and
depends on the controller type.
Editor properties
Category Name Note Input type Range Default
1 .. 64 UNICODE
Name User name of the instrument Text *)
char
0 .. screen width –
X Number 0
instrument width
General [X, Y] coordinates of top left corner
0 .. screen height –
Y Number 0
instrument height
Width Number 10 .. screen width 40
Width and height of the instrument
Height Number 10 .. screen height 40
Device that instrument is connected
Device Select List of devices
to
Generator (or empty if not supported Data point automatically
Data
or found in the selected device), the selection selected along with
Point
property is read-only (page 63) device if available
Link Link Link to another screen in site Select Screen selection No link
Note: *)
{Instrument Type} * {Last number +1 of instruments according type}
Editor properties
Category Name Note Input type Range Default
1 .. 64 UNICODE
Name User name of the instrument Text *)
chars
0 .. screen width
X Number – instrument 0
[X, Y] coordinates of top left corner width
General 0 .. screen height
Y Number – instrument 0
height
Width Number 10 .. screen width 40
Width and height of the instrument
10 .. screen
Height Number 40
height
Device that instrument is
Device Select List of devices
connected to
Source Engine – Horn Reset command (if Data point
Data
available), the property is read- selection
Point
only (page 63)
Note: *)
{Instrument Type} * {Last number +1 of instruments according type}
6.15 IFrame
Instrument that represents inline frame for embedding another content. With the IFrame instrument it is
possible to have for example an instruction video embedded in a custom screen.
To configure IFrame instrument, user has to set its Url (src) property to a valid source path to a content that
supports embedding by an iframe element.
Here is an example how to insert an IFrame Url for a video:
3. Select and copy only the src value of generated IFrame component
4. Paste the src value to the Url (src) property of an IFrame instrument in the Editor
If there is a configured source for the instrument, the path is visible within the top of the instrument
container in Editor. This information can not overlap instrument size so only first path row is visible.
If no source is set or the source is not accessible the IFrame instrument content in Runtime or Preview is
empty.
Editor properties
Category Name Note Input type Range Default
1 .. 64
User name of the
Name Text UNICODE *)
instrument
chars
0 .. screen
width –
X Number 0
General instrument
[X, Y] coordinates of top width
left corner 0 .. screen
height –
Y Number 0
instrument
height
Note: *)
{Instrument Type} * {Last number +1 of instruments according type}
6.16 Image
Instrument that represents an image. Use the Image instrument from the Instruments panel, or simply an
image from the Image Gallery for which the Source property is already set.
Note: *)
{Instrument Type} * {Last number +1 of instruments according type}
Click Save to set the selected image source or Cancel to close dialog without changes.
Some images are pre-defined by default, custom images can be also added to the Image Gallery
Use filter by packs or search by file name or tags function to explore gallery
6.17 LED
LED instrument is used to monitor states (values) of binary communication objects. User can select color and
which bit value (0 or 1) is for "On" state.
Note: *)
{Instrument Type} * {Last number +1 of instruments according type}
The Line instrument is defined by two points. The line can also be diagonal.
Editor properties
Category Name Note Input type Range Default
User name of the 1 .. 64 UNICODE
General Name Text *)
instrument chars
0 .. screen width –
X1 Number
[X, Y] coordinates of the instrument width
start point 0 .. screen height –
Y1 Number
instrument height
Position
0 .. screen width –
X2 Number X1 + 100
[X, Y] coordinates of the instrument width
end point 0 .. screen height –
Y2 Number Y1
instrument height
Line
Width of the line Number 1 .. 100 2
Width
Design
Color picker Gray
Color Line color
(page 65) (#7c7c7c)
Note: *)
{Instrument Type} * {Last number +1 of instruments according type}
Shortcut Action
Keeps horizontal or vertical orientation of a line when drag & drop.
Shift + Mouse down -> Mouse move Flips the line orientation according to the mouse moving to
horizontal or vertical.
6.19 Load
The Load instrument represents the status of the load, which is indicated by color:
Note: The color reflects the status of the respective LEDs of the controller (yellow = green + red) and
depends on the controller type.
Editor properties
Category Name Note Input type Range Default
1 .. 64 UNICODE
Name User name of the instrument Text *)
char
0 .. screen width –
X Number
instrument width
General [X, Y] coordinates of top left corner
0 .. screen height –
Y Number
instrument height
Width Number 10 .. screen width 40
Width and height of the instrument
Height Number 10 .. screen height 40
Device that instrument is
Device Select List of devices
connected to
Source Load (or empty if not supported or Data point automatically
Data
found in the selected device), the selection selected along with
Point
property is read-only (page 63) device if available
Link Link Link to another screen in site Select Screen selection No link
Note: *)
{Instrument Type} * {Last number +1 of instruments according type}
6.20 Mains
The Mains instrument represents the status of mains, which is indicated by color:
Green – OK
Yellow – warning
Red – shutdown
Grey – inactive
Note: The color reflects the status of the respective LEDs of the controller (yellow = green + red) and
depends on the controller type.
Note: *)
{Instrument Type} * {Last number +1 of instruments according type}
The Markdown Text instrument is used for a custom text. It supports the Markdown (markup language) and
some HTML syntax, which allows text formatting.
The Markdown Text instrument provides a validation of the inserted input, so it is not possible to process any
XSS vulnerabilities. Any part of the text that is evaluated as a possible security threat is automatically ignored.
Example: "javascript:...", "<script>/*+...+*/</script>" or "<iframe>...</iframe>".
Note: *)
{Instrument Type} * {Last number +1 of instruments according type}
# Heading level 1
## Heading level 2
### Heading level 3
Heading
#### Heading level 4
##### Heading level 5
###### Heading level 6
1. List level 1
Ordered list
2. List level 2
Ordered list
(Start 57. List level 57
numbering 1. List level 58
with offset)
| Col 1 | Col 2 |
| Col 1 | Col 2 |
Table | ------: | -----------: |
(Right
| Row 1 | Row 1 value |
aligned
columns) | Row 2 | Row 2 value |
| Row 3 | Row 3 value |
Mode Selector shows all available controller modes (depends on the device type). User can change the
controller mode (setpoint) by clicking any available mode on Mode Selector (there is a visual feedback -
button pressed).
Mode requested by user, different from active mode and not-yet active is
highlighted
Note: *)
{Instrument Type} * {Last number +1 of instruments according type}
Number of alarm records Active / unconfirmed (alarms marked with asterisk) / total
Editor properties
Category Name Note Input type Range Default
1 .. 64
Name User name of the instrument Text UNICODE *)
chars
0 .. screen
width –
X Number 0
instrument
[X, Y] coordinates of top left width
corner 0 .. screen
General height –
Y Number 0
instrument
height
300 .. screen
Width Number 320
Width and height of the width
instrument 150 .. screen
Height Number 320
height
Keep Aspect Keeps aspect ratio during
Checkbox Unchecked
Ratio resizing
Background color of the
Color
Background header. The transparent color
Header picker #3B415B
Color can be set to make the
(page 65)
background invisible.
Note: *)
{Instrument Type} * {Last number +1 of instruments according type}
6.24 Rectangle
Editor properties
Category Name Note Input type Range Default
1 .. 64
User name of the
Name Text UNICODE *)
instrument
char
0 .. screen
width –
X Number
instrument
[X, Y] coordinates of top width
General left corner 0 .. screen
width –
Y Number
instrument
width
5 .. screen
width –
Width Number 200
instrument
width
Note: *)
{Instrument Type} * {Last number +1 of instruments according type}
The Start Engine button is used to star an engine (it sends the Start command to the selected device). The
button conveys 2 possible states:
Enabled – green color
Disabled – gray color (eg. "Access lock" state applied on the button)
Editor properties
Category Name Note Input type Range Default
1 .. 64 UNICODE
Name User name of the instrument Text *)
char
0 .. screen width –
X Number
[X, Y] coordinates of top left instrument width
General
corner 0 .. screen height –
Y Number
instrument height
Width and height of the
Width Number 10 .. screen width 40
instrument
Note: *)
{Instrument Type} * {Last number +1 of instruments according type}
The Stop Engine button is used to stop an engine (it sends the Stop command to the selected device). The
button conveys 2 possible states:
Enabled – red color
Disabled – gray color (e.g. "Access lock" state applied on the button)
Editor properties
Category Name Note Input type Range Default
1 .. 64 UNICODE
Name User name of the instrument Text *)
chars
0 .. screen width –
X Number
[X, Y] coordinates of top left instrument width
General
corner 0 .. screen height –
Y Number
instrument height
Width Width and height of the Number 10 .. screen width 40
Height instrument Number 10 .. screen height 40
Device that instrument is
Device Select List of devices
connected to
Source Engine – Stop command (if Data point
Data
available), the property is read- selection
Point
only (page 63)
Note: *)
{Instrument Type} * {Last number +1 of instruments according type}
Editor properties
Category Name Note Input type Range Default
User name of the 1 .. 64 UNICODE
Name Text *)
instrument chars
0 .. screen width –
X Number
[X, Y] coordinates of top instrument width
left corner 0 .. screen height –
Y Number
General instrument height
Width Number 100 .. screen width 320
Width and height of the
100 .. screen
Height instrument Number 320
height
Keep Aspect Keeps aspect ratio during
Checkbox Unchecked
Ratio resizing
Device that Trend is
Device Select List of devices
connected to
Source Data point
A source for Trend plotting Filter: numeric or
Data Point selection
data (eg. Actual power) binary data points
(page 63)
One of the following types
can be used:
Constant – numeric
value defined by
Scale 0% Scale
Scale user Constant/Default Default
Type (page 62)
Default – low limit of
the Source data
point
Note: *)
{Instrument Type} * {Last number +1 of instruments according type}
Instrument that represents a connection of 2 busbars (wires). It can be linked to a LED type data point to
indicate its status in color.
Note: *)
{Instrument Type} * {Last number +1 of instruments according type}
Analog meter
Warning limit (yellow color) is
automatically set from Nominal
power Setpoint value up
Scale is defined from 0 kW to
125% value of Nominal power
Setpoint.
Engine State
Breaker State
Generator Frequency
Alarm List
Mode selector
Analog meter
Warning limit (yellow color) is
automatically set from Mains Import
value
Scale is defined from 0 kW to 125%
value of Mains Import.
Breaker State
Timer Text
Timer Value
Mains Voltage L1
Mains Current L1
Bus Frequency
Alarm List
Mode selector
Analog meter
Warning limit (yellow color) is
automatically set from Bus Left Import
value
Scale is defined from 0 kW to 125%
value of Bus Left Import.
Breaker State
Timer Text
Timer Value
Alarm List
Mode selector
Analog meter
TotAvlPnom
Aux load
CURR. PwrBand
TotRunPact Q
NEXT PwrBand
Alarm List
Fault Reset
Mode selector
Analog meter
Warning limit (yellow color) is
automatically set from Bus Left Import
value
Scale is defined from 0 kW to 125%
value of Bus Left Import.
Breaker State
Timer Text
Timer Value
Alarm List
Engine State
Timer Text
Timer Value
Run Hours
CPU Temperature
Speed Request
Battery Voltage
Oil Press
DEF Level
Alarm List
Fault Reset
Mains
Breaker (MCB)
Breaker (GCB)
Generator
Start Engine
Stop Engine
Mains
Breaker (MCB)
Breaker (GCB)
Generator
Start Engine
Stop Engine
Note: DP = data point
Breaker (GCB)
Start Engine
Stop Engine
Generator
Bus
Breaker (MCB)
Mains
Start Engine
Stop Engine
Note: DP = data point
Breaker (MGCB)
Bus
Breaker (MCB)
Mains
Start Engine
Stop Engine
Note: DP = data point
BTB
Bus (Left)
Bus (BTB)
Bus (Right)
Engine
Start Engine
Stop Engine
PSC
Load
Bus
Communication modules
Communication
Default template Instrument
module
InteliGateway
Device name – defined by
InteliFieldbus user
Gateway
Identification text
IMPORTANT: Remember to verify whether your personalized color settings are not interfering
with the indication of error states for any of your instruments.
6 back to Troubleshooting
Incorrect device
connection details
Unknown device or
Unknown device or unknown device
application application. For supported
devices and applications
see Supported ComAp
devices on page 17.
Note: The version of the database is different than the version of InteliSCADA. The version of the
database increases only when data schema changes.
6 back to Troubleshooting