listTasks 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 listTasks command displays a list of the activities and the activity files in the configuration profile.

Syntax

configmgr_cl listTasks [-task activity_type]  -profile myprofile
 [-help]

Parameters

-task activity_type
Optional. Indicates which activity type to list. 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 listed.

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

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

Lists 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

Lists 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

Lists the activity that configures business rules in your solution.

configureldap

configureldap.xml

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

Lists 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

Lists the activity that defines the default project area and the connection definition for the development environment target object store.

definetargetenv

definetargetenv.xml

Lists 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

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

Lists 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

Lists 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

Lists the activity that registers a data source other than Content Platform Engine.

registerprojectarea

registerprojectarea.xml

Lists the activity that registers the project area with IBM Content Navigator and configures the Content Platform Engine repositories.

registertargetenv

registertargetenv.xml

Lists the activity that registers the target environment with IBM Content Navigator and configures the Content Platform Engine repositories.

registerexternaldataurl

registerexternaldataurl.xml

Lists the activity that registers an external data source URL with IBM Business Automation Workflow.

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.

-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

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.
List all the configureldap activities in a Case Builder profile with multiple configureldap.n.xml files.
The following command lists all the configure case login module activities and the associated configuration XML files in the build profile in the install_root/CaseManagement/configure/profiles/develop1 directory:
configmgr_cl listTasks -task configureldap -profile develop1
A message such as the following example is displayed:
Activities in profile build of the activity type configureldap:
activity name: Configure LDAP
        File: configureldap.xml
activity name: Configure the LDAP Settings
        File: configureldap.2.xml
Show the help for the listTasks command.
The following command shows the help for the listTasks command:
configmgr_cl listTasks -help