Configuring the Loyalty Driver

  1. Select the Enterprise, property, or revenue center, click Setup, and then click Loyalty Driver.
  2. Insert a record and enter an appropriate gift and loyalty driver name.

    If you are using Valutec, you can name the driver record VTLoyaltyDriver.

  3. Double-click the record to open it.
  4. On the General tab, click the Import from a file link.
  5. Browse to [Drive Letter]:\MICROS\Simphony2\EgatewayService\handlers, select LoyaltyCommandModule.dll, and then click Open.

    If you are using Valuetec, select VTLoyaltyCommandModule.dll, and then click Open.

  6. Click the Configuration tab.
  7. From the Assembly/Class section, enter information in the following fields:

    Table 48-4 Assembly/Class Fields

    Field Description

    Module ID

    Enter the module identification (for example, LoyaltyDriver or VTLoyaltyDriver).

    Display Name

    Enter a name for the module (for example, Loyalty Driver or VTLoyaltyDriver).

    Description

    Enter a description for the module (for example, Loyalty Driver or VTLoyaltyDriver). Do not leave this field blank.

  8. From the iCareDriver Properties section, enter information in the following fields:

    If you are using Valutec, skip to Step 9.

    Table 48-5 iCareDriver Properties Fields

    Field Description

    Account Length

    Enter the number of digits for the loyalty account number.

    Account Prefix

    Enter the prefix for the account number.

    For example, if the card rule dictates that all account numbers start with 01013 and the Account Length is always 16, the following configuration allows you to enter the last digits (starting with the first non-zero digit), and the account number is concatenated as Prefix + padding zeroes + user input = where the number of padding zeroes ensures that the account length is correct.

    This image shows the Account Number Prefix.

    Certificate File

    If the property implemented a unique certificate file, specify the location of the certificate file on the local machine.

    Communications Offline Retry Count

    This value is the number of transactions that workstation operators can complete offline before attempting an online transaction. You cannot change the value in this field as it is based on the Tender Media or Service Charge records configured for offline use.

    Communications Timeout Seconds

    You cannot change the value in this field as it is based on the Tender Media or Service Charge records configured for offline use.

    Log iCare Client Debug Data

    If the client is using Gift and Loyalty, indicate whether the application includes debug information in the log file.

    Log iCare Client Message Data

    If the client is using Gift and Loyalty, indicate whether the application includes client messages in the log file.

    Login

    Leave this field blank at the Enterprise level. This value is set at the property level.

    Password

    Leave this field blank at the Enterprise level. This value is set at the property level.

    Web Address

    Enter the path to Gift and Loyalty, including location, port number and service path. Use the following format: https://[GiftLoyaltyLocation]:[GiftLoyaltyPortNumber]/ws/services/StoredValueService.

    If the property is using a third-party payment provider application (rather than Gift and Loyalty), enter the path to the third-party payment provider application. This can be a Web address or a local path.

  9. (Valutec only) In the Valutec Driver Properties section, enter information in the following fields:

    Table 48-6 Valutec Driver Properties Fields

    Field Description

    Client Key

    This value is provided by Valutec, and is used by the Valutec web service to identify the client.

    Terminal ID

    This value is provided by Valutec, and is used to identify each terminal initiating a transaction.

    Merchant ID

    This value is provided by Valutec, and is used to identify each merchant uniquely at the Valutec side.

    This number is used as an alternate number instead of the account number for loyalty operations.

  10. Click Save.