Skip to main content

PayComplete™™ Help Center

Receipt files and upgrading

All configuration files for Connect on-Device, including receipts, are stored in the resources folder.

The resources folder contain the following sub folders:

  • configurable — the contents of this folder is unchanged when you upgrade to a later version of Connect on-Device.

  • default — this folder is a mirror of the configurable folder but as it appears in the later version. That is, the default files for the later version. The files in this folder are only used when you use the Default button in Connect on-Device Studio.

  • static — the contents of this folder is updated with whatever the later version of Receipt Builder contains.

Receipt files and upgrading

The receipt files for the header and footer for all Connect on-Device receipts are stored in [installation folder]\resources\configurable\receipts. Any changes you make to the header or footer are automatically persisted if you upgrade to a later version of Connect on-Device.

The main receipt files for all individual receipts are stored in [installation folder]\resources\static\receipts.

There is one subfolder for each receipt type. These subfolders contain the project file, the layout file, and the data files for each receipt type. They also contain an additional file called DataTemplate.xml. It's an internal file used by the software to generate receipt data and should not be modified.

Important

Don't modify the DataTemplate.xml file.

The main receipt files are stored in the static folder, which means that any modifications you make to the body of a receipt is lost when you upgrade to a later version of Connect on-Device. The data for receipts may change between versions and there is no guarantee that modified receipt files are compatible with a later versions of Connect on-Device. However, the data for header and footer is backward compatible.

It is very important that you always keep a backup of your locally modified receipt files. Don't use the target folder for backups.

Important

Make a backup of the custom receipt files in the static folder before upgrading Connect on-Device.

After upgrading Connect on-Device, you need to add the custom receipt files to the static folder again. Before adding the custom receipt files to the static folder, investigate what may have changed for the receipt in question in the later version of Connect on-Device. Pay special attention to the changes made to the data for that receipt type. Test to make sure that your custom receipt still works with the later Connect on-Device version.

Language files and upgrading

Connect on-Device has one main language file used by all receipts. The main language file is stored in [installation folder]\resources\static\i18n\receipts\receipt-printer.xml. Because the file is stored in the static folder, it is always overwritten when you install a later version of Connect on-Device. However, this main language file is only used when editing receipts in Receipt Builder. When a receipt is printed from Connect on-Device, it uses a language-specific version of the file.

The language-specific files have the same name, but with the ISO language code as a suffix. The language-specific files are located in the configurable folder, for example, [installation folder]\resources\configurable\i18n\receipts\receipt-printer_en.xml. The first time Connect on-Device is installed, or if you reinstall and select Clean Installation in the installer, receipt-printer_en.xml is generated as a copy of the standard language file. You can modify the receipt-printer_en.xml file copy and add new languages with the translation tool in Connect on-Device Studio.