Touchpoint Pro Webserver Software User Guide

USER GUIDE
Touchpoint Pro Webserver
Revision History
Version
Description
Date
1.00.00
First Issue
07/07/2015
ii
Disclaimer
In no event shall Honeywell be liable for any damages or injury of any nature or kind, no matter how caused, that arise
from the use of the equipment referred to in this manual.
Strict compliance with the safety procedures set out and referred to in this manual, and extreme care in the use of the
equipment, are essential to avoid or minimize the chance of personal injury or damage to the equipment.
The information, figures, illustrations, tables, specifications, and schematics contained in this manual are believed to be
correct and accurate as at the date of publication or revision. However, no representation or warranty with respect to
such correctness or accuracy is given or implied and Honeywell will not, under any circumstances, be liable to any
person or corporation for any loss or damages incurred in connection with the use of this manual.
The information, figures, illustrations, tables, specifications, and schematics contained in this manual are subject to
change without notice.
Unauthorized modifications to the gas detection system or its installation are not permitted, as these may give rise to
unacceptable health and safety hazards.
Any software forming part of this equipment should be used only for the purposes for which Honeywell supplied it. The
user shall undertake no changes, modifications, conversions, translations into another computer language, or copies
(except for a necessary backup copy).
In no event shall Honeywell be liable for any equipment malfunction or damages whatsoever, including (without
limitation) incidental, direct, indirect, special, and consequential damages, damages for loss of business profits, business
interruption, loss of business information, or other pecuniary loss, resulting from any violation of the above prohibitions.
Warranty
Honeywell Analytics warrants the Touchpoint Pro system against defective parts and workmanship, and will repair or (at
its discretion) replace any components that are or may become defective under proper usage within 12 months from the
date of commissioning by a Honeywell Analytics approved representative* or 18 months from shipment from Honeywell
Analytics, whichever is sooner.
This warranty does not cover consumable, batteries, fuses, normal wear and tear, or damage caused by accident,
abuse, improper installation, unauthorized use, modification or repair, ambient environment, poisons, contaminants or
abnormal operating conditions.
rd
This warranty does not apply to sensors or components that are covered under separate warranties, or to any 3 -party
cables and components.
Any claim under the Honeywell Analytics Product Warranty must be made within the warranty period and as soon as
reasonably practicable after a defect is discovered. Please contact your local Honeywell Analytics Service representative
to register your claim.
This is a summary. For full warranty terms please refer to the Honeywell Analytics’ General Statement of Limited Product
Warranty, which is available on request.
* A Honeywell Analytics approved representative is a qualified person trained or employed by Honeywell Analytics, or a
qualified person trained in accordance with this manual.
Copyright Notice
Microsoft, MS and MS–DOS are registered trademarks of Microsoft Corp.
Other brand and product names mentioned in this manual may be trademarks or registered trademarks of their
respective companies and are the sole property of their respective holders.
Honeywell is the registered trademark of Honeywell Automation and Control Systems (ACS).
Touchpoint is a registered trademark of Honeywell Analytics (HA).
Find out more at www.honeywellanalytics.com
iii
MAN0989_Issue 1_07/15
Webserver
User Guide
CONTENTS
Contents
1
1.1
How to Use This Manual........................................................................................................................ 1
Purpose .................................................................................................................................................... 1
1.2
Scope ....................................................................................................................................................... 1
1.3
Minimum System Requirements .............................................................................................................. 1
1.4
Abbreviations ........................................................................................................................................... 2
2
2.1
Webserver License Management Work Flow ...................................................................................... 3
Licensing Process Explained ................................................................................................................... 3
2.2
Generating the Host ID File ..................................................................................................................... 4
3
Preparing the Controller for a Webserver Certificate Update ...........................................................7
4
Web Server Certificate Installation Procedure.................................................................................... 9
5
Installing the Client Certificate ...........................................................................................................12
6
Troubleshooting ...................................................................................................................................16
v
MAN0989_Issue 1_07/15
Webserver
User Guide
INTRODUCTION
1 How to Use This Manual
1.1
Purpose
This document describes how to install and use Webserver Software to configure and control Touchpoint Pro via a
VPN.
The Web Server is an external interface that provides web clients with data from the Touchpoint Pro System. This
facility allows remote access to Touchpoint Pro to view live status, and analyse event history.
While it is also possible to acknowledge, inhibit and reset I/O channels, calibration and configuration are not
available over the Web Server.
The Web Server supports 5 concurrent web clients. While it does not restrict further users from connecting, system
performance may be degraded.
Note: The Web Server is compatible with Internet Explorer version 8. Please refer to Touchpoint Pro Chapter 6,
Commissioning for the necessary settings. The following browsers are also supported:
•
•
•
•
1.2
Internet Explorer 6.0 to 8.0 (IE9 and IE10 not tested, but may work)
Chrome up to V38
Chrome up to V38 on Android devices
Safari
Scope
This User Guide is primarily aimed at Site Administrators and Site Engineers, and secondarily at Site Operators
who have limited access rights. It covers installing the software, product licensing, software and system
configuration and setup, software use and troubleshooting.
It does not cover how to set up, configure or commission the Touchpoint Pro, details of which are given in the
Touchpoint Pro Operating Instructions, and which can be found by clicking the Help button on the PC Configuration
tool bar.
1.3
Minimum System Requirements
Webserver has the following minimum requirements:
•
•
•
•
Networked Touchpoint Pro with CCB V3.xxx, COB V3.xxx, LHMI V4.xxx, Static IP, SSL
PC with Windows 7 or 8, Ethernet cable or Wifi, Network connection, manual Ping
Web browser (see above)
(Optional) Pre-installed PC Config software
IMPORTANT
Windows XP is considered a high security risk and shall not be used. Other operating systems are
not currently supported but may work, although the end-user is personally responsible for all security
aspects.
Honeywell will not be held liable for any loss or damage caused by any security breach, no matter
how caused.
Note: The Touchpoint Pro User Interface (UI) is designed to a fixed screen resolution of 1024 X 768, and may not
display correctly if the host PC uses accessibility options such as magnified text.
Note: The Touchpoint Pro must be connected to a network in order to use Webserver or to change any TCP/IP
settings. You must also be permitted to cross the Network Firewall and have Administrator privileges on your
computer. Please consult your IT service if you need any help.
1
MAN0989_Issue 1_07/15
Webserver
User Guide
INTRODUCTION
1.4
Abbreviations
The following abbreviations are used in this Guide.
Abbreviation
Meaning
HID or
Host ID
Data generated from the customers desktop/laptop by the PC configuration tool or Webserver
certificate generation tool. The .hid file contains the customer’s hard disk number, MAC ID and
serial numbers which are used to generate a node-locked license.
https
Hyper Text Transfer Protocol Secure is the more secure version of any http.www. address
LUI / HMI
Local User Interface, sometimes referred to as HMI or Human Machine Interface
OpenSSL
A Webserver certificate required for enabling the HTTPS
Product admin
A person who has the ability to add product versions, add voucher managers. There can be only
one Product admin.
SSL
Secure Socket Layer
TPPR
Touchpoint Pro
UAC
User Account Control – A Windows tool that controls your level of interaction with the PC
Voucher Manager
A person who generates vouchers based on the customer's orders. There can be multiple
voucher managers, typically one per region.
Voucher number
A unique number generated by a custom algorithm. This number is generated by the voucher
manager.
2
MAN0989_Issue 1_07/15
Webserver
User Guide
GENERATING THE HID FILE
2
Webserver License Management Work Flow
Customers can order a TPPR system with the Webserver software installed, or they can download the software for
an existing installation. In both cases the customer will have to generate and install the licence themselves.
The typical work flow is described in Figure 1 below:
Figure 1.
2.1
Webserver License Management Work Flow
Licensing Process Explained
The end customer places an order for the Webserver software installed on their TPPR to be licensed (optional).
Once the order is processed, the Honeywell Voucher Manager generates a voucher number which is valid for 12
months from the date of issue. The unit is assembled and the Webserver software is installed and shipped to the
customer.
On receiving the shipment and instructions, customers must go to the Honeywell Touchpoint Pro website, from
where they can download and install the Webserver certificate generation tool on a Windows PC.
The Webserver certificate generation tool provides a step by step guide on getting the licence. The licence must
then be activated by following the process mentioned below.
3
MAN0989_Issue 1_07/15
Webserver
User Guide
GENERATING THE HID FILE
2.2
Generating the Host ID File
The user should first generate a Host ID file by opening the installed Webserver certificate generation tool and
clicking the GenerateHostID button located on the “Generate Host ID file” tab (1 below).
Figure 2.
Generating The Host ID File
The default location where the Host ID will be saved is displayed on the Generate Host ID File tab (1 above). The
user has an option to change the default location by clicking the browse button and selecting a new path.
Figure 3.
Host ID Default Save Location
Clicking Tab 2: “Mail HID file and Voucher ID” will provide instructions on how to email the host ID file and the
voucher number. The voucher number can be obtained from the voucher number letter (Figure 5) sent separately
to the customer’s shipping address.
The subject of the email should be: VOUCHID:[VoucherNumber]
i.e.: Subject = VOUCHID:8535c74a-81f8-4d96-a560-31ca95ab0ac8) (There are no spaces.)
4
MAN0989_Issue 1_07/15
Webserver
User Guide
GENERATING THE HID FILE
Attach a copy of the HostID (.hid) file and send the email to: [email protected].
Figure 4.
Figure 5.
Data Required to Get a Licence Certificate
Voucher Details and Instructions Sent to the Customer
5
MAN0989_Issue 1_07/15
Webserver
User Guide
GENERATING THE HID FILE
Customers will receive an email containing a text file and instructions on how to save the file to the host PC, as
shown below:
Figure 6.
How to Save the Certificate File.
The license can be activated by opening the Certificate Generation Tool, clicking Tab 3 “Install the received license
certificate”, and then clicking Browse (Fig. 7) to find the saved file.
Once the certificate file is selected, click on the Install button (Fig. 6) to activate the license. Now the tool is
licensed and can be used to generate a cab file for installing the Webserver certificate.
Note: The certificate is valid for 12 months once activated.
CAUTION
Each Webserver Certificate Generation Tool license can be used once only to generate one cabinet
file. Utmost care must be taken to enter the data accurately.
Figure 7.
Installing The License Certificate
6
MAN0989_Issue 1_07/15
Webserver
User Guide
CONTROLLER PREPARATION
3
Preparing the Controller for a Webserver Certificate Update
The Webserver certificate must be installed on the TPPR controller. The certificate is packaged into a cabinet
(.cab) file.
When installed, the Webserver certificate is irrevocably linked to the target TPPR controller’s IP address and MAC
ID.
CAUTION
Contact your local IT specialist if you need help with your TCP/IP settings.
The Webserver certification tool requires the MAC ID and the IP address of the TPPR controller on which the
Webserver certificate is to be installed.
Ensure that the TPPR controller is online and that its static IP address is configured as per the instructions in
either the TPPR Technical Handbook or the PC Config. User Guide.
You must enter the IP and MAC addresses correctly as the generated cab file will be associated with this
information. Mistakes are irreversible and users cannot generate further cab files from the used certificate file!
If you make a mistake at this point you may have to purchase a replacement licence. Please contact Honeywell
Analytics if you need assistance. Contact details are on the back page.
Figure 8.
IP address and MAC ID
Launch the Webserver Certification Tool and select “Enter Correct details to generate CAB file” (Fig.8, tab 4).
Figure 9.
Data Entry for CAB File Generation
7
MAN0989_Issue 1_07/15
Webserver
User Guide
CONTROLLER PREPARATION
After all the data is entered correctly, click the “Generate CAB” button. User will get a confirmation message
displaying the MAC ID and the IP address:
Figure 10. MAC ID and IP Address Confirmation
Check the information is correct. If not, click “Cancel” and re-enter the correct data.
CAUTION
The Webserver certification tool is licensed for a SINGLE use and will be automatically locked once
the CAB file is generated.
If you make a mistake at this point you may have to purchase a replacement licence. Please contact
Honeywell Analytics if you need assistance. Contact details are on the back page.
On selecting the OK button, the cab files will be generated and a confirmation message will be displayed:
Figure 11. Confirmation of the Cab File Generation
Two .cab files will be generated; one is for use with a USB drive and the other for use with an SD card. By default
both files are stored in the same folder as the certification tool.
The picture below shows the default cab file location. Customers can change the default location by clicking on the
browse button during the generation process, but this is not recommended.
Figure 12. Certificate Files
Once the .cab files are generated you can proceed to installing the certificate, which is described in the next
chapter.
8
MAN0989_Issue 1_07/15
Webserver
User Guide
CERTIFICATE INSTALLATION
4
Web Server Certificate Installation Procedure
Before installing the Webserver certificate onto the TPPR controller, make sure that the TPPR is online and the IP
address is correctly configured.
Set up a new network connection on your PC, using IPV4 and the TCP/IP address of the TPPR. You may need
Administrator privileges on your PC, or you may need the help of an IT specialist.
Note: Specific examples cannot be shown as it varies between Operating systems and PC configurations.
Check the connection by ‘pinging’ the TPPR controller. To do this, open the Windows command prompt
(Start>Run>Cmd) and type ping followed by the TPPR’s IP address as shown below:
Figure 13. Ping Confirmation
If there is no response from the controller check the Ethernet connections or the configured IP address and get it to
work. On success of the above step, proceed further to install the Webserver certificate on the TPPR controller.
Copy the saved CAB files (i.e. C:\Program Files\Touchpoint Pro\WebSeverCertificationTool\CAB\cab_usb) onto a
USB drive:
Figure 14. Copy the Cab Files to a USB Drive
CAUTION
For the next step, use only the TPPR USB Host port for your USB flash drive.
Do not use the USB Device port as it is not EMC safe, and is authorised for manufacturing and
maintenance use only.
9
MAN0989_Issue 1_07/15
Webserver
User Guide
CERTIFICATE INSTALLATION
Insert the USB drive into the TPPR controller USB Host port (see TPPR Technical Handbook) and log in as an
Administrator.
Figure 15. Login as Administrator
Check that the system time and date settings are correct and enter them if not.
Note: Changing system time settings will be noted in the events log and may cause gaps or anomalies in the event
history. Constantly monitored exposure limits may also be reset.
Figure 16. Date and Time
Select component update on the global settings screen and then select Webserver Certificate update option:
Figure 17. Webserver Certificate Update
10
MAN0989_Issue 1_07/15
Webserver
User Guide
CERTIFICATE INSTALLATION
Figure 18. Webserver Certificate Installation Progress
The certificate will be installed and the TPPR controller UI will restart automatically.
11
MAN0989_Issue 1_07/15
Webserver
User Guide
CERTIFICATE INSTALLATION
5
Installing the Client Certificate
On your PC go to “Control Panel>Internet options”. Open the Advanced settings tab and ensure that “Use SSL 3.0”
is checked and that “Use SSL 2.0, TLS 1.0, TLS 1.1 and TLS1.2” are unchecked:
Figure 19. Internet Options
Select OK when ready to save the settings. You should not need to do this check again.
Open your browser and type [TPPR IP]/misc/caroottppr.cer in the address bar and then press Enter.
A certificate download dialog will appear (if the settings and protocols are all correct):
Figure 20. Download the Client Certificate
Click “Save” to save the certificate to your PC. (Normally this will be your browser default save location, i.e. the
Downloads folder.)
Figure 21. Certificate Icon
12
MAN0989_Issue 1_07/15
Webserver
User Guide
CERTIFICATE INSTALLATION
Double click on the saved certificate file to open it.
Select “Install Certificate”…:
Figure 22. Certificate Information
…to open this Wizard:
Figure 23. Certificate Import Wizard
Click “Next” and follow the options in the install wizard as shown below.
13
MAN0989_Issue 1_07/15
Webserver
User Guide
CERTIFICATE INSTALLATION
Click “Install Certificate”. Ensure that “Place all certificates in the following store” is checked, then browse for and
select the location “Trusted Root Certification Authorities” and then click “OK” and “Next”...:
Figure 24. Select Certificate Store
…followed by “Finish” to import the certificate:
Figure 25. Import Certificate and Finish
You will see the following dialog if the import was successful:
Figure 26. Certificate Imported
Click “OK” to exit the Wizard and start using the Webserver.
14
MAN0989_Issue 1_07/15
Webserver
User Guide
CERTIFICATE INSTALLATION
You can launch Webserver by typing the chosen HTTPS://[TPPR IP address] in your browser address bar and
pressing Return, or you can create a desktop shortcut and launch the application from there.
You can create multiple desktop shortcuts if you have multiple Webserver-accessed sites, or you can bookmark
(CTRL +D) each site as you visit it.
CAUTION
You should always use the more secure HTTPS:// address by default. Check your browser apps to
see if this can be done automatically.
15
MAN0989_Issue 1_07/15
Webserver
User Guide
TROUBLESHOOTING
6 Troubleshooting
Problem
You cannot connect to the Touchpoint Pro
Solution
Check that you have entered the correct Static IP address.
Check that you have entered the correct username and password
Check that someone with higher status is not already logged in
Check that you are registered on the Touchpoint Pro
Check your Webserver Licence is still valid
Check that the Touchpoint Pro TCP/IP is Enabled
Check that there are no error messages on the Touchpoint Pro UI
Message found on the Touchpoint Pro:
PC cannot establish (or loses) contact because the Touchpoint Pro
Static IP address is in conflict with the IP of the named machine. (This
may happen when Touchpoint Pro’s power is switched on or the CCB is
The System has detected a conflict for
power recycled.)
statically assigned IP address *** *** *** ***
and with the system having hardware address Disconnect the conflicting machine or change one of the IPs then reenable the Touchpoint Pro TCP/IP connection using the Local Interface.
** ** ** ** ** **. The local interface has been
disabled.
Allow time for the new Touchpoint Pro connection to establish before
clicking Save.
16
Find out more at
www.honeywellanalytics.com
Contact Honeywell Analytics:
Europe, Middle East, Africa
Life Safety Distribution AG
Javastrasse 2
8604 Hegnau
Switzerland
Tel: +41 (0)44 943 4300
Fax: +41 (0)44 943 4398
[email protected]
Customer Service:
Tel: 00800 333 222 44 (Freephone number)
Tel: +41 44 943 4380 (Alternative number)
Fax: 00800 333 222 55
Middle East Tel: +971 4 450 5800 (Fixed Gas Detection)
Middle East Tel: +971 4 450 5852 (Portable Gas Detection)
Americas
Honeywell Analytics Inc.
405 Barclay Blvd.
Lincolnshire, IL 60069
USA
Tel: +1 847 955 8200
Toll free: +1 800 538 0363
Fax: +1 847 955 8210
[email protected]
Asia Pacific
Honeywell Analytics Asia Pacific
#701 Kolon Science Valley (1)
43 Digital–Ro 34–Gil, Guro–Gu
Seoul 152–729
Korea
Tel: +82 (0)2 6909 0300
Fax: +82 (0)2 2025 0328
India Tel: +91 124 4752700
[email protected]
Please Note:
While every effort has been made to ensure accuracy in this
publication, no responsibility can be accepted for errors or
omissions. Data may change, as well as legislation and you are
strongly advised to obtain copies of the most recently issued
regulations, standards and guidelines. This publication is not
intended to form the basis of a contract
Technical Services
EMEA: [email protected]
US: [email protected]
AP: [email protected]
www.honeywell.com
Issue 1_07/2015
H_MAN0989_EMEA
2400M2563 A04643
© 2015 Honeywell Analytics