Documenti di Didattica
Documenti di Professioni
Documenti di Cultura
Reference Guide
Copyright 2009 ComAp s.r.o. Written by Jaromr Paln Prague, Czech Republic
ComAp, spol. s r.o. Kundratka 2359/17, 180 00 Praha 8, Czech Republic Tel: +420 246 012 111, Fax: +420 246 316 647 E-mail: info@comap.cz, www.comap.cz
Table of Contents Introduction ........................................................................................................................................ 3 Web based system for monitoring and controlling of ComAp controllers ......................................... 3 Supported controllers ..................................................................................................................... 3 First Steps.......................................................................................................................................... 4 Start to using...................................................................................................................................... 5 How to Register(Become a User of the WebSupervisor) and Login?............................................... 5 How to Log out from the WebSupervisor? ...................................................................................... 6 How to Get a Forgotten Password to the WebSupervisor? ............................................................. 6 How to register gen-sets and engines?........................................................................................... 6 Security.......................................................................................................................................... 7 Accounts............................................................................................................................................ 8 Free............................................................................................................................................... 8 Premium ........................................................................................................................................ 8 Configuration...................................................................................................................................... 9 How to set-up new users? .............................................................................................................. 9 How to delete users? ................................................................................................................... 11 How to set-up new gen-sets and engines? ................................................................................... 12 How to edit existing gen-sets and engines? .................................................................................. 15 How to delete gen-sets and machines? ........................................................................................ 16 Map View......................................................................................................................................... 18 Color of the symbols? .................................................................................................................. 18 Parts of the Map View? ................................................................................................................ 19 Table View ....................................................................................................................................... 22 Parts of the Table View? .............................................................................................................. 23 User Comments ............................................................................................................................... 26 What is an User Comments?........................................................................................................ 26 How to add an User Comment? ................................................................................................... 26 Active Comment........................................................................................................................... 26 Detail view ....................................................................................................................................... 27 Importance of certain values? ...................................................................................................... 27 History ............................................................................................................................................. 29 History Definition.......................................................................................................................... 30 Parts of History View.................................................................................................................... 31 History Charts .............................................................................................................................. 32 History Table................................................................................................................................ 33 Reports ............................................................................................................................................ 34 Report specification...................................................................................................................... 34 Report types ................................................................................................................................ 35 Parts of Reports........................................................................................................................... 35
WebSupervisor Reference Guide, ComAp January 2011 WebSupervisor-2.0 Reference Guide 01-2011.pdf
Introduction
Web based system for monitoring and controlling of ComAp controllers
WebSupervisor is web based system designed for monitoring and controlling ComAp controllers via the internet. This system offers a number of beneficial features that help optimize revenue for machinery fleets, as each piece of equipment can be individually monitored for all important operation values. The system works when the controller sends regular updates to a remote secure serve which then safely stores the information ready for users to view. Connection to the server is easily accessible to any registered user through an internet enabled device such as PC, netbook or even a smart-phone enabling equipment monitoring at any time or place. The system provides a high level of administration and security, with the central administrator able to determine users access rights for specific equipment within the fleet as well as appropriate information. In addition, event generated emails can be created and sent to specific users to give fast and efficient notification to improve decision making or react to additional revenue generating opportunities. WebSupervisor offers equipment owners a number of powerful reporting tools allowing monthly summaries of availability and revenue creation ensuring that maintenance scheduling and asset utilization can be maximized for individual equipment and the whole fleet. The information generated from each controller can be archived for future analysis and trend evaluation.
Supported controllers
WebSupervisor supports next type of ComAp controllers: IG-NTC-BB IS-NTC-BB IG-NT version 2.5 and later IS-NT version 2.5 and later IL-NT-WSUP IL-NT-VA version 1.5 and later IL-NT-JD version 1.3 and later ID-Lite version 2.0 and later ID-Mobile version 1.3 and later
WebSupervisor Reference Guide, ComAp January 2011 WebSupervisor-2.0 Reference Guide 01-2011.pdf
First Steps
Connect ComAp Controller with WebSupervisor support to the Internet Use connection via AirGate or via IG-IB (public and static IP address) Is connection o.k.? Try it with InteliMonitor or LiteEdit or DriveMonitor
Do not have an account? See chapter How to Register(Become a User of the WebSupervisor) and Login?
Register new Unit into WebSupervisor. See chapter How to register gen-sets and engines?
WebSupervisor Reference Guide, ComAp January 2011 WebSupervisor-2.0 Reference Guide 01-2011.pdf
Start to using
How to Register(Become a User of the WebSupervisor) and Login?
You can start using WebSupervisor without installation any special software on your PC. To start and login into WebSupervisor: 1. Open http://websupervisor.comap.cz/ in your browser. The WebSupervisor homepage appears:
2. Insert your login name and password into field LOGIN NAME and PASSWORD, see below.
If you have not created an access, please send email to admin.websupervisor@comap.cz. Please send us Name, Login name, Email address and Timezone. We will create free account for you to start using it. 3. For immediate use you can try WebSupervisor with this access: a. LOGIN NAME comaptest b. PASSWORD comaptest
WebSupervisor Reference Guide, ComAp January 2011 WebSupervisor-2.0 Reference Guide 01-2011.pdf
1. 2.
To register new units click on Add new gen-set/engine If you already have some units registered in WebSupervisor to add new units please use: a. Click on Configuration
3.
WebSupervisor Reference Guide, ComAp January 2011 WebSupervisor-2.0 Reference Guide 01-2011.pdf
4. 5.
Select an item Add unit from Choose an action box. You can set-up new unit information. To continue please see chapter How to set-up new gen-sets and engines?
Security
SSL For added security during transmission secure connection - SSL could be used. Secure Sockets Layer (SSL), are cryptographic protocols that provide communications security over the Internet. To use SSL please open address in your Internet browser: https://websupervisor.comap.cz/
To change the level of security you can also use login page.
Internet Explorer security issue using SSL If the SSL connection is selected, all customer information is encrypted with SSL. Only the maps are not encrypted and therefore Internet Explorer notes it. If the query window in IE appears, select NO.
WebSupervisor Reference Guide, ComAp January 2011 WebSupervisor-2.0 Reference Guide 01-2011.pdf
Accounts
Two types of accounts allow you to use a different functionality in WebSupervisor.
Free
Free account is free for use, only registration is needed. See chapter How to Register(Become a User of the WebSupervisor) and Login? Enabled functions: 1. Map view 2. Table view 3. Detail view 4. History a. Period 1 hour b. Storage 1 month back 5. Configuration
Premium
Premium account has a full unrestricted functionality, for price please contact your Area Sales Manager. Full functionality is described in this manual.
WebSupervisor Reference Guide, ComAp January 2011 WebSupervisor-2.0 Reference Guide 01-2011.pdf
Configuration
Configuration is available only for users with relevant privileges. It means for Customer account, for users with Administration privilege or for users with privilege to modify the units.
Delegation
Can create Unit 3 To add new users do: 1. Click Configuration in the main menu.
2.
3.
WebSupervisor Reference Guide, ComAp January 2011 WebSupervisor-2.0 Reference Guide 01-2011.pdf
4. 5. 6.
7. 8. 9. 10. 11.
Insert full user name into User name field. E.g. Peter Newman Insert login name into Login name field. Better use one world with small letters. e.g. comapnewman Insert Password of this new account into Password field. This password will be used by the new user to login. Please use a strong password. A strong password must constitute the following: i. It needs to contain special characters such as @#$%^& ii. It must be at least 8 characters long. iii. It must not have any common words such as 123, password, your birth date, your login name and any words that can be found in the dictionary. iv. a variation of capitalization and small letters Select Language. This language will be used for communication between this new user and WebSupervisor. Select Time zone. In this time zone this new user will see all the time items. Insert email address into Email field. This email will be used in case of forgotten password. Account State leave as Enabled. If you want to have temporarily lock this account, please select Disabled. Account will be suspended until you select the Enabled option. Save the information of the new user by clicking button Save New User.
12. If you want to delegate the user by adding and deleting accounts and units, please click Administrator box.
13. Save the change of the new user by clicking button Save Changes.
WebSupervisor Reference Guide, ComAp January 2011 WebSupervisor-2.0 Reference Guide 01-2011.pdf
10
1.
2.
2. 3. 4.
Select an item Edit user from Choose an action box. Edit user screen appears. On right side you can select any user to delete it. To delete selected user please click on button Delete User.
WebSupervisor Reference Guide, ComAp January 2011 WebSupervisor-2.0 Reference Guide 01-2011.pdf
11
2.
Select an item Add unit from Choose an action box. Add new unit screen appears.
3.
WebSupervisor Reference Guide, ComAp January 2011 WebSupervisor-2.0 Reference Guide 01-2011.pdf
12
a. Insert name of unit into Unit Name field. This name will be used for identification this unit in WebSupervisor. b. Select the Time Zone in which the unit is. c. Select communication type in field Communication Type as an AirGate to activate connection via AirGate. d. Insert AirGate ID into AirGate ID. This information is available in controller in Values. e. Insert Controller Address into Controller Address field. This value is a SetPoint in controller, typically 1. f. Insert password for possibility to control the unit into Controller Password field. If you do not want to control it, please leave 0 in this field. g. Insert Access Code into Access Code field. By default 0. h. Select position of the new unit in the map. Please insert GPS coordinates directly into fields GPS Coordinates, or simply click into the map and fields GPS Coordinates will fill automatically. i. Select if the unit can use GPS Position. Choose Static - No GPS to disable GPS function, position of unit in the map screen is stationary. Choose Mobile GPS used to enable GPS function. Controller must be equipped with GPS module and the position of this unit in the map screen will be changed depending on the actual GPS position. Please do not choose this option if the controller does not equipped with a GPS module. j. Select Enabled for the Unit State. If you do not want to communicate with this unit and you do not want to delete it, please select Disabled. Communication will be suspended until you select the Enabled option. k. Insert email address into field Alarm Emails. In case of unit alarm at this address will be sent a message. For more addresses please use ; as a separator. 4. Connection via IG-IB Public and Static IP Address is necessary to connect unit by this way.
a. Insert name of unit into Unit Name field. This name will be used for identification this unit in WebSupervisor. b. Select the Time Zone in which the unit is. c. Select communication type in field Communication Type as an InternetBridge to activate communication via IG-IB. It is necessary to have a static and public IP address for this IG-IB. d. Insert IP Address into Host field. E.g. 192.168.1.50. Insert port number on which IGIB communicates into field following the colon. By default 23. e. Insert Controller Address into Controller Address field. This value is a SetPoint in controller, typically 1. f. Insert password for possibility to control the unit into Controller Password field. If you do not want to control it, please leave 0 in this field. g. Insert Access Code into Access Code field. By default 0. h. Select position of the new unit in the map. Please insert GPS coordinates directly into fields GPS Coordinates, or simply click into the map and fields GPS Coordinates will fill automatically. WebSupervisor Reference Guide, ComAp January 2011 WebSupervisor-2.0 Reference Guide 01-2011.pdf 13
i.
j.
k. 5.
Select if the unit can use GPS Position. Choose Static - No GPS to disable GPS function, position of unit in the map screen is stationary. Choose Mobile GPS used to enable GPS function. Controller must be equipped with GPS module and the position of this unit in the map screen will be changed depending on the actual GPS position. Please do not choose this option if the controller does not equipped with a GPS module. Select Enabled for the Unit State. If you do not want to communicate with this unit and you do not want to delete it, please select Disabled. Communication will be suspended until you select the Enabled option. Insert email address into field Alarm Emails. In case of unit alarm at this address will be sent a message. For more addresses please use ; as a separator.
Save the information of the new unit by clicking button Save New Unit.
New unit will start to communicate. User who will create this unit will be as its owner. The owner can set-up the access to this unit. To change the access to unit please see chapter How to edit existing gen-sets and engines?
WebSupervisor Reference Guide, ComAp January 2011 WebSupervisor-2.0 Reference Guide 01-2011.pdf
14
2.
Select an item Edit unit from Choose an action box or by clicking on icon anywhere in WebSupervisor. Edit unit screen appears. On right side you can select any unit and change any information.
3. 4.
Normally you can change information as it is described in chapter How to set-up new gensets and engines? In addition a change of User Permissions can be done.
WebSupervisor Reference Guide, ComAp January 2011 WebSupervisor-2.0 Reference Guide 01-2011.pdf
15
5.
There is a table with users associated with the customer account. You can choose how any user can access the selected unit. a. User Name name of user b. Read user can only read the unit c. Control user can start/stop the unit d. Modify user can do any changes with unit 6. Save the change of the unit by clicking button Save Changes
WebSupervisor Reference Guide, ComAp January 2011 WebSupervisor-2.0 Reference Guide 01-2011.pdf
16
2.
3. 4.
Edit user screen appears. On right side you can select any unit to delete it. To delete selected unit please click on button Delete Unit.
WebSupervisor Reference Guide, ComAp January 2011 WebSupervisor-2.0 Reference Guide 01-2011.pdf
17
Map View
To show all users units in a map click on Map in the main menu. Map View also appears as a first page after login. The units that are presented depend on the user that is logon in the system. Period of data recovery is one minute.
1. 2. 3. 4. 5. 6.
Gen-set or engine is Loaded. Any shutdown is active. Any warning is active. Unit is ready to start. Communication is not online or communication is starting. Unit Stops, is Starting or Running, no alarm is active.
WebSupervisor Reference Guide, ComAp January 2011 WebSupervisor-2.0 Reference Guide 01-2011.pdf
18
7.
Disabled
Frame color Color of the frame around the icon represents auxiliary information.
1.
Blue
It means that any User Comment for the unit is active. See chapter User Comments. It means that position in the map is not an actual one from the GPS module, but the position is last known. Only for units equipped with GPS module. It means that unit information is locked in the map. All information is visible independently if mouse cursor is or not above the unit symbol.
2.
Brown dashed
3.
Red
1 4
WebSupervisor Reference Guide, ComAp January 2011 WebSupervisor-2.0 Reference Guide 01-2011.pdf
19
Interactive map of the world. All users units are placed in the map. Each units is represented
Zoom tools. To change map zoom or select actual view please use the map tool.
zoom-out
a. Click the map navigation home icon to get all available units view back b. To change zoom also you can use mouse double-click somewhere in the map.
double click
c.
To change the view of the map you can use mouse button.
WebSupervisor Reference Guide, ComAp January 2011 WebSupervisor-2.0 Reference Guide 01-2011.pdf
20
Navigation. There is a list of all users units at the right column. For each unit some action is available.
Click to zoom map on selected unit. Click to update configuration of selected unit. See chapter How to edit existing gen-sets and engines? Click to see details of selected unit. See chapter Detail view Click to see history of selected unit. See chapter Histo
Unit information. Move mouse cursor over unit symbol to see the basic unit information.
Of course an active User Comment is shown, see chapter User Comments. Click the unit name in right column to display and lock unit preview and highlight the unit icon on map. It means that unit information is locked in the map. All information is visible independently if mouse cursor is or not above the unit symbol. The color of item in list is changed to a pink and the frame is changed to red color. Click the unit name to disable the function.
WebSupervisor Reference Guide, ComAp January 2011 WebSupervisor-2.0 Reference Guide 01-2011.pdf
21
Table View
To show all users units in a one table click on Units in the main menu. The units that are presented depend on the user that is logon in the system. Period of data recovery is one minute.
WebSupervisor Reference Guide, ComAp January 2011 WebSupervisor-2.0 Reference Guide 01-2011.pdf
22
List of units. There is a list with all users units. For each unit some basic information is presented and the unit is represented by one row.
st
Unit Name Name of unit defined in Configuration Specific information according to the type of unit Specific information according to the type of unit Unit State Actual state of unit
Gen-set or engine is Loaded. Any shutdown is active. Any warning is active. Unit is ready to start. Communication is not online or communication is starting.
WebSupervisor Reference Guide, ComAp January 2011 WebSupervisor-2.0 Reference Guide 01-2011.pdf
23
Unit Stops, is Starting or Running, no alarm is active. Communication with unit is disabled. (Unit State is Disabled) 5th column Alarm Alarm state of unit
No alarm is active. Any warning is active. Any shutdown is active. 6th column Links Available actions for the unit
Click to zoom map on selected unit. Click to update configuration of selected unit. See chapter How to edit existing gen-sets and engines? Click to see details of selected unit. See chapter Detail view Click to see history of selected unit. See chapter Histo
If the row is selected mouse cursor is moved over it the color of row is changed do gray. At that moment, on the right side appears more detailed information about the unit, please see 3 . Click the unit row in table to display and lock unit details, the color of row is changed to pink.
Display units management. If the number of units is bigger than adjusted rate, the list of units is splitted to more pages. The number of shown units could be adjusted by navigation tools. Please select the displayed number of units using Units per page option.
All 10 20 50 100
Show all units on one page Show 10 units per one page, more pages are available Show 20 units per one page, more pages are available Show 50 units per one page, more pages are available Show 100 units per one page, more pages are available
WebSupervisor Reference Guide, ComAp January 2011 WebSupervisor-2.0 Reference Guide 01-2011.pdf
24
If the option 10, 20, 50 or 100 is selected and more pages are available, to change the active page please use navigation tool.
Go to the first page Go to the previous page Shows which page is active Go to the next page Go to the last page 3
Unit detail view. If any row of unit is selected, detailed information about the unit appears. To determine the importance of values please see chapter Importance of certain values?
WebSupervisor Reference Guide, ComAp January 2011 WebSupervisor-2.0 Reference Guide 01-2011.pdf
25
User Comments
Active Comment
Text of active user comment is displayed on the map page, see chapter Parts of the Map View? Unit with active comment is labeled with blue frame .
To confirm the active comment and mark it as non-active use button Mark as Read.
WebSupervisor Reference Guide, ComAp January 2011 WebSupervisor-2.0 Reference Guide 01-2011.pdf
26
Detail view
All values read from controller are available on page Detail View. To open it, please click on anywhere in Map or Table View. Period of data recovery is one minute.
No alarm is active.
WebSupervisor Reference Guide, ComAp January 2011 WebSupervisor-2.0 Reference Guide 01-2011.pdf
Alarm List
####
Value is not accessible
n/a
Value is not available for now, it has not been read yet Comments List of the user comments. See chapter User Comments. Last Update Time of last update values. Service Info Internal information for support issues only. Navigation tools
Click to see history of selected unit. See chapter History. Click to zoom map on selected unit. Click to update configuration of selected unit. See chapter How to edit existing gen-sets and engines?
WebSupervisor Reference Guide, ComAp January 2011 WebSupervisor-2.0 Reference Guide 01-2011.pdf
28
History
To show history of unit values please click on History in the main menu. Also to open it you can click on anywhere in the Map, Table or Detail View. This is a special history generated by WebSupervisor.
Values in history could be displayed as a chart (graph) or as a table. For changing mode please use the switch.
WebSupervisor Reference Guide, ComAp January 2011 WebSupervisor-2.0 Reference Guide 01-2011.pdf
29
History Definition
WebSupervisor stores values automatically in two ways. The values for which the history is available please see in article 3 . History is saved with a period of one hour. Depending on the type of account is available 2 years back (Preminum account) or 1 month back (Free account). 1. Controller is automatically adjusted to keep the values each hour. These values are saved into WebSupervisor history afterwards. The time format should be like as 09:00:00. Every hour
2. For increasing reliability of history, once an hour the values are read from the controller directly. It works regardless of whether the user is logged or not. Values are not synchronized to the hour. Every hour Periodical data reading Internet WebSupervisor History Web Supervisor
WebSupervisor Reference Guide, ComAp January 2011 WebSupervisor-2.0 Reference Guide 01-2011.pdf
30
2 1
3
1
Select a unit. From the list of users units you can choose one for which history appears. To show the history click on button Generate View.
Periods of time. To select the period for which history appears please use From and To field.
For simpler selecting the period you can use the abbreviated selections. Last week Last month Last 3 month Last year Select values from history for one week back from now Select values from history for one month back from now Select values from history for 3 months back from now Select values from history for one year back from now 31
WebSupervisor Reference Guide, ComAp January 2011 WebSupervisor-2.0 Reference Guide 01-2011.pdf
Displayed Values. You can select only certain values for which history appears. Just select from the list. For table history all values appears independently on selection.
history is displayed
History Charts
Value name
Value
Time axis Each selected value is shown individually in one chart. Scale for axes could not be changed. It is possible to select start and end date, see section 2 . Missing values Individual points in the graph are connected by line. In the event that the values were not available at that time, typically when the loss of communication, lack of points in the graph and neighboring points are not connected.
WebSupervisor Reference Guide, ComAp January 2011 WebSupervisor-2.0 Reference Guide 01-2011.pdf
32
Text values in a chart Text values in a chart for possibility to display are converted to numeric values. Each state of the value is assigned to a unique number. The assignment is displayed in the upper left corner of the chart. The chart then shows a numerical variable, and each point corresponds to state of text value. Example: Number 10 means unit has no alarm at the appropriate time. Number 11 means that at the time unit has an alarm Wrn Fuel Level. Number 12 means that at the time unit has an alarm Wrn Batt Volt.
History Table
All values are presented in the table independently which values are selected. One row corresponds to one record. First column is always the time stamp. Other columns present the individual values at the time in first column. 5
Navigation tools.
Click to zoom map on selected unit. Click to see details of selected unit. See chapter Detail view Click to update configuration of selected unit. See chapter How to edit existing gen-sets and engines?
WebSupervisor Reference Guide, ComAp January 2011 WebSupervisor-2.0 Reference Guide 01-2011.pdf
33
Reports
To show reports please click on Reports in the main menu.
Report specification
Reports can be displayed separately for each unit. The period for which the report is calculated is one calendar month. Report is divided by days, each row is one day. For the selected values are shown the total sum for chosen month.
Chosen Month
Report
WebSupervisor History
WebSupervisor Reference Guide, ComAp January 2011 WebSupervisor-2.0 Reference Guide 01-2011.pdf
34
Report types
Each product line has its own form report. Type of report is automatically selected according to product line: 1. IL-NT product line 2. IS/IG-NT product line 3. Drive product line
Parts of Reports
2 1
4
1
Select a unit. From the list of users units you can choose one for which report appears. The name of that unit is displayed in the left top corner. To show the report click on button Generate Report.
Selected period. To select the month for which report appears, please use the list of available months.
WebSupervisor Reference Guide, ComAp January 2011 WebSupervisor-2.0 Reference Guide 01-2011.pdf
35
The Month for which the report is calculated The total number of hours per month [h] The total electrical energy produced per month [kWh] What percentage of hours per month the unit was running or was ready to run [%] -------------------------------------------------------------------------------------------------------------------------Date The Date for which values are displayed on the appropriate line Total Energy Counter status of the Electrical Energy produced at the end of the day [kWh] Energy Produced Electrical Energy produced per day [kWh] Total Run Hours Counter status of the Run Hours at the end of the day [h] Run Hours Run Hours per day [h] Available Hours How many hours per day the unit was running or was ready to run [h] 2. IL-NT product line
Month The Month for which the report is calculated Hours in Month The total number of hours per month [h] -------------------------------------------------------------------------------------------------------------------------Date The Date for which values are displayed on the appropriate line Total kWh Counter status of the Electrical Energy produced at the end of the day [kWh] kWh / Day Electrical Energy produced per day [kWh] Total Run Hours Counter status of the Run Hours at the end of the day [h] Run Hours / Day Run Hours per day [h] Num Starts Counter status of the Num Starts at the end of the day Fuel Level Value Fuel Level at the end of the day [%] Battery Volts Value Battery Volts at the end of the day [V] WebSupervisor Reference Guide, ComAp January 2011 WebSupervisor-2.0 Reference Guide 01-2011.pdf 36
Month The Month for which the report is calculated Hours in Month The total number of hours per month [h] -------------------------------------------------------------------------------------------------------------------------Date The Date for which values are displayed on the appropriate line Total Fuel Counter status of Total Fuel Consumption at the end of the day [L] Fuel / Day Fuel consumption per day [h] Total Run Hours Counter status of the Run Hours at the end of the day [h] Run Hours / day Run Hours per day [h]
Total sums. Some columns contain a total sum for the month. The value of the total sum is displayed under the appropriate column so the name and unit of value is same as that column.
Navigation tools.
Click to see history of selected unit. See chapter History. Click to zoom map on selected unit. Click to see details of selected unit. See chapter Detail view Click to update configuration of selected unit. See chapter How to edit existing gen-sets and engines?
WebSupervisor Reference Guide, ComAp January 2011 WebSupervisor-2.0 Reference Guide 01-2011.pdf
37