Chat now with support
Chat with Support

Active Roles 7.6.3 - 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 Using regular expressions Administrative Template Communication ports Active Roles and supported Azure environments Active Roles integration with other One Identity and Quest products Active Roles integration with Duo Active Roles integration with Okta Active Roles Diagnostic Tools Active Roles Add-on Manager

Configuring “run-as” options

By default, CRUD activities are executed under the user account specified by the “run as” setting in the workflow options and start conditions. This could be the service account of the Active Roles Administration Service or the account of the user who caused the workflow to start. You can configure the activity to override the default “run as” setting.

To configure “run as” options for a CRUD activity

  1. In the process diagram, right-click the name of the activity and click Properties.
  2. Click the “Run as” options hyperlink at the bottom of the Properties dialog box.
  3. To override the default “run as” setting for this activity, select the Run this activity under check box, and then choose the account under which you want the activity to run:
    • Click The service account of Active Roles if you want this activity to run under the service account of the Active Roles Administration Service.
    • Click The account of the user who started the workflow if you want this activity to run under the account of the user who caused the workflow to start. Depending on the type of the workflow, this is either the user who requested the operation that started the workflow or the user who started the workflow on demand.

    The account under which the activity is running determines the access rights of the activity in the directory.

  1. View or change the settings under the Approval enforcement option heading.

The Approval enforcement option settings determine whether to apply approval rules to the operation requested by the activity if the activity is executed under a privileged account, such as the Active Roles service account, an Active Roles Admin account, or the account of the user who is designated as an approver. The following settings are available:

  • Inherit from the workflow options and start conditions  Select this option if you want the activity to use the approval enforcement option selected in the workflow options and start conditions.
  • Use the following option for this activity  Click this option and then select or clear the Enforce approval check box if you want this activity to override the approval enforcement option selected in the workflow options and start conditions.

    When selected, the Enforce approval check box causes the approval rules to be applied, submitting the operation for approval regardless of the account under which the activity is executed. Otherwise, the operation requested by the activity bypasses approval rules if the activity is executed under the Active Roles service account, an Active Roles Admin account, or the account of the user who is designated as an approver, so the operation is not submitted for approval.

Configuring additional settings

By using additional settings, you can override the default operation reason text, and add so-called request controls to modify behavior of the activity.

To configure additional settings for a CRUD activity

  1. In the process diagram, right-click the name of the activity and click Properties.
  2. Click the Additional settings link at the bottom of the Properties dialog box.
  3. In the Additional Settings dialog box, view or change the following 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.
    • Select Use this text instead of the original operation reason text. check box and type the appropriate reason text to replace the original reason text. Select the Use only if the operation reason is not originally specified check box if you want the activity to use your 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 check box should normally be cleared to prevent recurrent execution of the activity in the situation where the operation requested by that activity within a given workflow matches the start conditions of that same workflow. Selecting this check box may 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. For information about request controls, see Active Roles SDK.

    To add or change a control, click Add or Change, and then, in the dialog box that opens, specify the name and, if applicable, the value of the control. If you want the activity to add the control to the requests, click Include this control in the activity operation requests. If you want to ensure that the control never occurs in the requests created by this activity, click Exclude this control from the activity operation requests.

Configuring a Save Object Properties activity

When you configure a Save Object Properties activity, you can specify the rules for selecting the object whose properties you want the activity to save, and list the properties for the activity to save. Additional options are available, such as notification and error handling.

To configure a Save Object Properties activity

  1. In the Active Roles console tree, expand Configuration | Policies | Workflow, and select the workflow containing the Save Object Properties 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 Activity target tab in the “Save Object Properties” Activity Properties dialog box.
  3. Click in the Activity saves properties of this object box to specify the object whose properties you want the activity to save. This object is referred to as activity target. You can choose from the following options to specify the activity target:
    • Workflow target object.  In a change workflow, the activity target is 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.  The activity target is a particular object you select from Active Directory.
    • Object identified by workflow parameter.  The activity target is the object specified by the value of a certain parameter of the workflow. You can choose the desired parameter from the workflow definition.
    • Object from workflow data context.  The activity target will be selected by the activity on the basis of the data found in the workflow environment at the time of executing the workflow. You can specify which object you want the activity to select at workflow execution time.
    • Object identified by DN-value rule expression.  The Distinguished Name (DN) of the activity target 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 executing the workflow. You can create the desired rule expression when you configure the activity.
  4. Go to the Target properties tab in the “Save Object Properties” Activity Properties dialog box.
  5. Configure the list of the properties you want the activity to save:
    • To add a property to the list, click Add, and then select the name of the desired property.
    • To remove a property from the list, click the name of the property in the list, and then click Remove.

The Workflow Designer provides a default list of properties. You can remove all properties from the list by clicking Clear list or revert to the default list by clicking Restore default.

  1. Go to the Notification tab in the “Save Object Properties” Activity Properties dialog box to view or change notification settings. For instructions, see Configuring notification.
  2. Go to the Error handling tab in the “Save Object Properties” Activity Properties dialog box to view or change error handling settings. For instructions, see Configuring error handling.

Configuring a Modify Requested Changes activity

When you configure a Modify Requested Changes activity, you can define the property changes to add or remove from the change request. 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. Additional options are available such as notification, error handling, changing the container where to create new objects, and adding or removing Active Roles controls from change requests.

To configure a Modify Requested Changes activity

  1. In the Active Roles console tree, expand Configuration | Policies | Workflow, and select the change workflow containing the Modify Requested Changes 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 Target changes tab in the “Modify Requested Changes” Activity Properties dialog box.
  3. Configure the list of the properties you want the activity to modify:
    • To add a property to the list, click Add property, and then select the desired property.
    • To remove a property from the list, click the Delete button labeled X on the right side of the list item representing that property.
  4. After you have added a property, click in the Action field to specify the type of the changes you want the activity to make to that property:
    • Click Set to have the activity assign a new value to the property.
    • Click Clear to have the activity remove the property from the object.
    • In case of a multi-value property, click Add value or Remove value for the activity to add or remove the value of the property.
    • Click Remove from request if you want the workflow not to apply the changes to the property that were specified in the request that started the workflow.
  5. If an action other than Clear or Remove from request is selected, click in the Value filed to specify the property value you want the activity to set, add or remove. The following options are available:
    • Text string.  Use the given string of characters as the value of the property. You can type the desired 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 desired 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 desired 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 desired property from a list of object properties.
    • Workflow parameter value.  Use the value of a certain parameter of the workflow. You can choose the desired 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 desired 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. You can configure a rule expression to compose a string value based on properties of various objects found in the workflow run-time environment.
  6. Go to the Notification tab in the “Modify Requested Changes” Activity Properties dialog box to view or change notification settings. For instructions, see Configuring notification.
  7. Go to the Error handling tab in the “Modify Requested Changes” Activity Properties dialog box to view or change error handling settings. For instructions, see Configuring error handling.
  8. Click the Additional settings link at the bottom of the “Modify Requested Changes” Activity Properties dialog box.
  9. In the Additional Settings dialog box that appears, you can configure the activity to:
      • Change the container where to create new objects. Click in the Modify object creation requests so as to create objects in this container box, and then choose from the following options:
        • Fixed container in directory.  With this option, objects will be created in the given OU or container. You can select the desired OU or container in Active Directory when you configure the activity.
        • Parent OU of workflow target object.  With this option, objects are created in the OU that holds the target object of the request that started the workflow.
        • Activity target object.  With this option, objects are created in the OU or container created or otherwise processed by a particular CRUD activity at the time of executing the workflow. You can select the desired CRUD activity from the workflow definition when you configure the activity.
        • Object identified by workflow parameter.  With this option, objects are created in the OU or container specified by the value of a certain parameter of the workflow. You can choose the desired parameter from the workflow definition when you configure the activity.
        • Object from workflow data context.  With this option, objects are created in the OU or container that will be selected by the activity on the basis of the data found in the workflow environment at the time of executing the workflow. You can specify which OU or container you want the activity to select.
        • Object identified by DN-value rule expression.  With this option, objects are created in the OU or container 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 executing the workflow. You can create the desired rule expression when you configure the activity.
    • Add or remove Active Roles controls from the request. To add or change a control, click Add or Change, and then, in the dialog box that appears, specify the name and, if applicable, the value of the control. If you want the activity to add the control to the request, click Include this control in the change request. If you want to ensure that the control never occurs in the request, click Exclude this control from the change request.

    Controls can be used to pass additional information to Active Roles on how to process the request. See Active Roles SDK for information about controls.

Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating