Professional Documents
Culture Documents
Installation Guide
Version: 6
July 2013
iVend Retail
Installation Guide
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 ............................................................................................. 14
Purpose ............................................................................................................................ 14
Procedure......................................................................................................................... 14
iVend Retail Configuration ............................................................................................ 24
iVend Enterprise Master Data Backup ............................................................................ 26
iVend New Store Initialization (Restore) ...................................................................... 28
iVend SBO Integration Service Configuration ................................................................ 29
Replication Service Configuration At iVend Enterprise ............................................... 32
Replication Service Configuration At Retail Store ....................................................... 35
Connection Manager ....................................................................................................... 37
Integration Monitor ......................................................................................................... 39
Integration Failure Log .................................................................................................... 40
Replication Monitor ......................................................................................................... 41
iVend Mobile Installation and Setup ............................................................................. 42
Registering the iVend add-on.......................................................................................... 44
SAP Business One Add-On Installation Procedure ........................................................ 45
Registering the iVend add-on.......................................................................................... 45
Removing the iVend add-on............................................................................................ 46
New Menu Items in SAP Business One ............................................................................ 48
Database Mirroring For High Availability ...................................................................... 49
Prerequisites .................................................................................................................... 49
Servers ...................................................................................................................... 49
Page 2 of 58
iVend Retail
Installation Guide
Page 3 of 58
iVend Retail
Installation Guide
Icons
Icon
Meaning
Caution
Example
Note
Recommendation
Syntax
Typographic Conventions
Type Style
Description
Example text
Example text
EXAMPLE TEXT
Example text
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.
EXAMPLE TEXT
Example text
Exact user entry. These are words or characters that you enter in
the system exactly as they appear in the documentation.
<Example text>
Page 4 of 58
iVend Retail
Installation Guide
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.
Installation Preparations
Before installing add-ons with SAP Business One Add-On Administration, you should:
Check all hardware and software requirements as per the list given in Hardware
Software Specifications Guide
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
iVend Retail
Installation Guide
Point of Sale
Each register has a point of sale client installed through which all forms of
sales transactions are conducted.
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 APIs enables users to synchronize data between iVend Mobile and iVend Enterprise
and also enables you to integrate iVend with third party applications or ERPs.
Page 6 of 58
iVend Retail
Installation Guide
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.
Page 7 of 58
iVend Retail
Installation Guide
4. In the License Agreement screen, after reading the EULA and then accepting the
License Agreement, click on Next button.
Page 8 of 58
iVend Retail
Installation Guide
5. In the Customer Information window, enter your user name and company name and
choose the Next button.
6. In the Destination Folder window, select Change button to change the installation
location and then choose the Next button.
Page 9 of 58
iVend Retail
Installation Guide
7. In Installation Mode Selection window, choose the Single Machine Installation button.
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.
Page 10 of 58
iVend Retail
Installation Guide
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
Page 11 of 58
iVend Retail
Installation Guide
11. Installer will run the installation process and would copy the files and database scripts.
Page 12 of 58
iVend Retail
Installation Guide
12. In the following window, choose the Finish button to complete the installation.
Page 13 of 58
iVend Retail
Installation Guide
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.
Page 14 of 58
iVend Retail
Installation Guide
4. In the License Agreement screen, after reading the EULA and then accepting the
License Agreement, click on Next button.
Page 15 of 58
iVend Retail
Installation Guide
5. In the Customer Information window, enter your user name and company name and
choose the Next button.
6. In the Destination Folder window, select Change button to change the installation
location and then choose the Next button.
Page 16 of 58
iVend Retail
Installation Guide
8. In the Installation Option screen, select one of the options based on the following
Page 17 of 58
iVend Retail
Installation Guide
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.
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
iVend Retail
Installation Guide
Custom Installation: Select this option if you want to install both iVend server and
client components on the current machine.
Page 19 of 58
iVend Retail
Installation Guide
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
Page 20 of 58
iVend Retail
Installation Guide
11. Installer will run the installation process and would copy the files and database scripts.
Page 21 of 58
iVend Retail
Installation Guide
12. In the following window, choose the Finish button to complete the installation.
Page 22 of 58
iVend Retail
Installation Guide
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
iVend Retail
Installation Guide
The
icon is displayed in system tray. The user can right click on icon and select
any of the following menu items.
Configure Service
o
Replication Service Only available at iVend Store Server and iVend Enterprise Server
Upgrade Progress
Replication Monitor Only available at iVend Store Server and iVend Enterprise Server
Page 24 of 58
iVend Retail
Installation Guide
Replication Monitor Mobile : Only available at iVend Store Server and iVend Enterprise
Server
Page 25 of 58
iVend Retail
Installation Guide
Page 26 of 58
iVend Retail
Field
Installation Guide
Description/Activity
Database Name
User Id
Password
Site Id
Site Id of the store for which the backup file needs to be generated.
Buttons
Connect
Fill the required information and click connect button. Select the store
for which the backup needs to be generated.
Backup
OK
Cancel
Page 27 of 58
iVend Retail
Installation Guide
Field
Description/Activity
Connection Properties
Server Name
Database Name
User Id
Password
Backup File
Browse and select the Backup file that was generated at iVend
enterprise for this site id.
Buttons
Connect
Restore
OK
Cancel
Page 28 of 58
iVend Retail
Installation Guide
Field
Description/Activity
Sepecify the SQL Server name/IP of the SQL Server of SAP Business
One Database.
Database
Name
DB User Id
Enter the SQL DB UserId for the SAP Business One Database.
DB Password
User Id
Enter the integration User Id. Select one from B1i or CXSRetail. The
user selected here must be a superuser in SAP Business One.
Password
Enter the password setup in SAP Business one for the selected user.
Page 29 of 58
iVend Retail
Installation Guide
Field
Description/Activity
iVend Enterprise
Server Name
Database
Name
User Id
Password
Failover
Server
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
iVend Retail
Installation Guide
Page 31 of 58
iVend Retail
Field
Installation Guide
Description/Activity
Integration
Server Name
Database
Name
User Id
Password
Auto Retry
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.
Auto Retry
Interval(Minu
tes)
Specify the time interval in which the service will try posting the failed
records. Ideally this should be setup as more than 15 minutes.
Buttons
Start
After filling the required fileds and updating the settings, press this button to
start the services.
Stop
Update
After filling the required filed, click on update to update the changed
settings.
Cancel
Page 32 of 58
iVend Retail
Installation Guide
Page 33 of 58
iVend Retail
Field
Installation Guide
Description/Activity
Enterprise Settings
Server Name
Database
Name
User Id
Password
Failover
Enter the SQL Server Name if the mirror server is configured for the
Server
server defined in Server Name field. For more information see setting
up mirror server
Buttons
Start
After filling the required fileds and updating the settings, press this
button to start the services.
Stop
Update
After filling the required filed, click on update to update the changed
settings.
Cancel
Page 34 of 58
iVend Retail
Installation Guide
Field
Description/Activity
Enterprise Settings
Server Name
Sepecify the SQL Server name/IP of the SQL Server of iVend Enterprise
Database.
Database
Name
User Id
Password
Page 35 of 58
iVend Retail
Installation Guide
Field
Description/Activity
Local Settings
Server Name
Sepecify the SQL Server name/IP of the SQL Server of iVend Store
Database.
Database
Name
User Id
Password
Site Id
Buttons
Start
After filling the required fileds and updating the settings, press this
button to start the services.
Stop
Update
After filling the required filed, click on update to update the changed
settings.
Cancel
Page 36 of 58
iVend Retail
Installation Guide
Connection Manager
Connection manager need to be configured on the systems on which any of the following
components are installed
Field
Description/Activity
Database Name
User Id
Password
Failover Server
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
Network Information
Server Name
Display the name of the server. This can be used in iVend Mobile
configuration to connect to iVend Server.
Page 37 of 58
iVend Retail
Server IP Address
Installation Guide
Page 38 of 58
iVend Retail
Installation Guide
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
iVend Retail
Installation Guide
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
iVend Retail
Installation Guide
Replication Monitor
Through this screen the users can view the status of replication to store or enterprise server.
Page 41 of 58
iVend Retail
Installation Guide
Page 42 of 58
iVend Retail
Installation Guide
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.
Page 43 of 58
iVend Retail
Installation Guide
Page 44 of 58
iVend Retail
Installation Guide
Action
Result
p
1.
2.
3.
4.
5.
6.
7.
8.
9.
10.
Page 45 of 58
iVend Retail
Installation Guide
11.
12.
13.
automatically.
Check the option Ask for restart on the The
add-on
installation
will
installer window and click the Install add-on commence and on completion a
button.
success message box will be
displayed.
Click the OK button on the success message A SAP Business One system
box
message will be displayed informing
the user that SAP Business One will
close after add-on installation.
Click the OK button on the system message The SAP Business One application
closes.
2.
3.
4.
5.
Action
Result
The Add-On
appears.
Administration
window
Page 46 of 58
iVend Retail
Installation Guide
Page 47 of 58
iVend Retail
Installation Guide
Page 48 of 58
iVend Retail
Installation Guide
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.
Page 49 of 58
iVend Retail
Installation Guide
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
iVend Retail
Installation Guide
Page 51 of 58
iVend Retail
Installation Guide
Page 52 of 58
iVend Retail
Installation Guide
Page 53 of 58
iVend Retail
Installation Guide
3. Select the Yes option to include the Witness Server and then click on Next
button.
Page 54 of 58
iVend Retail
Installation Guide
Page 55 of 58
iVend Retail
Installation Guide
7. Leave the service accounts as blank and then click on Finish button.
8. System will configure the endpoints for mirroring. Click Close button to proceed.
Page 56 of 58
iVend Retail
Installation Guide
10. Verify the message shown in the Status to confirm that the mirroring has started.
Page 57 of 58
iVend Retail
Installation Guide
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.
Page 58 of 58