RSM Web Gateway RSM Web Client INSTALLATION AND ADMINISTRATION GUIDE

RSM Web Gateway RSM Web Client INSTALLATION AND ADMINISTRATION GUIDE Installation and Administration Guide RSM Web Client and RSM Web Gateway 17 August, 2004 Page 1

Copyright Notice 2004 Sony Corporation. All rights reserved. This manual may not be reproduced, translated or reduced to any machine readable form in whole or in part, without prior written approval from Sony Corporation. SONY CORPORATION PROVIDES NO WARRANTY WITH REGARD TO THIS MANUAL OR INFORMATION CONTAINED HEREIN AND HEREBY EXPRESSLY DISCLAIMS ANY IMPLIED WARRANTIES OF MERCHANTABILITY OR FITNESS FOR ANY PARTICULAR PURPOSE WITH REGARD TO THIS MANUAL OR SUCH INFORMATION. IN NO EVENT SHALL SONY CORPORATION BE LIABLE FOR ANY INCIDENTAL, CONSEQUENTIAL OR SPECIAL DAMAGES, WHETHER BASED ON TORT, CONTRACT, OR OTHERWISE, ARISING OUT OF OR IN CONNECTION WITH THIS MANUAL OR INFORMATION CONTAINED HEREIN OR THE USE THEREOF. Sony Corporation reserves the right to make any modification to this manual or the information contained herein at any time without notice. Trademarks Microsoft, Windows and Windows NT are registered trademarks of Microsoft Corporation. Intel and Pentium are registered trademarks of Intel Corporation. Ethernet is a registered trademark of Xerox Corporation All other brands and product names are trademarks or registered trademarks of their respective owners. Page 2 17 August, 2004

Contents Introduction...4 RSM Web Gateway Installation...5 RSM Web Gateway Requirements... 5 Starting the Installation process... 6 Starting RSM Web Gateway... 13 Uninstalling RSM Web Gateway... 14 RSM Web Client Installation...15 RSM Web Client Requirements... 15 Java Runtime Environment... 16 Java Plug-in... 16 Uninstalling RSM Web Client... 17 RSM Web Administration...18 RSM Web Administration... 18 Registering RSM Servers with RSM Gateway... 18 User Administration... 24 Listing RMS Web Client Users... 24 Adding Users to the RSM Web Client... 25 Editing Roles Assigned to a User... 26 Deleting a User From the RSM Web Client... 27 Viewing Active Users... 27 Recovering Forgotten User Passwords... 28 Increasing Performance and Scalability of RSM Web Gateway... 29 Appendix...31 Roles... 31 Pan, Tilt and Zoom (PTZ) User... 32 User Administrator... 32 RSM Web Client Administrator... 32 Page 3 17 August, 2004

Chapter 1 Introduction RSM Web Client and RSM Web Gateway enable you to access your RealShot Manager installation though a web browser. Figure 1 illustrates a typical RSM Web system architecture. Up to 32 cameras RSM Web Client RSM Web Gateway Up to 32 cameras RSM Servers Trusted Network Up to 32 cameras Figure 1 System Example This document describes how to: Install the RSM Web Gateway Install the RSM Web Client. Administer the RSM Web Client. Page 4 17 August, 2004

Chapter 2 RSM Web Gateway Installation This section describes how to install RSM Web Gateway on your computer. RSM Web Gateway Requirements The following table describes the system configuration required to successfully install the RSM Web Gateway. Where appropriate, links have been provided to sites that provide additional information and support. Administrator rights are required on the installation PC. Operating System Windows 2000 Minimum service pack 3 Windows XP Latest Service Pack CPU 2.0 GHz (or faster) Intel Celeron, Intel P4 or equivalent RAM 512 MB Minimum Hard Disk 500 MB Spare Capacity Web Browser Internet Explorer Version 6.0 or later Miscellaneous Network connection RSM Web Gateway includes software developed by The Apache Software Foundation (http://www.apache.org/). Page 5 17 August, 2004

Starting the Installation process To start the installation process, launch the RSM Web installation by double-clicking on the RSM Web Gateway executable file (RSM Web Gateway 1.0.1.exe). The installation procedure is outlined below. Step 1 The RSM Web Gateway installer will guide you through the installation. Click Next to continue. Step 2 The installer will detect if the Java Runtime Environment (JRE) is installed and that the version is 1.4.2 or higher (excluding version 1.5). If necessary the RSM Web Gateway installer will launch the Java JRE installer. If the JRE is already installed you will skip to step 6. Tick I accept the terms in the license agreement and then click Next to continue. Page 6 17 August, 2004

Step 3 Choose Typical and then click Next to continue. Step 4 Wait until the installer has completed copying the files. Step 5 Click Finish to successfully complete the installation of the Java Runtime Environment. The RSM Web Gateway installer will now begin the Apache Tomcat installation. Page 7 17 August, 2004

Step 6 The installer will detect if Tomcat 5.0 is installed. If not the RSM Web Gateway installer will launch the Apache Tomcat 5.0 Setup Wizard. Click Next to continue. If Tomcat V5.0 is already installed, the install procedure skips to Step 13. Step 7 Click I Agree to continue the installation of Apache Tomcat 5.0. Step 8 IMPORTANT: Click on the Service check box in the Tomcat node to install Apache Tomcat V5.0 as a service. Click Next to continue. Page 8 17 August, 2004

Step 9 Browse to the directory in which Tomcat 5.0 will be installed. Click NEXT to continue. Step 10 Adding the Tomcat V5.0 basic configuration details. N.B. Make a note of the CONNECTOR PORT that you enter here as this is also required for Step 15. Click NEXT to continue. Step 11 Select the folder where the Java JRE is installed. Click INSTALL to continue. Page 9 17 August, 2004

Step 12 Wait until the Setup Wizard has finished the Apache Tomcat installation Step 13 Uncheck the two check boxes ( Run Apache Tomcat and Show Readme ) Click Finish to successfully complete the Tomcat installation. Control now passes back to the RSM Web Gateway Installer. Step 14 Selecting the install Destination Directory. Click Change to choose the destination directory. Click Next to continue. Page 10 17 August, 2004

Step 15 Enter the port number on which the Apache Tomcat V5.0 application is running. This is the same as the port number you entered in Step 10. Contact your local Network Administrator to ascertain the port number, if in doubt. Step 16 To launch the RSM Web Gateway automatically on Windows start up: Click on the Start Tomcat web Server check box. Uncheck this box to launch the RSM Web Gateway manually. Step 17 Enter the hostname or IP address and port that clients will use to connect to the RSM Web Gateway. If the server name is not resolvable, enter an IP address. The port is typically the same as the Tomcat port entered in Step 10 and 15. However, if your system is protected by a firewall using Network Address Translation, the port number may be different. If in doubt, consult your Network Administrator. Note: If the details are entered incorrectly for Step 17, users will be unable to view Live Camera Feeds. To change these settings, RSM Web Gateway should be uninstalled then reinstalled. Page 11 17 August, 2004

Step 18 Click Back to change any of the previously entered configuration details or click Install to copy the RSM Web Gateway files onto your computer. Step 19 Click Finish to exit the installer. The RSM Web Gateway is now ready for use. Page 12 17 August, 2004

Starting RSM Web Gateway To start RSM Web Server, navigate to Start Programs Sony RSM Web Gateway and click on Start RSM Web Gateway as shown below: This will start the RSM Web Gateway and open an RSM Web Client session in Internet Explorer. Note: RSM Web Gateway can also be started and stopped using the Windows Services. 1. Navigate to Start Settings Control Panel Administrative Tools Services 2. Select Apache Tomcat from the list. 3. Click on the Start icon. Page 13 17 August, 2004

Uninstalling RSM Web Gateway To uninstall RSM Web Gateway follow the process described below: Step 1 Got to Start Settings Control Panel Add or Remove Programs And select RSM Web Gateway. Click on Change/Remove. Step 2 Click OK to Uninstall RSM Web Gateway will be removed from your computer. Note that this process does not uninstall Tomcat 5.0. To uninstall Tomcat, select Apache Tomcat 5.0 from the Add or Remove Programs window and click on Change/Remove. Page 14 17 August, 2004

Chapter 3 RSM Web Client Installation This section describes how to install RSM Web Client on your computer. RSM Web Client Requirements The following table describes the system configuration required to successfully use RSM Web Client. Where appropriate, links have been provided to sites that provide additional information and support. Operating System Windows 2000 Minimum service pack 3 Windows XP Latest Service Pack CPU 2.0 GHz (or faster) Intel Celeron, Intel P4 or equivalent RAM 512 MB Minimum Hard Disk 500 MB Spare Capacity Web Browser Internet Explorer Version 6.0 or later Miscellaneous Network connection RSM Web Client is designed for minimum installation. To use the RSM Web Client, open Internet Explorer and enter the URL for your RSM Web installation as http://<rsmweb-servername>:<port>/rsm (for example, http://rsm.sonybiz.net:8080/rsm) You will be presented with the logon page. The default logon details are: User Name: Password: admin admin It is recommended to change the password after logging in. Page 15 17 August, 2004

Java Runtime Environment The Java Runtime Environment version 1.4.2 or later is required for the RSM Web Client. Note that Java 1.5, currently available as a beta release, is not supported and should not be present on the server or client. If the JRE is not present, then the following window will appear: Click Yes, and then follow the instructions as outlined in steps 2 to 6 in the RSM Web Gateway installation. Note: It may take some time to download the Java Runtime Environment over a slow network connection. Java Plug-in The RSM Web Client applet is downloaded at logon. The applet s digital certificate is now displayed awaiting your response. Page 16 17 August, 2004

Click Yes to trust the applet for this session only, or click Always to avoid seeing this message again The first time that you run the RSM Web Client on your PC, you are prompted to install an extension for inteljpegdecoder. This enables faster performance when viewing cameras. Note: If the incorrect details were entered in Step 17 of the RSM Web Gateway installation process, this part of the client installation will be unsuccessful, and an error will occur on the RSM Web Client. Click Yes to install the inteljpegdecoder extension. Click OK to continue loading the applet. Uninstalling RSM Web Client The RSM Web Client is a web-based client, therefore there is no uninstall mechanism. Page 17 17 August, 2004

Chapter 4 RSM Web Administration To administer the RSM Web Client you must be assigned one or more or the following roles: RSM Web Client administrator User administrator Each role has the ability to configure the relevant details in the particular area of operation. This section describes the tasks associated with each of these roles and explains how to use them. RSM Web Administration If you have been assigned the role "RSM Web Client Administrator" you can: List all registered RSM Servers Add or remove RSM Servers Modify configuration parameters. Registering RSM Servers with RSM Gateway To expose RSM Servers via RSM Web Gateway, the RSM Servers must be shared and then registered with RSM Web Gateway. Page 18 17 August, 2004

Configure RSM to Share its Resources 1. Open your RealShot Manager General Settings, click on the Remote & Sharing tab and then check the box next to Enable sharing this computer to enable sharing: Specify the name of your RSM Server that users will use to identify the sever and enter the port number that the RSM Server will use for connections from RSM Web Gateway then click OK. 2. Open your RealShot Manager Setup Manager and share any resources which are to be visible to the RSM Web Client and Gateway: Enable the sharing of each camera that you want to make available to users Page 19 17 August, 2004

Share all IO Pins that are to be raised as alarms on the RSM Web Client. It is advisable to give the IO Pin a user friendly, meaningful name, as the IO Pin name will appear on the RSM Web Client when the pin is turned on. For detailed information, refer to your RealShot Manager Administration Guide. Configure RSM Web Gateway to Access your RSM Server(s) 1. Open the RSM Web Client and login using and account with RSM Administrator privileges. The default Administrator login is admin with the password admin it is highly recommended that this password is changed at first login. 2. Click on RSM Admin to open the RSM Server administration page then click on Add RSM Server to add your server. Page 20 17 August, 2004

3. Enter the parameters for the RSM Server machine: IP Address the IP Address of the machine that the RSM Server is running on. Port the port that the RSM Server is shared on. Hostname the hostname of the RSM Server. Can be obtained by typing hostname in a command prompt window on the RSM Server. Username the username that was entered when sharing the RSM Server (RSM 2.2 and later). The password is case sensitive. Password - the password that was entered when sharing the RSM Server (RSM 2.2. and later). The password is case sensitive. Proxy via RSM Web Gateway this should be checked if the RSM Servers are on a network which is not visible to the RSM Web Client. For example, the RSM Servers may be on private, non-routable IP addresses (e.g. 192.168.*.* or 10.*.*.* ) or behind a firewall, or in a network environment which uses Network Address Translation. If in doubt, please consult your network administrator. If ANY of the RSM Server details are entered incorrectly, the RSM Server and cameras will be not be visible to RSM Web Client users. Page 21 17 August, 2004

4. Click Add to add the RSM Server to the list. All users will now be able to see the RSM Server and access the camera feeds shared on it. Note: When the RSM Web Gateway has successfully contacted the RSM Server, the RSM Server name will appear in the name field. Click refresh on the browser in the RSM Admin pages to check that the RSM Server name is available. If the RSM Web Gateway is unable to contact the RSM Server, the name field will remain blank. This may be an indication that the RSM Server is unavailable or the RSM Server details have been entered incorrectly. Repeat the above process to add all of the RSM Servers you want to provide access to through the RSM Web Gateway. Adding the RSM Image Compressor (optional) RSM Web Gateway can regulate the bandwidth used by image streams for clients working in a limited bandwidth environment. This is done using the supplied RSM Image Compressor component to provide on-the-fly compression of the camera feeds through the RSM Web Gateway. Users cannot modify bandwidth settings unless the RSM Image Compressor has been registered via the RSM Admin pages. You must install the RSM Image Compressor then configure the RSM Web Client with the host machine s details as follows: 1. To add the RSM Image Compressor, launch the Image Compressor installation by doubleclicking on the Setup.exe file in the RSM Image Compressor folder. 2. Follow the on screen instructions to perform the installation. By default the RSM Image Compressor is installed to start automatically and communicate on port 9999. Refer to the RSM Image Compressor Release Notes for more information about this component. 3. Open the RSM Web Client and login using and account with RSM Administrator privileges. 4. Click on RSM Admin to open the RSM Server administration page then click on RSM Image Compressor to add your RSM Image Compressor. 5. Enter the IP address of the machine that the RSM Image Compressor is installed on and its port number (only if you changed this manually after installation). Page 22 17 August, 2004

6. Click Save to store the changes and to link the RSM Web Gateway with the RSM Image Compressor. A confirmation message is displayed. Modifying your RSM Server Settings If you remove an RSM Server or change the host machine s IP address or Port settings, you need to update the RSM Servers details that are registered with the RSM Web Gateway. 1. Open the RSM Web Client and login using and account with RSM Administrator privileges. 2. Click on RSM Admin to open the RSM Server administration page and view the list of currently configured RSM Servers. 3. Click on the Delete button to remove an RSM Server from the list or click on Modify to change its parameters. Note: If a RSM Server is deleted, users layouts may be affected. You should contact all users to advise them to edit any layouts that contain cameras from the deleted RSM Server. Cameras will be displayed as Camera Missing in the Manage Layouts editor. Note: If a RSM Server is completely uninstalled, then reinstalled and the camera details re-entered, users may find their layouts show different cameras to those expected. Page 23 17 August, 2004

User Administration If you have been assigned the role of "User Administrator" you can: List all RMS Web Client users. Add new users or delete existing users Change the roles of users. View list of users currently logged in. The following sub-sections describe how to perform these tasks. Listing RMS Web Client Users To display a list of the users within the RSM Web Client: 1. Logon to the RSM Web Client. 2. Click on Manage Users in the RSM Web Client menu bar. A list of all users is displayed, as shown below: You may now edit the roles assigned to a selected user or simply delete the user. Page 24 17 August, 2004

Adding Users to the RSM Web Client To display a list of the users within the RSM Web Client: 1. Logon to the RSM Web Client. 2. Click on Manage Users in the RSM Web Client menu bar. A list of all users is displayed, as shown below: 3. Click on the Add User option in the menu bar above the list of All Users to display the Enter new user details window, as shown below: 4. Click in the Username box and enter the username for the new user (must be greater than six characters). 5. Click in the Password box and enter a password for this user which must also be greater than six characters. 6. Click in the Confirm Password box and re-enter the new password. There are four roles that can now be assigned to a user. See Appendix A for a description of these roles. Page 25 17 August, 2004

7. Click on the appropriate check box to assign that role to the selected user each user may be assigned up to four roles, as required. A tick appears in the appropriate check box when a role has been assigned. 8. To de-assign (remove) a role from the selected user, click on the check box of the role. The tick is removed from the check box signifying that this user no longer has this role. 9. Click the Add button to store the details for this user and display the All Users list containing the new user. Editing Roles Assigned to a User 1. Click on the Edit User button for the required user on the All Users display. The Edit User window is displayed for the selected user. In the illustration below the user called, Michael is selected for editing. There are four roles that can be assigned to a user. See Appendix A for a description of these roles. 2. Click on the appropriate check box to assign that role to the selected user each user may be assigned up to four roles, as shown below: A tick appears in the appropriate check box when a role has been assigned. 3. To de-assign (remove) a role from the selected user, click on the check box of the role. The tick is removed from the check box signifying that this user no longer has this role. 4. Click the Save button to store the details for this user. The Delete procedure is also available from the Edit User window. 1. Click on the Delete <Username> button to delete this user. This procedure is identical to the Delete procedure described below. Page 26 17 August, 2004

Deleting a User From the RSM Web Client To display a list of the users within the RSM Web Client: 1. Logon to the RSM Web Client. 2. Click on Manage Users in the RSM Web Client menu bar. A list of all users is displayed, as shown below: 3. Click on the Delete button for the required user on the All Users display. In the illustration above the user called, Johnathan is selected for deletion. A confirmation message is now displayed awaiting your response. 4. Click on the OK button to delete the selected user. The user is deleted with no further confirmation required. Viewing Active Users To display a list of active users who are currently logged on to the RSM Web Client: 1. Logon to the RSM Web Client. 2. Click on the Manage Users option in the RSM Web Client menu bar. A list of all users is displayed, as shown below: Page 27 17 August, 2004

3. Click on the Active Users option in the menu bar above the list of All Users to display the Currently Active Users window, as shown below: 4. Click the List Users option in the menu bar to return to the list of All Users, if required. 5. Click on the Add User option to add other user, is required. Note: If a user closes the browser without logging out, there will some delay in their name being removed from the list of active users. Recovering Forgotten User Passwords If a user forgets the password to their account, you need to: Delete the user s account Create a new account with identical name. This new account will inherit all the settings of the previous account but with the new password that you set. Page 28 17 August, 2004

Increasing Performance and Scalability of RSM Web Gateway The default memory size for RSM Web Gateway on installation is 64 MB. With the default configuration, RSM Web Gateway will support up to 27 concurrent streams (equivalent to 3 clients showing a Three By Three layout, with Proxy streams via RSM Web Gateway). Streams that are not processed via RSM Web Gateway do not count towards in this figure. If a user is showing 2 three-by-three layouts in sequential mode, this counts as 18 streams, not 9 streams If the number of concurrent streams via RSM Web Gateway is predicted to exceed 27 streams, it is strongly recommended to change the default memory configuration of RSM Web Gateway. Allocate another 32 MB to the default of 64 MB for each additional 9 concurrent streams above 27. Number of streams Memory options 27 Streams Default is sufficient. 36 Streams -Xms96m Xmx96m 45 Streams -Xms128m Xmx128m 54 Streams -Xms160m Xmx160m 60 Streams -Xms192m Xmx192m The upper limit varies according to your system setup. To change the memory settings: 1. Click on Start->Programs->Apache Tomcat 5.0->Configure Tomcat 2. Click on the Java VM tab Page 29 17 August, 2004

3. In the Java Options field, add the following to the end, after -Xrs optionally replacing 192 with the value suitable for your installation: -Xms192m Xmx192m 4. Click OK 5. Restart RSM Web Gateway: Start->Programs->Sony->RSM Web Gateway-> Stop RSM Web Gateway then Start->Programs->Sony->RSM Web Gateway-> Start RSM Web Gateway Page 30 17 August, 2004

Chapter 5 Appendix Roles Once you have been authorised to use the RSM Web Client, you are assigned one or more of the following four roles: Standard user PTZ user User administrator RSM Web Client administrator The On-line Help provides help for the Standard User role and the PTZ User role. Whereas, help for the User administrator and the RSM Web Client administrator can be found in the RMS Web Client Administrator s Users Guide (this guide). This guide is available from the Admin Help option in the menu bar of RMS Web Client. Standard User Role If you are assigned a Standard User role you can: View Live Camera Feeds As a standard user you can view live camera feeds and can select any of the available cameras on the RSM Web Gateway. You can also assign a camera to a position on the layout used. These settings are saved between logins. By default, the live feed is obtained directly from the RSM Web Gateway. However, where the RSM Web Gateway is in a private network, the RSM Web Client may obtain the feed via the RSM Web Gateway using a proxy setting. You can also modify the properties of the live feed, such as the update speed, bandwidth and image quality. You can also choose to display the camera name and the local time on the position display. This is true for each position in a layout. Manage and Select Layouts Three layouts are available for live feeds: One by One, a single camera layout. Two by Two layout that provides four positions and a Three by Three which provides nine positions. You can predefine up to eight distinct layouts, with a camera assigned to each position in each layout. Each layout is saved with a unique name. You can also choose to view a single layout, or view a selection of layouts in a defined sequence, with the RMS Web Client automatically switching between layouts after a predetermined number of seconds (Sequential View). Page 31 17 August, 2004

Recording playback If you are assigned the role of User or PTZ User you can select an individual camera and view the available recordings for this camera on a timeline. The date can be selected for inclusion on a position using a calendar. You can scroll forwards and backwards along the timeline and zoom in or out to see more or less detail. Recordings can be made manually or automatically (according to a particular schedule) or when triggered by a motion alarm. These recordings are colour coded according to the way in which they were recorded. You can select a point on a timeline and then click the "Play" button to play the recording for the camera specified at that time. The recording will play and automatically skip to the next available recording if there are gaps in the recording sequence. Pan, Tilt and Zoom (PTZ) User If you are assigned the PTZ role, you can carry out pan, tilt and zoom operations wherever it is supported by the camera. You will also be able to perform the standard user functions. As a PTZ user you can view live camera feeds and can select any of the available cameras. You can also assign a camera to a position on the layout used. These settings are saved between logins. When you are assigned the role PTZ role you can also use the Pan, Tilt and Zoom presets that are available from cameras that support these functions, such as the SNC-RZ30. User Administrator If you have been assigned the role of "User Administrator" you can: List all RMS Web Client users Add new users or delete existing users Change the roles of users. View list of users currently logged in. A description of each of the User Administrator activities and how to use them can be found in the appropriate sections of this guide. RSM Web Client Administrator If you have been assigned the role of RSM Web Client Administrator you can: List all RSM Web Gateways Add or remove RSM Web Gateways Modify configuration parameters A description of each of the RSM Web Client Administrator activities and how to use them can be found in the appropriate sections of this guide. Page 32 17 August, 2004