POS Commands are used by User Interfaces to control the pos operation. They can be executed from native UI files, or web pages. Information on these pages is designed for User Interface designers and is not introductory in nature.

Active Commands (Most Commonly Used)

Active Commands

Undocumented Commands

The following commands are not yet documented. They are listed here for reference purposes. Some of these commands will be documented to full support status, others may be retired

Retired and Deprecated Commands

The following commands have been deprecated or retired and are no longer documented. Many of these commands continue to work to ensure backward compatiability.

PosScript is a Point of Sale specific scripting language to allow simple business rules to be implemented in the system. It is broadly similar in concept to Javascript but is different. There are alternatives to PosScript however this is very quick and flexible for small, rapid deployment

Fieldpine POS-Script is the scripting language used by Fieldpine POS core engine to control and influence operation of the POS. POS-Script allows you to alter and flex the POS in a wide variety of ways allowing close integration with your current business procedures.

PosScript is quickest to learn by examples. As it uses polymorphic operations, describing how it works can be hard to comphrend, where documented examples are reasonably obvious in intent

If you are already familar with one of the following languages, the following quick comparison may assist your understanding of script positioning.

Fundamentals

Script is a line processed script language. The POS dynamically interprets script at execution time by converting to an internal Just In Time compiled format. This compiled format is typically cached for repeat execution performance. If you are editing a script, the POS may not reload it automatically due to this caching, unless designer mode is selected or debug settings are selected to disable caching. To disable caching of script files, tick "Programming mode" on the configure page (or setting UIProgramMode=1 ).

The command parser is sensitive to whitespace, and if lines are not parsing as expected, it is wise to try separating each element with at least one space.

The POS also includes a runtime script debugger that allows you to set breakpoints and single step. You can enable the debugger by selecting "designer mode" on the debug screen.

Variables and Datatypes

Variable names must start with a letter.can only include letters and numbers.are not case sensitive and script writers are encouraged to only use lower case names.starting with underscore are reserved for internal use and special purposes.with dots, are used to refer to the Data Space.

Base data types are:
 number
 float
 string
 boolean
 money
 raw
 date
 time
 timespan
 special (described later)

The special purposes variable names are:
 _output   the current selected output device  

Formatting

When variables are output they can be formatted in different ways depending on their type.

Money

%a Abbreviated weekday name
%A Full weekday name
%b Abbreviated month name
%B Full month name
%c Date and time representation appropriate for locale
%d Day of month as decimal number (01 - 31)
%H Hour in 24-hour format (00 - 23)
%I Hour in 12-hour format (01 - 12)
%j Day of year as decimal number (001 - 366)
%m Month as decimal number (01 - 12)
%M Minute as decimal number (00 - 59)
%p Current locale's A.M./P.M. indicator for 12-hour clock
%S Second as decimal number (00 - 59)
%U Week of year as decimal number, with Sunday as first day of week (00 - 51)
%w Weekday as decimal number (0 - 6; Sunday is 0)
%W Week of year as decimal number, with Monday as first day of week (00 - 51)
%x Date representation for current locale
%X Time representation for current locale
%y Year without century, as decimal number (00 - 99)
%Y Year with century, as decimal number
%z, %Z Time-zone name or abbreviation; no characters if time zone is unknown

float

#	Insert a variable number of digits
0	Insert a single digit
other	Insert the character other.

boolean

Always formats as "1" for TRUE, and "0" for false.

Arithmetic

Operators
  +  addition
  -   subtraction
  *   multiplication
  /   division
  ^ and "xor"  exclusive or  (number variables only)
  | and  "or" inclusive or	(number variables only)
  & and "and" boolean and (number variables only)
  % and "remainder" remainder (number variables only)

Logical Expressions

 = or eq
<> or != or ne
< or lt
> or gt
<= or le
>= or ge
in

Commands

PosScript has a small set of commands primarily around flow control and variable loading. In additional there are a number of functions which are documented under Variables

PosScript can also directly embed PosCommands, meaning the PosScript can access all PosCommands and some additional flow control and variable operations that PosCommands do not have

Example:
	myVar++
	LoopCounter--

    if expression then statement

    if expression
    then
	   statements
    else
	  statements
    endif 
	

while 1 = f % 2
   f--
end while

f = 3
while f gt 0
   f--
endwhile

f = 2
message(99,1,f entry  F is %f%)
while f > 0
   message(99,1,%f%)
   set g = 2
   while (f > 0) & (g < 4)
	  message(99,1,Inner f=%f%  g = %g%)
	  g++
   end while
   f--
end while
message(99,1,f exit)

switch f 
case	1
	message(99,1, f is 1)
case	2
	message(99,1, f is 2)
case	3
	message(99,1, f is 3)
	nobreak
case	4
case	5
	message(99,1, f is 4 or 5 or flow through from 3)
default
	message(99,1,In default)
	f = 3
endswitch

Events in the POS are internal actions and conditions that occur when certain actions are processed. For example, creating a new sale causes a new-sale event to be fired. You can write event handlers in POS-Script to handle and control how events are processed. This scripted ability gives you absolute control over the complete sale handling in your POS

Events are desigend solely to handle small tasks and return control to the main POS logic. You should not attempt large scale changes to the system, such as altering unrelated sales. It is also not permitted to cause recursion, such that an event handler causes itself to be fired again while still active. eg A "set customer" event cannot use POS Commands that would cause the current customer to change again while the first is still being processed.

The illustration highlights how events are called as part of the internal processing and return to the same context when they started

Events are most useful for ensuring business rules are being enforced. Adding a saleline might use an event to ensure all relevant information is captured for the saleline

Events are not reprocessed after restart. If the system is shutdown for any reason while an event handler is processing, there is no guarantee it will be reactivated when the POS starts again.

Event handlers can be written using PosScript, C programming language, or using the TalkToFieldpine interface

The following table shows when events were enabled for different interfaces. N/A means an event is deliberately not available for an interface. A space means not yet implemented or available for customer use.

A Passive event is where the system advises you something, but you have no ability to alter or control this event. An active event allows you to control operation

Barcode Events

Customer and Account Events

Hardware Events

These events require additional components and are only present for some types of Hardware

Sale Events

Saleline Events

Settlement Events

System Events

Teller Management Events

User Interface Events

Adding Images and Text to receipts

This example shows how random images and text can be placed on customer receipts using PosCommands.

Printing on external pre-printed stationery

Shows how POS can print on external pre printed forms. Used for filling in details on forms, such as regulatory documents or event tickets.

Displaying user messages in a web page

Describes how simple user prompting messages can invoke a web page, allowing you to customise the display and operation of a message being displayed