Users of Process Portal can
set their preferences to receive an email notification when a new
task is assigned to them. To exploit this functionality, you need
to enable your email environment to send notifications.
Before you begin
Ensure that your Simple Mail Transfer Protocol (SMTP) server
is configured. For more information, see Configuring the SMTP server.
Verify
that the following components are stopped:
- Process Center server
- Process Server
About this task
The entries in the email properties section in the
99Local.xml configuration
file define the properties for your email environment.
Important: Make all required modifications to the 100Custom.xml file.
Do not edit the 99Local.xml file.
Procedure
- Open the 99Local.xml file and locate
the email properties section.
- Open the 100Custom.xml file, and copy
and paste the email properties section into the 100Custom.xml file.
- Insert the values that are appropriate for your environment
in the <email> element.
- <default-from-address> element: Ensure that
the value of this element is a valid email address.
- <client link> element: Include the URL for
your Process Portal server
in this element. Ensure that the value has the following format:
http://host_name:port_number/teamworks
This
element is used to form the link to the Process Portal page
in the email notification.Tip: To avoid "Server not found
errors" when process participants click links in email notifications,
specify the fully qualified host name of your Process Portal server
in the <client-link> element.
- <send-email-notifications-to-list> element:
By default, separate email is sent to each user that is assigned to
the task and is registered for email notifications. To avoid lock
time-outs when there are many users registered for notifications,
change the value to true so that users receive notification
email grouped by locale.
- <send-email-notifications-async> element:
By default, notification email is sent synchronously with the navigation
transaction of the business process definition (BPD). To avoid lock
time-outs when there are many users registered for notifications,
change the value to true so that notification email
is sent asychrounously in a separate thread.
- Save your changes.
- Start Process Center server
and Process Server.
Example of an email properties section
The
following example shows the values that you need to set for the
<email> element
in the
100Custom.xml file.
<server merge="mergeChildren">
<email merge="mergeChildren">
<!-- SMTP server that mail should be sent to -->
<smtp-server merge="replace">smtp.example.com</smtp-server>
<mail-template merge="mergeChildren">
<client-link merge="replace">http://hostname.example.com:9080/teamworks</client-link>
</mail-template>
<valid-from-required merge="replace">true</valid-from-required>
<default-from-address merge="replace">username@example.com</default-from-address>
<send-external-email merge="replace">true</send-external-email>
<send-email-notifications-to-list>false</send-email-notifications-to-list>
<send-email-notifications-async>false</send-email-notifications-async>
</email>
</server>
What to do next
To receive email notifications, process participants must
update their user preferences to include their email address and enable
the email notification option.