Importing a solution package by using the command line

Edit online

You must import the case management solution package into the production environment design object store before you can deploy the solution to the production environment domain.

Before you begin

Be sure to have your completed configuration checklist available.

About this task

A solution package consists of the assets in the solution folder in a case management design object store. The package includes these items:

The solution definition file.
The connection definition.
The task steps (stored as one XPDL file per case type).
The Pages subfolder.
The default page objects and any custom page objects that you created in the development environment.
Any documents, objects, or folders that were in the solution folder at the time of export, including those added by the user.

Procedure

To import the solution package:

Change the current directory to the install_root/CaseManagement/configure directory. Where install_root is the location where IBM® Business Automation Workflow is installed.
If you need custom service data mapping, create and edit the service data map XML file.
1. Run the following command. Do not enter any line breaks when you enter the command.
```
configmgr_cl generateServiceDataMap 
 -solutionPackage package_file
 -file service_data_map_name
[-help]
```
  -solutionPackage package_file
  
  Specifies the full path and file name the solution package ZIP file that contains the solution to import. If the path includes spaces, put the entire path in double quotation marks. For example, enter "C:\Solution Packages\Credit Dispute Solution.zip".
  
  -file service_data_map_name
  
  Specifies the full path and file name for the service data map XML file to create. The directory structure in the path must already exist. You can use any valid file name, but the .xml extension is recommended. If the path includes a directory name with spaces, enclose the entire path in double quotation marks. For example, enter "C:\Solution Packages\service_data_map.xml".
  
  -help
  
  Optional and displays a brief message on the command syntax instead of running the command.
  
  Tip: You can also use FileNet® Deployment Manager to create the service data map file.
2. Use a text editor to edit the values in the service data map XML file. You can change the value for the Name or the URL for the <Destination> elements in the XML file.
If you did not use FileNet Deployment Manager to create an object store data map file, run the following command. Do not enter any line breaks when you enter the command.
```
configmgr_cl generateObjectStoreDataMap 
 -solutionPackage package_file
 -file object_store_data_map_name
[-help]
```
-solutionPackage package_file

Specifies the full path and file name the solution package ZIP file that contains the solution to import. If the path includes spaces, put the entire path in double quotation marks. For example, enter "C:\Solution Packages\Credit Dispute Solution.zip".

-file object_store_data_map_name

Specifies the full path and file name for the object store data map XML file to create. The directory structure in the path must already exist. You can use any valid file name, but the .xml extension is recommended. If the path includes a directory name with spaces, enclose the entire path in double quotation marks. For example, enter "C:\Solution Packages\object_store_data_map.xml".

-help

Optional and displays a brief message on the command syntax instead of running the command.
Import the solution package by running the following command. Do not enter any line breaks when you enter the command.
```
configmgr_cl importSolution -profile myprofile 
 -solutionPackage package_file
 -projectAreaName project_area_name 
 -serviceDataMap service_data_map_name
 -objectStoreDataMap object_store_data_map_name
[-silent] [-force]
```
-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.
-solutionPackage package_file

Specifies the full path and file name the solution package ZIP file that contains the solution to import. If the path includes spaces, put the entire path in double quotation marks. For example, enter "C:\Solution Packages\Credit Dispute Solution.zip". If you enter a solution name that already exists, the solution will be overwritten in the design object store.

-projectAreaName project_area_name

Specifies the name of the project area for the solution. This option is valid only for importing a solution package to into another development environment.

-serviceDataMap service_data_map_name

Specifies the full path and file name for the service data map XML file that was generated by using the generateServiceDataMap command or by using FileNet Deployment Manager. If the path includes a directory name with spaces, enclose the entire path in double quotation marks. For example, enter "C:\Solution Packages\service_data_map.xml".
If user does not specify a value for -serviceDataMap, the services are mapped to themselves.

-objectStoreDataMap object_store_data_map_name

Specifies the full path and file name for the object store data map XML file that was generated by using the generateObjectStoreDataMap command or by using FileNet Deployment Manager. If the path includes a directory name with spaces, enclose the entire path in double quotation marks. For example, enter "C:\Solution Packages\object_store_data_map.xml".
If the user does not specify a value for -objectStoreDataMap, the design object store is mapped to the specified profile's design object store. If there is a target object store configured, and a project area is specified, the target object store is mapped to the specified project area's target object store. If there is a target object store and no project area is specified, or if there are other object stores, this value is required.

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