HDB Industrial Project
User Guide
Issue Date:
[06-Jun-2017]
This document contains proprietary information that is confidential to the Ascertem Pte Ltd.
Written permission must be obtained prior to the disclosure of this document to any party not
described herein this document. Any hardcopy of this document, printed or photocopied, is
considered an uncontrolled copy. The original, signed-off document is the controlled copy.
© Copyright 2014, Ascertem Pte Ltd
Issue Date:
[13-JAN-2015]
Revision History
Version Effective Date Summary of Changes
Author
1
1-May-2017
First Draft
Xing Yijing
2
06-Jun-2017
Updated Guide with Images
Xing Yijing
Page 2 of 41
Issue Date:
[13-JAN-2015]
Reviewed By
Name
Project Role
Xing YiJing
Ascertem Project Engineer
Signature
Date
(DD/MMM/YYYY)
Signature
Date
(DD/MMM/YYYY)
Approved By
Name
Project Role
Toh Hong Pin
Ascertem Project Manager
Page 3 of 41
Issue Date:
[13-JAN-2015]
Table of Contents
1.
OVERVIEW ......................................................................................................... 5
2.
SUMMARY OF PLATFORM ................................................................................ 6
3.
2.1
Dashboard..................................................................................................... 6
2.2
Live View ....................................................................................................... 6
2.3
Situation Awareness ..................................................................................... 6
2.4
Alert Management ......................................................................................... 6
2.5
Business Analytic .......................................................................................... 6
2.6
User Management......................................................................................... 6
2.7
Device Management ..................................................................................... 6
GETTING STARTED ........................................................................................... 7
3.1
Login Page .................................................................................................... 7
3.2
Dashboard..................................................................................................... 8
3.2.1
Camera View .......................................................................................... 9
3.2.2
Floor View............................................................................................. 13
3.2.3
User Profile Summary........................................................................... 15
3.2.4
Left Slider Task Bar .............................................................................. 16
4.
LIVE VIEW ......................................................................................................... 17
5.
EVENT ALERT .................................................................................................. 20
6.
REPORT............................................................................................................ 24
7.
6.1
Device Alerts ............................................................................................... 24
6.2
Comparison Mode ....................................................................................... 26
SETTING ........................................................................................................... 27
7.1
Scheduler Settings ...................................................................................... 27
7.2
Alert Settings ............................................................................................... 31
7.3
User Settings............................................................................................... 33
7.4
Device Settings ........................................................................................... 36
7.4.1
7.5
Device Settings..................................................................................... 36
General Settings ......................................................................................... 40
Page 4 of 41
Issue Date:
[13-JAN-2015]
1. OVERVIEW
Purpose of Document
This document describes the user’s usage of the system for the HDB Industrial
Project.
Scope
The document covers the following aspects:
•
•
•
•
•
•
•
•
Overview
Dashboard
Live View
Situation Awareness
Alert Management
Business Analytic
Manage Users
Manage Devices
Page 5 of 41
Issue Date:
[13-JAN-2015]
2. SUMMARY OF PLATFORM
The Platform provides a means to observe and append information to each
individual event for better tracking of event record. This allows user to be always in
constant awareness of the events which had happened and the chain of actions
which followed up to the closure of each individual event.
The main functions of the platform are classified under general categories, namely:
a. Dashboard
b. Live View
c. Situation Awareness
d. Alert Management
e. Business Analytic
f. User Management
g. Device Management
2.1 Dashboard
This section allows user to have the overview of the whole platform, i.e. the map
view on placement of sensor (camera location, I/O device etc.).
2.2 Live View
This section provides user the viewing of video stream from camera installed.
2.3 Situation Awareness
This section provides user a means to keep track of events that had happened and
have an overview of incident as things happen.
2.4 Alert Management
This section provides user the list of alerts triggered from event/s and the after-action
carried out on each individual event.
2.5 Business Analytic
This section provides user a graphical view of events based on required period of the
year.
2.6 User Management
This section provides user the simple capability to add or delete user account.
2.7 Device Management
This section provides user a simple interface to manage any equipment or device.
Page 6 of 41
Issue Date:
[13-JAN-2015]
3. GETTING STARTED
This section explains the basic Dashboard function of the platform.
3.1 Login Page
Figure 1
Figure 1 shows the main login screen of the Platform.
Username and password is required to proceed on from this point onwards.
Page 7 of 41
Issue Date:
[13-JAN-2015]
3.2 Dashboard
Figure 2
Figure 2 shows the layout of Dashboard when user logs in. Each of the camera view
shows the latest camera view snapshot. This snapshot provides user a general view
of where the camera is looking at.
By default, the
the map of site will appear.
is selected. By clicking on the
,
shows the summary of alert that had been triggered and had not been read
by user.
shows the account in which is currently being logged on.
Clicking on the picture icon will bring up the
function.
Page 8 of 41
Issue Date:
[13-JAN-2015]
3.2.1 Camera View
3.2.1.1 More Filters Button
Figure 3
On the
, clicking on the
icon on the top right
corner will open up filtering function for the user to minimize camera view based on
certain criteria.
Below are the filter selections available.
Scroll bar to select number of camera
view to show on the Dashboard
Figure 3a
Shows the camera currently online
Figure 3b
Shows the camera currently offline
Page 9 of 41
Issue Date:
[13-JAN-2015]
Figure 3c
Figure 3d
Figure 3e
Figure 3f
Shows the camera currently on
Maintenance mode
Shows the camera that has no analytic
set for it
Shows the camera that has analytic set
for it
Page 10 of 41
Issue Date:
[13-JAN-2015]
3.2.1.2 Camera View Information
Information shown on each camera view is as below:
Status of Analytic for
the camera
Figure 4a
Cam 03
Offline Since:
Figure 4
Figure 4b
Figure 4c
Camera Name
Status Info
Graphical
representation of
camera status
Info of any triggered
analytic from the
camera
Page 11 of 41
Issue Date:
[13-JAN-2015]
3.2.1.3 Camera Summary View
By clicking on a camera view, the platform will load the following interface.
Figure 5
Below is a table of information in which will be shown to user.
Cam 02
Description
Analytic
Site
Floor
Location
Online Since
Name of the camera
A short info to inform user of the camera
Type of analytic set for the camera (if any)
Main Building Name
Floor level in which the camera is installed
A more precise info on the installation spot of the device
Info on how long the camera had been up and running
button will bring the camera view back to the Dashboard Camera View
Page
button will bring the user to the Event Alert Page. This button will
appears only if there is an event
Page 12 of 41
Issue Date:
[13-JAN-2015]
3.2.2 Floor View
Figure 6
By clicking on the
icon, a dropdown list
shown to the user to select location.
of the level selection is
Zoom selection on the map, to zoom in or out
Figure 6a
Figure 6b
Option to switch between Full Screen mode selection option or
browser-based
Page 13 of 41
Issue Date:
[13-JAN-2015]
On the map, there are two types of icon. The info on the icon is as below:
Figure 6c
Icon to represent camera which is currently online at which
location
Icon to represent camera which is currently offline, either faulty
or on maintenance at which location
Figure 6d
By clicking on either of the type of icon, the platform will load the images from the
selected camera icon. Please refer to Figure 5 for interface which will be loaded.
Page 14 of 41
Issue Date:
[13-JAN-2015]
3.2.3 User Profile Summary
Figure 7
The info shown on this page consists of:
Image of User
userData.fullName
Location Assigned
Position
Registered Date
Last Login
Shift Time
Contact
Email
A picture to show the current user logged on
User’s screen name
User current area to patrol or to handle
Role of user in the platform
The date user is added into the platform
Last access info onto the platform
The normal working hour of user
Contact number
Email address in the platform and not HDB email
Page 15 of 41
Issue Date:
[13-JAN-2015]
3.2.4 Left Slider Task Bar
Main page of Platform
Shows the live view from selected camera
Playback recording from camera
View alert from camera analytic
View various report from analytic
Setting for maintenance mode on past and
upcoming schedule
Priority setting for type of analytic
Input of information of site and different
level of building
User management module
Device management module
Alert announcement timeout and generic
message reply template
Figure 8
The left slider task bar allow user to switch between different functions.
Page 16 of 41
Issue Date:
[13-JAN-2015]
4. LIVE VIEW
Figure 9
Figure 9 shows the 9-view layout of the live view display. The figures below allow
users to control the performance of the platform display.
Refresh all the camera view in a single motion
Figure 9a
Expands the platform display to full screen view
Figure 9b
Figure 9c
Selection of the number of live viewing screen between 1 to 16
views
Page 17 of 41
Issue Date:
[13-JAN-2015]
Figure 10
Figure 10 shows the window of single camera view.
There are five icons which accompanied each of the live view video streams.
Figure 10a
Figure 10b
Figure 10c
Figure 10d
Figure 10e
Event Alert. Clicking on the alert icon will bring user to Event
Alerts page. This will appear only when there is event triggered.
Refresh of camera image from only the selected camera
Playback selection. Please refer to section 5 for more info
Edit function. To change the camera view to another camera view
To expand the selected camera view as a single viewing screen
Page 18 of 41
Issue Date:
[13-JAN-2015]
Figure 11
function, once activated, will rotate all the available
camera view within the selection of viewing screen.
Figure 12
There are 4 time range selection available when View Rotation option is selected.
When activated, the camera view on screen will rotate all the camera view until a full
cycle display had gone through.
To change the desire number of viewing screen for the camera live view, click on the
button to activate the viewing screen.
Page 19 of 41
Issue Date:
[13-JAN-2015]
5. EVENT ALERT
Figure 13
Figure 13 shows the default view of alert showing up on the platform.
Click on the
(Figure 14) of camera.
button of an alert to open up the situation awareness page
Page 20 of 41
Issue Date:
[13-JAN-2015]
Figure 14
The
camera.
icon indicates on the map, where the alert occurs from the affected
shows the live view of the camera on site.
shows the playback of recorded video.
button will bring the platform back to Figure 13.
,
are possible camera that are nearest to the event camera.
allows the user to bring out the camera selection list to change the camera
view to that of another.
Page 21 of 41
Issue Date:
[13-JAN-2015]
button will bring out the function
and
.
ALERT INFO
Figure 15 shows the breakdown
of info for the alert generated.
Clicking on the
button will bring out the Report
page (figure 17)
Figure 15
Figure 16 shows info regarding
the device.
Figure 16
Page 22 of 41
Issue Date:
[13-JAN-2015]
Figure 17
The Report page will consolidate various info regarding the alert and display them
under a single summary page.
ALERT TRAIL
Figure 18
Figure 18 shows the alert trail of the event selected. Information such as response
time is shown to the user.
Page 23 of 41
Issue Date:
[13-JAN-2015]
6. REPORT
6.1 Device Alerts
Figure 19
Figure 19 shows the report default page. Report will show in Pie chart format. There
are two formats available.
Switch report view to Pie Chart format
Switch report view to Pie Chart format
Selecting the
and
to input the month and year to generate out the report.
Clicking on the
will allow user
button will down the report to the platform.
Page 24 of 41
Issue Date:
[13-JAN-2015]
Figure 20
Figure 20 shows the report in Bar Chart.
Figure 21
Figure 22
Figure 21 and 22 illustrate the pop-out information when the mouse cursor is placed
over the type of analytic.
Page 25 of 41
Issue Date:
[13-JAN-2015]
6.2 Comparison Mode
Figure 23
Clicking on the
select to generate the report.
will reveal a dropdown list of analytic to
Selecting the
and
to input the month and year to generate out the report.
Click on the
can also click on the
report.
will allow user
button will down all the report to the platform. User
button to download just a particular
Same as of Figure 21 and 22, there will be a pop-out information when the mouse
cursor is placed over the type of analytic.
Page 26 of 41
Issue Date:
[13-JAN-2015]
7. SETTING
7.1 Scheduler Settings
Figure 24
Figure 24 shows the default page in which shows the user, any upcoming
maintenance schedule is/are planned. From here, user will be able to access past
maintenance planning, the devices involved and
Shows the schedule that had been planned
Shows the past schedule of device
Input of info for new schedule
View all the details of the selected scheduled
maintenance
Edit function to make changes to the scheduled
maintenance. Figure 26 will appear for user to edit
Page 27 of 41
Issue Date:
[13-JAN-2015]
Delete function
Search function
Figure 25
Figure 25 shows the maintenance schedule input interface.
Page 28 of 41
Issue Date:
[13-JAN-2015]
Figure 26
The Edit Schedule page allows user to make changes to
1
2
3
4
Schedule Type (Single or Recurring)
Recurring (Daily , Weekly, Monthly, Yearly)
Reminder unit count (hour, week, day, month, year)
Maintenance device
Clicking on the
devices.
will brings out the device list for adding or deleting of
Page 29 of 41
Issue Date:
[13-JAN-2015]
Figure 27
Figure 27 shows the input interface for adding of maintenance schedule. Multiple
schedules can be set together under one single setting.
Page 30 of 41
Issue Date:
[13-JAN-2015]
7.2 Alert Settings
Figure 28
Figure 28 shows the information regarding the alert type. User is able to change the
priority between high and low for each type of analytic.
Edit function to make changes
Delete function
Add function to input a new type of analytic
Search function
Page 31 of 41
Issue Date:
[13-JAN-2015]
Figure 29
Figure 29 shows the interface to edit the priority of the analytic. The icon button can
be replaced with another image for use to better recognize the type of alert that will
appear.
Page 32 of 41
Issue Date:
[13-JAN-2015]
7.3 User Settings
Figure 30
Figure 30 shows the interface to add or delete user. The Platform allows two types of
users: Administrator and User.
Edit function to make changes.
Delete function
Search function
Page 33 of 41
Issue Date:
[13-JAN-2015]
Figure 31
Figure 31 shows the interface to edit user for both Admin and User mode. User can
also upload new image to be display as their profile image.
Page 34 of 41
Issue Date:
[13-JAN-2015]
Figure 32
Figure 32 shows the interface to edit user for both Admin and User mode. User can
also upload image to be display as their profile image.
Adding of user(s) into the platform
Download the list of user account from the platform
Mass upload of normal user instead of manual login.
Page 35 of 41
Issue Date:
[13-JAN-2015]
7.4 Device Settings
7.4.1 Device Settings
Figure 33
Figure 33 shows the list of devices currently available on the platform.
As Administrator account incorporated additional of devices, adding of new devices
function will be available to Administrator account.
Edit function to make changes.
Delete function
Search function
Adding of devices onto map location
Adding of devices into the platform
Page 36 of 41
Issue Date:
[13-JAN-2015]
Figure 34
Clicking on the
button of Figure 33 will bring user to this interface.
User can decide on the info, whether to leave them as blank or input info into the
respective field.
Multiple devices can also be added under a single entry.
Page 37 of 41
Issue Date:
[13-JAN-2015]
Figure 35
Figure 35 shows the interface to add in the device placement on the floor plan. Once
user had clicked on
button, Figure 36 will pop-out to let user choose a
device to place on the location chosen. Once a device is chosen, user can then
place the device onto the floor plan.
Page 38 of 41
Issue Date:
[13-JAN-2015]
Figure 36
Figure 36 shows the device list available on the platform. Clicking on the
button of any device, the floor plan will show the placement of the chosen device.
Click on the
button to place the device onto the floor plan.
Page 39 of 41
Issue Date:
[13-JAN-2015]
7.5 General Settings
Figure 37
Figure 37 shows the alert time setting function. Any changes to this timing will affect
all the alerts generated.
Page 40 of 41
Issue Date:
[13-JAN-2015]
Figure 38
Figure 38 shows the template in which user can utilize for common alerts generated.
This will save user time to input reply repetitively
.
Edit function to make changes.
Delete function
Page 41 of 41