Inbound Integration Guide - Devices, Location and POS Terminals

Description

This How-to guide explains the integration of following configuration data entities.

• Location
• Devices
• POS Terminal

Notes

This guide does not cover all possible integration topics. Please see the Enactor Books for detailed information.

See the Inbound Integration Guide - Introduction for the basics of importing and exporting data.

This guide will use manual import and export of data using the Enactor Estate Manager.

Overview

Locations identify the warehouse, office, store, or restaurant locations.

Devices identify the specific endpoints that can connect to the Enactor solution. Devices require a location.

POS Terminals define the Point-of-Sale devices and their behaviors. POS Terminals require a device.

Location

A location describes a Warehouse, Office, Store, or Restaurant.

The Office, Store, and Restaurant are tax-applicable locations and require tax information identifying a tax region and tax scheme. Office and store derive directly from the taxable location entity and restaurant derives from the store entity.

XML Example

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Batch xmlns:core="http://www.enactor.com/core"
    xmlns:retail="http://www.enactor.com/retail">

    <retail:store>
        <retail:description>Enactor Store</retail:description>
        <retail:locationType>store</retail:locationType>
        <retail:startDate>2014-05-08T00:00:00+01:00</retail:startDate>
        <retail:supportEmailAddress></retail:supportEmailAddress>
        <retail:systemUserId></retail:systemUserId>
        <retail:locationAddress>
            <retail:countryCodeId>GB</retail:countryCodeId>
            <retail:organisation>Enactor</retail:organisation>
            <retail:typeId></retail:typeId>
            <retail:county>Hertfordshire</retail:county>
            <retail:email>info@enactor.co.uk</retail:email>
            <retail:phone1>01992 500881</retail:phone1>
            <retail:postCode>SG14 1PB</retail:postCode>
            <retail:street1>Enactor House</retail:street1>
            <retail:street2>1 Bluecoats</retail:street2>
            <retail:town>Hertford</retail:town>
            <retail:referenceName>locationAddress</retail:referenceName>
            <retail:isTemplate>false</retail:isTemplate>
        </retail:locationAddress>
        <retail:locationId>0001</retail:locationId>
        <retail:emailConfiguration>
            <retail:locationId>0001</retail:locationId>
            <retail:referenceName>emailConfiguration</retail:referenceName>
            <retail:isTemplate>false</retail:isTemplate>
        </retail:emailConfiguration>
        <retail:purgeDetails>
            <retail:isTemplate>false</retail:isTemplate>
        </retail:purgeDetails>
        <retail:groupId groupHierarchyId="All" groupTypeId="region">UK</retail:groupId>
        <retail:defaultMenuGroupId variantGroupHierarchyId="All" variantGroupId="All" variantGroupTypeId="region" groupHierarchyId="All" groupTypeId="menuGroup">All</retail:defaultMenuGroupId>
        <retail:menuGroupId variantGroupHierarchyId="All" variantGroupId="All" variantGroupTypeId="region" groupHierarchyId="All" groupTypeId="menuGroup">All</retail:menuGroupId>
        <retail:priceGroupId variantGroupHierarchyId="All" variantGroupId="All" variantGroupTypeId="region" groupHierarchyId="ALL" groupTypeId="priceGroup">UK</retail:priceGroupId>
        <retail:isLive>true</retail:isLive>
        <retail:mmGroupHierarchyId variantGroupHierarchyId="All" variantGroupId="All" variantGroupTypeId="region" groupHierarchyId="GROCERY" groupTypeId="mmGroup">GROCERY</retail:mmGroupHierarchyId>
        <retail:volumetricWeightFactor>0</retail:volumetricWeightFactor>
        <retail:customerForwarderSurcharge>0</retail:customerForwarderSurcharge>
        <retail:templateKey>STORE_TEMPLATE_UK</retail:templateKey>
        <retail:isTemplate>false</retail:isTemplate>

        <retail:autoFinaliseCashedUpSessions>false</retail:autoFinaliseCashedUpSessions>
        <retail:autoGenerateSealNumbers>false</retail:autoGenerateSealNumbers>
        <retail:branchNumber>1</retail:branchNumber>
        <retail:customerWelcomeMessage></retail:customerWelcomeMessage>
        <retail:tillClosedMessage></retail:tillClosedMessage>
        <retail:cashManagementMethod>TERMINAL</retail:cashManagementMethod>
        <retail:denominationEntryMethod>EITHER</retail:denominationEntryMethod>
        <retail:suppressSpotcheckSummary>false</retail:suppressSpotcheckSummary>
        <retail:tenderBagsOption>DISALLOWED</retail:tenderBagsOption>
        <retail:headerLines></retail:headerLines>
        <retail:headerLinesCentred>false</retail:headerLinesCentred>
        <retail:manager></retail:manager>
        <retail:maximumCashupRecounts>0</retail:maximumCashupRecounts>
        <retail:nearestStores>0003</retail:nearestStores>
        <retail:performFloatCheckAfterSignOn>false</retail:performFloatCheckAfterSignOn>
        <retail:trailerLines>Thankyou for shopping at Enactor</retail:trailerLines>
        <retail:trailerLinesCentred>true</retail:trailerLinesCentred>
        <retail:dayEnd>
            <retail:day>2</retail:day>
        </retail:dayEnd>
        <retail:dayEnd>
            <retail:day>3</retail:day>
        </retail:dayEnd>
        <retail:dayEnd>
            <retail:day>4</retail:day>
        </retail:dayEnd>
        <retail:dayEnd>
            <retail:day>5</retail:day>
        </retail:dayEnd>
        <retail:dayEnd>
            <retail:day>6</retail:day>
        </retail:dayEnd>
        <retail:dayEnd>
            <retail:day>7</retail:day>
        </retail:dayEnd>
        <retail:dayEnd>
            <retail:day>1</retail:day>
        </retail:dayEnd>
        <retail:locationBankDetails>
            <retail:bankAddress>
                <retail:countryCodeId></retail:countryCodeId>
                <retail:typeId></retail:typeId>
                <retail:isTemplate>false</retail:isTemplate>
            </retail:bankAddress>
            <retail:isTemplate>false</retail:isTemplate>
        </retail:locationBankDetails>
        <retail:receiptHeaderImageId type="bmp" category="RECEIPT">ENACTOR</retail:receiptHeaderImageId>
        <retail:receiptTrailerImageId category=""></retail:receiptTrailerImageId>
    </retail:store>

</Batch>

XML Structure

store

XML Tag	Parent Element	Type	Description	Data Type	Length
store		Root	outer wrapper for the entity
locationId	store	Element	The unique ID for this location	String	20
locationType	store	Element	Fixed: The type of location. Must be one of the following: office, store, restaurant, warehouse	fixed
description	store	Element	The name of this location	String
groupId	store	Element	The region for this location (see groupId)	groupId
isLive	store	Element	The status of this location; if false, transactions from this location will not be processed; if omitted, false	Boolean
isTemplate	store	Element	true, if this location definition is a template if omitted, false	Boolean
branchNumber	store	Element	if supplied, a value for transaction identifiers, part of the audit log filename, part of the serial number for credit notes, branch at which transaction was originated, stored, and completed, update retail transactions that have been returned	Integer	8
autoFinalise CashedUpSessions	store	Element	if true, the cash up sessions will be auto finalised at this location if omitted, false	Boolean
autoGenerate SealNumbers	store	Element	if true, the seal numbers will be auto generated at this location if omitted, false	Boolean
cashManagement Method	store	Element	One of the following fixed values: CASHIER, TERMINAL, PAY_POINT	fixed
customerWelcome Message	store	Element	A customer welcome message to be displayed	String
defaultMenu Group	store	Element	In conjunction with User Role, Locale, and Menu ID, identifies the default menus for the user interface	String
denomination EntryMethod	store	Element	One of the following fixed values: EITHER , BY_VALUE, BY_QUANTITY	fixed
headerLines	store	Element	Receipt header lines for this location	String
headerLines Centered	store	Element	if true, center the receipt header lines if omitted, false	Boolean
trailerLines	store	Element	Receipt trailer lines for this location	String
trailerLines Centered	store	Element	if true, center the receipt trailer lines if omitted, false	Boolean
receiptHeader ImageId	store	Element	The image id for the receipt header image	String
receiptTrailer ImageId	store	Element	The image id for the receipt trailer image	String
manager	store	Element	The name of the manager for this location	String
maximumCashup Recounts	store	Element	number of times a cash up can be retried; 0 means unlimited if omitted, 0	Integer
menuGroupId	store	Element	In conjunction with User Role, Locale, and Menu ID, identifies menus for the user interface (see groupId)	groupId
mmGroup HierarchyId	store	Element	The mmGroup hierarchy for search and selling options based on department (see groupId)	groupId
nearestStores	store	Element	a nearest store location Id; this element should be repeated for multiple nearest stores	String
performFloat CheckAfterSignOn	store	Element	if true, perform a float check following sign on	Boolean
priceGroupId	store	Element	Used with product prices to identify the price group for this location (see groupId)	groupId
startDate	store	Element	The date that this store started trading	Date
supportEmail Address	store	Element	The email address for support	String	50
suppress Spotcheck Summary	store	Element	if true, spot check summary will be suppressd at this location if omitted, false	Boolean
systemUserId	store	Element	System user id associated with this location	String
templateKey	store	Element	The template to use for this location	String
tenderBagsOption	store	Element	One of the following fixed values: DISALLOWED, COMPULSORY, OPTIONAL	fixed
tillClosedMessage	store	Element	A message when the till is closed	String
customer Forwarder Surcharge	store	Element	A Surcharge to be applied if an external Freight Forwarding service is used to fulfil a Customer Delivery from this Location	Integer
volumetricWeight Factor	store	Element	A factor used in calculating Delivery Charges based on the Volumetric Weight of Custom Deliveries dispatched from this Location	Integer
locationAddress	store	Element	Address data for this location	String
email Configuration	store	Element	Outgoing email configuration for this location	String
purgeDetails	store	Element	Location specific purge details	String
dayEnd	store	Element	Location specific day end details	String
locationBank Details	store	Element	Location specific bank Details	String

locationAddress

XML Tag	Parent Element	Type	Description	Data Type	Length
locationAddress		Root	outer wrapper for the entity
countryCodeId	locationAddress	Element	The country code for this location	String	5
organisation	locationAddress	Element	The organization ID for this location	String	40
county	locationAddress	Element	The county for this location	String	50
email	locationAddress	Element	The email for this location	String	255
phone1	locationAddress	Element	The phone for this location	String	50
phone2	locationAddress	Element	An additional phone for this location	String	20
fax	locationAddress	Element	The fax number for this location	String	20
postcode	locationAddress	Element	The post code of this location	String	20
street1	locationAddress	Element	The street address of this location	String	255
street2	locationAddress	Element	Additional street address information for this location	String	255
street3	locationAddress	Element	Additional street address information for this location	String	255
town	locationAddress	Element	The town/city for this location	String	100
referenceName	locationAddress	Element	A reference name for this location	String	20
isTemplate	locationAddress	Element	true if this address is a template; if omitted, false	Boolean

emailConfiguration

XML Tag	Parent Element	Type	Description	Data Type	Length
email Configuration		Root	outer wrapper for the entity
locationId	email Configuration	Element	The unique ID for this location	String	20
smtpHost	email Configuration	Element	The outgoing SMTP hostname or IP address	String
smtpPort	email Configuration	Element	The outgoing SMTP port	String
pop3Host	email Configuration	Element	The incoming POP3 hostname or IP address	String
pop3Port	email Configuration	Element	The incoming POP3 port	String
imap4Host	email Configuration	Element	The incoming IMAP4 hostname or IP address	String
imap4Port	email Configuration	Element	The incoming IMAP4 port	String
authenticate OutgoingMail	email Configuration	Element	if true, use the supplied system credentials to authenticate outgoing mail if omitted, false	Boolean
allowFallback	email Configuration	Element	if true, allow fallback to unsecure communications if omitted, false	Boolean
referenceName	email Configuration	Element	A reference name for this email configuration	Boolean
isTemplate	email Configuration	Element	if true, this configuration is a template if omitted, false	Boolean

purgeDetails

XML Tag	Parent Element	Type	Description	Data Type	Length
store		Root	outer wrapper for the entity
locationId	store	Element	The unique ID for this location	String	20

dayEnd

XML Tag	Parent Element	Type	Description	Data Type	Length
dayEnd		Root	outer wrapper for the entity
day	dayEnd	Element	The day of the week for this entry	Integer	1
storeOpen	dayEnd	Element	The time for this day when the store opens
hour	storeOpen	Attribute	The hour the store opens	String	2
minute	storeOpen	Attribute	The minute the store opens	String	2
second	storeOpen	Attribute	The second the store opens	String	2
storeClosed	dayEnd	Element	The time for this day when the store closes
hour	storeClosed	Attribute	The hour the store closes	String	2
minute	storeClosed	Attribute	The minute the store closes	String	2
second	storeClosed	Attribute	The second the store closes	String	2
dayEnd	dayEnd	Element	The time for this day to run day end processes
hour	dayEnd	Attribute	The hour to run day end processes	String	2
minute	dayEnd	Attribute	The minute to run day end processes	String	2
second	dayEnd	Attribute	The second to run day end processes	String	2
weekEnd	dayEnd	Element	if true, run the weekEnd processes on this day after the dayEnd processes if omitted, false	Boolean

locationBankDetails

XML Tag	Parent Element	Type	Description	Data Type	Length
locationBank Details		Root	outer wrapper for the entity
bankAddress	locationBank Details	Element	outer wrapper for the entity	String	20
countryCodeId	bankAddress	Element	The country code for this location's bank	String	5
organisation	bankAddress	Element	The organization ID for this location's bank	String	40
county	bankAddress	Element	The county for this location's bank	String	50
email	bankAddress	Element	The email for this location's bank	String	255
phone1	bankAddress	Element	The phone for this location's bank	String	50
phone2	bankAddress	Element	An additional phone for this location's bank	String	20
fax	bankAddress	Element	The fax number for this location's bank	String	20
postcode	bankAddress	Element	The post code of this location's bank	String	20
street1	bankAddress	Element	The street address of this location's bank	String	255
street2	bankAddress	Element	Additional street address information for this location's bank	String	255
street3	bankAddress	Element	Additional street address information for this location's bank	String	255
town	bankAddress	Element	The town/city for this location's bank	String	100
referenceName	bankAddress	Element	A reference name for this location's bank	String	20
isTemplate	bankAddress	Element	true if this address is a template; if omitted, false	Boolean

Device

A device describes an endpoint that can connect to the solution.

XML Example

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Batch xmlns:core="http://www.enactor.com/core"
    xmlns:retail="http://www.enactor.com/retail">

    <retail:device>
        <retail:deviceId>pos1@0001.enactor</retail:deviceId>
        <retail:deviceName>POS 1@ 0001</retail:deviceName>
        <retail:deviceNotInUse>false</retail:deviceNotInUse>
        <retail:deviceType>MASTER_POS</retail:deviceType>
        <retail:hostName>localhost</retail:hostName>
        <retail:locationId>0001</retail:locationId>
        <retail:dataSource/>

        <retail:httpPort>8080</retail:httpPort>
        <retail:rmiPort>2099</retail:rmiPort>
    </retail:device>

</Batch>

XML Structure

device

XML Tag	Parent Element	Type	Description	Data Type	Length
device		Root	outer wrapper for the entity
deviceId	device	Element	The unique Id for a device	String	40
deviceName	device	Element	A name for the device	String	40
deviceNotInUse	device	Element	if true, do not not allow use of this device, do not process transactions from this device if omitted, false	Boolean
deviceType	device	Element	One of the following fixed values: CARD_AUTH_SERVER MOBILE_POS POS MASTER_POS ORDER_MANAGER INVENTORY_MANAGER ESTATE_MANAGER BACK_OFFICE PROMOTION_MANAGER CUSTOMER_MANAGER PDP_SERVER HHT WEB_SITE_SERVER	fixed
hostName	device	Element		String	40
locationId	device	Element	The location where this device is located	String	20
httpPort	device	Element	Port on which the services of this device are offered (Tomcat configuration)	Integer	5
rmiPort	device	Element	Port on which Java RMI services of this device are offered (enactor.xml configuration)	Integer	5

POS Terminal

A POS Terminal describes a Point-of-Sale device with peripherals that can be use for user interaction.

XML Example

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Batch xmlns:core="http://www.enactor.com/core"
    xmlns:retail="http://www.enactor.com/retail">

    <retail:posTerminal>
        <retail:deviceId>pos1@0001.enactor</retail:deviceId>
        <retail:posDayStartConfig>
            <retail:allowSales>false</retail:allowSales>
            <retail:isTemplate>false</retail:isTemplate>
        </retail:posDayStartConfig>
        <retail:posDayEndConfig>
            <retail:isTemplate>false</retail:isTemplate>
        </retail:posDayEndConfig>
        <retail:posSessionEndConfig>
            <retail:isTemplate>false</retail:isTemplate>
        </retail:posSessionEndConfig>
        <retail:posReportDefinition>
            <retail:isTemplate>false</retail:isTemplate>
        </retail:posReportDefinition>
        <retail:customerViewConfiguration>
            <retail:isTemplate>false</retail:isTemplate>
            <retail:showBasket>true</retail:showBasket>
        </retail:customerViewConfiguration>

        <retail:description>POS 1 @ Enactor</retail:description>
        <retail:terminalNumber>1</retail:terminalNumber>
        <retail:defaultSafeId></retail:defaultSafeId>
        <retail:defaultPayPointId></retail:defaultPayPointId>
        <retail:taxRegionId variantGroupHierarchyId="All" variantGroupId="All" variantGroupTypeId="region" groupHierarchyId="ALLREGIONS" groupTypeId="taxRegion">UK</retail:taxRegionId>
        <retail:taxSchemeId>UK</retail:taxSchemeId>
        <retail:enableDCC>true</retail:enableDCC>
        <retail:disableEmailReceiptsInTrainingMode>false</retail:disableEmailReceiptsInTrainingMode>
        <retail:operatorDisplayType></retail:operatorDisplayType>
        <retail:operatorDisplayAddress></retail:operatorDisplayAddress>
        <retail:operatorDisplayClassname></retail:operatorDisplayClassname>
        <retail:customerDisplayType></retail:customerDisplayType>
        <retail:customerDisplayAddress></retail:customerDisplayAddress>
        <retail:customerDisplayClassname></retail:customerDisplayClassname>
        <retail:cashDrawerType>Test CashDrawer</retail:cashDrawerType>
        <retail:cashDrawerShared>false</retail:cashDrawerShared>
        <retail:cashDrawerAddress></retail:cashDrawerAddress>
        <retail:cashDrawerClassname></retail:cashDrawerClassname>
        <retail:cashAcceptorType></retail:cashAcceptorType>
        <retail:cashAcceptorAddress></retail:cashAcceptorAddress>
        <retail:cashAcceptorClassname></retail:cashAcceptorClassname>
        <retail:cashDispenserType></retail:cashDispenserType>
        <retail:cashDispenserAddress></retail:cashDispenserAddress>
        <retail:cashDispenserClassname></retail:cashDispenserClassname>
        <retail:receiptPrinterType>Test Printer</retail:receiptPrinterType>
        <retail:receiptPrinterShared>false</retail:receiptPrinterShared>
        <retail:receiptPrinterAddress></retail:receiptPrinterAddress>
        <retail:receiptPrinterClassname></retail:receiptPrinterClassname>
        <retail:auditPrinterType></retail:auditPrinterType>
        <retail:auditPrinterAddress></retail:auditPrinterAddress>
        <retail:auditPrinterClassname></retail:auditPrinterClassname>
        <retail:keyboardType></retail:keyboardType>
        <retail:keyboardAddress></retail:keyboardAddress>
        <retail:keyboardClassname></retail:keyboardClassname>
        <retail:toneIndicatorType></retail:toneIndicatorType>
        <retail:toneIndicatorAddress></retail:toneIndicatorAddress>
        <retail:toneIndicatorClassname></retail:toneIndicatorClassname>
        <retail:scannerType></retail:scannerType>
        <retail:scannerAddress></retail:scannerAddress>
        <retail:scannerClassname></retail:scannerClassname>
        <retail:scanner2Type></retail:scanner2Type>
        <retail:scanner2Address></retail:scanner2Address>
        <retail:scanner2Classname></retail:scanner2Classname>
        <retail:scalesType></retail:scalesType>
        <retail:scalesAddress></retail:scalesAddress>
        <retail:scalesClassname></retail:scalesClassname>
        <retail:msrType>Test MSR</retail:msrType>
        <retail:msrAddress></retail:msrAddress>
        <retail:msrClassname></retail:msrClassname>
        <retail:micrReaderType></retail:micrReaderType>
        <retail:micrReaderAddress></retail:micrReaderAddress>
        <retail:micrReaderClassname></retail:micrReaderClassname>
        <retail:boardingCardReaderType></retail:boardingCardReaderType>
        <retail:boardingCardReaderAddress></retail:boardingCardReaderAddress>
        <retail:boardingCardReaderClassname></retail:boardingCardReaderClassname>
        <retail:iccReaderType>Test ICC Reader</retail:iccReaderType>
        <retail:iccReaderAddress></retail:iccReaderAddress>
        <retail:iccReaderClassname></retail:iccReaderClassname>
        <retail:signatureCaptureType></retail:signatureCaptureType>
        <retail:signatureCaptureAddress></retail:signatureCaptureAddress>
        <retail:signatureCaptureClassname></retail:signatureCaptureClassname>
        <retail:carrierBagProductId></retail:carrierBagProductId>
        <retail:auditLogReceiptCopy>false</retail:auditLogReceiptCopy>
        <retail:customerViewTheme></retail:customerViewTheme>
        <retail:acquirerConnections xsi:type="core:WrappedNull"/>
        <retail:defaultLoyaltySchemeId>LOYALTY_UK</retail:defaultLoyaltySchemeId>
        <retail:defaultLoyaltyTierCode>FR1</retail:defaultLoyaltyTierCode>
        <retail:loyaltyPromptAtStartTransaction>false</retail:loyaltyPromptAtStartTransaction>
        <retail:loyaltyPromptAtTotal>false</retail:loyaltyPromptAtTotal>
        <retail:loyaltyOfferPrompt>false</retail:loyaltyOfferPrompt>
        <retail:storedCustomerTransactionAge>0</retail:storedCustomerTransactionAge>
        <retail:transactionTenderLimit>0</retail:transactionTenderLimit>
        <retail:taxFreeEligibilityThreshold>0</retail:taxFreeEligibilityThreshold>
        <retail:motionSensorType></retail:motionSensorType>
        <retail:paymentServiceType></retail:paymentServiceType>
        <retail:paymentServiceClassname></retail:paymentServiceClassname>
        <retail:paymentDeviceHostId></retail:paymentDeviceHostId>
        <retail:enableTaxRefundRequest>false</retail:enableTaxRefundRequest>
        <retail:capturePrivacyPolicyAgreement>false</retail:capturePrivacyPolicyAgreement>
        <retail:posTerminalBranding>
            <retail:isTemplate>false</retail:isTemplate>
        </retail:posTerminalBranding>
        <retail:enableEndpointStatusMonitor>true</retail:enableEndpointStatusMonitor>
        <retail:templateKey>RETAIL_FIXED_POS_TEMPLATE</retail:templateKey>
        <retail:isTemplate>false</retail:isTemplate>
        <retail:biometricScannerAddress></retail:biometricScannerAddress>
        <retail:biometricScannerClassname></retail:biometricScannerClassname>
    </retail:posTerminal>

</Batch>

XML Structure

posTerminal

XML Tag	Parent Element	Type	Description	Data Type	Length
posTerminal		Root	outer wrapper for the entity
deviceId	posTerminal	Element	The unique device id for this terminal	String	40
description	posTerminal	Element	A friendly name for the terminal	String
terminalNumber	posTerminal	Element	A numeric id for the terminal	Integer
defaultSafeId	posTerminal	Element	The safe id for this terminal	String
defaultPayPointId	posTerminal	Element	The default pay point id for this terminal	String
localeId	posTerminal	Element	The locale for this terminal if different from the location	Locale String
currencyId	posTerminal	Element	The currency for this terminal if different from the location	String
taxRegionId	posTerminal	Element	Tax region for this terminal (see groupId)	groupId
taxSchemeId	posTerminal	Element	The tax scheme for this terminal	String
priceGroupId	posTerminal	Element	The price group for this terminal (see groupId)	groupId
defaultUI ProductGroupId	posTerminal	Element	The default menu group for the POS UI (see groupId)	groupId
menuGroupId	posTerminal	Element	The menu group for the POS UI (see groupId)	groupId
receipt Communication ScriptId	posTerminal	Element	The communication script for receipts	String
quoteReceipt Communication ScriptId	posTerminal	Element	The communication script for quotes	String
enableDCC	posTerminal	Element	If true, enable dynamic currency conversion if omitted, false	Boolean
trainingMode	posTerminal	Element	if true, force training mode for this terminal if omitted, false	Boolean
disableEmail ReceiptsIn TrainingMode	posTerminal	Element	if true, do not send email receipts when the terminal is in training mode if omitted, false	Boolean
remoteTerminal	posTerminal	Element	if true, this terminal is a remote terminal (Mobile, Mobile on Open Network)	Boolean
mobileTerminal	posTerminal	Element	if remoteTerminal is true, if true, mobile terminal on store network if remoteTerminal is true, if false, mobile terminal on open network	Boolean
skipFloatCheck afterSignOn	posTerminal	Element	if true, skip float check after user signs on if omitted, false	Boolean
cashDrawerType	posTerminal	Element	if omitted, no device one of the following fixed values: JposCashdrawer TestCashdrawer	fixed
cashDrawerShared	posTerminal	Element	if true, device is shared by one or more terminals if omitted, false	Boolean
cashDrawer Address	posTerminal	Element	The JPOS device id	String
cashDrawer Classname	posTerminal	Element	The JPOS classname	String
cashDrawer AtServer	posTerminal	Element	if true, connect the device to the server if false, connect the device to the client if omitted, false	Boolean
receiptPrinterType	posTerminal	Element	if omitted, no device one of the following fixed values: JposPrinter TestPrinter	fixed
receiptPrinter Shared	posTerminal	Element	if true, device is shared by one or more terminals if omitted, false	Boolean
receiptPrinter Address	posTerminal	Element	The JPOS device id	String
receiptPrinter Config	posTerminal	Element	Any device specific configuration that may be needed	String
receiptPrinter Classname	posTerminal	Element	The JPOS classname	String
receiptPrinter AtServer	posTerminal	Element	if true, connect the cashdrawer to the server if false, connect the cashdrawer to the client if omitted, false	Boolean
keyboardType	posTerminal	Element	if omitted, no device one of the following fixed values: JPOS Test	fixed
keyboardAddress	posTerminal	Element	The JPOS device id	String
keyboard Classname	posTerminal	Element	The JPOS classname	String
keyboardAt Server	posTerminal	Element	if true, connect the device to the server if false, connect the device to the client if omitted, false	Boolean
scannerType	posTerminal	Element	if omitted, no device one of the following fixed values: JposScanner TestScanner	fixed
scannerAddress	posTerminal	Element	The JPOS device id	String
scanner Classname	posTerminal	Element	The JPOS classname	String
scannerAtServer	posTerminal	Element	if true, connect the device to the server if false, connect the device to the client if omitted, false	Boolean
scanner2Type	posTerminal	Element	if omitted, no device one of the following fixed values: JposScanner TestScanner	fixed
scanner2Address	posTerminal	Element	The JPOS device id	String
scanner2 Classname	posTerminal	Element	The JPOS classname	String
scanner2AtServer	posTerminal	Element	if true, connect the device to the server if false, connect the device to the client if omitted, false	Boolean
scalesType	posTerminal	Element	if omitted, no device one of the following fixed values: Jpos Scale TestScale	fixed
scalesAddress	posTerminal	Element	The JPOS device id	String
scalesClassname	posTerminal	Element	The JPOS classname	String
scalesAtServer	posTerminal	Element	if true, connect the device to the server if false, connect the device to the client if omitted, false	Boolean
msrType	posTerminal	Element	if omitted, no device one of the following fixed values: JposMSR TestMSR	fixed
msrAddress	posTerminal	Element	The JPOS device id	String
msrClassname	posTerminal	Element	The JPOS classname	String
msrAtServer	posTerminal	Element	if true, connect the device to the server if false, connect the device to the client if omitted, false	Boolean
micrReaderType	posTerminal	Element	if omitted, no device one of the following fixed values: Jpos MICRReader TestMicr	fixed
micrReader Address	posTerminal	Element	The JPOS device id	String
micrReader Classname	posTerminal	Element	The JPOS classname	String
micrReader AtServer	posTerminal	Element	if true, connect the device to the server if false, connect the device to the client if omitted, false	Boolean
iccReaderType	posTerminal	Element	if omitted, no device	String
iccReaderAddress	posTerminal	Element	The device id	String
iccReader Classname	posTerminal	Element	The classname	String
iccReaderAtServer	posTerminal	Element	if true, connect the device to the server if false, connect the device to the client if omitted, false	Boolean
signatureCapture Type	posTerminal	Element	if omitted, no device otherwise, JPOS	fixed
signatureCapture Address	posTerminal	Element	The device id	String
signatureCapture Classname	posTerminal	Element	The classname	String
receipt DocumentId	posTerminal	Element	The receipt name to use	String
pagePrinter Receipt DocumentId	posTerminal	Element	The receipt name to use	String
combined Receipt DocumentId	posTerminal	Element	The receipt name to use	String
additional Receipt1 DocumentId	posTerminal	Element	The receipt name to use	String
additional Receipt2 DocumentId	posTerminal	Element	The receipt name to use	String
giftItemReceipt DocumentId	posTerminal	Element	The receipt name to use	String
giftTransaction ReceiptDocument Id	posTerminal	Element	The receipt name to use	String
splitBillPart ReceiptDocument Id	posTerminal	Element	The receipt name to use	String
storedTransaction DocumentId	posTerminal	Element	The receipt name to use	String
productWastage DocumentId	posTerminal	Element	The receipt name to use	String
noSaleDocument Id	posTerminal	Element	The receipt name to use	String
customerSignature SlipDocumentId	posTerminal	Element	The receipt name to use	String
employee SignatureSlip DocumentId	posTerminal	Element	The receipt name to use	String
giftCardAdviceSlip DocumentId	posTerminal	Element	The receipt name to use	String
giftCardEnquiry SlipDocumentId	posTerminal	Element	The receipt name to use	String
cardVoucher MerchantCopy DocumentId	posTerminal	Element	The receipt name to use	String
cardVoucher CustomerCopy DocumentId	posTerminal	Element	The receipt name to use	String
cardVoucher Cancelled MerchantCopy DocumentId	posTerminal	Element	The receipt name to use	String
cardVoucher Cancelled CustomerCopy DocumentId	posTerminal	Element	The receipt name to use	String
pagePrinterCard VoucherMerchant CopyDocumentId	posTerminal	Element	The receipt name to use	String
pagePrinterCard VoucherCustomer CopyDocumentId	posTerminal	Element	The receipt name to use	String
pagePrinterCard VoucherCancelled MerchantCopy DocumentId	posTerminal	Element	The receipt name to use	String
pagePrinterCard VouchCancelled CustomerCopy DocumentId	posTerminal	Element	The receipt name to use	String
creditNoteIssue DocumentId	posTerminal	Element	The receipt name to use	String
goodsOutNote DocumentId	posTerminal	Element	The receipt name to use	String
receiptGoodsOut NoteDocumentId	posTerminal	Element	The receipt name to use	String
collectionSlip DocumentId	posTerminal	Element	The receipt name to use	String
collectionRequest SlipDocumentId	posTerminal	Element	The receipt name to use	String
alterationService SlipDocumentId	posTerminal	Element	The receipt name to use	String
reversalReceipt DocumentId	posTerminal	Element	The receipt name to use	String
reversalCombined Receipt DocumentId	posTerminal	Element	The receipt name to use	String
reversalCard VoucherCustomer CopyDocumentId	posTerminal	Element	The receipt name to use	String
reversalCard VoucherMerchant CopyDocumentId	posTerminal	Element	The receipt name to use	String
sessionSummary DocumentId	posTerminal	Element	The receipt name to use	String
cashManagement NormalReceipt DocumentId	posTerminal	Element	The receipt name to use	String
taxRefundRequest PostVoid DocumentId	posTerminal	Element	The receipt name to use	String
balanceReport DocumentId	posTerminal	Element	The receipt name to use	String
retailQuote ReceiptDocument Id	posTerminal	Element	The receipt name to use	String
PagePrinter ProductNotes DocumentId	posTerminal	Element	The receipt name to use	String
pagePrinterFiscal InvoiceDocument Id	posTerminal	Element	The receipt name to use	String
carrierBag ProductId	posTerminal	Element	The product id of the carrier bag	String
displayCarrierBag Prompt	posTerminal	Element	if true, display the carrier bag prompt if omitted, false	Boolean
printOnDemand	posTerminal	Element	if true, disable automatic printing of receipt if omitted, false	Boolean
offerEmailReceipt	posTerminal	Element	if true, prompt cashier for email receipts, printed receipts, or both if omitted, false	Boolean
embedEmail Receipt	posTerminal	Element	if true, embed the receipt as an image in the emailed receipt if omitted, false	Boolean
offerPrinter Selection	posTerminal	Element	if true, allow operator to select receipt printer from available printers if omitted, false	Boolean
offerGift Receipts	posTerminal	Element	if true, offer gift receipts if omitted, false	Boolean
auditLogReceipt Copy	posTerminal	Element	if true, print audit log receipt copy if omitted, false	Boolean
printTaxDetails	posTerminal	Element	if true, print the details of the transaction taxes on the receipt if omitted, false	Boolean
printVoid Transaction	posTerminal	Element	if true, print a receipt for a transaction void if omitted, false	Boolean
customerView Theme	posTerminal	Element	The theme for the customer view	String
operatorView LayoutUrl	posTerminal	Element	The operator layout URL	String
operatorView Theme	posTerminal	Element	The operator view theme	String
displayFunction KeyLabelsInMenu	posTerminal	Element	if true, display the function key labels if omitted, false	Boolean
defaultTransaction Type	posTerminal	Element	The type of transaction to start	String
defaultLoyalty SchemeId	posTerminal	Element	The default loyalty scheme when enrolling a new participant	String
defaultLoyalty TierCode	posTerminal	Element	The default loyalty tier when enrolling a new participant	String
loyaltyPromptAt StartTransaction	posTerminal	Element	if true, prompt for loyalty information when starting a transaction if omitted, false	Boolean
loyaltyPromptAt Total	posTerminal	Element	if true, prompt for loyalty information when total is pressed if not present in transaction if omitted, false	Boolean
loyaltyOffer Prompt	posTerminal	Element	if true, a loyalty card should be offered at the total press if omitted, false	Boolean
storedCustomer TransactionAge	posTerminal	Element	in hours, the duration of a customer stored transaction before the transaction is unavailable for recall 0 mean unlimited	Integer
loyaltyClaim ValidityPeriod InDays	posTerminal	Element	The number of days an unclaimed loyalty transaction can be claimed	Integer
transactionTender Limit	posTerminal	Element	The maximum amount of a tender for this pos terminal	Integer
loyaltyEnquirySlip DocumentId	posTerminal	Element	The receipt name to use	String
unknownItemSale SlipDocumentId	posTerminal	Element	The receipt name to use	String
productReturn SlipDocumentId	posTerminal	Element	The receipt name to use	String
dccQuote DocumentId	posTerminal	Element	The receipt name to use	String
taxFree Eligibility Threshold	posTerminal	Element	The amount of the transaction before taxes to be eligible for tax free benefits	Integer
enableAutomatic TaxRefundForm Printing	posTerminal	Element	if true, auto print tax refund form if omitted, false	Boolean
enableAutoPrint ShowCustomer Details	posTerminal	Element	if true, automatically show customer details if omitted, false	Boolean
maxDays TransactionValid ForTaxRefund	posTerminal	Element	The number of days a transaction is valid for tax refund 0 means unlimited days	Integer
recallUsesLocal Transaction Number	posTerminal	Element	if true, use a local transaction number for recalled transactions	Boolean
enableTaxRefund Request	posTerminal	Element	if true, use the tax refund service for transactions if omitted, false	Boolean
attemptTopUpFor FailedGiftCard Activations	posTerminal	Element	if true, if activation fails for gift cards, try top up for amount if omitted, false	Boolean
displayLaunch Menu	posTerminal	Element	if true, display the POS launch menu before starting a transaction if omitted, false	Boolean
forceOrder	posTerminal	Element	if true, force an order for transactions if omitted, false	Boolean
selfServiceMode	posTerminal	Element	if true, operate in self service mode if omitted, false	Boolean
defaultQuote ValidityInDays	posTerminal	Element	The number of days a quote will be valid 0 mean unlimited	Integer
enableDelivery Scheduling	posTerminal	Element	if true, schedule delivery if omitted, false	Boolean
capturePrivacy PolicyAgreements	posTerminal	Element	if true, capture privacy policy agreements at the terminal if omitted, false	Boolean
promptForReceipt LocaleOnReprint	posTerminal	Element	if true, display prompt operator for locale on receipt reprint if omitted, false	Boolean
enableEndpoint StatusMonitor	posTerminal	Element	if true, enable endpoint status monitor for this terminal if omitted, false	Boolean
isTemplate	posTerminal	Element	if true, this pos terminal definition is a template if omitted, false	Boolean

posDayEndConfig

XML Tag	Parent Element	Type	Description	Data Type	Length
posDayEndConfig		Root	outer wrapper for the entity
disallowSales	posDayEndConfig	Element	if true, do not allow sales from this terminal if omitted, false	Boolean
terminalOutOfUse	posDayEndConfig	Element	if true, terminal is not in use if omitted, false	Boolean
forceCash Declaration	posDayEndConfig	Element	One of the following fixed values:	String
openCashDrawer	posDayEndConfig	Element	if true, open the cashdrawer at end of day if omitted, false	Boolean
closeCashDrawer	posDayEndConfig	Element	if true, close the cashdrawer at end of day if omitted, false	Boolean
excludeFrom AutoDayEnd	posDayEndConfig	Element	if true, exclude from automatic day end processing if omitted, false	Boolean
finaliseCash Session	posDayEndConfig	Element	if true, finalise the cash session at end of day if omitted, false	Boolean
finaliseCash SessionNo Discrepancy	posDayEndConfig	Element	if true, finalise the cash session when no discrepancy if omitted, false	Boolean
allowBefore Earliest	posDayEndConfig	Element	if true, allow end of day before earliest day end time if omitted, false	Boolean
deleteStored Transactions	posDayEndConfig	Element	if true, delete stored transactions during day end processing if omitted, false	Boolean
isTemplate	posDayEndConfig	Element	if true, this is a template if omitted, false	Boolean

posSessionEndConfig

XML Tag	Parent Element	Type	Description	Data Type	Length
posSessionEnd Config		Root	outer wrapper for the entity
isTemplate	posSessionEnd Config	Element	if true, this is a template if omitted, false	Boolean

posReportDefinition

XML Tag	Parent Element	Type	Description	Data Type	Length
posReport Definition		Root	outer wrapper for the entity
isTemplate	posReport Definition	Element	if true, this is a template if omitted, false	Boolean
tenderTotal DocumentId	posReport Definition	Element	The receipt id for this report	String
userSales DocumentId	posReport Definition	Element	The receipt id for this report	String
department SalesDocumentId	posReport Definition	Element	The receipt id for this report	String
hourlySales DocumentId	posReport Definition	Element	The receipt id for this report	String
tradingExceptions DocumentId	posReport Definition	Element	The receipt id for this report	String
tradingSummaries DocumentId	posReport Definition	Element	The receipt id for this report	String

posTerminalBranding

XML Tag	Parent Element	Type	Description	Data Type	Length
posTerminal Branding		Root	outer wrapper for the entity
isTemplate	posTerminal Branding	Element	if true, this is a template if omitted, false	Boolean

customerViewConfiguration

XML Tag	Parent Element	Type	Description	Data Type	Length
customerView Configuration		Root	outer wrapper for the entity
isTemplate	customerView Configuration	Element	if true, this is a template if omitted, false	Boolean
showBasket	customerView Configuration	Element	if true, show the basket if omitted, false	Boolean

Device Delete

XML Example

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Batch xmlns:core="http://www.enactor.com/core"
    xmlns:retail="http://www.enactor.com/retail"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">

    <!--   DeviceKey -->
    <core:entityDeleteRequest>
        <core:entityKey xsi:type="retail:DeviceKey">deviceId</core:entityKey>
    </core:entityDeleteRequest>
</Batch>

XML Structure

entityDeleteRequest

XML Tag	Parent Element	Type	Description	Data Type	Length
entityKey	entityDelete Request	Element	The device id key to delete	String
type	entityKey	Attribute	Fixed:DeviceKey	fixed

Location Delete

XML Example

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Batch xmlns:core="http://www.enactor.com/core"
    xmlns:retail="http://www.enactor.com/retail"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">

    <!--   LocationKey -->
    <core:entityDeleteRequest>
        <core:entityKey xsi:type="retail:LocationKey">locationId</core:entityKey>
    </core:entityDeleteRequest>
</Batch>

XML Structure

entityDeleteRequest

XML Tag	Parent Element	Type	Description	Data Type	Length
entityKey	entityDelete Request	Element	The location id key to delete	String
type	entityKey	Attribute	Fixed:LocationKey	fixed

POS Terminal Delete

XML Example

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Batch xmlns:core="http://www.enactor.com/core"
    xmlns:retail="http://www.enactor.com/retail"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">

    <!--   POSTerminalKey -->
    <core:entityDeleteRequest>
        <core:entityKey xsi:type="retail:POSTerminalKey">posTerminalId</core:entityKey>
    </core:entityDeleteRequest>
</Batch>

XML Structure

entityDeleteRequest

XML Tag	Parent Element	Type	Description	Data Type	Length
entityKey	entityDelete Request	Element	The pos terminal id key to delete	String
type	entityKey	Attribute	Fixed:POSTerminalKey	fixed