JBoss.orgCommunity Documentation

Scribble User Guide

This is the installation guide for the Scribble tools. Scribble is a notation for describing interaction based protocols between multiple parties.

The pre-requisites for the Scribble design time tools are:

The design time tools are Java based, so you will need a suitable JVM (Java Virtual Machine) to run the tools. If you also intend to generate Java APIs, for use at runtime, then you will need a JDK (Java Development Kit). Download the version 1.6 (or higher) from the http://www.java.com . Once downloaded, follow the instructions to install the JVM or JDK on your system.

  1. Eclipse

The Scribble protocol descriptions can be edited using a standard text editor, and the Scribble tools can be invoked using command line tools (as described in the following chapter). However it is also possible to use the Scribble tools from within the Eclipse IDE environment, by installing the Scribble tools as plugins. If you wish to use this approach, then you will need a version of Eclipse (3.6 or higher) which can be downloaded from the Eclipse website: http://www.eclipse.org .

To install the command line version of the Scribble tools:

  1. Download the Scribble tools distribution from: http://www.jboss.org/scribble/downloads .

  2. Unpack the tool distribution in a suitable location

  3. Setup environment

The commands can be executed from the bin folder of the Scribble tools distribution. Alternatively, the bin folder can be added to the execution path, to enable the commands to be performed from any folder. For example, on Linux running bash, simply edit the .bash_profile file within your home directory to add:


NOTE: Currently on Windows it is only possible to run the scripts from the bin folder.

The Eclipse plugins for the Scribble tools can be loaded from an update site using the update manager.

Select the Help->Install New Software... menu item, from your Eclipse environment, and follow the instructions.

If installing a stable or development milestone release of the tools, then the plugins can be installed directly from the network. If installing a nightly build of the plugins, to access the latest (but unstable) version of the tools, then it will be necessary to download the update site as an archive, and point the Eclipse update manager at the downloaded zip file.

The location of the stable, development and nightly builds can be found on the Scribble download page: http://www.jboss.org/scribble/downloads .

Once the Eclipse environment has restarted, and if the distribution has been downloaded and expanded, then the next step is to import the samples into the Eclipse workspace.

This can be done by selecting the Import->General->Existing Projects into Workspace and locating the samples folder from the Scribble distribution.

This will display the set of projects within the samples folder, which can either be individually selected, or all imported at once. Once imported, the Scribble Protocol files can be opened by double clicking the file, to open the protocol context sensitive editor.

This section describes how to use the command line tools that are available in the bin folder of the Scribble protocol tools distribution.

Information on the Scribble protocol notation (or language) can be found in the Scribble Protocol Guide .

The parse command takes a single parameter, which is the path to the file containing the protocol description to be parsed.

For example, if the user is in the top level folder of the Scribble tools distribution, without the bin folder being added to the system path, then the following command can be executed to parse one of the sample protocol descriptions:

If the supplied file path is not valid, then the command will report an error.

This command will read the protocol description, as shown below, and convert it into an internal object model representation.

If any errors are detected in the syntax of the parsed protocol description, then these will be reported to the command window.

Revision History
Revision 2.0.0Sept 20 2011Gary Brown
Initial version of user guide