A configuration guide for the Dojo pay at counter (PAC) integration, using the Dojo EPoS Data
WebSocket Specification.
Dojo Pay at Counter setup
TouchPoint Setup
Application Settings
Troubleshooting
Dojo Pay at Counter
(PAC) configuration
guide
This guide provides the step-by-step procedure for installing and configuring the Dojo "Pay at
Counter" feature, which integrates TouchPoint with your Dojo card machine for seamless
Electronic Funds Transfer (EFT) payment processing.
The EFT application facilitates communication between TouchPoint and the Dojo terminal.
1. Download the installer from the ICRTouch Forum.
2. Run the installer with the default settings as prompted.
3. Upon completion, the integration application should launch automatically and display a
status icon in the system taskbar (near the clock).
4. Link the application to your Dojo account:
Open the integration application via the taskbar icon or Windows start menu.
Enter API key: Navigate to the application's settings and enter your unique Dojo API
Key in the designated field.
Dojo Pay at Counter setup
Prerequisites:
TouchPoint 2024
Windows 10
The application requires the .NET Runtime to operate. If it is not installed, download it from
https://dotnet.microsoft.com/en-us/download/dotnet/8.0/runtime
Dojo supported hardware
Send an email with your TouchPoint licences to the ICRTouch Support Team to complete and
enable the integration.
Installing the EFT application
1. Select Programming > All programming > System Flags > EFT Control. Configure as
follows:
EFT SYSTEM (1) Local EFT App
Prompt for cash back? Whether to receive a prompt for cash back
Use SaleID in Merchant Ref?
Whether to use the unique Sale ID as the
transaction reference for easier payment
reconciliation.
Begin transaction for transaction key EFT?
This begins a sale early if a transaction key is used
and finalises to EFT, for example a Received on
Account key.
This is required for some EFT providers so that the
Sale ID has been created prior to the card sale being
processed.
This has the downside that if the EFT transaction
fails, TouchPoint will be left in the middle of a
transaction requiring remedial action, for example
pressing [Cancel] or finalising to [Cash].
2. Select Programming > Function keys > Finalise Key to setup the EFT credit card button.
Select an unused key, then configure as follows:
Key Type EFT
3. Add the key to a keyboard level.
To print a local store of Pay at Counter transaction initiated from Touchpoint:
Local EFT, Z Report (Summary Totals)
Local EFT, Banking Report (Transaction List)
TouchPoint Setup
Reports

The application settings window will be displayed on first run. It can also be accessed via the rightclick
taskbar tray.
1. Select the test button to confirm that the API key and Reseller ID are correct.
2. Use the save button to store the settings.
Dojo Api Key Provided by Dojo. May be found in the Dojo Portal.
Reseller ID The Reseller ID is a Dojo-assigned identifier to the
company supporting the site.
Currency Code Primary currency used for all transactions.
Preferred Terminal Select which Dojo terminal should be used for this
TouchPoint.
Enable Cancellation Hides the cancel buttons.
Printer Width Char width used when formatting printing output.
Print Customer Receipt Auto print customer receipt.
Print Merchant Receipt Auto-print the merchant receipt.
Application Settings
The application logs most error messages; however, there may be cases of silent errors, and the
application can crash without notice.
1. In some cases, failures may be due to external server outages. Check the official Dojo
system status at https://status.dojo.tech/ before contacting ICRTouch support.
2. Search the log files for the events that led to the error/crash. Locate the logs in
C:\ICRTouch\DojoPayAtCounter\Log\.
3. Use the information in the log file to recreate the issue and provide feedback to the
ICRTouch support team if appropriate.
4. Download the .NET Runtime from - https://dotnet.microsoft.com/enus/
download/dotnet/8.0/runtime
Troubleshooting

 

Gift Aid

Gift Aid admission PLUs

During the sale of a Gift Aid donation admission ticket you are prompted to select whether the Gift Aid prompt is:

On PLU entry.If you have more than one Gift Aid admission PLU we recommend you increase the maximum Gift Aid prompts in TouchPoint. For instance, if you have 3 Gift Aid admission ticket types, child, adult, and senior citizen, increase your max Gift Aid number prompts to 3. TouchPoint will prompt you to enter the Gift Aid donor's details up to 3 times during the sale. The prompt disappears after entering the donors' information on the 1st, 2nd, or 3rd prompt.

At the end of sale.The Gift Aid prompt is triggered when you press the finalise key. The Max Gift Aid number prompts field is ignored.

Prompt trigger PLU entry

In TouchPoint, select Program > All programming > ETAL > Gift Aid > Admission settings.

Scroll down to prompt trigger.

Select PLU entry.

Press enter to increase the number of prompts.

Prompt trigger end of sale

In TouchPoint, select Program > All programming > ETAL > Gift Aid > Admission settings.

Scroll down to prompt trigger.

Select End of sale.

Gift Aid donation sale

Follow all the steps below to register a Gift Aid donation:

When prompted whether the donation is for Gift Aid, select YES.If the Gift Aid donation prompt does not appear during an admission or cash donation sale, and you have not added the customer's details, cancel the sale and start again.This prompt does not appear when processing Gift Aid product donations.

Enter the postal code and select the address. Try again if the address list is empty, or enter the address manually.

Select or enter the customer's details.

Ensure the donor signs the declaration - select YES when prompted.

Gift Aid admission

During the sale of a Gift Aid donation admission ticket you are prompted to select whether the donation is for Gift Aid.If the prompt trigger is PLU entry and you select NO on the last Gift Aid donation prompt, you will have to error correct the PLU from the reg window or cancel the sale and start again as the sale will not be linked to Gift Aid.

If you select YES enter the postcode. If the postal address is found select the address from the list. If you include the house number or name in the search the address list is narrowed down.If the postal address is not found try again or manually add the address.If you do not enter a postcode you will have to error correct the PLU from the reg window or cancel the sale and start again as the sale will not be linked to Gift Aid.

If the customer has donated previously select the customer from the list. If not, enter the customers information when prompted.

If the donor has signed the declaration select YES.If you select NO you will have to error correct the PLU from the reg window or cancel the sale and start again as the sale will not be linked to Gift Aid.

Finalise the sale.

If the prompt trigger is end of sale the Gift Aid entry is triggered when you select the finalise key.

Gift Aid cash donation

Select the Gift Aid cash donation PLU and then enter the donation value.

When prompted whether the donation is for Gift Aid, select YES. If you select NO you will have to error correct the PLU from the reg window or cancel the sale and start again as the sale will not be linked to Gift Aid.

If you select YES enter the postcode. If the postal address is found select the address from the list. If you include the house number or name in the search the address list is narrowed down.If the postal address is not found try again or manually add the address.If you do not enter a postcode you will have to error correct the PLU from the reg window or cancel the sale and start again as the sale will not be linked to Gift Aid.

If the customer has donated previously select the customer from the list. If not, enter the customers information when prompted.

If the donor has signed the declaration select YES.If you select NO you will have to error correct the PLU from the reg window or cancel the sale and start again as the sale will not be linked to Gift Aid.

Finalise the sale.

Gift Aid product donation

Select the Gift Aid donation key.

Enter the postcode. If the postal address is found select the address from the list. If you include the house number or name in the search the address list is narrowed down.If the postal address is not found try again or manually add the address.

If the customer donated previously select the customer from the list. If not, enter the customers information when prompted.

If the donor has signed the declaration select YES.If you select NO you will have to error correct the PLU from the reg window or cancel the sale and start again as the donation will not be linked to Gift Aid.

Enter the product descriptor, the department it is linked to and the price.

The barcode is printed and can be placed on the product.

To edit the price of the product select the edit price key.

Scan the barcode and edit the price.

Just Eat integration

This document is aimed at ICRTouch Authorised Partners and is a reference manual to ICRTouch’s Just Eat integration services. Just Eat orders are sent straight to TouchPoint, enabling restaurants to see all their orders in one place, in real-time.

This manual contains information relating to services owned and operated by third parties. This information is provided for your information and convenience only and is not an endorsement of such third party services. ICRTouch is not responsible for, nor has any control of the content, availability, functionality, pricing or charges of any 3rd party service.

Just Eat PLU webshop options

In TouchOffice Web if not applying to all sites (Head Office), select the appropriate site from the dropdown.

Select Products and click on the product number.

Select the Webshop Options tab.

Ensure the Just Eat Product tick box is ticked.

If you are using a separate price level, you can also select the Price Level here.

Save.

Repeat for all products that will be delivered by Just Eat.

TillConfig menu

TillConfig Just Eat setup

In TillConfig navigate to Webshop > Just Eat > General Settings > select the Site.

Enter the Delivery Charge PLU.

If you require a Small Order Fee PLU, repeat the process used above for adding your Delivery Charge PLU.

Save.

Select Just Eat.

Select Opening Times.

Select the Site.

Click on 'Add' under each day to enter the opening & closing times.

Scroll down the page to enter the collection times - click on Add under each day.

Save.

TillConfig Just Eat API

Once your menu has been setup and the initial process has been confirmed by our Support team, you will be provided with your Just Eat FLYT API Credentials.

In TillConfig select Just Eat.

Select API Credentials.

Enter the FLYT API Key provided to you by ICRTouch Support.

Save.

TillConfig Just Eat menu

Select the Just Eat breadcrumb.

Select Menus.

Select the Site from the drop down menu.

Load the Menu from the Site that you have programmed and preview to confirm it has been configured.

Once you have confirmed that the menu is visible, notify ICRTouch Support so they can communicate with Just Eat to ensure the site has been successfully integrated.

Once confirmed, you can now click 'Push Menu'.

You can also save your menu configuration at this point for later use to update your menu. (Ensure future menu updates are only pushed from Tillconfig rather from the standalone Just Eat device).

You can configure a menu on one site and push it to a number of different ones at the same time.

TillConfig Just Eat stock

In TillConfig select the Just Eat breadcrumb.

Select Stock.

Select the Site from the drop down menu.

You can make products available or unavailable on your menu from this interface as well as view your current stock levels.

 

Reserve with Google Integration for TouchReservation
Google Business Profile
Reservation screenshots
Reserve with
Google Integration
The Reserve with Google integration allows customers to book services directly through Google
Search, Maps, and Assistant. The integration streamlines the booking experience by connecting
customers with TouchReservation in real-time.
The Reserve with Google integration provides access to the following application programming
interfaces:
Inventory - submit availability, services, and merchants.
Booking - receive and manage booking requests.
Order update - manage updates, cancellations, and status changes.
View customer facing reservation screenshots.
Restrictions:
Deposits are not possible with this integration.
Reservations are only available up to 30 days in advance.
Reserve with Google
Integration for
TouchReservation
Reserve with Google is only available on Google Business accounts in the following
categories:
Pub, Café, Bistro, Restaurant, Gastropub, Wine Bar, Brewery, Modern European Restaurant,
Tapas Restaurant, Seafood Restaurant, Mediterranean Restaurant, Asian Fusion
Restaurant…and similar restaurant or hospitality types.
The same applies for demo accounts. We recommend utilising this account for
demonstrations: https://share.google/tyA8WOJZQdzYQTT3f
1. TouchOffice Web.
View the Partner portal reference guide.
2. TouchReservation.
3. Reserve with Google Web service - Partners must complete a request form at
https://icrtou.ch/rwg.
4. Set up your Google Business Profile - Refer to the Google Business Profile Help Get
started guide for details.
1. Go to tillconfig.net, then sign in.
2. Configure TouchReservation.
Prerequisites:
TillConfig instructions
3. Select Reservations, then select View sites. Add and edit sites as required. Google
requires the full business address listed here to match the Google Business Profile.
4. Select Reservations, then select Reserve with Google.
5. Select the Enable checkbox on each site which requires the integration.
TillConfig changes are synchronised with Google at 2am UTC each day. When a reservation is
requested, Google checks the information in TillConfig in real-time.
To cancel the service, complete the form at https://icrtou.ch/rwgcancel
Cancellations
1. Refer to the Google Business Profile get started guide for details.
2. Find the listing:
Open Google Maps or Google Search on a computer or mobile device.
Search for the business name.
If a listing appears, select it to ensure it's the correct business.
3. Claim the business:
Select "Claim this business".
4. Verify ownership:
Select a verification option (phone or email).
Follow the on-screen instructions to complete the verification process.
5. Manage your profile:
Google Business Profile
Once verified, you can manage your business information, including adding photos,
operating hours, and other details.
6. Drop a pin for your business on Google Maps:
With Google Maps, select Edit profile and then Business information and then
location.
Next to 'Business location', select Edit Edit.
To adjust your pin location, select Adjust.
Move the map so the pin points to your business location.
Select Done and then Save.
Book a reservation
Reservation confirmation
Reservation screenshots
Google Maps screenshots
Reservation summary
Modify a reservation
Cancel a reservation

WooCommerce's target market is online retail stores, not hospitality. Therefore, we do not
recommend using this solution for food service businesses, as it has multiple limitations that may
not meet the needs of most business owners. While WooCommerce provides support for multisite
operations, comprehensive stock control is unavailable.
API key
Request your WebShop WooCommerce API key from support@icrtouch.com. The email should
include the account alias and specify the request is for WooCommerce.
WooCommerce
TouchPoint 2016 or newer required
On the till you will need to configure the Access Key in System Programming ≥ System
Configuration.
Terminal Access Key
1. Go to www.tillconfig.net.
2. Select Terminal Access Key.
3. On TouchPoint, select Programming > System programming > System configuration.
Enter the Terminal Access Key in the Terminal ID field.
4. You will need to set Webshop to YES. When the till is setup any sales waiting on the
website will be sent to the till.
If you are using stock with your webshop, you will also need to set 'Enable stock download' to 'YES'
in System Programming ≥ System Configuration.
For the stock figures to upload you will need to set the stock figures on your PLU’s on the tills and
set the “Maintain Stock” flag to “YES”.
This is set via “Program 3” ≥ “PLU” ≥ “PLU” ≥ (Select a product you wish to enter stock for).
The stock figures for all PLU’s set to “Maintain Stock” will be uploaded to the cloud when the till is
started and any subsequent sales on the terminal will upload to the website.
The webshop (woocommerce) will then get the latest stock figures from here.
The ICRTouchPLU setting must be configured on all PLU’s on the webshop that you wish to link
with TouchPoint.
The ICRTouchPLU number can be set under “General” settings for normal products, or under the
variation options for products with different sizes or colours etc.
In addition the ICRTouchPLU numbers are now shown on the main products page on the website in
an extra column.
Variation Products
Variation products are products which have been assigned multiple attributes i.e. different sizes of
clothing or different designs etc.
When a product becomes a variable product the ‘ICRTouchPLU’ attribute is no longer assigned to
the main product but instead it is assigned to each variation so different sized clothes for example
can refer to different PLU numbers on the TouchPoint Terminal.
In this example we have a Jura Giga X8 Coffee Machine with 3x different colours for Silver, Black
and White.
Each of these different colours has been configured with different PLU numbers to refer to the
products on the till.

All Products
The main product page will show all of the ICRTouchPLU numbers currently assigned to a product.
Variable products will show each product separated by a “|” separator.
ICRTouch Tillconfig Stock Figures
You can now view the stock figures uploaded from the tills by logging into your account at
www.tillconfig.net and clicking on the “View Stock” page.
Multisite Limitations
WooCommerce's target market is online retail stores, not hospitality. Therefore, we do not
recommend using this solution for food service businesses, as it has multiple limitations that may
not meet the needs of most business owners. While WooCommerce provides support for multisite
operations, comprehensive stock control is unavailable.
The available stock shown on the product pages, shows the available stock on the site set in the
Site ID box on the plugin settings page.
Using the plugin settings, you can set up a 'site picker'. When enabled, and site names are set, an
extra option will appear on the checkout page asking which site the customer wants to use for
their order.
This would primarily be used for setting which site the order would be collected from. The stock
adjustment for products purchased in the order will be made on the site chosen using the picker
on the checkout page, however the available stock showing on the product will still show the stock
in the Site as set in the Site ID box.
Revision #7
Created 19 March 2025 11:21:58 by Louise Friedman
Updated 19 March 2025 15:31:20 by Louise Friedman

This document describes how to set up the Stripe EFT Payments for TouchPoint.
Getting started
TouchPoint setup
Linking to TouchOffice Web
EFT Application Settings
Troubleshooting
Stripe EFT for
Touchpoint
Use Stripe Terminal and TouchOffice web to accept in-person payments on TouchPoint.
Windows 10
TouchPoint 2024 VID8004 or Later
TouchPoint must be licensed
TouchOffice Web Account
Stripe Account onboarded via TouchOffice Web.
Supported Stripe Smart Reader.
Net8.0 Desktop Runtime
Note: only readers supplied by ICRTouch are supported:
1. Stripe Reader S700 - https://stripe.com/gb/terminal/s700
Getting started
Overview
Prerequisites
Supported Readers
Total
£31.66
Tap or insert
2. Stripe BBPOS WisePOS E - https://stripe.com/gb/terminal/wisepose
1. Contact ICRTouch support team to request the integration installer.
2. Run the installer with the default settings on the Point of Sale Terminal.
3. When complete the EFT Application should start and display an icon in the Taskbar.
Installing the EFT Application
4. The application can also be manually started from the Start Menu.
5. After Installing Start Touchpoint and perform the steps detailed TouchPoint Setup page.
Linking Stripe to Touchoffice Web
Link the Stripe terminal to TouchOffice Web
ICRTOUCH
CANCEL
D
This device is not
1. In TouchPoint, select Programming > System programming > System flags > EFT control
program menu navigate go to the EFT Control options.
TouchPoint setup
EFT Control
2. The settings should be set as follows.
No Name Setting
1 EFT system Local EFT App
2 Prompt for cash back NO
3 Use SaleId in merchant ref YES
To Pay using the EFT Integration you will need a EFT Finalise key on your Touchpoint screen.
1. In TouchPoint, select Programming > Function keys > Finalise key.
2. Select a Finalise key to be your EFT finalisation key. This should be a EFT type button
linked to its own In Drawer totalizer.
3. The settings should be set as follows:
No Name Setting
1 Descriptor EFT
2 Update keyboard text? NO
3 Key type EFT
4 Low amount limit £ 0
5 Low amount limit £ 0
6 Drawer in
CREDIT in Drawer
Drawer in will be reflected in your
End of Day reports and
TouchOffice Web.
7 Drawer out
CashBack
Drawer out will be reflected in
your End of Day reports and
TouchOffice Web.
8 Open drawer YES
9 Enforce amount tendered YES
10 Inhibit partial tendering NO
11 Inhibit amount tendering NO
12 Enforce subtotal NO
13 Automatic receipt printing NO
EFT Finalise Key
No Name Setting
14 Warn if a check is open NO
15 No over-tender
16 Print tax break down
17
Print extra ticket with signature
strip
18 Compulsory Eat In/Take Out
19 Tendered amounts in EUROs (sub)
20
Prompt with numeric keypad for
tender
21 Prompt for device
If set to yes, the application will
display a select terminal dialog
before starting the transaction.
4. Link the key on your keyboard level. In TouchPoint select Programming > Keyboard.
There are no locally printed Touchpoint reports required for Stripe. TouchOffice web will include
Interactive sales explorer detailing stripe payments.
Reports
A TouchOffice Web account that has an onboarded Stripe account is required to use this
Integration. A login with access to the API authorisation page is required to complete this step.
1. The first time you attempt a transaction the application be prompted to link to
TouchOffice Web. The linking screen can also be launched from a connect option on right
click menu.
Linking to TouchOffice Web
2.
Press the Connect button to start the linking process.
3. Make a note of the short digit code displayed and then Login to TouchOffice web and go
to the API Authorisation page.
4. From the Authorisation page use the Activate Button
5. Enter the code into TouchOffice Web. The EFT Application connect screen will now update
to show connected.
6. Once connected. You can close this screen. You will now be able to process card
payments
Some options are supplied by the application for the ICRTouch Partner to find tune the Integration
to the customers needs. Settings can be accessed by right clicking the icon and choosing settings
option.
[Image]
No Setting Description
1 Language*
Set Default Language for prompts
and feedback supplied by the
Integration.
* Language files are defined
in
%AppData%\ICRTouch\StripeE
FTInterface\Language
2 Currency Set currency code
3 Preferred Terminal
Which terminal is used for
transactions when TouchPoint Select
Device flag is off.
4 Preferred Location Select device prompt will limit list to
terminals in this location.
5 Receipt Width
Column width for EFT Receipt. Should
match TouchPoint Receipt width
setting.
6 Print Customer Receipt Print Customer Receipt to TouchPoint
7 Includes address Add location address header?
8 Print Merchant Receipt
Print Merchant Receipt To
TouchPoint. ( Note payment detail
will be viewable in TouchOffice Web)
9 Includes address Add location address header?
EFT Application Settings
1. Check the POS terminal and Ped has network internet access.
2. Check the POS terminal has access to https://api.touchoffice.net
Stripe uses the following fully qualified domain names to interact with your integration:
api.emms.bbpos.com
armada.stripe.com
gator.stripe.com
*.terminal-events.stripe.com
Stripe Terminal uses the following fully qualified domain names to sync the device date over NTP:
time.android.com
time.cloudflare.com
2.android.pool.ntp.org
Stripe Terminal uses the following partially qualified domain name to interact with your integration:
*.[random-string].device.stripe-terminal-local-reader.net
Troubleshooting
Troubleshooting
Stripe terminal domains
Fully qualified domain names
Partially qualified domain names
ICRTouch support
1. Send the ICRTouch support team the EFT application log for the relevant day/day of
problem - it can be found in %AppData%\ICRTouch\StripeEFTInterface\Log\
2. When contacting ICRTouch support you will need to include the log file for day of your
issue.
3. The application requires .Net 8.0 desktop runtime to work properly.
4. Installed runtimes can be queried in windows by running the following command in
terminal or command line.
dotnet --info
Failed to connect to Reader
We attempted to start a sale but the
reader did not response. Check the
Reader is connected to a network
with Internet Access.
Failed to JackRabbitService
Ped contact lost and did not
reconnect in a timely manor. This
may be caused by low battery device
losing power during transaction.
Charge the device and retry.
Common errors Resolution
Common issues

Installation and initial configuration
Gift Aid general settings
Program Gift Aid departments
Gift Aid Admission or charity membership
Retail Gift Aid - shop
Gift Aid - recycling
Administration
Gift Aid donor emails
Gift Aid wastage
Troubleshooting
Non Gift Aid cash donations TouchPoint setup
Non Gift Aid cash donations TouchTakeway, ByTable and ByRetail setup
Gift Aid
1. Monthly ICRTouch Gift Aid subscription service.
2. The Gift Aid service Terminal Access Key and admin login from ICRTouch.
3. A Point of Sale terminal running TouchPoint 2017+.
4. An understanding of Shop Gift Aid requirements.
5. A receipt printer.
6. A label printer setup to print in Windows.
7. EAN-JK font (eanjk.ttf is included in the script download).
The following setup and configuration tasks should be done on each TouchPoint terminal that
will be connecting to Gift Aid.
The Gift Aid functionality is provided as an Etal script which sends and receives requests from the
web service.
1. Download the Gift Aid Etal script.
2. Extract the files to ICRTouch > Etal.
3. Open the ICRTouch > Etal > Giftaid2 folder.
Installation and initial
configuration
Prerequisites
TouchPoint installation and configuration
Etal script
The Gift Aid script is dependant on bundled application binaries which may be blocked by default.
Follow the instructions below to unblock msxsl.exe and Print32.exe:
1. Unblock msxsl.exe:
Open Microsoft Windows Explorer.
Right-click on ICRTouch > Etal > Giftaid2 > msxsl.exe.
Select Properties from the context menu.
Click the Unblock button in the lower right-hand corner of the resulting dialog.
Click OK or Apply.
2.
Windows security block
Unblock Print32.exe:
Open Microsoft Windows Explorer.
Right-click on ICRTouch > Etal > Print32.exe.
Select Properties from the context menu.
Click the Unblock button in the lower right-hand corner of the resulting dialog.
Click OK or Apply.
Etal.xml
1. Edit ICRTouch > Etal > Etal.xml in a text editor that understands xml highlighting such as
Notepad+ or Visual Studio Code.
2. Make sure the file is pointing to the correct Gift Aid file in bold below:
<?xml version="1.0"?>
<ETAL>
<FILE>GiftAid2.emoc2</FILE>
<OUTPUTFILE>output.txt</OUTPUTFILE>
<NAME>Gift Aid</NAME>
<CREATED>01/12/2017</CREATED>
<LASTMODIFIED>17/02/2020</LASTMODIFIED>
<MINVERID>6800</MINVERID>
<AUTHOR>ICRTouch</AUTHOR>
</ETAL>
3. Save
To customise the label you need to edit the ICRTouch > Etal > config.xml file - you are able to
change the position, size, font, colour etc. of each label component.
Components are the main block of the document. A component may be written by a script or may
be a generic component. Components are positioned on the label in the order set up in the
config.xml file.
There are a number of components that make up the label:
Text components - text components are automatically updated by the application and
include the date, barcode, randomcode and name.
Label components - label components are used for adding custom text or headers.
Shape components - shape components add label shapes such as a circle, rectangle,
hline, vline
Setup the Windows label
Image components - image components are useful for adding your logo and branding.
To configure the printer settings and the label components:
1. Open the ICRTouch > Etal > Giftaid2 folder.
2. Duplicate config.xml and name it config-backup.xml (this is a backup in case you would
like to revert back to the original file).
3. Edit config.xml, in a text editor that understands xml highlighting such as Notepad+ or
Visual Studio Code using the guidance in the table below:
Code Description
Printer settings
Syntax Description
<printer>Windows Printer Name</printer>
Replace Windows Printer Name with the name of
the label printer as it appears in Windows.
<width>51<width>
Replace 51 with the page width as required.
<height>28</height>
Replace 28 the page height as required.
<landscape/>
</page>
<landscape/>
The orientation can be configured as landscape or
portrait. Replace landscape with portrait if required.
<!--<preview/>-->
If you would like to setup a preview before printing
whilst you are setting up the layout of the barcode
labels replace:
<!--<preview/>--> with <preview/>
Once you have finished testing replace:
<preview/> with <!--<preview/>-->
Code Description
The printer section will look something like this:
<config>
<printer>OKI C5250n</printer>
<page>
<width>51</width>
<height>28</height>
<landscape/>
</page>
<landscape/>
<!--<preview/>-->
The date, barcode, randomcode, name and price components are created by the Gift Aid script and are
standard in the config.xml file. The following settings are to format the date on the label.
Text components
Syntax Description
<name>Date</name>
The name is to identify the component in the
print.xml file.
<type>text</type>
Identifies the type of component.
<left>26</left >
The position from the left in mm's.
< top>2.5</top >
The position from the top in mm's.
<face>Arial</ face >
The typeface.
<colour>000000</colour>
<colour>black</colour>
The colour can be specified by the RGB colour value
or by the colour name.
<italic/> Characters that slant upward to the right.
<bold/> Characters that are darker and heavier than normal.
<size>10</size > Print size.
<alignment>left</alignment >
<alignment>centre</alignment >
<alignment>right</alignment >
Sets the alignment, options are left, centre and right.
Code Description
Labels will print out the text written in the caption field. Used for adding custom text or headers.
Label Component
Syntax Description
<name>Unique name</ name >
The name is to identify the component in the
print.xml file.
<type>label</type>
Identifies the type of component.
<caption>This is a text label</caption>
Caption to be printed.
<left>26</left>
The position from the left in mm's.
<top>2.5</top>
The position from the top in mm's.
<face>Comic Sans MS</face>
The typeface.
<colour>ff0000</colour>
The colour can be specified by the RGB colour value
or by the colour name.
<italic/>
Characters that slant upward to the right.
<bold/>
Characters that are darker and heavier than normal.
<size>10</size>
Size.
<alignment>centre</alignment>
Aignmentl.
This will add a circle, rectangle, hline or vline shape to the label.
Shape component
<name>Unique name</name>
The name is to identify the component in the
print.xml file.
<type>Shape</type>
Identifies the type of component.
<subtype>Circle</subtype>
Identifies the subtype of component.
<left>47</left>
The position from the left in mm's.
Code Description
<top>6</top>
The position from the top in mm's.
<width>20</width>
Width.
<height>20</height>
Height.
<line>RGB colour and width of the outline
Outline colour.
<fillcolour>00FF00</fillcolour> RGB fill colour, if
no present the fill is transparent
The colour can be specified by the RGB colour value
or by the colour name.
This will add an image to the label.
Image Component
<name>Unique Name</name>
The name is to identify the component in the
print.xml file.
<type>Image</type>
Identifies the type of component.
<file>c:\image.jpg</file>
Image path and file name.
<left>47</left>
The position from the left in mm's.
<top>6</top>
The position from the top in mm's.
<width>20</width>
Width.
<height>20</height>
Height.
<stretch/>
If set the image is stretched to fit in the size, else
the image is cropped to fit.
4. Save the file and exit. The Windows print job is generated using the print layout specified
in the config.xml file.
Config.xml file example
The following table shows the formatting of a collector teapot label. The settings in the config.xml
file are edited not the print.xml file. The config.xml file sends the print instructions to the print.xml
file.
config.xml print.xml
In the example the printer is specified as Microsoft Print to PDF instead of a printer. Once
you have fully tested how the label will print you can change the printer to an actual printer.
<config>
<printer>Microsoft Print to PDF</printer>
<page>
<width>63.5</width>
<height>32</height>
<!--<landscape/>-->
</page>
<!--<preview/>-->
<components>
<component>
<name>Barcode</name>
<type>text</type>
<left>2</left>
<top>7</top>
<font>
<face>EAN JK</face>
<size>48</size>
</font>
<alignment>left</alignment>
</component>
<component>
<name>Randomcode</name>
<type>text</type>
<left>3</left>
<top>21</top>
<font>
<face>Arial</face>
<size>8</size>
</font>
<alignment>left</alignment>
</component>
<component>
<name>date</name>
<type>text</type>
<left>60</left>
<top>21</top>
<font>
<face>Arial</face>
<size>8</size>
</font>
<alignment>right</alignment>
</component>
<component>
<name>Name</name>
<type>text</type>
<left>2</left>
<top>3</top>
<font>
<face>Arial</face>
<size>10</size>
</font>
</component>
<component>
<name>Price</name>
<type>text</type>
<left>60</left>
<top>12</top>
<PRINT>
<ITEMS>
<ITEM>
<DATE>26/10/2022</DATE>
<BARCODE>2900100004213</BARCODE>
<RANDOMCODE>2900100004213</RANDOMCODE>
<PRICE>&#163;5.00</PRICE>
<NAME>Collector Teapot</NAME>
</ITEM>
</ITEMS>
</PRINT>
Do not edit this file.
Label components illustration
Label print illustration
The donor label is similar to the item label except there is no price.
Getting the alignment working as intended can take a little trial and error. Once you have
configured the settings you can test the printer double clicking the print32.exe file.
Donor label
The Print.xml file is recreated for each print and should not be modified. The Items in this file have
a corresponding component in the config.xml file.
<PRINT>
<ITEMS>
<ITEM>
<DATE>26/10/2022</DATE>
<BARCODE>2900100004213</BARCODE>
<RANDOMCODE>2900100004213</RANDOMCODE>
<PRICE>&#163;5.00</PRICE>
<NAME>Collector Teapot</NAME>
</ITEM>
</ITEMS>
</PRINT>
1. In TouchPoint select Program > All programming > System programming > System
configuration.
2. Scroll down to Access Key and enter the access key found in TillConfig > Other settings >
Terminal Access Key.
TouchPoint, Program, All programming, System programming > System
configuration illustration
Print.xml file
Setup the Terminal Access Key
1. In TouchPoint select Program > System > Check for update.
TouchPoint, Program, System, Check for update illustration
Update the TouchPoint libraries

2. Enter ETALLIB in the Check for update field and then select enter.
Update software illustration
3. Select Yes to update the software.
4. Restart TouchPoint.
5. The Gift Aid functionality is activated.
6. The Gift Aid status keys are created:
GiftAidDonate = 528
EditGoodPrice = 529
NonGiftAidDonate = 581 (this status key is no longer in use).
RePrintLastLabel = 582
GiftAidCustBarcode = 583
DeclarationTestPrint = 584
ProgramGADepts = 585
GiftAidCustNo = 586
1. In TouchPoint select Program > All Programming > Etal > Gift Aid.
TouchPoint Program, All programming, Etal, Gift Aid illustration
2. Update the settings using the guidance in the table below:
No Field Description
TouchPoint Program, All programming, Etal, Gift Aid fields
Gift Aid general settings
Gift Aid general settings
1 3 Digit Site ID for GiftAid
Retail barcodes generated by the
system will contain a site ID. The
default value is 100.
2 PLU range start
The PLU range start
automatically
reprograms a range of
250 continuous PLUs
when setting retail
shop items.
The range should be
at least 250 lower
than the Scanning
PLU Start Record
and not clash with any
pre-programmed
products.
To check the Scanning
PLU start record select
Program > System
programming >
System flags > PLU
control > Scanning
PLU start record and
Scanning PLU end
record.
3 Show wait window
Displays a wait message whilst
the system is loading.
Options:
YES
NO
4 Allow blank email
Options:
YES
NO
By default the system will force
the email request.
It is a legal requirement
for the charity to contact
the donor regarding the
declaration details. If the
charity wishes to contact
by post then you can
allow blank emails.
5 Print settings
Settings regarding whether to
print a declaration, which printer
is used and whether to print gift
aid barcodes on the receipt.
5a Print declarations
You need to make a Gift Aid
declaration in order for the
charity to claim.
Options:
YES
NO
5b Connected to MC No.
Options:
My device
5c Connected to Port No.
Options:
Not connected
COM1
COM2
COM3
COM4
COM5
COM6
COM7
COM8
LPT1
LPT2
OPOS1
OPOS2
OPOS3
OPOS4
OPOS5
OPOS6
5d Reprint declarations every
visit
Options:
YES
NO
5e Print barcode
Options:
YES
NO
6 Logo settings Logo and Text Content settings.
6a GiftAid declaration heading This must identify your charity.
6b Line 1 Name of charity
6c Line 2 Charity address 1
6d Line 3 Charity address 2
6e Line 4 Charity address 3
6f GiftAid declaration footer This must declare that the
donation is for Gift Aid.
6g Line 1 I want to Gift Aid my current
donation
6h Line 2 and any donations I may make in
the
6i Line 3 future or have made in the past 4
years
6j Line 4 to (Name of Charity).
6k Line 5
6l Line 6 I am a UK taxpayer and
understand that
6m Line 7 if I pay less Income Tax and/or
Capital
6n Line 8 Gains Tax than the amount of Gift
Aid
6o Line 9 claimed on all my donations in
that tax
6p Line 10 year it is my responsibility to pay
6q Line 11 any difference.
6r Line 12
6s Line 13 I will notify
6t Line 14 (Name of Charity)
6u Line 15 of any change in my personal
6v Line 16 circumstances, such as name and
6w Line 17 address, or that I no longer pay
UK
6x Line 18 Income or Capital Gains tax or I
wish
6y Line 19 to cancel the declaration.
7 Debug settings
7a File Gift Aid
7b Output file GiftAid2.emoc2
7c Author output.txt
7d Created ICRTouch
7e Last modified
3. The Range PLU will automatically create 250 PLUs with the fields set as per the table
below (do not modify these PLUs as they are reserved for the Gift Aid functionality):
No Field Description
1 List box link 1
The following Gift Aid
fields are set to No link:
List box link 1
List box link 2
List box link 3
List box link 4
List box link 5
List box link 6
2 List box link 2
3 List box link 3
4 List box link 4
5 List box link 5
6 List box link 6
7 Set menu
The Set menu field is set
to NO.
8 Tax rate
The Tax rate field is set
to No tax.
9 Mix & match
The Mix & Match field is
set to NONE.
10 Quantity of 1st @ price
The Quantity of 1st @
price is set to 1.00.
11 Selective Itemiser 1
Selective itemiser 1 is
set to NO.
12 Selective Itemiser 2
Selective itemiser 2 is
set to NO.
13 GA sell a weight PLU +250
GA sell a weight PLU
+250 is set to NO.
14 GA misc CASH donation
GA misc CASH donation
is set to NO.
15 GA admission
GA admission is set to
NO.
4. When the Gift Aid script runs for the first time it will create 8 Gift Aid status keys near the
end of the other status keys. To view these status keys in TouchPoint select Program >
All programming > Functiion keys > Status key.
TouchPoint, Program, All programming, function keys, status key Retail Shop
Gift Aid keys illustration
The status key creation status is logged in ICRTouch > Etal > Giftaid2 > output.txt.

The function of the ProgramGADepts status key is to update the Gift Aid PLU range descriptor. This
action only needs to be done once.
Assign the ProgramGADepts status key:
Program Gift Aid
departments
ProgramGADepts
1. In TouchPoint, select Program > Keyboard.
2. Select the Screen level using the arrows.
3. Select an empty button.
4. Select Status key from Choose file type.
5. Scroll down and select ProgramGADepts and select OK.
6. Exit Program mode.
7. In TouchPoint select Sales and then select the keyboard level.
8. Select the ProgramGADepts button to create the Gift Aid department links (this only
needs to be done once).
9. In TouchPoint select Program > All programming > PLU > PLU.
10. Enter the first PLU number to jump to the PLU (or use the arrow keys to scroll down). The
PLUs will be named Dept 1, Dept 2 etc.
TouchPoint, Program, All programming, PLU, PLU Range PLUs illustration
11. Exit Program mode.
The function of Gift Aid admission is to include an optional Gift Aid cash donation with the
purchase of an admission fee/ticket.
An uplift is configured and the customer asked whether they would like to make a voluntary cash
donation to a charitable cause. The charity is allowed to claim an additional 25p for every £1 (from
HM Revenue & Customs) donated under the Gift Aid scheme.
Money raised from this scheme goes towards vital charitable causes. An extra £1 paid under the
scheme can be worth 25% more to the charity as shown below:
Admission type Amount paid by visitor Amount paid by
government Total Received
Gift Aid admission* £11.00 £0.25 £11.25
Standard admission £10.00 £0.00 £10.00
*Gift Aid donations must be supported by a valid Gift Aid declaration - a Gift Aid declaration can
only cover donations made by an individual for themselves and members of their family.
Anyone can pay the Gift Aid on admission price, but the charity can only reclaim the tax on the
admission if the donor is a UK taxpayer. The donor needs to pay enough income tax or capital
gains tax in each tax year to cover the Gift Aid claimed on all their donations to charity. For more
information on the Gift Aid program go to https://www.gov.uk/donating-to-charity/gift-aid.
Gift Aid Admission or charity
membership
Admission
Charity membership fees
The Gift Aid admission functionality is to claim the Gift Aid benefit for charity membership fees.
Add your charitable causes as separates reasons when a customer purchases a ticket.
1. In TouchPoint, select Program > System programming > Reason table.
2. Select an empty reason.
3. Type a reason description.
Configure a reason table
The Gift Aid transaction key allows you to setup how the Gift Aid will be allocated.
1. In TouchPoint, select Program > All programming > Function keys > Transaction key.
2. Select an empty transaction key.
3. Populate the fields using the guidance in the table below:
No Field Description
Create a Gift Aid transaction key
1 Descriptor
GIFTAID.
2 Update keyboard text?
YES.
3 Key type
+AMOUNT.
4 Value
Enter the value of 0.00. The value
of the donation is configured in
the next step.
5 Show reason table
YES.
6 Print extra ticket with
signature strip?
YES.
1. In TouchPoint, select Program > All programming > ETAL > Gift Aid.
2. Select Admission settings.
3. Populate the fields using the guidance in the table below:
No Field Description
Update the Gift Aid admission settings
1 Surcharge admissions
Select YES.
2 Surcharge rate
Enter the surcharge percentage
i.e. 20.000 is 20 percent.
3 Surcharge amount key
Select the surcharge amount key
GIFTAID.
4 Prompt trigger
Select whether to prompt Gift aid
on PLU entry or at the end of the
sale.
4 Max GiftAid no prompts
Select the number of Gift Aid
prompts:
5 GA infoline on receipt?
Select YES.
6 GA amount line
Select YES.
7 GA amount text
Enter the amount text:
1. In TouchPoint, select Program > All programming > PLU > PLU.
2. Select an empty PLU and populate the fields using the guidance below:
No Field Description
Create the PLU
1 Descriptor
Enter a descriptor.
2 1st @ price Enter the admission price.
3 Department link Select the department.
4 Quantity of 1st @ price Select 1.
5 GA Admission Select YES.
1. In TouchPoint, select Program > Keyboard.
2. Select the Screen Level.
3. Select an empty button.
4. Choose PLU from Choose file type.
5. Select the PLU created for Gift Aid.
When the button is selected the teller is prompted to:
1. Include a Gift Aid donation
Assign the PLU to the keyboard
Selling a ticket with Gift Aid admission
2. Enter a postcode:
3. Select the charitable cause:
4. If the donor is found select the donor's address. If the donor is not found the teller will be
prompted to enter the title, first name, last name, house no or name, street, address line
1, address line 2, town/city, county and email address.
The function of the GiftAidDonate status key is to:
1. Register the donor's information.
2. Add new donated Gift Aid items that will be resold in the shop.
Retail Gift Aid - shop
GiftAidDonate status key
3. The GiftAidDonate status key is automatically created by the Etal script and should not be
modified.
To add the functionality to accept donated Gift Aid items that will be sold in a charity shop create
the Run Etal script status key.
1. In TouchPoint, select Program > All programming > Function keys > Status key.
2. Select an empty status key.
3. Populate the fields using the guidance in the table below:
No Setting Description
Donated items to be sold in a shop
1 Descriptor
Enter a description.
2 Update keyboard Text?
Select No.
3 Key type
Select Run Script (Etal).
4 Number
Enter 528.
4. Create the PLU number status key.
5. In TouchPoint, select Program > All programming > Function keys > Status key.
6. Select an empty status key.
7. Populate the fields using the guidance in the table below:
No Setting Description
1 Descriptor
Enter a description.
2 Update keyboard Text?
Select No.
3 Key type
Select PLU number.
4 Use random PLU codes (if no
mem num)?
Select Yes.
8. Assign the status key to the keyboard.
9. In TouchPoint, select Program > Keyboard.
10. Select the keyboard level and then select an empty button.
11. Select Status key from Choose file type.
12. Select the status key number that you created for the Donate GiftAid items status key.
13. Add a button image.
To accept a donated item that will be resold:
1. Enter the donor's postcode:
Registering the donor and accepting a donation
2. If the donor is found select the donor's address. If the donor is not found the teller
will be prompted to enter the title, first name, last name, house no or name, street,
address line 1, address line 2, town/city, county and email address.
3. A summary is displayed. Press ESC to exit:
4. Enter the donated item description:
5. Select the department:
6. Enter the price without the decimal point i.e. 1000 = £10.00.
7. Select Add to add additional Gift Aid stock items:
8. Select EDIT to modify the stock item if there is more than one item being donated.
9. When all stock items have been added select DONE.
10. The labels are printed.
Label components illustration
The function of the GiftAidDonate status key is to:
1. Add stock for recycling.
2. The GiftAidDonate status key is automatically created by the Etal script and should not be
modified.
Gift Aid - recycling
GiftAidDonate status key
To add the functionality to accept donated Gift Aid items that will be recycled create the Run Etal
script status key.
1. In TouchPoint, select Program > All programming > Function keys > Status key.
2. Select an empty status key.
3. Populate the fields using the guidance in the table below:
No Setting Description
Donated items to be recycled
1 Descriptor
Enter a description.
2 Update keyboard Text?
Select No.
3 Key type
Select Run Script (Etal).
4 Number
Enter 528.
4. Create separate departments for each category of recycled items. For example:
GLASS PLASTIC APPLIANCES
CARDBOARD
AND PAPER
METAL BATTERIES
5. In TouchPoint, select Program, All programming > PLU > Department.
6. Select an empty department and enter a description.
No Setting Description

1 Descriptor
Enter a description.
7. Create separate PLUs for each category of recycled items.
GLASS PLASTIC APPLIANCES
CARDBOARD
AND PAPER
METAL BATTERIES
8. In TouchPoint, select Program, All programming > PLU > PLU.
9. Populate the fields using the guidance in the table below:
No Setting Description
1 Descriptor
Enter a description.
2 1st @ price
Enter 1.00.
3 Department link
Select the relevant recycling
department.
4 Group link
Select the relevant recycling
group.
4 Enable preset overide?
Select Yes.
5 High digit limit
Enter 8.
6 PLU is weight PLU?
Select Yes.
7 Allow manual weight entry?
Select Yes.
8 Quantity of 1st @ price
Enter 1.00.
9 GA sell a weight PLU +250
Select Yes.
10 GA misc cash donation
Select No.
11 Ga admission
Select No.
10. Assign the PLU to the keyboard. In TouchPoint, select Program > Keyboard.
11. Select the keyboard level and then select an empty button.
12. Select PLU from Choose file type.
13. Select the PLU that you created in the previous step.
14. Add a button image.
The function of the GiftAidCustBarcode status key is to add a Gift Aid donors information and print
a barcoded label without adding donated stock. The label is printed and the Item entry resolved at
point of sale.
The reasons a charity shop may want this option is:
Administration
GiftAidCustBarcode status key
1. To print out labels with a barcode in preparation for the donation. This saves time when
the donor brings the donated items to the shop or is a regular donor.
2. Stock can sit on the shelf for several weeks or months. By not entering the stock details
at the time of the donation the charity shop can decide the price when a customer
purchases the item.
Assign the GiftAidCustBarcode status key:
1. In TouchPoint, select Program > Keyboard.
2. Select the Screen level using the arrows.
3. Select an empty button.
4. Select Status key from Choose file type.
5. Scroll down and select GiftAidCustBarcode and select OK.
When the button is selected the teller will be prompted to:
1. Enter a postcode:
2. Select a title:
3. Enter a first name:
4. Enter a last name:
5. Enter the house number or name:
6. Enter the street name:
7. Enter address line 1:
8. Enter address line 2:
9. Enter the town or city:
10. Enter the county:
11. Enter the customer's email address:
12. The label is printed.
13. When the donor brings in an item to donate the teller will scan the barcode and be
prompted to choose the department:
The function of the DeclarationTestPrint status key is to test print the Gift Aid declaration..
DeclarationTestPrint status key
The function of the GiftAidCustNo status key is to reprint the donor's barcoded label.
GiftAidCustNo status key
1. In TouchPoint, select Program > Keyboard.
2. Select the Screen Level.
3. Select an empty button.
4. Choose Status key from Choose file type.
5. Scroll down and select GiftAidCustNo and select OK.
6. When the button is pressed the teller will be prompted to:
Enter a customer number:
Enter the quantity of labels required:
The function of the EditGoodPrice status key is to edit the price of a previously added Gift Aid
stock item.
To assign the GiftAid EditGoodPrice status key:
1. In TouchPoint, select Program > Keyboard.
EditGoodPrice status key
2. Select the Screen level using the arrows.
3. Select an empty button.
4. Select Status key from Choose file type.
5. Scroll down and select GiftAid EditGoodPrice and select OK.
6. When the button is selected the teller will be prompted to scan the barcode.
7. Enter the price.
8. Enter the department.
The function of the RePrintLastLabel status key is to reprint the last label.
RePrintLastLabel status key
1. In TouchPoint, select Program > Keyboard.
2. Select the Screen Level.
3. Select an empty button.
4. Choose Status key from Choose file type.
5. Scroll down and select Reprintlastlabel and select OK.
The function of the NonGiftAidDonate status key is not in use.
NonGiftAidDonate status key

Email content
1. In TillConfig select GiftAid > Emails.
2. Select the Email editor button.
3. Position your cursor in the email content area to edit.
Gift Aid donor emails
4. Text in curly brackets are tags that are populated with data by the application - for
example {COMPANY_NAME} will be populated with the company name.
Email editor illustration
Do not hard code information into these tags unless you want them to appear in
every email. For instance, hard coding a donors name will result in all donors being
addressed by that donors name.
5. To add tags position your cursor in the email content where you would like the tag to
appear and select Email tags > Giftaid - select the tag type followed by the tag to insert:
General tags:
- Company name - {COMPANY_NAME}
- End of current tax year - {YYYY}
- Commission percentage - {CP}
- Commission value - {C}
-Customer tags:
- Title - {CUSTOMER_TITLE}
- Firstname - {CUSTOMER_FIRSTNAME}
- Surname - {CUSTOMER_LASTNAME}
Giftaid tags:
- Company name - {COMPANY_NAME}
- End of current tax year - {YYYY}
- Commission percentage - {CP}
- Commission value - {C}
6. Select the paragraph tab and then select the paragraph type:
- Paragraph
- Address
- Pre
- Heading 1
- Heading 2
- Heading 3
- Heading 4
- Heading 5
- Heading 6
7. Select the font family tab and then select the font:
- Andale mon
- Arial
- Arial black
- Book antiqua
- Comic sans MS
- Courier new
- Georgia
- Helvetica
- Impact
- Symbol
- Tahoma
- Terminal
- Times new roman
8. Select the Font sizes tab and then select the size:
- 8pt
- 10pt
- 12pt
- 14pt
- 18pt
- 24 pt
- 36 pt
9. Select Send email automatically for goods sold if you would like to automate the goods
sold email - save.
10. Select Send email manually to push emails immediately.
11. Select Send email automatically for remaining stock if you would like to automate the
stock remaining email - save.
We recommend that you do not select Send email automatically for remaining
stock as an email will be sent to the donor each time an item is sold.
To record damaged stock:
1. In TillConfig, select Gift Aid > Stock Wastage.
2. Record the reason and select the tick box to record as wastage.
Gift Aid wastage

Troubleshooting
The status key creation status is logged in ICRTouch > Etal > Giftaid2 > output.txt.

The function of the Cash donations PLU is to accept cash or credit card donations directly via the
till.
1. Select Program > All programming > PLU > PLU.
2. Select an empty PLU and populate the fields using the guidance below:
No Field Description
Non Gift Aid cash donations
TouchPoint setup
Cash donations PLU
1 Descriptor Enter a description.
2 1st @ price Enter 0.00.
3 Tax rate This is used for tax calculation.
See Tax Table programming.
If the multi tax rates flag is set,
then you will be able to select
any combination of the first 8 tax
rates. Only tax rates with
configured name or a rate will be
shown.
Select No Tax.
4 Enable preset overide? When set, prices can be typed
into the button, for misc buttons
etc. Repeat price when pressed
again (see flag in PLU Control).
Select YES.
5 High digit limit Specifies the maximum number
of digits that can be keyed in
against an open price PLU.
Enter 8.

1. In TouchOffice Web select Products.
2. Select 0 - Head Office from the drop down list.
3. Select the Webshop options tab.
4. Ensure Shop on Webshop is ticked.
5. Select the Edit button under the Web category section.
6. Enter the name of the new category i.e. Adopt an elephant.
7. Save and then select Ok.
8. Make sure the new category is selected and then select the Edit button.
9. Press the pencil icon next to the category.
10. Upload an image, add a description and then select Save.
Edit web categories illustration
Non Gift Aid cash donations
TouchTakeway, ByTable
and ByRetail setup
Webshop options
11. Repeat if you would like to include additional web categories for other charities.
12. Drag and drop to reorder web categories.
Edit web categories illustration
Associate List PLUs with the PLU
You can create sub-web categories with a colon provided they do not exceed 255
characters.
Parent categories can contain a mixture of PLUs and sub-categories if desired. The
parent category must exist in your category list regardless of whether it is linked
directly to the PLU.
13. Select Web List Link 1 from the drop down list box.
14. Select Web List Link 2 from the drop down list box. Repeat if you have set up other List
PLU's.
Refer to the ICRTouch Foundational documentation for more information regarding the
classification, organisation and separation of data.

This is the flag reference manual to be used alongside the data layout manual.
File 1 - PLU
File 5 - Clerk
File 10 - List PLU
File 24 - Tax
File 50 - Fixed Total
File 51 - Finalise Key
File 52 - Transaction Key
File 53 - Status Key
File 54 - Subdepartments
File 59 - Mix & Match 1
File 75 - Keyboard2
File 101 - System Flags
File 149 - Non-PLU Table
File 159 - Mix & Match 2
File 260 - Customer
Flag Reference
Manual
File 270 - Customer Group
File 302 - System Configuration
File 304 - Device connection
File 900 - Journal
34 FLAG1 0x01 Prompt with picture
34 FLAG1 0x02 Prompt with notes
34 FLAG1 0x04 Single item sale
34 FLAG1 0x08 Selective itemiser 1
34 FLAG1 0x10 Selective itemiser 2
34 FLAG1 0x20 Selective itemiser 3
34 FLAG1 0x40 Selective itemiser 4
34 FLAG1 0x80 Selective itemiser 5
Field XML Tag Flag Description
35 FLAG2 0x01 Enable zero price sale
35 FLAG2 0x02 PLU is negative
35 FLAG2 0x04 Enable preset override
35 FLAG2 0x08 PLU is condiment
35 FLAG2 0x10 Do not print on receipts or
bills
35 FLAG2 0x20 PLU is weight PLU
35 FLAG2 0x40 Allow manual weight entry
File 1 - PLU
FLAG1
FLAG2
Field XML Tag Flag Description
35 FLAG2 0x80 Window stays until escape
Field XML Tag Flag Description
36 FLAG3 0x01 Commission 1
36 FLAG3 0x02 Commission 2
36 FLAG3 0x04 Commission 3
36 FLAG3 0x08 Commission 4
36 FLAG3 0x10 List link 6 items enforced
zero price
36 FLAG3 0x20 Set menu premium item
36 FLAG3 0x80 Update keyboard text
Field XML Tag Flag Description
55 FLAG4 0x00000001 Customer verify 1
55 FLAG4 0x00000002 Customer verify 2
55 FLAG4 0x00000004 Marine fuel
55 FLAG4 0x00000008 Generate Range Servant
ball dispenser code
55 FLAG4 0x00000010 Enable SEL printing
55 FLAG4 0x00000020 Pending SEL
Field XML Tag Flag Description
FLAG3
FLAG4
45 STOCKFLAG 0x01 Maintain stock
45 STOCKFLAG 0x02 Error when minimum stock
reached
45 STOCKFLAG 0x04 Inhibit sales when below
minimum stock
45 STOCKFLAG 0x08 Display stock quantity
Field XML Tag Flag Description
64 ALLERGENS 0x00000001 Celery
64 ALLERGENS 0x00000002 Cereals containing gluten
64 ALLERGENS 0x00000004 Crustaceans
64 ALLERGENS 0x00000008 Eggs
64 ALLERGENS 0x00000010 Fish
64 ALLERGENS 0x00000020 Lupin
64 ALLERGENS 0x00000040 Milk
64 ALLERGENS 0x00000080 Molluscs
64 ALLERGENS 0x00000100 Mustard
64 ALLERGENS 0x00000200 Nuts
64 ALLERGENS 0x00000400 Peanuts
64 ALLERGENS 0x00000800 Sesame seeds
STOCKFLAG
ALLERGENS
Field XML Tag Flag Description
64 ALLERGENS 0x00001000 Soya
64 ALLERGENS 0x00002000 Sulphur dioxide
64 ALLERGENS 0x00004000 Allergen 15
64 ALLERGENS 0x00008000 Allergen 16
Field XML Tag Flag Description
49 KPFLAG 0x0001 Print to KP 1
49 KPFLAG 0x0002 Print to KP 2
49 KPFLAG 0x0004 Print to KP 3
49 KPFLAG 0x0008 Print to KP 4
49 KPFLAG 0x0010 Print to KP 5
49 KPFLAG 0x0020 Print to KP 6
49 KPFLAG 0x0040 Print to KP 7
49 KPFLAG 0x0080 Print to KP 8
49 KPFLAG 0x0100 Print to KP 9
49 KPFLAG 0x0200 Print to KP 10
49 KPFLAG 0x0400 Print to KP 11
49 KPFLAG 0x0800 Print to KP 12
49 KPFLAG 0x0FFF Print to KP mask
49 KPFLAG 0x1000 Print in red
KPFLAG
Field XML Tag Flag Description
49 KPFLAG 0x2000 Print to ticket printer 1
49 KPFLAG 0x4000 Print to ticket printer 2
Field XML Tag Flag Description
5 COMPULSIONS 0x0001 Compulsory order number
5 COMPULSIONS 0x0002 Compulsory number of
covers
5 COMPULSIONS 0x0004 Compulsory check number
5 COMPULSIONS 0x0008 Prompt for customer
number
5 COMPULSIONS 0x0010 Prompt for eat in/take out
5 COMPULSIONS 0x0020 Compulsory customer
Field XML Tag Flag Description
6 RESTRICTIONS1 0x0001 Allow use of No Sale
6 RESTRICTIONS1 0x0002 Allow use of Error Correct
6 RESTRICTIONS1 0x0004 Allow use of Void
6 RESTRICTIONS1 0x0008 Allow use of Cancel
6 RESTRICTIONS1 0x0010 Allow use of Refund
6 RESTRICTIONS1 0x0040 Allow use of Price Shift
6 RESTRICTIONS1 0x0080 Allow use of Price Level
Change
6 RESTRICTIONS1 0x0100 Allow use of Menu Level
Shift
File 5 - Clerk
COMPULSIONS
RESTRICTIONS1
Field XML Tag Flag Description
6 RESTRICTIONS1 0x0200 Allow use of View Active
Clerks
6 RESTRICTIONS1 0x0400 Allow use of New Check
6 RESTRICTIONS1 0x0800 Allow use of Old Check
6 RESTRICTIONS1 0x1000 Allow use of New/Old Check
6 RESTRICTIONS1 0x2000 Allow use of Check Transfer
6 RESTRICTIONS1 0x4000 Allow use of Plus Amount
6 RESTRICTIONS1 0x8000 Allow use of Minus Amount
Field XML Tag Flag Description
7 MODECONTROL 0x0001 Allow use of Reg mode
7 MODECONTROL 0x0004 Allow use of Refund mode
7 MODECONTROL 0x0010 Allow use of X mode
7 MODECONTROL 0x0020 Allow use of Z mode
7 MODECONTROL 0x0080 Allow use of Manager mode
7 MODECONTROL 0x0100 Allow use of Program 1
7 MODECONTROL 0x0200 Allow use of Program 2
7 MODECONTROL 0x0400 Allow use of Program 3
7 MODECONTROL 0x0800 Allow use of Program 4
7 MODECONTROL 0x1000 Allow use of Program 5
7 MODECONTROL 0x2000 Allow use of Program 6
MODECONTROL
Field XML Tag Flag Description
8 OPERATION 0x0001 Sign off clerk at close of
sale
8 OPERATION 0x0002 Allowed to open other
clerks checks
8 OPERATION 0x0004 Use drawer 2
8 OPERATION 0x0008 Clerk is manager
8 OPERATION 0x0010 Clerk is trainee
8 OPERATION 0x0020 Default to floorplan at sign
on
8 OPERATION 0x0040 Allowed to correct items
from checks
8 OPERATION 0x0080 Last item error correct only
8 OPERATION 0x0100 Prompt to clock in at sign
on
8 OPERATION 0x0200 Compulsory clocked in
8 OPERATION 0x0400 Use drawer 3
8 OPERATION 0x0800 Non turnover
Field XML Tag Flag Description
9 RESTICTIONS2 0x0001 Allow use of Plus Percent
9 RESTICTIONS2 0x0002 Allow use of Minus Percent
OPERATION
RESTRICTIONS2
Field XML Tag Flag Description
9 RESTICTIONS2 0x0004 Allow use of Exchange
Points
9 RESTICTIONS2 0x0008 Allow use of
Suspend/Resume
9 RESTICTIONS2 0x0010 Allow use of Paid Out
9 RESTICTIONS2 0x0020 Allow use of Received on
Account
9 RESTICTIONS2 0x0040 Allow use of Price Change
9 RESTICTIONS2 0x0080 Allow use of Split Check
9 RESTICTIONS2 0x0100 Allow use of Deposit
9 RESTICTIONS2 0x0200 Allow use of Pay Account
9 RESTICTIONS2 0x0400 Allow use of Customer
Inquiry
9 RESTICTIONS2 0x0800 Allow use of Hot Card
Button
9 RESTICTIONS2 0x1000 Allow use of Customer
Transfer
9 RESTICTIONS2 0x2000 Allow use of Service
Charge Key
9 RESTICTIONS2 0x4000 Allow use of View
Customer Detail
9 RESTICTIONS2 0x8000 Allow use of View Remote
Journal
Field XML Tag Flag Description
10 RESTRICTIONS3 0x0001 Allow use of Credit Card
Capture
10 RESTRICTIONS3 0x0002 Allow use of House Bon
10 RESTRICTIONS3 0x0004 Allow use of View Open
Checks
RESTRICTIONS3
Field XML Tag Flag Description
10 RESTRICTIONS3 0x0008 Allow use of Edit Check
Text
10 RESTRICTIONS3 0x0010 Allow use of Cash2
10 RESTRICTIONS3 0x0020 Allow use of Minimise
10 RESTRICTIONS3 0x0040 Allow use of Menu Level
Shift2
10 RESTRICTIONS3 0x0080 Allow use of Media
Exchange
10 RESTRICTIONS3 0x0100 Allow use of Launch Batch
File
10 RESTRICTIONS3 0x0200 Allow use of Global Eat
In/Take Out
10 RESTRICTIONS3 0x0400 Allow use of Edit Customer
10 RESTRICTIONS3 0x0800 Allow use of Points
Adjustment
10 RESTRICTIONS3 0x1000 Allow use of Customer
Biometrics
10 RESTRICTIONS3 0x2000 Allow use of Preauth
Field XML Tag Flag Description
53 FLAG 0x00000001 Window stays until escape
53 FLAG 0x00000002 Force zero price
Field XML Tag Flag Description
File 10 - List PLU
FLAG
4 FLAG 0x0001 Add in
Field XML Tag Flag Description
File 24 - Tax
FLAG
3 FLAG 0x01 Totaliser is Non-Resetable
3 FLAG 0x02 Totaliser does NOT print on
reports
3 FLAG 0x04
Totaliser does NOT add to
total in drawer (FT 4 - 11)
No currency symbol (Etal
FT 100 - 199)
Field XML Tag Flag Description
File 50 - Fixed Total
FLAG
5 FLAG 0x0001 Open drawer
5 FLAG 0x0002 Inhibit amount tendering
5 FLAG 0x0004 Enforce amount tendering
5 FLAG 0x0008 Enforce subtotal
5 FLAG 0x0010 Automatic receipt printing
5 FLAG 0x0020 Inhibit partial tendering
5 FLAG 0x0040 Print tax breakdown
5 FLAG 0x0080 Prompt for cash back
5 FLAG 0x0100 Warn if a check is open
5 FLAG 0x0200 Tendered amount is Euro
(sub)
5 FLAG 0x0400 Compulsory eat in/take out
5 FLAG 0x0800 Prompt with numeric
keypad
5 FLAG 0x2000 Compulsory non-add
number entry
5 FLAG 0x4000 Print extra ticket with
signature strip
5 FLAG 0x8000 Update keyboard text
Field XML Tag Flag Description
File 51 - Finalise Key
Key type: 1 - Cash
Key type: 2 - Cheque
5 FLAG 0x0001 Open drawer
5 FLAG 0x0002 Inhibit amount tendering
5 FLAG 0x0004 Enforce amount tendering
5 FLAG 0x0008 Enforce subtotal
5 FLAG 0x0010 Automatic receipt printing
5 FLAG 0x0020 Inhibit partial tendering
5 FLAG 0x0040 Print tax breakdown
5 FLAG 0x0080 Print cheque
5 FLAG 0x0100 Warn if a check is open
5 FLAG 0x0200 Tendered amount is Euro
(sub)
5 FLAG 0x0400 Compulsory eat in/take out
5 FLAG 0x0800 Prompt with numeric
keypad
5 FLAG 0x2000 Compulsory non-add
number entry
5 FLAG 0x4000 Print extra ticket with
signature strip
5 FLAG 0x8000 Update keyboard text
Field XML Tag Flag Description
5 FLAG 0x0001 Open drawer
5 FLAG 0x0002 Inhibit amount tendering
5 FLAG 0x0004 Enforce amount tendering
Key type: 3 - EFT
Field XML Tag Flag Description
5 FLAG 0x0008 Enforce subtotal
5 FLAG 0x0010 Automatic receipt printing
5 FLAG 0x0020 Inhibit partial tendering
5 FLAG 0x0040 Print tax breakdown
5 FLAG 0x0080 No over tender
5 FLAG 0x0100 Warn if a check is open
5 FLAG 0x0200 Tendered amount is Euro
(sub)
5 FLAG 0x0400 Compulsory eat in/take out
5 FLAG 0x0800 Prompt with numeric
keypad
5 FLAG 0x1000 Prompt for device
5 FLAG 0x2000 Compulsory non-add
number entry
5 FLAG 0x4000 Print extra ticket with
signature strip
5 FLAG 0x8000 Update keyboard text
Field XML Tag Flag Description
5 FLAG 0x0001 Open drawer
5 FLAG 0x0002 Inhibit amount tendering
5 FLAG 0x0004 Enforce amount tendering
5 FLAG 0x0008 Enforce subtotal
5 FLAG 0x0010 Automatic receipt printing
Key type: 4 - Account
Field XML Tag Flag Description
5 FLAG 0x0020 Inhibit partial tendering
5 FLAG 0x0040 Print tax breakdown
5 FLAG 0x0080 No tender at partial credit
5 FLAG 0x0100 Warn if a check is open
5 FLAG 0x0200 Tendered amount is Euro
(sub)
5 FLAG 0x0400 Compulsory eat in/take out
5 FLAG 0x0800 Prompt with numeric
keypad
5 FLAG 0x2000 Compulsory non-add
number entry
5 FLAG 0x4000 Print extra ticket with
signature strip
5 FLAG 0x8000 Update keyboard text
Field XML Tag Flag Description
5 FLAG 0x0001 Open drawer
5 FLAG 0x0002 Inhibit amount tendering
5 FLAG 0x0004 Enforce amount tendering
5 FLAG 0x0008 Enforce subtotal
5 FLAG 0x0010 Automatic receipt printing
5 FLAG 0x0020 Inhibit partial tendering
5 FLAG 0x0040 Print tax breakdown
Key type: 5 - Hotel Transfer
Field XML Tag Flag Description
5 FLAG 0x0100 Warn if a check is open
5 FLAG 0x0200 Tendered amount is Euro
(sub)
5 FLAG 0x0400 Compulsory eat in/take out
5 FLAG 0x0800 Use booking ref (No, room
number)
5 FLAG 0x2000 Compulsory non-add
number entry
5 FLAG 0x4000 Print extra ticket with
signature strip
5 FLAG 0x8000 Update keyboard text
Field XML Tag Flag Description
5 FLAG 0x0001 Open drawer
5 FLAG 0x0002 Inhibit amount tendering
5 FLAG 0x0004 Enforce amount tendering
5 FLAG 0x0008 Enforce subtotal
5 FLAG 0x0010 Automatic receipt printing
5 FLAG 0x0020 Inhibit partial tendering
5 FLAG 0x0040 Print tax breakdown
5 FLAG 0x0100 Warn if a check is open
5 FLAG 0x0200 Tendered amount is Euro
(sub)
5 FLAG 0x0400 Compulsory eat in/take out
Key type: 11 - Cash2
Field XML Tag Flag Description
5 FLAG 0x0800 Prompt with numeric
keypad
5 FLAG 0x1000 Do not display change
5 FLAG 0x2000 Compulsory non-add
number entry
5 FLAG 0x4000 Print extra ticket with
signature strip
5 FLAG 0x8000 Update keyboard text
Field XML Tag Flag Description
5 FLAG 0x0001 Open drawer
5 FLAG 0x0008 Enforce subtotal
5 FLAG 0x0010 Automatic receipt printing
5 FLAG 0x0040 Print tax breakdown
5 FLAG 0x0100 Warn if a check is open
5 FLAG 0x0400 Compulsory eat in/take out
5 FLAG 0x2000 Compulsory non-add
number entry
5 FLAG 0x4000 Print extra ticket with
signature strip
5 FLAG 0x8000 Update keyboard text
Key type: 13 - Voucher
5 FLAG 0x0002 Compulsory eat in/take out
5 FLAG 0x4000 Print extra ticket with
signature strip
5 FLAG 0x8000 Update keyboard text
Field XML Tag Flag Description
Field XML Tag Flag Description
5 FLAG 0x0001 Allow price increase
5 FLAG 0x0002 Allow price decrease
5 FLAG 0x0004 Show reason table
5 FLAG 0x4000 Print extra ticket with
signature strip
5 FLAG 0x8000 Update keyboard text
Field XML Tag Flag Description
5 FLAG 0x4000 Print extra ticket with
signature strip
File 52 - Transaction Key
Key type: 7 - New Balance
Key type: 9 - Price Change
Key type: 14 - Voucher
Field XML Tag Flag Description
5 FLAG 0x8000 Update keyboard text
Field XML Tag Flag Description
5 FLAG 0x0002 Show reason table
5 FLAG 0x4000 Print extra ticket with
signature strip
5 FLAG 0x8000 Update keyboard text
Field XML Tag Flag Description
5 FLAG 0x0001 Force drawer 1
5 FLAG 0x0002 Force drawer 2
5 FLAG 0x0004 Show reason table
5 FLAG 0x4000 Print extra ticket with
signature strip
5 FLAG 0x8000 Update keyboard text
Field XML Tag Flag Description
5 FLAG 0x0001 Force drawer 1
Key type: 19 - Media Exchange
Key type: 20 - Paid Out
Key type: 21 - Received on Account
Field XML Tag Flag Description
5 FLAG 0x0002 Force drawer 2
5 FLAG 0x0004 Show reason table
5 FLAG 0x4000 Print extra ticket with
signature strip
5 FLAG 0x8000 Update keyboard text
Field XML Tag Flag Description
5 FLAG 0x0001 Force drawer 1
5 FLAG 0x0002 Force drawer 2
5 FLAG 0x0004 Show reason table
5 FLAG 0x4000 Print extra ticket with
signature strip
5 FLAG 0x8000 Update keyboard text
Field XML Tag Flag Description
5 FLAG 0x0001 Force drawer 1
5 FLAG 0x0002 Force drawer 2
5 FLAG 0x0004 Show reason table
5 FLAG 0x4000 Print extra ticket with
signature strip
5 FLAG 0x8000 Update keyboard text
Key type: 22 - Deposit
Key type: 23 - Pay Account
Field XML Tag Flag Description
5 FLAG 0x0010 Show reason table
5 FLAG 0x4000 Print extra ticket with
signature strip
5 FLAG 0x8000 Update keyboard text
Field XML Tag Flag Description
5 FLAG 0x0001 Allow preset override
5 FLAG 0x0002 Restrict to one use per sale
5 FLAG 0x0004 Allow negative balance
5 FLAG 0x0010 Show reason table
5 FLAG 0x4000 Print extra ticket with
signature strip
5 FLAG 0x8000 Update keyboard text
Field XML Tag Flag Description
5 FLAG 0x0001 Allow preset override
5 FLAG 0x0002 Restrict to one use per sale
Key type: 25 - Plus Amount
Key type: 26 - Minus Amount
Key type: 27 - Plus Percent
Field XML Tag Flag Description
5 FLAG 0x0004 Not allowed after item
5 FLAG 0x0008 Not allowed after subtotal
5 FLAG 0x0010 Show reason table
5 FLAG 0x0080 Applies to all products
5 FLAG 0x0100 Applies to selective
itemiser 1
5 FLAG 0x0200 Applies to selective
itemiser 2
5 FLAG 0x0400 Applies to selective
itemiser 3
5 FLAG 0x0800 Applies to selective
itemiser 4
5 FLAG 0x1000 Applies to selective
itemiser 5
5 FLAG 0x4000 Print extra ticket with
signature strip
5 FLAG 0x8000 Update keyboard text
Field XML Tag Flag Description
5 FLAG 0x0001 Allow preset override
5 FLAG 0x0002 Restrict to one use per sale
5 FLAG 0x0004 Not allowed after item
5 FLAG 0x0008 Not allowed after subtotal
5 FLAG 0x0010 Show reason table
5 FLAG 0x0080 Discount all products
Key type: 28 - Minus Percent
Field XML Tag Flag Description
5 FLAG 0x0100 Discount selective itemiser
1
5 FLAG 0x0200 Discount selective itemiser
2
5 FLAG 0x0400 Discount selective itemiser
3
5 FLAG 0x0800 Discount selective itemiser
4
5 FLAG 0x1000 Discount selective itemiser
5
5 FLAG 0x4000 Print extra ticket with
signature strip
5 FLAG 0x8000 Update keyboard text
Field XML Tag Flag Description
5 FLAG 0x0001 Tendered amount is value
5 FLAG 0x4000 Print extra ticket with
signature strip
5 FLAG 0x8000 Update keyboard text
Field XML Tag Flag Description
5 FLAG 0x0001 Adds to points (rather than
subtract points)
5 FLAG 0x4000 Print extra ticket with
signature strip
5 FLAG 0x8000 Update keyboard text
Key type: 29 - Exchange Points
Key type: 31 - Points Adjustment
Field XML Tag Flag Description
5 FLAG 0x0001 Add to tips 2
5 FLAG 0x0002 Show reason table
5 FLAG 0x4000 Print extra ticket with
signature strip
5 FLAG 0x8000 Update keyboard text
Field XML Tag Flag Description
5 FLAG 0x0001 Does not affect stock
5 FLAG 0x0002 Show reason table
5 FLAG 0x4000 Print extra ticket with
signature strip
5 FLAG 0x8000 Update keyboard text
Field XML Tag Flag Description
5 FLAG 0x4000 Print extra ticket with
signature strip
5 FLAG 0x8000 Update keyboard text
Key type: 32 - Tips
Key type: 33 - Refund
Key type: 36 - Cancel
Field XML Tag Flag Description
5 FLAG 0x0001 Complete line void
5 FLAG 0x0002 Show reason table for void
5 FLAG 0x0004 Show reason table for last
item correct
5 FLAG 0x4000 Print extra ticket with
signature strip
5 FLAG 0x8000 Update keyboard text
Field XML Tag Flag Description
5 FLAG 0x0001 Force drawer 1
5 FLAG 0x0002 Force drawer 2
5 FLAG 0x0004 Show reason table
5 FLAG 0x4000 Print extra ticket with
signature strip
5 FLAG 0x8000 Update keyboard text
Field XML Tag Flag Description
5 FLAG 0x4000 Print extra ticket with
signature strip
Key type: 37 - Error Correct
Key type: 40 - No Sale
Key type: 64 - EFT Preauth
Field XML Tag Flag Description
5 FLAG 0x8000 Update keyboard text
Field XML Tag Flag Description
5 FLAG 0x0001 Auto new check
5 FLAG 0x0002 Compulsory eat in/take out
5 FLAG 0x0004 Opens tables
5 FLAG 0x4000 Print extra ticket with
signature strip
5 FLAG 0x8000 Update keyboard text
Field XML Tag Flag Description
5 FLAG 0x4000 Print extra ticket with
signature strip
5 FLAG 0x8000 Update keyboard text
Field XML Tag Flag Description
5 FLAG 0x0001 Selected item
Key type: 92 - Check Transfer
Key type: 112 - Reason Table
Key type: 114 - House Bon
Field XML Tag Flag Description
5 FLAG 0x0002 Show reason table
5 FLAG 0x4000 Print extra ticket with
signature strip
5 FLAG 0x8000 Update keyboard text
5 FLAG 0x0001 Print on receipt
5 FLAG 0x0002 Includes service charge
5 FLAG 0x0004 Toggle between local and
Euro (sub)
5 FLAG 0x0008 Subtotal is Euro (sub)
5 FLAG 0x0010 Show end of sale total
window
5 FLAG 0x8000 Update keyboard text
Field XML Tag Flag Description
5 FLAG 0x8000 Update keyboard text
Field XML Tag Flag Description
5 FLAG 0x8000 Update keyboard text
Field XML Tag Flag Description
File 53 - Status Key
Key type: 6 - Subtotal
Key type: 8 - Price Inquiry
Key type: 10 - PLU Picture Inquiry
5 FLAG 0x8000 Update keyboard text
Field XML Tag Flag Description
5 FLAG 0x8000 Update keyboard text
Field XML Tag Flag Description
5 FLAG 0x8000 Update keyboard text
Field XML Tag Flag Description
5 FLAG 0x0001 Print to KP1
5 FLAG 0x0002 Print to KP2
5 FLAG 0x0004 Print to KP3
5 FLAG 0x0008 Print to KP4
5 FLAG 0x0010 Print to KP45
5 FLAG 0x0020 Print to KP6
5 FLAG 0x0040 Print to KP7
Key type: 12 - Stock Inquiry
Key type: 24 - Enable Tax
Key type: 30 - PLU Notes Inquiry
Key type: 41 - Non-add Number
Field XML Tag Flag Description
5 FLAG 0x0080 Print to KP8
5 FLAG 0x0100 Print on receipt
5 FLAG 0x0200 Allow alphanumeric
characters
5 FLAG 0x0400 Print to KP9
5 FLAG 0x0800 Print to KP10
5 FLAG 0x1000 Print on KPs in red
5 FLAG 0x2000 Treat as condiment1
5 FLAG 0x8000 Update keyboard text
Field XML Tag Flag Description
5 FLAG 0x0001 Generate next order
number
5 FLAG 0x8000 Update keyboard text
Field XML Tag Flag Description
5 FLAG 0x0001 Print to KP1
5 FLAG 0x0002 Print to KP2
5 FLAG 0x0004 Print to KP3
1. Prior to TouchPoint 76.08 this flag was known as "Use KP status of parent".
Key type: 42 - Order number
Key type: 43 - Text Message
Field XML Tag Flag Description
5 FLAG 0x0008 Print to KP4
5 FLAG 0x0010 Print to KP45
5 FLAG 0x0020 Print to KP6
5 FLAG 0x0040 Print to KP7
5 FLAG 0x0080 Print to KP8
5 FLAG 0x0100 Print on receipt
5 FLAG 0x0200 Send message to terminals
5 FLAG 0x0400 Print to KP9
5 FLAG 0x0800 Print to KP10
5 FLAG 0x1000 Print on KPs in red
5 FLAG 0x2000 Treat as condiment1
5 FLAG 0x8000 Update keyboard text
Field XML Tag Flag Description
5 FLAG 0x0001 Prompt for customer name
5 FLAG 0x0002 Issue stub receipt
5 FLAG 0x0004 Manual entry only
5 FLAG 0x0008 Print signature strip on
ticket
5 FLAG 0x8000 Update keyboard text
1. Prior to TouchPoint 76.08 this flag was known as "Use KP status of parent".
Key type: 44 - Credit Card Capture
Field XML Tag Flag Description
5 FLAG 0x8000 Update keyboard text
Field XML Tag Flag Description
5 FLAG 0x8000 Update keyboard text
Field XML Tag Flag Description
5 FLAG 0x8000 Update keyboard text
Field XML Tag Flag Description
5 FLAG 0x0001 Print to KP1
5 FLAG 0x0002 Print to KP2
5 FLAG 0x0004 Print to KP3
5 FLAG 0x0008 Print to KP4
Key type: 45 - Fidelity Loyalty Card
Key type: 46 - Change Check Text
Key type: 47 - Edit Customer
Key type: 49 - Preset Text Message
Field XML Tag Flag Description
5 FLAG 0x0010 Print to KP45
5 FLAG 0x0020 Print to KP6
5 FLAG 0x0040 Print to KP7
5 FLAG 0x0080 Print to KP8
5 FLAG 0x0100 Print on receipt
5 FLAG 0x0200 Send message to terminals
5 FLAG 0x0400 Print to KP9
5 FLAG 0x0800 Print to KP10
5 FLAG 0x1000 Print on KPs in red
5 FLAG 0x2000 Treat as condiment1
5 FLAG 0x8000 Update keyboard text
Field XML Tag Flag Description
5 FLAG 0x0001 Use random codes
5 FLAG 0x0002 Use search dialog
5 FLAG 0x0004 Use QWERTY
5 FLAG 0x8000 Update keyboard text
Field XML Tag Flag Description
1. Prior to TouchPoint 76.08 this flag was known as "Use KP status of parent".
Key type: 50 - PLU Number
5 FLAG 0x8000 Update keyboard text
Field XML Tag Flag Description
5 FLAG 0x0001 Next item only
5 FLAG 0x8000 Update keyboard text
Field XML Tag Flag Description
5 FLAG 0x8000 Update keyboard text
Field XML Tag Flag Description
5 FLAG 0x0001 Receipt item consolidation
5 FLAG 0x0002 Receipt sort by group
5 FLAG 0x0004 Receipt sort by dept
5 FLAG 0x0008 Receipt sort with totals only
5 FLAG 0x0020 Use receipt printer 2
Key type: 51 - Defer
Key type: 52 - KP Category Shift
Key type: 53 - Seat Number
Key type: 54 - Gift Receipt
Field XML Tag Flag Description
5 FLAG 0x4000 Allow intermediate receipt
printing
5 FLAG 0x8000 Update keyboard text
Field XML Tag Flag Description
5 FLAG 0x0001 Alphabetical order
5 FLAG 0x0002 Use search dialog
5 FLAG 0x8000 Update keyboard text
Field XML Tag Flag Description
5 FLAG 0x0001 View for signed on clerk
only
5 FLAG 0x8000 Update keyboard text
Field XML Tag Flag Description
5 FLAG 0x8000 Update keyboard text
Field XML Tag Flag Description
Key type: 58 - PLU Group Search
Key type: 59 - View Journal
Key type: 61 - Edit Floor Plan
5 FLAG 0x8000 Update keyboard text
Field XML Tag Flag Description
5 FLAG 0x8000 Update keyboard text
Field XML Tag Flag Description
5 FLAG 0x8000 Update keyboard text
Field XML Tag Flag Description
5 FLAG 0x8000 Update keyboard text
Field XML Tag Flag Description
Key type: 62 - Floor Plan
Key type: 63 - Remote Journal View/Tillwatch
Key type: 68 - Suspend
Key type: 69 - Resume
Key type: 70 - Price Shift
5 FLAG 0x8000 Update keyboard text
Field XML Tag Flag Description
5 FLAG 0x8000 Update keyboard text
Field XML Tag Flag Description
5 FLAG 0x8000 Update keyboard text
Field XML Tag Flag Description
5 FLAG 0x0001 Print on receipt
5 FLAG 0x8000 Update keyboard text
Field XML Tag Flag Description
5 FLAG 0x0001
Use account number
(rather than memory
number)
Key type: 71 - Receipt On/Off
Key type: 72 - Clerk Number
Key type: 73 - Multiply
Key type: 74 - Customer Number
Field XML Tag Flag Description
5 FLAG 0x0002 Use 3rd party customer
server (not ICRTouch)
5 FLAG 0x0004 Use search dialog
5 FLAG 0x8000 Update keyboard text
Field XML Tag Flag Description
5 FLAG 0x8000 Update keyboard text
Field XML Tag Flag Description
5 FLAG 0x0001 Receipt item consolidation
5 FLAG 0x0002 Receipt sort by group
5 FLAG 0x0004 Receipt sort by department
5 FLAG 0x0008 Receipt sort with totals only
5 FLAG 0x0010 Reprint last EFT receipt
5 FLAG 0x0020 Use receipt printer 2
5 FLAG 0x0040 Opens tables
5 FLAG 0x0100 Bill item consolidation
5 FLAG 0x0200 Bill sort by group
Key type: 75 - Sign Off
Key type: 76 - Receipt Print
Field XML Tag Flag Description
5 FLAG 0x0400 Bill sort by department
5 FLAG 0x0800 Bill print date/time
separator
5 FLAG 0x1000 Bill sort with totals only
5 FLAG 0x2000 Bill print only
5 FLAG 0x4000 Allow intermediate receipts
5 FLAG 0x8000 Update keyboard text
Field XML Tag Flag Description
5 FLAG 0x8000 Update keyboard text
Field XML Tag Flag Description
5 FLAG 0x0001 Receipt item consolidation
5 FLAG 0x0002 Receipt sort by group
5 FLAG 0x0004 Receipt sort by department
5 FLAG 0x0008 Receipt sort with totals only
5 FLAG 0x0010 Reprint last EFT receipt
5 FLAG 0x0040 Opens tables
Key type: 77 - Download Graphic Logo
Key type: 78 - Slip Print
Field XML Tag Flag Description
5 FLAG 0x0100 Bill item consolidation
5 FLAG 0x0200 Bill sort by group
5 FLAG 0x0400 Bill sort by department
5 FLAG 0x0800 Bill print date/time
separator
5 FLAG 0x1000 Bill sort with totals only
5 FLAG 0x2000 New items only
5 FLAG 0x8000 Update keyboard text
Field XML Tag Flag Description
5 FLAG 0x0002 Use 3rd party customer
server (not ICRTouch)
5 FLAG 0x8000 Update keyboard text
Field XML Tag Flag Description
5 FLAG 0x0001 Clear blacklist flag (no sets
flag)
5 FLAG 0x8000 Update keyboard text
Field XML Tag Flag Description
Key type: 79 - Customer Inquiry
Key type: 80 - Customer Hot Card
5 FLAG 0x8000 Update keyboard text
Field XML Tag Flag Description
5 FLAG 0x0001 Signed on customer only
5 FLAG 0x8000 Update keyboard text
Field XML Tag Flag Description
5 FLAG 0x8000 Update keyboard text
Field XML Tag Flag Description
5 FLAG 0x8000 Update keyboard text
Field XML Tag Flag Description
Key type: 81 - Customer Transfer
Key type: 82 - View Customer Detail
Key type: 83 - Caller ID Logon
Key type: 84 - Customer Biometrics
Key type: 88 - Weight
5 FLAG 0x0002 Get weight from scale
5 FLAG 0x8000 Update keyboard text
Field XML Tag Flag Description
5 FLAG 0x8000 Update keyboard text
Field XML Tag Flag Description
5 FLAG 0x8000 Update keyboard text
Field XML Tag Flag Description
5 FLAG 0x0001 Auto new check
5 FLAG 0x0002 Do not allow numeric entry
5 FLAG 0x0004 Opens tables
5 FLAG 0x8000 Update keyboard text
Field XML Tag Flag Description
Key type: 90 - Reg Window Down Arrow
Key type: 91 - Reg Window Up Arrow
Key type: 93 - New Check
5 FLAG 0x0004 Opens tables
5 FLAG 0x8000 Update keyboard text
Field XML Tag Flag Description
5 FLAG 0x0001 Auto new check
5 FLAG 0x0004 Opens tables
5 FLAG 0x8000 Update keyboard text
Field XML Tag Flag Description
5 FLAG 0x0001 Window stays down until
escape
5 FLAG 0x8000 Update keyboard text
Field XML Tag Flag Description
5 FLAG 0x8000 Update keyboard text
Field XML Tag Flag Description
Key type: 94 - Old Check
Key type: 95 - New/Old Check
Key type: 96 - List PLU
Key type: 97 - Covers
5 FLAG 0x8000 Update keyboard text
Field XML Tag Flag Description
5 FLAG 0x0001 Removes service charge
5 FLAG 0x0002 Sets service charge
5 FLAG 0x0004 Allow override amount
entry
5 FLAG 0x8000 Update keyboard text
Field XML Tag Flag Description
5 FLAG 0x8000 Update keyboard text
Field XML Tag Flag Description
5 FLAG 0x8000 Update keyboard text
Field XML Tag Flag Description
Key type: 98 - Split Check
Key type: 99 - Service Charge
Key type: 100 - Euro Shift
Key type: 101 - Location
5 FLAG 0x8000 Update keyboard text
Field XML Tag Flag Description
5 FLAG 0x8000 Update keyboard text
Field XML Tag Flag Description
5 FLAG 0x8000 Update keyboard text
Field XML Tag Flag Description
5 FLAG 0x8000 Update keyboard text
Field XML Tag Flag Description
Key type: 102 - Currency Exchange
Key type: 103 - Table Reservation
Key type: 105 - Clock In
Key type: 106 - Clock Out
Key type: 107 - Break In
5 FLAG 0x8000 Update keyboard text
Field XML Tag Flag Description
5 FLAG 0x8000 Update keyboard text
Field XML Tag Flag Description
5 FLAG 0x8000 Update keyboard text
Field XML Tag Flag Description
5 FLAG 0x0001 Script flag 1
5 FLAG 0x0002 Script flag 2
5 FLAG 0x0004 Script flag 3
5 FLAG 0x0008 Script flag 4
5 FLAG 0x0010 Script flag 5
5 FLAG 0x0020 Script flag 6
5 FLAG 0x0040 Script flag 7
5 FLAG 0x0080 Script flag 8
Key type: 108 - Break Out
Key type: 109 - Validation Print
Key type: 110 - Run Script (Etal)
Field XML Tag Flag Description
5 FLAG 0x0100 Script flag 9
5 FLAG 0x0200 Script flag 10
5 FLAG 0x0400 Script flag 11
5 FLAG 0x0800 Script flag 12
5 FLAG 0x1000 Script flag 13
5 FLAG 0x2000 Script flag 14
5 FLAG 0x4000 Script flag 15
5 FLAG 0x8000 Update keyboard text
Field XML Tag Flag Description
5 FLAG 0x8000 Update keyboard text
Field XML Tag Flag Description
5 FLAG 0x8000 Update keyboard text
Field XML Tag Flag Description
Key type: 111 - Play Macro
Key type: 113 - Set Menu Shift
Key type: 115 - Split Item
5 FLAG 0x8000 Update keyboard text
Field XML Tag Flag Description
5 FLAG 0x0001 Subtotal after shift
5 FLAG 0x8000 Update keyboard text
Field XML Tag Flag Description
5 FLAG 0x0001 Subtotal after shift
5 FLAG 0x8000 Update keyboard text
Field XML Tag Flag Description
5 FLAG 0x8000 Update keyboard text
Field XML Tag Flag Description
Key type: 159 - Menu Shift 2
Key type: 160 - Menu Shift
Key type: 161 - Escape
Key type: 162 - Price Level Change
5 FLAG 0x0001 Affects current sale only
5 FLAG 0x0002 Show current price level on
keyboard text
5 FLAG 0x8000 Update keyboard text
Field XML Tag Flag Description
5 FLAG 0x0001 Exempt tax 1
5 FLAG 0x0002 Exempt tax 1
5 FLAG 0x0004 Exempt tax 1
5 FLAG 0x0008 Exempt tax 1
5 FLAG 0x0010 Exempt tax 1
5 FLAG 0x0020 Shift tax rates (1 - 5 => 6 -
10)
5 FLAG 0x8000 Update keyboard text
Field XML Tag Flag Description
5 FLAG 0x0001 Exempt tax 1
5 FLAG 0x0002 Exempt tax 1
5 FLAG 0x0004 Exempt tax 1
5 FLAG 0x0008 Exempt tax 1
Key type: 163 - Eat In
Key type: 164 - Take Out
Field XML Tag Flag Description
5 FLAG 0x0010 Exempt tax 1
5 FLAG 0x0020 Shift tax rates (1 - 5 => 6 -
10)
5 FLAG 0x8000 Update keyboard text
Field XML Tag Flag Description
5 FLAG 0x0001 Use programmed directory
location
5 FLAG 0x0002 Delete file after use
5 FLAG 0x8000 Update keyboard text
Field XML Tag Flag Description
5 FLAG 0x0002 Show current eat in/take
out record on keyboard text
5 FLAG 0x8000 Update keyboard text
Field XML Tag Flag Description
5 FLAG 0x8000 Update keyboard text
Key type: 165 - Sale Item List Import
Key type: 166 - Global Eat In/Take Out
Key type: 172 - Auto Clerk
Field XML Tag Flag Description
5 FLAG 0x8000 Update keyboard text
Field XML Tag Flag Description
5 FLAG 0x8000 Update keyboard text
Field XML Tag Flag Description
5 FLAG 0x0001 Always prompt for number
of bills
5 FLAG 0x0040 Opens tables
5 FLAG 0x0100 Item consolidation
5 FLAG 0x0200 Sort by group
5 FLAG 0x0400 Sort by department
5 FLAG 0x0800 Print date/time separator
5 FLAG 0x1000 Sort with totals only
5 FLAG 0x8000 Update keyboard text
Key type: 173 - View Active Clerks
Key type: 174 - Clerk Change
Key type: 176 - Go Dutch Bill Print
Field XML Tag Flag Description
5 FLAG 0x0001 Print to KP1
5 FLAG 0x0002 Print to KP2
5 FLAG 0x0004 Print to KP3
5 FLAG 0x0008 Print to KP4
5 FLAG 0x0010 Print to KP5
5 FLAG 0x0020 Print to KP6
5 FLAG 0x0040 Print to KP7
5 FLAG 0x0080 Print to KP8
5 FLAG 0x0400 Print to KP9
5 FLAG 0x0800 Print to KP10
5 FLAG 0x8000 Update keyboard text
Field XML Tag Flag Description
5 FLAG 0x8000 Update keyboard text
Field XML Tag Flag Description
Key type: 177 - Send To KP Now
Key type: 178 - Plus Item
5 FLAG 0x0001 Allowed to open check
5 FLAG 0x0002 Show only this clerk's
checks
5 FLAG 0x0100 Show check file 1 (check)
5 FLAG 0x0200 Show check file 2 (table)
5 FLAG 0x0400 Show check file 3 (future)
5 FLAG 0x1000 Show check file 4 (future)
5 FLAG 0x8000 Update keyboard text
Field XML Tag Flag Description
5 FLAG 0x8000 Update keyboard text
Field XML Tag Flag Description
5 FLAG 0x8000 Update keyboard text
Field XML Tag Flag Description
Key type: 195 - View Open Checks
Key type: 196 - View Paid Checks
Key type: 197 - View Receipts
Key type: 198 - View Reports
5 FLAG 0x8000 Update keyboard text
Field XML Tag Flag Description
5 FLAG 0x8000 Update keyboard text
Field XML Tag Flag Description
5 FLAG 0x0001 Wait until completion
5 FLAG 0x0002 Launch as minimised
5 FLAG 0x8000 Update keyboard text
Field XML Tag Flag Description
5 FLAG 0x8000 Update keyboard text
Field XML Tag Flag Description
Key type: 199 - View Websales
Key type: 209 - Launch Batch File
Key type: 210 - Inline Functions
Key type: 211 - Clerk Functions
5 FLAG 0x8000 Update keyboard text
Field XML Tag Flag Description
5 FLAG 0x8000 Update keyboard text
Field XML Tag Flag Description
5 FLAG 0x8000 Update keyboard text
Field XML Tag Flag Description
5 FLAG 0x0001 Data backup
5 FLAG 0x0002 Data restore
5 FLAG 0x0004 Location 1 (floppy drive)
5 FLAG 0x0008 Location 2 (data backup
folder)
5 FLAG 0x0010 Location 3 (programmed
location)
5 FLAG 0x8000 Update keyboard text
Field XML Tag Flag Description
Key type: 212 - Send Program
Key type: 213 - Receive Program
Key type: 214 - Data Backup/Restore
5 FLAG 0x8000 Update keyboard text
Field XML Tag Flag Description
5 FLAG 0x0001 Open drawer when no
amount entered
5 FLAG 0x0002 Add to cash declared fixed
totaliser
5 FLAG 0x8000 Update keyboard text
Field XML Tag Flag Description
5 FLAG 0x0001 Open drawer when no
amount entered
5 FLAG 0x0002 Add to cash declared fixed
totaliser
5 FLAG 0x0004 Enforce multiply key for
multiple quantity
5 FLAG 0x8000 Update keyboard text
Field XML Tag Flag Description
Key type: 215 - Minimise TouchPoint
Key type: 216 - Cash Declaration
Key type: 217 - Cash Declaration 2
Key type: 218 - End Session
5 FLAG 0x8000 Update keyboard text
Field XML Tag Flag Description
5 FLAG 0x0004 Prints to display
5 FLAG 0x0008 Prompt for department
range
5 FLAG 0x0010 Prompt for PLU group range
5 FLAG 0x8000 Update keyboard text
Field XML Tag Flag Description
5 FLAG 0x0004 Prints to display
5 FLAG 0x0008 Prompt for department
range
5 FLAG 0x0010 Prompt for PLU group range
5 FLAG 0x8000 Update keyboard text
Field XML Tag Flag Description
5 FLAG 0x0004 Prints to display
Key type: 220 - Period 1 Report
Key type: 221 - Period 2 Report
Key type: 222 - Period 3 Report
Field XML Tag Flag Description
5 FLAG 0x0008 Prompt for department
range
5 FLAG 0x0010 Prompt for PLU group range
5 FLAG 0x8000 Update keyboard text
Field XML Tag Flag Description
5 FLAG 0x0004 Prints to display
5 FLAG 0x1000 Do not print X/Z counter
summary on report
5 FLAG 0x2000 Do not print X/Z counter
summary on journal
5 FLAG 0x8000 Update keyboard text
Field XML Tag Flag Description
5 FLAG 0x0001 Report for this location only
5 FLAG 0x0002 Report for all locations
5 FLAG 0x0004 Prints to display
5 FLAG 0x0008 Prompt for department
range
5 FLAG 0x0010 Prompt for PLU group range
5 FLAG 0x0020 Report is inline collection
Key type: 224 - Batch Report
Key type: 225 - Inline Period 1 Report
Field XML Tag Flag Description
5 FLAG 0x0040 Report is inline
consolidation
5 FLAG 0x8000 Update keyboard text
Field XML Tag Flag Description
5 FLAG 0x0001 Report for this location only
5 FLAG 0x0002 Report for all locations
5 FLAG 0x0004 Prints to display
5 FLAG 0x0008 Prompt for department
range
5 FLAG 0x0010 Prompt for PLU group range
5 FLAG 0x0020 Report is inline collection
5 FLAG 0x0040 Report is inline
consolidation
5 FLAG 0x8000 Update keyboard text
Field XML Tag Flag Description
5 FLAG 0x0001 Report for this location only
5 FLAG 0x0002 Report for all locations
5 FLAG 0x0004 Prints to display
Key type: 226 - Inline Period 2 Report
Key type: 227 - Inline Period 3 Report
Field XML Tag Flag Description
5 FLAG 0x0008 Prompt for department
range
5 FLAG 0x0010 Prompt for PLU group range
5 FLAG 0x0020 Report is inline collection
5 FLAG 0x0040 Report is inline
consolidation
5 FLAG 0x8000 Update keyboard text
Field XML Tag Flag Description
5 FLAG 0x0001 Report for this location only
5 FLAG 0x0002 Report for all locations
5 FLAG 0x0004 Prints to display
5 FLAG 0x0020 Report is inline collection
5 FLAG 0x0040 Report is inline
consolidation
5 FLAG 0x1000 Do not print X/Z counter
summary on report
5 FLAG 0x2000 Do not print X/Z counter
summary on journal
5 FLAG 0x8000 Update keyboard text
Field XML Tag Flag Description
Key type: 228 - Inline Batch Report
Key type: 230 - Registration Mode
5 FLAG 0x8000 Update keyboard text
Field XML Tag Flag Description
5 FLAG 0x8000 Update keyboard text
Field XML Tag Flag Description
5 FLAG 0x8000 Update keyboard text
Field XML Tag Flag Description
5 FLAG 0x8000 Update keyboard text
Field XML Tag Flag Description
5 FLAG 0x8000 Update keyboard text
Field XML Tag Flag Description
Key type: 231 - X/Z Mode
Key type: 232 - Program Mode
Key type: 233 - Home Mode
Key type: 234 - Close Till Down
Key type: 235 - Refund Mode
5 FLAG 0x8000 Update keyboard text
Field XML Tag Flag Description
5 FLAG 0x8000 Update keyboard text
Field XML Tag Flag Description
5 FLAG 0x8000 Update keyboard text
Field XML Tag Flag Description
5 FLAG 0x0001 Open drawer 1
5 FLAG 0x0002 Open drawer 2
5 FLAG 0x0008 Disable drawer alarm
5 FLAG 0x0010 Turn off display
5 FLAG 0x8000 Update keyboard text
Field XML Tag Flag Description
Key type: 236 - Manager Mode
Key type: 238 - Clean Screen
Key type: 239 - Lock Terminal
4 FLAG 0x0001 Don't print total on reports
Field XML Tag Flag Description
File 54 - Subdepartments
FLAG
6 FLAG1 0x00000004 Include old items from
checks
6 FLAG1 0x00000010 Include 2nd & 3rd @ items
6 FLAG1 0x00000020 Warn user when table
starts
6 FLAG1 0x00000040 Price level 1 items only
Field XML Tag Flag Description
14 TIMEFLAG 0x01 Time range applies to
Sunday
14 TIMEFLAG 0x02 Time range applies to
Monday
14 TIMEFLAG 0x04 Time range applies to
Tuesday
14 TIMEFLAG 0x08 Time range applies to
Wednesday
14 TIMEFLAG 0x10 Time range applies to
Thursday
14 TIMEFLAG 0x20 Time range applies to
Friday
14 TIMEFLAG 0x40 Time range applies to
Saturday
14 TIMEFLAG 0x80 Only available in time
range
Field XML Tag Flag Description
File 59 - Mix & Match 1
FLAG1
TIMEFLAG
4 FLAG 0x01 Image instead of text
Field XML Tag Flag Description
File 75 - Keyboard2
FLAG
2 MC1 0x00000001 Compulsory drawer closed
2 MC1 0x00000002 Consolidate REG display
window
2 MC1 0x00000004 Prohibit multiple refunds
2 MC1 0x00000008 Reset consecutive number
after Z1 fixed totaliser reset
2 MC1 0x00000010 Direct entry for option
windows
2 MC1 0x00000020 Auto receipt for refund
mode
2 MC1 0x00000040 Disable clerk interrupts
2 MC1 0x00000080 Zero subtotal opens drawer
2 MC1 0x00000100 Clerk float in location only
2 MC1 0x00000200 Trainee clerk opens drawer
2 MC1 0x00000400 Use price level 1 when no
price in current level
2 MC1 0x00000800 Show end of sale total
window
2 MC1 0x00001000 Only process mix & match
at subtotal
2 MC1 0x00002000
Print extra ticket with
signature strip in refund
mode
2 MC1 0x00004000 Item corrects go to
registration buffer
2 MC1 0x00008000 From checks only (item
corrects)
Field XML Tag Flag Description
File 101 - System Flags
MC1
3 MC2 0x00000001 Net totalising for
PLUs/groups/departments1
3 MC2 0x00000002 IButtons for clerks
3 MC2 0x00000004 IButtons for customers
3 MC2 0x00000100 Disable key press sound
3 MC2 0x00000200 Sign off at removal of
IButton
3 MC2 0x00000400 Manual tax system
3 MC2 0x00001000 Power off at Windows
shutdown
3 MC2 0x00010000 Ignore track 1 magnetic
card swipes
3 MC2 0x00020000 Ignore track 2 magnetic
card swipes
3 MC2 0x00040000 Enable finger print reader
3 MC2 0x00080000 Round EFT sales
3 MC2 0x00100000 Collect contact details
3 MC2 0x00200000 Enable multi tax rates
Field XML Tag Flag Description
5 JOURNALCTRL 0x0001 No journal 2
MC2
1. Removed in TouchPoint 76.00 onwards
JOURNALCTRL
Field XML Tag Flag Description
5 JOURNALCTRL 0x0200 Do not print time on journal
1
5 JOURNALCTRL 0x0400 Do not print consecutive
number on journal1
5 JOURNALCTRL 0x0400 Do not print time on journal
1
5 JOURNALCTRL 0x0800 Do not print consecutive
number on journal1
5 JOURNALCTRL 0x1000 Create CCTV journal
5 JOURNALCTRL 0x2000 Verbose program mode
changes
Field XML Tag Flag Description
6 ORDERCTRL 0x00000001 Automatically calculate
next order number
6 ORDERCTRL 0x00000002 Order numbers only apply
to KP items
6 ORDERCTRL 0x00000004 Print refund mode sales on
KP
6 ORDERCTRL 0x00000010 Auto receipt for KP items
6 ORDERCTRL 0x00000020 Reset order number after
Z1 fixed totaliser reset
6 ORDERCTRL 0x00000040 Compulsory covers only
applies to KP items
6 ORDERCTRL 0x00000100 Prompt for location
6 ORDERCTRL 0x00200000 Enforce order number
when prompted
6 ORDERCTRL 0x00400000 Compulsory check/table for
KP items
1. Removed in TouchPoint 76.00 onwards
ORDERCTRL
Field XML Tag Flag Description
6 ORDERCTRL 0x01000000 Printer supports 180dpi
vertical print
6 ORDERCTRL 0x02000000 Set menu items do not
follow parent
6 ORDERCTRL 0x04000000 Orders go to KP controller
Field XML Tag Flag Description
7 REPORTCTRL 0x00000001 Do not print X count
7 REPORTCTRL 0x00000002 Do not print Z count
7 REPORTCTRL 0x00000004 Compulsory cash
declaration
7 REPORTCTRL 0x00000008 Do not print reports on
journal
7 REPORTCTRL 0x00000010 Do not print report headers
7 REPORTCTRL 0x00000020 Do not print report reset
lines
7 REPORTCTRL 0x00000040 Sort cash declaration
amounts
7 REPORTCTRL 0x00000080 Consolidate cash
declaration amounts
7 REPORTCTRL 0x00000100 Do not print time on reports
1
7 REPORTCTRL 0x00000200 Do not print consecutive
number on reports1
7 REPORTCTRL 0x00000400 Do not print date on reports
1
7 REPORTCTRL 0x00000800 No Z report when active
clerks
7 REPORTCTRL 0x00001000 No Z report when active
checks
7 REPORTCTRL 0x00002000 Skip "Are you sure?" reset
prompt
REPORTCTRL
Field XML Tag Flag Description
7 REPORTCTRL 0x00004000 Do not print random codes
on PLU reports
7 REPORTCTRL 0x00008000 Store reports
7 REPORTCTRL 0x00010000 Print sales ratio on
department reports
7 REPORTCTRL 0x00020000 Print sales ration on PLU
group reports
7 REPORTCTRL 0x00040000 Do not print last date run
Field XML Tag Flag Description
8 CHECKTRACK 0x00000001 Show check number on
table plan1
8 CHECKTRACK 0x00000002 Show covers on table plan1
8 CHECKTRACK 0x00000004 Compulsory covers only
applies to checks
8 CHECKTRACK 0x00000008 Table numbers are checks
8 CHECKTRACK 0x00000010 Allow Z mode open check
report
8 CHECKTRACK 0x00000020 Tracking type is check
tracking
8 CHECKTRACK 0x00000040 Auto receipt for checks
8 CHECKTRACK 0x00000080 Auto new balance at sign
off
8 CHECKTRACK 0x00000100 Do not print time on checks
2
8 CHECKTRACK 0x00000200 Do not print consecutive
number on checks
1. Removed in TouchPoint 76.00 onwards
CHECKTRACK
Field XML Tag Flag Description
8 CHECKTRACK 0x00000400 Do not print date on checks
2
8 CHECKTRACK 0x00000800 Automatic full bill at
finalisation
8 CHECKTRACK 0x00001000 Prompt for text on new
check
8 CHECKTRACK 0x00002000 Prompt for text on new
table
8 CHECKTRACK 0x00004000 Prompt with text when
present
8 CHECKTRACK 0x00008000 Reset auto check number
on Z1 fixed totaliser reset
8 CHECKTRACK 0x00010000 Service charge on selective
item 1
8 CHECKTRACK 0x00020000 Service charge on selective
item 2
8 CHECKTRACK 0x00040000 Service charge on selective
item 3
8 CHECKTRACK 0x00080000 Service charge on selective
item 4
8 CHECKTRACK 0x00100000 Service charge on selective
item 5
8 CHECKTRACK 0x00200000 Service charge on all items
8 CHECKTRACK 0x00400000 Service charge is amount
8 CHECKTRACK 0x00800000 Service charge adds to net
sales
8 CHECKTRACK 0x01000000 Number of covers is 1
when no covers entered
8 CHECKTRACK 0x02000000 Service charge added by
service charge key only
8 CHECKTRACK 0x04000000 Do not print item count on
checks
8 CHECKTRACK 0x08000000 Do not Z reset open check
in batch reports
8 CHECKTRACK 0x10000000 Print barcode on receipt
8 CHECKTRACK 0x20000000 Show check text on
floorplan
Field XML Tag Flag Description
Field XML Tag Flag Description
8 CHECKTRACK 0x40000000 Print check text in double
size
8 CHECKTRACK 0x80000000 Preview floorplan bill prints
Field XML Tag Flag Description
13 CUSTOMERCTRL 0x00000001 Reserved 1
13 CUSTOMERCTRL 0x00000002 Automatically issue a
receipt for customers
13 CUSTOMERCTRL 0x00000004 Allow open balance Z
report
13 CUSTOMERCTRL 0x00000008 Auto create new customers
13 CUSTOMERCTRL 0x00000010 Auto create prompt for
customer group
13 CUSTOMERCTRL 0x00000020 Auto create prompt for
address
13 CUSTOMERCTRL 0x00000040 Auto create prompt for
phone
13 CUSTOMERCTRL 0x00000080 Reserved 2
13 CUSTOMERCTRL 0x00000100 Warn if account customer
finalised not by account
13 CUSTOMERCTRL 0x00000200 Use alphanumeric account
numbers
13 CUSTOMERCTRL 0x00000400 Show called ID information
on display
13 CUSTOMERCTRL 0x00000800 Enable track 1 custom
cards
1. Removed in TouchPoint 78.01 onwards
2. Removed in TouchPoint 76.00 onwards
CUSTOMERCTRL
Field XML Tag Flag Description
13 CUSTOMERCTRL 0x00001000 Enable track 2 custom
cards
13 CUSTOMERCTRL 0x00002000
Search account number for
unknown track 1 card
swipes
13 CUSTOMERCTRL 0x00004000
Search account number for
unknown track 2 card
swipes
13 CUSTOMERCTRL 0x00008000 Auto create new customer
when not found
13 CUSTOMERCTRL 0x00010000 In drawer for account
payments is negative
13 CUSTOMERCTRL 0x00020000 Prompt to post change
amount to account
13 CUSTOMERCTRL 0x00040000 Auto create prompt for
account number
13 CUSTOMERCTRL 0x00080000 Auto create prompt for
mobile phone
13 CUSTOMERCTRL 0x00100000 Auto create prompt for
work phone
13 CUSTOMERCTRL 0x00200000 Auto create prompt for not
allowed selective item 5
13 CUSTOMERCTRL 0x00400000 Auto create prompt for
email address
13 CUSTOMERCTRL 0x00800000 Auto create prompt for
expiry date
13 CUSTOMERCTRL 0x01000000 Auto create prompt for
notes
13 CUSTOMERCTRL 0x02000000 Don't show available
balance at sign on
Field XML Tag Flag Description
14 PRINTCTRL 0x00000001 Print graphic logo
PRINTCTRL
Field XML Tag Flag Description
14 PRINTCTRL 0x00000002 Print receipt header
14 PRINTCTRL 0x00000004 Print commercial message
14 PRINTCTRL 0x00000008 Print bottom message
14 PRINTCTRL 0x00000010 Reserved 1
14 PRINTCTRL 0x00000020 Print report header
14 PRINTCTRL 0x00000040 Print tax symbol
14 PRINTCTRL 0x00000080 Print VAT number
14 PRINTCTRL 0x00000100 Do not print time on
receipts1
14 PRINTCTRL 0x00000200 Do not print consecutive
number on receipts
14 PRINTCTRL 0x00000400 Do not print date on
receipts1
14 PRINTCTRL 0x00000800 Reserved 2
14 PRINTCTRL 0x00001000 Print order number double
height
14 PRINTCTRL 0x00002000 Print order number double
width
14 PRINTCTRL 0x00004000 Do not print item count on
receipts
14 PRINTCTRL 0x00008000 Centre receipt header
14 PRINTCTRL 0x00010000 Centre commercial
message
14 PRINTCTRL 0x00020000 Centre bottom message
14 PRINTCTRL 0x00040000 Centre signature strip
14 PRINTCTRL 0x00080000 Centre VAT number
14 PRINTCTRL 0x00100000 Centre report header
14 PRINTCTRL 0x00200000 Print signature strip on
intermediate bills
Field XML Tag Flag Description
Field XML Tag Flag Description
14 PRINTCTRL 0x00400000 Print signature strip on
final bills
14 PRINTCTRL 0x00800000 Store receipts
14 PRINTCTRL 0x01000000 Print bottom graphic logo
14 PRINTCTRL 0x02000000 Only managers can
duplicate bills
14 PRINTCTRL 0x04000000 Do not print quantity on
condiment items
14 PRINTCTRL 0x08000000 Do not print reason on
receipt
Field XML Tag Flag Description
22 AUTOBROADCAST 0x00000001 Auto broadcast PLUs
22 AUTOBROADCAST 0x00000002 Auto broadcast PLU groups
22 AUTOBROADCAST 0x00000004 Auto broadcast clerks
22 AUTOBROADCAST 0x00000008 Auto broadcast clerk details
22 AUTOBROADCAST 0x00000010 Auto broadcast list PLUs
22 AUTOBROADCAST 0x00000020 Auto broadcast batch
reports
22 AUTOBROADCAST 0x00000040 Auto broadcast receipt
logos
22 AUTOBROADCAST 0x00000080 Auto broadcast scrolling
messages
1. Removed in TouchPoint 76.00 onwards
AUTOBROADCAST
Field XML Tag Flag Description
22 AUTOBROADCAST 0x00000100 Auto broadcast cheque
printing
22 AUTOBROADCAST 0x00000200 Auto broadcast keyboard
level names
22 AUTOBROADCAST 0x00000400 Auto broadcast fixed
characters
22 AUTOBROADCAST 0x00000800 Auto broadcast error
messages
22 AUTOBROADCAST 0x00001000 Auto broadcast fixed
totalisers
22 AUTOBROADCAST 0x00002000 Auto broadcast finalise
keys
22 AUTOBROADCAST 0x00004000 Auto broadcast transaction
keys
22 AUTOBROADCAST 0x00008000 Auto broadcast status keys
22 AUTOBROADCAST 0x00010000 Auto broadcast
departments
22 AUTOBROADCAST 0x00020000 Auto broadcast price level
scheduler
22 AUTOBROADCAST 0x00040000 Auto broadcast keyboard
22 AUTOBROADCAST 0x00080000 Auto broadcast IP printers
22 AUTOBROADCAST 0x00100000 Auto broadcast system
flags
22 AUTOBROADCAST 0x00200000 Auto broadcast customers
22 AUTOBROADCAST 0x00400000 Auto broadcast customer
groups
22 AUTOBROADCAST 0x00800000 Auto broadcast I/O
parameter
22 AUTOBROADCAST 0x01000000 Auto broadcast device
connection
22 AUTOBROADCAST 0x02000000 Auto broadcast floor plan
tables
22 AUTOBROADCAST 0x04000000 Auto broadcast tax table
22 AUTOBROADCAST 0x08000000 Auto broadcast time zones
Field XML Tag Flag Description
Field XML Tag Flag Description
22 AUTOBROADCAST 0x10000000 Auto broadcast non-PLU
22 AUTOBROADCAST 0x20000000 Auto broadcast mix &
match
22 AUTOBROADCAST 0x40000000 Auto broadcast check texts
22 AUTOBROADCAST 0x80000000 Auto broadcast employees
Field XML Tag Flag Description
27 SCANPLUSTATUS 0x00000001 Auto create not found PLUs
27 SCANPLUSTATUS 0x00000002 Lock register at not found
PLU
27 SCANPLUSTATUS 0x00000004 Do not validate check digit
27 SCANPLUSTATUS 0x00000008 Print random code on
receipt
27 SCANPLUSTATUS 0x00000010 Print random code on
journal
27 SCANPLUSTATUS 0x00000020 Disable open priced PLU
repeat
27 SCANPLUSTATUS 0x00000040 Auto create prompt for tax
rate
27 SCANPLUSTATUS 0x00000080 Non turnover sales affects
stock
27 SCANPLUSTATUS 0x00000100 Non turnover sales affects
last time sold
27 SCANPLUSTATUS 0x00000200 Non turnover sales affects
dispense monitoring
27 SCANPLUSTATUS 0x00000400 Non turnover sales prints
to KP
27 SCANPLUSTATUS 0x00000800 Auto create new ISSN
variants
SCANPLUSTATUS
Field XML Tag Flag Description
27 SCANPLUSTATUS 0x00001000 Enable pseudo @ quantities
27 SCANPLUSTATUS 0x00002000 Reason table on customer
verify
27 SCANPLUSTATUS 0x00004000 Enforced tax rate
27 SCANPLUSTATUS 0x00008000 List PLU uses menu level
Field XML Tag Flag Description
31 EFTCONTROL 0x00000001 Prompt for cash back
31 EFTCONTROL 0x00000002 Cash back adds to drawer
totaliser
31 EFTCONTROL 0x00000004 Prompt for gratuity
31 EFTCONTROL 0x00000008 Gratuity adds to drawer
totaliser
31 EFTCONTROL 0x00000010 Allow customer not present
transactions
31 EFTCONTROL 0x00000020 Not used
31 EFTCONTROL 0x00000040 Use bill lodging
31 EFTCONTROL 0x00000080 Use socket mode
31 EFTCONTROL 0x00000100 Not used
31 EFTCONTROL 0x00000200 Use Thyron in portable
mode
31 EFTCONTROL 0x00000400 Bill lodging sends checks
31 EFTCONTROL 0x00000800 Bill lodging sends table
31 EFTCONTROL 0x00001000 Bill lodging only send
printed
EFTCONTROL
Field XML Tag Flag Description
31 EFTCONTROL 0x00002000 Await EFT receipts from
Ocius
31 EFTCONTROL 0x00004000 Use sale ID in merchant
reference
31 EFTCONTROL 0x00008000 Use EFT dialog for CNP
details
31 EFTCONTROL 0x00010000 Prompt for address
31 EFTCONTROL 0x00020000 Process offline transactions
31 EFTCONTROL 0x00040000 Do not print merchant copy
Field XML Tag Flag Description
35 SLIPPRINTCTRL 0x00000002 Print receipt header
35 SLIPPRINTCTRL 0x00000004 Print commercial message
35 SLIPPRINTCTRL 0x00000008 Print bottom message
35 SLIPPRINTCTRL 0x00000040 Print tax symbol
35 SLIPPRINTCTRL 0x00000080 Print VAT number
35 SLIPPRINTCTRL 0x00200000 Print signature strip on
intermediate bills
35 SLIPPRINTCTRL 0x00400000 Print signature strip on
final bills
Field XML Tag Flag Description
SLIPPRINTCTRL
EUROSTATUS
43 EUROSTATUS 0x00000001 Show Euro (sub) total in
reg window
43 EUROSTATUS 0x00000002 Show Euro (sub) total on
receipt
43 EUROSTATUS 0x00000004 Change in Euro (sub)
43 EUROSTATUS 0x00000008 Euro (sub) uses 2nd drawer
43 EUROSTATUS 0x00000010 Show Euro (sub) total on
customer display
43 EUROSTATUS 0x00000020 Show change in both
currencies
43 EUROSTATUS 0x00000040 Currency 1 uses 2nd
drawer
43 EUROSTATUS 0x00000080 Currency 2 uses 2nd
drawer
43 EUROSTATUS 0x00000100 Currency 3 uses 2nd
drawer
43 EUROSTATUS 0x00000200 Currency 4 uses 2nd
drawer
43 EUROSTATUS 0x00000400 Currency 5 uses 2nd
drawer
43 EUROSTATUS 0x00000800 Currency 6 uses 2nd
drawer
43 EUROSTATUS 0x00001000 Currency 7 uses 2nd
drawer
43 EUROSTATUS 0x00002000 Currency 8 uses 2nd
drawer
43 EUROSTATUS 0x00004000 Currency 9 uses 2nd
drawer
43 EUROSTATUS 0x00008000 Currency 10 uses 2nd
drawer
Field XML Tag Flag Description
46 HOTELCONTROL 0x00000001 Post group totals (rather
than departments)
HOTELCONTROL
Field XML Tag Flag Description
46 HOTELCONTROL 0x00000002 Use alphanumeric room
numbers
46 HOTELCONTROL 0x00000004 Use shift allowances
46 HOTELCONTROL 0x00000008 Enclose fields using "" in
CSV export format
46 HOTELCONTROL 0x00000010 Print individual items
46 HOTELCONTROL 0x00000020 Print department/group
totals
46 HOTELCONTROL 0x00000040 Cut ticket after each
posting
46 HOTELCONTROL 0x00000080 Guestline post Z read totals
Field XML Tag Flag Description
57 SPLITREPORTCONTROL 0x00000001 Enable split reporting
57 SPLITREPORTCONTROL 0x00000002 Report 1 adds to period 1
sales
57 SPLITREPORTCONTROL 0x00000004 Report 1 adds to period 2
sales
57 SPLITREPORTCONTROL 0x00000008 Report 1 adds to period 3
sales
57 SPLITREPORTCONTROL 0x00000010 Report 2 adds to period 1
sales
57 SPLITREPORTCONTROL 0x00000020 Report 2 adds to period 2
sales
57 SPLITREPORTCONTROL 0x00000040 Report 2 adds to period 3
sales
57 SPLITREPORTCONTROL 0x00000080 Stop electronic journal 1
during report 2
57 SPLITREPORTCONTROL 0x00000100 Stop electronic journal 2
during report 2
SPLITREPORTCONTROL
Field XML Tag Flag Description
57 SPLITREPORTCONTROL 0x00000200 Stop journal printer during
report 2
57 SPLITREPORTCONTROL 0x00000400 Stop consecutive number
during report 2
57 SPLITREPORTCONTROL 0x00000800 Report 2 uses order
number 2
Field XML Tag Flag Description
92 FIDELITYCONTROL 0x00000001 Enable fidelity loyalty
92 FIDELITYCONTROL 0x00000002 Accept fidelity ID as nonadd
number
106 TICKETISSUANCE 0x00000001 Show price on ticket
106 TICKETISSUANCE 0x00000002 Print ticket number
106 TICKETISSUANCE 0x00000004 Print receipt header
message
106 TICKETISSUANCE 0x00000008 Print 1 line of header
message
106 TICKETISSUANCE 0x00000010 Print receipt bottom
message
106 TICKETISSUANCE 0x00000020 Print 1 line of bottom
message
106 TICKETISSUANCE 0x00000040 Cut ticket
Split reporting was removed in TouchPoint 72.00 onwards
FIDELITYCONTROL
TICKETISSUANCE
Field XML Tag Flag Description
106 TICKETISSUANCE 0x00000080 Dotted line at end of ticket
106 TICKETISSUANCE 0x00000100 Star TSP700 detects start
of ticket
106 TICKETISSUANCE 0x00000200 Print receipt info line
106 TICKETISSUANCE 0x00000400 Info line prints at bottom of
ticket
106 TICKETISSUANCE 0x00000800 Print graphic logo
106 TICKETISSUANCE 0x00001000 Print in double size
106 TICKETISSUANCE 0x00002000 Ticket number resets at Z1
fixed totaliser reset
106 TICKETISSUANCE 0x00004000 Print order info
106 TICKETISSUANCE 0x00008000 Star TSP700 print density
heavy
106 TICKETISSUANCE 0x00010000 Use 3rd@ quantity for
number of tickets
106 TICKETISSUANCE 0x00020000 Increment ticket number
for per item tickets
106 TICKETISSUANCE 0x00040000 Ticket printer 2 uses ticket
number 1
106 TICKETISSUANCE 0x00080000 Print total number of tickets
106 TICKETISSUANCE 0x00100000 Left justify ticket
106 TICKETISSUANCE 0x00200000 Print customer name
106 TICKETISSUANCE 0x00400000 Print customer address
106 TICKETISSUANCE 0x00800000 Print customer phone
number
Field XML Tag Flag Description
TIMEATTENDANCECTRL
117 TIMEATTENDANCECTRL 0x00000001 Log time changes
117 TIMEATTENDANCECTRL 0x00000002 Ignore iffy hours worked
117 TIMEATTENDANCECTRL 0x00000004 Print stub tickets for time
& attendance operations
Field XML Tag Flag Description
119 IRCCONTROL 0x00000001 Auto IRC at startup
119 IRCCONTROL 0x00000002 When auto IRC init, issue
receipt
Field XML Tag Flag Description
121 THIRDPARTYCUSTCONTROL 0x00000001 Enclose fields using " in
.csv format
121 THIRDPARTYCUSTCONTROL 0x00000002 Use track 1 magnetic card
swipes
121 THIRDPARTYCUSTCONTROL 0x00000004 Use track 2 magnetic card
swipes
121 THIRDPARTYCUSTCONTROL 0x00000008 Auto receipt when
customer is used
121 THIRDPARTYCUSTCONTROL 0x00000020 Use rebound barcode
reader
121 THIRDPARTYCUSTCONTROL 0x00000040 Allow alpha account
numbers
IRCCONTROL
THIRDPARTYCUSTCONTROL
DISPENSEMONITORING
128 DISPENSEMONITORING 0x00000001 Enable dispense monitoring
Field XML Tag Flag Description
130 TABLERESERVATIONS 0x00000001 Tables reserved by time
zone
130 TABLERESERVATIONS 0x00000002 Reserved 1
130 TABLERESERVATIONS 0x00000004 Reserved 2
130 TABLERESERVATIONS 0x00000008 Post deposits from
reservation into table
130 TABLERESERVATIONS 0x00000010 Warn user when opening a
table
130 TABLERESERVATIONS 0x00000020 Reserve cashiers not tables
Field XML Tag Flag Description
155 AUTOBROADCAST2 0x00000001 Auto broadcast external
product groups
155 AUTOBROADCAST2 0x00000002 Auto broadcast set menu
155 AUTOBROADCAST2 0x00000004 Auto broadcast KP
categories
155 AUTOBROADCAST2 0x00000008 Auto broadcast reasons
155 AUTOBROADCAST2 0x00000010 Auto broadcast preset
messages
155 AUTOBROADCAST2 0x00000020 Auto broadcast SEL
155 AUTOBROADCAST2 0x00000040 Auto broadcast sub
departments
TABLERESERVATIONS
AUTOBROADCAST2
Field XML Tag Flag Description
158 COINDISPENSECONTROL 0x01 Also display total change in
input window
Field XML Tag Flag Description
163 TABLEANALYSISFLAG 0x0001 Track checks
163 TABLEANALYSISFLAG 0x0002 Track tables
163 TABLEANALYSISFLAG 0x0004 Track departments
163 TABLEANALYSISFLAG 0x0008 Track groups
163 TABLEANALYSISFLAG 0x0010 Store finalised bills
Field XML Tag Flag Description
163 CHECKTRACK2 0x00000001 Service charge applies to
all sales
163 CHECKTRACK2 0x00000002 Calculate service charge
on subtotal
163 CHECKTRACK2 0x00000004 Show date/time line in reg
window
163 CHECKTRACK2 0x00000008 Print transfers to KP
COINDISPENSECONTROL
TABLEANALYSISFLAG
CHECKTRACK2
163 CHECKTRACK2 0x00000010 Set location to floor plan
level on new table
163 CHECKTRACK2 0x00000020 Use alpha check numbers
3 FLAG 0x00000001 Embedded value is weight
Field XML Tag Flag Description
File 149 - Non-PLU Table
FLAG
12 FLAG1 0x00000004 Include old items from
checks
12 FLAG1 0x00000010 Include 2nd & 3rd @ items
12 FLAG1 0x00000020 Warn user when table
starts
12 FLAG1 0x00000040 Price level 1 items only
12 FLAG1 0x00000080 Link items from next table
Field XML Tag Flag Description
20 TIMEFLAG 0x01 Time range applies to
Sunday
20 TIMEFLAG 0x02 Time range applies to
Monday
20 TIMEFLAG 0x04 Time range applies to
Tuesday
20 TIMEFLAG 0x08 Time range applies to
Wednesday
20 TIMEFLAG 0x10 Time range applies to
Thursday
20 TIMEFLAG 0x20 Time range applies to
Friday
20 TIMEFLAG 0x40 Time range applies to
Saturday
20 TIMEFLAG 0x80 Only available in time
range
Field XML Tag Flag Description
File 159 - Mix & Match 2
FLAG1
TIMEFLAG

18 FLAG 0x00000001 Blacklisted
18 FLAG 0x00000002 New customer
18 FLAG 0x00000004 Not allowed selective
itemiser 5 items
Field XML Tag Flag Description
File 260 - Customer
FLAG
When the customer group loyalty type is set to "School Meals", RATE5 houses flags relating to
time zone settings.
7 RATE5 0x0001 Sunday time zone 1
7 RATE5 0x0002 Monday time zone 1
7 RATE5 0x0004 Tuesday time zone 1
7 RATE5 0x0008 Wednesday time zone 1
7 RATE5 0x0010 Thursday time zone 1
7 RATE5 0x0020 Friday time zone 1
7 RATE5 0x0040 Saturday time zone 1
7 RATE5 0x0100 Sunday time zone 2
7 RATE5 0x0200 Monday time zone 2
7 RATE5 0x0400 Tuesday time zone 2
7 RATE5 0x0800 Wednesday time zone 2
7 RATE5 0x1000 Thursday time zone 2
7 RATE5 0x2000 Friday time zone 2
7 RATE5 0x4000 Saturday time zone 2
Field XML Tag Flag Description
File 270 - Customer Group
RATE5
MULTIUSE5
When the customer group loyalty type is set to "School Meals", MULTIUSE5 houses flags relating to
spending.
13 MULTIUSE5 0x0001 Use a morning spend limit
13 MULTIUSE5 0x0002 Use a daily spend limit
13 MULTIUSE5 0x0004 No morning free meal
entitlement
13 MULTIUSE5 0x0008 Tax exempt
13 MULTIUSE5 0x0010 Use a weekly spend limit
Field XML Tag Flag Description
17 FLAG 0x00000001 Print last transaction date
on receipt
17 FLAG 0x00000002 Print spend today on
receipt
17 FLAG 0x00000004 Print times used today on
receipt
17 FLAG 0x00000008 Print spend to date on
receipt
17 FLAG 0x00000010 Print spend to discount on
receipt
17 FLAG 0x00000020 Print discount total on
receipt
17 FLAG 0x00000040 Only print automatic
receipt if discount due
17 FLAG 0x00000080 Print address on receipt
17 FLAG 0x00000100 Print phone number on
receipt
17 FLAG 0x00000200 Account customer
17 FLAG 0x00000400 Print name on KP
17 FLAG 0x00000800 Print address on KP
FLAG
Field XML Tag Flag Description
17 FLAG 0x00001000 Print account number on
receipt
17 FLAG 0x00002000 School can only sign on
during time zone
17 FLAG 0x00004000 Prompt with picture
17 FLAG 0x00008000 Print phone number on KP
17 FLAG 0x00010000 Points apply to subtotal
only
17 FLAG 0x00020000 Award points on whole
pounds only
17 FLAG 0x00040000 Shift to price level 2
17 FLAG 0x00080000 Also print customer details
on KV
17 FLAG 0x00100000 Print notes on KP
Field XML Tag Flag Description
5 FLAG 0x00000001 Clerks float
5 FLAG 0x00000002 Use centralised check
system
5 FLAG 0x00000004 This machine check
backup master
5 FLAG 0x00000010 I am check backup master
5 FLAG 0x00000020 Use centralised customer
totals
5 FLAG 0x00000040 This machine customer
master
5 FLAG 0x00000100 Use centralised time &
attendance master
5 FLAG 0x00000200 This machine time &
attendance master
5 FLAG 0x00000800 Use TCP/IP
5 FLAG 0x00001000 Enable UPNP
5 FLAG 0x00002000 Enable Dynamic DNS
updater
5 FLAG 0x00004000 Enable VNC server
5 FLAG 0x00008000 Enable EHP server
Field XML Tag Flag Description
7 UPNP_FLAG 0x0001 Enabled
File 302 - System
Configuration
FLAG
UPNP_FLAG
Field XML Tag Flag Description
7 UPNP_FLAG 0x0002 Use seed mappings
Field XML Tag Flag Description
77 CONNECT_FLAG 0x00000001 Table reservations
77 CONNECT_FLAG 0x00000002 Webshop
77 CONNECT_FLAG 0x00000004 IDC uploader
77 CONNECT_FLAG 0x00000008 Postcode address lookup
77 CONNECT_FLAG 0x00000010 Text predictions
77 CONNECT_FLAG 0x00000020 TouchTopUp web
77 CONNECT_FLAG 0x00000080 Uploaded non-turnover
sales
77 CONNECT_FLAG 0x00000100 Automatic backup
77 CONNECT_FLAG 0x00000200 Paytable
77 CONNECT_FLAG 0x00000400 Barcode predictions
77 CONNECT_FLAG 0x00000800 Enable stock download
77 CONNECT_FLAG 0x00001000 Online vouchers
77 CONNECT_FLAG 0x00002000 Use SSL
77 CONNECT_FLAG 0x00004000 TouchTopUu is customer
totals master
77 CONNECT_FLAG 0x00008000 Upload program data
changes
Field XML Tag Flag Description
CONNECT_FLAG

146 SOUNDCONTROL 0x00000001 Play sounds for speakers
(rather than buzzer)
146 SOUNDCONTROL 0x00000002 Disable Ctrl + M macro
start
146 SOUNDCONTROL 0x00000004 Search for Dallas iButton
readers
146 SOUNDCONTROL 0x00000008 CCTV Journal output CR
146 SOUNDCONTROL 0x00000010 CCTV Journal output LF
146 SOUNDCONTROL 0x00000020 CCTV Journal persistent
connection
146 SOUNDCONTROL 0x00000040 CCTV Journal output
formatting characters
Field XML Tag Flag Description
147 GRAPHICSCONTROL 0x00000001 Reserved
147 GRAPHICSCONTROL 0x00000002 System contains a mix of
screen sizes
Field XML Tag Flag Description
150 KPCONFIURATION 0x00000001 Print price
150 KPCONFIURATION 0x00000002 Translate KP order
File 304 - Device connection
SOUNDCONTROL
GRAPHICSCONTROL
KPCONFIGURATION
Field XML Tag Flag Description
150 KPCONFIURATION 0x00000004 Do not print English
150 KPCONFIURATION 0x00000008 Insert a line in between KP
items
150 KPCONFIURATION 0x00000010 Print KP in double height
150 KPCONFIURATION 0x00000020 Print KP in double width
150 KPCONFIURATION 0x00000040 Print order number in
double height
150 KPCONFIURATION 0x00000080 Print check/table number
in double height
150 KPCONFIURATION 0x00000100 Condense double size
items when overrun
150 KPCONFIURATION 0x00000200 Compress KP ticket
150 KPCONFIURATION 0x00000400 Auto cut KP ticket
150 KPCONFIURATION 0x00000800 Print dotted line at end of
order
150 KPCONFIURATION 0x00001000 Issue FF at end of order
150 KPCONFIURATION 0x00002000 Sound buzzer at order
150 KPCONFIURATION 0x00004000 Condiments always print
small
150 KPCONFIURATION 0x00008000 Print large time
150 KPCONFIURATION 0x00010000 Consolidate
150 KPCONFIURATION 0x00020000 Consolidate items with
differing condiments
150 KPCONFIURATION 0x00040000 Consolidate set menus
with differing items
150 KPCONFIURATION 0x00100000 Locale use only
150 KPCONFIURATION 0x00200000 Remote use only
150 KPCONFIURATION 0x00400000 CollectionPoint status
150 KPCONFIURATION 0x00800000 Do not send to KP controller
Field XML Tag Flag Description
Field XML Tag Flag Description
150 KPCONFIURATION 0x01000000 Do not print quantity on
condiment items
150 KPCONFIURATION 0x02000000 Print sale total
150 KPCONFIURATION 0x04000000 Is schedulable
Field XML Tag Flag Description
7 FLAG 0x00000001 Condiment item
7 FLAG 0x00000002 Euro item
7 FLAG 0x00000004 Straight number (i.e. check
number)
7 FLAG 0x00000008 No price
7 FLAG 0x00000010 No quantity
7 FLAG 0x00000020 Set menu item
Field XML Tag Flag Description
File 900 - Journal
FLAG

Squirrel Standard Library
Introduction
Input/Output Library
Blob Library
Math Library
System Library
String Library
Squirrel Reference Manual
Introduction
Lexical Structure
Values and Data types
Execution Context
Statements
Expressions
Tables
Etal Developer's
Manual
Arrays
Functions
Classes
Generators
Constants & Enumerations
Threads
Weak References
Delegation
Metamethods
Built-in Functions
ICRTouch Standard Library
Dialog functions
Utility functions
Date functions
Sales mode functions
Data functions
Printing functions
Kitchen printer controller functions
Graphic drawing functions
Device functions
User data functions
Program menu functions
System functions
Display functions
Drawing functions
Email functions
FTP functions
SMS functions
Web functions
Encryption functions
Voucher functions
EHP server functions
System events
Sales mode events
Printing events
XML socket events
Program mode events
Kitchen printer controller events
Display events
Communications events
Table value names
Constant values
Keytype list
Appendix
Squirrel Standard Library
Squirrel Standard Library
Alberto Demichelis
Copyright © 2003-2014 Alberto Demichelis
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and
associated documentation files (the “Software”), to deal in the Software without restriction,
including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense,
and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do
so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial
portions of the Software.
THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH
THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
The squirrel standard libraries consist in a set of modules implemented in C++. While are not
essential for the language, they provide a set of useful services that are commonly used by a wide
range of applications(file I/O, regular expressions, etc…), plus they offer a foundation for
developing additional libraries.
All libraries are implemented through the squirrel API and the ANSI C runtime library. The modules
are organized in the following way:
I/O : input and output
blob : binary buffers manipilation
math : basic mathematical routines
system : system access function
string : string formatting and manipulation
Introduction
Introduction
The libraries can be registered independently,except for the IO library that depends from the
bloblib.
Squirrel Standard Library
The input/output library implements basic input/output routines.
dofile(path, [raiseerror]);
Compiles a squirrel script or loads a precompiled one and executes it. Returns the value returned
by the script or null if no value is returned. If the optional parameter raiseerror is true, the
compiler error handler is invoked in case of a syntax error. If raiseerror is omitted or set to false,
the compiler error handler is not invoked. When squirrel is compiled in unicode mode the function
can handle different character encodings, UTF8 with and without prefix and UCS-2 prefixed(both
big endian and little endian). If the source stream is not prefixed UTF8 encoding is used as default.
loadfile(path, [raiseerror]);
Compiles a squirrel script or loads a precompiled one an returns it as as function. If the optional
parameter raiseerror is true, the compiler error handler is invoked in case of a syntax error. If
raiseerror is omitted or set to false, the compiler error handler is not invoked. When squirrel is
compiled in unicode mode the function can handle different character encodings, UTF8 with and
without prefix and UCS-2 prefixed(both big endian and little endian). If the source stream is not
prefixed UTF8 encoding is used as default.
writeclosuretofile(destpath, closure);
Serializes a closure to a bytecode file ( destpath ). The serialized file can be loaded using
loadfile() and dofile() .
File object bound on the os standard error stream.
Input/Output Library
Global Symbols
dofile()
loadfile()
writeclosuretofile()
stderr
stdin
File object bound on the os standard input stream.
File object bound on the os standard output stream.
The file object implements a stream on an operating system file. Its constructor imitates the
behaviour of the C runtime function fopen for eg.
local myfile = file("test.xxx","wb+");
Creates a file with read/write access in the current directory.
close();
Closes the file.
eos();
Returns a non-null value if the read/write pointer is at the end of the stream.
flush();
Flushes the stream. Returns a value != null if succeeded, otherwise returns null.
len();
Returns the length of the stream.
readblob(size);
Read 'n' bytes from the stream and returns them as blob.
readn(type);
stdout
File Class
close()
eos()
flush()
len()
readblob()
readn()
Reads a number from the stream according to the type parameter. type can have the following
values:
'i' 32bit number
's' 16bit signed integer
'w' 16bit unsigned integer
'c' 8bit signed integer
'b' 8bit unsigned integer
'f' 32bit float
'd' 64bit float
seek(seek, [origin]);
Moves the read/write pointer to a specified location. offset indicates the number of bytes from
origin . origin can be 'b' beginning of the stream, 'c' current location or 'e' end of the
stream. If origin is omitted the parameter is defaulted as 'b' (beginning of the stream).
tell();
Returns the read/write pointer absolute position.
writeblob(blob);
Writes a blob in the stream.
writen(n, type);
Writes a number in the stream formatted according to the type parameter. type can have the
following values:
'l'
processor dependant
32bit on 32bit processors
64bit on 64bit processors
seek()
tell()
writeblob()
writen()
'i' 32bit number
's' 16bit signed integer
'w' 16bit unsigned integer
'c' 8bit signed integer
'b' 8bit unsigned integer
'f' 32bit float
'd' 64bit float
Squirrel Standard Library
The blob library implements binary data manipulations routines.
The library is based on blob objects that represent a buffer of arbitrary binary data.
blob(size);
Returns a new instance of a blob class of the specified size in bytes.
castf2i(float);
Casts a float to an integer.
casti2f(integer);
Casts an integer to a float.
swap2(integer);
Swap the byte order of a number (like it would a 16bit integer).
swap4(integer);
Swap the byte order of an integer.
swapfloat(float);
Swap the byte order of a float.
Blob Library
Global Symbols
blob()
castf2i()
casti2f()
swap2()
swap4()
swapfloat()
The blob object is a buffer of arbitrary binary data. The object behaves like a file stream, it has a
read/write pointer and it automatically grows if data is written out of its boundary.
A blob can also be accessed byte by byte through the [] operator.
eos();
Returns a non-null value if the read/write pointer is at the end of the stream.
flush();
Flushes the stream. Returns a value != null if succeeded, otherwise returns null.
len();
Returns the length of the stream.
readblob(size);
Read n bytes from the stream and returns them as a blob.
readn(type);
Reads a number from the stream according to the type parameter. type can have the following
values:
'i' 32bit number
's' 16bit signed integer
'w' 16bit unsigned integer
'c' 8bit signed integer
'b' 8bit unsigned integer
'f' 32bit float
'd' 64bit float
Blob Class
eos()
flush()
len()
readblob()
readn()
resize(size);
Resizes the blob to the specified size .
seek(seek, [origin]);
Moves the read/write pointer to a specified location. offset indicates the number of bytes from
origin . origin can be 'b' beginning of the stream, 'c' current location or 'e' end of the
stream. If origin is omitted the parameter is defaulted as 'b' (beginning of the stream).
swap2();
Swap the byte order of the blob content as it would be an array of 16bit integers.
swap4();
Swap the byte order of the blob content as it would be an array of 32bit integers.
tell();
Returns the read/write pointer absolute position.
writeblob(blob);
Writes a blob in the stream.
writen(n, type);
Writes a number in the stream formatted according to the type parameter. type can have the
following values:
'l'
processor dependant
32bit on 32bit processors
64bit on 64bit processors
resize()
seek()
swap2()
swap4()
tell()
writeblob()
writen()
'i' 32bit number
's' 16bit signed integer
'w' 16bit unsigned integer
'c' 8bit signed integer
'b' 8bit unsigned integer
'f' 32bit float
'd' 64bit float
Squirrel Standard Library
The math library provides basic mathematics routines. The library mimics the C runtime library
implementation.
abs(x);
Returns the absolute value of x as an integer.
acos(x);
Returns the arccosine of x .
asin(x);
Returns the arcsine of x .
atan(x);
Returns the arctangent of x .
atan2(x, y);
Returns the arctangent of x / y .
ceil(x);
Returns a float value representing the smallest integer that is greater than or equal to x .
Math Library
Global Symbols
abs()
acos()
asin()
atan()
atan2()
ceil()
cos(x);
Returns the cosine of x .
exp(x);
Returns the exponential value of float parameter x .
fabs(x);
Returns the absolute value of x as a float.
floor(x);
Returns a float value representing the largest integer that is less and or equal to x .
log(x);
Returns the natural logarithm of x .
log10(x);
Returns the logarithm base-10 of x .
pow(x, y);
Returns x raised to the power of y .
rand();
Returns a pseudorandom integer in the range of 0 to RAND_MAX .
cos()
exp()
fabs()
floor()
log()
log10()
pow()
rand()
sin()
sin(x);
Returns the sine of x .
sqrt(x);
Returns the square root of x .
srand(seed);
Sets the starting point for generating pseudorandom integers.
tan(x);
Returns the tangent of x .
PI
The numeric constant pi (3.141592) is the ratio of the circumference of a circle to its diameter.
RAND_MAX
The maximum value that can be returned by the rand() function.
In Etal, the returned value is 32767.
sqrt()
srand()
tan()
PI
RAND_MAX
Squirrel Standard Library
The system library exposes operating system facilities like environment variables, datetime
manipulation etc.
clock();
Returns a float representing the number of seconds elapsed since the start of the process.
date();
Returns a table containing the current date/time split into the following slots:
sec Seconds after minute (0 -59)
min Minutes after hour (0 - 59)
hour Hours since midnight (0 - 23)
day Day of the month (1 - 31)
month Month (1 - 12; January = 1)
year Year (current year)
wday Day of week (0 - 6; Sunday = 0)
yday Day of year (0 - 365; January 1 = 0)
getenv(varname);
Returns a string containing the value of the environment variable varname .
remove(path);
System Library
Global Symbols
clock()
date()
getenv()
remove()
Deletes the file specified by path .
rename(oldname, newname);
Renames the file or directory specified by oldname to the name given by newname .
system(cmd);
Executes the string cmd through the os command interpreter.
time();
Returns the number of seconds elapsed since midnight 00:00:00, January 1st, 1970.
rename()
system()
time()
Squirrel Standard Library
The string library implements string formatting and regular expression matching routines.
format(formatstr, ...);
Returns a string formatted according formatstr and the optional parameters following it.
The format string follows the same rules as the printf family of C functions (the “*” is not
supported).
For example:
lstrip(str);
Strips white-space-only characters that might appear at the beginning of the given string and
returns the new stripped string.
regexp(pattern);
Compiles a regular expression pattern and returns it as a new regexp class instance.
\ Quote the next metacharacter
^ Match the beginning of the string
. Match any character
$ Match the end of a string
| Alternation
(subexp) Grouping (creates a capture)
String Library
Global Symbols
format()
print(format("%s %d 0x%02X\n","this is a test :",123,10));
this is a test : 123 0x0A
lstrip()
regexp()
(?:subexp) No capture grouping (no capture)
[] Character class
* Match 0 or more times
+ Match 1 or more times
? Match 1 or 0 times
{n} Match exactly n times
{n,} Match at least n times
{n,m} Match at least n but not more than m times
\t Tab (HT, TAB)
\n New line (LF, NL)
\r Return (CR)
\f Form Feed (FF)
Predefined Classes
\l Lowercase next character
\u Uppercase next character
\a Letters
\A Non letters
\w Alphanumeric [_0-9a-zA-Z]
\W Non alphanumeric [^_0-9a-zA-Z]
\s Space
\S Non space
\d Digits
\D Non nondigits
\x Exadecimal digits
\X Non exadecimal digits
\c Control characters
\C Non control characters
\p Punctuation
Greedy Closures
Escape Characters
\P Non punctuation
\b Word boundary
\B Non word boundary
i Case insensitive
g Global
m Multiline
s Single line (dotall)
u Unicode
y Sticky
Regex flags may not be supported.
rstrip()
rstrip(str);
Strips white-space-only characters that might appear at the end of the given string and returns the
new stripped string.
split(str, separators);
Returns an array of string split at each point where a separator character occurs in the str . The
separator is not returned as part of any array element.
The parameter separators is a string that specifies the characters as to be used for the splitting.
For example:
strip(str);
Strips white-space-only characters that might appear at the beginning or end of the given string
and returns the new stripped string.
Regexp Flags
split()
local a = split("1.2-3;4/5",".-/;");
// the result will be ["1","2","3","4","5"]
strip()
The regexp object represents a precompiled regular expression pattern. The object is created
through the function regexp() .
capture(str, [start]);
Returns an array of tables containing two indexes (“begin” and “end”) of the first match of the
regular expression in the string str .
An array entry is created for each captured sub expressions.
If no match occurs, the returned value is null. The search starts from the index start of the string,
if start is omitted the search starts from the beginning of the string.
The first element of the returned array (index 0) always contains the complete match.
match(str);
Returns true if the regular expression matches the string str , otherwise returns false.
search(str, [start]);
Returns a table containing two indexes (“begin” and “end”) of the first match of the regular
expression in the string str , otherwise if no match occurs returns null.
Regexp Class
capture()
Elocal ex = regexp(@"(\d+) ([a-zA-Z]+)(\p)");
local string = "stuff 123 Test;";
local res = ex.capture(string);
foreach(i,val in res)
{
print(format("match number[%02d] %s\n", i, string.slice(val.begin,val.end))); //prints "Test"
}
...will print
match number[00] 123 Test;
match number[01] 123;
match number[02] Test;
match number[03];
match()
search()
The search starts from the index start of the string, if start is omitted the search starts from
the beginning of the string.
local ex = regexp("[a-zA-Z]+");
local string = "123 Test;";
local res = ex.search(string);
print(string.slice(res.begin, res.end)); //prints "Test"
Squirrel Reference Manual
Squirrel Reference Manual
version 3.0.6 release stable
Alberto Demichelis
Extensive review: Wouter Van Oortmersern
Copyright © 2003-2014 Alberto Demichelis
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and
associated documentation files (the “Software”), to deal in the Software without restriction,
including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense,
and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do
so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial
portions of the Software.
THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH
THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
Squirrel is a high level imperative-OO programming language, designed to be a powerful scripting
tool that fits in the size, memory bandwidth, and real-time requirements of applications like
games. Although Squirrel offers a wide range of features like dynamic typing, delegation, higher
order functions, generators, tail recursion, exception handling, automatic memory management,
both compiler and virtual machine fit together in about 6k lines of C++ code.
Introduction
Introduction
Squirrel Reference Manual
This part of the document describes the syntax and semantics of the language.
Identifiers start with an alphabetic character or '' followed by any number of alphabetic characters,
'' or digits ([0-9]). Squirrel is a case sensitive language, this means that the lowercase and
uppercase representation of the same alphabetic character are considered different characters.
For instance “foo”, “Foo” and “fOo” will be treated as 3 distinct identifiers.
The following words are reserved words by the language and cannot be used as identifiers:
base break case catch class clone
continue const default delete else enum
extends for foreach function if in
local null resume return switch this
throw try typeof while yield constructor
instanceof true false static
Keywords are covered in detail later in this document.
Squirrel recognizes the following operators:
! != || == && <= >= >
<=> + += - -= / /= *
*= % %= ++ -- <- = &
Lexical Structure
Identifiers
id:= [a-zA-Z_]+[a-zA-Z_0-9]*
Keywords
Operators
^ | ~ >> << >>>
Other tokens used are:
{ } [ ] . : :: ' ; " @"
Squirrel accepts integer numbers, floating point numbers and strings literals.
A comment is text that the compiler ignores but that is useful for programmers.
Comments are normally used to embed annotations in the code. The compiler treats them as
white space.
The /* (slash, asterisk) characters, followed by any sequence of characters (including new lines),
followed by the */ characters. This syntax is the same as ANSI C.
The // (two slashes) characters, followed by any sequence of characters. A new line not
immediately preceded by a backslash terminates this form of comment. It is commonly called a
“single-line comment.”
This to facilitate the use of squirrel in UNIX-style shell scripts.
Other Tokens
Literals
IntegerLiteral := [1-9][0-9]* | '0x' [0-9A-Fa-f]+ | ''' [.]+ ''' | 0[0-7]+
FloatLiteral := [0-9]+ '.' [0-9]+
FloatLiteral := [0-9]+ '.' 'e'|'E' '+'|'-' [0-9]+
StringLiteral:= '"'[.]* '"'
VerbatimStringLiteral:= '@''"'[.]* '"'
Comments
/*
this is
a multiline comment.
this lines will be ignored by the compiler
*/
//this is a single line comment. this line will be ignored by the compiler.
#this is also a single line comment.

Squirrel Reference Manual
Squirrel is a dynamically typed language so variables do not have a type, although they refer to a
value that does have a type. Squirrel basic types are integer, float, string, null, table, array,
function, generator, class, instance, bool, thread and userdata.
An Integer represents a 32 bits (or better) signed number.
A float represents a 32 bits (or better) floating point number.
Strings are an immutable sequence of characters to modify a string is necessary create a new one.
Squirrel's strings, behave like C or C++, are delimited by quotation marks( " ) and can contain
escape sequences( \t,\a,\b,\n,\r,\v,\f,\\,\",\',\0,\xhhhh ).
Verbatim string literals begin with @" and end with the matching quote. Verbatim string literals
also can extend over a line break. If they do, they include any white space characters between the
quotes:
Values and Data types
Integer
local a = 123; //decimal
local b = 0x0012; //hexadecimal
local c = 075; //octal
local d = 'w'; //char code
Float
local a = 1.0;
local b = 0.234;
String
local a = "I'm a wonderful string\n";
// has a newline at the end of the string
local x = @"I'm a verbatim string\n"
// the \n is copied in the string same as \\n in a regular string "I'm a verbatim
The only exception to the “no escape sequence” rule for verbatim string literals is that you can put
a double quotation mark inside a verbatim string by doubling it:
The null value is a primitive value that represents the null, empty, or non-existent reference. The
type Null has exactly one value, called null.
The bool data type can have only two. They are the literals true and false. A bool value expresses
the validity of a condition (tells whether the condition is true or false).
Tables are associative containers implemented as pairs of key/value (called a slot).
Arrays are simple sequence of objects, their size is dynamic and their index starts always from 0.
local multiline = @"
this is a multiline string
it will ""embed"" all the new line
characters
";
Null
local a = null;
Bool
local a = true;
Table
local t={};
local test = {
a = 10,
b = function(a) {
return a + 1;
}
};
Array
local a = ["I'm", "an", "array"];
local b = [null];
b[0] = a[2];
Functions are similar to those in other C-like languages and to most programming languages in
general, however there are a few key differences (see below).
Classes are associative containers implemented as pairs of key/value. Classes are created through
a 'class expression' or a 'class statement'. class members can be inherited from another class
object at creation time. After creation members can be added until a instance of the class is
created.
Class instances are created by calling a class object. Instances, as tables, are implemented as pair
of key/value. Instances members cannot be dyncamically added or removed however the value of
the members can be changed.
Generators are functions that can be suspended with the statement 'yield' and resumed later (see
Generators).
Userdata objects are blobs of memory(or pointers) defined by the host application but stored into
Squirrel variables (See Userdata and UserPointers).
Threads are objects that represents a cooperative thread of execution, also known as coroutines.
Weak References are objects that point to another(non scalar) object but do not own a strong
reference to it. (See Weak References).
Function
Class
Class instance
Generator
Userdata
Thread
Weak References
Squirrel Reference Manual
The execution context is the union of the function stack frame and the function environment
object( this ). The stack frame is the portion of stack where the local variables declared in its body
are stored. The environment object is an implicit parameter that is automatically passed by the
function caller (see Functions). During the execution, the body of a function can only transparently
refer to his execution context. This mean that a single identifier can refer either to a local variable
or to an environment object slot; Global variables require a special syntax (see Variables). The
environment object can be explicitly accessed by the keyword this.
There are two types of variables in Squirrel, local variables and tables/arrays slots. Because global
variables are stored in a table, they are table slots.
A single identifier refers to a local variable or a slot in the environment object.
with tables we can also use the . syntax
Squirrel first checks if an identifier is a local variable (function arguments are local variables) if not
it checks if it is a member of the environment object ( this ).
For instance:
Execution Context
Variables
derefexp := id;
_table["foo"];
_array[10];
derefexp := exp '.' id;
_table.foo;
function testy(arg)
{
local a = 10;
print(a);
return arg;
}
will access to local variable a and prints 10.
in this case foo will be equivalent to this.foo or this["foo"] .
Global variables are stored in a table called the root table. Usually in the global scope the
environment object is the root table, but to explicitly access the global table from another scope,
the slot name must be prefixed with :: ( ::foo ).
For instance:
accesses the global variable foo .
However (since squirrel 2.0) if a variable is not local and is not found in the this object Squirrel
will search it in the root table.
is equivalent to write:
function testy(arg)
{
local a = 10;
return arg + foo;
}
exp:= '::' id;
function testy(arg)
{
local a = 10;
return arg + ::foo;
}
function test()
{
foo = 10;
}
function test()
{
if("foo" in this)
{
this.foo = 10;
}
else
{
::foo = 10;
}
}
Squirrel Reference Manual
A squirrel program is a simple sequence of statements.
Statements in squirrel are comparable to the C-Family languages (C/C++, Java, C# etc…):
assignment, function calls, program flow control structures etc.. plus some custom statement like
yield, table and array constructors (All those will be covered in detail later in this document).
Statements can be separated with a new line or ; (or with the keywords case or default if inside a
switch/case statement), both symbols are not required if the statement is followed by } .
A sequence of statements delimited by curly brackets ({ }) is called block; a block is a statement
itself.
squirrel implements the most common control flow statements: if, while, do-while, switch-case, for,
foreach.
Squirrel has a boolean type(bool) however like C++ it considers null , 0 (integer) and 0.0 (float)
as false, any other value is considered true .
Conditionally execute a statement depending on the result of an expression.
Statements
stats := stat [';'|'\n'] stats
Block
stat := '{' stats '}'
Control Flow Statements
true and false
if/else
stat:= 'if' '(' exp ')' stat ['else' stat]
if(a > b)
{
a = b;
}
Executes a statement while the condition is true.
else
{
b = a;
}
if(a == 10)
{
b = a + b;
return a;
}
while
stat:= 'while' '(' exp ')' stat
function testy(n)
{
local a = 0;
while(a < n)
{
a+=1;
}
while(1)
{
if(a < 0)
{
break;
}
a -= 1;
}
}
do/while
stat:= 'do' stat 'while' '(' expression ')'
Executes a statement once, and then repeats execution of the statement until a condition
expression evaluates to false.
Is a control statement allows multiple selections of code by passing control to one of the case
statements within its body. The control is transferred to the case label whose case_exp matches
with exp if none of the case match will jump to the default label (if present). A switch statement
can contain any number if case instances, if 2 case have the same expression result the first one
will be taken in account first. The default label is only allowed once and must be the last one. A
break statement will jump outside the switch block.
Executes a statement as long as a condition is different than false.
local a = 0;
do
{
print(a + "\n");
a+=1;
} while(a > 100)
switch
stat := 'switch' ''( exp ')' '{'
'case' case_exp ':'
stats
['default' ':'
stats]
'}'
Loops
for
stat:= 'for' '(' [initexp] ';' [condexp] ';' [incexp] ')' statement
for(local a = 0; a < 10; a += 1)
{
print(a + "\n");
}
//or
Executes a statement for every element contained in an array, table, class, string or generator. If
exp is a generator it will be resumed every iteration as long as it is alive; the value will be the
result of 'resume' and the index the sequence number of the iteration starting from 0.
The break statement terminates the execution of a loop (for, foreach, while or do/ while) or jumps
out of switch statement.
glob <- null;
for(glob = 0; glob < 10; glob += 1)
{
print(glob + "\n");
}
//or
for(;;)
{
print(loops forever + "\n");
}
foreach
'foreach' '(' [index_id','] value_id 'in' exp ')' stat
local a = [10, 23, 33, 41, 589, 56];
foreach(idx,val in a)
{
print("index=" + idx + " value=" + val + "\n");
}
//or
foreach(val in a)
{
print("value=" + val + "\n");
}
break
stat := 'break'
The continue operator jumps to the next iteration of the loop skipping the execution of the
following statements.
The return statement terminates the execution of the current function/generator and optionally
returns the result of an expression. If the expression is omitted the function will return null. If the
return statement is used inside a generator, the generator will not be resumable anymore.
(see Generators).
Local variables can be declared at any point in the program; they exist between their declaration
to the end of the block where they have been declared.
EXCEPTION: a local declaration statement is allowed as first expression in a for loop.
creates a new function.
continue
stat := 'continue'
return
stat:= return [Exp]
yield
stat := yield [Exp]
Local variables declaration
initz := id [= exp][',' initz]
stat := 'local' initz
for(local a = 0; a < 10; a += 1)
{
print(a);
}
Function declaration
funcname := id ['::' id]
stat:= 'function' id ['::' id]+ '(' args ')'[':' '(' args ')'] stat
creates a new class.
The try statement encloses a block of code in which an exceptional condition can occur, such as a
runtime error or a throw statement. The catch clause provides the exceptionhandling code. When
a catch clause catches an exception, its id is bound to that exception.
Throws an exception. Any value can be thrown.
Declares a constant (see Constants & Enumerations).
Declares an enumeration (see Constants & Enumerations).
Class declaration
memberdecl := id '=' exp [';'] | '[' exp ']' '=' exp [';'] | functionstat | 'cons
stat:= 'class' derefexp ['extends' derefexp] '{'
[memberdecl]
'}'
try/catch
stat:= 'try' stat 'catch' '(' id ')' stat
throw
stat:= 'throw' Exp
const
stat:= 'const' id '=' 'Integer | Float | StringLiteral
enum
enumerations := ( ‘id’ '=' Integer | Float | StringLiteral ) [‘,’]
stat:= 'enum' id '{' enumerations '}'
expression statement
stat := Exp
In Squirrel every expression is also allowed as statement, if so, the result of the expression is
thrown away.
Squirrel Reference Manual
squirrel implements 2 kind of assignment: the normal assignment( = )
and the “new slot” assignment.
The new slot expression allows to add a new slot into a table(see Tables). If the slot already exists
in the table it behaves like a normal assignment.
Conditionally evaluate an expression depending on the result of an expression.
Squirrel supports the standard arithmetic operators + , - , * , / and % . Other than that is also
supports compact operators ( += , -= , *= , /= , %= ) and increment and decrement operators( ++
and -- ).
Expressions
Assignment(=) & new slot(<-)
exp := derefexp '=' Exp
exp:= derefexp '<-' Exp
a = 10;
a <- 10;
Operators
?: Operator
exp := exp_cond '?' exp1 ':' exp2
Arithmetic
exp:= 'exp' op 'exp'
a += 2; //is the same as writing a = a + 2;
x++ //is the same as writing x = x + 1
All operators work normally with integers and floats; if one operand is an integer and one is a float
the result of the expression will be float. The + operator has a special behavior with strings; if one
of the operands is a string the operator + will try to convert the other operand to string as well
and concatenate both together. For instances and tables, _tostring is invoked.
Relational operators in Squirrel are: == < <= > >= !=
These operators return true if the expression is false and a value different than true if the
expression is true. Internally the VM uses the integer 1 as true but this could change in the future.
the 3 ways compare operator <=> compares 2 values A and B and returns an integer less than 0 if
A < B, 0 if A == B and an integer greater than 0 if A > B.
Logical operators in Squirrel are : && || !
The operator && (logical and) returns null if its first argument is null , otherwise returns its
second argument. The operator || (logical or) returns its first argument if is different than null ,
otherwise returns the second argument. The ! operator will return null if the given value to
negate was different than null , or a value different than null if the given value was null .
Tests the existence of a slot in a table. Returns true if keyexp is a valid key in tableexp
Relational
exp:= 'exp' op 'exp'
3 ways compare
exp:= 'exp' op 'exp'
Logical
exp := exp op Exp
exp := '!' Exp
in operator
exp:= keyexp 'in' tableexp
local t = {
foo = "I'm foo",
[123] = "I'm not foo"
};
Tests if a class instance is an instance of a certain class. Returns true if instanceexp is an instance
of classexp.
returns the type name of a value as string.
The comma operator evaluates two expression left to right, the result of the operator is the result
of the expression on the right; the result of the left expression is discarded.
if("foo" in t)
{
dostuff("yep");
}
if(123 in t)
{
dostuff();
}
instanceof operator
exp:= instanceexp 'instanceof' classexp
typeof operator
exp:= 'typeof' Exp
local a = {}, b = "squirrel";
print(typeof a); // Will print "table"
print(typeof b); // Will print "string"
comma operator
exp:= exp ',' Exp
local j = 0, k = 0;
for(local i = 0; i < 10; i++, j++)
{
k = i + j;
}
Squirrel supports the standard c-like bit wise operators & , | , ^ , ~ , << , >> plus the unsigned
right shift operator >>> . The unsigned right shift works exactly like the normal right shift operator(
>> ) except for treating the left operand as an unsigned integer, so is not affected by the sign.
Those operators only work on integers values, passing of any other operand type to these
operators will cause an exception.
- , ~ , ``, typeof , ++ , -- Highest
/ , * , % …
+ , -
<< , >> , >>>
< , <= , > , >=
== , != , <=>
&
^
|
&& , in
||
?:
+= , = , -= …
, (comma operator) Lowest
Creates a new table.
local a,k;
a = (k = 1, k + 2); // a becomes 3
Bitwise Operators
exp:= 'exp' op 'exp'
exp := '~' Exp
Operators Precedence
Table constructor
tslots := ( ‘id’ ‘=’ exp | ‘[‘ exp ‘]’ ‘=’ exp ) [‘,’]
exp := ‘{’ [tslots] ‘}’
A table constructor can also contain slots declaration; With the syntax:
a new slot with id as key and exp as value is created
An alternative syntax can be
A new slot with exp1 as key and exp2 as value is created
both syntaxes can be mixed
The comma between slots is optional.
Since Squirrel 3.0 is possible to declare a table using JSON syntax(see http://www.
wikipedia.org/wiki/JSON).
The following JSON snippet:
local a = {}; //create an empty table
id = exp [',']
local a = {
slot1 = "I'm the slot value"
};
'[' exp1 ']' = exp2 [',']
local a = {
[1] = "I'm the value"
};
local table = {
a = 10,
b = "string",
[10] = {},
function bau(a, b) {
return a + b;
}
};
Table with JSON syntax
is equivalent to the following squirrel code:
Clone performs shallow copy of a table, array or class instance (copies all slots in the new object
without recursion). If the source table has a delegate, the same delegate will be assigned as
delegate (not copied) to the new table (see Delegation).
After the new object is ready the _cloned meta method is called (see Metamethods). When a class
instance is cloned the constructor is not invoked(initializations must rely on _cloned instead.
Creates a new array.
Arrays can be initialized with values during the construction.
local x = {
"id": 1,
"name": "Foo",
"price": 123,
"tags": ["Bar", "Eek"]
};
local x = {
id = 1,
name = "Foo",
price = 123,
tags = ["Bar", "Eek"]
};
clone
exp:= ‘clone’ Exp
Array constructor
exp := ‘[’ [explist] ‘]’
a <- []; //creates an empty array
a <- [1, "string!", [], {}]; //creates an array with 4 elements
Squirrel Reference Manual
Tables are associative containers implemented as pairs of key/value (called slot); values can be
any possible type and keys any type except null . Tables are squirrel's skeleton, delegation and
many other features are all implemented through this type; event the environment, where global
variables are stored, is a table (known as the root table).
Tables are created through the table constructor (see Table Constructor).
Adding a new slot in an existing table is done through the “new slot” operator <- ; this operator
behaves like a normal assignment except that if the slot does not exist, it will be created.
The following line will cause an exception because the slot named newslot does not exist in the
table a.
This will succeed:
or
Deletion of a slot is done through the keyword delete; the result of this expression will be the
value of the deleted slot.
Tables
Construction
Slot Creation
local a = {};
a.newslot = 1234;
a.newslot <- 1234;
a[1] <- "I'm the value of the new slot";
Slot Deletion
exp := delete derefexp
a <- {
test1 = 1234,
deleteme = "now"
};
delete a.test1;
print(delete a.deleteme); // This will print the string "now".
Squirrel Reference Manual
An array is a sequence of values indexed by an integer number from 0 to the size of the array
minus 1.
Array elements can be obtained through their index.
Resizing, insertion, deletion of arrays and the array's elements is done through a set of standard
function (see built-in functions).
Arrays
local a = [“I’m a string”, 123];
print(typeof a[0]); //prints "string"
print(typeof a[1]); //prints "integer"
Squirrel Reference Manual
Functions are first class values like integer or strings and can be stored in table slots, local
variables, arrays and passed as function parameters. Functions can be implemented in Squirrel or
in a native language with calling conventions compatible with ANSI C.
Functions are declared through the function expression:
or with the syntactic sugar:
that is equivalent to
A local function can be declared with this syntactic sugar
that is equivalent to
Functions
Function Declaration
local a = function(a, b, c) {
return a + b - c;
}
function ciao(a, b, c)
{
return a + b - c;
}
this.ciao <- function(a, b, c) {
return a + b - c;
};
local function tuna(a, b, c) {
return a + b - c;
};
local tuna = function(a, b, c) {
return a + b - c;
is also possible to declare something like
Squirrel's functions can have default parameters.
A function with default parameters is declared as follows:
When the function test is invoked and the parameter c or d are not specified, the VM automatically
assigns the default value to the unspecified parameter. A default parameter can be any valid
squirrel expression. The expression is evaluated at runtime.
Squirrel's functions can have variable number of parameters (varargs functions).
};
T <- {};
function T::ciao(a, b, c)
{
return a + b - c;
}
//that is equivalent to write
T.ciao <- function(a, b, c) {
return a + b - c;
};
//or
T <- {
function ciao(a, b, c)
{
return a + b - c;
}
};
Default Parameters
function test(a, b, c = 10, d = 20)
{
[...]
}
Function With Variable Number of Parameters
A vararg function is declared by adding three dots ( ... ) at the end of it's parameter list.
When the function is called all the extra parameters will be accessible through the array called
vargv , that's is passed as an implicit parameter.
vargv is a regular squirrel array and can be used accordingly.
The expression is evaluated in this order: derefexp after the explist (arguments) and at the end of
the call.
Every function call in Squirrel passes the environment object this as a hidden parameter to the
called function. The this parameter is the object where the function was indexed from.
If we call a function with this syntax
the environment object passed to foo will be table
The environment object will be this (the same of the caller function).
function test(a, b, ...)
{
for(local i = 0; i< vargv.len(); i++)
{
::print("varparam " + i + " = " + vargv[i] + "\n");
}
foreach(i,val in vargv)
{
::print("varparam " + i + " = " + val + "\n");
}
}
test("goes in a", "goes in b", 0, 1, 2, 3, 4, 5, 6, 7, 8);
Function Calls
Exp := derefexp ‘(‘ explist ‘)’
table.foo(a);
foo(x, y); // equivalent to this.foo(x, y);
While by default a squirrel function call passes as environment object this, the object where the
function was indexed from. However, is also possible to statically bind an evironment to a closure
using the built-in method closure.bindenv(env_obj) . The method bindenv() returns a new instance
of a closure with the environment bound to it.
When an environment object is bound to a function, every time the function is invoked, its this
parameter will always be the previously bound environment. This mechanism is useful to
implement callbacks systems similar to C# delegates.
The closure keeps a weak reference to the bound environment object, because of this if the object
is deleted, the next call to the closure will result in a null environment object.
Lambda expressions are a syntactic sugar to quickly define a function that consists of a single
expression. This feature comes handy when functional programming patterns are applied, like
map/reduce or passing a compare method to array.sort() .
Here a lambda expression
that is equivalent to
A more useful usage could be
that could have been written as
Binding an Environment to a Function
Note
Lambda Expressions
exp := '@' '(' paramlist ')' exp
local myexp = @(a,b) a + b;
local myexp = function(a, b) {
return a + b;
}
local arr = [2, 3, 5, 8, 3, 5, 1, 2, 6];
arr.sort(@(a, b) a <=> b);
arr.sort(@(a, b) -(a <=> b));
other than being limited to a single expression lambdas support all features of regular functions. in
fact are implemented as a compile time feature.
A free variable is a variable external from the function scope as is not a local variable or parameter
of the function. Free variables reference a local variable from a outer scope. In the following
example the variables testy , x and y are bound to the function foo.
A program can read or write a free variable.
Tail recursion is a method for partially transforming a recursion in a program into an iteration: it
applies when the recursive calls in a function are the last executed statements in that function
(just before the return). If this happens the squirrel interpreter collapses the caller stack frame
before the recursive call; because of that very deep recursions are possible without risk of a stack
overflow.
local arr = [2, 3, 5 , 8 , 3 , 5 , 1 , 2 , 6];
arr.sort(function(a, b) {
return a <=> b;
});
arr.sort(function(a, b) {
return -(a <=> b);
});
Free Variables
local x = 10, y = 20;
local testy = "I’m testy";
function foo(a, b)
{
::print(testy);
return a + b + x + y;
}
Tail Recursion
function loopy(n)
{
if(n > 0)
{
::print("n=" + n + "\n");
return loopy(n - 1);
}
}
loopy(1000);
Squirrel Reference Manual
Squirrel implements a class mechanism similar to languages like Java/C++/etc… however because
of its dynamic nature it differs in several aspects. Classes are first class objects like integer or
strings and can be stored in table slots local variables, arrays and passed as function parameters.
A class object is created through the keyword class. The class object follows the same declaration
syntax of a table(see tables) with the only difference of using ; as an optional separator rather
than ,.
For instance:
The previous code examples is a syntactic sugar for:
Classes
Class Declaration
class Foo
{
//constructor
constructor(a)
{
testy = ["stuff", 1, 2, 3, a];
}
//member function
function PrintTesty()
{
foreach(i, val in testy)
{
::print("idx = " + i + " = " + val + " \n");
}
}
//property
testy = null;
}
In order to emulate namespaces, is also possible to declare something like this
Foo <- class {
//constructor
constructor(a)
{
testy = ["stuff", 1, 2, 3, a];
}
//member function
function PrintTesty()
{
foreach(i, val in testy)
{
::print("idx = " + i + " = " + val + " \n");
}
}
//property
testy = null;
};
// Just 2 regular nested tables
FakeNamespace <- {
Utils = {}
};
class FakeNamespace.Utils.SuperClass
{
constructor()
{
::print("FakeNamespace.Utils.SuperClass");
}
function DoSomething()
{
::print("DoSomething()");
}
}
After its declaration, methods or properties can be added or modified by following the same rules
that apply to a table(operator <- and = ).
After a class is instantiated is no longer possible to add new properties however is possible to add
or replace methods.
Squirrel's classes support static member variables. A static variable shares its value between all
instances of the class. Statics are declared by prefixing the variable declaration with the keyword
static; the declaration must be in the class body.
Statics are read-only.
function FakeNamespace::Utils::SuperClass::DoSomethingElse()
{
::print("FakeNamespace::Utils::SuperClass::DoSomethingElse()");
}
local testy = FakeNamespace.Utils.SuperClass();
testy.DoSomething();
testy.DoSomethingElse();
//adds a new property
Foo.stuff <- 10;
//modifies the default value of an existing property
Foo.testy = "I'm a string";
//adds a new method
function Foo::DoSomething(a, b)
{
return a + b;
}
Static Variables
Note
class Foo
{
constructor()
{
Classes allow to associate attributes to it's members. Attributes are a form of metadata that can
be used to store application specific informations, like documentations strings, properties for IDEs,
code generators etc… Class attributes are declared in the class body by preceding the member
declaration and are delimited by the symbol </ and /> . Here an example:
Attributes are, a matter of fact, a table. Squirrel uses </ /> syntax instead of curly brackets {}
for the attribute declaration to increase readability.
This means that all rules that apply to tables apply to attributes.
Attributes can be retrieved through the built-in function classobj.getattributes(membername) (see
built-in functions) and can be modified/added through the built-in function
classobj.setattributes(membername,val) .
The following code iterates through the attributes of all Foo members.
//..stuff
}
name = "normal variable";
//static variable
static classname = "The class name is foo";
};
Class Attributes
class Foo </ test = "I'm a class level attribute" />
{
</ test = "freakin attribute" /> // Attributes of PrintTesty
function PrintTesty()
{
foreach(i, val in testy)
{
::print("idx = " + i + " = " + val + " \n");
}
}
</ flippy = 10 , second = [1, 2, 3] /> // Attributes of testy
testy = null;
}
The class objects inherit several of the table's feature with the difference that multiple instances of
the same class can be created. A class instance is an object that shares the same structure of the
table that created it but holds is own values. Class instantiation uses function notation. A class
instance is created by calling a class object. Can be useful to imagine a class like a function that
returns a class instance.
When a class instance is created its members are initialized with the same value specified in the
class declaration. The values are copied verbatim, no cloning is performed even if the value is a
container or a class instances.
For C# and Java programmers:
Squirrel doesn't clone member's default values nor executes the member declaration for each
instace(as C# or java).
So consider this example:
foreach(member, val in Foo)
{
::print(member + "\n");
local attr;
if((attr = Foo.getattributes(member)) != null)
{
foreach(i, v in attr)
{
::print("\t" + i + " = " + (typeof v) + "\n");
}
}
else
{
::print("\t<no attributes>\n")
}
}
Class Instances
// Creates a new instance of Foo
local inst = Foo();
Note
class Foo
In the snippet above both instances will refer to the same array and same table. To achieve what a
C# or Java programmer would expect, the following approach should be taken.
When a class defines a method called constructor, the class instantiation operation will
automatically invoke it for the newly created instance. The constructor method can have
parameters, this will impact on the number of parameters that the instantiation operation will
require. Constructors, like normal functions, can have variable number of parameters (using the
parameter ...).
{
myarray = [1, 2, 3];
mytable = {};
}
local a = Foo();
local b = Foo();
class Foo
{
myarray = null;
mytable = null;
constructor()
{
myarray = [1, 2, 3];
mytable = {};
}
}
local a = Foo();
local b = Foo();
class Rect
{
constructor(w, h)
{
width = w;
height = h;
}
x = 0;
After an instance is created, its properties can be set or fetched following the same rules that
apply to tables. Methods cannot be set.
Instance members cannot be removed.
The class object that created a certain instance can be retrieved through the built-in function
instance.getclass() (see built-in functions).
The operator instanceof tests if a class instance is an instance of a certain class.
Since Squirrel 3.x instanceof doesn't throw an exception if the left expression is not a class, it
simply fails.
Squirrel's classes support single inheritance by adding the keyword extends, followed by an
expression, in the class declaration.
The syntax for a derived class is the following:
y = 0;
width = null;
height = null;
}
//Rect's constructor has 2 parameters so the class has to be 'called'
//with 2 parameters
local rc = Rect(100, 100);
local rc = Rect(100, 100);
if(rc instanceof ::Rect)
{
::print("It's a rect");
}
else
{
::print("It isn't a rect");
}
Note
Inheritance
class SuperFoo extends Foo
{
When a derived class is declared, Squirrel first copies all base's members in the new class then
proceeds with evaluating the rest of the declaration.
A derived class inherit all members and properties of its base if the derived class overrides a base
function the base implementation is shadowed. It's possible to access an overridden method of the
base class by fetching the method from through the base keyword.
Here an example:
Same rule applies to the constructor. The constructor is a regular function (apart from being
automatically invoked on construction).
function DoSomething()
{
::print("I'm doing something");
}
}
class Foo
{
function DoSomething()
{
::print("I'm the base");
}
}
class SuperFoo extends Foo
{
//overridden method
function DoSomething()
{
//calls the base method
base.DoSomething();
::print("I'm doing something");
}
}
class BaseClass
{
constructor()
{
::print("Base constructor\n");
The base class of a derived class can be retrieved through the built-in method getbase() .
Note that because methods do not have special protection policies when calling methods of the
same objects, a method of a base class that calls a method of the same class can end up calling
an overridden method of the derived class.
A method of a base class can be explicitly invoked by a method of a derived class though the
keyword base (as in base.MyMethod() ).
}
}
class ChildClass extends BaseClass
{
constructor()
{
base.constructor();
::print("Child constructor\n");
}
}
local test = ChildClass();
local thebaseclass = SuperFoo.getbase();
class Foo
{
function DoSomething()
{
::print("I'm the base");
}
function DoIt()
{
DoSomething();
}
};
class SuperFoo extends Foo
{
//overridden method
Class instances allow the customization of certain aspects of their semantics through
metamethods(see Metamethods). For C++ programmers: “metamethods behave roughly like
overloaded operators”.
The metamethods supported by classes are: _add , _sub , _mul , _div , _unm , _modulo , _set ,
_get , _typeof , _nexti , _cmp , _call , _delslot , _tostring
Class objects instead support only 2 metamethods: _newmember and _inherited .
The following example show how to create a class that implements the metamethod _add .
function DoSomething()
{
::print("I'm the derived");
}
function DoIt()
{
base.DoIt();
}
}
//creates a new instance of SuperFoo
local inst = SuperFoo();
//prints "I'm the derived"
inst.DoIt();
Metamethods
class Vector3
{
constructor(...)
{
if(vargv.len() >= 3)
{
x = vargv[0];
y = vargv[1];
z = vargv[2];
}
}
Since version 2.1, classes support 2 metamethods _inherited and _newmember . _inherited is
invoked when a class inherits from the one that implements _inherited . _newmember is invoked for
each member that is added to the class(at declaration time).
function _add(other)
{
return ::Vector3(x+other.x,y+other.y,z+other.z);
}
x = 0;
y = 0;
z = 0;
}
local v0 = Vector3(1, 2, 3);
local v1 = Vector3(11, 12, 13);
local v2 = v0 + v1;
::print(v2.x + "," + v2.y + "," + v2.z + "\n");
Squirrel Reference Manual
A function that contains a yield statement is called a “generator function”. When a generator
function is called, it does not execute the function body, instead, it returns a new suspended
generator. The returned generator can be resumed through the resume statement while it is alive.
The yield keyword, suspends the execution of a generator and optionally returns the result of an
expression to the function that resumed the generator. The generator dies when it returns, this
can happen through an explicit return statement or by exiting the function body; If an unhandled
exception (or runtime error) occurs while a generator is running, the generator will automatically
die.
A dead generator cannot be resumed anymore.
The output of this program will be:
Generators
function geny(n)
{
for(local i=0;i<n;i+=1)
{
yield i;
}
return null;
}
local gtor = geny(10);
local x;
while(x=resume gtor)
{
print(x + "\n");
}
0
1
2
3
Generators can also be iterated using the foreach statement. When a generator is evaluated by
foreach, the generator will be resumed for each iteration until it returns.
The value returned by the return statement will be ignored.
A suspended generator will hold a strong reference to all the values stored in its local variables
except the this object that is only a weak reference. A running generator holds a strong
reference also to the this object.
4
5
6
7
8
9
Note
Squirrel Reference Manual
Squirrel allows binding constant values to an identifier that will be evaluated compile-time. This is
achieved through constants and enumerations.
Constants bind a specific value to an identifier. Constants are similar to global values, except that
they are evaluated compile-time and their value cannot be changed.
Constant values can only be integers, floats or string literals. No expressions are allowed.
Constants are declared with the following syntax:
Constants are always globally scoped, from the moment they are declared, any following code can
reference them. Constants will shadow any global slot with the same name( the global slot will
remain visible by using the :: syntax).
As Constants, Enumerations bind a specific value to a name. Enumerations are also evaluated
compile-time and their value cannot be changed.
An enum declaration introduces a new enumeration into the program. Enumerations values can
only be integers, floats or string literals. No expressions are allowed.
or
Constants & Enumerations
Constants
const foobar = 100;
const floatbar = 1.2;
const stringbar = "I'm a contant string";
local x = foobar * 2;
Enumerations
enum Stuff {
first, // This will be 0
second, // This will be 1
third // This will be 2
};
An enum value is accessed in a manner that's similar to accessing a static class member. The
name of the member must be qualified with the name of the enumeration, for example
Stuff.second. Enumerations will shadow any global slot with the same name (the global slot will
remain visible by using the :: syntax).
Enumerations and Constants are a compile-time feature. Only integers, string and floats can be
declared as const/enum; No expressions are allowed(because they would have to be evaluated
compile time). When a const or an enum is declared, it is added compile time to the consttable.
This table is stored in the VM shared state and is shared by the VM and all its threads. The
consttable is a regular squirrel table; In the same way as the roottable it can be modified runtime.
You can access the consttable through the built-in function getconsttable() and also change it
through the built-in function setconsttable().
Here are some examples:
enum Stuff {
first = 10,
second = "string",
third = 1.2
};
local x = Stuff.first * 2;
Implementation notes
// Create a constant
getconsttable()["something"] <- 10";
// Create an enumeration
getconsttable()["somethingelse"] <- {
a = "10",
c = "20",
d = "200"
};
// Deletes the constant
delete getconsttable()["something"];
// Deletes the enumeration
delete getconsttable()["somethingelse"];
This system allows to procedurally declare constants and enumerations, it is also possible to
assign any squirrel type to a constant/enumeration(function,classes etc…).
However this will make serialization of a code chunk impossible.
Squirrel Reference Manual
TouchPoint Etal engine does not support Squirrel Threads
Squirrel supports cooperative threads(also known as coroutines). A cooperative thread is a
subroutine that can be suspended in mid-execution and provide value to the caller without
returning program flow, then its execution can be resumed later from the same point where it was
suspended. At first look a Squirrel thread can be confused with a generator, in fact their behaviour
is quite similar. However, while a generator runs in the caller stack and can suspend only the local
routine stack a thread has its own execution stack, global table and error handler; This allows a
thread to suspend nested calls and have it's own error policies.
Threads are created through the built-in function newthread(func) ; this function gets as parameter
a squirrel function and binds it to the new thread objects(will be the thread body). The returned
thread object is initially in 'idle' state. the thread can be started with the function threadobj.call()
; the parameters passed to call are passed to the thread function.
A thread can be suspended calling the function suspend() when this happens the function that
woke up(or started) the thread returns (If a parameter is passed to suspend() it will be the return
value of the wakeup function, if no parameter is passed the return value will be null). A suspended
thread can be resumed calling the function threadobj.wakeup when this happens the function that
suspended the thread will return(if a parameter is passed to wakeup it will be the return value of
the suspend function if no parameter is passed the return value will be null ).
A thread terminates when its main function returns or when an unhandled exception occurs during
its execution.
Threads
Using Threads
function coroutine_test(a,b)
{
::print(a + " " + b + "\n");
local ret = ::suspend("suspend 1");
::print("the coroutine says " + ret + "\n");
ret = ::suspend("suspend 2");
::print("the coroutine says " + ret + "\n");
The following is an interesting example of how threads and tail recursion can be combined.
ret = ::suspend("suspend 3");
::print("the coroutine says " + ret + "\n");
return "I'm done";
}
local coro = ::newthread(coroutine_test);
local susparam = coro.call("test", "coroutine"); // Starts the coroutine
local i = 1;
do
{
::print("suspend passed (" + susparam + ")\n");
susparam = coro.wakeup("ciao " + i);
++i;
} while(coro.getstatus() == "suspended");
::print("return passed (" + susparam + ")\n")
The result of this program will be:
test coroutine
suspend passed (suspend 1)
the coroutine says ciao 1
suspend passed (suspend 2)
the coroutine says ciao 2
suspend passed (suspend 3)
the coroutine says ciao 3
return passed (I'm done).
function state1()
{
::suspend("state1");
return state2(); // tail call
}
function state2()
{
::suspend("state2");
return state3(); // tail call
}
function state3()
{
::suspend("state3");
return state1(); // tail call
}
local statethread = ::newthread(state1);
::print(statethread.call()+"\n");
for(local i = 0; i < 10000; i++)
{
::print(statethread.wakeup() + "\n");
}
Squirrel Reference Manual
The weak references allow the programmers to create references to objects without influencing
the lifetime of the object itself. In squirrel, Weak references are first-class objects created through
the built-in method obj.weakref() . All types except null implement the weakref() method;
however in books, integers and float the method simply returns the object itself (this because
these types are always passed by value).
When a weak reference is assigned to a container (table slot, array, class or instance) is treated
differently than other objects; When a container slot that holds a weak reference is fetched, it
always returns the value pointed by the weak reference instead of the weak reference object. This
allows the programmer to ignore the fact that the value handled is weak. When the object pointed
by weak reference is destroyed, the weak reference is automatically set to null .
The table slot thearray contains a weak reference to an array. The following line prints “first”,
because tables (and all other containers) always return the object pointed by a weak ref.
The only strong reference to the array is owned by the local variable a, so because the following
line assigns an integer to 'a' the array is destroyed.
When an object pointed by a weak ref is destroyed the weak ref is automatically set to null, so the
following line will print “null”.
If a weak reference is assigned to a local variable, then is treated as any other value.
Weak References
local t = {};
local a = ["first", "second", "third"];
// Creates a weakref to the array and assigns it to a table slot
t.thearray <- a.weakref();
print(t.thearray[0]);
a = 123;
::print(typeof(t.thearray));
Handling Weak References Explicitly
The following line prints “ weakref ”.
The object pointed by the weakref can be obtained through the built-in method weakref.ref() .
The following line prints “ table ”.
local t = {};
local weakobj = t.weakref();
::print(typeof(weakobj))
::print(typeof(weakobj.ref()))
Squirrel Reference Manual
Squirrel supports implicit delegation. Every table or userdata can have a parent table (delegate). A
parent table is a normal table that allows the definition of special behaviours for his child. When a
table (or userdata) is indexed with a key that doesn’t correspond to one of its slots, the interpreter
automatically delegates the get (or set) operation to its parent.
The delegate of a table can be retrieved through the built-in method table.getdelegate() .
Delegation
Entity <- {};
function Entity::DoStuff()
{
::print(_name);
}
local newentity = {
_name = "I’m the new entity"
};
newentity.setdelegate(Entity);
newentity.DoStuff(); //prints "I'm the new entity"
local thedelegate = newentity.getdelegate();
Squirrel Reference Manual
Metamethods are a mechanism that allows the customization of certain aspects of the language
semantics. Those methods are normal functions placed in a table parent (delegate) or class
declaration; Is possible to change many aspects of a table/class instance behaviour by just
defining a metamethod. Class objects(not instances) supports only 2 metamethods _newmember ,
_inherited .
For example, when we use relational operators other than == on 2 tables, the VM will check if the
table has a method in his parent called _cmp if so it will call it to determine the relationship
between the tables.
Metamethods
local comparable = {
_cmp = function (other) {
if(name<other.name)return –1;
if(name>other.name)return 1;
return 0;
}
};
local a = {
name = "Alberto"
}.setdelegate(comparable);
local b = {
name = "Wouter"
}.setdelegate(comparable);
if(a > b)
{
print("a > b");
}
else
{
print("b <= a");
}
For classes the previous code become:
Invoked when the index idx is not present in the object or in its delegate chain. _set must throw
null to notify that a key wasn't found but there were no runtime errors(clean failure). This allows
the program to differentiate between a runtime error and an index not found.
class Comparable {
constructor(n)
{
name = n;
}
function _cmp(other)
{
if(name<other.name) return -1;
if(name>other.name) return 1;
return 0;
}
name = null;
}
local a = Comparable("Alberto");
local b = Comparable("Wouter");
if(a > b)
{
print("a > b");
}
else
{
print("b <= a");
}
_set
function _set(idx,val) //returns val
_get
Invoked when the index idx is not present in the object or in its delegate chain. _get must throw
null to notify that a key wasn't found but there were no runtime errors(clean failure). This allows
the program to differentiate between a runtime error and an 'index not found'.
Invoked when a script tries to add a new slot in a table.
If the slot already exists in the target table the method will not be invoked also if the new slot
operator is used.
Invoked when a script deletes a slot from a table. If the method is invoked squirrel will not try to
delete the slot himself.
The + operator.
The – operator (like _add ).
The * operator (like _add ).
The / operator (like _add ).
The % operator (like _add ).
function _get(idx) //return the fetched values
_newslot
function _newslot(key,value) //returns val
_delslot
function _delslot(key)
_add
function _add(op) //returns this+op
_sub
_mul
_div
_modulo
_unm
The unary minus operator.
Invoked by the typeof operator on tables, userdata and class instances.
Invoked to emulate the < > <= >= operators
Returns an integer:
> 0 If this > other
0 If this == other
< 0 If this < other
Invoked when a table, userdata or class instance is called.
Invoked when a table or class instance is cloned (in the cloned table).
Invoked when a userdata or class instance is iterated by a foreach loop.
If previdx == null it means that it is the first iteration. The function has to return the index of the
next value.
function _unm()
_typeof
function _typeof() //returns the type of this as string
_cmp
function _cmp(other)
_call
function _call(original_this,params…)
_cloned
function _cloned(original)
_nexti
function _nexti(previdx)
Invoked when during string concatenation or when the print function prints a table, instance or
userdata. The method is also invoked by the sq_tostring() API.
Must return a string representation of the object.
Invoked when a class object inherits from the class implementing _inherited the this contains the
new class.
Return value is ignored.
Invoked for each member declared in a class body(at declaration time).
If the function is implemented, members will not be added to the class.
_tostring
function _tostring()
_inherited
function _inherited(attributes)
_newmember
function _newmember(index, value, attributes, isstatic)
Squirrel Reference Manual
The squirrel virtual machine has a set of built utility functions.
array(size, [fill]);
Creates and returns an array of a specified size . If the optional parameter fill is specified its
value will be used to fill the new array's slots. If the fill parameter is omitted null is used
instead.
seterrorhandler(func);
Sets the runtime error handler.
callee();
Returns the currently running closure.
setdebughook(hook_func);
Sets the debug hook.
enabledebuginfo(enable);
Enable/disable the debug line information generation at compile time.
enable != null enables. enable == null disables.
getroottable();
Returns the root table of the VM.
Built-in Functions
Global symbols
array()
seterrorhandler()
callee()
setdebughook()
enabledebuginfo()
getroottable()
setroottable(table);
Sets the root table of the VM and returns the previous root table.
getconsttable();
Returns the const table of the VM.
setconsttable(table);
Sets the const table of the VM. And returns the previous const table.
assert(Exp);
Throws an exception if exp is null.
print(x);
Prints x in the standard output.
error(x);
Prints x in the standard error output.
compilestring(string, [buffername]);
Compiles a string containing a squirrel script into a function and returns it.
collectgarbage();
setroottable()
getconsttable()
setconsttable()
assert()
print()
error()
compilestring()
local compiledscript = compilestring("::print(\"ciao\")");
//run the script
compiledscript();
collectgarbage()
Runs the garbage collector and returns the number of reference cycles found (and deleted) This
function only works on garbage collector builds.
resurrectunreachable();
Runs the garbage collector and returns an array containing all unreachable object found. If no
unreachable object is found, null is returned instead. This function is meant to help debugging
reference cycles. This function only works on garbage collector builds.
type(obj);
Returns the 'raw' type of an object without invoking the metamethod _typeof .
getstackinfos(level);
Returns the stack information of a given call stack level.
Returns a table formatted as follows:
level = 0 is the current function, level = 1 is the caller and so on. If the stack level doesn't exist
the function returns null .
newthread(threadfunc);
Creates a new cooperative thread object(coroutine) and returns it.
_versionnumber_
resurrectunreachable()
type()
getstackinfos()
{
func = "DoStuff", //function name
src = "test.nut", //source file
line = 10, //line number
locals = { // a table containing the local variables
a = 10,
testy = "I'm a string"
};
}
newthread()
_versionnumber_
Integer values describing the version of VM and compiler. eg. for Squirrel 3.0.1 this value will be
301.
_version_
String values describing the version of VM and compiler.
_charsize_
Size in bytes of the internal VM representation for characters (1 for ASCII builds 2 for UNICODE
builds).
_intsize_
Size in bytes of the internal VM representation for integers (4 for 32bits builds 8 for 64bits builds).
_floatsize_
Size in bytes of the internal VM representation for floats (4 for single-precision builds 8 for double
precision builds).
Except null and userdata every squirrel object has a default delegate containing a set of functions
to manipulate and retrieve information from the object itself.
integer.tofloat();
Convert the number to float and returns it.
integer.tostring();
Converts the number to string and returns it.
integer.tointeger();
_version_
_charsize
_intsize_
_floatsize_
Default delegates
Integer
tofloat()
tostring()
tointeger()
Returns the value of the integer (dummy function).
integer.tochar();
Returns a string containing a single character represented by the integer.
integer.toutf8();
Returns a string containing the utf8 representation of the unicode codepoint represented by the
integer.
integer.weakref();
Dummy function, returns the integer itself.
float.tofloat();
Returns the value of the float (dummy function).
float.tointeger();
Converts the number to integer and returns it.
float.tostring();
Converts the number to string and returns it.
float.tochar();
Returns a string containing a single character represented by the integer part of the float.
float.weakref();
Dummy function, returns the float itself.
tochar()
toutf8()
weakref()
Float
tofloat()
tointeger()
tostring()
tochar()
weakref()
boolean.tofloat();
Returns 1.0 for true, 0.0 for false.
boolean.tointeger();
Returns 1 for true, 0 for false.
boolean.tostring();
Returns “true” for true, “false” for false.
boolean.weakref();
Dummy function, returns the bool itself.
string.len();
Returns the string length.
string.tointeger();
Converts the string to integer and returns it.
string.tofloat();
Converts the string to float and returns it.
string.tostring();
Returns the string (dummy function)
Boolean
tofloat()
tointeger()
tostring()
weakref()
String
len()
tointeger()
tofloat()
tostring()
slice()
string.slice(start, [end]);
Returns a section of the string as a new string.
Copies from start to the end (not included).
If start is negative the index is calculated as length + start .
If end is negative the index is calculated as length + end .
If end is omitted end is equal to the string length .
string.find(substr, [startidx]);
Search a substring( substr ) starting from the index( startidx )and returns the index of its first
occurrence. If startidx is omitted the search operation starts from the beginning of the string.
The function returns null if substr is not found.
string.tolower();
Returns a lowercase copy of the string.
string.toupper();
Returns a uppercase copy of the string.
string.weakref();
Returns a weak reference to the object.
table.len();
Returns the number of slots contained in a table.
table.rawget(key);
Tries to get a value from the slot key without employing delegation.
table.rawset(key, val);
find()
tolower()
toupper()
weakref()
Table
len()
rawget()
rawset()
Sets the slot ‘ key ’ with the value val without employing delegation. If the slot does not exist, it
will be created.
table.rawdelete();
Deletes the slot key without employing delegation and returns its value. If the slot does not exist
returns always null.
table.rawin(key);
Returns true if the slot key exists. The function has the same effect as the operator in but does not
employ delegation.
table.weakref();
Returns a weak reference to the object.
Tries to invoke the _tostring metamethod, if failed. returns “ (table : pointer) ”.
table.clear();
Removes all the slots from the table.
table.setdelegate(table);
Sets the delegate of the table, to remove a delegate null must be passed to the function. The
function returns the table itself (eg. a.setdelegate(b) in this case a is the return value).
table.getdelegate();
Returns the table's delegate or null if no delegate was set.
rawdelete()
rawin()
weakref()
tostring()
table.tostring();
clear()
setdelegate()
getdelegate()
Array
len()
array.len();
Returns the length of the array.
array.append(val);
Appends the value val at the end of the array.
array.push(val);
Appends the value val at the end of the array.
array.extend(array);
Extends the array by appending all the items in the given array.
array.pop();
Removes a value from the back of the array and returns it.
array.top();
Returns the value of the array with the higher index.
array.insert(idx, val);
Inserts the value val at the position idx in the array.
array.remove(idx);
Removes the value at the position idx in the array.
array.resize(size, [fill]);
Resizes the array, if the optional parameter fill is specified its value will be used to fill the new
array's slots (if the size specified is bigger than the previous size). If the fill parameter is
omitted null is used instead.
append()
push()
extend()
pop()
top()
insert()
remove()
resize()
array.sort([compare_func]);
Sorts the array. a custom compare function can be optionally passed.
The function prototype as to be the following:
A more compact version of a custom compare can be written using a lambda expression and the
operator <=> :
array.reverse();
Reverse the elements of the array in place.
array.slice(start, [end]);
Returns a section of the array as a new array. Copies from start to the end (not included).
If start is negative the index is calculated as length + start .
If end is negative the index is calculated as length + end .
If end is omitted end is equal to the array length.
array.weakref();
Returns a weak reference to the object.
array.tostring();
Returns the string “ (array : pointer) ”.
sort()
function custom_compare(a, b)
{
if(a > b) return 1;
else if(a<b) return -1;
return 0;
}
arr.sort(@(a, b) a <=> b);
reverse()
slice()
weakref()
tostring()
clear()
array.clear();
Removes all the items from the array.
array.map(func(a));
Creates a new array of the same size. For each element in the original array invokes the function
func and assigns the return value of the function to the corresponding element of the newly
created array.
array.apply(func(a));
For each element in the array invokes the function func and replace the original value of the
element with the return value of the function.
array.reduce(func(prevval, curval));
Reduces an array to a single value. For each element in the array invokes the function func
passing the initial value (or value from the previous callback call) and the value of the current
element. the return value of the function is then used as prevval for the next element.
Given an array of length 0, returns null .
Given an array of length 1, returns the first element.
Given an array with 2 or more elements calls the function with the first two elements as the
parameters, gets that result, then calls the function with that result and the third element, gets
that result, calls the function with that result and the fourth parameter and so on until all elements
have been processed.
Finally returns the return value of the last invocation of func .
array.filter(func(index, val));
Creates a new array with all elements that pass the test implemented by the provided function. In
detail, it creates a new array, for each element in the original array invokes the specified function
passing the index of the element and its value ; if the function returns “ true ”, then the value of
the corresponding element is added on the newly created array.
array.find(value);
map()
apply()
reduce()
filter()
find()
Performs a linear search for the value in the array. Returns the index of the value if it was found
null otherwise.
Function
call(_this, args…);
Calls the function with the specified environment object( this ) and parameters.
pcall(_this, args…);
calls the function with the specified environment object ( this ) and parameters, this function will
not invoke the error callback in case of failure (pcall stays for 'protected call').
acall(array_args);
Calls the function with the specified environment object ( this ) and parameters. The function
accepts an array containing the parameters that will be passed to the called function. Where
array_args has to contain the required this object at the [0] position.
pacall(array_args);
Calls the function with the specified environment object ( this ) and parameters. The function
accepts an array containing the parameters that will be passed to the called function. Where
array_args has to contain the required this object at the [0] position.
This function will not invoke the error callback in case of failure (pacall stays for 'protected array
call')
weakref();
Returns a weak reference to the object.
tostring();
Returns the string “ (closure : pointer) ”.
bindenv(env);
call()
pcall()
acall()
pacall()
weakref()
tostring()
bindenv()
Clones the function (aka closure) and bind the environment object to it (table, class or instance).
the this parameter of the newly created function will always be set to env .
Note that the created function holds a weak reference to its environment object so cannot be used
to control its lifetime.
getinfos();
Returns a table containing information about the function, like parameters, name and source
name;
class.instance();
Returns a new instance of the class. this function does not invoke the instance constructor. The
constructor must be explicitly called( eg. class_inst.constructor(class_inst)).
class.getattributes(membername);
getinfos()
//the data is returned as a table is in form
//pure squirrel function
{
native = false,
name = "zefuncname",
src = "/somthing/something.nut",
parameters = ["a", "b", "c"],
defparams = [1, "def"],
varargs = 2
}
//native C function
{
native = true
name = "zefuncname"
paramscheck = 2
typecheck = [83886082, 83886384] //this is the typemask (see C defines OT_INTEGER,OT_FLOAT
etc...)
}
Class
instance()
getattributes()
Returns the attributes of the specified member. if the parameter member is null the function
returns the class level attributes.
class.setattributes(membername, attr);
Sets the attribute of the specified member and returns the previous attribute value. If the
parameter member is null the function sets the class level attributes.
class.rawin(key);
Returns true if the slot key exists. The function has the same effect as the operator in but does not
employ delegation.
class.weakref();
Returns a weak reference to the object.
class.tostring();
Returns the string “ (class : pointer) ”.
class.rawget(key);
Tries to get a value from the slot key without employing delegation.
class.rawset(key, val);
Sets the slot key with the value val without employing delegation. If the slot does not exist, it will
be created.
class.newmember(key, oval, [attrs], [static]);
Sets/adds the slot key with the value val and attributes attrs and if present invokes the
_newmember metamethod. If static is true the slot will be added as static. If the slot does not
exist, it will be created.
setattributes()
rawin()
weakref()
tostring()
rawget()
rawset()
newmember()
rawnewmember()
class.rawnewmember(key, oval, [attrs], [static]);
Sets/adds the slot key with the value val and attributes attrs. If static is true the slot will be added
as static. If the slot does not exist, it will be created. It doesn't invoke any metamethod.
instance.getclass();
Returns the class that created the instance.
instance.rawin(key);
Returns true if the slot key exists. The function has the same effect as the operator in but does not
employ delegation.
instance.weakref();
Returns a weak reference to the object.
instance.tostring();
Tries to invoke the _tostring metamethod, if failed. returns “ (instance : pointer) ”.
instance.rawget(key);
Tries to get a value from the slot key without employing delegation.
instance.rawset(key,val);
Sets the slot key with the value val without employing delegation. If the slot does not exist, it will
be created.
generator.getstatus();
Returns the status of the generator as a string: running , dead or suspended .
Class Instance
getclass()
rawin()
weakref()
tostring()
rawget()
rawset()
Generator
getstatus()
generator.weakref();
Returns a weak reference to the object.
generator.tostring();
Returns the string “ (generator : pointer) ”.
thread.call(...);
Starts the thread with the specified parameters.
thread.wakeup([wakeupval]);
Wakes up a suspended thread, accepts an optional parameter that will be used as return value for
the function that suspended the thread(usually suspend() ).
thread.getstatus();
Returns the status of the thread ( idle , running , suspended )
thread.weakref();
Returns a weak reference to the object.
thread.tostring();
Returns the string “ (thread : pointer) ”.
thread.getstackinfos(stacklevel);
Returns the stack frame information at the given stack level (0 is the current function 1 is the
caller and so on).
weakref()
tostring()
Thread
call()
wakeup()
getstatus()
weakref()
tostring()
getstackinfos()
weakreference.ref();
Returns the object that the weak reference is pointing at, null if the object that was pointed at was
destroyed.
weakreference.weakref();
Returns a weak reference to the object.
weakreference.tostring();
Returns the string “ (weakref : pointer) ”.
Weak Reference
ref()
weakref()
tostring()
ICRTouch specific events & methods.
ICRTouch Standard Library
ICRTouch Standard Library
ICR_MessageBox(string szLine1, string szLine2, string szTitle, integer nType): integer
Prompts a message box.
Parameter Description Values
szLine1 Line 1
szLine2 Line 2
szTitle Title
nType Message box type 0 - OK
1 - Yes/no
Returns an integer value based on the option selected.
Dialog functions
ICR_MessageBox
Parameters
Return values
Examples
function BeforeKeyPress(nFile, nRecord, nKeyType)
{
if(nFile == 51)
{
// Get the clerk buffer and check if we're already in finalisation.
local tClerkBuffer = ICR_GetClerkBuffer_Index();
if(tClerkBuffer.INFINALISATION)
{
// Already finalising, continue.
return true;
ICR_GetNumberDialog(string szTitle = "", integer nStartingNumber = 0, boolean bHideNumber =
false, integer nType = 0): integer
Opens a numeric entry dialog.
Parameter Description Values
szTitle Dialog title
nStartingNumber Starting number
bHideNumber Hide number true - Replaces entry with *
false - Displays entered value
}
// Finalise key pressed, do we want to finalise the sale?
local nResult = ICR_MessageBox("Finalise sale", "Are you sure?", "Confirmation",
1);
if(nResult)
{
// Yes selected, return true.
return true;
}
else
{
// No selected, return false.
return false;
}
}
// Not a key we're interested in, let TouchPoint handle it, return true.
return true;
}
ICR_GetNumberDialog
Parameters
Parameter Description Values
nType Entry type
0 - Standard
1 - Time
2 - Weight
3 - String
4 - Date
Returns an integer value based on the data entered.
ICR_GetAlphaDialog(string szTitle = "", integer nMax = 0, boolean bCaps = false, string
szSTartingText = ""): string
Opens a QWERTY dialog.
Return values
Examples
function BeforeKeyPress(nFile, nRecord, nKeyType)
{
if(nKeyType == 97)
{
// Covers key pressed.
// Get the value entered, make sure that covers are entered.
local nCovers = ICR_GetNumberDialog("Covers", 0);
while(nCovers == 0)
{
// While covers are 0, prompt again until a value is entered.
nCovers = ICR_GetNumberDialog("Covers", 0);
}
// Set the next dialog input to the value (covers key).
ICR_SetNextDialogInput(nCovers);
}
return true;
}
ICR_GetAlphaDialog
Parameter Description Values
szTitle Dialog title
nMax Maximum number of characters
bCaps Force uppercase
szStartingText Placeholder text
Returns a string value based on the data entered.
Parameters
Return values
Examples
function OnRunScriptKeyPress(nFile, nRecord, nNumber, nValue, nFlag)
{
// Grab the clerk buffer.
local tClerkBuffer = ICR_GetClerkBuffer_Index();
// Check the key's assigned number
switch(nNumber)
{
case 1:
// Check the clerk buffer for the current customer
if(tClerkBuffer.CUSTOMER == 0)
{
// No customer signed on, get the address.
local tAddress = GetCustomerAddress();
// Process the address.
CustomerAddressHandler(tAddress);
}
break;
}
}
function GetCustomerAddress()
{
// Spawn a Alpha Dialog box for each address element and capture data.
return {
ICR_ListDialog(string szTitle = "", integer nStartItem = 1): integer
Opens a list dialog based on items added using ICR_ListDialog_AddItem .
Parameter Description Values
szTitle Dialog title
nStartItem Default selected item
Return an integer value based on the list item selected.
ICR_ListDialog_AddItem(string szItem = "", boolean bFirstItem = false)
// LINE1, LINE2, CITY, COUNTY
// - Maximum length of string: 30/20, uppercase set to false.
LINE1 <- ICR_GetAlphaDialog("Delivery Line1", 30, false);
LINE2 <- ICR_GetAlphaDialog("Delivery Line2" 30, false);
CITY <- ICR_GetAlphaDialog("Delivery Town" 20, false);
COUNTY <- ICR_GetAlphaDialog("Delivery County" 20, false);
// POSTCODE
// - Maximum length of string: 8, uppercase set to true
POSTCODE <- ICR_GetAlphaDialog("Delivery POSTCODE" 8, true);
};
}
ICR_ListDialog
Parameters
Return values
Examples
local nSelection = ICR_ListDialog("In drawer totals");
ICR_ListDialog_AddItem
Adds a new item to the current list of dialog items.
Setting bFirstItem to true clears out the current list data ready for new items to be added.
Parameter Description Values
szItem Item name
bFirstItem List reset
true - Reset list and add this item
as the first
false - Add this item to the list data
None
Parameters
Return values
Examples
function GetInDrawerTotaliser()
{
// Set bFirst to true, this will be used to reset the list data.
local bFirst = true;
// Iterate over our 8 in drawer totals.
for(local nCount = 4; nCount <= 11; nCount++)
{
// Get the Program data for this totaliser.
local tFixedTotal = ICR_GetPGMData(50, nCount);
// Add this total to the list, resetting the list as required.
ICR_ListDialog_AddItem(tFixedTotal.NAME, bFirst);
// After first iteration, set the bFirst to false to prevent multi-reset.
bFirst = false;
}
// Prompt the list dialog and return the selection.
return ICR_ListDialog("In drawer totaliser");
}
ICR_DataEntryDialog(string szTitle = "", boolean bRecordSelectionMode = false): table|integer
Opens a data entry dialog.
bRecordSelectionMode changes the state from an entry dialog to a selection dialog similar to
ICR_ListDialog .
When used as a record selection dialog, this has the advantage of being able to display more
information to the user across two columns.
Parameter Description Values
szTitle Dialog title
bRecordSelectionMode Selection mode true - Selection dialog
false - Data entry dialog
Returns either a table of entered data or, when in record selection mode, an integer based off of
the selected item.
ICR_DataEntryDialog_AddItem(string szFieldName, boolean bFirstItem, string szData, integer
nDataType = 2, integer nMaxLength = 0, integer nDP = 0, boolean bReadOnly = false)
Adds a new item to the current list of data entry dialog items.
Setting bFirstItem to true clears out the current list data ready for new items to be added.
ICR_DataEntryDialog
Parameters
Return values
Examples
Data entry mode
local tData = ICR_DataEntryDialog("Customer address", false);
Record selection mode
local nSelection = ICR_DataEntryDialog("Matching records", true);
ICR_DataEntryDialog_AddItem
Parameters
Parameter Description Values
szFieldName Field name
bFirst Data entry reset
true - Reset list and add this item
as the first
false - Add this item to the list data
szData Field value
nDataType Data type
1 - Yes/no
2 - String
3 - Number
4 - Drop down window
10 - Ok
42 - Postcode lookup
nMaxLength Maximum length of data
nDP Decimal places or list ID if nDataType
is 4 (drop down window)
bReadOnly Read only
None
Return values
Examples
Data entry mode
local g_nTerminalState = 1;
enum STATE {NORMAL = 1, PGMPLU = 2};
function BeforeKeyPress(nFile, nRecord, nKeytype)
{
if(nFile == 1)
{
// PLU Pressed, check the programming state.
switch(g_nTerminalState)
{
case STATE.NORMAL: // Normal, allow sale.
return true;
case STATE.PGMPLU: // Programming mode.
ProgramPLU(nRecord);
return false;
default: // State not catered for, return true.
return true;
}
}
// Not a PLU, just return.
return true;
}
function ProgramPLU(nRecord)
{
// Get the PLU program data.
local tPLU = ICR_GetPGMData(1, nRecord);
// Add the current data to the data entry dialog.
ICR_DataEntryDialog_AddItem("PLU name", true, tPLU.NAME);
ICR_DataEntryDialog_AddItem("Department", false, tPLU.DEPT, 4, 0, 0);
ICR_DataEntryDialog_AddItem("PLU group", false, tPLU.GROUP, 4, 0, 1);
ICR_DataEntryDialog_AddItem("1st@ price", false, tPLU.PRICE1L1, 3, 0, 2);
ICR_DataEntryDialog_AddItem("2nd@ price", false, tPLU.PRICE2L1, 3, 0, 2);
ICR_DataEntryDialog_AddItem("3rd@ price", false, tPLU.PRICE3L1, 3, 0, 2);
ICR_DataEntryDialog_AddItem("4th@ price", false, tPLU.PRICE4L1, 3, 0, 2);
// Get the result.
local tResult = ICR_DataEntryDialog("Program PLU");
// Assign the new data from the dialog to the PLU data.
tPLU.NAME <- tResult.FIELD1;
tPLU.DEPT <- tResult.FIELD2;
tPLU.GROUP <- tResult.FIELD3;
tPLU.PRICE1L1 <- tResult.FIELD4;
tPLU.PRICE2L1 <- tResult.FIELD5;
tPLU.PRICE3L1 <- tResult.FIELD6;
tPLU.PRICE4L1 <- tResult.FIELD7;
// Set the PLU program data.
ICR_SetPGMData(1, nRecord, tPLU);
}
Record selection mode
function BeforeKeyPress(nFile, nRecord, nKeytype)
{
if(nKeyType == 50)
{
// PLU number key, override action and display our dialog.
// Find PLU.
local nRecord = FindPLU();
if(type(nRecord) == "integer" && nRecord > 0)
{
// Record found, sell it.
ICR_KeyPress(1, nRecord);
}
else
{
// Not found, show message.
ICR_SetInput_Message("PLU Not Found");
}
return false;
}
return true;
}
function FindPLU(nRecord)
{
// Capture the search term.
local szSearchTerm = ICR_GetAlphaDialog("PLU search term");
// Match this to our PLUs
local arrFoundPLUs = MatchPLUs(szSearchTerm);
// Set bFirstg to true, this will be used to reset the list data.
local bFirst = true;
foreach(idx, plu in arrFoundPLUs)
{
// Iterate through the found PLUs and add them to the data entry dialog.
For a list of drop down window types please see constant values.
TouchPoint 6210+
ICR_SetNextDialogInput(string|integer szData)
Sets the input for the next dialog prompt.
Parameter Description Values
szData Input data
For list dialog pass list item number
to be selected.
For Yes/No dialog pass "YES" or "NO"
None
ICR_DataEntryDialog_AddItem(plu.RECORD, bFirst, plu.NAME);
// After first iteration, set the bFirst to false to prevent multi-reset.
bFirst = false;
}
// Return the selected value.
return ICR_DataEntryDialog("Select PLU", true);
}
Notes
ICR_SetNextDialogInput
Parameters
Return values
Examples
function OnCardSwipe(nTrack, szData)
{
if(nTrack != 1)
{
// Not track 1, return true.
return true;
TouchPoint 7200+
ICR_GetDateDialog(string|integer szStartDate = ""): string
Draws a calendar to the screen for user date selection.
The calendar will start from the date provided, or today if the parameter is empty or invalid.
Parameter Description Values
szStartDate Start date
Returns a string value representing the user's selected date.
}
if(szData.len() != 11)
{
// Incorrect length, return true.
return true;
}
if(szData.slice(0, 3) != "ICR")
{
// Front 3 characters do not match, return true.
return true;
}
// Slice off the last 4 characters and pass to the customer number key.
ICR_SetNextDialogInput(szData.slice(7, 11));
ICR_KeyPress(53, g_nCustomerSignOnKey);
}
ICR_GetDateDialog
Parameters
Return values
Examples
// Draw a date dialog starting from today.
local szSelectedDate = ICR_GetDateDialog();
// Draw a date dialog starting from 1st April 2036.
local szSelectedDate = ICR_GetDateDialog(1042036);
// Draw a date dialog starting from 19th September 2029.
local szSelectedDate = ICR_GetDateDialog("19092029");
ICRTouch Standard Library
ICR_EnableDebugLog(boolean bEnable)
Toggles debug logging to the standard output.txt file.
Parameter Description Values
bEnable Logging on/off
None
ICR_EnableDebugLog() should only be used for development purposes and should not be left
enabled for production scripts.
ICR_SetFeature(string szFeature, string szValue)
Sets a feature to the specified value.
Whilst it's expecting a string, other types may be converted (i.e booleans).
Currently settable features are DEBUGLOG , CONSOLE and AUTORESTART .
Utility functions
ICR_EnableDebugLog
Parameters
Return values
Examples
local bDebugPrinting = true;
function OnInit()
{
ICR_EnableDebugLog(bDebugPrinting);
}
Notes
ICR_SetFeature
Parameter Description Values
szFeature Feature name
szValue Feature value
None
ICR_SetFeature("DEBUGLOG", true) is the same as ICR_EnableDebugLog(true) .
ICR_SetFeature("CONSOLE", true) is the same as ICR_EnableConsole(true) .
ICR_SetFeature("AUTORESTART", true) is the same as ICR_RestartScriptingEngine() except it will
restart the script engine upon script file modification.
The items settable with ICR_SetFeature() should only be used for development purposes and
should not be deployed into production scripts.
ICR_StealEvent(string szEventName, boolean bOnceOnly = false)
Locks the event specified in szEventName to the VM only.
bOnceOnly , when set, releases the event immediately after the first time it has been called.
The event should be released again so that other VMs receives it using
ICR_ReleaseEvent(szEventName) .
This will stop other scripts interacting with the event until it has been released.
Parameters
Return values
Examples
local bDebugPrinting = true;
function OnInit()
{
ICR_EnableDebugLog(bDebugPrinting);
ICR_SetFeature("CONSOLE", bDebugPrinting);
ICR_SetFeature("AUTORESTART", bDebugPrinting);
}
Notes
ICR_StealEvent
Parameters
Parameter Description Values
szEventName Event name
bOnceOnly Steal event for single use
None
Return values
Examples
function LockTill(bLock = false, strDisplayMessage = "")
{
if (bLock)
{
// Terminal "locked".
if(strDisplayMessage != "")
{
// Display a message to the user.
ICR_SetInput_Message(strDisplayMessage);
}
// Store the locked value.
g_bLocked = true;
// Stop other scripts accessing the following events.
ICR_StealEvent("BeforeKeyPress");
ICR_StealEvent("OnIButtonPressed");
ICR_StealEvent("OnCardSwipe");
ICR_StealEvent("OnBarcode");
}
else
{
// Terminal "unlocked".
if(strDisplayMessage != "")
{
// Display a message to the user.
ICR_SetInput_Message(strDisplayMessage);
}
// Store the locked value.
ICR_ReleaseEvent(string szEventName)
Releases an event previously locked through ICR_StealEvent() .
Parameter Description Values
szEventName Event name
None
See ICR_StealEvent .
ICR_SysProc(string szCommand, mixed arg1, mixed arg2)
Runs an internal procedure, arguments are command specific and vary in number and type.
Parameter Description Values
g_bLocked = false;
// Allow other scripts access to the events
ICR_ReleaseEvent("BeforeKeyPress");
ICR_ReleaseEvent("OnIButtonPressed");
ICR_ReleaseEvent("OnCardSwipe");
ICR_ReleaseEvent("OnBarcode");
}
}
ICR_ReleaseEvent
Parameters
Return values
Examples
ICR_SysProc
Parameters
szCommand Command to execute
PAYCODE - Prompt payment code
dialog
RENTAL - Force check of rental codes
UPDATE - Check for updates
OPENDRAWER - Trigger the specified
drawer
MINIMIZE - Minimise TouchPoint
EXIT - Exit to Windows
arg1 First argument
szType - UPDATE - Update code (i.e
2017)
nDrawerNumber - OPENDRAWER -
Drawer number
arg2 Second argument bSilent - UPDATE
None
Version Description
7600 Added MINIMIZE & EXIT
Return values
Examples
// Create relevant dialogs.
ICR_SysProc("PAYCODE");
ICR_SysProc("RENTAL");
// Fire a connected cash drawer.
ICR_SysProc("OPENDRAWER", 1);
ICR_SysProc("OPENDRAWER", 2);
// Check for update.
ICR_SysProc("UPDATE", "etallib", true);
// Minimise TouchPoint
ICR_SysProc("MINIMIZE");
// Exit to Windows.
ICR_SysProc("EXIT");
Changelog
ICR_RestartScriptingEngine()
Restarts the Etal engine that the script is running in.
None
None
ICR_RestartScriptingEngine() should only be used for development purposes and should not be
deployed into a live environment.
This may have unpredictable results on the stability of TouchPoint.
ICR_EnableConsole(boolean bEnabled)
Enables/disables the developer console window for debug output.
Parameter Description Values
bEnabled Enable/disable the debug window
None
ICR_RestartScriptingEngine
Parameters
Return values
Examples
// Restart the scripting engine.
ICR_RestartScriptingEngine();
Notes
ICR_EnableConsole
Parameters
Return values
Examples
ICR_EnableConsole() should only be used for development purposes and should not be deployed
into a live environment.
// Enable the developer console window.
ICR_EnableConsole(true);
Notes
ICRTouch Standard Library
ICR_GetUTCTimeBias(): integer
Gets the current offset between local and UTC time in minutes
None
Returns an integer value.
TouchPoint 7603+
ICR_LocalTimeToUTC(table tDate): table
Applies the current UTC offset to the supplied date table.
Parameter Description Values
tDate Date table
Date functions
ICR_GetUTCTimeBias
Parameters
Return values
Examples
local g_nUTCOffset = 0;
function OnInit()
{
g_nUTCOffset = ICR_GetUTCTimeBias();
}
ICR_LocalTimeToUTC
Parameters
Returns the date table modified to apply the UTC offset.
TouchPoint 7603+
ICR_LocalTimeFromUTC(table tDate): table
Removes the current UTC offset from the supplied date table.
Parameter Description Values
tDate Date table
Returns the date table modified to remove the UTC offset.
Return values
Examples
local tDate = date();
local tModifiedDate = ICR_LocalTimeToUTC(tDate);
// Input:
// {"year":2023,"month":4,"day":6,"hour":15,"min":2,"sec":15,"wday":1,"yday":309}
// Output:
// {"year":2023,"month":4,"day":6,"hour":14,"min":2,"sec":15,"wday":1,"yday":309}
ICR_LocalTimeFromUTC
Parameters
Return values
Examples
local tDate = date();
local tModifiedDate = ICR_LocalTimeFromUTC(tDate);
// Input:
// {"year":2023,"month":4,"day":6,"hour":15,"min":2,"sec":15,"wday":1,"yday":309}
// Output:
// {"year":2023,"month":4,"day":6,"hour":16,"min":2,"sec":15,"wday":1,"yday":309}
ICRTouch Standard Library
ICR_KeyPress(integer nFile, integer nRecord)
Simulates a key press and carries out its function.
Parameter Description Values
nFile File number
nRecord Record number
None
ICR_Sound(integer nSound)
Plays a TouchPoint sound.
Parameter Description Values
nSound Sound ID 0 - Keypress
1 - Error
None
Sales mode functions
ICR_KeyPress
Parameters
Return values
Examples
// Sell PLU 10
ICR_KeyPress(1, 10);
ICR_Sound
Parameters
Return values
ICR_GetInput(): string
Retrieves the contents of the input buffer.
None
Returns a string value representing the data currently set against the input buffer.
ICR_SetInput(string szInput)
Sets the contents of the input buffer.
Parameter Description Values
szInput Input data
None
Examples
ICR_Sound(1);
ICR_GetInput
Parameters
Return values
Examples
local szInput = ICR_GetInput();
ICR_SetInput
Parameters
Return values
Examples
ICR_SetInput("10.00");
ICR_SetInput_Message(string szLeftMessage, string szRightMessage = "")
Displays a message in the input window.
Parameter Description Values
szLeftMessage Left message
szRightMessage Right message
None
ICR_Error(integer nError)
Displays a TouchPoint error message in the input window.
ICR_SetInput_Message
Parameters
Return values
Examples
local g_bLockTill = true;
function BeforeKeyPress(nFile, nRecord, nKeyType)
{
if(g_bLockTill)
{
// We pressed a button while still sending a email.
// Display error to the user and return false.
ICR_SetInput_Message("Please wait Sending Email");
return false;
}
// TouchPoint not locked, return true.
return true;
}
ICR_Error
Parameter Description Values
nError Error number
None
ICR_GetClerkBuffer_Index(): table
Retrieves the current clerk's clerk buffer index. See Clerk buffer index.
None
Returns a table containing the clerk buffer index.
Parameters
Return values
Examples
function OnRunScriptKeyPress(nFile, nRecord, nNumber, nValue, nFlag)
{
if(!ICR_GetCurrentClerk())
{
// No clerk signed on, display "Sign On First" error in the input window and return.
ICR_Error(1);
return;
}
[...]
}
ICR_GetClerkBuffer_Index
Parameters
Return values
Examples
function BeforeKeyPress(nFile, nRecord, nKeyType)
{
Version Description
7200 Added DISPLAYNUMBER
7200
With the addition of DISPLAYNUMBER the CHECK / TABLE
fields should not be used to draw the number to the
screen. These should only be used for comparison or to
check to see if a table/check is open.
7200 Added WEIGHT
ICR_GetClerkBuffer_Item(integer nItem): table
Retrieves a clerk buffer item from the current clerk's clerk buffer. See Clerk buffer item.
Parameter Description Values
nItem Item number
if(nFile != 1)
{
// Not a PLU, continue.
return true;
}
// Get the clerk buffer index.
local tClerkBuffer = ICR_GetClerkBuffer_Index();
if(tClerkBuffer.CUSTOMER == 0)
{
// No customer signed on, disallow PLU sale.
return false;
}
return true;
}
Changelog
ICR_GetClerkBuffer_Item
Parameters
Return values
Returns a table containing the clerk buffer item data.
Version Description
7811 Added ITEMID
Examples
function BeforeKeyPress(nFile, nRecord, nKeyType)
{
// Refresh the sold PLUs array.
g_arrSoldPLUs.clear();
if(nFile != 51 || nKeyType != 7)
{
// Not a finalise or new balance key, return true.
return true;
}
// Get the clerk buffer.
local tClerkBuffer = ICR_GetClerkBuffer_Index();
// Iterate over each clerk buffer item.
for(local nItemCount = 1; nItemCount <= tClerkBuffer.REGPOS; nItemCount++)
{
// Get the clerk item.
local tClerkItem = ICR_GetClerkBuffer_Item(nItemCount);
if(tClerkItem.FILE != 1)
{
// Not a PLU, skip this item.
continue;
}
// Add the clerk item (PLU) to the sold PLUs array.
g_arrSoldPLUs.push(tClerkItem);
}
}
Changelog
TouchPoint 6800+
ICR_AddToClerkBuffer_Item(table tItemData)
Adds an item to the clerk buffer.
Follows the same table structure as a clerk buffer item.
Parameter Description Values
tItemData Clerk item data
None
ICR_SelectItem(integer nItem)
Selects an item in the reg window.
Parameter Description Values
nItem Item number
ICR_AddToClerkBuffer_Item
Parameters
Return values
Examples
local tItemData = {
NAME = "Some text",
PRICE = 0,
FILE = 100,
RECORD = 1
};
ICR_AddToClerkBuffer_Item(tItemData);
ICR_SelectItem
Parameters
None
ICR_GetCurrent3rdPartyCustomer(): table
Retrieves 3rd party customer information for the currently signed on customer.
None
Returns a table containing information pertaining to the currently signed on 3rd party customer.
ICR_SetEtalSaleFlag(integer nFlag)
Sets a miscellaneous flag against the clerk buffer.
Parameter Description Values
nFlag Flag value to be set
None
Return values
Examples
ICR_SelectItem(2);
ICR_GetCurrent3rdPartyCustomer
Parameters
Return values
Examples
local tCustomer = ICR_GetCurrent3rdPartyCustomer();
ICR_SetEtalSaleFlag
Parameters
Return values
Examples
TouchPoint 7811+
ICR_Get_CurrentSaleControlFlag(): integer
Gets the current value of the 'Current sale control flag'.
For control flag values see: Current sale control flag.
None
Return values
Returns an integer value representing the current value of the sale control flag.
TouchPoint 7811+
ICR_Set_CurrentSaleControlFlag(integer nFlagMask [, integer nMode = 0])
Makes a change to the 'Current sale control flag'. For control flag values see: Current sale control
flag.
Parameter Description Values
nFlagMask Mask of flag values to set
// Set misc Etal flag
ICR_SetEtalSaleFlag(0x0001);
ICR_Get_CurrentSaleControlFlag
Parameters
Examples
// Retrieve and output the current sale control flag
print("ICR_Get_CurrentSaleControlFlag() : " + ICR_Get_CurrentSaleControlFlag());
ICR_Set_CurrentSaleControlFlag
Parameters
Parameter Description Values
nMode Method of employing the flag mask.
0 - Overwrite the entire sale control
flag
1 - Set the bits that are set in the
mask
2 - Unset the bits that are SET in
the mask
None
Return values
Examples
function AfterKeyPress(nFile, nRecord, nKeytype)
{
print("ICR_Get_CurrentSaleControlFlag() : " + ICR_Get_CurrentSaleControlFlag());
if(nFile == 998)
{
// Disable reg buffer consolidation on / off
local nFlag = 0x01;
if(nRecord == 9)
{
print("Numeric 8 key pressed - Turn on");
ICR_Set_CurrentSaleControlFlag(nFlag, 1 /* Set */);
}
if(nRecord == 10)
{
print("Numeric 9 key pressed - Turn off");
ICR_Set_CurrentSaleControlFlag(nFlag, 2 /* Unset */);
}
print("ICR_Get_CurrentSaleControlFlag() : " +
ICR_Get_CurrentSaleControlFlag());
return;
}
}
ICRTouch Standard Library
ICR_GetStock(integer nPlu): float
Retrieves the stock quantity of the requested PLU.
Parameter Description Values
nPlu PLU record number
Returns a floating point value.
ICR_SetStock(integer nPlu, float fQty)
Sets the stock quantity of the PLU.
Parameter Description Values
nPlu PLU record number
fQty New stock quantity
None
Data functions
ICR_GetStock
Parameters
Return values
Examples
local nStockQuantity = ICR_GetStock(78);
ICR_SetStock
Parameters
Return values
ICR_GetCurrentClerk(): integer
Retrieves the currently signed on clerk number.
None
Returns an integer representing the clerk number.
This will return 0 if no clerk is signed on.
ICR_GetCurrentMode(): integer
Retrieves the current mode number.
See constant values for mode numbers.
Parameters
None
Return an integer representing the mode number.
Examples
ICR_SetStock(4, 15.0);
ICR_GetCurrentClerk
Parameters
Return values
Examples
local nClerk = ICR_GetCurrentClerk();
ICR_GetCurrentMode
Return values
Examples
ICR_GetCustomPLUData(integer nRecord): string
Retrieves the customer data set against a PLU.
Parameter Description Values
nRecord PLU record number
Returns the data string set against the PLU, or null if no data exists.
ICR_SetCustomPLUData(integer nRecord, string szData)
Sets a string of data for a PLU in the PLU Store.
Parameter Description Values
nRecord PLU record number
szData Data to set
None
local nMode = ICR_GetCurrentMode();
ICR_GetCustomPLUData
Parameters
Return values
Examples
local szPLUData = ICR_GetCustomPLUData(99);
ICR_SetCustomPLUData
Parameters
Return values
Examples
ICR_GetPGMData(integer nFile, integer nRecord): table
Retrieves a table containing program data for the specified file and record number.
Field names are as per the XML tag in the data layout manual.
Parameter Description Values
nFile File number
nRecord Record number
Returns a table of program data for the requested file/record combination.
ICR_SetPGMData(integer nFile, integer nRecord, table tData, boolean bUpload = false)
Sets program data for the specified file and record number using the supplied table, only field
entries in the supplied table are overwritten.
Field names are as per the XML tag in the data layout manual.
Parameter Description Values
ICR_SetCustomPLUData(5, "This is the data I am writing.");
ICR_GetPGMData
Parameters
Return values
Examples
// Get program data for PLU 5.
local tPlu = ICR_GetPGMData(1, 5);
// Get program data for clerk 10.
local tClerk = ICR_GetPGMData(5, 10);
ICR_SetPGMData
Parameters
nFile File number
nRecord Record number
tData Program data to set
bUpload Upload program changes to TOW
None
Uploading program changes to TOW will only work on single site accounts.
Version Description
7200 Added 4th parameter to facilitate the upload the modified
program data to TOW
ICR_GetSalesData(integer nFile, integer nRecord, integer nPeriod): table
Retrieves a table containing sales data for the specified file, record number and sales period (1 -
3).
Field names are as per the XML Tag in the data layout manual.
Return values
Examples
// Get the program data for clerk 1.
local tClerk = ICR_GetPGMData(5, 1);
// Edit the name to "Dave".
tClerk.NAME <- "Dave";
// Set the clerk table back to record 1, overwriting the previous data.
ICR_SetPGMData(5, 1, tClerk);
Notes
Changelog
ICR_GetSalesData
Parameters
Parameter Description Values
nFile File number
nRecord Record number
nPeriod Sales period (1 - 3)
Returns a table containing the sales data for the requested file, record and period.
ICR_GetSystemData(): table
Retrieves a table containing the system data.
See system data table values.
None
Returns a table containing the system data.
Return values
Examples
// Get the sales data for fixed totaliser 1.
local tNetSales = ICR_GetSalesData(50, 1, 1);
ICR_GetSystemData
Parameters
Return values
Examples
// Get the system data.
local tSystemData = ICR_GetSystemData();
// Print the version ID.
print(tSystemData.VERSIONID);
ICR_GetFileSize
ICR_GetFileSize(integer nFile): integer
Returns the size of a specified file.
Parameter Description Values
nFile File number
Returns an integer representing the file size of the requested file number.
ICR_GetLanguageText(integer nLanguageID): string
Retrieves the text for the specified language ID.
For language IDs, please refer to ICRTouch/skin/language.*, where "*" represents the active
language file extension.
Parameter Description Values
nLanguageID Language ID
Returns a language definition string for the requested language ID.
Parameters
Return values
Examples
// Get the PLU file size.
nPluFileSize = ICR_GetFileSize(1);
ICR_GetLanguageText
Parameters
Return values
Examples
// Get the language for ID 5827, "Author".
local szText = ICR_GetLanguageText(5827);
// Output "Author" to the console.
print(szText);
ICR_SetLanguageText(integer nLanguageID, string szText)
Sets the language text for the specified language ID.
Parameter Description Values
nLanguageID Language ID
szText New language definition
None
Language changes do not affect the underlying language.def file and so will not persist a reboot.
ICR_GetPLURecNumber(string szRandomCode): integer
Retrieves the record number of the first PLU found with a matching random code.
Parameter Description Values
szRandomCode Random code to search for
ICR_SetLanguageText
Parameters
Return values
Examples
// Set the definition for language ID 5827 to "Supplier".
ICR_SetLanguageText(5827, "Supplier");
Notes
ICR_GetPLURecNumber
Parameters
Return values
Returns the PLU record number of the found PLU.
If no matching random code is found, then 0 is returned.
TouchPoint 5800+
ICR_UpdateCheckIndexFile(boolean bForceUpdate): integer
Polls a copy of the check index file from the check master so that open check reports etc can be
run from it.
This function can be called on systems running as standalone or on masters and will be ignored.
The default functionality on the backup master is to ignore this function but can be overridden by
setting the optional boolean to true .
Parameter Description Values
bForceUpdate Force update boolean true - Force update
false - Don't force an update
Returns an integer representing the success of the command.
0 - OK
1 - User cancelled
2 - Error
Examples
// Try to get the PLU record number for our provided EAN8.
local nPLU = ICR_GetPLURecNumber("12345675");
ICR_UpdateCheckIndexFile
Parameters
Return values
Examples
// Attempt to update the check index file from the master.
local nResult = ICR_UpdateCheckIndexFile();
TouchPoint 5800+
ICR_ResetTotals(integer nFile, integer nPeriod)
Executes a Z reset of the specified file and sales period (1 - 3).
Parameter Description Values
nFile File number
nPeriod Sales period to reset (1 - 3)
None
ICR_AdjustTotals(integer nFile, integer nRecord, integer nPeriod, integer nQuantity, integer
nValue)
Executes a sales total adjustment for the specified file, record and sales period (1 - 3).
Parameter Description Values
nFile File number
nRecord Record number
nPeriod Sales period (1 - 3)
nQuantity Quantity
nValue Value
ICR_ResetTotals
Parameters
Return values
Examples
// Reset the fixed totaliser totals for sales period 2.
ICR_ResetTotals(50, 2);
ICR_AdjustTotals
Parameters
Return values
None
Only Etal fixed totalisers are valid.
These are contained in file 50 between record numbers 101 - 200.
Provided quantities and values must be integers.
ICR_AdjustCustomer(integer nCustomer, integer nBalance = 0, integer nPoints = 0): boolean
Adjusts a customer's points or balance.
Parameter Description Values
nCustomer Customer record number
nBalance Balance adjustment
nPoints Points adjustment
Returns true on success, false on failure.
Examples
// Adjust fixed total 101 by a quantity of 1 and value of 10.50.
ICR_AdjustTotals(50, 101, 1, 100, 1050);
Notes
ICR_AdjustCustomer
Parameters
Return values
Examples
// Increase customer 4's balance by 1.00.
local bResult = ICR_AdjustCustomer(4, 100);
// Increase customer 8's points by 50.
local bResult = ICR_AdjustCustomer(8, 0, 50);
Whilst you can adjust both balance and points at the same time it is not advisable to do so, if you
do and only one of them succeeds it will still return true.
ICR_FromPassword(string szPassword): string
Converts an ICRTouch password field back into a string of plain text.
Parameter Description Values
szPassword Password to convert
Returns the converted string of plain text from a ICRTouch password field.
ICR_ToPassword(string szPassword): string
Converts a string of plain text into an ICRTouch password field for storage.
// Reduce customer 20's balance by 5.00.
local bResult = ICR_AdjustCustomer(20, -500);
Notes
ICR_FromPassword
Parameters
Return values
Examples
// Get our stored password.
local szPasswordField = ICR_GetLocalUserdata("my_password");
// Convert the stored password back into plain text.
local szPassword = ICR_FromPassword(szPasswordField);
ICR_ToPassword
Parameters
Parameter Description Values
szPassword Password to convert
Returns the converted ICRTouch password string.
For security purposes, please refrain from storing sensitive data using this method.
It is not cryptographically secure.
ICR_MakeNumberString(integer nValue, integer nDP = 0, string szCurrencySymbol = "", boolean
bUseThousandSeparator = false, boolean bHideDP = false): string
Converts an integer to a string.
Parameter Description Values
nValue Value to convert
nDP Decimal places
szCurrencySymbol Currency Symbol
bUseThousandSeparator Use thousand separator true - Use thousand separator
false - No thousand separator
bHideDP Hide decimal value true - Truncate decimal value
false - Show full number
Returns the converted integer as a string based on the parameters provided.
Return values
Examples
// Convert "MyPassword" into an ICRTouch password for storage.
local szConvertedString = ICR_ToPassword("MyPassword");
Notes
ICR_MakeNumberString
Parameters
Return values
Examples
ICR_GetEmployeeLastTAOP(integer nClerk, integer nOperation): table
Retrieves a data table for the specified clerk and their last T&A operation details.
The method works from the most recent change to the employee job.
For example, nOperation = 0 would be the most recent operation.
Parameter Description Values
nClerk Clerk number
nOperation T&A operation
Returns a table containing details of the last clerk T&A details.
// Convert 10 into "0.10".
local szNumber = ICR_MakeNumberString(10, 2);
// Convert 1234 into "12.34".
local szNumber = ICR_MakeNumberString(1234, 2);
// Convert 500 into "£5.00".
local szNumber = ICR_MakeNumberString(500, 2, "£");
// Convert 76890123 into "768,901.23"
local szNumber = ICR_MakeNumberString(10, 2, "", true);
// Convert 76890100 into "768,901"
local szNumber = ICR_MakeNumberString(10, 2, "", true, true);
ICR_GetEmployeeLastTAOP
Parameters
Return values
Examples
// Get the current clerk.
local nClerk = ICR_GetCurrentClerk();
// Create a local table to store the operations.
TouchPoint 7407+
ICR_GetCheck_Index(string szCheckNumber, boolean bTable = false): table
Get the check index for a specified check/table number.
See check index table values.
Parameter Description Values
szCheckNumber Check/table number
bTable True if table, false if check
Returns a table of data for the requested check/table if it exists.
This will return null if no check/table exists for the requested number.
TouchPoint 7407+
ICR_GetCheckItem(string szCheckNumber, boolean bTable, integer nItemID): table
local tClerkOperations = {};
// Iterate from 1 - 5.
for(local nCount = 1; nCount <= 5; nCount++)
{
// Get and store the current clerk's last 5 most recent T&A operations.
tLastClerkOp[tLastClerkOp.len() + 1] <- ICR_GetEmployeeLastTAOp(nClerk, nCount);
}
ICR_GetCheck_Index
Parameters
Return values
Examples
// Get the check index for table 5.
local tTable = ICR_GetCheck_Index(5, true);
// Get the check index for check 74.
local tCheck = ICR_GetCheck_Index(74);
ICR_GetCheck_Item
Get the details of an item attached to a check/table number.
See check item table values.
Parameter Description Values
szCheckNumber Check/table number
bTable True if table, false if check
nItemID Item ID
Returns a table of data for the requested check item.
This will return null if no data exists at the record requested.
Parameters
Return values
Examples
// Get the check index.
local tCheckIndex = ICR_GetCheck_Index(szCheckNumber, false);
print("NUMBER : " + tCheckIndex.NUMBER);
print("DETAILLENGTH : " + tCheckIndex.DETAILLENGTH);
// Iterate over the check items and out some simple data.
for(local nDetailCount = 1; nDetailCount <= tCheckIndex.DETAILLENGTH; nDetailCount++)
{
// Get the check item info.
local tCheckItem = ICR_GetCheck_Item(szCheckNumber, bTable, nDetailCount);
print("FILE: " + tCheckItem.FILE + " RECORD: " + tCheckItem.RECORD + " -> " +
tCheckItem.NAME);
}
ICRTouch Standard Library
ICR_JournalItem(string szText, integer nPrice, integer nQuantity, integer nFile, integer
nRecord, integer nStatus)
Adds an item entry to the journal.
Parameter Description Values
szText Line text
nPrice Price
nQuantity Quantity
nFile File number
nRecord Record number
nStatus Status flag
None
ICR_JournalLine(string szText, integer nPrice, integer nQuantity, integer nFile, integer
nRecord, integer nStatus)
Adds a line entry to the journal.
Parameter Description Values
Printing functions
ICR_JournalItem
Parameters
Return values
Examples
ICR_JournalItem("Burger", 1020, 100, 1, 10, 0);
ICR_JournalLine
Parameters
szText Line text
nPrice Price
nQuantity Quantity
nFile File number
nRecord Record number
nStatus Status flag
None
ICR_ReceiptItem(string szText, integer nPrice, integer nQuantity, integer nFile, integer
nRecord, integer nStatus)
Adds an item entry to the current receipt buffer.
Parameter Description Values
szText Line text
nPrice Price
nQuantity Quantity
nFile File number
nRecord Record number
nStatus Status flag
None
Return values
Examples
ICR_JournalLine("Batch procedure complete", 0, 0, 53, 10, 0)
ICR_ReceiptItem
Parameters
Return values
Examples
ICR_ReceiptItem("Burger", 1020, 100, 1, 10, 0);
Version Description
7031 Prevented from use if there is no active sale
ICR_ReceiptLine(string szText, integer nPrice, integer nQuantity, integer nFile, integer
nRecord, integer nStatus)
Adds a line entry to the current receipt buffer.
Parameter Description Values
szText Line text
nPrice Price
nQuantity Quantity
nFile File number
nRecord Record number
nStatus Status flag
None
Version Description
7031 Prevented from use if there is no active sale
ICR_GetReceipt_Header(integer nClerk): table
Changelog
ICR_ReceiptLine
Parameters
Return values
Examples
ICR_ReceiptLine("Free bananas on Friday", 0, 0, 53, 10, 0);
Changelog
ICR_GetReceipt_Header
Retrieves the receipt header for the specified clerk.
Parameter Description Values
nClerk Clerk number
Returns a table containing receipt header data.
Version Description
7200 Added DISPLAYNUMBER
7200
With the addition of DISPLAYNUMBER the CHECK / TABLE
fields should not be used to draw the number to the
screen. These should only be used for comparison or to
check to see if a table/check is open.
ICR_GetReceiptLine(integer nClerk, integer nLine): table
Retrieves a receipt line for a specified clerk and line number.
Parameter Description Values
nClerk Clerk number
nLine Receipt line number
Returns a table containing receipt line data.
Parameters
Return values
Examples
local tReceiptHeader = ICR_GetReceipt_Header(5);
Changelog
ICR_GetReceipt_Line
Parameters
Return values
Examples
local tReceiptLine = ICR_GetReceipt_Line(2, 7);
ICRTouch Standard Library
TouchPoint 7604+
ICR_KPC_GetKPTicketList(integer nMaximumTickets, string szStatusFilter = "", integer nKPMask =
0x0FFF, string szSinceUpdateCounter = "0"): string
Retrieves a list of ticket IDs that have been sent to a kitchen printer or kitchen video.
Tickets can be filtered to the provided szStatusFilter or, if left blank, active/pegged tickets.
Parameter Description Values
nMaximumTickets Number of tickets to retrieve
szStatusFilter Ticket status filter
nKPMask KP filter mask
0x0001 - KP/KV1
0x0002 - KP/KV2
0x0004 - KP/KV3
0x0008 - KP/KV4
0x0010 - KP/KV5
0x0020 - KP/KV6
0x0040 - KP/KV7
0x0080 - KP/KV8
0x0100 - KP/KV9
0x0200 - KP/KV10
0x0400 - KP/KV11
0x0800 - KP/KV12
Note: 0x0000 - Is treated as 0xFFFF
Kitchen printer controller
functions
ICR_KPC_GetKPTicketList
Parameters
Parameter Description Values
szSinceUpdateCounter Return KP tickets only with updates
since the supplied update counter.
Defaults to "0" which will return all
KP Tickets, including those with an
update counter of "0".
All other values will return KP Tickets
with a higher update counter, eg "1"
will return those KP Tickets with a
counter of "2" or more.
This should be supplied as a string in
order to support values higher than
the maximum that a 32 bit integer
will allow.
Returns a JSON object described here: KPC_GetKPTicketList
Version Description
7803
Added 4th parameter szSinceUpdateCounter .
Returns KP tickets only with updates since the supplied
update counter.
TouchPoint 7604+
ICR_KPC_GetKPTickets(array arrTicketIDs, integer nKPConfigFlag = 0x0000, integer nKPMask =
0x0FFF, integer nSortType = 0): string
Return values
Examples
// Get the latest 100 active/pegged orders.
local tOrders = ICR_KPC_GetKPTicketList(100);
// Get the latest 100 finished orders.
local tOrders = ICR_KPC_GetKPTicketList(100, "finished");
// Get a maximum of 100 KP Tickets, for active orders / all KP Flags, Since update counter
"1001"
local tOrders = ICR_KPC_GetKPTicketList(100, "active", 0xFFF, "1001");
Changelog
ICR_KPC_GetKPTickets
Retrieves the order details for each ID provided in the array, arrTicketIDs .
Parameter Description Values
arrTicketIDs Array of ticket IDs
nKPConfigFlag KP config flag
0x00010000 - Consolidate items
0x00020000 - Consolidate different
items
0x00040000 - Consolidate different
set menu items
nKPMask KP filter mask
0x0001 - KP/KV1
0x0002 - KP/KV2
0x0004 - KP/KV3
0x0008 - KP/KV4
0x0010 - KP/KV5
0x0020 - KP/KV6
0x0040 - KP/KV7
0x0080 - KP/KV8
0x0100 - KP/KV9
0x0200 - KP/KV10
0x0400 - KP/KV11
0x0800 - KP/KV12
Note: 0x0000 - Is treated as 0xFFFF
nSortType Required item sorting for the output
0 - No sorting
1 - Department
2 - PLU Group
3 - KP Category
4 - Seat
Returns a JSON string containing the array of ticket detail tables.
Version Description
7605 Added index_entry header into the ticket body
7608 Added 4th parameter for ticket item sorting.
Parameters
Return values
Examples
local tOrderDetails = ICR_KPC_GetKPTickets([1,5,9], 0x00030000, 0x04);
Changelog
Version Description
7803 Added customer , clerk , price_level , terminal ,
location & eat_in_take_out .
7808 Added webshop_order_reference & tta_table_location
fields.
TouchPoint 7604+
ICR_KPC_SetKPTicketStatus(integer nID, string szNewStatus, integer nAppliesToKPFlag = 0xFFF):
string
Sets the provided status against a kp ticket.
Parameter Description Values
nID Ticket ID
szNewStatus Ticket status
nAppliesToKPFlag A flag mask of kp that that status
applies to for special statuses only.
Use for finished , unfinished ,
pegged and unpegged
Note: 0x0000 - Is treated as 0xFFFF
Returns a boolean value.
TouchPoint 7604+
ICR_KPC_SetKPTicketItemsStatus(integer nID, array arrItemNumber, string szNewStatus, integer
nAppliesToKPFlag = 0xFFF): string
ICR_KPC_SetKPTicketStatus
Parameters
Return values
Examples
local bResult = ICR_SetTicketStatus(5, "finished");
ICR_KPC_SetKPTicketItemsStatus
Sets the provided status against the item number of a ticket.
Parameter Description Values
nID Ticket ID
arrItemNumber Array of item numbers
szNewStatus Ticket item status
nAppliesToKPFlag A flag mask of kp that that status
applies to for special statuses only.
Use for finished and unfinished
Note: 0x0000 - Is treated as 0xFFFF
Returns a boolean value.
TouchPoint 7803+
ICR_KPC_AlterKPFlag(integer nTicketID, array arrItems, integer nUnsetKPFlag, integer nSetKPFlag,
integer nAppliesToKPFlag = 0x0000)
Alters the KP flag against a KP Ticket's items, enabling you to toggle them on or off. By making use
of the 'applies to' flag you have the ability to shift items from one KP to another. For example
Unset = 0x01, Set = 0x04, AppliesTo = 0x01 would then shift all items that are flagged for KP1 to
KP3.
Triggers the AfterKPCUpdate event with event type 4 .
Parameter Description Values
nTicketID Ticket ID
arrItems Array of item IDs
Parameters
Return values
Examples
local bResult = ICR_KPC_SetKPTicketItemsStatus(2, [1,4], "finished");
ICR_KPC_AlterKPFlag
Parameters
Parameter Description Values
nUnsetKPFlag Flag mask to unset
nSetKPFlag Flag mask to set
nAppliesToKPFlag Only applies to items that have this
specific mask
Default: 0x0000
Note: 0x0000 - Is treated as 0xFFFF
Returns a JSON string
TouchPoint 7604+
ICR_KPC_StoreData(string szReference, string szData) : boolean
Stores a key/value pair of data.
Parameter Description Values
szReference Key
szData Value
None
Return values
Examples
ICR_KPC_AlterKPFlag(602, [1,2,3,4,5,6,7], 0x01, 0x02, 0x01);
ICR_KPC_StoreData
Parameters
Return values
Examples
local tKPData = {
ID = 1,
NAME = "Starters"
};
local szKPData = JSONSerialise(tKPData);
TouchPoint 7604+
ICR_KPC_GetData(string szReference): string
Retrieves data for the specified reference.
Parameter Description Values
szReference Key
Returns a string value
ICR_KPC_StoreData("kp_settings", szKPData);
ICR_KPC_GetData
Parameters
Return values
Examples
local szKPData = ICR_KPC_GetData("kp_settings");
local tKPData = JSONDeserialise(szKPData);
ICRTouch Standard Library
ICR_PrintImage_Start(integer nWidth, integer nHeight)
Create a print image canvas.
Parameter Description Values
nWidth Image pixel width
nHeight Image pixel height
None
ICR_PrintImage_Print(integer nMC, integer nPort, boolean b180dpiMode = false)
Dispatches the print image canvas down to the printer.
Parameter Description Values
nMC Terminal ID ( 0 is self)
Graphic drawing functions
ICR_PrintImage_Start
Parameters
Return values
Examples
// Create the drawing canvas.
ICR_PrintImage_Start(512, 300)
ICR_PrintImage_Print
Parameters
Parameter Description Values
nPort Printer port
b180dpiMode Enforce 180dpi print mode
None
ICR_PrintImage_DrawBox(integer nLeft, integer nTop, integer nWidth, integer nHeight, integer
nColour)
Draws a filled box of the supplied dimensions and colour.
Parameter Description Values
nLeft Left position
nTop Top position
nWidth Box width
nHeight Box height
nColour Hex colour code
None
Return values
Examples
// Print the image.
ICR_PrintImage_Print(0, 1, true);
ICR_PrintImage_DrawBox
Parameters
Return values
Examples
// Draw a black box.
ICR_PrintImage_DrawBox(10, 10, 100, 100, 0x000000);
ICR_PrintImage_DrawFrame(integer nLeft, integer nTop, integer nWidth, integer nHeight, integer
nBorder, integer nColour)
Draws an empty box of the supplied dimensions and colour.
Parameter Description Values
nLeft Left position
nTop Top position
nWidth Box width
nHeight Box height
nBorder Border width
nColour Hex colour code
None
ICR_PrintImage_DrawFrame(integer nLeft, integer nTop, integer nColour)
Draws a pixel at the supplied coordinates and colour.
Parameter Description Values
nLeft Left position
ICR_PrintImage_DrawFrame
Parameters
Return values
Examples
// Draw a red frame.
ICR_PrintImage_DrawFrame(10, 10, 100, 100, 2, 0xFF0000);
ICR_PrintImage_DrawPixel
Parameters
Parameter Description Values
nTop Top position
nColour Hex colour code
None
ICR_PrintImage_DrawImage(integer nLeft, integer nTop, integer nWidth = null, integer nHeight =
null)
Draws the currently selected image at the specified coordinates.
Parameter Description Values
nLeft Left position
nTop Top position
nWidth Image width
nHeight Image height
None
Return values
Examples
// Draw a blue pixel
ICR_PrintImage_DrawPixel(10, 10, 0x0000FF);
ICR_PrintImage_DrawImage
Parameters
Return values
Examples
// Select the image to draw.
ICR_SelectImage(nImageID);
If height and width aren't supplied then the image's width and height are used.
ICR_PrintImage_DrawImage(integer nLeft, integer nTop, string szText)
Draws text to the print canvas.
Parameter Description Values
nLeft Left position
nTop Top position
szText Text to print
None
ICR_PrintImage_DrawQRCode(string szQRData, integer nLeft, integer nTop, integer nXScale = 1,
integer nYScale = 1)
Draws a QR code to the canvas.
// Draw the image to the canvas.
ICR_PrintImage_DrawImage(10, 10);
Notes
ICR_PrintImage_DrawText
Parameters
Return values
Examples
// Draw text to the canvas.
ICR_PrintImage_DrawText(10, 10, "Hello");
ICR_PrintImage_DrawQRCode
Parameters
Parameter Description Values
szQRData QR code data
nLeft Left position
nTop Top position
nXScale X scale
nYScale Y scale
None
ICR_PrintImage_GetQRWidth(string szQRData): integer
Returns the width & height, before scaling, of a QR code containing the data in szQRData.
Parameter Description Values
szQRData QR code data
Returns an integer representing the width & height of a QR code.
Return values
Examples
// Draw a QR code to the canvas containing a link to icrtouch.com.
ICR_PrintImage_DrawQRCode("https://icrtouch.com", 10, 10);
ICR_PrintImage_GetQRWidth
Parameters
Return values
Examples
// Get the width & height of the QR code data.
local nWidth = ICR_PrintImage_GetQRWidth("https://icrtouch.com");

ICRTouch Standard Library
Deprecated. See ICR_OutputLine .
ICR_OutputToDevice(string szOutputData, integer nMC, integer nPort)
Outputs raw data to a device.
Parameter Description Values
szOutputData Output data
nMC Machine number
nPort Port number
None
Device functions
ICR_OutputToDevice
Parameters
Return values
Examples
function PrintData(arrData)
{
// Set newline character to a variable and get DEVICE1 MC/Port.
local szNewLine = "\n";
local tDeviceConfig = ICR_GetPGMData(304, 1);
local nMC = tDeviceConfig.DEVICE1MC;
local nPort = tDeviceConfig.DEVICE1PORT;
// Iterate over and output our data.
foreach(idx, val in arrData)
{
ICR_OutputToDevice(val + szNewline, nMC, nPort);
}
TouchPoint 6800+
ICR_OutputLine(string szOutputData, integer nMC, integer nPort)
Outputs raw data to a device.
This method will automatically add a newline character to the end of the data, unlike
ICR_OutputToDevice .
Parameter Description Values
szOutputData Output data
nMC Machine number
nPort Port number
None
// Flush the buffer.
ICR_EndPrinting(nMC, nPort);
}
ICR_OutputLine
Parameters
Return values
Examples
function PrintData(arrData)
{
// Get DEVICE1 MC/Port.
local tDeviceConfig = ICR_GetPGMData(304, 1);
local nMC = tDeviceConfig.DEVICE1MC;
local nPort = tDeviceConfig.DEVICE1PORT;
// Iterate over and output our data.
foreach(idx, val in arrData)
{
ICR_OutputLine(val, nMC, nPort);
}
// Flush the buffer.
ICR_EndPrinting(nMC, nPort);
ICR_EndPrinting(integer nMC, integer nPort)
Finishes printing to the print, cuts ticket etc.
If used with an IP printer then this dispatches the data to the buffer of the device.
Parameter Description Values
nMC Machine number
nPort Port number
Return description
ICR_DeviceStatus(integer nMC, integer nPort): boolean
Returns the online status of the specified device.
Parameter Description Values
}
ICR_EndPrinting
Parameters
Return values
Examples
function PrintData(arrData)
{
// Get DEVICE1 MC/Port.
local tDeviceConfig = ICR_GetPGMData(304, 1);
local nMC = tDeviceConfig.DEVICE1MC;
local nPort = tDeviceConfig.DEVICE1PORT;
[...]
// Flush the buffer.
ICR_EndPrinting(nMC, nPort);
}
ICR_DeviceStatus
Parameters
nMC Machine number
nPort Port number
Returns a boolean value representing the device online status.
Return values
Examples
function CheckPrinterStatus(nMC, nPort)
{
local bOnline = false;
local nRetry = 1;
if(nPort == 10)
{
// No printer configured, return false.
return false;
}
if(nMC == 0)
{
// nMC = self, replace with the actual terminal ID.
local tSysConfig = ICR_GetPGMData(302,1);
nMC = tSysConfig.TERMINALID;
}
// Get the online status of the device.
bOnline = ICR_DeviceStatus(nMC, nPort);
while(!bOnline)
{
// Device offline, inform the user and ask if they want to try again.
nRetry = ICR_MessageBox(ICR_GetLanguageText(4125) ,"","",1);
if(!nRetry)
{
// No retry, simply break out.
break;
}
TouchPoint 8206+
ICR_OutputQRCode(table tQRCode)
Outputs a QC code to a connect printer.
Parameter Description Values
tQRCode Table containing the parameters for
QR code printing See: Output QR Code
// Get the online status of the device within this iteration.
bOnline = ICR_DeviceStatus(nMC, nPort);
}
// Return the status result.
return bOnline;
}
ICR_OutputQRCode
Parameters
Examples
function BeforePrint(nType, nFile, nRecord, nMC, nPort)
{
// Output to debug why the BeforePrint() event was called
print("TYPE: " + nType + " FILE: " + nFile + " RECORD: " + nRecord + " MC: " + nMC +"
PORT: " + nPort);
if(nFile == 51)
{
// File 51 - Finalise key being printed
// Create an object to put our QR config data into
local tQRCode = {};
// Add the data that we would like to output
tQRCode["data"] <- "This is the test from Etal !";
// The number of the terminal that the device is connected to - this was passed to us
in the Event
// Could be set to 0 to represent 'me'
tQRCode["machine"] <- nMC;
// The port number that the device is connected to
tQRCode["port"] <- nPort;
// We do not want to print in graphics mode
tQRCode["graphicsmode"] <- false;
// If the printing does end up in graphics mode then it needs to be high res
(thermal)
tQRCode["highresgraphics"] <- true;
// Set the model
tQRCode["model"] <- 1;
// Set the error correction level
tQRCode["eclevel"] <- 0;
// Set the size of a module
tQRCode["modulesize"] <- 4;
// Set the justification
tQRCode["hjustify"] <- "centre";
// Now call to output the code
ICR_OutputQRCode(tQRCode);
}
}
ICRTouch Standard Library
ICR_GetLocalUserData(string szName): mixed
Retrieves user data that is local to this script.
Parameter Description Values
szName Stored data key name
Returns the data in the format which it was stored.
ICR_SetLocalUserData(string szName, mixed Value, boolean bCreateOnly)
Stores user data that is local to this script file.
If bCreateOnly is set then if the value already exists it won't be overwritten.
Parameter Description Values
szName Data key name
Value Data value
bCreateOnly Create value
true - Create the value if it doesn't
exist
false - Create/overwrite value
User data functions
ICR_GetLocalUserData
Parameters
Return values
Examples
local szUserName = ICR_GetLocalUserData("szUsername");
ICR_SetLocalUserData
Parameters
None
ICR_GetGlobalUserData(string szName): mixed
Retrieves user data that is global to all scripts.
Parameter Description Values
szName Stored data key name
Returns the data in the format which it was stored.
ICR_SetGlobalUserData(string szName, mixed Value, boolean bCreateOnly)
Stores user data that is global to all scripts.
If bCreateOnly is set then if the value already exists it won't be overwritten.
Parameter Description Values
szName Data key name
Return values
Examples
local g_bDebugPrinting = true;
ICR_SetLocalUserData("bDebugPrinting", bDebugPrinting, true);
ICR_GetGlobalUserData
Parameters
Return values
Examples
local szUserName = ICR_GetGlobalUserData("szUsername");
ICR_SetGlobalUserData
Parameters
Parameter Description Values
Value Data value
bCreateOnly Create value
true - Create the value if it doesn't
exist
false - Create/overwrite value
None
Return values
Examples
local nCount = 156;
ICR_SetGlobalUserData("nDataCount", nCount, true);
ICRTouch Standard Library
ICR_AdvertiseProgramHeading(string szTitle)
Displays a heading in the script's programming menu.
Parameter Description Values
szTitle Text to display
None
ICR_AdvertiseProgramSetting(string szTitle, string szValueName)
Displays a value from local.userdata to be edited in the script's programming menu.
Program menu functions
ICR_AdvertiseProgramHeading
Parameters
Return values
Examples
function OnEnterPGMMenu(nSubMenu)
{
ICR_PurgeProgramSettings();
switch(nSubMenu)
{
case 0:
ICR_AdvertiseProgramHeading("My script | v1.2.3");
break;
}
}
ICR_AdvertiseProgramSetting
Parameter Description Values
szTitle Text to display
szValueName local.userdata key
Returns an integer representing the ID of the displayed setting.
This can be later used to manipulate the display/action of the data.
ICR_AdvertiseProgramSubMenu(string szTitle, integer nSubMenu)
Displays a link to a sub menu in the script's programming menu.
Parameter Description Values
szTitle Sub menu title
nSubMenu Sub menu ID
Parameters
Return values
Examples
function OnEnterPGMMenu(nSubMenu)
{
ICR_PurgeProgramSettings();
switch(nSubMenu)
{
case 0:
ICR_AdvertiseProgramHeading("My script | v1.2.3");
ICR_AdvertiseProgramSetting("Enable script?", "bScriptEnabled");
break;
}
}
ICR_AdvertiseProgramSubMenu
Parameters
Return values
None
ICR_PurgeProgramSettings()
Resets the data stored in the programmable list.
None
None
Examples
function OnEnterPGMMenu(nSubMenu)
{
ICR_PurgeProgramSettings();
switch(nSubMenu)
{
case 0:
ICR_AdvertiseProgramHeading("My script | v1.2.3");
ICR_AdvertiseProgramSubMenu("Flag settings", 5);
break;
case 5:
ICR_AdvertiseProgramHeading("Flag Menu");
break;
}
}
ICR_PurgeProgramSettings
Parameters
Return values
Examples
function OnEnterPGMMenu(nSub)
{
ICR_PurgeProgramSettings();
}
ICR_ProgramItem_SetReadOnly(integer nItemID)
Sets a program itme to be read only.
Parameter Description Values
nItemID Program item ID
None
ICR_ProgramItem_SetDP(integer nItemID, integer nDP)
Sets the decimal places on a numeric program item.
Parameter Description Values
ICR_ProgramItem_SetReadOnly
Parameters
Return values
Examples
function OnEnterPGMMenu(nSubMenu)
{
ICR_PurgeProgramSettings();
switch(nSubMenu)
{
case 0:
local nID = ICR_AdvertiseProgramSetting("Price", "nPrice");
ICR_ProgramItem_SetReadOnly(nID);
break;
}
}
ICR_ProgramItem_SetDP
Parameters
nItemID Program item ID
nDP Decimal places
None
ICR_ProgramItem_SetAltType(integer nItemID, integer nType)
Sets the program item to be an alternative type.
Parameter Description Values
nItemID Program item ID
nType Alternative value type ID
None
Return values
Examples
function OnEnterPGMMenu(nSubMenu)
{
ICR_PurgeProgramSettings();
switch(nSubMenu)
{
case 0:
local nID = ICR_AdvertiseProgramSetting("Price", "nPrice");
ICR_ProgramItem_SetDP(nID, 2);
break;
}
}
ICR_ProgramItem_SetAltType
Parameters
Return values
Examples
A list of alternative value types can be found in constant values.
ICR_ProgramItem_SetOptionList(integer nItemID, integer nListID [, integer nStartValue])
Sets a program entry as being a drop down option list.
Only applies to numeric items. Optional
Parameter Description Values
nItemID Program item ID
nListID Option list ID
nStartValue Option list starting value Start Value of 0 or 1 for the dialog.
None
function OnEnterPGMMenu(nSubMenu)
{
ICR_PurgeProgramSettings();
switch(nSubMenu)
{
case 0:
local nID = ICR_AdvertiseProgramSetting("Start Time", "nTime");
ICR_ProgramItem_SetAltType(nID, 20);
break;
}
}
Notes
ICR_ProgramItem_SetOptionList
Parameters
Return values
Examples
function OnEnterPGMMenu(nSubMenu)
{
ICR_PurgeProgramSettings();
ICR_PurgeProgramOptionList()
Resets the current list of items in the program option list.
None
None
ICR_ProgramOptionList_Add(string szText, integer nVal)
Adds an item to the current program option list.
Parameter Description Values
switch(nSubMenu)
{
case 0:
local nID = ICR_AdvertiseProgramSetting("Animal", "nAnimal");
ICR_ProgramItem_SetOptionList(nID, 2, 1);
break;
}
}
ICR_PurgeProgramOptionList
Parameters
Return values
Examples
function OnEnterPGMOptionList(nListID)
{
ICR_PurgeProgramOptionList();
}
ICR_ProgramOptionList_Add
Parameters
szText List item text
nValue List item selection index
None
Return values
Examples
function OnEnterPGMOptionList(nListID)
{
ICR_PurgeProgramOptionList();
switch(nListID)
{
case 1:
ICR_ProgramOptionList_Add("Puppy", 1);
ICR_ProgramOptionList_Add("Chihuahua", 2);
ICR_ProgramOptionList_Add("Monster", 3);
break;
}
}
ICRTouch Standard Library
Deprecated.
See ICR_SetNextDialogInput .
ICR_SendToKeyboard(string szKBData)
Sends a string of characters to the keyboard buffer.
Parameter Description Values
szKBData Keyboard data
None
ICR_StartTimer(integer nTimeout): integer
Starts a timer that triggers the OnTimer event every time the set timeout elapses.
The timer is called repeatedly until ICR_StopTimer is called.
Parameter Description Values
nTimeout Timeout in milliseconds
System functions
ICR_SendToKeyboard
Parameters
Return values
Examples
ICR_SendToKeyboard("12345\r");
ICR_StartTimer
Parameters
Returns an integer value representing the timer ID.
ICR_STopTimer(integer nTimerID)
Stops a specified timer.
Parameter Description Values
nTimerID Timer to stop
None
Return values
Examples
local g_nTimerID = 0;
function OnInit()
{
// Start a 500ms timer.
g_nTimerID = ICR_StartTimer(500);
}
ICR_StopTimer
Parameters
Return values
Examples
local g_nTimerID = 0;
function OnInit()
{
// Start a 500ms timer.
g_nTimerID = ICR_StartTimer(500);
}
function OnTimer(nTimerID, nSystemTime)
ICR_AwaitFile(string szFilePath, integer nTimeout, integer nEventID)
Tells TouchPoint to await the presence of a specified file.
Triggers OnAwaitFile if the file is found or nTimeout expires.
Parameter Description Values
szFilePath File path
nTimeout Timeout in seconds
nEventID User specified event ID
None
{
if(nTimerID == g_nTimerID)
{
// The elapsed timer is the one we want.
TimerHandler();
}
}
function TimerHandler()
{
// Stop the timer and reset the stored ID.
ICR_StopTimer(g_nTimerID);
g_nTimerID = null;
}
ICR_AwaitFile
Parameters
Return values
Examples
function OnInit()
{
// Find the file.txt file.
ICR_AwaitFile("Etal\\file.txt", 5, 1);
TouchPoint 5800+
ICR_ProgramSendFile(integer nFile, integer nTerminalID)
Makes ICRTouch send program data to another terminal on the network.
Parameter Description Values
nFile File number
Specify file number or:
0 - Prompt for file
999 - All program files
9990 - Auto broadcastable files
nTerminalID Terminal ID
Specify terminal ID or:
0 - Prompt for terminal
999 - All terminals
Return values
None
}
function OnAwaitFile(szFileName, nEventID, bExpired)
{
if(bExpired)
{
// File not found.
FileNotFoundHandler(szFileName, nEventID);
return;
}
// File found.
FileFoundHandler(szFileName, nEventID);
}
ICR_ProgramSendFile
Parameters
Examples
TouchPoint 5800+
ICR_ProgramReceiveFile(integer nFile, integer nTerminalID)
Makes ICRTouch receive program data from another terminal on the network.
Parameter Description Values
nFile File number
Specify file number or:
0 - Prompt for file
999 - All program files
9990 - Auto broadcastable files
nTerminalID Terminal ID
Specify terminal ID or:
0 - Prompt for terminal
999 - All terminals
None
TouchPoint 5800+
ICR_PlayMacro(string szFileName): boolean
Plays a recorded macro.
Macros can be recorded by pressing CTRL-M at any time to start the recorder and again to stop it
ICR_ProgramSendFile(1, 999);
ICR_ProgramReceiveFile
Parameters
Return values
Examples
ICR_ProgramReceiveFile(1, 1);
ICR_PlayMacro
Parameters
Parameter Description Values
szFileName Macro filename
Returns true if the macro player was started or false if the system is already playing a macro.
ICR_PostCodeLookup(string szPostcode = "", string szHouseNumber = ""): table
Triggers a postcode lookup based on the supplied postcode and house number.
If the function is called without its optional parameters then TouchPoint launches its built in
postcode lookup dialog.
Parameter Description Values
szPostCode Postcode
szHouseNumber House name or number
Returns a table of address data
Return values
Examples
local bResult = ICR_PlayMacro("macro.txt");
ICR_PostCodeLookup
Parameters
Return values
Examples
local tResult = ICR_PostCodeLookUp();
if(tResult.RESULT)
{
print(tResult.LINE1);
print(tResult.LINE2);
print(tResult.POSTTOWN);
print(tResult.COUNTY);
print(tResult.POSCODE);
ICR_File_OpenPipe(string szCommand, boolean bSetLocalDirToScript = false)
Loads a console application.
Triggers OnFile_ReadPipeEvent reading the data from stdOut.
Parameter Description Values
szCommand Console command
bSetLocalDirToScript Sets local directory to script directory
true - Local directory is script
directory
false - Local directory is ICRTouch
Return an integer number representing the ID number of the request.
}
else
{
print("Failed :(");
}
ICR_File_OpenPipe
Parameters
Return values
Examples
local g_arrFileList = [];
function OnRunScriptKeyPress(nFile, nRecord, nNumber, nValue, nFlag)
{
if(nNumber == g_nRunScriptKey)
{
// Get a list of files in the script directory.
g_nPipeID = ICR_File_OpenPipe("C:\\WINDOWS\\system32\\cmd.exe /C dir "+
tSystemData.SCRIPTLOCATION + " /b");
}
}
function OnFile_ReadPipeResult(nID, szData)
Version Description
7401
Support added for upto 10 concurrent pipes.
Added 2nd optional parameter to set local directory to
script directory.
TouchPoint 7400+
ICR_File_WritePipe(integer nID, string szMessage)
Allows data to be written back to an open pipe.
Parameter Description Values
nID Pipe ID
szMessage Message to write to the pipe
None
{
// Clear any residual data.
g_arrFileList.clear();
// Split the data on new line and store.
g_arrFileList = split(szData, "\r\n");
}
Changelog
ICR_File_WritePipe
Parameters
Return values
Examples
function OnFile_ReadPipeResult(nID, szData)
{
// Print out the pipe data.
print("OnFile_ReadPipeResult() -> ID: " + nID + " DATA: " + szData);
TouchPoint 7200+
ICR_PlaySound(string szFilePath)
Play a sound from a specified *.wave file
Parameter Description Values
szFilePath File path
None
TouchPoint 7200+
ICR_ShellExecute(table tParams)
// Write message back to the client
ICR_File_WritePipe(nID, "I RECEIVED -> " + szData);
}
ICR_PlaySound
Parameters
Return values
Examples
// Play sound from relative directory path.
ICR_PlaySound("Error_34.wav");
// Play sound from relative parent directory path.
ICR_PlaySound("..\\..\\Sounds\\DrawerAlarm.wav");
// Play sound from absolute directory path.
ICR_PlaySound("c:\\ICRTouch\\Sounds\\DrawerAlarm.wav");
ICR_ShellExecute
Execute shell commands against files.
For more information see Microsoft Docs.
Parameter Description Values
tParams Shell data
The table is comprised of various compulsory key value pairs used to execute the command
Parameter Description Values
VERB Operation to be completed
open - Opens the specified file
edit - Opens the specified file for
editing, this must be a document files
(i.e .txt)
explore - Opens a specified
directory in windows explorer.
find - Opens a specified directory
for searching in windows explorer.
print - Prints the specified file. This
must be a document file (i.e .txt)
runas - Runs the file/application as
an administrator. Depending on
settings you may be faced with UAC
prompts.
FILE Requested file/application to be
opened
DIR Working directory
PARM
The file to be opened if FILE is an
application.
If FILE is a document, this should be
empty.
Parameters
Parameter Description Values
SHOW Specifies how a window should be
displayed
0 - Hides the window.
1 - Displays the window in its
default state, size and position.
2 - Displays the window minimised.
3 - Displays the window maximised.
4 - Displays the window in its most
recent state, size and position.
5 - Displays the window in its
current state, size and position.
6 - Minimises the specified window
and shows the next window from the
top level.
7 - Displays the window minimised,
but not the active window.
8 - Displays the window in its
current state, but not the active
window.
9 - Restores an open window from a
minimised state.
10 - Default - The defined
applications default state. This is
defined by the called application.
Returns true on success, false on failure.
Return values
Examples
// Open C:\ICRTouch\Etal\icrtouch.moc to allow editing/reading in notepad.exe in it's current
size/position.
local tShellExecute = {
VERB = "open",
FILE = "notepad.exe",
DIR = "C:\\ICRTouch\\Etal",
PARM = "icrtouch.moc",
SHOW = 5
};
ICR_ShellExecute(tShellExecute);
// Open C:\ICRTouch\Etal\block.png for editing in the default image application.
local tShellExecute = {
VERB = "edit",
FILE = "block.png",
DIR = "C:\\ICRTouch\\Etal",
TouchPoint 8000+
ICR_GetHealthCheck(): string
Retrieves a JSON string containing health check data about the terminal.
PARM = "",
SHOW = 5
};
ICR_ShellExecute(tShellExecute);
// Open C:\ICRTouch in windows explorer.
local tShellExecute = {
VERB = "explore",
FILE = "",
DIR = "C:\\ICRTouch",
PARM = "",
SHOW = 5
};
ICR_ShellExecute(tShellExecute);
// Run the SagePay.exe application as an administrator in its default state.
// UAC prompts may show depending on settings.
local tShellExecute = {
VERB = "runas",
FILE = "SagePay.exe",
DIR = "C:\\ICRTouch\\SagePay\\",
PARM = "",
SHOW = 10
};
ICR_ShellExecute(tShellExecute);
ICR_GetHealthCheck
Parameters
Parameter Description Values
Returns a string value containing the health check data in JSON format. See Health Check Data
Fields.
Return value
Example
local szHealthCheckData = ICR_GetHealthCheck();
print(szHealthCheckData);
ICRTouch Standard Library
ICR_SalesModeWindow_Add(string szXMLFilePath, boolean bValidInHomeMode = false): integer
Creates a sales mode script window.
Setting bValidInHomeMode to true allows the window to be shown on the home mode screen.
Parameter Description Values
szXMLFilePath File path
bValidInHomeMode Allow window on home mode true - Allow on home mode
false - Disallow on home mode
Returns an integer value representing the newly created window ID.
ICR_2ndDisplayWindow_Add(string szXMLFilePath): integer
Creates a script window on the 2nd display.
Parameter Description Values
szXMLFilePath File path
Display functions
ICR_SalesModeWindow_Add
Parameters
Return values
Examples
local nWindowID = ICR_SalesModeWindow_Add("window.xml");
ICR_2ndDisplayWindow_Add
Parameters
Returns an integer value representing the newly created window ID.
ICR_Window_Enable(integer nWindowID, boolean bEnable)
Enables or disables a specified script window.
Parameter Description Values
nWindowID Window ID
bEnable Enable/disable window true - Enable window
false - Disable window
None
ICR_GetWindowDimensions(integer nWindowID): table
Gets the size of the specified script window.
Return values
Examples
local nWindowID = ICR_2ndDisplayWindow_Add("window.xml");
ICR_Window_Enable
Parameters
Return values
Examples
local nSalesWindowID = ICR_SalesModeWindow_Add("window.xml", false);
ICR_Window_Enable(nSalesWindowID, true);
ICR_GetWindowDimensions
Parameters
Parameter Description Values
nWindowID Window ID
Returns a table containing the window dimensions.
ICR_RedrawScreen()
Forces a screen repaint.
None
None
Version Description
7601 Any open dialogs are undrawn when ICR_RedrawScreen()
is called.
Return values
Examples
local nSalesWindowID = ICR_SalesModeWindow_Add("window.xml", false);
ICR_GetWindowDimensions(nSalesWindowID);
ICR_RedrawScreen
Parameters
Return values
Examples
ICR_RedrawScreen();
Changelog
ICR_RedrawWindow
ICR_RedrawWindow(integer nWindowID, integer nSubWindowID = null)
Instructs TouchPoint to redraw the specified sales mode window.
Parameter Description Values
nWindowID Sales mode window ID
0 - Clerk name
1 - Date
2 - Time
3 - Mode
4 - Price level
5 - Check number
6 - Device status 1
7 - Device status 2
8 - Device status 3
9 - Device status 4
10 - Device status 5
11 - Device status 6
12 - Device block 1
13 - Device block 2
14 - Device block 3
15 - Device block 4
16 - Device block 5
17 - Device block 6
18 - Subtotal
19 - Item count
20 - Picture
21 - Etal script
nSubWindowID Sub window ID
None
ICR_InvalidateCachedLevel(integer nMenuLevel = null)
Invalidates a menu level in the level cache.
If the level parameter is omitted, then all levels are invalidated.
Parameters
Return values
Examples
ICR_RedrawWindow(5);
ICR_RedrawWindow(21, 4);
ICR_InvalidateCachedLevel
Parameter Description Values
nMenuLevel Menu level
None
ICR_CreateFont(string szFontFace, integer nFontSize, boolean bBold = false, boolean bItalic =
false, boolean bUnderline = false): integer
Creates a new font that can be used for drawing to scripted windows.
Parameter Description Values
szFontFace Font face
nFontSize Font size in pixels
bBold Embolden text
bItalic Italicise text
bUnderline Underline text
Returns an integer value representing the newly created font ID.
Parameters
Return values
Examples
ICR_InvalidateCachedLevel(10);
ICR_CreateFont
Parameters
Return values
Examples
Version Description
7609 Performance enhancements
ICR_SelectFont(integer nNewFontID): integer
Selects the specified font ID as returned from ICR_CreateFont for following text drawing operations.
Parameter Description Values
nNewFontID Font ID
Returns an integer value representing the previously selected font ID.
ICR_SetText_Colour(integer nColour)
Set the text colour.
Parameter Description Values
local nHeaderFontID = ICR_CreateFont("Arial", 32, true, false, true);
local nBodyFontID = ICR_CreateFont("Arial", 16);
Changelog
ICR_SelectFont
Parameters
Return values
Examples
local nPreviousFont = ICR_SelectFont(nBodyFont);
ICR_SelectText_Colour
Parameters
nColour Hex colour code
None
Version Description
7609 Performance enhancements
ICR_SetText_HAlign(integer nAlignment): integer
Sets the horizontal alignment for the current font when using ICR_DrawText .
Parameter Description Values
nAlignment Alignment
0 - Left
1 - Centre
2 - Right
Returns an integer value representing the previous horizontal alignment.
Return values
Examples
// Set the font colour to white.
ICR_SetText_Colour(0xFFFFFF);
// Set the font colour to red.
ICR_SetText_Colour(0xFF0000);
// Set the font colour to blue.
ICR_SetText_Colour(0x0000FF);
Changelog
ICR_SetText_HAlign
Parameters
Return values
Examples
Version Description
7609 Performance enhancements
ICR_SetText_VAlign(integer nAlignment): integer
Sets the vertical alignment for the current font when using ICR_DrawText .
Parameter Description Values
nAlignment Alignment
0 - Top
1 - Centre
2 - Bottom
Returns an integer value representing the previous vertical alignment.
ICR_GetText_Width(string szText): integer
Retrieves the height of the supplied text string using the currently selected font.
Parameter Description Values
local nPreviousAlignment = ICR_SetText_HAlign(2);
Changelog
ICR_SetText_VAlign
Parameters
Return values
Examples
local nPreviousAlignment = ICR_SetText_VAlign(1);
ICR_GetText_Width
Parameters
szText Text string
Returns an integer value representing the text width in pixels.
ICR_GetText_Height(string szText): integer
Retrieves the height of the supplied text string using the currently selected font.
Parameter Description Values
szText Text string
Returns an integer value representing the text height in pixels.
ICR_LoadImage(string szFilePath): integer
Loads an image that can be used for drawing to scripted windows.
Parameter Description Values
Return values
Examples
local nTextWidth = ICR_GetText_Width("Text String");
ICR_GetText_Height
Parameters
Return values
Examples
local nTextHeight = ICR_GetText_Height("Text String");
ICR_LoadImage
Parameters
szFilePath Image file path
Returns an integer value containing the newly created image ID.
Version Description
6650 Added support for absolute filepaths.
ICR_UnloadImage(integer nImageID)
Unload an image from memory.
Parameter Description Values
nImageID Image ID to unload
None
Return values
Examples
local nImageID = ICR_LoadImage("Etal\\display\\first_image.png");
Changelog
ICR_UnloadImage
Parameters
Return values
Examples
// Load in an image.
local nImageID = ICR_LoadImage("Etal\\display\\first_image.png");
// Select the image to manipulate.
ICR_SelectImage(nImageID);
// Unload the image.
ICR_UnloadImage(nImageID);
ICR_GetImageSize(integer nImageID): table
Gets the size of the selected image.
Parameter Description Values
nImageID Selected image ID
Returns a table containing the image dimensions.
ICR_SelectImage(integer nNewImageID): integer
Selects the specified image ID as returns from ICR_LoadImage for following display operations.
Parameter Description Values
nNewImageID Selected image ID
Returns an integer value containing the previously selected image ID.
ICR_GetImageSize
Parameters
Return values
Examples
local nImageID = ICR_LoadImage("Etal\\display\\first_image.png");
local tDimensions = ICR_GetImageSize(nImageID);
ICR_SelectImage
Parameters
Return values
Examples
ICR_Image_SetTransparent(integer nColour32)
Sets the transparent colour on the currently selected image hexadecimal.
Parameter Description Values
nColour32 Transparent colour
None
ICR_AttachWindow(integer nWindowID, string szWindowCaption, integer nOptions)
Attaches the contents of a windows application to an Etal window.
This is an experimental method.
Parameter Description Values
nWindowID Etal window ID
szWindowCaption Caption of the attached window
local nImage1ID = ICR_LoadImage("Etal\\display\\first_image.png");
local nImage2ID = ICR_LoadImage("Etal\\display\\second_image.png");
local nOldImageID = ICR_SelectImage(nImage2ID);
ICR_Image_SetTransparent
Parameters
Return values
Examples
ICR_Image_SetTransparent(0xFFFF00);
ICR_AttachWindow
Parameters
Parameter Description Values
nOptions Flag options 0x00000001 - Scale to fit window
None
Return values
Examples
// ID of the window that we'll be using to attach to Notepad.
local g_nNotepadWindowID = 0;
function AttachNotepadWindow()
{
// Add a template window (see window.xml for more detail).
g_nNotepadWindowID = ICR_SalesModeWindow_Add("window.xml");
// Enable a copy of the window we are going to use the window later.
ICR_Window_Enable(g_nNotepadWindowID, true);
// Attached the Notepad window, ensure scaling.
ICR_AttachWindow(g_nNotepadWindowID, "Notepad", 0x0001);
}
ICRTouch Standard Library
ICR_DrawBox(integer nLeft, integer nTop, integer nWidth, integer nHeight, integer nColour32)
Draw a box with the specified position with the supplied dimensions and colour.
Parameter Description Values
nLeft Left offset in pixels
nTop top offset in pixels
nWidth Box width
nHeight Box height
nColour32 Fill colour
None
Version Description
7609 Performance enhancements
Drawing functions
ICR_DrawBox
Parameters
Return values
Examples
function OnWindowPaint(nWindowID)
{
// Draw a blue box.
ICR_DrawBox(10, 10, 100, 100, 0x0000FF);
}
Changelog
ICR_DrawFrame(integer nLeft, integer nTop, integer nWidth, integer nHeight, integer nFrameWidth,
integer nColour32)
Draw an empty box at the specified position with the supplied dimensions and colour.
Parameter Description Values
nLeft Left offset in pixels
nTop Top offset in pixels
nWidth Box width
nHeight Box height
nFrameWidth Frame width
nColour32 Fill colour
None
Version Description
7609 Performance enhancements
ICR_DrawPixel(integer nLeft, integer nTop, integer nColour32)
ICR_DrawFrame
Parameters
Return values
Examples
function OnWindowPaint(nWindowID)
{
// Draw a red frame.
ICR_DrawFrame(10, 10, 100, 100, 3, 0xFF0000);
}
Changelog
ICR_DrawPixel
Draws a pixel at the specified position in the supplied colour.
Parameter Description Values
nLeft Left offset in pixels
nTop Top offset in pixels
nColour32 Fill colour
None
Version Description
7609 Performance enhancements
ICR_SetTextClip(integer nLeft, integer nTop, integer nRight, integer nBottom)
Sets a clip on the text for subsequent ICR_DrawText functions for the current OnWindowPaint event.
Parameter Description Values
nLeft Left offset
nTop Top offset
nRight Right offset
Parameters
Return values
Examples
function OnWindowPaint(nWindowID)
{
// Draw a magenta pixel.
ICR_DrawPixel(50, 75, 0xFFFF00);
}
Changelog
ICR_SetTextClip
Parameters
Parameter Description Values
nBottom Bottom offset
None
ICR_DrawImage(integer nLeft, integer nTop, integer nWidth = null, integer nHeight = null)
Draws the currently selected image at the specified position.
If nWidth & nHeight aren't supplied, the image's width & height are used.
Parameter Description Values
nLeft Left offset
nTop Top offset
nWidth Image width
nHeight Image height
None
Return values
Examples
function OnWindowPaint(nWindowID)
{
// Set a drawable area for text.
ICR_SetTextClip(10, 10, 510, 510);
// This text will be visible.
ICR_DrawText(20, 100, "Test text");
// This text will NOT be visible.
ICR_DrawText(520, 100, "Test text");
}
ICR_DrawImage
Parameters
Return values
Version Description
7412 Fixed drawn artifacts
ICR_DrawText(integer nLeft, integer nTop, string szText)
Draws the supplied string to the specified position.
Parameter Description Values
nLeft Left offset
nTop Top offset
szText Text
None
Examples
local g_nImageID = 0;
function OnInit()
{
// Load an image.
g_nImageID = ICR_LoadImage("Etal\\Images\\image.png");
}
function OnWindowPaint(nWindowID)
{
// Select and draw the image.
ICR_SelectImage(g_nImageID);
ICR_DrawImage(10, 10, 640, 480);
}
Changelog
ICR_DrawText
Parameters
Return values
Version Description
7609 Performance enhancements
ICR_DrawPie(integer nLeft, integer nTop, integer nWidth, integer nHeight, integer nX1, integer
nY1, integer nX2, integer nY2, integer nBorderColour, integer nFillColour)
Draws a pie segment anticlockwise from nX1 , nY1 to nX2 , nY2 within the area specified by the
position/dimensions.
Parameter Description Values
nLeft Left offset
nTop Top offset
Examples
local g_nFontID = 0;
function OnInit()
{
// Create a font for text drawing.
g_nFontID = ICR_CreateFont("Arial", 16);
}
function OnWindowPaint(nWindowID)
{
// Select the font and draw the text.
ICR_SelectFont(g_nFontID);
ICR_DrawText(10, 10, "Text to draw");
}
Changelog
ICR_DrawPie
Parameters
Parameter Description Values
nWidth Width
nHeight Height
nX1 Segment start X
nY1 Segment start Y
nX2 Segment end X
nY2 Segment end Y
nBorderColour32 Border colour
nFillColour32 Fill colour
None
Return values
Examples
// Draw a pie chart, tSegmentSizes is a table of sizes as integer percentages.
// tColours is a table/array of 24 bit colour values, [0] contains the border colour, [1]...
contains colours to use for pie segments
local tColours = {
[0]=0xFFFFFF,
[1]=0xFF0000,
[2]=0x00FF00,
[3]=0x0000FF,
[4]=0xFFFF00,
[5]=0xFF00FF
};
local g_nColour = 0;
// PI / 50, the number of radians in 1% of a circle, so we can put the segment sizes in %
const c_ANGLESTEP = 0.06283185;
function DrawPie(tSegmentSizes, nLeft, nTop, nRadius)
ICR_FloodFill(integer nX, integer nY, integer nColour32)
Flood fills outwards from the specified nX & nY positions with colour.
~600 times faster than doing it via ICR_DrawPixel .
{
// where are we drawing from?
local nOriginX = nRadius + nLeft;
local nOriginY = nRadius + nTop;
local nWidth = nRadius * 2;
local nHeight = nRadius * 2;
local fAngle = 0.0;
// Iterate over each of the segments.
for(local nSegmentNumber = 0; nSegmentNumber < tSegmentSizes.len(); nSegmentNumber++)
{
// For this segment
// Set the colour
g_nColour = tColours[(nSegmentNumber + 1) % tColours.len()];
// Calculate the start of the segment.
local nY1 = floor(sin(fAngle) * nRadius).tointeger();
local nX1 = floor(cos(fAngle) * nRadius).tointeger();
// Calculate the end of the segment.
// - because we're drawing anticlockwise.
fAngle = fAngle - (c_ANGLESTEP * tSegmentSizes[nSegmentNumber]);
local nY2 = floor(sin(fAngle) * nRadius).tointeger();
local nX2 = floor(cos(fAngle) * nRadius).tointeger();
// Get TouchPoint to draw the pie segment.
ICR_DrawPie(nLeft, nTop, nWidth, nHeight, nOriginX + nX1, nOriginY + nY1, nOriginX +
nX2, nOriginY + nY2, tColours[0], g_nColour);
}
}
ICR_FloodFill
Parameter Description Values
nX X position
nY Y position
nColour32 Fill colour
None
ICR_GetPixel(integer nX, integer, nY): integer
Parameters
Return values
Examples
function OnWindowPaint(nWindowID)
{
if(nWindowID == g_nWindowID)
{
// Draw our window.
DrawWindow();
}
}
function DrawWindow()
{
// Store the frame width so we know where the inside of the box is.
local nFrameWidth = 5;
// Draw an empty red frame.
ICR_DrawFrame(100, 100, 200, 200, nFrameWidth, 0XFF0000);
// Fill the inside of the frame with green.
ICR_FloodFill(100 + nFrameWidth, 100 + nFrameWidth, 0x00FF00);
}
ICR_GetPixel
Gets the colour of the pixel at the designated coordinates.
Parameter Description Values
nX X position
nY Y position
Returns an integer value representing the colour of the specified pixel.
Parameters
Return values
Examples
function OnWindowPaint(nWindowID)
{
if(nWindowID == g_nMainWindowID)
{
// Draw our window.
DrawWindow();
}
}
function DrawWindow()
{
// Draw a red pixel.
ICR_DrawPixel(100, 100, 0xFF0000);
// Get the colour of the pixel at pos 100, 100.
local nColour = ICR_GetPixel(100, 100);
}
ICRTouch Standard Library
TouchPoint 5800+
ICR_MailReset()
Clears out any current mail configuration/content data.
None
None
TouchPoint 5800+
ICR_MailConfigure(string szServer, integer nPort, string szUsername, string szPassword, string
szSenderName, string szSenderEmail, string szReplyToAddress = "", string szSecurityType = "",
boolean bHTML = false)
Configures the email settings and needs to be called before emails are able to be dispatched.
This only needs to be called once by each script, but can be called multiple times if changes are
made to any settings.
If nPort is set to 0, the default 25 is used.
If szReplyToAddress is empty, szSenderEmail is used.
Email functions
ICR_MailReset
Parameters
Return values
Examples
ICR_MailReset();
ICR_MailConfigure
Parameters
Parameter Description Values
szServer Server address
nPort Port number
szUsername Username
szPassword Password
szSenderName Sender name
szSenderEmail Sender email address
szReplyToAddress Reply to address
szSecurityType Security type
None - No security
TLS - TLS
SSL - SSL
bHTML HTML email true - HTML email
false - Plain text email
None
Version Description
5830 HTML email support added
TouchPoint 5800+
Return values
Examples
ICR_MailConfigure("mail.example.com", 465, "user", "password", "Mr Example",
"mr@example.com", "mr@example.com", "TLS", true);
Changelog
ICR_MailAddReceipient
ICR_MailAddRecipient(string szReceipient, string szName = "", integer nType)
Add a new recipient to the current email.
Parameter Description Values
szRecipient Recipient email address
szName Recipient name
nType Recipient type
0 - To
1 - CC
2 - BCC
None
TouchPoint 5800+
ICR_MailSetSUbject(string szSubject)
Sets the subject against the current email.
Parameter Description Values
szSubject Email subject
None
Parameters
Return values
Examples
ICR_MailAddRecipient("mr@example.com");
ICR_MailAddRecipient("mr2@example.com", "Mr Example", 1);
ICR_MailSetSubject
Parameters
Return values
Examples
TouchPoint 5800+
ICR_MailAddToMessage(string szMessage)
Appends the provided string to the end of of the current email message.
Parameter Description Values
szMessage Message
None
TouchPoint 5800+
ICR_MailAddToMessageLine(string szMessage)
Appends the provided string to the end of the current email message and automatically appends a
CRLF ( \r\n ) pair.
ICR_MailSetSubject("Test email");
ICR_MailAddToMessage
Parameters
Return values
Examples
local szDblLineBreak = "\r\n\r\n";
ICR_MailAddToMessage("Hello Mr Example" + szDblLineBreak);
ICR_MailAddToMessage("This is a test email" + szDblLineBreak);
ICR_MailAddToMessage("Best regards" + szDblLineBreak + "Test Email");
ICR_MailAddToMessageLine
Parameters
Parameter Description Values
szMessage Message line
None
TouchPoint 5800+
ICR_MailAddAttachment(string szFilePath)
Adds an attachment to the current email.
Parameter Description Values
szFilePath File path
None
Return values
Examples
ICR_MailAddToMessageLine("Hello Mr Example");
ICR_MailAddToMessageLine("");
ICR_MailAddToMessageLine("This is a test email");
ICR_MailAddToMessageLine("");
ICR_MailAddToMessageLine("Best regards");
ICR_MailAddToMessageLine("");
ICR_MailAddToMessageLine("Test Email");
ICR_MailAddAttachment
Parameters
Return values
Examples
ICR_MailAddAttachment("C:\\ICRTouch\\Reports\\report.pdf");
TouchPoint 5800+
ICR_MailSendSimple(string szRecipient, string szSubject, string szMessage)
Simple function for sending an email.
On a successful send, ICR_MailReset is called automatically.
Email send result triggers OnEmailOutResult .
Parameter Description Values
szRecipient Recipient email address
szSubject Email subject
szMessage Message
None
TouchPoint 5800+
ICR_MailSend()
Dispatches the current email.
On a successful send, ICR_MailReset is called automatically.
Email send result triggers OnEmailOutResult .
ICR_MailSendSimple
Parameters
Return values
Examples
ICR_MailReset();
ICR_MailConfigure("mail.example.com", 465, "user", "password", "Mr Example",
"mr@example.com", "mr@example.com", "TLS", true);
ICR_MailSendSimple("mr.recipient@email.com", "Test Email", "Hello Mr Example\r\n\r\nHow are
you today?\r\n\r\nTest Email");
ICR_MailSend
None
None
Parameters
Return values
Examples
ICR_MailReset();
ICR_MailConfigure("mail.example.com", 465, "user", "password", "Mr Example",
"mr@example.com", "mr@example.com", "TLS", true);
ICR_MailSetSubject("Till report");
ICR_MailAddRecipient("mr.recipient@email.com");
ICR_MailAddAttachment("C:\\ICRTouch\\Reports\\report.pdf");
ICR_MailSend();
ICRTouch Standard Library
TouchPoint 5830+
ICR_FTPConfigure(string szServer, integer nPort, string szUsername, string szPassword)
Configures the FTP server connection with the specified credentials.
This only needs to be called once by each script.
If you need to connect with different settings the you can call this function multiple times.
Parameter Description Values
szServer Server address
nPort Port number
szUsername Username
szPassword Password
Return description
TouchPoint 5800+
ICR_FTPUpload(string szRemoteFilePath, string szLocalFilePath, boolean bAppend = false)
Uploads a file to the FTP server.
The result is passed through the OnFTPResult() event.
FTP functions
ICR_FTPConfigure
Parameters
Return values
Examples
ICR_FTPConfigure("ftp.server.example.com", 21, "username", "password");
ICR_FTPUpload
Parameter Description Values
szLocalFilePath Local file path
szRemoteFilePath Remote file path
bAppend Append to file true - Append to file
false - Overwrite file
None
Version Description
6600 Added append option
TouchPoint 5800+
ICR_FTPDownload(string szRemoteFilePath, string szLocalFilePath)
Downloads a file from the FTP server.
The result is passed through the OnFTPResult() event.
Parameter Description Values
szRemoteFilePath Remote file path
szocalFilePath Local file path
None
Parameters
Return values
Examples
ICR_FTPUpload("c:\\temp\\ftptest.txt", "/html/example.com/ftptest.txt");
Changelog
ICR_FTPDownload
Parameters
Return values
Examples
ICR_FTPDownload("/html/example.com/ftptest.txt", "c:\\temp\\ftptest.txt");
ICRTouch Standard Library
TouchPoint 5800+
ICR_SendSMS(string szUsername, string szPassword, string szFrom, string nTo, string szNumbers,
boolean bTestMode = false)
Sends an SMS message from TouchPoint.
An active SMS account with credit must be used and can be registered at
http://www.sendsms.org.uk/icrtouch/
Parameter Description Values
szUsername Username
szPassword Password
szFrom From address
szTo Comma separated list of numbers
szMessage Message
bTestMode Test mode true - Simulates sending
false - Sends message
None
The from address is the text that is displayed when a message arrives on a users handset.
This can only be alphanumeric with spaces, must have a minimum or 3 characters and a maximum
of 11.
SMS functions
ICR_SendSMS
Parameters
Return values
Examples
ICR_SendSMS("user@example.com", "password", "ICRTouch", "447912345678,447987654321", "This is
a message.");
Notes
If invalid details are entered, the from address shown is the default for the account.
Numbers must be purely numeric, containing no + symbols, hyphens or spaces.
All numbers must begin with the international prefix.
For example, in the UK this is 44 .
The message can be up to 612 characters in length.
A single message is 153 characters, longer messages are 153 characters each (2 = 312, 3 = 469,
4 = 612).
To insert a newline character use %n.
Euro symbols are treated as new characters.
ICRTouch Standard Library
ICR_Web_Reset()
Clears any current web request data.
None
None
TouchPoint 6600+
ICR_Web_SetHeaderField(string szHeader, string szValue)
Sets a HTTP header against the current web request.
Parameter Description Values
szHeader Header name
szValue Header value
Web functions
ICR_Web_Reset
Parameters
Return values
Examples
ICR_Web_Reset();
ICR_Web_SetHeaderField
Parameters
Return values
None
Content-Type is set in the 2nd Parameter of ICR_Web_SetPostData .
Version Description
7010 Increased the capacity from 100 to 200 bytes
8202
Increased the maximum size of individual HTTP POST
header fields to 4,000 bytes, and the total POST header
size to 20,000 bytes.
ICR_Web_SetURL(string szURL)
Sets the target URL for the HTTP request.
Parameter Description Values
szURL Target URL
None
Examples
ICR_Web_SetHeaderField("Accept", "application/json");
Notes
Changelog
ICR_Web_SetURL
Parameters
Return values
Examples
ICR_Web_SetURL("http://localhost:9980/test.ehp");
ICR_Web_SetPostData(string szPostData, string szContentType)
Adds a HTTP request body to the current request.
Parameter Description Values
szPostData POST data
szContentType Content-Type header
None
ICR_Web_Get(integer nID, string szOutputFileName = "")
Make a HTTP GET request to the currently set URL.
Request result triggers OnWebResult .
Parameter Description Values
nID Provided request ID
szOutputFilename Document/file download destination
ICR_Web_SetPostData
Parameters
Return values
Examples
local tData = {
Status = 1,
message = "Ok"
};
local szData = JSONSerialise(tData);
ICR_Web_SetPostData(szData, "application/json");
ICR_Web_Get
Parameters
None
ICR_Web_Post(integer nID)
Make a HTTP POST request to the currently set URL.
Request result triggers OnWebResult .
Parameter Description Values
nID Provided request ID
None
Return values
Examples
ICR_Web_Reset();
ICR_Web_SetURL("http://requestaddress/get-endpoint/13");
ICR_Web_Get(1);
ICR_Web_Post
Parameters
Return values
Examples
local tData = {
FIRSTNAME = "David",
LASTNAME = "Smith"
};
local szData = JSONSerialise(tData);
ICR_Web_Reset();
ICR_Web_SetURL("http://requestaddress/post-endpoint");
ICR_Web_Put(integer nID)
Make a HTTP PUT request to the currently set URL.
Request result triggers OnWebResult .
Parameter Description Values
nID Provided request ID
None
ICR_Web_SetPostData(szData, "application/json");
ICR_Web_Post(1);
ICR_Web_Put
Parameters
Return values
Examples
local tData = {
FIRSTNAME = "David",
LASTNAME = "Smith"
};
local szData = JSONSerialise(tData);
ICR_Web_Reset();
ICR_Web_SetURL("http://requestaddress/put-endpoint/10");
ICR_Web_SetPostData(szData, "application/json");
ICR_Web_Put(2);
ICR_Web_Patch(integer nID)
Make a HTTP PATCH request to the currently set URL.
Request result triggers OnWebResult .
Parameter Description Values
nID Provided request ID
None
ICR_Web_Delete(integer nID)
ICR_Web_Patch
Parameters
Return values
Examples
local tData = {
FIRSTNAME = "David",
LASTNAME = "Smith"
};
local szData = JSONSerialise(tData);
ICR_Web_Reset();
ICR_Web_SetURL("http://requestaddress/patch-endpoint/5");
ICR_Web_SetPostData(szData, "application/json");
ICR_Web_Patch(4);
ICR_Web_Delete
Make a HTTP DELETE request to the currently set URL.
Request result triggers OnWebResult .
Parameter Description Values
nID Provided request ID
None
ICR_SendRemoteMessage(integer nLicence, string szMessage)
Sends a message directly to the specified licence number.
This sends messages over the internet via HTTP.
Parameter Description Values
nLicence Licence number
szMessage Message to send
Returns true on succes, false on failure.
Parameters
Return values
Examples
ICR_Web_Reset();
ICR_Web_SetURL("http://requestaddress/delete-endpoint/7");
ICR_Web_Delete(1);
ICR_SendRemoteMessage
Parameters
Return values
Examples
// Send a message to a licence
local bResult = ICR_SendRemoteMessage(999999, "Hello, there!");

ICRTouch Standard Library
TouchPoint 6200+
ICR_CreateHMAC(string szKey, string szValue, string szType): string
Create a HMAC of the supplied value using the hashing key.
Parameter Description Values
szKey Hash key
szValue Data to be hashed
szType Hash type MD5 - Message Digest Algorithm
SHA1 - Secure Hash Algorithm 1
Returns a 128-bit MD5 or 160-bit SHA1 string containing the calculated hash.
The above would return something similar to A95669C550C0C9CC91EF29A91873CA4F .
TouchPoint 6800+
ICR_CreatePBKDF2(string szPassword, string szSalt, integer nIterations, integer
nOutputKeyLength): string
Creates a PBKDF2 crytographic key derivation.
Used in ICR_EncryptAES and ICR_DecryptAES as the IV/Key.
Encryption functions
ICR_CreateHMAC
Parameters
Return values
Examples
local szHashedString = ICR_CreateHMAC("key", "password", "MD5");
ICR_CreatePBKDF2
Parameter Description Values
szPassword Master password
szSalt Salt
nIterations Number of times the key is generated
nOutputKeyLength Output length in bytes
Returns a string containing the derived key as hexadecimal.
The above would return something similar to F9D39C571D66A03C2A71A81535B0C2D0 .
TouchPoint 6800+
ICR_EncryptAES(string szData, string szMethod, string szKey, string szIV): string
Encrypt a string of data using the AES128 algorithm.
Parameter Description Values
szData Data to encrypt
szMethod Encryption method AES-128-CBC
szKey Passphrase
szIV Initialisation Vector
Returns the encrypted string value as base64.
Parameters
Return values
Examples
dofile("Etal\\lib\\strings.moc");
local szPBKDF2 = ICR_CreatePBKDF2("password", StringToHexString("salt"), 1024, 16);
ICR_EncryptAES
Parameters
Return values
The above would output something similar to 1FKDkhKD5xWYcj5k+NeRXA== .
TouchPoint 6800+
ICR_DecryptAES(string szData, string szMethod, string szKey, string szIV): string
Decrypt a base64 string of data using the AES128 algorithm.
Parameter Description Values
szData Data to decrypt
szMethod Encryption method AES-128-CBC
szKey Passphrase
szIV Initialisation Vector
Examples
dofile("Etal\\lib\\strings.moc");
function OnInit()
{
// Encrypt our data.
local szEncryptedString = ICR_EncryptString("stringtoencrypt", "mypassword", "mysalt");
}
function EncryptString(szData, szPassword, szSalt)
{
// Convert salt to hex string, create PBKDF2 for Key/IV.
local szSaltHex = StringToHexString(szSalt);
local szKey = ICR_CreatePBKDF2(szPassword, szSaltHex , 128, 16);
local szIV = ICR_CreatePBKDF2(szPassword, szSaltHex , 128, 16);
// Encrypt the string and return result
return ICR_EncryptAES(szData, "AES-128-CBC", szKey, szIV);
}
ICR_DecryptAES
Parameters
Returns the decrypted string value.
The above would output the originally encrypted string upon success, or a random string based on
the data supplied on failure.
For instance, the supplied string above decrypts to stringtoencrypt .
If the password is changed slightly, this would output something like Ë*É▒Éü▄æ5ßÉÔ\nn .
Return values
Examples
dofile("Etal\\lib\\strings.moc");
function OnInit()
{
// Decrypt our data.
local szDecryptedString = ICR_DecryptString("1FKDkhKD5xWYcj5k+NeRXA==", "mypassword",
"mysalt");
}
function DecryptString(szData, szPassword, szSalt)
{
// Convert salt to hex string, create PBKDF2 for Key/IV.
local szSaltHex = StringToHexString(szSalt);
local szKey = ICR_CreatePBKDF2(szPassword, szSaltHex , 128, 16);
local szIV = ICR_CreatePBKDF2(szPassword, szSaltHex , 128, 16);
// Decrypt the string and return result
return ICR_DecryptAES(szData, "AES-128-CBC", szKey, szIV);
}
ICRTouch Standard Library
ICR_Voucher_Used(string szCode, integer nAmount, string szSaleID)
Makes a request to modify a voucher's balance.
Request result triggers OnVoucherResult .
Parameter Description Values
szCode Voucher code
nAmount Adjustment amount
None
A positive nAmount value reduces the voucher balance, whereas a negative value increases the
voucher balance.
ICR_Voucher_Create(table tData)
Makes a request to create a voucher.
Request result triggers OnVoucherResult .
Voucher functions
ICR_Voucher_Used
Parameters
Return values
Examples
ICR_Voucher_Used("VCHRCODEXX", 1000, "1001004823090322");
Notes
ICR_Voucher_Create
Parameters
Parameter Description Values
tData Voucher data
None
VALUE: Integer value in minor currency without decimal point.
STARTDATE,EXPDATE: Dates are supplied as Integer of format of DDMMYYYY
STARTTIME,EXPTIME: Times are supplied as Integer of format of HHMM are appended to date.
ICR_Voucher_SetActive(string szCode, boolean bActive)
Makes a request to set a specified voucher's active status.
Request result triggers OnVoucherResult .
Parameter Description Values
szCode Voucher code
bActive Voucher status true - Activate voucher
false - Deactivate voucher
Return values
Examples
local tVoucher = {
NAME = "Test Voucher",
DESCRIPTION = "My Test",
TYPE = 1,
VALUE = 1500,
ACTIVE = true,
STARTDATE = 22032022,
EXPDATE = 1042036,
SITE = 0
};
ICR_Voucher_Create(tVoucher);
Notes
ICR_Voucher_SetActive
Parameters
None
ICR_Voucher_Get(string szCode)
Makes a request to get a voucher's details.
Request result triggers OnVoucherResult .
Parameter Description Values
szCode Voucher code
None
Return values
Examples
ICR_Voucher_SetActive("VCHRCODEXX", true);
ICR_Voucher_Get
Parameters
Return values
Examples
ICR_Voucher_Get("VCHRCODEXX");
ICRTouch Standard Library
TouchPoint 6800+
ICR_EHP_Output(string szOutputData)
Outputs the supplied string to the EHP server.
Parameter Description Values
szOutputData Output data
None
TouchPoint 6800+
ICR_EHP_SetHeader(string szHeader, string szValue)
Sets a header against the returned EHP page/data.
EHP server functions
ICR_EHP_Output
Parameters
Return values
Examples
<%
ICR_EHP_Output("<div class=\"container\">");
ICR_EHP_Output("<p class=\"main\">This is some example output text</p>");
ICR_EHP_Output("</div>");
%>
ICR_EHP_SetHeader
Parameters
Parameter Description Values
szHeader Header name
szValue Header value
None
TouchPoint 7000+
ICR_EHP_GetPostData(): string
Retrieves HTTP POST data from the HTTP BODY.
None
Return values
Returns a string of HTTP POST data.
Return values
Examples
<%
ICR_EHP_SetHeader("Access-Control-Allow-Origin", "http://localhost");
ICR_EHP_SetHeader("Access-Control-Allow-Origin", "POST, GET, OPTIONS");
ICR_EHP_SetHeader("Access-Control-Allow-Origin", "Content-Type, Accept");
ICR_EHP_SetHeader("Content-Type", "application/json");
ICR_EHP_SetHeader("Accept", "application/json");
%>
ICR_EHP_GetPostData
Parameters
Examples
<%
dofile("Etal\\lib\\json.moc");
local szPostData = ICR_EHP_GetPostData();
TouchPoint 7604+
ICR_EHP_GetRequestMethod(): string
Retrieves the HTTP method.
None
Returns a string value containing the HTTP request method.
TouchPoint 7604+
ICR_EHP_GetRequestHeader(string szHeader): string
Retrieves the requested HTTP header.
Parameter Description Values
szHeader Header key
local tPostData = JSONDeserialise("szPostData");
%>
ICR_EHP_GetRequestMethod
Parameters
Return values
Examples
<%
local szMethod = ICR_EHP_GetRequestMethod();
%>
ICR_EHP_GetRequestHeader
Parameters
Return values
Returns a string value containing the data for the requested header.
If the header doesn't exist, an empty string is returned.
TouchPoint 6800+
ICR_EHP_SetFilePos(integer nPosition)
Recorded for completion and is not usable in scripts.
Automatically generated by EHP Scripts to determine the position of the EHP code.
Parameter Description Values
nPosition File position
None
None
Examples
<%
local szContentType = ICR_EHP_GetRequestHeader("Content-Type");
%>
ICR_EHP_SetFilePos
Parameters
Return values
Examples
ICRTouch Standard Library
OnInit()
Triggered when the script engine launches.
None
OnTimer(integer nTimerID, integer nSystemTime)
System events
OnInit
Parameters
Examples
local bDebugPrinting = true;
function OnInit()
{
if(bDebugPrinting)
{
// Debug logging required.
// Enable debug logging, output console and autorestart on save.
ICR_EnableDebugLog(true);
ICR_SetFeature("CONSOLE",true);
ICR_SetFeature("AUTORESTART",true);
}
// Set local user data for our bDebugPrinting variable for later use.
ICR_SetLocalUserData("bDebugPrinting", bDebugPrinting, true);
}
OnTimer
Triggered when the timer created using ICR_StartTimer()has elapsed.
Parameter Description Values
nTimerID Elapsed timer ID
nSystemTime UNIX timestamp of current time
AfterModeChange(integer nFrom, integer nTo)
Triggered when ICRTouch changes mode.
Parameter Description Values
nFrom Outgoing mode
nTo Incoming mode
Parameters
Examples
function OnTimer(nTimerID, nSystemTime)
{
if(nTimerID == g_nOurTimer)
{
// Stop our timer.
ICR_StopTimer(nTimerID);
}
}
AfterModeChange
Parameters
Examples
function AfterModeChange(nFrom, nTo)
{
if (nFrom == 10) // Check if we're leaving PGM3
{
OnAwaitFile(string szFileName, integer nEventID, boolean bExpired)
Triggered as the result of the ICR_AwaitFile() method.
Parameter Description Values
szFileName Requested file name
nEventID User specified ID
// Force a save of local userdata.
ICR_SetLocalUserData("bDebugPrinting", false);
}
}
OnAwaitFile
Parameters
function ReportEvent(nEventType, nReportCode, nPeriod, bZReport, nLocation, bNetwork,
nFromDept, nToDept, nFromGroup, nToGroup, nMC, nPort)
{
switch(nEventType)
{
case 1: // Before print
break;
case 2: // After print - Ok
break;
case 3: // After print - Stopped
break;
case 4: // Report Z reset
break;
}
}
Parameter Description Values
bExpired Await file timeout
true - Timeout expired, file not
found
false - File found
OnPlayMacroResult(boolean bSuccess)
Trigged as a result of the ICR_PlayMacro() method.
Parameter Description Values
bSuccess Macro success true - Success
false - Failure
Examples
function OnAwaitFile(szFileName, nEventID, bExpired)
{
if(nEventID == g_nOurFileEvent)
{
// Check if the file was found.
if(bExpired)
{
// The file was not found and our timeout elapsed.
}
else
{
// The file was found.
}
}
}
OnPlayMacroResult
Parameters
Examples
function OnPlayMacroResult(bSuccess)
{
ReportEvent(integer nEventType, integer nReportCode, integer nPeriod, boolean bZReport, integer
nLocation, boolean bNetwork, integer nFromDept, integer nToDept, integer nFromGroup, integer
nToGroup, integer nMC, integer nPort)
Triggered as the result of running an X/Z report.
Parameter Description Values
nEventType Report event
1 - Before print
2 - After print - OK
3 - After print - Stopped
4 - Report Z reset
nReportCode Report code
nPeriod Report period
1 - Period 1
2 - Period 2
3 - Period 3
bZReport X/Z report true - Z report
false - X report
nLocation Location ID
bNetwork Inline or standalone report true - Inline report
false - Standalone report
nFromDept Department start record
nToDept Department end record
if(bSuccess)
{
// Macro played successfully.
}
else
{
// Macro failed.
}
}
ReportEvent
Parameters
Parameter Description Values
nFromGroup PLU group start record
nToGroup PLU group end record
nMC Machine number
nPort Port number
AfterFullSalesDataReset()
Triggered when a sales data reset completes.
Examples
function ReportEvent(nEventType, nReportCode, nPeriod, bZReport, nLocation, bNetwork,
nFromDept, nToDept, nFromGroup, nToGroup, nMC, nPort)
{
switch(nEventType)
{
case 1: // Before print
break;
case 2: // After print - Ok
break;
case 3: // After print - Stopped
break;
case 4: // Report Z reset
break;
}
}
AfterFullSalesDataReset
Parameters
None
OnFile_ReadPipeResult(integer nID, string szData)
Triggered by data being returned from a ICR_File_OpenPipe() command.
Parameter Description Values
nID ICR_File_OpenPipe() ID
szData Response data
Examples
function AfterFullSalesDataReset()
{
// Sales data reset complete.
}
OnFile_ReadPipeResult
Parameters
Examples
local g_nIPconfig = 0;
local g_szIPAddress = "";
function OnInit()
{
// Fire off a pipe command through the command line to run "ipconfig".
local g_nIPconfig = ICR_File_OpenPipe("C:\\WINDOWS\\system32\\cmd.exe /C ipconfig");
}
function OnFile_ReadPipeResult(nID, szData)
{
if(nID == g_nIPconfig)
{
if(szData.find("IPv4 Address") != null)
{
// IP Address found in text, find the start.
local nIPv4Start = szData.find("IPv4 Address");
// Slice from the start of the line onwards.
local szSlicedData = szData.slice(nIPv4Start);
// Find where the IP address begins and the end of line.
local nColon = szSlicedData.find(":") + 2;
local nEOL = szSlicedData.find("\r\n");
// Slice out the actual IP address
g_szIPAddress = szSlicedData.slice(nColon, nEOL);
}
}
}
ICRTouch Standard Library
BeforeKeyPress(integer nFile, integer nRecord, integer nKeyType): boolean
Triggered before a key press is processed.
Returning true or false determines whether the keypress is allowed to continue.
Parameter Description Values
nFile File number
nRecord Record number
nKeyType Key type
Returns a boolean value.
ICR_KeyPress() does not trigger this event.
Sales mode events
BeforeKeyPress
Parameters
Return values
Examples
function BeforeKeyPress(nFile, nRecord, nKeyType)
{
if(nKeyType == 25 || nKeyType == 26)
{
// A +/- AMOUNT key has been pressed, disallow it.
return false;
}
return true;
}
Notes
AfterKeyPress(integer nFile, integer nRecord, integer nKeyType)
Triggered after a key press has been processed.
Parameter Description Values
nFile File number
nRecord Record number
nKeyType Key type
ICR_KeyPress() does not trigger this event.
OnRunScriptKeyPress(integer nFile, integer nRecord, integer nNumber, integer nValue, integer
nFlag)
Triggered by pressing a "Run Script (Etal)" status key.
Parameter Description Values
nFile File number
nRecord Record number
AfterKeyPress
Parameters
Examples
function AfterKeyPress(nFile, nRecord, nKeyType)
{
// A key has been pressed.
}
Notes
OnRunScriptKeyPress
Parameters
Parameter Description Values
nNumber Set number
nValue Set value
nFlag Set flags
OnIButtonPress(string szIButton): boolean
Triggered an iButton being read, called before the data has been processed by TouchPoint.
Returning true or false determines whether the iButton is allowed to continue.
Parameter Description Values
szIButton IButton data
Examples
function OnRunScriptKeyPress(nFile, nRecord, nNumber, nValue, nFlag)
{
// A run script key has been pressed.
switch(nNumber)
{
case g_nScriptKeyNumber:
// Our script key was pressed.
// Do something.
break;
default:
// Not our script key, just return from the keypress.
// No action required.
return;
}
}
OnIButtonPressed
Parameters
Return values
Returns a boolean value.
OnCardSwipe(integer nTrack, string szData): boolean
Triggered by a magnetic card swipe, called before the data has been processed by TouchPoint.
Returning true or false from this function determines whether the mag card swipe is allowed to
continue.
Parameter Description Values
nTrack Track number
szData Card swipe data
Examples
local g_bAllowIButtons = false;
function OnIButtonPressed(szIButton)
{
// An iButton has been read.
if(!g_bAllowIButtons)
{
// iButtons are not allowed, return false.
return false;
}
// iButtons are allowed, return true.
return true;
}
OnCardSwipe
Parameters
Examples
local g_nCustomerSignOnKey = 5;
function OnCardSwipe(nTrack, szData)
{
The szData parameter does not include the start or end sentinels
// Card swipe received.
if(nTrack != 1)
{
// Not a track 1 swipe so let TouchPoint sort it out.
return true;
}
if (szData.len() != 11)
{
// It is not 11 characters, return true and let TouchPoint handle it.
return true;
}
// Check if the first 3 characters are 'ICR'.
if(szData[0] != 'I' && szData[1] != 'C' && szData[2] != 'R')
{
// They are not 'ICR', return true and let TouchPoint handle it.
return true;
}
// This is one of the cards we are looking for.
// Slice off the back 4 digits.
local szFullCode = szCardData.slice(7, 11);
// Push the last 4 digits through the ICR_SetInput() method.
ICR_SetInput(szFullCode);
// Press the customer sign on key. This will sign on our customer.
ICR_KeyPress (53, g_nCustomerSignOnKey);
// Return false, as we have handled the card swipe, so TouchPoint doesn't have to.
return false;
}
Notes
OnBarcode(string szBarcodeData): boolean
Triggered by scanning a EAN8/EAN13 barcode, called before the data is processed by TouchPoint.
Returning true or false determines whether the barcode scan is allowed to continue.
Parameter Description Values
szBarcodeData Barcode data
Returns a boolean value.
OnReceiptRequired(boolean bReceiptRequired): boolean
OnBarcode
Parameters
Return values
Examples
function OnBarcode(szBarcodeData)
{
// Barcode scanned.
// Check to see if the barcode has an assigned PLU.
local nScannedPLU = ICR_GetPLURecNumber(szBarcodeData);
if(nScannedPLU != 0)
{
// This is a TouchPoint PLU, get the PLU Data.
local tPLU = ICR_GetPGMData(1, nScannedPLU);
// Do something with the PLU.
}
// Return true, allowing the barcode.
return true;
}
OnReceiptRequired
Triggered before ICRTouch prints a receipt at the end of the current sale.
Returning true or false allows you to overwrite the current setting.
Parameter Description Values
bReceiptRequired Current receipt print requirement
Returns a boolean value.
AfterSignOn(integer nClerk)
Triggered when a clerk is signed on.
Parameters
Return values
Examples
function OnReceiptRequired(bCurrentReceiptOnSetting)
{
// Receipt required event called.
// Get the clerk buffer index.
local tClerkBuffer = ICR_GetClerkBuffer_Index();
// Check if we have a check/table open.
if (tClerkBuffer.CHECK > 0 || tClerkBuffer.TABLE > 0)
{
// We have a check or table open.
// Return false and do not print a receipt.
return false;
}
// No check/table open, let the current RECEIPT ON/OFF setting handle the printing.
return bCurrentReceiptOnSetting;
}
AfterSignOn
Parameters
Parameter Description Values
nClerk Clerk number
AfterCustomerLogOn(integer nCustomer)
Triggered when a customer is signed on.
Parameter Description Values
nCustomer Customer number
Examples
function AfterSignOn(nClerk)
{
// Clerk has been signed on.
// Get the clerk details.
local tClerk = ICR_GetPGMData(6, nClerk);
}
AfterCustomerLogOn
Parameters
Examples
function AfterCustomerLogOn(nCustomer)
{
// Customer has been signed on.
// Get the customer details.
local tCustomer = ICR_GetPGMData(260, nCustomer);
// Get the customer group data.
local tCustomerGroup = ICR_GetPGMData(270, tCustomer.GROUP);
}
AfterExtCustomerLogOn
AfterExtCustomerLogOn(string szCustomer): boolean
Triggered when a customer is signed on using 3rd party software.
Parameter Description Values
szCustomer Customer number
TouchPoint 5800+
OnNewCustomer(integer nCustomer)
Triggered when a customer is created through the auto creation process.
Parameter Description Values
nCustomer Customer number
Parameters
Examples
function AfterExtCustomerLogOn(szCustomer)
{
// 3rd party customer has been signed on.
// Get the 3rd party customer details.
local tCustomer = ICR_GetCurrent3rdPartyCustomer();
}
OnNewCustomer
Parameters
Examples
function OnNewCustomer(nCustomer)
{
// Customer has been signed on.
// Get the customer details.
local tCustomer = ICR_GetPGMData(260, nCustomer);
// Get the customer group data.
OnCustomerExpired(): boolean
Triggered before just before TouchPoint throws up the 'Expired' error message when an expired
customer is logged on.
Returning false from this function prevents TouchPoint from displaying the message and allows
the customer to sign on.
None
Returns a boolean value.
local tCustomerGroup = ICR_GetPGMData(270, tCustomer.GROUP);
}
OnCustomerExpired
Parameters
Return values
Examples
local g_nExtensionPLU = 5;
function OnCustomerExpired()
{
// Expired customer has been requested.
// Check to see if an extension PLU has been sold.
local bExtensionPLUSold = CheckForExtensionPLU();
// Evaluate the response of the CheckForExtensionPLU() method.
if(bExtensionPLUSold)
{
// Extension PLU found, allow the customer to sign on and act as normal.
return false;
}
// Extension PLU has not been found, return true and let TouchPoint handle it.
// The customer will not be signed on.
return true;
AfterRegItemSelect(integer nItem)
Triggered when an item has been selected in the reg window.
}
function CheckForExtensionPLU()
{
// Get the clerk buffer table.
local tClerkBuffer = ICR_GetClerkBuffer_Index();
// Iterate over each of the clerk buffer items.
for(local nCount = 1; nCount <= tClerkBuffer.REGPOS; nCount++)
{
// Get the clerk buffer item table for this item.
local tClerkItem = ICR_GetClerkBuffer_Item(nCount);
if(tClerkItem.FILE != 1)
{
// Skip this item as it's not a PLU.
continue;
}
// Check to see if this is our extension PLU.
if(tClerkItem.RECORD == g_nExtensionPLU)
{
// It is our extension PLU, return true.
return true;
}
}
// No extension PLU found, return false.
return false;
}
AfterRegItemSelect
Parameters
Parameter Description Values
nItem Selected item
OnMixMatch(integer nTable, integer nType): integer
Triggered when a mix & match with the type 'Etal' executed.
The return value is the amount to be discounted from the sale.
Parameter Description Values
nTable Triggered M&M table
nType Triggered M&M type
Returns an integer value.
The value returned by default will not be removed from the sale. It will simply write to the reg
window. If the value is to be removed from the sale then the value must be bitwise OR'd with
0x10000000 .
If applying a discount via a keypress inside the method, then do not OR your value with 0x10000000
, otherwise, you will apply an additional discount.
Examples
function AfterRegItemSelect(nItem)
{
// Reg item has been selected by the user.
// Get the clerk buffer item table for this item.
local tClerkItem = ICR_GetClerkBuffer_Item(nItem);
if(tClerkItem.FILE == 1)
{
// Item is a PLU, get the data.
local tPLU = ICR_GetPGMData(tClerkItem.FILE, tClerkItem.RECORD);
}
}
OnMixMatch
Parameters
Return values
Examples
local g_nSpecialGroup = 1;
function OnMixMatch(nTable, nType)
{
// Set a local variable to record the discount value.
local nValue = 0;
// A Mix & Match has been triggered.
// Check if it is type 2.
if(nType == 2 && nTable == 1)
{
// It is type 2 and the table is 1.
// Get the clerk buffer index.
local tClerkBuffer = ICR_GetClerkBuffer_Index();
// Get this Mix & Match program data.
local tMixMatch = ICR_GetPGMData(159, nTable);
// Create an empty table for storing only PLUs that are relevant to the M&M.
local tValidPLUs = {};
// Loop through the sale.
for(local nCount = 1; nCount <= tClerkBuffer.REGPOS; nCount++)
{
// Get this clerk buffer item.
local tClerkItem = ICR_GetClerkBuffer_Item(nCount);
// Chec if this item is a PLU, if it isn't skip this loop iteration and proceed
to the next record.
if(tClerkItem.FILE != 1) continue;
// This is a PLU.
// Loop through the M&M program data record and evaluate this PLU in the sale
against it.
for(local nMMItems = 1; nMMItems <= 30; nMMItems++)
{
// Check if this PLU matches this M&M item. Also make sure that an M&M has
not previously been applied.
if((tClerkItem.RECORD == tMixMatch["ITEM"+nMMItems]) && !(tClerkItem.FLAG1 &
0x10))
{
// This is a valid PLU, add it to our table of valid
PLUs.
tValidPLUs[nCount] <- tClerkItem;
}
}
}
// Iterate through our valid PLUs table.
foreach(idx, val in tValidPLUs)
{
// Get this PLUs program data.
local tThisPLU = ICR_GetPGMData(tValidPLUs[idx].FILE,
tValidPLUs[idx].RECORD);
if(tThisPLU.GROUP == g_nSpecialGroup)
{
// PLU is assigned to our set group.
// Evaluate the PRICE data stored in the clerk item table.
switch(val.PRICE)
{
case 500: // The price is 5.00, remove 1.00 from
it.
nValue += 100;
break;
case 250: // The price is 2.50, remove 0.50 from
it.
nValue += 50;
break;
default: // Default item discount value is 0.10.
nValue += 10;
break;
}
}
}
}
The maximum value that can be discounted using the Etal M&M type is 268435455 .
BeforeSaleFinalise(integer nRecord, integer nKeyType, integer nTenderAmount): boolean
Triggered when the first finalise key in the sale has been pressed but before the finalisation
actually starts.
Returning false will stop the sale being finalised (this is only possible with Cash and Cash2 types).
Parameter Description Values
nRecord Finalise key record number
nKeyType Finalise key type
nTenderAmount Amount tendered
Returns a boolean.
// Return the value from the above loop.
// Bitwise OR the value with 0x10000000 to remove the value from the sale.
return nValue | 0x10000000;
}
Notes
BeforeFinalise
Parameters
Return values
Examples
function BeforeFinalise(nRecord, nKeyType, nTenderAmount)
{
if(nKeyType == 11)
{
// Cash2 key, disallow this as the initial keypress.
// Return false, stopping the keypress.
return false;
PresaleFinalised()
Triggered immediately before the sale is finalised.
None
This method is the last possible stage to acquire the clerk buffer index and associated items on a
satellite terminal.
}
// All other cases, return true, allowing finalisation to continue.
return true;
}
PreSaleFinalised
Parameters
Examples
local g_tEvent = {
NAME = "TouchPoint Expo",
DATE = "31/10/2022"
};
function PreSaleFinalised()
{
// Check if we have data in our table.
if("NAME" in g_tEvent && "DATE" in g_tEvent)
{
// Add the data to the bottom of our receipt for printing.
ICR_ReceiptLine("", 0, 0, 53, 10, 0);
ICR_ReceiptLine("Name: " + g_tEvent.NAME, 0, 0, 53, 10, 0);
ICR_ReceiptLine("Date: " + g_tEvent.DATE, 0, 0, 53, 10, 0);
ICR_ReceiptLine("", 0, 0, 53, 10, 0);
}
}
Notes
This is the last possible stage to add items to the receipt buffer.
AfterFinalise()
Triggered after a sale is finalised.
None
This method is the last possible stage to acquire the clerk buffer index and associated items on a
master terminal.
AfterFinalise
Parameters
Examples
function AfterFinalise()
{
// Sale has been finalised.
}
Notes
ICRTouch Standard Library
BeforePrint(integer nType, integer nFile, integer nRecord, integer nMC, integer nPort)
Triggered just prior to ICRTouch outputting to the printer.
Parameter Description Values
nType Printer type
0 - Receipt
1 - Bill
2 - Voucher
4 - Ticket
nFile File number
nRecord Record number
nMC Machine number
nPort Printer port
Printing events
BeforePrint
Parameters
Examples
function BeforePrint(nType, nFile, nRecord, nMC, nPort)
{
if(nType != 0)
{
// Not a receipt.
return;
}
if(nFile == 402 && nRecord == 8)
{
// End of the receipt, get footer text.
local szFooterText = GetFooterText();
// Check string length.
if(szFooterText.len() > 0)
Version Description
6400 Bill print support added
6800 Voucher print support added
TouchPoint 5800+
OnKPDeviceRequested(integer nKP): integer
Triggered just before a KP device is selected for printing.
The script is given the option to divert the printing to a different kp device by returning the new kp
number from the function, or stopping printing to that device by returning 0.
Parameter Description Values
nKP Kitchen printer ID
Returns an integer representing a kitchen printer ID.
{
// Longer than 0, print footer text.
ICR_OutputLine(szFooterText, nMC, nPort);
}
}
}
Changelog
OnKPDeviceRequested
Parameters
Return values
Examples
function OnKPDeviceRequested(nKP)
{
if(nKP == 1)
{
// Move all KP 1 prints to KP 2
return 2;
TouchPoint 6400+
InsertAdditionalOrderInfo(integer nDest): string
Triggered when the order information box is printed.
Parameter Description Values
nDest Order info destination
0 - Receipt
1 - Kitchen Printer
2 - Bill
3 - Ticket
4 - Customer detail
5 - XML socket journal
6 - Remote receipt
7 - Webshop store
8 - Receipt rebuild
Returns a string to be printed.
}
// For everything else return the provided value.
return nKP;
}
InsertAdditionalOrderInfo
Parameters
Return values
Examples
// Voucher request types
enum Destination {
RECEIPT = 0,
KP = 1,
BILL = 2,
TICKET = 3
};
local szNewLine = "\n";
Version Description
7015 Added extra destinations
function InsertAdditionalOrderInfo(nDest)
{
if(nDest == Destination.KP || nDest == Destination.RECEIPT)
{
local szAddress = GetAddress();
return "Delivery Address" + szNewLine + szAddress;
}
return "";
}
Changelog
ICRTouch Standard Library
TouchPoint 7400+
AfterXMLSocketSendSale(string szRequest, string szResponse)
Triggered as a result of a sale received via the XML socket.
Parameter Description Values
szRequest Request data
szResponse Response data
TouchPoint 7407+
XMLSocketCheckPayment(integer nID, string szRequest, string szResponse, bCompleted)
Triggered as a result of a payment received on a check over the XML socket.
Parameter Description Values
nID Payment ID
XML socket events
AfterXMLSocketSendSale
Parameters
Examples
function AfterXMLSocketSendSale(szRequest, szResponse)
{
print("Request: " + szRequest);
print("Response: " + szResponse);
}
XMLSocketCheckPayment
Parameters
Parameter Description Values
szRequest Request data
szResponse Response data
bCompleted Payment completion status true - Payment complete
false - Payment incomplete
The event is called twice, once before the payment is completed and once after.
The first time the event is called szResponse will be empty and bCompleted will be set to false .
The second time the event is called szResponse will be filled and bCompleted will be set to true .
Examples
function XMLSocketCheckPayment(nID, szRequest, szResponse, bCompleted)
{
print("ID: " + nID);
print("REQUEST: " + szRequest);
print("RESPONSE: " + szResponse);
print("COMPLETED: " + bCompleted);
}
Notes
ICRTouch Standard Library
OnEnterPGMMenu(integer nSubMenu)
Trigged when a script's PGM3 > ETAL programming menu has been entered.
Parameter Description Values
nSubMenu Program menu level 0 - Main menu
Program mode events
OnEnterPGMMenu
Parameters
Examples
function OnEnterPGMMenu(nSubMenu)
{
// Reset the menu.
ICR_PurgeProgramSettings();
// hHeck which menu to render.
switch(nSubMenu)
{
case 0: // Main Menu
ICR_AdvertiseProgramHeading("Script Version 1.0");
ICR_AdvertiseProgramSetting("Enable Script", "bScriptEnabled");
ICR_AdvertiseProgramSetting("Version Info", "SCRIPTVERINF");
break;
default: // All other undefined cases/menus.
ICR_AdvertiseProgramHeading("This menu does not exist.");
break;
}
}
OnEnterProgramOptionList(integer nID)
Triggered when data for a program mode option list is required.
Parameter Description Values
nID Option list ID
OnEnterPGMOptionList
Parameters
Examples
function OnEnterPGMOptionList(nID)
{
// Reset the option list.
ICR_PurgeProgramOptionList();
switch(nID)
{
case 1: // Alignment list
ICR_ProgramOptionList_Add("LEFT", 1);
ICR_ProgramOptionList_Add("CENTRE", 2);
ICR_ProgramOptionList_Add("RIGHT", 3);
break;
case 2: // Font size
ICR_ProgramOptionList_Add("12px", 12);
ICR_ProgramOptionList_Add("14px", 14);
ICR_ProgramOptionList_Add("16px", 16);
ICR_ProgramOptionList_Add("18px", 18);
ICR_ProgramOptionList_Add("20px", 20);
break;
}
}
ICRTouch Standard Library
TouchPoint 7604+
AfterKPCUpdate(integer nEventType, string szID)
Event triggered whenever there is a data change in the KP Controller.
Parameter Description Values
nEventType Event type
1 - New kp ticket
2 - KP Ticket status change
3 - KP Ticket item status change
4 - KP Ticket item KP flag change
6 - Data store update
szID ID of the item that the event relates
to
Kitchen printer controller
events
AfterKPCUpdate
Parameters
Example
function AfterKPCUpdate(nEventType, szID)
{
local szEvent = nEventType + " ";
// Work out what type of event it is
switch(nEventType)
{
case 1:
szEvent += "(NEW KP TICKET)";
break;
case 2:
szEvent += "(KP TICKET STATUS CHANGE)";
break;
case 3:
szEvent += "(KP TICKET ITEM STATUS CHANGE)";
break;
case 4:
szEvent += "(KP TICKET ITEM KP FLAG CHANGE)";
break;
case 5:
szEvent += "(RESERVED)";
break;
case 6:
szEvent += "(DATASTORE UPDATE)";
break;
default:
szEvent += "(UNKNOWN)";
break;
}
print("KPC_AfterKPTicketUpdate() -> Event Type: " + szEvent + " ID: " + szID);
if(nEventType >= 1 && nEventType <= 5)
{
// Then this is a ticket event
// Get and output the ticket
local arrTickets = [];
arrTickets.push(szID);
local szKPTicket = ICR_KPC_GetKPTickets(arrTickets);
print("TICKET: " + szKPTicket);
}
if(nEventType == 6)
{
// Then this is a datastore event
local szData = ICR_KPC_GetData(szID);
print("DATA: " + szData);
}
}
Changelog
Version Description
7613 Finished ticket items that will also finish the ticket will
also now trigger a ticket status change.
ICRTouch Standard Library
OnMouseEvent(integer nWindowID, integer nEvent, integer nX, integer nY)
Triggered when a mouse event occurs in a window owned by this script.
Parameter Description Values
nWindowID Window ID
nEvent Event type
0 - Mouse down
1 - Mouse up
2 - Mouse move
nX Event x position
nY Event y position
Display events
OnMouseEvent
Parameters
Examples
local g_nWindowID = 0;
enum MouseEvents {
MOUSEDOWN = 0,
MOUSEUP = 1,
MOUSEMOVE = 2
};
function OnInit()
{
// Load window data.
g_nWindowID = ICR_SalesModeWindow_Add("main_window.xml", false);
ICR_Window_Enable(g_nWindowID, false);
}
function OnMouseEvent(nWindowID, nEvent, nX, nY)
{
OnWindowPaint(integer nWindowID)
Triggered when a window owned by the script requires drawing.
Parameter Description Values
nWindowID Window ID
if(nWindowID == g_nWindowID)
{
// Window owned by this script.
// Detect event type.
switch(nEvent)
{
case MouseEvents.MOUSEDOWN: // Mouse click down
MouseDownHandler(nX, nY);
break;
case MouseEvents.MOUSEUP: // Mouse click up
MouseUpHandler(nX, nY);
break;
case MouseEvents.MOUSEMOVE: // Mouse move
MouseMoveHandler(nX, nY);
break;
}
}
}
OnWindowPaint
Parameters
Examples
local g_nWindowID = 0;
function OnInit()
{
// Load window data.
g_nWindowID = ICR_SalesModeWindow_Add("main_window.xml", false);
ICR_Window_Enable(g_nWindowID, false);
}
function AfterModeChange(nFrom, nTo)
{
if(nTo == 1)
{
// Sales mode
ICR_Window_Enable(g_nWindowID, true);
ICR_RedrawScreen();
}
else
{
// Not sales mode
ICR_Window_Enable(g_nWindowID, true);
ICR_RedrawScreen();
}
}
function OnWindowPaint(nID)
{
// Painting a window
if(nID == g_nWindowID)
{
DrawWindow();
}
}
ICRTouch Standard Library
TouchPoint 5800+
OnEmailOutResult(boolean bSuccess, string szMessage)
Triggered as the result of an ICR_MailSendSimple() or ICR_MailSend() method.
Parameter Description Values
bSuccess Email result
szMessage Response from mail server
TouchPoint 5800+
Communications events
OnEmailOutResult
Parameters
Examples
function OnEmailOutResult(bSuccess, szMessage)
{
if(bSuccess)
{
// It was successful, do something.
}
else
{
// It was not a success. Print the error to the output.
print("Error: " + szMessage);
}
}
OnSMSOutResult
OnSMSOutResult(boolean bSuccess, string szMessage, string szNumberOfContacts, strings
zCreditsRequired, string szCreditsRemaining)
Triggered as the result of the ICR_SendSMS() method.
Parameter Description Values
bSuccess SMS result
szMessage Response from SMS provider
szNumberOfContacts Number of contacts the SMS was
sent to
szCreditsRequired Credits required
szCreditsRemaining Credits remaining
TouchPoint 5800+
OnFTPResult(boolean bSuccess, string szMessage, string szLocalFileName, string szRemoteFileName)
Triggered as the result of an ICR_FTPUpload() or ICR_FTPDownload() method.
Parameters
Examples
function OnSMSOutResult(bSuccess, szMessage, szNumberOfContacts, szCreditsRequired,
szCreditsRemaining)
{
if(bSuccess)
{
// It was successful, do something.
}
else
{
// It was not a success. Print the error to the output.
print("Error: " + szMessage);
}
}
OnFTPResult
Parameter Description Values
bSuccess FTP result
szMessage Response from FTP server
szLocalFileName Local file name
szRemoteFileName Remote file name
OnRemoteMessageReceived(integer nLicence, string szMessage)
Handles a message received directly from the specified licence number.
This receives messages over the internet via HTTP.
Parameter Description Values
nLicence Licence number
Parameters
Examples
function OnFTPResult(bSuccess, szMessage, szLocalFileName, szRemoteFileName)
{
if(bSuccess)
{
// It was successful, do something.
}
else
{
// It was not a success. Print the error to the output.
print("Error: " + szMessage);
}
}
OnRemoteMessageReceived
Parameters
Parameter Description Values
szMessage Received message
TouchPoint 6800+
OnWebResult(integer nID, integer nResult, string szData, string szType)
Triggered as the result of the following methods:
ICR_Web_Post()
ICR_Web_Get()
ICR_Web_Delete()
ICR_Web_Patch()
ICR_Web_Put()
Parameter Description Values
nID HTTP request ID
nResult HTTP response code
szData Response data
szType Response content-type
Examples
function OnRemoteMessageReceived(nLicence, szMessage)
{
print("Licence number: " + nLicence);
print("Message: " + szMessage);
}
OnWebResult
Parameters
Examples
dofile("etal\\lib\\json.moc");
This method replaces OnWebPostResult() in TouchPoint 2016 onwards.
Both events are still called regardless of the web operation; however, this method should be used.
TouchPoint 6200+
Deprecated. See OnWebResult .
OnWebPostResult(integer nID, string szData, string szType)
Triggered as a result of the ICR_Web_Post() method.
Parameter Description Values
nID HTTP request ID
szData Response data
szType Response content-type
dofile("etal\\lib\\HTTPStatusCode.moc");
function OnWebResult(nID, nResult, szData, szType)
{
// If our result was not successful.
if(nResult != 200)
{
print("HTTP Error: " + HTTPStatusCodeText(nResult));
}
if(szType == "application/json")
{
local tDeserialisedJSONData = JSONDeserialise(szData);
// Do something with the data.
}
}
Notes
OnWebPostResult
Parameters
Although deprecated, this event is triggered on a result of a web request.
Both OnWebPostResult() and OnWebResult() are called.
As of TouchPoint 2017, OnWebResult() should be used instead of OnWebPostResult() .
TouchPoint 6800+
OnVoucherResult(boolean bSuccess, string szVoucherCode, integer nJob, table tVoucherData = {})
Triggered as a result of the followingmethods:
ICR_Voucher_Create()
ICR_Voucher_SetActive()
ICR_Voucher_Get()
ICR_Voucher_Used()
Examples
dofile("etal\\lib\\json.moc");
dofile("etal\\lib\\HTTPStatusCode.moc");
function OnWebPostResult(nID, szData, szType)
{
// If our result was not successful.
if(nResult != 200)
{
print("HTTP Error: " + HTTPStatusCodeText(nResult));
}
if(szType == "application/json")
{
local tDeserialisedJSONData = JSONDeserialise(szData);
// Do something with the data.
}
}
Notes
OnVoucherResult
Parameter Description Values
bSuccess Voucher result
szVoucherCode Voucher code
nJob Request type
tVoucherData Voucher data from ICR_Voucher_Get()
Parameters
Examples
// Voucher request types
enum RequestType {CREATE = 1, SETACTIVE = 2, ADJUSTMENT = 3, GETINFO = 4};
function OnVoucherResult(bSuccess, szVoucherCode, nJob, tVoucherData)
{
if(bSuccess)
{
// Which request was made?
switch(nJob)
{
case RequestType.CREATE: // Voucher create
VoucherCreateHandler();
break;
case RequestType.SETACTIVE: // Voucher set active
VoucherSetActiveHandler();
break;
case RequestType.ADJUSTMENT: // Voucher adjustment
VoucherAdjustHandler();
break;
case RequestType.GETINFO: // Voucher get
VoucherGetHandler(tVoucherData);
break;
}
}
Version Description
7000 Added optional 4th parameter for result of
ICR_Voucher_Get() request.
else
{
// Something went wrong, handle the error.
VoucherErrorHandler(szVoucherCode);
}
}
Changelog
ICRTouch Standard Library
Name Type Description Values
REGPOS integer Current length of the
registration buffer
SELITEM integer Current selected item
INFINALISATION boolean In the middle of finalisation
MENULEVEL integer Current menu level
PRICESHIFT integer Current price shift {1st@,
2nd@, 3rd@, 4th@}
ORDERNUMBER integer Order number
ITEMCOUNT integer Number of items
TABLE integer Table number if a table is
in use
CHECK integer Check number if a check is
in use
DISPLAYNUMBER string Printed check/table number
CUSTOMER integer
Customer number if a
customer is currently
signed on
SUBTOTAL integer Current Subtotal
SUBTOTALPRESSED boolean Subtotal key pressed
DISCOUNT integer Current discount total on
the sale
POINTS integer Current points value of the
sale
Table value names
ICR_GetClerkBuffer_Index
Name Type Description Values
THISSALETOTAL integer Total for this sale {not inc
pbal check items}
DEPOSIT integer Deposit value currently
applied to sale
MODE integer Current mode number
STATUS integer Status flags
0x01 - Print full bill
0x02 - Cancel disabled
0x04 - Open cash drawer 1
0x08 - Open cash drawer 2
0x10 - Print check pick up
count on journal
BILLSTATUS integer Bill status flags
0x01 - Bill printed
0x02 - Service charge
removed
0x04 - Use tax
0x08 - Forced service
charge
0x10 - Discounted items
removed
0x20 - Contact details
collected
LOCATION integer Location ID number
ROOMNUMBER mixed PMS room number - Can be
alpha
ROOMTEXT string PMS Room Text
SPLITREPORTZONE integer Split reporting zone 1/2
PRICELEVEL integer Current price level
CONSECUTIVENUMBER integer Sale consecutive number
FINALISEDCONSECNO integer Consecutive number at
finalise
UNIQUESALEID integer Unique sale ID
IDCUNIQUESALEID integer IDC unique sale ID
FINALISED boolean Sale finalised, true/false
Name Type Description Values
FINALNETSALETOTAL integer Finalised sale total
BALANCEADJUSTMENT integer Customer balance
adjustment
EATINTAKEOUT integer Eat in/takeout status key
record
CLERK integer Current clerk
FREEMEALUSAGE integer Free school meal usage
CURRENTNETSALETOTAL integer
Current total including
service charge and add on
tax
CUSTOMER3RDPARTY string 3rd Party customer record
MULTIPLIER integer
Integer representing the
current multiply assuming
3 dp, eg 3500 is 3.5x
FROMSPLITSEAT integer
Displays which split
window the sale has been
assigned.
BILLSERIALNUMBER integer Bill serial ID attached to
this table/check
TAX'X'_NET integer Total before tax. Replace
'X' with the tax rate ID
TAX'X'_TAX integer Total tax added. Replace
'X' with the tax rate ID
COVERS integer Covers
WEIGHT integer Current weight on
integrated scale
Name Type Description Values
NAME string Clerk buffer item line name
PRICE integer Sales price
ICR_GetClerkBuffer_Item
Name Type Description Values
SEAT integer Assigned seat number
FILE integer Item file
RECORD integer Item record
QUANTITY integer Quantity of PLU
SALESQUANTITY integer Quantity x @Qty
FROMLISTPLU integer List PLU ID
FLAG1 integer Flag 1 status flags
0x01 - Customer discount
applied
0x02 - Points applied
0x04 - Last item
0x08 - Item has come
from check
0x10 - M&M has been
applied
0x20 - Item has been
corrected
0x40 - Slip printed
0x80 - Consolidation has
been printed
FLAG2 integer Flag 2 status flags
0x01 - Is condiment item
0x02 - Price shift 2
0x04 - Price shift 3
0x08 - Is Euro
0x10 - Straight number
i.e. check transfer
0x20 - Is weight item
0x40 - Price shift 4
FROMSETMENU integer Set menu ID
SETMENUITEM integer Set menu count
MIXANDMATCH integer *Not supported - No values
returned.
NETPRICE integer Sales price less
adjustments
PRICELEVEL integer Price level item was
registered on
ITEMID integer ID number of the item
Name Type Description Values
NUMBER integer Check/table number
ICR_GetCheck_Index
Name Type Description Values
TABLE boolean True if table, false if check
NAME string Check text
OPEN integer 1 if Open, 0 if closed
BUSY integer 1 if Busy, 0 if free
PICKUPCOUNT integer
Number of times the
check/table has been
opened and closed.
LOCATION integer Location ID
CUSTOMER integer
Customer number if a
customer is currently
signed on
HEADER1 string Receipt header line 1
HEADER2 string Receipt header line 2
FINALSALECONSECNUMBER integer Consecutive number at
finalise
DETAILLENGTH integer Length of the check detail
SERIALNUMBER integer Bill serial number
CHECKTOTAL integer Check total
ITEMCOUNT integer Number of items
COVERS integer Number of covers
BILLSTATUS integer
Bill status flags
0x01 - Bill printed
0x02 - Service charge
removed
0x04 - Use tax
0x08 - Forced service
charge
0x10 - Discounted items
removed
DEPOSIT integer Deposit value
EATINTAKEOUT integer Eat in take out status key
MANUALSERVICECHARGE integer Service charge
LASTUSEDDAY integer Last day used
LASTUSEDTIME integer Last time used
PAYTABLECODE string PayTable code
PREAUTHAMOUNT integer Pre-auth amount (EFT)
PREAUTHCODE integer Pre-auth code (EFT)
Name Type Description Values
CLERK integer Last clerk
UNIQUESALEID integer Unique sale ID
TAX'X'_NET integer Total before tax. Replace
'X' with the tax rate ID
TAX'X'_TAX integer Total tax added. Replace
'X' with the tax rate ID
Name Type Description Values
NAME string Check details item name
PRICE integer Sales price
SEAT integer Assigned seat number
FILE integer Item file
RECORD integer Item record
QUANTITY integer Quantity of PLU
SALESQUANTITY integer Quantity x @Qty
FROMLISTPLU integer List PLU ID
FLAG1 integer Flag 1 status flags
0x01 - Discount applied
0x02 - Points applied
0x04 - Last Item
0x08 - Item has come
from check
0x10 - M&M has been
applied
0x40 - Slip printed
0x80 - Consolidation has
been printed
ICR_GetCheck_Item
Name Type Description Values
FLAG2 integer Flag 2 status flags
0x01 - Is condiment item
0x02 - Price shift 2
0x04 - Price shift 3
0x08 - Is Euro
0x10 - Straight number
i.e. check transfer
0x20 - Is weight item
0x40 - Price shift 4
FROMSETMENU integer Set menu ID
SETMENUITEM integer Set menu item
MIXANDMATCH integer *Not supported - No values
returned.
NETPRICE integer Sales price less
adjustments
PRICELEVEL integer Price level item was
registered on
Name Type Description Values
LENGTH integer Receipt buffer length
FINALISED boolean Indicates that the sale has
been finalised
TABLE integer Table number
CHECK integer Check number
DISPLAYNUMBER string Printed check/table number
PRINTED boolean If the receipt has been
printed
CUSTOMER integer If there was a customer on
the sale
CONSECUTIVENUMBER integer The consecutive number
DATE integer Format: ddmmyyyy
TIME integer Format: hhmm
TERMINALID integer Terminal id that the sale
was started on
ICR_GetReceipt_Header
Name Type Description Values
MODE integer Registration mode
Name Type Description Values
TEXT string Text data that is printed
FILE integer Item file
RECORD integer Item record
QUANTITY integer Item Quantity
PRICE integer Item Price
FLAG integer Status flags
0x0001 - Is condiment item
0x0002 - Consolidation
printed
0x0004 - Is Euro
0x0008 - Straight number
i.e. check transfer
0x0010 - No price
0x0020 - Set menu item
0x0040 - Force no quantity
0x8000 - Full text line
Name Type Description Values
status integer Result code from the
request
0 - Ok
3 - Etal parameter error
101 - KP Controller failed
to start
102 - KP Controller not
licenced
103 - Machine not KP
Controller
message string Message describing the
result code
kp_tickets array Array of KP Ticket index
entry objects (see below)
ICR_GetReceipt_Line
ICR_KPC_GetKPTicketList
Name Type Description Values
update_counter string The current update counter
Should be stored stored as
string as it may overflow
32 bit integer storage
current_id integer Current ID
demo_mode boolean Optional boolean indicating
if in demo mode
True if the KP Controller is
running in demo mode
Name Type Description Values
id array Ticket ID
time string Creation DateTime
kp_flag integer KP mask flag
0x0001 - KP/KV1
0x0002 - KP/KV2
0x0004 - KP/KV3
0x0008 - KP/KV4
0x0010 - KP/KV5
0x0020 - KP/KV6
0x0040 - KP/KV7
0x0080 - KP/KV8
0x0100 - KP/KV9
0x0200 - KP/KV10
0x0400 - KP/KV11
0x0800 - KP/KV12
kp_flag_finished integer KP mask for finished status See above
kp_flag_pegged integer KP mask for pegged status
time string DateTime that the kp
ticket was created
kp_ticket_status string Ticket status Current text status of the
ticket
finished_time string Finished DateTime
last_status_change string DateTime of the last time
the status was changed
network_delayed boolean
Indicates that the kp ticket
was sent from a satellite at
a time later than when the
transaction was completed
KP Ticket index entry
Name Type Description Values
update_counter string
The update counter at the
time when the ticket was
large change
Name Type Description Values
status integer Result code from the
request
0 - Ok
1 - KP Ticket not found
2 - KP Ticket does not
exist on storage
3 - Etal parameter error
101 - KP Controller failed
to start
102 - KP Controller not
licenced
103 - Machine not KP
Controller
message string Message describing the
result code
demo_mode boolean Present if KPC is running in
demo mode
True if KP Controller is
running in demo mode
kp_tickets array Array of kp ticket detail
objects (see below)
sort_texts array
Array of texts associated
with sort_number s
supplied with KP Ticket
Items (see below)
Name Type Description Values
id array Array of tickets
index_entry object Contains the kp ticket's
KP Ticket index entry
terminal_id integer Terminal ID
item_count integer Item count
consecutive_number integer Consecutive number
ICR_KPC_GetKPTickets
KP Ticket details
Name Type Description Values
covers integer Covers
training_mode boolean Training mode
refund_mode boolean Refund mode
net_sale_total string Net sale total
sale_id string Sale ID
order_number integer Order number
check_number integer Table/check number
is_table boolean Table/check true - Table
false - Check
check_text string Check text
eat_in_take_out_record integer Redacted do not use. See
eat_in_take_out
Will be removed in 2024
eat_in_take_out_text string Redacted do not use. See
eat_in_take_out
Will be removed in 2024
from_webshop boolean Sale from webshop
webshop_sale_id integer Webshop sale ID
misc_etal_flag integer Misc Etal flag
items array
Array of kp ticket item
objects (See KP Ticket -
items)
from_webshop boolean From webshop flag true - From webshop
false - From TouchPoint
webshop_saleid integer Webshop sale ID
additional_order_info_line
s array Array of order info line
strings
Name Type Description Values
order_notes array Array of order note strings
webshop_customer_info array Array of customer info
objects
clerk object
Describes the clerk that
was used on the sale. See
KP Ticket - clerk
price_level object Price level that was in use.
See KP Ticket - price_level
terminal object
Terminal that the sale
originated from. See KP
Ticket - terminal
customer object
If a loyalty customer was
used with the sale. See KP
Ticket - customer
location object
The customer's seating
location. See KP Ticket -
location
eat_in_take_out object
If an eat in take out status
was set. See KP Ticket -
eat_in_take_out
xml_socket_sale boolean
Used to indicate that the
sale originated from the
XML socket. For example:
PocketTouch or the TTA
system
true - The sale originated
from the XML socket.
false or not present -
The sale was created at
the terminal
webshop_order_reference string
Contains the Order
Reference as supplied for a
webshop sale. Derived
from, but not necessarily
the same as the
webshop_saleid .
tta_table_location object
If TTA table location is
passed, this object will
contain that data. See KP
Ticket - tta_table_location
Name Type Description Values
number integer Number of the clerk
KP Ticket - clerk
Name Type Description Values
name string Name of the clerk
Name Type Description Values
number integer Price level that was used 1 - 9
name string Name of the price level
Name Type Description Values
number integer Till number
name string Till name
Name Type Description Values
number integer Number of the customer
name string Customer name
address array Up to 4 lines of address
postcode string Postcode
phone_number_1 string Primary phone number
notes array Up to 4 lines of notes
against the customer
Name Type Description Values
number integer Location number
name string Location text
KP Ticket - price_level
KP Ticket - terminal
KP Ticket - customer
KP Ticket - location
Name Type Description Values
number integer Eat in / take out status key
record number
name string Text of eat in take out
status key
Name Type Description Values
text string The text title for the table
location eg 'Table No:'
value string The value of the table
location eg '5'
Name Type Description Values
item_number integer Row number in the output
file integer File number
record integer Record number
key_type integer The key type number when
the row is a function key
item_status string Item status
text string PLU descriptor
quantity string Quantity
price string Price
net_price string Net price
reg_status_1 integer Reg status 1 flag
reg_status_2 integer Reg status 2 flag
KP Ticket - eat_in_take_out
KP Ticket - tta_table_location
KP Ticket - items
Name Type Description Values
kp_flag integer KP mask flag
0x0001 - KP/KV1
0x0002 - KP/KV2
0x0004 - KP/KV3
0x0008 - KP/KV4
0x0010 - KP/KV5
0x0020 - KP/KV6
0x0040 - KP/KV7
0x0080 - KP/KV8
0x0100 - KP/KV9
0x0200 - KP/KV10
0x0400 - KP/KV11
0x0800 - KP/KV12
kp_flag_finished integer KP mask flag for the
finished status of the item See above
print_red boolean True if item is set to print
in red
from_setmenu integer Set menu ID
setmenu_item integer Set menu list item
from_listplu integer List PLU ID
seat integer Seat number
plu_alt_text string PLU Alternative text
misc1 integer Misc 1 flag
misc2 integer Misc 2 flag
parent_item_number integer Parent item number
finished_time string Finished DateTime
kp_category integer
The KP Category, including
possible temporary shift, of
the item
PLU only
department integer The department that the
item belongs to PLU only
plu_group integer The PLU Group that the
item belongs to PLU only
sort_number integer The integer number used
for sorting.
See sort_texts in KP
Tickets Object
Name Type Description Values
source_items array
An array of source item
numbers, these should be
used when changing the
status of an item
Name Type Description Values
number integer Number of sort, from
sort_number in KP Item.
text string Displayable text of the sort
Name Type Description Values
number integer Field type ID
1 - Name
2 - Company
3 - Address 1
4 - Address 2
5 - City
6 - Postcode
7 - Phone
8 - Email
field string Field description
name
company
address1
address2
city
postcode
phone
email
text string Field value
Name Type Description Values
VERSIONINFO string Version name
VERSIONID integer Version ID
LICENCENUMBER integer Licence number
KP Sort Texts
Webshop customer info
ICR_GetSystemData
Name Type Description Values
MODE integer Current mode
CURRENTCLERK integer Current clerk
RECEIPTON boolean Receipt on/off status
CHECKMASTER integer Check master ID
CHECKBACKUPMASTER integer Check backup master ID
CHKBKUPMSTR_OFFLINE boolean Indicates the offline status
of the check backup master
true if currently offline
else false
CUSTOMERMASTER integer Customer master ID
TIMEATTMASTER integer Time & attendance master
ID
HARDWAREPLATFORM string ** May not be supported -
Windows platform
XRES integer X resolution
YRES integer Y resolution
SCRIPTLOCATION string Script path
PAYCODEDAYSLEFT integer Days until payment code
expiry
9999 - Payment code
entered
SCREENSAVERON boolean Whether the screensaver is
currently running
TERMINALID integer Terminal ID
DRAWEROPEN boolean Drawer open status
IDCLASTSTATUS string IDC Uploader last status
IDCUPLOADED integer Number of sales uploaded
IDCPENDING integer Number of sales pending
upload
Name Type Description Values
NUMBER string Customer number
NAME string Customer name
DISCOUNTPER integer % discount
ICR_Get3rdPartyCustomer
Name Type Description Values
DISCOUNTFLAG integer Discount flags 0x0001 - Discount
Cheapest Items Only
DISCOUNTAMT integer Discount amount
DISCOUNTREC integer Discount key record
number
POINTS integer Current points
BALANCE integer Current balance
AVAILABLEBAL integer Current available balance
PRICELEVEL integer Customer price level
OTHERFLAG integer Defined by scripts. ie.
Coffee Shop
NOTALLOWEDSIMASK integer Disallowed selective
itemisers
DISCOUNTSI1 integer % Discount rate selective
itemiser 1
DISCOUNTSI2 integer % Discount rate selective
itemiser 2
DISCOUNTSI3 integer % Discount rate selective
itemiser 3
DISCOUNTSI4 integer % Discount rate selective
itemiser 4
DISCOUNTSI5 integer % Discount rate selective
itemiser5
TOTALDISCOUNTED integer Current total amount
discounted
ACCOUNTTENDERED integer Current amount finalised
to account
POINTSREDEEMED integer Points redeemed on sale
PAYMENTTOACCOUNT integer Payment to account this
sale
INTERNALFLAG integer Status flags
0x0001 - No Points
0x0002 - No Balance
0x0004 - Enforce Receipt
SHIFTTOMENULEVEL integer Customer set menu level
Name Type Description Values
LEFT integer Left position
TOP integer Top position
WIDTH integer Image width
HEIGHT integer Image height
Name Type Description Values
WIDTH integer Image width
HEIGHT integer Image height
Note:
1. Not all printers support native QR Code printing.
2. For Epson printers use the Epson TM-T88V driver.
3. TouchPoint will revert to graphics printing for printers that do no support QR Code
printing.
4. Not all features are supported when in graphics printing mode.
Name Type Description Values
data string The data to be encoded
into the QR Code https://www.icrtouch.com
model integer The model to be used for
the QR Code
1 - The original QR Code
design
2 - The improved QR Code
that can hold more data
3 - The micro QR Code
ICR_GetWindowDimensions
ICR_GetImageSize
ICR_OutputQRCode
Name Type Description Values
modulesize integer
The size of on an individual
module
If this is set too high the
printer will not print the QR
code.
1 - 16
eclevel integer Error correction level to be
used
0 - Low / 1 - Medium / 2 -
Quartile / 3 - High
graphicsmode boolean
Sends the QC code to the
printer as a a graphic
image.
'True' - printed in graphics
mode else native printing
mode.
highresgraphics boolean
When in graphics mode set
to true to use high res
printing (24 bit)
'True' - high res / thermal
printing.
hjustify string Horizontal justification of
the QC code 'left' / 'centre' / 'right'
machine integer Machine number that the
printer is connected to
0 for this machine, or a
terminal number
port integer Port number that the
device is connected to
eg 1 - COM1 / 11 - IP
Printer 1
ICRTouch Standard Library
Description Value
COM 1 1
COM 2 2
COM 3 3
COM 4 4
COM 5 5
COM 6 6
COM 7 7
COM 8 8
Printer display 9
Not connected 10
IP printer 1 11
IP printer 2 12
IP printer 3 13
IP printer 4 14
IP printer 5 15
IP printer 6 16
IP printer 7 17
IP printer 8 18
IP printer 9 19
IP printer 10 20
IP printer 11 21
IP printer 12 22
IP printer 13 23
IP printer 14 24
IP printer 15 25
Constant values
Device numbers
Description Value
IP printer 16 26
OPOS 1 27
LPT 1 28
LPT 2 29
OPOS 2 30
OPOS 3 31
OPOS 4 32
OPOS 5 33
OPOS 6 34
XML socket 35
Billstore buffer 36
Description Value
Time 20
Date 40
Hex 21
Password 24
24 bit colour 29
PLU 44
Description Value
String with no title 5
Program item alt types
Integers
Strings
Description Value
Password 35
Description Value
Left 0
Centre 1
Right 2
Description Value
Top 0
Centre 1
Bottom 2
Description Value
Clerk name 0
Date 1
Time 2
Mode 3
Price level 4
Check number 5
Text horizontal alignment
Text vertical alignment
Window IDs
Description Value
Device status 1 6
Device status 2 7
Device status 3 8
Device status 4 9
Device status 5 10
Device status 6 11
Device block 1 12
Device block 2 13
Device block 3 14
Device block 4 15
Device block 5 16
Device block 6 17
Subtotal 18
Item count 19
Picture 20
Etal Script 21
Description Value
Close down 0
Registration 1
Refund 3
X mode 4
Z mode 5
Manager mode 6
Home mode 7
Program 1 8
Program 2 9
Program 3 10
Modes
Description Value
Program 4 11
Program 5 12
Program 6 13
Program 7 14
Description Value
Standard 0
Time 1
Weight 2
String 3
Date 4
Description Value
Before Print 1
After Print - Ok 2
After Print - Stopped 3
Report Z Reset 4
Description Value
Yes/No 1
String 2
Number 3
GetNumber types
ReportEvent types
DataEntryDialog data types
Description Value
Drop Down Window 4
Ok 10
Lookup Post Code 42
Value Description
Department 0
PLU Group 1
Finalise Key Type 2
Transaction Key Type 3
Status Key Type 4
In Drawer Links 5
Report Codes 6
Price Level Change With No Price Level Change) 7
Device List 8
File List 9
List PLU 10
Baud Rates 11
Parity 12
Data Bits 13
Stop Bits 14
Device Port 15
DataEntryDialog drop down window types
Value Description
Customer Groups 16
Keyboard Menu Shifts 17
Price Shifts 18
Clerk for Sign on Button 19
Batch Report 20
Report Codes (Inline) 21
PLU Group (PLU Group Search) 22
Tax Rate for PLU 23
Customer Loyalty Type 24
Day of Week 25
Connected Terminals 26
Cash Drawer Device Type 27
Price Levels 28
Sort Type 29
Locations 30
Reserved 31
Hotel System 32
Currency 33
PocketTouch Operation Type 34
Price Level With Prompt 35
Default Menu Level for Clerk 36
Mix & Match 1 37
Value Description
Mix & Match Type 38
Kitchen Video Type 39
Kitchen Video - “Number at top is” 40
Rounding Method 41
Check Type 42
Employee Shift 43
Employee Job 44
Transaction Keys 45
EFT System 46
Finalise Keys 47
Skin 48
Sale Total Rounding Method 49
In drawer Link With Prompt 50
Import Type 51
Product Group Item Type 52
Set Menu 53
KP Sorting Method 54
KP Category 55
Department With None 56
PLU Group With None 57
Customer Group With None 58
Preset Message 59
Value Description
Network Protocol 60
Shelf Edge Label Item Type 61
Horizontal Justification 62
Vertical Justification 63
Unit Size 64
Network Adapter 65
Etal Window 66
In Drawer Link With None 67
DynDNS Service 68
Webshop Sale Destination 69
Text Prediction Caps Type 70
KP Category for KP Category Shift Key 71
View Receipts Key Source 72
Sub Department 73
Status Keys 74
Status Keys With None 75
Reasons 76
Country 77
Key Type for Reasons 78
KP Alt Text Usage 79
Rebuild Receipt from REG Buffer Type 80
Price Shifts With None 81
Description Value
Receipt 0
Kitchen Printer 1
Bill 2
Ticket 3
Customer Detail 4
XML Socket Journal 5
Remote Receipt 6
Webshop Store 7
Receipt Rebuild 8
Description Value
Receipt 0
Bill 1
Voucher 2
Ticket 4
Description Value
Gift card 1
Discount 2
Order info destinations
BeforePrint types
Voucher types
Description Value
Disable consolidation of the registration buffer 0x00000001
Prevent the cashier from being floated 0x00000002
Prevent the cashier from being interrupted 0x00000004
Current sale control flags
ICRTouch Standard Library
Keytype Description
1 Cash
2 Cheque
3 EFT
4 Account
5 Hotel Transfer
6 Subtotal
7 New Balance
8 Price Inquire
9 Price Change
10 Plu Picture
11 Cash 2
12 Stock Inquire
13 Voucher Finalise
14 Voucher Transaction
19 Media Exchange
20 Paid Out
21 Received On Account
22 Deposit
23 Pay Account
Keytype list
Keytype Description
24 Enable Tax
25 Plus Amount
26 Minus Amount
27 Plus Percent
28 Minus Percent
29 Exchange Points
30 Plu Notes Inquire
31 Points Adjustment
32 Tips
33 Refund
36 Cancel
37 Error Correct
40 No Sale
41 Non-Add Number
42 Order Number
43 Text Message
44 Card Capture
45 Fidelity Loyalty Key
46 Change Check Text
47 Edit Customer
48 GFX KP Message
49 Preset Text Message
Keytype Description
50 Plu Number
51 Defer
52 Category Shift
53 Seat Number
54 Gift Receipt
58 Plu Group Search
59 View Journal
61 Edit Floorplan
62 Floorplan
63 Till Watch
68 Suspend
69 Resume
70 Price Shift
71 Receipt On Off
72 Clerk
73 Multiply
74 Customer Number
75 Sign Off
76 Receipt Print
77 Download Graphic Logo
78 Slip Print
79 Customer Inquiry
Keytype Description
80 Hot Card
81 Customer Transfer
82 View Customer Detail
83 Caller ID
84 Customer Biometrics
88 Weight Key
90 Reg Down Arrow
91 Reg Up Arrow
92 Check Transfer
93 New Check
94 Old Check
95 New Old Check
96 List Plu
97 Covers
98 Split Check
99 Service Charge
100 Euro Shift
101 Location
102 Currency Exchange
103 Table Reservation
105 Clock In
106 Clock Out
Keytype Description
107 Break In
108 Break Out
109 Validation
110 Script
111 Macro
114 House Bon
159 Menu Shift 2
160 Menu Shift
161 Escape
162 Price Level Change
163 Eatin
164 Takeout
165 Sale Item Import
166 Global Eatin Takeout
172 Auto Clerk
173 View Active Clerks
174 Clerk Change
176 Go Dutch
177 Send to KP Now
178 Plus Item
195 View Open Checks
196 View Paid Checks
Keytype Description
197 View Receipts
198 View Reports
209 Launch Batch File
210 Inline Functions
211 Clerk Functions
212 Send
213 Receive
214 Backup/Restore
215 Minimise TouchPoint
216 Cash Declaration
217 Cash Declaration 2
220 Period 1 Report
221 Period 2 Report
222 Period 3 Report
224 Batch Report
225 Inline Period 1 Report
226 Inline Period 2 Report
227 Inline Period 3 Report
228 Inline BatchReport
229 RF Upload
230 Registration Mode
231 X/Z Mode
Keytype Description
232 Program Mode
233 Home Mode
234 Close Down
235 Refund Mode
236 Manager Mode
238 Clean Screen
239 Lock Terminal
240 Number 0
241 Number 1
242 Number 2
243 Number 3
244 Number 4
245 Number 5
246 Number 6
247 Number 7
248 Number 8
249 Number 9
250 Number 00
251 Number 000
252 .'
253 Clear
1000 PLU

ICRTouch Standard Library
Initial release
Method Type Information
ICR_MailConfigure Add
ICR_MailSendSimple Add
ICR_MailAddRecipient Add
ICR_MailSetSubject Add
ICR_MailAddToMessage Add
ICR_MailAddToMessageLine Add
ICR_MailAddAttachment Add
ICR_MailReset Add
ICR_MailSend Add
OnEmailOutResult Add
OnKPDeviceRequested Add
ICR_UpdateCheckIndexFile Add
ICR_ProgramSendFile Add
Appendix
Revision history
TouchPoint 2011 v2.56.0 - VID: 5600 - February 2011
TouchPoint 2012 v2.58.0 - VID5800 - May 2012
Method Type Information
ICR_ProgramReceiveFile Add
ICR_SendSMS Add
OnSMSOutResult Add
ICR_PlayMacro Add
OnNewCustomer Add
ICR_FTPConnect Add
ICR_FTPDisconnect Add
ICR_FTPUpload Add
ICR_FTPDownload Add
OnFTPResult Add
ICR_ResetTotals Add
Method Type Information
ICR_FTPConnect Removed
ICR_FTPDisconnect Removed
ICR_FTPConfigure Add
ICR_MailConfigure Modified HTML email support added
Method Type Information
ICR_AdjustTotals Add
TouchPoint 2012 v2.58.3 - VID5830 - September 2012
TouchPoint 2013 v2.60.0 - VID6000 - July 2013
Method Type Information
AfterRegItemSelect Add
ICR_GetNumberDialog Modified Added ability to specify input type
ICR_PrintImage_Start Add
ICR_PrintImage_Print Add
ICR_PrintImage_DrawBox Add
ICR_PrintImage_DrawText Add
ICR_PrintImage_DrawFrame Add
ICR_PrintImage_DrawPixel Add
ICR_PrintImage_DrawImage Add
ICR_PrintImage_DrawQRCode Add
ICR_PrintImage_GetQRWidth Add
ICR_PostCodeLoopkUp Add
OnReportEvent Add
ICR_ToPassword Add
ICR_FromPassword Add
ICR_DataEntryDialog Add
ICR_DataEntryDialog_AddItem Add
date Mod Month now returns as 1-12 {was 0-
11}
Method Type Information
TouchPoint 2013 v2.60.2 : VID6020 - September 2013
ICR_SelectItem Add
Method Type Information
ICR_GetNumberDialog Modified Now accepts and returns type 3,
string
Method Type Information
ICR_GetUTCTimeBias Add
ICR_DrawPie Add
ICR_FloodFill Add
ICR_GetPixel Add
ICR_SetFeature Add
ICR_SysProc Add
ICR_Web_Reset Add
ICR_Web_SetURL Add
ICR_Web_SetPostData Add
ICR_Web_Post Add
OnWebPostResult Add
ICR_File_OpenPipe Add
OnFile_ReadPipeResult Add
ICR_CreateHMAC Add
TouchPoint 2013 v2.60.3 - VID6030 - November 2013
TouchPoint 2014 v2.62.0 - VID6200 - August 2014
Method Type Information
PreSaleFinalised Add
BeforeFinalise Add
ICR_SysProc Modified Added OPENDRAWER
Method Type Information
InsertAdditionalOrderInfo Add
AfterExtCustomerLogOn Add
ICR_AdjustCustomer Add
ICR_SetNextDialogInput Add
AfterFullDataReset Add
ICR_Web_Post Modified SSL/TLS support
BeforePrint Modified Now supports bill prints (Type 1)
ICR_SendToKeyboard Modified Deprecated
Method Type Information
ICR_SetEtalSaleFlag Add
ICR_Web_SetHeaderField Add
ICR_Web_Get Add
ICR_GetSystemData Modified Added TERMINALID & DRAWEROPEN
OnWebPostResult Modified Added szResult Param
TouchPoint 2014 v2.62.1 - VID6210 - October 2014
TouchPoint 2014 v2.62.1 - VID6210 - October 2014
TouchPoint 2016 v2.66.0 - VID6600 - June 2016
Method Type Information
ICR_GetClerkBuffer_Index Modified Added FROMSPLITSEAT
Method Type Information
ICR_GetSystemData Modified Added IDCLASTSTATUS
Method Type Information
ICR_LoadImage Modified Absolute file paths can now be used
Method Type Information
ICR_Attach_Window Add
ICR_MakeNumberString Add
ICR_GetEmployeeLastTAOP Add
ICR_OutputLine Add
ICR_SetCustomPLUData Add
ICR_GetCustomPLUData Add
ICR_EncryptAES Add
ICR_DecryptAES Add
ICR_CreatePBKDF2 Add
TouchPoint 2016 v2.66.1 - VID6610 - July 2016
TouchPoint 2016 v2.66.3 - VID6630 - November 2016
TouchPoint 2016 v2.66.5 - VID6650 - March 2017
TouchPoint 2017 v68.00 - VID6800 - October 2017
Method Type Information
ICR_EHP_Output Add
ICR_EHP_SetFilePos Add
ICR_EHP_SetHeader Add
ICR_Web_Put Add
ICR_AddToClerkBuffer_Item Add
ICR_Voucher_Create Add
ICR_Voucher_SetActive Add
ICR_Voucher_Used Add
OnWebResult Add Replaces OnWebPostResult
OnWebPostResult Modified Deprecated
ICR_GetSystemData Modified Added IDCUPLOADED & IDCPENDING
ICR_ProgramItem_SetAltType Modified Added Type 44 - PLU
ICR_GetClerkBuffer_Index Modified Add Tax Totals
Method Type Information
ICR_Voucher_Get Add
ICR_GetImageSize Add
ICR_EHP_GetPostData Add
ICR_GetClerkBuffer_Index Modified Added BILLSERIALNUMBER
ICR_Web_SetHeaderField Modified Increased the capacity from 100 to
200 bytes
ICR_FromPassword Modified Increased capacity to 1000 chars
ICR_ToPassword Modified Increased capacity to 1000 chars
TouchPoint 2019 v70.10 - VID7010 - January 2019
Method Type Information
ICR_Voucher_Create Modified Added MAXUSES and SITE
ICR_Web_Delete Add
ICR_Web_Patch Add
Method Type Information
ICR_GetClerkBuffer_Index Modified Added DISPLAYNUMBER
ICR_GetReceipt_Header Modified Added DISPLAYNUMBER
ICR_GetClerkBuffer_Index Modified
With the addition of DISPLAYNUMBER
the CHECK / TABLE fields should not
be used to draw the number to the
screen. These should only be used
for comparison or to check to see if a
table/check is open.
ICR_GetReceipt_Header Modified
With the addition of DISPLAYNUMBER
the CHECK / TABLE fields should not
be used to draw the number to the
screen. These should only be used
for comparison or to check to see if a
table/check is open.
ICR_GetClerkBuffer_Index Modified Added WEIGHT
ICR_GetDateDialog Add
OnVoucherPrint Add
ICR_SetPGMData Modified
Added 4th parameter to facilitate the
upload the modified program data to
TOW
ICR_ShellExecute Add
ICR_PlaySound Add
ICR_PrintImage_DrawText Modified Added support for UTF-8 characters
ICR_DrawText Modified Added support for UTF-8 characters
TouchPoint 2020 v72.00 - VID7200 - February 2020
Method Type Information
ICR_SetLocalUserData Modified Performance improvements
ICR_SetGlobalUserData Modified Performance Improvements
TouchPoint 2021 v74.00 - VID7400 - December 2020
Method Type Information
AfterXMLSocketSendSale Add
ICR_File_OpenPipe Modified Support for multiple concurrent pipes
ICR_File_WritePipe Add
Method Type Information
XMLSocketCheckPayment Add
ICR_GetCheck_Index Add
ICR_GetCheck_Item Add
Method Type Information
ICR_DrawImage Modified Fixed drawn artifacts
Method Type Information
ICR_SysProc Modified Added EXIT & MINIMIZE commands
TouchPoint 2021 v74.06 - VID7406 - June 2021
TouchPoint 2021 v74.12 - VID 7412 - November 2021
TouchPoint 2022 v76.00 - VID 7600 - March 2022
Method Type Information
ICR_RedrawScreen Modified Any open dialogs are undrawn when
ICR_RedrawScreen() is called.
Method Type Information
ICR_LocalTimeFromUTC Add
ICR_LocalTimeToUTC Add
Method Type Information
ICR_EHP_GetRequestMethod Add
ICR_EHP_GetRequestHeader Add
ICR_KPC_GetKPTicketList Add
ICR_KPC_GetKPTickets Add
ICR_KPC_SetKPTicketStatus Add
ICR_KPC_SetKPTicketItemsStatus Add
ICR_KPC_StoreData Add
ICR_KPC_GetData Add
AfterKPCUpdate Add
TouchPoint 2022 v76.01 - VID 7601 - April 2022
TouchPoint 2022 v76.03 - VID 7603 - June 2022
TouchPoint 2022 v76.04 - VID 7604 - June 2022
Method Type Information
ICR_KPC_GetKPTickets Modified Added index_entry header into the
ticket body
Method Type Information
ICR_KPC_GetKPTickets Modified Added 4th parameter for ticket item
sorting.
Method Type Information
ICR_DrawBox Modified Performance enhancements
ICR_DrawFrame Modified Performance enhancements
ICR_DrawPixel Modified Performance enhancements
ICR_CreateFont Modified Performance enhancements
ICR_DrawText Modified Performance enhancements
ICR_SetText_Colour Modified Performance enhancements
ICR_SetText_HAlign Modified Performance enhancements
Method Type Information
AfterKPCUpdate Modified
Finished ticket items that will also
finish the ticket will also now trigger
a ticket status change.
TouchPoint 2023 v76.05 - VID 7605 - June 2022
TouchPoint 2023 v78.08 - VID 7608 - August 2022
TouchPoint 2022 v76.09 - VID 7609 - September 2022
TouchPoint 2022 v76.13 - VID 7613 - November 2022
TouchPoint 2023 v76.15 - VID 7615 - January 2023
Method Type Information
AfterXMLSocketSendSale Modified Added webshop sale information
Method Type Information
ICR_KPC_AlterKPFlag Add
ICR_KPC_GetTicketList Modified
Added 4th parameter
szSinceUpdateCounter .
Returns KP tickets only with updates
since the supplied update counter.
ICR_KPC_GetKPTickets Modified
Added customer , clerk ,
price_level , terminal , location &
eat_in_take_out objects.
Method Type Information
ICR_KPC_GetKPTickets Modified Added webshop_order_reference &
tta_table_location fields.
Method Type Information
ICR_Set_CurrentSaleControlFlag Add
ICR_Get_CurrentSaleControlFlag Add
ICR_GetClerkBuffer_Item
Modified Added ITEMID field
Method Type Information
ICR_GetHealthCheck Add
TouchPoint 2023 v78.03 - VID 7803 - March 2023
TouchPoint 2023 v78.08 - VID 7808 - June 2023
TouchPoint 2023 v78.11 - VID 7811 - September 2023
TouchPoint 2024 v80.00 - VID 8000 - March 2024
Method Type Information
ICR_Web_SetHeaderField Modified
Increased the maximum size of
individual HTTP POST header fields to
4,000 bytes, and the total POST
header size to 20,000 bytes.
Method Type Information
ICR_OutputQRCode Add Prints QR Codes
TouchPoint 2025 v82.02 - VID 8202 - July 2025
TouchPoint 2025 v82.06 - VID 8206 - September 2025