Follow

MICROS RES Install Guide

 

Installation

And

Configuration Notes

for MICROS Integration

 

 

Version 1.05

 

8/16/20174

 

 

 

 

 

 

 

 

 

 

© Copyright 2014 Ackroo Inc.

 

 

 

Table of Contents

 

Introduction.. 3

Prerequisites. 3

MICROS Configuration.. 4

Configure Interface. 4

Configure Menu Items. 7

Configure Tender Items. 12

Touchscreen Configuration.. 16

Edit svcServer.cfg. 18

Ackroo Configuration.. 19

Prerequisites. 19

Installation.. 19

Ackroo Configuration.. 22

Backing Up the Ackroo Settings. 24

Uninstalling Ackroo Application.. 24

Upgrading the Ackroo Application.. 24

Testing. 25

Troubleshooting. 25

Ackroo Customer Support. 26

 

 

 

 

 

Introduction

This document is intended to assist in the setup of the Ackroo Gift and Loyalty Program for a merchant using the MICROS RES 3700 system.

This document guides the user through setup of the Ackroo Integration module as well as the configuration settings needed in MICROS in order to process Ackroo gift and loyalty transactions from the MICROS frontend.

 

 

 

 

Prerequisites

 

The MICROS RES3700 system must have the Stored Value Card (SVC) driver installed. This is not on the system by default. Refer to the Stored Value Card Installation and Setup guide ‘MICROS Stored Value v4.0.pdf”. Refer to all steps in this document to install SVC.

In addition to run the Ackroo Application you will have to install the following Microsoft libraries. These items are downloadable from Microsoft Download Center

 

 

 

 

MICROS Configuration

 

Configure Interface

 

  1. In POS Configurator, select Devices tab and click on Interfaces

 

 

 

 

 

  1. Add a new interface and name it msvc-ackroo (it must be this name). Be sure to note the Number (Id) of the newly created interface.

 

 

  1. Save and exit from the Interfaces screen.
  2. Copy the svc.isl file from the SVC installation directory (e.g. D:/MICROS/ProfessionalServices/StoredValueCard) to the MICROS/Res/Pos/Etc directory and rename it to pmsX.isl where X is the number of the Ackroo interface. From the example above, the file should be name “pms99.isl”.

 

 

 

 

Configure Menu Items

 

  1. Select Sales tab

 

 

 

  1. Click on the Menu Items Classes button.

Create a new menu item class for Ackroo.  

As shown below, the Description page must have a valid Sales Itemizer set, and Tax Class must be set to NO TAX.

 

On the General Options tab, the only item checked should be the ‘Reference required’, no other items should be checked.

 

On the remaining tabs nothing should be checked. See below for the ‘Display’ and ‘Price/Totals’ tabs.

Create Gift Card funding (issuance) menu items.

 

 

Create an Item for Ackroo Gift Card as well as for Loyalty Card, both are setup in the same way with the same options set exactly.

Note the Number (id) of the newly created records, as they will be needed for other parts of the setup.

The Menu Class must be set to the class id created in the previous step. The Menu Level Class must be set to ‘ALL LEVELS’. Print Class should be set to ‘Guest Check Only’.

 

The Groups tab generally has all fields blank, unless menu group required by customer.

 

 

Reporting tab must have a major group and family group selected.

 

 

All remaining tabs should be blank or unchecked including the Prices tab.

 

 

 

 

 

 

 

 

Configure Tender Items

 

  1. Create Tender/Media items.   Click on Tender / Media button.

Create a tender item for Ackroo gift card redemption and one for Loyalty redemption. Both will be the same setup.

 

All new tenders must be added to tracking totals.

Note the Number (id) of the newly created records, as they will be needed for other parts of the setup.

On the General Tab, Type must be Payment, Exempted Tax Class should be Blank, Print Class should be Guest Check Only and Menu Level Class should be All Levels. See screen shot below.

 

 

 

On the Tender tab you will need to check Reference Required, Item is Shareable and Post to gross receipts. You may want to also check ‘Require amount entry’. If not checked then the full amount of the bill is the default. It is possible that this checkbox will differ depending on the desired behavior for Gift vs. Loyalty redemptions.

 

On the PMS tab the first two checkboxes should be selected.

All remaining tabs should have blank fields and empty checkboxes.

 

 

  1. Setup a Send Order command.

If you don’t have a Send Order command setup already, you will need to create one. Type must be Service Total.

 

You must note the number associated with this command, it will be entered into the configuration file.

 

 

 

Touchscreen Configuration

 

For more information please refer to the Stored Value Card Installation and Setup guide ‘MICROS Stored Value v4.0.pdf”.

The screen shots below are examples of how to configure the MICROS user interface to add buttons and [optionally] screens that initiate SVC transactions.

If necessary, you can add a new screen rather than modifying an existing screen. This is a 2 step process.

First, create the new screen by pressing Touchscreens button under the Devices tab in POSConfigurator. Add a new record by clicking the blue + icon in the toolbar.

Second, click Touchscreen Designer button and select your newly created screen from the drop down list in the upper left corner. Add the desired buttons to the screen.

Recommendation: Use an existing screen that has the same structure and format as a guide when creating a new screen. You can go back and forth between the reference screen and your screen adding buttons and configuring them similarly, and then adding customizing your screen as desired.

As shown below, to configure a button to call SVC, you need to set the Category to SIM/PMS Inquire, select the device interface you previously configured for Interface, and enter the Inquire Number as listed here:

Function

 

Inquire #

Issue Gift Card

 

1

Redeem Gift Card

 

10

Gift Card Balance

 

5

Issue Loyalty

 

7

Redeem Loyalty

 

8

Loyalty Balance

 

9

 

 

Edit svcServer.cfg

This file should be in the MICROS installation dir.
(typically D:/MICROS/ProfessionalServices/StoredValueCard)

 

 

  1. In the cfg file you will find various MICROS settings at the start of the file. Likely some of these have already been customized for the business. For example the text after ‘SiteName’ will show up as the business name on the receipt. Below is part of this file:

 

SiteName                           The Ackroo Café
SiteID                              1
RoundPoints                         N
SendOrderItem                       903
LocalCurrency                       CAD

  1. When setting up the Tender/Media you created a Send Order command. This ID Number must be entered into the config file on the line with ‘SendOrderItem’ in our example this was 903.
  2. The LocalCurrency setting should be CAD for Canadian dollars and USD for US dollars.
  3. The RoundPoints should be set to N in most situations. Ackroo normally uses dollar based loyalty with decimals, so N will cause the MICROS system to show the full decimal amount. If the merchant is using Ackroo Points then this should be set to Y.
  4. There may be other settings in this section which are useful to set or modify.

 

  1. Add or modify the section with ‘msvc’ options as shown below:

 

 

#

# Stand-alone Host-Adapter Settings

#

# Replace #xxxx-xxxx with message name assigned to

# interface.

 

msvc-ackroo-address                     127.0.0.1

msvc-ackroo-port                       8255

msvc-ackroo-protocol-version           1

msvc-ackroo-send-check-summary         Y

msvc-ackroo-prompt-for-points          N

msvc-ackroo-offline-tender             0

msvc-ackroo-allow-tip-on-redeem         Y

msvc-ackroo-prompt-for-auth-on-reversal Y

 

Make sure the –address matches the machine where the Ackroo MICROS Integration will run and the –port is not in use by any other process.

 

 

 

Ackroo Configuration

 

Prerequisites

If you didn’t install these items already, it must be done before continuing:

 

Installation

  1. Unzip (if necessary) and run the AckrooMicrosIntegrationSetup.exe

  • Click ‘Next >’ to continue installation…

  • Normally use the default location given for the installation, but you may enter the desired installation location (using browse if necessary) and click ‘Next >’.

  • Enter or select the Start Menu folder and click ‘Next >’.

  • Review installation settings and click ‘< Back’ to make changes on previous panels. Otherwise, click ‘Install’ to begin installation.

  • Once the installation is completed, click ‘Finish’ to exit the installer.

 

Ackroo Configuration

 

  1. Run exe located in the MICROS Ackroo Micros Integration installation directory.
  2. The Ackroo tab configures the connection to the Ackroo Server.

The Host URL is normally ‘api.ackroo.net’ unless otherwise specified by Ackroo support. The Host Port currently will always be 443.

Ackroo Support Staff will assign a 16 digit Client ID to the merchant. This will be entered into the Client ID field. The Client PIN is not necessary in this case. It is also not necessary to click the Register button.

The client ID is then entered along with the given PIN number and then click ‘Register’. This will connect to the Ackroo Server and complete the setup of the MICROS terminal. 

  1. Select the MICROS

 

    4. Enter the codes for the corresponding menu items/service charges/tenders.

  1. For menu items, the code must be an ‘M’ followed by the number noted when creating the new menu item.
  2. For tenders, the code must be a ‘T’ followed by the number noted when creating the new tender.
  3. For service charges, the code must be an ‘S’ followed by the number noted when creating the new service charge.

 

  1. Make sure the MICROS SVC TCP Port number matches the port number configured in the cfg file.

 

  1. Click ‘Save’ to save the configuration and exit the configuration application.

 

  1. Go to Services (e.g. Control Panel -> Administrative Tools -> Services) and Start or Restart the Ackroo Management System Service

 

This service will need to be restarted any time that the Ackroo configuration is changed.

 

  1. Reboot the POS instance.

 

Backing Up the Ackroo Settings

If needed for backup purposes or for a system restore the Ackroo configuration settings are stored in the file: Ackoo.config.   This file will be in the installation directory. (e.g. D:\Micros\ProfessionalServices\Ackroo) Simply backup this file and restore as necessary.

 

Uninstalling Ackroo Application

If necessary backup the Ackroo.config file as described in the previous section, as this file will be removed if the application is uninstalled.

To uninstall the application go to the Control Panel – “Add or Remove Programs” or “Programs and Features”.   Select ‘Ackroo Micros Integration” and select Remove or Uninstall.

 

Upgrading the Ackroo Application

There is no automatic upgrade procedure. If a new version must be installed follow this procedure.

  • Backup the Ackroo.config file
  • Uninstall the current version
  • Install the new version

See the appropriate sections for more information.

 

 

Testing

Once everything is setup some tests can be performed.

The easiest tests to run initially are to run balance checks or to redeem from an empty card. Balances should be zero and redemptions should fail with an error such as ‘Insufficient Funds’.

You may want to run some actual transactions to load a card with Gift Funds or Issue Loyalty. Note that these transactions may remain on the card, and you wouldn’t want to give a used card to a new customer. Discuss options with Ackroo Support in order to avoid this scenario.

If you want to do a complete test beyond ensuring that the basic connectivity is working. Here is a starting point:

  • Perform the basic transactions
    • Load/Sell Gift card
    • Issue Loyalty
    • Redeem Gift card
    • Redeem Loyalty dollars
    • Gift Balance Check
    • Loyalty Balance Check
  • Perform Redemption transactions for more than on the card.
  • If you have setup a Loyalty threshold (minimum) attempt to redeem less than this amount.
  • A card may need to be registered by the card holder (e.g. setup account with email) before loyalty can be redeemed.
  • Confirm that receipts are showing the correct/expected amounts.
  • Void a transaction and confirm balance is updated properly.

 

Troubleshooting

If problems are occurring here are some checks to perform.

  • Were you given a PIN? If yes – did you successfully register using the PIN?
  • Were you given a Client ID? Open the Ackroo Configuration Application: and check that there is a Client ID specified.
  • In the Ackroo Config Application check the Host URL and Host Port.
    • If necessary confirm with Ackroo support that these values are correct.
  • Check the Settings on the MICROS tab of the Ackroo Config Application. The entries here should start with M, T or S followed by a number. Check that these numbers match with the MICROS settings as described in the previous sections.
  • Check that the Touchscreen settings are correct and match the appropriate commands shown in that section.
  • There is an ackroo.log file in the logs directory below the Ackroo installation directory. (e.g. D:\MICROS\ProfessionalServices\Ackroo)   This file can be viewed, but ideally it can be send to Ackroo for investigation.
  • Ackroo can check server logs if necessary as well.

Ackroo Customer Support

 

If necessary contact Ackroo Customer Support using:

 

 

 

Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request

Comments