Skip to main content

PayComplete™™ Help Center

Create a new receipt — workflow

Creating a receipt from scratch is usually not something you do very often. If you are using the Connect on-Device SDK (Software Development Kit), you may want to create your own receipt. You can create a new receipt using Receipt Builder.

Create a work folder

Create a folder on your computer for the new receipt. It is recommended to create the folder in the Connect on-Device installation folder to automatically get the correct relative paths.

Receipt Builder needs to know the root folder for all receipt files to locate project files, such as images, headers and footers. When you open a standard receipt project from its default location it recognizes the path and automatically selects a root folder. If you have saved the receipt files in a different folder, the Select root folder for receipt files browser is opened.

Save custom images in the new folder

Save any custom images you intend to use in the new receipt folder.

Design a data format

  • Decide how the data should be presented on the receipt, that is, the format of the XML file generated by Receipt Builder.

  • The requirements are:

    • Use a standard XML file

    • Use <document> as the root tag in the XML file

    • Make sure all data fields are children inside the <document> tag

    • Make sure all data fields have data value as element value in the <document> tag

    Note

    • The data XML file doesn't use attributes for the tags

    • You can have several tags with the same name.

  • Save an example of a data XML file in your receipt folder and name the file something that helps you identify it, for example, dataExample.xml.

Example 36. Data XML file example
<?xml version="1.0" encoding="ISO-8859-1"?>
<document>
          <date>2010-08-04</date>
          <time>07:23</time>
          <movies>
                    <movie>
                            <name>The Fellowship Of The Ring</name>
                            <oscars>4</oscars>
                    </movie>
                    <movie>
                            <name>The Two Towers</name>
                            <oscars>2</oscars>
                    </movie>
                    <movie>
                            <name>The Return Of They King</name>
                            <oscars>11</oscars>
                    </movie>
          </movies>
</document>


Decide how to handle language

Decide how to handle the language. These are the options:

  • Use the same language file as the software, for example, Receipt Builder

  • Reuse a language file created for other custom receipts

  • Use a local language file for this receipt only

  • Don’t use a language file

Create the new project

You create a new project when you want to create a new receipt. The project is the container for all the included receipt files.

For more information, see Creating a new project.

Design the receipt

You design a receipt to control how the information is shown on the receipt. You can also add a logo and an image to the receipt.

For more information, see Designing a receipt.