startDocumentStoreMigration command

The startDocumentStoreMigration command is run using the AdminTask object of the wsadmin scripting client.

Prerequisites

The following conditions must be met:

• The command must be run on the deployment manager node.
• One or more application cluster members must be running.
• Run the command in connected mode. Do not specify the wsadmin -conntype none option.
• You must connect to the deployment manager with a user ID that has WebSphere Application Server operator privileges.

Before running this command, you should review the task topic "Migrating document attachments to the IBM BPM document store."

Location

Start the wsadmin scripting client from the profile_root/bin directory of the deployment manager profile (or the stand-alone server profile of IBM BPM Express). The startDocumentStoreMigration command does not write to a log file, but the wsadmin scripting client always writes a profile_root/logs/wsadmin.traceout log file where you will find exception stack traces and other information.

Syntax

startDocumentStoreMigration
-serverName server_name
-nodeName node_name
-clusterName cluster_name
-deName deployment_environment_name
[-keepFailedDocuments true|false]

Parameters

-serverName server_name

A required parameter that specifies the server name of the IBM BPM document store. If you specify the -serverName parameter, you must also specify the -nodeName parameter.

-nodeName node_name

A required parameter that specifies the node name of the IBM BPM document store. If you specify the -nodeName parameter, you must also specify the -serverName parameter.

-clusterName cluster_name

A required parameter that specifies the cluster name of the IBM BPM document store.

-deName deployment_environment_name

A required parameter that specifies the deployment environment name of IBM Business Process Manager.

-keepFailedDocuments true|false

An optional parameter that specifies whether documents that fail to migrate from the BPM database to the IBM BPM document store are permanently retained in the BPM database. Specify a parameter value of true to permanently retain documents in the BPM database that have failed to migrate to the IBM BPM document store. The default parameter value is false.

You must specify the -clusterName parameter, or the -deName parameter, or both the -serverName and -nodeName parameters. As an alternative to specifying any parameters, you can invoke the command on a target object of type BPMDeploymentEnvironment, ServerCluster, or Server.