Testing a task in a configuration profile (test)

Use the test command to test the connection information in XML task files.

Command description

The test command verifies the LDAP, database, and IBM® FileNet® Content Engine connection information that you added to the respective XML task files in the configuration profile.

The test command can be run only on the following tasks:
  • configureldap
  • configurejdbcecm
  • downloadcejarstask
Remember: Run the test command on these tasks prior to running the execute command to ensure that the tasks have the necessary information to connect to your LDAP server, configuration database, and IBM FileNet Content Engine server.

test command syntax

To run the test command, use the following syntax: 
configmgr_cl test
-task value | -taskfile value
-profile value
[-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 how you might use the test command.

Test the LDAP connection data in a specified profile if only one LDAP task was configured
configmgr_cl test -task configureldap 
-profile myProfile
Test the IBM FileNet Content Engine connection data in the Content Engine task
configmgr_cl test -task downloadcejarstask 
-profile myProfile

Command parameters

Specify the following parameters to test the connection information in the configureldap, configurejdbcecm, and downloadcejarstask XML task files.
-task

Required: No. You can omit the -task parameter if you specify the -taskfile parameter.

Description: Specifies the type of task to test.

Valid values:
configureldap
Tests the LDAP connection data in the XML file for the task.
configurejdbcecm
Tests the database connection data in the XML file for the task.
downloadcejarstask
Tests the IBM FileNet Content Engine connection data in the XML file for the task.
-taskfile
Required: Only if you have multiple configuration XML files for a task.

Description: Specifies which XML file to test for a task. For example, if your profile contains more than one configureldap task, then you must use the -taskfile parameter to specify the XML file name.

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.

Valid values: To see a list of the tasks in your profile, use the listTasks command: 
configmgr_cl listTasks -profile myProfile
-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.