Chat now with support
Chat with Support

Active Roles 7.6.2 - Administration Guide

Introduction About Active Roles Getting Started Rule-based Administrative Views Role-based Administration
Access Templates as administrative roles Access Template management tasks Examples of use Deployment considerations Windows claims-based Access Rules
Rule-based AutoProvisioning and Deprovisioning
About Policy Objects Policy Object management tasks Policy configuration tasks
Property Generation and Validation User Logon Name Generation Group Membership AutoProvisioning E-mail Alias Generation Exchange Mailbox AutoProvisioning AutoProvisioning for SaaS products OneDrive Provisioning Home Folder AutoProvisioning Script Execution Office 365 and Azure Tenant Selection User Account Deprovisioning Office 365 Licenses Retention Group Membership Removal Exchange Mailbox Deprovisioning Home Folder Deprovisioning User Account Relocation User Account Permanent Deletion Group Object Deprovisioning Group Object Relocation Group Object Permanent Deletion Notification Distribution Report Distribution
Deployment considerations Checking for policy compliance Deprovisioning users or groups Restoring deprovisioned users or groups Container Deletion Prevention policy Picture management rules Policy extensions
Workflows
Understanding workflow Workflow activities overview Configuring a workflow
Creating a workflow definition 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
Example: Approval workflow E-mail based approval Automation workflow Activity extensions
Temporal Group Memberships Group Family Dynamic Groups Active Roles Reporting Management History
Understanding Management History Management History configuration Viewing change history
Workflow activity report sections Policy report items Active Roles internal policy report items
Examining user activity
Entitlement Profile Recycle Bin AD LDS Data Management One Identity Starling Management Managing One Identity Starling Connect Configuring linked mailboxes with Exchange Resource Forest Management Configuring remote mailboxes for on-premises users Azure AD, Office 365, and Exchange Online management
Configuring Active Roles to manage hybrid AD objects Managing Hybrid AD Users Unified provisioning policy for Azure O365 Tenant Selection, Office 365 License Selection, and Office 365 Roles Selection, and OneDrive provisioning Office 365 roles management for hybrid environment users Managing Office 365 Contacts Managing Hybrid AD Groups Managing Office 365 Groups Managing Azure Security Groups Managing cloud-only distribution groups Managing cloud-only Azure users Managing cloud-only Azure guest users Managing cloud-only Azure contacts Changes to Active Roles policies for cloud-only Azure objects Managing room mailboxes Managing cloud-only shared mailboxes
Managing Configuration of Active Roles
Connecting to the Administration Service Adding and removing 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 Appendix A: Using regular expressions Appendix B: Administrative Template Appendix C: Communication ports Appendix D: Active Roles and supported Azure environments Appendix E: Active Roles integration with other One Identity and Quest products Appendix F: Active Roles integration with Duo Appendix G: Active Roles integration with Okta

Events, recipients and messages

To add a notification

  1. In the Events, recipients and messages area, click Add.
  2. In the Notification Settings dialog box, 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 e-mail addresses of the recipients you select on the Notification Recipients tab appear in the To field of the notification e-mail messages. To add recipient addresses to the Cc or Bcc field, click the Cc Recipients or Bcc Recipients button, 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.

  1. 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.
  2. On the Notification Message tab, click Modify to view or change the message template, including the subject and the body of the notification message.
  3. 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.
  4. Click OK to close the Notification Settings dialog box.

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 e-mail 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 the Insert Token button 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 box 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

Active Roles Web Interface

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.

E-mail server settings

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

To configure e-mail server settings

  1. In the E-mail server settings area, click Properties.
  2. Use the Properties dialog box to view or change the e-mail server settings.

To select a different e-mail 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. For information and instructions on how to create a script for a Script activity, refer to Active Roles SDK documentation.

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 window in the details pane, representing the workflow definition as a process diagram.

  1. In the process diagram, right-click the name of the activity and click Properties.
  2. Go to the General tab in the Script Activity Properties dialog box.
  3. 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 the Browse button to select the Script Module you want.
  4. 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.

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

  2. (Optional) Go to the Notification tab in the Script Activity Properties dialog box, 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 e-mail if no significant errors occurred during execution of this activity.
    • Activity encountered an error.  When configured to notify of this event, the activity causes Active Roles to send a notification e-mail if any significant errors occurred during execution of this activity.
  3. (Optional) Go to the Error handling tab in the Script Activity Properties dialog box, 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 terminate 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