Chat now with support
Chat with Support

Active Roles 8.2.1 - Administration Guide

Introduction Getting started with Active Roles Configuring rule-based administrative views Configuring role-based administration Configuring rule-based autoprovisioning and deprovisioning
Configuring Provisioning Policy Objects
User Logon Name Generation E-mail Alias Generation Exchange Mailbox AutoProvisioning Group Membership AutoProvisioning Home Folder AutoProvisioning Property Generation and Validation Script Execution O365 and Azure Tenant Selection AutoProvisioning in SaaS products
Configuring Deprovisioning Policy Objects
User Account Deprovisioning Group Membership Removal User Account Relocation Exchange Mailbox Deprovisioning Home Folder Deprovisioning User Account Permanent Deletion Office 365 Licenses Retention Group Object Deprovisioning Group Object Relocation Group Object Permanent Deletion Script Execution Notification Distribution Report Distribution
Configuring entry types Configuring a Container Deletion Prevention policy Configuring picture management rules Managing Policy Objects Checking for policy compliance Deprovisioning users or groups Restoring deprovisioned users or groups Configuring policy extensions
Using rule-based and role-based tools for granular administration Workflows
About workflow processes Workflow processing overview Workflow activities overview Configuring a workflow
Creating a workflow definition for a workflow Configuring workflow start conditions Configuring workflow parameters Adding activities to a workflow Configuring an Approval activity Configuring a Notification activity Configuring a Script activity Configuring an If-Else activity Configuring a Stop/Break activity Configuring an Add Report Section activity Configuring a Search activity Configuring CRUD activities Configuring a Save Object Properties activity Configuring a Modify Requested Changes activity Enabling or disabling an activity Enabling or disabling a workflow Using the initialization script
Approval workflow Email-based approval Automation workflow Activity extensions
Temporal Group Memberships Group Family Dynamic groups Active Roles Reporting Management History Entitlement profile Recycle Bin AD LDS data management One Identity Starling Join and configuration through Active Roles Managing One Identity Starling Connect Configuring linked mailboxes with Exchange Resource Forest Management Configuring remote mailboxes for on-premises users Migrating Active Roles configuration with the Configuration Transfer Wizard Managing Skype for Business Server with Active Roles
About Skype for Business Server User Management Active Directory topologies supported by Skype for Business Server User Management User Management policy for Skype for Business Server User Management Master Account Management policy for Skype for Business Server User Management Access Templates for Skype for Business Server Configuring the Skype for Business Server User Management feature Managing Skype for Business Server users
Exchanging provisioning information with Active Roles SPML Provider Monitoring Active Roles with Management Pack for SCOM Configuring Active Roles for AWS Managed Microsoft AD Azure AD, Microsoft 365, and Exchange Online Management
Azure tenant types and environment types supported by Active Roles Using Active Roles to manage Azure AD objects Unified provisioning policy for Azure M365 Tenant Selection, Microsoft 365 License Selection, Microsoft 365 Roles Selection, and OneDrive provisioning Changes to Active Roles policies for cloud-only Azure objects
Managing the configuration of Active Roles
Connecting to the Administration Service Managed domains Using unmanaged domains Evaluating product usage Creating and using virtual attributes Examining client sessions Monitoring performance Customizing the Console Using Configuration Center Changing the Active Roles Admin account Enabling or disabling diagnostic logs Active Roles Log Viewer
SQL Server replication Using regular expressions Administrative Template Configuring federated authentication Communication ports and URLs used by Active Roles Integrating Active Roles with other products and services Active Roles Language Pack Active Roles Diagnostic Tools Active Roles Add-on Manager

Events, recipients, messages

To add a notification

  1. In the Events, recipients and messages area, click Add.

  2. In the Notification Settings dialog, in the Select an event, list click the event to notify of.

  3. 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.

  4. 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.

  5. On the Notification Message tab, click Modify to view or change the message template, including the subject and the body of the notification message.

  6. In case of a Notification activity, choose additional options on the Notification Message tab as needed:

    • If you want the notification message to include the Change History report (in case of a change workflow) or Run History report (in case of an automation workflow), select the Attach a report of workflow execution to notification message check box.

    • For the activity to send plain-text notification messages, select the Format notification message as plain text check box. Otherwise, the activity sends notification messages in HTML format.

  7. 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.

To delete a notification

  • Click an entry in the Events, recipients, and messages list, and then click Remove.

Active Roles Web Interface URL in Notifications

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

  1. 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).

  2. Click Test to verify the address. If the address is correct, this opens the Web Interface site in your web browser.

Email server settings

The settings specified in this area determine the server to use for notification delivery.

To configure email server settings

  1. In the E-mail server settings area, click Properties.

  2. Use the Properties dialog to view or change the email server settings.

To select a different email server configuration

  • Click the name of the desired configuration in the Configuration of the outgoing mail server list.

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.

Configuring a Script activity

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

  1. 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.

  2. In the process diagram, right-click the name of the activity and click Properties.

  3. Navigate to the General tab in the Script Activity Properties dialog.

  4. 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.

  5. 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.

  6. 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.

  7. (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.

  8. (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.

Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating