Copy Page

You are not logged in. Any changes you make will be marked as anonymous. You may want to Log In if you already have an account. You can also Sign Up for a new account.

<table class="wysiwyg-macro" data-macro-name="excerpt" data-macro-parameters="atlassian-macro-output-type=BLOCK|hidden=true" style="background-image: url(/plugins/servlet/confluence/placeholder/macro-heading?definition=e2V4Y2VycHQ6aGlkZGVuPXRydWV8YXRsYXNzaWFuLW1hY3JvLW91dHB1dC10eXBlPUJMT0NLfQ&amp;locale=en_GB&amp;version=2); background-repeat: no-repeat;" data-macro-body-type="RICH_TEXT"><tr><td class="wysiwyg-macro-body">script Windows ActiveX and COM components with Groovy </td></tr></table>

<h1>Introduction</h1>

Scriptom (<a class="confluence-link unresolved" data-filename="scriptom-1.5.zip" data-linked-resource-default-alias="scriptom-1.5.zip" href="#">scriptom-1.5.zip</a>), an optional Groovy module originally developed by <a href="http://glaforge.free.fr/weblog">Guillaume Laforge</a>, combines the elegant &quot;syntactical sugar&quot; of Groovy with the power of the <a href="http://sourceforge.net/projects/jacob-project/">Jacob library (Java COM Bridge)</a>. The result is something that looks an awful lot like Windows Scripting Host (WSH) scripting with VBScript - only it's for Java.  Once installed into Groovy, Scriptom allows you to script ActiveX or COM Windows components from Groovy.

What this means is that you can use Groovy to automate Word or Excel documents, control Internet Explorer, make your PC talk using the Microsoft Speech API, monitor processes with WMI (Windows Management Instrumentation), or browse the Windows Registry using WShell (among many, many other things).  It is also a convenient way to talk to custom VB6 or COM-enabled Microsoft.NET libraries (compare this to the administrative headaches of getting Java and .NET to talk using Web Services - it's a no brainer).  All this without ever leaving the comfortable Java universe.

Of course, Scriptom can be used only on Microsoft Windows.

Scriptom is bundled into the <a href="http://groovy.codehaus.org/Download">Groovy Windows-Installer</a>, and the most current version can be downloaded from this page (see below). The codebase is considered stable and feature-complete.  The Jacob project - Scriptom's foundation - was started in 1999 and is being used in thousands of production applications worldwide.  Scriptom is only a few years old, but it is already stable and mature because it is built on an existing, best-of-breed platform.

Scriptom gives you all the COM-scripting power of Jacob, only it is a lot easier.

The Scriptom team
<ul>
	<li><a href="http://glaforge.free.fr/weblog">Guillaume Laforge</a></li>
	<li>Dierk Koenig</li>
	<li>Marc Guillemot</li>
	<li><a href="http://groovierthanthou.blogspot.com/">Jason Smith</a></li>
</ul>

<h1>Installation</h1>

Scriptom 1.5 requires Groovy 1.5. Because of dependencies on Jacob 1.14, Scriptom also requires Java 1.5 or higher.

Download the project archive(s) and extract the files.
<ul>
	<li><img class="emoticon emoticon-tick" data-emoticon-name="tick" border="0" src="/s/en_GB/3278/15/_/images/icons/emoticons/check.png" alt="(tick)" title="(tick)" /> <a class="confluence-link unresolved" data-filename="scriptom-1.5.zip" data-linked-resource-default-alias="scriptom-1.5.zip" href="#">scriptom-1.5.zip</a> Build 10 (12/10/2007) - Scriptom JAR file, Scriptom-1.5.0bX-32.dll, Scriptom-1.5.0bX-64.dll, Java source code, ANT build script, examples, tests, and utilities.</li>
	<li><img class="emoticon emoticon-information" data-emoticon-name="information" border="0" src="/s/en_GB/3278/15/_/images/icons/emoticons/information.png" alt="(info)" title="(info)" /> <a class="confluence-link unresolved" data-filename="scriptom-1.5-javadoc.zip" data-linked-resource-default-alias="scriptom-1.5-javadoc.zip" href="#">scriptom-1.5-javadoc.zip</a> - JavaDoc for Scriptom and included type-library information.</li>
</ul>

Install the jar file and DLL file(s) into your project, and optionally install an update from Microsoft:
<ol>
	<li>Add the Scriptom jar file (scriptom-1.5.0bX-XX.jar) into your Java classpath.  It contains both Scriptom and Jacob class files, so you must not include jacob.jar. 
<table class="wysiwyg-macro" data-macro-name="warning" style="background-image: url(/plugins/servlet/confluence/placeholder/macro-heading?definition=e3dhcm5pbmd9&amp;locale=en_GB&amp;version=2); background-repeat: no-repeat;" data-macro-body-type="RICH_TEXT"><tr><td class="wysiwyg-macro-body">Scriptom contains a full (current) version of the Jacob library. If you are using Jacob directly elsewhere in your project, remove all references to it and use the version built in to Scriptom. </td></tr></table></li>
	<li>Copy both Scriptom-1.5.0bX-XX.dll files to somewhere on your java.library.path. (usually somewhere on the system 'PATH'). 
<table class="wysiwyg-macro" data-macro-name="info" style="background-image: url(/plugins/servlet/confluence/placeholder/macro-heading?definition=e2luZm99&amp;locale=en_GB&amp;version=2); background-repeat: no-repeat;" data-macro-body-type="RICH_TEXT"><tr><td class="wysiwyg-macro-body">The Scriptom DLL naming convention allows multiple versions of Scriptom to run on the same machine. However, you can only run a single version of Scriptom JAR in any given project. </td></tr></table></li>
	<li>To avoid the dreaded java.lang.UnsatisfiedLinkError, download and install one of the following updates from Microsoft: <a href="http://www.microsoft.com/downloads/details.aspx?familyid=200B2FD9-AE1A-4A14-984D-389C36F85647&amp;displaylang=en">Microsoft Visual C++ 2005 SP1 Redistributable Package (x86)</a>or <a href="http://www.microsoft.com/downloads/details.aspx?FamilyID=eb4ebe2d-33c0-4a47-9dd4-b9a6d7bd44da&amp;DisplayLang=en">Microsoft Visual C++ 2005 SP1 Redistributable Package (x64)</a>. Scriptom doesn't support the  IA-64 (Itanium) architecture at this time, mainly due to lack of interest. If you are wondering about the different processor architectures, check out the <a href="http://en.wikipedia.org/wiki/X86-64">x86-64 wiki</a>. It is usually necessary to install these updates on Windows Server 2003 and Windows 2000, and we've found that it may also be necessary for Windows XP and even Vista. 
<table class="wysiwyg-macro" data-macro-name="note" style="background-image: url(/plugins/servlet/confluence/placeholder/macro-heading?definition=e25vdGV9&amp;locale=en_GB&amp;version=2); background-repeat: no-repeat;" data-macro-body-type="RICH_TEXT"><tr><td class="wysiwyg-macro-body">
A project can only use one version of Scriptom at a time. If you have installed Groovy using the Groovy Windows Installer, you must remove any versions of Scriptom JAR files or replace them with the latest version. A version of Scriptom is installed as part of the Groovy Windows Installer installation. </td></tr></table>
Scriptom 1.5 is not supported for Groovy 1.0 and earlier (Scriptom 1.2 is still available). Please contact us if this presents a serious problem for you.</li>
</ol>

<h1>Building from Source</h1>

The project archive contains all the Scriptom source files, Java source files from Jacob, and an ANT build script. To save space, the Groovy JAR files have been omitted from the archive.  For a successful compilation, Groovy JAR files must be added to the project/lib folder.

The latest build requires Groovy 1.5.

Scriptom includes source files from Jacob version 1.14.  You don't need to download it from the Jacob project on SourceForge.net.

To build the project, run project/build/make.bat.

The build process requires Java 1.5 or higher (Java 1.6 recommended) and ANT 1.6.5 or better.

<h1>Changes from Scriptom 1.x</h1>

Scriptom 1.5 is a substantial upgrade to previous versions of Scriptom, and is not backward compatible.  We hope you will agree that it is worth a little code rework to get all these great new features! 
<ul>
	<li>Provides simplified helper methods for dealing with COM apartment threading models.</li>
	<li>ActiveXProxy name changed to ActiveXObject to match WSH convention.</li>
	<li>VariantProxy no longer exists (the functionality was refactored into ActiveXObject).</li>
	<li>Variant values are converted to and from the equivalent Java type; no more calling .value on everything!</li>
	<li>Supports COM event callbacks using closures (this is still a work in progress, but usable as is).</li>
	<li>Supports indexed properties, including multiple indexes.</li>
	<li>Supports typed, multi-dimensional SafeArrays.</li>
	<li>Supports pass-byref (in/out) values, both in method calls and event handler callbacks.</li>
	<li>Supports COM enumerable types (so you can use .each, for example).</li>
	<li>Supports missing arguments (for optional parameters) in method/property calls and events.</li>
	<li>Includes constant definitions for several popular Windows applications, derived from these type libraries (see JavaDoc):
	<ul>
		<li>Microsoft Office 2003 (works with other versions as well)
		<ul>
			<li>Word 2003</li>
			<li>Excel 2003</li>
			<li>Outlook 2003</li>
			<li>Access 2003</li>
			<li>PowerPoint 2003</li>
		</ul>
		</li>
		<li>Microsoft Internet Explorer 6 (works with other versions as well)</li>
		<li>Microsoft Scripting (i.e., FileSystemObject)</li>
		<li>Microsoft Speech API</li>
		<li>Windows Scripting Host (WSH)</li>
		<li>WbemScripting (WMI - Windows Management Instrumentation)</li>
	</ul>
	</li>
	<li>Supports the latest features from Jacob 1.14, including new support for the Decimal data type and 64-bit integers.</li>
</ul>

<h1>Migrating from Previous Versions of Scriptom</h1>

Scriptom 1.5 is not backward compatible with previous versions of Scriptom.  To get your scripts running again, do this:
<ul>
	<li>Change all references to ActiveXProxy into ActiveXObject.</li>
	<li>Wrap any code that references an ActiveXObject in Scriptom.withMTA { ... }, which replaces the way Scriptom previously handled COM threading.  </li>
	<li>Remove all references to .value property references. </li>
	<li>Remove any statically typed references to VariantProxy.</li>
	<li>Support for COM events is greatly improved in this version - and also greatly changed.  Refer to the Events section below for more information.</li>
	<li>Verify that your project is using the correct version of jacob.dll.
 </li>
</ul>

<h1>Quick Start</h1>

Let's say you want an application that talks. Pure Java implementations aside (this is, after all, a Groovy/COM tutorial), and ignoring the fact that the default voice on pre-Vista machines sounds like <a href="http://en.wikipedia.org/wiki/Dr._Zoidberg">Dr. Zoidberg</a> with a sinus infection, you could use the Microsoft Speech API (SAPI) to get the job done.

You start by creating an ActiveXObject with the prog-id for SpVoice. Now you can call any of the methods it supports. By default, SpVoice will block until it is done speaking, but we're going to have it speak asynchronously and wait until it is done.
<table class="wysiwyg-macro" data-macro-name="code" style="background-image: url(/plugins/servlet/confluence/placeholder/macro-heading?definition=e2NvZGV9&amp;locale=en_GB&amp;version=2); background-repeat: no-repeat;" data-macro-body-type="PLAIN_TEXT"><tr><td class="wysiwyg-macro-body"><pre>
import org.codehaus.groovy.scriptom.*
import org.codehaus.groovy.scriptom.tlb.sapi.SpeechVoiceSpeakFlags;
import org.codehaus.groovy.scriptom.tlb.sapi.SpeechRunState;

//Definitive proof that you CAN talk and chew gum at the same time.
Scriptom.inApartment
{
 def voice = new ActiveXObject('SAPI.SpVoice')
 voice.Speak 'GROOVY and SCRIPT um make com automation simple, fun, and groovy, man!', SpeechVoiceSpeakFlags.SVSFlagsAsync
 while(voice.Status.RunningState != SpeechRunState.SRSEDone)
 {
 println 'Chew gum...'
 sleep 1000
 }
}
println 'Speaker is done.'
</pre></td></tr></table>
If you have scripted COM before, you are probably used to using &quot;magic numbers&quot; throughout your code in place of COM constants.  In this code sample, we're using fully-qualified constants instead.

Scriptom includes fully JavaDoc'd constant and interface definitions from a number of commonly used type-libraries, and you can even create your own.  The source code for generating COM type library definitions for Groovy is written in Groovy<img class="emoticon emoticon-smile" data-emoticon-name="smile" border="0" src="/s/en_GB/3278/15/_/images/icons/emoticons/smile.png" alt="(smile)" title="(smile)" /> , and it's included in the project. It may not seem like a big deal to replace a couple of numbers, but it will be a lot easier in 10 years to find relevant information on SpeechVoiceSpeakFlags.SVSFlagsAsync than on the number 1 (Google returns a little more than 9 billion hits for the number '1', and about 1,000 for 'SpeechVoiceSpeakFlags.SVSFlagsAsync,' including hits on this paragraph).  And besides, the code reads better.

Speaking of interfaces, it turns out that SpVoice supports several.  You can test an ActiveXObject to see if it supports a given interface using .supportsInterface, and you can cast an ActiveXObject to a given interface using .toInterface.

This next example displays the COM interfaces that SpVoice supports (within the SAPI library only):
 
<table class="wysiwyg-macro" data-macro-name="code" style="background-image: url(/plugins/servlet/confluence/placeholder/macro-heading?definition=e2NvZGV9&amp;locale=en_GB&amp;version=2); background-repeat: no-repeat;" data-macro-body-type="PLAIN_TEXT"><tr><td class="wysiwyg-macro-body"><pre>
import org.codehaus.groovy.scriptom.*;
import org.codehaus.groovy.scriptom.tlb.sapi.SpeechLib;

Scriptom.inApartment
{
 def voice = new ActiveXObject('SAPI.SpVoice')
 SpeechLib.interfaces.each {name, iid -> if(voice.supportsInterface(iid)) println "SpeechLib.$name - $iid"}
}
</pre></td></tr></table>

<h1>Programmer's Guide </h1>

<table class="confluenceTable"><tbody>
<tr>
<td class="confluenceTd"> <a class="confluence-link" href="/display/GROOVY/The+Least+You+Need+to+Know+about+COM" data-linked-resource-id="24576229" data-linked-resource-type="page" data-linked-resource-default-alias="The Least You Need to Know about COM" data-base-url="http://docs.codehaus.org">The Least You Need to Know about COM</a> </td>
<td class="confluenceTd"> <img class="editor-inline-macro" src="/plugins/servlet/confluence/placeholder/macro?definition=e2V4Y2VycHQtaW5jbHVkZTpUaGUgTGVhc3QgWW91IE5lZWQgdG8gS25vdyBhYm91dCBDT018bm9wYW5lbD10cnVlfQ&amp;locale=en_GB&amp;version=2" data-macro-name="excerpt-include" data-macro-parameters="nopanel=true" data-macro-default-parameter="The Least You Need to Know about COM"> </td>
</tr>
<tr>
<td class="confluenceTd"> <a class="confluence-link" href="/display/GROOVY/COM+Data+Types+in+Scriptom" data-linked-resource-id="24576234" data-linked-resource-type="page" data-linked-resource-default-alias="COM Data Types in Scriptom" data-base-url="http://docs.codehaus.org">COM Data Types in Scriptom</a> </td>
<td class="confluenceTd"> <img class="editor-inline-macro" src="/plugins/servlet/confluence/placeholder/macro?definition=e2V4Y2VycHQtaW5jbHVkZTpDT00gRGF0YSBUeXBlcyBpbiBTY3JpcHRvbXxub3BhbmVsPXRydWV9&amp;locale=en_GB&amp;version=2" data-macro-name="excerpt-include" data-macro-parameters="nopanel=true" data-macro-default-parameter="COM Data Types in Scriptom"> </td>
</tr>
<tr>
<td class="confluenceTd"> <a class="confluence-link" href="/display/GROOVY/COM+Methods+and+Properties+in+Scriptom" data-linked-resource-id="24576238" data-linked-resource-type="page" data-linked-resource-default-alias="COM Methods and Properties in Scriptom" data-base-url="http://docs.codehaus.org">COM Methods and Properties in Scriptom</a> </td>
<td class="confluenceTd"> <img class="editor-inline-macro" src="/plugins/servlet/confluence/placeholder/macro?definition=e2V4Y2VycHQtaW5jbHVkZTpDT00gTWV0aG9kcyBhbmQgUHJvcGVydGllcyBpbiBTY3JpcHRvbXxub3BhbmVsPXRydWV9&amp;locale=en_GB&amp;version=2" data-macro-name="excerpt-include" data-macro-parameters="nopanel=true" data-macro-default-parameter="COM Methods and Properties in Scriptom"> </td>
</tr>
<tr>
<td class="confluenceTd"> <a class="confluence-link" href="/pages/viewpage.action?pageId=27328519" data-linked-resource-id="27328519" data-linked-resource-type="page" data-linked-resource-default-alias="Passing Values by Reference (in-out)" data-base-url="http://docs.codehaus.org">Passing Values by Reference (in-out)</a> </td>
<td class="confluenceTd"> <img class="editor-inline-macro" src="/plugins/servlet/confluence/placeholder/macro?definition=e2V4Y2VycHQtaW5jbHVkZTpQYXNzaW5nIFZhbHVlcyBieSBSZWZlcmVuY2UgKGluLW91dCl8bm9wYW5lbD10cnVlfQ&amp;locale=en_GB&amp;version=2" data-macro-name="excerpt-include" data-macro-parameters="nopanel=true" data-macro-default-parameter="Passing Values by Reference (in-out)"> </td>
</tr>
<tr>
<td class="confluenceTd"> <a class="confluence-link" href="/display/GROOVY/COM+Events" data-linked-resource-id="27328520" data-linked-resource-type="page" data-linked-resource-default-alias="COM Events" data-base-url="http://docs.codehaus.org">COM Events</a> </td>
<td class="confluenceTd"> <img class="editor-inline-macro" src="/plugins/servlet/confluence/placeholder/macro?definition=e2V4Y2VycHQtaW5jbHVkZTpDT00gRXZlbnRzfG5vcGFuZWw9dHJ1ZX0&amp;locale=en_GB&amp;version=2" data-macro-name="excerpt-include" data-macro-parameters="nopanel=true" data-macro-default-parameter="COM Events"> </td>
</tr>
<tr>
<td class="confluenceTd"> <a class="confluence-link" href="/display/GROOVY/All+About+Arrays" data-linked-resource-id="27983890" data-linked-resource-type="page" data-linked-resource-default-alias="All About Arrays" data-base-url="http://docs.codehaus.org">All About Arrays</a> </td>
<td class="confluenceTd"> <img class="editor-inline-macro" src="/plugins/servlet/confluence/placeholder/macro?definition=e2V4Y2VycHQtaW5jbHVkZTpBbGwgQWJvdXQgQXJyYXlzfG5vcGFuZWw9dHJ1ZX0&amp;locale=en_GB&amp;version=2" data-macro-name="excerpt-include" data-macro-parameters="nopanel=true" data-macro-default-parameter="All About Arrays"> </td>
</tr>
</tbody></table>

<h1>Examples</h1>

Here is a simple example that uses the Microsoft ScriptControl to evaluate a JScript expression.   This is a very indirect way to add 2 and 2.
 
<table class="wysiwyg-macro" data-macro-name="code" style="background-image: url(/plugins/servlet/confluence/placeholder/macro-heading?definition=e2NvZGV9&amp;locale=en_GB&amp;version=2); background-repeat: no-repeat;" data-macro-body-type="PLAIN_TEXT"><tr><td class="wysiwyg-macro-body"><pre>
import org.codehaus.groovy.scriptom.*

Scriptom.inApartment
{
 def scriptControl = new ActiveXObject("ScriptControl")
 scriptControl.Language = "JScript"
 println scriptControl.Eval('2.0 + 2.0;')
}
</pre></td></tr></table>
There are many, many potential uses for Scriptom - far to many to try to maintain as part of this documentation.   So we've included a whole slew of meaty examples in the project archive for you to play with.  We'd like to encourage you to go look at those examples, run them, and modify them.  And if you come up with an especially interesting example, let us know about it.  We may even include it in a future release!

Some additional examples included with Scriptom:
<ul>
	<li>Automated writing to and reading from Excel spreadsheets. Includes COM events example.</li>
	<li>Navigation in Internet Explorer.  Includes COM events example. </li>
	<li>Gathering information about processes and Windows NT services using WMI.</li>
	<li>Parsing a *.msg file with Microsoft Outlook.</li>
</ul>

Consuming Visual Basic 6 (VB6) and Visual Basic.NET COM-enabled DLLs.

<h1>Articles</h1>

<h1>Post Scriptom</h1>

All known (unresolved) issues and feature requests are listed in the <a href="http://jira.codehaus.org/secure/IssueNavigator.jspa?reset=true&amp;mode=hide&amp;pid=10242&amp;sorter/order=DESC&amp;sorter/field=priority&amp;resolution=-1&amp;component=11335">Scriptom Jira</a> database.

Changes to each build are summarized in the <a class="confluence-link" href="/display/GROOVY/Change+Log" data-linked-resource-id="27983882" data-linked-resource-type="page" data-linked-resource-default-alias="Change Log" data-base-url="http://docs.codehaus.org">Change Log</a>.

Recent builds of Scriptom can be found <a href="http://docs.codehaus.org/pages/viewpageattachments.action?pageId=24576222#">here</a>. Older versions are archived:
<img class="editor-inline-macro" src="/plugins/servlet/confluence/placeholder/macro?definition=e2luY2x1ZGU6U2NyaXB0b20gQXJjaGl2ZX0&amp;locale=en_GB&amp;version=2" data-macro-name="include" data-macro-default-parameter="Scriptom Archive">