Running the tasks in a configuration profile (execute)

Use the execute command to apply the settings in an configuration XML file to a task that you need to deploy in an instance of IBM® Content Navigator, IBM ECM CMIS, or IBM FileNet® Collaboration Services in your environment.

Command description

The execute command applies the settings of the configuration XML files that are created when you run the generateConfig command. You can run all tasks in a configuration profile at once or you can run each task individually.

Prerequisites

Before you run the execute command, ensure that the following prerequisites are met:

Run the generateConfig command that creates the configuration tasks and XML files in a profile. For more information about the generateConfig command, see Creating a configuration profile (generateConfig) .
Edit the configuration XML files that are generated by the generateConfig command to enter your environment settings.
Store passwords for tasks that require these passwords. If you store task passwords before running the execute command, you are not prompted for these passwords during the execution of a task. For more information, see Storing passwords that are associated with a configuration profile (storePasswords command).
Optionally, you can test the connection to your Content Cortex repository, your LDAP server, and your database. For more information, see Checking the status of tasks in a configuration profile (checkStatus).

execute command syntax

To run tasks in a profile, enter the execute command with the following syntax:

configmgr_cl execute -task task_type | [-taskfile task_file_name]
 -profile myprofile 
[-silent] [-force] 
[-help]

Important:

Before you run the command, change to the configure subdirectory of the IBM Content Navigator installation directory. The default location is:
- AIX, Linux, and Linux for System z: /opt/IBM/ECMClient/configure
- Windows: C:\Program Files\IBM\ECMClient\configure
Enter the command and parameters on a single line, without any line breaks.
The command name is not case-sensitive.
The parameter names and parameter values are case-sensitive.

Examples of use cases

The following examples show different use cases for the execute command:

Run all tasks in a profile

The following command runs all the tasks in the myprofile profile directory. The -silent parameter is specified to prevent informational messages and prompts from being displayed on the console. The -force parameter prevents failure or error messages from stopping the execution of the task.

configmgr_cl execute -profile myprofile 
-silent -force

Run the configureldap (LDAP configuration) task

The following command runs the configureldap task in the myprofile profile directory:

configmgr_cl execute -task configureldap 
-profile myprofile

Run the importltpakey (import the LTPA key) task

The following command runs the importltpakey task for the myprofile profile:

configmgr_cl execute -task importltpakey 
-profile myprofile

Display the help content for the execute command

The following command displays the help content for the execute command, including a list of valid parameters and values:

configmgr_cl execute -help

Command parameters

To run the execute command, use the following parameters:

-task

Required: Yes. If the parameter is not specified, all the configuration tasks in the profile directory are run.

Description: Specifies the task type to be applied to the repository when you run the execute command.

Valid values:

downloadcejarstask: Required for IBM Content Cortex and IBM CMIS for FileNet Content Manager users only.
configureodwek: Required for IBM Content Manager OnDemand users only.
configurepe: Required for IBM Content Cortex users only.
configurecmisp8: Required for IBM CMIS for FileNet Content Manager users only.
configurejdbcjarecm: Required for IBM Content Navigator and IBM CMIS for Content Manager on WebSphere® Application Server users only.
configurecm8task: Required for IBM Content Manager users only.
configurecmiscmtask: Required for IBM CMIS for Content Manager users only.
configurejdbcecm: Required for all IBM Content Navigator users.
configureldap: Required for IBM Content Cortex and IBM CMIS for FileNet Content Manager users only.
importltpakey: Required for IBM Content Cortex and IBM CMIS for FileNet Content Manager users on WebSphere Application Server only.
configureloginmodules: Required for IBM Content Navigator on WebSphere Application Server users only.
configurecmisauthenticationtask: Required for IBM ECM CMIS on WebSphere Application Server users only.
configuretmtask: Required if you want to configure Task Manager. Required if you are configuring an IBM Content Navigator web client application that is not associated with a repository type.
configurefncstask: Required for FileNet Collaboration Services users.
configureicntask: Required for all IBM Content Navigator users.
rebuildear: Required for all users.
deployapplication: Optional parameter.

For more information about tasks that are generated by the generateConfig command and that can be run with the execute command, see Creating a configuration profile (generateConfig command).

-taskfile

Required: Required only if you have multiple configuration XML files for the specified task.

Description: Specifies the name of the configuration XML file to run in the configuration profile. You can omit the -task parameter if you specify -taskfile when you run the command. If your profile contains more than one configureldap task for example, then you must specify the -taskfile parameter to identify the task to run. By default, the file name increments for each new file that is generated. For example, a second LDAP configuration file is named configureldap.2.xml.

-profile

Required: Yes

Description: The fully qualified directory where the configuration XML files are located. When you specify the -profile parameter, the default location of the configuration XML files is ..\Program Files\IBM\ECMClient\configure\profiles or /opt/IBM/ECMClient/configure/profiles. If the profile directory is at this location, you only need to specify the name of the profile directory.

-silent

Required: No

Description: Runs the command silently, without any user interaction, which means that no prompts or informational messages are displayed on the console. Instead, the errors are written to the log files. Failure messages and validation error messages are displayed as needed, such as messages about missing passwords.

-force

Required: If the -silent parameter is used.

Description: Overrides the checks that the command runs. The task is forced to run without pausing to prompt you for required input or responses to validation error messages. The force parameter should always be used with caution; otherwise, it might result in the loss of data.

-help

Required: No

Description: Use the help parameter to get information about the command syntax, valid parameters, and values.