Installation and upgrade guide 1/10

Installation and upgrade guide

The following document describes the system requirements of the B1 Usability Package and how to
Install, upgrade or uninstall the add-on.

Table of content
System Requirements................................................................................................................................................ 2
Software requirements ......................................................................................................................................... 2
Windows permissions requirements ................................................................................................................. 2
Hardware Requirements ....................................................................................................................................... 2
Server................................................................................................................................................................. 2
Clients ................................................................................................................................................................ 2
Installing the B1 Usability Package ............................................................................................................................ 3
GUI vs. Silent installer ............................................................................................................................................ 3
32 bit vs. 64 bit installed........................................................................................................................................ 3
How to install......................................................................................................................................................... 4
Upgrading the B1 Usability Package to a new version .............................................................................................. 6
Uninstalling the B1 Usability Package ....................................................................................................................... 6
Appendix 1: User-cache and how to optionally override its location. ...................................................................... 7
Appendix 2: Details on what happens during an installation .................................................................................... 9
Step 1: Registration of add-on (only happens once per SAP installation)............................................................. 9
Step 2: Install of the add-on into the B1 Client ..................................................................................................... 9
Appendix 3: Troubleshooting a silent install ........................................................................................................... 10

Copyright 2016 – Boyum IT A/S

Installation and upgrade guide 2/10

System Requirements

Software requirements
Current version of the B1 Usability Package is written for the SBO 9.1 (PL06 or higher) and SAP 9.2 for MSSQL
and SAP HANA. For support on previous or future versions of SAP Business One please consult the www.boyum-
it.com website1.

The supported databases for running SAP Business One are:

- Microsoft SQL Server 2008, 2008 R2, 2012 or 2014
- SAP HANA
Client running the add-on should meet the following requirements:
- Microsoft Windows Vista, 7, 8, 10 or Windows Server 2008/2012
- Microsoft .Net Framework 4.0 or later2 (The framework can be downloaded at
http://www.microsoft.com/downloads)
- Adobe Acrobat Reader 9.0 or higher
- Microsoft Office Outlook 2007, 2010, 2013 or 2016 (If you plan to use B1 Print and Delivery)
- Microsoft Office Word 2007, 2010, 2013 or 2016 (If you plan to use the Letter Merge functionality)
- Crystal Report 2011 (13.x) Runtime Environment (If you plan to use the Crystal Report functionality)
o Also required on server if B1 Print and Delivery server component is used.

Windows permissions requirements

GUI Installer Silent Installer
How to install During installation the install need Installed by SBO Client Agent
Administrator rights (Right-click > (Automatic Admin rights)
Run as Administrator on the SAP
Business One executable).
The add-ons need to have full access to the following directories (All need read, write, and modify).
- The Windows Temp-folder (%temp%)
- The appdata folder (%appdata%\Boyum IT\) and all sub-folders
- Also during an installation the RegEdit will place a new entry in HKEY_LOCAL_MACHINE > SOFTWARE >
SAP, so permissions should be set to be able to create these entries.

NB: FURTHERMORE YOU WILL NEED AN ACTIVE LICENSE FOR THE B1 USABILITY PACKAGE (SEE THE B1UP LICENSE
GUIDE FOR MORE INFORMATION)

Hardware Requirements
Server
B1 Usability Package has an optional Server Component. For details please see the Server component Installation
Guide.

Clients
Component Requirement

1
If you install this version on a SAP below SBO9.1 PL06, might still work but do to a bug from SAP (www.boyum-
it.com/Link/BinaryInstallError) many people have trouble installing the add-on. In such a scenario you need to meet the
install requirements.

Copyright 2016 – Boyum IT A/S

Installation and upgrade guide 3/10

Processor Intel Pentium 4 or higher (Multi-core machines are recommended)

Memory 4 GB or higher
Free Hard Disk 400 MB
Display 1024 x 768 with 24-bit colors or higher
NB: RUNNING B1 USABILITY PACKAGE ON A TERMINAL SERVER OR CITRIX ENVIRONMENT REQUIRES A MINIMUM OF 6GB OF
MEMORY. IF OVER 5 USERS, 8 GB OR MORE IS RECOMMENDED.

Installing the B1 Usability Package

Online video version of this section is also available. Click here to watch it

Install follows the normal install procedure as described in the SAP Business One documentation.

GUI vs. Silent installer

This installer support both the Silent install system and the old legacy GUI based install.

The add-on will for install contain 3 files3. The Installer.exe and 2 Installer.ard files that determined if you will do
a silent install or not.

Ard file selected Installer used Run SBO as administrator required

Installer.ard Silent installer No
Installer (With install path selection).ard GUI Installer Yes

NB: IF YOU RUN WINDOWS VISTA, WINDOWS 7 OR WINDOWS SERVER 2008 AND USE THE GUI INSTALLER YOU SHOULD RUN SAP
BUSINESS ONE AS ADMINISTRATOR (ADMINISTRATOR RIGHTS ARE REQUIRED DURING INSTALLATION OF ADD-ONS). IF THIS IS NOT
DONE YOU COULD END UP WITH A CORRUPT INSTALLATION!

NB: SELECTION OF SILENT VS. GUI INSTALL AFFECT ALL CLIENTS (IT CANNOT BE DEFINED PER CLIENT SO IF YOU HAVE MULTIPLE
MACHINES AND THE ADD-ON NEED TO BE INSTALLED IF DIFFERENT FOLDERS ON DIFFERENT THE DIFFERENT MACHINES IT YOU WILL
NEED TO USE THE GUI INSTALLER)

Boyum IT A/S recommends using the silent installer

32 bit vs. 64 bit installed

In SAP Business One 9.0/9.1 both a 32 bit client and a 64 bit client is possible to install on the same system.
B1UP support both configurations (2 different installers) and can be installed on both clients on the same
system.

3
The file “InstallParams.zip” are also required to be present while installing (Part of the installer configurations).

Copyright 2016 – Boyum IT A/S

Installation and upgrade guide 4/10

How to install
To install the add-on, please log on to SAP Business One as manager or super user and navigate to
"Administration > Add-Ons > Add-On Administration" and press the "Register Add-on".

Press the buttons on the right to choose the .ard and .exe. Tick off if the Add-on should be assigned to the
currently logged into, and choose if you want to install as part of the registration (Checkbox).

Copyright 2016 – Boyum IT A/S

Installation and upgrade guide 5/10

GUI Install Silent Install

NB: REMEMBER TO RUN SAP BUSINESS ONE WITH THE RUN AS Install happens 100% automatically without additional
ADMINISTRATOR OPTION WHEN USING THE GUI INSTALLER actions or permissions required. The installation will install
the product to the following path:
When the GUI install is initiated, you will be prompted
where to install the add-on. “C:\Program Files (x86)\SAP\SAP Business
One\Addons\BOY\B1 Usability Package”4

Choose the folder you want to install into and press the
Install button

When you first run the add-on, it will begin creating the tables and fields (only happens when the first user
installs the add-on). After creation of tables, fields and default data, the add-on will prompt for another restart.
This is required in order for SAP Business One to register the new data created. (Again this is only needed for the
first installation).

Please note that creating metadata takes quite some time, especially on smaller systems.

4
For 9.0/9.1 64bit systems the path is “C:\Program Files\SAP\SAP Business One\Addons\BOY\B1 Usability Package”. The
“Program Files” path of the path is OS language specific and the installer understands this.

Copyright 2016 – Boyum IT A/S

Installation and upgrade guide 6/10

Upgrading the B1 Usability Package to a new version

NB: IF YOU RUN WINDOWS VISTA, WINDOWS 7 OR WINDOWS SERVER 2008 AND USE THE GUI INSTALL YOU SHOULD RUN SAP
BUSINESS ONE AS ADMINISTRATOR (ADMINISTRATOR RIGHTS ARE REQUIRED DURING UPGRADE OF ADD-ONS). IF THIS IS NOT DONE
YOU COULD END UP WITH A CORRUPT INSTALLATION!

To upgrade a previous version of the B1 Usability Package to a later version, all you need to do is consider the
upgrade as a normal installation. During an upgrade, SAP Business One will automatically uninstall the previous
version of B1UP and then install the new version

If you for some reason wish to install a previous version than the one installed, you will need to uninstall current
version before you install the previous version.

Uninstalling the B1 Usability Package

NB: IF YOU RUN WINDOWS VISTA, WINDOWS 7 OR WINDOWS SERVER 2008 AND USE THE GUI INSTALL YOU SHOULD RUN SAP
BUSINESS ONE AS ADMINISTRATOR (ADMINISTRATOR RIGHTS ARE REQUIRED DURING UNINSTALL OF ADD-ONS). IF THIS IS NOT DONE
YOU COULD END UP WITH A CORRUPT INSTALLATION!

Uninstall follows the normal uninstall procedure as described in the SAP Business One documentation.

Go to Administration > Add-Ons > Add-on Administration

Select the B1 Usability Package on the right hand side so it is highlighted and press the button to unassign
the add-on from the company.

Copyright 2016 – Boyum IT A/S

Installation and upgrade guide 7/10

Next, select B1 Usability Package on the left hand side and press the “Remove Add-on” button, and finally the
Update button.

Restart SAP Business One to begin the uninstallment.

NB. DURING UNINSTALL, NO DATA IN THE DATABASE WILL BE REMOVED. CONSULT THE TECHNICAL DATA DOCUMENT TO GET
INFORMATION ABOUT WHICH DATA WAS CREATED BY THE ADD-ON.

Appendix 1: User-cache and how to optionally override its location.

During normal execution of B1UP users will generate various cached data (XML cache, Eventlogs etc.) These
data are normally stored in “%AppData%\Boyum IT\BOY_USABILITY”5
(C:\Users\<username>\AppData\Roaming\Boyum IT\BOY_USABILITY).

Should you for some reason not be able/wish to use this folder as user-cache folder, you have the option to, on
machine level, change the location.

- Stop add-on
- Navigate to B1UP install folder (Normally C:\Program Files (x86)\SAP\SAP Business One\Addons\BOY\B1
Usability Package)
- Create a file called “OVERRIDE_USERFOLDER_LOCATION.txt”
- Inside the file enter the path to the location you wish to store the data
o Example: “C:\MyCachedData”
o You have the option to use the following keyword for specialfolders
<COMMONAPPLICATIONDATA> The directory that serves as a common repository for application-
specific data that is used by all users.
<COMMONPROGRAMFILES> The directory for components that are shared across applications.
<LOCALAPPLICATIONDATA> The directory that serves as a common repository for application-

5
For 64 bit version the folder is called BOY_USABILIY_X64

Copyright 2016 – Boyum IT A/S

Installation and upgrade guide 8/10

specific data that is used by the current, non-roaming user.

<MYDOCUMENTS> The My Documents folder.
<PERSONAL> The directory that serves as a common repository for documents.
This member is equivalent to MyDocuments.
<PROGRAMFILES> The program files directory.
<PROGRAMS> The directory that contains the user's program groups.
<APPLICATIONDATA> (Default) The directory that serves as a common repository for application-
specific data for the current roaming user.
A roaming user works on more than one computer on a network.
A roaming user's profile is kept on a server on the network and is
loaded onto a system when the user logs on.
<TEMPLATES> The directory that serves as a common repository for document
templates.
<STARTUP> The directory that corresponds to the user's Startup program
group.
<TEMP> The users Temp folder.
- Save the file
- The next time you start the add-on this indicated folder is the user-cache folder.

Copyright 2016 – Boyum IT A/S

Installation and upgrade guide 9/10

Appendix 2: Details on what happens during an installation

The following describes in details how what steps happen when you install an add-on. This information is for
people interested in the inner workings on what happen when you install and is not mandatory reading.

Install of an add-on happens in 2 steps

Step 1: Registration of add-on (only happens once per SAP installation)

a) 1a: User goes into any B1Client and register the add-on (Administrators > Add-on > Add-on registration
b) 1b: SAP upload the add-on information + the installer (in binary form) to the table SARI in the SBO-
COMMON database on the server
c) 1c: SAP mark add-on as assigned to the logged in company (record in the OARI table)
d) 1d: If user marked registration to install then SAP initiate the installation (Step 2)

* Registration is complete *

Step 2: Install of the add-on into the B1 Client

a) 2a: SAP identifies that user wish to have add-on available in logged in database (OARI table in SAP
database)
b) 2b: SAP Check local machine if add-on is already installed on current machine (check if record exist in
file AddonsLocalRegistration.sbo file located in the SAP installation on the machine
(Example: "C:\Program Files (x86)\SAP\SAP Business One\AddOnsLocalRegistration.sbo")
c) 2c: If not found as installed SAP download the installer.exe from SBO-COMMON.SARI table to the local
machines %temp% folder and initiate the install
d) 2d: Boyum begin to install (Via dialog to user (requires administrator rights) or silent install (done via the
SAP Business One client windows service and progress is written to C:\BoyumInstallLog.txt))
e) 2e: Boyum unpack the content of the installer to selected install path (default: C:\Program Files
(x86)\SAP\SAP Business One\AddOns\BOY\B1 Usability Package)
f) 2f: Boyum write entry to Windows registry database indicating where add-on was installed (so it can
later be uninstall if needed)
g) 2g: Boyum informs SAP that installation is complete
h) 2h: SAP Write entry to file AddonsLocalRegistration.sbo indicating it also accept add-on as installed

* Installation is complete *

Copyright 2016 – Boyum IT A/S

Installation and upgrade guide 10/10

Appendix 3: Troubleshooting a silent install

Should a silent install against expectation fail then you can get more information of what happened and what
went wrong in the C:\BoyumInstallerLog.txt file.

Copyright 2016 – Boyum IT A/S