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

Additional settings

The additional settings specify whether to terminate the workflow if it runs longer that a certain time period. Click the Additional settings link on the Workflow Options and Start Conditions page to view or change the following setting:

  • Terminate the workflow if it runs longer than: <time period>

This setting allows you to limit the amount of time the workflow is allowed to run. Use this setting to limit the automation workflow that might take a long period of time to execute, causing an inconvenience to the user.

Parameters

When you configure workflow options and start conditions for an automation workflow, you can set up workflow parameters and assign values to workflow parameters. Parameter values are used by the workflow activities when the workflow is running. An activity may retrieve the value of the desired parameter and perform the action depending upon the parameter value.

By default, the workflow does not have any parameters defined. You can add, modify (edit) or remove parameter definitions on the Parameters page. Once the definition of a parameter has been added to the workflow, you can:

  • Assign a value to the parameter.  To do this, select the parameter from the list on the Parameters page and click the View or change parameter value button. The value assigned to the parameter is stored in the workflow definition. The workflow activities can retrieve the parameter value from the workflow definition when the workflow is running.
  • Configure the parameter so that the user can set the parameter value when starting the workflow on demand.  To do this, select the parameter from the list on the Parameters page, click the Edit button, and then clear the Don’t show this parameter when starting the workflow on demand check box. Active Roles will prompt the user to set the parameter value when the user starts the workflow on demand. The parameter value supplied by the user will only be used during the current run of the workflow.
  • View or change various properties of the parameter. To do this, select the parameter from the list in the Parameters page, click the Edit button, and then use the options in the Parameter Definition dialog box.

Each parameter has a number of properties that define it, including the parameter name, parameter description, syntax of parameter values, a list of acceptable parameter values, whether the parameter accepts a single value or multiple values, and whether the parameter must have a value. The acceptable values can be determined either by a static list of values or by using a script. In the latter case, the script calculates the list of the acceptable values each time the workflow is started. A script can also be used to assign a value to the parameter. The script calculates the value each time the workflow is started.

For further information about workflow parameters, see Configuring workflow parameters earlier in this document.

Initialization script

When you configure an automation workflow, you can specify PowerShell commands you want the workflow run-time engine to execute immediately after creation of the PowerShell operating environment for the script activities held in that workflow. These commands constitute the initialization script that the workflow engine runs prior to performing script activities.

With the initialization script, you can:

  • Load PowerShell modules and snap-ins. All activity scripts can use the modules and snap-ins loaded in the initialization script, without having to load the prerequisite modules or snap-ins on a per-activity basis.
  • Initialize environment-specific variables, referred to as global variables. All activity script can retrieve and update global variables, which makes it possible to exchange data between different activity scripts.

For further information, see Using the initialization script earlier in this document.

Using automation workflow

This section contains information and step-by-step instructions that explain how to use the Active Roles user interface to manage automation workflows. The following topics are covered:

Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating