Gemcom32 Installation Guide

Transcription

1 Gemcom32 Installation Guide Gemcom32 is a software system that allows communications among third-party, back-office PC-based software, the VeriFone Ruby SuperSystem, and the Sapphire Mini-server. This software system allows for the retrieval of point of sale (POS) totals and modification of the POS configuration data. Versions prior to work with Ruby SuperSystem terminals, but cannot access the Sapphire Mini-server via the Ethernet. Versions and higher add the ability to transfer PLUs across an Ethernet connection to the Sapphire. Versions and higher add the ability to retrieve totals across the Ethernet connection from the Sapphire. Version includes significant enhancements and corrections and provides improvements in error detection and reporting. Version replaces the custom setup options to include Sapphire communication components. This version (or greater) is required when Sapphire with GTIN (14-digit PLU numbers) is used. Version provides compatibility with CISP (Cardholder Information Security Program) standards for applications at Base 158 or higher. Version includes SSL, PAYROLL and NE2TOT datasets, and network totals by batch. In addition, this version eliminates random Sapphire password failures, works with the Microsoft Windows DEP feature, and automatically applies software updates from future Sapphire applications. See the Gemcom32 Release Notes for detailed information. Contents Overview Naming Conventions System Requirements Hardware Configuration Software Installation Configuration Settings

2 Overview The Gemcom32 installation consists of two software components: Gemcom/Ruby A set of one or more load modules for the Ruby terminal or Sapphire Mini-server that are placed on these systems during initial installation. Gemcom32 The PC utility program developed and released independently of Ruby, Sapphire, and Topaz application software. These two components communicate with each other using a direct RS-232 connection between the PC and the Ruby/Sapphire system using RubyLink communication protocol. When the Sapphire Mini-server is present, an additional Ethernet connection can be used to send and retrieve datasets and totals. This additional Ethernet connection is required for use with the Topaz. Note: The Gemcom32 installation instructions provided in this document replace those found in the Gemcom Application References. 2

3 Naming Conventions Convention Description CISP Gemcom16 Gemcom32 Gemcom Gemcom/PC Gemcom protocol Gemcom/Ruby GemcomXML Java Runtime Environment Ruby SuperSystem RubyLink protocol Rubylink.dll Rubylink.ini Ruby Manager Sapphire Topaz Refers exclusively to the Cardholder Information Security Program. CISP is used by credit card companies to ensure the privacy and security of financial data. Refers exclusively to the legacy, MS-DOS -based, PC utility program, formerly referred to as Gemcom in earlier versions of this documentation. Refers exclusively to the 32-bit Microsoft Windows console-mode program. For the purposes of this document, Gemcom refers to Gemcom32. Refers collectively to Gemcom16 and Gemcom32. The communications protocol that Gemcom16 uses to communicate with the Ruby terminal. Refers collectively to the load modules for the Ruby terminal that communicate over either the Gemcom protocol or RubyLink protocol. A Java -based program internally used by Gemcom32 and RubyLink to provide data transfer with Sapphire via Ethernet. Java is a software-only platform that runs on top of other hardware-based platforms. One or more Ruby terminals connected together as a system. The communications protocol that Gemcom32 uses to communicate with the Ruby terminal, Sapphire Miniserver, and Topaz workstation. RubyLink Dynamic Link Library file needed for Gemcom/RubyLink communications. The settings in this file determine whether data and/or totals are transferred using the serial or the Ethernet connection. This includes Ruby Manager connectivity, if applicable. A software application that manages Ruby Super Systems, Sapphire and Topaz data files, as well as totals. The Sapphire Mini-server. The touch-screen workstation. 3

4 System Requirements To install Gemcom32, your computer system must meet the following minimum requirements: Pentium 166 MHz or faster processor 200 MB free hard disk space, 64 MB RAM Mouse CD-ROM Drive One of the following operating systems: Microsoft Windows 2000 Professional Service Pack 3 Microsoft Windows XP Professional In addition, each Ruby terminal or Sapphire Mini-server that is accessed using Gemcom32 must have Gemcom/RubyLink software installed. At least one Ruby terminal (or the Sapphire Mini-server, if present) must have a serial data COM port configured for RubyLink. For Sapphire, an Ethernet connection is required if Supersized PLUs or Topaz is used. Note: Gemcom/RubyLink is an installation option in Gemstall. Cables The following cables are required: Ethernet cable (P/N XX) from each Topaz workstation to the hub and/or router If a hub is used, an additional Ethernet cable (P/N XX) to the router RS-232 cable (P/N XX) Null Modem Adapter (P/N ) Note: For more information, see the Sapphire Hardware Installation Guide (P/N 55404), the HPV-20 Installation Guide (P/N 55488), and the Topaz Installation Guide (P/N 22696). 4

5 Hardware Configuration Following are brief descriptions of setting up the hardware for Ruby terminals, Sapphire Mini-servers, and Topaz workstations to install Gemcom32 software. RS-232 Back Office PC HPV-20 (Manager s Control Station) Ethernet Sapphire Mini-server Router Sapphire Mini-server The Sapphire Mini-server hardware configuration requires a router and an Ethernet card in the PC that is using Gemcom Connect an Ethernet cable (P/N XX) to the Ethernet port on the Sapphire Mini-server. 2. Plug the other end of the Ethernet cable into the router. 3. If a built-in serial port is not available on the PC, plug a serial converter into the USB port on the PC. 4. Connect a 9-pin null modem adaptor to the PC serial port. 5. Connect an RS-232 cable (P/N ) from the null modem adaptor on the PC to the designated RubyLink COM port on the Sapphire Mini-server. Note: Serial RJ-45 cables and Ethernet cables do not have the same pinouts and are NOT interchangeable. Note: Even if you intend to transfer data using the Ethernet connection, the serial data cable between the back office PC and the Sapphire is still required for most installations. 5

6 Ruby SuperSystem To connect the PC to a Ruby terminal, do the following: 1. If a built-in serial port is not available on the PC, plug a serial converter into the USB port on the PC. 2. Connect a 9-pin null modem adaptor to the PC serial port. 3. Plug an RS-232 cable (P/N ) into the null modem adaptor and connect it to a communications port on the Ruby terminal. HPV-20 Run an Ethernet cable from the HPV-20 Ethernet port to the router. Topaz Workstation 1. Connect an Ethernet cable (P/N XX) to the Ethernet port on the Topaz workstation. 2. Plug the other end of the Ethernet cable into the router. 6

7 Software Installation 1. Download Gemcom32 from the VeriFone Premier Web Portal. 2. Unzip the files and double-click on Gemcom32.msi. 3. At the Welcome dialog box, click Next to continue the installation. 4. Click I accept the terms of the license agreement. (If you do not accept the terms, click Cancel to quit the installation.) 5. Click Next. 6. Click Next to install on the default Destination Folder. (Click Change to select a new Destination Folder, click OK and Next.) 7

8 7. Select one of the following installation types: Complete Installs all program features. Click Next. Go to Step 8. Custom Installs selected features. Click Next. The Custom Setup screen appears. a. Click Space to learn the disk space requirements, and click OK. b. Select the components to install. c. Click Change to select a new Destination Folder and click OK. d. Click Next. 8

9 8. Click Install to continue installation. A message box shows the installation progress. After this phase of the installation, the Certificate dialog box appears. 9. To enable the certificate that makes Sapphire a trusted site, click Install Certificate. The Certificate Import Wizard appears. 9

10 10.To continue the process, read the information and click Next. The Certificate Store dialog box appears. 11. Select the storage area for this certificate and click Next. The dialog box displays your selection. 10

11 12.If you want to make changes, click Back; otherwise, click Finish. The Security Warning message appears. 13.Read the information and click Yes. The success message appears. 14.Click OK. Click OK again on the Certificate dialog box. The Adjust / Test Settings dialog box appears. 11

12 The following table explains how to use the Adjust / Test Settings dialog box. Element Transfer Method Totals Override Sapphire Default Host Settings. Disable secure (SSL) communications Java Runtime Environment Settings Search Actions Select one of the following: Sapphire/Ruby Serial Port Gemcom32 uses serial communications. Sapphire Ethernet Port Gemcom32 uses Ethernet communications to send and retrieve PLU data. Select to retrieve totals from the Sapphire Ethernet communication. Select to override Sapphire default host settings. Enter the following: IP address Port number Select to communicate without a secure connection. Click to change the Java Home Directory. A directory screen appears. Click the down arrow to select a new directory. Click Open to continue. Do one of the following: Click Search registry and click Search to locate a Java file. Click Search directories and click Search to locate all Java files. 12

13 Element Available Logs Actions Click the down arrow and select an available log. Click View. Tests Test the Sapphire connection Test the Java Runtime Environment Gemcom Tests Select and click Test to verify that the Sapphire Mini-server is communicating with the Ruby. Select and click Test to verify that the Java Runtime Environment is present and that the version is 1.41 or higher. If an error message appears and the Java Runtime Environment is absent or is a version lower than 1.41, see Java Runtime Environment 1.41 or higher is not installed at the end of this table. Select from the following: Select Test Pushing PLUs to verify that PLUs can be sent to the Sapphire or Ruby and click Test. This test uses both Ethernet and serial communications, or just serial communications depending on the configuration. Select Test Pulling Version Information to verify that the version data can be pulled from the Sapphire and click Test. This test uses serial communications. Other CISP Generate New Password (May appear when the Test or Save button is clicked.) Enter Administrator Username and Password. Click Generate. Password Expired If the administrator s password for generating the Gemcom account password has expired, the Password Expired dialog box appears. Enter the old password, enter the new password, enter the new password again in Verify New Password. Click OK. 13

14 Element Java Runtime Environment 1.41 or higher is not installed Actions Do one of the following: Uninstall Gemcom32 and reinstall with the Custom installation type selected. Open Sapphire communications components in the Custom dialog box and select This feature will not be available. Only Gemcom32 is then installed. Do not install GemcomXML. (This setup disables the ability to communicate with a Sapphire.) Install the Java Runtime Environment from the VeriFone Premier Web Portal. Double-click the install file that was extracted. Java Runtime Environment may also be downloaded from 15.After the tests are completed, click Exit. The InstallShield Wizard Completed dialog box appears. 16.Click Finish. 14

15 Configuration Settings Gemcom32 In order to communicate with Gemcom32 version or higher, the Ruby terminal, Sapphire Mini-server, and Topaz workstation require that RubyLink be installed on the PC. RubyLink is a Gemstall option offered during the installation of the Ruby terminal and/or Sapphire system software. Note: If any applications pointing specifically to gemcom.exe are currently installed, you may need to change the gemcom32.exe filename to gemcom.exe. RubyLink Comm Options The RubyLink Comm Options function allows you to change the communication settings chosen during installation. 1. Go to Start> Programs> Gemcom32 > RubyLink Comm Options. 2. Do one of the following: Click Adjust and Test RubyLink Settings. Click Run diagnostics. 3. Click Next. 15

16 Note: The directory from which the program was launched displays by default. 4. Do one of the following: Click Search to look for additional directories containing Gemcom 32 or RubyLink. This may take several minutes. Click Next. Adjust / Test Settings a. Make appropriate changes. See Software Installation > Adjust / Test Settings (step 14). b. Click Save to save the new settings or click Cancel to keep the current settings. c. Click Close when finished. 16

17 Run Diagnostics a. Click Update to update this directory. b. Click Repair to correct any issues. c. Click Close when finished by VeriFone, Inc. THIS DOCUMENT IS THE PROPERTY OF VERIFONE, AND CONTAINS VERIFONE CONFIDENTIAL AND PROPRIETARY INFORMATION. IN CONSIDERATION OF VERIFONE S DISCLOSURE OF THIS DOCUMENT TO YOU, YOU AGREE THAT NEITHER IT, NOR THE INFORMATION CONTAINED THEREIN SHALL BE DISCLOSED TO OTHERS OR DUPLICATED IN WHOLE OR IN PART, OR USED FOR ANY PURPOSES OTHER THAN AGREED TO BY VERIFONE WITHOUT THE EXPRESS WRITTEN CONSENT OF VERIFONE. VeriFone, the VeriFone logo, and Ruby SuperSystem are registered trademarks of VeriFone, Inc. Sapphire, Topaz, HPV-20, Ruby Manager, Everest, EASY ID, Electronic Journal On-site, and Ruby Card are trademarks of VeriFone, Inc. in the U.S. and/or other countries. All other trademarks or brand names are the properties of their respective holders. Gemcom32 Installation Guide ( ) February

18 18