startDocumentStoreMigration command

Use the startDocumentStoreMigration command to migrate BPM documents from the BPM database to the IBM BPM document store in IBM Business Process Manager.

Purpose

This command provides a command-line method to migrate BPM documents from the BPM database to the IBM BPM document store in IBM Business Process Manager. The command can only be run in connected mode.

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

Required parameters

-serverName: Specifies the server name of the IBM BPM document store. If you specify the serverName parameter, you must also specify the nodeName parameter.
-nodeName: Specifies the node name of the IBM BPM document store. If you specify the nodeName parameter, you must also specify the serverName parameter.
-clusterName: Specifies the cluster name of the IBM BPM document store.
-deName: Specifies the deployment environment name of IBM Business Process Manager.

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.

Optional parameters

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

Examples

Note: The examples are for illustrative purposes only. They include variable values and are not meant to be reused as snippets of code.

The following example uses the startDocumentStoreMigration command to migrate documents from the BPM database to the IBM BPM document store for a specified node and server.

Jython example:

AdminTask.startDocumentStoreMigration('[-nodeName myNodeName -serverName myServerName]')

Jacl example:

$AdminTask startDocumentStoreMigration {-nodeName myNodeName -serverName myServerName}

The following example uses the startDocumentStoreMigration command to migrate documents from the BPM database to the IBM BPM document store for a specified cluster.

Jython example:

AdminTask.startDocumentStoreMigration('[-clusterName myClusterName]')

Jacl example:

$AdminTask startDocumentStoreMigration {-clusterName myClusterName}

The following example uses the startDocumentStoreMigration command to migrate documents from the BPM database to the IBM BPM document store for a specified deployment environment.

Jython example:

AdminTask.startDocumentStoreMigration('[-deName myDeName]')

Jacl example:

$AdminTask startDocumentStoreMigration {-deName myDeName}

The following example invokes the startDocumentStoreMigration command on a specified target object:

Jython example:

server = AdminConfig.getid('/Cell:myCellName/Node:myNodeName/Server:myServerName')
AdminTask.startDocumentStoreMigration(server)

Jacl example:

set server [$AdminConfig getid /Cell:myCellName/Node:myNodeName/Server:myServerName]
$AdminTask startDocumentStoreMigration $server

The following example invokes the startDocumentStoreMigration command on a specified target object:

Jython example:

cluster = AdminConfig.getid('/Cell:myCellName/ServerCluster:myClusterName')
AdminTask.startDocumentStoreMigration(cluster)

Jacl example:

set cluster [$AdminConfig getid /Cell:myCellName/ServerCluster:myClusterName]
$AdminTask startDocumentStoreMigration $cluster

The following example invokes the startDocumentStoreMigration command on a specified target object:

Jython example:

de = AdminUtilities.convertToList(AdminConfig.list("BPMDeploymentEnvironment"))[0]
AdminTask.startDocumentStoreMigration(de)

Jacl example:

foreach de [$AdminConfig list "BPMDeploymentEnvironment"] {
set result [$AdminTask startDocumentStoreMigration ${de}]
puts ${result}
}