The WebAccountManager Plugin (HTML5 version) Installation. delete from DB_OPERATIONS where GUID=' '

Transcription

1 delete from DB_OPERATIONS where GUID=' ' The WebAccountManager Plugin (HTML5 version) Installation TCPOS The WebAccountManager plugin (HTML5 version) - Installation Page 1/17

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: STD_INST_WebAccountManager_(HTML5)_1.0 Document date: June 2016 Document version: 1.0 Valid from Valid to last version released 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 WebAccountManager plugin (HTML5 version) - Installation Page 2/17

3 Index Index... 3 Scheme of the plugin workability inside TCPOS... 4 Part 1: Implementation... 6 Plugin modules... 7 Plugin installation... 7 Scheme of the web server directory structure inside TCPOS...9 The WebAccountManagerService installation...12 The customer s web page definition and configuration...16 TCPOS The WebAccountManager plugin (HTML5 version) - Installation Page 3/17

4 Foreword Scheme of the plugin workability inside TCPOS TCPOS The WebAccountManager plugin (HTML5 version) - Installation Page 4/17

5 Kernel and Plugin Data Scheme of the plugin workability inside TCPOS Blue arrows = internet WebSite request.open = " CLOUD WebService <server>tcpos4learning513@ :9095 <httpserveraddress> (WEB) ServerService :9095 dbaliases=tcpos4learning513 Till FrontEnd p2p = :6195 SHOP Admin p2p= :6195 Central DB tcpos4learning513 In the environment: ServerService - standard allows the communication between Admin and FrontEnd and the database WebService strictly linked to the Web Account Manager plugin the possible web page that will use the WebService structures and features Note To facilitate the installation, we used fake IP addresses that are used also in the chapter about the setup. TCPOS The WebAccountManager plugin (HTML5 version) - Installation Page 5/17

6 Part 1: Implementation Plugin modules Plugin installation TCPOS The WebAccountManager plugin (HTML5 version) - Installation Page 6/17

7 Plugin modules The plugin is composed by: an Admin dll and a dictionary (Plugin.WebAccountManager.Admin.dll, Plugin.WebAccountManager.Admin.dic) a FrontEnd dll and a dictionary (Plugin.WebAccountManager.FrontEnd.dll, Plugin.WebAccountManager.FrontEnd.dic) a DroidPos dll and a dictionary (Plugin.WebAccountManager.DroidPos.dll, Plugin.WebAccountManager.FrontEnd.dic) a file SQL that creates the tables used by the plugin (for Oracle, SQL Server and Postgres: AccountManagerDB-Oracle.sql, AccountManagerDB-Postgres.sql, AccountManagerDB-SqlServer.sql) a service that publishes the methods reachable from the website dir WebPages Dispatcher.WebAccountServer.dic Dispatcher.WebAccountServer.dll Example.TCPOS.JsonHttpServer.exe.config TCPOS.Compression.dll TCPOS.DbHelper.dll TCPOS.Debug.dll TCPOS.FrontEnd.DataClasses.dll TCPOS.FrontEnd.Server.dll TCPOS.FrontEnd.UserInterface.Interfaces.dll TCPOS.JsonHttpServer.exe TCPOS.RemotingHelper.dll TCPOS.Translation.dll TCPOS.Utilities.dll TCPOS.WCFHelper.dll Through the WebService it will be possible to integrate the web page developed by the customer, that will allow the automatic insertion of the order by the customers. dir WebPages\public_html Plugin installation Note The plugin installation follows the rules of the plugins standard installation. Database tables The Database tables are installed by running the script AccountManagerDB-Oracle.sql or AccountManagerDB-SqlServer.sql or AccountManagerDB-Postgres.sql according to the database type. Admin plugin installation Copy the files Plugin.WebAccountManager.Admin.dll and Plugin.WebAccountManager.Admin.dic in the same directory.\plugins where the Admin executables. The directory is usually C:\TCPOS.net\Admin\Executables\4.x.x.x\Plugins. If not available, you have to create it. FrontEnd plugin installation Copy the files Plugin.WebAccountManager.FrontEnd.dll and Plugin.WebAccountManager.FrontEnd.dll in the same directory.\plugins where the FrontEnd executables are already present. The directory is usually C:\TCPOS.net\FrontEnd\Executables\4.x.x.x\Plugins. If not available, you have to create it. TCPOS The WebAccountManager plugin (HTML5 version) - Installation Page 7/17

8 HttpServer plugin installation and customer s web page installation and configuration The installation workflow of this part is described in the chapter aside The WebAccountManagerService installation DroidPos DroidPos plugin installation Copy the files Plugin.WebAccountManager.DroidPos.dll, Plugin.WebAccountManager.FrontEnd.dic in the same directory.\plugins where the DroidPos executables are already available. The directory is usually..\tcpos.net\droidpos\executables\4.x.x.x\plugins. If not available, you have to create it. TCPOS The WebAccountManager plugin (HTML5 version) - Installation Page 8/17

9 Scheme of the web server directory structure inside TCPOS In this manual, examples refer only to the WebAccountManager plugin, but in the same installation there may be other web applicatons. The new structure of TCPOS web applications allows grouping them all in a single Web Service directory, simplifying also the management of certificates for firewalls. Therefore, instead of installing a webservice for each web application and activating services on separate ports, the management through the same listener is possible. Important Check the compatibility of the plugin setup procedure (parameters of TCPOS.JsonHttpServer.exe.config) before to grouping them on the same WebService. Specific web service: separate web service for each web application The final structure of the directory will be the following: A service that publishes the methods reachable from the website The subdirectory aside includes the service plugin dll. The subdirectory aside includes the html5 programs of the web pages. TCPOS The WebAccountManager plugin (HTML5 version) - Installation Page 9/17

10 Note To simplify the activation of the web meal reservation plugin, the released package contains also files referring this functionality, not used by the Web account manager plugin. Grouped web service: one web service for all web application The final structure of the directory will be the following: A service that publishes the methods reachable from the website The subdirectory aside includes the service dll according to the plugin installed. As you install the plugins, they can be added to this directory. The subdirectory aside includes the html5 programs of the web pages and they can be collected all together. TCPOS The WebAccountManager plugin (HTML5 version) - Installation Page 10/17

11 TCPOS The WebAccountManager plugin (HTML5 version) - Installation Page 11/17

12 The WebAccountManagerService installation This section describes the steps to follow so that you can implement the web service on the server (the possible page will work together with this service). 1 Create a directory, typically C:\TCPOS.net\WebAccountManagerService 2 And copy in it the related files. dir WebPages Dispatcher.WebAccountServer.dic Dispatcher.WebAccountServer.dll Example.TCPOS.JsonHttpServer.exe.config TCPOS.Compression.dll TCPOS.DbHelper.dll TCPOS.Debug.dll TCPOS.FrontEnd.DataClasses.dll TCPOS.FrontEnd.Server.dll TCPOS.FrontEnd.UserInterface.Interfaces.dll TCPOS.JsonHttpServer.exe TCPOS.RemotingHelper.dll TCPOS.Translation.dll TCPOS.Utilities.dll TCPOS.WCFHelper.dll 3 Create a subdirectory Dispatchers and move in it the following files: Dispatcher.WebAccountServer.dic Dispatcher.WebAccountServer.dll dir Dispatchers 4 Copy in the root C:\TCPOS.net\WebAccountManagerService the same file stored in the ServerService directory. In this way, the service is independent from the one of the ServerService 5 Rename the Example.TCPOS.JsonHttpServer.exe.config file in TCPOS.JsonHttpServer.exe.config. and configure it following the instructions described in the chapter aside 6 Rename the web-account-parameters.json_example file in web-account-parameters.json. and set it following the instructions described in the chapter aside. 7 Now start the webservice as administrator in order to test if it works DbAliases.ini The TCPOS.JsonHttpServer.exe.config configuration file The web-account-parameters.json configuration file TCPOS.JsonHttpServer.exe Then, access the webpage via browser (in the example aside the test is made on localhost, but the address must be the one of the machine where the webservice works) 8 Install finally the webservice WebService installation and activation TCPOS The WebAccountManager plugin (HTML5 version) - Installation Page 12/17

13 The TCPOS.JsonHttpServer.exe.config configuration file The configuration file TCPOS.JsonHttpServer.exe.config contains the information for the correct startup of the TCPOS.JsonHttpServer. Except for the parameters specifically described, all the other parameters can be left with their default values. Any other variation should be done with the supervision of the TCPOS 3 rd level team. File content This file contains the following main configuration nodes, the ones highlighted in grey are mandatory parameters to configure <configuration> header <appsettings> - service main parameters The <appsettings> main node configuration In this section the user defines on which port the service is listening Mandatory parameters to set In this section the following parameters have to be set, for all others, leave default settings. In our example: <add key="url" value=" <add key="index.html" value="web-account.html"/> <add key="dispatcher-directories" value=".\dispatchers" /> <add key="files-directory" value=".\webpages\public_html"/> <add key="db-alias" value="tcpos4learning513"/> TCPOS The WebAccountManager plugin (HTML5 version) - Installation Page 13/17

14 Parameters definition <add key="url" value=" = URL on which this TCPOS.JsonHttpServer instance will be listening for incoming connections on the format. Corresponds to the address entered in the browser to access the web pages. Example: without the lettering /tcposapps = recalling the web page, it is enough to insert the address and the web port with the lettering /tcposapps = recalling the web page, the browser redirects to a subpage. <add key="index.html" value="web-account.html"/> Entering this web address, the page is activated directly without writing the whole path <add key="dispatcher-directories" value="." /> = The path where to find the dispatchers assemblies, loaded at runtime <add key="files-directory" value=".\webpages\public_html"/> = The root of the web application files (web pages) in the local file system <add key="db-alias" value="tcpos"/> = DBalias for central db connection (local dbalias for direct connection or ServerService s dbalias in the format dbalias@servicehostip:servicehostport) <add key="_saferpay" value="accountid= , NotifyUrl= = <add key="_datatrans" value="merchantid= "/> Parameters to be configured with the provider address of the payment services like SaferPay and Datatrans. <add key="_payment-emulator" value="notifyurl= <add key="_payengine" value="pspid=tcpostestaccountjb,notifyurl= These parameters activate an emulator for a payment provider. The web-account-parameters.json configuration file After the file renaming, the.json parameters must be set for each web application. File content In this section the user defines on which port the service is listening Mandatory parameters to set In this section the following parameters have to be set. In our example: "webserverurl": " "defaultlanguage": "en" TCPOS The WebAccountManager plugin (HTML5 version) - Installation Page 14/17

15 Check of the webservice port Standard configuration of http procol indicates that service uses a specific port, in our example is used the To check if the port is already used through the telnet command; if it is the case, change the number of both parameters. The message visible in the following mask indicates that the port is unused. WebService installation and activation 1 Indicate the correct path of the TCPOS.JsonHttpServer.exe file followed by the /install parameter. 2 If the installation process is correct, the related confirmation message is displayed 3 you can already verify if the application is ready by interrogating the Services and files created automatically by the installation can be seen by interrogating the related directory Dir /Traces TCPOS The WebAccountManager plugin (HTML5 version) - Installation Page 15/17

16 The customer s web page definition and configuration Important In order to communicate with the web service, an http REST communication type is used, with POST messages. The demo pages supplied with the plugin do not require additional parameter settings. The WebAccountManagerService installation If necessary, it is possible to give information about the protocol to use and also to provide a web page used for tests/demos. Resolution of installation problems occurring when launching the web page If - when connecting to the web - the browser doesn t display the initial page, it means that an error has occurred. If in place of the initial page it is displayed an error message, it is possible to control the traces on the server to better focus on the problem. D:\tcpos\WebAccountManagerService\Traces\ The following pages explain some of the most common errors that may happen during the installation. Case 1: The TCPOS.WebAccountManager service was not active Problem The connection with the initial web page is activated, the message aside is displayed at its place. Message from web page says: Error NetworkError: Failed to execute send on XMLHttpRequest : Failed to load OK Solution In this case, the first thing to do is to check that the TCPOS web service is active. TCPOS.JsonHttpServer.exe Case 2: Oracle was not active Problem The connection with the initial web page is activated, the message aside is displayed at its place Message from web page Error DBError on TCPOS server. Please try again later Solution In this case, the first thing to do is to check that the Oracle services are active. TCPOS The WebAccountManager plugin (HTML5 version) - Installation Page 16/17

17 Case 3 : Services are correctly activated but the initial page is not displayed Problem The connection with the initial web page is activated, but the message aside is displayed at its place. From a first check, both Oracle that the service are active. Solution It is possible to analyze the content of the TCPOS.Trace file, to see if there is any further information. Message from web page says: Request failed: Error 404-Not found. OK Case 4 : Error when communicating with the server Problem The connection with the initial web page is activated, but the message aside is displayed at its place. Solution During the tests, the firewall prevented the access to the Database. Message from web page Communication error with server TCPOS The WebAccountManager plugin (HTML5 version) - Installation Page 17/17