Chat now with support
Chat with Support

Active Roles 7.4.1 - Quick Start Guide

Introduction Active Roles Setup package Active Roles uninstallation System Requirements Deploying the Administration Service Deploying user interfaces Installing additional components Upgrade of an earlier version Performing a pilot deployment Deployment considerations Silent installation of Active Roles components Configuring Active Roles to Manage Hybrid Active Directory Objects Active Roles on Windows Azure VM

Steps to install only the Shell, ADSI Provider and SDK

Active Roles Management Shell, SDK and ADSI Provider are collectively referred to as management tools. On the Component Selection page, the Active Roles Setup wizard selects the Management Tools component if you have selected any core component such as Administration Service, Console (MMC Interface) or Web Interface. This means that Setup installs the Shell, SDK and ADSI Provider together with any core component. However, it is possible to install solely the Shell, SDK and ADSI Provider by selecting the Management Shell component only.

To install only the Shell, SDK and ADSI Provider

  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, clear all check boxes except the Management Tools check box, and then click Next.
  5. On the Ready to Install page, click Install to perform installation.
  6. On the Completion page click Finish.

Once you have installed the management tools, you can open Management Shell or view SDK topics (including documentation for ADSI Provider). Depending upon the version of your Windows operating system, select the following on the Apps page or Start menu:

  • To open Management Shell, select Active Roles 7.4 Management Shell
  • To view SDK topics, select Active Roles 7.4 SDK

After you have opened Management Shell, you can view a reference manual by typing QuickRef. The manual contains documentation for all commands provided by Management Shell.

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 2012 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.4 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.4 Collector and Report Pack on the Apps page or Start menu, depending upon the version of your Windows operating system.

  1. On the Select Task page, click Deploy reports to Report Server, and then click Next.
  2. 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.

  1. 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 Administration Guide.

  1. 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 Administration Guide.

Upgrade of an earlier version

You can upgrade from Active Roles 7.0.x or later to Active Roles 7.x using one of the following methods:

  • In-place upgrade - Install the latest version of Active Roles on the computer without removing the earlier version.
  • New installation with import of database from earlier version - Install the latest version of Active Roles and import the database from the earlier version of Active Roles.

NOTE:

  • To perform a clean installation of Active Roles 7.4, uninstall Active Roles 7.x before installing Active Roles 7.4.
  • Active Roles supports selection of custom installation path only during a fresh installation. During an in-place upgrade, Active Roles does not support changing the custom installation path.

For information on importing configuration data from database of earlier version of Active Roles, see Import Configuration under Upgrading the Administration Service.

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 uninstalled.

NOTE: Before upgrading to the latest version of Active Roles, the add-ons of the earlier versions must be uninstalled.

Impact on Office 365 add-on

After an upgrade of Active Roles components to the Active Roles 7.4, 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.

NOTE:

  • Office 365 add-on is not supported on Active Roles 7.4 and must be uninstalled prior to the installation of Active Roles 7.4
  • Active Roles 7.4 manages Office 365 and Azure AD natively. However, Active Roles 7.4 does not support the following feature of Office 365 add-on that was supported in earlier versions of Active Roles:
    • Ability to manage and select Office 365 domains through policies..

Upgrading to Active Roles 7.4 from 7.0.x or later using in-place upgrade method

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

To upgrade the Active Roles package using in-place upgrade

  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.4, perform Configuring Active Roles 7.4 during in-place upgrade

Configuring Active Roles 7.4 during in-place upgrade

NOTE:

  • Before upgrading to the latest version of Active Roles:
    • The add-ons of the earlier versions must be uninstalled.
    • Replication partners, if any, must be removed.
  • The in-place upgrade of Active Roles 7.4 upgrades the Active Roles 7.4 Administration service and Web interface components.
  • The in-place upgrade of Active Roles 7.4 does not upgrade the Active Roles Solution components such as SPML Provider, Add-on Manager, Add-ins for Outlook, Diagnostic Tools, and so on. To upgrade the Solution components installed with Active Roles, use the respective installers available as part of the Active Roles installation package.
  • During Active Roles upgrade, if the Active Roles database is not split into configuration and management history databases, then the upgrade process by default creates a management history database.

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

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

    As part of this upgrade, Active Roles creates new databases with default names. The Upgrade Configuration wizard displays the new databases information.

    Optional step: To change the default names of the new databases, click Click here to change or provide existing database names.

  1. On the Upgrade Configuration wizard, select the check box to confirm that you have read the instructions in the Quick Start guide regarding "Configuring Active Roles 7.4 for in-place upgrade" .
  1. Click Next.

    NOTE: If the disk space in SQL server is insufficient, then an error is displayed prompting you to increase the disk space.

    In case of any errors during the in-place upgrade, you must resolve the errors and re-open the Configuration Center to continue the in-place upgrade.

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

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

NOTE:

  • To upgrade multiple Active Roles Service instances, log in to the individual systems where Active Roles Service was upgraded, and perform the in-place upgrade steps for each Service.

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.4. Earlier versions of the user interfaces may not work with the new Administration Service. The user interfaces of Active Roles 7.4 are only compatible with the Administration Service of version 7.4. Therefore, to use the Active Roles console or Web Interface of version 7.4, you must first 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 Active Roles Administration Service from a version earlier than 6.9 to 7.x, you must first upgrade to version 6.9.

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

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 on. 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 or later to 7.4 perform the following steps:

NOTE: Before upgrading to the latest version of Active Roles, the add-ons of the earlier versions must be uninstalled.

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

    The fields in the wizard are auto-populated. The database name for Configuration and Management history are suggested, by default. However. if you want to update the database name, click Click here to change or provide existing database names link.

  1. 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.4 for in-place upgrade" .
  1. 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 Execution tab displays the Progress bar for the upgrade.

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

You can upgrade from Active Roles 7.0.x or later to Active Roles 7.x using in-place upgrade or a new installation of Active Roles with import of database from an earlier version.

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 must 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. The Configuration Center 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.4 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 or the service account details of the Group Managed Service 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 Configuration 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. On the Management History Database Options page in the Configure Administration Service wizard, select the New Active Roles database option, and then click Next.

  7. On the Connection to Database page, perform the the steps a to c for Management history database.

  8. Click Next, and then complete the Encryption Key Backup page as described in Steps to deploy the Administration Service, earlier in this document.
  9. 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. To import configurations, you must identify that database. To identify the 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 Administration Guide).
  2. Select the console tree root, and then, on the page in the details pane, expand the Configuration Databases and Replication area.

    You 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>.

After identifying the database, perform the import 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 that you have identified. For detailed instructions, see Steps to deploy the Administration Service earlier in this document.

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

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 Administration Guide).
  2. Select the console tree root, and then, on the page in the details pane, expand the Management History Databases and Replication area.

    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>.

After identifying the database, 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.

  1. Now that you have the database of the new version, you can upgrade the remaining instances of the Administration Service, one by one.
  2. In the Configure Administration Service wizard, select the Existing Active Roles database option on the Configuration Database Options page, and then, on the Connection to Database page, specify the database created during upgrade of the first Administration Service instance. You need not import configuration as the database already has that data imported.
  3. In the Configure Administration Service wizard, select the Existing Active Roles database option on the Management History Database Options page, and then, on the Connection to Database page, specify the database created during upgrade of the first Administration Service instance. You need not import the 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.

Related Documents