74
Service Manual RC Gate Server Includes: Installation, specification, configuration, trouble-shooting, and upgrading

RC Gate Server Service Manual - kot320.dyndns.bizkot320.dyndns.biz/man/02/rcgate/s_rcgate.pdf · NIC CONFIGURATION ... Configuration Message Options ... The purpose of this guide

  • Upload
    dangdan

  • View
    228

  • Download
    1

Embed Size (px)

Citation preview

Page 1: RC Gate Server Service Manual - kot320.dyndns.bizkot320.dyndns.biz/man/02/rcgate/s_rcgate.pdf · NIC CONFIGURATION ... Configuration Message Options ... The purpose of this guide

Service Manual RC Gate Server

Includes: Installation, specification, configuration, trouble-shooting, and upgrading

Page 2: RC Gate Server Service Manual - kot320.dyndns.bizkot320.dyndns.biz/man/02/rcgate/s_rcgate.pdf · NIC CONFIGURATION ... Configuration Message Options ... The purpose of this guide

2

Trademarks

Windows and Microsoft and Internet Explorer are registered trademark of Microsoft Corporation.

Pentium is a registered trademark of Intel Corporation.

Ethernet is a registered trademark Xerox Corporation.

Netscape is a registered trademark of AOL.inc.

Other product names used herein are for identification purposes only and might be trademarks of their respective companies. We disclaim any and all right in those marks.

Page 3: RC Gate Server Service Manual - kot320.dyndns.bizkot320.dyndns.biz/man/02/rcgate/s_rcgate.pdf · NIC CONFIGURATION ... Configuration Message Options ... The purpose of this guide

3

Table of Contents TABLE OF CONTENTS............................................................................................................................. 3

INTRODUCTION....................................................................................................................................... 6

OVERVIEW OF RC GATE SERVER ............................................................................................................... 6 TECHNICAL DESCRIPTION.......................................................................................................................... 6 THEORY OF OPERATION............................................................................................................................. 7 RC GATE SERVER AND CENTER TOPOLOGY ........................................................................................... 7

SPECIFICATION ........................................................................................................................................ 8

DEVICE DISCOVERY.................................................................................................................................... 8 Maximum number of devices monitored ......................................................................................... 8 Discovery Configuration..................................................................................................................... 8

DEVICE INFORMATION............................................................................................................................... 9 STATUS POLLING...................................................................................................................................... 10 SENDING DEVICE INFORMATION PERIODICALLY THROUGH E-MAIL ....................................................... 11 CONFIGURATION MESSAGE ..................................................................................................................... 12 LONG REMAINING ERRORS....................................................................................................................... 12 IMMEDIATE EMAIL TRANSMISSION.......................................................................................................... 13 NRS SERVER HEARTBEAT........................................................................................................................ 14 NRS SERVER INSTALLATION ................................................................................................................... 14

INSTALLATION REQUIREMENTS .................................................................................................... 15

CUSTOMER SITE REQUIREMENTS ............................................................................................................. 15 Power Requirement ........................................................................................................................... 15 Network Requirements ..................................................................................................................... 15 Email requirements............................................................................................................................ 15 Firewall requirements ....................................................................................................................... 15 Supported Browsers by RC Gate Client.......................................................................................... 16 System Specifications......................................................................................................................... 16 Technician Tools................................................................................................................................. 16

INSTALLATION ...................................................................................................................................... 17

RC GATE SERVER TOPOLOGY .................................................................................................................. 17 SETTING UP THE RC GATE SERVER BOX FOR THE FIRST TIME ................................................................ 18

Configuring an IP address for your Laptop ................................................................................... 18 LOGGING ON TO THE RC GATE SERVER.................................................................................................. 19

RC GATE CONFIGURATION............................................................................................................... 20

NIC CONFIGURATION ............................................................................................................................. 20

Page 4: RC Gate Server Service Manual - kot320.dyndns.bizkot320.dyndns.biz/man/02/rcgate/s_rcgate.pdf · NIC CONFIGURATION ... Configuration Message Options ... The purpose of this guide

4

Before You Begin................................................................................................................................ 20 Configuring the NIC Properties....................................................................................................... 21

SERVER CONFIGURATION......................................................................................................................... 22 Before You Begin................................................................................................................................ 22 Configuring the Server Properties ................................................................................................... 24

DEVICE DISCOVERY CONFIGURATION........................................................................................ 25

TYPES OF DEVICE DISCOVERY.................................................................................................................. 25 LOCAL NETWORK AND/OR SUBNET AND NODE DISCOVERY CONFIGURATION ................................... 26

Enabling Local Network Discovery................................................................................................. 26 Add Network Discovery Configuration ......................................................................................... 28 Add Node Discovery Configuration ............................................................................................... 30

CONFIGURATION FILE UPLOAD............................................................................................................... 32 Configuration File Name and Format ............................................................................................. 32 Uploading the Configuration File.................................................................................................... 33 After File Upload................................................................................................................................ 34

NETWORK DISCOVERY STATUS................................................................................................................ 35 DEVICE DISCOVERY RESULTS................................................................................................................... 38 DEVICE LISTS ............................................................................................................................................ 39

Discovered Device List ...................................................................................................................... 39 Non-Discovered Device List............................................................................................................. 41

NETWORK DATABASE .............................................................................................................................. 42 Networks List ..................................................................................................................................... 42

NODES ...................................................................................................................................................... 45 CONFIGURATION MESSAGES.................................................................................................................... 47

Configuration Message Options ...................................................................................................... 47 RC GATE LOGS......................................................................................................................................... 48 SERVER TIME SETTING.............................................................................................................................. 51

Configuring the Server Time............................................................................................................ 51 ADMIN TOOLS .......................................................................................................................................... 52

Server Shutdown................................................................................................................................ 52 Export Discovery Configuration...................................................................................................... 53 Export Server Configuration ............................................................................................................ 53 Import Server Configuration............................................................................................................ 54

ANALYSIS TOOL ....................................................................................................................................... 55 Authentication in Analysis Tool Mode ........................................................................................... 55 Features in �Analysis Tool� Mode Login ......................................................................................... 56 Analysis Tool Configuration ............................................................................................................ 57 Analysis Tool Email Configuration ................................................................................................. 60 Export Device Information ............................................................................................................... 61

Page 5: RC Gate Server Service Manual - kot320.dyndns.bizkot320.dyndns.biz/man/02/rcgate/s_rcgate.pdf · NIC CONFIGURATION ... Configuration Message Options ... The purpose of this guide

5

Analysis Tool Logs............................................................................................................................. 63 Toner End Tool Logs ......................................................................................................................... 63 Moving the Analysis Tool to another Location.............................................................................. 64

TROUBLE-SHOOTING TIPS ................................................................................................................ 66

RETRIEVING RC GATE SERVER VERSION INFORMATION........................................................................ 66 BASIC TROUBLE-SHOOTING ...................................................................................................................... 66 CONFIGURATION VERIFICATION ............................................................................................................. 67

Verifying Installation/Configuration.............................................................................................. 67 Verifying connection to Center Server ............................................................................................ 67 Device Replaced Status ..................................................................................................................... 68 Moving the Server to another Network .......................................................................................... 68

LIMITATIONS ............................................................................................................................................ 68 Long Remaining Error limitation..................................................................................................... 68 Aficio 3850 Paper Jam........................................................................................................................ 69 Configuration Message and Browser XML Support ..................................................................... 69

UPGRADING AND UNINSTALLING/INSTALLING RC GATE SERVER SOFTWARE......... 70

UPGRADING THE RC GATE SOFTWARE -................................................................................................. 70 Backing Up Server Configuration.................................................................................................... 70 UnInstallation Procedure .................................................................................................................. 70 Upgrading Software from CD.......................................................................................................... 71 Restoring Server Configuration ....................................................................................................... 71

APPENDIX A � INSTALLING THE RC GATE ENVIRONMENT ................................................. 72

INSTALLING THE RC GATE ENVIRONMENT FOR THE FIRST TIME............................................................ 72 Installing Linux RedHat 7.2 Server.................................................................................................. 72 Installing the second NIC on Linux RedHat 7.2 ............................................................................ 73 Installing MySQL Server................................................................................................................... 74 Installing the RC Gate Server Software From CD ......................................................................... 74

Page 6: RC Gate Server Service Manual - kot320.dyndns.bizkot320.dyndns.biz/man/02/rcgate/s_rcgate.pdf · NIC CONFIGURATION ... Configuration Message Options ... The purpose of this guide

6

Introduction The purpose of this guide is to describe how to install and verify the operation of Ricoh�s Remote Communication Gate Server product. This document does not cover the Center Server or any other component of the RC Gate solution other than that of the RC Gate Server.

Overview of RC Gate Server The Remote Communication Gate (RC Gate) Server is intended to obtain and communicate printer/copier/MFP device information. Listed below are some of the features of the RC Gate Server.

• Automatic Device Discovery • Periodic Status Polling • Send device information through e-mail to Center Server periodically • Send Service call & other critical error information to Center Server when identified • Server configuration through web browser • Manage, un-manage and monitor elements

Technical Description AdventNet�s WebNMS product is used as a framework to develop RC Gate server functionality. RC Gate server uses AdventNet�s Web NMS API and SNMP APIs to poll the Ricoh device. Also Java Mail APIs are used to add Email functionality to WebNMS. Automatic device discovery can be configured using a web browser and is done by WebNMS. The RC Gate discovery filter is developed to discover only Ricoh/OEM devices and all printers on the network. Device information is initially collected when device is discovered.

Page 7: RC Gate Server Service Manual - kot320.dyndns.bizkot320.dyndns.biz/man/02/rcgate/s_rcgate.pdf · NIC CONFIGURATION ... Configuration Message Options ... The purpose of this guide

7

Theory of Operation Remote Communication Gate server is used to monitor Ricoh MFP/Printer devices from a remote site. The RC Gate Server will transmit device data automatically and transparently to the Center Server and relay device information that can be used in several ways. Upon arrival, the data will be decoded, verified. If the data is valid, it will be stored into the local database and immediately transmitted to the appropriate service organization. This information provides many benefits to Ricoh customers, dealers and service organizations including those listed below:

• Eliminating user errors in meter reading and reducing service organization and customer time spent reading meters.

• Eliminates mailing, faxing, telephone calls and data input entry costs. • Speeds delivery and increases reliability of billing related data. • Reducing delays in reception of service codes and device information improved

accuracy of problem reporting, exact SC code is reported by machine directly. • Integrating data into service organizations existing frameworks and software to

provide better service. • Building usage information to help with future sales and marketing strategies. • Automation integration with billing, reporting, service and other systems. • Improving customer relationship, confidence and service.

RC Gate Server AND Center Topology Data is collected at the customer site by the RC Gate Server box and is then transmitted as messages directly to the Center Server, which then retransmits data messages to the appropriate service organization.

Page 8: RC Gate Server Service Manual - kot320.dyndns.bizkot320.dyndns.biz/man/02/rcgate/s_rcgate.pdf · NIC CONFIGURATION ... Configuration Message Options ... The purpose of this guide

8

Specification

• Automatic Device Discovery

• Periodic Status Polling

• Send device information through e-mail to NRS center periodically.

• Send Service call & other critical error information to NRS center when identified.

• Server configuration through web browser.

• Manage and Unmanage elements

Device Discovery

Automatic device discovery is done by WebNMS. Discovery parameters can be set in conf/seed.file or

using a Web browser. Refer to NRS user interface section for details. Section 3.1.3 Discovery Settings

describes various settings configurable through Web UI.

Also discovery filter is developed to discover only Ricoh/OEM devices and all printers on the network.

Maximum number of devices monitored

500 Devices

Seed.file

Syntax seed.file and discovery parameters, which can be specified are listed in Appendix A.

Discovery Configuration

NRS Server has two modes in discovering and managing devices. These two modes are mutually exclusive. Basically one mode needs to be used on one Server, depending on the needs at the user site.

• Discover printers/MFPs on local Network and/or specified subnets and/or specific nodes automatically.

Page 9: RC Gate Server Service Manual - kot320.dyndns.bizkot320.dyndns.biz/man/02/rcgate/s_rcgate.pdf · NIC CONFIGURATION ... Configuration Message Options ... The purpose of this guide

9

To enable this mode, �Local Network Discovery� needs to be enabled. Also different sub networks

can be added to discovery list using �Add Network�. �Add Node� can be used to discover a specific

node on the Network.

Note: By default Local Network discover, option is disabled. Service engineer need to enable this option, when NRS Server is properly installed and configured at user site. Also if additional subnetworks or nodes to be managed, Service engineer has to Add Networks and Add Nodes through browser interface.

• Discover printers/MFPs listed in configuration file uploaded to the server.

To enable this mode �NRSDiscovery.conf� file needs to be uploaded to the Server using

�Configuration File Upload� option. Server discovers devices listed in this file. When server is in

this mode, Adding Network, Adding Node for discovery is disabled.

Device Information

Device information is collected when device is discovered. Discovery filter is developed to collect following information from the device. Information is stored in the database. (All information is provided from standard MIB)

A : Serial Number

B : IP Address

C : MAC Address

D : Model Name

E : Vendor Name

Vendor name is determined based on System Object ID.

F : Version Number of the device

Controller Version

NIC Version

NIC Type: Ricoh

NIC Type: DPI

Page 10: RC Gate Server Service Manual - kot320.dyndns.bizkot320.dyndns.biz/man/02/rcgate/s_rcgate.pdf · NIC CONFIGURATION ... Configuration Message Options ... The purpose of this guide

10

Status Polling

Device status information is collected when device status is polled periodically. A Poll filter is developed to collect information from the device. Information is stored in the database. (All information is provided from standard MIB)

Device polling interval:

Polling interval is user configurable.

Minimum 5 Minutes

Maximum 180 Minutes (3 Hours)

Default 10 Minutes

Information Polled:

A. Counter

1. Total Counter

2. Printer Counter

3. Copy Counter

4. Fax Counter

B. Supply Information

• Toner Low

• Toner End

• Toner Levels

Black Level

Cyan Level

Magenta Level

Yellow Level

C. Jam

D. Cover Open

Page 11: RC Gate Server Service Manual - kot320.dyndns.bizkot320.dyndns.biz/man/02/rcgate/s_rcgate.pdf · NIC CONFIGURATION ... Configuration Message Options ... The purpose of this guide

11

E. Service Call

Service call is indicated when above MIB object is set to filedService(5)

Service Call code is obtained through:

Sending device information periodically through e-mail

Mail type: SMTP

Data format: Encrypted XML format is sent as Email attachment.

Detailed data format is described in section 4.

Periodic Data Transmission Time:

Maximum three times a day can be set for periodic data transmission

Time of the day 1: HH

Time of the day 2: HH (Optional)

Time of the day 3: HH (Optional)

Logging of the data:

Directory: $(NRS)/NRSlog/Periodic_Message (Where $( NRS) is NRS Server Software installation

directory)

File Name: NRS_MsgNo_TimeStamp.log (Example: NRS_223_2002-01-28T08:00:00Z.log)

Duration: 2 Months. Message sent to the center from server is stored for two months in the above

directory.

Page 12: RC Gate Server Service Manual - kot320.dyndns.bizkot320.dyndns.biz/man/02/rcgate/s_rcgate.pdf · NIC CONFIGURATION ... Configuration Message Options ... The purpose of this guide

12

Configuration Message Mail type: SMTP

Data format: Encrypted XML format is sent as Email attachment.

Detailed data format is described in section 4.

Configuration message is sent when following conditions occur:

1. From Web UI, service engineer can send this message. (Press a button message is sent to NRS center)

2. Send when a device replaced condition is identified. (Same IP different Serial Number,

Send Old device information as �DEVICE_REPLACED� status)

3. Send when Server configuration is changed. (When server parameters are changed from

Web UI)

Logging of the data:

Directory: $( NRS)/NRSlog/Configuration_Message (Where $( NRS) is NRS Server Software

installation directory)

File Name: NRS_ MsgNo_TimeStamp.log (Example: NRS_23_2002-01-28T08:00:00Z.log)

Duration: 2 Months. Message sent to the center from server is stored for two months in the above directory.

Long remaining errors

When following critical errors remain more than certain amount of time, information is sent to NRS center through Email.

• Jam remains

• Door remain opened

• No response

Value: This is represented as multiple of polling period.

Minimum 2

Maximum 10

Default 2

Page 13: RC Gate Server Service Manual - kot320.dyndns.bizkot320.dyndns.biz/man/02/rcgate/s_rcgate.pdf · NIC CONFIGURATION ... Configuration Message Options ... The purpose of this guide

13

Also message is sent as soon as long remaining error condition is cleared.

• Jam Cleared after Long Remaining Error is sent • Door (Cover) closed after Long Remaining Error is sent • Device starts responding, after Long Remaining Error is sent

Data format: Encrypted XML format is sent as Email attachment.

Logging of the data:

Directory: $( NRS)/NRSlog/Long_Remaining_Errors (Where $( NRS) is NRS Server Software

installation directory)

File Name: NRS_MsgNo_TimeStamp_SerialNumber.log (Where SerialNumber is �Serial Number�

of the device. Example: NRS_212_2002-01-28T08:00:00Z_1234560.log)

Duration: 2 Months. Message sent to the center from server is stored for two months in the above

directory.

Immediate Email Transmission

Send Email immediately when following errors are identified and recovered. Email is sent to NRS center.

• Service Call

• Service Call recovered

• Supply Low/End

• Supply Recovered

Data format: Encrypted XML format is sent as Email attachment.

Logging of the data:

Directory: $( NRS)/NRSlog/Immediate_Errors (Where $( NRS) is NRS Server Software installation

directory)

File Name: NRS_MsgNo_TimeStamp_SerialNumber.log (Where SerialNumber is �Serial Number�

of the device. Example: NRS_24_2002-01-28T08:00:00Z_1234560.log)

Duration: 2 Months. Message sent to the center from server is stored for two months in the above

directory.

Page 14: RC Gate Server Service Manual - kot320.dyndns.bizkot320.dyndns.biz/man/02/rcgate/s_rcgate.pdf · NIC CONFIGURATION ... Configuration Message Options ... The purpose of this guide

14

NRS Server Heartbeat Send Email periodically to NRS center.

Values Supported: 1H, 2H, 4H, 6H, 8H, 12H, 24H

• Default 1H

Data format: Encrypted XML format is sent as Email attachment.

Logging of the data:

Directory: $( NRS)/NRSlog/Heartbeat (Where $( NRS) is NRS Server Software installation directory)

File Name: NRS_MsgNo_TimeStamp.log (Example: NRS_24_2002-01-28T08:00:00Z.log)

Duration: 2 Months. Message sent to the center from server is stored for two months in the above

directory.

NRS Server Installation Send Email to NRS center after first configuration of NRS Server.

This message is sent to the center as soon as user/service engineer installs and configures the server in the end user site. Also this is the first message with encrypted data and message digest as attachments, sent from NRS Server to NRS center.

Data format: Encrypted XML format is sent as Email attachment.

Page 15: RC Gate Server Service Manual - kot320.dyndns.bizkot320.dyndns.biz/man/02/rcgate/s_rcgate.pdf · NIC CONFIGURATION ... Configuration Message Options ... The purpose of this guide

15

Installation Requirements

Customer Site Requirements The following section lists the requirements to install and run the RC Gate Server. There is a maximum of 500 devices that can be managed by the RC Gate Server at one time.

Power Requirement

1. One 120V AC receptacle.

2. UPS (recommended, not provided)

Network Requirements

1. One open LAN jack (Ethernet only, Token Ring is not supported∗)

2. LAN Cable (not supplied)

3. Speed 10/100Mbps

4. Static IP address (for RC Gate Server, Network must be running TCP/IP)

5. Network Mask

6. Gateway address

7. DNS server address

Email requirements

1. SMTP server address

2. Administrator Email address

3. POP server address (Optional)

4. New Email account for RC Gate Server (Optional)

5. Password for RC Gate Server Email Account (Optional)

Firewall requirements

Note: Only Email is used to send messages out of user site.

∗ RC Gate Server has only Ethernet card installed, however server can manage devices connected to token ring with TCP/IP enabled.

Page 16: RC Gate Server Service Manual - kot320.dyndns.bizkot320.dyndns.biz/man/02/rcgate/s_rcgate.pdf · NIC CONFIGURATION ... Configuration Message Options ... The purpose of this guide

16

Supported Browsers by RC Gate Client

Windows Linux

Netscape Netscape 4.72, 4.76, 6 or later Netscape 4.72 or later

Internet Explorer IE 5.0, 5.5, 6.0

System Specifications

The RC Gate Server comes pre-bundled with the RC Gate Server software installed. The RC Gate server only supports Redhat Linux 7.2 environment and includes the modules below in AdvenNet WEB NMS v2.3.

Hardware Specifications

Platform Processor

Type

Processor Speed

Memory HDD Space for installation

HDD Free Space

Linux Pentium III 500 MHz 128MB 320 MB 200 MB

Server Components Specifications

Platforms Java Version Web Server Servlet Engine SNMP

Redhat Linux 7.2

JRE 1.3, JDK 1.3, JSDK 2.0

Apache 1.3 Tomcat 3.2 AdventNet

SNMP 3.3

Technician Tools

1. Laptop PC with appropriate browser installed.

2. Crossover Cable

Page 17: RC Gate Server Service Manual - kot320.dyndns.bizkot320.dyndns.biz/man/02/rcgate/s_rcgate.pdf · NIC CONFIGURATION ... Configuration Message Options ... The purpose of this guide

17

Installation RC Gate Server Software will be pre-installed on the server box and will be ready for installation on the customer site. The Software Installation Directory where the RC Gate software resides is: /Ricoh/NRS

Linux Login

User ID: root Password: password

RC Gate Server Topology The RC Gate Server has two network interface cards. One NIC (NIC1) is for connecting to the customer site LAN. (Marked as User NIC). The second NIC (NIC2) is used by the Service Engineer to configure the RC Gate server. (Marked as CE NIC. IP Address: 172.20.10.2)

The Service Engineer can configure NIC1 parameters (IP address, Net mask, Default gateway and DNS server address). The NIC2 comes pre-configured so that Service Engineer can use it to access the RC Gate Server to configure the server to the customer LAN.

RC Gate Server

Service EngineerLaptop

IP:172.20.10.3

NIC2CE NIC

172.20.10.2

NIC1UserNIC

User Network

Crossover cable

Note: Technical information on the NIC that is installed on the RC Gate Server can be found at http://support.intel.com/support/network/adapter/pro100/100info.htm

Page 18: RC Gate Server Service Manual - kot320.dyndns.bizkot320.dyndns.biz/man/02/rcgate/s_rcgate.pdf · NIC CONFIGURATION ... Configuration Message Options ... The purpose of this guide

18

Setting up the RC Gate Server Box for the First Time

1. To set up the server, connect a crossover Ethernet to cable (not provided) to Ethernet port marked as CE NIC or NIC2. See example drawing below.

NOTE: IP address of CE NIC in the RC Gate Server will be pre-configured as:

• IP address: 172.20.10.2:8080

• Net Mask: 255.255.255.0.

2. Connect the other end of the cable to the CE Terminal or Service Engineer�s PC/laptop with the address below (or an IP address is the range). This will enable the Service Engineer to access the RC Gate Server and configure it to the customer LAN.

• IP address: 172.20.10.3

• Net Mask: 255.255.255.0.

RC Gate Server

Service EngineerLaptop

IP:172.20.10.3

NIC2CE NIC

172.20.10.2

NIC1UserNIC User Network

Crossover cable

NOTE: If the CE NIC (NIC 1) address is by chance the same as the User NIC (NIC 2) address, the recommended IP address are as follows:

• CE NIC IP Address: 192.168.10.3

• User NIC IP Address: 192.168.10.2

Configuring an IP address for your Laptop

1. Go to �My Network Places�, left click

2. Click on �Properties�

3. Double Click on �Local Area Connection�

4. Click on �Properties�

5. Scroll down to �Internet Protocol (TCP/IP)�

6. Click on �Properties�

7. Check the Radio Button �Use the following IP address�

8. Enter the IP address, 172.20.10.3

Page 19: RC Gate Server Service Manual - kot320.dyndns.bizkot320.dyndns.biz/man/02/rcgate/s_rcgate.pdf · NIC CONFIGURATION ... Configuration Message Options ... The purpose of this guide

19

Logging on to the RC Gate Server Note: After powering on the RC Gate Server, wait 10 minutes before connecting to the RC Gate Server via the browser. This will allow time for the server to boot up and prepare for the connection.

1. Launch the web browser (see supported browser matrix under Installation Requirements above)

2. Browse http://172.20.10.2:8080

The following authentication screen is displayed in the browser:

3. Login with the following username and password:

• User Name: nrsadmin

• Password: nrsadmin

NOTE: This is the default username and password and cannot be changed.

NOTE: The session timeout is 30 minutes. After 30 minutes, the user will need to close the browser, open it again, and login in again.

Page 20: RC Gate Server Service Manual - kot320.dyndns.bizkot320.dyndns.biz/man/02/rcgate/s_rcgate.pdf · NIC CONFIGURATION ... Configuration Message Options ... The purpose of this guide

20

RC Gate Configuration There are four configurations that need to be performed before the RC Gate Server can begin discovery and sending messages to the Center. They consist of the NIC, Server, Device Discovery, and Time Zone. Each of these configurations is detailed below.

NIC Configuration

Before You Begin

Before you begin configuring the NIC card to the user site LAN, the following network information will be REQUIRED.

IP Address: IP address on user�s LAN

Subnet Mask: Subnet Mask on user�s LAN

Default Gateway: Default Gateway on user�s LAN

DNS Server Address: DNS Server address on user�s LAN (see note below)

Note: If the DNS server is not available at the customer�s site, the user will need to enter the Gateway address as the DNS Server Address in order to complete the configuration.

If the DNS server is not available, SMTP and POP server IP addresses will also need to be entered in the RC Gate Server configuration.

If the DNS server is available, the hostname of the SMTP and POP server can also be used in server configuration.

For information on how to configure the SMTP and POP server IP address, refer to the Server Configuration Section.

.

Page 21: RC Gate Server Service Manual - kot320.dyndns.bizkot320.dyndns.biz/man/02/rcgate/s_rcgate.pdf · NIC CONFIGURATION ... Configuration Message Options ... The purpose of this guide

21

Configuring the NIC Properties

4. Click on �NIC Configuration� to configure User NIC.

• Clicking �Reset� will change all of the values back to their previous setting

• The RC Gate Server performs integrity checking to ensure that the IP address is valid (numbers instead of characters, etc).

5. Enter the IP Address, Subnet Mask, Gateway, and DNS Server address as provided by Customer.

6. Click �Apply� which will cause the server to reboot. You will need to re-launch your browser and bring the RC Gate Server back up. The server may take a few minutes (5 min. max) to reboot. You will know it has rebooted when you can connect again via the browser.

7. Proceed to the Server Configuration instructions below once the RC Gate Server has rebooted and you have logged in.

Page 22: RC Gate Server Service Manual - kot320.dyndns.bizkot320.dyndns.biz/man/02/rcgate/s_rcgate.pdf · NIC CONFIGURATION ... Configuration Message Options ... The purpose of this guide

22

Server Configuration After the Server is rebooted, log in to the server using the steps in the �Logging on to the RC Gate Server� section above.

Before You Begin

To configure the Server to the user site LAN, the following information will be REQUIRED (unless otherwise noted). All other fields are optional and are set to a default value *.

RC Gate Server ID:

Used for identification from the Center Server. MAC Address of user NIC or Serial number of RC Gate box is highly recommended.

External System ID: Used to identify the server or server system to which the Center Server relays messages received from.

Note: Refer to Center Server Specification.

IMPORTANT: This should be set to �lanier� if the Center Server is relaying messages to Lanier.

Enable Email Function: Default: Checked

By unchecking this checkbox, Email functionality of RC Gate Server is completely disabled. This makes remaining Email settings optional.

Note: When this is unchecked Email feature of �Analysis Tool� is also disabled.

Enable RC Gate Email Logs Default: Checked

By unchecking this checkbox, Email communication between RC Gate Server and Center Server will be disabled.

Note: This can be used when RC Gate Server is used as �Analysis Tool�. This disables Email messages to �Center Server�.

Center Server Email Address 1: The email address where the RC Gate Server messages will be sent

Center Server Email Address 2: Optional email address where the RC Gate Server messages will be sent.

Administrator Email Address: Internal to customer�s company. IT personnel who is responsible for maintaining RC Gate Server at User Site.

This address will represent the �From� and �Reply-To� field on outbound email messages to the Center Server, if optional �RC Gate Server Email Address�(See below) is not entered during RC Gate Server Configuration.

IMPORTANT: In this situation Email messages NOT delivered to Center Server will be bounced back to �Administrator Email Address�

Page 23: RC Gate Server Service Manual - kot320.dyndns.bizkot320.dyndns.biz/man/02/rcgate/s_rcgate.pdf · NIC CONFIGURATION ... Configuration Message Options ... The purpose of this guide

23

SMTP Server Address: Required when �Enable Email Function� is checked.

POP Server: Used to retrieve undelivered Email messages, when an Email account for RC Gate Server is created on Email Server. (Required only if the �RC Gate Server Email Address� below is available.)

RC Gate Server Email Address: This address will represent the �From� and �Reply-To� field on outbound email messages to the Center Server. This is an optional field.

In this situation Email messages not delivered to Center Server will be bounced back to �RC Gate Server Email Address�. RC Gate Server periodically checks for bounced back messages and logs them under �Undelivered� messages.

When �RC Gate Server Email Address� is available, �Administrator Email Address� is not used by RC Gate Server.

NOTE: If no RC Gate Server Address is entered, the Administrator�s email address will be used for �From� and �Reply-To� field on outbound email messages to the Center Server.

RC Gate Email Password: This password is used by the RC Gate Server to Authenticate to POP Server when retrieving bounced back messages. (Optional)

Page 24: RC Gate Server Service Manual - kot320.dyndns.bizkot320.dyndns.biz/man/02/rcgate/s_rcgate.pdf · NIC CONFIGURATION ... Configuration Message Options ... The purpose of this guide

24

Configuring the Server Properties

1. Click on �Server Configuration� to configure the Server.

• Clicking �Reset� will change all of the values back to their previous setting

• The RC Gate Server performs integrity checking to ensure that the IP address is valid (numbers instead of characters, etc).

2. Enter the RC Gate Server ID, External System ID, Center Server Email Address, Administrator Email Address, SMTP Server, POP Server (Required only if the RC Gate Server Email Address is available)

3. Click �Apply� which will send a test message and �MSG_TYPE_SERVER_INSTALLATION� (server installation message) when Server is configured for the first time. For subsequent server reconfiguration a test message and �MSG_TYPE_SERVER_CONFIGURATION� is sent to the Center Server.

4. Proceed to the Device Discovery Configuration in the next section.

Page 25: RC Gate Server Service Manual - kot320.dyndns.bizkot320.dyndns.biz/man/02/rcgate/s_rcgate.pdf · NIC CONFIGURATION ... Configuration Message Options ... The purpose of this guide

25

Device Discovery Configuration

Types of Device Discovery There are two primary modes in discovery and managing devices. These two modes are mutually exclusive. Basically one mode needs to be used on one Server, depending on the needs at the user site. Descriptions of each mode are covered below.

The first mode allows the user to discover printers/MFPs on the local Network and/or specified subnets and/or specific nodes automatically. This mode has three options using automatic device discovery based on setting specified network parameters; Discovery Settings, Add Network, Add Node.

The second mode is by Configuration File Upload, which lists the specific devices to be discovered and managed. All discovered devices will be listed in the Discovered Devices List (discussed later on).

Local Network and/or Specified Subnets and Nodes Discovery

To enable this mode, �Local Network Discovery� needs to be enabled under �Discovery Setting� which will enable/disable the discovery of the Local Network. Different sub networks can be added to discovery list using �Add Network� or �Add Node� can be used to discover a specific node on the Network. If no additional parameters set, the RC Gate Server will only discover devices on the local network based on the parameters of the RC Gate Server network configuration. The discovery process commences when the RC Gate Server starts.

• Add Network - This option can be used to discover devices on specified networks. Network address and Subnet Mask need to be specified.

• Add Node - The Node Discovery configures the discovery of a single node in a network. The IP Address and Subnet Mask values are mandatory.

NOTE: By default when starting the server, no automatic discovery is configured. To do local discovery the Discovery Settings Local Discovery Setting box needs to be checked.

Configuration File Upload

• This method is used when the specific devices to be managed are known. Only the devices listed in the configuration file will be uploaded. When server is in this mode, Adding Network, Adding Node for discovery is disabled.

• To enable this mode a �RC_GateDiscovery.conf� file needs to be uploaded to the Server

using �Configuration File Upload� option

Page 26: RC Gate Server Service Manual - kot320.dyndns.bizkot320.dyndns.biz/man/02/rcgate/s_rcgate.pdf · NIC CONFIGURATION ... Configuration Message Options ... The purpose of this guide

26

Local Network and/or Subnet and Node Discovery Configuration To enable this mode, �Local Network Discovery� needs to be enabled under �Discovery Setting� which will enable/disable the discovery of the Local Network. Different sub networks can be added to discovery list using �Add Network� or �Add Node� can be used to discover a specific node on the Network

Enabling Local Network Discovery

This option will enable/disable the discovery of the Local Network. This is used when the user wants to automatically discover devices on their local network.

The discovery process commences when the RC Gate Server starts. By default this option is disabled and no automatic discovery occurs. The service engineer needs to enable this option when RC Gate Server is properly installed and configured at user site. To configure the RC Gate Server Discovery Setting Local Network Discovery follow the steps below.

1. Check (or uncheck to disable) the Local Network Discovery box.

2. Click �Apply�

3. Clicking �Reset� will change the value back to it�s previous setting

4. If the setting was successful, the following messages will be displayed:

Success! Local Network Discovery Enabled Success! Local Network Discovery Disabled

Note: All discovered devices will be listed in the Discovered Devices List (discussed later on).

Page 27: RC Gate Server Service Manual - kot320.dyndns.bizkot320.dyndns.biz/man/02/rcgate/s_rcgate.pdf · NIC CONFIGURATION ... Configuration Message Options ... The purpose of this guide

27

Error messages for Discovery Settings

Following are some of the possible error messages for this option:

• If the RC Gate Server has not yet been configured, the discovery configurations will not take affect and the following message will be displayed:

Error! Server not configured. Please click on 'Server configuration' to configure the server.

• The Discovery Settings option is available only when RC_GateDiscovery.conf file is not uploaded to the server. When a configuration file is present on the server, pressing �Apply� button results an error message as well.

Page 28: RC Gate Server Service Manual - kot320.dyndns.bizkot320.dyndns.biz/man/02/rcgate/s_rcgate.pdf · NIC CONFIGURATION ... Configuration Message Options ... The purpose of this guide

28

Add Network Discovery Configuration

This option can be used to discover specific networks. Network address and Net Mask need to be specified. To configure the RC Gate Server for specific Network Discovery, follow the steps below.

NOTE: By default when starting the server, no automatic discovery is configured. To do local discovery the Discovery Settings Local Discovery Setting box needs to be checked.

1. Enter the Network Address and Subnet Mask

2. Click �Apply�

• The RC Gate Server performs integrity checking to ensure that the IP address is valid (numbers instead of characters, etc).

• Clicking �Reset� will change all of the values back to their previous setting 3. The following message will be displayed if the network parameters were successfully

added:

Success! Added Network 172.30.2.0

Note: All discovered devices will be listed in the Discovered Devices List (discussed later on).

Page 29: RC Gate Server Service Manual - kot320.dyndns.bizkot320.dyndns.biz/man/02/rcgate/s_rcgate.pdf · NIC CONFIGURATION ... Configuration Message Options ... The purpose of this guide

29

Error Messages for Add Network

Following are some of the possible error messages for this option:

• If there was a failure to add the specific network (non-existent, invalid address, etc), the following message will be displayed:

Error! Failed to add Network IP address

• If an invalid address was attempted, the following type of message will be displayed:

Page 30: RC Gate Server Service Manual - kot320.dyndns.bizkot320.dyndns.biz/man/02/rcgate/s_rcgate.pdf · NIC CONFIGURATION ... Configuration Message Options ... The purpose of this guide

30

Add Node Discovery Configuration

The Add Node option configures the discovery of a single node in a network. This option allows the user to set specific network parameters for the devices to be discovered.

NOTE: By default there is no discovery set when the RC Gate Server box is first installed. To enable it, check the Local Network Discovery box under Discovery Configuration -> Discovery Settings.

1. Enter the required information (IP Address, Subnet Mask) and additional information if desired.

2. Click �Apply�

• The RC Gate Server performs integrity checking to ensure that the IP address is valid (numbers instead of characters, etc).

• Clicking �Reset� will change all of the values back to their previous setting 3. The following message will be displayed if the network node parameters were

successfully added:

Successfully Added to Database

Note: All discovered devices will be listed in the Discovered Devices List (discussed later on).

Page 31: RC Gate Server Service Manual - kot320.dyndns.bizkot320.dyndns.biz/man/02/rcgate/s_rcgate.pdf · NIC CONFIGURATION ... Configuration Message Options ... The purpose of this guide

31

Error Messages for Add Node

Following are some of the possible error messages for this option:

• If the node address is invalid and does not exist on the network, or is not an MFP or printer, the following error message will be displayed.

Cannot Add This Node IP Address Check Applied Filters

• If an invalid address was attempted, the following type of message will be displayed:

Page 32: RC Gate Server Service Manual - kot320.dyndns.bizkot320.dyndns.biz/man/02/rcgate/s_rcgate.pdf · NIC CONFIGURATION ... Configuration Message Options ... The purpose of this guide

32

Configuration File Upload This option is used when the specific devices to be discovered managed by the RC Gate server are known. It allows the user to specify the devices to be managed by uploading a configuration file containing each device�s information. Only the devices listed in the configuration file will be uploaded. When server is in this mode, Adding Network, Adding Node for discovery is disabled. Please note the requirements for the configuration file below.

If there is no current Configuration File uploaded, the bottom of the screen will display the following message:

Current Configuration File Status: RC_GateDiscovery.conf does not exists or contains invalid data

Configuration File Name and Format

Configuration files must be in the following file format for it to be accepted by the RC Gate Server. The file can be created in any text editor and carriage returns are required. If the serial number is unknown or incorrect, it will be overwritten by the RC Gate Server and displayed correctly in the browser.

File Name: RC_GateDiscovery.conf

File Format: IPAddress=Subnet Mask,Serial Number,Additional ID, Comment

Example:

10.10.2.25=255.255.255.0,1234567,UNKNOWN,Sales Division Printer

10.45.4.78=255.255.255.0,1233789,3345,Printer in 2nd Floor

10.46.4.78=255.255.255.0,45634,4421,CFO's Printer

Note: When an optional field is not available, a value �UNKNOWN� is entered in the file. This is mandatory.

Non-Discovered Devices

If devices are listed in the configuration file but are not discovered, they will be listed in the Non-Discovered Device List (discussed later on).

Page 33: RC Gate Server Service Manual - kot320.dyndns.bizkot320.dyndns.biz/man/02/rcgate/s_rcgate.pdf · NIC CONFIGURATION ... Configuration Message Options ... The purpose of this guide

33

Uploading the Configuration File

To upload a configuration file, follow the steps below.

1. After creating a file in the required file format, click on Browse to find and select the RC_GateDiscovery.conf file to be uploaded.

2. Click �Upload�

3. When the RC_GateDiscovery.conf file is successfully uploaded to the RC Gate Server following message is shown:

Success! Discovery configuration file Uploaded successfully. File Size: (file size)

Note: All discovered devices will be listed in the Discovered Devices List (discussed later on).

Page 34: RC Gate Server Service Manual - kot320.dyndns.bizkot320.dyndns.biz/man/02/rcgate/s_rcgate.pdf · NIC CONFIGURATION ... Configuration Message Options ... The purpose of this guide

34

After File Upload

Once the RC_GateDiscovery.conf configuration file has been uploaded successfully, the contents of the file are shown in the browser as in the example below:

Error Messages for Configuration File Upload

Following are some of the possible error messages for this option:

• When no file has been selected for upload but the �Upload� button has been clicked, the following error message will be displayed:

Page 35: RC Gate Server Service Manual - kot320.dyndns.bizkot320.dyndns.biz/man/02/rcgate/s_rcgate.pdf · NIC CONFIGURATION ... Configuration Message Options ... The purpose of this guide

35

Network Discovery Status This option is used to

• Display current discovery status of each sub networks managed by the RC Gate Server.

• Restart Discovery of managed sub networks.

• Manage/UnMange sub networks.

• Edit �Location� and �Comment� field associated with each sub network.

Discovery Status can have following values:

1 - YET_TO_BEGIN

2 - IN_PROGRESS

3 - FINISHED

4 - DISCOVERY_DISABLED

Pressing �Restart Discovery� will start the discovery of networks, which are in managed state.

Page 36: RC Gate Server Service Manual - kot320.dyndns.bizkot320.dyndns.biz/man/02/rcgate/s_rcgate.pdf · NIC CONFIGURATION ... Configuration Message Options ... The purpose of this guide

36

Managing and Un-Managing Networks

Clicking on the triangle image in the �Network column shows a context menu. This has two items�

1. Manage/UnMange

2. StartDiscovery/StopDiscovery

Items in the context menu will change based on the current status of Network. If the network is in �Managed� state & discovery is in progress, menu items will have �UnManage� and �StopDiscovery�

Page 37: RC Gate Server Service Manual - kot320.dyndns.bizkot320.dyndns.biz/man/02/rcgate/s_rcgate.pdf · NIC CONFIGURATION ... Configuration Message Options ... The purpose of this guide

37

Editing �Location� and �Comment�

Clicking on �Edit� button in �Location� or �Comment� shows following screen. User can Edit the �Location� and �Comment� of this network.

Page 38: RC Gate Server Service Manual - kot320.dyndns.bizkot320.dyndns.biz/man/02/rcgate/s_rcgate.pdf · NIC CONFIGURATION ... Configuration Message Options ... The purpose of this guide

38

Device Discovery Results Once discovery is configured, the discovered devices and list of networks and nodes for discovery are listed under the headings of Device List and Network Database respectively.

Page 39: RC Gate Server Service Manual - kot320.dyndns.bizkot320.dyndns.biz/man/02/rcgate/s_rcgate.pdf · NIC CONFIGURATION ... Configuration Message Options ... The purpose of this guide

39

Device Lists There are two types of Device Lists: Discovered Devices and Non-Discovered Devices. The Non-Discovered device list is only utilized when discovery is performed using an uploaded configuration file (RC_GateDiscovery.conf).

Discovered Device List

The Discovered Device List lists all of the devices and their respective information including the IP Address, Serial Number, Vendor, Model Name, Status, and the date the Status was last updated. Some of these fields are sort able in one direction by clicking on the column title.

There are two views for the device discovered list. See the following two examples. The Discovered Device List (View 2) allows the user to select the device and edit the Additional ID and Comment.

Clicking on �Edit� button in �Additional ID� or �Comment� shows following screen. User can Edit the �Additional ID� and �Comment� of this device.

Page 40: RC Gate Server Service Manual - kot320.dyndns.bizkot320.dyndns.biz/man/02/rcgate/s_rcgate.pdf · NIC CONFIGURATION ... Configuration Message Options ... The purpose of this guide

40

Page 41: RC Gate Server Service Manual - kot320.dyndns.bizkot320.dyndns.biz/man/02/rcgate/s_rcgate.pdf · NIC CONFIGURATION ... Configuration Message Options ... The purpose of this guide

41

Non-Discovered Device List

The Non-Discovered device list is available when an RC_GateDiscovery.conf file is uploaded to the server for device discovery. This list contains the devices that were listed in the uploaded file but that were not discovered.

NOTE: If no device discovery configuration file has been uploaded, the following will be displayed:

Page 42: RC Gate Server Service Manual - kot320.dyndns.bizkot320.dyndns.biz/man/02/rcgate/s_rcgate.pdf · NIC CONFIGURATION ... Configuration Message Options ... The purpose of this guide

42

Network Database The Network Database keeps track of all Networks and Nodes that were input into the Discovery Configuration parameters. Each Network and Node is listed along with their respective information which is stored in the database.

The Discovered Device List lists all of the devices and their respective information including the IP Address, Serial Number, Vendor, Model Name, Status, and the date the Status was last updated.

Networks List

This list contains a list of Networks that were input as Discovery Configuration parameters. The list contains each Network address along with its respective information. Some of these fields are sort able in one direction by clicking on the column title. For detailed Network attributes stored in the RC Gate Server database, click on the IP address link (this is used more so for troubleshooting and debugging).

�Discover� status (true/false) will indicate printers/MFPs under this network will be automatically discovered by RC Gate server or not.

Page 43: RC Gate Server Service Manual - kot320.dyndns.bizkot320.dyndns.biz/man/02/rcgate/s_rcgate.pdf · NIC CONFIGURATION ... Configuration Message Options ... The purpose of this guide

43

Network Database Attributes

Clicking on the IP address will display detailed Network attributes stored in the RC Gate Server database.

NOTE:

It is highly recommended that the user NOT change any of the values on this page. This is strictly for information purposes only.

Page 44: RC Gate Server Service Manual - kot320.dyndns.bizkot320.dyndns.biz/man/02/rcgate/s_rcgate.pdf · NIC CONFIGURATION ... Configuration Message Options ... The purpose of this guide

44

Managing and Un-Managing Networks

Clicking on the triangle image in the names column shows a context menu. This has two items�

3. Manage/UnMange

4. StartDiscovery/StopDiscovery

Items in the context menu will change based on the current status of Network. If the network is in �Managed� state & discovery is in progress, menu items will have �UnManage� and �StopDiscovery�

Page 45: RC Gate Server Service Manual - kot320.dyndns.bizkot320.dyndns.biz/man/02/rcgate/s_rcgate.pdf · NIC CONFIGURATION ... Configuration Message Options ... The purpose of this guide

45

Nodes This list contains a list of Nodes that were input as Discovery Configuration parameters. The list contains each Node address along with its respective information. For detailed Node attributes stored in the RC Gate Server database, click on the IP address link (this is used more so for troubleshooting and debugging).

Page 46: RC Gate Server Service Manual - kot320.dyndns.bizkot320.dyndns.biz/man/02/rcgate/s_rcgate.pdf · NIC CONFIGURATION ... Configuration Message Options ... The purpose of this guide

46

Managing and Un-Managing Network Nodes

This feature can also be used to set/unset managed status of the device. When the device status is set to �unmange� status polling of the device will stop. This feature can be used when a service engineer is working on the device in user site. This will prevent unnecessary alert messages being sent to the center.

NOTE: It is NOT recommended to use the delete feature.

Page 47: RC Gate Server Service Manual - kot320.dyndns.bizkot320.dyndns.biz/man/02/rcgate/s_rcgate.pdf · NIC CONFIGURATION ... Configuration Message Options ... The purpose of this guide

47

Configuration Messages This option allows the user to send a configuration message to the Center Server containing Discovered Devices information.

Configuration Message Options

• To send a Configuration Message, click the Send button. • To view the Configuration Message sent, check the Show Message box and click

Send. • To send a Configuration Message without displaying the contents, do not check the

Show Message box and just click Send.

Sending a Configuration Message

Page 48: RC Gate Server Service Manual - kot320.dyndns.bizkot320.dyndns.biz/man/02/rcgate/s_rcgate.pdf · NIC CONFIGURATION ... Configuration Message Options ... The purpose of this guide

48

Displaying a Configuration Message

NOTE: If the browser is XML capable, the message will be shown as it is shown above. The user will be able to expand/collapse the message. If the browser does not support XML, the XML tags will NOT be displayed.

Configuration Message Delivery Confirmation

RC Gate Logs

Page 49: RC Gate Server Service Manual - kot320.dyndns.bizkot320.dyndns.biz/man/02/rcgate/s_rcgate.pdf · NIC CONFIGURATION ... Configuration Message Options ... The purpose of this guide

49

There are six types of RC Gate Logs that contain the information that was sent to the Center Server. These logs are:

Periodic Messages Configuration Messages Long Remaining Errors

Immediate Errors Heartbeat Messages Undelivered Messages.

Clicking on any of the message logs listed on the tree, will display a list of logged messages.

The �Encrypt� folder contains encrypted messages and the MessageDigest folder contains a list of message digest associated with the message log name. This can be identified by the message number which is part of the filename. The purpose is for further security.

Clicking on the log file, will display the log contents or the message itself in the browser.

Log Files

Page 50: RC Gate Server Service Manual - kot320.dyndns.bizkot320.dyndns.biz/man/02/rcgate/s_rcgate.pdf · NIC CONFIGURATION ... Configuration Message Options ... The purpose of this guide

50

Log File Contents

Undelivered Messages

If there are no Undelivered Messages in the log file, it will appear as below:

Page 51: RC Gate Server Service Manual - kot320.dyndns.bizkot320.dyndns.biz/man/02/rcgate/s_rcgate.pdf · NIC CONFIGURATION ... Configuration Message Options ... The purpose of this guide

51

Server Time Setting

Configuring the Server Time

1. Input the time, date, and respective time zone

2. Click �Apply� which will display the following message in the browser:

Success! Set Server time successfully

• Time is in military time (i.e. 22:50 equals 10:50pm)

• Hour range is 0-23

NOTE: The session timeout is 30 minutes. After 30 minutes, the user will need to close the browser, open it again, and login in again. The browser session can timeout due to a change in the system time.

Time Zone Configuration Error Messages

Example messages are shown below. A warning message will be displayed for the following invalid inputs: Invalid Hour, Hour out of Range, Invalid Minute, Minute out of Range, Invalid Second, Second Out of Range, Invalid day, Invalid day in Feb, Invalid Year, Year out of Range

Page 52: RC Gate Server Service Manual - kot320.dyndns.bizkot320.dyndns.biz/man/02/rcgate/s_rcgate.pdf · NIC CONFIGURATION ... Configuration Message Options ... The purpose of this guide

52

Admin Tools

Server Shutdown

The Server Shutdown feature allows for the RC Gate Server to be safely shutdown. To safely shut down the server, click on the shutdown button. This feature may be used if the user is communicating with the RC Gate Server through the web browser versus using a keyboard and mouse directly.

NOTE: Wait 10 minutes after �Server Shutdown� operation before powering off the RC Gate Server hardware. The RC Gate Server hardware can be powered off by pushing the button located on the front of the RC Gate Server.

Page 53: RC Gate Server Service Manual - kot320.dyndns.bizkot320.dyndns.biz/man/02/rcgate/s_rcgate.pdf · NIC CONFIGURATION ... Configuration Message Options ... The purpose of this guide

53

Export Discovery Configuration

This option can be used to export the current discovered device list. The exported will be of RC_GateDiscovery.conf format. This file can be used by �Configuration File Upload� under �Discovery Configuration�. Refer to �Configuration File Upload� for details.

Export Server Configuration

This feature allows the user to export the current server configuration to a file. To export server configuration, click on the export button and select a file folder to save the configuration file RC_GateServer.conf to. The exported file can be used to restore Server�s previous settings after software upgrade.

Page 54: RC Gate Server Service Manual - kot320.dyndns.bizkot320.dyndns.biz/man/02/rcgate/s_rcgate.pdf · NIC CONFIGURATION ... Configuration Message Options ... The purpose of this guide

54

Import Server Configuration

This feature allows the user to import server configuration file that was previously exported using �Export Server Configuration�. To import this file, click on the Import button and select a file folder in which server configuration file RC_GateServer.conf is located.

Page 55: RC Gate Server Service Manual - kot320.dyndns.bizkot320.dyndns.biz/man/02/rcgate/s_rcgate.pdf · NIC CONFIGURATION ... Configuration Message Options ... The purpose of this guide

55

Analysis Tool This option enables the RC Gate Server to be used as a print volume analysis tool. RC Gate server configured in this mode, periodically/manually exports managed device information in a CSV file format. This CSV file can be used to analyze the print volume and also printer/MFP usage information. Sales person can download periodically logged CSV file from RC Gate Server through Web Browser.

RC Gate Server can also be configured to periodically Email encrypted CSV file to 10 different Email addresses.

Authentication in Analysis Tool Mode

A separate login is available to use RC Gate Server in �Analysis Tool� mode. RC Gate Server shows features relevant to �Analysis Tool� in this mode.

Login with the following username and password:

• User Name: salestool

• Password: salesadmin

Page 56: RC Gate Server Service Manual - kot320.dyndns.bizkot320.dyndns.biz/man/02/rcgate/s_rcgate.pdf · NIC CONFIGURATION ... Configuration Message Options ... The purpose of this guide

56

Features in �Analysis Tool� Mode Login

• Server Configuration

• Discovery Configuration

• Device List

• Analysis Tool

• About Remote Communication Gate

Note: User: �nrsadmin� authentication will display all the features of RC Gate Server, however authenticating as User: �salestool� will hide advanced features.

Page 57: RC Gate Server Service Manual - kot320.dyndns.bizkot320.dyndns.biz/man/02/rcgate/s_rcgate.pdf · NIC CONFIGURATION ... Configuration Message Options ... The purpose of this guide

57

Analysis Tool Configuration

This option enables the configuration of following settings related to Analysis Tool.

• Customer Information

• Device information export schedule settings.

Customer Information

Customer Name can be entered in this field. This information is used for logging.

Export Schedule Settings

Available options for �Schedule�

1. None (Export Disabled)

2. Daily

3. Weekly

4. Monthly

Based on the selection in the list box, additional relevant fields are enabled in the UI.

Page 58: RC Gate Server Service Manual - kot320.dyndns.bizkot320.dyndns.biz/man/02/rcgate/s_rcgate.pdf · NIC CONFIGURATION ... Configuration Message Options ... The purpose of this guide

58

Schedule Settings

1.None

This option disables CSV file export capability.

2. Daily

1. Preferred Time Available Values: 1:00 to 24:00

CSV File is created at the time selected in �Preferred Time� list box every day.

3. Weekly

1. Preferred Time Available Values: 1:00 to 24:00 2. Preferred Day Available Values: Sunday to Saturday CSV File is created at the time selected in �Preferred Time� list box & on the Week Day selected by �Preferred Day� list box every week.

Page 59: RC Gate Server Service Manual - kot320.dyndns.bizkot320.dyndns.biz/man/02/rcgate/s_rcgate.pdf · NIC CONFIGURATION ... Configuration Message Options ... The purpose of this guide

59

4. Monthly

1.Preferred Time Available Values: 1:00 to 24:00 2.Preferred Date Available Values: 1 to 31

CSV File is created at the time selected in �Preferred Time� list box & on the Date selected by �Preferred Day� list box every month.

Page 60: RC Gate Server Service Manual - kot320.dyndns.bizkot320.dyndns.biz/man/02/rcgate/s_rcgate.pdf · NIC CONFIGURATION ... Configuration Message Options ... The purpose of this guide

60

Analysis Tool Email Configuration

This option allows user to configure Email settings related to Analysis Tool.

Checking �Email Exported(CSV) File� enables sending exported CSV file as Email attachment to Recipient Email Addresses. User has an option of specifying 10 different Email addresses as recipients.

Page 61: RC Gate Server Service Manual - kot320.dyndns.bizkot320.dyndns.biz/man/02/rcgate/s_rcgate.pdf · NIC CONFIGURATION ... Configuration Message Options ... The purpose of this guide

61

Export Device Information

This feature enables the user to export (download) device information CSV file.

When export button is pressed following screen is shown (IE Browser)

Page 62: RC Gate Server Service Manual - kot320.dyndns.bizkot320.dyndns.biz/man/02/rcgate/s_rcgate.pdf · NIC CONFIGURATION ... Configuration Message Options ... The purpose of this guide

62

1. Selecting �Save this file to disk� option will show the �Save As� file dialog box:

2. Selecting �Open this file from current location� option will open �Microsoft Excel� (If Excel is installed).

Page 63: RC Gate Server Service Manual - kot320.dyndns.bizkot320.dyndns.biz/man/02/rcgate/s_rcgate.pdf · NIC CONFIGURATION ... Configuration Message Options ... The purpose of this guide

63

Analysis Tool Logs

This option enables the user to download/view the CSV file, which are logged by RC Gate Server.

Toner End Tool Logs

This option enables the user to download/view Toner End logs.

A new file is created every month. Whenever RC Gate Server polling engine discovers Toner End/Low condition on a device, Toner End log is updated.

Page 64: RC Gate Server Service Manual - kot320.dyndns.bizkot320.dyndns.biz/man/02/rcgate/s_rcgate.pdf · NIC CONFIGURATION ... Configuration Message Options ... The purpose of this guide

64

Moving the Analysis Tool to another Location

When moving the RC Gate Server to another location in the �Analysis Tool� mode, it must be returned to its preinstall condition. Follow these steps:

1. Shutdown the server:

cd /Ricoh/NRS/bin

./ShutDown.sh

2. Reinitialize the database:

cd /Ricoh/NRS/bin

./reinitialize_nrs.sh

3. Follow Server installation procedure in a new location.

Page 65: RC Gate Server Service Manual - kot320.dyndns.bizkot320.dyndns.biz/man/02/rcgate/s_rcgate.pdf · NIC CONFIGURATION ... Configuration Message Options ... The purpose of this guide

65

Test Tools This section is primarily used for debugging purposes therefore, no details will be provided. It contains the following debug options: Debug Settings, Decrypt Message, Digest Verification, Debug Logs, and Configuration Files.

Page 66: RC Gate Server Service Manual - kot320.dyndns.bizkot320.dyndns.biz/man/02/rcgate/s_rcgate.pdf · NIC CONFIGURATION ... Configuration Message Options ... The purpose of this guide

66

Trouble-shooting Tips

Retrieving RC Gate Server Version Information To retrieve the RC Gate Server Version information, click on �About� in Help menu or message will be sent out to the center with version number. See example below:

Basic trouble-shooting The following are options can be used when trying to troubleshoot a problem on the RC Gate server:

1. Reboot RC Gate Server

2. Reinstall Software

3. Enable Debug Logs and Download Log files for further analysis

4. Replace box (last option)

Page 67: RC Gate Server Service Manual - kot320.dyndns.bizkot320.dyndns.biz/man/02/rcgate/s_rcgate.pdf · NIC CONFIGURATION ... Configuration Message Options ... The purpose of this guide

67

Configuration Verification

Verifying Installation/Configuration

After installing and configuring the RC Gate Server, browse the RC Gate Server address and verify that the login screen appears.

Verifying connection to Center Server

After logging in to the RC Gate Server, send a configuration message using the Configuration Message option detailed in the Configuration Message section earlier in this document. Communicate with someone at the Center Server to verify that they have received this message.

Page 68: RC Gate Server Service Manual - kot320.dyndns.bizkot320.dyndns.biz/man/02/rcgate/s_rcgate.pdf · NIC CONFIGURATION ... Configuration Message Options ... The purpose of this guide

68

Special Conditions

Device Replaced Status

The RC Gate server identifies DEVICE_STATUS_REPLACED condition when there is a change in Serial Number for same IP address.

RC Gate Server sends a configuration message with old device information with last obtained counter values and device status set to DEVICE_STATUS_REPLACED status.

New device information is added to the RC Gate Server database after passing through the Discovery engine. Future configuration messages and periodic messages will have information about new device if this happens to be a printer or MFP.

Moving the Server to another Network

When moving the RC Gate Server to another network, it must be returned to its preinstall condition.

4. Shutdown the server:

cd /Ricoh/NRS/bin

./ShutDown.sh

2. Reinitialize the database:

cd /Ricoh/NRS/bin

./reinitialize_nrs.sh

3. Follow Server installation procedure.

Limitations

Long Remaining Error limitation

RC Gate Server polls device for error conditions such as Paper Jam, Cover Open and No Response. If the long remaining error interval is �X�, if the above mentioned errors are identified in �X� successive polls, long remaining error is sent to the Center Server. However if the above error gets cleared & reoccurred between two polling periods, RC Gate server cannot reset the long remaining error timer. This is a limitation.

Page 69: RC Gate Server Service Manual - kot320.dyndns.bizkot320.dyndns.biz/man/02/rcgate/s_rcgate.pdf · NIC CONFIGURATION ... Configuration Message Options ... The purpose of this guide

69

Aficio 3850 Paper Jam The RC Gate Server cannot discover paper jam (Single/Multiple) status on the Model J-EFI (Aficio 3850) device. This is an EFI issue with the following versions:

• Controller Firmware Version: PRO_0.9.0 • Controller Firmware Date: Jan 23 15:51:56 PST 2002 • Engine Version: B1.15B:33/M1.04:04

SmartNetMonitor for Admin also does not show Jam Status in the Status Summary, when Jam exists in Aficio 3850. This is because Jam bit in hrPrinterDetectedErrorState is not set in the MIB.

In the Network Database>Nodes the printer status shows ' Device_Status_Alert ' then check the object details at jamstatus it shows 'Jam_Status_OK'. Again, this only happens on the Jupiter-P EFI controller printer.

Configuration Message and Browser XML Support

This option allows the user to send a configuration message to the Center Server containing Discovered Devices information.

If the browser is XML capable, the message will be shown as it is shown below. The user will then be able to expand/collapse the message. If the browser does not support XML, the XML tags will NOT be displayed and the user will not be able to expand/collapse the message.

Page 70: RC Gate Server Service Manual - kot320.dyndns.bizkot320.dyndns.biz/man/02/rcgate/s_rcgate.pdf · NIC CONFIGURATION ... Configuration Message Options ... The purpose of this guide

70

Upgrading and Uninstalling/Installing RC Gate Server Software

Note: A keyboard, monitor, and mouse are required for the following procedures.

Upgrading the RC Gate Software -

Backing Up Server Configuration

1. Login to RC Gate Server from a laptop (PC)

User Name: nrsadmin

Password: nrsadmin

2. Click on �Export Server Configuration� under �Admin Tools�.

3. Click on �Export�

This will export current server configuration in �RC_GateServer.conf� file. Use this file to restore the server configuration after installing a newer version of the RC Gate Server Software.

Note: This operation backs up, data entered in �Server Configuration�, �Analysis Tool Configuration� and �Analysis Tool Email Configuration�. This does not backup device information managed by the RC Gate Server.

UnInstallation Procedure

5. Shutdown the server:

cd /Ricoh/NRS/bin

./ShutDown.sh

2. Reinitialize the database:

cd /Ricoh/NRS/bin

./reinitialize_nrs.sh

3. Delete RC Gate Software

cd /

rm �rf Ricoh

Page 71: RC Gate Server Service Manual - kot320.dyndns.bizkot320.dyndns.biz/man/02/rcgate/s_rcgate.pdf · NIC CONFIGURATION ... Configuration Message Options ... The purpose of this guide

71

Upgrading Software from CD

The following procedure is used for installing the RC Gate Server Software from CD following the steps above.

1. Insert the RC Gate Software CD

2. Open the shell prompt screen and type cd /mnt/cdrom

3. Type./nrs_installer to run the installer script

4. After installing the RC Gate software, the user will need to reboot the server by typing reboot at the command prompt.

Restoring Server Configuration

1. Login to RC Gate Server from a laptop (PC)

User Name: nrsadmin

Password: nrsadmin

2. Click on �Import Server Configuration� under �Admin Tools�.

3. Click on �Browse�

4. Select �RC_GateServer.conf� which was saved previously. (Refer to backing up server configuration)

5. Click on �Import�. This will restore previously backed up Server Configuration.

6. Click on �Server Configuration� and press �Apply� to configure the Server.

Follow steps described in �Discovery Configuration� to configure discovery settings.

Page 72: RC Gate Server Service Manual - kot320.dyndns.bizkot320.dyndns.biz/man/02/rcgate/s_rcgate.pdf · NIC CONFIGURATION ... Configuration Message Options ... The purpose of this guide

72

Appendix A � Installing the RC Gate Environment

Installing the RC Gate Environment for the first time

For manufacturer only The following section is written for ProMicro or whoever will be Installing and RC Gate Environment for the first time. This includes installing the Linux operating system, installing the NICs, Server Software, and MySQL server.

NOTE: Accept all defaults unless otherwise noted

Installing Linux RedHat 7.2 Server

1. Insert the Linux RedHat 7.2installation cd1 on cdrom drive and reboot the server box Click on the foot print icon on the task bar. Select and click log out. Select reboot and click on �Yes�.

2. Choose to install in graphical mode

3. Language selection � highlight English (default). Click next.

4. Keyboard configuration � generic 105, layout = 105 English, dead keys = enable (defaults). Click next.

5. Mouse configuration � select appropriate model mouse. Click next.

6. Welcome to RedHat. Click next.

7. Choose to install server. Click next.

8. Choose the option of installer automatically partition. Click next.

9. Select remove all partitions on this system. Click next.

10. Click �Yes� on warning screen.

11. Click �Reset� on partition screen.

12. Click to highlight /dev/hda2 and click on �Edit�. Mount point should be �/�. Click to select �Format partition as �ext3�. Click �OK�.

13. Click �Add Anyway� on warning screen.

14. Click to highlight /dev/hda1 and click on �Edit�. Mount point should be �/boot�. Click to select �Format partition as ext3�. Click �OK�.

15. Click to highlight existing swap partition. Click on �Delete�.

16. Click to highlight FreeSpace and click �New�.

17. Set FileSystemType as swap from drop down listing. Set size MB = 500, Click OK.

18. Partition screen should resemble figure 1 below.

Figure 1 Start End Size Type Mount Point Format

Page 73: RC Gate Server Service Manual - kot320.dyndns.bizkot320.dyndns.biz/man/02/rcgate/s_rcgate.pdf · NIC CONFIGURATION ... Configuration Message Options ... The purpose of this guide

73

Dev/hda

|----------- dev/hda1 1 6 47 ext3 /boot Yes

|----------- dev/hda2 7 2301 18003 ext3 / Yes

|----------- dev/hda3 2302 2365 502 swap Yes

|----------- Free 2366 2491 988 FreeSpace

19. Click �Next� then click �Yes� on warning screen about formatting.

20. Boot loader installation screen � accept all defaults (Use GRUB as the boot loader, install boot loader record on: /dev/had master boot record (MBR), partition /dev/hda2 default boot image select, boot label = RedHat Linux.) Click �Next�.

21. Do not use a GRUB password. Click �Next�.

22. On network configuration screen, select activate on boot and uncheck configure using DHCP for eth0 only. Click �Next�.

23. Select No firewall option. Click �Next�

24. Language support selection = English (USA). Click �Next�.

25. Time Zone selection � set for appropriate time zone. Click �Next�.

26. Account Configuration � set root password = �password� (lower case only). Click �Next�.

27. Select Classic X windows, X Windows, and GNOME options. (First three options on page) Click �Next� and wait for the installation to continue

28. Video Configuration � accept default highlighted. Click �Next�.

29. Click �Next�. NOTE: Once you click next, the installation program will begin. Once this process starts, it cannot be undone. It will take several minutes for it to load all necessary software.

30. Insert Linux installation cd2 when prompted and click �OK� and wait for installation to complete

31. Select �Skip boot disk creation� and click �Next�.

32. Monitor selection � accept defaults and click �Next�.

33. Custom X Configuration - accept defaults and click �Next�.

34. Click �Exit� and remove the CD when the system ejects it. System should reboot and bring up the login screen. Login as �root� and password is �password�.

35. Set the display resolution to 800x600 and Refresh Rate to 75Hz

36. Proceed to next section

Installing the second NIC on Linux RedHat 7.2

1. Click on foot print icon on task bar. Select programs, system, network configuration and left click.

2. Highlight the eth1 and delete it. Click �Yes� on warning screen.

3. Select the �Devices� option.

4. Click �Add�. Device type = Ethernet, click �OK�.

5. Nickname = eht1. Select �Activate device when computer starts.�

Page 74: RC Gate Server Service Manual - kot320.dyndns.bizkot320.dyndns.biz/man/02/rcgate/s_rcgate.pdf · NIC CONFIGURATION ... Configuration Message Options ... The purpose of this guide

74

6. Click �Protocols� and click �Edit�.

7. Uncheck �Automatically obtain IP Address settings with DHCP�.

8. Enter:

IP Address = 172.20.10.2

Subnet = 255.255.255.0

Default Gateway Address = 172.20.10.1.

9. Click �OK�

10. Click �Hardware Devices�. Change hardware device to eth1 (from drop down listing). Click �OK, then click �Apply�, the click �Close�, click �Yes� on save changes screen.

11. Reboot the server.

12. When prompted: login = root password = password

Installing MySQL Server

1. At the Shell prompt change Directory to /root/Ricoh/NRS/bin

2. Type ./installMySQL.sh to run the installer script

3. Once installation is complete, the server is ready for use

Note: Accept all defaults unless otherwise noted

Installing the RC Gate Server Software From CD

The following procedure is used for installing the RC Gate Server Software from CD following the steps above.

1. Insert the RC Gate Software CD

2. Open the shell prompt screen and type cd /mnt/cdrom

3. Type./nrs_installer to run the installer script

4. After installing the RC Gate software, the user will need to reboot the server

END OF DOCUMENT