ICash TpCash Plugin. TCPOS The ICash TpCash plugin Page 1/30

Transcription

1 ICash TpCash Plugin TCPOS The ICash TpCash plugin Page 1/30

2 This document and all of its contents are protected by copyright. All rights are expressly reserved including those of duplication, reproduction, translation, microfilming, storage on electronic media and processing in electronic form. TCPOS is a registered trademark of TCPOS SA. Microsoft, Windows, Windows XP, Windows Embedded POSready, Windows Vista, Windows 7, Windows 8, Windows Embedded POSready 7, Windows 2003 Server, Windows Server 2008, Windows Server 2008 R2, Windows Server 2012, Windows Server 2012 RC2, Microsoft SQLServer 2005, Microsoft SQLServer 2008, Microsoft SQLServer 2008 R2, Microsoft SQLServer 2012, Microsoft SQLServer 2012 Express Edition 32 bit & Microsoft SQLServer 2012 Express Edition 64 bit, Microsoft SQLServer 2014, Microsoft SQLServer 2014 Express Edition 32 bit & Microsoft SQLServer 2014 Express Edition 64 bit, Windows Mobile 2003, Windows Mobile 5.0, Windows CE.NET 4.0, Windows CE.NET 4.2, Windows CE 5.0, Windows CE 5.1, Windows CE 5.2, Windows Embedded CE 6.0, Windows Embedded CE 6.1, Windows Embedded CE 6.5, Windows Embedded CE 6.0 R2 and Windows Embedded CE 6.0 R3 are registered trademarks of Microsoft Corporation. Oracle 10gTM, Oracle 11gTM, Oracle 11g R2TM, Oracle 11 XE Express edition 32 bittm, Oracle 12cTM, are trademarks or registered trademarks of Oracle Corporation. The PostgreSQL 9.1, The PostgreSQL 9.3 are a registered trademark of The PostgreSQL Global Development Group. Android is a registered trademark of Google Inc. All other company, product and brand names are trademarks or registered trademarks of their respective owners. The information featured in this document may be subject to change without notice at any time. Copyright TCPOS SA, All Rights Reserved. Document info Document ID: I/F_ICash_TpCash_1.0 Document date: May 2016 Document version: 1.0 Valid from first plugin release Valid to x Distribution: This electronic file is the original and supersedes any printed copy Switzerland TCPOS SA - Lugano Centro Galleria 2, Via Cantonale 2c CH-6928 Manno Tel. +41 (0) Fax +41 (0) Germany TCPOS GmbH Völklingen (Saarbrücken) Saarwiesenstr. 5 D Völklingen Tel. +49 (0) Fax +49 (0) France TCPOS France - Paris 9 b Rue de la Sablière F Gennevilliers Tel. +33 (0) Italy ZUCCHETTI TCPOS Srl - Milan Via A. De Gasperi Rho (MI) Tel Fax: TCPOS SA - Lausanne Route Z.I. La Vulpillière 61B CH-1070 Puidoux Tel. +41 (0) Fax +41 (0) TCPOS SA - Zürich Giessenstrasse 15 CH-8953 Dietikon Tel. +41 (0) Fax +41 (0) USA TCPOS U.S.A. Inc. - Reno 1875 Plumas Street Ste 5 Reno, NV Tel +1 (775) North America TCPOS North America Toronto 2225 Sheppard Ave. East (Atria III Building) Suite 901 Toronto, ON Canada M2J 5C2. Tel. +1 (416) Fax +1 (416) Latin America TCPOS SA Buenos Aires Portela 407, 2ºC C1406FDI Buenos Aires- Argentina Tel (11) Fax +1 (416) China TCPOS ASIA Shanghai No.400 Fangchun Road China (Shanghai) Pilot Free Trade Zone Tel TCPOS The ICash TpCash plugin Page 2/30

3 Index Index... 3 Foreword... 4 This plugin guide... 5 Aim of the plugin... 5 Mandatory rules... 5 Part 1: Implementation... 6 Plugin modules... 7 Plugin installation... 7 Part 2: Setup Ribbon options, tabs, fields and permissions added by the plugin Configuration in Admin Configuration of the payments Configuration of the TpCash parameters Configuration of the Printout template Configuration of the tills Configuration of the withdrawals and deposits Configuration of the till template and new function keys...18 Part 3: Workability Workability in FrontEnd Payment with TpCash Withdrawals and deposits Final drawer count...29 TCPOS The ICash TpCash plugin Page 3/30

4 Foreword This plugin guide Aim of the plugin Mandatory rules TCPOS The ICash TpCash plugin Page 4/30

5 This plugin guide This document describes the features added to TCPOS by the "ICash TPCash" plugin. Aim of the plugin This plugin enables the integration of the Wincor Nixdorf TPCash solutions for automated, end-to-end cash management. Further information about the device can be found at this link: The TpCash machine substitutes the standard drawer of the till, therefore in this manual we also explain the mode of operation of some features linked to withdrawal/deposits and drawer counts. It intercepts cash payments (as defined in the TCPOS Admin module) and requires the customer to use the TpCash machines linked to the till to pay the transaction. It also manages the cash back due to transaction cancellation: if the payment was made with the TpCash machine, then the machine will also give money back in case of a transaction cancellation. Therefore, the standard storno function keys aside are also supported and their behavior does not change. FRONTEND Function key {44 Storno Transaction} FRONTEND Function key {46 Storno partial transaction} The machine provides a webserver that is used by TCPOS to make requests, and FrontEnd performs the retrieval of the information about payments made through the machine for cash payment, connected to the TCPOS frontend by LAN. In FrontEnd, the plugin provides also some additional functionalities in order to: print the current inventory of the TpCash machine; enable or disable on till the communication with TpCash machine; manage the withdrawal or deposit of cash from/into the TpCash machine. The plugin adds also a new tab used to display the total paid with the TpCash machine for a given shift, in Admin, when performing the final drawer count through the feature aside: ADMIN > Tasks > Drawer counts > Count selected button > tab TpCash and FrontEnd, in the mask of the final drawer count (tab Extra items ) retrieved through the standard function key aside: FRONTEND Function key {63 Final drawer count} FRONTEND Function key {Function [65 Final drawer count for another shift]} Mandatory rules Since the plugin works together with the TpCash machine installed in the environment, check that the System currency configured in TCPOS Admin is the same as the one set in the TpCash machine parameters. ADMIN > System > System Parameters > tab Main definitions > field System currency TCPOS The ICash TpCash plugin Page 5/30

6 Part 1: Implementation Plugin modules Plugin installation TCPOS The ICash TpCash plugin Page 6/30

7 Plugin modules The modules composing this plugin are described in the related wiki.tcpos.com article Please refer to it for further information. TCPOSwiki article: ICash TpCash Plugin Plugin installation Note The plugin installation follows the rules of the plugins standard installation. The installation workflow of this plugin is described in the related wiki.tcpos.com article Please refer to it for further information. TCPOSwiki article: ICash TpCash Plugin TCPOS The ICash TpCash plugin Page 7/30

8 Part 2: Setup Ribbon options, tabs, fields and permissions added by the plugin Configuration in Admin TCPOS The ICash TpCash plugin Page 8/30

9 1.1 Ribbon options, tabs, fields and permissions added by the plugin Menu options and their permissions After the operator s login, if the plugin is installed, a new ribbon option appears. ADMIN > TpCash Parameters Tabs and fields added by the plugin The plugin adds some new fields and new tabs in the Admin base data, used to manage the payments made through the TpCash machine. New tab involved used to manage the TpCash settings New tab in Admin involved used to show the total paid with the TpCash machine New tab in FrontEnd drawer count mask involved used to show the total paid with the TpCash machine ADMIN > Outlets > Tills > tab TpCash Settings ADMIN > Tasks > Drawer counts > Count selected button > tab TpCash FrontEnd > Final drawer count form > tab Extra Items Function keys added by the plugin The plugin defines some new non-standard function keys related to management of payments made through the TpCash machine: TpCash enable/disable machine ADMIN > Outlets > Till templates/popup layers > function key TpCash enable/disable machine TpCash Inventory ADMIN > Outlets > Till templates/popup layers > function key TpCash inventory TpCash Pay In ADMIN > Outlets > Till templates/popup layers > function key TpCash Pay in TpCash PayOut ADMIN > Outlets > Till templates/popup layers > function key TpCash PayOut TpCash enabled status (Info Panel) ADMIN > Outlets > Till templates/popup layers > button Configure keyboard > info TpCash enabled status TCPOS The ICash TpCash plugin Page 9/30

10 1.2 Configuration in Admin This section describes the features to configure so that you can use the extensions added by the plugin. Please follow the next related steps: 1. Configuring the payments used by the system to manage transactions paid through the TpCash machine Configuration of the payments 2. Configuring the TpCash main parameters Configuration of the TpCash parameters 3. Configuring the printout template for the inventory Configuration of the Printout template Configuring the till that will be connected to the TpCash machine Configuring the withdrawal/deposits used to load and unload the TpCash machine Configuration of the tills Configuration of the withdrawals and deposits 6. Configuring the till template Configuration of the till template TCPOS The ICash TpCash plugin Page 10/30

11 1.2.1 Configuration of the payments ADMIN > Sale items > Payments This form is used to define: the source payment that will be replaced with the TpCash payment in Frontend (in our example payment code 110 Cash4TpCash ); the payment used by TpCash for transactions (in our example payment code 111 TpCash Machine ). The payments must be of type Cash. Fields definition Since this is a standard form, all other fields are standard and there are no constraints for the entry of the parameters, that is at complete discretion of the user. Their description can be found in HELP ONLINE, downloadable from the TCPOS Community. TCPOS Wiki article: TCPOS User Manual TCPOS The ICash TpCash plugin Page 11/30

12 1.2.2 Configuration of the TpCash parameters ADMIN > TpCash Parameters This form is used to set the TpCash main parameters related to the payments. Fields definition Field Cash Mandatory TpCash Mandatory Description This is the source payment that will be replaced with the TpCash payment in Frontend. Select from combo the payment desired among the ones set in the related table aside, filter according to the visibility criteria and to the type; in fact, only payments of type Cash are displayed. This is the payment used by TpCash for transactions. Select from combo the payment desired among the ones set in the related table aside, filter according to the visibility criteria and to the type; in fact, only payments of type Cash are displayed. ADMIN > Sale items > Payments ADMIN > Sale items > Payments TCPOS The ICash TpCash plugin Page 12/30

13 1.2.3 Configuration of the Printout template Before using the plugin, it is necessary to create a Printout template, that will be later assigned as the default template for the printout of the inventory when using the specific function key provided by the plugin. ADMIN > System > Printout templates In order to create the template, copy the content of the file TpCashInventory.xslt available in the release directory of the plugin. Fields definition Since this is a standard form, the description of its fields can be found in HELP ONLINE, downloadable from the TCPOS Community. TCPOS Wiki article: TCPOS User Manual Example of printout Show 101 Manno Till 18 Operator 1 Admin Inventory Notes Q.ty Amount Cassette RECYCLE RECYCLE OVERFLOW COLLECT RECYCLE Total :54:22 Op: 1 C: 18 S: 101 TCPOS The ICash TpCash plugin Page 13/30

14 1.2.4 Configuration of the tills This feature is used to set the parameters of the server for the TpCash management. Note The configuration data in this picture is fake and entirely for demonstration purpose. The effective data is given by the TpCash technical staff. ADMIN > Outlets > Tills > tab TpCash Settings This form is used to define some specific parameters of the till that will be connected to the TpCash machine. Fields definition The tabs aside contain only standard fields, whose insertion is at the user s discretion, without any restriction linked to plugins. Since these are standard forms, the description of their fields can be found in HELP ONLINE, downloadable from the TCPOS Community. Main definition Amounts and flags Other parameters Printer parameters Extra printers parameters Table service Events and custom Template scheduling TCPOS Wiki article: TCPOS User Manual TCPOS The ICash TpCash plugin Page 14/30

15 Field Webservice address Mandatory Print template inventory Description This is the address of the TpCash machine the till connects to. Select from combo the template that will be used for the inventory printout. The combo for the parameter s selection retrieves the templates saved in the table aside, filtered according to the operator visibility criteria and according to the type. In fact only Templates of type Bill are displayed ADMIN > System > Printout templates TCPOS The ICash TpCash plugin Page 15/30

16 1.2.5 Configuration of the withdrawals and deposits ADMIN > Bookkeeping > Withdrawals/Deposits This form is used to define the withdrawal and deposit type that will be linked to the TpCash machine and used to store the data of those transactions in the Withdrawal transactions Admin standard form. Important You must set: a withdrawal type, that will be associated to the standard function key and used to take money from the TpCash machine (in our example code 30 TpCash Withdrawal ); a deposit type, that will be associated to the standard function key and used to load the TpCash machine when needed (in our example code 31 TpCash Deposit ); For both operations, it is mandatory to associate, in the grid below, field Payment, the source payment type previously configured in the form aside: (in our example code 110 Cash4TpCash ). ADMIN > Sale items > Payments Fields definition Since this is a standard form, all other fields are standard and there are no constraints for the entry of the parameters, that is at complete discretion of the user. Their description can be found in HELP ONLINE, downloadable from the TCPOS Community. TCPOS Wiki article: TCPOS User Manual TCPOS The ICash TpCash plugin Page 16/30

17 ADMIN > Outlets > Till templates/popup layers > button Configure keyboard > New button > Function Withdrawal/Deposit Now, configure in the till template two function keys that will be used to withdraw/deposit money from/into the TpCash machine and to store the data of those transactions in the Withdrawal transactions Admin standard form. Remember to select, in the combobox Parameter 2, the withdrawal/deposit type specifically configured for TpCash in the Admin form aside: ADMIN > Bookkeeping > Withdrawals/Deposits TCPOS The ICash TpCash plugin Page 17/30

18 1.2.6 Configuration of the till template and new function keys First of all, it is necessary to configure in the Total layer a button for the payment with TpCash machine. ADMIN > Outlets > Till templates/popup layers > button Configure keyboard > New button > function Payment Remember to select, in the combobox Current parameter, the payment previously configured in the Admin form aside as the source payment that will be replaced with the TpCash payment in Frontend (in our example payment code 110 Cash4TpCash ); ADMIN > Sale items > Payments Example of encoded layer TCPOS The ICash TpCash plugin Page 18/30

19 This plugin adds also some new function keys and an info panel, in order to manage the working method and the payments through the TpCash machine. ADMIN > Outlets > Till templates/popup layers > button Configure keyboard > info TpCash enabled status This infopanel displays the status of the TpCash machine (enabled/disabled). Example of encoded layer TCPOS The ICash TpCash plugin Page 19/30

20 ADMIN > Outlets > Till templates/popup layers > function key TpCash enable/disable machine Pressing this function key, FrontEnd can enable or disable the communication with the TpCash machine and, if necessary, go back to the working mode with the standard drawer. By clicking on the TpCash enable/disable machine button, the system displays the message aside: ADMIN > Outlets > Till templates/popup layers > function key TpCash inventory Pressing this function key, FrontEnd displays a form with the inventory of all notes and coins available in the device and other warnings and information given by the TpCash machine configuration. TCPOS The ICash TpCash plugin Page 20/30

21 ADMIN > Outlets > Till templates/popup layers > function key TpCash Pay in This function key is used to load the TpCash machine when needed. Pressing this function key, the system displays a form where the operator can see the detailed amount of money inserted in the TpCash machine for the load. To end the operation, click on the Stop Pay-in button When the operation is done, FrontEnd displays the message aside: Message INFO: Pay-in: 256,00 OK Important The operations made through this button are not stored in the standard TCPOS Admin bookkeeping information. Therefore this function key must be used only by managers. If you want to keep track of the withdrawal and deposit movements in TCPOS Admin bookkeeping, we recommend you to configure the TpCash Withdrawal and TpCash Deposit function keys as described in chapter Configuration of the withdrawals and deposits. Remember to check that the TpCash machine is correctly connected and enabled; otherwise the system, will display the message aside: Message WARNING: TpCash not working: Pay-in not possible. OK ADMIN > Outlets > Till templates/popup layers > function key TpCash PayOut This function key is used to withdraw cash from the TpCash machine when needed. Pressing this function key, the till displays a form where the operator can insert the amount he wants to withdraw. Insert the amount and press Ok. TCPOS The ICash TpCash plugin Page 21/30

22 The TpCash machine dispenses the money; when the operation is done, FrontEnd displays the message aside: Message INFO: Pay-out: 100,00 OK Important The operations made through this button are not stored in the standard TCPOS Admin bookkeeping information. Therefore this function key must be used only by managers. If you want to keep track of the withdrawal and deposit movements in TCPOS Admin bookkeeping, we recommend you to configure the TpCash Withdrawal and TpCash Deposit function keys as described in chapter Configuration of the withdrawals and deposits. Remember to check that the TpCash machine is correctly connected and enabled; otherwise the system, will display the message aside: Message WARNING: TpCash not working: Pay-out not possible. OK TCPOS The ICash TpCash plugin Page 22/30

23 Part 3: Workability Workability in FrontEnd TCPOS The ICash TpCash plugin Page 23/30

24 2. Workability in FrontEnd 2.1 Payment with TpCash Operational steps 1 Log in at the till with usercode and password. 2 Make a standard sale transaction. Press on the Total button to access the total layer and enter the payment. Press on the TpCash payment button to enable the payment through the TpCash machine. 3 The system displays a mask with the total amount to pay Now the customer can insert the money in the machine. During the insertion, the value in the Deposit field is constantly updated with the amount of money gradually inserted. 3.a If the customer pays the total amount in cash, the transaction is successfully closed and the till goes back to the sale layer. TCPOS The ICash TpCash plugin Page 24/30

25 3.b If the customer pays a part of the amount in cash, and the rest with another type of payment: insert the cash in the TpCash machine; the system will display the amount in the specific form press the Partial pay button to exit the form and go back to the total layer; select the type of payment for the remaining amount and close the transaction. Result in the ADMIN > Bookkeeping > Transactions Control form TCPOS The ICash TpCash plugin Page 25/30

26 2.2 Withdrawals and deposits The withdrawal and deposits operations on the TpCash machine can be performed through the specific function keys aside: FRONTEND function key TpCash Pay-in FRONTEND function key TpCash PayOut However, as previously explained, the operations made through these buttons are not stored in the standard TCPOS Admin bookkeeping information. Therefore these function keys must be used only by managers. If you want to keep track of the withdrawal and deposit movements in TCPOS Admin bookkeeping, the user have to configure the standard Withdrawal function key in FrontEnd as described aside: ADMIN > Outlets > Till templates/popup layers > button Configure keyboard > New button > Function Withdrawal/Deposit Operational steps for deposit 1 Log in at the till with usercode and password. 2 Press on the TpCash Deposit function key. The system displays a form where the user can insert the amount he wants to deposit in order to load the TpCash machine: Press Save/Print and start inserting the money in the TpCash machine. TCPOS The ICash TpCash plugin Page 26/30

27 3 The system displays a mask where the user can check the amount inserted When the operation is done, press Stop Pay-in to end it and go back to the sale layer. Result in the ADMIN > Bookkeeping > Withdrawal Transactions form TCPOS The ICash TpCash plugin Page 27/30

28 Operational steps for withdrawal 1 Log in at the till with usercode and password. 2 Press on the TpCash Withdrawal function key. The system displays a form where the user can insert the amount he wants to withdraw from the TpCash machine: Press Save/Print to start the operation. 3 The TpCash machine will dispense the money and the till will display the following message: Result in the ADMIN > Bookkeeping > Withdrawal Transactions form TCPOS The ICash TpCash plugin Page 28/30

29 2.3 Final drawer count The plugin adds also a new tab (both in Admin and FrontEnd) used to display the total paid with the TpCash machine for a given shift, when performing the final drawer count. The tabs display only the total amount of the transactions paid through the specific payment type configured with TpCash parameters, as explained in the chapter aside: ADMIN > Outlets > Till templates/popup layers > button Configure keyboard > New button > function Payment The amount displayed in the tab considers also withdrawals and deposit registered in TCPOS Admin data and performed through the function keys configured as described in chapter aside: ADMIN > Outlets > Till templates/popup layers > button Configure keyboard > New button > Function Withdrawal/Deposit Important The value retrieved in these tabs is read only and not editable. FrontEnd > Final drawer count form > tab Extra Items TCPOS The ICash TpCash plugin Page 29/30

30 ADMIN > Tasks > Drawer counts > Count selected button > tab TpCash TCPOS The ICash TpCash plugin Page 30/30