removeTask command
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 removetask -task activity_type | -taskfile activity_file_name
-profile myprofile [-silent][-force][-help]Parameters
- -task activity_type
- Indicates which activity to remove. This parameter must be included if the
-taskfile
activity_file_name parameter is omitted. The following table describes the valid
activity names, the associated configuration XML file, and a description of the settings affected by
the activity.
Table 1. activity_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
If you omit the -task activity_type parameter, all the configuration activities and the associated activity files for the profile are removed.
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
If you omit the -task activity_type parameter, all the configuration activities and the associated activity files for the profile are removed.
configbox configbox.xml This activity is required if you want to enable case workers to use Box to collaborate with external users. This activity configures the connection to the Box server.
configcaseloginmodules
configcaseloginmodules.xml
Removes the activity that configures 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 activity.
configcmos
configcmos.xml
Removes the activity that configures the design and target object stores. This activity installs the IBM® Business Automation Workflow Add-ons and creates the required events and subscriptions in Content Platform Engine.
configibmbpm
configibmbpm.xml
Configure Case Integration with IBM Business Automation Workflow. This activity configures the connection between the case components and the IBM Business Automation Workflow host server. This activity is required. Save your changes and run the activity.
configrules
configrules.xml
Removes the activity that configures business rules in your solution.
configureldap
configureldap.xml
configureldap.n.xml . n is an integer starting with 2.
Removes the activities that configure 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.
When you generate a second connection definition configuration file in the same profile, it is named configureldap.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 activity.
definedefaultprojectarea
definedefaultprojectarea.xml
Removes the activity that defines the default project area and the connection definition for the development environment target object store.
definetargetenv
definetargetenv.xml
Removes the activity that defines a target environment for the production environment.
deployregisterextensions deployregisterextensions.xml This activity registers and deploys your extensions package. deployregisterwidgets
deployregisterwidgets.xml
Removes the activity 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.
Removes the activities that deploy 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 activity.
registeradmin
registeradmin.xml
Removes the activity that registers the IBM Business Automation Workflow Case administration client with IBM Content Navigator.
registerbawplugin
registerbawplugin.xml
Runs the activity that registers the plug-in for IBM Business Automation Workflow to provide access to Workplace from your IBM Business Automation Workflow desktop.
registercpeapplets registercpeapplets.xml This activity registers the plug-in for IBM Content Navigator that contains the IBM FileNet® Process Designer applet.Tip: Run this activity only if you want to launch the IBM FileNet Process Designer applet from Case Builder. You do not need to run this activity to use the standalone IBM FileNet Process Designer.registerexternaldataurl
registerexternaldataurl.xml
Removes the activity that registers a data source other than Content Platform Engine.
registerprojectarea
registerprojectarea.xml
Removes the activity that registers the project area with IBM Content Navigator and configures the Content Platform Engine repositories.
registertargetenv
registertargetenv.xml
Removes the activity that registers the target environment with IBM Content Navigator and configures the Content Platform Engine repositories.
registerservices registerservices.xml This activity registers the plug-in for IBM Content Navigator that contains the IBM Business Automation Workflow services that are used by other components.
-
- -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.
- -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
- Remove the configureldap activity from a profile with only one configureldap activity.
- The following command removes the configureldap activity and the
configureldap.xml file from the profile named
develop1.
configmgr_cl removeTask -task configureldap -profile develop1 - Remove the configureldap activity from a profile with several configureldap activities.
- The following command removes the configureldap activity and the
configureldap.2.xml file from the profile named
develop2:
configmgr_cl removeTask -taskfile configureldap.2.xml -profile develop2 - Remove the configureldap activity from a profile with several configureldap activities by using a full path to the profile directory.
- The following command removes the configureldap activity and the
configureldap.2.xml file from the profile named develop2 that is in the
/temp/myprofiles/develop2
directory:
configmgr_cl removeTask -taskfile configureldap.2.xml -profile /temp/myprofiles/develop2 - Show the help for the removeTask command.
- The following command shows the help for the removeTask command:
configmgr_cl removeTask -help
This topic only applies to BAW, and is located in the BAW repository. Last updated on 2025-03-13 12:15