site manager installation and administrator guide · 2 • site manager installation and admin...

Site Manager Installation and Administrator Guide

026-1010 Rev 15 31-MAR-2017

Emerson Retail Solutions1065 Big Shanty Road NW, Suite 100

Kennesaw, GA 30144770-425-2724 • www.emerson.com

http://www.emerson.com

Table of Contents • vii

Table of Contents1 SERVER REQUIREMENTS........................................................................................................................................ 1

1.1. PRE-INSTALLATION CHECKLIST ................................................................................................................................... 21.2. INSTALLATION CONFIGURATIONS................................................................................................................................. 3

1.2.1. Multiple-Server Machine Configuration .............................................................................................................. 31.3. APPLICATION AND DATABASE SERVER SUPPORTED CONFIGURATION ........................................................................ 3

2 SUPPORTED SECURITY............................................................................................................................................ 4

3 ESTIMATED BANDWIDTH USAGE ........................................................................................................................ 4

4 BACKUP DATABASE AND WEB SERVER............................................................................................................. 4

5 INSTALLATION STEPS.............................................................................................................................................. 5

5.1. PREREQUISITE INSTALLATION ...................................................................................................................................... 75.2. DATABASE CONNECTION SETUP .................................................................................................................................. 85.3. WEB SERVER FILE LOCATION .................................................................................................................................... 105.4. DATABASE SETUP....................................................................................................................................................... 10

5.4.1. Create Database ................................................................................................................................................. 105.4.2. Database Update................................................................................................................................................. 11

5.5. PRODUCT REGISTRATION AND ACTIVATION .............................................................................................................. 165.5.1. Registration......................................................................................................................................................... 165.5.2. Activation ............................................................................................................................................................ 17

5.6. LAUNCHING SITE MANAGER ...................................................................................................................................... 19

6 UPGRADING SITE MANAGER............................................................................................................................... 20

7 UNINSTALLING SITE MANAGER......................................................................................................................... 21

8 QUICK START SOFTWARE SETUP ...................................................................................................................... 22

8.1. OVERVIEW .................................................................................................................................................................. 228.2. LAUNCHING SITE MANAGER ...................................................................................................................................... 228.3. LOGIN ......................................................................................................................................................................... 228.4. LICENSING .................................................................................................................................................................. 22

8.4.1. Maintenance Upgrades & Tech Support Licensing............................................................................................ 238.4.2. Feature Licensing ............................................................................................................................................... 23

8.5. CREATE A DIRECTORY STRUCTURE........................................................................................................................... 238.5.1. Add A Directory .................................................................................................................................................. 238.5.2. Add A Site............................................................................................................................................................ 238.5.3. Add A Control System ......................................................................................................................................... 24

8.6. SET UP USERS (OPTIONAL) ........................................................................................................................................ 24

APPENDIX A: SYSTEM REQUIREMENTS AND ADMINISTRATOR ACTIVITIES ....................................... A-1

SUPPORTED PRODUCT VERSIONS ...................................................................................................................................... A-1DATABASE AND WEB SERVER BACKUP ............................................................................................................................ A-2IMPORTING XML DATAFILE.............................................................................................................................................. A-2TROUBLESHOOTING ........................................................................................................................................................... A-2

APPENDIX B: JAVA INSTALLATION...................................................................................................................... B-1

APPENDIX C: APACHE TOMCAT INSTALLATION ............................................................................................ C-1

APPENDIX D: NOTES ON UPGRADING.................................................................................................................. D-1

APPENDIX E: LDAPS INSTRUCTIONS ................................................................................................................... E-1

Server Requirements • 1

1 Server Requirements

There are several things that can affect how well the Site Manager software will run in a given environment. Each of these is slightly different but can be considered a comparable load on the system.

1. Number of users: The number of users in general -- but especially the number of simultaneous users -- can put a taxing load on the Web server to service requests both to controllers as well as reading data from the database.

2. Number of sites: The number of sites that the system can communicate with -- especially simultaneous connections.

3. Functions performed on sites: There is a substantially different load on the system between an occasional log retrieval, backup, or graphical screen versus pulling every log out of each controller at a site daily.

NOTE: Refer to Appendix D: Notes On Upgrading for supported product versions.

2 • Site Manager Installation and Admin Guide 026-1010 Rev 15 31-MAR-2017

1.1. Pre-Installation ChecklistThe following data sets will be used during the installation of Site Manager and should be available prior to installation. You may use this page to fill in the required data. Data required is found under the second column and additional information is found in the third column. Write the corresponding value for each required data under the Answers column.

Area Information Needed More Information Answers

Database

Domain

Instance

Database Server

Database Name

Database User Name

Database Password

Database Owner Username

Database Owner Password

Web Server Tomcat Location

If installing Site Manager for the first time, you will be asked to specify the Tomcat folder path. Set the folder path to “C:\Program Files\Tomcat” for 32 bit machines or “C:\Program Files (x86)\Tomcat” for 64 bit machines for ease of installation and location.

If installing Site Manager upgrade, specify the existing Tomcat folder path on your machine. Set the folder path to the existing Tomcat folder.

Advisory Receiver Information (optional)

Primary Address

Network name or IP Address for this Site Manager server. IP Address should be entered unless only the E2 controllers will be sending alarms and the E2 has DNS enabled.

E1 Listen Port Default: 3002

E2 Listen Port Default: 3001

SMTP (Email)

SMTP Host Where email will be routed through

Port Default is 25 but can vary by environment.

User Use this if the SMTP server has authentication.

Password Use this if the SMTP server has authentication.

Adv Forward From Address Sender address for any Site Manager emails from Advisory Forwarding.

Schedule From Address Sender address for any Site Manager emails from Schedule Manager.

LDAP (Optional)

Domain Server Address and Port {IP Address or server name}:port#

Domain Login Domain\Account login credential

Password for Domain Login Account password credential

New Installation Obtain Site Manager Feature licenses

Contact Emerson to obtain Feature license.

Table 1-1 - Site Manager Pre-Installation Checklist

Installation Configurations Server Requirements • 3

1.2. Installation Configurations

The configuration for installing the Site Manager software is multiple server configuration.

1.2.1. Multiple-Server Machine Configuration

1.3. Application and Database Server Supported Configuration

Recommended System Requirements:

The installation configuration has the Site Manager Web application server and the database on two separate machines. This configuration allows the application server and protocols the CPU and memory they require. This can be especially crucial during intensive operations (such as log retrieval, which has to update the UI, pull logs from controllers and place those logs in the database).

CAUTION! Actual hardware system specifications are dependent upon multiple actors such as the number of concurrent users logged into the system, database storage requirements, number of activities run concurrently, types of activities to be run, the number of stores in the enterprise, and more. Contact your Retail Solutions representative to determine actual specifications required prior to installation.

See Appendix A: System Requirements and Administrator Activities for more information about server requirements.

Figure 1-1 - Multiple-Server Machine Configuration

NOTE: Using E2 2.10F01 or higher with the Site Manager program is recommended for optimum performance.


2 Supported Security

The product supports the use of all security possibilities available to an Internet product such as SSL, firewalls, VPN, etc.

3 Estimated Bandwidth Usage

The bandwidth usage can be divided into two categories:

1. Bandwidth between the Web server and client browsers is dependent on the number of users logged into the system and how quickly they are changing pages.

2. Bandwidth between the Web server and the controllers that are on the corporate WAN is dependent on the activity being performed and the number of sockets that is open. The number of sockets open can be configured in the application server.

4 Backup Database and Web Server

For a complete recovery of information in the event of a failure of the Web server on which Site Manager is running, it is highly recommended that backups be performed on a daily basis in two separate areas:

• Backup of the database (using the standard procedure for your particular database)

• Backup of applicable Web server areas

For more information on backup procedure, see the Administrator Activities section of the Site Manager online help.

Application and Database Server Supported Configuration Installation Steps • 5

5 Installation Steps

If upgrading from a previous version of Site Manager, you must first uninstall the program. Skip to the Upgrade section of this install guide (Section 6, Upgrading Site Manager).

1. Insert the Site Manager Installation CD into the CD ROM drive to begin installation setup.

a. If the setup does not automatically start, go to Start >Run and type “x:\setup.exe” where x is your installation source location.

A confirmation window will appear asking if a database server is installed and accessible:

b. Click Yes if you have one installed, No if you do not have a database installed. Clicking No will stop the setup and exit the program. A database must then be installed, accessible, and a database user-created with correct privileges to connect to the database.

2. When Yes is clicked, the Site Manager InstallShield Wizard window opens:

a. Click Next to continue.

3. The License Agreement window will open:

a. Read the “Terms of Use Agreement” and select I accept the terms of the license agreement if you wish to continue.

b. Click Next to continue.

Figure 5-1 - Preparing Setup

NOTE: You may choose which database and Web server will be used.

Figure 5-2 - Is A Database Installed?

Figure 5-3 - Install Welcome

Figure 5-4 - License Agreement


4. The Customer Information window will open:

a. Enter your name and company name into the respective fields and click Next to continue the install.

5. If you are running previous versions of Web servers or Java Runtime, the Previous Version Removal window will open with a list of the older products that must be updated before you can proceed with the installation:

If no software upgrades are needed, proceed with the installation to Step 6:

6. The Web Server Information window will open:

a. Select whether to use Tomcat or another Web Server installation: (For supported product versions, see Appendix D: Notes On Upgrading.)

Install or Use existing Tomcat Web Server Installation: Use an existing Tomcat Installation or install Tomcat, select Install or Use existing Tomcat Web Server Installation. Click Next to continue and go directly to the Prerequisite Installation Review window (Step 10, Section 5.1., Prerequisite Installation). Go to Appendix C: Apache Tomcat Installation for Tomcat installation instructions.

Install or Use other Web Server Installation: If you wish to install, or already have installed another Web server besides Tomcat, select Install or Use other Web Server Installation and click Next to continue (Step 7). Go to Appendix B: Java Installation for Java Installation instructions.

Figure 5-5 - Enter Customer Information

Figure 5-6 - Remove Any Old Versions of Web Servers

Figure 5-7 - Select Tomcat or Another Web Server

NOTE: Regardless of the type of server being used, it is suggested that a generic, non-version specific location for the install be

chosen.

Prerequisite Installation Installation Steps • 7

7. A confirmation window will open and ask if you have a Web server installed:

a. If you already have a Web server installed, click Yes.

8. Because Tomcat is not being used as the Web server, select the Web server location:

a. Select Change to choose a custom location for the Web server application location.


9. If you choose No on the Do you have a Web server already installed? message window, (Step 7) you are presented with a confirmation window that will

ask if you wish to install Tomcat on your machine as the Web server:

a. If you wish to install the Tomcat supported version as your Web server, click Yes. The Prerequisite Installation Review window opens, (Step 10) listing the prerequisites that need to be installed before the Site Manager installation can proceed.

b. If you do not wish to use the Tomcat supported version as the Web server, click No. A message window opens informing you that a Web server must be installed to continue or to select Install or Use existing Tomcat Web Server Installation on the Web Server Information window (Step 6).

c. Click OK to continue and the install is terminated. You will need to install a Web server to continue with the install.

For instructions on Web server installations, go to Appendix B: Java Installation for Java installation instructions and Appendix C: Apache Tomcat Installation for Tomcat installation instructions.

5.1. Prerequisite Installation

10. If you are not running the supported version of Tomcat and Java Runtime, the Prerequisite Installation Review window opens, listing the prerequisites that need to be installed before the Site Manager installation can proceed. (If no

Figure 5-8 - Web Server Installed?

Figure 5-9 - Web Server Location

Figure 5-10 - Install Tomcat as Web Server?

Figure 5-11 - Use Tomcat or Install Web Server


prerequisites need to be installed, go directly to Step 11).

a. Click Next to install the prerequisites and continue with the install.

5.2. Database Connection Setup

11. The Database Connection Setup window will open after all the prerequisites have been installed.

Choose which database Site Manager will be connecting to:

a. If Microsoft SQL is chosen, enter the domain for Windows authentication (Step 12).

12. The Windows authentication window:

For the Domain field, choose to use either Windows Authentication or SQL authentication for both users (database administrator and Site Manager end user). The same authentication type must be used for both users. For Windows authentication, enter the domain name. For SQL Authentication, leave the Domain field blank.

For the Instance field, if using an SQL instance that is not the default, enter it into the field. Otherwise, leave the Instance field blank.

13. The Database Connection Setup window opens:

Figure 5-12 - Prerequisite List

Figure 5-13 - Choose Database

Figure 5-14 - Windows Authentication for Microsoft SQL

Figure 5-15 - Database Connection Setup

Database Connection Setup Installation Steps • 9

The information in these fields will be used to connect the database with Site Manager.

a. Enter the database server, database name, and username into their respective fields:

• Server: Enter the name of the server that has the database installed.

• Name: Enter the name of the database that Site Manager will use to store its data.

• Username: Enter who will be the connection user. This is for the connection of the server running the product, not for populating the database.

After entering your information, click Next to go to Step 15. (Only proceed to Step 14 if using a database other than Microsoft SQL.)

14. If you have chosen a database other than Microsoft SQL, (Step 11) highlight all the database .jar files from the location on your PC and click Open. The database files will be copied into the correct location during the installation.

15. Click Next to enter your password and open the Web Server File Location window:

a. Enter the password for the database user and click Next to continue.

16. The Database Command Setup window opens:

NOTE: These parameters must be exact. If the information in these fields is entered incorrectly, you must contact Emerson Retail Solutions for assistance.

Figure 5-16 - Highlight Database Files and Click Open

Figure 5-17 - Enter Password for Database User

Figure 5-18 - Username with Database Owner Privileges

NOTE: This user must have proper privileges to drop, create, and populate tables in the database.


17. After the username has been entered, the Password window opens:

a. Enter the password for the database user and click Next.

5.3. Web Server File Location

18. Choose the location the install will deploy from in the Web Server File Location window:

a. Use the default location for deployment of the Site Manager Web server files, or click Browse to choose your own location.

b. Click Next to continue with the install and create a database or update an existing one.

Figure 5-19 - Password with Database Owner Privileges

Figure 5-20 - Location for Web Server Files

NOTE: This location must be correct in order for the application to function. If your Tomcat location has changed because of an upgrade during this install, you must change the

location to match this new Tomcat location (the “webapps” subfolder). For Web servers other than Tomcat, please see Web server documentation for correct location details.

Database Setup Installation Steps • 11

5.4. Database Setup

5.4.1. Create Database19. The Database Create/Update window opens:

a. If Create is chosen on this window, a database will be created and populated with basic data only, if a database already exists, the Database Create Procedure window will appear when Next is clicked.

b. If Update is chosen on this window, an existing database will be updated to work correctly with the latest version of Site Manager.

20. Database Create Procedure window:

a. Click Next when the database has been created, or click Cancel to quit the install and start over.

5.4.2. Database UpdateThe Database Create Procedure window (Figure 5-22) will open if you choose Update or if you have chosen Create but already have a database installed.

21. Click Yes to exit the install and back up the database, or pause on this screen, where you can back up the database and then click No to continue with the install. If you do not wish to back up the database, click No to continue with the install.

NOTE: For non Latin-based languages, there are special database settings. Contact your database administrator for further information.

NOTE: If updating or changing an existing database, it is strongly recommended that you back up any existing database before continuing.

Figure 5-21 - Create or Update Database

NOTE: If an existing database is used with this option, all data stored in the database will be lost. Also, the users created by the installation are “user” with a password of “pass” for basic

user access to the program, and “administrator” with a password of “pass” that has full control of the Site Manager system. It is strongly recommended that you rename these users and change the passwords as soon as the program is installed and running.

Figure 5-22 - Database Create Procedure

Figure 5-23 - Back Up Database?


22. The Choose Destination Location window will open where the you may choose where the database scripts will be stored:

a. Click Next to accept the default location or Change to specify another location.

23. For Advisory Receiving Setup, enter the server name or IP Address of where the advisories will be sent and the open ports for E1 Port and E2 Port fields:

These fields may be pre-populated with defaults; however, verify the IP address or server name entered in the Address field is static and visible from the controllers at the site. This address should also belong to the machine on which the installation is located. The ports entered must be

available and unused by any other application on this machine. Consult your network administrator for further information. Click Next to continue.

Email Setup

24. To send out advisories by email, enter the name of the machine that will be hosting SMTP in the SMTP field in the Email Setup window and click Next. (Change the Port if necessary and enter the Username if the SMTP server needs a login in order to send emails.) If you do not want to set up email sending, leave this field blank and click Next to skip to Step 25.

25. If a username is entered, enter the password in the window that appears below:

Figure 5-24 - Location for Database Scripts

Figure 5-25 - Advisory Receiving Setup

Figure 5-26 - Set Up Email Sending Ability

Figure 5-27 - Enter Password


To complete email setup, enter the sender email addresses in the fields; otherwise, leave blank. The Scheduler email address will be the sender of the scheduled activity results.

Click the Next button to continue.

Security Model Selection

26. When the current security model LOCAL is displayed, if No is selected, the installation process will proceed directly to the Installation Review (Figure 5-35).

If Yes is selected, the installation process will proceed to the LDAP Security Configuration window (Figure 5-31).

When the current security model LDAP is displayed, if No is selected, the installation process will proceed to the

LDAP Security Configuration window (Figure 5-31).

If Yes is selected, the security model will be changed from LDAP to LOCAL, and it should be noted that access to LDAP will not be available to Site Manager with this change. The installation process will proceed to the Installation Review window (Figure 5-35).

27. Specify the following credentials in the Server and Dom\User fields:

• LDAP URL in the Server input fieldExample: ldap://11.111.11.111:389

• LDAP UserExample: mydomain\mylogin

28. Next, specify the LDAP password credential:

Figure 5-28 - Email Setup

Figure 5-29 - Current Security Model - LOCAL

Figure 5-30 - Current Security Model - LDAP

Figure 5-31 - LDAP Security Configuration

Figure 5-32 - Enter the LDAP Password


Entering the password is required. After the password is entered and the Next button is clicked, a connection test verification process will be performed using the LDAP credentials entered by the user.

If the LDAP Connection Test failed, the following dialog will open:

29. The OK button must be clicked and the installation process will return to the LDAP Security Configuration window (Figure 5-31) and repeat the LDAP Configuration.

If the connection test was successful, the installation process will proceed to the Installation Review window (Figure 5-35) with the status of the connection test:

30. Review the installation information in the Installation Review window:

a. Click Next to continue.

31. If the Web server is up and running, you will be asked to shut it down:

a. After shutting down the Web server, click OK.

32. The Ready to Install the Program window will open to indicate the installation is ready to begin.

a. Click Install to begin the installation of Site Manager, Back to go back to the previous window, or Cancel to exit the install.

Figure 5-33 - Connection Test Failed Dialog

Figure 5-34 - Connection Test Status Information

Figure 5-35 - Installation Review

Figure 5-36 - Shut Down Web Server If Running

NOTE: The Web server must be shut down and ALL PEOPLE MUST BE OUT OF THE DATABASE before the installation can be continued.

Figure 5-37 - Begin Installation


33. The Setup Status progress window will display, detailing the status of the setup/installation:

34. If Create was chosen in the Database Create/Update window (Step 19), you will see this type of update status while the database scripts are running:

If Update was chosen in the Database Create/Update window (Step 19), you will see this type of update status while the database scripts are running:

Web Server Settings

These values are created automatically and are calculated for you based on the amount of memory. These values should not need to be changed. If you have any questions, contact Emerson Retail Solutions for assistance at 770-425-2724.

The max JVM heap size (Java command line setting -Xmx) and the min JVM heap size (Java command line setting -Xms) should be set to the same value. -Xmn is a Java “garbage” collection setting.

35. Once the settings are correct, click Next to complete the installation.

36. The InstallShield Wizard Complete window opens:

Click Finish to complete the installation of the program.

Figure 5-38 - Install Status

Figure 5-39 - Database Scripts Status

Figure 5-40 - Database Scripts Status

Figure 5-41 - Web Server Settings

Figure 5-42 - Install Complete


37. If the InstallShield Wizard Complete window asks if you would like to restart your computer, select to restart now (Yes) or later (No) and click Finish.

5.5. Product Registration and Activation

5.5.1. RegistrationTo register the software for a Trial License (90 days), go to the Feature Licensing page of the software.

1. Click the Help drop-down list and click Feature

Activation. The Feature Licensing page will open:

2. Click the Registration button to proceed in obtaining a license.

3. Click OK to open the Product Activation License Registration window. The state of the current license is displayed on this page:

NOTE: For Site Manager to function, you must start your Web server after the installation is complete.

Figure 5-43 - Restart Computer Now or Later

Figure 5-44 - Feature Licensing Page

Figure 5-45 - Click OK to Proceed

Figure 5-46 - Click Register to Begin Entering Information

Product Registration and Activation Installation Steps • 17

4. To begin entering your information, click the Register button and the window will open where you will enter your information:

5. Fill out all fields on this window including: Sales Order # (call Customer Service at 770-425-2724 to obtain your sales order number), Company Name, Address, Name, Email, Confirm Email, and a contact Phone Number. If desired, enter any extra information into the Additional Information box (optional). Note that for non-SMTP enabled systems, you must specify if the Web application is a virtual machine by selecting Yes or No for Virtual Server. Verify that the information you entered is correct and click the Submit Registration button.

For systems that are SMTP-enabled, your information will be sent automatically to Emerson Retail Solutions. Proceed to Step 6 to finish.

If successful, a confirmation window will open to notify

you that your registration information has been sent:

6. Click OK and you will return to the Feature Licensing page (Figure 5-44).

7. For systems that are not SMTP-enabled, (for more information, refer to Step 24 of this document) after filling out your information (Figure 5-47), follow the instructions in the Product Activation and Licensing window:

Step 1 - Create an email and include all the information listed in this step.

Figure 5-47 - Fill Out All Fields and Click Submit Registration

Figure 5-48 - Click OK

Figure 5-49 - Follow Steps 1-5 on this Window


Step 2 - Enter [email protected] in your email’s To: field.

Step 3 - In the Subject: field of your email, enter Site Manager Product Activation License SO# (followed by the Sales Order number obtained from customer service).

Step 4 - Open your browser window and locate the directory that contains the .zip file (verify that it is the most current version if there are more than one).

Step 5 - Send the email to [email protected]

Click OK.

This will return you to the Feature Licensing page (Figure 5-44).

5.5.2. Activation1. Once you receive the email containing the file for

purchasing the software, save the file to a location on your drive.

2. On the Feature Licensing page (Figure 5-44), click Activation:

3. Click OK on the confirmation window to proceed:

4. The Product Activation License Import window will open and show the current state of licensing:

5. Click Browse and the File Upload window will open:

6. Highlight the file and click Open.

7. When the file appears in the Browse path, click the Import License button:

Figure 5-50 - Activate License - Feature Licensing Page

Figure 5-51 - Click OK

Figure 5-52 - Click Browse

Figure 5-53 - Locate File in the File Upload Window

Figure 5-54 - Click Import License

Launching Site Manager Installation Steps • 19

8. The Product Activation License Update window will open:

9. Once the Apply Imported License button is clicked, the selected license file will be applied (or click Cancel to stop and exit).

5.6. Launching Site Manager

1. To launch the Site Manager program:

a. Open a Web browser. If running the same computer on which Site Manager was installed, type http://localhost/emerson inside the browser field. If running the program from another computer, use the machine name or IP address instead of localhost. The Site Manager program will open.

b. You may now log into the program. Users created by the installation are “user” with a password of “pass” for basic user access to the program, and “administrator” with a password of “pass” that has full control of the Site Manager system. It is strongly recommended that you rename these users and change the passwords as soon as the program is installed and running so that duplicate login names and passwords do not occur. For more information, refer to the User Manager and Group Manager online help.

Figure 5-55 - Click Apply Imported License

NOTE: If you wish to import site information from UltraSite or Site Manager Terminal Mode, go to the Administrative Activities section of the Site Manager online help and

follow the instructions for importing an XML datafile.


6 Upgrading Site Manager

1. To upgrade Site Manager to a newer version, run the CD or the setup.exe, and the Upgrade or Remove Program window opens to indicate that the program has been detected.

2. Select Upgrade and click Next.

3. Click Yes to continue with the uninstall, No to go back to the previous screen.

4. An Upgrade Reminders window will open with varying reminders depending on what version of the software you are upgrading to. Note these

reminders as they may impact installation after the upgrade is complete.

You must first uninstall the current installed version, and then repeat the setup steps of this guide (Section 5, Installation Steps) to install the new version.

5. Click Next to uninstall the current version and repeat the installation steps.

NOTE: When upgrading Site Manager, refer to Technical Bulletin P/N 026-4307 for complete instructions on how to upgrade Tomcat.

Figure 6-1 - Upgrade Site Manager

Figure 6-2 - Uninstall Current Version of Site Manager to Upgrade

Figure 6-3 - Make a Note of Upgrade Reminders

Launching Site Manager Uninstalling Site Manager • 21

7 Uninstalling Site Manager

1. To uninstall Site Manager, go to Add/Remove Programs in the Windows Control Panel, choose Site Manager, and the Upgrade or Remove Program window opens indicating that the program has been detected.

2. Select Remove and click Next to begin an uninstallation of the program. A confirmation window will open asking if you want to remove the selected application and all of its features.

3. Click Yes and a confirmation window opens. The Web server must be shut down before continuing with the uninstall. (Start > Control Panel > Administrative Tools > Services > Your Web Server > Right-click and select Stop)

4. Click Yes (Figure 7-3) after the Web server has been shut down to continue with the uninstall, or click No to stop the uninstall. (This will only occur

if the install identifies that the Web server is up and running; otherwise the window does not appear.)

5. The Maintenance Complete window will open. Click Finish to complete and exit the uninstall.

Figure 7-1 - Select Remove to Uninstall

Figure 7-2 - Remove Application?

Figure 7-3 - Click Yes to Continue

Figure 7-4 - Maintenance Complete


8 Quick Start Software Setup

8.1. OverviewThis section gives step-by-step instructions to show you how to log in to Site Manager, set up the navigation tree, user access, and communication information. From the navigation tree you can connect to controllers, set up directory, site, control system, and unit information.

8.2. Launching Site Manager

To begin using Site Manager, open a Web browser:

If running the same computer on which Site Manager was installed, type http://localhost/emerson inside the browser field. If running the program from another computer, use the machine name or IP address instead of localhost. The Site Manager program will open.

You can begin using Site Manager by creating a directory structure Section 8.5., Create A Directory Structure or setting up users Section 8.6., Set Up Users (Optional).

8.3. LoginThe login page is the first page that appears when the program is started.

1. Enter your Login ID and password into their respective fields (the Password field is case sensitive).

Users created by the installation are “user” with a password of “pass” for basic user access to the program, and “administrator” with a password of “pass” that has full control of the Site Manager system. It is strongly recommended that you rename these users and change the passwords as soon as the program is installed and running. It is also highly recommended that each user have his/her own login. For more information, go to User Manager and Group Manager sections of the Site Manager online help.

2. Press the Login button or press Return on your keyboard.

3. Click the I Agree button to begin using the application. (First-time users will be presented with the license agreement window.)

4. Once your login has been validated, the home page will open where the navigation tree and main information window are located.

8.4. LicensingSite Manager has basic (Maintenance Upgrades & Tech Support license) and extra features that are activated by obtaining a license (some of which will need to be renewed yearly) and includes features such as user info, pending activities, activity history, setup, obtaining controller info, adding, editing, and deleting directories, sites, and control systems, and some administrator functions.

For features such as backing up, sending reports, forwarding and viewing advisories, setpoint broadcast, accessing the online help system, firmware transfer, and more, a Site Manager license is needed for activation. Additional plug-in features will need specified keys for operation.

The license key must be entered on the Feature Licensing page to activate the desired feature. A Maintennance Upgrades & Tech Support license key activates basic features and the feature license key activates feature functionalities of Site Manager.

The licensing activation page is accessible from the Feature Activation menu on the online help drop-down menu in Site Manager. The menu will only be visible with certain user privileges enabled to allow you to add/edit software license keys.

1. Locate your unique Hardware Fingerprint number on the Feature Licensing page.

Figure 8-1 - Site Manager Login

Create A Directory Structure Quick Start Software Setup • 23

2. Call Emerson Retail Solutions Customer Service at 770-425-2724 with the Hardware Fingerprint to obtain a license key for the desired features you wish to activate.

3. Click the Add Feature button on the Licensing page and enter the key into the boxes provided.

4. Click Save.

The key entered will know what feature it is associated with and will populate the appropriate field(s) on the screen. To override an existing key, a new key will need to be added and replace the existing key.

Click Cancel to stop and exit.

8.4.1. Maintenance Upgrades & Tech Support Licensing

The basic features of Site Manager require a Maintenance Upgrades & Tech Support license key and will be entered when first starting the program. As the one-year renewal period approaches, a reminder window will appear and prompt you to renew the Maintenance Upgrades & Tech Support key. Contact Emerson Retail Solutions Customer Service for renewal 770-425-2724.

For more information on Status definitions, see the Feature Activation and Licensing topic in the Site Manager online help.

8.4.2. Feature LicensingAll possible Site Manager features will be displayed on the Site Manager Feature Activation screen.

8.5. Create A Directory Structure

8.5.1. Add A DirectoryDirectory structures include a directory, a site, and a control system. Units will automatically be populated once the control system has been added. To begin using the program by setting up a directory structure:

1. Right-click Site Directories in the navigation tree and click Add Directory, or open the Admin Tools drop-down menu.

2. Click Setup > Directory Manager.

3. Click the Add New button. The Directory Configuration page opens.

4. Enter the directory information into the fields and click Save. Your directory should now appear in the navigation tree where you can begin adding sites and other view levels.

Once a directory is created, sites and control systems can be added and will become visible on the tree. These different levels or “nodes” make up the navigation tree structure.

8.5.2. Add A SiteTo add a site from the navigation tree:

1. Right-click the directory you wish to add the site to.

2. Click Add Site. The Site Configuration page opens.

You can also access this menu from the Site Manager menu located under the Admin Tools drop-down list (click Add New) from the Site Manager page.

3. Enter the site information into the fields and click Save. The site you just added appears in the

Figure 8-2 - Site Manager Feature Licensing Page

Figure 8-3 - Directory Configuration Page


navigation tree where you can continue to add sites and other view levels if desired.

Click Cancel to stop and exit the page.

8.5.3. Add A Control SystemTo add a Control System from the navigation tree:

1. Right-click the site you wish to add the control system to (a control system is a descendant level of a site).

2. Click Add Control System. The Control System Configuration page opens.

3. Enter the control system information (Name, IP Address) into the fields and click Save. The new

control system is visible in the navigation tree. Continue to add other view levels if desired.

8.5.3.1. Security Settings

Security settings for Site Manager are defaulted at the group configuration level normally. Under the Optional section on the Control System Configuration page: If the protocol checkbox is enabled here (at the control system level), Site Manager will use the protocol information entered at the control system level and bypass the information at the group level for only the units located under this control system.

8.6. Set Up Users (Optional)It is recommended that a directory structure be set up first, but users with administrator privileges can set up users and passwords:

1. Open the Admin Tools drop-down menu.

2. Click Setup > User Manager.

3. Click the Add New button. The User Configuration page opens.

Figure 8-4 - Site Configuration Page

NOTE: Click the Refresh button at the top of the navigation window to see any new levels that have been added. The Windows

Refresh button on the browser will log you off.

Figure 8-5 - Control System Configuration Page

Set Up Users (Optional) Quick Start Software Setup • 25

4. Enter the user information into the fields and click Save. A user has been created and is saved to the database.

You have now successfully created a navigational tree structure where you can continue adding directories, sites, and other view levels.

Figure 8-6 - User Configuration Page

What Else Can You Do On The User Configuration Page? Set the Engineering Units default, activate GS Screen menus, and enable GS Screens to be set as your home page.

• A-1

Appendix A: System Requirements and Administrator ActivitiesCAUTION! Actual hardware system specifications are dependent upon multiple factors such as the number of concurrent users logged into the system, database storage requirements, number of activities run concurrently, types of activities to be run, the number of stores in the enterprise, and more. Contact your Retail Solutions representative to determine actual specifications required prior to installation.

Supported Product Versions

Multiple Server Configuration

Application Server (System Requirements) Database Server (System Requirements)

Minimum Specifications:

• 4GB of memory

• 4 CPU with 1.82 GHz

• 50GB hard drive space with 20% free

See the Supported Product Versions table below for the supported versions of Microsoft Windows Server

Minimum Specifications:

• 16GB of memory

• 8 CPU with 1.82 GHz

• Variable hard drive space with 50% required free because of SQL requirements.

See the Supported Product Versions table below for the supported versions of Microsoft SQL Server

NOTE: Using E2 2.10F01 or higher with the Site Manager program is recommended for optimum performance.

Product Name Supported Version

Java 1.8.0_45 (For Site Manager versions 16.1 and later)

Tomcat 8.0.23

Microsoft Windows Server • Microsoft Windows Server 2008 R2 Enterprise

• Microsoft Windows Server 2012 R2 Standard

Database Server • Microsoft SQL Server 2008 R2 SP1

• Microsoft SQL Server 2012 R2 SP1SQL Enterprise version is required for high volume usage and retention of data.Please note that Oracle Database and MySQL Databases are NOT supported.

Supported Browsers • IE 9 and above

• Latest version of Chrome (available on the Google Web site)https://www.google.com/chrome/browser/

• Latest version of Firefox (available on the Mozilla Web site)http://www.mozilla.org/en-US/firefox/new/

A-2 • Site Manager Installation and Admin Guide 026-1010 Rev 15 31-MAR-2017

Database and Web Server Backup

It is highly recommended that a backup of the database and Web server areas be performed on a daily basis for a complete recovery of information in the event of a failure of the Web server on which Site Manager is running. It is suggested that user-created components such as GS screens, widgets, images, and schedules be backed up.

STEP A

1. Back up the database using the standard procedure for your particular database.

2. Back up the applicable Web server areas:webserverhome\webapps\emerson\WEB-INF\classes\com\cpcus\jaru\ui\jsonrpc\GsFilesystem\Screens\User

If applicable: webserverhome\webapps\emerson\WEB-INF\classes\com\cpcus\jaru\ui\jsonrpc\GsFilesystem\Widgets\User

webserverhome\webapps\emerson\WEB-INF\classes\com\cpcus\jaru\ui\jsonrpc\GsFilesystem\Images

Log retrieval schedule files located in: webserverhome\webapps\emerson

If using a clustered environment, include these steps when backing up:

STEP B

If the environment being upgraded is now going to be in a clustered environment, each worker box in the cluster must have the GsFilesystem mirrored.

Copy the whole {tomcat webapp | worker classes folder}\classes\com\cpcus\jaru\ui\jsonrpc\GsFilesystem folder identically to each worker box.

Note that the location of these files are the default settings. They are user-configurable and therefore may be different. webserverhome is the location of your particular Web server. For example, a Web server location might be: c:\program files\tomcat.

Importing XML Datafile

When exporting a tree from UltraSite, the XML file can either be exported from UltraSite or the Site Manager PC application. For UltraSite, the XML file can be exported and saved via the Export Data options by right-clicking on the UltraSite tree. The file will be located in the UltraSite install location. For the Site Manager PC application, the XML file is stored in the Site Manager PC application install location, or a common location depending on the installation options chosen at the time of the install. Note that for the Site Manager PC application, all sites to be imported are assumed to be E2 sites and must be changed in the Site Manager application after importing is complete. From the Start menu on the Web server machine, go to Programs > Computer Process Controls > Emerson > XML Import Directions and follow the instructions for importing the XML file. (The XML import tool can be run as many times as desired and will only import new sites and directories. To run it more than once or to run it outside of this installation, view the XML import directions found at the path listed above.)

Note that because the Site Manager software must have time to start, the Yes button may have to be clicked several times after the Web server has been started.

Remember that only sites not already in the database will be imported, so the total number of sites may be lower than expected.

Default Time Zone During Import

If a time zone ID for a site is not present in the XML import file, it will be set to US/Eastern as default.

Troubleshooting

Page Troubleshooting

Online Help Navigation - Pop-up Window Scrolling in Online Help:

To scroll through pop-up windows in the online help, use the scroll wheel on your mouse. To close pop-up windows, click anywhere off the pop-up. If pop-up pages in the help appear blank, right-click inside the window and select Refresh.

• A-3

Error Report

If Site Manager encounters a program malfunction during a user's browsing session, an error report will appear on screen:

The error report page displays information of when (date and time) and where the error occurred.

• The Details button will show a set of program codes of the error when clicked. Click Hide Details to hide.

• Description - enter a description of the error in the field provided (what occurred before the error took place)

• Company - enter the name of your company

• Telephone - enter your contact numbers

• Email Address - (pre-filled by default) the error report will be sent to this email address

• Required Fields: Description, Company, Telephone

• Click Send to send the error report email.

Note that the Help link that is found in this page will not contain information about the current page. When clicked, help information about the page you were on right before the error occurred will display.

• B-1

Appendix B: Java Installation

If you are installing Java Runtime, the following windows will appear. If you need the Apache Tomcat installation, go to Appendix C: Apache Tomcat Installation.

1. The license agreement window will open:

a. The Java 2 SDK License Agreement window will open. I accept the terms in the license agreement must be selected to continue with the install and open the Custom Setup window:

2. The Custom Setup window gives you the option to only install what features are needed.

a. Development Tools and Public Java Runtime Environment are the only two that need to be selected.

b. If you wish to deselect an option, click the down arrow in the icon next to the item and select don't install this feature now.

c. Click Next and the development components will be installed.

3. The next Custom Setup window displays program features to install. Click Next to install these default features and proceed to the Browser Registration window.

4. The Browser Registration window will open:

a. Click Next to continue and start the installation.


Figure B-1 - Java License Agreement

Figure B-2 - Select Program Features to Install

Figure B-3 - Default Program Features to Install

Figure B-4 - Browser Registration

B-2 • Site Manager Installation and Admin Guide 026-1010 Rev 15 31-MAR-2017

5. A progress window will appear showing the progress of the Java installation:

6. When the installation of the Java is complete, the Java 2 SDK InstallShield Wizard Completed window opens:

a. Click Finish.

NOTE: If you have questions about the install, contact www.java.sun.com.

Figure B-5 - Java Install Progress Window

Figure B-6 - Java Install Complete Window

• C-1

Appendix C: Apache Tomcat Installation

When a Tomcat directory exists from a previous installation, this dialog will appear. Click OK from this dialog box to proceed with the installation. Refer to technical bulletin P/N 026-4307 for complete instructions if upgrading from a previous version of Tomcat.

1. If you are installing Tomcat, click Next on the first window of the Setup Wizard:

a. Click the I Agree button to continue:

2. Next, select the components of Tomcat to install from this window:

a. Check Tomcat, Start Menu Items, and Documentation. Select the Service Startup checkbox. It is strongly recommended that Service Startup be checked. If the Service Startup component is not selected, you will have to manually start the Web service each time the server is rebooted.

For security purposes, it is strongly recommended that Manager and Host Manager be unchecked as


Figure C-1 - Click OK To Proceed With Install

Figure C-2 - Install Tomcat

Figure C-3 - Tomcat Software License

Figure C-4 - Select Components to Install

C-2 • Site Manager Installation and Admin Guide 026-1010 Rev 15 31-MAR-2017

enabling these could be a security risk.

b. Click Next to proceed.

3. The Configuration Options window opens:

a. Optional fields include Connector Port and Create shortcuts for all users. Changing the HTTP/1.1 Connector Port to 80 and setting the Windows Service Name to Tomcat is optional depending on your environment. It is strongly recommended that for normal use the connector port be changed to 80.

For security purposes it is strongly recommended changing the User Name and Password fields from the default settings especially if exposing the system to the public Internet.


4. Select the path for the Java Virtual Machine:

This default location should be correct, but verify the path and change if needed.

a. Click Next to proceed and select the directory where you would like Tomcat to be installed.

5. Choose the default location or click Browse to choose a custom location from this window:

Figure C-5 - Tomcat Port Configuration

Figure C-6 - Select the Java Virtual Machine Path

Figure C-7 - Tomcat Install Location - 32 Bit

• C-3

For first-time installations, this naming path directory for Program Files is recommended.

If installing Site Manager for the first time, you will be asked to specify the Tomcat folder path. For ease of installation, set the folder path to “C:\Program Files\Tomcat” for 32 bit machines or “C:\Program Files (x86)\Tomcat” for 64 bit machines.

If installing Site Manager upgrade, specify the existing Tomcat folder path. Browse to the location of the existing Tomcat folder on your machine.

a. When you have selected the location, click Install to proceed with the installation.

6. Click OK on the dialog box to continue:

7. The Tomcat Setup progress window will open:

Figure C-8 - Tomcat Install Location - 64 Bit

NOTE: To avoid a change in Site Manager’s location each time Tomcat is upgraded, it is suggested that a generic, non-version specific

location for the install be chosen. For example, C:\Program Files\Tomcat or C:\Program Files (x86)\Tomcat.

Figure C-9 - Click OK to Proceed With Install

Figure C-10 - Tomcat Setup Progress

C-4 • Site Manager Installation and Admin Guide 026-1010 Rev 15 31-MAR-2017

a. Complete the Wizard Setup:

b. Verify the Run Apache Tomcat and Show Readme checkboxes are unchecked, and click Finish to close the Tomcat Setup window and complete the setup.

Figure C-11 - Click Finish To Complete Tomcat Setup

• D-1

Appendix D: Notes On Upgrading Upgrading Site Manager Versions 14.3 or Prior to Versions 15.1 or Above

OVERVIEW

Due to the growing feature set in Site Manager 15.1, the database update component of the installation will require additional steps to ensure proper completion. If Site Manager 14.3 or prior is currently installed and now moving to versions 15.1 or above, the following steps must be performed. Note that this upgrade may take longer than typical upgrades. Please allow the system to run without interruption.

ENSURE AVAILABLE DATABASE SPACE

This update requires a temporary copying of some data from one of the tables in the database. There-fore, space must be available for the Site Manager update to be successful.

Run the following command using SQL Server Management Studio:

exec sp_spaceused 'reference'

Determine adequate data space by taking the amount from the Data column in the result from the query and multiplying by 3. For example, if the value in the Data column is 1094528 KB, the database must have at least 3283584 KB (3.1 GB) free.

The database Transaction Log Configuration must be changed temporarily during the installation to one of these two options:

a. Set Recovery Mode to Simple Mode and ensure 20GB space is available. A full database backup is recommended prior to switching to Simple Mode.

b. Set Transaction Log to grow as needed and ensure 75GB space is available for transaction log.

After the installation has been completed, the configuration can be reset to the original settings and any free database space can be reclaimed if desired. Also note that if changing to Simple Mode temporarily, a full backup of the database should be done after returning to Full Recovery Mode.

• E-1

Appendix E - LDAPS InstructionsSTEP 1: Log into Site Manager using a non-LDAP user with Super User privilege.

Using the Super User menu, access the Properties Manager and ensure that the key named security.ldap.port is set to 636. If not, set the value to 636, ensure that the database radio button is checked, and click the Create/Update Override Value button. Once complete, log out of the Site Manager product.

Figure E-1 - Super User Menu

Figure E-2 - Properties Manager

Figure E-3 - Create/Update Override Value

E-2 • Site Manager Installation and Admin Guide 026-1010 Rev 15 31-MAR-2017

STEP 2: On the Site Manager application server, stop the Tomcat service via Windows Services.

After the tomcat service is stopped, ensure that the E1Protocol.exe and E2Protocol.exe processes are not active via Task Manager or the Process tab.

Figure E-4 - Tomcat Service

• E-3

STEP 3: Open a Command Prompt by typing cmd.exe and ensure it is using Run As Administrator.

Figure E-5 - E1 and E2 Protocol Services

Figure E-6 - Open Command Prompt

E-4 • Site Manager Installation and Admin Guide 026-1010 Rev 15 31-MAR-2017

STEP 4: In the Command Prompt, navigate to the Java Bin Directory (normally C:\Program\Files\Java\jre6\bin).

STEP 5: Type the following command: keytool -import -alias X -file Y -keystore..\lib\security\cacerts.

a. Note that X is usually the file name of the certificate and Y is the location and name of the certificate. For instance, X could be Emerson and Y could be c:\emerson.cer.

b. For example: keytool -import -alias Emerson -file c:\emerson.cer -keystore..\lib\security\cacerts.

STEP 6: Press Enter, and enter the Certificate Store Password.

The default password is changeit.

STEP 7: Type Yes and press Enter when asked to Trust This Certificate.

STEP 8: Assuming there are no errors, start the Tomcat service and wait for it to come up completely (it might take a few minutes).

STEP 9: Using your browser, go to the Site Manager login screen and try to log in using an LDAP user already entered into the Site Manager user list. The login attempt should be successful if the correct credentials are used.

Figure E-7 - Java Bin Directory

Figure E-8 - Administrator: Command Prompt

The contents of this publication are presented for informational purposes only and they are not to be construed as warranties or guarantees, express or implied, regarding the products or services described herein or their use or applicability. Emerson Climate Technologies Retail Solutions, Inc. and/or its affiliates (collectively “Emerson”), reserves the right to modify the designs or specifications of such products at any time without notice. Emerson does not assume responsibility for the selection, use or maintenance of any product. Responsibility for proper selection, use and maintenance of any product remains solely with the purchaser and end-user.

026-1010 31-MAR-2017 Emerson is a trademark of Emerson Electric Co. ©2017 Emerson Climate Technologies Retail Solutions, Inc. All rights reserved.

site manager installation and administrator guide · 2 • site manager installation and admin...

Documents