execute command

Draft comment:
This topic only applies to BAW, and is located in the BAW repository. Last updated on 2025-03-13 12:15
The execute command applies the settings from a configuration XML file for the specified configuration task.

Syntax

The following syntax includes line breaks to format the command for reading. Enter the command and options on a single line without any line breaks.
configmgr_cl execute [-task task_type | -taskfile task_file_name]
 -profile myprofile [-silent] [-force] [-help]

Parameters

-task task_type
Indicates which task to run. You can omit the -task task_type parameter if you want to run all of the tasks or if you specify the -taskfile task_file_name parameter. The following table describes 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 is specified.

A development environment configuration profile can contain the following files:
  • configbox.xml

  • configcmos.xml

  • configibmbpm.xml

  • configrules.xml

  • definedefaultprojectarea.xml

  • deploygateway.xml

  • deployregisterextensions.xml

  • deployregisterwidgets.xml

  • registeradmin.xml

  • registerbawplugin.xml

  • registerboxlistener.xml

  • registercpeapplets.xml

  • registerexternaldataurl.xml

  • registericmmonitor.xml
  • registerprojectarea.xml

  • registerservices.xml

Runs all the tasks in the profile. If you omit the -task task_type parameter and the -taskfile task_file_name parameter, the tool runs all of the configuration files in the profile. Any configuration XML file that has the enabled attribute value in the <configuration> element set to false is skipped.

No value is specified.

A production environment configuration profile can contain the following files:
  • configbox.xml

  • configcmos.xml

  • configibmbpm.xml

  • configrules.xml

  • definetargetenv.xml

  • deploygateway.xml

  • deployregisterextensions.xml

  • deployregisterwidgets.xml

  • deploysolution.xml

  • registeradmin.xml

  • registerbawplugin.xml

  • registerboxlistener.xml

  • registercpeapplets.xml

  • registerexternaldataurl.xml

  • registericmmonitor.xml

  • registerservices.xml

  • registertargetenv.xml

Runs all the tasks in the profile. If you omit the -task task_type parameter and the -taskfile task_file_name parameter, the tool runs all of the configuration files in the profile. Any configuration XML file that has the enabled attribute value in the <configuration> element set to false is skipped.

configcaseloginmodules

configcaseloginmodules.xml

Runs 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 option.

configcmos

configcmos.xml

Runs the task for configuring the design and target 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

This task configures 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

Lists the task that configures business rules in your solution.

configureldap

configureldap.xml

configureldap.n.xml . n is an integer starting with 2.

Runs the task to configure the directory service provider (LDAP) settings. The directory service provider (LDAP) settings define the directory service and the users and groups that IBM Business Automation Workflow 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

Lists the task that defines a target environment for the production environment.

deploygateway

deploygateway.xml

Runs the task that configures the gateway connection between the Content Platform Engine and the IBM Business Automation Workflow.

deployregisterwidgets

deployregisterwidgets.xml

Runs 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.

Runs the task to deploy a IBM Business Automation Workflow solution into a production target object store.

If you have one or more deploysolution.n.xml files in a profile, you must use the -taskfile task_file_name option to run a single task file.

registeradmin

registeradmin.xml

Runs the task that registers the IBM Business Automation Workflow Case 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 Workplace from your IBM Business Automation Workflow desktop.

registerexternaldataurl

registerexternaldataurl.xml

Runs the task that registers a data source other than Content Platform Engine.

registerprojectarea

registerprojectarea.xml

Runs the task that registers the project area with IBM Content Navigator and configures the Content Platform Engine repositories.

registertargetenv

registertargetenv.xml

Runs the task that registers the target environment with IBM Content Navigator and configures the Content Platform Engine repositories.

registerexternaldataurl

registerexternaldataurl.xml

Runs the task to register an external data source URL.

-taskfile activity_file_name
Specifies the configuration.xml file to use.
If only one activity file exists for the activity_type, the -taskfile activity_file_name parameter is optional.
If more than one activity file for the activity_type exists, you must include the -taskfile activity_file_name parameter. The activity_file value is case-sensitive if your operating system is case-sensitive for file names.
-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.
-silent
Optional: When you specify the -silent parameter, no prompts or informational messages are shown in the console, but the errors are written to the log. Failure messages and validation error messages are shown as needed, such as messages about missing passwords or invalid port numbers. If you run the execute command to run all the activities in a profile and you specify the -silent parameter, you must also specify the -force parameter.
-force
Optional and applies only when the -silent parameter is used. When you specify the -force parameter, the activity is run without pausing for required responses to validation error messages, such as messages about missing passwords or invalid port numbers.
-help
Optional: Shows a brief message on the command syntax instead of running the command.

Sample commands

The following examples include line breaks to format the command for reading. Enter the command and options on a single line without any line breaks.
Run all the tasks in a profile.
The following command runs all the tasks in the build profile, which is in the install_root/CaseManager/configure/profiles/develop1 directory.
 configmgr_cl execute -profile develop1
Run only the configureldap task in a profile that has only one configureldap task.
The following command runs the configureldap.xml file in the build profile, which is in the install_root/CaseManager/configure/profiles/develop1 directory:
configmgr_cl execute -task configureldap -profile develop1
Run only the configureldap.3.xml task file in a profile that has multiple configureldap tasks.
The following command runs the configureldap.3.xml file in the build profile, which is in the install_root/CaseManager/configure/profiles/develop3 directory:
configmgr_cl execute -taskfile configureldap.3.xml -profile develop3
Show the help for the execute command.
The following command shows the help for the execute command:
configmgr_cl execute -help