Embed Size (px)
Citation preview
078-1059-01D
LumInsight
Enterprise
Installation Guide
ii Preface
Echelon, LumInsight, and the Echelon logo are
trademarks of Echelon Corporation that may be
registered in the United States and other countries.
Other brand and product names are trademarks or
registered trademarks of their respective holders.
Echelon products are not designed or intended for use
in equipment or systems which involve danger to human
health or safety or a risk of property damage and
Echelon assumes no responsibility or liability for use of the
Echelon products in such applications.
Parts manufactured by vendors other than Echelon and
referenced in this document have been described for
illustrative purposes only, and may not have been tested
by Echelon. It is the responsibility of the customer to
determine the suitability of these parts for each
application.
ECHELON MAKES NO REPRESENTATION, WARRANTY, OR
CONDITION OF ANY KIND, EXPRESS, IMPLIED, STATUTORY,
OR OTHERWISE OR IN ANY COMMUNICATION WITH YOU,
INCLUDING, BUT NOT LIMITED TO, ANY IMPLIED
WARRANTIES OF MERCHANTABILITY, SATISFACTORY
QUALITY, FITNESS FOR ANY PARTICULAR PURPOSE,
NONINFRINGEMENT, AND THEIR EQUIVALENTS.
No part of this publication may be reproduced, stored in
a retrieval system, or transmitted, in any form or by any
means, electronic, mechanical, photocopying,
recording, or otherwise, without the prior written
permission of Echelon Corporation.
Printed in the United States of America.
Copyright © 2015 - 2016 by Echelon
Corporation.
All Rights Reserved.
Echelon Corporation
www.echelon.com
i
Contents
Purpose ................................................................................................... iii
Related Documentation ........................................................................... iii
Technical Support ................................................................................... iii
System Requirements .............................................................................. 2
Software Configuration and Installation .................................................... 2
Microsoft .NET Framework 3.5 for Windows 8.1 and Windows 10 ...... 2 Microsoft .NET Framework 4.5 for Windows 7 and Windows Server 2012 ......................................................................... 4 Microsoft Internet Information Services (IIS) ....................................... 5 Echelon LumInsight ............................................................................ 6 Validating the Installation .................................................................. 20
Remote Server Connectivity ................................................................... 24
Overview ................................................................................................ 26
SSL Certificate ....................................................................................... 26
Certificate Signing Request .................................................................... 26
ii Preface
Preface
This document describes how to install and configure LumInsight Enterprise CMS software.
iii
Purpose
This document is intended for system installers and IT professionals.
It details the required software components, and how to configure and install them.
Related Documentation
The following table lists related Echelon documentation that can be useful. The latest
versions of these manuals are available from the Echelon Web site at www.echelon.com.
Title Part Number Description
LumInsight Provisioning Tool
User Guide
078-0161-01C This manual describes how to use
the LumInsight Provisioning Tool
LumInsight CMS Web Portal
User Guide
078-0160-01C This manual describes how to use
the LumInsight Web Portal
Technical Support If you have technical questions that are not answered by this document, or by the related documentation, you
can obtain technical support via e-mail to [email protected].
See www.echelon.com/support for more information on Echelon’s support services. See
www.echelon.com/training for online training and for more information on Echelon’s training services.
1
1
Installing LumInsight Enterprise CMS
This document provides detailed installation and configuration instructions.
2 Installing LumInsight Enterprise
System Requirements The following are the system requirements for running LumInsight Enterprise CMS:
Microsoft
Windows 10 (64-bit and 32-bit), Windows 8.1 (64-bit and 32-bit), Windows 7 (64-bit and
32-bit), or Windows Server 2012 (64-bit).
2GHz or faster processor
≥8MB RAM
≥100GB of free hard disk space. The actual requirements will be dictated long term by the
number of geozones, the number of devices, associated data and archiving methodologies.
For reliability purposes, the drive(s) should be suitably fault tolerant with a backup facility
available.
Software Configuration and Installation This section details how to configure and install the pre-requisite software.
It is assumed that PostgreSQL has not previously been installed on the computer.
You will need a working internet connection to perform the configuration and installation.
Microsoft .NET Framework 3.5 for Windows 8.1 and Windows 10
For Windows 8.1 and Windows 10 computers only, you need to enable .NET Framework 3.5.
Open Control Panel, then open Programs and Features.
3
Click Turn Windows features on or off and wait for the list to be populated.
At the following dialog, expand .NET Framework 3.5 (includes .NET 2.0 and 3.0) and check both
Windows Communication Foundation HTTP Activation and Windows Communications
Foundation Non-HTTP Activation.
Click OK.
4 Installing LumInsight Enterprise
Microsoft .NET Framework 4.5 for Windows 7 and Windows
Server 2012
For Windows 7 and Windows Server 2012 computers only, open Control Panel, then open Programs
and Features and check to see if Microsoft .NET Framework 4.5 is installed.
If it is not installed or an earlier version is present, go to http://www.microsoft.com/en-
us/download/details.aspx?id=30653 download and then run dotNetFx45_Full_setup.exe.
5
Microsoft Internet Information Services (IIS)
In Programs and Features click Turn Windows features on or off and wait for the list to be
populated.
Under Internet Information Services, expand Web Management Tools and check IIS Management
Console. Under World Wide Web Services, check all features as shown below by expanding each
item in turn and checking all associated features.
Click OK. The following dialog will be displayed and will automatically close after a minute or so.
Restart the computer.
6 Installing LumInsight Enterprise
Echelon LumInsight
Download the LumInsight Enterprise installer from http://echelon.com/software-
downloads?ele=luminsight_enterprise.
To install the software you will need an activation key. To use the software, you will need an
activation key for each segment controller and an activation key for the lighting controllers. To
purchase the activation keys, contact your Echelon sale representative or distributor.
The LumInsight Provisioning Tool that is used to define devices in the network is downloaded and
installed separately to LumInsight Enterprise CMS.
Run the LumInsight Enterprise installer, click Yes at the first dialog. When prompted with the
following dialog, click OK to begin the installation of PostgreSQL.
At the following dialog, click Next.
7
At the following dialog, click Next to accept the default location.
At the following dialog click Next to accept the default location.
8 Installing LumInsight Enterprise
At the following dialog, provide a superuser password, retype it, make a note of it, then click Next.
At the following dialog, click Next to accept the default port number.
9
At the following dialog, click Next.
At the following dialog, click Next to begin the installation.
10 Installing LumInsight Enterprise
At the following dialog, uncheck Launch Stack Builder at exit? and click Finish.
At the following dialog, click Next.
11
At the following license agreement dialog, read the terms of the license agreement, check I accept the
terms in the license agreement and click Next.
At the next dialog, enter a suitable name in the User Name field.
Enter the IP address in the IP Address for IIS websites field you want to use to
access the Web Portal, Web Binder Service, and Field Commission Utility Web API. This
field cannot be left empty. If you do not want to specify an IP address at this moment,
then leave it as the default “*”.
Enter the LumInsight Enterprise activation key that you have previously obtained and if
you have them, your Echelon account details (this will allow you to transfer licenses
between computers should it be needed subsequently).
12 Installing LumInsight Enterprise
Click Next. Your activation key will be validated over the internet; this may take a while.
At the following dialog, click Next to accept the default location.
13
At the following dialog, you need to supply an unused TCP/IP port number for the Web
Portal (CMS Portal). This is the port that will be used when you connect to the
LumInsight Enterprise website using a browser with the URL format <server IP
address>:<CMS Portal Port Number>, for example 192.168.11.32:8081.
If you wish to use port 80 (the default http port) for the Web Portal you will first need to
remove the default web site established when installing IIS from within the Internet
Information Services (IIS) Manager.
The ports chosen must have a path open to them within the IT infrastructure, with relevant firewall
ports being opened or an appropriate secure PPTP or IPSEC tunnel created to the machine running
LumInsight Enterprise.
To find the currently used ports on your PC, open a command prompt using
administrator permissions (right click and select run as Administrator). Type the
following command:
netstat -ab | more
A list of all currently used ports will be displayed similar to the following screen shot:
14 Installing LumInsight Enterprise
In all, you will need three unused ports, one each for the Web Portal, the Web Binder Service and the
Field Commissioning Utility Web API. Three typically free ports would be 8081, 8082 and 8083.
Enter a suitable unused port in the Port Number Field (for example “8081” or “80” for the default
web port), do not leave it as "0". Make a note of the port you have specified and click Next.
If you wish to use secure https browser connections to the Web Portal, use a free temporary http port,
for example 8081 during the installation. Once the installation is complete, from within the Internet
Information Manager, create or obtain a valid SSL certificate, add a new binding for the Web Portal
using the Type as “https”, the IP Address as “All Unassigned”, the SSL Certificate as above along
with a suitable Host Name entry, delete the existing http binding and adjust the Web Portal SSL
settings as required.
At the following dialog, enter an unused port number for the Web Binder Service (for example
“8082”), make a note of it, click Next
15
At the following dialog, enter an unused port number for the Field Commissioning Utility (for example
“8083”) and click Next.
16 Installing LumInsight Enterprise
At the following dialog, enter the PostgresSQL superuser password you made a note of previously and
re-enter the password and click Next.
17
At the following dialog, enter your required email settings and click Next.
At the following dialog, enter a valid hostname or IP address that a SmartServer will be able to reach
the Web Service by in the HostName/IP field and leave the User Name and Password field blank.
Click Next.
18 Installing LumInsight Enterprise
At the following dialog, click Next.
At the following dialog, click Install to begin the installation.
19
After a while the following dialog will appear, click Finish to complete the installation.
If the following dialog appears during the installation, it is likely that .NET Framework 3.5 has not
been enabled. Click on OK, complete the installation, follow the instructions in the section Microsoft
.NET Framework 3.5 and then activate the license using LicenseWizard.exe that can be found in the
C:\Program Files (x86)\Echelon\License Tools folder.
20 Installing LumInsight Enterprise
When upgrading to a newer version of LumInsight Enterprise CMS, first return the activation key via
the Echelon License Wizard. When prompted for an activation key during the upgrade, use the
returned key. If you did not return the activation key before the upgrade, there may be a dialog stating
the license was invalid. Call Echelon Support and they can make your key work again. After
upgrading the license, restart the Echelon CMS Web Port from IIS.
Validating the Installation
Open Control Panel, open Administrator Tools.
21
In Administrative Tools, open Services.
The following screen will appear. Ensure that the following services are running:
Echelon Alarm Service
Echelon Datalogger Service
Echelon Framework Service
Close Services.
22 Installing LumInsight Enterprise
In Administrator Tools, open Internet Information Services (IIS) Manager.
Ensure that the Echelon CMS Portal, Echelon Field Commissioning Utility Web API and the
Echelon WebBinder Service websites are present as shown below:
23
Right click the Echelon CMS Portal, select Manage Website, then click Browse as shown below:
The default browser should launch (in this instance, Google Chrome) and you will see the following
login screen:
24 Installing LumInsight Enterprise
Enter “Echelon” as the User Name and “echeloncorp” as the password and you will see the following
screen that indicates a successful installation:
The default user name and password should be changed as soon as possible. In the upper right-hand corner of the
screen, shown above, the user is Echelon. Click the drop down box where the name appears and access your profile
page to change the default information.
In this instance, the CMS Portal website has been reached using the “localhost” IP address (127.0.01) which is only
valid when accessing it directly on the local server computer. You would normally launch the CMS Portal from a
remote computer using the URL<Server IP Address>:<CMS Portal Port Number>.
Close the browser, IIS Manager, Administrator Tools and Control Panel.
Remote Server Connectivity The server will typically need to have a public facing IP address and you will need to establish remote
connectivity to the server from each of the geozones in a secure fashion, to avoid publically exposing
the infrastructure. This would typically be done using VPN tunneling from the SmartServers to the
server over a cellular network.
25
Appendix A
HTTPS Support for LumInsight CMS
If you are using the LumInsight CMS Web portal
hosted on a computer with a public web address,
Echelon highly recommends you change your access
to HTTPS.
This appendix describes setting up HTTPS access
for LumInsight software over an Internet accessible
IP address.
26 Installing LumInsight Enterprise
Overview
HTTPS provides better security than HTTP if you intend to operate the LumInsight
CMS from an internet accessible address. You secure the site by changing the IIS
binding from HTTP over port 80 to HTTPS over port 443. The application installer does
not automate this process and your site’s system administrator may need to help
accomplish the move from HTTP to HTTPS.
SSL Certificate To move to HTTPS, you will need an SSL Certificate. The certificate is purchased from a certificate
provider. An SSL certificate provides the backbone for secure encrypted access to the LumInsight
CMS web portal.
There are multiple SSL certificate providers. The following table lists providers and their web
addresses. When a certificate is associated with a Web site, it comes with assurance to users that they
are accessing a verified legitimate endpoint that has not been compromised. Several varieties of
certificates are available for purchase. It is also possible your company already has a certificate that
you may apply to the server hosting LumInsight CMS. The following table includes certificate
providers and their web addresses.
Provider Web Site
SSL.com https://www.ssl.com
Verisign https://www.verisign.com
Digicert https://www.digicert.com
Comodo https://www.comodo.com
Thawte https://www.thawte.com
GoDaddy https://www.godaddy.com
Before you purchase your certificate, the IIS server hosting your LumInsight CMS should have a
registered domain name. While this is not a requirement, it is generally understood as a best practice.
For example, if you are operating as AceLighting.com, you would register your server as
LumInsight.AceLighting.com.
Certificate Signing Request If your company has a web presence, it is likely your web master has already purchased a wild card
certificate to secure existing website resources. If not, you must generate a Certificate Signing Request
(CSR) that is used by the certificate authority to authenticate your server.
It is assumed you have installed the LumInsight CMS on your targeted server, and the IP address for
the server has a registered DNS address. Now follow these instructions:
1. From the server running LumInsight, launch the Internet Information Services (IIS) Manager
control panel application.
2. Select the root of the IIS Manager Site navigation panel, and scroll to the IIS group in the main
frame. A screen shot shows the IIS manager .
27
3. Double-click the Server Certificates icon.
4. Fill out the Distinguished Name Properties according to the specifics of your organization. The
following is an example for a mythical company call Ace Lighting.
5. Save the Certificate Signing Request file with a .txt extension to a directory on your computer.
You will need to provide this file to your selected certificate provider.
28 Installing LumInsight Enterprise
6. Once you have been supplied with the actual certificate purchased from your certificate provider,
you need to add it to your server. You will have to have already copied (and possibly unzipped)
the certificate to a secure location on the server. Complete the process by returning to the Server
Certificate panel in the IIS Manager for web server.
7. Click the Complete Certificate Action in the Actions pane.
29
8. Fill out the Specify Certificate Authority Response form and Click OK.
9. Now that the Server Certificate is installed, the next step is to set the binding to the LumInsight
CMS web server to use HTTPS. In the IIS Manager, navigate to the Echelon CMS Portal web site
under the Sites folder.
30 Installing LumInsight Enterprise
10. Click the Edit Site Bindings… Action in the action pane on the right-hand side of the screen.
11. Click Add and fill out the Site Binding form to reflect your actual host DNS name and the SSL
Certificate you just installed. Recall that the Certificate request was against a specific host name
that must match what is entered here.
12. On the next screen, select the original port http/80 binding and click remove. This is the final
step.
13. Your site will now be accessed using https.
