20Migration Planning Using Siebel Migration
Migration Planning Using Siebel Migration
This chapter provides information on planning your data migration (for a Dev to Test to Production) with Siebel Migration. It includes the following topics:
About Migrating with Siebel Migration z/OS
Environments: All environments
Platforms: All platforms.
Siebel Migration is a Web-based tool for end-to-end repository and data migration. Migrating repository or data using Siebel Migration is not the same as performing a database upgrade where you migrate your custom repository and schema from one release of Siebel CRM to a higher release level. Migrating repository or data using Siebel Migration is a tool that allows you to replicate the setup (including repository, runtime repository, application workspace data, application data, application interface web artifacts, and file system artifacts) that exists on one environment (known as the source) to another environment (known as the target).
The source environment is the Design Time Repository (DR), also known as the development environment.
The target environment is the Runtime Repository (RR), also known as the test environment (system integration testing or user acceptance testing) or production (live environment) or pre-production environment that internal and external users access.
Siebel Migration uses the RESTful services to export the data on the source environment, transfer the exported data to the target environment, and then import the data to the target environment. Siebel Migration orchestrates all the resources chosen in the migration plan that is being executed.
Siebel Migration is capable of synchronous and asynchronous migration of database artifacts. For example, you can use Siebel Migration for the synchronous migration of your repository, runtime repository, application workspace data, application data, application interface Web artifacts and file system artifacts from a source environment to a target environment. You can also use Siebel Migration for asynchronous migration plans, where all activities that must be completed on the source environment can be done independently of all the migration activities to be completed on the target environment. This is beneficial if you have firewall restrictions or situations where source environments and target environments are managed by different teams. Creating asynchronous migration plans on the source and target environments allows customers to separate responsibilities by assigning a team to activities on the source environment and assigning another team to activities on the target environment.
Siebel Migration provides the following tools to prepare your data for migration:
Database Utilities.
Application Deployment Manager (ADM).
Migration Rules Expression Designer to create migration rules for your migration.
Use Siebel Migration to do the following:
Add connections to your migration. For more information about creating connections, see Creating a Connection.
Create Migration Plans. For more information about creating Migration Plans, see Creating a Migration Plan. Migration plans are segregated into two separate plans:
Source Only Environment Migration Plan. This migration plan exports all the required artifacts based on the resources selected as a package. If you create a Migration Plan for the Source Only environment, the plan can be used for Export only.
Destination Only Environment Migration Plan. This migration plan is on the target environment that imports all the required artifacts based on the same resources selected for the export migration plan on the source environment. If you create a Migration Plan for Destination Only target environment, the Migration Plan can be used for Import only.
View the historical data of the migration execution and log history for migration tasks. For more information about viewing historical data of the migration execution, see Viewing Migration History and Log Files.
Execute Migration Plans. The migration plan execution list includes the Package Filename field. This field is populated with the package filename provided by the user. Depending on the action selected when you execute the migration plan and the resources or services selected, you will be prompted to enter additional information. The following tables list the migration plan actions for different services and the additional information that you must provide.
When you execute an Export Only Migration Plan on a Source, Siebel Migration exports the data for all the selected resources and creates a package zip file. The package zip file will be created in the Migration Package Location if that location was configured in the Siebel Migration Console, otherwise, the package zip file will be created in the migration folder under the file system folder on the source environment. This package can be used to import data to a Destination environment. You must take the package zip file from the source environment and place it in the Migration Package Location if that location is configured in the Siebel Management Console, otherwise, you must place the package zip file in the migration folder under the file System on the destination environment. Once the exported package is placed in the destination environment, you can run the Migration Plan as Destination Only and the Siebel Migration application imports the package file.
Note: If both the Siebel Migration application that connects to the source environment and the Siebel Migration application that connects to the target environment are using the same Migration Package Location, then you do not need to copy the package ZIP file in the migration folder under the file system on the destination environment.When you execute an Export Only Migration Plan, Siebel Migration creates a manifest file and exports the data for the selected resources. The manifest file contains the list of resources that were exported as part of this execution and the watermark filename.
When you execute an Import Only Migration Plan using the package filename, Siebel Migration verifies that the resources selected in the migration plan matches the resources written in the manifest file. Siebel Migration also verifies that the watermark present in the watermark file and the manifest file matches the watermark on the connection where the user is importing. The execution proceeds only if both the resource and watermark matches.
Note: Watermarks are only matched for Incremental Runtime Repository and File Prepare and Deploy resources.For more information about executing migration plans, see Executing a Siebel Migration Plan.
Schema Service Migration Plan Actions
The following table lists the migration plan actions for the Schema Service and the additional information that you must provide.
Migration Plan Action |
User Prompt |
|---|---|
Export Only Migration Plan |
Package Filename |
Import Only Migration Plan |
The Import Only Migration Plan options are:
|
Export and Import Migration Plan |
The Export and Import Migration Plan options are:
|
Runtime Repository Data Service Migration Plan Actions
The following table lists the migration plan actions for the Runtime Repository Data Service and the additional information that you must provide.
Migration Plan Action |
User Prompt |
|---|---|
Export Only Migration Plan |
Package Filename |
Import Only Migration Plan |
The Import Only Migration Plan options are:
|
Export and Import Migration Plan |
The Export and Import Migration Plan options are:
|
Incremental Runtime Repository Data Service (IRR) Migration Plan Actions
The following table lists the migration plan actions for the Incremental Runtime Repository Data Service (IRR) and the additional information that you must provide.
Migration Plan Action |
User Prompt |
|---|---|
Export Only Migration Plan |
The Export Only Migration Plan options are:
|
Import Only Migration Plan |
The Import Only Migration Plan options are:
|
Export and Import Migration Plan |
The Export and Import Migration Plan options are:
|
Application Workspace Data Service (Full Seed/LOV) Migration Plan Actions
Migration Plan Action |
User Prompt |
|---|---|
Export Only Migration Plan |
Package Filename |
Import Only Migration Plan |
The Import Only Migration Plan options are:
|
Export and Import Migration Plan |
The Export and Import Migration Plan options are:
|
Incremental Application Workspace Data Service (Incremental LOV/Seed) Migration Plan Actions
The following table lists the migration plan actions for the Incremental Application Workspace Data Service (Incremental LOV/Seed) and the additional information that you must provide.
Migration Plan Action |
User Prompt |
|---|---|
Export Only Migration Plan |
The Export Only Migration Plan options are:
|
Import Only Migration Plan |
Package Filename |
Export and Import Migration Plan |
None |
Application Data Service Migration Plan Actions
The following table lists the migration plan actions for the Application Data Service and the additional information that you must provide.
Migration Plan Action |
User Prompt |
|---|---|
Export Only Migration Plan |
Package Filename |
Import Only Migration Plan |
Package Filename |
Export and Import Migration Plan |
None |
Application Data Service with Transformation Migration Plan Actions
The following table lists the migration plan actions for the Application Data Service with Transformation and the additional information that you must provide.
Migration Plan Action |
User Prompt |
|---|---|
Export Only Migration Plan |
Package Filename |
Import Only Migration Plan |
Package Filename |
Export and Import Migration Plan |
None |
File Prepare & Deploy Migration Plan Actions
The following table lists the migration plan actions for File Prepare & Deploy and the additional information that you must provide.
Migration Plan Action |
User Prompt |
|---|---|
Export Only Migration Plan |
The Export Only Migration Plan options are:
|
Import Only Migration Plan |
Package Filename |
Export and Import Migration Plan |
None |
You can also use REST APIs to interact with the Siebel Migration Application. You must run the repository upgrade before you use REST APIs with the Siebel Migration Application. For more information about using REST APIs with the Siebel Migration Application, see Using REST API with Siebel Migration Application.
The following chapters deal with Siebel Migration:
Roadmap for Planning a Migration with Siebel Migration
Environments: All environments
Platforms: All platforms.
This topic provides an overview of the recommended guidelines for planning and managing the data migration process.
Use the following steps to help plan your migration.
Install Siebel Migration. Siebel Migration is installed with Siebel Application Interface as part of the Siebel Enterprise Server software installation. For more information about installing Siebel Application Interface, see Siebel Installation Guide for Microsoft Windows.
Configure Siebel Migration with Siebel Management Console. Siebel Management Console is installed with Siebel Application Interface as part of the Siebel Enterprise Server software installation. Configuring Siebel Migration consists of the following tasks:
Create the Siebel Migration Profile. The Siebel Migration Profile is created with the Siebel Management Console. For more information about creating the Siebel Migration profile, see Siebel Installation Guide for Microsoft Windows.
Optionally, you can enter a Migration Package Location when you create a Siebel Migration Profile. You must give a network file share (NFS) path. If the Migration Package Location is configured in the Migration Profile in Siebel Management Console, the Export, Import and Generate Watermark actions use the Migration Package Location instead of using the migration folder in the file system. If the Migration Package Location field is provided, Siebel Migration copies the exported package file in the Migration Package Location and imports the specified package file from this Migration Package Location instead of the migration folder.
Configure Siebel Migration. Siebel Management Console comes with a pre-seed profile. You can either edit the existing pre-seed profile, create a new profile, or create a new profile by cloning the pre-seed profile. For more information about configuring Siebel Migration, see Siebel Installation Guide for Microsoft Windows.
Deploy the Siebel Migration Profile. The Siebel Migration Profile is deployed with the Siebel Management Console. For more information about deploying the Siebel Migration Profile, see Siebel Installation Guide for Microsoft Windows.
Configure Authentication for Siebel Migration. Siebel Migration supports Basic and SSO authentication:
Basic Authentication: Siebel REST services authenticate Siebel Migration users. Basic authentication internally uses the AuthenticateUser method from the Authentication Service For Migration RESTful Service to ensure whether the user has a permission to access the application.
SSO Authentication: The User is authenticated by the SSO server. Once the user is successfully authenticated, the request is forwarded to Siebel Migration. Siebel Migration uses the AuthenticateUser method from Authentication Service For Migration RESTful services to ensure whether a user has a permission to access Siebel Migration.
The authentication type can be selected during the Siebel Migration profile creation in the Siebel Management Console. For more information, see Siebel Installation Guide for Microsoft Windows.
The Siebel Migration invokes Authentication Service For Migration business service to authenticate a user. You must configure the Authentication Service for Migration business service to restrict the access to the Siebel Migration application by adding responsibilities to the AuthenticateUser method. For more information about configuring responsibilities and access control for business services, see Siebel Security Guide.
Configure REST Inbound in Siebel Management Console. Siebel Migration uses RESTful service. REST Authentication and REST Inbound Defaults are configured in Siebel Management Console as part of the Siebel Application Interface Profile. For more information about configuring REST Inbound in Siebel Management Console, see Siebel REST API Guide and Siebel Installation Guide for Microsoft Windows.
Setting Up the Siebel Environments. The source and target environments must have several Siebel Server components enabled. For more information about Siebel Server components, see Siebel System Administration Guide.
The source Siebel environment must have the following Siebel Server components enabled.
Workflow Management Component Group - Workflow Process Manager
Enterprise Application Integration Component Group - EAI Object Manager
Siebel Remote Component Group - Synchronization Manager
The target Siebel environment must have the following Siebel Server components enabled.
Workflow Management Component Group - Workflow Process Manager
Enterprise Application Integration Component Group - EAI Object Manager
The username requirements for migration are that both source and target environments should have the same username and password.
Set the LDR_CNTRL environment variable for AIX environments. For AIX environments, you must set the value of the LDR_CNTRL environment variable to the following:
LDR_CNTRL=LOADPUBLIC@MAXDATA=0x60000000
For more information about the LDR_CNTRL environment value, see Siebel Performance Tuning Guide.
Generate the storage control file. Log into the target Siebel Server and navigate to the
<Siebel Server Home>/bindirectory. Execute the following command:trgxtrct /u <database username> /p <database password> /c <ODBC Data Source> /d <Table Owner> /o <output path>/storage.ctl /4 BP2 /7 <DB Encoding Schema>
Once the storage control file is generated, copy the newly generated storage.ctl file to the following location:
<Target Siebel File System path>/migration/control/storage.ctl
Prepare the migration data. Siebel Migration exposes Database Utilities that you can use to prepare your data for migration. For more information about preparing data for migration, see Process of Preparing Siebel Application Data for Migration.
Create Application Data Migration Rules. Use Siebel Migration Rule Expressions Designer feature to create migration rules. For more information, see Creating Migration Rules.
Create Application Deployment Manager projects. Use Siebel Application Deployment Manager to create Application Deployment projects. For more information about creating Application Deployment Manager projects, see Siebel Application Deployment Manager Guide.
Note: In the Source environment, to export the ADM Project into a file, the EAIFileTransportFolders parameter should have the <Siebel File System>\migration folder configured. Otherwise, the export file fails due to a write permission issue. For more information about enabling write access for the EAI File Transport, see Transports and Interfaces: Siebel Enterprise Application Integration.To import the exported package on the Destination environment, the Deployment Project Name must be same as the Source Deployment Project Name or the import will fail.Use Application Deployment Manager to transform data. Use Application Deployment Manager to create data maps to transform your migration data. For more information about transforming data with Application Deployment Manager, see Process of Transforming Data with Siebel Application Deployment Manager.
Customize Migration Process Orchestration. You can add new migration resources to the ResourceSequence.txt file. The Siebel Migration application reads through this file during the execution process and executes the services in a sequential order. You can customize the sequence of the migration process by modifying the ResourceSequence.txt file. For more information about customizing the migration process orchestration, see About Migration Process Orchestration During the Siebel Migration Process.
Use Siebel Migration. Use Siebel Migration to add connections to a migration, create migration plans, execute migration plans, and review migration history. For more information about using Siebel Migration, see Data Migration Using Siebel Migration.
Review Migration Log Files. Use Siebel Migration to review migration log files. For more information about migration log files, see About the Siebel Migration Log Files.
About Siebel Rules Expression Designer
Environments: All environments
Platforms: All platforms.
Use Siebel Rules Expression Designer to create the following transformation rule file and input file for your migration:
Migration rule file. A migration rule file (.rul) contains data transformation rules that are executed during an export. On the target environment, the exported data file will contain the transformed data values.
A rule file consists of a list of tables along with the columns for which a default value is specified. Only direct substitutions are allowed for a column. The column can be of any datatype.
For a rule file, you can specify a WHERE clause which applies the transformation only to the records which satisfy the WHERE clause criteria. The WHERE clause can have filters only with the values.
For Update Actions, the following are the transformation rules for rule file:
Supports only the equal (=) relational operator.
Supports only the AND logical operator.
You can add a WHERE clause to filter the data and apply the transformation rule only to those records matching the WHERE clause.
Supports multiple rules. Each rule will be delimited by the semicolon character.
If you use more than one field, then use an AND logical operator.
Input file. An input file (.inp) is an input file for the selective export of data. Only the tables mentioned in the input file are exported. Record level filters can be applied based on the columns. In addition, a single WHERE clause is supported for every table in the Input file. A WHERE clause can consist of any number of columns combined using OR or AND operators.
For Conditions, the following are the filter rules for input files:
Supports any relational operator that a database query would support. For example, = is equal, != or <> is not equal, > is for less than.
Only the AND logical operator is supported.
After the migration rules are created, use Siebel Rules Expression Designer to validate the new rules.
Related Topic
About Migration Process Orchestration During the Siebel Migration Process
Environments: All environments
Platforms: All platforms.
During the migration process, the Siebel Migration application executes a set of business service methods for each resource. The execution sequence of these service methods is defined by an external sequence text file, the ResourceSequence.txt file. The ResourceSequence.txt file lists the names of the Business Services for each resource and the supported methods for Export, Import, and Status. The ResourceSequence.txt file defines the order of migration execution.
The Siebel Migration application reads through this file during the execution process and executes the services in a sequential order.
The migration executes a resource only if the resource is present in the ResourceSequence.txt file. If the resource is not defined in the ResourceSequence.txt file, the resource will not appear in the Siebel Migration and will not be executed.
New migration resources can be added to the ResourceSequence.txt file in the required execution order. New business services should adhere to the following standards:
The business service must support methods for Import, Export, and GetStatus.
Any extra methods or extra Input or Output to these methods are considered as exceptions and requires handling in the Siebel Migration code before inclusion in sequence file.
If the methods are Sync methods that do not support GetStatus, then the execution will proceed based on the HTTP response and the output parameters will not be parsed. If parsing is required for the output parameters, then it should be handled in the Siebel Migration code.
Oracle recommends that you do not modify the existing data in the ResourceSequence.txt.
Related Topic
Customizing Siebel Migration Execution and Resource Sequencing
About the Process Flow for Migration Resources
PreProcessing_Export: This section contains the steps to be executed before the resources are exported.
PostProcessing_Export: This section contains the (user defined) steps to be executed after the resources are exported.
PreProcessing_Import: This section contains the steps to be executed before the resources are imported.
PostProcessing_Import: This section contains the steps to be executed after the resources are imported.
Export: This section contains the resources and the corresponding steps to be exported.
Import: This section contains the resources and corresponding steps to be imported.
Each Migration resource has a section in the orchestration.json file that describes its process flow. The process flow is made up of a number of sub-processes or steps. Each step in the migration process flow has the following attributes:
ResType: Specifies the type of resource for migration, such as, pre or postprocessing, Business Service Export, or Import. The value for ResType is Process. This attribute applies only for the PreProcessing_Export, PostProcessing_Export, PreProcessing_Import, and PostProcessing_Import resources.
PlanType: Specifies the plan type for migration. Possible values are:
[“Export”]: This applies for Export Only Asynchronous Migration Execution.
[“Import”]: This applies for Import Only Asynchronous Migration Execution.
[“Export-Import”]: This applies only for Export and Import Synchronous Migration.
Business Service. The name of the Siebel Business Service.
Step Name: The name of the step in the Resource.
ApplyToResource: Specifies the actual resource for migration. A valid value for ApplyToResource is one or more comma-separated Business Service names, as defined in the Import or Export sections. If this attribute has a value defined, then this step is executed only for the business services mentioned in the Import and Export sections. If this attribute is empty, then this step is executed for all business services. This attribute applies only for the PreProcessing_Export, PostProcessing_Export, PreProcessing_Import, and PostProcessing_Import resources.
Method. The Siebel Business Service method.
Location. The location where the Siebel Business Service will be executed. Values are either Source or Target.
LogMethod: The method used to obtain the logs for the method.
InArg. The Siebel Business Service input arguments.
OutArg. The Siebel Business Service output arguments.
Async. This section contains details if the method is Asynchronous.
Async Business Service. The Siebel Business Service Name
Async Method. The Siebel Business Service method.
An example of the step sequence in a migration process flow from the orchestration.json file follows:
"Steps": [
{
"ResType": "Process",
"PlanType": ["Export"],
"Business Service": "Application Migration Utility Service",
"StepName": "GetWatermarkFromFile",
"ApplyToResource": ["Migration Schema Service",
"Migration Incremental Application Workspace Data Service",
"Migration Incremental Runtime Repository Data Service"],
"Method": "GetWatermarks",
"Location": "Source",
"LogMethod": "GetStatus",
"InArg": ["sharedPath", "filename", "migrationid"],
"OutArg": ["watermark"],
"Async": {}
]
For more information about the (preprocessing and postprocessing) operations involved and methods invoked during the execution of a migration plan, see Executing a Siebel Migration Plan.
About the Siebel Migration Log Files
Environments: All environments
Platforms: All platforms.
Siebel Migration creates log files that provide detailed information on the migration processes, including whether the migration succeeded or failed.
The Siebel Migration creates the following types of log files:
Migration log file. The migration log file contains all the migration events, such as errors and warnings, for the migration application.
The Siebel Migration Log file is located in the following directory:
<Application Interface Install Home>\applicationcontainer\logs\migration.log
Business Service log file. The Business Service log file is created in the EAI Object Manager log file when a Business Service is executed.
How to Locate Siebel Migration Resource Log Files
Siebel Migration resource files are stored in the following location:
Windows: SIEBEL_FILESYSTEM/migration/<migration id>
where:
SIEBEL_FILESYSTEM: Indicates the location of the Siebel file system.
migration: Indicates the location of all the Siebel Migration files.
inp: Indicates the input file generated by the Rule Expression Designer
rul: Indicates the rule file generated by the Rule Expression Designer.
-
<migration id>: The ID generated by the Siebel Migration application when the user executes the migration plan.
inp: Contains a copy of the input file used for a migration execution.
rul: Contains a copy of the rule file used for a migration execution.
dat: Contains all the data files generated by the export or moved from the source to target for import.
log: Contains the log file generated by the export or import.
schema: Contains the schema file generated schema export or moved from source for import.
other: Contains the Web artifacts or file system artifacts for export and moved from the source for import.
About REST API Used for Migration Discovery and Execution
Environments: All environments
Platforms: All platforms.
REST API requests are used for migration resource discovery and for migrating data from the source environment by exporting the data, transferring the data to the target environment, and importing the data into the target environment.
Siebel Migration includes the migration discovery service that is available to assist with discovering resources available for migration. The discovered services are listed in the Siebel Migration in the sequence in which they are executed during the migration process.
While creating a Siebel Migration plan, you can choose one or more services that are available. When you execute the Siebel Migration plan, those services are invoked to migrate the data.
The following table lists the migration resources that are available in the Siebel Migration.
| Migration Service | Description | Supported Methods |
|---|---|---|
Schema Service |
Migrates the physical Siebel schema from the source environment to the target environment. When you use this service, the Siebel Migration prompts you to enter the Table Owner User Name, the Table Owner Password, and Database Encoding. |
|
Runtime Repository Data Service |
Migrates only the Runtime Repository from the source environment to the target environment. The migrated repository is named Migrated Repository in the target environment. The user must select the name and version of the Workspace Branch. The default version will be the latest version. The Application Workspace Data Service is typically run along with the Runtime Repository Service. After the Siebel Migration is complete, you must change the Migrated Repository to Siebel Repository in the S_REPOSITORY table. |
|
Application Workspace Data Service (Full Seed /LOV) |
Migrates the LOV records from the source environment to the target environment. List of Values (LOV) is workspace-enabled. This option allows you to migrate all LOV records added to the workspace, which you selected when creating the migration plan. You must run the Runtime Repository Service along with the Application Workspace Data Service.
Note: The Application Workspace Data Service and the Runtime Repository Data Service do the same thing. The services selected are the same for both migrations.
|
|
Incremental Runtime Repository Data Service |
Identifies the version of the repository data that was previously migrated. This service takes all the changes from the previously migrated version and the latest version and migrates the data to the target environment. |
|
Incremental Application Workspace Data Service |
Identifies the version that was previously migrated. This service takes all the changes from the previously migrated version to the latest version and migrates them to the target environment. |
|
Application Data Service |
This service migrates the data from the source environment to the target environment based on the tables listed in the It is recommended that you review the tables configured in |
|
Application Data Service With Transformation |
Migrates the data from the source environment to the target environment based on the tables listed in the While exporting the data, this service uses the rule defined in the It is recommended that you review the tables configured in |
|
File Prepare And Deploy Service |
Identifies all the new or modified files and migrates the files to the target environment. On the Target environment, the File Prepare And Deploy Service transfers the modified or new files to each Siebel Application Interface node defined in Siebel Management Console (SMC). This service keeps track of the files that are migrated for each target environment. The next time that the user runs this service, the service will check the modified files or newly created files from the previous migration. This service migrates the file artifacts from Siebel Application Interface and the file system. The File Prepare and Deploy Service reads the checksum values for all the web artifact files from the watermark file. The File Prepare and Deploy Service compares the checksum of the files present in the source web artifacts path. The File Prepare and Deploy Service takes files whose checksum does not match and generates an export package. The files that are not included in the watermark file are included in the export package. While importing the export package on the target environment, the existing files will be overwritten. |
|