Microsoft Exchange Server Scripting and Routing

Introduced in Exchange Server 5.5, the Exchange Server Event Service supports server-side scripts triggered by folder events, either in public folders or individual mailboxes. A prime example is a script to handle booking of a conference room or other resource. The main source of document is the Agents.hlp file on the Exchange Server CD. You can also download updated samples and documentation.

Building on the Event Service, Microsoft Exchange Routing Objects provide server-side routing and state tracking to help you build workflow applications with Microsoft Exchange Server, using either parallel or sequential routing schemes. Released as part of Microsoft Exchange Server 5.5 Service Pack 1.

The big difference between scripting and routing and some other approaches to automatically processing items is that scripts and routing objects operate entirely on the server. It is not necessary for any client machines to be logged in. Because no user interface is involved, Event Service scripts should always have error-handling and can display neither Outlook items nor message or input boxes. Other limitations and considerations are discussed in the MSKB article Suitable Applications for Exchange Server Event Scripting.

Configuration

Use the Outlook client to enable scripts, using the Agents tab on the Properties dialog for in any mailbox or server folder. The Agents tab is not visible by default. You must specifically enable it using the Add-in Manager in Outlook. See these Microsoft Knowledgebase articles:

With Exchange 2000, you will need to configure the Event Service to run under a domain user account and set it to start automatically. The account also will need at least Editor permissions to the Event_Config folder and Owner permissions on the folders where you want to create scripts. None of these are default settings, so you'll have to configure them before the server will run scripts and you can install them. See:

Micro Eye Script Director is a deployment and administration tool to help developers and administrators manage Exchange folders with scripting or routing agents.

Writing Scripts

Code in Event Service scripts normally uses VBScript, a slim, portable version of the Visual Basic programming language. It is also possible to use JScript.

The object model for folder scripts is Collaboaration Data Objects (CDO).

Also see:

The Secrets of Exchange Scripting & Routing (CDOLive)

Routing

Both Exchange 2000 and Exchange 5.5 support workflow, but via different methods.

Exchange 2000:

The Workflow Designer for Exchange 2000 is included with Exchange 2000 and, in an updated version, the Office XP developer edition. Also see:

Exchange 5.5:

The Secrets of Exchange Server Scripting and Routing, Contents (CDOLive)
Agents.hlp on Service Pack CD - “Enabling a Folder for Routing”
The Routing Problem: The Microsoft Exchange Server Solution (MSDN) -- Includes a sample Outlook form for one-off routing
Programming Microsoft Outlook and Microsoft Exchange -- Chapter 13 of this book by Microsoft product manager Tom Rizzo includes the most detailed discussion of Routing Objects for Exchange 5.5 that I've found. It also includes a tool for installing agents and editing routing maps.
INFO What Does Terminate 0 1 Mean in the Routing Process
INFO What Does Wait 0 0 Mean in the Routing Process

Discussion

You can ask questions about Exchange scripting and routing in the microsoft.public.exchange.applications newsgroup on the msnews.microsoft.com server and at the CDOLive - Ask the Experts Area.

Samples

CDOLive Code Sample Library
The Exchange Code Exchange -- Features an enhanced version of an autoaccept script for resource calendars
Reliable E-mail Auto-forwarding (DevX) -- Script to forward high-importance messages to a pager.
Microsoft Exchange Agent Editor -- source and compiled for NT.
msgclass_event_005.txt (from the i405.com Microsoft LDAP / ADSI Admin Encouragement Page) can change the message class on incoming messages to a different message class that contains custom reply scripts or other actions.
HOWTO Sample JScript for the Exchange Event Service (Microsoft)
SAMPLE: SUGGEST.EXE is Microsoft Exchange Custom Agent -- MSKB article on creating a compile agent with C++.
To change an item's message class with an Exchange Server script
In-Out Board -- Uses the Out of Office Assistant settings for each user to generate a list of who's in and out of the office in a public folder.
Enterprise Calendar -- Complex sample to synchronize data from user Calendar folders to a central calendar, from Tom Howe
HOWTO- Allow Printing from an Exchange Event Script
HTMLCalendar -- Exchange event script sample to generate a web page showing a conference room schedule.

Sample Outlook forms using the Exchange Server Routing Wizard:

Sample Outlook forms with accompanying Exchange event script samples that use ADO database connections:

For installation instructions for these forms, see Microsoft Sample Applications. Also see Using Outlook Forms with Access Data, which explains in detail how the Student Attendance sample form works.

Tools

Agent Install	Sample application included in Tom Rizzo's Programming Microsoft Outlook and Microsoft Exchange book for installing script agents and routing maps.
Script Director	Tool for installing, managing and editing script agents throughout an organization. For Routing Objects, provides access to details on each item being routed, including the tracking status of each recipient. Also manages custom Outlook forms.

Problems

More Information

XADM How to Set Diagnostic Logging Levels for the Event Service
Working with Exchange 2000 Store Events -- training seminar


	© 2002-6 TurtleFlock, LLC All right reserved. About OutlookCode.com Send comments to webmaster@outlookcode.com Designed and Implemented by TerraLink USA FrontPage Integration by RobsonDesignWorks


get Sue's code \| forums \| share your own code \| registration