Boomerang System Administrator Manual

Transcription

1 Boomerang System Administrator Manual SG B2.doc Page 1 of 43

2 Table of Contents INTRODUCTION...4 BOOMERANG CLIENT...5 FILE Logout Exit... 6 VIEW Sensors events view Communication events view System events view Audit trail Alarm view System overview Sensor alarms tab System alarms Signing event in Alarm view Horizontal/Maximized view... 9 ADMINISTRATION APPLICATION SETTINGS Application settings - General Application settings - Language Application settings Application settings - GSM device General Embedded script Application settings - Transitions groups Application settings - Alarms Application notifications Alarm Dispatch ADMINISTRATION ALARM CONTACT SETTINGS...17 ADMINISTRATION USER MANAGEMENT Create/Edit user Add users to user groups Export list of users...18 ADMINISTRATION USER GROUP MANAGEMENT Add/Create groups for users User management in user groups Send to a group of users...19 ADMINISTRATION OBJECT GROUP MANAGEMENT Add/Rename group of sensors/object Add sensors to the groups Connect sensor/object groups to user groups to group...21 ADMINISTRATION - DATABASE BACKUP SETTINGS Manual backup Backup schedule...22 SG B2.doc Page 2 of 43

3 10.3. Restore database...22 ADMINISTRATION RESULT CODES...23 ADMINISTRATION CREATE REPORTS Create report Preview and print of the report Save the report ADMINISTRATION EXPORT DATA...27 ADMINISTRATION ADD SYSTEM COMMENT Add a system comment...28 ADMINISTRATION ADD PC-NODE Add a PC node/measuring unit S2 node ADMINISTRATION ADD NODE Add Node/measurement node...30 HELP Installation information About...34 TREE VIEW MENU Settings Sensor - Change settings of sensor Change data Configure values, control and calibration Settings PC-node - Remove node Create a folder of sensors Remove Sensor and Node Search sensor Add unit comment...39 SENSOR VIEW Graph hide/view Value in list format hide/view Events hide/view Sensor view settings Graph types Graph Zoom in/out Average line in graph Signing event in Sensor view SUPPORT LOCAL SUPPLIER SG B2.doc Page 3 of 43

4 Introduction The instructions in this manual are intended for the system administrator of the system, the manual is created for version of Boomerang version and higher. ICU Scandinavia AB reserves the right to modify or update this document at any time without notice. SG B2.doc Page 4 of 43

5 Boomerang Client The Boomerang client is used when running Boomerang as a service. Enter the server address and username and password to get access to the Boomerang system. SG B2.doc Page 5 of 43

6 File 3.1. Logout... This is used to logout from the Boomerang 3.2. Exit This will close Boomerang is running as standalone application. If Boomerang this will have the same function as Logout. SG B2.doc Page 6 of 43

7 View 4.1. Sensors events view This view will show sensor events for all sensors for a given period. The shown interval can be changes by changing the start and end date and refresh the view by pressing the Refresh button. The items can be viewed in details. Double click on the item to view in detail a new dialog will be open for the selected item Communication events view This view will show all communication events for a given period. The shown interval can be changes by changing the start and end date and refresh the view by pressing the Refresh button. The items can be viewed in details. Double click on the item to view in detail a new dialog will be open for the item System events view This view will show all System events for a given period. The shown interval can be changes by changing the start and end date and refresh the view by pressing the Refresh button. The items can be viewed in details. Double click on the item to view in detail a new dialog will be open for the item Audit trail To get a audit trail of system event in a document export the data from the chosen interval by simply press Export and follow the instructions. SG B2.doc Page 7 of 43

8 4.4. Alarm view To view the Alarm status chose Alarm status in the View menu System overview When the system is OK and all alarms have been signed all bares shall be green Sensor alarms tab When a sensor alarm is trigged a list of open items is viewed. To view details of the open item select the tab related to the alarm, double click on the item to view/sign. The open items for sensors can also be open in the event view of the sensor in the sensor view. If you press on the bottom left button will you get directly to the sensor, that generated the alarm. SG B2.doc Page 8 of 43

9 System alarms When a system alarm is trigged a list of open items is viewed. To view details of the open item select the tab related to the alarm, double click on the item to view/sign Signing event in Alarm view Mark the row with the alarm that shall be signed. If several alarms are to be signed mark the alarm by press shift button and click on the other alarms. Press sign and a dialog will be open. Sign the alarm(s) and press OK Horizontal/Maximized view In the horizontal view it is possible to see all open windows placed horizontal over one and other. Click on the window that shall be in selected. To enter horizontal view chose Horizontal View in the View menu. To only view one window at a time select Maximized view SG B2.doc Page 9 of 43

10 Administration Application settings To access the application settings select the Application settings in the Administration menu Application settings - General Prefilled username and password In General it is an option to select the Boomerang users to have prefilled username and password when logged into the Boomerang client. Revise the password periodically It is an option to revise the password periodically and with settable interval. Blocked of users after 3 incorrect login attempts The user can be blocked after 3 incorrect login attempts on the Boomerang client, the password has to be generated by the administrator of the system. System name The system name is used in reports and s sent from the system Here can the user change so that Boomerang remembers the Username and password. The user can also enter so that the password must be changed within 1-12 month. SG B2.doc Page 10 of 43

11 5.2. Application settings - Language The selected language is shown. To change language, select the language and press Apply and sign the change. The application has to be restarted to apply the changes Application settings - To set up account for distribution and sending of debug in the Boomerang application and account is needed. Setup/Change settings - Type the reply address the address that shall send the message. - Type the subject that shall be displayed in s sent from Boomerang application. - Type the message header that be in s sent from Boomerang application. - Type the SMTP server and port number valid for your account. - If authentication is needed on the account, enable the checkbox and type the Username and Password. Press Apply and sign the settings/changes Test settings - To test the settings fill in an address in the text box after the Test button - Press Test - The dialog shall appear Message was sent ok. If not a dialog which is describing the error will be displayed. (Follow instruction in the dialog to correct errors and retry to send the test , check with contact person for the creation and settings of accounts). SG B2.doc Page 11 of 43

12 5.4. Application settings - GSM device General The GSM device used shall be approved and verified for usage with the Boomerang application. Setup/Change GSM/SMS settings Enabling the GSM unit by ticking the check box Enabled - Select the serial port that the GSM unit is connected to Enter pin code - Message prefix, if a prefix on this application shall be sent on the SMS message the prefix shall be entered here. Signal strength indicator, the indicator shall preferable be on green indication. Press Apply and sign changes applied. Test message To send a test SMS, enter a number to send message to in Test Message and press Send to Check balance If a Prepaid card is used (not recommended) this field may be used to check saldo of the prepaid card. (Get the code for the saldo from your provider). SG B2.doc Page 12 of 43

13 Embedded script The embedded script function is only available with a special GSM/SMS module provided by ICU Scandinavia. This function will send SMS if the Boomerang service is not terminated in a correct way. Enable function To enable this function enable the checkbox Use watchdog Set the interval Watchdog trigger timeout Select receivers of message This is done by setting up a start and stop number of the SIM-card phonebook Edit receiver by adding receivers in phonebook. Enter the message to send when a failure has occurred. Press apply to apply the settings/changes and sign the changes. SG B2.doc Page 13 of 43

14 5.5. Application settings - Transitions groups This function is used to be able to send parallel messages on S2 nodes in the system. This function can only be used if masters are used in different locations on sites that don t interfere on radio with each other. Create/edit different groups of masters that don t interfere. The function can be enabled and disable by the checkbox Application settings - Alarms Application notifications Alarm sound - Every time an alarm occurs (even if same alarm) - Never Select the valid option by mark the item and press Apply and sign the changes. SG B2.doc Page 14 of 43

15 Alarm Dispatch In the Alarm Dispatch settings it is possible to add modules and components do be used to distribute alarms. Select the type to add and press Add Configure the settings of the alarm dispatcher type and press Apply and sign the adding of alarm dispatcher. The settings of the alarm dispatcher vary from alarm dispatcher to alarm dispatcher described below CCP Terminal The CCP Terminal is an alarm indicator. The indicator will give an overview of the status of measuring objects. The CCP terminal requires a static IP address. It is possible to install several CCP terminals in the Boomerang application. - Select the CCP Terminal and press Add - A dialog is open, type the Name of the CCP Terminal. - Enter the IP address of the CCP Terminal - Test the connection to the CCP Terminal by pressing Test, the CCP Terminal will blink on/off with all LEDs - If all settings are correct press OK and sign the adding of the CCP Terminal. To connect the alarms to the CCP Terminal continue to Alarm contacts connect alarms to the different lamps of the CCP Terminal Pager Pager module, with this module it is possible to distribute alarms to pagers, the module support both text and number based pagers. (The text message must also be supported by the operator; to use the pager module a GSM module is required). SG B2.doc Page 15 of 43

16 Add a pager to the Boomerang system - A GSM unit must be installed on the Boomerang system - Select the Pager and press Add - A dialog is open, type the Name of the pager. - Enter the Number to the pager - Select the type of pager that is used - A test of the pager settings is mandatory, perform the test by press the Test - If all settings are correct press OK and sign the adding of the pager. To connect the alarms to the pager continue to Alarm contacts Alarm Dispatch options IP-Switch Plug 801 The IP-Switch plug is a power plug that can be controlled via Ethernet. This gives the option to distribute an alarm to e.g. an alarm lamp or a horn. IP-Switchbox810 The IP-Switchbox is a relay box that be controlled via Ethernet, this gives the option to distribute an alarm to e.g. to existing alarm systems, alarm lamps or a horns. SG B2.doc Page 16 of 43

17 Administration Alarm Contact Settings There are several options to distribute alarms in Boomerang application. To set up the alarm distribution, open the Alarm contacts settings. in Administration menu. Select alarms/units to distribute Select the units to be included in the alarm and press New Chose period Select the days and time to distribute the alarm Select the distribution method - , enter address to sent message to. - SMS, enter GSM number to sent SMS to - Pager, select the pager to sent to, this has to be set up in alarm dispatcher menu first. (This requires a GSM unit) - CCP terminal (Critical Control Point terminal), optional Select if delayed alarm shall be used If you tick in Use only of unsigned after box and choose a time, then will Boomerang send out a new alarm. Connect alarms to user or user groups When creating an alarm contact for a sensor this is done by connecting this to a user group. When a user is added or removed this will also be handled in the alarm contacts. SG B2.doc Page 17 of 43

18 Administration User Management Data in User Management can be sorted in this menu be pressing on the header of the fields Create/Edit user The address and GSM number is used in sending alarms when the user is connected in alarm contacts either as a user or a member of a user group. The created user has to change password at first login Add users to user groups The created user must belong to a user group that has access to sensors 7.3. Export list of users Press the Export list to create a document of users from the Boomerang system SG B2.doc Page 18 of 43

19 Administration User Group Management 8.1. Add/Create groups for users Groups can be either different companies or groups within a company User management in user groups Add user to the group by selecting and adding them 8.3. Send to a group of users This function requires a mail client on the computer that runs Boomerang client, select the group and right click on the group. SG B2.doc Page 19 of 43

20 Administration Object Group Management 9.1. Add/Rename group of sensors/object Press the Add to create a new group. To rename a group mark the group to edit and press Rename 9.2. Add sensors to the groups Select the group to add a sensor to. Select the sensors in the sensor window. Apply the changes and sign. SG B2.doc Page 20 of 43

21 9.3. Connect sensor/object groups to user groups Select the group to connect sensors and/or user groups to. Press Add user to group to add user or Add group to group to add group. Apply changes and sign to group This function requires a mail client on the computer that runs Boomerang client, select the group and right click on the group. SG B2.doc Page 21 of 43

22 Administration - Database backup settings Manual backup To do a manual backup select Administration Database backup settings Select the directory to place the backup files in and press Backup now button. A dialog is opened when backup is performed, press OK The Backup files is stored in a sub directory of target director named with date and time e.g. C:\Program Files\ICU\Boomerang\Backups\2006_09_26_21_ Backup schedule To set up a backup schedule select Administration Database backup settings - Select the directory to place the backup files in. - Select the checkbox Use automatic backups - Select the number of backups that shall be stored before deleted - Press Apply to store the settings and sign the settings Note. If a network driver is selected make sure that Boomerang application has access to the drive. If the computer doesn t have a network access it is recommended that the backup is stored in a separate hard disk drive Restore database The restore of Boomerang database is not part of the Boomerang application. The SQL tool is used for this handling. This instruction is described in a separate document. SG B2.doc Page 22 of 43

23 Administration Result codes The result codes are connected to object groups. Select the group to handle result codes for. Chose to create new, edit existing or to delete existing codes to. Apply changes and sign. SG B2.doc Page 23 of 43

24 Administration Create reports Create report To create the report chose Administration Create reports A Create reports dialog is opened - Select the type of report to create - Select start and end date - Press Next >> A dialog for selecting sensors is opened - Select which measurement points to include in the report. - Press Next >> SG B2.doc Page 24 of 43

25 Preview and print of the report If a preview of the report is wanted tick the box Generate preview and press Generate report The preview is generated To view other pages use the arrows to step forward and backwards in the report. Print of report press the printer symbol. A print dialog is opened, choose the printer and press OK. When the report is printed, close the preview and close the report generator SG B2.doc Page 25 of 43

26 Save the report To save a report to file uncheck the tick box Generate preview, select which format to use and press Generate report. Choose a folder to store the report in. If the folder doesn t exists, press Make New Folder to create a new folder. Chose folder and Press OK While the report is generated a dialog displaying status is shown. When the report is generated a dialog is shown Report generated. Press OK to close the dialog. The report is generated and stored in the chosen location in this example as Temp - Refrigerator 15.pdf (Sensor name). Close report generator Press Cancel to close the Create report dialog. SG B2.doc Page 26 of 43

27 Administration Export data The export function gives the user to work with the sensor data in other applications.one example could be to present graphs in Microsoft Excel. To export data select the Export data in the Administration menu. Select which sensors to export data from and chose period by typing start and end date. Select the format to export to. Excel or text based format. Select the folder to export the data to. It is recommended to creating a folder for the period of data. Each sensor will have a file for the period that has been set. The file name will be the sensors name. If the folder doesn t exist make the new folder by pressing the Make New Folder button. When the export is completed a dialog appears Export complete! Exit the export menu by pressing Close The file can be opened from external application in the folder that they have been exported to. SG B2.doc Page 27 of 43

28 Administration Add system comment Add a system comment Add a system comment by selecting Add system comments in the administration menu Type the information and sign the comment SG B2.doc Page 28 of 43

29 Administration Add PC-Node Add a PC node/measuring unit Select Administration menu and then click on Add PC-Node. A dialog Choose PC node appears. Select the type of node to install and fill in data in the different steps S2 node If A dialog PC node settings appears, name the PC node, and select the node net (The node net is the node net that the nodes have been assigned to) and select the Serial port that the PC-node has been installed in. To test the setup, press the Test button. Press OK button to complete the installation. If the show PC-Nodes is selected to be shown the PC-node will appear in the tree view. SG B2.doc Page 29 of 43

30 Administration Add Node Add Node/measurement node In this example a standard measurement node, for other specific nodes see information available for that node, settings may vary depending on type of node. Observe that unsigned changes will be indicated in the tab with a!, when signed the! will disappear. Start installation of node/sensor Press the Administration menu and then click on Add node A dialog Choose PC node appears. Select the type of node to install and fill in data in the different steps. Configure sensor Next step is to configure the chosen sensor the configuration may vary a bit depending on which sensor that shall be configured. The configuration in this example of node/sensor is divided in five tabs General, Logging, Graph, Alarm and Result Codes. When all configurations are done press confirm and if several sensors are to be configured the next sensor will appear. SG B2.doc Page 30 of 43

31 Tab General In the first tab General the name of the sensor shall be typed, this is the name that will be shown and used in the Boomerang application. The name must be unique for every sensor. Select the next tab that shall be configured Logging tab In the Logging tab the interval of logging is set up, if filters for log shall be used set the number of readings that shall be above/beyond alarms levels to trigger an alarm. (This feature is used to filter e.g. defrost cycles that shouldn t trigger an alarm). It is also possible to filter glitches in readings by limiting the difference in between readings. If a reading is bigger then this set value a new reading is done and logged. SG B2.doc Page 31 of 43

32 Graph tab Graph tab, in this tab the settings of the graph is set. The Display decimals in graph is the number of decimals that shall be shown in the user interface of the Boomerang application. The maximum and minimum values of the graph can be set in to different ways. To use manual settings deselect the Use auto scale and type the minimum and maximum value of the graph, to use auto scale select the Use auto scale checkbox, the application will scale the graph continuously depending on the readings value. Alarm tab Use alarms If alarm limits shall be used the Use alarms checkbox shall be selected. If alarm limits is set up but shall not be used this can be deselected by deselected Use alarms check box. Temporary disable alarms (limits only) To use this function check the checkbox and select the start and stop time for this selection. SG B2.doc Page 32 of 43

33 Create/edit alarm limit To create a new/edit alarm limit press New or Edit The alarm limit shall be named and type of limit Alarm/Warning. This will be displayed as to different icons in the application. Select level of the alarm/warning high and/or low levels. Type the value of the alarms. Press OK As the last step the new alarm shall be Applied and signed. To apply press the Confirm button and sign the new alarm. If the alarm shall not be saved nor applied close the dialog by pressing Close if this is the case a control dialog is open to ensure that the settings/changes shouldn t be applied. SG B2.doc Page 33 of 43

34 Help Installation information In the Installation information data about the modules is presented About To view information about version of the installed version of the Boomerang application, select About in the Help menu SG B2.doc Page 34 of 43

35 Tree view menu Settings Sensor - Change settings of sensor To change settings of the node mark the sensor to change. Right click on the sensor and select Settings Change data Select the tab to change data in. Make sure to Apply changes in every tab to confirm the changes. Sign the changes SG B2.doc Page 35 of 43

36 Configure values, control and calibration To achieve accurate measurement values from the system, it has to be calibrated. To calibrate a sensor select the sensor and right click with the mouse and select settings Select the Configuration tab. If the tab doesn t appear make sure that the user level is authorised for calibration. The current value is showing the value present on the sensor including the calibration offset present. To clear the offset calibration, press Reset adjustment button. The calibration supported is one point calibration and shall be performed in the temperature range there the sensor shall operate. There are two different values of inserting the calibration. - Type the Adjustment offset and press Apply adjustment offset Or - Type the reference value given from the reference thermometer, the offset is calculated by the Boomerang application. Comments field, type information related to internal routines. Information could be such as reference thermometer, calibration temperature, next calibration date etc. SG B2.doc Page 36 of 43

37 18.2. Settings PC-node - Remove node To remove a node, select the PC node which the node belongs to and right click on the mouse and selects Settings Select the node to remove and right click on the node and select Remove. The Boomerang will not allow deleting of node if the node is used for linking. Press OK, change the used linking and start deleting the node. If the node that shall be deleted has sensors connected the user will be redirected to delete sensors before deleting the node. Confirm and sign deleting o sensors. When deleting the node a dialog will be opened, confirm deleting of node and sign the taken action Create a folder of sensors You can create folders in a tree structure for all nodes. This feature helps you keeping track of your nodes, that you are interested in working with. SG B2.doc Page 37 of 43

38 You create folders like this: Press Right mouse key once in the folder view, select Add new folder in the menu that is opened. Name the group with a freely chosen name, for example Second Floor. Drag and drop the sensors to the folder that the selected sensor shall be moved to Remove Sensor and Node To remove a sensor selects the sensor to remove and right click on the mouse. Click on Remove A dialog is open to confirm removal of sensor, press Yes to continue No to cancel removal of sensor. Sign the removal of sensor. Removal of sensor completed, all information of the removed sensor is to be found in folder Removed sensors. This folder is viewed when you presses on view, and then enable Show Removed sensors. SG B2.doc Page 38 of 43

39 18.5. Search sensor This feature makes it easy to be able to find existing sensors, active sensors old names and removed sensors. - Right click in the folder view and select the Search Sensor - Type the name to search for, in the example below sensor with the * to sensor for all sensors with the start of name sensor - Select if Matching of size of letters shall be used. - Select which sensor shall be included in the search, such as Include removed and/or Search old names by selecting these tick boxes. Press Search The search result is presented, select the sensor that you want to view, in this case the sensor_1 is marked press Select Add unit comment To add a unit comment e.g. defrost done on refrigerator is added by mark the sensor to add the comment to and right click with the mouse and select Add unit comment - Type the information and sign the comment - The comment is found in the event history for the sensor SG B2.doc Page 39 of 43

40 Sensor view The sensor view consists of three sub fields that can be selected to be viewed or not by selecting or deselecting the icons for the different fields. The fields are marked with numbers below. 1. Sensor graph 2. Sensor list of values 3. Sensor events Graph hide/view The user can selecting or deselecting button if Graph shall be shown in the view Value in list format hide/view The user can selecting or deselecting button if Values in list shall be shown in the view Events hide/view The user can selecting or deselecting button if events shall be shown in the view. Here can also the user choose to sort out the Event date, Sensors, Description and Sign rows. By clicking on them will they be sort different. SG B2.doc Page 40 of 43

41 Sensor view settings The user can select the period that shall be shown in the Sensor view by pressing the button. The interval can be set by entering start and end date or by selects the number of days that shall be shown in the sliding window. Show maximum and minimum value in the graph if you tick that box in, you will see the min and max temp in Graph view. The user can also select the shape of how the graph shall be displayed. To apply the edited data press OK Graph types Different graph types can be selected Graph Zoom in/out To view the graph in better detail the user can zoom in details. The zoom is not a setting of view; it is only a temporary detailed view. To zoom in the user has to place the arrow in the top left corner of the area to be viewed. Click and hold down the left button of the mouse and drag to the button right corner of the selection and a blue rectangular will indicate the area shown. To apply the zoom functions release the left button of the mouse. To zoom out and have full view according to settings of the graph the user has to press the normal N button Average line in graph Enable the average line in the graph (green dot line) by selecting average by selecting the average button A, disable the average line by deselecting the average button Signing event in Sensor view The alarm can be seen in the Alarm status at the button of the folder view and in the Sensor sub view, event history. To get more detailed information on the event double click on the line in the event history. To go to the Alarm view double click on the alarm displayed at the button of the folder view. SG B2.doc Page 41 of 43

42 Copyright The contents of this document are copyright of ICU Scandinavia AB or its subsidiaries. All Rights Reserved. You may view, print, copy and distribute information from this document provided that: (a) the information is used internally (by you or any third party to whom you distribute it) only for informational, non-commercial purposes; (b) no fee may be charged for distribution of any information to any third party; (c) any and all copyright or other proprietary notices that appear herein, together with this legal notice, must appear on all copies that you make or distribute; and (d) no material may be modified, edited or taken out of context such that its use creates a false or misleading statement or impression of the document. Modifications to the contents of this document are expressly prohibited. Trademarks ICU Boomerang, ICU ROQS and ICU System are all trademark of ICU Scandinavia AB. ICU Scandinavia is also a trademark. All other company names, products and services used herein are trademarks or registered trademarks of their respective owners. SG B2.doc Page 42 of 43

43 Support, Local Supplier SUPPORT, SUPPLY OF PARTS AND INSTALLATION ETC: Phone: vx. - info@comfort-control.se - Roger Sundberg or cell. roger.sundberg@comfort-control.se Linus Klippberg or cell. linus.klippberg@comfort-control.se SG B2.doc Page 43 of 43