Use Case Deployment Quick Reference

This chapter describes step-by-step setup and removal procedures that you can use for the use cases described in this document.

The information and instructions given here have been extracted from information and procedures in the DirX Identity documentation set and tailored to the specifics of deploying and maintaining these use cases. The referenced DirX Identity documentation includes:

  • Installation Guide – the sections "Using the Configurator" and "Installing Single Components".

  • Connectivity Administration Guide – in the chapter "Managing DirX Identity Servers", the sections "Managing the Java-based Server" and "Distributed Deployment and Scalability".

  • High Availability Use Case Document – the subsection "Java-based Server" in the "Configuration" section.

Note that installation and removal procedures and configuration details may change as new versions of DirX Identity are released. Be sure to consult the reference documentation listed above for the latest installation and removal procedures and configuration details.

Deploying a Complete Additional Domain

The following sections describe how to set up an additional domain and the first related Java-based Server and Web Center.

Note that we do not describe SSL configuration issue here. See the DirX Identity Connectivity Administration Guide for information about this topic.

To set up the complete additional domain:

  1. Launch the configuration tool:

    Start → All Programs → Atos DirX Identity V*n.n → *Configuration

  2. Click Next to proceed to the Configuration Options step. Check that the Domain Configuration, Java-based Server and Web Center options are selected.

  3. Proceed to the next step Directory Server for Connectivity and enter the host and port information of the directory server where your Connectivity configuration resides.

  4. Proceed to the next step Directory Server for Provisioning and enter all necessary data for the directory server where your Provisioning configuration resides.

  5. Click Next to proceed to the DirX Identity Administrators dialog and enter the information for both administrators.

  6. Click Next to proceed to the Domain Configuration step. Select Configure a customer domain.

  7. The configuration process displays input fields for specifying the data for your domain. In the Domain field, specify your domain name.

  8. Review the value in the Technical Domain Name field. You can change this name, but we recommend keeping it as similar as possible to the domain name you previously entered.

  9. Add a password for the account DomainAdmin and store it in a safe place.

  10. Click Next to proceed to the Java-based Server step. Be sure that <Create a new Java Server> is selected in the field Server to update or create.

    Specify Port and JMX port so that they are different from each other and from the ports used for the other co-located Java-based Servers.

    Specify the Dynamic port range so that it does not conflict with any other ports.

  11. Click Next to proceed to the Web Center Information step. In this step, you specify the appropriate data for Web Center. This step is optional. (See the subsection "Web Center Information" in the section "Using the Configurator" in the chapter "Configuring DirX Identity" in the DirX Identity Installation Guide for details.)

  12. Click Next to proceed to the Pre-Configuration Summary step. Carefully review your input data in this summary and then start the configuration process by clicking Next.

Wait until the configuration process is complete. Click Finish.

The following sections provide information about the results of the configuration process.

Post-Configuration Results - Additional Java-based Server

On Windows platforms, the configurator creates:

  • The service IdS-J-technical_domain_name-S1 version. For example:

DirX Identity IdS-J-My-Company-S1 V8.3

  • The file system install_path/ids-j-technical_domain_name-S1 for the new Java-based Server.

On Linux platforms, the configurator creates:

  • The script S99dmsvr-technical_domain_name-S1 in the folder install_path/etc for starting and stopping the related Java-based Server.

  • Command to start this Java-based Server:
    S99dmsvrj-technical_domain_name-S1 start

  • Command to stop this Java-based Server:
    S99dmsvrj-technical_domain_name-S1 stop

  • The file system install_path/ids-j-technical_domain_name-S1 for the new Java-based Server.

Post-Configuration Results - Web Center

After configuring the Web Center for a domain (also for a first Web Center), the configuration process results are:

  • A Web Center instance for the related domain accessible by the URL http://*host.tomcatport/webCenter-*technical_domain_name. On UNIX platforms, you must restart tomcat before you are able to access Web Center.

  • The file system install_path*/web/webCenter-*technical_domain_name

  • The configuration file webCenter-*technical_domain_name.xml in the subfolder *conf/Catalina/localhost of the tomcat installation.

Deploying Additional Components

There are several options that you can configure freely as required. For any of the use cases described in this document, you can:

  • Set up additional Java-based Servers for each of the configured domains to distribute load and separate applications.

  • Set up additional Web Center applications.

You may want to add more of these components to improve the performance of the solution that you’ve set up according to the use cases described in this document. The next sections describe how to add these components. For a detailed description of scalability and distribution in DirX Identity, see the following documentation:

  • High Availability Use Case Document

  • The section "Distributed Deployment and Scalability" in the chapter "Managing DirX Identity Servers" in the DirX Identity Connectivity Administration Guide.

These documents describe the methods that are available for distributing process workload and separating processes.

Setting up Additional Java-based Servers

This procedure consists of two steps:

  • Setting up the Java-based Server

  • Distributing the workflow types and adaptors

Setting up the Java-based Server

For each additional Java-based Server you want to create:

  • Run the Configurator (either Configuration or Initial Configuration).

  • Select the Java-based Server Configuration from the Configuration Options.

  • Define the domain name in the Domain Configuration step.

  • Select Create a new Java Server from the dropdown list of the Server to update or create field of the Java-based Server step.

  • Define the relevant parameters. Be careful to use free ports.

Distributing Workflow Types and Adaptors

You can configure each Java-based Server for specific workflow types or for specific adaptors. For example, you can configure one Java-based Server to handle request workflows, a second Java-based Server to handle user and account password change workflows, a third one to handle entry change workflows and a fourth one to handle provisioning request workflows.

For each Java-based Server to be created and configured:

  • Start DirX Identity Manager (Connectivity view group) and then select Expert View.

  • Open Configuration → DirX Identity Servers → Java Servers. You should see all your configured server instances and if you open them all created adaptors.

  • Select Manage IdS-J Configuration from the context menu of a Java Server node.

  • In the Adaptors tab, activate the relevant adaptors for this service instance and deactivate the ones that should not be active. By default, all adaptors are activated.

  • In the Request Workflow Timeout Check tab, select exactly one server to run the Request Workflow Timeout Check.

  • In the Scheduler tab, select exactly one server to run the Scheduler.

  • Click OK to store the configuration or Cancel to abort it.

  • Restart all Java-based Servers to load the updated configuration. Perform the restart by stopping all Java-based Servers; after the last server is stopped, start them all again.

  • Use Web Admin to check that the adaptors are configured correctly.

Setting Up Web Center Applications

You can use the Configuration tool to set up one Web Center application for one domain. If you want to set up additional Web Center applications to distribute load or tasks, you can do it manually by performing the steps described below in the manual configuration section.

Setting Up a Web Center Application with the Configurator

  • Run the Configurator (either Configuration or Initial Configuration).

  • Select the Web Center Configuration from the Configuration Options.

  • Define the domain name in the Domain Configuration step.

  • Finish the configuration.

  • Repeat this procedure for every domain where a Web Center has not already been configured.

The Configurator extracts all Web Center files in webManager.zip to the domain specific folder install_path*\web*\webCenter- domain, configures the files web.xml and webCenter.xml with some necessary parameters like server name, user bind name and tomcat path and then deploys the application to Tomcat.

Setting Up an Additional Application Manually

  • Extract webManager.zip to your desired folder_name under install_path\web.

  • Copy webCenter.xml to folder_name.xml.

  • Specify the folder in docBase of folder_name.xml.

  • Deploy folder_name.xml to Tomcat.

  • Adapt the Tomcat path in install_path\web\folder_name\endorsed\postInstallWebMgr.bat (or .sh) and then call the script to update some jar files in the Tomcat-endorsed folder.

  • Adapt the parameters in install_path\web\folder_name\Web-inf\web.xml to your needs.
    For a detailed description of the web.xml parameters, see the chapter "Using DirX Identity Web Center → Configuring the Web Center → Using the Web Center Configuration File" in the DirX Identity User Interfaces Guide.

  • Configure the bind passwords in install_path\ web\folder_name\Web-inf\password.properties.

Removing Additional Components

The following procedures help you to cleanse your environment of nonessential Java-based Servers or Web Center instances.

Removing an Additional Component

This section provides instructions for unconfiguring and removing an additional Java-based Server and an additional Web Center application.

Removing a Java-based Server

Before you remove a Java-based Server, be sure to move all tasks of this server to one of the remaining servers.

Windows Platform

To unconfigure an additional Java-based Server:

  1. Stop the related Java-based Server.

  2. Unregister the service:
    Run the script unregisterNTServer.bat in the folder install_path/ids-j-technical_domain_name-Sn/bin.

  3. Remove the related Java-based Server configuration entry.

  4. Delete the corresponding file folder in the installation area.

Linux Platform

To unconfigure an additional Java-based Server:

  1. Stop the related IdS-J Server:
    Run the script S99dmsvrj-technical_domain_name in the folder install_path/etc.

  2. Remove the script S99dmsvrj-technical_domain_name from the folder install_path/etc.

  3. Remove the related Java-based Server configuration entry.

  4. Delete the corresponding file folder in the installation area.

Removing an Additional Web Center

To unconfigure an additional Web Center:

  1. Stop the Tomcat service used by the Web Center.

  2. Remove the configuration file webCenter-technical_domain_name.xml from the subfolder conf/Catalina/localhost of the tomcat installation.

  3. Delete the corresponding file folder under the web subfolder in the installation area.