Overview of Migration Manager
Migration Manager application
The Migration Manager application is used to migrate configuration content from one product environment to another.
You manage the configuration content that you want to migrate in the form of package definitions and packages. As part of your implementation of a migration process, you use the Migration Manager application to define and create the package definitions, and then distribute and deploy the packages.
For example, you can migrate a configuration from a development environment to a test environment. After testing, you can migrate the configuration to a production environment. The development environment is the source and the test and production environments are targets. You can use this approach during the initial configuration of the product or anytime you want to change your configuration of the product.
The Migration Manager application has the following tabs:
• The Migration Manager application has the following tabs:
• List: To search the Migration Manager application for package definitions.
• Package definition: for defining, saving, approving and activating package definitions.
• Package definition structure: to view the hierarchical structure of a package definition.
• Distribution: to distribute a package from a source to a target environment.
• Package: To create, distribute, and deploy physical packages.
• Messages: To view detailed messages about the creation or deployment of physical packages.
You use the List tab to search the database for a specific record or group of records that meet your criteria. You use the filter fields above the List Table window to enter basic search criteria.
The List tab has a search toolbar with the following links:
Advanced Search: Select from a list of the following options:
More search fields
Enter Where clause
View search tips
Save Search: Select from a list of the following options:
Save current search
View / manage searches
Package Definition tab
You use the Package Definition tab in Migration Manager to create package definitions, which are templates for individual packages. A package definition organizes the content to be migrated and created before other migration activities occur.
The header area identifies the package definition and provides status information.
Migration groups section
Each row in the Migration groups section contains the following attributes:
Migration group – Name of the migration group.
Description – Description of the migration group
In this section, you can add or remove migration groups from a package definition.
You can also set conditions for migration objects within a migration group in a snapshot package definition by clicking Set where clause.
To view dependent migration groups, click View Details to the left of the Migration Group row.
The Dependencies section lists the groups that the current migration group depends on. The dependencies are the relationships between the underlying migration objects in the database. Use this section to determine whether a set of configuration information in one migration group depends on another set of configuration information in another migration group.
Compiled sources section
In the Compiled Resources section, you can add or remove information about compiled resources from a package definition.
Each row in this section contains the following attributes:
Filename – Name of the compiled source file.
Description – Description of the compiled resource.
Migration groups and compiled resources
Package definitions can include migration groups and compiled resources.
A migration group is a collection of related migration objects. A migration object is a group of related business objects (database tables).
You use the Migration Groups application to define and merge configuration objects, which simplifies the creation of package definitions.
You can include references to compiled resources in a package definition. A compiled resource is any file that is outside the product database but is part of the Enterprise Archive (EAR) file. Compiled resources can contain many types of files, such as class files, archive files, image files, and properties files. Compiled resources are usually located in product installation folders, but can also reside on the local client computer or on a mapped network drive
If you need to migrate multiple compiled source files, combine them into one EAR file to simplify the migration process.
Header area of the Migration Manager tabs
The Package definition, Package definition structure, Distribution, Package and Message tabs all have a header to identify the package definition and provide status information.
The header area has the following fields:
Package definition name – The name of the package definition.
Source – The name of the product source environment in which you defined the package. This name is a combination of the database host name, database ID, and database schema name. The source name helps you identify where the data is coming from. The source name is also used in the name of a package to ensure that each package name is unique.
Type – The type of package definition. A package definition can be a snapshot or a change. You specify the type when you create a package definition.
Batch Size – Specifies the number of records to be retrieved when a package is created. The default value is 100.
Change role – Specifies a designated role. Only changes made by users in this role are captured by the Migration Manager application when a change package is created.
Status – An indicator of the migration activities that can be performed on the package definition. The status can be WAPPR (waiting for approval), APPR (approved) or LOCKED.
Active – When selected, indicates that you can create a package based on the package definition. For a change package definition, this check box indicates that the event listeners are registered and that the Migration Manager application is logging change information. An active package definition cannot be changed. A package definition must be active before it can be used to migrate data.
Modify By – The user who last modified the package definition.
Modification Date – The date the package definition was last modified.
Package definition structure
Package definition structure tab
You use the Package definition structure tab to view a hierarchical representation of the content that can exist in the selected package definition. The hierarchy shows the following information:
– The migration groups in the package definition
– The migration objects and object structures in each migration group
– The business objects within each object structure
– All compiled resources in the package definition
The hierarchy section shows the information about the package definition in nested levels. The root of the hierarchy is the name of the current package definition.
The root item can have the following items:
Migration groups – The migration groups in the package definition and the migration objects in those groups. This level can also have an entry for Dependencies, which shows the migration groups that a particular migration group depends on.
Package Metadata – The metadata that describes the package definition.
Compiled Resources – The compiled resource files included in the package definition. Each item shows the absolute path and file name.
You use the Distribution tab to link destinations to a package definition and to change or delete these links.
Each row in the Benefits section has the following characteristics:
Target name – Name of the environment to which the package based on the package definition can be distributed.
Description – Description of the target environment.
Type – The type of target, DATABASE or FILE, depending on whether the target is a remote database or a file on a file system.
Database URL or File Path – The database URL or absolute path on a file system that is accessible by the application server.
To view details of a distribution, click View Details to the left of the distribution row. To delete a distribution, click Mark row for deletion to the right of the distribution row.
Target Details section
The Target Details section contains the following fields:
Username – Username for the target database.
Schema Name – Name of the database schema.
Modify By – The ID of the user who last modified the distribution definition.
Change Date – The date and time of the last changes to the distribution definition.
You use the Package tab to perform the following tasks on a package definition:
– Create or delete a package
– Divide or redistribute a package
– Download compiled resources in a package
– Download a package
– Deploy a package
– Close a package
Each row in the Packages section contains the following attributes:
Package – Name of the package, which is a combination of the package definition name and the source data.
Filename – The name of the package with the archive file extension. For a package targeting a database, this field is empty.
Status – Status of the package.
Status Date – The date the status was applied to the package.
To view detailed information about a particular package, click View details.
Package Details section
The Package Details section displays the following fields for the selected package:
Package – The name of the package. The name is a concatenation of the package definition name, source, and creation date and time, separated by underscores. For example, if the package definition is MyTest, the source is ServerA and the date and time is July 10, 2008, 4:00:00 PM, the package name is MyTest_ServerA_20080430160000.
Status – Status of the package.
Progress status – Indicates the progress of package processing in the source or destination environment.
File name – The file name that corresponds to this package when a package file is generated
Direction – Indicates whether the packet is outbound (from the source environment) or inbound (to the target environment).
Redistribution Source – The source information from which the package is redistributed. This value is the combination of database ID, database schema, and database host name. These values are retrieved from the database server in the environment from which the package is to be redistributed. The redistribution source is not the original source of the package.
Modify By – The user who last modified the package.
Status date – The date and time the package was last modified.
Readme Information – The information entered when the package was created.
The Package tab has tabs with more information about the selected package.
XML formatted information representing the package contents and version information. This information is used in the target environment to deploy the package.
Status History tab
The status and progress status of creating and deploying the package. This tab has the following fields:
Status – The status of the package.
Progress status – The progress status of the package.
Memo – Information about the status change.
Status date – Date and time the user changed the status.
The Details section shows the following additional fields:
Redistribution Source – Indicates whether the status change was caused by a redistribution of the package. The value represents the environment from which the redistribution started. If the package is not a redistributed package, this field is empty.
Change By – The user who changed the status.
Track Distribution tab
Information about the history of the distributions from the package to the target environment. Mainly indicates the success or failure of the distributions. This tab has the following fields:
Target: The environment to which the package is distributed.
Status – The status of the distribution.
Status Message – A message about the distribution.
Distribution Date – The date on which the package was distributed.
The Details section has the following additional field:
Distributed By – The user who distributed the package.
You use the Messages tab to view messages about package definitions and packages. The messages are created when packages are created and deployed. The messages contain progress information or errors.
Message Filter Options section
Use this section to filter the messages. You can select one of the following options:
By package definition – Displays all messages for all packages created based on the current package definition.
Per Package – Displays messages for a single package. If you select this option, enter a value in the Filter package field to select the package whose messages you want to view.
This section displays the messages for the package or package definition. The Messages section has the following fields:
Package – Name of the package.
Message – Text of the message. The message may be truncated in this field.
Message type – can be one of the following types: INFO, ERROR or WARN.
Change date – Date and time when the message was last modified.
Message details section
This section contains the following additional fields:
Message – Full text of the message.
Message Details – Additional details about the message, such as the program stack trace.
Modify By – The ID of the user who last modified the message.
Application for migration groups
You use the Migration Groups application to organize and group the configuration content that you want to migrate. After you set up the configuration content in migration groups, you can include these groups in package definitions in the Migration Manager application. Migration packages can be created based on the package definitions and these packages can then be migrated to another system or environment.
You can work with migration groups that come with the product (internal migration groups) or you can create your own (user-defined) migration groups.
The Migration Groups application has the following tabs:
List: Search for migration groups.
Mig Group: to create, view, edit or delete migration groups.
Mig group tree: To display in a hierarchy the migration objects that are in a migration group.
Migration groups tab Application list
Migration Group tab
You use the Migration Group tab in the Migration Groups application to define new migration groups and their dependencies. You can use these new migration groups in package definitions that you create in the Migration Manager application. The Migration Group tab contains the following sections:
The header section has the following fields:
Migration group – The name of the migration group.
Migration Group Order – Assign the correct order to migration groups to ensure correct sequential processing of configuration data. If migration groups are not properly ordered, the deployment of migration packages that contain these groups with the Migration Manager application may fail. For example, if records in migration group B depend on records in migration group A, specify the correct order to have the Migration Manager application insert or update the records from migration group A into the target database before inserting the records from the migration, or updated. group B.
Internal – If this check box is selected, the migration group is shipped with the product. The check box is read-only. You cannot edit internal groups.
Migration objects section
The Migration Objects section lists the migration objects in a migration group. You can view the migration objects or add objects to a migration group that you create. Each row in this section contains the following attributes:
Migration Object – The name of the migration object.
Description – The description of the migration object.
Migration Object Order – The order of the migration object within the migration group. Objects are processed in sequential order during the creation and deployment of tasks of the migration process. The value must be unique within the migration group. By default, the next consecutive value is assigned.
When a package is created, the Migration Manager application checks the object order to determine the order in which the migration object is processed. When a package is deployed, the Migration Manager application first populates tables in the target database with parent records, and then populates related tables with the related child records.
Internal – If this check box is selected, the migration object is shipped with the product. You cannot change internal objects.
To view detailed information about a particular migration object, click View Details to the left of the Migration Object row.
Example of ordering migration objects
You can use the Business Process Management (BPM) migration group to move workflow processes. This migration group contains the following migration objects, which must be processed in the order listed:
The sequence must be followed because a workflow process can reference one or more actions, roles, communication templates, or escalations. Likewise, an escalation can refer to one or more actions or communication templates, and a template can refer to a role.
Failure to process these objects in this order can cause the migration to fail, as the system may attempt to insert a record into a table before inserting a related and required record into a related table.
The Dependency section lists the groups that the migration group shown in the header (the current migration group) depends on. These dependencies indicate relationships between the underlying migration objects in the database.
To view detailed information about a dependency, click View Details to the left of the Dependent Migration Group column in the Dependency row.
Migration Group Structure tab
Use the Migration Group Structure tab to display a hierarchical view of the currently selected migration group, the migration objects, and the business objects of each migration object.
This tab also shows the dependent groups of the currently selected migration group, the migration objects, and the business objects of each migration object.
When you select this tab, the hierarchy is displayed collapsed. Expand the hierarchy by clicking the plus signs.
Object Structures Application
You use the Object Structure tab to identify the objects and data fields that make up an object structure. You also use the Object structure tab to define the following object structure characteristics:
Which system application consumes the object structure
Whether you can use the object structure to create, update, and delete object content, or to restrict the use of the object structure to query and publish object content
Whether you can use the object structure to display a non-hierarchical structure (flat file data)
The objects that you can include in the object structure and the relationships between the objects
The processing order for child objects that share the same parent object
Migration Job Flow
1 Define – The process of creating a package definition in your source environment. A package definition defines the boundaries of what product configuration content you want to include in packages based on the definition.
2 Create – Prepare a package substance with the product configuration content based on the package definition.
3 Distribute – After you create a package, distribute it to one or more suitable target environments. You must deploy a package to a target environment before you can deploy it in that environment. You can distribute to a database target or file target. Distribution to database is useful when migrating data from development to test. Distribute to file is useful when distributing from test to production, where direct access to a production database can be strictly controlled.
4 Deploy – Apply the product configurations in a package directly to the target environment. Back up your target database before deploying a package in that environment. To maintain the integrity of structural changes, you can deploy only one package at a time.