Development environment tasks and files

Edit online
Draft comment:
This topic only applies to BAW, and is located in the BAW repository. Last updated on 2025-03-13 12:15
The BPMConfig command creates a profile that consists of a set of files that contain information about your development environment. You can edit the component files and the task files to update or add information before you run the tasks.

Component files

For the development environment, the BPMConfig command specifies the arguments for the application server type, the Content Cortex Platform environment, and the IBM® Content Navigator environment. The settings are saved in files that are specific to each component.
Table 1. Component files for a profile
Component File Name Description
Application server websphereapplicationserver.xml Application server settings that are common to all tasks in the profile. These settings are used when you run any of the tasks for the development environment profile. The properties include the application server installation directory, the administrative user name and password, the port number, cell, and other information about the application server.

Each profile contains only one of these files, depending on the application server type.
Content Platform Engine contentengineserver.xml Content Platform Engine settings that are common to all tasks in the profile. These settings are used when you run any of the tasks for the development environment profile. The properties include the Content Platform Engine domain information, the case management design object store name, and other information about the development environment.
IBM Content Navigator contentnavigatorserver.xml IBM Content Navigator settings that are common to all tasks in the profile. These settings are used when you run some of the tasks for the development environment profile. The properties include the IBM Content Navigator server installation directory, the administrative user name and password, the port number, cell, and other information about IBM Content Navigator.

Task files

The task files are generated when you create the profile. For command usage, the argument value for each task is the name of the XML file without the file extension, for example, configbox.

Table 2. Tasks for a development environment profile
Task File Name Description
Register the Administration Console for Content Platform Engine (ACCE) Plug-in (deprecated) registeracceplugin.xml This task registers the (deprecated) plug-in for IBM Content Navigator that contains the Administration Console for Content Platform Engine (ACCE). This task is required. Save your changes and run the task to apply your settings.
Important: The ACCE is removed. Use the ACCE console that is embedded inside the Content Platform Engine.
Configure Box Collaboration configbox.xml 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.
Configure Case Integration with IBM Business Automation Workflow 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.
Note: You must specify a secure port for the Content Platform Engine server WSI port because IBM Business Automation Workflow only supports secure ports.
Configure the Case Management Object Stores configcmos.xml This task installs the IBM Business Automation Workflow add-ons for the case management design and target object store and creates the required events and subscriptions in Content Platform Engine.
Configure Business Rules configrules.xml This task configures the environment to be able to use rules in solutions.
Tips:
  • You can select only one locale in which to write the business rules for your solutions. If you need to create solutions with business rules in other locales, rerun this task to change the rule persistence locale before you create the solution. After the first rule for a solution is saved, the rule persistence locale cannot be changed.
  • If you rerun this task to change the location of the rules repository directory after you deploy any solutions, complete the following steps after you run the task:
    1. Stop Content Platform Engine.
    2. From the previous rules repository directory, move the res_data directory to the new location of the rules repository directory. In a cluster environment, the rules directory must be a shared directory that can be accessed by all Content Platform Engine cluster servers.
    3. Restart Content Platform Engine.
Define the Default Project Area definedefaultprojectarea.xml This task defines the default project area for the development environment. A project area groups solutions in the design object store so that the entire object store is not affected when you reset the test environment. Only users who are assigned to a project area can log on to Case Builder. The default project area is required for each development environment.

To create additional project areas and assign users and solutions to a project area, click Tools > Manage Project Areas or use the Case administration client.

Save your changes and run the task to apply your settings.
Deploy Gateway Service deploygateway.xml This task configures the gateway connection between the Content Platform Engine and IBM Business Automation Workflow.
Deploy and Register Extensions Package deployregisterextensions.xml This task registers and deploys your extensions package.
Deploy and Register Custom Widgets Package deployregisterwidgets.xml This task imports and registers the custom widgets package with the case components, registers the plug-in for the widgets package with the IBM Content Navigator server, and deploys the EAR file in the widgets package to the web application server, if present. 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.
Register the IBM Business Automation Workflow Administration Client Plug-in registeradmin.xml This task registers the plug-in for IBM Content Navigator that contains the administration client for IBM Business Automation Workflow. This task is required. Save your changes and run the task to apply your settings.
Register the Case Box Event Listener Plug-in registerboxlistener.xml

This task registers the plug-in for IBM Content Navigator that listens for case-related Box events when Box collaboration is enabled. This task is required if you want Box events to trigger the creation of cases or work items. Save your changes and run the task to apply your settings.
Register the Case Widgets Package registercaseclient.xml This task registers the widgets package with the workflow server and registers the plug-in for the widgets package with the IBM Content Navigator server. This task is required for the default case widgets package that comes with IBM Business Automation Workflow.
Register the IBM Content Platform Engine Applets Support Plug-in registercpeapplets.xml 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.
Register the Case Management Services Plug-in registerservices.xml This task registers the plug-in for IBM Content Navigator that contains the case management services that are used by other components.
Register the IBM Business Automation Workflow Plug-in registerbawplugin.xml This task registers the plug-in for IBM Business Automation Workflow that provides access to Workplace from your IBM Business Automation Workflow desktop. Save your changes and then run the task to apply your settings.

This plug-in adds the Workflow > Launch Process action to the Action menu and pop-up menu in the Browse view of the IBM Business Automation Workflow desktop. You can use this action to launch an IBM Business Automation Workflow process from a document. You can also add the Launch Process action to the menu in the Documents view for the Case Information widget.

Important: To use the IBM Business Automation Workflow plug-in, you must use the Hypertext Transfer Protocol Secure (HTTPS) in your IBM Content Navigator URL.
Register the External Data Service registerexternaldataurl.xml This task creates a connection to an external data service, which allows you to use data in a solution from a source other than Content Platform Engine.
Register the Case Monitor Widgets Package registericmmonitor.xml

This task imports and registers the Case Monitor widgets package with the 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.
Register Project Area registerprojectarea.xml 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.