10.12 Copying the Workflow Migration

Identity Manager enables you to pause and resume in-progress workflows through REST APIs. This is typically useful when you want to upgrade your workflow database without losing the workflow states. The Identity Applications workflow migration utility helps you copy the workflow data from one database to another database. The migration utility is available as a zip file in the ISO files at <LINUX_ISO>/user_application/IDM_Tools/WorkflowMigrationAPI.zip and <WINDOWS_ISO/IdentityApplications/IDM_Tools/WorkflowMigrationAPI.zip. Perform the following steps to copy the migration data:

IMPORTANT:Before performing the data migration, you must stop the Roles and Resource Driver. The Roles and Resource driver should not be started until the data export and import operations are completed.

  1. Copy the ISO file from <mountedISO>/user_application/IDM_Tools/WorkflowMigrationAPI.zip folder to /home directory and unzip the file.

  2. To copy the data from one location to another location, you must specify the source and destination details in the silent properties file as following:

    source.protocol=https
    
    source.ip=yourIP
    
    source.port=8543
    
    source.rbpm.web.context=IDMProv
    
    source.username=cn=uaadmin,ou=sa,o=data
    
    source.password=password
    
    destination.protocol=https
    
    destination.ip=yourIP
    
    destination.port=8543
    
    destination.rbpm.web.context=IDMProv
    
    destination.username=cn=uaadmin,ou=sa,o=data
    
    destination.password=password
    
    connection.timeout=10000000
  3. Run the following commands to export data from their respective directories where you have unzipped the ISO files based on your Operating System:

    Linux: Run the following command for Linux:

    /opt/netiq/common/jre/bin/java -jar WorkflowMigrationAPI.jar -e filename.zip -f silent.properties

    Windows: Run the following command for Windows:

    C:\NetIQ\Common\JRE\bin\java -jar WorkflowMigrationAPI.jar -e filename.zip -f silent.properties
  4. Create a new database for workflow engine and update the newly created workflow database details in the server.xml file.

  5. Set com.netiq.idm.create-db-on-startup attribute to true in the ism-configuration.properties file.

  6. Start the Tomcat server and ensure that the Workflow DB Schema has been created as part of the Tomcat startup.

  7. Run the following commands to import the data which was exported in step 3:

    Linux: Run the following command on Linux:

    /opt/netiq/common/jre/bin/java -jar WorkflowMigrationAPI.jar -i filename.zip -f silent.properties

    Windows: Run the following command on Windows:

    C:\NetIQ\Common\JRE\bin\java -jar WorkflowMigrationAPI.jar -i filename.zip -f silent.properties
  8. Start the Roles and Resource driver.

Workflow Migration Utility Command Usage

The following options are supported with the jar file:

-e                   Export to ZIP file name. Example: wf_db_migration.zip

-i                   Import data from ZIP file name. Example: wf_db_migration.zip

-sp                  Source Server protocol (http/https default: https)

-ss                  Source Server IP address (default: localhost)

-spo                 Source Server port (default: 8543)

-srctx               Source Server RBPM Context (default: IDMProv)

-su                  Source Username. Example: cn=uaadmin,ou=sa,o=data

-spwd                Source Password

-dp                  Destination Server protocol (http/https default: https)

-ds                  Destination Server IP adrress(default: localhost)

-dpo                 Destination Server port (default: 8543)

-drctx               Destination Server RBPM Context (default: IDMProv)

-du                  Destination Username. Example: cn=uaadmin,ou=sa,o=data

-dpwd                Destination Password

-f <filename>        Use this option to silently copy the data. In a silent mode, the file reads the values from the silent property file. Using this option overrides the other options passed to the migration utility.

where source specifies the location from where you want to copy the migration data and destination specifies the location to which you want to copy these data. Location can be a server, File System, or a Database.

NOTE:You must specify the values for the properties for the source. If you do not specify the value for the password property in the silent properties file, the utility prompts you for the value when you run it in the command line.

Perform the following actions to copy the migration data:

  1. Log in as a root user to the destination computer where you want to move the workflow migration.

  2. Open a terminal session.

  3. Specify the values for source and destination servers in the silent properties file.

  4. Run the migration utility by entering the following command:

    java -jar WorkflowMigrationAPI.jar [-option1] [value1]....[-optionN] [valueN]

Examples

Example 1: java -jar WorkflowMigrationAPI.jar -e wf_db_migration.zip -f silent.properties

This command copies all workflow migration data into the wf_db_migration.zip file. This option is useful when you want to save the exported settings.

Example 2: java -jar WorkflowMigrationAPI.jar -i wf_db_migration.zip -f silent.properties

This command imports all workflow migration data from the wf_db_migration.zip file to the destination server by reading the values provided in the silent properties file.

Example 3: java -jar WorkflowMigrationAPI.jar -e wf_db_migration.zip -sp http -ss localhost -spo 8543 -srctx IDMProv -su cn=uaadmin,ou=sa,o=data -spwd password

This command exports all workflow migration data from the server whose details are provided in the command prompt. This option is useful when you want to save the exported settings.

Example 4: java -jar WorkflowMigrationAPI.jar -i wf_db_migration.zip -dp http -ds localhost -dpo 8543 -drctx IDMProv -du cn=uaadmin,ou=sa,o=data -dpwd password

This command copies all client settings stored in the wf_db_migration.zip file to the destination server whose details are provided in the command prompt.