Chat now with support
Chat with Support

Active Roles 7.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 Home Folder AutoProvisioning Script Execution User Account Deprovisioning 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
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 Managing Configuration of Active Roles
Connecting to the Administration Service Adding and removing managed domains Using unmanaged domains Evaluating product usage Configuring replication Using AlwaysOn Availability Groups Using database mirroring 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
Using regular expressions Administrative Template Communication ports

Importing a script

Importing a script

To import a script file, in the console tree, right-click Script Modules, and click Import. This displays the Import Script dialog box where you can select and open a script file.

Creating a script

Creating a script

To create a new script module, in the console tree, right-click Script Modules and select New | Script Module. This opens the New Object - Script Module wizard.

TIP: It is advisable to store custom script modules in a separate container. You can create a container as follows: right-click Script Modules in the console tree, and select New | Scripts Container. After you have created a container, you can have the wizard add a script module to that container rather than directly to Script Modules: right-click the container in the console tree and select New | Script Module.

The first page of the wizard looks as shown in the following figure.

Figure 62: Script module: Creating a script

Type a name and description for the new script module, and select script language. Then, click Next. The next page looks as shown in then following figure.

Figure 63: Script Module: Policy script

On this page, select a type of the script module. Select Policy script to create a script that will be used as part of the Policy Object. The other options are:

  • Scheduled Task script  Script that you can schedule to run on the Administration Service.
  • Library script  Script to be used by other script modules. You can collect commonly used functions into a stand-alone script module and include it in other modules requiring those functions. This allows you to re-use some pieces of existing scripts, thus reducing development effort and time.

Select Policy script and click Next. This displays the page with a list of event handler functions shown in the following figure.

Figure 64: Script Module: Event handler functions

On this page, select functions to be used in the script, and click Next. Then, click Finish to create the script module.

For instructions and guidelines on how to develop policy scripts, refer to the Active Roles Software Development Kit (SDK).

In the Active Roles console, you can view and modify scripts, both imported and newly created.

Editing a script

Editing a script

To edit a script, select it in the console tree under Configuration/Script Modules. You can view and modify the script in the details pane. To start editing the script, right-click the script module and click Edit Script. Then, click Yes to confirm the operation. You can make changes to the script in the details pane.

When you are editing the script, a red asterisk is displayed next to the name of the script module in the console tree. This indicates the changes you are making to the script are not saved. You can undo your changes or save them:

  • To undo changes, press CTRL+Z. (The redo function is also available: press CTRL+Y.)
  • To undo all unsaved changes, right-click the script module and click Discard Changes. (This operation is irreversible: if you perform this command, your changes to the script are lost.)
  • To save the changes, right-click the script module and click Save Script on Server.

When the script module is ready, you can proceed to configuring a script policy that will use the prepared script module.

Active Roles allows you to attach a debugger to the Administration Service’s script host for a given policy script or scheduled task script. When the script is being executed by the specified Administration Service, the debugger may help you identify and isolate problems, if any, with the policy or task based on that script.

To enable debugging of a script in the Active Roles console, display the Properties dialog box for the script module containing the script, go to the Debugging tab, and select the Enable debugging check box. From the Debug on server list, select the Administration Service where you want the debugger to run.

Configuring a policy to execute a script

Configuring a policy to execute a script

To configure a script-based policy, select Script Execution on the Select Policy Type page in the New Provisioning Policy Object wizard, in the New Deprovisioning Policy Object wizard, or in the Add Policy wizard. Then, click Next to display the Script Module page.

Figure 65: Script Module: Executing a script

On this page, click Select a script module and select the script module. Then, click Next and follow the instructions in the wizard to create the Policy Object.

Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating