21Data Migration Using Siebel Migration
Data Migration Using Siebel Migration
This chapter provides guidelines for performing a migration with Siebel Migration. This chapter includes the following topics:
Before You Begin Migrating with Siebel Migration
Before you begin using Siebel Migration:
Review and follow the tasks listed in Roadmap for Planning a Migration with Siebel Migration
Start Siebel Migration with the following URL format:
https://<hostname>:<port>/siebel/migration
Back up your target database before starting to migrate repository or data using Siebel Migration.
Process of Using Siebel Migration to Migrate Data
This procedure describes how use Siebel Migration for migration tasks. Siebel Migration tasks include:
Creating Connections. For information on creating connections, see Creating a Connection.
Generating Watermarks. For more information on creating watermarks, see Generating a Watermark.
Creating Migration Plans. For more information on creating migration plans, see Creating a Migration Plan.
Executing Migration Plans. For more information on executing migration plans, see Executing a Siebel Migration Plan.
Reviewing Migration History. For more information about reviewing migration log history, see Viewing Migration History and Log Files.
Creating a Connection
Use Siebel Migration to create a connection, which registers a Siebel environment to the Siebel Migration. Each connection represents on Siebel environment and numerous connections can be created for a migration.
This procedure describes how use Siebel Migration to create an environment connection for a migration.
This task is a step in Process of Using Siebel Migration to Migrate Data.
To create a connection
In Siebel Migration, navigate to the Connection Tab.
Click New Connection.
Enter a Name for the new connection.
Enter a Valid Endpoint for the connection.
The valid REST Endpoint format is the following:
https://<hostname>:<port>/siebel/v1.0
Verify the status of connection. Statuses include:
Connection Alive
Connection Not Alive
Connection Unknown
Generating a Watermark
Use Siebel Migration to create a watermark. A watermark is useful to see the data that was previously migrated to your database environment. Based on the previously migrated data, you can determine the correct incremental version that you need to migrate.
Siebel Migration obtains the current repository watermark from the Siebel Server. Siebel Migration generates the watermark for the web artifacts file from the Siebel Application Interface folder and then writes the watermark file into the filename provided by the user in the migration folder under the file system or Shared Package Location if provided. The connection that points to the Siebel Server must be a Runtime Repository environment. If the connection points to a development environment, then Siebel Migration throws an error.
This task is a step in Process of Using Siebel Migration to Migrate Data.
To Generate a Watermark
In Siebel Migration, navigate to the Connection Tab.
Click the Watermark icon.
Enter the Watermark file name.
Click OK.
After creating the watermark file, a window displays a success message with the path and filename for the watermark file.
Creating a Migration Plan
When you create a Migration Plan, you must select connections, including the source environment and the target environment. When you run the Migration Plan, Siebel Migration exports the migration data from the Source environment and imports it into the Target environment.
When you create the Migration plan, you must select the resources that you want to migrate as part of this migration plan. In Siebel Migration, you can select Database Utilities, ADM Projects or File Prepare and Deploy services.
This procedure describes how use Siebel Migration to create a migration plan for a migration.
This task is a step in Process of Using Siebel Migration to Migrate Data.
To create a migration plan
In Siebel Migration, navigate to the Migration Plan tab.
Click New Migration.
Enter the Name of the Migration Plan and Description.
Drag and Drop the Source Connection & Target Connection in the Flow Chart.
An intersection of Migration Resources (between Source & Target) for Database Utilities and only from Source for ADM Projects will be displayed.
Select the Migration Resource that will be executed as part of the Migration Plan.
Siebel Migration Plan Dependencies
The Siebel Migration Discovery services that appear in Siebel Migration depends on selections that you make.
The following table contains Siebel Migration plan dependencies.
Table Siebel Migration Plan Dependencies
| If You Select this Resource... | Read Only Resources | Auto Selected Resources |
|---|---|---|
Application Workspace Data Service |
|
|
Design Repository Data Service |
|
|
Increment Repository Data Service |
|
Schema Service |
Runtime Repository Data Service |
|
Schema Service Application Workspace Data Service |
Incremental Application Workspace Data Service |
|
None |
Executing a Siebel Migration Plan
This procedure describes how to use Siebel Migration to execute a Migration Plan for a database migration.
This task is a step in Process of Using Siebel Migration to Migrate Data.
Executing a migration plan
In Siebel Migration, navigate to the Execute tab.
Identify the Migration Plan to be executed.
Click the Play icon in the Action column for the Migration Plan to be executed.
The Execution Details window appears. Depending on the selections you made when you created your migration plan, you will see one of the following prompts in the Execution Details window:
Database Encoding. You will be prompted for database encoding information if you created your migration plan as Import only with a Schema Service selected or if your migration plan was created for both Source and Target with a Schema Service selected.
Workspace Version Selection. You will be prompted for the Workspace version if you run the Incremental Runtime Repository service.
For the Database Encoding Execution Details window, enter the following information:
Enter the User ID. The User ID is the Username for the Target table owner.
Enter the Password for the Target table owner.
Select one of the following Database Encoding options:
UNICODE Database. This option is selected by default.
NON-UNICODE Database. If you are using a NON-UNICODE Database, then you must select the NON-UNICODE Database option.
Enter the Workspace Version Number. The Workspace Version Number is the next version of the Target and the latest version available on the Source.
The Workspace Branch Name is a read only field and is populated based on the Workspace Version Number that you enter.
Note: If the migration plan that you are executing has both the Source and Target selected, then the Workspace Branch Name and Workspace Version fields are automatically populated.Click OK.
If you selected the option to run the Incremental Runtime Repository service, the Execution Details window prompts you the enter the following information:
Enter the User ID for the Target Table Owner.
Enter the Password for the Target Table Owner.
Enter the Package Filename.
Enter the Watermark.
Click the Get Workspace Details button to populate the Workspace Branch Name and Workspace Version fields.
Click OK.
While the Migration Plan is running, click Refresh to refresh the migration plan or get status for a migration task.
While the Migration Plan is running, click Log to view log details for a migration task.
Viewing Migration History and Log Files
You can use Siebel Migration to view migration history and log files for a migration task. You can also view information such as status, Archive ID, and the filename for the migration package.
This task is a step in Process of Using Siebel Migration to Migrate Data.
To view history
In Siebel Migration, navigate to the History tab.
Select the migration task in which you want view log history.
Click the Plus icon next to the migration task in the plan to see additional History details.
Click Log to view the log details for the migration task.
Asynchronous Migration Using Siebel Migration
You can use Siebel Migration to plan and carry out an asynchronous migration. An asynchronous migration essentially involves creating an asynchronous migration plan for the source environment and another (separate) asynchronous migration plan for the target environment. Migration activities that must be completed on the source environment can then be carried out independently of the migration activities that must be completed on the target environment. For asynchronous migration to work, both source and target environments must be in a Repository Upgraded state; otherwise migration execution will be performed in synchronous mode.
Generating a watermark if required.
Creating and executing an export only migration plan to export resources from the source environment.
Creating and executing an import only migration plan to import (exported) resources to the target environment.
To perform an asynchronous migration using Siebel Migration
Generate a watermark if required. To export an incremental runtime repository, you must get the Watermark file from the target environment where you are planning to import the exported data.
Note: You must ensure that the watermark you use is the latest watermark. If you export the repository using an old watermark, then the import will fail with an error message similar to the following: Watermark does not match the exported resources watermark.Navigate to the Connections tab in Siebel Migration.
Click the Watermark icon next to the target connection (that is, the target environment where you want to import the exported data).
In the dialog that appears, enter the Watermark file name and click OK.
If the Migration Package Location is configured on the Migration Profile in Siebel Management Console, then the Watermark file is generated in the Migration Package Location path. Otherwise the Watermark file is generated in the
<File System>\migrationfolder on the selected connection.
Create an export only migration plan on the source environment.
Navigate to the Migration Plan tab in Siebel Migration.
Click New Migration and then enter the Name of the migration plan and a Description.
Select and move the connection, where you want to export data from, to the Source field.
Select the resources that you want to export.
Save the source migration plan.
Create an import only migration plan on the target environment.
Navigate to the Migration Plan tab in Siebel Migration.
Click New Migration and then enter the Name of the migration plan and a Description.
Select and move the connection, where you want to import data to, to the Destination field.
Select the resources you want to import.
Save the target migration plan.
Execute the export only migration plan on the source environment.
Navigate to the Execute tab in Siebel Migration.
Go to and select the migration plan that you created in Step 2 and want to export, and then click the Play icon in the Action column.
Complete the fields in the Execution Details Window that appears as required, and then click OK. For information on how to complete the fields in the Execution Details Window, see Executing a Siebel Migration Plan.
Siebel Migration starts to export all the resource data simultaneously. After all data has been exported, it is then packaged into a package file. If the Migration Package Location is configured on the Migration Profile in Siebel Management Console, then the package file will be created in the Migration Package Location path. Otherwise, the package file will be created in the
<File System>\migrationfolder on the source machine.The package file contains a list of all the resources that were exported. It also contains the Watermark information if you have chosen the Incremental Runtime Repository or Incremental Workspace Data resource in the migration plan.
Execute the import only migration plan on the target environment:
Navigate to the Execute tab in Siebel Migration.
Go to and select the migration plan that you created in Step 3 and want to import, and then click the Play icon in the Action column.
Complete the fields in the Execution Details Window that appears as required, and then click OK. For information about how to complete the fields in the Execution Details Window, see Executing a Siebel Migration Plan.
Before executing the import only migration plan, you must ensure and do the following:
Ensure that the package file (created in Step 4) is accessible to the target connection where you want to import the exported data. If the Migration Package Location is configured on the Migration Profile in Siebel Management Console, then the package file must be in the Migration Package Location path.
If the Migration Package Location is not configured, then you must copy the package file (created in Step 4) from the source to the target environment’s
<File System>\migrationfolder.
Note: Before the import starts, Siebel Migration ensures that the resources selected in the import only migration plan match the resources selected in the export only migration plan. If the resources do not match, then an error message appears and the import will not start. Similarly, if the Incremental Runtime Repository or Incremental Workspace Data is part of the migration plan, then the watermark used during the export must match the watermark in the target environment. Otherwise , an error message appears and the import will not start.Note: The File System path must be accessible by all Siebel Servers and application interface machines.
Migrating Siebel 18.8 Update or Later Release Repository Changes from a Development to a Production Environment
Once the development (source DR or design time repository) environment is upgraded to the Siebel 18.8 Update or later release binary and repository, you must perform the steps in the following procedure to migrate the changes to the production (target RR or runtime repository) environment. You can use the asynchronous migration feature to do this only if both source (development) and target (production) environments are in a Repository Upgraded state. If either (source or target) environment is not in a Repository Upgraded state, then the migration execution will be performed in synchronous mode.
To migrate Siebel 18.8 Update or later release repository changes from a development (source) to a production (target) environment
Create a connection to the target environment.
For more information about creating a connection, see Creating a Connection.
Create a migration plan with Incremental Runtime Repository Service where source is the Development (DR) environment and target is the Target (RR or production) environment. (You can use the Runtime Repository Service instead of Incremental Runtime Repository Service.)
For more information about migration planning, see Creating a Migration Plan.
Run the migration plan that you created in Step 2.
After you complete Steps 1 to 3, you must add the seed data to the target (RR or production) environment.
For more information, see Adding Seed Data to the Production Environment.
Adding Seed Data to the Production Environment
After you complete the steps described in Migrating Siebel 18.8 Update or Later Release Repository Changes from a Development to a Production Environment, you must complete the following procedure to add the seed data to the production (target RR or runtime repository) environment.
To add seed data to the production environment
In Siebel CRM, open the Call Center application from the development environment that is upgraded to the Siebel 18.8 Update or later release binary and repository.
Navigate to the Site Map and then Administration Application - Business Service Access.
In the Business Service applet, query for the Application Migration Utility Service in the Name field.
-
In the Business Service Method applet, verify that it contains the following methods:
CreateManifest
GenerateWatermark
GetWatermarkForIncrementalImport
GetWatermarks
ReadManifest
ValidateManifest
GetWatermarkFrmFile
In Siebel CRM on the target (RR or production) environment that you plan to upgrade to the 18.8 Update or later Siebel Runtime Repository, open the Call Center application. This step assumes that the binary is already upgraded to 18.8 Update or later. If not, upgrade the binary.
Navigate to the Site Map and then Administration Application - Business Service Access.
Create a new record in the Business Service applet.
Enter Application Migration Utility Service for the value in the Name field.
In the Access By Responsibility applet, add the appropriate responsibility. The default responsibility is Siebel Administrator.
In the Business Service Access Method applet, add all the methods listed in Step 4.
Save your changes.
Restart the EAI Object Manager component (
EAIObjMgr_<lang>) to read the newly added data.
Activating Workflows and Tasks in the Production Environment After Full Migration
All workflows and tasks must be activated. You need the design time workflow records to activate the workflows. The design time data for workflows is available after full migration even though the design time data is not stored in the production (target) environment. It is recommended that you activate all workflows immediately after a full migration. When an incremental migration is triggered after a full migration, it deletes all design time data for workflows (so the opportunity to activate any workflows is lost after you run an incremental migration). Activating workflows involves generating a runtime definition of the workflow from the design time records.
The following procedure shows you how to activate workflows and tasks in the production (target RR) environment after a full migration. This procedure applies for Siebel 17.x, Siebel 18.x and later releases.
To activate workflows and tasks in the production environment after a full migration
Rename the migrated repository to Siebel Repository.
To do this, for example, use an SQL statement on the target environment.
Restart the Siebel Server (siebsrvr).
Start the Siebel business application, for example, Siebel Call Center.
Navigate to the Administration - Business Service screen, then the Simulator view.
Run the following business service to activate all workflows and tasks in the target environment:
Business Service Name Invocation Method Input Arguments Siebel Runtime Metadata Publisher Service
ActivateWorkflowsTasks
Property Name = “Full Migration”
Value = True
Migrating from a Development to a Production Environment Without Repository Upgrade on the Target Environment
Typically if either source (development) or target (production) environment is not in a Repository Upgraded state, then migration execution is performed in synchronous mode. You can migrate asynchronously only if both environments are in a Repository Upgraded state. However, if you want to avoid synchronous migration altogether, you can manually apply any repository and schema changes to target environments that are not in a Repository Upgraded state by completing the steps in this procedure.
To migrate from a development (source) to a production (target) environment without Repository Upgrade on the target environment
Generate a watermark for the target environment:
Start the target application. For example: Siebel Call Center or any other employee facing application.
Navigate to the Administration - Business Service screen, then the Simulator view.
Click New (the plus (+) icon) to create a new Business Service record with the following values:
Service Name Method Name Migration Incremental Runtime Repository Data Service
GetWatermark
Click Run.
In the Output Arguments applet, copy the value in the Property Value field for the watermark Property Name.
Save the value in a text file because you will need it in Step 3 later.
Export the schema from the source environment:
Start the source application. For example: Siebel Call Center or any other employee facing application.
Navigate to the Administration - Business Service screen, then the Simulator view.
Click New (the plus (+) icon) to create a new Business Service record with the following values:
Service Name Method Name Migration Schema Service
Export
Create a new record in the Inputs Arguments list applet:
Click the multiple select button in the Property Name field, and then click the plus (+) icon on the Property Set Properties applet that appears.
Enter the following values in the Property Name and Value fields, and then click Save.
Property Name Value migrationid
schema_export
Click OK to close the Property Set Properties applet.
Click Run.
In the Output Arguments applet, copy the value in the Property Value field for the
trackingidProperty Name.Save the value in a text file because you will need it in Step 5 later.
Make sure that the ddldict process is running.
To do this, use Task Manager on Windows or the ps command on UNIX.
Export the Incremental Runtime Repository from the source environment:
Start the source application. For example: Siebel Call Center or any other employee facing application.
Navigate to the Administration - Business Service screen, then the Simulator view.
Click New (the plus (+) icon) to create a new Business Service record with the following values:
Service Name Method Name Migration Incremental Runtime Repository Data Service
Export
Create a new record in the Inputs Arguments list applet:
Click the multiple select button in the Property Name field, and then click the plus (+) icon on the Property Set Properties applet that appears.
Enter the following values in the Property Name and Value fields, and then click Save:
Property Name Value migrationid
repo_export
Click the plus (+) icon in Property Set Properties applet again, enter the following values in the Property Name and Value fields, and then click Save.
Property Name Value watermark
Paste the value that you saved from the Property Value field in the Output Arguments applet in Step 1 into this field.
Click OK to close the Property Set Properties applet.
Click Run.
In the Output Arguments applet, copy the value in the Property Value field for the
trackingidProperty Name.Save the value in a text file because you will need it in Step 6 later.
Make sure that the repimexp process is running.
To do this, use Task Manager on Windows or the ps command on UNIX.
Ensure that the Schema Export and Incremental Runtime Repository Export from the source environment is complete:
At regular intervals, check that the ddldict and repimexp processes are running, until they complete.
Verify the logs for ddldict and repimexp. The logs for these utilities are stored in the following locations:
<FS_PATH>\migration\schema_export\logfor Schema Export<FS_PATH>\migration\repo_export\logfor Incremental RRYou must wait until these two processes (ddldict and repimexp) are complete.
Import the (source) Schema to the target environment:
Copy the
schema_exportfolder from<FS_PATH>\migration\on the source machine.Paste the
schema_exportfolder into the<FS_PATH>\migrationpath on the target machine.Start the target application. For example: Siebel Call Center or any other employee facing application.
Navigate to the Administration - Business Service screen, then the Simulator view.
Click New (the plus (+) icon) to create a new Business Service record with the following values:
Service Name Method Name Migration Schema Service
Import
Create a new record in the Inputs Arguments list applet:
Click the multiple select button in the Property Name field, and then click the plus (+) icon on the Property Set Properties applet that appears.
Enter the following values in the Property Name and Value fields, and then click Save:
Property Name Value migrationid
schema_export
Click the plus (+) icon in Property Set Properties applet again, enter the following values in the Property Name and Value fields, and then click Save.
Property Name Value filename
Paste the value that you saved from the Property Value field in the Output Arguments applet in Step 2 into this field.
Click the plus (+) icon in Property Set Properties applet again, enter the following values in the Property Name and Value fields, and then click Save.
Property Name Value username
<Target Database Schema User Name>Note: The database schema user name is in plain text format. Contact your Siebel administrator if you do not know what the database schema user name is for the target environment.Click the plus (+) icon in Property Set Properties applet again, enter the following values in the Property Name and Value fields, and then click Save.
Property Name Value password
<Target Database Schema Password>Note: The database schema password must be in Base 64 encoded format. Contact your Siebel administrator if you do not know what the database schema password is for the target environment.Click OK to close the Property Set Properties applet.
Click Run.
Make sure that the ddlimp process is running in the target environment.
To do this, use Task Manager on Windows or the ps command on UNIX.
Wait until the ddlimp process completes successfully.
Verify the log located in the
<FS_PATH>\migration\schema_export\logfolder on the Target machine.
Import the (source) Incremental Runtime Repository to the target environment:
Note: Perform this step only if Step 5 completes successfully.Copy the
repo_exportfolder from<FS_PATH>\migration\on the source machine.Paste the
repo_exportfolder into the<FS_PATH>\migrationpath on the target machine.Start the target application. For example: Siebel Call Center or any other employee facing application.
Navigate to the Administration - Business Service screen, then the Simulator view.
Click New (the plus (+) icon) to create a new Business Service record with the following values:
Service Name Method Name Migration Incremental Runtime Repository Data Service
Import
Create a new record in the Inputs Arguments list applet:
Click the multiple select button in the Property Name field, and then click the plus (+) icon on the Property Set Properties applet that appears.
Enter the following values in the Property Name and Value fields, and then click Save:
Property Name Value migrationid
repo_export
Click the plus (+) icon in Property Set Properties applet again, enter the following values in the Property Name and Value fields, and then click Save.
Property Name Value filename
Paste the value that you saved from the Property Value field in Output Arguments applet in Step 3 into this field.
Click OK to close the Property Set Properties applet.
Click Run.
Make sure that the process repimexp is running in the target environment.
To do this, use Task Manager on Windows or the ps command on UNIX.
Wait until the repimexp process completes successfully.
Verify the log located in the
<FS_PATH>\migration\repo_export\logfolder on the Target machine.
After you complete the steps in this procedure, the environment is ready for asynchronous migration even if the target environment is not in a Repository Upgraded state.