Active Roles 7.2 - Quick Start Guide

Steps to install the console

The Active Roles console can be installed on any computer that meets the system requirements and has a reliable network connection to a computer running the Administration Service. It can also be installed on the Administration Service computer.

To install the Active Roles console

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 Console (MMC Interface) component is selected, and click Next.

   By default, all components are selected. If you only want to install the console, clear the check boxes that denote unwanted components.

5. On the Ready to Install page, click Install to perform installation.
6. On the Completion page click Finish.

Once you have installed the console, you can start it by selecting Active Roles 7.2 Console on the Apps page or Start menu, depending upon the version of your Windows operating system.

Steps to deploy the Web Interface

The Active Roles Web Interface can be installed on any computer that meets the system requirements and is running Internet Information Services (IIS) 7.5 or later. It is not necessary to install the Web Interface on the computer running the Administration Service. However, the computer that hosts the Web Interface must have a reliable network connection to a computer running the Administration Service.

Checking Web Interface prerequisites

Windows Server 2008 R2

On a Windows Server 2008 R2 based computer, ensure that the Web Server (IIS) server role with the following role services is installed:

• Web Server/Common HTTP Features/
  • Static Content
  • Default Document
  • HTTP Errors
  • HTTP Redirection
• Web Server/Application Development/
  • ASP.NET
  • .NET Extensibility
  • ASP
  • ISAPI Extensions
  • ISAPI Filters
• Web Server/Security/
  • Basic Authentication
  • Windows Authentication
  • Request Filtering
• Management Tools/IIS 6 Management Compatibility/
  • IIS 6 Metabase Compatibility

The Web Interface Setup program automatically installs the required server role and role services. You can use Server Manager to verify that the required server role and role services are installed.

Windows Server 2012

On a Windows Server 2012 based computer, ensure that the Web Server (IIS) sever role is installed, including:

• Web Server/Common HTTP Features/
  • Default Document
  • HTTP Errors
  • Static Content
  • HTTP Redirection
• Web Server/Security/
  • Request Filtering
  • Basic Authentication
  • Windows Authentication
• Web Server/Application Development/
  • .NET Extensibility 4.5
  • ASP
  • ASP.NET 4.5
  • ISAPI Extensions
  • ISAPI Filters
• Management Tools/IIS 6 Management Compatibility/
  • IIS 6 Metabase Compatibility

Windows Server 2016

On a Windows Server 2016 based computer, ensure that the Web Server (IIS) sever role is installed, including:

• Web Server/Common HTTP Features/
  • Default Document
  • HTTP Errors
  • Static Content
  • HTTP Redirection
• Web Server/Security/
  • Request Filtering
  • Basic Authentication
  • Windows Authentication
• Web Server/Application Development/
  • .NET Extensibility 4.5
  • ASP
  • ASP.NET 4.5
  • ISAPI Extensions
  • ISAPI Filters
• Management Tools/IIS 6 Management Compatibility/
  • IIS 6 Metabase Compatibility

The Web Interface Setup program configures the Web Server (IIS) server role to meet the Web Interface requirements. You can use Server Manager to verify that the server role is configured properly.

Feature delegation

Web Interface requires Internet Information Services to provide Read/Write delegation for the following features:

• Handler Mappings
• Modules

Use Feature Delegation in the Internet Information Services (IIS) Manager tool to confirm that these features have delegation set to Read/Write.

Installing and configuring the Web Interface

When installing and initially configuring the Web Interface, you first use the Setup wizard to install the Web Interface files and then use Active Roles Configuration Center to choose the Administration Service and create the Web Interface sites.

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.

   By default, all components are selected. If you only want to install the Web Interface, clear the check boxes that denote unwanted components.

5. On the Ready to Install page, click Install to perform installation.
6. On the Completion page, verify 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 by using Active Roles Configuration Center.

The procedure for configuring the Web Interface includes two stages:

• Steps to deploy the Web Interface  During initial configuration, the Administration Service is selected, and three Web Interface sites are created based on the default configuration templates.
• Steps to deploy the Web Interface  You can create additional sites, and modify or delete existing sites.

Initial configuration

Configuration Center allows you to configure the Web Interface to use:

• Administration Service that runs on the same computer as the Web Interface
• Administration Service that runs on a specified computer
• Any available Administration Service that belongs to a specified replication group

Before configuring the Web Interface, ensure that the Administration Service is configured and started. Otherwise, Configuration Center will fail to configure the Web Interface. You can view the state of the Administration Service on the Administration Service page in the Configuration Center main window.

To perform initial configuration of the Web Interface

1. Log on with a user account that has administrator rights on the computer.
2. Open Active Roles Configuration Center.

   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.2 Configuration Center on the Apps page or Start menu, depending upon the version of your Windows operating system.

3. In the Configuration Center main window, under Web Interface, click Configure.

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

4. On the Administration Service page, specify how you want the Web Interface to select the Active Roles Administration Service. You can choose from the following options:
   • Administration Service on the computer running the Web Interface
   • Administration Service on this computer
     Supply the fully qualified domain name of the computer running the desired Administration Service instance.
   • Any Administration Service of the same configuration as this one

   Specify any Administration Service whose database holds the desired configuration, by supplying in the fully qualified domain name of the computer running that Administration Service. If Active Roles replication is used to synchronize configuration data, this must be any Administration Service whose database server acts as the Publisher for the configuration database.

5. Click the Configure button to start the configuration process.
6. Wait while the wizard completes the configuration.

Configuration Center creates three Web Interface sites based on the following configuration templates:

• Default Site for Administrators  Supports a broad range of tasks, including the management of directory objects and computer resources.
• Default Site for Help Desk  Handles typical tasks performed by Help Desk operators, such as enabling/disabling accounts, resetting passwords, and modifying select properties of users and groups.
• Default Site for Self-Administration  Provides User Profile Editor, allowing end users to manage personal or emergency data through a simple-to-use Web interface.

Each configuration template provides an individual set of commands installed by default. Once a Web Interface site has been created, you can customize its configuration by adding or removing commands, and by modifying Web pages (forms) associated with commands. The customization procedures are covered in the Active Roles Web Interface Administrator Guide.

After initial configuration, you can modify Web Interface site parameters, such as the Web application alias, create new Web Interface sites, or delete existing Web Interface sites.

Additional configuration

After initial configuration, you can use Configuration Center to create additional Web Interface sites, as well as modify or delete existing Web Interface sites.

When creating Web Interface sites, you have the option to apply the configuration of an existing Web Interface site to the newly created one. If you have the Web Interface site tailored to meet your requirements, and need to deploy its instance on another Web server, this option ensures that the new Web Interface site has the same set of menus, commands and pages as the existing one.

To create, modify or delete a Web Interface site

1. Open Configuration Center.

   You can open Configuration Center by selecting Active Roles Active Roles 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, do one of the following:
   • To create a new site, click Create.
   • To modify an existing site, select the site from the list and click Modify.
   • To delete a site, select the site from the list and click Delete.
4. View or change the following settings in the wizard that appears if click Create or Modify:
   • IIS Web site Specifies the IIS Web site containing the Web application that implements the Web Interface site. You can select the desired Web site from a list of all Web sites defined on the Web server.
   • Alias  Specifies the alias of the Web application that implements the Web Interface site. The alias defines the virtual path used in the address of the Web Interface site on the Web server.
   • Configuration  Specifies customizable settings of user interface elements, such as menus, commands, and Web pages (forms), displayed by the Web Interface. The configuration of each Web Interface site is stored by the Active Roles Administration Service. Multiple sites may use the same configuration. You can choose from the following options:
     • Keep the current configuration  Choose this option when modifying an existing Web Interface site if you do not want to assign a different configuration to that site.
     • Create from a template  Create a new configuration for the Web Interface site based on a template. With this option, you need to supply a unique name for the new configuration and select the desired template.

   Choose this option if you want the Web Interface site to use a separate configuration that is initially populated with the template data.

• Use an existing configuration  Assign an existing configuration to the Web Interface site. With this option, you need to select the desired configuration from a list of configurations found on the Administration Service. The list includes the configurations of the current Active Roles version only.

  Choose this option if you want the Web Interface site to share its configuration with other Web Interface sites. For example, when creating a new instance of a given site for load balancing, you should assign the configuration of that site to the new Web Interface site.

• Import from an existing configuration  Create a new configuration for the Web Interface site by importing data from an existing configuration. With this option, you need to supply a unique name for the new configuration and select the desired existing configuration from a list of all supported configurations found on the Administration Service. The list includes the configurations of both the current and earlier Active Roles versions.

  Choose this option if you want the Web Interface site to use a separate configuration that is populated with the data imported from a configuration of an earlier Active Roles version or copied from a configuration of the current Active Roles version.

• Import from a file  Create a new configuration for the Web Interface site by importing data from an export file. With this option, you need to supply a unique name for the new configuration and select the export file. This can be an export file created by the current Active Roles version or an earlier, supported Active Roles version.

  Choose this option if you want the Web Interface site to use a separate configuration that is populated with the data found in an export file. You could create an export file from the Web Interface page in Configuration Center, by selecting a site and then selecting Export Configuration. Earlier Active Roles versions used the Web Interface Sites Configuration wizard to export Web Interface site configuration data.

Each Web Interface site can be accessed from a Web browser using the address based the Web application alias:

http://<WebSite>/<Alias>

Here, <WebSite> identifies the IIS Web site containing the Web application that implements the Web Interface site and <Alias> stands for the alias of that Web application, as specified in Configuration Center. For example, if the Web application is contained in the default Web site, the address is http://<Computer>/<Alias>, where <Computer> stands for the network name of the computer (Web server) running the Web Interface.

By default, Web Interface users connect to the Web Interface using an HTTP transport, which does not encrypt the data transferred from a Web browser to the Web Interface. If your business process requires a secure transport for passing data to the Web Interface, you should use an HTTPS transport.

The secure hypertext transfer protocol (HTTPS) uses Secure Sockets Layer (SSL) provided by the Web server for data encryption. For instructions on how to enable SSL on your Web server, see “Configuring Secure Sockets Layer in IIS 7” at http://go.microsoft.com/fwlink/?LinkID=108544.

Installing additional components

In addition to the Administration Service, MMC Interface and Web Interface, Active Roles allows you to install the following components:

• Active Roles Management Shell  Provides commands based on the Windows PowerShell platform for managing users, group, computers and other objects in Active Directory via Active Roles; administering certain Active Roles objects; and configuring Active Roles Administration Service instances and Web Interface sites.
• ADSI Provider  Enables custom applications and scripts to access directory data via Active Roles by using standard COM interfaces. Documentation for ADSI Provider can be found in the Active Roles SDK.
• Active Roles SDK  Provides developers with documentation and samples to help them customize Active Roles by creating custom client applications and user interfaces, and implementing business rules and policies based on custom scripts.
• Collector  Gathers data required for reporting. Retrieves data from specified data sources through the Administration Service, and stores the data on SQL Server.
• Report Pack  A comprehensive suite of report definitions that cover various administrative actions available in Active Roles.

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.2 Management Shell
• To view SDK topics, select Active Roles 7.2 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.