Email Campaign

With an email campaign, you can automatically send any content to selected recipients. Recipients can be added just as dynamically as you can design the content of the email—from individual pages in Intrexx applications, to pages generated with Groovy or Velocity, all the way to plain-text emails.

To use this feature, the email service must be set up in the "Tools" module. To send emails containing links to portal pages about processes, the "Base URL" field in the portal properties must contain the portal's base URL (e.g., https://exampleportal.com/).

You can find the email campaign in "Processes" under "Elements." From there, it can be dragged and dropped into the desired location in the process chain and then configured. General information on creating process elements can be found here.

Once you have created the email campaign on the workspace, double-click the item to open the Properties dialog box.

General

You'll also find this dialog box for other process elements.

You can edit the title and description here.

Multilingualism

Opens a dialog box in each case where the title can be entered in multiple languages. You can find more information here.

Contents

Subject

Static subject line, language-independent

Here you can specify any static subject line that will be used in every email.

Static subject line, language-dependent

Here you can specify a language-specific static subject line that will be included in every email. The language used for the subject line is the same as the language used for the body of the email. The language is usually determined from the context.

For more information, see the documentation for the Java class "de.uplanet.lucy.server.ContextLanguage".

The language can be overridden using the "language" expert attribute. The value can be either a language code (de or en) or a variable from the processing context that contains a language code.

Multilingualism

Opens a dialog box where a title can be entered in the various portal languages.

System value

Displays the selected system value.

Edit System Value

Opens a dialog box where the system value can be edited.

Data field

With this setting, the subject line is dynamically generated from the values in a data field. Select the desired data field here.

Contents

Page from the application

Select the view page to be sent here. The values from the current data record are used automatically for this purpose. All recipients of the page must be authorized to use the page and read the data record that was sent. If the page does not have the necessary permissions, it will not be sent. You can find information on the topic of rights here.

Edit Parameters

Opens a dialog box where you can edit the parameters required for the page.

Message with static text

This option allows you to compose a fixed text for the email.

Edit text

Opens an editor where the text can be edited.

Generate a message from Velocitycode

This option uses a Velocity script to generate the email text.

Edit Velocity Code

Opens the Velocity Editor, where messages can be generated from the context.

Options

HTML

With this option, the email is sent in HTML. On the page selected in this dialog as the email view page, you can create buttons that load application pages.

Text

With this option, the values in the display and input fields are output in text format, separated by tabs.

Text Message

If this option is selected, all line breaks will be removed. The entire text will be included in the subject line and sent via text message, provided that your telecommunications provider has enabled text messaging.

News headline

Indicates whether a message header is configured or not.

Edit News Headlines

Opens a dialog box where you can configure the header information for the email.

News Headlines

Select the desired header property by clicking in the corresponding cell. You can select predefined properties from the drop-down list that appears.

Once a property has been selected, the values are filtered accordingly, allowing you to easily select the relevant values.

In addition to the predefined properties, you can also create your own properties. To do this, click in the corresponding column and enter the property and value directly.

Clicking "Add Message Header" creates a new line, while "Remove Message Header" removes the selected line.

For some predefined properties, the value "${sender}" can be used. This dynamically populates the email sender field.

Confirm the settings by clicking "OK." If an email is sent afterward, the properties will appear in the email client as well as in the detailed header information.

mailheader.properties

Both the names of the predefined properties and the values that can be selected here are listed in the "mailheader.properties" file. You can find this file in the "client/cfg" installation directory. It may be supplemented or amended.

Dynamic Header Values

Instead of static values, dynamic values—such as those from the shared state of the current processing context—can also be used here. The following prefixes are supported:

            urn:sharedState:
urn:request:
urn:session:
urn:user:
urn:systemDataGroup:

In a specific example, within a Groovy action or filter condition, you could use

            def strValue = g_record["5A1D3EC0DB71BE6B6BC4F83BECCE85ACD22F82E6"].value
g_sharedState.customValue = strValue

A SharedState variable named "customValue" can be defined and assigned a specific value, such as the value from a data field. In a subsequent email operation, the value set in the shared state can be read again.

To do this, use the prefix "urn:sharedState:" mentioned above, followed by the name of the variable "customValue" defined in the Groovy action. When using an entry from a system data group, the value is composed as follows:

            urn:systemDataGroup:APPLICATIONS_GUID:DATAFIELD_GUID

Enter the GUID of the application in which the system data group was created, and the GUID of the data field from the system data group whose value you want to use, for example:

            urn:systemDataGroup:142EB475CEF4B719CE2A8430AFEEAF986BFCB229:8647E7B2E26E98FCBAF32DE2C867B2EF756707DA

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

Click "Next."

Sender

Send from

Current User

With this setting, the current user's email address is retrieved and used as the sender.

Application Administrator

Uses the email address of the user who last saved the application associated with the process.

Static Address

This option allows you to enter any static email address.

Address from data field

Here, you can select a data field as a dynamic sender list.

Default sender from the email service configuration

The default sender is used here.

System Value

This option allows system values to be used as the source of the email address.

Edit System Value

Opens a dialog box where the system value can be edited.

Options

Use an alternative sender address

You can enter an email address here that will be used if a sender address is not specified or is incorrect.

Click "Next."

Recipient, CC Recipient, BCC Recipient

Static Distribution List

Here, you can specify a fixed list of email addresses as a distribution list. The individual addresses must be separated by semicolons.

Dynamic Distribution List

Application, Data Group, Data Field

Select the source for the email addresses here. Text data fields that contain email addresses separated by semicolons can also be used. No other delimiters are allowed.

Edit Filter

Opens a dialog box where the address list can be narrowed down in advance using filter criteria.

Type

There are four options to choose from here:

Address from data field

Unlike the dynamic distribution list, the value from the current record is used here. This setting is available when you are on an entry or view page where a record is loaded or being created.

Data Field

Select the data field that contains the recipients' email addresses.

Type

There are four options to choose from here:

Supervisor / Deputy of the Current User

This setting retrieves the email address of the current user's supervisor or deputy.

System value

This option allows system values to be used as the source of email addresses.

Edit System Value

Opens a dialog box where the system value can be edited.

Options

One email per recipient

With this setting, a separate email is generated for each recipient. This setting cannot be configured for CC and BCC recipients. If this setting is not enabled, all recipients will be listed in the email, separated by semicolons.

If you click "OK" to confirm this dialog box, all settings will be saved and the dialog box will close. This completes the configuration of the email action.

Language

Starting with Intrexx version 12.2.0

This dialog box is used to set the language for the email's subject line and body.

The " Default Language from Current Context " setting is the default setting. Alternatively, you can select a static language or a language from a system value, which you candefine by clicking " " and then "Edit System Value ."

Exception Handling

Once the email campaign has been created and configured, you can open the Properties dialog again by double-clicking the item on the workspace and configure the behavior to follow if no recipients could be identified.

Cancel Transaction (Default)

Causes the entire process to be aborted if no email addresses are available. For example, if a dynamic distribution list of the "Free Text" type has been set as the source for the recipients, but the underlying data field in the current record does not contain any corresponding data, the entire process is terminated with this setting.

Continue the transaction

The error is ignored. No email will be sent. The process continues with the next step.

Zero values

Under certain circumstances, a process may not run without errors even though the "Continue Transaction" option is enabled.

If, for example, the process determines the email recipient using a system value from a system data group, the process may be terminated if there are any zero values—for example, if the recipient data field in the system data group is empty.

Values in the system data group are treated as configuration parameters for applications. In this context, the absence of a specific value is treated as an error. If this is not desired, a Groovy condition or a Groovy action—which passes the list of recipients to the shared state—can be inserted earlier in the process, for example. Such a list may be empty, but it must not contain any zero elements.

The behavior regarding the handling of null values is consistent for all context variables of type

  • URN_REQUEST_PREFIX

  • URN_SESSION_PREFIX

  • URN_SHARED_STATE_PREFIX

  • URN_USER_PREFIX

  • URN_WORKFLOW_USER_PREFIX

  • URN_SYSTEM_DATA_GROUP_PREFIX

The property for resuming the transaction refers to the list of identified recipient addresses. The recipient addresses in this list are collected from the following sources:

  • statically configured receivers

  • Recipient from the request

  • Recipients from the session

  • Recipients from SharedState

  • Recipient from a user field

  • Recipients from the system data group

  • Recipient from a data field in the current record

  • Recipients from a table

  • The current user's supervisor

  • Current User's Alternate

After this list of recipients has been compiled, the system checks to see if it is empty. This property is now used to control how the system handles the case where this list is empty:

  • as an error that causes an exception, or

  • as a warning in the log, without sending an email

More Information

IMAP Event Source - Monitor Folders on an IMAP Mail Server

"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