Running the development environment case configuration tasks

Use the development environment profile created by the BPMConfig command when you run the tasks in the Case configuration tool.

To configure the development environment, complete the following steps:

1. Set the application server timeout values. The default value is 14400. Higher timeout values help avoid transaction timeout issues when you run the configuration tool tasks. It also helps with the deployment of solutions.
   The following sample settings are for WebSphere® Application Server Version 8.5.5:

   • Servers > Server Types > WebSphere application servers > Click on your server > Configuration tab > Container Settings > Container Services > Transaction service > Total transaction lifetime timeout
   • Servers > Server Types > WebSphere application servers > Click on your server > Configuration tab > Container Settings > Container Services > Transaction service > Client inactivity timeout
   • Servers > Server Types > WebSphere application servers > Click on your server > Configuration tab > Container Settings > Container Services > Transaction service > Maximum transaction timeout
   • Servers > Server Types > WebSphere application servers > Click on your server > Configuration tab > Container Settings > Container Services > ORB service > Request timeout
   • Servers > Server Types > WebSphere application servers > Click on your server > Configuration tab > Container Settings > Container Services > ORB service > Locate request timeout
     Note: For WebSphere Application Server Version 8.5.5, the maximum value for the locate request timeout is 300.
   • Resources > JDBC > Data sources > [Content Engine or Case Manager data source name] > Connection Pool properties > Connection timeout
   • Resources > JDBC > Data sources > [Content Engine or Case Manager XA data source name] > Connection Pool properties > Connection timeout
2. Restart your entire environment.
   Note: If you are using Db2 for z/OS, your Register Project Area task might hang and fail when you restart your entire environment. To avoid this, after restart of entire environment, go to WAS console > Applications >  Application Types > WebSphere enterprise applications, and find IBM_BPM_DocumentStore_YourClusterName. Restart the application.
3. Start the Case configuration tool by running one of the following commands:

   Operating system	Command
   AIX®	Change to the install_root/CaseManagement/configure directory. Run the following command: ./configmgr
   Linux®	Change to the install_root/CaseManagement/configure directory. Run the following command: ./configmgr
   Linux for System z®	Change to the install_root/CaseManagement/configure directory. Run the following command: ./configmgr
   Linux on POWER Little Endian (LE)	Change to the install_root/CaseManagement/configure directory. Modify the comfigmgr.ini file to point to JDK 1.8 by making the following change: -vm /opt/install_root/java_1.8_64/bin Run the following command: ./configmgr
   Windows	Change to the install_root\CaseManagement\configure directory. Run the following command: configmgr.exe

4. Click Open Profile to open the predefined profile for your current development environment.
   The predefined profile is located in the following directory: dmgr_profile_root/CaseManagement/DE_name/profiles/ICM_dev
5. Edit the profile.

   •  Containers: If you are connecting with IBM Business Automation Navigator running in a container, configure single sign-on with User Management Service (UMS) by completing all the parameters in Table 1. UMS parameters for single sign-on. If you use LTPA single sign-on (SSO), leave the User Management Service URL blank.

   •  Traditional: If you are not connecting with IBM Business Automation Navigator running in a container, and you are not configuring single sign-on with User Management Service (UMS), do not change the default values for User Management Service URL, User Management Service user name, and User Management Service password.

     Table 1. UMS parameters for single sign-on

     Parameter	Description	Default value
     User Management Service URL	Enter the URL and port number for UMS. The URL format is https://ums_server:port. This parameter is optional. If you specify the UMS URL, the connection to the IBM Business Automation Navigator server will be redirected to UMS first and then return to the IBM Business Automation Navigator server after the authentication check.
     User Management Service user name	Enter the user account that can log in to UMS. If you do not have UMS, enter a placeholder username.	umsadmin
     User Management Service password	User Management Service password: Enter the password for the UMS user. If you do not have UMS, enter a placeholder password.	Default password

   Note: If you leave the User Management Service password value empty, a warning message is displayed to specify the password when running Case configuration tool tasks. You can click Yes to proceed with running the task.

   Save the profile and run the following tasks. Run the tasks in the order listed.

   Most of the configuration values are set based on your workflow environment. However, review the values to ensure that they are set correctly.

   Table 2. Task requirements for a development environment

   Task	Required
   Register the Administration Console for Content Platform Engine (ACCE) Plug-in (deprecated)	Always if you are using the embedded Content Platform Engine. If you are using an external Content Platform Engine, the ACCE plug-in (deprecated) is disabled. This is because it might not be compatible with the external Content Platform Engine server. Instead, use the ACCE console that is provided by your external Content Platform Engine server. Always Restriction: When you run the administration console for the Content Platform Engine from IBM Content Navigator, you cannot run Process Administrator or Process Configuration Console from the administration console. To use the Process Administrator or Process Configuration Console applets, follow the instructions in Configuring Process Designer to run from IBM Content Navigator. Important: The ACCE is removed. Use the ACCE console that is embedded inside the Content Platform Engine.
   Configure the Case Management Object Stores	Always Note: If you have multiple project areas in the profile, then you need to run this task multiple times, once against each one. For considerations on object store configuration, see Planning for an external Content Platform Engine.
   Define the Default Project Area	Always Important: If you are using an external Content Platform Engine, enter the correct configuration values for your environment.
   Configure Case Integration with IBM Business Automation Workflow	Always Note: If you have multiple project areas in the profile, then you need to run this task multiple times, once against each one.
   Deploy the Content Platform Engine Workflow Service	Always Important: If you are using an external Content Platform Engine, enter the correct configuration values for your environment.
   Deploy the Content Platform Engine Gateway Service	Always, unless you are using Content Platform Engine running in a container, in which case it is disabled. Note: Several other parameter values in the configuration of this task specify the cell environment of the Content Platform Engine application server, but the parameter value for the IBM Business Automation Workflow server cluster name is not dependent on it. The Business Automation Workflow server cluster name must be looked up separately in the server cell of the Business Automation Workflow server application and its value must be entered manually.
   Register the IBM Business Automation Workflow plug-in.	Always Important: If you are using an external IBM Content Navigator, enter the correct configuration values for your environment.
   Register the Case Management Services plug-in.	Always Note: After you configure a Business Automation Workflow environment, you can select the any other desktop as the Case Client desktop instead of the Business Automation Workflow default desktop: IBM Business Automation Workflow. To reuse your legacy environment or a customized desktop as the Case Client desktop instead of the new default desktop that changed to IBM Business Automation Workflow after the legacy IBM Case Manager environment was augmented to a Business Automation Workflow environment, select it and run the task. Important: If you are using an external IBM Content Navigator, enter the correct configuration values for your environment.
   Register the IBM Content Platform Engine Applets Support plug-in.	Required only if you want to start the IBM FileNet® Process Designer applet from Case Builder. You do not need to run this task to use the stand-alone IBM FileNet Process Designer. Important: If you are using an external IBM Content Navigator, enter the correct configuration values for your environment.
   Register the Case widgets Package.	Always Important: Do not modify the file path that is predefined for the Case Widgets package. If you are using an external IBM Content Navigator, enter the correct configuration values for your environment. If you are using an external IBM Content Navigator, enter the correct configuration values for your environment.
   Register the IBM Business Automation Workflow Case Administration Client plug-in.	Always Important: If you are using an external IBM Content Navigator, enter the correct configuration values for your environment.
   Configure Box Collaboration	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.
   Register the Case Box Event Listener plug-in	Required if you want Box events to trigger the creation of cases or work items. Important: If you are using an external IBM Content Navigator, enter the correct configuration values for your environment.
   Register Project Area	Always. When the Case Operations component queue is created in FileNet Content Platform Engine, it is named ICM_Operations. Note: If you have multiple project areas in the profile, then you need to run this task multiple times, once against each one.
   Configure Business Rules	Required if you use business rules in your solution.  Containers: If you are using Content Platform Engine running in a container, change the default path to the Content Platform Engine container path, which is mounted as the icmrules persistent volume (PV). You can find the original icmrules path in the PV mapping. See Creating volumes and folders for deployment on Kubernetes. If you need to update the default NFS share directory, see Changing the network shared directory. Tips: You can select only one locale in which to write the business rules for your solutions. If you must 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: Stop Content Platform Engine. 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. Restart Content Platform Engine. Note: If you have multiple project areas in the profile, then you need to run this task multiple times, once against each one.
   Register the Case Monitor Widgets Package	Always Important: Do not modify the file path that is predefined for the Case Monitor Widgets package. If you are using an external IBM Content Navigator, enter the correct configuration values for your environment.
   Register the External Data Service	Required for solutions that use the external data service.
   Deploy and Register Custom Widgets Package	Required if you have a custom widgets package that you want to use with your case solution. Important: If you run this task in a cluster environment, you must ensure that the plug-in is loaded on each node of the cluster. Either restart the cluster to force the plug-in to be loaded on all nodes or manually load the plug-in on each node by using the IBM Content Navigator administration client. If you are using an external IBM Content Navigator, enter the correct configuration values for your environment.
   Deploy and Register Extensions Package	Required only when you add an extensions package for a custom property editor or controller. Important: If you run this task in a cluster environment, you must make sure that the plug-in is loaded on each node of the cluster. Either restart the cluster to force the plug-in to be loaded on all nodes or manually load the plug-in on each node by using the IBM Content Navigator administration client. If you are using an external IBM Content Navigator, enter the correct configuration values for your environment.

6. If you are using an external Content Platform Engine, restart the external Content Platform Engine server.
7. Undo the changes that you made in the first step. Set the application server timeout values back to the values that you had before you started configuration.
8. Restart your entire environment.