Configuring and deploying IBM Content Navigator by using the command line

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

Before you begin

Complete the IBM Content Navigator installation and configuration worksheets before you use the command-line interface to configure and deployIBM Content Navigator.

About this task

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.

The scripts for the command-line version of the IBM Content Navigator Configuration and Deployment Tool are in the configure directory of the IBM Content Navigator installation 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.

    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.

  • Store the configuration files for each instance in a separate profile directory.

    The name that you specify for the profile is also used as the name for the directory where the configuration files are stored. The profile name must be a valid directory name for your operating system. By default, the profiles are stored in the configure/profiles directory of the IBM Content Navigator installation directory.

To configure and deploy IBM Content Navigator by using the command-line interface, you must edit and run the tasks that apply to your environment. The command to generate the configuration XML files creates only the tasks that are relevant to your environment. For more information about the tasks that the generateConfig creates, see IBM Content Navigator Configuration and Deployment Tool command-line reference.

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 following parameters are specific to IBM FileNet® P8 repositories. If you specify -configure_FileNetP8 no, you can omit these parameters from your command:
    • ldap_Repository
    • ldap

    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: Do not enter line breaks in the command.
    Tip: To see the status of the command through a page, append | more to the end of the command.
    To generate all of the XML files for an instance of IBM Content Navigator, enter:
    configmgr_cl generateConfig -appserver app_server_type 
-appserverVersion app_server_version -configure_FileNetP8 yes_or_no
  -configure_CM yes_or_no 
  -configure_CMOD yes_or_no 
  -db db_type -icn_sso value
-deploy deploy_type -ldap_Repository repository_type -ldap 
ldap_provider -profile fully_qualified_path_of_a_profile_directory
    For 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 generateConfig -appserver websphere 
-appserverVersion 8.5 -configure_FileNetP8 yes -configure_CM yes 
-db db2 -icn_sso none -deploy standard -ldap_Repository federated 
-ldap tivoli -profile C:\Program Files\IBM\ECMClient\configure\profiles\profile
  3. If you want to save your passwords, run the storepasswords command for each task that requires a password.
    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.
    To store your passwords, enter the following command:
    configmgr_cl storePasswords -profile 
fully_qualified_path_of_a_profile_directory -task task_name 
-taskfile task_name.xml
    A password is required for the following tasks:
    • applicationserver
    • configurepe
    • configurejdbcjarsecm
    • configurecm8task
    • configurejdbcecm
    • configureldap
    • importltpakey

    If you do not save your passwords, you must manually enter any required passwords into the XML configuration files before you run any of these 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. Start the application server where you plan to deploy IBM Content Navigator.
  6. From the command prompt, change to the IBM Content Navigator configure subdirectory, where the configmgr_cl file is located.
  7. Run the configuration XML files.
    Tip: 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.
    • To run all of the configuration files at the same time, enter:
      configmgr_cl execute -profile 
fully_qualified_path_of_a_profile_directory
      Tip: 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:
      configmgr_cl execute -task task_name 
-profile fully_qualified_path_of_a_profile_directory
      Tip: If you run the tasks individually, it is recommended that you run the tasks in the order that they are listed in IBM Content Navigator Configuration and Deployment Tool command-line reference. When you run the tasks in this order, it ensures that any prerequisite configuration is completed when you run each task.