---
title: "Linkly EFTPOS - QZ Tray Integration"
canonical: "https://kb.myframeworks.com.au/space/FRAM/28412142/Linkly%20EFTPOS%20-%20QZ%20Tray%20Integration"
format: markdown
---
# Overview 

[Version 6.1+] 

Frameworks can integrate with selected EFTPOS providers to send transaction information directly to the EFTPOS PINPad, eliminating the need for manual EFTPOS transaction entry.

This article provides instructions on setting up Linkly EFTPOS to integrate with Frameworks using QZ Tray file whitelisting. This setup allows files from Frameworks to be accessible by a connected EFTPOS PINPad.

# Requirements

To set up EFTPOS integration using Linkly/QZ Tray file integration, you will need the following:

1. **A Linkly compatible PINPad device**: These are provided by your EFTPOS provider.
2. **Linkly Client software**: This should be installed on the PC to which the PINPad is connected. The installation and configuration of the Linkly Client software should be done with guidance from your EFTPOS provider and/or IT provider.
3. **A Linkly gateway**: This should be set up and configured with guidance from your EFTPOS provider and/or IT provider.
4. **Required Printer Queues**: These should be set up and available on the PC to be configured. This setup should be performed by or with guidance from your IT provider.

> ℹ️ **Note: **The installation of these components is not covered by this document, and only limited support can be provided by Sterland for the installation, configuration, and ongoing maintenance of these components.

# Installation

The installation and configuration of the Linkly/QZ Tray file integration are divided into four steps:

> Macro (toc)

## 1. EFTPOS Folder Creation and Permissions

For the integration to work, files need to be written to a specific location on the local machine in both directions: from Frameworks to Linkly and from Linkly to Frameworks. To set this up, you need to create a folder and ensure that all users have permission to write to it.

Throughout this document, the main instructions assume that the default folder ***c:\eftpos*** is used for this integration. If you choose a different location, follow the modified instructions provided.

1. Create the folder in the desired location (default is ***c:\eftpos***).
2. Right-click on the folder and select Properties.
3. Go to the **Security** tab and click the **Edit **to change security permissions.
  
4. Once the security tab has loaded, ensure that all user types have Full Control permissions for the folder.
5. It is also recommended to add the "**Everyone**" user group to the permissions and grant full access for this user.
  
6. Click **Apply **to confirm the changes.

## 2. QZ Tray Installation and Configuration

The QZ Tray application is available from the QZ website. The minimum version required for the integration is v2.2.3, though it is recommended to use the latest version available.

1. Follow the instructions in the QZ Tray installer, selecting the desired installation location.
2. After installation is complete, open the file ***qz-tray.properties*** in Notepad or another text editor running as an administrator. This file is found in the installation folder chosen during installation (default is ***C:\Program Files\QZTray\qz-tray.properties***).
3. At the end of the file, add the following on a new line:
  This assumes you are using the default EFTPOS file location of ***C:\eftpos***. If you would like to use a different location for the EFTPOS files, substitute the location after the **= **sign, noting that directories are separated by double slashes **\\**. This must match the location specified by the DosToActiveX configuration and the Frameworks configuration.

> ℹ️ **Note: **For the change to be active in QZ Tray, the application will need to be restarted if it is running.

## 3. DosToActiveX Setup and Configuration

DosToActiveX is available from Sterland. It consists of a single executable file and is provided alongside a registry file which provides the correct settings for the executable.

1. The executable file can be placed in any location. We normally place it in ***C:\Sterland*** to make it easy to locate any log files required for troubleshooting.
2. Run the executable file once as an Administrator. This will create the registry keys necessary for the application. Please note that the Linkly client is required to be installed and running for the application to load. Once loaded, exit the application.
3. Make a shortcut to the executable in that location.
4. Move or copy the shortcut to the common startup folder (***C:\ProgramData\Microsoft\Windows\Start Menu\Programs\Startup***) to ensure that it runs on startup for any user.
5. Run the registry file (***dostoactivex.reg***) which adds the necessary keys to the system registry.
  1. **[HKEY_LOCAL_MACHINE\SOFTWARE\Ingenico\PC EFTPOS\File to Active X]**
  2. **[HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432Node\Ingenico\PC EFTPOS\File to**
    **Active X]**
  3. **[HKEY_CURRENT_USER\Software\Classes\VirtualStore\MACHINE\SOFTWARE\Wo**
    **w6432Node\INGENICO\PC EFTPOS\File to Active X]**
  4. **[HKEY_LOCAL_MACHINE\SOFTWARE\WOW6432Node\CullenSoftwareDesign\EFTCLIENT\CLIENT] "AUTODISMISS"=dword:00000001**
  5. **[HKEY_LOCAL_MACHINE\SOFTWARE\CullenSoftwareDesign\EFTCLIENT\CLIENT]**
    **"AUTODISMISS"=dword:00000001**

This assumes you are using the default EFTPOS file location of **C:\eftpos**. If you prefer a different location for the EFTPOS files, substitute the path for the "Input Folder" value after the = sign, ensuring directories are separated by double slashes \\. This location must match the one specified in the QZ Tray setup and the Frameworks setup.

## 4. Frameworks Configuration

There are four configuration options that need to be set in Frameworks. One is system-wide, another is set per device, and finally, there are settings that need to be configured from the device while signed in.

1. **UseQZForLinkly System Flag**  
This flag is located in **System Settings – Flags**. To access it, go to the **Frameworks Menu** > **System Administration** > **System Setup** > **Configuration **>** System Settings – Flags**. You can use the search bar to find the option. Make sure the checkbox for UseQZForLinkly is checked.
2. **Device Maintenance**  
In Device Maintenance, accessible through the **Frameworks Menu** > **System Administration** > **System Setup** > **Devices & Printing** > **Device Maintenance**, locate the desired device and modify the following settings:
  1. **Eftpos Supplier**: Set the Eftpos Supplier to "**ingenico**".
  2. **Eftpos Folder**: Set the Eftpos folder to ***c:/eftpos***.
  This assumes you are using the default EFTPOS file location of ***c:/eftpos***. If you prefer a different location for the EFTPOS files, substitute the value of the Eftpos Folder with the desired location. Note that directories are separated by a single forward slash / and do not contain a trailing slash. This location must match the one specified in the QZ Tray setup and the DosToActiveX setup.
3. **My Printer Configuration**
  To use QZ Tray for printing in Frameworks on the device being used for EFTPOS integration, follow these steps:
  1. Open Frameworks and log in to your account.
  2. Click on the **user menu** drop-down in the top right corner of the screen.
  3. Click on **My Printer Configuration**.
  4. Check the box corresponding to **Use QZ Tray**.
  You will need to configure printers through this menu, which is covered in a separate knowledge base article.

> ✅ Refer to [Frameworks Printing with QZ Tray Setup](https://sterlandsupport.atlassian.net/wiki/spaces/FRAM/pages/28378436).

4. **Printing EFTPOS Receipt Details on A4 Dockets (receipt.evt Integration)**  
Frameworks now support enhanced QZ Tray/Linkly integration, allowing EFTPOS transaction details to appear on A4 customer dockets. This update reads information from the `receipt.evt` file and includes it in the printed stationery.

> ℹ️ If your current docket layout does not include space for EFTPOS info, contact [Support ](https://kb.myframeworks.com.au/page/support)to assist with customization.

# Limitations

1. The shared EFTPOS configuration (system code ***SysEFTType = 'shared'***) is not supported.
2. The option to launch the EFT Settlement from the Frameworks menu is not supported.

# Additional Information

> ✅ Refer to [Frameworks Printing with QZ Tray Setup](https://sterlandsupport.atlassian.net/wiki/spaces/FRAM/pages/28378436) for more information about configuring printers with QZ Tray.