RMS (Retail Management Systems)

Installing the Cardknox RMS Plugin

This document includes instructions for installing the Cardknox integration for RMS. Click here for RMH (Retail Managment Hero) documentation instead.

System Requirements

.Net Framework 4 and above

Installation Instructions for Credit Cards

Enable Cardknox payment processing on RMS point-of-sale systems.

PART 1: Prepare each computer

  1. Run a Z Report:
    1. Open the Store Operations POS.
    2. Press F5.
    3. Select Print Z Report.
  2. Close the Store Operations POS.
  3. Go to the Store Operations Administrator and click
    File > Configuration > EDC.
  4. Select Do not use electronic capture draft software and click OK.
  5. Repeat steps 1 and 2 on each register.

PART 2: Download and run the software

  1. Download the Cardknox Updater plugin:
    https://cdn.cardknox.com/dl/updater.exe
  2. Right-click on the downloaded program (Updater.exe), then click Run as administrator and choose Yes when prompted.
  3. An input box will appear. Type fidelipayrms and click Enter.
  4. You will be prompted to enter your Cardknox key and Merchant ID. (Developers
    should use their Cardknox test key and 123456 for the MID for testing.)

Installation Instructions for Other Payment Types

The following steps will enable additional payment types on the Cardknox
gateway.

Installing Credit Card Capabilities

  1. Open the Store Operations Manager and go to Database > Tender Types.
  2. If Credit Card is not listed:
    1. Click on New.
    2. Type Credit Card in the Description field.
    3. Set the Tender Code and Display Order values.
  3. Click OK.
  4. Click Close.

Installing EBT Capabilities
PART 1: Configure or create EBTFS as a tender type

  1. Open the Store Operations Manager and go to Database > Tender Types.
  2. If EBTFS is listed as an existing tender type, select it, click on Properties, and continue to the next step. If it is not listed:
    1. Click on New.
    2. Type EBTFS in the Description field.
    3. Set the Tender Code and Display Order values.
  3. In the Tender Type dropdown, select Food Stamps.
  4. Click OK.
  5. Click Close.

PART 2: Add an EBTFS button

  1. Go to Database > Registers > Custom POS Buttons.
  2. Click New.
  3. On the popup window, fill in several fields:
    1. For the Style box, choose COM OBJECT (Session Object).
    2. For Caption, type EBT Balance.
    3. For Command, type
      FidelipayRMS.GetEBTFSBalance.
  4. Click OK.
  5. Click Close.

Installing Gift Card Capabilities
PART 1: Configure or create gift cards as a tender type

  1. Open the Store Operations Manager and go to Database > Tender Types.
  2. If Gift Card is listed as an existing tender type, select it and click Properties. Continue to the next step. If it is not listed:
    1. Click on New.
    2. Type Gift Card in the Description field.
    3. Type GC as the Tender Code.
    4. Set the Display Order value you desire.
  3. In the Tender Type dropdown, select Other.
  4. Click OK.
  5. Click Close.

PART 2: Add a Gift Card button

  1. Navigate to Database > Registers > Custom POS Buttons.
  2. Click New.
  3. In the window the pops up, you’ll need to fill in several fields:
    1. For the Style box, choose COM OBJECT (Session Object).
    2. For Caption, type Gift Card Balance.
    3. For Command, type
      FidelipayRMS.GetGiftBalance.
  4. Click OK.
  5. Click Close.

PART 3: Set option to enter price at POS

  1. Navigate to Database > Items.
  2. Check if the Gift Card item exists. The description for the item should be
    Gift Card. If it is listed, select the item and click on Properties and continue to the next step. If it is not listed:

    1. Click on New.
    2. Select on Standard Item and click OK.
    3. Set Item Lookup Code as gc.
  3. Select the Inventory tab and enter the appropriate
    information.
  4. Select the Options tab.
  5. Enable Must enter price at the POS.
  6. Click OK.

Installing Tokens

The following steps will enable you to securely save cardholder information for future use.
PART 1: Enable tokens on your POS

  1. Run C:\FPS_RMS_Plugin\FidelipayRMS.exe.
  2. Go to the FidelipayRMSSettings tab:
    1. EnableTokenization, 1
    2. DB_Database, [YourDatabaseName]
    3. DB_Username, [YourDatabaseUserName]
    4. DB_Server, [YourServerIpAddress]
    5. DB_Password [YourPassword]
    6. Click Test Connection.
  3. Close and save the Settings file.

PART 2: Add a Tokens button

  1. Open the Store Operations Manager and go to
    Database > Registers > Custom POS Buttons.
  2. Click New.
  3. On the popup window, fill in several fields:
    1. For the Style box, choose
      COM OBJECT (Session Object).
    2. For Caption, type Save Card.
    3. For Command, type FidelipayRMS.SaveCard.
  4. Click OK.
  5. If Store Operations POS is currently running, restart it. If not, open it.
  6. Click on Saved Card to test.

Connecting a Credit Card Pin Pad

PART 1: Download the device drivers
For VeriFone Mx devices: 32 bit:
cdn.cardknox.com/pe/drivers/verifone/verifone_unified_driver_installer_32.msi

64 bit:
cdn.cardknox.com/pe/drivers/verifone/verifone_unified_driver_installer_64.msi

For VeriFone Vx805 devices (backup driver):
https://www.cardknox.com/dl/Vx805_USB.exe
PART 2: Connect your terminal to RMS

  1. Navigate to C:\FPS_RMS_Plugin\FidelipayRMS.exe.
  2. Complete the form with the appropriate device settings.
  3. Restart RMS and run a test transaction.

Receipts Updater

The following steps enable a merchant using the RMS software to add the last 4 digits of the credit card (as well as the Cardknox transaction reference number) to the customer receipt.
PART 1: Locate the receipt currently in use

  1. In Store Operations Manager, go to Database > Registers > Register List.
  2. Select a register that is currently used and on which you wish to base the receipt.
  3. Click Properties.
  4. Click on the Receipt Printer 1 tab.
  5. The receipt currently in use can be found in the Receipt Format field.

PART 2: Save the current receipt

  1. In the Store Operations Manager, go to Database > Registers > Receipt Formats.
  2. Select the sales receipt that is currently used.
  3. Click Properties.
  4. Use the Save As command to save the receipt as
    CurrentReceipt to the following location:
    C:\Program Files\Microsoft Retail Management System\StoreOperations\ReceiptTemplates

PART 3: Update RMS through the desktop icon

  1. Open Store Operations Manager and go to Database > Registers > Receipt Formats.
  2. On the right side of the window, click New.
  3. Type plugin_receipt into both the Title and Description fields.
  4. In the Sales field, click the magnifying glass.
  5. Go to the following plugin folder:
    C:\Program Files\Microsoft RetailManagementSystem\StoreOperations\ReceiptTemplates\Plugin
  6. Select the current receipt name and click Open.
  7. When you are prompted to update all transaction types, click Yes.
  8. The Report box will still not have a file. Click the magnifying glass, select XReport.xml, and click Open.
  9. Click OK and close the Receipt Formats window.

PART 4: Select the receipt format for each register

  1. Go to Database > Registers > Register List and complete the following steps for each register:
    1. Select the register and click Properties.
    2. Choose the Receipt Printer 1 tab.
    3. In the Receipt Format box, click the magnifying glass.
    4. Select plugin_receipt and click OK.
  2. After this has been completed for all of the registers, close the Registers window and restart the POS.

Note: Receipts generated by these instructions do not display an EBT or gift card balance. To add this capability, please email integration@cardknox.com.