Introduction

This technology is intended for configurations, where the information about sales should be transmitted online. The data is sent to the external (third-party) system via HTTPS.
The data is transmitted in XML format. The data format should be negotiated with the service client.
The described technology can be used in different external systems. Initially, the service was ordered by the Pulkovo airport — all points of sale, leasing trading facilities on the premises of the airport, should have ensured sales data transmission to a single information system.

Contents of Distribution Package

The distribution package contains the following modules:

  • ExportXML_SVC.exe — the main executive module
  • sqlite3.dll — a library used to interact with the local SQLite DBMS
  • RK7XML.dll — an interface library for interaction with the r_keeper v7 cash server via an XML interface
  • Monlib.dll and RNBOPEN.DLL — interface and transport libraries (respectively), used to interact with the r_keeper v6 cash server
  • Monlib.ini — the Monlib.dll library configuration file

The Monlib.dll library requires the Monlib.key software license key — see details under the Licensing section

The distribution package is available on FTP: ftp://ftp.ucs.ru/r-keeper/Tools/ExportXML/

Licensing

r_keeper v7

At the moment of the last article edition, the module does not require licensing to interact with r_keeper v7. However, the lifetime of the main executive file ExportXML_SVC.exe expires on 18.03.2015. After this date, the module will stop functioning. In the future, a general licensing system is planned.

Setup

Main Settings

Relevant parameters for the connection to an external information system should be requested from the service client

To enter the configuration mode, launch ExportXML_SVC and click Settings.
Main parameters are set on the Main tab.

  • Bill downloading
    • WSDL — the address used to access an external service via the WDSL interface
    • URL  — the address used to access an external service via the SOAP interface
    • Service — the name of the service, f.ex. CheckInfo. The relevant value should be requested from the service client
    • Port — the name of the port, f.ex. CheckInfo_Port. The relevant value should be requested from the service client
    • Login — the username for accessing the service; should be provided by the service client
    • Password — the password for accessing the service; should be provided by the service client
  • Timezone — the current time zone, required for correct interaction with the external service
  • Detailed log — to record the detailed operation log
  • Save XML — to save XML files, sent to the external service, on the HDD
  • Non-relevant data — parameters controlling the management of accumulated information in the database
    • Number of days — the period (in days), during which the data should be accumulated and stored
    • Deletion time — the time of the day when the data is checked and cleaned up

All parameters are stored in the db.db database, which is created automatically at the first application launch.

Payment configuration

For the data to be formed correctly, configure the correspondence of payment types or currencies between r_keeper and the external system:

  1. Launch ExportXML_SVC.exe, go to the settings, and switch to the r_keeper tab
  2. In the Receipt payments section, right-click the menu, and select Add
  3. Fill in the parameters:
    • RK currency name — the currency name as specified in the editor (RK6), or at the manager station (RK7)
    • Currency — the relevant currency name in the external system; possible values should be requested from the service client
    • Method — the payment method for the currency; possible values should be requested from the service client.
  4. In the Payment defaults section, fill in the values of the Currency and Method parameters, which will be used by default for those currencies without a relevant match from the Receipt payment section, or if there is no receipt payments at all
  5. To save the parameters, click OK and restart ExportXML_SVC

r_keeper 7

To configure the interaction between ExportXML_SVC and r_keeper 7, do the following:

  1. At the manager station, add an XML interface to the cash server, define the port, and specify the encryption key (CryptKey), if required
  2. Launch ExportXML_SVC.exe, go to the settings, and switch to the r_keeper tab
  3. In the Cash system section, select r_keeper 7 and fill in the cash server XML interface connection parameters — IP address, port, and encryption key (CryptKey), if it is set on the cash server
  4. Specify the payment match
  5. If necessary, change the Cash desk polling frequency parameter value
  6. Fill in the VendorID (organization ID) and ObjectID (trading facility ID) parameters. The value should be requested from the service client
  7. To save the parameters, click OK and restart ExportXML_SVC.

Application Launch

The application can be launched in the following modes:

  • Launch without parameters — used to configure parameters and/or start data collection manually
  • With /autostart parameter — launching as a desktop application, automatic data collection start
  • With /install parameter — installing the application as a service; after the service launch, data collection starts automatically
  • With /uninstall parameter — deleting the installed service.
  • No labels