0% found this document useful (0 votes)
6 views36 pages

Server SetupGuide

The Sharp Remote Device Manager (SRDM) Server Software Setup Guide provides detailed instructions for installing and configuring SRDM, a web-based application for managing digital multifunction machines and printers. It includes system requirements, installation steps, and basic operations, as well as troubleshooting and database management. The guide emphasizes the need for administrator privileges and proper firewall settings for successful installation and operation.

Uploaded by

goldin1936
Copyright
© All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
0% found this document useful (0 votes)
6 views36 pages

Server SetupGuide

The Sharp Remote Device Manager (SRDM) Server Software Setup Guide provides detailed instructions for installing and configuring SRDM, a web-based application for managing digital multifunction machines and printers. It includes system requirements, installation steps, and basic operations, as well as troubleshooting and database management. The guide emphasizes the need for administrator privileges and proper firewall settings for successful installation and operation.

Uploaded by

goldin1936
Copyright
© All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd

Sharp Remote Device Manager (SRDM)

Server Software Setup Guide


This guide explains how to setup Sharp Remote Device Manager (referred to as "SRDM" in this guide) Software.
SRDM is a web-based software application that runs on a web server. After installing SRDM, you can use your
computer's web browser to operate and use the SRDM functions that are provided for the management of digital
multifunction machines (MFPs) and printers.

NOTE:
The following document describes about various features provided by SRDM and their operating procedure.
● Sharp Remote Device Manager Operation Guide (PDF format)
Log in to SRDM and click the "Help" button on the top-right corner of the window to view the
document.

Note:
To display the Operating Guide as a PDF file, you will need Acrobat® or Acrobat® Reader from Adobe
Acrobat® Reader can be downloaded from the following URL.
[Link]
Contents
1 INTRODUCTION ..........................................................................................................................................................3
1.1 Please Note .................................................................................................................................................................. 3
1.2 Warranty........................................................................................................................................................................ 3
1.3 Trademark Acknowledgments............................................................................................................................... 3
1.4 End User License Agreement ................................................................................................................................. 3
2 SYSTEM REQUIREMENTS ......................................................................................................................................... 4

3 SRDM INSTALLATION ................................................................................................................................................6


3.1 Windows Firewall Settings ...................................................................................................................................... 6
3.2 SRDM INSTALLATION .............................................................................................................................................. 7
3.3 SRDM Startup Configuration ................................................................................................................................. 9
4 OPENING SRDM .........................................................................................................................................................11
4.1 Opening SRDM from a computer where the SRDM server is installed ................................................. 11
4.2 Opening SRDM from a computer at a remote location ............................................................................. 12
4.3 Logging into SRDM ................................................................................................................................................. 12
5 SETTING DISPLAY LANGUAGE AND TIME ZONE .................................................................................................... 14

6 BASIC SRDM OPERATIONS..................................................................................................................................... 16


6.1 Basic Setup Tasks ..................................................................................................................................................... 16
6.2 Searching for Devices ............................................................................................................................................. 16
7 UNINSTALLING SRDM ............................................................................................................................................. 18
7.1 Stopping the Service ............................................................................................................................................... 18
7.2 Deleting the SRDM Installation Folder ............................................................................................................. 19
8 UPDATING SRDM ..................................................................................................................................................... 20
8.1 SRDM DB version up tool ..................................................................................................................................... 21
9 DATABASE OPTIMIZATION ................................................................................................................................... 26

10 BACKING UP/RESTORING DATABASES .............................................................................................................. 28


10.1 Backing Up Databases............................................................................................................................................28
10.2 Restoring Databases ...............................................................................................................................................29
11 TROUBLESHOOTING ............................................................................................................................................... 30

12 APPENDIX................................................................................................................................................................... 32
12.1 Procedure for configuring SSL certificates with SRDM ...............................................................................32

Server Software Setup Guide


1
INTRODUCTION
1.1 Please Note
• The explanations in this Setup Guide assume that the person who will install the product and the users
of the product have a working knowledge of Microsoft Windows and the Internet.
• For information on the operating system, please refer to your operating system manual or the online
Help function.
• This Setup Guide explains screens and procedures under Windows Server® 2016. The screens may vary
in other versions of Windows and/or web browsers to be used.
• The screenshots used in this Setup Guide appear in the default "Graphite" display theme.
• The screenshots and contents used in this Setup Guide may change for improvement without notice.
(The current information is as of April 2024.)
• Digital multifunction machines and printers manufactured by Sharp or other manufacturers, as well as
displays manufactured by Sharp, are referred to as "devices".
• To obtain device data in certain intervals, set a scheduled action. For more information refer to "Setting
scheduled actions" available in the Operation Guide.

1.2 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 Setup Guide.
© 2014 SHARP CORPORATION
Reproduction, adaptation or translation without prior written permission is prohibited, except as allowed under
copyright laws.

1.3 Trademark Acknowledgments


• Microsoft® Windows®, Windows Server® 2016, Windows Server® 2019, Windows Server® 2022, Visual
C++® and Active Directory® are registered trademarks of Microsoft Corporation in the United States and
other countries.
• ChromeTM browser is registered trademark or trademark of Google LLC in the United States and other
countries.
• VMware is a registered trademark of VMware Inc. in the United States and other countries.
• Adobe, the Adobe logo, Acrobat, the Acrobat PDF logo, and Adobe Reader are registered trademarks
of Adobe in the United States and other countries.
• All other trademarks and copyrights are the property of their respective owners.

1.4 End User License Agreement


The END USER LICENSE AGREEMENT 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 END USER LICENSE AGREEMENT.

Server Software Setup Guide Page 3


2
SYSTEM REQUIREMENTS
Supported Operating Systems
SRDM 2.18 supports the following 64-bit operating systems.

• Windows Server 2016


• Windows Server 2019
• Windows Server 2022

SRDM does not support the FAT file system.

Note:
Be sure to run Windows Update regularly in order to maintain your operating system at the latest
version.

Supported Browsers
• Google Chrome
• Microsoft Edge (Chromium version)

Note:
SRDM does not support the display magnification function of web browsers. Use with the display ratio
set to 100%.

Supported VMware Products


Supported Combination between VMware Products and Operating Systems
VMware Products OS Type
Windows Server 2016
VMware ESXi 7.0 Windows Server 2019
Windows Server 2022

Note:
• The virtual machine, in which SRDM is being installed, should be connected to a network as a
network bridge.
• In addition, please make sure that the virtual machine is connected via TCP/IP network from
other computer.
• Sharp Corporation does not provide support for any issues in case they are only observed in the
virtual environment and cannot be reproduced in the actual environment.

Server Software Setup Guide Page 4


SYSTEM REQUIREMENTS

Supported Operating System Languages*1


English / Japanese / French / German / Italian / Spanish / Dutch / Swedish / Norwegian / Danish

Recommended Hardware Requirements*2


• CPU: Core i7-3770 3.4 GHz, 4 Cores / 8 Threads or higher
• Memory: 8GB or more
• HDD: 80GB or more*3 *4

*1: Only English and Japanese are supported as display languages on software operation screens.
*2: The recommended hardware requirements are provided with the assumption that the number of devices
being managed is 500 or fewer. The server must have sufficient resources for SRDM to run in a stable
behavior. Hardware requirements vary with the operating environment. If managing more than 500 devices,
more system resources will be necessary.
*3: This figure is a guide in cases where "Schedule Log Delete" is set to "Off", or if it is set to a period of more
than six months and the status update operation for 500 devices is done once in a day for a period of six
months. More hard disk space than this may be required during actual operation.
*4: If the amount of free hard disk space is less than 12GB, then a warning message will be displayed when you
log into SRDM to notify you that the amount of free space is low. When the free space drops below 6GB,
the SRDM service will be stopped.

Server Software Setup Guide Page 5


3
SRDM INSTALLATION
3.1 Windows Firewall Settings
The Windows Firewall settings of the computer on which SRDM is installed must be updated, so that the SRDM
can communicate with other devices and computers which all are connected via TCP/IP network.
Configure the settings below to open the related port and allow the protocol.

1. On the desktop screen of a computer in which SRDM is to be installed, press the Windows key and the
"R" key at the same time.
2. The Run dialog box will open, so enter "MMC" and then click the [OK] button. The Microsoft
Management Console will open.
3. 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].
4. Click the [OK] button.
5. 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], and click [Next] button
• For [Protocol and Ports], select [TCP]. Select [Specific Local Ports] and enter "8086". Then click the [Next]
button.
• After selecting connection settings, and rule application option, enter any name in [Name] to complete
the settings.

Note:
Port numbers specified in the inbound rules must be same as the port numbers specified in the SRDM
control panel.

Server Software Setup Guide Page 6


SRDM INSTALLATION
3.2 SRDM INSTALLATION

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.

3.2 SRDM INSTALLATION


You will need to have administrator privileges to install SRDM on the server machine. In case you are updating
from a previous version, refer to "UPDATING SRDM".

1. Double-click the SRDM executable file [[Link]], which has been copied to the computer,
to run the installer.
• Ensure you have the administrator rights
• The User Account Control Dialog Box will be displayed. After reviewing its contents, click the [Next (N)>]
button to continue.
• The root folder in the drive (e.g.: C:\) or network shared folder (e.g.: \\computer name or IP
address\shared name) cannot be specified as the installation destination folder.

2. Install the software by following the instructions provided by the setup wizard.
3. Once the setup is finished, a dialog box will be displayed informing you that installation is completed.
Click the [Finish] button to launch the SRDM control panel.

Server Software Setup Guide Page 7


SRDM INSTALLATION
3.2 SRDM INSTALLATION

Once the [Finish] button is clicked, the "END USER LICENSE AGREEMENT" will be displayed as follows.

After reviewing its terms, click the [I agree] button to accept them.
If you click the [Disagree] button, the "END USER LICENSE AGREEMENT" screen will be closed and SRDM
application launch will be canceled.
This "END USER LICENSE AGREEMENT" screen will be displayed until the user agrees to the agreement.
If you click the [I agree] button, the license terms will be accepted and SRDM will be launched.
After agreeing to the license agreement, a dialog box will be displayed with a message asking whether you wish
to launch the DB version up tool.

If you wish to continue using data from older versions, click the [Yes] button. Refer to "UPDATING SRDM" for
more information on how to continue using data from an older version of SRDM.

Note:
During the installation of this software, the following warning may be displayed:
"Windows protected your PC. Windows Smart Screen prevented an unrecognized app from starting.
Running this app might put your PC at risk."
If this warning is displayed, click [Details] and then [Run] to continue with the installation.

Server Software Setup Guide Page 8


SRDM INSTALLATION
3.3 SRDM Startup Configuration

3.3 SRDM Startup Configuration


To use SRDM, configure essential settings on the SRDM control panel, and start the service.
When the service starts, it is registered as a service and can be automatically started next time when Windows
starts.

Note:
• The SRDM control panel is automatically displayed after installation.
• To display the SRDM control panel, select “Run as administrator...” from the menu displayed by
right-clicking the icon of the following file in the SRDM installed folder.
«SRDM Install Folder»\SRDM\[Link]

1. Change the SRDM distinguished name (1) as needed. This


(1) distinguished name is displayed on the name of the
Windows service registered to the operating system, and
(2)
the title bar of this dialog box.
2. Enter the IP address of the server which provides SRDM
(3) service in field (2). Enter the IP address directly, or select
from the pulldown list.
(4) 3. Click the Embedded database [Start Service] button (3) to
(5) (6) start the service. Status of service starting is displayed on
the log display area (7). Once the service is started, the
SRDM [Start Service] button (5) will be enabled.
(7) 4. Change the HTTPS port number (4) as needed, and click
the SRDM [Start Service] button (5). Status of service
starting is displayed on the log display area (7). Once the
service is started, the SRDM [Stop Service] button (6) will
be enabled.

Server Software Setup Guide Page 9


SRDM INSTALLATION
3.3 SRDM Startup Configuration

By using “Portable deployment“, SRDM can be launched as an application. SRDM will not be installed as a
Windows service. If SRDM is launched in this mode, the program closes when the SRDM server stops, and SRDM
needs to be launched again after rebooting the server.
You can use “Portable deployment“ by the following steps.

(1) 1. Change the SRDM distinguished name (2) as needed. The


(2) name is displayed on the title bar of this dialog box.
2. Enter the IP address of the server which provides SRDM
(4) (3)
service in field (3). Enter the IP address directly, or select
from the pulldown list.
3. Select [Portable deployment] (4) from the [System] menu
(1) to display the [Portable deployment] dialog box.
4. Click the [DB startup] button (5), and wait until the
database is launched. Once the database is launched, the
[Start Service] button (6) will be enabled.
5. Click the [Start SRDM] button (6), and wait until SRDM is
launched.
6. Click the [Close] button (7) to close the [Portable
deployment] dialog box.

(5)
(6)
(7)

Note:
In the case the Microsoft Visual C++ run-time components have not been installed on your
computer at the time of SRDM service startup or service registration, the dialog box for the
installation of the Microsoft Visual C++ Redistributable Packages appears. Follow the instructions in
the dialog box to install the packages. If the installation of the packages fails, SRDM service will not
start up.

Server Software Setup Guide Page 10


4
OPENING SRDM
4.1 Opening SRDM from a computer where the SRDM server is
installed
Opening SRDM from the SRDM control
panel
Click the Login URL to start SRDM. The browser
which is default for that user will be opened and
SRDM will be displayed.

Opening SRDM from a browser


Enter the following address in the address bar on a
web browser.
In case of the default setting:
[Link] address>>:8086/WebUI/

In place of "<<Service address>>", enter the IP


address which has been set as the service address in
the SRDM Control Panel or the host name.

Server Software Setup Guide Page 11


OPENING SRDM
4.2 Opening SRDM from a computer at a remote location

4.2 Opening SRDM 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.
Launch the web browser in the computer and enter the URL for SRDM in the address bar.

• Default setting: [Link]

Note:
• Make sure that JavaScript is enabled in your Web browser settings.
• Cookies must be enabled for the browser on a client computer to run properly. SRDM uses
session variables and cookie files to store session data and user settings.

4.3 Logging into SRDM

1. Confirm the login ID and initial password.


• Select [Administrator Password] from the
SRDM control panel [System] menu.
• You can check the initial password in the
[Administrator Password] dialog box. It is
recommended that you change the initial
password after logging in for the first time.
• Generating a new password
You can generate a new initial password by
clicking [Initialize Password]. If the service is
running, refer to "Stopping the service" and
stop the service. The [Initialize Password]
button will be enabled.

Note:
• An initial password will be generated when SRDM is started for the first time.
• You will need to stop the SRDM service to generate a new password.
• Once the password is changed, this initial password does not work.

Server Software Setup Guide Page 12


OPENING SRDM
4.3 Logging into SRDM

2. At the login screen, enter the user name (1) and password (2) as described below.
The default settings are as follows.
User Name: admin
Password: the default administrator password which was confirmed in the previous step.

If you want to reset the entries, click the [Reset] button (4).

3. Click the Login (3) button to log in.

(1)

(2)

(3) (4)

The login page will be displayed in English when you log in for the first time.

Note:
Warning messages and errors during login:
If the amount of free hard disk space is less than 12GB, then the following warning message will be
displayed:
"Warning: SRDM server is running with low disk space. Please contact Administrator, or refer Server
Setup Guide.", When the free space on the hard disk drops below 6GB, the SRDM service will be
stopped and the following error will be displayed: "Service is not available (E0046). Please contact
Administrator, or refer to Server Setup Guide.", and you will no longer be able to log in. If this
happens, carry out the steps below to increase the amount of free space on the hard disk to 6GB or
more.
◦ Delete unnecessary files on the hard disk.
◦ Execute database optimization. For more information, refer to "DATABASE OPTIMIZATION".
◦ Delete old SRDM log files. With SRDM, the schedule log delete setting allows you to automatically
delete logs. The schedule log delete setting allows you to keep logs for a maximum of 12 months,
and in addition, you can set the shortest period for keeping logs to only the latest log entry. Even
if you use the "Latest one log" setting, operation log data will be kept for a minimum of one
month, but only the latest log entry will be available for other logs such as device logs. Note that,
as long as the [Schedule Log Delete] is selected, the counter log data is always kept for 14 months
regardless of the value set for the period during which the log is set to remain. For more
information about settings for scheduled log deletion, refer to "Basic Window Configuration" in
the Operation Guide.

Server Software Setup Guide Page 13


5
SETTING DISPLAY LANGUAGE AND TIME ZONE
You can configure the SRDM UI display language and time zone for administrator users according to the
location where the software is being used.
The display language and time zone settings can be configured individually for each login account. An
administrator user can configure these settings immediately after logging in for the first time by the following
procedure.
For details on basic SRDM operations, refer to "Basic Window Configuration" in the Operation Guide.

1. Click [Settings] and select [Properties].

2. Select the display language from the [Language Setting] list.

3. Select the format for the date and time from the [Date and Time Format] list.

Server Software Setup Guide Page 14


SETTING DISPLAY LANGUAGE AND TIME ZONE

4. Click the [Change Time Zone] button, and then either select the appropriate time zone from the
[Specify Time Zone] list or select "Auto". (Default setting : Auto)

5. Click the [OK] button.


6. If the language setting is changed, a confirmation dialog box will be displayed. Click [Yes] to close the
dialog box.

Note:
If you select "Auto" as the time zone setting, the setting used will be the time zone setting for the web
browser which is being used to access SRDM. Furthermore, the time zone which is selected by means
of the time zone setting in the Properties will not affect the schedule settings.

Server Software Setup Guide Page 15


6
BASIC SRDM OPERATIONS
The following section provides an overview of the basic tasks that must be performed in order to manage digital
multifunction machines and printers after installing SRDM. The following information should be prepared before
starting this process:

• List of MFPs and printers to be managed.


• List of required management groups.
• E-mail account information used for e-mail notifications (when necessary).

For details on basic SRDM operations including display devices management, refer to "Basic SRDM Operations"
in the Operation Guide.

6.1 Basic Setup Tasks


The first operations that must be performed in order to start managing devices after installing SRDM are
discovering and registering the devices.
As part of installation, SRDM performs local broadcast discovery and automatically registers the discovered
devices so that they can be managed.
To manage the devices which are not discovered as part of initial discovery, you can perform discovery and
registration operations manually.

Note:
SRDM also carries out local broadcast discovery and registers the discovered devices automatically
when the service is started.

6.2 Searching for Devices

You can discover network connected devices by following


any of the procedures given below.
Search using the [Menu] button " " in a group tab.

1. Click the [Menu] button " " in a group tab.


2. Click on [Discovery (Includes Sub Groups)] option.

While device discovery is in progress, the " " icon will


be displayed.

Server Software Setup Guide Page 16


BASIC SRDM OPERATIONS
6.2 Searching for Devices

Since "Register Device(s) Automatically" is enabled in the default setting, devices that have been searched for
will be automatically registered, and displayed in the [Registered Devices] tab.

Device discovery can also be performed by clicking the " " button.
The default device discovery settings cover only local broadcast searches.
You can also discover the devices using the [Discover] button in the [Device Discovery] tab. For detailed
information, refer to the Operation Guide.

Server Software Setup Guide Page 17


7
UNINSTALLING SRDM
To uninstall SRDM, stop the service and delete the folder in which SRDM is installed, according to the following
steps.

7.1 Stopping the Service

1. Click the [Stop Service] button (3) of SRDM.


Status transition to stop the service is
displayed on the log display area (4).
When the service is stopped, the Embedded
(1) (2) database [Stop Service] button (2) is enabled.
Once the service is stopped, registration as a
Windows service will be canceled as well.
(3) 2. Click the [Stop Service] button (2) of the
Embedded database. Status transition to stop
(4)
the service is displayed on the log display area
(4). When the service is stopped, the
Embedded database [Start Service] button (1)
is enabled.
Once the service is stopped, registration as a
Windows service will be canceled as well.
3. Click the [Close] button (5) to close the SRDM
control panel.
(5)
If SRDM is launched from “Portable deployment“,
display the [Portable deployment] dialog box from
the menu.

1. Click the [SRDM termination] button (8). Once


SRDM is terminated, the [DB termination]
button (7) becomes active.
2. Click the [DB termination] button (7). Once DB
(6) (7)
is terminated, the [DB startup] button (6)
(8) becomes active.
3. Click the [Close] button (9) to close the
(9)
[Portable deployment] dialog box.
4. Click the [Close] button (5) to close the SRDM
control panel.

Server Software Setup Guide Page 18


UNINSTALLING SRDM
7.2 Deleting the SRDM Installation Folder

7.2 Deleting the SRDM Installation Folder


Delete all SRDM folders created during installation.

Server Software Setup Guide Page 19


8
UPDATING SRDM
When updating SRDM from an older version, the DB version up tool allows to migrate the data from the older
version to the new version. For details, refer to “SRDM DB version up tool”.

Note
In the event of update failures, it is recommended to backup the databases in advance to avoid any
losses. For how to backup the databases, refer to "Backing Up Databases".

Usage of the DB version up tool depends on the procedure followed for updating SRDM.

Stop the running SRDM service.


1. Select “Run as administrator...” from the menu, which is
displayed by right-clicking the icon of the following file
in the SRDM installed folder, to display the SRDM
control panel. (1) (2)
«SRDM Install Folder»\SRDM\[Link]

2. Stop the service.


(3)
A) Click the [Stop Service] button (3) of SRDM. Status
transition to stop the service is displayed on the
log display area (4). (4)
When the service is stopped, the Embedded
Database [Stop Service] button (2) is enabled.
Once the service is stopped, registration as a
Windows service will be canceled as well.
B) Click the [Stop Service] button (2) of the
Embedded database. Status transition to stop the
service is displayed on the log display area (4).
When the service is stopped, the Embedded
Database [Start Service] button (1) is enabled. (5)
Once the service is stopped, registration as a
Windows service will be canceled as well.

If SRDM is launched from “Portable deployment“, display the [Potable deployment] dialog box from
the menu.
A) Click the [SRDM termination] button (8). Once SRDM is closed, the [DB termination] (7) button
becomes active.
B) Click the [DB termination] button (7). Once DB is (7)
(6)
closed, the [DB startup] button (6) becomes active.
(8)
C) Click the [Close] button (9) to close the [Portable
deployment] dialog box.
(9)

3. Click the [Close] button (5) to close the SRDM control panel.

Server Software Setup Guide Page 20


UPDATING SRDM
8.1 SRDM DB version up tool

Install the software by following the instructions provided by the installer's setup wizard.
For more information about how to install the software, refer to "SRDM INSTALLATION".

The SRDM DB version up tool will be launched automatically.


For details, refer to "SRDM DB version up tool".

8.1 SRDM DB version up tool


If you are currently using an older version of SRDM, you can inherit some data by using the SRDM DB version
up tool. When the SRDM DB version up tool is launched, a dialog box will be displayed asking whether you wish
to migrate the old data. If you wish to continue using data, click the [Yes] button.

Note:
Note the following when using the SRDM DB version up tool:
◦ Supported versions (pre-update) for upgrade: SRDM 2.16 series / SRDM 2.17 series
◦ The folder hierarchical structure and the contained files of the source SRDM have not been
changed with an unauthorized operation. This folder means the folder you specified when you
installed SRDM. (Default setting : C:\SRDM)
◦ Both copies of SRDM (the version being updated and the new version) must be stopped.
◦ A roll back cannot be performed if an error occurs when copying or updating the DB for any
reason. Hence it is recommended to back up the DB file before carrying out the update.
◦ If you are using a version which is older than the SRDM 2.16 series and you need to continue
using existing data, first update the version to SRDM 2.16, and then update to SRDM 2.18.
◦ In case that the Microsoft Visual C++ run-time components has not been installed on your
computer, the SRDM installer will also install the Microsoft Visual C++ Redistributable Packages.
If you cancel the installation of the Microsoft Visual C++ Redistributable Packages, the SRDM
installation will be also canceled.
◦ The schedule settings for searching devices and updating device information have been changed
since SRDM 2.9. The settings may not be taken over depending on the original version, if you
have set the scheduled action, check the setting contents after updating.

Server Software Setup Guide Page 21


UPDATING SRDM
8.1 SRDM DB version up tool

Execution procedure
When launching the tool manually, run [«SRDM Install Folder»\SRDM\Svr\DBUtility\Versionup\[Link]]
which is available in the folder of SRDM which is the newer version. Run it from the command prompt without
specifying any arguments.

When you click the [Yes] button, the SRDM DB version up tool dialog box is launched.
You can update SRDM by selecting either the "Select from the list" or "Specify the folder" option displayed in
the dialog box.

Select from the list


1. Select the version of SRDM which needs to be updated in the displayed dialog box as shown below.
This dialog list the available SRDM installations on the target PC.

2. Click the [Run] button.


3. A dialog box will be displayed informing you that the DB update is being processed.
4. A dialog box will be displayed asking you to confirm that the update is completed.

Server Software Setup Guide Page 22


UPDATING SRDM
8.1 SRDM DB version up tool

Specify the folder


1. You can click the [Browse] button to select the folder containing the copy of SRDM which needs to be
updated.

2. After selecting the SRDM folder, click the [Run] button.


3. A dialog box will be displayed informing you that the DB update is being processed.
4. A dialog box will be displayed informing you that the update is completed successfully.

If an error code is not displayed, it means that the update is successful. If the update fails, an error code will be
displayed. For details on error codes, refer to "When an error occurs".

Note:
• SRDM cannot be used while the database is being updated.
• Update process takes time normally. However, it is not recommended to stop the process during
the update.
If the update process is interrupted, refer to "Restarting the interrupted tool execution".

DB after the completion of tool execution


Once the update is completed, the DB for the new version of SRDM"s environment will be added separately
from the data folder as a new "data" folder under "«SRDM Install Folder»\SRDM\Svr\DBService".
The old "data" folder contains a backup of DB before tool execution.

When an error occurs


When an error occurs during execution of the update, the error code below will be displayed.
Exxxx-y
xxxx is a 4 digits number.
y is either 1 or 2.
For details on the codes which are output, refer to "Error code and resolution method".

Server Software Setup Guide Page 23


UPDATING SRDM
8.1 SRDM DB version up tool

Error code and resolution method


The error codes which can be displayed during execution of an update and their resolution methods are
described below.

Error code Resolution method


E0001 • Specify the path to the copy of SRDM being updated.
E0002 • Check whether the input path is correct.
• Check whether the input path points to the old version of SRDM.
E0100 • Stop the corresponding SRDM.
• When the corresponding SRDM is accessible even when it is stopped, there is a
possibility that another application is running. Please identify and end the application.
E0101 • Check whether the folder configuration of corresponding SRDM is correct.
• This error code is displayed when the "[Link]" file cannot be found in
the copy of SRDM being updated or the newly updated copy of SRDM.
E0102 • You have not accepted the terms of the software licensing agreement for the new
version of SRDM.
E0200 • Check whether the folder configuration of corresponding SRDM is correct.
E0300 • Check whether the data folder is present in the relevant SRDM environment.
• This error code is displayed when the "data" folder in the "DBService" cannot be found
in the copy of SRDM being updated.
E0301 • Check that the data folder subdirectory for the relevant SRDM environment is not
empty.
E0400 • Check that the copy of SRDM which is being updated is a supported version.
• This error code is displayed when the version of the copy of SRDM being updated or
the version of the newly updated copy of SRDM is not supported by the DB version up
tool.
E0500 • Version up has already been implemented. If the update process has been
interrupted, refer to "Restarting the interrupted tool execution".
E0709 / E9999 • System error. Refer to "When an error cannot be resolved".

Server Software Setup Guide Page 24


UPDATING SRDM
8.1 SRDM DB version up tool

When an error cannot be resolved

Note:
Error codes E0100, E0101, E0200, E0201, E0300, E0301, and E0400 are appended by "-1" if the error
involved the copy of SRDM being updated or by "-2" if the error involved the newly updated copy of
SRDM.

If an error persists even when it is resolved as mentioned in "Error code and resolution method", or when E0709
/ E9999 occurs, the log file is necessary for investigation.
In addition, the DB may be required depending on the investigation result.

Restarting the interrupted tool execution


When the tool execution process is interrupted due to reasons such as PC power failure, or when the tool is to
be re-executed, check that the "data" folder described in "DB after the completion of tool execution" is present.
If the folder is present, then renaming the data folder to any name (the folder may also be deleted), and
renaming the "data_org" folder to "data", will return SRDM to the state prior to tool execution.

Starting the new version


Refer to "OPENING SRDM" for the method of starting SRDM.

Deletion of old version


If they are no longer needed, delete the files belonging to the old version.

Server Software Setup Guide Page 25


9
DATABASE OPTIMIZATION
Based on the usage, SRDM database file size will be increased. The database file does not become smaller even
when data is deleted from the database.
Even if the logs are deleted, the database file size still remains the same.
By optimizing the database, you can reduce the size of the database file and improve the performance of SRDM.

Note:
• The optimization process will not compress the data, but it will reduce the size of the database
file by deleting unnecessary data.
• If the free space on the hard disk becomes less than 6 GB, the SRDM service will stop and the
user will not be able to log in. If there is still not enough free space on the hard disk even after
optimizing the database, increase the amount of free space on the hard disk to 6 GB or more by
following the procedure given below.
◦ Delete old logs within SRDM (Refer to the Operation Guide)
◦ Delete unnecessary files on the hard disk.

You can perform database optimization by the following steps.

1. Launch the SRDM control panel.


If the SRDM service is running, click the SRDM [Stop Service] button to stop the SRDM service. Once
the service is stopped, click the [Stop Service] button of the built-in database.
If SRDM is launched from “Portable deployment“, display the [Potable deployment] dialog box from the
menu, and terminate SRDM and DB.

Server Software Setup Guide Page 26


DATABASE OPTIMIZATION

2. Select [System] → [Database optimization...] and click [OK] in the following dialog box.

3. After the database optimization process is completed, the following dialog box will be displayed. Click
the [OK] button.

4. After the database optimization process is completed, launch the SRDM service.

Note:
• During optimization, if the process is forcibly interrupted due to unexpected power failure etc.,
files will not be deleted. In this case, execute this operation again. The files will be deleted when
this operation is completed successfully.
• In addition to the manual procedure described above, database optimization can be carried out
automatically at regular intervals by setting a schedule. For details, refer to the Operation Guide.
• A backup is created during database optimization, so the optimization process may failed if there
is not enough free space on the hard disk. As a guide, more than twice the size of the folder
“«SRDM Install Folder»\SRDM\Svr\DBService\data” in your SRDM installed folder is required.

When the database is optimized, in addition to the database folder for containing data after optimization, a
backup file for the database before optimization will be created in the following location.

• «SRDM Install Folder» \SRDM\Svr\DBService\backup\srdm_yyyyMMdd_HHmmss.gz

To revert to the database after optimization has been carried out, refer to “Restoring Databases”.

Note:
Regarding the database backup files before optimization, only the latest data is stored and old one is
deleted sequentially to free up hard disk space. If you wish to keep old data, take backup of databases.
Regarding the procedure for backing up databases, refer to “Backing Up Databases”.

Server Software Setup Guide Page 27


10
BACKING UP/RESTORING DATABASES
This section describes the database backup procedure where an administrator outputs databases to a folder at
any time the administrator wishes. It also describes the procedure on how to restore databases from the output
backup files.

10.1 Backing Up Databases


1. If SRDM is running, stop SRDM from the SRDM control panel. For more information about how to stop
SRDM, refer to “Stop the running SRDM Service”.
2. Run the Command Prompt as an administrator.
3. Move to the path “«SRDM Install Folder»\SRDM\Svr\DBUtility\DBBackup” where the backup tool
“[Link]” is stored.
4. Execute the backup command. Enter “[Link]” and then press the Enter key. The following
options can be specified when executing the backup command. The file name extension of a backup
file is “.gz”.
• Output destination folder: Specifies a destination folder where the backup file is to be output.
Example: When outputting the backup file into the “SRDM\Backup” folder in the C drive
→ Enter “[Link] C:\SRDM\Backup”.
• Output file name: Specifies a file name of the backup file.
Example: When outputting into the same folder as for the backup tool as a file named
“SRDM2.18_Backup.gz”
→ Enter “[Link] SRDM2.18_Backup.gz”.
• Output destination folder + Output file name: Specifies both the destination folder where the
backup file is to be output and the file name.
Example: When outputting the backup file as a file named “SRDM2.18_Backup.gz” into the
“SRDM\Backup” folder in the C drive
→ Enter “[Link] C:\SRDM\Backup\SRDM2.18_Backup.gz”.
5. Confirm the output results of the backup file. Confirm that a file named “srdm_yyyyMMdd_HHmmss.gz”
is output in the “«SRDM Install Folder»\SRDM\Svr\DBUtility\DBBackup” folder.

Note:
• If the output destination folder or output file name is specified using the backup command
options, confirm that they are output as specified.
• If error code E0108 displays during the backup process and your backup attempt fails, check that
you are running the command prompt as an administrator.

6. Copy the following folders and files inside the SRDM installed folder to a backup media.
- «SRDM Install Folder»\SRDM\Svr\tomcat\webapps\deviceImage
- «SRDM Install Folder»\SRDM\Svr\tomcat\srdmData*1
- «SRDM Install Folder»\SRDM\Svr\command\settings

*1: "«SRDM Install Folder»\SRDM\Svr\tomcat\srdmData” is a folder that is generated when a printer driver file
or a device cloning file is uploaded. If it does not exist, this folder can be omitted from the backup.

Server Software Setup Guide Page 28


BACKING UP/RESTORING DATABASES
10.2 Restoring Databases

10.2 Restoring Databases


1. If SRDM is running, stop SRDM from the SRDM control panel. For more information about how to stop
SRDM, refer to “Stop the running SRDM Service”.
2. Run the Command Prompt as an administrator.
3. Move to the path “«SRDM Install Folder»\SRDM\Svr\DBUtility\DBBackup” where the restore tool
“[Link]” is stored.
4. Specify the backup file to be restored and then execute the restore command. Enter “[Link]
«Backup file to be restored»” and then press the Enter key. The backup file to be restored can be
specified with either an absolute path or a relative path.
• Example: When restoring the backup file “SRDM2.18_Backup.gz” stored in the same folder as for
the restore tool
→ Enter “[Link] SRDM2.18_Backup.gz”.
• Example: When restoring the backup file “SRDM2.18_Backup.gz” stored in the “SRDM\Backup”
folder in the C drive
→ Enter “[Link] C:\SRDM\Backup\SRDM2.18_Backup.gz”.

5. Restore the folders and files stored in the backup to the following folders insider the SRDM installed
folder.
- «SRDM Install Folder»\SRDM\Svr\tomcat\webapps\deviceImage
- «SRDM Install Folder»\SRDM\Svr\tomcat\srdmData*1
- «SRDM Install Folder»\SRDM\Svr\command\settings

*1: "«SRDM Install Folder»\SRDM\Svr\tomcat\srdmData” is a folder that is generated when a printer driver file
or a device cloning file is uploaded. If it does not exist, there is no need to restore.

Note:
• For restoring data, the SRDM version of the restore destination needs to be the same as that of
the backup source.
• If error code E0108 displays during the restoration process and your restoration attempt fails,
check that you are running the command prompt as an administrator.

Server Software Setup Guide Page 29


11
TROUBLESHOOTING
Problem Causes and Remedies
During SRDM installation, "Error This is due to SRDM installation path is too long. Try installing in
opening file for writing" error shortest path (Example: C:\SRDM).
message is displayed.
SRDM server cannot be started. Check that the TCP port number which you are trying to use is not
being used by another application.
SRDM cannot be accessed from a PC If a personal firewall is enabled, make sure that the TCP port for
other than the one on which SRDM SRDM access is set to "Enabled".
is running
"Service is not available" is displayed There is a possibility that there is insufficient free space in the hard
in the login screen and the user disk.
cannot log in. Refer to "DATABASE OPTIMIZATION" to increase the free space in
the hard disk, and then re-launch SRDM.
Response takes a long time. There is a possibility that the database file size is too large.
(Displaying pages takes time.) Refer to "DATABASE OPTIMIZATION" to decrease the database file
size, and then re-launch SRDM.
After making an error logging into If you make an error logging into the same account five times in a
the same account several times, the row, the account will be temporarily locked, and logging into that
message "Login has failed." is account will not be possible for 30 minutes. In such cases, wait 30
displayed and login is not possible minutes or more, and then try logging into the account using the
even when the correct account correct details.
information is entered. When the account is locked, it will still be possible for a user with
administrator privileges to log into SRDM and cancel the lock form
the account management window. For details, refer to the
Operation Guide.
"Service is not available (E0046). The amount of free space in the hard disk has dropped below 6
Please contact administrator or refer GB. If this happens, carry out the steps below to increase the
to Server Setup Guide." is displayed amount of free space in the hard disk to 6GB or more.
and the user cannot log in. Delete unnecessary files on the hard disk.
Execute database optimization. For more information, refer to
"DATABASE OPTIMIZATION".
Delete old SRDM log files. With SRDM, the schedule log delete
setting allows you to automatically delete logs. The schedule log
delete setting allows you to keep logs for a maximum of 12
months, and in addition, you can set the shortest period for
keeping logs to only the latest log entry. Even if you use the
"Latest one log" setting, operation log data will be kept for a
minimum of one month, but only the latest log entry will be
available for other logs such as device logs. Note that, as long as
the [Schedule Log Delete] is selected, the counter log data is
always kept for 14 months regardless of the value set for the
period during which the log is set to remain.
For more information about settings for scheduled log deletion,
refer to "Basic Window Configuration" in the Operation Guide.

Server Software Setup Guide Page 30


TROUBLESHOOTING

Problem Causes and Remedies


None of the above remedies help. If none of the above remedies help, try resetting SRDM to its initial
state using the following procedure. (All data will be lost.)
1. If SRDM is running, stop SRDM from the SRDM control panel.
For more information about how to stop SRDM, refer to “Stop
the running SRDM Service”.
2. Select [System] -> [Database initialization] and click [OK] in a
confirmation dialog box.
3. After the database initialization process is completed, a
completion dialog box will be displayed. Click the [OK] button.
4. Launch the SRDM service.

Server Software Setup Guide Page 31


12
APPENDIX
12.1 Procedure for configuring SSL certificates with SRDM
Overview
SRDM contains an SSL self-signed certificate. To apply the SSL certificate which has been obtained by the
customer, carry out the steps below.
You can register your own SSL certificate with SRDM by following the procedure below:

1. Delete the self-signed certificate.


2. Creating a public and private key pair
3. Have a certificate authority sign the public key (create a server certificate).
4. Embed the server certificate into SRDM.

Step 1: Preparing for the procedure


This description assumes the environment described below. Replacement should be made according to the
customer's environment.

Common name (SRDM server hostname) [Link]


SRDM location directory c:\SRDM\SRDM2.18.x
Root certificate alias name root
Intermediate CA certificate alias name cacert
Server certificate filename [Link]
Root certificate filename [Link]
Intermediate CA certificate filename [Link]
Keystore file password changeit

Perform the steps described below on the server running SRDM.


Make sure that the SRDM distribution files have been copied to c:\SRDM\SRDM2.18.x.
Check that SRDM is not running. If it is running, stop the SRDM service.
The SRDM private key and certificate are stored in the .keystore file. The .keystore file is located in the following
folder.

c:\SRDM\SRDM2.18.x\SRDM\Svr\tomcat\conf\.keystore

In the default configuration, the self-signed certificate is stored in the .keystore file. If you use SSL to access
SRDM in this state, most browsers will display a warning.
The same key as the generated private key cannot be recreated. Make a backup copy of the .keystore file
including the private key to avoid losing it.
The remaining steps are performed by entering commands at a command prompt.
Open the command prompt and set the execution path.

set PATH=c:\SRDM\SRDM2.18.x\SRDM\Svr\tomcat\jre\bin;%PATH%

Move to the working directory.

pushd "c:\SRDM\SRDM2.18.x\SRDM\Svr\tomcat\conf"

Server Software Setup Guide Page 32


APPENDIX
12.1 Procedure for configuring SSL certificates with SRDM

Step 2: Deleting the certificate


In the default configuration, the self-signed certificate is stored in the .keystore file. Before creating the public
and private key pair, delete this self-signed certificate.

keytool -delete -alias tomcat -keystore .keystore -storepass changeit

Step 3: Creating a public and private key pair


Create a public and private key pair. The key pair will be stored in the .keystore file in the SRDM directory.
Run the following command on the server on which SRDM is installed:

keytool -genkeypair -alias tomcat -keyalg RSA -keysize 2048 -keystore .keystore -storepass changeit -
dname "CN=[Link], O=COMPANY, L=CITY, ST=STATE, C=COUNTRY" -validity 365 -keypass
changeit

Specify [Link], COMPANY, CITY, STATE, COUNTRY, and -validity 365 according to the customer's
environment.
This operation generates a unique private key in the .keystore file. This .keystore file is used to register the
certificate.
It is recommended that you back up the .keystore file that contains the private key.

Step 4: Having a certificate authority sign the public key (creating the server certificate)
Run the following command on the server on which SRDM is installed to generate a certificate request file:

keytool -certreq -alias tomcat -file [Link] -keystore .keystore -storepass changeit

Submit the [Link] file that is created by the command to the certificate authority and obtain a server
certificate.
You may need to obtain a root certificate and intermediate CA certificate from the certificate authority.

Step 5: Embedding the server certificate into SRDM


Register the certificate with the server on which SRDM is installed.
The certificate will be stored in the .keystore file in the SRDM directory.
Obtain the following files from the certificate authority:

• Signed server certificate ([Link])


• Root certificate ([Link])

In addition, one or more intermediate certificates may be required depending on the certification authority.

• Intermediate CA certificate ([Link])

The certificates are registered in the .keystore file in the order of root certificate, intermediate CA certificate, and
server certificate.

Registering the root certificate


Register the root certificate.

Server Software Setup Guide Page 33


APPENDIX
12.1 Procedure for configuring SSL certificates with SRDM

keytool -importcert -trustcacerts -alias root -file [Link] -keypass changeit -keystore .keystore -
storepass changeit

If you are asked "Trust this certificate?" while executing the command, enter "yes." For Japanese-language
environments, enter "はい".

Registering the intermediate CA certificate


If an intermediate CA certificate is required, register it by repeating the following procedure as many times as
required. When multiple intermediate CA certificates are registered,

• Register the intermediate CA certificates in order from the one nearest to the root certificate.
• Change the alias name ("cacert" is used below) and the intermediate CA certificate filename so that they
do not duplicate other alias names.
• Replace the intermediate CA certificate file name ("[Link]" described below) according to the
customer's environment.

keytool -importcert -trustcacerts -alias cacert -file [Link] -keypass changeit -keystore .keystore -
storepass changeit

Registering the server certificate


Register the server certificate according to the following procedure.

keytool -importcert -trustcacerts -alias tomcat -file [Link] -keypass changeit -keystore .keystore -
storepass changeit

When specifying the alias name, use the same string as the alias name that you specified when creating the key
pair in "Creating a public and private key pair" (in this example, "tomcat" is used).

Step 6: Checking operation


Launch SRDM, access the following URL from a Web browser, and verify that no SSL warning is displayed.
Replace the server name and port number according to the customer's environment.

[Link]

Server Software Setup Guide Page 34


APPENDIX
12.1 Procedure for configuring SSL certificates with SRDM

Reference
The following commands are available to confirm the contents of the .keystore file or to delete the certificates.

• To check .keystore file contents

keytool -list -keystore .keystore -storepass changeit

• To delete a certificate in the .keystore file

keytool -delete -alias <Certificate alias name> -keystore .keystore -storepass changeit

Server Software Setup Guide Page 35


EN_Rev.45

You might also like