Sharp Remote Device Manager (SRDM) Server Software Setup Guide

Transcription

1 Sharp Remote Device Manager (SRDM) Server Software Setup Guide This Guide explains how to install the software which is required in order to use Sharp Remote Device Manager (SRDM). SRDM is a web-based software application which is used for running web servers. You can use a PC s web browser to operate the web server in order to provide management functions for digital multifunction printers (MFPs) and printers. CONTENTS INTRODUCTION... 2 SYSTEM REQUIREMENTS... 3 Supported operating systems and browsers... 3 Supported VMware products... 3 Other requirements... 3 SRDM INSTALLATION... 4 Windows Firewall settings... 4 Installing Microsoft.NET Framework 3.5 Service Pack Installing SRDM... 6 STARTING SRDM AND VIEWING THE OPERATION GUIDE... 8 Starting SRDM... 8 Logging in SRDM... 9 SRDM UNINSTALLATION Installing RSP Server Installing RSP Server Registering RSP Client RSP SERVER UNINSTALLATION BACKING UP DATABASES Backing up Databases Restoring Databases Note: The following document also contains information regarding SRDM. Sharp Remote Device Manager Operation Guide (PDF file) This Guide describes the SRDM operating procedure. Log into SRDM and click the Help button in the top-right corner of the window to display the link. Sharp Remote Device Manager Agent Software Setup Guide (PDF file) This explains the procedure for setting up the SRDM agent software. Log into SRDM and click the Help button in the top-right corner of the window to display the link. To display the Operating Guide as a PDF file, you will need Adobe Reader or Acrobat Reader from Adobe Systems Inc. Adobe Reader can be downloaded from the following URL. 1

2 INTRODUCTION Please note The explanations in this Guide assume that the person who will install the product and the users of the product have a working knowledge of Microsoft Windows. For information on the operating system, please refer to your operating system manual or the online Help function. The explanations of screens and procedures in this guide are for Windows Server The screens may vary in other versions of Windows. Screenshots and contents in this manual may be changed. (As of November, 2013) Warranty While every effort has been made to make this document as accurate and helpful as possible, Sharp Corporation makes no warranty of any kind with regard to its content. All information included herein is subject to change without notice. Sharp is not responsible for any loss or damages direct or indirect arising from or related to the use of this document. Copyright Sharp Corporation 2013 All rights reserved. Reproduction, adaptation or translation without prior written permission is prohibited, except as allowed under copyright laws. Trademark acknowledgments Microsoft Windows, Windows Server 2008, Windows Server 2008 R2 and Windows Server 2012 are registered trademarks or trademarks of Microsoft Corporation in the United States and other countries. Chrome browser is registered trademarks or trademarks of Google Inc in the United States and other countries. VMware is registered trademarks or trademarks of VMware, Inc in the United States and other countries. Adobe, the Adobe logo, Acrobat, the Adobe PDF logo, and Reader are registered trademarks or trademarks of Adobe Systems Incorporated in the United States and other countries. All other trademarks and copyrights are the property of their respective owners. SOFTWARE LICENSE The SOFTWARE LICENSE will appear when you install the software. By using all or any portion of the software, you are agreeing to be bound by the terms of the SOFTWARE LICENSE. 2

3 SYSTEM REQUIREMENTS Supported operating systems and browsers Supported Operating Systems Type* 1 Service Pack (SP) 32-Bit Version 64-Bit Version (x64) Supported Browsers Windows Server 2008 SP2 Windows Server 2008 R2 SP1 Windows Server 2012 Google Chrome* 2 Internet Explorer 8.0 Internet Explorer 9.0 Internet Explorer 10.0 *1 SRDM does not support the FAT file system. *2 SRDM has evaluated with Google Chrome 32. Supported VMware products Supported Combination between VMware Products and Operating Systems VMware Products VMware ESX 5.0 OS Type Windows Server 2008 Windows Server 2008 R2 Windows Server 2012 A virtual machine installing SRDM must be connected to network as a network bridge. In addition, please make sure that the virtual machine is available to connect via TCP/IP network from other computer. All problems that cannot recreate on an actual environment are not supported by Sharp if problems happen on virtual environment. Other requirements Supported Operating System Languages* 1 English / Japanese / French / German / Italy / Spanish / Dutch / Swedish / Norwegian / Danish Other hardware requirements* 2 When managing up to 500 devices When managing up to 30,000 devices CPU: Core2 Duo 2.0 GHz or higher Memory: 4GB or more HDD: 40GB or more* 3 CPU: Xeon E5 2 GHz or more x 2 Memory: 7.5 GB or more HDD: 275 GB or more* 3 Required Software Microsoft.NET Framework 3.5 Service Pack 1 *1 English and Japanese are the only languages which are supported as display languages in the program windows. *2 Sufficient resources for SRDM to run stably are required. Hardware requirements will depend on your usage conditions. *3 Guide to the hard disk capacity required if refreshing of data is carried out once a day for half a year. 3

4 SRDM INSTALLATION Windows Firewall settings Windows Firewall settings must be changed to access to the computer on which SRDM is installed from computers that is connected by a TCP/IP network. Configure the settings below to open the related port and allow the protocol. 1. Start MMC (Microsoft Management Console). Click the Windows [Start] button and enter MMC in Start Search. Then, press enter key. If the User Account Control screen appears, click the [Yes] (or [Continue]) button. 2. Click [File] - [Add/Remove Snap-in ], select [Windows Firewall with Advanced Security], and click [Add]. A computer selection screen will open. Select [Local Computer] and click [Finish]. 3. Click the [OK] button. 4. Add a new rule. (1) Open [Windows Firewall with Advanced Security on Local Computer] from the menu on the left side of the screen. (2) Click [Inbound Rules] so that it is selected, and then right-click [Inbound Rules] and select [New Rule ]. (3) Follow the on-screen instructions to add the new rule. Select the settings for the new rule as indicated below. Use the default settings for all other items. For the [Rule Type], select [Port]. For [Protocol and Ports], select [TCP]. Select [Specific local ports] and enter the 8085 Enter any name in [Name]. 5. Repeat step 4 to add a new rule. In this rule, enter 8086 in "Specific local ports". 6. Select [Exit] from the [File] menu. A confirmation screen will appear. Click the [Yes] button and then click the [Save] button to save the console. Installing Microsoft.NET Framework 3.5 Service Pack 1 If Microsoft.NET Framework Service Pack 1 is already installed, check the following. 1. Check that a folder named v3.5 exists in the following location. C (startup drive):\windows\microsoft.net\framework 2. Check that the SP key in the following location is set to 1 or higher. (1) Enter regedit at the command prompt to open Registry Editor. (2) If the User Account Control screen appears, click the [Yes] (or [Continue]) button. (3) Select the registry key: HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\NET Framework Setup\NDP\v3.5 (4) Check that the SP key in the side panel on the right side is 1 or higher. 4

5 If Microsoft.NET Framework 3.5 Service Pack 1 is not installed, install it by following the procedure given below. Installation on Windows Server 2008 Download from the Microsoft home page, and then install. Installation on Windows Server 2008 R2 Enable Microsoft.NET Framework 3.5 Service Pack 1 by following the procedure given below. 1. Click the Windows [Start] button, and then click [Control Panel]. 2. Double-click [Programs and Features]. 3. Click [Turn Windows features on or off]. If the [User Account Control] window appears, click the [Yes] (or [Continue]) button. 4. [Windows Features] dialog will open. Open [Microsoft.NET Framework 3.5.x] and select all the items. (Add check marks.) Select [Windows Communication Foundation HTTP Activation] and [Windows Communication Foundation Non-HTTP Activation]. 5. Click [OK]. Installation on Windows Server 2012 Microsoft.NET Framework 3.5 Service Pack 1 is already pre-installed. Enable Microsoft.NET Framework 3.5 Service Pack 1 by the procedure given below. 1. On the desktop, hover the mouse cursor in the upper right corner of the screen, and click [Settings]. Then, click [Control Panel]. 2. Click [Programs and Features]. 3. Click [Turn Windows features on or off]. If the [User Account Control] window appears, click the [Yes] (or [Continue]) button. 4. Click [Add roles and features] option. 5. Click the [Next] button on the [Installation Type] screen, the [Server Selection] screen, and the [Server Roles] screen with default options. 6. On the [Features] screen, open [.NET Framework 3.5 (includes.net 2.0 and 3.0)] and select all items (add check marks). Select [.NET Framework 3.5 (includes.net 2.0 and 3.0)], [HTTP Activation] and [Non-HTTP Activation]. 7. Click the [Next] button on the [Web Server Roles (IIS)] screen and the [Role Services] screen with default options. 8. Click [Install]. After installing Microsoft.NET Framework 3.5 Service Pack 1, run Windows Update to update Windows to the latest version. 5

6 Installing SRDM 1. Obtain the SRDM installation zip file, extract it to your computer Before extracting zip file, open properties for the zip file and check if they are unblocked by Windows Security. If it is blocked, click [Unblock] button. If the installation folder name has a multi byte character, SRDM cannot work properly. Extract SRDM to the folder that has not a multi byte character such as following: C (startup drive):\srdm\ 2. Execute [ipaucontrolpanel.cmd] in the extracted folder Administrator privileges are required to install SRDM. Software license agreement will appear. Click [I Agree] button if you agree with the terms. 3. Launch SRDM ([Portable Deployment Mode] or [Permanent Deployment Mode]) [Portable Deployment Mode] allows you to launch SRDM as stand-alone mode. It is not installed as Windows service. This installation type is suitable to the user who has a possibility to stop SRDM service frequently. Select this installation type when the SRDM data is not on the drive installed Windows OS, such as portable HDD or USB flash memory. [Permanent Deployment Mode] allows you to launch SRDM as Windows service. This installation type is suitable to users who want to launch SRDM automatically at the same time as booting up Windows. Launching as [Portable Deployment Mode] 1. Check the check box (9) if HTTPS communication is required. 2. Enter the server IP address in which SRDM is installed in field (10). 3. Click button (1). When the preparations for providing the SRDM service are complete, button (1) will become disabled, and button (2) will be enabled. (1) (2) (3) (4) (5) (7) (6) (8) (9) (10) (11) 6

7 Launching as [Permanent Deployment Mode] 1. Check the check box (9) if HTTPS communication is required. 2. Enter the server IP address in which provide SRDM service in field (10). 3. Click button (3). Button (3) will become disabled and button (4) will be enabled. When this happens, registration of SRDM as a Windows service is complete. 4. Select the startup type (Automatic, Manual or Disabled) in the combo box (5), and then click button (6). 5. Click button (8). Once the Service Status (7) changes to [Start], SRDM service preparation will be complete. If the Service Status is not reflected properly on the Control Panel, click (11) button to refresh the status. 7

8 STARTING SRDM AND VIEWING THE OPERATION GUIDE Starting SRDM Starting on the computer (server) on which SRDM is installed Starting from [ipaucontrolpanel.cmd] Click Open button to start SRDM. A Web browser that is set as default is launched and SRDM is displayed. Starting from a browser Enter the following address in the address bar on a Web browser. HTTP connection (Default settings): HTTPS connection (Default settings): Starting from a computer at a remote location SRDM can be accessed using a Web browser from any computer that is connected by a TCP/IP network to the computer on which SRDM is installed. Start the computer's Web browser and enter the URL of SRDM on the address bar. HTTP connection (Default settings): HTTPS connection (Default settings): Enter the IP address or host name of the computer on which SRDM is installed in "xxxxxx". Set a browser so that JavaScript is not blocked. Cookies must be enabled for a browser on a client computer to run properly. SRDM uses session variables and cookie files to store session data and user settings. 8

9 Logging in SRDM Logging in SRDM 1. Input Login ID, User Name and Password in (1) and (2) Default Login ID and Password are as follows: Login ID: 0 User Name: None (Blank field) Password: Admin000 If you want to reset input items, click (4) button. 2. Click (3) button to log in (1) (2) (3) (4) 9

10 SRDM UNINSTALLATION Stopping Portable Deployment Mode service 1. Click button (2). SRDM will be stopped. When SRDM is stopped, button (2) will become disabled, and button (1) will be enabled. 2. Click button (7) to close SRDM Service Control Panel. 3. Delete folder. Delete all folder and files which are extracted when installing. (1) (3) (4) (2) Stopping Permanent Deployment Mode service 1. Click button (6). SRDM will be stopped. When SRDM is stopped, (5) will become Stop. 2. Click button (4). Button (4) will become disabled and button (3) will be enabled. When this happens, registration of SRDM as a Windows service is canceled. 3. Click button (7) to close SRDM Service Control Panel. 4. Delete folder. Delete all folder and files which are extracted when installing. (5) (6) (7) 10

11 INSTALLING RSP SERVER The remote service protocol (RSP) is dedicated tunneling software for the SRDM to carry out communication that passes through the firewall. For standard intranets, firewall settings are used to configure the network so that access from outside the intranet is blocked. By utilizing RSP, management of devices which are set up within the intranet can be carried out from the SRDM via the Internet, without changing the settings for the firewall which protects the intranet. RSP consists of an RSP server and RSP clients. The RSP server must be installed on the same hardware as the SRDM server. The RSP clients must be installed on PC in an intranet. This Setup Guide describes the installation method for the RSP server. For details on installing the RSP clients, refer to the Agent Software Setup Guide. RSP is useful at times such as when you have SRDM installed on a server which is accessible via the Internet in order to manage devices which have been set up in several different locations. If not using an SRDM on the Internet to carry out management of devices within the intranet from outside the intranet s firewall, it is not necessary to install the RSP server. English is the only language which is supported as display languages for RSP Installing RSP Server 1. Open ports in Windows Firewall Open the following ports to communicate with Agent through Firewall via RSP tunnel (For the process, see Windows Firewall settings.) Port Number Port Type Use 8443 TCP port for receiving For receiving packets via RSP tunnel TCP port for receiving For Payload 2. Execute RSPServer.msi and ConnectionManager.msi RSPServer.msi and ConnectionManager.msi are in the following folder: SRDM Installation Folder \RSPInstaller\ Administrator privileges are required to install. Tunnel port number is required when [RSP Server.msi] is executed. Enter NET Framework 3.5 SP1 is required. See Installing Microsoft.NET Framework 3.5 Service Pack 1 RSP Connection Manager icon is created on the desktop in the PC. 3. Execute RSP Connection Manager Administrator privileges are required. 4. Click [Settings] button to change the ports RSP Modify Settings is opened. Enter the following settings. If the settings are changed, RSP Connection Manager is automatically rebooted. Items Value Http Proxy Ports Http Proxy Host IP address for the PC where the RSP server is installed Whitelist is enabled Enable (Check the check box) Tunnel Port 8443 Tunnel Host SSL Certificate localhost UID Api Port Api Host UID Certificate RSPUIDCert 11

12 5. Click [Anonymous Whitelist] tab at the bottom of RSP Explorer 6. Right-click on the list and click [Add ] 7. Enter the following values and click [OK] button Host IP address for the PC where the RSP server is installed 1 Port number for providing SRDM Web UI (HTTP) Port Default: 8085 Host IP address for the PC where the RSP server is installed 2 Port number for providing SRDM Web UI (HTTPS) Port Default: Click [Exit] from the [File] menu. 9. Open SRDM and Login with Login ID: 0 For a password, see the Logging in SRDM 10. Click [Settings] button and click System Settings 12

13 11. Enter the following values and click [OK] button RSP Server IP Address IP address for the PC where the RSP server is installed RSP Server Port RSP Server Name Enter IP address for the PC where the RSP server is installed and ;gateway1 RSP server installation has completed. 13

14 Registering RSP Client 1. Execute RSP Connection Manager Administrator privileges are required. 2. Click [Add Account] button to enter Remote Name, Local Name and One Time Password Enter the following settings and click [OK] button. Items Remote Name Local Name One Time Password Value <Client IP Address>;gateway1 <Server IP Address>;gateway1 Enter a password for RSP Authentication RSP Client registration has completed. The value that input as One Time Password is required when RSP client installation. For the RSP client installation, see Agent Software Setup Guide. 14

15 RSP SERVER UNINSTALLATION 1. Click the Windows [Start] button and then click [Control Panel]. 2. Double-click [Programs and Features]. 3. Select [RSP Server] and uninstall it. 4. Select [RSP Connection Manager] and uninstall it. RSP server uninstallation has completed. After uninstalling RSP server, restart your computer. 15

16 BACKING UP DATABASES Backing up Databases 1. Stop SRDM service For details on stopping SRDM, see the SRDM UNINSTALLATION. 2. Copy the following folders and files to backup media. These folders and files are in a folder in which SRDM is installed. No. Folder name / File name 1 \basex\data 2 \tomcat\webapps\deviceimage 3 \ControlPanel\_settings 4 Restoring Databases \tomcat\webapps\srdmcloudscheduleservice\web-inf\classes\processing-system-to-removeconfig.properties 1. Stop SRDM service For details on stopping SRDM, see the SRDM UNINSTALLATION. 2. Restore the backed up data to the following folders in SRDM installed folder: No. Folder name / File name 1 \basex\data 2 \tomcat\webapps\deviceimage 3 \ControlPanel\_settings \tomcat\webapps\srdmcloudscheduleservice\web-inf\classes\processing-system-to-removeconfig.properties 4 16

17 EN_Rev.13