Professional Documents
Culture Documents
INSTALLATION
GUIDE
[Note]
The symbol indicates new features and information for GlobalScan NX version 2.0.0.0 or later.
Installation Guide
2. ABOUT Operating The following operating systems are no longer supported for this software.
GLOBALSCAN NX > Systems Microsoft Windows 2000 Server Service Pack 4
Requirements and
Specifications > Server Microsoft Windows 2000 Advanced Server Service Pack 4
Edition
The following operating systems are added to the supported operating systems
for installing GlobalScan NX Server application and AdminTool:
Microsoft Windows 2003 (WOW64)
Microsoft Windows 2003 R2 (WOW64)
Microsoft Windows 2008 (WOW64)
Microsoft Windows 2008 R2
[Note]
The GlobalScan NX application and Admin Tool can also be installed on the
above operating systems running under Windows Hyper-V 1.0, 2.0.
1
Original Chapter / Page Changes
Web Server The supported version of Web Servers has changed to the following.
Microsoft Internet Information Services 6.0
Microsoft Internet Information Services 7.0
Microsoft Internet Information Services 7.5
Browsing The following operating systems are no longer supported for this software.
AdminTool Microsoft Windows 2000 Professional Service Pack 4
Microsoft Windows 2000 Server Service Pack 4
Microsoft Windows 2000 Advanced Server Service Pack 4
Web The supported version of Web Browsers has changed to the following.
Browser Microsoft Internet Explorer 8 (except for 64 bit version)
Microsoft Internet Explorer 9
Firefox 9.0.1
The version of Adobe Flash Player required for AdminTool has changed to
11.2.202.228 or later.
Operating The following operating systems are no longer supported for this software.
Systems Microsoft Windows 2000 Professional Service Pack 4
Microsoft Windows 2000 Server Service Pack 4
Microsoft Windows 2000 Advanced Server Service Pack 4
The following operating systems are added to the supported operating systems
for installing GlobalScan NX AdminTool:
Microsoft Windows 7 Professional/Enterprise/Ultimate (32-bit version only)
Microsoft Windows 2003 (WOW64)
Microsoft Windows 2003 R2 (WOW64)
Microsoft Windows 2008 (WOW64)
Microsoft Windows 2008 R2
2
Original Chapter / Page Changes
2. ABOUT CPU
GLOBALSCAN NX > Core 2 Duo 2 GHz or faster recommended
Requirements and
Specifications > RAM
Serverless Edition 2.0 GB recommended
Hard Disk Space
1.0 GB recommended for software
2.0 GB recommended for data
2. ABOUT Web Server If you have installed Admin Tool on one of the following operating systems, IIS
GLOBALSCAN NX > cannot be used.
Requirements and Windows XP Professional
Specifications >
Serverless Edition Windows Vista Business/Enterprise/Ultimate
Windows 7 Professional/Enterprise/Ultimate
The supported version of Web Servers has changed to the following.
Microsoft Internet Information Services 6.0
Microsoft Internet Information Services 7.0
Microsoft Internet Information Services 7.5
Web The supported version of Web Browsers has changed to the following.
Browser Microsoft Internet Explorer 8 (except for 64 bit version)
Microsoft Internet Explorer 9
Firefox 9.0.1
The version of Adobe Flash Player required for AdminTool has changed to
11.2.202.228 or later.
Send to Email The Send to Email function can be used with the following mail servers:
Gmail Server
Microsoft Exchange Server 2010
Desknet's V7.0 R2.0
2. ABOUT Important MFPs’ Auto-Off Timer needs to be set to 5 minutes or longer as long as
GLOBALSCAN NX > GlobalScan NX is installed. This limitation is caused by the way applications
Requirements and are loaded on MFPs. If an MFP enters sleep mode before an application and its
Specifications > associated software finish starting up, the MFP might not work correctly.
Available Delivery
Methods and Required
Environments
3. SOFTWARE Note the following important information before you install GlobalScan NX:
INSTALLATION > [Important]
Preparing to Install
GlobalScan NX If you are installing GlobalScan NX on a server running Windows 2008, and
Software you want to use IIS 7.0 as the Web server, you must also have installed
ISAPI extensions and ISAPI filters for IIS. If these have not been installed,
[Internet Information Service] will not appear as an option during
installation.
3
Original Chapter / Page Changes
3. SOFTWARE Software An Installation Modification is necessary to change only the following settings:
INSTALLATION > Installation Web Server
Installing GlobalScan Modification
NX Software Port Number
Virtual Directory
An Installation Modification is not necessary to change the Built-in Password or the
Auto On/Off for delivery service setting.
4
Original Chapter / Page Changes
[Note]
There is a 45-day trial period for GlobalScan NX and its options after installation. If
you intend to continue using this software, perform activate it during the trial
period.
5
This page intentionally left blank.
GlobalScan NX v2 Installation Guide
TABLE OF CONTENTS
PDF Page #
APPENDIX
NOTE:
For GSNX v2 Plug-in administration and user's information, refer to
the information provided with the plug-in.
For GSNX v2 MFP installation and activation, refer to the “Remote
Install Manager Guide” beginning on page 39 in this manual.
This page intentionally left blank.
Readme.txt
**************************************************
GlobalScan NX
Version 2.1.1.0
**************************************************
- Read Me First -
September 2012
* Aficio MP
4000/4000B/5000/5000B/LD040/LD040B/LD050/LD050B/9040/9040b/9050/9050b
* Aficio MP
2550/2550B/3350/3350B/LD425/LD425B/LD433/LD433B/9025/9025B/9033/9033B
* Aficio MP C6000/C7500/LD260c/LD275c/C6055/C7570
* Aficio MP 4002/5002/DSm940/DSm950
* Aficio MPW5100en/W7140en/en5100WD/en7140WD/LW5100en/LW7140en
* Aficio MP C6501/C7501/LD365C/LD375C/C9065/C9075
* Aficio MP C2800/C3300/LD528C/LD533C
* Aficio MP C4000/C5000/LD540C/LD550C
* Aficio MP C2050/C2550/LD520C/LD525C
* Aficio MP C3001/C3501/LD630C/LD635C/C9130/C9135
* Aficio MP C4501/C5501/LD645C/LD655C/C9145/C9155
* Aficio MP C2051/C2551/LD620C/LD625C/C9120/C9125
* Aficio MP C300/C400/LD130C/LD140C
* Aficio MP C3002/C3502/DSc930/DSc935
* Aficio MP C4502/C4502A/C5502/C5502A
* Aficio MP 6001/7001/8001/9001/LD360/LD370/LD380/LD390/9060/9070/9080/9090
* Aficio MP 6001SP/7001SP/8001SP/9001SP/LD360sp/LD370sp/LD380sp/LD390sp/9060sp
/9070sp/9080sp/9090sp
* Aficio MP 171SPF/LD117SPF/917SPF
* Aficio MP 201SPF/LD220SPF/920SPF
* Aficio MP 4001/5001/LD140/LD150/9240/9250
* Aficio MP 2851/3351/LD528/LD533/9228/9233
* Aficio SP 5200S/5210SF/5210SR
* Aficio MP 2352SP/2852SP/3352 SP
* Aficio MP W5100/W7140/GWD5100/GWD7140/LW5100/LW7140/5100WD/7140WD
Page 2
Readme.txt
* Aficio MP W2401/W3601/GWD3006/LW426/3406WD
* Aficio MP 301 (*)
* Aficio MPC 305/DSc530 (*)
* Aficio MP 6002/7502/9002
Devices marked with an asterix (*) have a 4.3 inch operation panel.
-------- Supported WebDAV Servers --------
- Memory on Device
Note that the memory on the devices should be expanded as much as possible.
GlobalScan NX application may not work properly on a device where its memory
has not been fully expanded.
Other devices:
16MB
- Account for installation
To install GlobalScan NX, you must have administrator privileges, which
means you must belong to the Administrators group.
- Computer name
The name of the computer on which you install GlobalScan NX must contain
only alphanumeric characters (A-Z, a-z, 0-9) and hyphens (-).
- Installation Folder
Page 3
Readme.txt
The button to create a new folder will be disabled on the Install
Folder Selection screen of the installer when the Program Files folder is
selected as the destination folder. New folders can be created under the
Program Files folder by manually editing the path name. However, it is
suggested that the new folder be created before starting the installation.
Also, both Web Image Monitor and the device's Extended Feature Settings screen
may display the status of GlobalScan NX as "Suspend".
This is equivalent to "Starting Up" and is normal behavior, there is no need
to restart.
- Modifying the built-in user's password, port number, virtual directory, or web
server used
To modify the above settings, re-install the product from the installation
media.
Uninstallation of the product before starting the re-installation may be
required
depending on the settings you want to modify.
- When the device's IP address has been changed, it must re-registered to the
GlobalScan NX device list after removal.
-------- Operation Restrictions --------
1. Open the Web Sites Properties dialog and select the Directory Security
tab.
2. Select the [Edit...] button at the Authentication and access control
setting.
3. On the Authentication Methods dialog, and Enable anonymous
access.
4. If the problem continues to happen, set a valid user name and
password via the dialog opened in step 3.
Page 5
Readme.txt
- XML Transformer Filter XSL file name display issue
On the Properties screen of the XML Transformer Filter, the XSL file path
field always displays the name "dest.xsl", instead of the actual
name of the specified file, when the [Upload] button is pressed.
- Using the AdminTool with FireFox and SSL
Using Firefox to access the AdminTool over SSL causes the following
operations to fail:
- Recommended Restarts
If GlobalScan NX crashes or its performance drops, try restarting the device.
Note, however, do not create more than 100 Projects in a Profile when using
Aficio MP 171SPF/LD117SPF/917SPF.
(*) The settings for the printer driver of the logon user of GlobalScan Service.
The logon user can be checked from the Services menu of Windows.
- Unsupported printers
The Scan to Printer Service does not support the printers that require user
interaction
at the time of printing or whose output is electronic data, not a printed sheet
of paper.
Disable (uncheck) "Do not save encrypted pages to disk" on the Internet Options
> Advanced tab. This is described in the following KB:
http://support.microsoft.com/kb/815313/en-us
Page 12
Readme.txt
-------- Recommendations --------
- Backups Regularly
We strongly recommend that you back up regularly all configuration
information of GlobalScan NX. We are not responsible for any loss of nor
damage to your GlobalScan NX configuration information.
-------- Notes --------
- Device Auto Off Timer
During installation of the SDK application, the device's Auto Off Timer must
be set to 6 minutes or longer. After installation this value can be reduced to
a minimum of 1 minute.
-------- Uninstalling GlobalScan NX --------
http://support-download.com/services/pub/jcifs/
===================
Oracle trademark
Oracle and Java are registered trademarks of Oracle and/or its affiliates.
Page 13
Readme.txt
Other names may be trademarks of their respective owners.
This product includes software developed by The Apache Software Foundation
(http://www.apache.org/).
This product includes software developed by the OpenSymphony Group
(http://www.opensymphony.com/).
This product includes software developed by the JBoss community
(http://www.jboss.org/javassist/).
This product includes software developed by The JCIFS Project
(http://jcifs.samba.org/).
This product includes software developed by the Mort Bay Consulting
(http://jetty.mortbay.org/).
This product includes software developed by the The Legion of the Bouncy Castle
(http://www.bouncycastle.org/).
This product includes software developed by Sam Leffler and Silicon Graphics
(http://www.remotesensing.org/libtiff/).
Page 14
Readme.txt
This product includes software developed by Sun Microsystems, Inc.
(http://www.sun.com/).
c 1984-2008 Adobe Systems Incorporated and its licensors. All rights reserved.
Protected by U.S. Patents 5,929,866; 5,943,063; 6,289,364; 6,563,502; 6,185,684;
6,205,549; 6,639,593;7,213,269; 7,246,748; 7,272,628; 7,278,168; 7,343,551;
7,395,503; 7,389,200; 7,406,599;6,754,382; Patents Pending.
AdobeR, the Adobe logo, AcrobatR, the Adobe PDF logo are either registered
trademarks or trademarks of Adobe Systems Incorporated in the United States and/or
other countries. All other trademarks are the property of their respective owners.
Opening DjVu image format:
Portions of this computer program are copyright c 1996-2007 LizardTech, Inc. All
rights reserved. DjVu is protected by U.S. Patent No. 6,058,214. Foreign Patents
Pending.
Working with JPEG image format:
This software is based in part on the work of the Independent JPEG Group.
Unicode support:
Portions of this software are copyright c 1996-2002, 2006 The FreeType Project
(www.freetype.org). All rights reserved.
===================
(C)2008-2012
Page 15
Readme.txt
Page 16
GlobalScan NX Server
Installation Quick Reference
Version 1.1
Version 1.2
July 5, 2012
Special Considerations
• When using a customer's PC, the client may be worried about information leaks or data corruption,
so care must be taken to reduce such fears. Before performing operations, it may be best to ask the
customer to sign a memorandum of understanding (such as a Non-disclosure agreement or a
waiver of liability).
• If the service representative is using their PC or a USB device to attach a customer's PC, care should
be taken to not introduce a virus or other malware into the customer's network.
1
Glossary
Term Description
This is the name of the entire system which has the following roles:
• SDK software product delivery
eDC-i • Product key and license file delivery
• Product activation authorization
• License management on database.
This server is designed to be the primary interface for the eDC-i. All
functions needed by marketing, customer engineers, or technical
Operation UI Server support staff can be quickly accessed by logging in to the Operation UI
Server from any web browser located on the R-WAN (some features
will eventually be available from outside the R-WAN).
2
TABLE OF CONTENTS
Special Considerations......................................................................................................................................1
Glossary..............................................................................................................................................................2
1. Overview
Introduction.........................................................................................................................................................7
Basic Functions of Remote Install Manager.................................................................................................7
Operating Environment..................................................................................................................................8
Limitations.....................................................................................................................................................10
Screen and Menu Description........................................................................................................................12
Workflow......................................................................................................................................................12
Quick Installation Screen............................................................................................................................12
Device List Screen........................................................................................................................................14
Product Key List Screen...............................................................................................................................32
Basic Functions of Remote Install Manager...................................................................................................41
System Outline of Remote Install Manager...............................................................................................41
Work State Archive File...............................................................................................................................44
Importance of Deactivation.............................................................................................................................45
Overview of eDC-i system and Remote Install Manager..............................................................................46
Case 1: Online Environment.......................................................................................................................46
Case 2: Offline Environment.......................................................................................................................46
Online Environment: Installation/Activation..............................................................................................48
Online Environment: License Update.........................................................................................................49
Online Environment: Software Update......................................................................................................50
Online Environment: Uninstallation/Deactivation.....................................................................................51
Offline Environment: Installation/Activation (2 visit-course)....................................................................52
Offline Environment: License Update.........................................................................................................53
Offline Environment: Software Update......................................................................................................54
Offline Environment: Uninstallation/Deactivation....................................................................................55
2. Preparation
Prior Confirmation............................................................................................................................................57
Environmental Check...................................................................................................................................57
Product Key(s) and Device List/ Work Archive File..................................................................................58
Java VM Version Check..............................................................................................................................59
Type-C Application Check..........................................................................................................................60
3
Device Authentication..................................................................................................................................60
3. Installation/Activation
Launching Remote Install Manager................................................................................................................61
Online: Installation/Activation........................................................................................................................63
Important Notices........................................................................................................................................63
Work Flow....................................................................................................................................................64
Installation/Activation Procedure...............................................................................................................65
Offline: Installation/Activation........................................................................................................................72
Important Notices........................................................................................................................................72
2-visit Course................................................................................................................................................72
4. Updating Licenses
Online: Updating Licenses...............................................................................................................................83
Work Flow....................................................................................................................................................83
Update Licenses Procedure.........................................................................................................................83
Offline: Updating Licenses...............................................................................................................................90
Work Flow....................................................................................................................................................90
Update License Procedure..........................................................................................................................91
5. Updating Software
Online: Updating Software.............................................................................................................................99
Work Flow....................................................................................................................................................99
Update Software Procedure.......................................................................................................................99
Offline: Updating Software...........................................................................................................................105
Work Flow.................................................................................................................................................105
Update Software Procedure.....................................................................................................................105
6. Uninstallation/Deactivation
Online: Uninstallation/Deactivation............................................................................................................109
Important Notices......................................................................................................................................109
Work Flow.................................................................................................................................................109
Uninstallation/Deactivation Procedure...................................................................................................110
Offline: Uninstallation/Deactivation............................................................................................................114
Work Flow.................................................................................................................................................115
Uninstallation/Deactivation Procedure...................................................................................................116
4
7. Other Operations
Offline Operations.........................................................................................................................................121
Update Java VM.......................................................................................................................................121
Change Heap/Stack Size........................................................................................................................124
8. Troubleshooting
Troubleshooting Guide..................................................................................................................................127
Error Code List...........................................................................................................................................127
5
6
1. Overview
Introduction 1
Basic Functions of Remote Install Manager
Remote Install Manager is an application which enables managing software as well as installing or
updating software to numerous multifunctional devices (referred to as "device" hereafter). The following
are the main basic functions.
Installation
New software for which a product key has been purchased can be installed and activated on target
devices.
For details, refer to p.61 "Installation/Activation".
Update License
Licenses can be updated to convert Trial Version Licenses to Official Licenses.
For details, refer to p.83 "Updating Licenses".
Update Software
When updated software for software installed in a device released on the Component Server, it can be
downloaded to update the software.
For details, refer to p.99 "Updating Software".
Uninstallation
When the deactivation of software is necessary due to the replacement of a device or the termination of
a contract, software can be deactivated and uninstalled.
For details, refer to p.109 "Uninstallation/Deactivation".
Updating Java VM
The eDC-i on which the function of Remote Install Manager can be operated can update the Java VM in
conjunction with a software update as a simple batch operation.
For details, refer to p.121 "Update Java VM".
Change Heap/Stack Size
Changes the Heap/Stack Size for the devices (offline), in order to adjust the correct Heap/Stack size
for the software combination used in the devices.
For details, refer to p.124 "Change Heap/Stack Size".
7
1. Overview
Operating Environment
PC
8
Introduction
Program Area: 20 MB
Hard Disk Space Log Files: Several MB
Software Size: Depending on components
1
Supported Browsers Browsers which support WIM (Web Image Monitor)
External Systems
Devices
Remote Install Manager supports 07A or later devices.
Server
• Component Server
• Activation Server
Java VM Version
The Remote Install Manager can update the Java VM in conjunction with a software update as a simple
batch operation. However, if the Java VM is a version not supported by the RIM (Remote Install
Manager) system, the JavaVM must be updated to a supported version manually before the batch
update function can be used.
To use this functionality, the versions of Java VM shown in the following table are required.
Online
Devices Java VM
Offline
Devices Java VM
9
1. Overview
Devices Java VM
• If the Java VM is older than the version shown in the offline table above, Remote Install Manager
will fail to detect the version of Java VM installed on the device.
• If an offline-supported but not online-supported Java VM version is installed, an error will occur
when attempting to update it using the online method.
• To update the Java VM from an older, unsupported version, use the Version Up Tool.
Network
A network environment with the following protocols and port numbers is required for communication
with external systems.
Communication with the Device
HTTPS 443
Limitations
10
Introduction
The maximum number of devices is limited to 100: Up to 100 devices can be added to the list. If
you attempt to add more devices, you will get an error message.
• The maximum number of product keys
The maximum number of product keys is limited to 100: Up to 100 product keys can be added to the 1
list. If you attempt to add more product keys, you will get an error message.
11
1. Overview
1 Workflow
The following is the workflow (screen transition) for Remote Install Manager and the basic functions that
can be operated from each screen.
This screen is used to execute the procedure of Installation, Update License or Others in a series of steps.
12
Screen and Menu Description
The following operations are available from the Quick Installation screen.
[Installation]
Installs new software for which a product key has been purchased on target devices.
For details, refer to p.63 "Online: Installation/Activation".
[Update License]
Updates licenses to convert Trial Version Licenses to Official Licenses.
For details, refer to p.83 "Online: Updating Licenses".
[Other]
Switches to the List screen and enables checking the status of the devices and product keys. Update
Software and uninstallation of software are performed from the List screen.
13
1. Overview
Function Description
Refresh All Items Same as [Refresh All Items] of the [View] menu.
Refresh Selected Items Same as [Refresh Selected Items] of the [View] menu.
Quick Installation Screen Same as [Quick Installation Screen] of the [View] menu.
14
Screen and Menu Description
(4) Header
A list of purchased software appears in the [Select Product] combo box. When a software program is
selected, the installation status appears in [Software Status] of the List View.
(5) List View 1
A list of registered devices appears.
Column Description
Last Communication Date Date and time of the last communication made with the device
• If the installation status cannot be retrieved, " " appears for [Software Status].
• The contents displayed in [Operation Results] are as follows.
[Operation
Description
Results]
The device or server is still processing your request. Select [Refresh All Items] or
Processing
[Refresh Selected Items] in the [View] menu to update the information.
Off-line
The offline process is not completed yet.
Processing
15
1. Overview
An error has occurred. Details of the error and ways to correct it can be checked in
Error
[Display Results] of the [Device Operation] menu.
[File] Menu
[New]
Creates a new work state archive for the device list and product key list.
1. In the [File] menu, select [New].
• A confirmation screen appears asking whether to save the file currently being viewed.
• When saving a new file, make sure to specify “.clz” as the file extension.
[Open]
16
Screen and Menu Description
Opens the work state archive for the device list and product key list.
1. In the [File] menu, select [Open].
• A confirmation screen appears asking whether to save the file currently being viewed.
1
• When saving a new file, make sure to specify “.clz” as the file extension.
3. Select the file to be opened.
• Select a file with the file extension “.clz”.
4. In the [View] menu of the Device List and Product Key List screens, select [Refresh All Items] or
[Refresh Selected Items].
[Save]
Overwrites and saves the information for the file currently being used.
[Save As]
Saves the current information as a file. Information for the device list and product key list are saved as
one file.
17
1. Overview
18
Screen and Menu Description
19
1. Overview
• Set the user name and password used to access a device. (The user name and password must
be the same as the user name and password used in Web Image Monitor.)
Server Communication Settings
Configures the settings for the proxy server.
1. In the [File] menu, select [Environment Setting...].
• The Environment Setting screen appears.
20
Screen and Menu Description
21
1. Overview
• Set the user name and password used to access the proxy server.
6. Click [Execute] in the “Server connection test” to check if the server connection is properly set.
• Click [OK] when the “Connected successfully.” pop-up screen appears.
• Re-configure the settings for the server communication.
[Exit]
Ends Remote Install Manager.
1. In the [File] menu, select [Exit].
• If changes were made in the Device List or Product Key List, a confirmation screen appears
asking whether to save the changes.
• When saving a new file, make sure to specify “.clz” as the file extension.
22
Screen and Menu Description
[Display Result...]
Displays the details of the error and ways to correct it when an error occurs during installation, updating
licenses or uninstalling software.
1. Select the device on which the error you want to check occurred.
2. In the [Device Operation] menu, select [Display Result].
• Details of the error and ways to correct it are displayed.
23
1. Overview
24
Screen and Menu Description
25
1. Overview
26
Screen and Menu Description
Last Communication Date and time of the last communication made with
Date the device
Host files (the addresses or host names included in the file are added as devices)
27
1. Overview
3. Click [OPEN].
• The devices are added to the List View of the Device List screen.
• If [Specify from File] is selected, all devices listed in the specified file are added. The
following descriptions are displayed for [Result].
28
Screen and Menu Description
[Result] Description
Communication
The device is not turned on. Or, this is not the target device.
error
Authentication
An authentication error has occurred.
error
Non-target
The version of Java VM is not a supported version.
device
[Delete]
Deletes the selected device from the Device List.
29
1. Overview
• Web Image Monitor is a management tool which enables checking the status of a device from a
PC (web browser). You can view the Web Image Monitor, without using Remote Install Manager,
just by entering the IP address of the device as the web browser address. Consumable replacement
schedules can also be checked.
• If the Web Image Monitor is not displayed after selecting [Properties], a network setting of the
customer site does not meet the network setting requirements of the Web Image Monitor. For
details about configuring the network settings of the Web Image Monitor, see "SSL Setting for Web
Image Monitor" in the "Appendixes".
[Export]
Exports a list of information on registered devices in CSV file format.
[Installation]
Installs new software on target devices with a product key and activates the software.
For details, refer to p.63 "Online: Installation/Activation".
[Update License]
Updates licenses to convert Trial Version Licenses to Official Licenses.
For details, refer to p.83 "Online: Updating Licenses".
[Update Software]
Enables downloading and performing update for software installed in a device when updates are
released on the Component Server.
For details, refer to p.99 "Online: Updating Software".
[Offline Operations]
This menu is mainly used for customers who have no internet connection environment or domains which
are not allowed to the use automatic verification of supported combinations.
30
Screen and Menu Description
31
1. Overview
[View] Menu
[Help] Menu
[Display Help]
Displays the Remote Install Manager Instruction Manual (this file).
[About]
Displays the Remote Install Manager version information.
32
Screen and Menu Description
Function Description
Refresh All Items Same as [Refresh All Items] of the [View] menu.
Refresh Selected Items Same as [Refresh Selected Items] of the [View] menu.
Quick Installation Screen Same as [Quick Installation Screen] of the [View] menu.
Column Description
License Type Official License (No Period Limit), Trial Version License
33
1. Overview
Date and time the information regarding the license was last updated
Last Update
(the date and time the Activation Server was last accessed)
1
• If the license type cannot be determined, " " appears for [License Type].
[File] Menu
Menu items are the same as the [File] menu in the Device List screen.
[Add]
Adds product key(s) to the list. You can add the product key using [Manual Entry] or [Specify from File].
To add multiple product keys at once, select [Specify from File].
Manual Entry
1. In the [Product Key Operation] menu, select [Add] and then [Manual Entry].
34
Screen and Menu Description
35
1. Overview
Number of License(s)
Number of unused licenses that can be installed
Installable.
36
Screen and Menu Description
3. Click [OPEN].
• The product keys are added to the List View of the Product key List screen.
• If [Specify from File] is selected, all product keys listed in the specified file are added.
• If an error occurs, the following screen appears.
37
1. Overview
[Result] Description
4. Select the added product key(s) and then select [Refresh All Items] or [Refresh Selected Items] in the
[View] menu.
5. In Tree View, select [Device List] to display the Device List screen.
6. In the [View] menu, select [Refresh All Items] or [Refresh Selected Items].
[Delete]
Deletes the selected product key(s) from the list.
38
Screen and Menu Description
Uninstallation
Deactivates and uninstalls software from devices (offline) and returns the license file to the "Activation
Server" (online). For details, refer to p.114 "Offline: Uninstallation/Deactivation".
[View] Menu
39
1. Overview
[Help] Menu
Menu items are the same as the [Help] menu in the Device List screen.
40
Basic Functions of Remote Install Manager
SDK*:
41
1. Overview
• An SDK application is an application developed using the Ricoh Device SDK, based on Java
Technology. Before installing an SDK application, a Java VM card needs to be installed in the
device.
1
Terms List around Remote Install Manager
Item Explanation
42
Basic Functions of Remote Install Manager
Item Explanation
43
1. Overview
Feature Explanation
This feature firstly removes the license file from the device and returns
Software Deactivation and
the license file to the Activation server.
Uninstallation
Then, software uninstallation will be done.
Device list, product key list and software list can be saved in a work state archive. All the work state
archives are archived in a zip file but with the extension “*clz”.
We strongly recommend that a work state archive file (*clz) be kept in your service station. This is
because it might take much time and effort to recover information for target devices if the work state
archive file is lost.
Device list
The format is the same as those created by Remote Manager. The file name is Devicelist.csv.
One file is created per feature as “Feature name”.txt. Each file contains its product keys, with one line
per product key.
44
Importance of Deactivation
Importance of Deactivation
When using Remote Install Manager, you can perform Software Uninstallation and Deactivation by
selecting “Uninstallation”. 1
Unless deactivation is completely performed, you are not able to do the following:
1. The same product key cannot be re-used for
a.) software re-installation/re-activation on the same device.
b.) software installation/activation on other devices.
2. On the same device (with the same machine ID (serial number)), the same product cannot be
activated, even when preparing another unused product key. (Additional activation for the same
product with a new product key will be refused by the Activation Server.)
45
1. Overview
While Remote Install Manage on a PC is accessing a device at the customer site over a network, internet
access is also possible.
While accessing the device, internet access is not possible at the customer site.
46
Overview of eDC-i system and Remote Install Manager
47
1. Overview
48
Overview of eDC-i system and Remote Install Manager
49
1. Overview
50
Overview of eDC-i system and Remote Install Manager
51
1. Overview
52
Overview of eDC-i system and Remote Install Manager
53
1. Overview
54
Overview of eDC-i system and Remote Install Manager
55
1. Overview
56
2. Preparation
Prior Confirmation
Environmental Check 2
Online/Offline
• Using multiple network interfaces is NOT supported by Remote Install Manager. This means
that both the access to devices and internet connection must be achieved using a network
interface.
57
2. Preparation
In the case of the Online configuration with the automatic verification of supported combinations
disabled or the Offline configuration, download the Embedded Software Combination Table from the
Operation UI Server to check the following:
• Version compatibility of Java VM and system F/W
• Supported combination of SDK applications
• Necessary Heap/Stack size
2
Country Name
[Country Name] is required for the operation of Remote Install Manager. Ask your sales staff for the
correct customer country (domain) before visiting a customer site.
Ask the customer to prepare a product key list (CSV file) and a device list (CSV file), or a Work Archive
file (CLZ file).
58
Prior Confirmation
2
• [A]: Product Key List
• [B]: Device List
A sample product key list and device list are stored in a unzipped folder of the Remote Install Manager
zip file as shown below.
• When a software update or uninstallation is performed, using the Work Archive File is strongly
recommended because it contains all the necessary information about all previous operations.
59
2. Preparation
• If an offline-supported but not online-supported Java VM version (e.g. V4.21-23) is installed, the
online-supported version of the Java VM package for the Offline environment must be prepared.
• If a not offline-supported Java VM version (e.g. V4.20 or earlier) is installed, the online-supported
version of Java VM Version-up Tool must be prepared.
Java VM must be updated manually to the online-supported version using the following method.
2 • The Java VM module (*.ifu) will be obtained from the Firmware Download Site.
Check if an SDK application that contains a Type-C module (i.e. modules developed using C++) is going
to be installed/updated/uninstalled.
• ELP-NX includes a Type-C module (FR Filter).
• This kind of application requires additional operations on the MFP/LP operation panel in order to
move the Type-C module stored on the VM card to the target machine’s HDD.
• Therefore, in cases where the target MFP/LP is installed in a remote location, it is necessary to have
a person on-site who is capable of moving the module at the operation panel.
Device Authentication
Ask the customer if all the target devices have the same login user name and password.
• If the device’s user name or password differs from that of Remote Install Manager, software
installation/update/uninstallation will be skipped.
60
3. Installation/Activation
• Do not execute Remote Install Manager in a folder which is encrypted. Otherwise, Remote Install
Manager will not work properly.
1. Download Remote Install Manager.
3
2. Extract the downloaded file to a folder.
• Do not extract the downloaded file to a folder which is encrypted.
3. Double-click the RemoteInstallManager.exe icon.
• Remote Install Manager is launched and the Environment Setting screen appears.
4. The Environment Setting screen appears the first time that you launch Remote Install Manager.
• Configure the settings for [Operating Environment], [Device Communication Setting] or
[Server Communication Setting].
• Customer Code can be entered. If you want to use Customer Code, select [*Others...] in
[Country Name], and then enter the [Customer Code].
• [Country Name] is required for Remote Install Manager. Ask your sales staff for the correct
customer country (domain) before visiting a customer site.
61
3. Installation/Activation
• From the second time on, you only need to perform step 3 to launch Remote Install Manager.
62
Online: Installation/Activation
Online: Installation/Activation
Purpose:
• Install new SDK application software on a device and make the software on the device ready for
use (= activate the software with license information).
• With a volume license product key, it is possible to install and activate SDK application software on
multiple devices at once.
3
Important Notices
The eDC-i can optimize the Java VM version and adjust the correct Heap/Stack size for a combination
of several SDK software items automatically when the automatic verification of supported combinations
is turned on. However, a correct Java VM version and Heap/Stack size for software to be installed
have to be checked by a field technician if the automatic verification of supported combinations of eDC-i
is not turned on or a customer site does not have internet access. Follow the one of two actions below;
• Download the Embedded Software Combination Table from the Operation UI Server.
• Consult with your sales staff about a correct Java VM version and Heap/Stack size for software to
be installed before visiting a customer site.
Remote Install Manager can complete the installation and uninstallation only for Type J software. If
software to be installed has mixed type software (type C and J), Type C software has to be installed
from the operation panel of the target machine. Check if software to be installed includes Type C
software.
Operation from Remote Install Manager is effective only for devices which have the same administration
authentication settings (user name and password) as the ones in the Environment Settings of Remote
Install Manager. If some devices have different administrator authentication settings from the ones in the
Environment Settings of Remote Install Manager, operation to those devices is cancelled.
63
3. Installation/Activation
Four Type C applications or more can not be installed in a device. Make sure of this limitation when
installing SDK software package with Remote Install Manager. Installing four Type C applications in the
device can cause an installation error.
Work Flow
64
Online: Installation/Activation
Installation/Activation Procedure
• If the device gets damaged, replaced, or discarded, you will be UNABLE to de-activate the
product license, as the Activation Server administrator requires the machine ID (device serial
number) to forcibly de-activate the license. This will make the product key affected to the license
unusable. To avoid this situation, please ask the customer to keep a copy of the machine ID (device
serial number), and the work state archive (*clz) should be created as a part of normal Remote
Install Manager operation.
• Four or more Type C applications cannot be installed in a device. Make sure of this limitation when
installing an SDK software package with Remote Install Manager. Installing four Type C
applications in the device can cause an installation error.
1. Prepare as follows.
Items (Confirm with the customer):
• A PC with Remote Install Manager
65
3. Installation/Activation
• Product Keys
• IP addresses and host names for target devices
• User name and password of the machine administrator account for each target devices
• Embedded Software Combination Table or information about supported software
combinations in the target machine
Action:
• Check if the VM Card (Java VM) is installed in the target devices and the version of the VM
card is compatible for the use of Remote Install Manager.
3 If not, install the VM card in a target machine and update the VM program to a supported
program version.
• Check if the firmware (e.g. system module) of the target devices is the latest version.
If not, update the firmware.
• Check if the Network/PC/Device meets the Environmental Requirement.
If not, configure the required environment.
• Make sure that the target devices are not used by the customer during the following
operation.
2. If the Remote Install Manager system does not use the automatic verification of supported
combinations, follow the steps below:
• 1) Check if the Java VM in the target machine agrees with the online-supported version for
Remote Install Manager. (For details, see p.9 "Java VM Version".) If not, update the Java VM
in the target machine to a correct version referring to Embedded Software Combination Table
or information about supported software combinations in the target machine.
• 2) Select [Change Heap/Stack Size] in [Offlien Operations] under [Device Operation].
• 3) Change the Heap/Stack size to the correct value for the target device which you have
already checked. If no information about a correct Heap/Stack size is available, change the
Heap/Stack size to the maximum value of the target device.
3. You can perform installation from the Device List screen or the Quick Installation screen.
Installation from the Quick Installation screen:
Launch Remote Install Manager and click [Quick Installation Screen] under the [View] menu.
66
Online: Installation/Activation
• To refer to a product key used previously, click [Browse Previous Value]. Select the product
key to use and click [OK].
67
3. Installation/Activation
5. Click [Next].
• Communication with the "Activation Server" begins. When communication is complete, a
confirmation screen appears.
6. Check the contents and click [Next].
7. Select the check boxes for the devices onto which to install the software.
68
Online: Installation/Activation
69
3. Installation/Activation
70
Online: Installation/Activation
• If a result other than [Completed] is displayed in [Operation Results], right-click on the device
column and select [Display Result...] to view a description of the error and ways to correct it.
11. Double-click the target device in the Device List screen, and then check if the target software has
been installed in the target device with WIM.
71
3. Installation/Activation
Offline: Installation/Activation
Important Notices
A correct Java VM version and Heap/Stack size for software to be installed have to be checked by a
3 field technician if a customer site does not have internet access. Follow one of the two actions below:
• Download the Embedded Software Combination Table from the Operation UI Server.
• Consult with your sales staff about a correct Java VM version and Heap/Stack size for software to
be installed before visiting a customer site.
Remote Install Manager can complete the installation and uninstallation only for Type J software. If
software to be installed has mixed type software (type C and J), Type C software has to be installed
from the operation panel of the target machine. Check if software to be installed includes Type C
software.
Operation from Remote Install Manager is effective only for devices which have the same administration
authentication settings (user name and password) as the ones in the Environment Settings of Remote
Install Manager. If some devices have different administrator authentication settings from the ones in the
Environment Settings of Remote Install Manager, operation to those devices is cancelled.
Four or more Type C applications cannot be installed in a device. Make sure of this limitation when
installing an SDK software package with Remote Install Manager. Installing four Type C applications in
the device can cause an installation error.
2-visit Course
Purpose:
• Install new SDK application software on a device and make the software on the device ready for
use (= activate the software with license information).
72
Offline: Installation/Activation
• With a volume license product key, it is possible to install and activate SDK application software on
multiple devices at once.
Work Flow
73
3. Installation/Activation
Installation Procedure
• If the device gets damaged, replaced, or discarded, you will be UNABLE to de-activate the
product license, as the Activation Server administrator requires the machine ID (device serial
number) to forcibly de-activate the license. This will make the product key affected to the license
unusable. To avoid this situation, please ask the customer to keep a copy of the machine ID (device
serial number), and the work state archive (*clz) should be created as a part of normal Remote
Install Manager operation.
74
Offline: Installation/Activation
• Four or more Type C applications cannot be installed in a device. Make sure of this limitation when
installing SDK software package with Remote Install Manager. Installing four Type C applications
in the device can cause an installation error.
1. Prepare as follows.
Items (Confirm with the customer):
• A PC with Remote Manager Installer
• A SDK application software file (*.zip) to install
• Product Keys
• IP addresses and host names for target devices 3
• User name and password of the machine administrator account for each target devices.
• Embedded Software Combination Table or information about supported software
combinations on the target device
Action:
• Check if the VM Card (Java VM) is installed in the target devices and the firmware version of
the VM card is compatible for the use of Remote Installer Manager.
If not, install the VM card in a target device and update the firmware to a supported program
version.
• Check if the firmware (e.g. system module) of target devices is in the latest version.
If not, update the firmware.
• Check if the Network/PC/Device meets the Environmental Requirement.
If not, configure the required environment.
• Make sure that the target devices are not used by the customer during the following
operation.
<Customer Site>
2. Check if the Java VM in the target machine agrees with the online-supported version for Remote
Install Manager. (For details, see p.9 "Java VM Version".) If not, update the Java VM in the target
machine to a correct version referring to Embedded Software Combination Table or information
about supported software combination to the target machine.
3. Launch "Remote Install Manager" at the customer site.
75
3. Installation/Activation
3 4. Add a device to the "Device List" by using [Manual Entry] or [Specify from File].
76
Offline: Installation/Activation
9. Select the product (zip file), and then click the [Open] button.
Activation Procedure
<Internet Environment>
77
3. Installation/Activation
1. Launch "Remote Install Manager" and open the work state archive file (*clz) which was saved at
the customer site.
2. Select [2.Get License[Internet]] in [Install[2-visit course]] under [Offline Operations].
78
Offline: Installation/Activation
79
3. Installation/Activation
80
Offline: Installation/Activation
• Storage of the software starts, and then the Process Completion screen appears.
14. Click the [Finish] button.
81
3. Installation/Activation
15. The Installation/Activation Warning screen appears if the software to be installed has a Type C
application.
• A Type C application has to be installed in the target device from its operation panel
manually. “Warning” is displayed in the Device List until the Type C application is properly
installed.
16. Save the work state archive (*clz), and ask the customer to keep it.
82
4. Updating Licenses
Work Flow
• The license type can be checked in [License Type] in the Product Key List screen.
1. Prepare as follows.
Items (Confirm with the customer):
• A PC with Remote Install Manager
• Product Keys for updating the licenses
• IP addresses and host names for target devices
• The latest Work State Archive file (*.clz) that was saved and kept at the customer site.
• User name and password of the machine administrator account for each target device.
83
4. Updating Licenses
Action:
• Make sure that the target devices are not used by the customer during the following
operation.
2. You can update licenses from the Device List screen or the Quick Installation screen.
Updating licenses from the Quick Installation screen:
Launch Remote Install Manager and click [Update License] on the Quick Installation screen.
84
Online: Updating Licenses
• To refer to a product key used previously, click [Browse Previous Value]. Select the product
key to use and click the [OK] button.
85
4. Updating Licenses
6. Select the check boxes for the devices in which to update the licenses.
86
Online: Updating Licenses
87
4. Updating Licenses
8. When the downloading, installation or activation is complete, click the [Finish] button.
• If a result other than [Completed] is displayed in [Status], right-click on the device column and
select [Display Result(s)] to view a description of the error and ways to correct it.
9. Check the target device in the Device List screen, and then check if the “License update” of the
target has been completed.
88
Online: Updating Licenses
89
4. Updating Licenses
Work Flow
90
Offline: Updating Licenses
This procedure shows how to update a Trial Version License or term license of a device in an offline
environment.
1. Prepare as follows.
Items (Confirm with the customer):
• A PC with Remote Install Manager
• Product Keys for updating the licenses
• IP addresses and host names for target devices
• The latest Work State Archive file (*.clz) that was saved and kept at the customer site.
• User name and password of the machine administrator account for each target device.
Action:
91
4. Updating Licenses
• Make sure that the target devices are not used by the customer during the following
operation.
<Customer Site>
2. Launch the "Remote Install Manager" and open the work state archive (*clz) at the customer site.
3. Select a device to be updated in the Device List screen.
4. In the [View] menu of the Device List, select [Refresh All Items] or [Refresh Selected Items].
92
Offline: Updating Licenses
93
4. Updating Licenses
94
Offline: Updating Licenses
20. Select [2.Store License[Device]] in [Update License] under the [Offline Operations] menu.
95
4. Updating Licenses
4
• The Select Device to Install screen appears.
21. Click the [Next] button.
• Update of the license starts, and then the Process Completion screen appears.
22. Click the [Finish] button.
96
Offline: Updating Licenses
23. Save a work state archive (*clz), and ask the customer to keep it.
97
4. Updating Licenses
98
5. Updating Software
• This function will work only if newer version software is stored in the Component Server.
Work Flow
1. Prepare as follows.
Items (Confirm with the customer):
• A PC with Remote Manager Installer
• IP addresses and host names for target devices, in which the software should be updated.
99
5. Updating Software
• The latest Work State Archive file (*.clz) that was saved and kept at the customer site.
• User name and password of the machine administrator account for each target devices.
Action:
• Check if the firmware (e.g. system module) of target devices is the latest version.
If not, update the firmware.
• Make sure that the target devices are not used by the customer during the following
operation.
2. Launch "Remote Install Manger" and open the latest work state archive (*clz).
3. On the Device List screen, select the device on which the software to be updated is installed.
100
Online: Updating Software
5
• Remote Install Manager searches for software for which updated software is available.
101
5. Updating Software
5
• The Version Consistency column for each software item indicates whether version
matching is required for it.
• If any one of the software programs requires version matching, a warning is displayed.
6. Click the [OK] button after a pop-up dialog for confirmation appears.
102
Online: Updating Software
103
5. Updating Software
5
• Right-click on the device column and select [Display Result(s)] to view a description of the
error and ways to correct it.
7. Check the contents and click the [Finish] button.
8. Double-click the target device in the Device List screen, and then check if the target software has
been updated with WIM.
104
Offline: Updating Software
Work Flow
1. Prepare as follows.
Items (Confirm with the customer):
• A PC with Remote Install Manager
• Updated software
• IP addresses and host names for target devices
105
5. Updating Software
• The latest Work State Archive file (*.clz) that was saved and kept at the customer site.
• User name and password of the machine administrator account for each target device.
Action:
• Make sure that the target devices are not used by the customer during the following
operation.
<Customer Site>
2. Launch "Remote Install Manager" and open the work state archive (*clz) at the customer site.
3. Select a device to be updated in the Device List screen.
• Multiple devices can be selected.
• Click [Select All] or [Deselect All] to select or deselect all of the devices displayed.
4. Select [Update Software[Local File]] in [Update License] under [Offline Operations].
106
Offline: Updating Software
5
• The confirmation screen appears.
7. The main screen automatically returns to the Device List screen after completing software updating.
• Check if the operation result in the Device List is “Completed”.
8. Save a work state archive (*clz).
107
5. Updating Software
108
6. Uninstallation/Deactivation
Online: Uninstallation/Deactivation
Purpose:
• Deactivate and uninstall SDK software from devices due to replacement of the device or
termination of the contract, etc.
Important Notices
About Uninstallation/Deactivation 6
Uninstallation from the operation panel or WIM cannot be allowed because deactivation operation
must be done before uninstallation. If you do so, some special operation is required to recover the lost
volume license.
Work Flow
109
6. Uninstallation/Deactivation
Uninstallation/Deactivation Procedure
1. Prepare as follows.
Items (Confirm with the customer):
• A PC with Remote Install Manager
• Product Keys for which the software should be uninstalled/deactivated.
• IP addresses and host names for target devices in which the software should be uninstalled/
deactivated.
• The latest Work State Archive file (*.clz) that was saved and kept at the customer site.
• User name and password of the machine administrator account for each target device.
Action:
• Make sure that the target devices are not used by the customer during the following
operation.
2. Launch the "Remote Install Manager" and open the latest work state archive file (*clz).
3. In the Product Key List screen, select the product key to be uninstalled.
6
• If the target product key does not appear in the Product Key List screen, add it from [Add] in
the [Product Key Operation] menu in the Product Key List screen. You can do this by manually
entering the product key from [Manual Entry] of [Add] or by importing the relevant csv file
(must be exported in advance) from [Specify from File] of [Add].
• The target device must be added to the device list beforehand. So if the target device does not
appear in the Device List screen, add it from [Add] in the [Device Operation] menu in the
Device List screen. You can do this by manually entering the host name or IP address of the
target device from [Manual Entry] of [Add] or by importing the relevant csv file (must be
exported in advance) from [Specify from File] of [Add].
4. In the [Product Key Operation] menu, select [Uninstall].
110
Online: Uninstallation/Deactivation
5. Select the check boxes for the devices from which to uninstall the software.
111
6. Uninstallation/Deactivation
112
Online: Uninstallation/Deactivation
• If a result other than [Completed] is displayed in [Status], right-click on the device column and
select [Display Result] to view a description of the error and ways to correct it.
8. In the Tree View of the Product List screen, select [Device List] to display the Device List screen.
• You can check the result of the uninstallation operation in [Last Operation] and [Operation Result]
of the List View or by double-clicking the target device in the Device List screen with WIM.
113
6. Uninstallation/Deactivation
Offline: Uninstallation/Deactivation
Purpose:
• Deactivate and uninstall SDK software from devices due to replacement of the device or
termination of the contract, etc.
114
Offline: Uninstallation/Deactivation
Work Flow
115
6. Uninstallation/Deactivation
Uninstallation/Deactivation Procedure
1. Prepare as follows.
Items (Confirm with the customer):
• A PC with Remote Install Manager
• Product Keys for which the software should be uninstalled/deactivated.
• IP addresses and host names for target devices in which the software should be uninstalled/
deactivated.
• The latest Work State Archive file (*.clz) that was saved and kept at the customer site.
• User name and password of the machine administrator account for each target device.
Action:
• Make sure that the target devices are not used by the customer during the following
operation.
<Customer Site>
2. Launch "Remote Install Manager" and open a work state archive (*clz).
6 3. Select the product key for the installed software in the target device.
4. Select [1.Deactivate&Uninstall[Device]] in [Uninstall] under [Offline Operations].
5. Select the check boxes for the devices on which to uninstall the software.
116
Offline: Uninstallation/Deactivation
117
6. Uninstallation/Deactivation
• If a result other than [Processing offline] is displayed in [Status], right-click on the device
column and select [Display Result(s)] to view a description of the error and ways to correct it.
8. Save a work state archive (*clz).
9. Move to an online environment to get the internet access.
<Internet Environment>
10. Launch "Remote Install Manager" and open the work state archive (*clz) at the customer site.
• The "Operation Instruction Message" pop-up appears.
11. Click the [OK] button.
118
Offline: Uninstallation/Deactivation
119
6. Uninstallation/Deactivation
• If a result other than [Completed] is displayed in [Operation Results], right-click on the device
column and select [Display Result(s)] to view a description of the error and ways to correct it.
17. Save a work state archive (*clz), and ask the customer to keep it.
120
7. Other Operations
Offline Operations
The menus under Offline Operations are mainly used for devices located in the no-internet connection
environment.
These menus are the following:
• Update Java VM
• Change Heap/Stack Size
• Install [2-visit course]
• Update License
• Update Software
Update Java VM
This menu updates the Java VM on the devices (offline), in order to update Java VM to convert the
current version to a new version.
7
Updating Procedure
1. Launch "Remote Install Manger" and open the latest work state archive (*clz), or add devices with
the [Add] menu under [Device Operation].
2. On the Device List screen, select the device on which the Java VM to be updated is installed.
121
7. Other Operations
• If you want to refresh the Device List, select [Refresh All Items] or [Refresh Selected Items] in
the [View] menu of the Device List. The necessary time to refresh all devices differs depending
on the number of registered devices.
4. Select an updated firmware file (*.ifu), and then click the [Open] button.
122
Offline Operations
123
7. Other Operations
This menu changes the Heap/Stack size for each device if the installation or updating of software is
done in a no-internet connection (offline) environment.
1. Launch the "Remote Install Manger" and open the latest work state archive (*clz) or add devices
with the [Add] menu under the [Device Operation].
2. On the Device List screen, select the device for which changing Heap/Stack Size is required.
• If you want to refresh the Device List, select [Refresh All Items] or [Refresh Selected Items] in
the [View] menu of the Device List. The necessary time to refresh all devices differs depending
on the number of registered devices.
124
Offline Operations
4. Enter the correct value for the [Heap size] and [Stack size].
• Check the correct value for the combination of software to be installed.
125
7. Other Operations
6. Check the Heap and Stack size of the target device in the Device List screen.
126
8. Troubleshooting
Troubleshooting Guide
Error Code List
• For error codes displayed on the [Display Results] screen, follow the operations shown on the
screen for [Handling Method].
• “RIM” stands for Remote Install Manager.
ERR-004 Error from a device Check the device status at the customer site.
Failure or incompletion of
downloading from the Activation or Check the network condition.
ERR-008 Component Server due to network Stop other applications on your PC, and
problem or insufficient memory on a then reboot your PC and RIM.
PC
127
2(Nkhn[e^lahhmbg`
=hgg^\mbhg^kkhkmhl^ko^kl]n^mh
_heehpbg`\Znl^l
Ư Qkhg`ikhqrl^mmbg`l
Ư =hgg^\mbhgCgm^kknimbhg[r
_bk^pZeelh_mpZk^ >hma^\hkk^\m\hngm^kf^Zlnk^_hk^Z\a
?LL'*+*
Ư =hgg^\mbhgihkm"..-#\ehl^] \Znl^(
Ư =hgg^\mbhg^kkhkmhl^ko^kl]n^mh
g^mphkdikh[e^f
Ư Qkhg`l^ko^kbg_hkfZmbhghgƪbgbƫ
_be^
• Check if free space exists in HDD.
• License file write error
• Check if the folder where RIM has
ERR-043 • Component data file write error been installed has restrictions for
• Received data error from servers read and write
8
RTY-001 No response from a device
the customer site.
• See p.138 "Detailed Device Error
Number List" about “Cxx” displayed
• Request error from RIM. on the pop-up window.
RTY-002
• Device error • Ask your supervisor if “Cxx” is not
displayed on the pop-up window.
RTY-004 Error from a device Check the device status at the customer site.
Check with the server maintenance section
Error with suffix [S01] from the when the maintenance for servers is
RTY-005 Activation or Component Server completed. (HTTP 500 error)
Check with the server maintenance section
Error with suffix [S01] from the when the maintenance for servers is
RTY-006 Activation or Component Server completed. (HTTP 503 error)
Note 1: To prevent the Java VM from being updated with an incompatible IFU file, perform the
Java VM update using Remote Install Manager v1.1.3 or newer. These versions can detect
whether or not the IFU file selected is compatible with Java VM in the VM card. If they are not
compatible, the update cannot be performed.
+,2
Troubleshooting Guide
RTY-014 • Component data file write error • Check if the folder where RIM has
been installed has restrictions for read
• Received data error from servers and write.
129
8. Troubleshooting
SRV-012 Failure of name resolution to DNS Check the DNS server or network
SRV-028 server condition.
130
Troubleshooting Guide
DEV-007 Device addition error to the Device List Check the Device List again.
DEV-011 Process incomplete device error Refresh incomplete devices with RIM.
131
8. Troubleshooting
RIM-001 RIM internal process error • Check if the folder where RIM has
been installed has restrictions for read
and write.
RIM-002 RIM internal process error • Check if the folder where RIM has
been installed has restrictions for read
and write.
RIM-003 Read and write restriction error • Check if the folder where RIM has
been installed has restrictions for read
and write.
RIM-005 No help file error Check if RIM has a help file installed.
132
Troubleshooting Guide
RIM-011 Work state archive file saving error • Check if the folder where RIM has
been installed has restrictions for read
and write.
Wrong entry of device administrator Enter the same password in the text boxes
RIM-012
authentication for “Password” and “Confirm Password”.
133
8. Troubleshooting
This occurs when trying to operate • Check the rest of the licenses and
devices more than licenses which a devices to be operated.
8 ERR-005
product key has. (Activation Server • Buy a new product key or uninstall
error) and deactivate other devices.
Server internal process error from the Check the Activation or Component Server
ERR-011
Activation or Component Server condition.
ERR-012 Error from the Activation Server Check the start date for license updating.
ERR-015 Error from the Activation Server Check the expiration date of the license.
134
Troubleshooting Guide
Error from the Component Server Check the software installed in the target
device. Install necessary software if
ERR-022 supported combinations of SDK
applications are not installed in the target
device.
Error from the Component Server Check the software to be installed in the 8
target device. The special modified
ERR-024
software may already be installed in the
target device.
Error from the Activation Server Check the entered product key status by
ERR-027 • Entered product key is invalided referring to the Operation UI Server.
by the Activation Server. Use another product key.
135
8. Troubleshooting
Error from the Activation Server • Use the product key which was used
in the previous operation, and then try
ERR-029 to operate again.
• To update a trial license, buy a new
product key for an updated license.
Error from the Activation Server Check the machine ID (serial number) of
ERR-030
the target device.
Server internal process error from the Wait until the operation of the Activation or
ERR-037
Activation or Component Server Component Server is recovered.
136
Troubleshooting Guide
Error from the Activation Server or • Use the product key which was used
error in RIM in the previous operation, and then try
• Other product key has been to update license again.
ERR-039
registered for the target device on • Check the Operation UI Server to
the Activation Server. Previous confirm the product key which has
license update operation may fail. been used for the target device.
Server internal process error from the Wait until the operation of the Activation
RTY-015
Activation Server Server is recovered.
137
8. Troubleshooting
8 Error at Installation
• If the software to be operated is
installed in the target device, uninstall
it from the WIM or operation panel of
the target device.
Target device can not accept SDK
• Check if the installed SD card in the
C05 application and SDK/Java platform
target device is correct or the installed
package.
SD card is not write-protected.
Error at Offline Installation
• Check if the Java VM in the target
device is the version supported by
eDC-i1.2.
138
Troubleshooting Guide
139
MEMO
140 EN
Operating Instructions
Installation Guide
Guides for This Solution
The following guides are available for GlobalScan NX:
GlobalScan NX Installation Guide (this guide, HTML/PDF)
This guide is intended for the Administrator and explains how to run the install/uninstall, activation
and modification programs available for the Serverless Edition and Server Edition of GlobalScan
NX. Server certificate installation procedures are also covered.
GlobalScan NX Installation Quick Reference Guide (PDF)
This reference is intended for the Administrator. It contains a summary of procedures outlined in the
GlobalScan NX Installation Guide.
GlobalScan NX Administrator's Guide (HTML/PDF)
This guide is intended for the Administrator. It explains how to utilize GlobalScan NX AdminTool to
configure and manage settings and operations, for example, creation of Profiles, Groups/Projects,
and Flows, as well as the selection of Services/Filters.
GlobalScan NX Administrator's Quick Reference Guide (PDF)
This reference is intended for Administrators. It contains a summary of procedures outlined in the
GlobalScan NX Administrator's Guide.
GlobalScan NX User's Guide (HTML/PDF)
This guide is intended for the end user. It explains how to perform walk-up scan operations from the
MFP display panel, for example, Send to Email, Send to Folder, and Send to FTP.
GlobalScan NX User's Quick Reference Guide (PDF)
This reference is intended for the end user. It contains a summary of how to perform walk-up scan
operations from the GlobalScan NX-enabled MFP.
1
TABLE OF CONTENTS
Guides for This Solution.....................................................................................................................................1
Important.............................................................................................................................................................4
Trademarks..........................................................................................................................................................5
1. INTRODUCTION
How to Read This Guide....................................................................................................................................7
Symbols...........................................................................................................................................................7
Abbreviations..................................................................................................................................................8
2. ABOUT GLOBALSCAN NX
GlobalScan NX Feature Summary....................................................................................................................9
GlobalScan NX Editions..................................................................................................................................11
Serverless Edition.........................................................................................................................................11
Server Edition...............................................................................................................................................12
Requirements and Specifications....................................................................................................................13
Server Edition...............................................................................................................................................13
Serverless Edition.........................................................................................................................................16
Available Authentication Methods.............................................................................................................18
Available Delivery Methods and Required Environments........................................................................18
3. SOFTWARE INSTALLATION
Preparing to Install GlobalScan NX Software...............................................................................................21
Installing GlobalScan NX Software...............................................................................................................22
4. SOFTWARE INSTALLATION MODIFICATION
Preparing to Modify GlobalScan NX Software............................................................................................31
Modifying GlobalScan NX Software.............................................................................................................32
Synchronizing the System................................................................................................................................39
5. SOFTWARE ACTIVATION
Activating GlobalScan NX Software..............................................................................................................41
6. SOFTWARE UNINSTALL
Uninstalling GlobalScan NX Software...........................................................................................................45
7. APPENDIX
Activity Directory Authentication..........................................................................................47
2
GlobalScan NX PC/Server - Date & Time Setting...................................................................................49
GlobalScan NX PC/Server - DNS Server IP Address Setting.................................................................50
MFP - Date & Time Setting..........................................................................................................................51
MFP - DNS Server IP Address Setting........................................................................................................51
Managing the Server Certificate.....................................................................................................................53
Obtaining and Installing a Server Certificate............................................................................................54
IIS - SSL On/Off..........................................................................................................................................61
Managing the Site Certificate.........................................................................................................................64
Managing the Private Keys.........................................................................................................................66
GlobalScan NX Software Upgrade Procedures...........................................................................................67
Step 1 : Execute Backup in Serverless Edition...........................................................................................67
Step 2 : Uninstall Serverless Edition...........................................................................................................67
Step 3 : Install Server Edition Software......................................................................................................67
Step 4 : Execute Upload/Restore/Synchronize in Server Edition..........................................................67
Glossary of Terms.............................................................................................................................................69
INDEX.............................................................................................................................................................71
3
Important
• To the maximum extent permitted by applicable laws, in no event will the manufacturer be liable for
any damages whatsoever arising out of failures of this product, losses of documents or data, or the
use of this product and operation manuals provided with it.
• Make sure that you always copy or have backups of important documents or data. Documents or
data might be erased due to your operational errors or malfunctions of the machine. Also, you are
responsible for taking protective measures against computer viruses, worms, and other harmful
software.
• In no event will the manufacturer be responsible for any documents created by you using this
product or any results from the data executed by you.
• Some illustrations or explanations in this guide may differ from your product due to improvement or
change in the product.
• Contents of this document are subject to change without notice.
• No part of this document may be duplicated, replicated, reproduced in any form, modified or
quoted without prior consent of the supplier.
4
Trademarks
Adobe, Acrobat, Acrobat Reader, Flash, Macromedia, and Reader are either registered trademarks or
trademarks of Adobe Systems Incorporated in the United States and/or other countries.
Microsoft, Windows, Windows Server, and Windows Vista are either registered trademarks or
trademarks of Microsoft Corporation in the United States and/or other countries.
VMware and VMware ESX Server are registered trademarks or trademarks of VMware Inc.
Firefox is a registered trademark of the Mozilla Foundation.
Linux is a registered trademark of Linus Torvalds.
Novell, NetWare, NDS and NDPS are registered trademarks of Novell, Inc.
Sendmail is a trademark or registered trademark of Sendmail, Inc.
Other product names used herein are for identification purposes only and might be trademarks of their
respective companies. We disclaim any and all rights to those marks.
Microsoft product screen shots reprinted with permission from Microsoft Corporation.
5
• The product names of Windows Server 2008 R2 are as follows:
Microsoft® Windows Server® 2008 R2 Foundation
Microsoft® Windows Server® 2008 R2 Standard
Microsoft® Windows Server® 2008 R2 Enterprise
Microsoft® Windows Server® 2008 R2 Datacenter
Microsoft® Windows Server® 2008 R2 for Itanium-based Systems
Microsoft® Windows® Web Server 2008 R2
Microsoft® Windows® HPC Server 2008 R2
Other product names used herein are for identification purposes only and might be trademarks of their
respective companies. We disclaim any and all rights to those marks.
6
1. INTRODUCTION
This guide is intended for the System Administrator and explains how to run the install/uninstall,
activation and modification programs available for the Serverless Edition and Server Edition of
GlobalScan NX. Server certificate installation procedures are also covered, should you wish to secure
communication between the Web browser and MFP. GlobalScan NX is a secure document capture and
distribution solution that enables users of a compatible multifunctional device (MFP) to perform a wide
range of network scanning functions. As a convenient electronic routing system, GlobalScan NX enables
users to seamlessly merge paper documents into an electronic workflow.
• Keep the GlobalScan NX Installation media in a safe place for future reference.
Symbols
The following symbols are used in the guide to help you to identify content quickly.
This symbol indicates points to pay attention to when using the application.
This symbol indicates supplementary information that you may find helpful, but not essential to
completing a task.
This symbol indicates where you can find further relevant information.
This symbol indicates numerical limits, functions that cannot be used together, or conditions in which a
particular function cannot be used.
[]
This symbol indicates the name of buttons and fields displayed on the computer screen or keys on the
MFP control panel.
7
1. INTRODUCTION
Abbreviations
Product/Name Abbreviation
8
2. ABOUT GLOBALSCAN NX
GlobalScan NX bridges the gap between hardcopy and electronic workflows by enabling a network-
connected MFP to convert paper documents, such as contracts, invoices, and brochures, into easily
shared digital images. Once in electronic form, the file can be delivered to customers, clients, and
colleagues, either around the corner or around the globe. GlobalScan NX can process and deliver
documents scanned by the MFP and documents received by fax.
9
2. ABOUT GLOBALSCAN NX
BMA003S
10
GlobalScan NX Editions
GlobalScan NX Editions
Designed as a pluggable and scalable software solution, GlobalScan NX is available in Serverless and
Server Editions, allowing you to implement a document management solution that fits your
organization's system integration and budgetary requirements.
Serverless Edition
GlobalScan NX Serverless Edition enables control of connected MFPs without the need for a dedicated
server PC, thus there is no overhead associated with network server integration. All Services and related
processes necessary for document distribution are performed within the MFP(s).
BMA002S
11
2. ABOUT GLOBALSCAN NX
Server Edition
GlobalScan NX Server Edition supports the configuration and management of up to 750 MFPs (for the
Enterprise Server Edition) or 32 MFPs (for the Business Server Edition). The Server Edition offers the most
advanced feature-set for document capture and distribution, including additional Filters and file formats,
as well as value-added options that are not supported by the Serverless Edition.
The Server Edition requires a dedicated Server PC to maintain all the system settings and data necessary
for document indexing and distribution. All Services and related processes necessary for document
distribution are performed by the Server PC.
BMA003S
12
Requirements and Specifications
Server Edition
To install GlobalScan NX server application and AdminTool, the server computer must meet the
following system requirements:
• Do not install other products on the same computer in which GlobalScan NX server application
and AdminTool are installed.
Main unit
• PC/AT compatible
CPU
• Xeon 5000 or faster recommended
RAM
• 2.0 GB recommended
Hard Disk Space
• 1.0 MB recommended for software
• 2.0 GB recommended for data
Operating Systems
• Microsoft Windows Server 2003 Standard Edition (32bit / 64bit uses WOW64)
• Microsoft Windows Server 2003 Enterprise Edition (32bit / 64bit uses WOW64)
• Microsoft Windows Server 2003 R2 Standard Edition (32bit / 64bit uses WOW64)
• Microsoft Windows Server 2003 R2 Enterprise Edition (32bit / 64bit uses WOW64)
• Microsoft Windows Server 2008 Standard (32bit / 64bit uses WOW64)
• Microsoft Windows Server 2008 Enterprise (32bit / 64bit uses WOW64)
• Microsoft Windows Server 2008 R2 Standard
13
2. ABOUT GLOBALSCAN NX
14
Requirements and Specifications
• If there is a firewall between server and clients, set it to make the communication port
available.
To browse AdminTool, the computer must meet the following system requirements:
CPU
• Core 2 duo 2 GHz or faster recommended
Operating Systems
• Microsoft Windows XP Professional (32-bit version only)
• Microsoft Windows Vista Business (32-bit version only)
• Microsoft Windows Vista Enterprise (32-bit version only)
• Microsoft Windows Vista Ultimate (32-bit version only)
• Microsoft Windows Server 2003 Standard Edition (32bit / 64bit uses WOW64)
• Microsoft Windows Server 2003 Enterprise Edition (32bit / 64bit uses WOW64)
• Microsoft Windows Server 2003 R2 Standard Edition (32bit / 64bit uses WOW64)
• Microsoft Windows Server 2003 R2 Enterprise Edition (32bit / 64bit uses WOW64)
• Microsoft Windows Server 2008 Standard (32bit / 64bit uses WOW64)
• Microsoft Windows Server 2008 Enterprise (32bit / 64bit uses WOW64)
• Microsoft Windows Server 2008 R2 Standard
• Microsoft Windows Server 2008 R2 Enterprise
Web Browser
• Microsoft Internet Explorer 8 (except for 64 bit version)
• Microsoft Internet Explorer 9
• Firefox 9.0.1
15
2. ABOUT GLOBALSCAN NX
Serverless Edition
To install AdminTool, the computer must meet the following system requirements:
Main unit
• PC/AT compatible
CPU
• Core 2 Duo 2 GHz or faster recommended
RAM
• 2.0 GB recommended
Hard Disk Space
• 1.0 MB recommended for software
• 2.0 GB recommended for data
Operating Systems
• Microsoft Windows XP Professional (32-bit version only)
• Microsoft Windows Vista Business (32-bit version only)
• Microsoft Windows Vista Enterprise (32-bit version only)
• Microsoft Windows Vista Ultimate (32-bit version only)
• Microsoft Windows 7 Professional (32-bit version only)
• Microsoft Windows 7 Enterprise (32-bit version only)
• Microsoft Windows 7 Ultimate (32-bit version only)
• Microsoft Windows Server 2003 Standard Edition (32bit / 64bit uses WOW64)
• Microsoft Windows Server 2003 Enterprise Edition (32bit / 64bit uses WOW64)
• Microsoft Windows Server 2003 R2 Standard Edition (32bit / 64bit uses WOW64)
• Microsoft Windows Server 2003 R2 Enterprise Edition (32bit / 64bit uses WOW64)
• Microsoft Windows Server 2008 Standard (32bit / 64bit uses WOW64)
• Microsoft Windows Server 2008 Enterprise (32bit / 64bit uses WOW64)
• Microsoft Windows Server 2008 R2 Standard
• Microsoft Windows Server 2008 R2 Enterprise
16
Requirements and Specifications
• It is also possible to install AdminTool on the operating systems listed above that run on VMWare
ESX Server 4.1 / 5.0.
Web Server
The Built-in Web Server is automatically installed by selecting [Built-in Web Server (Default)]
during installation of AdminTool.
In addition to the Built-in Web Server, the following versions of Microsoft Internet Information
Services are also supported.
• Microsoft Internet Information Services 6.0
• Microsoft Internet Information Services 7.0
• Microsoft Internet Information Services 7.5
• If you want to use Microsoft Internet Information Services, it is necessary to set up Microsoft
Internet Information Services on the PC before installing AdminTool.
• IIS must be running on a PC running a server edition of Windows.
• If you have installed Admin Tool on one of the following operating systems, IIS cannot be
used.
• Windows XP Professional
• Windows Vista Business/Enterprise/Ultimate
• Windows 7 Professional/Enterprise/Ultimate
Network Protocol
• TCP/IP
Communication Port
To use AdminTool, the following ports must be available.
• Port for HTTP (Default at installation: 8080(TCP))
Required to set a port number when AdminTool is installed.
• Port for HTTPS (Default at installation: 8443(TCP))
Required to set a port number when AdminTool is installed.
• If there is a firewall between server and clients, set it to make the communication port
available.
17
2. ABOUT GLOBALSCAN NX
To use AdminTool, the computer must meet the following system requirements:
Web Browser
• Microsoft Internet Explorer 8 (except for 64 bit version)
• Microsoft Internet Explorer 9
• Firefox 9.0.1
Authentication methods available for GlobalScan NX and the environment required to use GlobalScan
NX are as follows:
Active Directory Authentication
• Active Directory (Microsoft Windows Server 2003/Microsoft Windows Server 2008)
LDAP Authentication
• Active Directory (Microsoft Windows Server 2003/Microsoft Windows Server 2008)
• Novell Directory Service
• OpenLDAP 2.0
• Lotus Domino 6.5/7.0/8.0/8.5
The table below lists the delivery types that are available and the environments they require.
18
Requirements and Specifications
19
2. ABOUT GLOBALSCAN NX
20
3. SOFTWARE INSTALLATION
This chapter explains how to install GlobalScan NX Server Edition or Serverless Edition software. After
installation is complete, you will be able to launch the GlobalScan NX AdminTool and begin
configuring and managing the connected MFP(s).
• After software installation, the Administrator must configure the necessary network settings and
Distribution Parameters to support scan functionality on the GlobalScan NX-enabled MFP(s).
• You must log on to the computer you will install the software on using an account that has
administrator privileges.
• MFPs’ Auto-Off Timer needs to be set to 5 minutes or longer as long as GlobalScan NX is installed.
This limitation is caused by the way applications are loaded on MFPs. If an MFP enters sleep mode
before an application and its associated software finish starting up, the MFP might not work
correctly.
21
3. SOFTWARE INSTALLATION
• Auto Run may not work with certain operating system settings. If this happens, launch
"RDLaunch.exe" in installation media.
3. Click the component(s), you wish to install, Serverless Edition [AdminTool] or Server
Edition [Application & AdminTool].
The language selection screen displays.
• The default language is determined by the Operating System. If the Operating System
language is not supported, English is used.
• Supported languages include English, German, French, Italian, Spanish, and Dutch.
22
Installing GlobalScan NX Software
• If GlobalScan NX software of the same edition has already been installed, an alert message
displays. Before proceeding, see p.31 "SOFTWARE INSTALLATION MODIFICATION".
• If any of the following conditions exist, an error message will display. Click [Cancel] to Exit the
installation.
• You attempt to install the Serverless Edition in a Server Edition environment.
• Current login user does not have administrative privileges.
• GlobalScan NX is currently running on the PC.
• Operating System is not supported. If the Operating System Check screen displays, the
Operating System you are attempting to install the GlobalScan NX software on is not
supported.
6. Read the licensing agreement, select "I accept the terms ...", and then click [Next].
If you do not accept terms of the agreement, you cannot proceed.
23
3. SOFTWARE INSTALLATION
7. Enter the Installation Folder and Data Path, and then click [Next].
The Installation Folder is where the GlobalScan NX software resides. The Data Path is where the
GlobalScan NX system setting data resides. To specify a different path, click the associated
[Browse] button, and select a new path.
• If the installation path is incorrect, an error message will appear. Click [OK], and then specify
a valid path. An invalid path error can occur under any of the following conditions:
• The specified folder is not empty.
• When you are performing an overwrite installation, the specified folder contains files
other than the activation file.
• The length of the specified path exceeds the maximum allowed length of a path.
• The amount of free space on the specified drive is not sufficient to perform the installation.
• The specified path contains an unusable string.
• If GlobalScan NX was previously installed, a message will inform you that the directory
already exists. Follow the on-screen instructions.
8. Specify the Starting Mode, and then click [Next].
The Starting Mode check box specifies the GlobalScan NX Server's Running/ Suspended status for
job processing. Select the check box and GlobalScan NX will start delivery service immediately
after the PC (running the GlobalScan NX application) is turned on. If necessary, the Starting mode
can be changed from the AdminTool after installation.
24
Installing GlobalScan NX Software
• The [Setup Type] screen shown above will only display during installation of GlobalScan NX
Server Edition. If you are installing GlobalScan NX Serverless Edition, this screen will not
appear.
9. To install a template Project, select the [Install the template] check box, and then click
[Next].
Installing a template Project allows you to use GlobalScan NX's basic delivery services
immediately after the installation.
• The option of installing the template is only available the first time you install GlobalScan NX;
it is not available when you perform an overwrite or modification installation. When you
perform an overwrite or modification installation, existing Project data is used.
• The StartPoint Path in the template Project is pre-configured with the following settings:
• [Path]: "GSNX"
• [User Name]: "User Name" (When [Proxy User] is selected as the authentication
method.)
For details about these settings, see the GlobalScan NX Administrator's Guide.
25
3. SOFTWARE INSTALLATION
• If you are installing GlobalScan NX on a server running Windows 2008, and you want to use
IIS 7.0 as the Web server, you must also have installed ISAPI extensions and ISAPI filters for
IIS. If these have not been installed, "Internet Information Service" will not appear as an option
during installation.
26
Installing GlobalScan NX Software
27
3. SOFTWARE INSTALLATION
• To halt the installation process, click [Interrupt]. The File Copy Start screen displays. Click
[Next] to resume the installation.
• To cancel the installation, click [Cancel]. Click [Yes] to exit the installation program. Click [No]
to resume installation.
28
Installing GlobalScan NX Software
• If you must restart the computer, a restart confirmation message will appear. Click [OK] to
proceed with the restart.
• If you want to use the failover or load balancing functions, it is necessary to install the GlobalScan
NX software on additional PCs. For details about the failover and load balancing functions, see
GlobalScan NX Administrator's Guide.
• Several optional plug-ins are included in the Options folder on the GlobalScan NX installation
media. To install the plus-ins, run [GSLaunch] from the GlobalScan NX installation media, and then
follow the instructions that appear.
29
3. SOFTWARE INSTALLATION
30
4. SOFTWARE INSTALLATION
MODIFICATION
This chapter explains how to modify installed GlobalScan NX software settings, specifically the web
server, port number, and virtual directory. The procedures are the only way to change these settings.
• After modifying the installation, the Administrator must perform a synchronization of the PC/Server
with the MFP(s).
• You must log on to the computer you will perform the installation on using an account that has
administrator privileges.
• An Installation Modification is not necessary to change the Built-in Password or the Auto On/Off
for delivery service setting.
31
4. SOFTWARE INSTALLATION MODIFICATION
• If you are reconfiguring the port number, virtual directory, or web server, make sure that the
[Delete data path] check box is cleared on the Uninstall screen (step 5 in the uninstallation
procedure). Doing this will allow the current settings to be carried over when you re-install
GlobalScan NX.
• Keep a record of the path to the settings folder. You will need this path in step 8.
• Auto Run may not work with certain operating system settings. If this happens, launch
"RDLaunch.exe" in installation media.
4. Click the version of GlobalScan NX to modify, Serverless Edition [AdminTool] or Server
Edition [Application & AdminTool].
The Language Selection screen displays.
32
Modifying GlobalScan NX Software
• The default language is determined by the Operating System. Supported languages include
English, German, French, Italian, Spanish, and Dutch.
The Welcome screen displays.
6. To proceed with the installation, click [Next].
To exit the installation program, click [Cancel].
7. Read the licensing agreement, select "I accept the terms...", and then click [Next].
If you do not accept terms of the agreement, you cannot proceed.
33
4. SOFTWARE INSTALLATION MODIFICATION
8. In [Data Path:], enter the same path to data folder that you used in the previous
installation, and then click [Next].
• A warning message will appear, indicating that the data path already exists. Click [OK] to
continue.
• In [Installation Folder:], if you select a different installation path from your previous installation,
you will need to perform activation again.
• An error message will appear if the folder specified in [Installation Folder:] contains files other
than those necessary for the modification installation.
9. Specify the Starting mode, and then click [Next].
The Starting Mode check box specifies the GlobalScan NX Server's Running/ Suspended status for
job processing. Select the check box and GlobalScan NX will start delivery service immediately
after the PC (running the GlobalScan NX application) is turned on. If necessary, the Starting mode
can be changed from the AdminTool after installation.
• The [Setup Type] screen shown above only displays during re-installation of GlobalScan NX
Server Edition. If you are re-installing GlobalScan NX Serverless Edition, this screen will not
appear.
34
Modifying GlobalScan NX Software
35
4. SOFTWARE INSTALLATION MODIFICATION
36
Modifying GlobalScan NX Software
• To halt the installation process, click [Interrupt]. The File Copy Start screen displays. Click
[Next] to resume the installation.
• To cancel the installation, click [Cancel]. Click [Yes] to exit the installation program. Click [No]
to resume the installation process.
17. Click [Finish].
37
4. SOFTWARE INSTALLATION MODIFICATION
• If you must restart the computer, a restart confirmation message will appear. Click [OK] to
proceed with the restart.
• If you were using SSL, you need to configure SSL again. If you run SSL Certificate Setting Tool, SSL
will be selected, but you still need to perform the SSL settings again. However, you do not need to
reimport certificates. For details, see p.61 "IIS - SSL On/Off".
• If you are using the failover or load balancing functions, you must modify the installation on each
server. Make sure that you select the same options when modifying the installation. If you select
different options, the failover/load balancing functions will not work. For details about the failover
and load balancing functions, see GlobalScan NX Administrator's Guide.
38
Synchronizing the System
• In order to use GlobalScan NX, it is necessary to install the GlobalScan NX application on the
MFP. An authorized service provider installs and activates application.
There are four conditions when the Administrator must synchronize the GlobalScan PC/Server and
connected MFP(s):
• Software Installation Modification
After performing an Installation Modification, whereby you reinstall the GlobalScan NX software.
This is necessary if you must change the Web Server, Port Number, and/or Virtual Directory. In
addition, this is the only way to change the Built-in Password or Auto On/Off for delivery service
settings.
• System Recovery
39
4. SOFTWARE INSTALLATION MODIFICATION
3. To select all MFPs in the list, click the check box located in the first row/column.
4. Click [Synchronize].
• Synchronization occurs sequentially, device by device, thus if an error should occur attempting to
synchronize a particular machine, an error screen will display. To continue synchronization on the
next device, click [OK] or [Cancel] to exit.
• To determine the status of synchronization, check the System Log.
40
5. SOFTWARE ACTIVATION
Before you can use GlobalScan NX Server Edition and certain plug-ins, you must first obtain a License
Code and then activate the GlobalScan NX software. The License Code is required for new installations
only.
To complete the activation process, you must have the Product Key that is printed on the purchased
product certificate. Without the certificate, online product registration cannot be performed.
The GlobalScan NX Locking Code and Activation Method screen displays. Please write down the
Locking Code and keep in a safe place.
41
5. SOFTWARE ACTIVATION
• If the computer cannot connect to the Internet, access the following URL using a different
computer, and then acquire the License Code. Then set the Activation Method to [Enter license
code], and register the License Code you receive.
• https://www.onlineactivation.net
3. The privacy statement screen appears.
4. From the drop-down list, select the language you want to use for the activation.
5. Click [Help] to download the activation guide.
6. Follow the procedures in the activation guide to register user information and receive a
License Code.
7. Copy and paste the License Code into the Activation Tool running on the PC.
9. Click [Finish].
10. Reboot the GlobalScan NX server.
42
Activating GlobalScan NX Software
11. Log in to AdminTool, and then synchronize the GlobalScan NX server and registered
MFPs. For details, see p.39 "Synchronizing the System".
12. Restart the registered MFPs.
• If you want to use the failover or load balancing functions, you must activate the GlobalScan NX
software for each server. For details about the failover and load balancing functions, see
GlobalScan NX Administrator's Guide.
• There is a 45-day trial period for GlobalScan NX and its options after installation. If you intend to
continue using this software, perform activate it during the trial period.
43
5. SOFTWARE ACTIVATION
44
6. SOFTWARE UNINSTALL
This chapter explains how to remove GlobalScan NX software from a PC running the Serverless Edition
or Server Edition.
• You must log on to the computer you will perform the uninstallation on using an account that has
administrator privileges.
• Before you uninstall an optional plug-in, make sure that the plug-in has been removed from all
delivery flows. The plug-in must be deleted from every flow before you uninstall it.
• If you are reconfiguring the port number, virtual directory, or web server, make sure the [Delete
data path] check box is cleared on the Uninstall screen (step 5). Doing this will allow the current
settings to be carried over when you re-install GlobalScan NX.
• If you are reconfiguring system settings other than those mentioned above, make sure the [Delete
data path] check box is selected on the Uninstall screen (step 5).
When the checkbox is selected, all relevant files, including shortcuts, except data related to
activation will be uninstalled.
• If you clear the [Delete data path] check box, you can reuse your settings data if you install
GlobalScan NX again.
45
6. SOFTWARE UNINSTALL
• When the message prompting you to confirm the uninstallation appears, click [Yes] to
continue or [No] to cancel the uninstallation.
6. Click [Finish].
• If you are using the failover or load balancing function, you must uninstall the GlobalScan NX
software from each server. For details about the failover and load balancing functions, see
GlobalScan NX Administrator's Guide.
46
7. APPENDIX
• If you want to use the failover or load balancing functions, the two following settings must be the
same for both the Primary Delivery Server and the Secondary Delivery Server/Load Balance
Servers:
• DNS Server IP address
• Date/time setting
• For details about the failover and load balancing functions, see GlobalScan NX Administrator's
Guide.
1. From the desktop, right-click on the time setting (lower right of the taskbar).
2. Click [Adjust Date/Time].
3. Confirm or adjust [Date & Time] and [Time Zone].
47
8. APPENDIX
1. From the desktop, for example, click [Start] > [Control Panel] > [Network Connections] >
[Local Area Connection].
2. Click [Properties].
6. Click [OK].
48
Active Directory Authentication
1. At the MFP control panel, press [User Tools/Counter] > [System Settings] > [Timer
Settings] tab.
2. Press [Set Date] and enter the date via the 10-keypad.
3. Press [OK].
4. Press [Set Time] and enter the time via the 10-keypad.
5. Press [OK], and then [Exit].
1. At the MFP control panel, press [User Tools/Counter] > [System Settings] > [Interface
Settings] tab > [DNS Configuration].
49
8. APPENDIX
52
Managing the Server Certificate
• When using SSL, it is not necessary to install certificates on registered MFPs, as the VM card
contains a self-certified web server.
• A maximum of two server certificates can be managed per PC.
• If IIS is specified as the Web server for GSNX, only the On/Off feature is provided. See p.61
"IIS - SSL On/Off".
• If you will be using the failover or load balancing functions and want to protect the data, you must
install server certificates on the servers that you will use for these functions.
• When SSL is used, the URL of the AdminTool must be specified as follows:
https://FQDN:PortNo/DirectoryName/
Use the same URL that was entered for the Common Name [CN] by the Administrator. For details,
see GlobalScan NX Administrator's Guide.
53
8. APPENDIX
BMA072S
If the Built-in Web Server (Default) is selected during GlobalScan NX software installation, the Web
Server is automatically installed on the PC, along with a shortcut to the Server Certificate Setting Tool.
Use this tool to obtain and install a server certificate.
• The Server Certificate Setting Tool is not available to remote PCs, i.e., it can only start from the
Web browser on the PC running GlobalScan NX software.
1. Click [Start] > [All Programs] > [GlobalScan NX] > [GlobalScan NX SSL Setting Tool].
You can also double - click the [GlobalScan NX SSL Setting Tool] shortcut icon on the desktop.
The Server Certificate Management screen displays.
• Unlike the AdminTool, the Server Certification Setting Tool does not require login. Therefore,
the Server Certificate Management screen displays immediately after start up.
54
Managing the Server Certificate
• The display language you chose during GlobalScan NX software installation is applied to the
Server Certification Setting Tool. Unlike the AdminTool, you cannot change the Tool's display
language.
A B C D
E
BMA021S
2. Review the table, and then continue with step 3. Please do not execute any functions until
step 3.
E [Certification] Select the certificate to use from the available certificates listed
Drop-down List in the drop-down.
Choose [Do not use] if a certificate is not used.
55
8. APPENDIX
Item Description
• Issuer
CA that issued the certificate.
• Subject
Certificate target; same as CN in following table.
• Term of Validity
Certificate expiration date.
• When you are carrying out this operation on a line whose "Certificate Status" is not
"None", you create a CSR using the existing private key. For example, in a situation
where you want to extend the use of a certificate that has expired, select the appropriate
line and follow this procedure to create a CSR again.
2. Click [Create CSR].
The Create CSR screen displays.
56
Managing the Server Certificate
• Do not abbreviate.
• Do not abbreviate.
57
8. APPENDIX
*1 Supported Characters lists the characters that are generally supported. However, as the
supported characters can vary between Certificate Authorities, you might want to check them
beforehand.
4. Click [OK].
The Create CSR screen closes.
The "Certificate Status" changes to "Requesting".
58
Managing the Server Certificate
3. Copy and paste the CSR content from the Certificate Details screen and submit it to a
Certificate Authority.
• Be sure to choose the line where you created the CSR content. If you choose the other
one, operation will not be guaranteed, even if the installation is successful.
2. Click [Install Certificate].
The Install Certificate screen displays.
59
8. APPENDIX
4. Copy the content of the intermediate CA certificate to import, and paste it to the text
area in the screen.
• Some Certificate Authorities send the certificate via email, others display the certificate in
the Web browser. For details, see the instructions provided by the CA.
• See the sample certificate obtained from a Certificate Authority by email. The text
from"-----BEGIN CERTIFICATE-----" to"-----END CERTIFICATE -----" is the certificate
content (information) you must copy and paste to the text area.
5. Click [OK].
The Create CSR screen closes. The "Certificate Status" changes to "Installed".
6. Click [Install Certificate].
The Install Certificate screen displays.
7. Confirm that the [Intermediate CA Certificates] check box is not selected.
8. Copy the content of the certificate issued using the CSR, and paste it to the text area
in the screen.
• Some Certificate Authorities send the certificate via email, others display the certificate in
the Web browser. For details, see the instructions provided by the CA.
• See the sample certificate obtained from a Certificate Authority by email. The text
from"-----BEGIN CERTIFICATE-----" to"-----END CERTIFICATE -----" is the certificate
content (information) you must copy and paste to the text area.
60
Managing the Server Certificate
9. Click [OK].
The Create CSR screen closes. The "Certificate Status" changes to "Installed".
6. Select the certificate you wish to use from the Certification drop-down list.
• You can select not to use a certificate. In that case, choose [Do not use].
7. When finished, close the Web browser.
• When you have changed the certificate, you are prompted to restart the PC/server. Please do
so.
If the IIS Web Server was specified during GlobalScan NX software installation, the screen below
displays when launching the Server Certificate Setting Tool. On this screen, SSL On/Off control is
supported.
In order to enable SSL communication, it is necessary to configure IIS as well as GlobalScan NX. The
configuration can be done through the IIS Management Tool (Internet Services Manager).
The following procedure gives a simple explanation of how to enable SSL using IIS.
61
8. APPENDIX
• The SSL setting in GlobalScan NX must first be configured before configuring the SSL setting in IIS.
• In case you first configured the SSL setting in IIS, access the following URL to set the SSL setting in
GlobalScan NX to On.
https://127.0.0.1:8443/gsnx/ssl_xx.html
Replace "xx" with your desired language code as specified below:
• English: en
• French: fr
• German: de
• Italian: it
• Dutch: nl
• Spanish: es
• After configuring the SSL setting in GlobalScan NX, you must reboot the PC to enable the new
setting.
62
Managing the Server Certificate
63
8. APPENDIX
BMA072S
• If you will be using the failover or load balancing functions, you must also import a Site Certificate
on the servers that you will use for these functions. Import the certificate before registering the
servers.
• If you would like to use Private Keys for secure Send to FTP Service, refer to the GlobalScan NX
Administrator's Guide, "Managing the Private Keys".
Supported Certificate file formats include the following:
• DER encoded binary X.509
• Base 64 encoded X.509
64
Managing the Site Certificate
6. Specify the path to the file, i.e., browse and select, for example, "sample.cer".
The Site Certificate has been successfully imported.
• To delete a Site Certificate, select (highlight) the Certificate, and then click [Delete]. Click [OK] to
confirm deletion.
65
8. APPENDIX
• Deletion of a Certificate is performed regardless of whether the Certificate is currently used or not.
When using SFTP, or Secure FTP(SSH Protocol), in the Send to FTP Service, it is necessary to import a
Private Key.
• To delete a Private Key, select (highlight) the Key, and then click [Delete]. Click [OK] to confirm
deletion.
• Selection of multiple Keys is supported as follows:
click multiple items while pressing the SHIFT key or CTRL key.
• Deletion of a Key is performed regardless of whether the Key is currently used or not.
66
GlobalScan NX Software Upgrade Procedures
• If you do not perform the download procedure, the backup data will be erased during the
uninstall procedure (Step 2).
67
8. APPENDIX
68
Glossary of Terms
Glossary of Terms
AdminTool
The AdminTool is a software utility that enables the GlobalScan NX Administrator to establish all
network and MFP configuration and management settings. An easy to navigate, Web-based
application, the AdminTool enables creation of Profiles, Groups/Projects, and Flows, as well as
the selection of Services/Filters. Once configured, GlobalScan NX-enabled MFPs can join in
network-scanning operations.
Distribution Parameter
A parameter that is set to a Service/Filter and is used for document distribution. Distribution
Parameters can be set by means of the AdminTool and/or the MFP display panel. For example, it
is possible to pre-set only the "To" address(es) and the file format by using the AdminTool and
leave the "Cc" address(es) and the Subject unset so that users can specify them from the display
panel when they scan a document.
Failover
Failover is a function where job processing switches from the Primary Delivery Server (the main
processing server) to a Secondary Delivery Server if the Primary Delivery Server fails due to a
connection error or other cause.
Filter
A Filter represents a set of criteria that defines input/output, controlling how the document is
processed. Filters are added to Projects according to application needs and may require that
additional settings be configured via the AdminTool and/or the MFP display panel.
Flow
A Flow (or Workflow) represents a document distribution process for a Project. Each Project has a
Flow that holds the details of the Services/Filters used in the Project. The Flow for each Project is
configured by the Administrator via the AdminTool.
GlobalScan NX Server Edition
The Server Edition of GlobalScan NX supports the configuration and management of up to 750
(for the Enterprise Server Edition) or 32 (for the Business Server Edition) connected devices. The
Server Edition requires that the GlobalScan NX application and AdminTool software be installed
on a PC. The Server Edition offers the most advanced feature-set for document capture and
distribution, including image enhancements and plug-ins. The Server Edition requires a dedicated
Server PC to maintain all the system settings and data necessary for distribution. All Services and
related processes necessary for document distribution are performed by the Server PC.
GlobalScan NX Serverless Edition
GlobalScan NX Serverless Edition enables control of connected MFPs without the need for a
dedicated Server PC, thus there is no overhead associated with network server integration. All
Services and related processes necessary for document distribution are performed within the
MFP(s).
69
8. APPENDIX
Group
A Group allows the Administrator to group Projects registered with a Profile. Groups are added to
a Profile by creating a new Group or editing an existing Group, as needed. For example, Projects
of a Profile can be grouped based on their job type, names, etc. Groups are useful when a Profile
has multiple registered Projects. Groups are displayed as tabs on the MFP display panel.
Load Balancing
Load balancing is a method to increase job processing efficiency by distributing jobs to several
servers. Several jobs can then be processed simultaneously, increasing the rate at which jobs are
completed.
Metadata
Metadata can be added to each scanned document. The Administrator can design Metadata for a
Project by combining available input components, such as a text box and a drop-down list. Like
Distribution Parameters, the value of each input component can be set via the AdminTool and/or
MFP display panel. The values given through the Metadata are added as document information to
the scanned document. These values can be utilized as Distribution Parameters in Services/Filters.
Profile
A Profile is a set of parameters that is applied to the MFP. These parameters are configured by the
Administrator in order to control MFP operation.
Project
A Project refers to a document distribution task, or collection of Services that are available to users,
and is configured by the Administrator to address application needs of a specific user group.
Secondary Delivery Server
When you enable the failover function, the Secondary Delivery Server processes jobs in the event
that the main server is down. If the main server fails, for example it loses its network connection,
processing is automatically switched to the Secondary Delivery Server.
Send to Email
Sends scanned images as an email message from the MFP to one or more addresses.
Send to Folder
Sends scanned images from the MFP to the specified folder(s) on a network directory.
Send to FTP
Sends scanned images from the MFP to the specified folder(s) on an FTP server.
Send to WebDAV
Sends scanned images from the MFP to the specified folder(s) on a WebDAV (Web-based
Distributed Authoring and Versioning) server.
Services
A Service represents a distribution method used during document processing. For example, the
Send to Email Service.
70
INDEX
A H
About GlobalScan NX............................................9 How to Read This Guide.........................................7
Activating GlobalScan NX...................................41 HTTP Default Port Number.............................26, 35
Active Directory Authentication............................49 Server Edition.....................................................................14
GlobalScan NX PC/Server - Date & Time Setting.........49 Serverless Edition...............................................................17
GlobalScan NX PC/Server - DNS Server IP Address HTTPS.....................................................................53
Setting.................................................................................50
HTTPS Default Port Number...........................26, 35
MFP - Date & Time Setting................................................51 Server Edition.....................................................................15
MFP - DNS Server IP Address Setting.............................. 51 Serverless Edition...............................................................17
AdminTool..............................................................39
I
Authentication Methods........................................18
Active Directory Authentication........................................18 IIS - SSL On/Off....................................................61
LDAP Authentication..........................................................18 Installation Folder and Data Path.........................24
B Internet Information Services (IIS)....14, 17, 21, 26,
35
Built-in User Password........................................... 27 IP Address Change................................................39
Built-in Web Server...............14, 17, 21, 26, 35, 54
L
C
Language Support..........................................22, 33
Certificates................................................................1 LDAP Server (Address Book)................................19
Managing the Server Certificate......................................53
License Agreement..........................................23, 33
Managing the Site Certificate...........................................64
Load Balance Server Required Settings..............49
Obtaining and Installing a Server Certificate..................54
Load Balancing.........................................29, 38, 46
Communication Port........................................14, 17
CSR Input Form......................................................56 M
D Mail Server............................................................18
Delivery Methods and Required Environments...18 N
Send to Email.....................................................................18
Network Protocol............................................14, 17
Send to Folder....................................................................19
Send to FTP.........................................................................19
Network Shared Folders.......................................19
Send to WebDAV..............................................................19 O
Device List...............................................................40
Operating System Check......................................23
F Operating Systems...................................13, 15, 16
Failover......................................................29, 38, 46 P
Firewall............................................................15, 17
Plug-ins...................................................................29
FTP Server..............................................................19
Port Numbers.........................................................35
G Private Keys............................................................66
GlobalScan NX AdminTool...........................21, 39 Product names..........................................................5
GlobalScan NX Editions.......................................11 R
Server Edition.....................................................................12
Serverless Edition...............................................................11
Requirements and Specifications.........................13
Requirements and Specifications (Server Edition)...
Glossary of Terms..................................................69 ................................................................................13
Guides for This Solution..........................................1 Computer for Browsing AdminTool..................................15
71
Computer for Installing GlobalScan NX Server
Application and AdminTool..............................................13
Requirements and Specifications (Serverless
Edition)...................................................................16
Computer for Browsing AdminTool..................................18
Computer for Installing AdminTool...................................16
S
Secondary Delivery Server Required Settings....49
Setup Type.......................................................25, 34
Software Installation..............................................21
Installing GlobalScan NX Software.................................22
Preparing to Install GlobalScan NX Software................21
Software Installation Modification.......................39
Modifying GlobalScan NX Software..............................32
Preparing to Modify GlobalScan NX Software..............31
Software Uninstallation.........................................45
SSL setting (When Reinstalling)............................38
SSL Setting Change...............................................39
Starting Mode (Delivery Service)..................24, 34
Synchronization.....................................................31
Synchronizing the System.....................................39
System Recovery...................................................39
T
Trademarks...............................................................5
U
Uninstall..................................................................45
Upgrade.................................................................67
V
Virtual Directory..............................................27, 35
W
Web Browser..................................................15, 18
Web Server...............................................14, 17, 35
72 EN GB EN US D420-5501E
EN GB EN US D420-5501E © 2008-2012 Ricoh Co., Ltd.
GlobalScan NX v2
Installation Guide
APPENDIX
This page intentionally left blank.
GlobalScan NX Server and Serverless
with Card Authentication Package
Single Sign‐on Quick Reference
© Copyright Ricoh Americas Corporation 2009, All Rights Reserved
Trademarks
Adobe, Acrobat, and Reader are registered trademarks or trademarks of Adobe Systems
Incorporated in the United States and/or other countries.
Microsoft, Windows, Excel, and Internet Explorer are registered trademarks or trademarks of
Microsoft Corporation in the United States and other countries.
Novell and eDirectory are registered trademarks or trademarks of Novell, Inc. in the United
States.
Domino is a registered trademark of IBM Corporation and Lotus Development Corporation.
Other product names used herein are for identification purposes only and might be trademarks
of their respective companies. We disclaim any and all rights to those marks.
Manual Version 1.0
It is the reader's responsibility when discussing the information contained
within this document to maintain a level of confidentiality that is in the
best interest of Ricoh Corporation and its member companies.
NO PART OF THIS DOCUMENT MAY BE REPRODUCED IN
ANYFASHION AND DISTRIBUTED WITHOUT THE PRIOR
PERMISSION OF RICOH AMERICAS CORPORATION.
All product names, domain names or product illustrations, including
desktop images, used in this document are trademarks, registered
trademarks or the property of their respective companies.
They are used throughout this book in an informational or editorial fashion
only and for the benefit of such companies. No such use, or the use of
any trade name, or web site is intended to convey endorsement or other
affiliation with Ricoh products.
© 2009 RICOH Corporation. All rights reserved.
© Copyright Ricoh Americas Corporation 2009, All Rights Reserved
Overview
“Single Sign‐on” (SSO) allows the user to authenticate to
a GlobalScan NX (GS NX) version 1.2 and above
environment, that incorporates the Card Authentication
Package (CAP) version 1.2 and above at the MFP using
only one authentication step.
SSO eliminates the necessity of first authenticating to
the MFP via Card Authentication Package and then
authenticating again via GlobalScan NX to the user’s
network.
For Single Sign‐on to function Card Authentication
Package and GlobalScan NX must be properly installed
and operational and both applications MUST be set to
the same authentication type.
Screen 1: SSO allows for one simple login.
Configure CAP Authentication
1. Using a PC with a network connection to the
MFP. Using your Window’s Internet Browser (i.e.
Internet Explorer 7) in the address field enter:
“http://<MFP’s IP Address:8080/cap.”
2. Enter the CAP login credentials to access the
CAP Configuration Tool (default: User Name:
admin, Password: password)
Screen 2: Enter the IP address:8080/cap and log‐in.
3. Select [Configuration].
Screen 3: Select the “Configuration” page.
Single Sign‐on GlobalScan NX and Card Authentication Package Reference 1
4. In the [Configuration] menu, click
[Authentication Settings].
Screen 4: Select the “Authentication Settings” page.
5. The [Authentication Settings] screen appears.
6. Select the authentication type from [Device User
Authentication], [Active Directory], [LDAP
Server] or [CAP Enterprise Server]. Remember
that the authentication type chosen here must
match the authentication type used with
GlobalScan NX.
Screen 5: Select the Authentication Type.
7. The items within each configuration settings
group that you can specify vary depending on
the selected authentication type.
The configuration settings include…
• Server Settings
• Proxy User Settings
• Attribute Name Settings
Refer to “Configuring the Authentication Settings”
section 4 in the Card Authentication Administrator’s
Guide for specific details.
8. Scroll down and complete ALL necessary
settings, then select [OK] and close the CAP
Configuration Tool.
Continue to the “Configure GlobalScan NX” Screen 5: Select the Authentication Type.
information provided on the next page. Note: you
can configure GlobalScan NX first and then CAP,
there is no specific order when setting up Single
Sign‐on. Remember, the authentication types must
be the same for both GS NX and CAP, or Single Sign‐
on will not function.
Single Sign‐on GlobalScan NX and Card Authentication Package Reference 2
Configure GS NX Authentication
GlobalScan NX uses logon authentication to control
access to GlobalScan functions from the MFP.
GlobalScan supports Active Directory, LDAP(S), and
NT authentication. Authentication is enabled at the
profile level. If you plan to use authentication, you
should configure the default authentication profile
before you begin configuring profiles.
Refer to “Configuring an Authentication Profile” in
the GlobalScan NX Administrator’s Quick Reference
or Administrator’s Guide for specific details.
1. Using a PC with either the GlobalScan NX
AdminTool installed to, or one that has a
network connection to the PC with AdminTool,
and using your Window’s Internet Browser (i.e.
Internet Explorer 7) in the address field enter:
“http://<PC’s IP Address>:8080/gsnx.”
2. Enter the GSNX Admin Tool login credentials to
access Admin Tool (default: User Name: admin,
Password: created during Admin Tool
installation)
Screen 1: Access the GS NX Admin Tool and login.
3. On the Admin Tool home page, click [System].
You can also click on the “System” option on the
menu bar.
Screen2: Select System settings.
4. On the System Settings page, click on
Single Sign‐on GlobalScan NX and Card Authentication Package Reference 3
[Authentication Profiles].
Screen 3: Select “Authentication Profiles.
5. Click [Add].
6. Select the Authentication Method and configure
the settings as listed on the page, then press Screen 4: Click on Add.
[OK].
Screen 5: Select the Authentication Method. This method MUST
match the Authentication Type used for the CAP configuration.
Single Sign‐on GlobalScan NX and Card Authentication Package Reference 4
7. Select the created Profile from the Default
Authentication Profile dropdown, and click [Set
as default Authentication Profile].
Screen 6: Set the new Authentication Profile as the default.
8. Click [back] to exit the Authentication Profile
Settings, logout from the Admin Tool.
Remember, the authentication types must be the
same for both GS NX and CAP, or Single Sign‐on will
not function.
Screen 7: Select [Back] and then logout .
Using Single Sign‐on (SSO)
Once configured, the user can then authenticate
using their Prox card, or by entering their
credentials to both the MFP and GS NX via their
network simultaneously.
Screen 1: The user can now login to both Cap and GSNX
One popular application for single sign‐on is “Scan
to Home Folder.” The steps provided on the next
page illustrate how to configure GS NX for Scan to
Home Folder.
Single Sign‐on GlobalScan NX and Card Authentication Package Reference 5
1. As demonstrated in the “Configuring GS NX
Authentication” access and log into the GS NX
Admin Tool.
Screen 1: The user can now login to both Cap and GSNX
2. As per the instructions provided in the GS
NX Administrator’s Guide, edit or create a
Profile that includes the desired Groups and
Projects.
3. Double‐click on the Project that will include
“Scan to Home Folder” as a part of its
delivery flow.
Screen 2: Open the Project to edit the delivery flow.
4. This will then open the Delivery Flow Editor
for the Project. Double‐click on the “Send to
folder” Service to edit its properties.
Screen 3: Open the Send to Folder Service properties.
5. From the Send to Folder Properties screen,
click on the “Send to Home Folder”
accordion button located at the bottom of
the screen.
Screen 4: Open the Send to Home Folder settings.
Single Sign‐on GlobalScan NX and Card Authentication Package Reference 6
6. Select (a check mark is inserted) “Enable
Send to Home Folder.” Then click on [OK].
This setting can also be made at the System –
Services configuration screen. Always refer to the GS
NX Administrator’s Guide for details or procedure
changes.
Screen 5: Select “Enable Send to Home Folder.”
7. Click on [OK] again to save the settings.
Screen 6: Click OK to save the new settings.
8. Select [Device] from the menu bar and then
Synchronize the new Profile to the MFP.
When completed, logout of the GS NX
Admin Tool.
Send to Home Folder can only be used within an
Active Directory network environment.
Screen 7: Copy the Profile to the MFP – logout .
Single Sign‐on GlobalScan NX and Card Authentication Package Reference 7
This page intentionally left blank.