Chat now with support
Chat with Support

Active Roles 8.1.1 - Administration Guide

Introduction 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
Provisioning Policy Objects Deprovisioning Policy Objects How Policy Objects work Policy Object management tasks Policy configuration tasks
Property Generation and Validation User Logon Name Generation Group Membership AutoProvisioning Exchange Mailbox AutoProvisioning AutoProvisioning in SaaS products OneDrive Provisioning Home Folder AutoProvisioning Script Execution Microsoft 365 and Azure Tenant Selection E-mail Alias Generation 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
Using rule-based and role-based tools for granular administration Workflows
Key workflow features and definitions 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 Configure 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 Azure AD, Microsoft 365, and Exchange Online Management
Configuring Active Roles to manage Hybrid AD objects Managing Hybrid AD users
Creating a new Azure AD user with the Web Interface Viewing or updating the Azure AD user properties with the Web Interface Viewing or modifying the manager of a hybrid Azure user Disabling an Azure AD user Enabling an Azure AD user Deprovisioning of an Azure AD user Undo deprovisioning of an Azure AD user Adding an Azure AD user to a group Removing an Azure AD user from a group View the change history and user activity for an Azure AD user Deleting an Azure AD user with the Web Interface Creating a new hybrid Azure user with the Active Roles Web Interface Converting an on-premises user with an Exchange mailbox to a hybrid Azure user Licensing a hybrid Azure user for an Exchange Online mailbox Viewing or modifying the Exchange Online properties of a hybrid Azure user Creating a new Azure AD user with Management Shell Updating the Azure AD user properties with the Management Shell Viewing the Azure AD user properties with the Management Shell Delete an Azure AD user with the Management Shell Assigning Microsoft 365 licenses to new hybrid users Assigning Microsoft 365 licenses to existing hybrid users Modifying or removing Microsoft 365 licenses assigned to hybrid users Updating Microsoft 365 licenses display names
Unified provisioning policy for Azure M365 Tenant Selection, Microsoft 365 License Selection, Microsoft 365 Roles Selection, and OneDrive provisioning Microsoft 365 roles management for hybrid environment users Managing Microsoft 365 contacts Managing Hybrid AD groups Managing Microsoft 365 Groups Managing cloud-only distribution groups Managing cloud-only dynamic distribution groups Managing Azure security 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
Modern Authentication 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 Communication ports Active Roles and supported Azure environments Integrating Active Roles with other products and services Active Roles Language Pack Active Roles Diagnostic Tools Active Roles Add-on Manager

Design elements for activity extension

The extensibility of workflow activity types is designed around two interactions: activity type deployment and activity type usage.

Activity type deployment

The deployment process involves the development of a script that implements the workflow action and declares the activity parameters the creation of a Script Module containing that script and the creation of a Policy Type object referring to that Script Module. To deploy an activity type to a different environment, you can export the activity type to an export file in the source environment and then import the file in the destination environment. The use of export files makes it easy to distribute custom activity types.

Activity type usage

This is the process of configuring workflow activities. It occurs whenever you add an activity to a workflow in the Workflow Designer. To add an activity to a workflow, you drag the desired activity type from the toolbox onto the workflow process diagram. The toolbox, located on the left of the diagram, lists all the activity types defined in Active Roles, including the custom activity types. For each activity of a custom type the Workflow Designer provides a page for configuring the activity parameters specific to that activity type. Once the activity parameters have been configured, the workflow contains a fully functional activity of the selected custom type.

Active Roles provides a graphical user interface, complete with a programming interface, for creating and managing custom activity types. Using those interfaces, Active Roles workflows can be extended to meet the needs of a particular environment. Active Roles also has a deployment mechanism by which administrators put new types of workflow activity into operation.

Since workflow activity extension involves two interactions, Active Roles provides solutions in both areas. The Administration Service maintains activity type definitions, exposing activity types to its clients such as the Active Roles Console or ADSI Provider. The Console can be used to:

  • Create a new custom activity type, either from scratch or by importing an activity type that was exported from another environment.

  • Make changes to the definition of an existing custom activity type.

  • Add an activity of a particular custom type to a workflow, making the necessary changes to the activity parameters provided by the activity type definition.

Normally, an Active Roles expert develops a custom activity type in a separate environment, and then exports the activity type to an export file. An Active Roles administrator deploys the activity type in the production environment by importing the export file. After that, the Workflow Designer can be used to configure and apply activities of the new type.

Policy Type objects

The extensibility of workflow activity types builds upon Policy Type objects of the workflow activity category, each of which represent a single type of workflow activity. Policy Type objects are used within both the activity type deployment and activity type usage processes. The process of deploying a new activity type involves the creation of a Policy Type object. During the process of adding an activity of a custom type to a workflow, the activity type definition is retrieved from the respective Policy Type object.

Each Policy Type object of the workflow activity category holds the following data to define a single activity type:

  • Display name: Identifies the activity type in the Workflow Designer. This name is displayed in the activities toolbox located on the left of the workflow process diagram.

  • Description: A text describing the activity type. This text is used as a default description for every activity that is based on this Policy Type object.

  • Reference to Script Module: Identifies the Script Module that is used by the workflow activities of this type. When adding an activity of a custom type to a workflow, you effectively create an activity that runs a certain script function from the Script Module specified by the respective Policy Type object.

  • Policy Type category: The Policy Type objects that define custom workflow activities fall in a separate policy type category named “workflow activity.”

  • Workflow category: Determines whether the custom activity can be used in change workflows only, automation workflows only, or both change and automation workflows.

  • Function to run: Identifies the script function that is run by the workflow activities of this type. The function must exist in the Script Module selected for the policy type.

  • Function to declare parameters: Identifies the script function that declares the parameters for the workflow activities of this type. The function must exist in the Script Module selected for the policy type. By default, it is assumed that the parameters are declared by the function named onInit.

  • Policy Type icon: The image that appears next to the display name of the activity type in the Workflow Designer, to help identify and visually distinguish this activity type from the other types of workflow activity.

To create a custom activity type, first create a Script Module that holds the script function that will be run by the workflow activities of that type. Then, you can create a Policy Type object referring to that Script Module. When you import an activity type, Active Roles automatically creates both the Script Module and the Policy Type object for that activity type. After the Policy Type object has been created, you can add an activity of the new type to a workflow.

Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating