generateConfig command

Syntax

configmgr_cl generateConfig
 [-box ]
 -deploy deploy_type
 -profileType profile_type -task task_type
 -taskfile task_file_name -taskname task_display_name
 -profile myprofile 
  [-silent] [-force] [-help]

Parameters

-box

Optional. Specify -box if you are configuring Box collaboration in Case Client.

-deploy deploy_type

Specifies the type of IBM Business Automation Workflow deployment.

Table 1. Valid deploy_type values

Option	Description
cluster	Specify cluster if you are deploying the Content Platform Engine Workflow Service to a web application server cluster.
nd	Specify nd if you are deploying the Content Platform Engine Workflow Service to a network deployment environment that is managed but not clustered..
standard	Specify standard if you are deploying the Content Platform Engine Workflow Service to a stand-alone web application server which is not managed or clustered.

The -deploy parameter is required only when you are generating all the files at the same time or when you are generating a single file by using one of the following -taskfile task_file_name options or -task task_type options:

Table 2. Deployment type is required to generate a single file by using these task options

-taskfile task_file_name	-task task_type
deployibmbpmis.xml	deployibmbpmis
deployregisterextensions.xml	deployregisterextensions
deployregisterwidgets.xml	deployregisterwidgets

-profileType profile_type

Indicates which type of profile to generate. The profile type determines which types of tasks can be generated. In general, you must generate and run all of the tasks for a profile type.

Table 3. Valid profile_type values

Option	Task files	Profile description
devenv	If you create a full profile by omitting the -task task_type option, the profile includes a file for the application server properties, a file for Content Platform Engine server properties, and a file for each task. 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	The development environment configuration profile prepares the development environment for creating, modifying, and testing solutions before moving them into a production domain. The profile includes the application server settings, Content Platform Engine server settings, and IBM Content Navigator settings. The profile can include one or more tasks.
prodenv	If you create a full profile by omitting the -task task_type option, the profile includes a file for the application server properties, a file for Content Platform Engine server properties, and a file for each task. 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	The production environment configuration profile prepares the production environment for deploying solutions. The profile includes the application server settings, Content Platform Engine server settings, and IBM Content Navigator settings. The profile can include one or more tasks.

-task task_type

Indicates which task to generate. You can limit the tasks that are generated for a profile by using the -tasktask_type option. You can omit the -task task_type parameter if you want to generate all 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 that are affected by the task.

Table 4. Valid task_type values

Option	Description
No value is specified.	Use with the -profileType profile_type option to generate all of the tasks for the profile. If you omit the -task task_type parameter and the -taskfile task_file_name parameter, all the configuration files for the profile are generated. See the file list for the profile type in the table for the -profileType type_of_profile entry.
configbox	This task is required if you want to enable case workers to use Box to collaborate with external users. This task configures the connection to the Box server.
configcaseloginmodules	Use with the -profileType profile_type option to generate the file for 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 generation. This option generates the following file: configcaseloginmodules.xml
configcmos	Use with the -profileType devenv | wldevelopmentenvironment option to generate the file 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. This option generates the following file: configcmos.xml
configibmbpm	Use with the -profileType profile_type option to generate the file for configuring case integration with IBM Business Automation Workflow. This option generates the following file: configibmbpm.xml
configrules	Use with the -profileType profile_type option to generate the file for configuring business rules. This option generates the following file: configrules.xml
configureldap	Use with the -profileType profile_type option to generate the file 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 federated repositories and you must support multiple LDAP servers, create one additional file for each LDAP configuration. 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 task. This option generates the following files: configureldap.xml configureldap.n.xml. n is an integer starting with 2.
definedefaultprojectarea	Use with the -profileType profile_type option to generate the file for defining the default project area and the connection definition for the development environment target object store. This option generates the following file: definedefaultprojectarea.xml
definetargetenv	Use with the -profileType profile_type option to generate the file for defining the target environment and the connection definition for the production environment target object store. This option generates the following file: definetargetenv.xml
deployibmbpmis	Use with the -profileType profile_type option to generate the file for deploying IBM Business Automation Workflow. This option generates the following file: deployibmbpmis.xml
deployregisterextension	This task registers and deploys your extensions package.
deployregisterwidgets	Use with the -profileType profile_type option to generate the file for registering and deploying a widget package with Case Builder and IBM Content Navigator. This option generates the following file: deployregisterwidgets.xml
deploysolution	Use with the -profileType prodenv option to generate the file 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. You can create additional task files in the same profile, or you can create a separate profile for the additional settings. 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. This option generates the following files: deploysolution.xml deploysolution.n.xml. n is an integer starting with 2.
registeradmin	Use with the -profileType profile_type option to generate the file for registering the IBM Business Automation Workflow Case administration client with IBM Content Navigator. This option generates the following file: registeradmin.xml
registerbawplugin	This task 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.
registercpeapplets	This task registers the plug-in for IBM Content Navigator that contains the IBM FileNet® Process Designer applet. Tip: Run this task only if you want to launch the IBM FileNet Process Designer applet from Case Builder. You do not need to run this task to use the standalone IBM FileNet Process Designer.
registerexternaldataurl	Use with the -profileType profile_type option to generate the file that registers a data source other than Content Platform Engine. This option generates the following file: registerexternaldataurl.xml
registerprojectarea	Use with the -profileType profile_type option to generate the file for registering the project area with IBM Content Navigator and configures the Content Platform Engine repositories. This option generates the following file: registerprojectarea.xml
registertargetenv	Use with the -profileType profile_type option to generate the file for registering the target environment with IBM Content Navigator and configures the Content Platform Engine repositories. This option generates the following file: registertargetenv.xml
registerexternaldataurl	Use with the -profileType profile_type option to generate the file for registering an external data source URL with IBM Business Automation Workflow. This option generates the following file: registerexternaldataurl.xml
registericmmonitor	This task imports and registers the Case Monitor widgets package with the IBM Business Automation Workflow server, registers the plug-in for the widgets package with the IBM Content Navigator server, and creates the Case Monitor desktop. This task is required to enable Case Monitor. Save your changes and run the task to apply your settings. In a cluster environment, you must either use the IBM Content Navigator administration client to manually load the plug-in inside of the extensions package on each node or restart the application server cluster to force all nodes to load the plug-in. Before using Case Monitor, you must create a Case Analyzer store for each case management target object store.
registerprojectarea	This task registers a project area with an IBM Business Automation Workflow desktop, creates default IBM Business Automation Workflow desktops, configures repositories for the case management design and target object stores, and adds IBM Business Automation Workflow features to the desktop. Also, this task configures the Case Operations component queue and configures the project area's isolated region to work with solution workflows. This task is required and must be run for every project area.
registerservices	This task 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.

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.

-taskname task_display_name

Specifies the task display name. Use this option with the -task task_type or -taskfile task_file_name to provide a custom display name for the task. If you omit this parameter, a default display name is used. When you configure multiple tasks of the same type (for example, multiple deploysolution tasks), ensure that you enter descriptive display names for each task.

-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