Echelon Enterprise Services 2.0 SR2 and SP2 ReadMe

Release 4.04.119, February 2011

Copyright © 1998 – 2011 Echelon® Corporation
All Rights Reserved

1       Introduction

This document describes Echelon Enterprise Services (EES) 2.0 Service Release 2 (SR2) and Service Pack 2 (SP2).  EES 2.0 SR2 is shipped with SmartServer 2.0 SR2 Energy Managers, and you can apply SmartServer 2.0 SP2 to update previous EES 2.0 installations to the same version of the EES software that is included with SmartServer 2.0 SR2.

Additional information and updates, including service packs and critical updates, may be available at www.echelon.com/smartserver.  The latest service packs and updates may not be included with your SmartServer.  See Echelon’s Knowledge Base at www.echelon.com/support for answers to frequently asked questions.

To provide full functionality, EES and the SmartServer software must be used with the latest Microsoft Internet Explorer 8 or newer, or Mozilla Firefox 3.0 or newer.  If you are using a SmartServer with an LNS® Server or the LonMaker® Integration Tool, you must be using the latest Echelon LNS Turbo and LonMaker service packs and updates.  The latest LNS and LonMaker service packs and updates are available from www.echelon.com/downloads.

2       Contents

1        Introduction. 1

2        Contents. 1

3        Release Identification. 2

4        Upgrading to EES 2.0 SR2 or SP2. 3

5        Changes in EES 2.0. 3

5.1         Changes in EES 2.0 SR2/SP2. 3

5.1.1     Improved Missing Type Handling. 3

5.2         Changes in EES 2.0 SP1. 4

5.2.1     Rapid Deployment 4

5.2.2     Chinese, Japanese, and Korean Language Support 4

5.3         Fixes. 4

6        Known Problems and Workarounds. 5

6.1         Missing EES Icon After Update. 5

6.2         Fast Data Log Transfer 5

6.3         EES AdminServer Upgrade Failures. 5

6.4         LNS Mode Deployment Fails With Different LonWorks Directory. 6

6.5         Extra Tab in Firefox when Using a FB Plug-in. 6

6.6         LNS Proxy Disabled after EES 2.0 IP Address is Changed. 6

6.7         Firmware Upgrade Overwrites Customized SmartServer Home Page. 6

7        Documentation. 6

7.1         Rapid SmartServer Deployment 6

7.2         Rapid Component Deployment 7

7.3         AdminServer Paths. 8

7.4         Data Log Repository Backup. 8

 

3       Release Identification

This document applies to Echelon Enterprise Services 2.0 with Service Release 2 or Service Pack 2 software (Release 4.04.119).  To determine which release of the EES software you have installed on your computer, follow one of the following procedures:

·        For Windows 7 and Windows Vista, click the Start button, type Programs and Features in the Search box, press ENTER to open Programs and Features, and then click Echelon i.LON SmartServer [Release] Enterprise Services.  If the Version column is not displayed, right click the list header, select More, and then select Version to add the Version column. 

·        For Windows XP, open Add or Remove Programs in Windows Control Panel, and then click Echelon i.LON SmartServer [Release] Enterprise Services.  Click the Click Here for Support Information link. 

The following table summarizes the SmartServer and i.LON 100 e3 plus release history:

Name

Number

Date

i.LON 100 e3 plus

3.03

April 2008

i.LON 100 e3 plus SP1

3.04

December 2009

SmartServer

4.00.136

January 2008

SmartServer SR1

4.01.012

March 2008

SmartServer SR2 and SP2

4.02.055

October 2008

SmartServer 2.0

4.03.123

October 2009

SmartServer 2.0 SP1

4.04.088

August 2010

SmartServer 2.1 SR2/SP2

4.04.119

February 2011

SmartServer 2.1 (streetlight system use only)

4.05.093

October 2010

4       Upgrading to EES 2.0 SR2 or SP2

You can upgrade previous versions of EES 2.0 to EES 2.0 SR2 by installing SmartServer 2.0 SR2 software from a SmartServer 2.0 SR2 DVD or from a download provided by Echelon Corporation.  You can update a prior version of the SmartServer 2.0 software to SR2 by downloading and installing SmartServer 2.0 SP2. SmartServer 2.0 SP2 is available as a free download at www.echelon.com/smartserver but can only be installed on a computer with a prior release of the SmartServer 2.0 software.  To upgrade the i.LON 100 e3 Plus or SmartServer 1.0 software, you can purchase a license for the SmartServer 2.0 Software and the software will be provided to you as a software download..  To upgrade to SmartServer 2.0 SR2 or SP2, follow these steps:

1.     If you are installing SmartServer 2.0 SR2 from a SmartServer 2.0 SR2 DVD, insert the DVD into your DVD drive.  If your computer does not have a DVD drive, insert the Echelon SmartServer 2.0 SR2 DVD on a network accessible computer that has a DVD drive and copy the files on the DVD to a shared network drive.  If the SmartServer 2.0 SR2 setup application does not start immediately, open the setup.exe file on the root directory of the Echelon SmartServer 2.0 SR2 DVD.

If you are installing SmartServer 2.0 SR2 or SP2 from a file that you downloaded from the Echelon website, extract all the files from the download file to a C:\SmartServer directory using a zip utility, and then open the setup.exe file in the SmartServer directory.

WARNING: On some computers, the setup application will not start if you extract the files to your user directory.  Workaround: Extract the files to a C:\SmartServer directory, and then run the setup application. (58181)

2.     The Echelon i.LON SmartServer 2.0 SR2 setup application main menu appears.

3.     Click Install Products.  The Install Products dialog appears.

4.     Click Echelon i.LON SmartServer 2.0 SR2 Enterprise Services.  The Echelon i.LON SmartServer 2.0 SR2 Enterprise Services installer appears.

5.     Follow the steps of the installation wizard.  The installation will automatically upgrade the existing EES software installation on your computer to Echelon i.LON SmartServer 2.0 SR2 Enterprise Services.  See Chapter 1 of the Echelon Enterprise Services 2.0 User’s Guide for more information on installing the EES 2.0 SR2 software.

5       Changes in EES 2.0

5.1      Changes in EES 2.0 SR2/SP2

5.1.1    Improved Missing Type Handling

When using LNS network management mode, the LNS Proxy Server is now more tolerant of missing type definitions when importing a device interface (XIF) file.  Previously, importing a XIF file failed if any type definitions for types referenced in the XIF file were missing.  XIF files with missing types can now be imported. (57147)

5.2      Changes in EES 2.0 SP1

5.2.1    Rapid Deployment

The EES AdminServer no longer stores the standard SmartServer firmware files in the template when you create an i.LON template.  This significantly reduces the time required to create and deploy i.LON templates.  See 7.1 Rapid SmartServer Deployment for documentation.

The EES AdminServer can now be used to create and deploy components to up to 100 SmartServers at a time.  A component is any collection of files that you want to deploy to one or more SmartServers from an AdminServer.  For example, a component may consist of an FPM app, resource files, XIF files, and custom Web pages that you want to deploy to one or many SmartServers.  See 7.2 Rapid Component Deployment for documentation. (57345)

5.2.2    Chinese, Japanese, and Korean Language Support

EES Web pages are now available in Chinese, Japanese, and Korean language versions, in addition to the previous English and German versions. (57186)

5.3      Fixes

The following table summarizes problems fixed in the EES 2.0 releases and service packs.  The EPR column lists Echelon internal problem tracking numbers.  The release or service pack that first included the fix is listed in parentheses.

EPR

Description

54842

An i.LON template that included an LNS network database contained the entire LonWorks Types folder. (2.0 SP1)

56433

When deploying an i.LON template that contained a capitalized license folder (“License”), the AdminServer incorrectly replaced the license files on the target SmartServers. (2.0 SP1)

56549

The EES Administration Service Web interface sometimes failed with Firefox 3.6. (2.0 SP1)

56818

If you installed EES 2.0 on a computer that does already have the Java Developer’s Kit (JDK) installed on it, the Tomcat Server used by EES 2.0 did not run. (2.0 SP1)

57194

An extra space appeared after the “AT” characters in the modem configuration files. (2.0 SP1)

56401

The LonMaker tool sometimes failed when many network variables were created in LNS mode. (2.0 SP1)

56858

The EES AdminServer could not update a Release 4.03 SmartServer 2.0 to Release 4.04.088 (SmartServer 2.0 with SP1). (2.0 SP1)

57776

i.LON projects with blank characters at the end of their names could not be exported or deleted. (2.0 SR2/SP2)

58741

When using the fast data log transfer capability, the data log extractor did not convert raw hex data in .bin files to the .CSV format.  (2.0 SR2/SP2)

58742

When using the fast data log transfer capability, repository names were created incorrectly if the SmartServer’s logical IDs included hex digits. (2.0 SR2/SP2)

59084

EES did not start after being updated to EES 2.0 SP2/SR2. (2.0 SR2/SP2)

6       Known Problems and Workarounds

This section describes known limitations and problems for this release.  Numbers in parentheses at the end of the descriptions are Echelon's internal problem tracking IDs.

6.1      Missing EES Icon After Update

The EES icon that is typically displayed in the Windows notification area will sometimes no longer appear after you install an update to EES.  Workaround: If the EES icon does not appear in the notification area after you install an update, either restart your computer or open the Echelon i.LON SmartServer 2.0 SR2 Enterprise Services program folder and then click Echelon i.LON SmartServer 2.0 SR2 Enterprise Services System Tray Tool. (59198)

6.2      Fast Data Log Transfer

When using fast data log transfer to send data logs from a SmartServer to a computer running EES, an LNS Turbo Server must be installed on the computer with EES to extract data from the data logs.  The LNS Server is required even if the SmartServer is running in standalone mode.  Workaround: Install an LNS Server on the same computer with EES if you are using fast data log transfer.  An LNS Server is included with the SmartServer 2.0 LNS Server Edition. (59348)

6.3      EES AdminServer Upgrade Failures

After upgrading an earlier version of EES to EES 2.0 SR2, the Echelon EES4 service required by EES may fail to start due to an EES database corruption.  Workaround: If an EES upgrade failure is reported, follow these steps:

1.     Delete the cmSrvcDb.index.db file in the LonWorks iLON\EnterpriseServices\EchelonES directory.

2.     Run services.msc to start the Windows Services snap-in.

3.     Right-click the Echelon EES4 service and then click Restart on the shortcut menu.  (58376)

Stale EES AdminServer pages are sometimes displayed after the AdminServer is upgraded from an earlier version.  Workaround: Clear the browser cache after an EES upgrade. (57576)

6.4      LNS Mode Deployment Fails With Different LonWorks Directory

If you deploy a SmartServer template created on one computer using a different computer with a different LonWorks directory, the deployment fails.  Workaround: Ensure that the LonWorks directory is in the same location on the computers you use to create and deploy templates. (57543)

6.5      Extra Tab in Firefox when Using a FB Plug-in 

When you configure a functional block in the LNS tree using a plug-in, an additional tab opens if you are using Firefox.  Workaround: Close the extra tab.  (53410)

6.6      LNS Proxy Disabled after EES 2.0 IP Address is Changed

If you change the IP address of the computer running EES, the LNS Proxy Web service is disabled.  Workaround: Restart EES using the tray tool.  (54447)

6.7      Firmware Upgrade Overwrites Customized SmartServer Home Page

If you have customized the SmartServer home page, upgrading the SmartServer’s firmware to SmartServer 2.0 SR2/SP2 may overwrite your custom SmartServer home page. Workaround: If you have changed the index.htm or index.html file in the root/web directory of a SmartServer that you are upgrading, back up the index.htm and index.html files before upgrading your SmartServer.  After you upgrade the SmartServer’s firmware, copy the index.htm and index.html files that you backed up to the root/web directory on the SmartServer flash disk. (59029)

7       Documentation

This section describes updates to the documentation.

7.1      Rapid SmartServer Deployment

You can use the EES AdminServer to create and deploy i.LON templates, which are templates containing all the configuration data for a SmartServer.  You can use i.LON templates for SmartServers that have been configured in LNS mode or Standalone mode.  If you create an i.LON template for LNS mode, the template also includes a copy of the LNS network database for the SmartServer.

Starting with Release 4.04.088 (SmartServer 2.0 with SP1), i.LON templates do not include a copy of the standard SmartServer firmware files.  When you deploy an i.LON template, the AdminServer verifies that the SmartServer firmware on the target SmartServer is compatible with the template.  If you are deploying a template created with Release 4.04.088 (SmartServer 2.0 with SP1 or later) to a SmartServer with Release 4.03 (SmartServer 2.0) or earlier, use the EES 2.0 AdminServer to upgrade the SmartServer firmware before deploying the i.LON template. 

See Upgrading the SmartServer Firmware, Creating an i.LON Template, and Deploying an i.LON Template in the Echelon Enterprise Services 2.0 User’s Guide for more details.

7.2      Rapid Component Deployment

You can use the EES 2.0 AdminServer can to create and deploy components to up to 100 SmartServers at a time.  A component is any collection of files that you want to deploy to one or more SmartServers from an AdminServer.  For example, a component may consist of an FPM app, resource files, XIF files, and custom Web pages that you want to deploy to one or many SmartServers.  Components are deployed without stopping or rebooting the running apps on the target SmartServer or SmartServers.  This allows you to deploy components to operational sites without disrupting the sites.  As a result, don’t use component deployment for deploying updates to SmartServer system files—use i.LON templates for deploying system files instead.  The AdminServer does reboot the target SmartServers when you use deploy an i.LON template.

To create a component, follow these steps:

1.     Create a folder in the LonWorks iLON\EnterpriseServices\repository\ees-import\component directory with the name of your component.  By default, the LonWorks directory is C:\LonWorks.  For example, to create a component called MyHomePage using the default LonWorks folder, create C:\LonWorks\iLON\EnterpriseServices\repository\ees-import\component\MyHomePage.

2.     Create a directory hierarchy within your component folder that matches the directory hierarchy to be deployed to the SmartServer and copy the files to be deployed to that hierarchy.  For example, to create a component that replaces the default SmartServer home page, create an iLON\EnterpriseServices\ees-import\component\MyHomePage\web directory and copy your custom index.html file to the web directory.

3.     Right-click the Component folder in the AdminServer navigation pane and then click Import on the shortcut menu.  The AdminServer imports the files in your component directory and creates your component from them.  The AdminServer also deletes your original files so be sure to keep a copy of your original files in case you need to modify your component.  The component is named with your component name followed by a timestamp.

To deploy the component to one or more SmartServers, follow these steps:

1.     Expand the Component folder in the AdminServer navigation pane.

2.     Right-click the component to be deployed, and then click Deploy.  A deployment page appears in the application pane. 

3.     Click any SmartServers in the navigation pane to add them to the deployment target list.  SmartServers appear under the LAN heading for your projects in the navigation pane.  You can select up to 100 SmartServers.

4.     Click the Deploy button to start the deployment.  All the files in the selected component will be deployed to all the selected SmartServers.  Deployment status is displayed under the Status heading in the application pane.

To delete a component, right-click the component in the navigation pane and then click Delete on the shortcut menu.

To export a component that you can import on another AdminServer, right-click the component in the navigation pane and then click Export on the shortcut menu.  This creates a component file in your iLON\EnterpriseServices\repository\ees-export\component directory that you can import on another AdminServer.  The component file name will be the name of your component followed by a time stamp, with a .zip extension.  Using the example from creating a component above, the path and filename would be the following (with a different timestamp):
C:\LonWorks\iLON\EnterpriseServices\repository\ees-export\component\MyHomePage-2010-07-06-170319556.zip

To import a component from another AdminServer, follow these steps:

1.     Copy the component file to your iLON\EnterpriseServices\repository\ees-import\component directory.

2.     Right-click the Components folder in the navigation pane, and then click Import on the shortcut menu. 

3.     Click the Import button.  The AdminSever imports the component and deletes the component file.

7.3      AdminServer Paths

When you specify paths to the i.LON AdminServer, you must enter the paths with the correct case—that is, paths are case sensitive for the i.LON AdminServer, even though paths are usually not case sensitive in Windows or in Web browsers.  For example, if the path is /LnsProxy/LnsProxyService and you enter /lnsproxy/lnsproxyservice, the path will not work. (58079)

7.4      Data Log Repository Backup

Before you upgrade your EES 2.0 software, back up the ReceivedFiles folders stored in your LonWorks iLON\EnterpriseServices\repository\ees‑lnsproxy directory.  After you install the EES 2.0 software upgrade, copy the backed up the ReceivedFiles folders to the LonWorks iLON\EnterpriseServices\repository\ees‑lnsproxy directory. (59158)

 

Echelon, LON, LonWorks, i.LON, LNS, and LonMaker are registered trademarks of Echelon Corporation in the U.S.  and other countries.