Show TOC

Object documentationForms Locate this document in the navigation structure

 

Data forms define the visual means through which configured prompts or functions are presented at the POS terminal. Data form content sometimes displays in windows that are launched when you start a function or prompt.

A data form can consist of a single prompt line or a combination of several prompt lines. For example, to create a data form to collect credit card information, you must capture the tender amount, credit card number, and expiry date. The business date data form only requires a single line to prompt for the business date. You can configure a multiline data form that displays prompt lines one at a time as you enter responses, or you can display all the prompt lines at once allowing for greater flexibility in viewing and responding to the prompts.

This section describes parameters that define the behavior of your data form.

General

Screen Element

Description

Allow Review

Reviews prompt responses at the end of the prompting sequence

At End, Loop to Line

Line number that specifies where the prompt loops back to after a repeating sequence

Display Form

Displays all the prompt lines of the data form definition on the screen at the same time

Clear Action

Defines the action when you select the Clear option while in the data form. It displays the following actions:

  • Abandon Function

    clears the data and the function

  • Invoke Function — calls a different function
  • Do Not Allow — ignores the clear

  • Clear Previous Line — moves up a line in the form

  • Clear Data Form — clears all lines

Clear Function

Starts a function when you select the Invoke Function check box

Requires Explicit Send

Sends a function request when you select the Send check box

Enable MICR

Allows check validation with MICR reader validation. If this data form is activated or displayed, the MICR check handling device opens
Defines the prompts that your data form presents to the cashier. Some data forms can be configured to automatically trigger a series of prompts when a specific function is triggered (currently, this feature is only supported for the loans and pickup functions).
Form Lines

Screen Element

Description

Option This parameter displays the following options:
  • Type — displays the prompts to add to the data form
  • Value — displays prompt lines
  • Default — automatically generates a data form for a pickup or loan function. In this scenario, all tenders, which are eligible for loans or pickups (this is specified in the Tenders component) are added to the data form, at execution time
Required Specifies that the selected prompt is only executed when additional information is required for a specified function. This parameter displays the following options:
  • Required — indicates that the prompt is always required and displays on the POS terminal without going to the server first to verify if it is required
  • Conditionally Required — launches a prompt flagged as conditionally required if the POS server determines that it does not have sufficient information to execute the requested function

    Example Example

    For example, in the Apply Discount UDF data form, the discount preset amount prompt is configured as conditionally required. If there is not enough information on the price of an item to execute the requested discount, it launches the conditional prompt to capture the missing pricing information. If there is sufficient information in the item file to satisfy the function request that prompt line is not displayed.
    End of the example.
  • Required After Permission Check — indicates that a permission check must be performed before executing the prompt
  • Not Required on OLC Server — if you have a POS terminal with offline capability, this data prompt is not supported or required when the POS is in offline mode
Clear on Failure Clears prompt responses that require validation when validation fails. It removes the data from the data form and forces the cashier to re-enter the data
Post Validate Suspends validation of the initial prompt until the data is collected from the second prompt in instances where response data is required to launch a subsequent prompt, but data from both prompts must be validated to initiate a transaction. When this option is not activated, the system performs the validation as data is gathered
Send On Cancel Captures a record of when a data form is canceled at the POS terminal. For example, when a credit service requests for signature verification after the client sends an authorization request, the cashier can choose Clear to ignore the data form prompt. When you select this check box, it maintains a record of the cashier’s action
Sets Source Indicates to the server where the primary data used by a function came from. For example, if a card number is retrieved by swiping the card, or if the number is keyed instead. Also, when the item was sold based on whether the item was scanned or keyed
Include in Function Authorization Indicates if the prompt line must be included in a function authorization request