IBM Content Navigator, Version 2.0.3         

Worksheet content references

Use this topic to create content references for the installation and configuration worksheets.

Table 1. Parameters that are used in multiple worksheets
Parameter Description Value
Configure IBM® Content Navigator for SSO IBM FileNet® P8 users only.

If you have an IBM Tivoli® Access Manager for e-business environment for SSO, you can select this option to enable IBM Content Navigator for single sign-on by using Tivoli Access Manager SSO.

If you have a Kerberos environment for SSO, you can select this option to enableIBM Content Navigator for Kerberos SSO.

Important: This option does not apply if you also configure this instance of IBM Content Navigator to connect to IBM Content Manager Enterprise Edition or IBM Content Manager OnDemand.

Specify whether this option applies to your environment.

  
JDBC driver

The JDBC driver that corresponds to the type of database where you will store IBM Content Navigator configuration data.

IBM Content Navigator supports the following JDBC drivers:
  • DB2® Universal JDBC Driver
  • DB2 for z/OS® Universal JDBC Driver (available on WebSphere® Application Server only)
  • DB2 Universal JDBC Driver (pureScale or HADR) (available on WebSphere Application Server only)
  • Microsoft JDBC Driver
  • Oracle JDBC Driver
  • Oracle JDBC Driver (RAC Support)
Remember: You must copy the JDBC driver for your database to the IBM Content Navigator server.

In addition, if you are deploying on Oracle WebLogic Server, you must add the JDBC driver class path to the Oracle WebLogic Server startup script. For more information, see Preparing Oracle WebLogic Server for IBM Content Navigator.

  
JDBC driver The JDBC driver that corresponds to the type of database where you will store IBM Content Navigator configuration data.
IBM Content Navigator supports the following JDBC drivers:
  • DB2 Universal JDBC Driver
  • DB2 for z/OS Universal JDBC Driver
  • DB2 Universal JDBC Driver (pureScale or HADR)
  • Microsoft JDBC Driver
  • Oracle JDBC Driver
  • Oracle JDBC Driver (RAC Support)
Remember: You must copy the JDBC driver for your database to the IBM Content Navigator server.
  
JDBC directory The directory where you installed the JDBC driver files on your IBM Content Navigator server.

If you plan to deploy IBM Content Navigator in a highly available cluster, you must copy the driver files to the same directory on each node in the cluster.

  
Deployment type The type of environment where the web application will be deployed. Valid values are:
Cluster
A highly available server cluster
Network Deployment
A WebSphere Application Server Network Deployment environment without a cluster
Standard
A stand-alone server
  
Application server node Standard and Network Deployment deployments only.

The node where the web application will be deployed.

 
Application server name Standard and Network Deployment deployments only.

The server where the web application will be deployed.

 
Application server cluster name Cluster deployments only.

The cluster where the web application will be deployed.

 
Application server virtual host The virtual host where the web application will be deployed.  
Database host name The short name, long name, or the IP address of the server where the IBM Content Navigator database software is installed.  
Database port The port number that is used by the database instance where you want to create the IBM Content Navigator configuration table.  
Database port The port number that is used by the database instance where you want to create the IBM Content Navigator configuration table. The default port is 50000.  
Database port The port number that is used by the database instance where you want to create the IBM Content Navigator configuration table. The default port is 446.  
Database port The port number that is used by the database instance where you will create the IBM Content Navigator database table. The default port is 1433.  
Database port The port number that is used by the database instance where you will create the IBM Content Navigator database table. The default port is 1521.  
Oracle JDBC RAC data The list of database host names and port numbers in your Oracle Real Application Cluster (RAC). Separate the host name and port number with a colon (:). Separate each server entry with a comma (,). For example, enter: host_name1:port_1,host_name2:port_2.  
Database service name The name of the database that you created to store the IBM Content Navigator configuration data and user preferences. This is the database where you want to create the IBM Content Navigator configuration table. You must specify an existing database.  
Oracle RAC retries The number of attempts for the Oracle Real Application Clusters (RAC). This value determines the number of times that communication with the list of servers in the Oracle cluster is attempted before the connection to the database fails. The default number of attempts is 32.  
Oracle RAC delay The amount of delay, in seconds, between attempts to connect to the list of servers in the Oracle Real Application Clusters (RAC). The default delay is 4 seconds.  
Database instance name The unique name to use for the web client when connecting to the IBM Content Navigator configuration database.

The name must contain 1 - 8 characters. The name cannot contain spaces or special characters.

  
Database storage group The volumes where the IBM Content Navigator database table and indexes will be stored.

Specify the value that you used when you created the IBM Content Navigator database. If you used the sample script to create your database, this is the ECMClient_STOGROUP parameter.

  
Storage group option The storage group options recommended by your database administrator. The storage group options are part of the SQL command CREATE INDEX USING STOGROUP. IBM Content Navigator uses the storage group options to create an index for the database. The default option is PRIQTY 10 SECQTY 5.  
Retry interval for client reroute The time (in seconds) between connection attempts made by the automatic client reroute if the primary connection to the server fails.  
Maximum retries for client reroute The maximum number of connection attempts made by the automatic client reroute if the primary connection to the server fails.  
Alternate server name and port number The list of alternate server names and port numbers for the DB2 server. Separate the server name and port number with a colon (:). Separate each server entry with a comma (,). For example, enter: host_name1:port_1,host_name2:port_2.  
Database name The name of the database that you created to store the IBM Content Navigator configuration data and user preferences. This is the database where you want to create the IBM Content Navigator configuration table. You must specify an existing database.  
JDBC data source name The name of the non-XA JDBC data source that you want to create to communicate with the IBM Content Navigator database. The name must be unique and cannot contain spaces. The default name is ECMClientDS.

You cannot run this task if the data source name exists on your web application server. It is recommended that you remove the existing data source by using your application server administration tools before you run this task.

  
Database user name The name of the database user that theIBM Content Navigator data source will use to connect to the database.

The user must have INSERT, DELETE, and SELECT authority on the IBM Content Navigator configuration table.

  
Database user name The name of the database users that the IBM Content Navigator data source will use to connect to the database.

The user must be an SQL server user with rights to the database.

  
Database user name The name of the database users that the IBM Content Navigator data source will use to connect to the database.

The user must be a table space owner.

  
Database user name The name of the database user that the IBM Content Navigator data source will use to connect to the database.

The user must be a table space owner.

This parameter is the ECMClient_SCHEMA parameter in the database script, ORACLE_ONE_SCRIPT.sql.

  
IBM Content Navigator administrator The name of the user that you want to use as the IBM Content Navigator administrator.
Important: This user must be an existing web application server user name or LDAP user name.

This parameter is the ECMClient_ADMINID parameter in the database script, ORACLE_ONE_SCRIPT.sql.

  
Database administrator The name of the database administrator.  
Database user password The password of the specified database user.  
Table space name The name of the table space that you want to create on the IBM Content Navigator configuration database.

This parameter is the ECMClient_TBLSPACE parameter in the database script, ORACLE_ONE_SCRIPT.sql.

The table space name is also used for the following parameters:
  • The name of the datafile is ECMClient_TBLSPACE
  • The name of the tempfile is ECMClient_TBLSPACE@TEMP
If you need to create the datafile table space or the tempfile table space in a specific location on the database server, work with your Oracle database server administrator to modify and manually run the script on the database server.
  
Run the script to build and populate the database You can use the IBM Content Navigator Configuration and Deployment Tool to run the script that is generated by this task on your database server.

When you run this script, it creates the objects that you identified in this task on the database and populates the database with the default configuration.

If you do not select this option, you must manually run the updated script on your database server to create the IBM Content Navigator configuration table on your database instance. You must complete this step after you deploy the web application but before you administer the web client.

Specify whether this option applies to your environment.

  
JDBC driver version The version of the JDBC driver that is installed on the IBM Content Navigator database server.  
JDBC configuration script The fully qualified path of the JDBC data source configuration script. The name of the script depends on the web application server you are using:
  • On Oracle WebLogic Server, the script is configureWLJDBC.py.
  • On WebSphere Application Server, the script is configureWSJDBC.tcl.
  • On AIX®, the default directory is /opt/IBM/ECMClient/configure/scripts/script_name.
  • On Linux, the default directory is /opt/IBM/ECMClient/configure/scripts/script_name.
  • On Linux for System z®, the default directory is /opt/IBM/ECMClient/configure/scripts/script_name.
  • On Windows, the default directory is C:\Program Files (x86)\IBM\ECMClient\configure\scripts\script_name.
  
Database failover support enabled You can enable connection validation (WebSphere Application Server) or automatic connection testing (Oracle WebLogic Server) on the data source to decrease the likelihood of the web client encountering a connection failure to the database.

For more information on connection validation and automatic connection testing, see your web application server documentation.

Specify whether this option applies to your environment.

Note: This description is different from the description in the IBM Content Navigator Configuration and Deployment Tool. Refer to this description when completing the task.
  
IBM Content Navigator application name The name to display for the application on the web application server (for example, in the administrative console). See your web application server documentation for naming restrictions.

The default name is navigator.

Important: On IBM WebSphere Application Server, each application in a cell must have a unique name.
  
Temporary directory The fully qualified path to a temporary directory that the IBM Content Navigator Configuration and Deployment Tool can use to run the task. You must have read and write access for the directory.

The default directory is the \configure\tmp subdirectory of the IBM Content Navigator installation directory.

It is recommended that you use the default value.

  
Deployable EAR file The fully qualified path of the web application EAR file.
Important: The EAR file must be generated by running the IBM Content Navigator Configuration and Deployment Tool.
  • On AIX, the default path is /opt/IBM/ECMClient/configure/deploy/navigatorEAR.ear.
  • On Linux, the default path is /opt/IBM/ECMClient/configure/deploy/navigatorEAR.ear.
  • On Linux for System z, the default path is /opt/IBM/ECMClient/configure/deploy/navigatorEAR.ear.
  • On Windows, the default path is C:\Program Files (x86)\IBM\ECMClient\configure\deploy\navigatorEAR.ear.

It is recommended that you use the default value.

  
Database type The type of database that your Content Manager library server uses. Valid values are:
  • DB2
  • DB2ZOS
  • ORACLE
  
Library server host name The fully qualified host name of the machine where the library server resides. The name is the value that is specified for the ICMHOSTNAME variable in the cmbicmsrvs.ini file.  
Library server database name The existing name of the library server database. The default value is icmnlsdb. The name is the value that is specified for the ICMREMOTEDB variable in the cmbicmsrvs.ini file.  
Library server schema name The existing schema name of the library server. A schema name is an identifier, similar to a user ID, that is used to group tables and other database objects together. The default value is icmadmin. This name is the value that is specified for the ICMSCHEMA variable in the cmbicmsrvs.ini file.  
Database port number The port number that the system administration client uses to access the library server. This is the value that is specified for the ICMPORT variable in the cmbicmsrvs.ini file.  
Database instance name DB2 for z/OS users only.

You must enter the Library server database name for this parameter.

Note: This description is different from the description in the IBM Content Navigator Configuration and Deployment Tool. Refer to this description when completing the task.
  
Library server connection ID The database connection ID of the user that is authorized to connect to the library server. The default value is icmconct. You can obtain this ID from your Content Manager administrator.  
Connection ID password The password for the specified connection ID. You can obtain this password from your Content Manager administrator.  
Database storage group DB2 for z/OS users only

The volumes where the Content Manager library server indexes are stored.

Important: This description is different from the description in the IBM Content Navigator Configuration and Deployment Tool. Refer to this description when completing the task.
  
Database user name The name of the database user that the IBM Content Navigator data source will use to connect to the database.

The user must have INSERT, DELETE, and SELECT authority on the IBM Content Navigator configuration table.

Important: If you want to run the script from the IBM Content Navigator Configuration and Deployment Tool, the user must have SYSADM authority.

This parameter is the ECMClient_DBUSER parameter in the database script, DB2_ONE_SCRIPT.sql.

  
IBM Content Navigator administrator The name of the user that you want to use as the IBM Content Navigator administrator.
Important: This user must be an existing web application server user name or LDAP user name.

This parameter is the ECMClient_ADMINID parameter in the database script, DB2_ONE_SCRIPT.sql.

  
Schema name The name that you want to use for the schema when you create the IBM Content Navigator database table. See your database documentation for naming restrictions.

This parameter is the ECMClient_SCHEMA parameter in the database script, DB2_ONE_SCRIPT.sql.

  
Table space name The name of the table space that you want to create on the IBM Content Navigator configuration database.

This parameter is the ECMClient_TBLSPACE parameter in the database script, DB2_ONE_SCRIPT.sql.

  
Current databse configuration Specify whether your database has already been configured for IBM Content Navigator or not.  
Databse version The version of the database that is installed on the IBM Content Navigator database server.  
Enable database connection validation You can enable connection validation (WebSphere Application Server) or automatic connection testing (Oracle WebLogic Server) on the data source to decrease the likelihood of the web client encountering a connection failure to the database.

For more information on connection validation and automatic connection testing, see your web application server documentation.

Specify whether this option applies to your environment.

  
Administrator password The password of the specified database administrator.  
Task manager URL

The URL by which other applications can communicate with the IBM task manager component after it is deployed.

The URL has the format: http://host_name:port_number/taskManagerWeb/api/v1

  
Task manager configuration script The fully qualified path of the IBM task manager configuration script, configureWSTMApplication.tcl.
  • On AIX, the default directory is /opt/IBM/ECMClient/configure/scripts/configureWSTMApplication.tcl.
  • On Linux, the default directory is /opt/IBM/ECMClient/configure/scripts/configureWSTMApplication.tcl.
  • On Linux for System z, the default directory is /opt/IBM/ECMClient/configure/scripts/configureWSTMApplication.tcl.
  • On Windows, the default directory is C:\Program Files (x86)\IBM\ECMClient\configure\scripts\configureWSTMApplication.tcl.
  
Use my existing task manager component database

Select this option if you deployed the task manager component by using and earlier version of IBM Content Navigator and you want to reuse your existing task manager database.

  
Library server administrative user The IBM Content Manager administrator user name.  
Library server administrative password The password for the IBM Content Manager administrator.  
Run the PathModelCreate tool Run the PathModelCreate tool from the IBM Content Navigator Configuration and Deployment Tool. The PathModelCreate tool defines a data model with the minimum set of metadata that is required for IBM CMIS for Content Manager to work.

If you do not select this option, you can run the PathModelCreate tool after you deploy your web application.

Important: You cannot use the deployed application until you create a data model for IBM CMIS for Content Manager on your IBM Content Manager repository.
  
OnDemand server name The host name or the IP address of your IBM Content Manager OnDemand server.  
OnDemand server port number The TCP/IP port number which the IBM Content Manager OnDemand server listens to. The default value is 1445.  
Installation directory The fully qualified path of the IBM Content Manager OnDemand Web Enablement Kit (ODWEK) installation directory.  
Task manager context root The context root to use for the task manager web module. The default context root is taskManagerWeb.

If you configure the task manager component, the context root is included in the URL by which other applications can communicate with the task manager component after it is deployed. The default format of the URL is http://host_name:port_number/taskManagerWeb/api/v1.

Important: You must specify the context root that you entered when configuring the task manger component.
  
IBM Content Navigator context root The context root to use for the IBM Content Navigator web module. .

The default context root is navigator.

The context root is included in the URL to the IBM Content Navigator web application. The default format of the URL is http://host_name:port_number/navigator

  
Sync services context root The context root to use for the sync services web module. The default context root is sync.

If you configure sync services, the context root is included in the URL by which repositories communicate with the IBM Content Navigator sync services. The default format of the URL is http://host_name:port_number/sync/api/repositories/notify

  
Build script The fully qualified path of the build script, create_ear.bat or create_ear.sh
  • On AIX®, the default directory is /opt/IBM/ECMClient/configure/explodedformat/create_ear.sh
  • On Linux, the default directory is /opt/IBM/ECMClient/configure/explodedformat/create_ear.sh
  • On Linux for System z®, the default directory is /opt/IBM/ECMClient/configure/explodedformat/create_ear.sh
  • On Windows, the default directory is C:\Program Files(x86)\IBM\ECMClient\configure\explodedformat\create_ear.bat

It is recommended that you use the default value.

  
IBM CMIS for Content Manager context root The context root to use for the IBM CMIS for Content Manager web module. The default context root is cmcmis.

The context root is included in the IBM CMIS for Content Manager service URLs. You can access the service collection URLs from the IBM CMIS for Content Manager index page, index.jsp.

The default format of the index page URL is http://host_name:port_number/cmcmis/index.jsp

  
IBM CMIS for Content Manager OnDemand context root The context root to use for the IBM CMIS for Content Manager OnDemand web module. The default context root is odcmis.

The context root is included in the IBM CMIS for Content Manager OnDemand service URLs. You can access the service collection URLs from the IBM CMIS for Content Manager OnDemand index page, index.jsp.

The default format of the index page URL is http://host_name:port_number/odcmis/index.jsp

  
IBM CMIS for FileNet Content Manager context root The context root to use for the IBM CMIS for FileNet Content Manager web module. The default context root is fncmis.

The context root is included in the IBM CMIS for FileNet Content Manager service URLs. You can access the service collection URLs from the IBM CMIS for FileNet Content Manager index page, index.jsp.

The default format of the index page URL is http://host_name:port_number/fncmis/index.jsp

  
IBM FileNet Collaboration Services context root The context root to use for the IBM FileNet Collaboration Services web module. The default context root is dm.

To ensure interoperability with other client applications, it is recommended that you do not change the context root.

The context root is included in the URL by which other applications can communicate with IBM FileNet Collaboration Services. The default format of the URL is http://host_name:port_number/dm.

  
Parent topic: Installation and configuration worksheets