The Active Roles Collector allows you to collect data from computers running the Administration Service and store them in an on-premises or Azure SQL database, making the data available for reporting.
NOTE: The Collector is installed as a separate component of Active Roles.
Data for reports are collected from the following sources:
- Active Directory: The Collector accesses Active Directory through the Administration Service. Reports built on this data provide detailed information about domains, accounts, groups, and other Active Directory objects.
- Active Roles configuration database: Reports built on this data provide detailed information about who can carry out what actions and to which directory objects using Active Roles, as well as information about the policies defined by Active Roles.
- Event log on computers running the Administration Service: Reports built on this data provide detailed information about actions performed, the success or failure of each action, and object properties that were modified using Active Roles.
The scope of data that the Collector can retrieve from Active Directory is restricted by the access rights of the user account under which the Collector performs the data collection task. Therefore, reports based on Active Directory data only include information about the objects that the Collector is permitted to access in Active Directory.
For example, suppose the Collector performs a data collection task under the user account that is not permitted to access user account properties in Active Directory. As a result, the Collector will not be able to retrieve data related to user accounts, and reports will not display any information about user accounts (including the number of user accounts).
To start the Active Roles Collector wizard
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 database server to make the information available to the report server.
-
Process gathered events: Export selected events to another database server, 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.
If you select the Collect data from the network option on the Select Task page, the Collector wizard displays the Configure Connection page next.
On the Configure Connection page, the wizard prompts you to specify the basic options for managing the data (that is, 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 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.
To proceed to the Data to Collect page, click Next.
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:
-
To select a domain or OU to add to the list on the page, click Add.
-
To delete a selected domain or OU from the list, click Remove.
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 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.
To proceed to the Select Operation Mode page, click Next.
On the Select Operation Mode page, you can specify whether you want to start running the tasks immediately, or to schedule running the task at a convenient time. You can also disable SID resolving for faster data collection.
If you want to start the collection process immediately, select Now under Run Active Roles Collector and click Next. While the wizard performs the operation, you can follow the progress details displayed on the progress screen.
When the operation is completed, the wizard displays the final screen, with the operation results. You can click View Log to examine the 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. To create a schedule for the task, click Add. In the User account under which the task will run area, enter 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.
You can use the Active Roles Collector to prepare data for reporting. The data you will prepare for reporting are stored in the database you specify. To make the data available for the report server, you have to configure the data source on the report server to connect to the database that stores the data. This section 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.
To collect data from the network, start the Collector wizard, and complete the wizard pages as follows. For more information, see Starting the Active Roles Collector wizard.
-
On the Select Task page, select the Collect data from the network option.
-
On the Configure Connection page, specify:
-
The database in which you want to store the collected data
-
The computer running the Administration Service
-
The credentials to log on to that computer:
-
To initially specify a database, or choose a different database, click the button next to the Database box, then use the dialog that appears to specify the required database type, database, and authentication option for connection to database server.
-
In Active Roles Service, specify the full name of the computer running the Administration Service from which you want to collect information.
-
Under Log on as, click one of these options:
-
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 are 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.
-
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.
-
On the Select Domains or OUs page, specify the domains or containers from which you want to collect information:
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 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.
-
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 immediately, click Now, then click Next.
-
To schedule the task, select On a schedule, then click Next.
-
If you selected the On a schedule option, 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 configured. 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
-
If Task Scheduler is not open, start Task Scheduler.
You can start Task Scheduler by typing Taskschd.msc into a command prompt (for example, cmd.exe).
-
In the Console tree, select Task Scheduler Library > Active Roles > Collector.
-
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).
-
In the dialog that appears, click a tab to view or change the task’s properties located on that tab.
-
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.
