Lotus Domino Administrator 8.5 Help - Enabling the Domino server to communicate with the DB2 server

DOMINO AND DB2

Enabling the Domino server to communicate with the DB2 server
Use the DB2 Server Enablement Tool, available from the IBM® Lotus® Domino® Administrator client, to automatically enable Domino to access an IBM® DB2 Universal Database™ Enterprise Server Edition server. Or, you can manually enable Domino to access a DB2 server. When you enable a Domino server for DB2, Domino stores its IBM® Lotus® Notes® data in DB2. When a Notes database is enabled for DB2, Domino creates a DB2 database schema for it, as well as a set of tables in that schema to hold the Notes database data. The schema name is based on the NSF file name.

The DB2 Server Enablement Tool is the recommended method of enabling Domino access to a DB2 server. The DB2 Server Enablement Tool does the following:

Checks for a valid DB2 library path and does one of these:
Inserts the DB2 user name and password in the Domino server ID.
Checks the accuracy of the DB2 information that you entered. (If any DB2 information is incorrect, the Enable Server for DB2-Based Data dialog box displays with the focus in the field containing the incorrect information.) If the DB2 information is accurate, Domino does the following:
Enables DB2 as a data store for Domino, which enables Domino to use DB2. The fact that DB2 is used as a data store is transparent to Notes client users. Only administrators are aware of this. Notes users use Domino Notes as usual; Domino uses DB2.
The DB2 database is created when the Domino server starts up after the DB2-enablement process. Domino uses the administration process to create that database, and the administration process requires that the administration server is running. After the database is created, the default schemas, domino.catalog, and other objects are created.

The administration process posts an administration request in the local copy of the Administration Requests database (ADMIN4.NSF). The replicator then replicates ADMIN4.NSF to the administration server. The administration process on the administration server processes the administration request and updates the Server document with the new information. The replicator then replicates the changes to the Server document on the originating server.

The Domino server user

The Domino server user name and password are stored in the Domino server's ID file. The Domino server user account enables Domino to access a DB2 server. Create one Domino server user account for each Domino server.

Note If you are using Microsoft Windows and you have already created a system control group to which you want to add the Domino server user, add the Domino server user to that group.

After creating the Domino server user account, create a Domino server user group named DB2DOM and add the Domino server user to that group. You must then manually define DB2DOM as a system control group in DB2. The system control group parameter assigns system control (SYSCTRL) authority to the group name. The Domino server user account is a member of the DB2DOM group that has SYSCTRL authority; and as such, the Domino server user account has the right to allow Domino to access the DB2 server. The Domino server user has complete authorization over the DB2 database and its contents. This server user acts on behalf of all Notes users.

Note If you have a Windows user account that you want to use as the Domino server user, begin this process with Step 3 of the procedure in the topic Manually creating the Domino server user account and the DB2DOM group.

Activating the SYSCTRL_GROUP setting

This information applies regardless of whether you use the Server Enablement Tool or you manually create the Domino server user and DB2DOM group. If the SYSCTRL_GROUP is set up for the first time in DB2, stop and start the DB2 server by issuing the following commands from the DB2 Command Line Processor (CLP):

DB2STOP

DB2START

To successfully create the original DB2 database during the server enablement process, you must be logged on to the Domino server with a user name that meets this criteria:

You must be logged on to the Domino server with the user name of the owner of the Domino server
The user name must be in the SYSADM group
The user name must meet DB2 naming conventions for the platform on which you are running the Domino server. For information about the DB2 naming conventions, see the DB2 Information Center.

You can view a list of NOTES.INI variables that are added when you run the DB2 Server Enablement Tool, in the topic NOTES.INI variables set by the DB2 Server Enablement Tool.

In this procedure, all of the steps apply to all supported platforms unless there is a notation at the beginning of the step that indicates it is for IBM® AIX® only or Microsoft Windows only. If a step does not apply to your configuration, just omit that step and proceed to the next step.

Prerequisites

1. From the Domino Administrator, point to the server you are enabling.

2. Have this information available before you begin the procedure:

The name of the DB2 instance that you created when you installed DB2. If you are using Microsoft Windows, the default instance name is DB2; on AIX, it is whatever you named it.
The Domino server account name and password. This is a user name created at the OS level that will be used by the Domino server to access the DB2 server. This user account must have at least SYSCTRL_GROUP access in DB2 or it must be a member of the group, DB2DOM.
The server ID that you created for the DB2 Access server.
The location where you installed the DB2 Access server. This path is used in the DB2 Access Path field of the Server document and in the DB2 Server Enablement tool.

Procedure

1. From the Domino Administrator, click Configuration.

2. Click DB2 Server -- Enable Server for DB2.

Note

If the feature Enable Server for DB2 is not active, the Domino server is already enabled for DB2, or you are using a pre-Domino 7 version of the Lotus Domino and Notes software, or you are using a platform other than Microsoft® Windows® or IBM AIX.

3. Complete these fields:

Field	Action
DB2 and Domino are on different systems or DB2 is 64-bit on AIX server	If any of these conditions are true, click this check box: DB2 and Domino are installed on different computers. 64-bit DB2 instance is used on the DB2 AIX server. You are using the DB2 Run-Time Client on the Domino server.
DB2 Instance Name	Enter the DB2 instance name that you created when you installed the DB2 server. Note This field only applies to local configurations.
DB2 Datastore Directory	(Optional) Enter the full path and name of the directory where the DB2 group data will be stored relative to the Domino server. For example, In Microsoft Windows®, a sample path is: c:\db2db\srvr\ In IBM AIX, a sample path is: /local1/db2inst1/db2dir/ Users must have appropriate access rights for the directory that you enter. Note If multiple Domino servers are connected to different instances of the same DB2 server, the directory that you specify must be unique for each Domino server, or the Directory field must be blank for each Domino server. This is an advanced setting and in most cases, the default can be used.
DB2 Database Name	Enter a database name, or accept DOMINO as the default DB2 database. The DB2 database name is stored in the NOTES.INI variable DB2DATABASE. If you later delete or modify this value, Domino's DB2 capabilities are effectively disabled. The DB2 database name is used as the basis for the names of the database, buffer pool, tablespaces, and schema.
Host Name	Enter the name of the remote server that will store data. This field applies only to remote configurations.
Port Number/Service Name	Enter the port number or service name for the remote instance of DB2. This field applies only to remote configurations. Open the DB2 Control Center to obtain this information, and then right click the instance to which you are connecting. Select "Setup Communications." Review the TCP/IP properties. An example of a service name is db2c_DB2. An example of a port number is 50000. You can use either in this field.
OS account name to be used by Domino to access DB2	This user name is an operating system user account name that Domino uses to access the DB2 server. This is a Microsoft Windows® or IBM® AIX® account. If you are using IBM AIX, you can only enter an existing user account name; you cannot create one from this dialog box. Do one: Enter a new name to create the new user account. This option applies only to Microsoft Windows. Enter an existing user account name if you have created one that you want to use. It must be an OS user account name.
DB2 Password	Enter the password for the new or existing user account name that you entered in the field "OS account name to be used by Domino to access DB2." that The Domino server uses this password to access the DB2 server.
Verify DB2 Password	Reenter the password.
DB2 Password Expiration	Number of days after which the DB2 password expires. This is the OS account password that Domino uses to access the DB2 server.
Update system account password	Click this check box to update the OS system account password that Domino uses to access the DB2 server. When the check box is not checked, the password is stored but the OS server account password is not updated.
DB2 Node Name	This field applies if you have a remote configuration or if you are using a 64-bit DB2 instance on a DB2 AIX server. Enter the DB2 node name, that is, the name assigned to the DB2 server in the DB2 Node Directory. The node name acts as a pointer to the DB2 database, allowing you to access the DB2 server. The node name you enter cannot be a name that is assigned to another entity in the DB2 configuration. For example, the node name cannot be identical to the DB2 instance name nor the Domino server name. The DB2 server enablement tool uses the DB2 node name to create the DB2 node.
By default, create databases as	Choose one: DB2 (default) -- Creates DB2 databases. NSF -- Creates Domino NSF databases.
Immediately update the server's Domino Directory with DB2 information	Click this check box to update the Domino Directory immediately instead of waiting for the administration process to initiate the update.
Automatically restart the Domino server upon successful enablement	Click this check box to restart the server after the DB2 Server Enablement Tool runs and the DB2 information is added to the Domino Directory.

Database storage types are described in the topic Databases created with Domino.

4. Click Enable.

5. One of these occurs, according to platform:

Microsoft® Windows® -- A status box displays. If there are no errors, click OK.
IBM® AIX® or Linux® -- A series of messages appears. Review the messages, and then click Stop or Continue according to what you want to do.

If you are using a remote DB2 server, see the topic Using a remote DB2 server with server enablement.

If you are working with a Microsoft® Windows® platform, return to the roadmap topic Installing Domino and DB2 on Microsoft Windows platforms.

If you are working on an IBM® AIX® platform, return to the roadmap topic Installing Domino and DB2 on IBM AIX and Linux platforms.

Installing Domino and DB2 on IBM AIX and Linux platforms

Granting SETSESSIONUSER privilege to the Domino server user

Manually creating the Domino server user account and the DB2DOM group

NOTES.INI variables set by the DB2 Server Enablement Tool

Databases created with Domino

Additional documentation resources

Glossary

Feedback on Help or Product Usability?

Help on Help

All Help Contents

Glossary