Obba Developer Documentation
Remark
The following information is for Obba developers wishing to install Obba together with their own library and sheets on a clients system.
Customizing Obba via Obba.properties file
The Obba.properties can be used to customize Obba. Obba maintains its settings in this file. This file also contains the registration information (name and serial number). The location of the file depends on your configuration:
- Obba for Excel stores Obba.properties under %APPDATA%\Obba\lib\
- Obba for OpenOffice stores Obba.properties under the OpenOffice config directory.
- On Mac OS X this is /Applications/OpenOffice.org.app/Contents/basis-link/share/config
- On Windows this is %ProgramFiles%\OpenOffice.org 3\Basis\share\config
You can set the following properties:
- userid
- The user id (part of the registration information).
- serial
- The serial number (part of the registration information).
- controlpanel
- If set to disallow access to the control panel is blocked.
- menu
- If set to hide the Obba menu for Excel is not shown.
Note that a registered version of Obba will not show a splash screen.
Installing a Serial Number
The registration information can be entered in the Obba control panel dialog "Registration...". In case you like to install a registered version you can do this by installing the appropriate Obba.properties file. The file is a standard Java properties files. The registration information is stored under the keys userid and serial.
If the file does not exist, Obba will create it. You may use this on your development system to create a template Obba.properties file.
Installing Obba Components together with Your Software
Obba for Excel
It is strongly recommended that you use the standard Obba installer (you can customize the installation as a second step).
If you have a developer license you may redistribute the installer bundled with you own application to be installed on a clients system. You may integrate the installer in your own installation process.
Silent Installation
By default the standard installer shows a gui and upon completion the user has to close the installer manually.
If you want to use the standard installer within a batch file (or you own installer) you can launch the Obba installer in silent mode using the command line option /S.
This following command will instal Obba for Excel without showing up a gui and without user interaction:
"Install Obba for Excel.exe" /S
Installation Steps
The following describes the steps performed by the Obba installer for Excel. The description is only for reference. You do not need to perform these steps manually.
Obba for Excel needs a Java Runtime Environment. The location of the JRE is determined from the environment variable %JRE_HOME%, or, if it is not set, from the registry entry HKLM\SOFTWARE\JavaSoft\Java Runtime Environment\%JRE_VERSION%\JavaHome where HKLM\SOFTWARE\JavaSoft\Java Runtime Environment\CurrentVersion.
Ihe installer fails if it cannot find a Java Runtime Environment.
The installer performs the following steps:
- Install Obba.dll to %APPDATA%\Obba\bin
- Install Obba.jar to %APPDATA%\Obba\lib
- Install Obba.properties to %APPDATA%\Obba\lib
- Install Obba.xla to %APPDATA%\Microsoft\Excel\XLStart
- Register Obba.dll with Windows. Make registry entries under the following keys:
-
HKCU SOFTWARE\Obba
HKCU SOFTWARE\Classes\Obba.Bean
HKCU SOFTWARE\Classes\Obba.Bean.1
HKCU Classes\CLSID\{ECE3AC28-A26C-4F1F-B3CB-429BEF1842DE}
HKCU Classes\TypeLib\{9E477726-3956-41E8-91B8-9CB1B1ED5C77}
These entries will tell Windows where Obba is installed. They will also tell Obba which Java runtime it should use.
- Install the Uninstaller in %APPDATA%\Obba
Note: If you move the Obba folder %APPDATA%\Obba then Obba cannot launch.
Creating a Custom Installer
The Obba Developers Resources contains an example of a customized installation (see the folder Obba for Excel - Custom Installer). The corresponding batch file first runs the standard Obba installer, then performs some customizations.
Obba for OpenOffice
Obba for OpenOffice is installed by opening Obba.oxt with OpenOffice. There is no specific installer.
Signing Obba (Obba.jar) with your own Certificate
Obba for Excel
Depending on the Windows setup user will have to accept a certificate prior first use of an Excel Sheet using Obba function.
By default, Obba uses a self signed certificate (publisher is Christian Fries). If you want to sign Obba with your certificate perform the following steps:
- Download the Obba Developers Resources. It contains an unsigned Obba.jar file.
- Sign the file Obba Developers/Unsigned JAR/Obba.jar with your certificate.
- Use this file in a customized installer (place the file in %APPDATA%\Obba\lib after running the standard installer. For example, the custom installer example will perform this step if you placed you signed jar in Obba Developers\Obba for Excel - Custom Installer\InstallerFiles\lib (see Section "Creating a Custom Installer").
Note: Using an unsigned Obba.jar in Obba Excel may break functionality due to access violations. For example, a call to
obAddAllJars may generate an exception: java.security.AccessControlException: access denied (java.lang.RuntimePermission setContextClassLoader).
Obba for OpenOffice
The jar file contained in Obba.oxt is unsigned (note: Obba.oxt is just a zip where the extension has been renamed from .zip to .oxt). You need to sign all the JAR files contained in this archive.