Production environment tasks and files

The BPMConfig command creates a profile that consists of a set of files that contain information about your production 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 production environment, the BPMConfig command specifies the arguments for the application server type, the FileNet® P8 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 production 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 production environment profile. The properties include the Content Platform Engine domain information, the case management staging object store name, and other information about the production 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 production 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
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 staging 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 Target Environment definetargetenv.xml A case management solution is deployed to a target environment. A target environment consists of a connection point and an object store, and is associated with one or more IBM Content Navigator desktops. A unique target environment is required for every connection point that will be used for solution deployment.
Deploy the Content Platform Engine Workflow Service deployibmbpmis.xml This task configures and deploys the Content Platform Engine Workflow Service, which uses a Web Services Reliable Messaging Protocol to ensure that requests are sent to IBM Business Automation Workflow. This integration service is required by the case components to provide communication between the Content Platform Engine server and the IBM Business Automation Workflow server. Save your changes and run the task.
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.
Deploy Solution deploysolution.xml This task deploys a case management solution to a production environment object store. After you deploy the solution, users can log on to Case Client to create cases and work items, view and edit case data, and complete work items for a case. This task is required for each solution that you deploy to your production environment.
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 your IBM Process Portal Work dashboard 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 IBM Business Automation Workflow Case 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 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 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.
Register the Case Management Services Plug-in registerservices.xml This task registers the plug-in for IBM Content Navigator that contains the IBM Business Automation Workflow services that are used by other components.
Register Target Environment registertargetenv.xml This task registers a target environment with an IBM Content Navigator desktop, creates default IBM Business Automation Workflow desktops, configures repositories for the case management staging 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 target environment's isolated region to work with solution workflows.