Show TOC

Object documentationAuto Reference Numbers Locate this document in the navigation structure

 

This section describes how to print documents with a unique control or reference number to produce credit notes or chits. Reference numbers also play a role in generating terminal and store-based sequence numbers used in the EFT Manager for credit and debit requests and reversals.

Auto reference numbers allow you to define how an automatically generated reference number are created and specify the elements, which it must contain. The auto reference number can consist of any number or combination of element formats such as fixed values, defined sequence values, or field values. You can define the length of each element and use values such as the store number, transaction number, terminal number, and cashier number in any element of the reference number. You can also add a Check Digit to the reference number.

Auto reference number generation rules are defined in the Printing section of the Configurator. To generate an auto reference number rule, you must attach the definition to a new or an existing User-Defined Function (UDF) in Functions. For more information about functions and permissions, see Permissions for User-Defined Functions.

You enter information to configure auto reference number elements as follows:

General

Screen Element

Description

Type

Element formatting type. Depending on the format that you select, you must define the value for the element and include the following types: Value, Sequence, and Field.

  • Value — entered if the element source is a constant or fixed value, such as the same code that identifies the entity being printed. This produces an element, which is the same in every auto generated reference number

  • Field — printed as an auto generate request. Options are as follows: Terminal Number, Cashier Number, Amount, and a series of date formats

  • Sequence Number — range for the sequence number. The sequence number generates in the Start field the first time that an auto reference number is requested (for the current definition). Each subsequent time that it requests an auto reference number, the value is increased by one. When the end value is reached in the End field, the system resets to the start value the next time an auto reference number is requested

  • Length — length of the element specified and starting point of the element, which follows it. You must specify a value for the length for every element regardless of its type, and cannot select zero as the length value. If the value of an element is less than its specified length, the reference number is padded with zeroes to the left of the value

Example Example

When you set a value of 99 and a length of three, the element is padded to produce 099. If the value of the element is greater than the specified length, it left-truncates the number beyond the value of the length. If you select Transaction Number as a Field option and set the length value to 3, the element is truncated to the last three characters at the right end of the transaction number.

End of the example.

Append Check Digit

Check digit routine that calculates the value for the auto reference number

Sequence Number by

Sequence number for an auto request number is as follows:

  • By Store — generates numbers per store

  • By Terminal — generates the numbers per terminal