Configuration and deployment command-line reference for IBM Content Navigator, Version 2.0.1

Product documentation


Abstract

You can configure and deploy IBM Content Navigator by using the command-line version of IBM Content Navigator Configuration and Deployment Tool.

Content

It is recommended that most users use the graphical user interface version of the IBM Content Navigator Configuration and Deployment Tool, which enables you to test the values that you enter before you run tasks.

In addition, it is recommended that you complete the IBM Content Navigator installation and configuration worksheets before you use the command-line interface to configure and deploy IBM Content Navigator.

The scripts for the command-line version of the IBM Content Navigator Configuration and Deployment Tool are in the IBM_Content_Navigator_installation_directory\configure\ directory.

To configure and deploy IBM Content Navigator by using the command-line interface, you must generate and edit the configuration XML files, run the configuration tasks, and then deploy the web application to your web application server.

Important: If you plan to deploy multiple instances of IBM Content Navigator on the same web application server, you must:

  • Generate, edit, and run a complete set of configuration files for each instance.
  • Store the configuration files for each instance in a separate profile directory.

You can either generate all of the configuration XML files before you edit and run the files, or you can generate, edit, run, and verify the files one at a time.


Syntax for the the configmgr_cl generateConfig command
Use this diagram to understand the accepted values for each parameter in the configmgr_cl command ( configmgr_cl on AIX, Linux, and Linux for System z, or configmgr_cl.bat on Windows)

>>-configmgr_cl.exe--|  generateConfig  |---------------------------><

|-- -appserver--+-websphere-+--+-- -configure_FileNetP8-+--yes--+--->
                '-weblogic--'                          '--no---'        

>-- -configure_CM-+--yes--+-- -configure_CMOD-+--yes--+------------->
                  '--no---'                   '--no---'

>-- -db--+-db2--------+--------------------------------------------->
         +-db2zos-----+  
         +-mssql------+  
         +-oracle-----+  
         '-oracle_rac-'                          

>-- -deploy--+-standard--+------------------------------------------>
             +-cluster---+  
             '-netdeploy-'  

>-- -ldap_Repository--+-federated--+-- -ldap--+-tivoli------------+->
                      '-standalone-'          +-activedirectory---+  
                                              +-adam--------------+  
                                              +-ca----------------+  
                                              +-edirectory--------+  
                                              +-oid---------------+  
                                              '-oracledirectorySE-'  

>-- -profile----fully_qualified_path_of_a_profile_directory ---->

>--+-------------------+----------------------------------------|
   '-|-- more ->-- con '  



Task descriptions
The command line interface for configuring and deploying IBM Content Navigator includes a list of tasks that you can run to configure IBM Content Navigator for your environment. Use these task names when you run a command that includes the -task parameter.

Use the following table to determine which configuration tasks are required for your environment.

Tip: When you run the command to generate the configuration XML files, only the tasks that are relevant to your environment are created.


Task Name Description
downloadcejarstask Required for IBM FileNet P8 users only.

This task is required only if the version of the Content Engine connector files that are installed with IBM Content Navigator do not match the version of the files on your Content Engine server.

Prerequisites: Ensure that you are running a supported version of Content Engine before you run this task.

This task downloads the correct version of the Content Engine client connector files from the Content Engine server.
configureodwek Required for IBM Content Manager OnDemand users only.

Prerequisites: Install IBM Content Manager OnDemand Web Enablement Kit on the IBM Content Navigator server before you run this task.

This task enables the web client to connect to IBM Content Manager OnDemand repositories and tells the web client where to find the OnDemand Web Enablement Kit.
configurepe Required for IBM FileNet P8 users only.

This task is required only if you want to use IBM FileNet P8 workflows in IBM Content Navigator.

Prerequisites: Before you run this task:
  • Ensure that you are running a supported version of Process Engine
  • Ensure that the version of the Process Engine client connector files on the IBM Content Navigator server match the version of Process Engine that you are running.
  • Create an isolated region or identify an existing isolated region that you want to use for IBM Content Navigator.

This task registers the IBM Content Navigator application in Process Engine and creates the IBM Content Navigator step processor in the isolated region.
configurejdbcjarsecm Required for WebSphere Application Server users only.

This task is required regardless of the types of repositories that you plan to connect to from IBM Content Navigator.

Prerequisites: Copy the JDBC drivers for your database to the IBM Content Navigator server before you run this task. If you plan to deploy IBM Content Navigator in a highly available cluster, you must copy the driver to the same directory on each node in your cluster.

This task adds your database JDBC driver to your web application server environment variables so that IBM Content Navigator can access its configuration database table.
configurecm8task Required for IBM Content Manager users only.

This task enables the web client to connect to IBM Content Manager repositories by enabling IBM Content Navigator to communicate with your IBM Content Manager library server.

Restriction: You can configure IBM Content Navigator to connect to IBM Content Manager only if you deploy IBM Content Navigator on WebSphere Application Server.
rundbcommand Required for all users.

Prerequisites: You must have an existing database and a database ID before you run this task.

IBM Content Navigator stores configuration information and user preferences in a database. This task updates a script that you can run to build and populate the IBM Content Navigator database on your database instance. Optionally, you can also configure this task to run the script on your database instance.
configurejdbcecm Required for all users.

Prerequisites: If you have an existing data source that uses the same name as the data source that you plan to use when you run this task, you must use your application server administration tools to manually remove the data source before you run this task. If you do not remove the existing data source, you cannot run the task successfully.

This task creates a data source connection that enables the web client to connect to the IBM Content Navigator database.
configureldap Required for IBM FileNet P8 users only.

If you have an LDAP configuration on the web application server where you are deploying IBM Content Navigator and the LDAP configuration matches the settings on your Content Engine LDAP repository, you do not need to run this task.

This task configures your web application server to use the Content Engine LDAP repository.

Important: The values that you enter must match the values that are set on your Content Engine server.

The IBM Content Navigator Configuration and Deployment Tool does not include every option that you can set when configuring your LDAP server connection. Work with your LDAP server administrator to determine if there are any settings that you must configure that are not included in the IBM Content Navigator Configuration and Deployment Tool. If your LDAP server connection includes additional settings, you must manually update your LDAP server connection on your web application server after you run this task. You can open the administrative console for the web application server for Content Engine to ensure that your LDAP configurations match.
importltpakey Required for IBM FileNet P8 users on WebSphere Application Server only.

If you plan to deploy IBM Content Navigator in the same cell as Content Engine on WebSphere Application Server, you do not need to run this task.

Prerequisites: You must export the LTPA key file from the Content Engine server and save it to the IBM Content Navigator server before you run this task.

This task imports your Content Engine LTPA key to the IBM Content Navigator web application server to enable IBM Content Navigator to authenticate to the Content Engine server.
configureloginmodules Required for WebSphere Application Server users only.

This task is required regardless of the types of repositories that you plan to connect to from IBM Content Navigator.

IBM Content Navigator uses Java Authentication and Authorization Service (JAAS) to authenticate users’ login credentials. This task configures your web application server to use JAAS authentication.
rebuildear Required for all users.

Prerequisites: If you are running the tasks individually, you must run all of the other tasks to configure IBM Content Navigator for your environment before you run this task.

This task builds the application EAR file that you deploy to your web application server.
deployapplication Optional.

Prerequisites: You must complete the other web application configuration tasks before you deploy the web application. If any of the configuration tasks fail, the deployed web application will not work properly.

You must deploy the web application to your web application server. You can use the IBM Content Navigator Configuration and Deployment Tool to deploy the web application, or you can deploy the EAR file manually.


Procedure
To configure and deploy IBM Content Navigator by using the command-line interface:
  1. From the command prompt, change to the IBM Content Navigator \configure subdirectory.
  2. Generate the configuration XML files for an instance of IBM Content Navigator by running the generateConfig command. The parameters that you specify depend on the types of repositories that you are connecting to. The generateConfig command creates the configuration XML files in the profile directory that you specify in the -profile argument. The configuration XML files contain the properties that you must specify for each configuration task.

    Important: You must include all three repository arguments (configure_FileNetP8, configure_CM, and configure_CMOD) in your command. Do not enter line breaks in the command.

    To generate all of the XML files for an instance of IBM Content Navigator on Windows, enter the command with the following format:
    configmgr_cl.exe generateConfig -appserver app_server_type -configure_FileNetP8 yes_or_no -configure_CM yes_or_no -configure_CMOD yes_or_no -db db_type -deploy deploy_type -ldap_Repository repository_type -ldap ldap_provider -profile fully_qualified_path_of_a_profile_directory

    Tip: To see the status of the command, append | more > con to the end of the command.

    Example
    To generate the configuration XML files for an instance of IBM Content Navigator that will connect to IBM FileNet P8 and IBM Content Manager repositories on Microsoft Windows, enter:configmgr_cl.exe generateConfig -appserver websphere -configure_FileNetP8 yes -configure_CM yes -configure_CMOD no -db db2 -deploy standard -ldap_Repository federated -ldap tivoli -profile C:\Location to my profile directory path\ | more > con

    The following parameters are specific to IBM FileNet P8 repositories only. If you specify -configure_FileNetP8 no, you can omit these parameters from the command:
    • ldap_Repository
    • ldap

  3. If you want to save your passwords, run the storepasswords command for each task that requires a password. On Windows, enter the command with the following format:

    configmgr_cl.exe storePasswords -profile fully_qualified_path_of_a_profile_directory -task task_name -taskfile task_name.xml

    Important: Your passwords are encrypted before they are saved to the configuration XML files. However, the encryption method might not comply with Federal Information Processing Standards (FIPS) 140. To comply with FIPS 140, ensure that the operating system access permissions on the XML configuration files for each task are set to allow only the administrator who edits and runs the tasks to read or write to the files.

    A password is required for the following tasks:
    • configurepe
    • configurejdbcjarsecm
    • configurecm8task
    • rundbcommand
    • configurejdbcecm
    • configureldap

      If you do not save your passwords, you must manually enter any required passwords into the XML configuration files before you run the following the tasks.
  4. Edit the configuration XML files to provide values for your environment. The XML files are in the profile directory that you specified when you ran the generateConfig command.

    Tip: You can use the IBM Content Navigator installation and configuration worksheets to determine the appropriate values for your environment.
  5. Apply your configuration settings by running the execute command:
    1. Start the application server where you plan to deploy IBM Content Navigator if it is not already running.
    2. From the command prompt, change to the IBM Content Navigator \configure subdirectory, where the configmgr_cl file is located.
    3. Run the configuration XML files. If you need to run the configuration XML files for a profile that was created or edited in the graphical user interface version of the IBM Content Navigator Configuration and Deployment Tool, verify that the XML files contain values for the required passwords before you run the files.

      Important: Do not enter line breaks in the command.

      Tip: To see the status of the command, append | more > con to the end of the command.
      • To run all of the configuration files at the same time, enter:
        • On AIX, Linux, or Linux for System z, enter:
          configmgr_cl
          execute -profile fully_qualified_path_of_a_profile_directory
        • On Windows, enter:
          configmgr_cl.exe execute -profile fully_qualified_path_of_a_profile_directory

        If you run all of the tasks at the same time, ensure that all of the tasks are complete before you run the execute command.

      • To run each configuration file individually, enter:
        • On AIX, Linux, or Linux for System z, enter:
          configmgr_cl
          execute -task task_name 
          -profile fully_qualified_path_of_a_profile_directory
        • On Windows, enter:
          configmgr_cl.exe execute -task task_name 
          -profile fully_qualified_path_of_a_profile_directory

        If you run the tasks individually, it is recommended that you run the tasks in the order that they are listed in the order listed in the Task Descriptions table. When you run the tasks in this order, it ensures that any prerequisite configuration is completed when you run each task.

Rate this page:

(0 users)Average rating

Add comments

Document information


More support for:

Content Navigator

Software version:

2.0.1

Operating system(s):

AIX, Linux, Linux on System z, Windows

Reference #:

7036855

Modified date:

2013-11-15

Translate my page

Machine Translation

Content navigation