Installation and Configuration

IBM Tivoli Directory Integrator

Installation and Configuration

See Installing IBM TDI for information about installing TDI and the Administration and Monitoring Console. Installing AMC also installs the Action Manager. If us choose a custom Tivoli Integrated Portal (ISC embedded) to deploy AMC or defer deployment of AMC during installation, see Deploying AMC to a custom ISC SE or Tivoli Integrated Portal (ISC embedded) for information on additional deployment requirements.

Deploying AMC into the Integrated Solutions Console (ISC)

These instructions require that you be familiar with the IBM TDI 7.1 Installation procedures. See Using the platform-specific TDI installer for information about TDI Installation. Installing AMC also installs the Action Manager.

If we want to deploy TDI Administration and Monitoring Console into the ISC automatically, select one of the following options:

Embedded instance of ISC SE
Existing instance of ISC

If we do not want to deploy AMC into ISC automatically at installation time, select "Do not specify. I will manually deploy AMC at a later time."

The installer automatically installs ISC and deploys AMC in it if we select "Embedded instance of ISC SE" or "Existing instance of ISC" during IBM TDI 7.1 installation.

To install and deploy the Administration and Monitoring Console into the ISC SE:

Invoke the TDI 7.1 installer.
During installation, select the Custom installation. (Typical installation does not offer the AMC option.)
On the "Select Features" window of the installation, select AMC: Administration Monitoring Console and embedded Web platform (includes Integrated Solutions Console, Standard Edition (ISC SE).
Finish installing TDI 7.1.

Deploying AMC as a Windows service or UNIX process using the TDI installer

We can register AMC as a Windows service or UNIX process if the following conditions are satisfied:

We cannot register AMC as a service on i5/OS.

The person installing TDI must have administrative permissions (Administrators group on Windows or root on UNIX).
We have selected to install AMC into an "Embedded instance of ISC Standard Edition."
We have selected "Register AMC as a system service" and given the service a name. The default service name is tdiamc

Starting the Administration and Monitoring Console and Action Manager and logging in

We can start and stop the Administration and Monitoring Console and Action Manager by running the following scripts shipped in the TDI_install_dir/bin/amc folder:

To start AMC, run the start_tdiamc script.
To start AM, run the startAM script.

For more information about these scripts, see AMC and AM Command line utilities.

The above will start AMC and AM using a Derby database configured locally on the machine running in network mode on localhost at port 1528. For more information on alternate settings and configurations for both AMC and AM, see sections Enabling AMC and Enabling Action Manager.

Once the Administration and Monitoring Console is started, you can access it from the following URL: http://localhost:13100/ibm/console; for more information, see Log in and logout of the console.

Stopping AMC and AM can be accomplished by running the stop_tdiamc and stopAM scripts, respectively.

Notes:

For information on adding users and user roles, see section Console user authority.
For information on AM, see section Action Manager.
For information on usage of individual panels in AMC, see the online panel help, or section Administation and Monitoring Console User Interface.
We will be registering TDI Servers in AMC so that solutions from TDI configurations can be administered. AMC will only be able to find Configs that each TDI server has loaded when its started up. By default, TDI 7.1 Servers have the remote server API enabled. Ensure that our TDI_install_dir/configs folder has the Configs we want to administer and monitor (or put them in the config folder of the solution directory if your server is using a solution directory).
For an example walk through of on using AMC and Action Manager for a few simple tasks, see Example walkthrough of creating a Solution View and Rules.

Enabling AMC

The configuration file for the Administration and Monitoring Console is the amc.properties file that is located at the same level as the WEB-INF directory. This file contains the AMC's database configuration properties, LDAP properties, SSL related properties and help server details.

By default, the Administration and Monitoring Console makes use of Derby version 10 to store data. When AMC is started for the first time, AMC creates a tdiamcdb folder inside the Web server directory and creates the tables needed for AMC to function. The Derby database can be accessed in either the network mode or embedded mode. By default, AMC is shipped with Derby configured in network mode. The following properties in amc.properties are applicable to Derby configured for network mode:

com.ibm.di.amc.jdbc.database=jdbc:derby://localhost:1528/tdiamcdb;create=true
com.ibm.di.amc.jdbc.driver=org.apache.derby.jdbc.ClientDriver
com.ibm.di.amc.jdbc.urlprefix=jdbc:derby:
com.ibm.di.amc.jdbc.user=APP
com.ibm.di.amc.jdbc.password=APP
com.ibm.di.amc.jdbc.start.mode=automatic
com.ibm.di.amc.jdbc.host=localhost
com.ibm.di.amc.jdbc.port=1528
com.ibm.di.amc.jdbc.sysibm=true

The property com.ibm.di.amc.jdbc.database points to Derby in network mode, running on localhost:1528. The database name being accessed is tdiamcdb, and create=true, indicating that AMC should create the database if not found.

You should change the create=true to create=false once your environment is set, so that in case the database path gets modified, AMC does not re-create the database, but instead throws a "Database not found" exception. You should also ensure that the database path be set to an absolute path to avoid any confusion about the database path later.

Other databases than Derby can be configured by setting the appropriate properties; see JDBC Properties.

AMC provides a separate startup and shutdown script for Action Manager. AMC allows the Action Manager to run remotely and provides a separate Derby start or shutdown script.

The Administration and Monitoring Console can also be configured to connect to the Derby database in Embedded Mode. In this case, the Action Manager, a separate application that also talks to the AMC database, is unable to connect to AMC's database. This is because in Embedded Mode, only one JVM at a time is allowed to connect to the Derby database. The following example shows the amc.properties file with Derby configured for embedded mode:

##Location of the database (embedded mode)
configured for embedded mode: 
##Location of the database (embedded mode)
com.ibm.di.amc.jdbc.database=tdiamcdb
com.ibm.di.amc.jdbc.driver=org.apache.derby.jdbc.EmbeddedDriver
com.ibm.di.amc.jdbc.urlprefix=jdbc:derby:
com.ibm.di.amc.jdbc.user=APP
com.ibm.di.amc.jdbc.password=APP

The com.ibm.di.amc.jdbc.database property points to the location of the AMC database. We suggest that this value be set to an absolute path to avoid any confusion about the database path later.

Running Action Manager remotely

Beginning with TDI 7.0, we can run Action Manager remotely without starting the AMC first. The database for AMC, Derby, must be running in Network mode in order for Action Manager to connect to it. TDI 7.0 also provides start and shutdown scripts for the Derby data store so that a user can start Action Manager remotely without starting the AMC.

Notes:

Before we start Action Manager for the first time, you must have run AMC at least once. This is because AMC creates the necessary database tables required for AM.
We can find the scripts in this section in the following folder of the Install Directory of the remote computer: TDI_install_dir\bin\amc\ActionManager\.
The instructions in the startup and shutdown sections that follow are for Action Manager and Derby running on different remote computers, and with AMC not running.
To verify that AMC, Action Manager or Derby has stopped, check the logs.

AMC and Action Manager startup

If we want to run Action Manager and Derby with AMC running, start AMC by typing start_tdiamc.bat(sh) and start the Action Manager by typing startAM.bat(sh). The tidamc script calls the startNetworkServer.bat(sh) script, thereby starting the Derby database in network mode.

The startAM.bat(sh) script has the Classpath defined for all the jars required by the Action Manager. There are two variables namely CLASSPATH and DB_CLASSPATH. The DB_CLASSPATH has the path separated list of JAR files required for achieving JDBC Connectivity with the database. When AMC is configured to use Oracle, MS SQL Server or DB2 the corresponding JDBC JAR files of these databases should be added to the DB_CLASSPATH variable.

AMC and Derby shutdown

The stop_tdiamc.bat(sh) script calls the stopNetworkServer.bat(sh) script. This ensures that the Derby Network server is stopped when AMC is shutdown.

If Action Manager (AM) is running, this should be shut down first.

Action Manager remote startup

This section assumes that Action Manager and Derby are running on different computers.

Start Derby using the script startNetworkServer.bat(sh).
Start Action Manager using the script startAM.bat(sh).

The startNetworkServer script is used for starting the Derby database server in Network mode. The Derby server starts in Network mode on port 1528. The port selected is different from the default port for Derby.

Action Manager shutdown

The Action Manager is stopped using the stopAM.bat(sh) script located in the TDI_install_dir/bin/amc directory. This script uses the processID of the started AM to kill it. The processID is obtained by the startAM script and is stored in a file, which in turn is read by the stopAM script.

To stop the Derby database, type stopNetworkServer, which stops the Derby database server in Network mode. This should be done after AM is stopped, not before.