Skip to content

start:

Installation Guide for the Office Scripting Framework

Contents

Who Should Read This Document

This document should be read by:

  • Application Developers who wish to enhance OpenOffice.org functionality without needing to develop UNO components or to connect to OpenOffice.org from a remote JVM

  • OpenOffice.org users who wish to execute Office scripts via menu, key and event bindings in OpenOffice.org

Top

Pre-requisites

  • This is an Early Developer Release of the Office Scripting Framework provided for users and developers of OpenOffice.org to try out and provide feedback. Future releases of the Framework may change.
  • This release of the Scripting Framework runs on OpenOffice.org 644 and above.
  • The Scripting Framework is currently available in English only.
The table below shows the JDK and memory requirements for running the Office Scripting Framework.

UserIDEJDK requiredMemory required
Script User-1.3256MB
Script DeveloperNetBeans 3.41.3512MB
Top

Downloading the Scripting Framework

The Scripting Framework is available for download in the form of a Jar file which can be obtained from here. The contents of the Jar file are as follows:
  • installer - A platform-independent installer for the Scripting Framework written in Java.
  • bindingdialog - A collection of StarBasic dialogs to enable the user to assign (bind) scripts to menu and key items, and to document and application events. This directory also contains the necessary XML files for the menu items that invoke these StarBasic dialogs.
  • examples - Example scripts written in Java and BeanShell.
  • sframework - A UNO package containing the Scripting Framework libraries, Jar files and types.
  • ide - The Jar files for NetBeans integration.
Top

Installing the Scripting Framework

Before you begin installation, you need to ensure all Office processes have terminated and on Windows and Linux, that the QuickStarter has been closed.

Note: Before installing an updated version of the Scripting Framework, the previous version should be removed. (See the Guide for Uninstalling)

To install the Scripting Framework:

  • Open a terminal (Linux/UNIX) or DOS Command Prompt (Windows)
  • Ensure that java is in your execution path
  • Run the command: java -jar SFrameworkInstall.jar

This will start the installer GUI, which you can use to select the Office installation to which you want to install the Scripting Framework. The framework is installed in the <Office Installation>/user/uno_packages directory of the Office installation you choose. If the installer detects an installation of either NetBeans 3.4 you will be asked whether you wish to install the IDE Add-ins. These add-ins provide support for developing and deploying Office Scripts.

Note: If you do not wish to use the GUI you can install the Scripting Framework and the IDE Add-in via the command line using the command:

java -jar SFrameworkInstall.jar -office <Office Installation> -netbeans <NetBeans Installation>

Note: The installer detects IDE installations by looking for session related files in the home directory of the user running the install, so in order for your IDE to be detected you will need to have run it at least once.

Top

Last Modified: Tue Mar 12 11:40:28 GMT 2003