Event Listner 4.0

This tool has various applications. You can be busy developing a plugin an need to know which data is available when the plugin is executing. Or you want to see how your plugin modifies the in- or outputparameters of a message.

Key features:

• Trace any plugin event available to the SDK
• See all details available in the plugin context
• Optionally trace events generated in an Offline outlook client
• Filtering of which events are received
• Multiple filters can be defined and reused

For the CRM 2011 version click here.

Start a new session

1. Open a connection to the CRM server/organization of your choice.
   This can be done using the connection menu on left side of the toolbar.
2. When the connection is established you must define a the filter.
   Do this using the filter button.
3. When you have defined a filter click the record button to start the session.

Defining a filter

When defining a filter to select which messages to trace you have can do the following:

• Disable the filter: this will automatically register to any available event.
• Add one or more rules
• Load a filter from a file.

The following details can be set on a filter rule:

• Message: which message should the event bind to. This list contains all the messages present on the CRM server, this may include message which are not available to the SDK.
• Primary/Secondary Entity: Select a specific entity for this rule or any for all entities.
• Stage: Register to the pre and or post stage
• Pipeline: Register to the parent or Child pipeline (not available for all messages)
• Rank: Plugin steps are executed ordered by rank, the lowest number is excuted first.

Save/Load a filter

Filters can be saved to or loaded from an XML file. The file is created using the XML Serializer.

Communcation with CRM

The event listner registers a plugin on the CRM server which fowards all events to the Event listner client using a remoting connection. If the server name in the connection is 'localhost' or the machine name an IPC channel is used and no TCP configuration is required.
When the client is running on another system a TCP connection is used. The TCP connection connects from the server to the client. The port for the connection can be configured in the settings, the default port is 8546.

If the client is shutdown without unregistering the plugin the plugin will continue transmitting message to the client. These will not break functionality on the server but will cause a severe performance hit.
You can restart the client and hit the record button again the continue tracing events. This will show a notification that the server allready has a registration for the eventlistner plugin. Simply select no to use the filter on the server or yes to replace the server filter. Clicking the stop button or when shutting down the application the plugin registration should be removed.

Download