Show TOC

Object documentationDocument Definition Locate this document in the navigation structure

 

The Documents component defines and formats information to display or print at the POS terminal.

Each completed definition is called a document, where you can specify to print, where or how to capture data (defined through variables), format, and print or display content. You can create documents to print items such as store or customer receipts, gift receipts, return tickets, pickup receipts, loan receipts, suspended transaction tickets, and to frank cheques or forms. Documents to display items such as line display messages or on-screen receipts are also created using this component.

An overall document definition consists of a collection of sections called forms. Forms contain instructions on how the system handles print or display requests when they are started at the POS terminal. Forms always respond to events by printing or displaying specific information, or to only respond when certain conditions are met as specified in the overall document definition. Once you complete a document, it is completed, saved, and becomes available in Functions , Terminal Operations, Validation Rules, and Transactions components. Any function that requires printing, or on-screen display can then use the definition to specify a print or display the request.

The interface for creating a new document definition or modifying an existing one consists of a free-format text input box. To define a document, you must provide the parameters and specify formatting instructions for the content in a specific method resembling code. The Document component has most of the common definitions, such as customer receipts, return tickets and refund documents that are already created, however you can modify any of the default elements within those definitions to suit your requirements. You can also create a new document using common elements from an existing definition and by modifying the parameters. For more information about document formatting codes, see Common Document Formatting Properties.

General

Screen Element

Description

Sensitive Data

Data in this document is sensitive and must be encrypted

Lines Per Page

The number of lines to print on one page; this parameter is required for multiform documents. When the number of lines specified per page is printed and the document ejects, you can intervene to continue printing. For hard copy printing, the POS terminal cuts the paper at this point and waits for the cashier’s prompt response; for screen text, the cashier presses another key to continue the display. If you do not require this feature, choose zero, the default value

Top Margin

Number of rows to skip from the top of the page before printing the first line

Left Margin

Number of character columns to indent from the left edge of the page for a margin

No Paper Cut

Specifies not to cut the paper at the end of the document

Confirmation Prompt

Prompts to confirm or cancel printing. Prompt options have an attached choice list and the option supports the Optional Document function. When you start the print function in a transaction, it is determined whether or not you require the document based on the conditions of the current transaction. To print the document every time you start the function, you can choose None (the default value)

Confirmation Response

Specifies a response to continue printing

Reprint Prompt

Prompt to display if the document requires reprinting

Reprint Response

Specifies a response to continue printing

This section describes document parameters.

Document

Screen Element

Description

Document Detail

Properties, variables and formatting instructions as required for the document to define the content to print. For more information about document formatting, see Common Document Formatting Properties. For a document definition, you must provide the following:

  • Formatting instructions (alignment, blank lines, font style)

  • Variables (if any) that are required for gathering data to print

  • Repetitive straight copy that prints on every document regardless of the details of the transaction (for example, as in a promotional message)

Document Outline

Optional parameter that controls the type of lines that appear on the receipt. For more information about the settings, see Document Outlines.