Working with Migration Definitions

Creating Migration Definitions

Artifacts to migrate must be defined in a migration definition. Note the following about migration definitions:

A migration definition is created in Oracle Hyperion Shared Services Console when you perform an export or import operation.
When you export artifacts, Oracle Hyperion Enterprise Performance Management System Lifecycle Management creates two XML files, one for export and one for import. These XML files can be used for the migration definition file in the Lifecycle Management Utility.
When you perform an export operation, the MDF file for that export and for the corresponding import is automatically created in the File System folder under the root folder.

Migration Definition File XML Schema

The following illustration depicts an XML schema outline of the migration definition.

Figure 7-2 XML Schema Outline of the Migration Definition File

This image is an XML schema outline of the migration definition file.

Migration Definition File Elements

This section describes the elements and attributes used in the XML schema for migration definition files.

Locale

Defines the server locale at the time the migration definition file is created. All error messages and console messages are included in this locale.

User and Password

Defines the user name and encrypted password of the user who will be executing the migration definition file.

Task

Defines the tasks to complete during the migration. A task that is defined in the migration definition file depends on the source, the destination, and the artifacts to migrate. At a minimum, each task contains source, destination, and artifact tags.

For multiple sources and destinations, you must define at least one task for each source-destination combination. For example, extracting artifacts to the file system would be defined as task 1. Loading the artifacts from the file system to an application would be defined as task 2.

Note:

By default, after a failed task, the utility continues with the next task. Validation of a task's source and target connections are performed only when the task is executed and not before starting the task execution.

Task contains these elements:

Source

Defines the source for the migration. You must define one source and one destination per task.

Table 7-1 Source Attributes

Attribute	Description
`application`	Name with which the application is registered. The application name is visible in Shared Services Console. Example: `HPAPP1`
`filePath`	Directory where artifacts are stored on the file system. Example: `filePath="/Essbase.Sample.Basic"` Note: When an MDF file is generated from the UI, the path is a relative path to the working folder. If the MDF file is not in the working folder, use the `-b` command-line argument to use the base path relative to where the file system path is set.
`product`	Product code for the application that is registered with Shared Services. Examples: `HUB` (Oracle Hyperion Shared Services) `CALC` (Oracle Hyperion Calculation Manager) `ESBAPP` (Oracle Essbase) `BPM` (Oracle Essbase Studio) `AIF` (Oracle Hyperion Financial Data Quality Management, Enterprise Edition) `HFM` (Oracle Hyperion Financial Management) `FCC` (Oracle Hyperion Financial Close Management) `HP` (Oracle Hyperion Planning) `HPM` (Oracle Hyperion Profitability and Cost Management)
`project`	Name of the Shared Services Application Group to which the application belongs. The project name is visible in Shared Services Console. Example: `DevPlan_Proj`
`type`	Connection types: `FileSystem` for the file system connection `Application` for the application connection registered with Shared Services

Target

Defines the destination for the migration. You must define one destination per task.

Table 7-2 Target Attributes

Attribute	Description
`application`	Name with which the application is registered. The application name is visible in Shared Services Console. Example: `HPAPP1`
`filePath`	Directory where artifacts are stored on the file system. Example: `filePath="/Essbase.Sample.Basic"` Note: When an MDF file is generated from the UI, the path is a relative path to the working folder. If the .MDF file is not in the working folder, use the `-b` command-line argument to use the base path relative to where the file system path is set.
`product`	Product code for the application that is registered with Shared Services. Examples: `HUB` (Shared Services) `ESBAPP` (Essbase) `HFM` (Financial Management) `HP` (Planning) `CALC` (Calculation Manager) `HPM` (Profitability and Cost Management)
`project`	Name of the Shared Services Application Group to which the application belongs. The project name is visible in Shared Services Console. Example: `DevHP_Proj`

Artifact

Filter used for the current migration.

Table 7-3 Artifact Attributes

Attribute Description

Attribute	Description
`parentPath`	Top-level directory where artifact or data for the migration is stored. See the appendixes at the end of this guide for information on product directory structures. Example: `/Data Analysis & Report Creation` Caution: If the parent path directory contains an ampersand (&) character, replace it with `"&"` in the migration definition file (see example below). Notes: If `recursive="true"`, all artifacts contained in the subdirectories within this directory are imported. The `pattern` attribute is required for all products.
`pattern`	Artifact-selection criteria. Specify the name of an artifact to import or use an * (asterisk) to import all artifacts that match filter conditions. Example: * Note: The `pattern` attribute is required for all products.
`recursive`	Whether the migration should be performed on artifacts stored in subdirectories. Example: `true` Note: The `recursive` attribute is optional.

parentPath

Top-level directory where artifact or data for the migration is stored. See the appendixes at the end of this guide for information on product directory structures.

Example: /Data Analysis & Report Creation

Caution: If the parent path directory contains an ampersand (&) character, replace it with "&" in the migration definition file (see example below).

Notes:

If recursive="true", all artifacts contained in the subdirectories within this directory are imported.

The pattern attribute is required for all products.

pattern

Artifact-selection criteria.

Specify the name of an artifact to import or use an * (asterisk) to import all artifacts that match filter conditions.

Example: *

Note: The pattern attribute is required for all products.

recursive

Whether the migration should be performed on artifacts stored in subdirectories.

Example: true

Note: The recursive attribute is optional.

Options

Options are product-specific. Refer to the appendixes at the end of this guide for the import and export options that you can set. The source or destination interprets the options to understand the artifacts being migrated.

If options are not set, the default options set in Oracle Hyperion Shared Services Registry are used.

Table 7-4 Options Attributes

Attribute	Description
`option`	Name used to override the option name defined in Shared Services Registry. Example: `ExportJobOutput`
`value`	Value used to override the option value defined in Shared Services Registry. Example: `true`

Sample Migration Definition File

Following is a sample migration definition file. Any change in the structure or syntax result in errors during migration.

<?xml version="1.0" encoding="UTF-8"?>
<Package>
<LOCALE>en_US</LOCALE>
<User name="admin" password=""/>
   <Task>
      <Source type="Application" product="HUB" project="Foundation" application="Shared Services"/>
      <Target type="FileSystem" filePath="/folder/HUB.Shared Services" />
      <Options option="GroupFilter" Value= "*" />
      <Artifact recursive="true" parentPath="/Native Directory" pattern="*"/>
      <Artifact recursive="true" parentPath="/Taskflows" pattern="*"/>
   </Task>
   <Task>
      <Source type="FileSystem" filePath="/folder/HUB.Shared Services" />
      <Target type="Application" product="HUB" project="Foundation" application="Shared Services" />
      <Artifact recursive="true" parentPath="/Native Directory" pattern="*"/>
      <Artifact recursive="true" parentPath="/Taskflows" pattern="*"/>
	   </Task>
</Package>