Chapter 3: Configuration of Prerequisites
Last updated
Last updated
This chapter describes the configurations of master data that are associated with IBMS application and other necessary configurations. Configurations will be done by the Application administrator.
It is recommended to follow the below stated sequence of configurations in IBMS application as some data become Prerequisites for some other configurations. Most of the configurations have been described under this chapter, while some of the configurations found under Chapter 4 – Escalations and Chapter 5 – Register.
In IBMS application, the following tasks have to be carried out beforehand:
Configure Subsystems
( Described under Chapter 4 – Escalations)
(Described under Chapter 4 –Escalations)
( Described under Chapter 5 – Register)
( Described under Chapter 5 –Register)
( Described under Chapter 5 –Register)
An IBMS Zone is a wrapper around a “Site” which logically groups equipment on a Site.
This section describes the following:
On the Zones search page, click the New Zone link. A dialog box to configure a new Zone appears.
Select the Location from the Location list box.
In the Zone ID box, type the name of the Zone that you want to configure.
On the Zones search page, click the Zone ID you want to edit. Detailed page of the selected Zone will appear.
Zone Details tab displays IBMS Zone details.
Edit the Zone ID as required.
Location cannot be changed. If required, create a new Zone with desired Site.
Click Save. Click Cancel to discard the changes.
Subsystem Interface Connector tab displays the IBMS Subsystem Interface configuration details.
Equipment tab displays the assets that are associated with the respective Zone.
Go to the Zones Search page and click the Zone ID you want to delete. Detailed page of the selected Zone will appear.
A message box to confirm deletion appears. Click Delete to confirm deletion of the Zone, or to close the message box without deleting, click Cancel. If the Zone is in use, a message will appear stating that it cannot be deleted.
On the Zones search page, to search by the Zone name, type the name of the Zone you want in the Search Zones box. Matching record/records will be filtered as you type.
To filter Zones by the Site, select the required Site from the box on the top right.
Generate Report: This is used to view the filtered results on a required format as a report.
In the Format box, select the type of format(PDF/Word/Excel/Excel raw) you want.
Click Generate Report. IBMS Zones Report will open with the filtered IBMS zones.
To go to the detailed page of a Zone in the search results, click its name.
Zone Details tab shows the top-level location (Site) that this zone is configured for.
Subsystem Interface Connector tab displays the IBMS Subsystem Interface configuration details.
Equipment tab lists all the available equipment, relevant to the selected Zone. Clicking on the equipment name will navigate to the quick info page. Clicking on the Equipment name on the quick info page will show the Asset details.
Alarm Class is used to configure alarm Escalation Times of 5 Escalation Levels of each Severity for Working Hour Escalations and After Hour Escalations. E.g. If the Severity of an Alarm is Critical, you need to configure times of each Escalation Level which will be used as a base to send notifications to Alarm Notification Groups once an Alarm with the respective Severity is triggered. You need to configure the Escalation Times of Severity for Working Hour Escalations and After Hour Escalations.
This section describes the following:
On the Alarm Classes search page, click the New Alarm Class link on the top right corner. New Alarm Class configuration window appears.
In the Alarm Class Name box, type a unique and appropriate name for the new Alarm Class and type in a description to the alarm class in the Description box.
Click Add to create the new Alarm Class. A new Alarm Class will be created and its detailed page will open.
To configure the Alarm Escalation Levels for each Severity for working hours, (Severity-wise Level configuration) go to the “Working Hour Escalations” tab.
Type the required Alarm Escalation times of rest of the Escalation levels and click Update.
Configure the ‘After Hour escalation levels’ of each Severity under the “After Hour Escalations” tab as you configured the escalation levels under ‘Working Hour Escalations’.
On the Alarm Classes search page, search for the required Alarm Class and click the Alarm Class name that you want to edit. Alarm Class detail page will open.
Edit the Alarm Class details required and click Save.
To edit the Working Hour and After Hour escalations, go to the respective tabs.
On the Alarm Classes search page, search for the required Alarm Class and click the name of it to go to its detailed page.
Alarm Severity is used to define the importance of each Alarm. Each Alarm has its Severity level. You can use the Alarm Severities to help you decide the order in which you should attend (prioritize) and investigate triggered alarms.
Typical Alarm Severities
Alarm Severities are color coded by configuring a color code for each Severity level. This is helpful for easy identification of alarms.
E.g. Severity “Critical” Color Code: “Red”
This section describes the following:
On the Alarm Severities page, click the Add New Alarm Severity link.
Type the name of the Alarm Severity (e.g. Critical).
Type its Color code (e.g. FF0000).
Enter the Severity Weight (e.g. 1).
Click Add.
On the Alarm Severities page, hover over the required Alarm Severity and click the Edit icon.
Modify details as required and click Save.
On the Alarm Severities page, click the relevant Delete icon displayed along with the Alarm Severity you need to delete.
Click Delete.
If the Alarm Severity is in use, you will not be allowed to delete it.
System Types are used as a grouping method to group IBMS System Pages. System Type will be used to filter System Pages based on System Types (e.g. BMC, LCS, ACS, etc.) System Types should be configured before registering Systems.
This section describes the following:
On the System Types search page, click the New System Type link.
On the System Type configuration page, type the name of the System Type and a description about it.
Click Create. Once created, its detailed page will open.
On the System Types search page, click the required System Type name to go to its detail page.
Modify details as required and click Save.
If the System Type is in use, you will not be allowed to delete it.
Equipment Template is a template for a collection of points for a particular type/brand/model of Equipment. Equipment Template logically groups points for a particular Equipment type.
This section describes the following:
On the Equipment Templates search page, click the New Equipment Template link. New Equipment Template dialog box appears.
In the Equipment Template box, type a unique and appropriate name for the new Equipment template.
In the Description box, type a suitable description on Equipment template.
On the Equipment Templates search page, click on the Equipment Template you want to edit.
Edit the name of the Equipment Template as required.
Edit the Description as required.
Enable Real-time Summary GUI:
Click Save. Click Cancel to discard the changes.
Edit the Point Templates tab on the Equipment Template.
Under RT GUI tab,
To delete an Equipment Template;
On the Equipment Templates search page, click the Equipment Template that you want to delete, to go to its detailed page.
If the selected Equipment Template is in use, a popup box appears with the message “This Equipment Template is in use and cannot be deleted”.
On the Equipment Templates search page, type the name of the required Equipment Template in the Search Equipment Templates box. Matching record/records will be filtered as you type.
To go to the detailed page of an Equipment Template in the search results, click its name.
Details tab shows the details of the selected Equipment Template.
Point Template is a template for a particular Point on Equipment Template. After configuring an Equipment Template, you need to configure Point Templates for it.
This section describes the following:
This section helps you to configure Point Templates for Equipment Templates. These Point templates will be the points for equipment registered using the respective Equipment Template in the system.
Search and click the required Equipment Template to which you want to add a new Point Template.
Then its Point Template detail page will appear. Click the Point Templates tab.
In the Point Name box, type a unique and appropriate name for the new Point Template.
In the Data Type list box, select the relevant Data Type of the Point (Value, Binary, Text or Multi-state).
Go to the relevant Equipment Template detail page 🡪Point Template tab.
Click the name of the Point Template you want to edit. Details page of the selected Point Template will appear.
Go to Details tab.
Edit the Point Template name if required.
Type a description about Point Template under the Point Template Description box.
Click Save to save the changes in the General section.
Data Type
Data Type of the Point
The Data Type can be any of these types (Value, Binary, Text or Multi-state).
Read/Write State
Select Read or Write from the list box to denote the Point as read-only or write-only.
Units
Select the unit of measurement from the supported units in the combo box. (e.g. Point Template : Return Air Temperature, Units: Celsius (C) )
Valid Range (L:H)
This range will be the Valid Range (Low: High) of Point values. SSIF will send only Point Values within this valid range and rest of the Point values will be ignored. E.g. 0.01 :1)
Display Range (L:H)
Display Range shows the formatted ‘Valid Range’ to give a proper look to the Point Values sent by SSIF to make it more convenient in usage (e.g. Valid Range is multiplied by 100 to make it ‘Display Range’). Display Range (Low: High) e.g. 1:100
Round Off
Point Value will be rounded off up to this decimal point e.g. Round Off value is 1 -> if the real value is 2.46, the value will be rounded off to 1 decimal point and make it 2.5
Deadband
If the difference between the new Point Value and the existing Point value is plus or minus the Deadband, the new Point Value will be ignored. If the difference of the new Value falls between the deadband, the new Point value will be ignored. E.g. 0.5 and -0.5
Polling Frequency
Frequency of polling in seconds for the value you monitor from Sub System Interface.
Also apply for overridden points
Select this check box to apply the settings under Properties for overridden points
Reset Value – This is used to configure the Consultant recommended default value for Point Template.
Note: You can override this consultant recommended Reset value at each Point level in the respective Point Template according to your requirement.
Enter Previous Reset Value, Configured User and Configured Date Time.
Also apply for overridden points: Select this check box to apply the settings under Reset Value Configuration for overridden points.
Click Save.
Use Controller Based Trends - select this check box to use the trends that get recorded at Controller level.
Note: If “Use Controller Based Trends” check box is selected, “Sample Interval” and “Change of Value (COV) trending” fields will be hidden.
Sample Interval (trending) – Trending sample interval frequency in minutes
Change of Value (COV) trending – Select this checkbox to use COV (Change of Value) of point to trend instead of poling for given trending intervals.
Also apply for overridden points - Select this check box to apply the settings under Trend section for overridden points.
Click Save.
Alarm configuration under Point Templates varies due to the Data Type (e.g. Binary, Text, Value, Multi-state) of Point Template.
Prerequisites: Alarm Class and Alarm Severity
Access Point Template search page via Equipment Template Search page.
Click the relevant Equipment Template which has the required Point Template.
Click the Point Templates tab.
Access Point Template via Point Template Search page. (Settings🡪 View🡪 Point Templates)
Click the name of the Point Template you want and navigate to Point Template details page. Scroll down and go to the Alarm section.
Select the relevant Alarm Severity from the Alarm Severity box. Alarm Severities should be configured beforehand.
If the Data Type of the selected Point is “Value”;
In the ‘Alarm When’ drop-down box, select the relevant condition. (Equals, Is Not Equal To, Greater, Greater or Equal, Less, Less or Equal, Between, Between or Equal and Controller Based Alarms).
Type in the relevant value/values in Alarm When textbox according to the selected above logical expression. E.g. If you have selected “Between” for “Alarm When”, you need to type two values to denote the range.
In the ‘Alarm When’ drop-down box, select ‘Controller Based Alarm’ if the respective alarm is based on controllers.
If the Data Type of the selected Point is “Binary”;
If the alarm is a ‘Controller based alarm’, select the ‘Controller based Alarm’ from Alarm When drop-down box.
If the alarm is not a ‘Controller based alarm’, in the Alarm When textbox, type the relevant binary value (0 or 1) of the Alarm point.
If the Data Type of the selected Point is “Text”;
In the Alarm Value box, type the required text to be checked as the condition.
In the Text Compare Mode box, select the mode that you want to compare the text with. (e.g. Whether to see the given Alarm Value is ‘Not in’ or whether to see it Contains the Alarm Value)
If the Data Type is ‘Multi-State’;
In the Alarm Value box, type the relevant value which is 0 – N.
In the Alarm Message box, type the required alarm message to be relayed.
Alarm Deadband
Alarm will be triggered only if the Alarm Value goes above this value (Alarm Deadband). E.g. If alarm trigger value is >24 and Deadband is 0.5 then the alarm should get triggered only if the value goes above 24.5.
Clearance Deadband
Alarm will be cleared only if the Alarm value goes below this Value named as “Clearance Deadband”.
E.g. If alarm trigger value is >24 and Clearance Deadband is -0.5 then the alarm should get cleared only if the value goes below 23.5.
Alarm Delay
Alarm will be triggered only after the time configured as ‘Alarm Delay’ even though the Alarm conditions are met.
Clearance Delay
Alarm will be cleared only after the time configured as ‘Clearance Delay’.
Enable only for Working Hours
Alarm will be triggered only during the period configured as ‘Working Hours’.
Enable only for non-working hours
Alarm will be triggered only during the period configured as ‘non-working hours’.
Go to the relevant Equipment Template detail page 🡪Point Templates tab.
Click the name of the Point Template you want and go to its details page.
Edit the Alarm details as required.
When an Alarm Condition is added or changed at Point Template level or Point level, the system will validate the condition and pop-up validation messages if there are Active alarms for that particular Alarm Condition.
Validation confirmation messages will be popped- up due to the following situations;
When changing an alarm condition while there are active alarms
It is required to check whether there are active alarms in the system for the respective alarm condition. If available, user should be notified and get the confirmation to disable the active alarms.
When adding Controller based alarms while having iviva alarms enabled
When a Controller Based Alarm is added/enabled for a particular point template or point, it is required to have all other iviva based alarms to be disabled. E.g. Validation Confirmation message at Point Template level: “There are enabled iviva alarms for this point template. Please disable/remove them before adding a controller based alarm.”
When adding an iviva alarm while having enabled Controller based alarms
System will allow to add/enable iviva based alarms, only if there are no Controller Based alarms or if the Controller Based alarms are disabled.
The above steps should be carried out to prevent the following issues;
If you change an alarm condition while there are active alarms, current active alarm(s) gets junked and it may cause the point not to become alarmed again.
SSIFs cannot handle both iviva and Controller based alarms at once, because controller based and iviva based alarms are handled in two channels.
Go to the relevant Equipment Template detail page 🡪Point Templates tab.
Click the name of the Point Template you want and go to its details page.
If the respective alarm is in use, the system will not allow the user to delete it.
To delete a Point Template;
Go to the relevant Equipment Template detail page 🡪Point Templates tab.
A message box to confirm deletion appears. Click OK to confirm deletion of the Point Template, or to close the message box without deleting, click Cancel.
Click the name of the Equipment Template, which contains the Point Template.
Click the Point Templates tab and click a name of a Point Template to go to the detailed page.
To search by the Point Template name, in the Search Point Templates box, type the name of the required Point Template. Matching result/results will be displayed as you type.
To filter by any Equipment Template that Point Template belongs to, select the relevant Equipment Template name in the Equipment Template box.
Click the name of a Point Template to go to its detailed page.
Interface Driver Type contains the common protocol configuration settings for a particular protocol for an interface.
This section describes the following:
On the Interface Driver Types search page, click Add Interface Driver Type link.
In the Driver Type box, type a unique and appropriate name for the new Interface Driver Type.
In the Parameter List box, type the relevant comma separated parameters.
Click Create. New Interface Driver Type will be created and its detailed page will open.
On the Interface Driver Type search page, click the required Driver Type to be edited. Its detailed page will open.
Edit necessary details.
Click Save.
On the Interface Driver Type details page, Binaries tab is used to upload the SSIF Binary files relevant to the respective Interface Driver Type.
To upload a Binary File;
On the Interface Driver Type detail page, click the Binaries tab.
Drag and drop the relevant SSIF Binary file (.Zip file) onto the given area on the page above the Upload button; or click on the given area to search and select for the relevant Binary file.
Click Upload.
Assembly Name (.exe name of the Interface), Interface Version and Description (if available in the Binary file) fields on the GUI will be automatically filled up by obtaining the respective details from the uploaded Binary file.
On the Interface Driver Type Search page, click the name of the Interface Driver Type that you need to delete, to go to its detailed page.
If the Interface Driver Type is in use, you cannot delete it.
An Interface defines a communication channel between a Point and a Sub System Interface.
This section describes the following:
On the Interfaces search page, click the Add a new Interface link.
In the Interface ID box, type a unique and appropriate name for the new Interface.
In the Driver Type box, select the relevant Interface Driver Type. Interface will be created based on the selected Interface Driver Type.
In the IBMS Zone box, select the Zone, which is associated with the respective Interface.
Click Create to create the new Interface. A new Interface will be created and its detailed page will open. Except Proxy Server details, other fields on the Interface Details page will be filled with default values.
The following table shows the fields that appear on the Interface Details page. These are the values that will be applied to Interface.
Configuration Refresh Interval (seconds)
The period of time in seconds between two events in checking the configuration change in Equipment Point address. This checking will be done by the Interface.
On-Demand (Default Value=0 means On Demand Support is Enabled)
If On Demand Support is enabled, Interface requests data from Subsystem only when real-time values of equipment are monitored. If it’s not On Demand (On Demand Support is disabled), the Interface will continuously request data from Subsystem.
Max Real-Time Queue Limit
Value Changes in Points will be sent as a batch to the Interface. This “Max Real-Time queue limit” field defines the maximum Value Change count that will be sent at one request.
e.g. Max Real-Time Queue Limit= 200 means, though there are more than 200 value changes in the queue, only 200 value changes will be sent to the Interface as 200 is the maximum count.
Max Resend Queue Limit
There will be a ‘Resend queue’ to queue Value Changes which will be used if there is a failure in sending normal Value Changes. A warning will be logged, if the Value change limit in the queue reaches this ‘Resend “queue limit.
e.g. 10000. This means if the no. of Value Changes in the queue exceeds 10000, the system will start logging a warning message.
Max Points to be downloaded per request
Maximum number of points to be requested and downloaded in one request.
Send Transaction Events (Default value is Disabled)
This shows whether the Subsystem events are captured or not.
Proxy Server
Proxy User Name
Proxy Password
If iviva is hosted in cloud, there may be a Proxy Server to assist in sending calls out to the Interfaces in local machines. These fields will be the Proxy Server settings.
Log Level
e.g. 1 = Exceptions 2 = Exceptions+ Additional Transaction Data
Log Notification Threshold (minutes)
Time duration that the system waits after a log notification, before sending another error log notification. This helps to wait for the given threshold time, without sending the same error log notification.
Expiry Duration (minutes)
SSIF Heartbeat or Points will expire after this Expiry Duration in minutes.
Certificate Validation
Select the Certificate Validation checkbox to turn on the HTTPS Certificate validation in the SSIF. It is the Certificate applied to iviva. By default, certificate validation is turned off.
If the Certificate Validation checkbox is selected (checked), SSIF will validate the certificate when connecting to iviva. There will be an error if the certificate is expired and SSIF cannot be connected to iviva.
TCP Message Bus
SSIF needs to subscribe to iviva to receive on-demand requests to point values, set data commands and alarm acknowledge.
This happens via two methods:
1. WebSocket Message Bus (default)
2. TCP Message Bus
TCP Message Bus checkbox is used to enable the feature.
Cloud Local URL Validation
This is used by SSIF. The SSIF will connect to iviva using the configured iviva URL and the API key in the SSIF configuration file.
For example, an operator accesses iviva using the domain URL, but the SSIF cannot access the domain URL to send data. Therefore, it uses the IP Address of the domain URL.
So, at that time, the SSIF thinks that there are two iviva instances and can try to push data to both iviva instances, which is wrong. Because both channels will send data to the same iviva database.
Therefore, such scenarios can be turned off by this validation, so that the SSIF will push data via only one channel to iviva.
On the Interfaces search page, search and click on the Interface ID to navigate to its details page.
Hover over the Interface Details section and click edit icon that appears. Edit the details on Interface Details tab as required and click Save. Click Cancel to discard the changes.
Go to the Clusters tab and create a Cluster.
After creating an Interface, you need to create Clusters. If there is only one Instance of Interface (one machine), then you shall create only one Cluster. If there are two instances of the same Interface to be run on two machines, you shall create 2 Clusters. If the active Cluster stops working, then the other Cluster will become active.
Create a Cluster
To create a Cluster;
On the Interface Details page, click the Clusters tab.
In the Cluster ID box, type a relevant name for the new Cluster.
Select the Enabled check box to enable the Cluster.
Gateway IP will be automatically updated, when the respective Cluster runs.
Active Status will be automatically updated, when the respective Cluster runs.
Click Add to save the Cluster.
Under the “Clusters” tab, the following details of each Cluster will be displayed;
Cluster ID
Enabled Status
Active Status/IP address of Gateway
Last Active Time/Active Since
Binary Updated Time/Binary Version
Service Status
Edit a Cluster
To edit Cluster details;
On the respective Interface Details page, click the Clusters tab.
Change the Cluster ID or Enabled/Disabled value if required.
The Parameters of the respective Interface Driver Type will be displayed. You may configure the relevant parameters according to the respective Cluster and the machine that it runs.
To configure a parameter, type the relevant parameter value in the given box.
Click Set.
Click Update to save the changes.
Manually Activate/Deactivate/Refresh a Cluster
On the respective Interface Details page, click the Clusters tab.
On the pop-up window, click Activate link to manually activate the respective Cluster.
If a Cluster is active and if you want to deactivate it, click the Deactivate link on the pop-up.
Click Refresh link to re-fresh the details in the Cluster.
The following additional functional options will be available for each selected Cluster under Cluster options, when the “SubsystemInterfaceUpdate.exe” is running as a background service.
Restart Service
Start Service
Stop Service
Install Service
Uninstall Service
Update Service
To select an option under a Cluster;
Delete a Cluster
On the respective Interface Details page, click the Clusters tab.
Transaction tab is used to log the transactions associated with Cluster related functionalities.
Cluster commands will be logged under the Transaction tab.
System will log the following details of cluster commands.
Transaction Time: Displays the date & time that the transaction occurred
Transaction Description: Displays the type of the option (Cluster Commands)
User ID: User ID of the user who performed the function
Description: Displays whether the transaction (command) is successful
You can filter the transaction records by giving Start Time (Start Date & Time) on the side panel.
To generate a report on Interface Transactions:
On the side panel, filter the transaction records by giving Start Time (Start Date & Time).
In the Format Box, select the report format (PDF/Word/Excel/Excel-Raw) as you want.
Click Generate Report.
Debug tab displays the debug information which is managed by SSI when troubleshooting.
On the Interfaces search page, click the name of the Interface that you need to delete, to go to its detailed page.
On the Interfaces search page, to search by IBMS Zone, select the relevant IBMS Zone from the list box.
To filter Interfaces by Driver Types, select the required Driver Type.
To filter only the Interfaces that are active, select the Show Active Interfaces check box.
You can filter the required Interfaces and Update/Restart/Refresh them by clicking the respective button on the Side bar.
Generate Report: This is used to generate the current report in PDF/Word/Excel/Excel-raw formats.
In the Format box, select the type of format you want.
Click Generate Report.
Interface ID
Name of the Interface
Active Cluster
Name of the Active Cluster. This will be shown only if the Interface is active.
Driver Type
Type of the Driver associated with the Interface
Zone
Name of the Zone associated with the Interface
Active Status/ Time
Status of the Interface and the Date Time if Status is Active.
If Active 🡪 Active +<Last time that the interface was on Active status> E.g. Active 6-June-2019 11:24 AM LK
If Inactive 🡪 E.g. Inactive
Service Status/Time
A Trend Group is a collection of Trend Points with same unit of measurement. (e.g. Temperatures, percentage, pressure) This section describes the following:
On the Trend Groups search page, click the Add New Trend Group link. New Trend Group configuration page opens.
In the Trend Group Name box, type a unique and appropriate name for the new Trend Group.
In the Location box, select the relevant Location where the Trend Group is configured for.
To select Location from the Location list box, click on the Location box and select the location from the populated list.
Click Create to create the new Trend Group. Configured Trend Group name will be displayed on the Trend Groups page. Trend Group Detail page will open. Trend Group detail page will consists of the following tabs.
Details – Shows the main details such as Trend Group Name and Location
Points – Shows the Configured Points in the Trend Group. Type the required Point name in the Search Points search box, to filter Points by Point name.
Trend – Shows the Trends associated with the Trend Group
You can add configured points to the created Trend Group.
Go to the Trend Group Detail page.
On the Trend Group details page, click the Points tab.
Select the Point Name from the Points search page. Points can be added from the pinboard as well.
Click the Point Name to add the selected Point.
Go to the Trend Group Detail page. Click the Points tab.
Click the Point Name to go to the relevant Point details page.
Edit the respective point details.
You can also access the point details page by
On the Trend detail page, go to the Points tab.
Click the Equipment name to go to the relevant Equipment detail page.
Go to the Points tab and click on the required point name to open the relevant detail page.
Go to the Trend Group detail page. Click the Points tab.
A message box appears to confirm the deletion of Point. Click OK to confirm deletion of the Point. Click Cancel to abort the operation.
On the Trend Groups search page, search for the required Trend Group.
Click the required Trend Group name that you want to edit. Trend details page will open.
Edit the Trend Group Name, Location and Trend Report Name as required.
Click Save. Click Cancel to discard the changes.
On the Trend Groups search page, search for the Trend Group. Click the required Trend Group name to go to the Trend detail page.
Or go to App Dashboard🡪Trend Groups tab.
On the Trend Groups search page, search for the required Trend Group and go to its detail page. Trends associated with the configured points will be displayed.
Trends can be filtered by time range.
Click Apply Filter for Graph. Trends will be filtered according to the selected time range and will be displayed in the graph.
Generate Report: This is used to create a report based on the filtered trends.
After applying the required time range, select the Format.
Click Generate Report.
Tip – You can view respective User Activities associated with a Trend Group (on the respective Trend Group detail page) such as Trend Group creation, Point addition, Point Deletion, etc. on the right pane in the respective Trend Group detail page under Activities section.
You can view Real-Time trends on a full view or on a Pop-up window.
Or go to App Dashboard 🡪Trend Groups tab.
Real-Time Trend Pop-up window:
On the Trend Groups search page, click the required Trend Group name to go to its detail view.
Click the Real-Time Trends link on the top right corner to go to the pop-up window of the Trend Group’s Real-Time Trends.
You can create Trend Groups which are dynamic and which will be used only for the required period to view trends. Configured Dynamic Trend Groups will not be saved in the database and will be only used until you view their live trends.
To configure a Dynamic Trend Group;
On the Trend Groups search page, click the Create New Dynamic Trend Group link on the top right corner.
Select the Location that you are interested in to filter the Equipment based on the selected Location and click Create. Dynamic Trend Groups page will be opened.
Select the required Equipment. Points of the selected Equipment will be displayed.
Select the Data Type and the Unit as required to filter the Points further.
To view only the trend enabled points, select the ‘Only Trend enable points’ checkbox.
Data Sources allow you to configure custom points, which can be used to show user required custom data as point values on IBMS dashboards. A Data source is configured using a custom Data Source script written in different data protocols such as SQL, Python.
The following on Data Sources are described below.
This describes how to configure a custom point using Data Source script written in a data protocol.
Click New Data Source link on the top right corner. New Data Source configuration page will appear.
In the Point Name box, type the name of the custom point that you want to configure.
In the Data Type list box, select the relevant Data Type.
In the Units box, type the Unit of the point. e.g. ‘C’ if the point is to denote temperature.
In the Data Protocol list box, select the data protocol used to write the Data Source script.
In the Data Source Script box, write the Data Source script to get the required point.
Click Create. A new Data Source will be created and listed under Data Source search page.
This describes how to edit the configuration details of a selected Data Source.
In the Search Data Sources box, type the name of the Data Source or part of the name that you want. Matching data will be listed.
Click the Point Name to go to the detail page of the Data Source.
Hover over the Data Source Details area and click the Edit icon to go to the edit mode.
Edit the details accordingly and click Save.
In the Search Data Sources box, type the name of the Data Source or part of the name that you want. Matching data will be listed.
Click the Point Name to go to the detail page of the Data Source.
IBMS Message Templates are used to configure E-mail, HTML e-mail (Rich-text) and SMS templates that need to be sent especially in escalated Alarm messages. This section describes the following:
Setting under App Configuration Escalated Alarm Message Templates configured here (Settings🡪Configure🡪Escalated Alarm Message Templates) will be populated in “Assignee Message Template” and “Un-assignee Message Template” Drop-down boxes in App Configuration page, which enable user to select accordingly.
To configure an Escalated Alarm Message Template;
On the Escalated Alarm Message Templates Search page, click the Add New Message Template link. New Escalated Alarm Message Template configuration page will open.
In the Name box, type a name for the new message template.
In the Subject box, type the subject of the message.
In the Message box, configure the message using message text and relevant Placeholders.
Click Show Placeholders link to view list of placeholder in a pop up window.
Note –The default message that will be created here is the plain text e-mail message. Once you have created the Message Template, you will have the ability to create other templates.
Select the From Address.
Add Recipients.
Click the Add Recipient link.
To add multiple recipients, repeat the step 4.
Add recipients under CC List and BCC List.
Click Create to create the new message template. Detailed page of the created Message template will appear. Observe that there are 5 tabs, Notification Template, Message, Rich Message, Short Message and Attachments.
In the Notification Template tab, edit Name, Subject, and Recipients if required.
In the Message tab, edit the message text as required which you need to send to recipients.
List of Placeholders:
AlarmDateTime
This is the time stamp of alarm occurrence.
ClearedDateTime
Alarm cleared Date Time
AckedDateTime
Alarm Acknowledged Date Time
AlarmMessage
Returns the alarm message
All_Alarm_Assignees
Returns the users assign to the alarm
Alarm_Assignee_comment
Returns the assignee comment which is given when adding a new Assignee
Alarm_Assignee
Returns the Assignee
Alarm_Unassigned
Returns the Unassignee
AssignedBy
Returns the Assigned By User
UnassignedBy
Returns the User who unassigned
AlarmPriority
Returns the Returns the alarm priority
OperatorNote
Returns the operator note
PointValue
Returns the Point Value of the alarmed point
PointName
Returns the point name
PointDescription
Returns the Point Description
AssetName
Returns the Asset Name
AssetLocation
Returns the Asset Location
AlarmSeverity
Returns the Alarm Severity Key
AlarmSeverityName
Returns the name of the Alarm Severity
AlarmClass
Returns the Alarm Class
AlarmLocation
Returns the Alarm Location
ExpireTime_EscalationLevel_1
Returns the expiration time of alarm escalation level 1
ExpireTime_EscalationLevel_2
Returns the expiration time of alarm escalation level 2
ExpireTime_EscalationLevel_3
Returns the expiration time of alarm escalation level 3
ExpireTime_EscalationLevel_4
Returns the expiration time of alarm escalation level 4
ExpireTime_EscalationLevel_5
Returns the expiration time of alarm escalation level 5
ExpireTime_EscalationLevel_1_After_Hours
Returns the after hour expire time of alarm escalation level 1
ExpireTime_EscalationLevel_2_AfterHours
Returns the after hour expire time of alarm escalation level 2
ExpireTime_EscalationLevel_3_AfterHours
Returns the after hour expire time of alarm escalation level 3
ExpireTime_EscalationLevel_4_AfterHours
Returns the the after hour expire time of alarm escalation level 4
ExpireTime_EscalationLevel_5_AfterHours
Returns the the after hour expire time of alarm escalation level 5
SMSAlarmAckCode
Returns the SMS Alarm Acknowledge Code
AckedUser
Acknowledged User
AckedTime
Acknowledged Time
AlarmPageLink
Returns the Alarm Page Link
Name
Returns the full name of the recipient
Type
Returns the type of the recipient. This is usually the 'User'
Key
Returns the Key associated with the recipient in the System
Rich Text Message Template allows you to configure a message template for HTML e-mail messages. A Rich Text Message can contain tables, different fonts, HTML formatting and styles. If you know HTML coding, you can go to the code level and make changes to format your template.
On the Message Template detailed page, click the Rich Message tab.
In the text box, use given tools and Placeholders (Click the Show Placeholders link to bring up Placeholders list and select from it) to format your message template.
Click the Apply Template button to select a format out of preset template formats.
Click on </> link to switch between code editor and form editor modes.
Once you are done formatting the message, click the Update button to save the template or Cancel button to discard all your changes.
A short Message Template is meant for the messages to be sent to mobile devices, (e.g. SMS).
On the Message Template detailed page, click the Short Message tab.
In the given box, configure the short message using message text and relevant Placeholders.
Click Update.
You can configure alternate notification message to be sent as a push notification through mobile apps. To configure a push notification;
On the Message Template detailed page, click the Push Notifications tab.
Click the Add New Push Notifications link.
Select the required Mobile App Name.
Type in the message to be sent.
Click Add.
You can attach attachments related to the Message to be sent.
On the Message Template detailed page, click Attachments tab.
In the Name box, type a name for the attachment.
In the Type box, select ‘File (Attach a File)’ option.
Select other Options.
Drag and drop the required file to be attached to the Message Template or click the marked area to select a file from the file explorer.
Click Upload.
On the Escalated Alarm Message Templates search page, select the Message template you want to edit and click on it to go to its detail page (inside Notification Template tab).
Edit the message template as you want. (See above).
Click Update.
On the Escalated Alarm Message Templates search page, select the Message template you want to delete and click on it to go to its detail page.
A message to confirm the deletion appears. Click Delete.
To export a Message Template;
On the Escalated Alarm Message Templates search page, select the Message template you want to export and click on it to go to its detailed page.
Save the attachment.
Click Localised Messages link in the side bar to send the required message in another language. Available language/s will be listed in a QI window. Click the required language.
On the Escalation Disable Message Templates search page, click the Add New Message Template link. New Alarm Escalation Disable Message Template configuration page will open.
Setting under App Configuration Alarm Escalation Disable Message Templates configured here (Settings🡪Configure🡪Alarm Escalation Disable Message Templates) will be populated in “Alarm Escalation Disable Message Template” Drop-down box in App Configuration page, which enables user to select a relevant message template.
Controls (e.g. button) on Real-Time (RT) Pages of Equipment can be linked to other RT pages or to required URLs according to your requirements, (e.g. clicking a button on a RT page, can open another RT page or can direct to another URL).
Before providing links to Controls on RT pages, you need to perform the following operations;
Create Links accordingly, for Equipment under respective Equipment configuration page. When you configure RT pages, you shall add the pre-configured Links to Controls on RT page.
To create Link Templates on an Equipment Template;
Go to the detailed page of the required Equipment Template.
In the Link Name box, type a name for the Link template.
Click Add.
After creating Link Templates on Equipment Template configuration page, you shall configure Links on the Equipment created using the respective Equipment Template. To configure Links under Equipment configuration page;
Click Equipment tab on the IBMS home page or go to Settings🡪View🡪Equipment. Equipment search page will appear.
Search by the respective Equipment Template by using the Equipment Template filter on the Side bar.
Click the Equipment name to go to the Equipment details page.
Click the Links tab. Pre-configured Link template name/names will be displayed.
On the Link Details window, type the required URL of the destination page, which will be linked using the respective Link.
Click Clear to erase the entered text if necessary.
After typing the required URL, click Update.
Path Settings icon on the Application Dashboard 🡪 Configure section 🡪 Zones 🡪 Zones Search page
Click Add to create the new Zone. Click the Close icon to close and abort the operation.
Move the cursor to the Zone Details section and click the Edit icon that appears.
Click the Delete this Zone link or Delete this Item icon on the sidebar.
Note – The Assets that have been registered as Equipment for the IBMS Zone, will be listed under the Equipment tab on the Zone Details page. To see details on registering an Equipment, please refer to the section below.
Tip – To go back to the IBMS Home page, click the icon.
Note – Prerequisite: should be configured before configuring Alarm Classes.
Path Settings icon 🡪 Configure section 🡪 Alarm Classes 🡪 Alarm Classes search page
Click the respective Edit icon of a Severity and type the respective Escalation Time of Level 1.
Move the cursor to the Details section and click the Edit icon that appears.
Click the Delete this Alarm Class link or Delete this item iconon the sidebar.
A message box to confirm deletion appears. Click Delete to confirm deletion of the Alarm Class, or to close the message box without deleting, click Cancel . If the Alarm Class is in use, a message will appear stating that it cannot be deleted.
Path Settings icon on the Application Dashboard 🡪 Configure section 🡪 Alarm Severity 🡪 Alarm Severities page
Path Settings icon on the Application Dashboard 🡪 Configure section 🡪 System Types🡪 System Types search page
Hover over the System Type tab and click the Edit icon .
On the System Types search page, click the required System Type name to go to its detail page and click the Delete this System Type link/Delete icon on the side panel.
A message box to confirm deletion appears. Click Delete to confirm deletion of the System Type, or to close the message box without deleting, click .
Path Settings icon 🡪 Configure section 🡪 Equipment Templates 🡪 Equipment Templates search page
Click Create to create the new Equipment Template. Click icon to close and abort the operation. Once an Equipment Template is created, its detailed page will be opened. On the detailed page, you can edit Equipment Template Details and configure Point Templates of the Equipment Template.
To see how to edit Equipment Template Details, please refer to the section below.
To see how to configure Point Templates, please refer to the section.
To see how to configure Link Templates, please refer to the section.
To see how to configure Equipment, please refer to the section.
To see how to configure RT GUI, please refer to the section.
On the Detail page, move the cursor to the General section and click the Edit icon.
Under the Link Templates tab,
Under Equipment tab, .
Click the Delete this Equipment Template link or Delete icon on the Side bar.
A message to confirm deletion appears. Click Delete to confirm deletion of the Equipment Template, or to close the message box without deleting, click icon on the top left of the message box.
Point Templates tab lists all the Point Templates that have been configured for this Equipment Template. (To see how to configure Point Templates for Equipment Template, please refer to the section)
Path Settings icon🡪 Configure section 🡪 Equipment Templates 🡪 Equipment Templates search page🡪 Relevant Equipment Template 🡪 Equipment Template Detail page🡪Point Template tab
Click the Settings icon and select Equipment Templates under Configure section. Equipment Templates search page will appear.
Click the Add icon. New Point Template dialog box appears.
Click Add to create the new Point Template. Click icon to close and abort the operation.
General: To edit the General section, which contains the general data of the Point Template, hover over the General section click the Edit icon.
Properties: Hover over the Properties section and click the Edit icon. Configure the following attributes of the Point Template and click Save.
Reset Value Configuration: Click the Edit icon next to the Reset Value Configuration section to edit the following details.
Trend: Click the Edit icon next to the Trend section to edit the following details.
Click the Settings icon and select Equipment Templates under Configure section. Equipment Templates Search page will appear.
Click on Add icon under Alarm section. Add Alarm dialog box appears.
Select Alarm Class from the configured Alarm Classes in the list box (To see how to configure Alarm Classes, please refer to section).
Enter Alarm Deadband, Clearance Deadband, Alarm Delay and Clearance Delay accordingly.
Select Enable only for working hours/ Enable only for non-working hours checkboxes accordingly.
Click Add. Click icon to abort operation.
Scroll down to Alarms section and click on icon on the far right corner of the alarm.
Click Update. Click icon to discard changes.
Scroll down to Alarms section and click on the respective Delete icon of the alarm that you want to delete.
Click the respective Delete icon to the right of the Point Template name.
Click the Settings icon and select Equipment Templates under Configure section. Equipment Templates Search page will appear.
Alternatively, click the Settings icon on the Home Page and select the Point Templates link under the View section. Point Templates search page will open.
Path Settings icon🡪 Configure section 🡪 Interface Driver Type 🡪 Interface Driver Types search page
On the Driver Type Details tab, hover over the Basic Details section and click the Edit icon.
Click the Delete icon or click the Delete this Driver Type link on the side panel under Driver Type Details tab. A message box to confirm deletion appears.
Click Delete to confirm deletion of the Interface Driver Type, or to close the message box without deleting, click the icon.
Path Settings icon🡪 Configure section 🡪 Interfaces 🡪 Interfaces search page
Click the Add icon. Cluster configuration page appears.
Click the Edit icon to open the Cluster Details page.
Click the respective icon.
(Or you can click icon of a selected Cluster to refresh the details in the Cluster).
Click the respective icon and select the required option from the pop-up menu.
Click the respective Delete icon to the right to delete Cluster from the Interface.
Note –If a Cluster is active, Delete icon will not be displayed along with the respective Cluster details.
Click the Delete icon or the Delete this Interface link on the side panel.
A message box to confirm deletion appears. Click Delete to confirm deletion of the Interface, or to close the message box without deleting, click the icon. If the selected Interface is in use, a message will appear stating that it cannot be deleted.
To view the name of each data column in the Interface Search page, click the icon on the Toolbar.
New Version is available
This is to show an Exclamation icon, if the updated Interface details are not downloaded by SSIF, after an Interface is updated.
Status of the associated Service and the last time that the Service’s status returned E.g.
Path Settings icon🡪 Configure section 🡪 Trend Groups 🡪 Trend Groups search page
To select the location from the Location search page, click the Search icon and select the location you want from the Location search window that appears.
To select the Location from the pinboard, click the Pin icon and select from the pinned item list.
Click the Add icon. Points search window will open to add configured Points to the respective Trend Group. Point configuration should be done first in order to list the configured points in the Point Search Window. Refer section for more details on configuring points.
Click the icon on the right hand of the same row of the Point that you want to delete.
In the Details tab, hover over the Details section and click the Edit icon that appears.
Click the respective Delete this Trend Group link or Delete icon in the Sidebar.
A message box to confirm deletion appears. Click Delete to confirm deletion of the Trend Group, or to close the message box without deleting, click . If the Trend Group is in use, you will not be allowed to delete it.
Go to Settings and click Trend Groups under View section.
Click the Filter icon on the top right corner.
Under From Date Time, click Calendar icon and select the From Date that you want to start plotting data.
Click the Time icon and select the Start Time to plot data.
Under To Date Time, click Calendar icon and select the To Date that you want to stop plotting data.
Click the Time icon and select the To Time, which denotes the end time to stop plotting data.
Go to Settings and click Trend Groups under View section.
Full View: On the Trend Groups search page, click the Full View icon to go to the Real-Time Trends Full page view.
Go to Settings icon🡪Configure🡪 Trend Groups.
Click the Add icon on the top right corner.
Click icon to select the required Date/Time range to select the Trend period.
Path Settings icon 🡪 Configure section🡪 Data Sources
Click the Settings icon and select Data Sources under Configure section. Search Data Source page will appear.
Click the Settings icon and select Data Sources under Configure section. Search Data Source page will appear.
Click the Settings icon and select Data Sources under Configure section. Search Data Source page will appear.
Click the Delete icon or Delete this Data Source link. A message appears to confirm the deletion.
Click Delete. Click to abort the operation.
For details on Real-Time Reports, go to the section
Path Settings iconon the Application Dashboard 🡪 Configure section 🡪 Escalated Alarm Message Templates 🡪 Escalated Alarm Message Templates search page
Click the Info icon and select the relevant recipient from the window that appears.
To remove a recipient which is already added, click the respective Delete icon.
Click the Add icon .
Click the Delete this Template link or click the Delete icon on the side bar on the right.
Click Export link on the Side bar.
Path Settings icon on the Application Dashboard 🡪 Configure section 🡪 Alarm Escalation Disable Message Templates 🡪 Escalation Disable Message Templates search page To configure an Alarm Escalation Disable Message Template;
Follow the relevant steps under the section named described above.
Configuration. This is used to create a template for links. Created Link Template will be applied to the Equipment configured using the respective Equipment Template.
Click the Settings icon and select Equipment Templates under Configure section. Equipment Templates Search page will appear.
On the Link Templates tab, click the Add icon.
Click the respective Edit icon .
