You are on page 1of 9

Version 6.

7
January 2004
English

SAP Business One SDK


6.7
Add-On Installation and Administration Draft

SAP AG
Neurottstr. 16
69190 Walldorf
Germany
SAP Business One SDK 6.7 Add-On Installation and Administration

Copyright

© Copyright 2004 SAP AG. All rights reserved.

No part of this publication may be reproduced or transmitted in any form or for any purpose without the express
permission of SAP AG. The information contained herein may be changed without prior notice.
Some software products marketed by SAP AG and its distributors contain proprietary software components of
other software vendors.

Microsoft, Windows, Outlook, and PowerPoint are registered trademarks of Microsoft Corporation.
IBM, DB2, DB2 Universal Database, OS/2, Parallel Sysplex, MVS/ESA, AIX, S/390, AS/400, OS/390, OS/400,
iSeries, pSeries, xSeries, zSeries, z/OS, AFP, Intelligent Miner, WebSphere, Netfinity, Tivoli, and Informix are
trademarks or registered trademarks of IBM Corporation in the United States and/or other countries.

Oracle is a registered trademark of Oracle Corporation.

UNIX, X/Open, OSF/1, and Motif are registered trademarks of the Open Group.

Citrix, ICA, Program Neighborhood, MetaFrame, WinFrame, VideoFrame, and MultiWin are trademarks or
registered trademarks of Citrix Systems, Inc.
HTML, XML, XHTML and W3C are trademarks or registered trademarks of W3C®, World Wide Web Consortium,
Massachusetts Institute of Technology.

Java is a registered trademark of Sun Microsystems, Inc.

JavaScript is a registered trademark of Sun Microsystems, Inc., used under license for technology invented and
implemented by Netscape.

MaxDB is a trademark of MySQL AB, Sweden.

WinFax® is a U.S. registered Trademark from Symantec Corporation.

SAP, R/3, mySAP, mySAP.com, xApps, xApp, and other SAP products and services mentioned herein as well as
their respective logos are trademarks or registered trademarks of SAP AG in Germany and in several other
countries all over the world. All other product and service names mentioned are the trademarks of their
respective companies. Data contained in this document serves informational purposes only. National product
specifications may vary.

These materials are subject to change without notice. These materials are provided by SAP AG and its affiliated
companies ("SAP Group") for informational purposes only, without representation or warranty of any kind, and
SAP Group shall not be liable for errors or omissions with respect to the materials. The only warranties for SAP
Group products and services are those that are set forth in the express warranty statements accompanying such
products and services, if any. Nothing herein should be construed as constituting an additional warranty.

SAP AG - Internal use only Page 2 of 9


SAP Business One SDK 6.7 Add-On Installation and Administration

Disclaimer
This document should be regarded as a guide only. The new and existing features
described in this document may be excluded from, or changed in, the released
product. In addition, the released product may include new or changed features not
described in this document.

Contents
Summary............................................................................................................................................... 4
Package and Installation....................................................................................................................... 5
Creating a Registration Data File...................................................................................................... 5
Creating a Setup Program................................................................................................................. 6
Creating Documentation.................................................................................................................... 6
Add-On Administration.......................................................................................................................... 7
Registration....................................................................................................................................... 7
Setting Company Preferences........................................................................................................... 8
Start-up behavior........................................................................................................................ 8
Force install................................................................................................................................ 8
Event-receiving order................................................................................................................. 8
Setting User Preferences.................................................................................................................. 8
Removing Add-On Programs............................................................................................................. 9

SAP AG - Internal use only Page 3 of 9


SAP Business One SDK 6.7 Add-On Installation and Administration

Summary
The following document introduces the add-on administration system and how to work with it in SAP
Business One SDK 6.7. In addition, the document summarizes changes in the setup and installation
of add-on in version 6.7.

SAP AG - Internal use only Page 4 of 9


SAP Business One SDK 6.7 Add-On Installation and Administration

Package and Installation


As a partner of SAP Business One, it is your responsibility to ensure that the add-on solution is
compatible with the SDK release and the SAP Business One release used at the customer site. In
addition, you are also responsible for upgrade consistency of your delivered add-on components.
Your partner package should include the following items:
 SAP Business One application – deployed to the customer via the usual distribution channel.
 Add-on solution – delivered on a separate CD and including the following items:
§ Add-on components
§ Registration data file – enabling you to register the add-on for start-up with the
SAP Business One application.
§ Setup program
§ Documentation – for both the installation procedure and the usage of the
components

Creating a Registration Data File


The registration data file enables you to register your add-on with the SAP Business One application.
This allows the application to identify your add-on and run it automatically when the application is
launched. In addition, after registration, you will be able to set add-on preferences for a company and
for specific users.

To generate your registration data file:


1. Run the AddOnRegDataGen.exe file, typically located at:
C:\Program Files\SAP Manage\SAP Business One SDK\UI API\Tools.

2. Enter your partner information: Name, Namespace, and Contact Data. This information is
mandatory to the creation of the registration data file.
3. Enter the add-on information:
 Name and Version – Mandatory. Name and version number of your add-on program.

SAP AG - Internal use only Page 5 of 9


SAP Business One SDK 6.7 Add-On Installation and Administration

The Add-On version could be only digits and ‘.’ dot mark.
 Add-On Exe Full Path – Mandatory. For security reasons, the registration data file contains a
digital signature for three executable files in your add-on solution. To calculate the digital
signature, you need to provide the location of the executable files.
 Mandatory/Automatic – Optional. Select the start-up behavior of the add-on. If none are
selected, the add-on will be executed manually.
4. Enter the data of the add-on installer:
 Installer/Uninstaller Exe Full Path – Optional. For security reasons, the registration data file
contains a digital signature for each executable file in your add-on solution. To calculate the
digital signature, you need to provide the location of the executable files.
 Estimated Install Time – Mandatory. Enter a time estimate to complete the installation. Valid
range: 1 to 3,600 seconds.
 Installer/Uninstaller Command Line Arguments – Optional. Depending on the installation
software you are using, enter the appropriate arguments for your setup program. These
arguments are needed to allow correct work with the installer program.
The automatical installation feature in Add-On Management will execute the add-on installer
automatically when needed and will pass by command line the recommended install path for
the specific add-on.
5. Choose Generate File to create the registration data file. You can choose View File to view the
generated file.
The generated file should be supplied with the add-on install package to the customer for further
registration in the database.

Creating a Setup Program


Build a setup program for the installation and removal of the add-on components. The setup program
must include the SBOAddonReg.dll and extract it during the installation.
The SBOAddonReg.dll contains three functions to support the installation process:
 RestartNeeded() – call this function, if the setup program restarts the computer. Make
sure to call the EndInsatll() function only once (the installer program may restart the
computer several times) before the SAP Business One application is launched again. The
function returns 0 for success, 1 for error.
 SetAddOnFolder(path) – call this function and specify an installation path, only if you
modified the installation path specified in the registration data file by default. The function
returns 0 for success, 1 for error.
 EndInsatll() – your installation program must call this function at the end of the
installation process. If you fail to call this function within the designated time set in the
registration data file, The SAP Business One application marks the add-on as failed to install
and will not try to install it again. To force the application to reinstall the add-on, check the
Force Install option in the Add-On Administration. The function returns 0 for success, 1 for
error.
.

During the installation of an add-on on a specific Common database, do not switch to a


different Common databases before the installation completes. Changing Common
database in the middle of the installation process, will result in failure of the installation.

SAP AG - Internal use only Page 6 of 9


SAP Business One SDK 6.7 Add-On Installation and Administration

Creating Documentation
Your add-on documentation should comply with the SAP Business One standards that are based on
the Standard and Guidelines for Writing SAP Documentation.
For more information, see the SAP Business One SDK Standard and Guidelines (shipped together
with the SDK) or SAPNet under the alias S&G.

Add-On Administration
The Add-On Administration tool is designed to help administrators to easily deploy and manage add-
on applications on end-users workstations.
The Add-On Administration allows you to:
 Register add-on
This is required by the SAP Business One application in order to automatically run your add-on.
Once an add-on is registered, you can set company and user-specific preferences for the
ad-don.
 Configure company-wide preferences
 Configure user preferences
To run the Add-On Administration, you must have the SAP Business One application and the UI API
installed on the client machine.

Registration
You register and assign add-on applications using the Add-On Administration tool. Before registering
an add-on, make sure you have a valid registration data file and setup package for the add-on.
For more information on the process of generating a data file, see Package and Installation.
1. In the SAP Business One application, choose Administration → Add-On → Add-On
Administration.

2. In the Add-On Administration window, choose Register Add-On.


3. In the Add-On Registration Data File, choose and locate the data file of the add-on.

SAP AG - Internal use only Page 7 of 9


SAP Business One SDK 6.7 Add-On Installation and Administration

Once you've selected the file, its full path and name will appear in the text box.
4. In the Add-On Install Package, choose to locate the setup file of the add-on.
5. Select Assign to Current Company to automatically assign the add-on to the company database
to which the application is currently connected.
6. Choose OK to close the window and register the add-on. Once the add-on is registered, it
appears in the Available Add-On list on the Add-On Administration window.

Setting Company Preferences


The Add-On Administration tool lets you set different company-wide preferences for
each company-assigned add-on.
To set these preferences, you must assign the add-on to the company (if you haven't done so already
during the registration process) by moving the add-on from the Available Add-On list to the Company
Assigned Add-On list using the icons.

The company preferences include:

Start-up behavior
The start-up behavior controls the launch and deployment of add-on for all users connected to the
company. Each add-on can be classified to one of the four start-up behavior groups available from
the Default Group column.
For Automatic, Manual, and Disabled you can override the company preferences by setting different
preferences to specific users in the company.
 Mandatory - Add-on is necessary to the successful operation of the SAP Business One
application. The application will launch the add-on at start up and will be shut down if the add-
on is terminated for any reason.
 Automatic - Add-on is started automatically by the SAP Business One application. End-users
can terminate automatic add-on without affecting the SAP Business One application. The
application issues a warning when an automatic add-on is closed.
 Manual - Add-on is not started automatically by the SAP Business One application. End-users
can run and manual add-on at any time. When a manual add-on is closed, a message informs
the user.
 Disabled - Add-on is not available for this company, but can be executed manually for specific
users with the appropriate preferences. This is typically used for debugging purposes.

Force install
Forces the SAP Business One application to reinstall an add-on that was failed to install, each time
the end-user logs on to the company. If the add-on is already installed, the application will not reinstall
it.

Event-receiving order
You can determine the order in which the company-assigned add-on will receive events from the SAP
Business One application. This order is determined by the order of appearance (from top to bottom)
in the Company Assigned Add-On list.

To change the order, use the and icons.

Setting User Preferences

SAP AG - Internal use only Page 8 of 9


SAP Business One SDK 6.7 Add-On Installation and Administration

In addition to Company Preferences, you can also set add-on preferences to specific users in the
company. The add-on preferences for a user override the add-on company preferences.

You cannot set user preferences for an add-on defined as Mandatory in the company
preferences.
On the User Preferences tab, you can set the add-on start-up behavior for specific users of the
company. This behavior will override what you set for the entire company, except for Mandatory add-
on.

To set user preferences:


1. Choose the User Preferences tab and select a user from the Users list.

2. From the Preferences column, choose one of the available start-up behavior:
 Automatic – Add-on is started automatically by the SAP Business One application. End-users
can terminate automatic add-on without affecting the SAP Business One application. The
application issues a warning when an automatic add-on is closed.
 Manual – Add-on is not started automatically by the SAP Business One application. End-users
can run and manual add-on at any time. When a manual add-on is closed, a message
informs the user.
 Default – add-on preferences for this user are taken from the company preferences.

Removing Add-On Programs


You can remove an add-on from the client workstation in the Add-On Administration tool.
1. From the Company Assigned Add-On list, select the add-on you want to remove and choose .
2. Choose Remove Add-On. The Add-On Administration unregisters the add-on and removes it
from the Available Add-On list.

SAP AG - Internal use only Page 9 of 9