Skip to main content

Paytronix for Aloha: Installation Guide

A complete guide to installing or upgrading Paytronix products to integrate with Aloha POS systems.

Updated over 2 months ago

Overview

This guide is provided to support standard installations of Paytronix software to integrate with an Aloha POS; it does not cover every single contingency. It also does not cover using Aloha itself (or other software applications) in-depth. If you need help with something not covered by the guide, please contact a Solutions Consultant.

Installation

Installation is completed in three major steps, each covered in their own section of this guide:

  1. Aloha Database Configuration & Setup

  2. Installing Paytronix on BOH machine

  3. Installing Paytronix on Order Entry Terminals

Note: This guide covers both QS (Quick Service) and TS (Table Service) versions of Aloha. Section headings will specify if a process is unique to one version (e.g., TS Only, QS Only). If there is no notation, the instructions are the same for both versions. The biggest differences in instructions for the two versions are in the sections on button definitions and setup.

If you are using NCR Connected Payments, please call us before you begin the installation process.

Upgrading to a New Aloha Version

Upgrading to a new version of Aloha? Please call us before you begin your upgrade!

System Requirements

BOH Machine

Item

Requirement

Aloha POS Software

Version 12.3+, 15.1.29+, 19.x

Operating Systems

Windows 7

Windows 8

Windows 10

RAL

Version 17.5.5.26+

Landesk

Landesk is a security application suite often provided by NCR. It needs to be configured to allow you to install the necessary software. It can be difficult to determine if your BOH machine is running Landesk. If you are trying to install Java or the Paytronix Controller, and the install fails without specific errors, this can be due to Landesk. Your IT Department may need to contact NCR to see if Landesk is blocking software installations. If installs are being blocked by Landesk, your IT

Department will need to contact NCR Security to allow the install.

Java

(OpenJDK11 embedded in Paytronix Controller installation)

Other

You will need admin access to the BOH machine

Order Entry Terminals

Item

Requirement

Operating Systems

Windows 7, 8, or 10

Hardware Requirements

BOH Machine

  • 128 MB RAM (minimum)

  • 20 MB available RAM (minimum)

Order Entry Terminals

  • 32 MB RAM (minimum)

  • 4.5 MB available RAM (minimum)

  • All terminal hardware should be swipe tested

Licensing

In addition to your existing Aloha license(s), you will need two specific license options from Aloha to use Paytronix products:

  • POS License Option: Aloha Connect

  • Software License Option: Interface Terminals (sometimes called External Interface Terminals, or EIT)

Note: If you already have an EIT license for another application, you will need a separate EIT license for Paytronix. Paytronix will provide codes so you can update the license with NCR.

If you are unable to check a hardcopy of the Aloha license documentation, and you do not have the necessary license options to run Paytronix, you will only see an error after installation. For this reason, we highly encourage you to review a hardcopy of your Aloha license documentation before beginning installation. For more information on how to check your Aloha license documentation, please see Appendix D: How to Check for an Aloha Connect License.

Networking

A stable Internet connection is required to use Paytronix on Aloha. If a location’s Internet connection is down, loyalty accrual transactions will be queued and processed once you are back online. You cannot process gift card or loyalty redemption transactions without an Internet connection.

Paytronix Credentials (BOH MAC Addresses)

Each location’s BOH machine will each need a valid credential to communicate with Paytronix systems. You will need to provide Paytronix with a complete list of locations and their MAC addresses. Paytronix uses the MAC address you provide to create the credential. Submit this list as soon as you have it ready to avoid delays later in the installation process.

Important Notes

In some parts of this guide, we walk you through processes not owned by Paytronix (Aloha and Windows). While we do our best to keep this guide up to date, as we do not own Aloha or Windows code, there may be times when the instructions in this guide do not exactly match the most current changes in Aloha or Windows. If in doubt, if you have difficulty with non-Paytronix systems, please contact your organization’s IT Help Desk or a Technology Consultant.

Useful Acronyms & Lingo

Before you start, there are some acronyms and terms used throughout this guide that you will be helpful to know.

Acronym

Full Name

Notes

Aloha CFC

Aloha Configuration Center

This is the environment where you will be doing most of the setup and configuration. A few clients use Aloha Manager. For the purposes of this guide, Aloha CFC and Aloha Manager are

interchangeable.

BOH

Back of House machine

The computer or server that sits in the back of house (back office); the main machine that

controls all Order Entry Terminals.

PXC

Paytronix Controller

The Paytronix Controller is the software that

connects the BOH with Paytronix systems.

Aloha QS

Aloha Quick Service

Aloha QS and Aloha TS have slightly different functionality that affects how Paytronix integrates, and setup/configuration for

Paytronix on Aloha.

Aloha TS

Aloha Table Service

Aloha QS and Aloha TS have slightly different functionality that affects how Paytronix integrates, and setup/configuration for

Paytronix on Aloha.

Aloha RAL

Aloha Remote Application Loader

Support tool provided by Aloha to push changes/updates from BOH to all Order Entry Terminals in only a few steps. It also manages all Order Entry Terminal logins with encrypted passwords and provides other important

security layers.

Summary Sheet

The summary sheet provides some info specific to your setup and/or configuration based on your organization’s needs and programs. You will need to reference it frequently; we recommend printing it and using it as a checklist and reference during installation.

Pre-Installation Checklist:

  • Check all system requirements.

  • Check to see if Landesk is running.

  • Send MAC addresses for all BOH machines to Paytronix.

(If you do not know how to get the BOH machine’s MAC address, see Appendix A: Identifying a BOH Machine’s MAC address)

Information You will Need During Setup:

  • Paytronix login and password

  • Paytronix credential (for each BOH machine)

  • Merchant ID

  • Store Codes (Each location has its own Store Code)

  • PXC Version

  • Aloha Version

Aloha Configuration and Setup Specifics:

Program Element

Section

in Aloha CFC

Section

in This Guide

<Name> Function

<OBJ>

Aloha ID

Notes

POS User for special Paytronix Stored Value Functions

Employees

Create Manager User

Jobcode

Set up a NEW Jobcode; do not use an

existing one.

POS Access Level

Set up a NEW Access Level; do not

use an existing one.

POS/Manager User

The POS User is created by

referencing the newly created Jobcode and POS Access Level. This POS User runs in the background to restrict a couple of very specific Paytronix gift card functions.

Submenu

Submenus

Creating

Menus & Submenus (TS)

Paytronix

Submenus are used in Aloha TS. Actual Submenu names will vary with each client. CHECK TO SEE WHICH SUBMENUS THEY USE

Paytronix Manager

Panel

Panels

Creating

Menus & Submenus (QS)

Order Panel

Panels are used in Aloha QS and TS.

Actual Panel names will vary with each merchant. CHECK TO SEE WHICH PANELS THEY USE

Program Element

Section

in Aloha CFC

Section

in This Guide

<Name> Function

<OBJ>

Aloha ID

Notes

Menu Item

Items

Create Menu Items

Px Sell GC

OR

Px Add GC $

This is the Menu Item used to sell a

new gift card or to add value to an existing gift card.

Px Bulk Sell GC

This is the menu item used to sell

multiple gift cards each with the same amount (e.g., sell 10 gift cards, each worth $50 in one transaction).

Px Loyalty Activate

This menu item is only required if

membership in the loyalty program (with or without a card) will be sold for a fixed cost price at the POS. This fixed cost can be $0.

Px Loyalty Accrual

This menu item is used to add guest

activity to new or an existing loyalty account before the check closes.

Px Issue Comp $

Px Add Comp $

These are the Menu Items used to

issue a comp card, or to add value to an existing comp card.

Px Issue Product Comp

These menu items are used to issue

comp cards with specific products loaded to a guest account. It is most often used for guest recovery (e.g., free cup of coffee, dessert, etc.).

Exchange Card

This menu item allows transfer of all

account details (history, balance, etc.) from a previous card (broken, lost) to a new card.

$0.00 Placeholder

Item

QS ONLY. Used to prevent errors

with Paytronix Menu Items on check.

Category

Categories

Create Categories

PX Sales

All Paytronix Menu Items must be

assigned to a sales category. You can create a new sales category specifically for Paytronix Menu Items. You can assign Paytronix Menu Items to an existing sales category.

PX Non-Sales

Non-Sales categories can be used for

different kinds of tracking or reward eligibility on an as-needed basis.

Comp

Comps

Create Comps

Redeem Dollar

Comp

The comp function in Aloha is used to

execute reward redemptions (in both comp and loyalty programs). Reward definition is set up via PXS; it is executed on Aloha POS via either the Redeem Dollar Comp or the Redeem Product Comp function.

Redeem Product Comp


​

Program Element

Section

in Aloha CFC

Section

in This Guide

<Name> Function

<OBJ>

Aloha ID

Notes

Tender

Tenders

Create Tenders

SV SpeedPay

SV SpeedPay is a 1-step method of

gift card payment. When a gift card is swiped, the available balance will be verified. Any available balance will be applied to the check, and gift card balance will be reduced by the amount swiped. Tipping is possible but needs to be done as a separate transaction after payment is processed for the check.

SV Auth

When a gift card is swiped, the

balance is verified. Two receipts are printed: one for the merchant, one for the guest. The guest copy will have a line to add a tip and provide a signature. This process is similar to a credit card payment.

SV Final

The gift card is not swiped for this

step. It is a process at the POS to complete the transaction.

Configuration & Setup: Aloha Database

All changes are made on the BOH machine. All changes made on the BOH machine will need to be pushed out to the Order Entry Terminals using the Refresh Data function. Configuration and setup on the BOH machine and pushing changes to Order Entry Terminals is the most common process. However, some organizations can make changes at a corporate level, pushing changes to each location’s BOH and its Order Entry Terminals without having to do the configuration and setup on each BOH machine. If you have this option, we recommend it as it saves considerable time. Please call a Technology Consultant if you want guidance on how to proceed.

Authorize Paytronix – Edit Aloha License File

For security reasons, the magnetic stripe reader on your POS is locked; third-party applications cannot read card data as cards are swiped. Third-party applications cannot access data as a card is swiped unless you specifically authorize them. You authorize them by editing the Aloha License File to allow access to the magnetic stripe reader.

Note: Aloha Connect License and Interface Terminal License allow Paytronix to integrate with Aloha POS software, but they do not allow Paytronix to access magnetic strip data (which is needed for Paytronix functionality at the POS) by default.

To edit the Aloha License File, do the following on the BOH machine:

  1. Make a backup copy of the %LOCALDIR%\BIN\radacctl.lic file
    ​

  2. Search the radacctl.lic file for these strings:
    4;014K5W3@5:4>4R2<4J541@1T1?2F3R2Y4Y0Q2T0Q5W0>1R5O5T0T315E1Q4W5W 4Q1=3X4C1V2N

    470?4J3:3E3F4A4B2<4G541?1@1?2F4V0:4V0Q031Y5U2N1R5P3<145S5F1>4V5S451N 3X491V2J
    ​

  3. If you search and find both strings, no further action is needed. This is common in more current versions of Aloha.
    ​

  4. If you search and do not find the strings, do the following:

a. Edit the %LOCALDIR%\BIN\radacctl.lic file by adding both strings above to the bottom of the file.

b. Save the radacctl.lic file.

c. Refresh Data via Aloha CFC to push changes to all Order Entry Terminals (Utilities > Refresh Data).

Register Paytronix COM Object

You will need to register the Paytronix COM object on each BOH machine. You can do this remotely via a centralized configuration center, but each BOH must be updated.

To register the Paytronix COM object on the BOH machine, do the following:

  1. Log in to Aloha CFC with administrative privileges.
    ​

  2. Select Maintenance > Business > Store > Select store from the drop-down menu.
    ​

  3. Ensure that Use FOH COM interface tick box, if present, is checked.
    ​

  4. In the Interfaces section, there is a list of external integrated software components. If you integrate with other third-party applications, you may see them here. Enter the Paytronix COM object exactly as show below: PaytronixApplication.PxInterceptAloha
    ​
    (Note: There are no spaces in the text above).
    ​

  5. Click Save.
    ​

  6. Exit the Store > Store Settings window.
    ​

  7. To push these settings to all Order Entry Terminals, use Aloha CFC. Select Utilities > Refresh Data.

Restrict Sensitive Paytronix Functions with Jobcodes and Access Levels

Much like your existing Aloha users have different privileges and access associated with their accounts, you will need to set up access and permissions for Paytronix functions on Aloha. Not all users should have access to all Paytronix functions; some functions should be reserved for a limited pool of users.
​

We recommend not using existing Jobcodes and Access Levels; for best results, create new ones from scratch. Keep the Jobcode and Access Level for Paytronix functions separate from the ones contained in the general manager functions. Failure to do so may give too much access.
​

If you use Paytronix for gift cards, we highly recommend you create a Manager User. Creating a Manager User to restrict Paytronix functions helps mitigate two specific types of fraud:

  • Prevents a user from adjusting the SV Auth Tender – If you use SV Auth and SV Final for gift card redemptions, it prevents a user from adjusting the SV Auth Tender amount and locks it at 0.
    ​

  • Tip cannot exceed gift card balance – This prevents a user from specifying a tip amount that exceeds the amount of value remaining on the gift card. The tip amount will be automatically updated to the remaining balance on the gift card.

The custom Paytronix Manager user is also required when using SV Auth and SV Final to account for a manager approval prompt introduced in Aloha POS 16.1. Without the Paytronix Manager user, the SV Auth and SV Final redemption would not process properly.

Create Custom Jobcode and Custom Access Level

To set up a Jobcode and Access Level to restrict sensitive Paytronix functions, do the following:

  1. Navigate to the Jobcodes window.
    ​

  2. Edit the options on the Jobcodes tab:
    ​

  3. Edit the options on the Order Entry tab:
    ​

  4. Edit the options on the Financial tab:
    ​

  5. Create a new custom Access Level for use with Paytronix:

    1. In Aloha CFC select Maintenance > Labor > POS Access Levels

    2. Click the New button.

    3. Define the following:

      1. Number: 1-99 (You can select any number that is not currently in use)

      2. Name: Paytronix

      3. Delete Payments: tick this box

      4. Adjust Payments: tick this box

    4. Leave all other boxes unticked.

e. Click the Save button.

Create Manager User

Now that you have set up a new Jobcode and Access Level, you can create a Manager User. If you use Paytronix for gift cards, we highly recommend you create a Manager User. Creating a Manager User to restrict Paytronix functions helps mitigate two specific types of fraud:

  1. Prevents a user from adjusting the Auth Tender – If you use Auth and Final for gift card redemptions, it prevents a user from adjusting the Auth Tender amount and locks it at 0.
    ​

  2. Tip cannot exceed gift card balance – This prevents a user from specifying a tip amount that exceeds the amount of value remaining on the gift card. The tip amount will be automatically updated to the remaining balance on the gift card.

To create a Manager User, do the following:

  1. In Aloha CFC, select Maintenance > Labor > Employees
    ​

  2. From the Employee tab:

    1. On the right, click the down arrow next to the New button.

    2. In the pop-up, select POS Only.

    3. Click OK.

    4. The New Employee window should load.

    5. In the New Employee window, define the following:
      ​

      1. Employee Tab:

        1. POS Employee Number: Enter a number that is consistent with your organization’s employee number assignments. You will need to provide this number to Paytronix.

        2. Confirm System access: POS Only

        3. Based on your organization, there may be additional required fields. They will be marked in red. Complete all additional required fields per your organization’s policies.

        4. POS Security options: Confirm all fields are blank, all checkboxes are unticked.
          ​

      2. Status Tab:

        1. Employment status: Active.

        2. Job status: Leave as default.

        3. Start date: You may need to set a start date; you can select any date that is not a future date.

        4. Break exemption: Leave as default.
          ​

      3. Jobcodes Tab:

        1. Click the Add button.

        2. A new line will appear on the list.

        3. Click the pull-down menu on the line under Jobcode column.

        4. From the list, select the Paytronix Jobcode (This is the Jobcode you just created).

        5. From the list, select the Paytronix Jobcode (This is the Jobcode you just created).

        6. Click the pull-down menu on the line under Access Level and select the Paytronix Access level (This is the Access Level you just created).

        7. Leave everything else on this screen, and on the Tax and Custom Settings tab as default.

        8. Click Save.

        9. Refresh Data via Aloha CFC to push changes to all Order Entry Terminals (Utilities > Refresh Data).

Create Menu Items

Menu Items must be created via Aloha CFC for each Paytronix-related entry that will need to appear on a check. These items do not include payment information; payment information is handled separately and described in Create Tenders section. The following Menu Items are only for Add Events. When selling a gift card, an item needs to appear on the check (including the dollar amount of the gift card). Refer to your Summary Sheet to identify which Menu Items you will need to create; Menu Items vary based on which Paytronix products you are using, and your program’s requirements. They are unique to each client.

Important Notes:

  • You will need to repeat the process below for each Menu Item you need to create.

  • Aloha has several types of Menu Items; all Paytronix Menu Items must be added as Standard Type.

  • The process below covers most Menu Items. See separate steps unique to gift card Menu Items, and activation of fixed-cost cards in the Special Processes section.

To create a new Menu Item, do the following:

  1. In Aloha CFC, select Maintenance > Menu > Items

    1. Click the down arrow next to the New button on the right.

    2. From the drop-down menu, select Standard.

    3. Click OK.

    4. Start on the Item Tab:

      1. Item Tab:

        1. Number: Assign any number not currently in use.

        2. Confirm Type: Standard.

        3. Short Name: Assign any name not currently in use.

        4. Chit Name: Assign any name not currently in use.

        5. Chit Name Alternate: Assign any name not currently in use.

        6. Long Name: Assign any name not currently in use.

        7. Long Name Alternate: Assign any name not currently in use.

        8. Button image: Do not assign.

        9. Control Name: Assign any name not currently in use, this is generally used in reporting.

        10. Ask for description: Leave blank.

        11. Export ID: Leave blank.
          ​

      2. Assignments Tab:

        1. Tax group: Assign the tax group to the one most appropriate to gift cards per your organization’s policies.

        2. Concept: Leave as default

        3. Sales/retail category: Used for reporting, select the category most appropriate to gift cards, per your organization’s policies.

      3. Modifier Tab:

        1. Leave all settings on this tab as default.

      4. Print Tab:

        1. Click Print on check when price is 0: Tick this box.

        2. Leave all other settings on this tab as default.
          ​

  2. Special Processes

    1. For gift card Menu Items: For gift cards only, check the General Settings to confirm that the Revenue item tick box is ticked.

    2. For Menu Items used to activate a card with a fixed cost (e.g., a loyalty card program with a set fee to join the program, charity fundraising cards with a fixed dollar value or a Menu Item pre-loaded on the card): On the Pricing Tab, set Default price at the fixed cost of the card.

    3. For QS only, you will need to set up a $0.00 placeholder menu item. In Aloha QS, a Paytronix Menu Item (e.g., gift card purchase) cannot be the first item on a check (trying to do this produces an error). A good example of when this might occur is if a customer is only purchasing a gift card. To prevent this error, all Paytronix buttons should be scripted to automatically insert the $0.00 placeholder Menu Item before running the user program application to prevent the actual Paytronix Menu Item from being the first item in the check. For the button script to work, the $0.00 placeholder Menu Item must already exist. This means you will need to create it if it does not already exist. To create the $0.00 Menu Item, follow the instructions to create a new Menu Item above. Note: you can control how this item prints on the guest’s check when you set up the various names during the Menu Item setup.

Create Categories

Categories are important for reporting out of Aloha. Based on the reporting needs of your organization, part of setting up Paytronix on Aloha may require adding to existing Categories or creating new Categories. Aloha requires that all Menu Items created must belong to either a Sales or Retail Category. Paytronix does not have specific requirements or guidelines as to how to assign Menu Items to Categories. How you assign Menu Items will depend on your organization’s guidelines and policies.

In addition to the Aloha requirement of assigning all Menu Items to either a Sales or Retail Category, we recommend using a Non-Sales Category (especially for loyalty programs). This Category may already exist; if it does not exist, you will need to create it.

You can either use existing Sales/Retail and Non-Sales Categories or create new Categories. Whether you use existing Categories, or create new ones, you will need to associate the new Paytronix Menu Items with the correct Categories.

Creating New Categories & Adding Paytronix Menu Items

To create new Categories and add Paytronix Menu Items in those categories, do the following:

  1. Sales/Retail Category:

    1. In Aloha CFC, select Maintenance > Menu > Categories

    2. Click the down arrow next to New to select from a list.

    3. Select either Sales or Retail.

    4. Click OK.

    5. The Categories window will open. On the Category tab, and define the following:

      1. Number: Use any valid value (1-30000) not currently in use.

      2. Name: Enter a description of the new Category (e.g., Paytronix Sales).

      3. Maximum Per Check: 999.

    6. Click Save.
      ​

  2. Non-Sales Category:

    1. In Aloha CFC, select Maintenance > Menu > Categories

    2. Click the down arrow next to New to select from a list.

    3. Select General.

    4. Click OK.

    5. The Categories window will open. On the Category tab, and define the following:

      1. Number: Use any valid value (1-30000) not currently in use.

      2. Name: Enter a description of the new Category (e.g., Paytronix Sales).

      3. Maximum Per Check: 999.

      4. Click Save.

Adding Paytronix Menu Items in Existing Categories

To add Paytronix Menu Items to existing Categories, do the following:

  1. Sales/Retail Category:

    1. In Aloha CFC, select Maintenance > Menu > Categories

    2. In the Category drop-down menu, select the correct Sales or Retail Category to use.

    3. From the Items tab, select and Include into this Category all the Paytronix Menu Items you just created.

    4. Click Save.
      ​

  2. Non-Sales Category:

    1. In Aloha CFC, select Maintenance > Menu > Categories.

    2. In the Category drop-down menu, select the correct Non-Sales Category to use.

    3. From the Items tab, select and Include into this Category all the Paytronix Menu Items you just created.

    4. Click Save.

Create Tenders

Depending on your organization and programs, you will need to set up different forms of Tender in Aloha. Check the Summary Sheet for the Tenders you will need to set up; you will need to follow the process for each Tender setup.

Important Note: If your organization uses pre-existing Tender Groups, you must place Paytronix Tenders in the proper Tender Groups. If there are no pre-existing groups, you can skip this step.

SV SpeedPay Tender Setup

To set up SV SpeedPay Tender, do the following:

  1. In Aloha CFC, select Maintenance > Payments > Tenders
    ​

  2. Click the down arrow next to New.
    ​

  3. Select Generic.
    ​

  4. Click OK.
    ​

  5. In the Tender tab, define the following:

    1. Number: Enter any valid value (1-999). You will need to communicate this number to Paytronix for proper adjustment of the config file.

    2. Name: Enter any name for your tender.

    3. Default Amount: Ask for Amount.

    4. Active: Tick this box.

    5. Track: Tick this box.

    6. Can refund: Tick this box.

    7. Print Check on Close: Tick this box.

    8. Allow Tips: Tick if needed (optional, tick box if tips if your organization allows tipping via gift card).

    9. Maximum tip %: 200.

    10. Click Save.

    11. Report as: SV SpeedPay (Select the Tender you are creating).

    12. Click Save.

    13. Leave all other fields on all other tabs as default.
      ​

  6. In the Identification tab, define the following:

    1. Require identification: Tick this box.'

    2. Prompt: Enter text: Ref Line

    3. Minimum: Enter 5.

    4. Maximum: Enter 19.

    5. Print on check: Tick this box.

SV Auth Tender Setup

To set up SV Auth Tender, do the following:

  1. In Aloha CFC, select Maintenance > Payments > Tenders
    ​

  2. Click the down arrow next to New.
    ​

  3. Select Generic.
    ​

  4. Click OK.
    ​

  5. In the Tender tab, define the following:

    1. Number: Enter any valid value (1-999). You will need to communicate this number to Paytronix for proper adjustment of the config file.

    2. Name: Enter any name for your tender.

    3. Default Amount: Ask for Amount.

    4. Active: Tick this box.

    5. Track: Leave box unticked.

    6. Can refund: Leave box unticked.

    7. Print Check on Close: Tick this box.

    8. Click Save.

    9. Report as: SV Auth (Select the Tender you are creating).

    10. Click Save.

    11. Leave all other fields as default.
      ​

  6. In the Identification tab, define the following:

    1. Require identification: Tick this box.

    2. Prompt: Enter text: Ref Line

    3. Minimum: Enter 5.

    4. Maximum: Enter 19.

    5. Print on check: Tick this box.

SV Final Tender Setup

To set up SV Final Tender, do the following:

  1. In Aloha CFC, select Maintenance > Payments > Tenders
    ​

  2. Click the down arrow next to New.
    ​

  3. Select Generic.
    ​

  4. Click OK.
    ​

  5. In the Tender tab, define the following:

    1. Number: Enter any valid value (1-999). You will need to communicate this number to Paytronix for proper adjustment of the config file.

    2. Name: Enter any name for your tender.

    3. Default Amount: Ask for Amount.

    4. Active: Tick this box.

    5. Track: Tick this box.

    6. Can refund: Tick this box.

    7. Print Check on Close: Do not tick this box.

    8. Allow Tips: Tick.

    9. Maximum tip %: 200.

    10. Click Save.

    11. Report as: SV Final (Select the Tender you are creating).

    12. Click Save.

    13. Leave all other fields as default.
      ​

  6. In the Identification tab, define the following:

    1. Require identification: Tick this box.

    2. Prompt: Enter text: Ref Line

    3. Minimum: Enter 5.

    4. Maximum: Enter 19.

    5. Print on check: Tick this box.

Tender Groups

To place Paytronix Tenders in the proper Tender Groups, do the following:

  1. In Aloha CFC, select Maintenance > Payments > Tender Groups
    ​

  2. Select the pre-existing Tender Group that you will use for Paytronix Tenders.
    ​

  3. On the Assignments tab:

    1. Select which Tenders to add to this Tender Group.

    2. Click the >> button to add it to the Included section.

    3. After all appropriate Tenders have been added by including them, click Save.
      ​

  4. Repeat these steps for each Paytronix Tender you need to include in existing Tender Groups.

Here is a cheat sheet for setting up Tenders:

Create Comps

There are all kinds of comp programs: charity drives, customer recovery, store-opening promotions, employee benefits. No matter how you use them, the setup and configuration in the Aloha database is very similar. Check the Summary Sheet for the Comps you will need to set up; you will need to follow the process for each Comp.

Important Note: On some of the setup tabs, the instructions are slightly different for QS vs TS.

Comp Setup

  1. In Aloha CFC, select Maintenance > Payments > Comps
    ​

  2. In the pop-up window, click the down arrow, New, Regular, OK.
    ​

  3. This opens the Comps window.
    ​

  4. On the Comp tab, define the following:

    1. Number: Enter any valid value (1-999999). You will need to communicate this number to Paytronix for proper adjustment of the back-end setup.

    2. Name: Create a name for your Comp (this is what will appear on reports).

    3. Active: Tick this box.

    4. Check Name: Comp Label in Check (this is what will print on the check).

    5. Method: Prompt for Amount.

    6. Maximum Amount: 0.00

    7. Print Check on Close: Tick this box.

    8. Click Save

    9. Report As: Select the Comp you are creating.

    10. Click Save.

    11. NOTES:

      1. The Paytronix integration is designed to work with the Prompt for Amount Method only. Setting Method to any other selection would result in unexpected behavior.

      2. Do not tick the Manager Required box as it would have an undesirable effect.

  5. On the Taxes tab, set up based on your organization’s guidelines and policies.
    ​

  6. On the Eligibility tab, set it to All Items (unless otherwise directed by Paytronix).
    ​

  7. On the Restrictions tab, you will follow different instructions for QS vs TS:

    1. On the Restrictions tab, with QS, define the following:

      1. Promotion Restriction and Comp Restriction: Tick all boxes.

      2. Set Maximum Per Check to 99 (If your organization restricts the number of Comps that can be redeemed per transaction, this restriction is set somewhere else. It must be unrestricted in Aloha to function properly).

    2. On the Restrictions tab, with TS, define the following:

      1. Promotion Restriction and Comp Restriction: Tick all boxes.

      2. Set Maximum Per Check to 99 (If your organization restricts the number of Comps that can be redeemed per check, this restriction is set somewhere else. It must be unrestricted in Aloha to function properly).

      3. Set Maximum Per Table to 99 (If your organization restricts the number of Comps that can be redeemed per table, this restriction is set somewhere else. It must be unrestricted in Aloha to function properly).

Configuration & Setup: Aloha Buttons & Menus

In this section, you will adjust settings to determine how Paytronix Menu Items will appear on Order Entry Terminals. Our integration is flexible, and we do not require any specific Menu and/or Button configuration because every organization is different.

You will want to configure the Aloha Interface (terminal display) with Paytronix products in a way that makes sense for your organization. You may need to create Menus, Submenus, Buttons, or a combination. You may want Paytronix Buttons in line with your regular Menus or separated out on their own Menu.

Creating Menus & Submenus

Paytronix buttons can be inserted on two types of Aloha screens:

  • Menu screen

  • Tender screen

This section covers configuration of buttons on menus and submenus, and tender screens in both QS and TS versions of Aloha.

A few important notes before you start:

  • The instructions in this section are especially specific to version (QS vs. TS); please pay close attention to instruction headers to make sure you are following the instructions for the correct version of Aloha.

  • As a rule, some Buttons are restricted by their function.

    • Buttons that perform a Menu Item action (e.g., Sell Gift Card, Add $ to Card, Add Comp Dollars, Activate Card, Exchange Card) must be on an Order Screen.

    • Buttons that perform a payment action (e.g., SV SpeedPay, SV Auth, SV Final, Point Accrual) must be on a Payment Screen.

    • Buttons that perform a Comp action (e.g., Inquiry Redeem Rewards, Apply All Discounts) must be on a Comp or Promo Screen (usually a subsection of a Payment Screen).

Creating Menus & Submenus – TS Version Only

Check the Summary Sheet to see if you need to create Submenus. If you do not need to create Submenus, you can skip this section.

Create a New Submenu – TS Version Only

  1. In Aloha CFC, select Maintenance > Menu > Submenus
    ​

  2. On the Submenu tab, expand the Submenus drop-down.
    ​

  3. Refer to the Summary Sheet, to enter the following info:

    1. Type the Submenu Number into the Submenu ID field and click Enter. This action creates a new Submenu with the number you entered.

    2. Type the Submenu name into both the Short name and Long name fields and click Enter. Both names must be entered; they can be the same.

    3. Leave all other settings as default.

    4. Click Save.

    5. Repeat these steps for each Submenu on the Summary Sheet


​

Attach a New Submenu to Menus – TS Version Only

You have added Submenus but you will not be able to see them in Aloha until you attach them to a Menu. To attach a Submenu to a Menu, do the following:

  1. In Aloha CFC, select Maintenance > Menu > Menus
    ​

  2. From the Menus screen, click on the Layout tab.
    ​

  3. On the Layout tab, click on the first gray, unmarked button to attach the Submenu you just created. This opens the gray button.
    ​

  4. After you click the gray button, you will see a pull-down list of Submenus. Choose the one you just created; you may need to scroll down the list if there are a lot of Submenus.
    ​

  5. Click OK.
    ​

  6. Repeat these steps for each Submenu you created.
    ​

  7. Leave all other fields on all other tabs as default.
    ​

  8. Once each menu is configured with the desired Submenus, click Save.

Create Paytronix Buttons on Menus and Submenus – TS Version Only

Now that you have created the necessary Menus and Submenus, you will need to add Buttons to them. Adding Buttons is not done through the Aloha CFC interface; Buttons are configured using a config file installed on the BOH machine.

  • Button file location: %LOCALDIR%\NewData\TSButton.cfg

  • TS Buttons are configured in the TSButton.cfg file. The TSButton.cfg file is a text file required by Aloha for many external applications to run. This file may already exist. If it does exist, you will need to edit it to add information specific to Paytronix. If it does not exist, you will need to create it.

  • The config file contains comments; comment lines begin with a #. See Appendix B: Modifying TSButton.cfg for a detailed description of how the TSButton.cfg file works and its syntax.

To define Buttons, do the following:

  1. Navigate to %LOCALDIR%\NewData\ and search for: TSButton.cfg

    1. If the TSButton.cfg file does not exist, create it. To create it, open a blank text file and save it as TSButton.cfg

    2. If the TSButton.cfg file does exist, open it.
      ​

  2. Review the TSButton.cfg file

    1. Read the file and make sure that the Paytronix Buttons will not overlap with other Buttons previously defined in the TSButton.cfg file, or Buttons defined via Aloha CFC.

    2. If you created a brand-new Submenu for these Buttons, there should not be any overlap (this is more prevalent on Tender screens).

    3. Please see Appendix B: Modifying TSButton.cfg to learn how Buttons are positioned.
      ​

  3. Add text to the TSButton.cfg file for each Paytronix Button that needs to be configured. Each organization will set up POS systems to meet the unique aspects of their business. Button setup can and should vary to meet the needs of your organization. Below are a few examples of TS Button configurations. Your exact configurations will depend greatly on your organization. Do not simply copy/paste the text below into a TSButton.cfg file; this file is provided for demonstration purposes only:


​

Creating Menus & Submenus – QS Version Only

Aloha QS offers a bit more flexibility in terms of incorporating Paytronix products into the POS. You will have many options and should pick the ones that best fit your organization’s needs, policies, guidelines, etc. In Aloha QS, generally you will be adding Buttons to a Panel – either an existing Panel or a new one created especially for Paytronix products. Again, Panel setup will vary greatly based on your organization.

As Aloha QS configs can vary greatly, if you will be adding new Panels or changing the screen layout to incorporate Paytronix products, please consult Aloha’s documentation for creating new Panels and changing screen layout prior to proceeding.

Adding Buttons to Panels – QS Version Only

Depending on the functionality you need, Buttons may be added to newly created Panels or to existing panels. Most often, Buttons are added to existing Panels. See the Summary Sheet for which Buttons you will need to create.

  1. Locate and open a Panel by doing the following:

    1. In Aloha CFC, select Maintenance > Screen Designer > QuickService Screen Designer

    2. This Quick Service Screen Designer window will pop up:
      ​

    3. Click the Work with Panels link.

    4. You should see this Quick Service Screen Designer: Panel Editor window:
      ​

    5. From the menu, select Open Panel…

    6. This will open a list of existing Panels, like this:
      ​

    7. Choose the Panel you want to edit, click on it, then click OK.
      ​

  2. Add a Button to a Panel by doing the following:

    1. Right-click anywhere on the open Panel, click the New Button link from the list that pops up.
      ​

    2. Use the Properties window to define how your Button will look. This will vary based on your organization’s guidelines for font, color, size, etc.

    3. Under Function, select Script from the list:
      ​

    4. After you select Script from the list, a new line will appear in the Function section called Script Action. Click on the ellipsis (…) button.

    5. Now you should see the Edit Script Actions window.

    6. Click Add.

    7. Depending on the type of Button you are adding, you will follow slightly different instructions.
      ​

  3. Functions that insert a Paytronix menu item into the check, such as Sell Gift Card, must be scripted to order the placeholder item before running the Paytronix application so that the Paytronix menu item can never be the first menu item added to the check. Buttons for the following functions must be defined to order the placeholder item before running the Paytronix user program application:
    ​

    • EXCHANGE_CARD

    • SELL_GIFT_CARD

    • ADD_VALUE_TO_CARD

    • VOID_ADD_VALUE_TO_CARD

    • BULK_ACTIVATE_ADD

    • LATE_FLOW_POINT_ACCRUAL

    • ACCOUNT_QUERY

    • SMS_ENROLL

    • ACTIVATE_CARD

    • SELL_DOLLARS

    • SELL_REWARDS

    • VOID_ACTIVATE_CARD
      ​

    1. Define The button script actions to be:

      • Action Type: Order
        Item Item: Placeholder Item

      • Action Type: Run Application

      • Application: C:\Paytronix\pxalohaui.exe [FUNCTION]
        Pass Parameters: True

  4. Functions that insert a Paytronix menu item into the check, such as Sell Gift Card, must be scripted to order the placeholder item before running the Paytronix application so that the Paytronix menu item can never be the first menu item added to the check. Buttons for the following functions do not need to order the placeholder item before running the Paytronix user program application:

    • BALANCE_INQUIRY

    • TRANSACTION_HISTORY

    • PAY_BY_CARD

    • SV_AUTH

    • SV_FINAL

    • INQUIRY_REDEEM

    • APPLY_ALL_DISCOUNTS

    • VALIDATE_COUPON

    • TOUR_HISTORY

    • TOUR_SUGGESTIONS
      ​

    1. Define The button script actions to be:

      • Action Type: Run Application Application: C:\Paytronix\pxalohaui.exe [FUNCTION] Pass Parameters: True
        ​

  5. Select OK to return to the Button Properties dialog.
    ​

  6. Define the Button text and text attributes
    ​

  7. After all buttons for the panel have been defined, select Panel > Save All Panels to save the button changes.


​

Security & Allowlisting

When Paytronix products are installed on Aloha, there is back-and-forth communication between the Order Entry Terminals, the BOH machine, and Paytronix systems (PXS). Your organization’s corporate information security team may use firewalls, security software, or other products and services designed to monitor networks, detect possible intrusions, and/or block suspicious network traffic. The best way to make sure communication between Aloha and Paytronix continues uninterrupted is to allowlist the specific URLs, ports, hosts, services, installers, and applications required for communication. If you think you are experiencing connectivity issues related to security or allowlisting, please work with your organization’s IT Security Team. We highly recommend that you meet with your organization’s IT Security Team before installing anything on the BOH machine so they can conduct an official security review.

Allowing specific URLs, ports, hosts, services, installers, and applications is required for communication between your technology and the Paytronix systems. Refer to the Paytronix Security & Network Allowlist Guide on the Paytronix Support Help Center.

Configuration & Setup: Paytronix Software Installation

At this point, you have configured the Aloha database, menus, and buttons to be ready to successfully interact with Paytronix systems. In this section, you will be installing the Paytronix Controller (PXC) on the BOH machine and pushing the Paytronix User Program to the Order Entry Terminals.

Overview

This section is broken down into two parts:

  1. Install PXC on BOH machine.

  2. Install Paytronix User Program on Order Entry Terminals using RAL.

Important Note: In step 2, you will need to reboot and refresh Order Entry Terminals which will take all Order Entry Terminals offline for a bit of time. You may want to schedule this part of the installation when your location is closed.

We strongly recommend installing PXC version 22.5 or later; version 22.5+ supports improved security. PXC versions 22.5 and later will install three services:

  • Paytronix Controller (PXC)

  • Paytronix Daemon Service

  • Paytronix Upgrader Service

In this section you will need to know the BOH MAC address, Merchant ID, and Store Code. You can get this info from the Summary Sheet.

Install PXC on BOH Machine

Download the Paytronix for Aloha Installer Files

  1. Create a directory named C:\PXInstall on the BOH machine. If this folder already exists, remove any old installer folders it may contain. This folder will be used as a distribution directory for the installation files.
    ​

  2. Access the download in a web browser:
    ​https://supportpx.com/PxSoftware_Aloha/
    ​Note: URLs are case-sensitive. There is an underscore between PxSoftware and Aloha
    ​

  3. Log in using the following credentials:

    • user: aloha

    • password: aloha
      ​

  4. Download the installation kit to the C:\PXInstall folder:

    • Version-####-Aloha-ManifestInstall.zip
      Note: #### = version number
      ​

  5. Unzip the installation package to the directory you created earlier, C:\PXInstall
    ​

  6. Check that the installation archive was extracted properly by verifying you see all necessary files in the C:\PXInstall directory.

    • controller-installer-####.exe

    • aloha-user-program-####.zip
      Note: #### = version number

Install the Paytronix Controller (PXC)

  1. The PXC must be installed on the BOH machine.
    ​

  2. Double-click the following setup file: C:\PXInstall\controller-installer-####.exe
    ​

  3. Click Next to proceed with the installation:
    ​

  4. Click Next to accept C:\Paytronix as the default installation directory:
    ​

  5. When prompted for Merchant ID and Store Code, enter these values.
    ​Note: The Merchant ID is the same for all stores, but each store will have its own Store Code.
    ​

  6. Select the server to use from the Server radio button options:
    ​

  7. Review the installation summary and click Install to begin the installation
    ​

  8. After the installation is complete, the BOH machine should have a C:\Paytronix directory. All Paytronix software will be in this folder. Click Finish to exit the Install Wizard.

Start Paytronix Controller Service (PXC Service)

Important Note: You will not be able to start Paytronix Service or use the PXC without having a credential. Make sure you have a credential for the BOH machine from Paytronix before proceeding.

  1. After the Paytronix Controller is installed, upgraded, or reinstalled, the Paytronix Controller service does not appear under Windows Services initially, but a Paytronix Daemon Service exists. The Paytronix Controller service should get added to the Windows Services list and start automatically after about a minute.
    ​

  2. If the Paytronix Controller service does not appear in the Windows Services list after about a minute, restart the Paytronix Daemon Service through the Windows Programs and Features utility on the back-office machine.
    ​

  3. The Paytronix Controller service is added to the services list in the Windows Services utility and starts. If the Paytronix Controller (PXC) service is not running, start the service.

Verify Connectivity Status

The PXC is what allows your BOH machine to communicate with Paytronix systems. In this section you will verify that your BOH machine can communicate with Paytronix via the PXC. You will want to verify that the PXC is connecting.

  1. Log in to the PXS Merchant Portal:
    ​https://www.pxsweb.com/merchant/home.srv
    ​
    Note, if you are using the test environment, you will log in to: https://www.train.paytronix.com/merchant/storestatus.srv
    ​

  2. From the Customer Service menu, select Connectivity Status:
    ​

  3. From the Connectivity Status page, check for green as the Status for the Store ID where you have done the installation. This is an example of a successful connection status:

Verify pxalohaui.cfg file

The following file should download automatically when the Paytronix Controller initially connects to the Paytronix server. Confirm the following configuration file is present on the BOH machine as it is required for the installation of the user program on the terminals:

C:\Paytronix\config\userprog\pxalohaui.cfg

Install the Paytronix User Program on the Order Entry Terminals

The Paytronix User Program is installed on the Order Entry Terminals using NCR Aloha RAL with the Paytronix Manifest file and operates in least privilege mode, as required. Before proceeding, make sure you have downloaded and installed the PXC to the BOH machine, started the Paytronix service, and verified connectivity status as described in the Install PXC on BOH Machine section of this guide.

Important Notes:

  • Aloha RAL version 17.5.5.26 or later is required for the RAL Manifest installation of the Paytronix User Program on Order Entry Terminals. Older RAL versions will not load or process the manifest file properly.

  • Terminals must have Windows 7 OS (or later) to use RAL Manifest installation (Windows XP is not supported for RAL Manifest installation. It is not PCI-compliant and will not process manifest files).

  • Before proceeding, make sure you have downloaded and installed the PXC to the BOH machine, started the Paytronix service, and verified connectivity status as described in the Install PXC on BOH Machine section of this guide. For a new installation, the custom config files will download when the PXC connects for the first time. If you have not completed all steps in the Install PXC on BOH Machine section, including making sure you can connect to PXS, STOP HERE and complete that section before proceeding.

Paytronix User Program Installation for Order Entry Terminals via RAL Manifest

  1. Extract .ZIP File from the Installer Kit

    1. Extract the Paytronix User Program zip file (aloha-user-program-****.zip). When prompted, save it into the C:\Paytronix folder on the Aloha BOH. When extracted, all files must be in the main C:\Paytronix folder (NOT in a sub-folder).

      1. *.bmp files (exact name and number will vary based on your installation)

      2. pxalohaui.exe

      3. pxalohaui.mft or pxalohaui.xml (Paytronix manifest file is named pxalohaui.mft and in a Manifests subfolder in version 22.6 or later and named pxalohaui.xml in the top-level Paytronix folder in prior versions)
        ​Note: It is very important that all files are in the main C:\Paytronix folder. Moving or saving files to sub-folders is a common error and can cause the installation to fail.
        ​

  2. Copy Files

    1. Copy the encrypted Paytronix manifest file (pxalohaui.mft or pxalohaui.xml) from C:\Paytronix and paste it into the %LOCALDIR%\ExtData\Manifests folder on the BOH machine.

    2. If you do not see a Manifests folder in the ExtData folder, create a sub-folder, and name it Manifests.

    3. Do not rename the pxalohaui.mft or pxalohaui.xml file; using a different file name may prevent RAL from accessing the manifest file, or otherwise affect the installation process.
      ​

  3. Aloha Service Admin

    1. Launch the Aloha Service Admin UI on the BOH machine
      ​

    2. When launched you should see the Site Configuration window:
      ​

    3. Click the Manifests button to open the Manifest Configuration window.

    4. Click the Add button on the left:
      ​

    5. Navigate to the %LOCALDIR%\ExtData\Manifests folder. If the manifest file does not list, change the File Type selector to All Files. Select the pxalohaui.mft or pxalohaui.xml file. Click the Open button:
      ​

    6. The Paytronix User Program manifest should now appear in the list of Active manifests. If it does not appear, select OK to close the Manifest list dialog and select Manifests again to reopen the Manifest list dialog.
      ​

    7. Click Paytronix User Program from the list, then click the View button.

    8. When the Manifest View opens click OK, this will return you to the main Site Configuration window:
      ​

    9. From the Site Configuration window, click the Reload All button. This will mark all Order Entry Terminals for reload:
      ​

    10. Click Cancel Reload All button. (This clears all Order Entry Terminals for reload.)

    11. In pop-up window, Click the Yes button on the pop-up after clicking the Cancel Reload All button:
      ​

    12. Then click the Reload All button once more to mark all Order Entry Terminals for reload.
      ​

  4. Refresh & Reboot Order Entry Terminals
    You will need to Refresh Data (which reboots the Order Entry Terminals) to complete the installation. Rebooting the Order Entry Terminals will take them offline; you may want to delay this step until off hours. STOP here if your location is currently open; resume when your location is closed for the day. To Refresh Data on all Order Entry Terminals:

    1. In Aloha CFC, select Utilities > Refresh Data

    2. Refreshing data usually takes about 10 minutes; it can take up to 30 minutes. Plan accordingly.

    3. When you Refresh Data, the Paytronix User Program manifest will process on each Order Entry Terminal. This is what you will see on the Order Entry Terminal as the manifest is processing:
      ​

    4. When the Paytronix User Program manifest completes processing via Refresh Data, you will see screen below. After processing is complete, Aloha Iber will launch on the Order Entry Terminal:


​

Appendices

Appendix A: Identifying a BOH Machine’s MAC Address

Credentials are associated (and locked) to the hardware network address of the machine on which the application runs. The network or MAC (Media Access Control) address is a unique identification associated with a NIC (Network Interface Card) on a machine.

To find the MAC address, log onto the BOH machine. If you are performing this at your corporate office, you will need to dial in to the machine, or call someone at the location and walk that person through the following instructions:

  1. Open a Windows Command Prompt window by selecting Start > Run …
    ​

  2. Enter cmd in the input field of the Run dialog.
    ​

  3. Click OK.
    ​

  4. In the Command Prompt window, set the Paytronix PXC loadpoint directory (e.g., C:\Paytronix) as the current working directory by typing C: and then cd \paytronix in the window.
    ​

  5. Type the command viewMacAddress.bat in the Command Prompt window. This command runs a utility that displays the machine’s operating system and the MAC address(es) present.
    ​

  6. Alternatively, execute the command ipconfig /all from the Command Prompt window. This command displays the network configuration of the system. The MAC address is the value of the Physical Address setting in the Ethernet adapter Local Area Connection section.
    ​

  7. Note the MAC address displayed for the system. The MAC address consists of 6 pairs of digits (0-9, A-F) in the format XX-XX-XX-XX-XX-XX. The separator character, a dash in the given example, may vary depending on the operating system.

Important Note: It is important to know that a PC will have as many MAC addresses as the number of NICs installed on it. There may also be MAC addresses associated with virtual network adapters (such as Point-to-Point Protocol, or PPP, on Windows, or Loopback on UNIX). In the case where more than one NIC is present, as in the above examples, it is important to select and mark which NIC card is being used for this installation. If this NIC card is removed, a new set of credentials must be created and downloaded.

Related Articles
Paytronix Security & Network Allowlist Guide
Aloha POS Paytronix Manager User Definition for Gift Cards
Paytronix Controller (PXC) Installation & Upgrade Guide
Troubleshooting Paytronix Controller (PXC) Installation & Upgrade
Paytronix for Simphony 19.3 Installation Guide
Did this answer your question?