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

Additional settings – CRUD activities

A CRUD activity has the following additional configuration options:

  • Use this text instead of the original operation reason text: If the operation requested by the CRUD activity is subject to approval, you can specify the operation reason text to be shown to the approver instead of the reason text specified in the operation request that started the workflow. The Use only if the operation reason is not originally specified sub-option configures the activity to replace the reason text only if the operation request that started the workflow does not have any reason text specified.

  • Allow the request created by this activity to start a new instance of the workflow containing this activity: This option is normally disabled to prevent recurrent execution of the CRUD activity in the situation where the operation requested by that activity within a given workflow matches the start conditions of that same workflow. Enabling this option could result in a loop of workflow instances executing the same activity again and again, and eventually would cause an overflow condition.

  • Exclude or include request controls from the activity operation request: Request controls are certain pieces of data in an operation request that can be used to pass additional information to Active Roles on how to process the request. Request controls are optional. If no request controls are added to a request, then Active Roles determines how to process the request based solely on the type of the request. You can configure the activity to add certain controls to its operation requests (include request controls) or to ensure that certain controls never occur in the activity operation requests (exclude request controls). For information about Active Roles request controls, see the Active Roles SDK documentation.

Save Object Properties activity

The Save Object Properties activity is used to save properties of a particular object at workflow execution time. The properties are saved in the workflow data context, and can be retrieved by other activities before or after the object has changed. This capability is instrumental in situations that require knowing not only the changed object state or properties but also the previous or old values of certain properties. Old values may be required to determine the previous state of an object in order to make some decision or perform a certain action based on those values. For example, to notify of object deletions, you can create a workflow that starts when deletion of an object is requested, saves the object’s name, and then, after the object is deleted, sends a notification message that includes the saved name of the deleted object.

This activity has the following configuration options:

  • Activity target: This option lets you specify the object whose properties you want the activity to save. You can choose to specify:

    • Workflow target object: In a change workflow, the target object of the request that started the workflow. For example, in a workflow that starts upon a deletion request, this choice causes the activity to save the properties of the object whose deletion is requested.

    • Fixed object in directory: A particular object you select from Active Directory.

    • Object identified by workflow parameter: The object specified by the value of a certain parameter of the workflow. You can choose the parameter from the workflow definition.

    • Object from workflow data context: The object will be selected by the activity on the basis of the data found in the workflow environment at the time of running the workflow. You can specify which object you want the activity to select at the time of running the workflow.

    • Object identified by DN-value rule expression: The object whose Distinguished Name (DN) is specified by the string value of a certain rule expression. By using a rule expression, you can compose a string value based on properties of various objects found in the workflow environment at the time of running the workflow. You can create the rule expression when you configure the activity.

  • Target properties: This option lets you specify the object properties you want the activity to save. The Workflow Designer proposes the default list of properties, and allows you to change the list as needed. By default, the activity saves all single-value non-constructed attributes found in the directory schema for the target object, including custom virtual attributes added to the directory schema by Active Roles.

  • Notification: You can configure the 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.

    The notification settings specify the notification events and recipients. When run by the workflow, the activity prepares a notification message appropriate to the specified event. Active Roles retains the message prepared by the activity, and sends the message to the specified recipients once that event occurs. The notification settings are similar to the notification settings of a Notification activity. For more information, see Notification activity.

  • Error handling: You can choose whether to suppress errors encountered by the activity. The following option is available: Continue workflow even if this activity encounters an error. If this option is not selected (default setting), then an error condition encountered by the activity causes Active Roles to terminate the workflow. If you select this option, the workflow continues regardless of whether or not the activity encounters an error condition.

Retrieving saved properties

In a workflow that includes an activity of the Save Object Properties type, you can configure other activities to retrieve object properties saved by that activity:

  • By using the following expression in a Script activity: $workflow.SavedObjectProperties("activityName").get("attributeName")

    In this expression, activityName stands for the name of the Save Object Properties activity and attributeName is the LDAP display name of the attribute representing the property you want the script to retrieve. You must specify an attribute listed in the Target properties setting of the Save Object PropertiesSave Object Properties activity; otherwise, this expression returns no property value when running the workflow.

  • By adding the Workflow - Saved Object Properties token to the notification message template. For more information, see Events, recipients, messages.

  • To add the token:

    1. In the Insert Token dialog, click Workflow - Saved Object Properties in the list of tokens, and then click OK.

    2. In the dialog that appears, select the name of the Save Object Properties activity and the saved property you want the token to retrieve.

      You must select a property listed in the Target properties setting of the Save Object Properties activity; otherwise, the token you have configured returns no property value when running the workflow.

  • By choosing the Property of object from workflow data context configuration option, available in If-Else branch conditions, Search filter, Create activity, Update activity, and Add Report Section activity (see also Configuring an Add Report Section activity).

  • If you choose this option, then you need to perform the following configuration steps:

    1. In the Object Property dialog, click the link in the Target object field, and then click More choices.

    2. In the dialog that appears, click Saved Object Properties in the left pane, select the name of the Save Object Properties activity from the Activity list, and then click OK.

    3. In the Object Property dialog, click the link in the Target property field, and select the property you want.

      You must select a property listed in the Target properties setting of the Save Object Properties activity; otherwise, the entry you have configured returns no property value when running the workflow.

Modify Requested Changes activity

The Modify Requested Changes activity is intended to update the change request that started the workflow, allowing you to add or remove changes to the properties of the workflow target object at workflow execution time. For example, in a workflow that starts when the creation of an object is requested, you can use this activity to modify the properties that are going to be assigned to the new object, or change the container in which to create the object. In a workflow that starts upon a request to change an object, you can use this activity to modify the requested changes to the properties of that object.

This activity has the following configuration options:

  • Target changes: You can define the property changes to add or remove from the change request. When you configure this activity, you can choose the properties you want the activity to change and, for each property, choose to remove the property from the request, clear the property value in the request, or specify the new value to be assigned to that property. For a multi-value property, you can choose to add or remove a value from that property. The following options are available:

    • Text string: Use the given string of characters as the value of the property. You can type the string.

    • Property of workflow target object: Use the value of a certain property of the target object of the request that started the workflow. You can select the property from a list of object properties.

    • Property of workflow initiator: Use the value of a certain property of the user whose request started the workflow. You can select the property from a list of object properties.

    • Changed value of workflow target object property: Use the value that is requested to be assigned to a certain property of the workflow target object. You can select the property from a list of object properties.

    • Workflow parameter value: Use the value of a certain parameter of the workflow. You can choose the parameter from a list of the workflow parameters.

    • Property of object from workflow data context: Use the value of a certain property of the object that will be selected by the activity on the basis of the data found in the workflow run-time environment. You can choose the property and specify which object you want the activity to select at workflow run time.

    • Value generated by rule expression: Use the string value of a certain rule expression. By using a rule expression, you can compose a string value based on properties of various objects found in the workflow run-time environment. You can create the rule expression when you configure the activity.

  • Notification: You can configure the 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.

    The notification settings specify the notification event and recipients. When run by the workflow, the activity prepares a notification message appropriate to the specified event. Active Roles retains the message prepared by the activity, and sends the message to the specified recipients upon occurrence of that event. The notification settings are similar to the notification settings of a Notification activity. For more information, see Notification activity.

  • Error handling: You can choose whether to suppress errors encountered by the activity. The following option is available: Continue workflow even if this activity encounters an error. If this option is not selected (default setting), then an error condition encountered by the activity causes Active Roles to stop the workflow. If you select this option, the workflow continues regardless of whether or not the encounters an error condition.

  • Additional settings: You can configure the activity to:

    • Change the container where to create new objects while ensuring that the policies and workflows are applied from the container where the object will actually be created rather than from the container that was originally specified in the object creation request.

    • Add or remove Active Roles controls from the request.

    Controls are certain pieces of data that can be used to provide additional information to Active Roles on how to process the request. If no controls are added to a request, then Active Roles determines how to process the request based solely on the type of the request. You can configure the activity to add certain controls to the request (include controls) or to ensure that certain controls never occur in the request (exclude controls). For information about Active Roles controls, see the Active Roles SDK documentation.

NOTE: The Modify Requested Changes activity type is unavailable in case of an automation workflow. You can add activities of this type to a change workflow only.

Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating