checkStatus command
The checkStatus command checks the status of the specified configuration task.
Syntax
configmgr_cl checkStatus [-task task_type | -taskfile task_file_name]
-profile myprofile [-help]
Parameters
- -task task_type
- Specifies which task to use for the status check. You can omit
the -task task_type parameter
if you want to check all of the tasks or if you specify the -taskfile task_file_name parameter.
The following table lists the valid task names, the associated configuration
XML file, and a description of the settings affected by the task.
Table 1. task_type values Option Configuration file Description No value specified.
A development environment configuration profile can contain the following files:-
configbox.xml
-
configcmos.xml
-
configibmbpm.xml
-
configrules.xml
-
definedefaultprojectarea.xml
-
deploygateway.xml
-
deployibmbpmis.xml
-
deployregisterextensions.xml
-
deployregisterwidgets.xml
-
registeradmin.xml
-
registerbawplugin.xml
-
registerboxlistener.xml
-
registercpeapplets.xml
-
registerexternaldataurl.xml
- registericmmonitor.xml
-
registerprojectarea.xml
-
registerservices.xml
Checks the status of all tasks. If you omit the -task task_type parameter and the -taskfile task_file_name parameter, the status for all the configuration files in the profile is shown.
No value specified.
A production environment configuration profile can contain the following files:-
configbox.xml
-
configcmos.xml
-
configibmbpm.xml
-
configrules.xml
-
definetargetenv.xml
-
deploygateway.xml
-
deployibmbpmis.xml
-
deployregisterextensions.xml
-
deployregisterwidgets.xml
-
deploysolution.xml
-
registeradmin.xml
-
registerbawplugin.xml
-
registerboxlistener.xml
-
registercpeapplets.xml
-
registerexternaldataurl.xml
-
registericmmonitor.xml
-
registerservices.xml
-
registertargetenv.xml
Checks the status of all tasks. If you omit the -task task_type parameter and the -taskfile task_file_name parameter, the status for all the configuration files in the profile is shown.
configcaseloginmodules
configcaseloginmodules.xml
Checks the status of the task for configuring the login modules for the Case Builder application. The login modules provide authentication information for the Case Builder application. If you are deploying Case Builder to the same application server where Content Platform Engine is deployed, skip this task.
configcmos
configcmos.xml
Checks the status for configuring the object stores. This task installs the IBM® Business Automation Workflow Add-ons and creates the required events and subscriptions in Content Platform Engine.
configibmbpm
configibmbpm.xml
Checks the status of the task for configuring the connection between the case components and the IBM Business Automation Workflow host server. This task is required. Save your changes and run the task.
configrules
configrules.xml
Checks the status of the task that configures business rules in your solution.
configureldap
configureldap.xml
configureldap.n.xml . n is an integer starting with 2.
Checks the status for configuring the directory service provider (LDAP) settings for the Case Builder application. The directory service provider (LDAP) settings define the directory service and the users and groups that uses for authentication.
If you have one or more configureldap.n.xml files in a profile, you must use the -taskfile task_file_name option to run a single task file.
definedefaultprojectarea
definedefaultprojectarea.xml
Checks the status for defining the default project area for the development environment.
definetargetenv
definetargetenv.xml
Checks the status for the task that defines a target environment for the production environment.
deployibmbpmis
deployibmbpmis.xml
Checks the status for the task that deploys the IBM Business Automation Workflow integration service. deployregisterwidgets
deployregisterwidgets.xml
Checks the status for the task that registers and deploys a widget package with Case Builder and IBM Content Navigator.
deploysolution
deploysolution.xml
deploysolution.n.xml. n is an integer starting with 2.
Checks the status for deploying an IBM Business Automation Workflow solution into a production target object store.
You need one configuration file for each production environment target object store that you deploy a solution to. When you generate a second solution deployment configuration file in a profile, it is named deploysolution.2.xml. The file name increments for each new file that you generate. You cannot change the file name, but you can edit the value in the file for the name of the task.
registeradmin
registeradmin.xml
Checks the status for the task that registers the IBM Business Automation Workflow administration client with IBM Content Navigator.
registerbawplugin
registerbawplugin.xml
Runs the task that registers the plug-in for IBM Business Automation Workflow to provide access to your IBM Process Portal Work dashboard from your IBM Business Automation Workflow desktop.
registerexternaldataurl
registerexternaldataurl.xml
Checks the status for the task that registers a data source other than Content Platform Engine.
registerprojectarea
registerprojectarea.xml
Checks the status for the task that registers the project area with IBM Content Navigator and configures the Content Platform Engine repositories.
registertargetenv
registertargetenv.xml
Checks the status for the task that registers the target environment with IBM Content Navigator and configures the Content Platform Engine repositories.
registerexternaldataurl
registerexternaldataurl.xml
Checks the status for registering an external data source URL.
-
- -taskfile activity_file_name
- Specifies the configuration.xml file to use.
- -profile myprofile
- Specifies the profile to use. The myprofile value
can be one of the following items:
- The name of the profile, such as develop1. The profile is located in the install_root/CaseManagement/configure/profiles directory. install_root is the location where IBM Business Automation Workflow is installed.
- The full path to the profile directory, such as "install_root\CaseManagement\configure\profiles\develop1" or /install_root/CaseManagement/configure/profiles/develop1.
- The full path to the profile input file, such as "install_root\CaseManagement\configure\profiles\develop1\develop1.cfgp" or /install_root/CaseManagement/configure/profiles/develop1/develop1.cfgp.
- -help
- Optional: Shows a brief message on the command syntax instead of running the command.
Sample commands
- Check the status for configuring the login modules for the development environment.
- The following command checks the status of the configcaseloginmodules task
in the install_path/CaseManagement/configure/profiles/develop1 directory:
configmgr_cl checkStatus -task configcaseloginmodules -profile develop1
- Show the help for the checkStatus command.
- The following command shows the help for the checkStatus command:
configmgr_cl checkStatus -help