placeholder Command:  FORWARDING RECEIPT CONFIGURATIONS 


Short version Long version Changes Example

Mandatory: no
max. Occurrence:  unbounded
Description:
This tag is used as container for commands regarding the forwarding receipt configuration.
 
Mandatory: yes
max. Occurrence:  unbounded
Supported modes: read Read the named item.
readall Read all items from the desired device(s). This doesn't mean comparable reading as in the L2 protocol.
write Write the named item.
Description:
Configuring a forwarding receipt server.
The job of a forwarding receipt server is to forward a file for each closed receipt to an FTP-Server.
To be able to forward receipts it is necessary to set the parameters for the FTP-Server.

"Forwarding receipts" is an option which needs a licence-key to be enabled (uc3options.xml).
Notes:
To use the forwarding receipt functionality on the device it is necessary to activate it.
The XML command is processed by the device whithout activiation.
The forwarding receipt functionality itself doesn't work with activation.

Version 1.3.0 and higher
The configuration of a single property is now supported without the loss of the remaining properties.

Version 1.2.1 and lower
For the mode ''write'' all properties have to be sent at once since they are stored in a file.
When sending not all properties at once the loss of the unnamed properties is inevitable.

   
Mandatory: no
max. Occurrence:  1
Description:
A list of properties.
All the configuration properties have to be encapsulated within here.
     
Mandatory: yes
max. Occurrence:  unbounded
Description:
Each configartion property is separted within here.
       
Mandatory: yes
max. Occurrence: 1
Datatype: string
Range: max. 20 characters
Nillable: no
Description:
The name of the property.
For the Mettler-Toledo implementation of the forwarding receipt server the following names are predefined.
Name Description Value
server.nEnable Disable or enable the receipt forwarding functionality for this device. (0/1)
server.szIpAddress The IP address of the device (server) where the receipts have to be forwarded. e.g. 172.21.92.108
server.unPortNo The port number on which the device (server) is expecting the connection request. Normally the port number is depending on the service that is used for the forwarding of the receipts. The standard port numbers are listed by the IANA (Internet Assigned Numbers Authority) at http://www.iana.org.
server.szUsername The username that has to be used for authorization.
server.szPassword The password by which the user is authorizing.
server.szSubdir The name of a subdirectory on the device (server) where the receipts are copied to.
The following properties are supported with version 1.1.0 and higher.
common.nStrategy
Value Description
0 The receipt will always be forwarded to the FTP server specified at server.szIpAddress . If this server fails the receipt will be forwarded to the FTP server specified at backup.szIpAddress . Within the next 5 minutes generated receipts are forwarded to the server specified at backup.szIpAddress . After that time a verification is done whether the server specified at server.szIpAddress is available again. If it is available then the receipts will be forwarded to this FTP server again.
1 Every receipt will be forwarded to each specified FTP server. In the case of having unavailable FTP servers the receipt is forwarded successfully if it is forwarded to at least one FTP server. A FTP server that has failed will be contacted after 5 minutes.
(0/1)
backup.nEnable Disable or enable the receipt forwarding functionality for an existing backup FTP server. This server is used if the default FTP server is not available. (0/1)
backup.szIpAddress The IP address of the device (server) where the receipts have to be forwarded when the default FTP server is not available. e.g. 172.21.92.108
backup.unPortNo The port number on which the device (backup FTP server) is expecting the connection request. Normally the port number is depending on the service that is used for the forwarding of the receipts. The standard port numbers are listed by the IANA (Internet Assigned Numbers Authority) at http://www.iana.org.
backup.szUsername The username that has to be used for authorization on the backup FTP server.
backup.szPassword The password by which the user is authorizing on the backup FTP server.
backup.szSubdir The name of a subdirectory on the device (backup FTP server) where the receipts are copied to.
The following properties are supported with version 1.2.0 and higher.
app.szPrefixSM A string that will be assigned to the name of the forwarding receipt file as prefix in application sale.
app.szPrefixPP A string that will be assigned to the name of the forwarding receipt file as prefix in application prepack.
app.szPrefixSS A string that will be assigned to the name of the forwarding receipt file as prefix in application selfservice.
app.szPrefixInv A string that will be assigned to the name of the forwarding receipt file as prefix in application inventory.
app.szPrefixInv1 A string that will be assigned to the name of the forwarding receipt file as prefix in application inventory mode1.
app.szPrefixInv2 A string that will be assigned to the name of the forwarding receipt file as prefix in application inventory mode2.
app.szPrefixInv3 A string that will be assigned to the name of the forwarding receipt file as prefix in application inventory mode3.
app.szPrefixInv4 A string that will be assigned to the name of the forwarding receipt file as prefix in application inventory mode4.
app.szPrefixInv5 A string that will be assigned to the name of the forwarding receipt file as prefix in application inventory mode5.
app.szPrefixInv6 A string that will be assigned to the name of the forwarding receipt file as prefix in application inventory mode6.
app.szPrefixInv7 A string that will be assigned to the name of the forwarding receipt file as prefix in application inventory mode7.
app.szPrefixInv8 A string that will be assigned to the name of the forwarding receipt file as prefix in application inventory mode8.
app.szPrefixInv9 A string that will be assigned to the name of the forwarding receipt file as prefix in application inventory mode9.
The following property is supported with version 1.6.0 and higher.
app.szPrefixCashReg A string that will be assigned to the name of the forwarding receipt file as prefix when cash register option is enabled.
For information about enabling the cash register option see command <sales_application_configurations> With version 1.10.0 and higher a cash register mode is available. The string will be assigned to the name of the forwarding receipt file as prefix in application cash register.
The following property is supported with version 1.10.0 and higher.
app.szPrefixMoney A string that will be assigned to the name of the forwarding receipt file as prefix for the flow of money transactions done in the NSM menu Cash Register - Paid In, Cash Register - Paid Out, Cash Register - Loan, Cash Register - Pick Up and Cash Register - Cash Register Report.

       
Mandatory: yes
max. Occurrence: 1
Datatype: string
Range: max. 20 characters
Nillable: no
Description:
The value that shall be assigned to the property name.
For more information see the description of the element <name> above.