Migration Definition File Elements

Subtopics

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

Connections Element

Defines the connection to use for the operation. Three types of connections can be defined—HSS, FileSystem, and Application.

HSS connection attributes:

ConnectionInfo name
type
description
user
password

FileSystem connection attributes:

ConnectionInfo name
type
description
filePath

Application connection attributes:

ConnectionInfo name
type
product
project
application
HSS-Connection
description

Import operations must have a source and a destination (Shared Services, an application, or a file system).

Table 5. Connection Attributes

Attribute	Description
ConnectionInfo name	Connections used for this task. Examples: MyHSS-Connection1 FileSystem-Connection1 AppConnection1 Note: The naming convention requires that you use the preceding format. Only the connection number can change; for example, change 1 to 2.
type	Connection types: HSS for the Shared Services instance connection FileSystem for the file system connection Application for the application connection registered with Shared Services
description	Description of the connection. Example: My Shared Services Connection
user	Used only for the MyHSS-Connection type, this is the user account that is assigned the LCM Administrator role in Shared Services. Example: pturner Note: Ensure that the user and password values are provided if you are using the utility to run a scheduled migration; otherwise, the utility prompts you for those values and will not execute.
password	Used only for the MyHSS-Connection type, this is the plain-text password of the user. This password is encrypted after the first run. Example: pturner_pwd Note: Ensure that the user and password values are provided if you are using the utility to run a scheduled migration; otherwise, the utility prompts you for those values and will not execute.
filePath	Used only for the FileSystem-Connection type, this is the 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, you can edit the .mdf file to overwrite the relative path with an absolute path.
product	Used only for the AppConnection type, this is the product code for the application that is registered with Shared Services. Examples: HUB (for Shared Services) HREG (for Shared Services Registry) HAVA (for Reporting and Analysis) ESBAPP (for Essbase) HFM (for Financial Management) HP (for Planning) BPMA (for Performance Management Architect) CALC (for Calculation Manager) HPS (for Performance Scorecard) HPM (for Profitability and Cost Management)
HSSConnection	Used only for the AppConnection type, this is the Shared Services connection definition. Must be of type HSS defined in the migration definition Example: MyHSS-Connection1
project	Used only for the AppConnection type, this is the name of the Shared Services Application Group (previously known as Project) to which the application belongs. The project name is visible in Shared Services Console. Example: DevBIPlus_Proj
application	Used only for the AppConnection type, this is the name with which the application is registered. The application name is visible in Shared Services Console. Example: HAVAAPP1

Task Element

Defines the tasks to complete during the operation. The number of tasks defined in the migration definition file depends on the source and destination and the artifact being migrated. If only one source and destination are involved, you need to define only one task.

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.

Table 6. Task Attributes

Attribute	Description
Task seqID	Sequence in which tasks are executed. Example: 1,2,3

Source Element

The Source element defines the source for this operation. You must define one source and one destination per task.

Table 7. Source Attributes

Attribute	Description
Source connection	Connection to use for this task. Use the connection name defined in the Connection element. Note: You cannot use a connection of type HSS in source definitions. Only connections of type AppConnection or FileSystem-Connection can be used in source definitions. Example: AppConnection1
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 option set in the product registration file is used. options attributes: optionInfo name value
optionInfo name	Option name used to override the option name defined in the Shared Services registration file. Example: ExportJobOutput
value	Value used to override the option value defined in the Shared Services registration file. Example: true
artifact	Filter used for this operation. This element takes these attributes: Artifact recursive parentPath pattern type startDate endDate Note the following: The Artifact recursive attribute is optional. The parentPath and pattern attributes are required for all products. The type attribute is available for Reporting and Analysis only (this attribute only can be set in the XML file directly). The startDate and endDate attributes are applicable only to the artifacts that support the modified date parameter (these attributes can be set only directly in the XML file).
Artifact recursive	Whether the operation should be performed on artifacts stored in subdirectories. Example: true
parentPath	Top-level directory where artifact or data for the operation is stored. See the appendixes at the end of this guide for information on product directory structures. Caution! If the parent path directory contains an ampersand (&) character, replace it with “&” in the migration definition file (see example below). Example: /Data Analysis & Report Creation Note: If Artifact recursive="true", all artifacts contained in the subdirectories within this directory are imported.
type	This attribute is applicable only to Reporting and Analysis. Type of Reporting and Analysis artifact to import. For a listing of Reporting and Analysis artifact types, see Reporting and Analysis and Lifecycle Management. Example: Financial Reports Note: This value can only be set directly in the XML file and not in Shared Services Console.
pattern	Artifact-selection criterion. You can specify the name of an artifact to import or use an * (asterisk) to indicate that you want to import all artifacts that match filter conditions. Example: *
startDate	Beginning date of date range. You can specify a date range (start and end date, inclusive) to filter artifacts whose last modified date falls within this range. The specified start and end dates are inclusive. Example: 2006-01-01 Note: This value can only be set directly in the XML file and not in Shared Services Console.
endDate	Ending date of a date range. Example: 2006-01-31 Note: This value can only be set directly in the XML file and not in Shared Services Console.

Target Element

Defines the destination for this operation. You must define one destination per task.

Table 8. Target Attributes

Attribute	Description
options	Processing instructions for this operation. Options are product-specific. See the appendixes at the end of this guide for the destination options you can set. The source or destination interprets the options to understand the artifacts being migrated. If options are not set, the default option set in the product registration file is used. options attributes: optionInfo name value
optionInfo name	Option name used to override the option name defined in the Shared Services registration file. Example: ExportJobOutput
value	Value used to override the option value set in the Shared Services registration file. Example: true

Attribute

Description

options

Processing instructions for this operation.

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

If options are not set, the default option set in the product registration file is used.

options attributes:

optionInfo name
value

optionInfo name

Option name used to override the option name defined in the Shared Services registration file.

Example: ExportJobOutput

value

Value used to override the option value set in the Shared Services registration file.

Example: true