POSXML - Commands List

  1. Presentation
  2. Commands List

Presentation

List of available commands on the CloudWalk IDE.

If you run any application containing a command not supported by the version of CloudWalk Framework installed on the device, an error occurs WALK: Byte Mode Error, stating that the Byte Code command does not exist in the version of CloudWalk Framework installed.

Commands List

For organizational purposes, the POSXML commands are grouped by similarity. In case of doubt, there is also the possibility to view all commands by category 'All commands'.

if

Instruction of decision making or logical comparison

else

Logical condition in a block of the if statement

while

Instruction that allows the execution of a code multiple times

break

The break command allows immediate exit from while loop

function

Defines a block of code that can be executed later

callfunction

Makes a call on a previously defined function

execute

Execute a POSXML application stored on the device

exit

Immediately closes the execution of the POSXML application

getcardvariable

Gets the card number and stores it directly on a variable

system.readcard

Waits until a card is passed or a key is pressed

system.inputtransaction

Instruction to receive the data card on a contactless transaction

menu

Displays a menu based on the device screen (number of lines)

menuwithheader

Displays a header with a menu based on the device screen (number of lines)

displaybitmap

Displays a monochromatic bitmap on the display

display

Displays a custom message on device's display

cleandisplay

Clean the device display (like a clear or cls)

system.gettouchscreen

Captures the coordinates (x and y) where the display was pressed

system.gettouchscreenkeyboard

Wait for a TOUCHSCREEN or KEYBOARD event

inputfloat

Allows the entry of a value with dot (.) by pressing (*)

inputformat

Allows the entry of a value based on a pre-defined format

inputinteger

Allows the entry of an integer

inputoption

Allows the entry of an integer

inputmoney

Allows the entry of a monetary value

crypto.crc

16-bit CRC calculation, support CRC-CCITT

crypto.encryptdecrypt

Encryption routines with algorithms DES, 3DES or NEWDES

crypto.lrc

Generates a LRC byte of the string in the buffer

crypto.xor

Performs a binary XOR operation on the bytes of two strings

filesystem.listfiles

Lists the files of a directory by saving them in a file

filesystem.renamefile

Rename a file

filesystem.filesize

Returns the size of a file in the memory of the POS

filesystem.space

Checks the space (free and used) and the number of files in memory

file.open

Opens a file for reading or writing

file.read

Reads a file that was previously opened by file.open

xml.getelement

Read the XML data file.

json.getelement

Read the JSON data file.

file.write

Writes a file that was previously opened by file.open

file.close

Closes a file that was previously opened by file.open

readfile

Reads a dbfile WALK file (key/value)

readfilebyindex

Reads a key from a file WALK dbfile

editfile

Allows write a file in WALK dbfile format (key/value)

deletefile

Deletes a file from the device memory

downloadfile

Downloads a file previously registered on the CloudWalk Manager

iso8583.initfieldtable

Starts field table ISO8583 based on a specified file

iso8583.initmessage

Initiates assembly of the ISO message

iso8583.putfield

Inserts a field in the message, necessarily in ascending order

iso8583.endmessage

Ends assembly of the ISO message

iso8583.transactmessage

Adds size, header and trailer and sends the ISO message to the authorizer

iso8583.analyzemessage

Starts the process of analysis and decomposition of the fields of the message

iso8583.getfield

Extracts a field of the previously analyzed message

openserialport

Opens the serial port for communication with external peripherals

writeserialport

Writes a buffer on the serial port

readserialport

Reads a buffer from an external device captured by the serial port

closeserialport

Closes the serial port

getdatetime

Stores in a variable date and time at runtime

time.calculate

Calculates time. Supports addition, subtraction and difference

predial

Performs a dial-up connection with the provider

preconnect

Connects to the host authorizer

network.start

Starts the device's modem.

shutdownmodem

Turns off the modem and cancels the operations

network.checkgprssignal

Checks the status of the connection, if the POS supports GPRS

network.hostdisconnect

Disconnects the device from the host, keeping it connected to the network

network.ping

Checks the status of the connection with the host

network.send

Sends a buffer to the host previously connected

network.receive

Receives from the host buffer previously connected

pinpad.open

Enables communication with the external or internal pinpad

pinpad.loadipek

Records an initial key and an initial ksn on the memory of pinpad

pinpad.getkey

Captures a key that is pressed on the external pinpad

pinpad.getpindukpt

Catches a PIN and encrypts it using DUKPT standard

pinpad.display

Displays a custom message on the display of the pinpad

pinpad.close

Terminates communication with the external or internal pinpad

emv.open

Initializes EMV library

emv.loadtables

load tables EMV and PKI of the file for the buyer

emv.cleanstructures

Clears all input and output parameters

emv.adddata

Adds parameters to EMV process

emv.getinfo

Returns information parameters after the execution of the EMV process

emv.inittransaction

Initializes the EMV process with inserted parameters

emv.processtransaction

Starts the execution of the EMV process

emv.finishtransaction

Terminates the execution of the EMV process

emv.removecard

Waits for card removal

emv.settimeout

Define timeout (in seconds) of the library of the EMV process

system.readcard

Waits until a card is passed or a key is pressed

system.inputtransaction

Instruction to receive the data card on a contactless transaction

integervariable

Creates an instance of the variable of integer type

stringvariable

Creates an instance of the variable of string type

integerconvert

Conversion from integer to binary, octal or hexadecimal

convert.toint

Converts binary, decimal or hexadecimal to integer

inttostring

Conversion from integer to string

stringtoint

Conversion from string to integer

integeroperator

Increases by 1 (+1) or decrements by 1 (-1) a variable of integer type

string.tohex

Converts a string to its hexadecimal representation

string.fromhex

Converts a hexadecimal representation to a string

string.charat

Extracts specified string character

string.elementat

Returns a specific element in the string

string.elements

Returns how many elements there are in the specified string

string.find

Searches for a substring in the specified string

string.getvaluebykey

Searches in the string for a value based on key/value

string.trim

Eliminates the blanks on the left and right of the string

string.insertat

Inserts an element at specific index in string

string.length

Returns length of the specified string

string.pad

Adds a padding with specific character in string

string.removeat

Removes an element from specific index in string

string.replace

Replace all occurrences of the specified substring

string.replaceat

Replaces an element at a specific index in string

string.substring

Capture a specific part of string

substring

Copies part of a variable string to another variable

joinstring

Concatenates in a string the value of another 2 strings

smartcard.insertedcard

Checks if the card is inserted in the smart card reader

smartcard.closereader

Terminates communication process of with the smart card

smartcard.startreader

Starts the smart card reader and try to start the card

smartcard.transmitapdu

Sends an APDU command to the smart card

mathematicaloperation

Performs a mathematical operation between two values

system.backlight

Define the device's backlight intensity level.

system.qrcode

Generate a QR Code based on the entered data

system.beep

Produces a short beep

system.checkbattery

Checks the device battery status

system.info

Gets device information (MAC Address, SIM ID, etc)

system.restart

Restarts the device

unzipfile

Unpacks a zip file

waitkey

Pauses execution until a button is pressed

waitkeytimeout

Same as command waitkey but has a timeout

readkey

Same as command waitkey, but holds the pressed key

wait

Pauses execution for a set time