To add a notification
-
In the Events, recipients and messages area, click Add.
-
In the Notification Settings dialog, in the Select an event, list click the event to notify of.
-
On the Notification Recipients tab, select check boxes to specify the notification recipients.
The email addresses of the recipients you select on the Notification Recipients tab appear in the To field of the notification email messages. To add recipient addresses to the Cc or Bcc field, click Cc Recipients or Bcc Recipients, respectively. This opens a page that is similar to the Notification Recipients tab, allowing you to view or change which recipient addresses will appear in the Cc or Bcc field.
-
On the Notification Delivery tab, select the delivery options you want:
-
Select the Immediate option for the notification message to be sent immediately, on every occurrence of the event.
-
Select the Scheduled option for the notification messages within a certain time period to be grouped and sent as a single message; then, specify the desired period. This option is available only for the Task created event in an Approval activity.
-
On the Notification Message tab, click Modify to view or change the message template, including the subject and the body of the notification message.
-
In case of a Notification activity, choose additional options on the Notification Message tab as needed:
-
Click OK to close the Notification Settings dialog.
For the Task created event in an Approval activity, notification can be configured so that notification messages are grouped together and sent out on a scheduled basis. If you select the Scheduled option on the Notification Delivery tab, the messages within a certain, scheduled period are accumulated in a temporary storage instead of being sent out immediately upon event occurrences. Upon the expiration of that period, all the collected messages are sent out as a single message. You can configure the activity to deliver notification on a daily or hourly schedule.
Clicking Modify on the Notification Message tab opens a window where you can view and modify e-mail notification templates. For each event type, the notification configuration defines a default template based on which Active Roles composes email notification messages. Each template includes XHTML markup along with the text and tokens representing information about the event.
To make notification messages more meaningful to the recipients, notification templates provide the option for the messages to include tokens representing additional information about the event. Click Insert Token to view a list of the available tokens. The list provides a brief description for each token.
You can edit templates in order to customize the contents and format of notification e-mails. The changes to templates are notification-specific and event-specific: When you modify the template for a certain event within the configuration of a certain notification, your changes have no effect on the other notifications or events. This allows different notifications and events to have different, custom notification templates.
To view or change a notification
-
Click an entry in the Events, recipients and messages list, click Edit, and use the Notification Settings dialog as described earlier in this topic.
The address (URL) specified in this area is used to construct hyperlinks in the notification messages so that notification recipients can easily access the Web Interface pages for performing workflow tasks.
To specify the address of the Active Roles Web Interface
-
In the edit box under Active Roles Web Interface, type the address (URL) of the Active Roles Web Interface site (for example, http://<server>/ARServerAdmin).
-
Click Test to verify the address. If the address is correct, this opens the Web Interface site in your web browser.
The settings specified in this area determine the server to use for notification delivery.
To configure email server settings
-
In the E-mail server settings area, click Properties.
-
Use the Properties dialog to view or change the email server settings.
To select a different email server configuration
To create an e-mail server configuration
-
In the Active Roles Console tree, expand Configuration > Server Configuration, right-click Mail Configuration, and select New > Mail Configuration.
When configuring a Script activity, you select the Script Module that contains the script to be used by the activity, and then, from the functions held in that script, you choose the function to be run by the activity and, optionally, the function that declares the activity parameters. If any parameters are declared, then you need to supply parameter values.
To configure a Script activity
-
In the Active Roles Console tree, expand Configuration > Policies > Workflow, and select the workflow containing the Script activity you want to configure.
This opens the Workflow Designer in the Details pane, representing the workflow definition as a process diagram.
-
In the process diagram, right-click the name of the activity and click Properties.
-
Navigate to the General tab in the Script Activity Properties dialog.
-
Do one of the following:
-
If the activity has no Script Module selected (for example, the activity has just been added to the process diagram), click Browse and select the Script Module containing the script you want the activity to use.
-
If the activity already has a Script Module selected and you want to use a different Script Module, click Browse to select the Script Module you want.
-
In the Function to run box, view the name of the script function that will be run by this activity. You can choose the appropriate function from the Function to run list.
The list contains the names of all script functions found in the selected Script Module. The activity runs the function specified in the Function to run box.
-
In Function to declare parameters box, view the name of the function that defines the activity parameters. Click Specify Parameters, and then do the following:
-
If necessary, from the Function to declare parameters list, choose the function that defines the parameters specific to this activity.
The list contains the names of all script functions found in the selected Script Module. The activity has the parameters that are defined by the function specified in the Function to declare parameters box. Normally, this is a function named onInit.
-
Under Parameter values, view or change the values of the activity parameters. To change the value of a parameter, select the name of the parameter and click Edit.
Clicking Edit displays a page where you can add, remove, or select a value or values for the selected parameter. For each parameter, the function that is used to declare parameters defines the name of the parameter and other characteristics, such as a description, a list of possible values, the default value, and whether a value is required. If a list of possible values is defined, then you can only select values from that list.
-
(Optional) Navigate to the Notification tab in the Script Activity Properties dialog, and use the steps for Configuring a Notification activity to subscribe recipients to the notifications of the following events:
-
Activity completed successfully: When configured to notify of this event, the activity causes Active Roles to send a notification email if no significant errors occurred during the run of this activity.
-
Activity encountered an error: When configured to notify of this event, the activity causes Active Roles to send a notification email if any significant errors occurred during the run of this activity.
-
(Optional) Navigate to the Error handling tab in the Script Activity Properties dialog, and select or clear the Continue workflow even if this activity encounters an error check box to specify whether you want Active Roles to suppress errors encountered by this Script activity.
If this check box is not selected (default setting), then an error condition encountered by the activity causes Active Roles to stop the workflow. If you select this check box, the workflow continues regardless of whether or not the activity encounters an error condition.