Versions Compared

Old Version 2

changes.mady.by.user Ekaterina Marchenko

Saved on

compared with

New Version 3

changes.mady.by.user Ekaterina Marchenko

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Introduction

ExternalDeliveryInterface module — hereinafter EDI — allows exchanging information between external third-party delivery system and r_keeper 7 cash system.

Interaction between systems is performed by .CSV files exchange. Pre-processed files are placed at a special network resource at the server in the company head office, and on network resources of servers installed in departments — restaurants — of the Company. These network resources should be availble for clients and servers of delivery systems and r_keeper 7 via LAN (head office) and VPN channels (departments), including while connecting to the specified servers in terminal mode — disks connection setup.

Distribution Kit

Module includes three files:

...

The distribution package is available at FTP ftp://ftp.ucs.ru/rk7/other/ExternalDeliveryInterface

Setup

  1. In the manager station, go to Service > Stations and Devices, select a required cash server and add XML interface for Windows on the Drivers tab. In the Options section of the driver properties, specify the Port, f.ex., 14441.
  2. In the Sevice > Interfaces menu, link this XML interface to the logical interface
  3. Restart the cash server
  4. In Options > Tables and Plans > Hall Plans and Tables, create a new table or tables, or use existing one, to which orders from external delivery will be placed. Remember the table code
  5. Create a folder for file exchange, for example, d:\UCS\EDI\Exchange\

  6. Edit the Settings.ini file

    Code Block
    [Main]
Frequency=15 ; Frequency of working folder scanning, in seconds
WorkPath=C:\UCS\Aventa\v.1.0.0.41\ ; Working folder as per 3.4.
LogLevel=2 ; logging level (maximum is 4)

[RK]
Server=127.0.0.1 ; IP address of r_keeper_7 POS server
Port=14441 ; Port for XML interface
PriceIdent=3 ; price type identifier in РК7 (Menu -> Price types reference)
StationIdent=15015 ; station identifier
GuestType=1  ; guest type identifier, optional
UseXML=1
UsePrice=0
PayIdent=1043924 ; order pre-paymentprepayment currency identifier
PrepayReasonIdent=1043926 ; pre-paymentprepayment deposit reason identifier
PayInterfaceIdent=1 ; identifier of logical interface for connection to loyalty system (PDS or SRM). Required to associatelink card withto order
StationIdent=1 ; cash register station identifier
OneTableMode = 1; mode of creating orders creation at one table mode (creation ofcreating tables with "point") — mode on (1) or off (0), starting from version 1.0.0.47
                ; if off (0), interface will only create one order if different orders with the same table number are created
OneTableIdent = 12345; table identifier for orders creation in OneTableMode = 1 mode, starting from version 1.0.0.47

[License]
Server=l.ucs.ru ; IP address of license server, do not modify
Port=60606 ; Port for license server, do not modify

; Optional parameters
 
[Main]
DebugMode=1 ; debug mode

; Enable interface with statsstatistics
[Main]
RefServerPort=7251 ; servers port

    Usage:

...

    •  — shows current session

...

...

    •  — shows stats for the last 3 days
  2. Run Run the ExternalDeliveryInterface.exeexe file.
Note
titleImportant!

Run the file as an administrator!

Licensing

  • In "License Request" section press "Generate request" and copy the license request code (see Fig. 1).
  • at license server site l.ucs.ru, create new SW request for your object, select "R-Keeper module Interface to delivery system SW" module (see Fig. 2).
  • upon request confirmation, generate licnese

...

Depending on folder timeout (p. 3 of Settings section), response file will appear. (see Annex 2).

Functional operations with data exchange

Menu download

Download is performed automatically into file by pointing the ExternalDeliveryInterface.exe application with a mouse in tray and pressing "Save menu". Then, select folder to save the file in, and specify file name, e. g., menu.csv. Saving is only possible is license is in place. 
If references need to be downloaded for external delivery software without interrupting EDI service, act as follows:

...

  1. 0.0.1:7251/{A11858BB-8C51-475A-A000-3E82AA1A56C8};
  2. Observe successful saving message or error message.

New order download

Delivery orders are generated by users in external delivery system. 

External delivery system client shall compose Order_New<Table_code>.csv file, where <Table_code> is some 4-symbol unique integer identifier generated by external delivery (e. g., Order_New9032.csv and OrderParts_New9032.csv). The files contain values of order fields and order lines, respectively. Suffix New is the marker of initial order download to R-Keeper 7. See file format in Annex 1.

The file is downloaded to the folder specified in 3.3. Software application (ExternalDeliveryInterface.exe) that implements data exchange between external delivery system and R-Keeper 7 performs automatic periodic resource (folder created in 3.3) scanning for Order import files. If downloaded Order files are found, data import to R-Keeper 7 is performed. Upon import completion, processed files are deleted from address folder, and response file is created.

When data is imported to R-Keeper 7, a table is created. Therewith:

...