Active Roles 7.2 - Quick Start Guide

Steps to install Collector and Report Pack

Active Roles comes with a comprehensive suite of report definitions, contained in the Active Roles Report Pack. To work with reports, you need to:

• Install the Active Roles Collector
• Use the Collector wizard to deploy the Report Pack

Installing Collector

The Active Roles Collector is used to prepare data for reporting, allowing you to configure, schedule, and run data collection jobs. Collector stores report data in a database on SQL Server. For best results, use Microsoft SQL Server 2008 or a later version of SQL Server to host the Collector’s database.

To install the Collector

1. Install Active Roles Management Tools. For installation instructions, see Steps to install only the Shell, ADSI Provider and SDK earlier in this document.
2. In the Active Roles distribution package, navigate to the Solutions/Collector and Report Pack folder, and double-click the .msi file held in that folder.
3. Follow the instructions in the Setup wizard.
4. Wait while the wizard completes the installation.

Once you have installed Collector, you can start the Collector wizard by selecting Active Roles 7.2 Collector and Report Pack on the Apps page or Start menu, depending upon the version of your Windows operating system.

Deploying Report Pack

Report Pack requires Microsoft SQL Server Reporting Services (SSRS). Make sure that you have SSRS deployed in your environment. When deploying Report Pack, the Collector wizard prompts you for the address (URL) of the Report Server Web service. You can find this address on the Web Service URL page in the Reporting Services Configuration Manager tool on the server where SSRS is installed.

To deploy the Report Pack

1. Start the Collector wizard.

   You can start the Collector wizard by selecting Active Roles 7.2 Collector and Report Pack on the Apps page or Start menu, depending upon the version of your Windows operating system.

2. On the Select Task page, click Deploy reports to Report Server, and then click Next.
3. On the Report Server page, type the URL of your SSRS Report Server in the Report Server Web Service URL box. Click Next.

   By default, the URL is http://<serverName>/ReportServer. You can use the Reporting Services Configuration Manager tool to confirm the server name and URL. For more information about URLs used in Reporting Services, see the topic “Configure Report Server URLs (SSRS Configuration Manager)” at http://msdn.microsoft.com/library/ms159261.aspx.

4. Optionally, on the Data Source page, configure the data source for the Active Roles reports:
   1. Click the Configure Data Source button.
   2. Use the Configure Data Source dialog box to specify the SQL Server instance that hosts the database you have prepared by using Collector, the name of the database, and the authentication method to use for connection to the database.

   Configuring the data source is an optional step. If you do not have a database prepared by Collector, you can configure the data source later, after you have deployed the Report Pack. For instructions, see “Working with reports” in the Active Roles Administrator Guide.

5. Click Next and wait while the wizard deploys the Report Pack.

You can create and view Active Roles reports using Report Manager, a Web-based tool included with SSRS. For instructions, see “Generating and viewing a report” in the Active Roles Administrator Guide.

Upgrade of an earlier version

Upgrading from Active Roles 7.0.x to Active Roles 7.x is always an in-place upgrade.

Upgrading from Active Roles 6.9 version to 7.x version is a side-by-side upgrade, which does not interrupt operations or affect the configuration of your earlier Active Roles version. To ensure smooth upgrade to the new Active Roles version, you should first upgrade the Administration Service and then upgrade the Web Interface.

Active Roles 6.x components are not used in the upgrade and neither are any components from the earlier version are uninstalled.

Impact on Office 365 add-on

After an upgrade of Active Roles components to the Active Roles 7.2, the Office 365 add-on which was supported in the earlier versions of Active Roles, ceases to work. Hence, it is recommended to uninstall the Office 365 add-on prior to the upgrade of Active Roles.

Upgrading to Active Roles 7.2 from 7.0.x

To upgrade existing Active Roles 7.0.x to the latest version, perform the following steps.

To upgrade the Active Roles package

1. Log on with a user account that has administrator rights on the computer.
2. Navigate to the location of the Active Roles distribution package, and start the Setup wizard by double-clicking ActiveRoles.exe.
3. Follow the instructions in the Setup wizard.
4. On the Ready to Upgrade page, click Upgrade to perform upgrade.
5. On the Completion page, click Finish.

Note: After upgrading the Active Roles package to 7.2, perform Configuring Active Roles 7.2 for in-place upgrade

Configuring Active Roles 7.2 for in-place upgrade

The following steps describe the in-place upgrade scenario for Active Roles 7.2:

1. After upgrading the Active Roles package to 7.2, you are prompted to restart the system.
2. After the system restarts, the Configuration Center opens by default, displaying the Upgarde Configuration wizard.

   The fields in the wizard are auto-populated with the recently configured database details (including the Management history SQL Server and Database if it exists seperately).

3. Select the check box on the Upgrade Configuration wizard, to confirm that you have read the instructions in the Quick Start guide regarding "Configuring Active Role 7.2 for in-place upgrade" .

4. Click Next.

   NOTE: If you click Next without selecting the check box, an error is displayed prompting you to follow the instructions given against the check box and select the check box.

   The upgrade starts and the Exectution tab displays the Progress bar for the upgrade.

   The database upgrade process creates a backup of the earlier version database in the format "DatabaseName__BACKUP "

After the database upgrade is complete, the Active Roles Service is automatically started and ready for use.

Compatibility of Active Roles components

The new Administration Service is only compatible with the Active Roles user interfaces (Web Interface and console) of version 7.2. Earlier versions of the user interfaces may not work with the new Administration Service. The user interfaces of version Active Roles are only compatible with the Administration Service of version 7.2. Therefore, to use the Active Roles console or Web Interface of version 7.2, you first need to upgrade the Administration Service.

Impact on custom solutions

An upgrade of Active Roles may affect custom solutions (such as scripts or other modifications), if any, that rely on the Active Roles functions. Custom solutions that work fine with an earlier Active Roles version may cease to work after the upgrade. Prior to attempting an upgrade, you should test the existing solutions with the new Active Roles version in a lab environment to verify that the solutions continue to work.

Upgrading the Administration Service

To upgrade a version earlier than 6.9 to 7.x, you first need to upgrade to version 6.9.

You can upgrade the Administration Service of version 6.9, 7.0, or 7.1 to version 7.2.

Upgrading the Administration Service implies creation of a new Administration Service instance of the latest version, with the configuration and management history data imported from your Administration Service of an earlier version. As a result, the new Administration Service instance inherits all of your existing Active Roles configuration settings, such as managed domains, managed units, permission assignments, policies, workflows, virtual attributes and so forth. By importing management history data, you transfer change history, approval tasks, and temporal group membership tasks from your Administration Service of an earlier version to the new Administration Service instance.

To upgrade the new Administration Service instance from 7.0.x to 7.1.x, perform the following steps:

1. After upgrading the Active Roles package to 7.2, you are prompted to restart the system.
2. After the system restarts, the Configuration Center opens by default, displaying the Upgarde Configuration wizard.

   The fields in the wizard are auto-populated with the recently configured database details.

3. Select the check box on the Upgade Configuration wizard, to confirm that you have read the instructions in the Quick Start guide regarding "Configuring Active Role 7.2 for in-place upgrade" .

4. Click Next.

   NOTE: If you click Next without selecting the check box, an error is displayed prompting you to follow the instructions given against the check box and select the check box.

   The upgrade starts and the Exectution tab displays the Progress bar for the upgrade.

   The database upgrade process creates a backup of the earlier version database in the format "DatabaseName__BACKUP "

After the database upgrade is complete, the Active Roles Service is automatically started and ready for use.

Upgrading from Active Roles 7.0.x to Active Roles 7.x is always an in-place upgrade.

Upgrading from Active Roles 6.9 version to 7.x version is a side-by-side upgrade, which does not interrupt operations or affect the configuration of your earlier Active Roles version. To ensure smooth upgrade to the new Active Roles version, you should first upgrade the Administration Service and then upgrade the Web Interface.

If you no longer need the Administration Service of the earlier version, you can uninstall it using Programs and Features in Control Panel: Right-click Administration Service in the list of installed programs, and then click Uninstall.

Install and configure the Administration Service

To create a new Administration Service instance, you first install Administration Service files and then perform initial configuration.

To install the Administration Service files

1. Log on with a user account that has administrator rights on the computer.
2. Navigate to the location of the Active Roles distribution package, and start the Setup wizard by double-clicking ActiveRoles.exe.
3. Follow the instructions in the Setup wizard.
4. On the Component Selection page, ensure that the Administration Service component is selected, and click Next.
5. On the Ready to Install page, click Install to perform installation.
6. On the Completion page, select the I want to perform configuration check box, and click Finish.

The Setup wizard only installs the files. After you have completed the Setup wizard, you need to configure the newly installed Administration Service instance by using Active Roles Configuration Center that opens automatically if you select the I want to perform configuration check box on the Completion page in the Setup wizard. Another way to open Configuration Center is by selecting Active Roles 7.2 Configuration Center on the Apps page or Start menu, depending upon the version of your Windows operating system.

To perform initial configuration

1. In Configuration Center, under Administration Service, click Configure.
2. On the Service Account page in the Configure Administration Service wizard that appears, enter the name and password of the domain user account to be used as the Administration Service account, and then click Next.
3. On the Active Roles Admin page, accept the default account, or click Browse and select the group or user to be designated as Active Roles Admin. When finished, click Next.
4. On the Database Options page, select the New Active Roles database option, and then click Next.
5. On the Connection to Database page, specify a SQL Server instance and database name, and select the authentication option:
   1. In the SQL Server box, specify a SQL Server instance in the form <Computer>\<Instance> (for named instance) or <Computer> (for default instance), where <Computer> stands for the short name of the computer running SQL Server. The wizard will create the database on the SQL Server instance you specify.
   2. In the Database box, type a name for the database that will be created.
   3. Under Connect using, select the appropriate authentication option:
      • To have the Administration Service connect to the database using the service account, click Windows authentication.
      • To have the Administration Service connect to the database using a SQL Server login, click SQL Server authentication and type the login name and password.
6. Click Next, and then complete the Encryption Key Backup page as described in Steps to deploy the Administration Service, earlier in this document.
7. Click Next, and follow the instructions in the wizard to complete the configuration.

Import configuration

After you have installed and initially configured the Administration Service of the new version, import the configuration data from the database used by your Administration Service of the earlier version. First, identify that database:

1. Open the Active Roles console and connect to your Administration Service of the earlier version (see “Connecting to the Administration Service” in the Active Roles Administrator Guide).
2. Select the console tree root, and then, on the page in the details pane, expand the Configuration Databases and Replication area.

Yo can identify the database name and SQL Server name from the first string in the Configuration Databases and Replication area that has the following format: Database <name> on SQL Server <name>.

Then, perform the import. You can do this using the Import Configuration wizard provided by Configuration Center. On the Source Database page in the Import Configuration wizard, supply the database name and SQL Server name you have identified. For detailed instructions, see Steps to deploy the Administration Service earlier in this document.

Import management history

After you have imported configuration of your earlier Active Roles version, import the management history data from the database used by your Administration Service of the earlier version. First, identify that database:

1. Open the Active Roles console and connect to your Administration Service of the earlier version (see “Connecting to the Administration Service” in the Active Roles Administrator Guide).
2. Select the console tree root, and then, on the page in the details pane, expand the Management History Databases and Replication area.

Yo can identify the database name and SQL Server name from the first string in the Management History Databases and Replication area that has the following format: Database <name> on SQL Server <name>.

Then, perform the import. You can do this using the Import Management History wizard provided by Configuration Center. On the Source Database page in the Import Management History wizard, supply the database name and SQL Server name you have identified. For detailed instructions, see Steps to deploy the Administration Service earlier in this document.

Upgrade in case of shared database

If multiple instances of the Administration Service use a single database, then you can perform the upgrade as follows:

1. Upgrade one of the Administration Service instances as described earlier (see Upgrading the Administration Service).

   As a result of this step, you have an Administration Service instance of the new version connected to the new database containing the data imported from the old database. The other instances of the Administration Service are not upgraded at this point; they continue to use the old database.

2. Now that you have the database of the new version, you can upgrade the remaining instances of the Administration Service, one by one. In the Configure Administration Service wizard, select the Existing Active Roles database option on the Database Options page, and then, on the Connection to Database page, specify the database created during upgrade of the first Administration Service instance. You don’t need to import configuration or management history as the database already has that data imported.

As a result of these steps, multiple Administration Service instances of the new version use a single database updated with the configuration and management history data of your earlier Active Roles version.

Upgrading the Web Interface

To upgrade a version earlier than 6.9 to 7.x, you first need to upgrade to version 6.9.

You can upgrade the Web Interface of version 6.9, 7.0, or 7.1 to version 7.2.

Upgrading the Web Interface implies creation of a new Web Interface instance of the latest version that has the same Web Interface sites as your Web Interface of an earlier version, with the site configuration data imported from your Active Roles configuration of the earlier version. As a result, the new Web Interface sites inherit all customizations that were made to the menus, commands, forms and other elements of your Web Interface sites of the earlier version.

When an import configuration is performed from Active Roles version 7.1 to 7.2, the web interface does not get upgraded. However, the Configuration Center or any client report the Active Roles Web interface version incorrectly as 7.2. To upgrade the Web interface to the latest version see Upgrading the Web Interface.

Creating Web interface sites and importing configuration

To create a new Web Interface instance of the latest version and import the site configurations perform the following steps:

1. For each Web Interface site of your earlier Active Roles version, identify and note down the name of the configuration object that the Administration Service uses to store the site’s configuration data.
2. Install and configure the Web Interface instance of the latest Active Roles version, choosing the new Administration Service to which you have imported configuration of your earlier Active Roles version (see Upgrading the Administration Service earlier in this document).
3. On the new Web Interface instance that you installed and configured in Step 2, create sites based on information you noted down in Step 1, importing data from the configuration objects used by your earlier Web Interface version. Those configuration objects were copied to the new Administration Service during configuration data import (see Upgrading the Administration Service earlier in this document).
4. Optionally, delete the default sites that were created when you configured the Web Interface in Step 2. The default sites are unaware of your existing site customizations, and have the default configuration of menus, command, forms and other elements.

These steps are covered in the topics that follow.

You can install the Web Interface of version Active Roles side-by-side with the Web Interface of version 6.9 on the same computer, and perform the upgrade without interrupting operations or affecting the configuration of your Web Interface sites of the earlier Active Roles version.

If you no longer need the Web Interface of the earlier version, you can uninstall it using Programs and Features in Control Panel: Right-click Web Interface in the list of installed programs, and then click Uninstall.

Identify configuration objects

When creating Web Interface sites of the new Active Roles version, you need to know which configuration objects are used by your Web Interface sites of the earlier version. Each site stores its configuration in a certain object on the Administration Service, referred to as the site configuration object. Upgrade of the Administration Service copies the existing site configuration objects to the new Administration Service, retaining the name of each object.

To create a Web Interface site of the new Active Roles version that inherits your existing site customizations, you need to specify the name of the corresponding site configuration object of the earlier version. Then, Active Roles creates a site configuration object of the new version, imports the site configuration data to that object, and causes the new Web Interface site to use that object. As a result, the new Web Interface site has the same configuration as the Web Interface site of the earlier version.

You can identify your existing site configuration objects by using the Web Interface Sites Configuration wizard on the computer running the Web Interface of Active Roles version 6.9 or earlier.

To identify the configuration object of the Web Interface site of an earlier Active Roles version

1. On the Web server running your Web Interface of the earlier Active Roles version, start the Web Interface Sites Configuration wizard.

   To start the wizard, select Web Interface Sites Configuration on the Apps page or Start menu, depending upon the version of the Windows operating system on the Web server.

2. Proceed to the Web Interface Configuration page in the Web Interface Sites Configuration wizard.

   The page lists your Web Interface sites of the earlier Active Roles version.

3. On the Web Interface Configuration page, click the list item representing the desired site, and then click the Edit button.

   You can distinguish sites by alias, shown in the Virtual Directory column on the Web Interface Configuration page. The alias defines the virtual path used in the address of the Web Interface site on the Web server. For example, in Active Roles version 6.9, the alias of the default Web Interface site for Administrators ARWebServerAdmin, which results in the following address of that site: http://<Host>/ARServerAdmin.

4. Note down the name of the site’s configuration object shown in the Configuration settings area of the dialog box that appears.

   The name of the object is displayed in the Name box under the Use existing configuration option, and includes the version number. For example, the name of the site configuration object used by the default Web Interface site for Administrators of version 6.9 is Site for Administrators (6.9.0).

5. Click Cancel to close the dialog box.

To identify the configuration object of the Web Interface site of the current Active Roles version

1. Start the Configuration Center on the computer running the Administration Service instance on which you want to identify the web interface sites.

   You can start Configuration Center by selecting Active Roles 7.2 Configuration Center on the Apps page or Start menu, depending upon the version of your Windows operating system.

2. On the Configuration Settings main window, on the left pane, click Web Interface.

   The Web Interface page is displayed, which lists the Web Interface sites of the current Active Roles version that are deployed on the Web server running the Web Interface.

   For each Web Interface site, the list provides the following information:

   • IIS Web site The name of the Web site that holds the Web application implementing the Web Interface site
   • Web app alias The alias of the Web application that implements the Web Interface site, which defines the virtual path of that application on the Web server.
   • Configuration Identifies the object that holds the Web Interface site’s configuration and customization data on the Active Roles Administration Service.

3. From the Web Interface page, you can open Web Interface sites in your Web browser:
   1. Click an entry in the list of Web Interface sites.
   2. Click Open in Browser on toolbar.

You can also use Configuration Center to:

• Create, modify or delete Web Interface sites
• Export a Web Interface site’s configuration object to a file

For more information, see the Web Interface management tasks section in the One Identity Active Roles Administrator Guide.

Identify the configuration object for each of your existing Web Interface sites, and note down the name of each object. You will need these names when creating the Web Interface sites of the new Active Roles version.

Install and configure the Web Interface

To create a new Web Interface instance, you first install Web Interface files and then perform initial configuration.

To install the Web Interface files

1. Log on with a user account that has administrator rights on the computer.
2. Navigate to the location of the Active Roles distribution package, and start the Setup wizard by double-clicking ActiveRoles.exe.
3. Follow the instructions in the Setup wizard.
4. On the Component Selection page, ensure that the Web Interface component is selected, and click Next.
5. On the Ready to Install page, click Install to perform installation.
6. On the Completion page, confirm that the I want to perform configuration check box is selected, and click Finish.

The Setup wizard only installs the files. After you have completed the Setup wizard, you need to configure the newly installed Web Interface instance by using Active Roles Configuration Center that opens automatically if you select the I want to perform configuration check box on the Completion page in the Setup wizard. Another way to open Configuration Center is by selecting Active Roles 7.2 Configuration Center on the Apps page or Start menu, depending upon the version of your Windows operating system.

To perform initial configuration

1. In Configuration Center, under Web Interface, click Configure.

   This starts the wizard that will perform initial configuration of the Web Interface.

2. On the Administration Service page, specify the new Administration Service instance created during upgrade (see Upgrading the Administration Service earlier in this document).

   If the new Administration Service instance runs on the computer on which you are installing the new Web Interface, choose the option Administration Service on the computer running the Web Interface. Otherwise, choose the option Administration Service on this computer, and supply the fully qualified domain name of the computer running the new Administration Service instance.

3. Click the Configure button, and wait while the wizard completes the configuration.

Create sites based on old configuration objects

After you have installed and configured the Web Interface instance of the new Active Roles version, you can use Configuration Center to create Web Interface sites of the new version, importing site configuration data from the configuration objects used by your existing Web Interface sites of the earlier Active Roles version (see Upgrading the Web Interface earlier in this document). As a result, the new Web Interface sites will inherit all customizations that were made to the menus, commands, forms and other elements of your Web Interface sites of the earlier version.

To create a Web Interface site based on an old configuration object

1. Open Configuration Center.

   You can open Configuration Center by selecting Active Roles 7.2 Configuration Center on the Apps page or Start menu, depending upon the version of your Windows operating system.

2. In the Configuration Center main window, under Web Interface, click Manage Sites.
3. On the Sites page, click Create.
4. On the Web Application page in the Create Web Interface Site that appears, choose the IIS Web site to contain the Web application that implements the Web Interface site, and specify an alias for that application.

   The alias defines the virtual path that is a part of the Web Interface site’s address. You can view the resulting address on the Web Application page.

5. Click Next to proceed to the Configuration page.
6. From the list on the Configuration page, select the Import from an existing configuration option.
7. Complete the fields on the Configuration page:
   1. In the Configuration name field, supply the name of the configuration object for the new Web Interface site. You can accept the default name.
   2. The wizard will create a configuration object with the specified name, and import configuration data to that object.
   3. From the list in the Configuration to import box, select the name of the configuration object from which to import the configuration data.

   This must be the name of the configuration object used by one of your existing Web Interface sites of the earlier Active Roles version (see Upgrading the Web Interface earlier in this document).

8. Click the Create button, and wait while the wizard creates the new Web Interface site.

Perform these steps for each of your Web Interface sites of the earlier version, selecting the appropriate object name in Step 7b.

Delete default sites

After you have created the Web Interface sites of the new version that inherit the configuration of your Web Interface sites of the earlier version, you might delete the default Web Interface sites that were created by initial configuration of the Web Interface (see Upgrading the Web Interface earlier in this document).

To delete the default Web Interface sites

1. Open Configuration Center.

   You can open Configuration Center by selecting Active Roles 7.2 Configuration Center on the Apps page or Start menu, depending upon the version of your Windows operating system.

2. In the Configuration Center main window, under Web Interface, click Manage Sites.
3. On the Sites page, identify list entries representing default Web Interface sites, and use the Delete button to delete them one by one.

   You can distinguish list entries representing default Web Interface sites by the name in the Configuration column:

• Site for Administrators (7.2) indicates the default site for administrators
• Site for HelpDesk (7.2) indicates the default site for Help Desk
• Site for Self-Administration (7.2) indicates the default site for self-administration