Chat now with support
Chat with Support

Active Roles 7.4.1 - 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 License Management Office 365 Roles Management 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 One Identity Starling Two-factor Authentication for Active Roles Managing One Identity Starling Connect Azure_Overview
Config ARS to Manage Hybrid AD Objects Managing Hybrid AD Users Office 365 roles management for hybrid environment users Managing Office 365 Contacts Managing Hybrid AD Groups Managing Azure O365 or Unified Groups
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 Appendix A: Using regular expressions Appendix B: Administrative Template Appendix C: Communication ports Appendix D: Active Roles and supported Azure environments Appendix E: Enabling delegation for Federated Authentication

Starting the Active Roles Collector wizard

Starting the Active Roles Collector wizard

To start the Active Roles Collector wizard

  • Depending upon the version of your Windows operating system, click One Identity Active Roles | Active Roles Collector and Report Pack on the Apps page or select All Programs |One Identity Active Roles | Active Roles Collector and Report Pack from the Start menu.

When started, the Collector wizard displays the Select Task page where you can select one of the following the tasks to perform:

  • Collect data from the network  Collect data and events from the computers running the Administration Service, and store the collected information in a SQL Server database to make the information available to the report server.
  • Process gathered events  Export selected events to another SQL Server database, or delete obsolete information from the database.
  • Import events from an earlier database version  As the current version of the Active Roles reports is only compatible with the database of the current Collector version, you need to import events from the database of an earlier version to the database of the current version if you want to use those events for reporting.
  • Deploy reports to Report Server  Setup only installs the Active Roles report definitions to the local computer. To use the reports, you need to publish them to your SQL Server Reporting Services (SSRS) Report Server.

Collecting data from the network

If you select the option Collect data from the network on the Select Task page, the Collector wizard displays the Configure Connection page on the next step.

On the Configure Connection page, the wizard prompts you to specify the basic options for managing the data: the database in which you want to store the collected data; the source computer running the Administration Service; and the credentials to log on to that computer.

To specify a database, click the button next to the Database box. In the dialog box that appears, you can specify the desired database and authentication option for connection to SQL Server.

In the Active Roles Service box, type the full name of the computer running the Administration Service from which you want to collect information.

In the Log on as area, specify the credentials that the Collector will use to connect to the Administration Service. You can choose one of the following options:

  • Current user  Connect to the Administration Service with the credentials of the user account under which the Collector is running.
  • Specified user  Connect to the Administration Service with the specified user name and password.

Click Next to proceed to the Data Collection Tasks page.

On the Data Collection Tasks page, the wizard prompts you to select the sources of the data you want Collector to retrieve:

  • Active Directory  Collect information about users, groups, computers, organizational units, and domains from Active Directory.
  • Policy Compliance Information  Collect data to determine whether directory objects comply with the policies defined by Active Roles. This option requires the Active Directory option to be selected.
  • Active Roles event log  Collect events from the Active Roles event log on the computers running the Administration Service.

Click Next to proceed to the Data to Collect page.

NOTE: The wizard only displays the Data to Collect page if you select the Active Directory check box on the Data Collection Tasks page.

On the Data to Collect page, the wizard prompts you to specify the categories of data you want to collect:

  • Access Templates  Information about Access Templates defined in your Active Roles environment.
  • Policy Objects  Information about Policy Objects defined in your Active Roles environment.
  • Managed Units  Information about Managed Units defined in your Active Roles environment.
  • Script Modules  Information about Script Modules defined in your Active Roles environment.

NOTE: If you select the Policy Compliance Information check box on the previous page, the wizard does not allow the Policy Objects check box to be cleared on the Data to Collect page.

Click Next to proceed to the Select Domains or OUs page.

On the Select Domains or OUs page, the wizard prompts you to specify the domains or containers from which you want to collect information. You can complete this page as follows:

  • Click Add to select a domain or OU to add to the list on the page.
  • Click Remove to delete a selected domain or OU from the list.

When selecting a domain or OU, you have the option to force the wizard to collect information about all objects held in the selected domain or OU: select the Use subtree search check box in the dialog box that appears when you click Add. If you clear the Use subtree search check box, the wizard only collects information about the immediate child objects of the selected domain or OU.

Click Next to proceed to the Select Operation Mode page.

On the Select Operation Mode page, you can specify whether to start the task execution immediately or schedule the task to run at a convenient time. You can also disable SID resolving for faster data collection.

If you want to start the collection process right now, select Now under Run Active Roles Collector and click Next. While the wizard performs the operation you can see the progress screen, showing you the progress details.

When the operation is completed, the wizard displays the final screen that shows you the operation results. You can click View Log to examine operation log for possible errors.

If you want to schedule the task, select On a schedule and click Next. This displays the Schedule page where you can specify the task schedule and logon account. Click Add to create a schedule for the task. In the User account under which the task will run area, supply the user name and password of the user account under which you want the task to run. Once the scheduling options are set, click Next to complete the wizard.

Steps for collecting data from the network

You use the Active Roles Collector to prepare data for reporting. The data is stored in the database you specify. Then, in order to make the data available to the report server, you need to configure the data source on the report server to connect to the database that holds the data. This topic provides instructions on how to prepare report data. For instructions on how to configure the data source for the Active Roles Report Pack, see Configuring the data source later in this chapter.

To collect data from the network, start the Collector wizard (see Starting the Active Roles Collector wizard), and complete the wizard pages as follows.

  1. On the Select Task page, select the Collect data from the network option.
  2. On the Configure Connection page, specify the database in which you want to store the collected data; the computer running the Administration Service; and the credentials to log on to that computer:
    1. To initially specify a database, or choose a different database, click the button next to the Database box, and then use the dialog box that appears to specify the desired database and authentication option for connection to SQL Server.
    2. In Active Roles Service, specify the full name of the computer running the Administration Service from which you want to collect information.
    3. Under Log on as, click one of these options:
      • Current user to connect to the Administration Service with the user account under which the Collector is running.
      • Specified user to specify the user name and password you want the Collector to use when connecting to the Administration Service.
  3. On the Data Collection Tasks page, specify the sources of data you want to collect. Select or clear these check boxes as appropriate:
    • Active Directory to collect information about users, groups, computers, organizational units, and domains from Active Directory.
    • Policy Compliance Information to collect information on whether Active Directory data is in compliance with the policies defined by Active Roles. If you select this check box, the Active Directory check box is selected as well.
    • Active Roles event log to collect information from the Active Roles event log on the computers running the Administration Service.
  4. On the Data to Collect page, specify the categories of Active Roles data you want to collect. Select or clear these check boxes as appropriate:
    • Access Templates to collect information about Access Templates defined in your Active Roles environment.
    • Policy Objects to collect information about Policy Objects defined in your Active Roles environment.
    • Managed Units to collect information about Managed Units defined in your Active Roles environment.
    • Script Modules to collect information about Script Modules defined in your Active Roles environment.
  5. On the Select Domains or OUs page, specify the domains or containers from which you want to collect information:
    • Click Add to select a domain or OU to add to the list on the page.
    • Click Remove to delete a selected domain or OU from the list.

    When selecting a domain or OU, you have the option to force the wizard to collect information about all child objects of the selected domain or OU: Select the Use subtree search check box in the dialog box that appears when you click Add. If you clear the Use subtree search check box, the wizard only collects information about the immediate child objects of the selected domain or OU.

  1. On the Select Operation Mode page, specify whether to start the task execution immediately or schedule the task to run at a convenient time:
    • To start the collection process right now, click Now, and then click Next.
    • To schedule the task, select On a schedule, and then click Next.
  2. If you selected the On a schedule option, then, on the Schedule page, specify the task schedule and logon account:
    • Click Add to create a schedule for the task.
    • In the User account under which the task will run area, supply the user name and password of the user account under which you want the task to run.

    The user account under which the task will run must have the “Log on as a batch job” right. Use Group Policy security settings to assign that right to the user account. Members of the Administrators or Backup Operators group have the “Log on as a batch job” right by default.

You can use the Task Scheduler console to examine the Collector task that you have scheduled. Task Scheduler allows you to view or change the task’s properties such as task’s name, description, security options, triggers, conditions, and settings. The task’s history can also be viewed along with the properties. Task Scheduler tracks the task’s history by events that are raised when the task is started, run, finished executing, and at other times as needed to track the task’s history. Errors related to the task are also tracked in the task’s history.

To view the task’s properties and history by using Task Scheduler

  1. If Task Scheduler is not open, start Task Scheduler.

You can start Task Scheduler by entering Taskschd.msc at a command prompt.

  1. In the console tree, select Task Scheduler Library | Active Roles | Collector.
  2. In the console window, double-click the name of the task.

The name of the task in the Task Scheduler console has the following format:
Active Roles Collector ( <task name> ) where <task name> stands for the name you specified in the Collector wizard; for example, Active Roles Collector (New Task).

  1. In the dialog box that appears, click a tab to view or change the task’s properties located on that tab.
  2. Click the History tab to view the task’s history.

    The History tab lists the events specific to the task you selected. Click an event in the list to view the description of the event.

Processing gathered events

If you select the option Process gathered events on the Select Task page, the Collector wizard displays the Data Processing Task page on the next step.

On the Data Processing Task page, the wizard prompts you to specify what you want to do with the events that were gathered from the Administration Service computers and stored in the database. You can choose one of the following options:

  • Export using date range  Specify the date range for the events you want to export. The time you specify is considered Greenwich Mean Time (GMT).
  • Export events older than  Specify the age limit for the events you want to export.
  • Delete events older than  Specify the age limit for the events you want to delete.

Click Next to proceed to the Source Database page allowing you to specify the database from which you want to export or delete information. Click the button next to the Database field. In the dialog box that appears, you can specify the desired database and authentication option for connection to SQL Server.

When finished, click Next to continue.

If you have chosen the option to export information, the wizard displays the Target Database page prompting you to specify the database to which you want to export information. Click the button next to the Database field. In the dialog box that appears, you can specify the desired database and authentication option for connection to SQL Server.

When finished, click Next to start the operation.

While the wizard performs the operation you selected, you can see the progress screen, showing you the progress details. When the operation is completed, the wizard displays the final screen that shows you the operation results. You can click View Log to examine the operation log for possible errors.

Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating