Groovy Event Handler

A Groovy event handler responds to any event. On the "Server Events" tab , you can select the events generated by the server. In the Groovy script, these events are filtered more precisely as needed. The Groovy event handler allows you to link actions and conditions.

You can find the Groovy event handler in Processes under "Elements." It belongs to the "Event Handler" category. From there, it can be dragged and dropped to the desired location on the desktop and then configured. General information on creating process elements can be found here.

Once you have created the Groovy event handler on the workspace, double-click the element to open the Properties dialog.

General

You can find all the information about the settings in this dialog box here.

Click "Next."

Server Events

The name of the selected server event is displayed here. In the Groovy script, these events are filtered more precisely as needed. If the script returns the boolean value true (in the Groovy sense), the event is processed; otherwise, it is not.

Delete Server Event

Deletes the currently selected server event.

Add a Server Event

Opens a dialog box where you can select a server event.

Click "OK" to complete the configuration.

Server Event

Add Server Events

This option allows you to select a server event.

Add the following server event

This option allows you to specify interface names for server events directly (e.g., "de.uplanet.lucy.server.workflow.event.IWorkflowEvent" to listen for all workflow events).

Enable the "Send login process event on login" setting in the portal properties if you want to use this server event with the Groovy event handler.

Server Events

Publishing a New Application

For more information: IApplicationCreateEvent interface

Starting with Intrexx version 12.0.0

For more information: IApplicationCreateEvent interface

Publishing an Existing Application

For more information: IApplicationUpdateEvent interface

Starting with Intrexx version 12.0.0

Additional information: IApplicationUpdateEvent interface

Before Deleting an Application

Additional information: IApplicationBeforeDeleteEvent interface

Starting with Intrexx version 12.0.0

Additional information: IApplicationBeforeDeleteEvent interface

After deleting an application

Additional information: IApplicationAfterDeleteEvent interface

Starting with Intrexx version 12.0.0

Additional information: IApplicationAfterDeleteEvent interface

These events contain the application's GUID. The GUID can be determined as follows:

            def strAppGuid = g_event.applicationGuid
        

Portal Export Start

Occurs at the start of a portal export. The event contains the export directory or export file.

Additional information: IPortalExportStartEvent interface

Starting with Intrexx version 12.0.0

Additional information: IPortalExportStartEvent interface

End of Portal Export

Occurs at the end of the portal export. The event contains the export directory or export file.

Additional information: IPortalExportEndEvent interface

Starting with Intrexx version 12.0.0

Additional information: IPortalExportEndEvent interface

Adding a User (Web)

This event occurs after a new user has been created via the user application. The event contains the GUID of the newly added user.

For more information: IOrgStructureChangedEvent interface

Starting with Intrexx version 12.0.0

For more information: IOrgStructureChangedEvent interface

Deactivating a User (Web)

Occurs after a user has been deactivated via the user application. The event contains the GUID of the deactivated user.

Additional information: IUserDeactivatedEvent interface

Starting with Intrexx version 12.0.0

Additional information: IUserDeactivatedEvent interface

Blocking a User (Web)

Occurs when a user is locked out of the web interface after exceeding the allowed number of login attempts.

Additional information: IUserLockedWorkflowEvent interface

Starting with Intrexx version 12.0.0

Additional information: IUserLockedWorkflowEvent interface

User Login

Requires the "Send login process event upon login" setting in the portal properties. Occurs after a user has logged in. The event contains the logged-in session and the name of the authentication configuration being used. A user's GUID can be determined using the following Groovy script:

            def intUserId = g_session?.user?.id
def strUserGuid = g_session?.user?.guid
        

User Logout

Requires the "Send login process event upon login" setting in the portal properties. Occurs after a user has logged out of a session. The event contains the logged-out session as well as the name of the authentication configuration used.

Starting with Intrexx version 12.2.0

Start Server

Sent when the portal service starts.

Please note that only a limited processing context is available at that time.
Please also note that the event occurs on every node when Intrexx is running as a cluster (horizontal scaling).

If the startup event is to be processed only once per cluster startup, this can be achieved by setting and querying a global lock (see (Groovy API for the LockService) can be achieved.

Server Shutdown

Occurs while the portal server is shutting down.

Additional information: IServerStopEvent interface

Starting with Intrexx version 12.0.0

Additional information: IServerStopEvent interface

Custom Event

Occurs when triggered by a user, for example, via JavaScript or as a user-defined workflow follow-up event in task scheduling.

Timer processing complete

Fires when a global timer has finished processing.

Changing the Portal Language

Change the language setting in the portal properties.

For more information: ILanguagesChangedEvent interface

Starting with Intrexx version 12.0.0

For more information: ILanguagesChangedEvent interface

Changing the Location-Specific Formats of the Portal

Changes the format settings in the portal properties.

Additional information: ILocaleFormatsChangedEvent interface

Starting with Intrexx version 12.0.0

More information: ILocaleFormatsChangedEvent interface

Email delivery failed (BadMail folder)

This event occurs when an email is moved to the BadMail folder (/internal/mailroot/badmail).

More Information

https://docs.intrexx.com/intrexx/version/11000/steady/api/groovy/jdk/de/uplanet/lucy/server/workflow/event/IWorkflowEvent.html

https://docs.intrexx.com/intrexx/version/steady/api/groovy/jdk/de/uplanet/lucy/server/workflow/event/IWorkflowEvent.html

Click "OK" to save the settings and close the dialog box.

Click "Next."

Script

Here you can access the editors where you can edit Groovy scripts.

File path

Displays the path to the Groovy script file.

Edit File Path

Opens a dialog box where you can change the Groovy script file path. The file path can only be changed if the advanced options are enabled.

Edit File Path

You can edit the file path here.

Please note that directly editing the file path is reserved for users with the necessary expertise. INTREXX GmbH expressly notes that any changes made in this area are the sole responsibility of the user. We do not provide support for editing the file path or for any resulting consequences.

Select a script file

Opens a dialog box where you can select the Groovy file.

Once you have specified the file path, click "OK" to save your changes and close the dialog box.

Open the Intrexx Editor

Opens the built-in Groovy script editor.

Open External Editor

This link appears when the path to an external editor is specified in the editor settings. Clicking the link will then open the external editor.

Cache Compiled Script Classes

With this setting, the compiled Groovy script classes are cached.

Click "OK" to complete the configuration of the Groovy event handler.

More Information

"Processes" Module

Create and Manage Processes

The sections of the "Processes" module

Creating and Connecting Elements

Analyze the log file

Options

External Data in Processes

Java Classes in Process Objects