Chapter 7: Managing the Application
Last updated
Last updated
Manage section describes the following:
App Configuration page has been divided into few sections. Each section has settings related to a specific area in IBMS app.
Path Settings icon🡪 Manage section 🡪 App Configuration
Click the Settings icon and select App Configuration under Manage.
After configuring the following settings, click Update to save the settings.
“Comment required for write command” check box
If this check box is selected, Real Time GUI and Real-Time Values pages of equipment and systems will have mandatory comment boxes for the user to add comments when manual override is done.
“Enable desktop sound/flash notification for new alarms” checkbox
This enables desktop beep sound and flash notification when a new alarm is triggered. Desktop sound/notifications for new alarms work only for https connections.
System User Account
Allowed to select the System User which will be logged as the user in user transactions.
“Display Alarm Class in Weblets and Search pages” check box
Used to enable/disable displaying Alarm Class in weblets and in search pages where Alarm class is not already displayed as a search filter.
“Merge Point Name and Point Description in Real-Time value page” checkbox
If this check box is selected, Point Name & Point Description will be merged and displayed in one column on Equipment/ System Real-Time Value pages. E.g.
Note: A quick method to navigate to Equipment Real-Time value page/ System Real-Time value page,
Enable auto refresh in Real-Time Value page
Used to enable Auto Refresh feature on every Equipment Real-Time Value page.
“Enable only "Print Chart" function in Trend Graphs” checkbox
Note: To navigate to Historical Trend Graph /Real Time Trend Graph,
Go to Real Time Trend tab to observe print chart feature.
This feature is applicable for both Equipment and Systems.
Also applicable for Trend Groups (App 🡪 Groups tab🡪relevant Trend Group).
OnDemand polling frequency
BACnet OnDemand trend polling request frequency
BACnet OnDemand trend polling request time out
Maximum month range for trend chart filter
App Admin shall select the required setting for Process Trigger Priority under App Configuration page. Default configuration “Terminate the running process” will terminate the current process and start another process. (E.g. If a new alarm generated, the current alarm will be stopped and new alarm will be notified). Other option “Terminate this process” will terminate the process without starting a new process.
On the App Configuration page, select the Default Configuration from the list for Process Trigger Priority.
If it is required to show the Alarm Viewer Pop-up;
On the App Configuration page, go to the Alarm Viewer section. Alarm Viewer Pop-up setting allows to configure the following.
Show Pop-up Alarm Viewer
Show Acked Alarms in Alarm History Viewer
Alarm confirmation required
Apply Filters for New Alarms
Show Only Active and Cleared Alarm Tabs
Show Alarm Summary Tab in Alarm Viewer
Select the Show Pop-up Alarm Viewer check box if it is required to show the Alarm Viewer pop-up.
Select the Show Acked Alarms in Alarm History Viewer check box, if it is required to show the acknowledged alarms under Alarm History Viewer. If this check box is selected, the acknowledged alarms will be cleared and displayed under Alarm History Viewer, without displaying under the Acknowledged Alarms tab on Alarm Viewer. Alarm Viewer will have a link named Alarm History Viewer to view the alarms in Alarm History Viewer.
Select the Alarm Confirmation Required checkbox, if the alarms need confirmation actions (Corrective Action required and Corrective Action not required). If the Alarm Confirmation Required check box in App Configuration page is selected;
Confirmed Alarms tab on Alarm Viewer will be displayed containing the confirmed alarms.
Alarm History Viewer link on Alarm Viewer will be displayed.
This option allows to apply filters for alarms with “New” status in Alarm viewer according to the customer requirement.
To apply filters for alarms with the status “New”, select the “Apply Filters for New Alarms” check box
If you do not need to apply filters for New alarms, deselect the check box.
Once you enable this feature,
The alarm viewer will only have two tabs available when this option is enabled. Below tabs will be enabled when “Show Only Active and Cleared Alarm Tabs” check box is selected under App Configuration.
Active Alarms tab
Cleared Alarms tab
When Show Alarm Summary Tab in Alarm Viewer check box is selected, the Alarm Summary Tab will be displayed on the Alarm Viewer page (Settings🡪View🡪Alarm Viewer).
If it is deselected, the Alarm Summary Tab will not be displayed on the Alarm Viewer page.
The following operating scopes cannot be changed by the end-users.
Equipment Based Permission
Used to filter equipment to Equipment search page based on the Asset Group. If Equipment based permission is selected, both location scope and Asset group scope will be applied.
Location Scope
Location scope is applied to search pages where location, Equipment, Zone interfaces etc. are used.
Point Based Scope
Applied to filter point related pages, equipment point configuration and Real Time pages
This section allows admin to configure the following;
Alarm escalation disable notification group: Group to be notified when alarm escalation is disabled
Alarm escalation disable message template: Message template used in Alarm escalation disable notifying message
Assignee message template: Message template used in messages to be sent to Alarm assignees
Unassignee message template: Message template used in messages to be sent to respective users when alarms are unassigned
Once you are done with necessary configurations, click Update to save the changes.
This section describes how to add and manage User Roles and their User Rights. A User Role grants permission for app users to perform a collection of tasks, through the User Rights attached to it. User Rights in a User Role, give access rights to functionalities in IBMS App. User Rights are grouped into four ‘User Rights Groups’ (Guest User, Normal User, Power User and Administrator) based on the typical access permission levels. (E.g. Administrator User Rights – group the User Rights typically associated with Admins to perform crucial tasks such as Master data configurations, Guest User Rights –group the User Rights which allow tasks such as view search pages/reports in app).
In the User Role box, type the name of the User Role. (E.g. FM Manager)
User Right Configuration
To add all the User Rights grouped under a typical User Role to the new User Role at once, select its checkbox.
If not, select each checkbox, to add them individually to the User Role as you require.
E.g. User Role - e.g. Administrator
User Rights – Administrator User Rights (If the “Administrator User Rights” checkbox is selected, all the User rights under “Administrator User Rights” will be applied. Or else, select individual User Rights considering the permissions you need to provide to each functionality in the App)
Click Add.
To find a specific User Role(s) based on its text, type in the required text in the Search box.
Select the required search criterion in the drop-down box to filter the User Rights.
Make the required changes and click Update.
Search filter in List box
Purpose of Search filter
All Items
To view all the User Rights
Selected Items
To view only the selected (ticked) User Rights
Unselected Items
To view only the User Rights that are not selected
Click OK to confirm. Click Cancel to abort the operation.
Copy feature allows you to copy an existing User Role including its all User Rights to another User Role at once. You can
Copy an existing User Role to a new User Role
Copy an existing User Role to another existing User Role
Go to Settings🡪Manage🡪User Roles.
Type the new User Role that you need to create in the ‘User Role’ box.
Select the User Role that you need to copy, from the ‘Copy’ drop-down box.
Click Add. Selected User Role’s User Rights will be copied and applied to the new User Role.
Go to Settings🡪Manage🡪User Roles.
Select the User Role which you need to copy from the drop-down box named ‘Copy’. Message will appear to confirm the action.
Click OK. User Role selected under ‘Copy’ box will be applied to the selected User Role
Trend Configuration functionality in the system is used to add/edit/delete and audit Trend Data. Trend Data Functionality will be useful in situations such as;
When SSIF goes offline/ subsystem communication fails, all trend data generated during that period may be lost.
When a device sends false data due to malfunctioning.
Trend Configuration page can be used to correct or remove corrupted data where necessary. If any Trend Data loss occurs for a significant period of time, you will need to add trend data to iviva system manually via Bulk Data upload. Trend data added to the system via Bulk data upload will be displayed under Trend Configuration page.
Trend Configuration page allows you to audit the uploaded trend data by comparing data editing and verifying, before confirming them for trending.
Trend Configuration functionality
First, upload the Trend data via Bulk Import Data process.
Go to Settings 🡪 Manage 🡪 Bulk Data Import.
To import bulk Trend data to system, go to the Trend Data tab on the Bulk Data Imports detail page and follow the Bulk Data Import process.
To view the uploaded Trend data;
Click the Trend Configuration link on the side bar on the Trend Data tab under Bulk Data Import detail page OR
Go to Settings 🡪Manage 🡪 Trend Configuration.
On the Trend Configuration page;
Click Add icon and add new individual trends.
Modify the Trend data as required.
Click “Show only modified” check box to display only the modified Trend data.
Click “Show only bulk uploaded” check box to filter and display the trend data added only through bulk data import process.
After comparing and verifying Trend values, click Confirm to save the Trend data for trending.
Point Bulk Upload has been enhanced to upload Point properties which are inherited from Point Template and to use those Point properties to override values of Point.
Download Point Data with Override Options
This is used to download Point specific Data with Properties inherited from Point Template and alarm details (which will be used to override Point values) and to export them to Excel.
Go to Settings 🡪Manage 🡪 Bulk Data Imports 🡪 Point Data tab.
On the Point Data tab, click the Download Points Data link on the Side bar. Points search page will open.
Select the Download with override options checkbox.
Click Export to Excel link. Data along with properties inherited from Point Template will be exported to an Excel file.
Upload Point Data with Point Override details
Upload the Excel file with Point data and properties inherited from Point Template.
Note: For details on Bulk Data upload, please refer to the Bulk Data Import user guide.
Processes for Alarms allows you to configure Process Types and Stages for alarms. Process Types that are tied with alarms will be retrieved and displayed under “Processes for Alarms” page. You need to upload the relevant Process for alarms to Process Type. An alarm Process Type allows you to define a process for Alarm status transitions.
The Alarm state transition is called Normal to Alarm (N2A)
Alarm state transition happens based on the point value of the alarm point. Changes happen due to the point value being changed based on a field sensor condition.
Alarm Stages are a condition of an alarm based on the actions taken on an alarm.
A newly created alarm would be in a default Stage provided that there is no Process Type associated with the Alarm state transition. Which means no user interaction has happened.
Alarm Stages are user definable depending on the requirement.
An Alarm Process is a combination of activities and Alarm Stage transitions due to those actions. For example, when an alarm happens, a process maybe defined for an incident to be created, a work order to be created and a notification to be sent, changing the alarm stage to be notified.
On the Process Types tab, the created Process Type will be listed.
Upload the required Process via the Process Editor to the Process Type. Once a Process is uploaded, its name will be displayed under the respective Process Type.
Go to Settings 🡪Manage 🡪 Processes for Alarms
To view the uploaded Process diagram of the Process Type;
Go to Settings🡪Manage🡪Processes for Alarms
On the Process Types tab, click the Preview link which is displayed along with the Process that you want to view. Process diagram will be displayed.
To download the Process;
Click the Download link which is displayed along with the Process that you want to download.
After uploading a Process to the Process Type, you need to add the Stages of the Process. It is required to add the same Stages that you find in the uploaded Process.
Go to Settings🡪Manage🡪Processes for Alarms. Process Configuration page will appear.
Click the Stages tab.
Click in the Default Stage box and select a new default stage from the list box.
Click Save.
In the Stage text box, type the name of the Stage, as in the Process diagram that you upload.
Select the Active checkbox, if the respective Stage is active in the respective Process.
Click Add.
Repeat the steps 6-9 to add all the Stages as in the Process diagram.
Use the Up and Down arrows to arrange the Stage order as in the Process diagram.
Go to Equipment Search page and filter equipment records. Click the Real-Time Values icon of the respective equipment record.
Go to System Search page and filter System records. Click the Real-Time Values icon of the respective System record.
Once enabled, Auto Refresh icon will be green.
Go to Equipment Search page and filter equipment records. Click the Real-Time Values icon of the respective equipment record.
Click Historical Trend icon of the required point to go to Historical Trend tab in point details to see this feature.
Click the Settings icon and select App Configuration under Manage Section.
Alarm Viewer Pop Up will be displayed, when you click Alarm icon in App Dashboard.
Acknowledged alarms under “Alarm Viewer” will have a Confirm button to confirm the Alarms by the user.
Filter icon will be enabled on Alarm Viewer page (To go to Alarm Viewer Page, go to Settings🡪View🡪Alarm Viewer).
Or go to app dashboard and click Alarm icon.
Path Settings iconon the Application Home page 🡪 Manage section 🡪 User Roles
Click the Settings iconand go to Manage section 🡪 User Roles.
Click the Add icon . Add User Role window will appear.
To view User Rights available under a typical User Role Group, expand by clicking the respective icon.
On the User Roles page, find the User Role that you want to edit and click the respective Edit icon.
On the User Roles page, find the User Role that you want to delete and click the respective Delete icon to the right. A message to confirm the deletion will appear.
Click the Add icon.
Select the User Role that you need to edit and click on its Edit icon. ‘Edit User Role’ page will appear with the selected User Role’s name under the ‘User Role’ box.
If it is required to discard all the changes done in Trend data, click icon.
If it is required to delete all the Trend data displayed on the Trend Configuration page, click icon.
Path Settings icon 🡪 Manage section 🡪 Bulk Data Imports
Path Settings icon 🡪 Manage section 🡪 Processes for Alarms
Click the Settings icon and select Processes for Alarms under Manage section. Processes page will appear.
On the Process Types tab, click the Delete icon which is displayed along with the Process that you want to remove from the Process Type.
Hover over the stage value for the Default Stage field, and click on the Edit icon that appears.
Click the Add icon . New Stage configuration page pops up.
To delete a Stage, click the respective Delete icon.
Click the Edit icon and add the required UI features of the respective Stage and click Update.