ivend Retail Installation Guide Version: 6

Transcription

1 Version: 6 July 2013

2 Table of Contents Typographic Conventions... 4 Purpose... 5 Target Audience... 5 Hardware and Software Requirements... 5 Installation Preparations... 5 ivend Components... 5 Enterprise Server... 5 Store Server... 5 Point of Sale... 6 SAP Business One Integration Service... 6 Management Console... 6 ivend API... 6 Installing ivend Retail on Single Machine (Without SAP Business One Integration)... 7 Purpose... 7 Procedure... 7 Multi location Installation Purpose Procedure ivend Retail Configuration ivend Enterprise Master Data Backup ivend New Store Initialization (Restore) ivend SBO Integration Service Configuration Replication Service Configuration At ivend Enterprise Replication Service Configuration At Retail Store Connection Manager Integration Monitor Integration Failure Log Replication Monitor ivend Mobile Installation and Setup Registering the ivend add-on SAP Business One Add-On Installation Procedure Registering the ivend add-on Removing the ivend add-on New Menu Items in SAP Business One Database Mirroring For High Availability Prerequisites Servers Page 2 of 58

3 Change the Recovery Model of ivend database Set the same service accounts on all the servers involved in mirroring Backing up the Retail database and restoring it on Mirror Server Setting up database for mirroring Page 3 of 58

4 Icons Icon Meaning Caution Example Note Recommendation Syntax Typographic Conventions Type Style Example text Example text EXAMPLE TEXT Example text EXAMPLE TEXT Example text <Example text> Description Words or characters that appear on the screen. These include field names, screen titles, pushbuttons as well as menu names, paths and options. Cross-references to other documentation. Emphasized words or phrases in body text, titles of graphics and tables. Names of elements in the system. These include report names, program names, transaction codes, table names, and individual key words of a programming language, when surrounded by body text, for example, SELECT and INCLUDE. Screen output. This includes file and directory names and their paths, messages, source code, names of variables and parameters as well as names of installation, upgrade and database tools. Keys on the keyboard, for example, function keys (such as F2) or the ENTER key. Exact user entry. These are words or characters that you enter in the system exactly as they appear in the documentation. Variable user entry. Pointed brackets indicate that you replace these words and characters with appropriate entries. Page 4 of 58

5 Purpose This document describes how to install and configure ivend Retail in different scenarios. Target Audience This document is designed for end users or consultants. Hardware and Software Requirements Please refer Hardware & Software Specifications Guide for this. Installation Preparations Before installing add-ons with SAP Business One Add-On Administration, you should: Create a backup file of all your company s production databases. Check all hardware and software requirements as per the list given in Hardware Software Specifications Guide SQL Server 2008 and its services are up and running ivend Components There are five components that may be installed in an ivend implementation. Enterprise Server The Enterprise Server is where enterprise information is entered and where settings are made that affect all stores in the system. The Enterprise Server is where data from all stores is consolidated. Store Server The Store Server is where information is entered about each store and where settings are made affecting the behavior and limitations of each user and each Point of Sale register. Master record information is synchronized to and from the Enterprise Server at this server. This primarily install database for the store and the replication service on the machine. Page 5 of 58

6 Point of Sale Each register has a point of sale client installed through which all forms of sales transactions are conducted. SAP Business One Integration Service SAP Business One Integration Service provides the setting and means to communicate data to and from the Enterprise Server and to monitor that activity. Management Console Management console connects to either Enterprise Server or Store Server for proving the User Interface for the data store on these servers. Based on the database server it is connected to, from Management Console settings for the Enterprise or Store can be defined. Inventory transactions including inventory movement, pricing and discounts can be managed from this User Interface. ivend API ivend API s enables users to synchronize data between ivend Mobile and ivend Enterprise and also enables you to integrate ivend with third party applications or ERP s. Page 6 of 58

7 Installing ivend Retail on Single Machine (Without SAP Business One Integration) Purpose 1. This can be used for setting up the demo systems. 2. This can be used for installing the Single Store, Single POS production environment. 3. Installation includes Enterprise Server, Management Console, Point of Sale and ivend APIs. Procedure 1. Run setup.exe. This will launch the installation wizard. 2. Follow the instructions on the screen to complete the installation of ivend Retail. Figure 1 Setup Wizard Initialization Screen Page 7 of 58

8 3. In the following screen, choose the Next option.. Figure 2 Setup Wizard Welcome Screen 4. In the License Agreement screen, after reading the EULA and then accepting the License Agreement, click on Next button. Figure 3 Setup Wizard License Agreement Screen Page 8 of 58

9 5. In the Customer Information window, enter your user name and company name and choose the Next button. Figure 4 Company/User Information screen 6. In the Destination Folder window, select Change button to change the installation location and then choose the Next button. Figure 5 Destination Folder screen Page 9 of 58

10 7. In Installation Mode Selection window, choose the Single Machine Installation button. Figure 6 Installation Mode Selection Screen 8. In the Database Setup Selection screen, select the correct database option and then click on Next button. a. Create New Database: Select this option, if you are creating a production environment b. Use Existing Database: Select this option, if you already have an existing ivend database and would like to use the same for this installation. c. Create Demo Database: Select this option if you are setting up a demo machine. Figure 7 Database Setup Selection Screen Page 10 of 58

11 Note If installer does not find SQL Server installation on local machine then an option to install SQL Server 2008 R2 Express Edition is shown to the user. Note If installer does not find IIS Server installation on local machine then an option to install IIS Server is shown to the user. 9. In the Database Server window, enter the following information and choose the Next button. a. Database Server b. Login Id c. Password d. Database Name Figure 8 Database Server Screen 10. In the Ready to Install window, choose the Next button. Page 11 of 58

12 Figure 9 Install Screen 11. Installer will run the installation process and would copy the files and database scripts. Figure 10 Copying Files Page 12 of 58

13 Figure 11 Executing Database Scripts 12. In the following window, choose the Finish button to complete the installation. Figure 12 Installation Completion Screen Page 13 of 58

14 Multi location Installation Purpose 1. This option installs an instance of the ivend Retail Enterprise Server at the head office or a Store Server at the store. 2. This option installs an instance of the ivend Retail Enterprise Server at the head office with SAP Business One Integration Components. 3. Installing ivend Management Console and Point of Sale. Procedure 1. Run setup.exe. This will launch the installation wizard. 2. Follow the instructions on the screen to complete the installation of ivend Retail. Figure 13 Setup Wizard Initialization Screen Page 14 of 58

15 3. In the following screen, choose the Next option. Figure 14 Setup Wizard Welcome Screen 4. In the License Agreement screen, after reading the EULA and then accepting the License Agreement, click on Next button. Figure 15 Setup Wizard License Agreement Screen Page 15 of 58

16 5. In the Customer Information window, enter your user name and company name and choose the Next button. Figure 16 Company/User Information screen 6. In the Destination Folder window, select Change button to change the installation location and then choose the Next button. Figure 17 Destination Folder screen Page 16 of 58

17 7. In Installation Mode Selection window, choose the Choose an Installation option button. Figure 18 Installation Mode Selection Screen 8. In the Installation Option screen, select one of the options based on the following Figure 19 Installation option Screen Page 17 of 58

18 Server Installation: Select this option if you are installing ivend Enterprise or ivend Store on the current machine and do not want to install the client components like Management Console or ivend POS. This will also give an option to install ivend APIs along with the other server components. Select ivend APIs as component to install if you would like to connect ivend Mobile to your stores or enterprise server. Figure 20 Server Installation option Screen Client Installation: Select this option if you just want to install ivend Management Console or ivend POS on the current machine. Page 18 of 58

19 Figure 21 Client Installation option Screen Custom Installation: Select this option if you want to install both ivend server and client components on the current machine. Figure 22 Custom Installation option Screen Page 19 of 58

20 Note Please note that the Store Server and the SAP Business One Integration Service cannot be installed on the same machine. However the Enterprise server and SAP Business One Integration Service can be installed on the same server. 9. In the Database Server window, enter the following information and choose the Next button. a. Database Server b. Login Id c. Password d. Database Name Figure 23 Database Server Screen 10. In the Ready to Install window, choose the Next button. Page 20 of 58

21 Figure 24 Install Screen 11. Installer will run the installation process and would copy the files and database scripts. Figure 25 Copying Files Page 21 of 58

22 Figure 26 Executing Database Scripts 12. In the following window, choose the Finish button to complete the installation. Figure 27 Installation Completion Screen Page 22 of 58

23 After the successful installation, user has to configure the Point of Sale, the Management Console and SBO Integration Service credentials with help of ivend Configuration Manager. Please refer to the ivend Retail Configuration section. Page 23 of 58

24 ivend Retail Configuration After completing the installation of the ivend, click on Start ivend Retail ivend Configuration Manager. Figure 28 System Tray showing ivend Configuration Manager The icon is displayed in system tray. The user can right click on icon and select any of the following menu items. Figure 29 Integration Service o o o o o o o Database Backup (Available only for ivend Enterprise Server Installation) Database Restore (Available only for Store server) Configure Service o Replication Service Only available at ivend Store Server and ivend Enterprise Server o Integration Service Only available at ivend Enterprise Server Connection Manager - Only available at ivend Enterprise Server Upgrade Information - Only available at ivend Enterprise Server Upgrade Progress Replication Monitor Only available at ivend Store Server and ivend Enterprise Server Page 24 of 58

25 o o o Replication Monitor Mobile : Only available at ivend Store Server and ivend Enterprise Server Integration Monitor Only available at ivend Enterprise Server Integration Failure Log Only available at ivend Enterprise Server Page 25 of 58

26 ivend Enterprise Master Data Backup The Master Data Backup screen is available where the Enterprise Server is installed. The screen allows the user to generate a backup file of ivend master tables for a specific store. Enter the ivend Enterprise database credentials. Click Connect button. Select the store for which the backup file needs to be generated. Figure 30 Master Data backup at ivend Enterprise Page 26 of 58

27 Field Master Data Backup Server Name Database Name User Id Password Site Id Buttons Connect Backup OK Cancel Description/Activity Sepecify the SQL Server name/ip of the of ivend Enterprise Database. Enter the name of the ivend Enterprise Database. Enter the SQL DB UserId for the ivend Enterprise Database. Enter the DB Password for the ivend Enterprise Database. Site Id of the store for which the backup file needs to be generated. Fill the required information and click connect button. Select the store for which the backup needs to be generated. Click button to start backup of the database. Closes the form. Closes the form. Page 27 of 58

28 ivend New Store Initialization (Restore) This screen allows restoring the master data backup created at the enterprise. This backup can be used to create a new store by using the restore utility thus saving the time and effort required to initialize master data replication for each store. Figure 31 New Store Initialization (Restore) Field Connection Properties Server Name Database Name User Id Password Backup File Buttons Connect Restore OK Cancel Description/Activity Sepecify the SQL Server name/ip of the SQL Server of ivend Store Database. Enter the name of the ivend Store Database. Enter the SQL DB UserId for the ivend Store Database. Enter the DB Password for the ivend Store Database. Browse and select the Backup file that was generated at ivend enterprise for this site id. Fill the required information and click connect to connect to ivend store database. Click button to start restore of the database. Closes the form. Closes the form. Page 28 of 58

29 ivend SBO Integration Service Configuration The Integration Service needs to be configured and started. The SAP Business One Company, ivend Enterprise and Integration credentials need to be entered. Figure 32 SAP Business One Settings Information Field SAP Business One Server Name Database Name DB User Id DB Password User Id Password Description/Activity Sepecify the SQL Server name/ip of the SQL Server of SAP Business One Database. Enter the name of the SAP Business One Database. Enter the SQL DB UserId for the SAP Business One Database. Enter the DB Password for the SAP Business One Database. Enter the integration User Id. Select one from B1i or CXSRetail. The user selected here must be a superuser in SAP Business One. Enter the password setup in SAP Business one for the selected user. Page 29 of 58

30 Figure 33 ivend Enterprise Settings Information Field ivend Enterprise Server Name Database Name User Id Password Failover Server Description/Activity Sepecify the SQL Server name/ip of the SQL Server of ivend Enterprise Database. Enter the name of the ivend Enterprise Database. Enter the SQL DB UserId for the ivend Enterprise Database. Enter the DB Password for the ivend Enterprise Database. Enter the SQL Server Name if the mirror server is configured for the server defined in Server Name field. For more information see setting up mirror server Page 30 of 58

31 Figure 34 Integration Settings Information Page 31 of 58

32 Field Integration Server Name Database Name User Id Password Auto Retry Auto Retry Interval(Minu tes) Buttons Start Stop Update Cancel Description/Activity Specify the SQL Server name/ip of the SQL Server of CXSIntegration database. It is same as that of SAP Business One database server. This is disabled field and is defaulted to CXSIntegration. Enter the SQL DB UserId for the CXSIntegration Database. Enter the DB Password for the CXSIntegration Database. If this flag is checked then the integration service will autoretry positng the failed records to SAP Business One which were generated/updated in ivend. Specify the time interval in which the service will try posting the failed records. Ideally this should be setup as more than 15 minutes. After filling the required fileds and updating the settings, press this button to start the services. If the service is running, press this button to stop the service. After filling the required filed, click on update to update the changed settings. Click to close the form. Replication Service Configuration At ivend Enterprise The Enterprise Replication Windows Service needs to be configured and started. The ivend Enterprise database credentials need to be entered. Page 32 of 58

33 Figure 35 Replication Enterprise Settings Information Page 33 of 58

34 Field Enterprise Settings Description/Activity Server Name Database Name User Id Password Failover Server Sepecify the SQL Server name/ip of the SQL Server of ivend Enterprise Database. Enter the name of the ivend Enterprise Database. Enter the SQL UserId for the ivend Enterprise Database. Enter the password for the ivend Enterprise Database. Enter the SQL Server Name if the mirror server is configured for the server defined in Server Name field. For more information see setting up mirror server Buttons Start Stop Update Cancel After filling the required fileds and updating the settings, press this button to start the services. If the service is running, press this button to stop the service. After filling the required filed, click on update to update the changed settings. Click to close the form. Page 34 of 58

35 Replication Service Configuration At Retail Store The ivend Replication Store Windows Service needs to be configured at the store. The store database credentials have to be specified. In the Enterprise Settings, the Enterprise credentials have to be specified. Figure 36 Replication Enterprise Settings Information Field Enterprise Settings Server Name Database Name User Id Password Description/Activity Sepecify the SQL Server name/ip of the SQL Server of ivend Enterprise Database. Enter the name of the ivend Enterprise Database. Enter the SQL UserId for the ivend Enterprise Database. Enter the password for the ivend Enterprise Database. Page 35 of 58

36 Figure 37 Replication Local Settings Information Field Local Settings Server Name Database Name User Id Password Site Id Buttons Start Stop Update Cancel Description/Activity Sepecify the SQL Server name/ip of the SQL Server of ivend Store Database. Enter the name of the ivend Store Database. Enter the SQL UserId for the ivend Store Database. Enter the password for the ivend Store Database. Enter the Site Id for the store. After filling the required fileds and updating the settings, press this button to start the services. If the service is running, press this button to stop the service. After filling the required filed, click on update to update the changed settings. Click to close the form. Page 36 of 58

37 Connection Manager Connection manager need to be configured on the systems on which any of the following components are installed ivend Management Console ivend POS ivend APIs Figure 38 Connection Settings Information Field Description/Activity ivend APIs/POS / Management Console Connection Information Server Name Database Name User Id Password Failover Server Network Information Server Name Enter the SQL Server Name for ivend Enter the ivend Database Name Enter the User Id for the ivend Database Enter the password for the ivend Database Enter the SQL Server Name if the mirror server is configured for the server defined in Server Name field. For more information see setting up mirror server Display the name of the server. This can be used in ivend Mobile configuration to connect to ivend Server. Page 37 of 58

38 Server IP Address Display the IP Address of the server. This can be used in ivend Mobile configuration to connect to ivend Server. Page 38 of 58

39 Integration Monitor Figure 39 Integration Monitor From this screen, the user can view the status of the data integration between SAP Business One and ivend. The upper half of the screen shown the data that is updated in SAP Business One and is to be integrated with ivend whereas the bottom half of the screen will show the data that is modified in ivend and is then to be integrated to SAP Business One. Marking the option Do not display failed message will not show the records that have failed to integrate with SAP Business One. Page 39 of 58

40 Integration Failure Log Figure 40 Integration Failure Log Through this screen, the user can view only failed events while integration data between SBO to ivend and ivend to SBO. The screen also has the option check multiple failed events in grid and press Retry button. It will reinitiate selected events. User can also download the failed records in excel for further analysis for the cause of the failure. Use Show Complete Error Message option will show the user the complete error message that SAP Business One has thrown while posting the record in SAP Business One. Page 40 of 58

41 Replication Monitor Figure 41 Replication Monitor Through this screen the users can view the status of replication to store or enterprise server. Page 41 of 58

42 ivend Mobile Installation and Setup Install ivend POS (Mobile) from Apple App Store. 1. For the same search for ivend POS in Apple Store or 2. Use this link: 3. Run the ivend POS app in your mobile device. 4. Go to Setup option 5. Turn off the Demo Mode click Save button. 6. Lookup the ivend Connection Manager for your machine IP address. Page 42 of 58

43 7. Enter your machine IP address in the Server Address field and enter the POS API Token in the API token field (API tokens will be generated by the system when creating a new mobile POS from ivend Management Console). Ensure that you have connectivity between your ivend API server (machine on which ivend APIs are installed) and your mobile device. You must have port 8642 open in your firewall to allow communication between ivend Mobile POS and ivend Server. 8. Click on Initialize button. 9. Wait for the initialization process to complete successfully. 10. Click the back button to display the login view. 11. Login to ivend mobile POS using your user name and password setup in ivend. Page 43 of 58

44 Registering the ivend add-on The add-on installation procedure starts by registering the add-on with the SAP Business One server. This registration procedure triggers the upload of the add-on installation package to the SAP Business One server. To register the add-on, you must have super user authorization. To use SAP Business One Add-On Administration to register the add-on, follow this procedure: Page 44 of 58

45 SAP Business One Add-On Installation Procedure Registering the ivend add-on The add-on installation procedure starts by registering the add-on with the SAP Business One server. This registration procedure triggers the upload of the add-on installation package to the SAP Business One server. To register the add-on, you must have super user authorization. To use SAP Business One Add-On Administration to register the add-on, follow this procedure: Ste p Action 1. Open SAP Business One. Log on to a company with a user that has super user authorization. 2. On the SAP Business One main menu, choose Administration Add-Ons Add- Result The SAP Business One application opens for the company database. The Add-On Administration window appears. On Administration. 3. Choose Register Add-On The Add-On Registration window appears. 4. Browse for the path for the Add-On Registration Data file (*.ard file) and choose the ivend add-on file 5. Check if the displayed path for the Add-On Installation Package (*.exe) is correct. 6. Select the Assign to Current Company option, to assign the add-on to the current company after installation. This option is selected by default. 7. Choose OK In the Add-On Administration window, the name of the add-on appears in the list of Available Add- Ons. The add-on installation package has been uploaded to the SAP Business One server. The add-on is now available for all company databases on this server. 8. Choose OK on the Add-on Administration Add-on Administration window closes window. 9. Close the SAP Business One application. SAP Business One application closes 10. Open SAP Business One. Log on to a company with a user that has super user authorization. The SAP Business One application opens for the company database. The add-on installation will launch Page 45 of 58

46 11. Check the option Ask for restart on the installer window and click the Install add-on button. 12. Click the OK button on the success message box automatically. The add-on installation will commence and on completion a success message box will be displayed. A SAP Business One system message will be displayed informing the user that SAP Business One will close after add-on installation. 13. Click the OK button on the system message The SAP Business One application closes. Removing the ivend add-on The add-on cannot be removed from the server or a client manually using the Add/Remove Programs feature in Microsoft Windows. You must remove an add-on using SAP Business One Add-On Administration. When you use the add-on administration tool to remove an add-on, the add-on installation package is removed from the SAP Business One server. When a client with the installed add-on later connects to that server, the add-on is also removed from the client. The removal procedure with SAP Business One Add-On Administration is as follows: Step Action Result 1. Open SAP Business One where the add-on is installed. Log on with a user that has super user authorization. Log on to a company database with the add-on. 2. On the SAP Business One main menu, choose Administration Add-Ons Add-On Administration. 3. Select the Company Preferences tab. 4. If the add-on that you want to remove is assigned to the company, first un-assign it: To un-assign the add-on, select the add-on in the Company-Assigned The SAP Business One application opens for the company database. The Add-On Administration window appears. The add-ons installed on the client are displayed in the Available Add-Ons list. The add-ons assigned to the company are displayed in the Company-Assigned Add- Ons list. The add-on is removed from the list of Company-Assigned Add-Ons. Add-Ons list. Choose. 5. Select the add-on in the Available Add-Ons list. Choose Remove Addon. The add-on is removed from the list of Available Add-Ons. The system will automatically start the Page 46 of 58

47 removal procedure the next time you start the SAP Business One application from any client that is connected to the server. Page 47 of 58

48 New Menu Items in SAP Business One On successful installation of the add-on, the following additional menu items will be available on the SAP Business One standard menu. Figure 42 ivend Menu within SAP Business One On expanding the Administration System Initialization module in the main menu, a new folder ivend Retail can be seen as shown above. Page 48 of 58

49 Database Mirroring For High Availability Caution If your servers are not in domain and you are using workgroups then please contact CitiXsys for configuring the database mirroring for ivend. Prerequisites All the database servers should have the same version of SQL Server installations. Servers This setup would require the following 3 SQL Servers a. Principal Server: This is the server that has the principal CXSRetail database which is to be mirrored. b. Mirrored Server: This server would host the mirror copy of the principal database. c. Witness Server: This server helps in automatic switching of database in case of principal server failures. Change the Recovery Model of ivend database 1. Right click on the CXSRetail database and then select properties from the context menu. 2. In properties windows select the Options tab from the left menu as shown below. 3. Change the values of Recovery Model from current value of Simple to Full. 4. Click OK button to save the settings. Page 49 of 58

50 Figure 43 Database properties of ivend database (CXSRetail) Set the same service accounts on all the servers involved in mirroring Repeat the following steps on all of the SQL Servers d. Principal Server: This is the server that has the principal CXSRetail database which is to be mirrored. e. Mirrored Server: This server would host the mirror copy of the principal database. f. Witness Server: This server helps in automatic switching of database in case of principal server failures. 1. Open SQL Server Configuration Manager from program menu. 2. Under SQL Server Services tab, select the SQL Server services that are hosting the ivend database. 3. Right click the service and open the properties of the SQL Server. 4. Under Log On tab change the setting Log on as: from Built-in-accounts to this account as shown in the figure below. The format for this would be [Domain]\[Account] 5. Click on Apply button to save the credentials. 6. Restart the SQL SERVER service. Page 50 of 58

51 Figure 44 Set service account Backing up the Retail database and restoring it on Mirror Server 1. Take the Full backup of the ivend Retail database from the principal server. 2. Take the Transaction Log backup of ivend Retail database from the principal server. As shown below Page 51 of 58

52 Figure 45 Full database backup Figure 46 Transaction log backup 3. Restore the backup on the Mirror Server as shown below. a. Restored database name should be the same as that of the principal server s database name. b. The Recovery mode should be selected as (RESTORE WITH NORECOVERY). Figure 47 Restore Database Figure 48 Restore database options Page 52 of 58

53 Setting up database for mirroring 1. Right click on the principal server database which is to be mirrored. Figure 49 Principal database 2. Click on Configure Security button as shown below. Figure 50 Configure Security at Principal Page 53 of 58

54 3. Select the Yes option to include the Witness Server and then click on Next button. Figure 51 Select witness server 4. Select the principal server and then click on Next button. Figure 52 Select principal server Page 54 of 58

55 5. Select the Mirror Server and then click on Next button. Figure 53 Select mirror server 6. Select the Witness server and then click on Next button. Figure 54 Select witness server Page 55 of 58

56 7. Leave the service accounts as blank and then click on Finish button. Figure 52 Service accounts 8. System will configure the endpoints for mirroring. Click Close button to proceed. Figure 53 Configuring End points Page 56 of 58

57 9. Click on Start Mirroring button to complete the setup. Figure 54 Start Mirroring 10. Verify the message shown in the Status to confirm that the mirroring has started. Figure 55 Verify Mirroring Page 57 of 58

58 11. Refresh the status of the SQL SERVERS to verify that the principal database has status as Principal, Synchronized whereas the status of the mirrored database on Mirror Server is Mirror, Synchronized/Restoring. Figure 56 Mirroring in action Page 58 of 58