OFSAAI has introduced a UI to migrate objects using ObjectMigration.sh file. That is, this approach is based on the Command Line Utility for Object Migration. You can migrate (export/ import) Infrastructure metadata objects across different information domains or setups from OFSAAI releases 8.0 and above. For the list of objects that can be migrated, see the Objects Supported for Command Line Migration section.
NOTE |
The REST authentication is done against the Service Account user mentioned under OFSAA_SRVC_ACC parameter in the CONFIGURATION table. This user should be created with "SMS Auth Only" attribute from the User Maintenance window. By default, OFSAA_SRVC_ACC parameter is set as SYSADMN. |
· Folders (segments) and user groups that are designated for the import should be present in the target.
· The source and target environment should have the same installed languages.
· OFSAA users in source should be the same in target (at least for users associated with objects migrated).
· OFSAA users should have access to folders in target as well as source.
· Tables accessible to users in source should also
exist in target.
For example, if you want to migrate a Data Element Filter based on "Table
A" and "Table B" in the source, those two tables should
exist in the target.
· Before migrating a DQ Group, ensure the DQ Rules present in that DQ Group are unmapped from all other groups in the target. That is, if a DQ Rule is mapped to one or more DQ Groups in the target, then it has to be unmapped from all the groups before migration.
· For AMHM Dimensions and Hierarchies:
§ The key processing Dimensions should be the same in both the source and target environments.
§ For Member migration, the Dimension type should have the same attributes in both source and target environments.
§ Numeric Dimension Member IDs should be the same in both the source and target environments, to ensure the integrity of any Member-based objects.
NOTE |
If you have used the Master Table approach for loading Dimension data and set it up to generate surrogate keys for Members, this results in different IDs between the source and target, so it may cause errors if you have objects which depend on these IDs |
· All objects that generate new ID after migrating to a different information domain and all components which are registered through the Component Registration window, which will be used in the RRF, must be manually entered in AAI_OBJ_REF_UPDATE table in the Configuration Schema. The attributes present in the table are:
§ V_OBJECT_TYPE- EPM Object Type
§ V_RRF_OBJECT_TYPE- RRF object Type. The ID can be referred from pr2_component_master table
§ V_ICC_OBJECT_TYPE- ICC object type, can be referred from component_master table.
§ F_IS_FILTER- Is the object to be migrated as a filter/not?
§ N_BATCH_PARAMETER_ORDER- the order of parameter in task (if used in a batch).
The following sections are covered:
This feature allows you to export a set of objects to migrate across Information Domains within the same setup or across different setups. You can select one or more objects within an object type or within multiple object types and migrate the same along with or without the dependent objects.
The roles mapped to Object Migration Export are as follows:
· OMEXREAD
· OMEXWRITE
· OMEXADVND
· OMEXPHTM
For all the roles, functions and descriptions, see Appendix A.
The Object Migration Export Summary window displays the list of pre-defined Export Definitions with their Migration Code and Dump Name. By clicking the Column header names, you can sort the column names in ascending or descending order. You can add, view, edit, copy, export, and delete Export Definition. You can search for a specific Export Definition based on the Migration Code or Dump Name.
To export objects, perform the following steps:
1. From the Object Migration Export
Summary window, click Add. The Export Objects
window is displayed.
2. Enter a unique Migration Code to identify the status of the migration process. For example: 8860
3. Enter the name to be given to the dump file in the Dump Name field.
4. Select the objects you want to export from the Available Objects pane.
§ The Available Objects pane lists the Object types
which are supported for migration in the alphabetical order. Mouse over
Object Name and click or
to sort the Object types in ascending or descending
alphabetical order.
§ Click adjacent
to an Object Type to display the available Objects. Only 5 objects are
displayed at a time.
1 To view the next set of objects, click NEXT.
2 Search for an object by providing a part of the
object name in the Search field and clicking.
3 To do advanced search, click icon
adjacent to Available Objects. The Filter and Search
window is displayed. You can search for an Object based on Object Type,
Name, Created Date, Last Modified Date, Created by, and Last Modified
by.
4 To select all objects displayed in the page, click
icon adjacent to the Object Name. For example,
.
5 If the Object Name is too long, only first 30 characters will be displayed. The tooltip will display the full object name.
6 Tooltip of Object name displays the full Object Name and Object ID. Additionally, it displays the Object Sub Type ID in case of Filters and AMHM Hierarchy.
§ Click icon
corresponding to the Object Type to export all available objects in the
setup. For example, if you click
icon corresponding
to Business Hierarchies, all available Business Hierarchies will be exported.
A confirmation message is displayed. Click OK to confirm or Cancel to skip.
§ All the selected Objects will be displayed under Selected Objects pane.
§ Click icon
corresponding to the Object Type Name to remove all selected objects of
that type. Click
icon corresponding
to an Object Name to remove that object.
§ check
box under Include Dependency indicates dependent
objects also will be exported. Deselect the check box to export the selected
objects without the dependent objects. Click
icon
to display the dependent objects.
§ Click icon
to display the additional parameters. Enter/Select the additional parameters
if it is required for the selected object type.
Field |
Description |
Sandbox Infodom |
Enter the Sandbox Information Domain name to export Sandbox. |
With Models |
Select the checkbox if you want to export all models present in the Sandbox Infodom along with the Sandbox. Deselect the check box if you want to export only the Sandbox. |
Is Response Data Required |
This is applicable only for Questionnaire migration. Select the checkbox if you want to export the responses for Questionnaire. Deselect the check box if you want to skip it. |
Application Code |
This is applicable only for Questionnaire migration. Enter the application code for which you want to export the Questionnaire data. For example, to migrate KYC related Questionnaire data, specify the application code OFS_KYC. Similarly, you can specify the application code for other applications and migrate the related Questionnaire data. |
Include Instances |
This is applicable only for PMF migration. Select the checkbox if you want to export Questionnaire related workflow instance data. Deselect the check box if you want to skip it. |
5. Click Save. The input files, migration.properties file and export_input.csv are generated in the /ftpshare/ObjectMigration/conf folder. The Export definition will be available in the Object Migration Export Summary window.
6. Select the definition and click Export to execute ObjectMigration.sh.
7. A confirmation message is displayed. Click Ok to trigger the export process.
8. A batch will be generated and automatically executed. The dump file will be created in /ftpshare/ObjectMigration/metadata/archive folder. You can view the logs from /ftpshare/logs/<ExecutionDate>/<Infodom Name>/RUN EXECUTABLE folder.
You can view individual Export definition details at any given point.
To view an existing Export definition:
1. From the Object Migration Export
Summary window, select the Export definition that you want to view
and click View.
The Export Objects window is displayed.
The Export Objects window displays the details of the selected Export definition like Migration Code, Dump Name and the objects selected for exporting.
You can update the existing Export definition details except the Migration Code.
You can add more objects for exporting or removing the existing objects.
To modify the Export definition:
1. From the Object Migration Export
Summary window, select the Export definition that you want to view
and click Edit.
The Export Objects window is displayed.
2. Update the required details. For more information, see Creating Export Definition.
3. Click Save and update the changes.
This option allows you to quickly create a new Export definition based on an existing Export definition. You need to provide a new Migration Code and can modify other required details.
To copy an existing Export definition:
1. From the Object Migration Export
Summary window, select the Export definition that you want to view
and click Copy.
The Export Objects window is displayed.
2. Enter a unique migration code to identify the status of the migration process.
3. Update other details if required. For more information, see Creating Export Definition.
4. Click Save.
This option allows you to delete an Export definition.
To delete an Export definition
1. From the Object Migration Export
Summary window, select the Export definition that you want to view
and click Delete.
2. A confirmation message is displayed. Click Yes. The definition gets deleted.
This feature allows you to import objects to your target environment from the archived dump file. The dump file from source environment should be downloaded and moved into /ftpshare/ObjectMigration/metadata/restore folder in the target system. This folder structure needs to be created manually.
The roles mapped to Object Migration Export are as follows:
· OMIMREAD
· OMIMWRITE
· OMIMADVND
· OMIMPHTM
For all the roles, functions and descriptions, see Appendix A.
The Object Migration Import Summary window displays the list of pre-defined Import Definitions with their Migration Code and Dump Name. By clicking the Column header names, you can sort the column names in ascending or descending order. You can add, view, edit, copy, and delete Import Definition. You can search for a specific Import Definition based on the Migration Code and Dump Name.
To import objects, perform the following steps:
1. From the Import Objects window, enter a unique migration code to identify the status of the migration process in the Migration Code field.
2. Select the dump file from the drop-down list. It displays the dump files in the /ftpshare/ObjectMigration/metadata/restore folder. The objects in the dump file will be displayed in the Available Objects pane.
3. Select the required Folder from the drop-down list. This is the default target folder if object specific Folder is not provided. However, if both Folders are not specified, then source folder available in the exported dump file will be considered as target folder.
4. Turn ON the Retain IDs toggle button to retain the source AMHM objects after migration.
If it is turned ON, different scenarios and the behaviors are as follows:
§ Object and ID does not exist in Target- the object is created in target environment with same ID as that in source.
§ Object exists in Target with different ID- object is migrated and the ID in the target is retained.
§ ID already exists in Target with different object- then the object is migrated to target environment and a new ID is generated.
§ Same object and ID exists in Target- In this case, the behavior depends on the OVERWRITE flag.
5. Turn ON the Fail On Error toggle button to stop the import process if there is any error. If it is set OFF, the import process will continue with the next object even if there is an error.
6. Turn ON the Import All toggle button to import all objects in the dump file to the target environment.
7. Turn ON the Overwrite toggle button to overwrite any existing metadata. If it is turned OFF, it will not overwrite the object and continue migrating the next object.
8. Select the objects you want to import from the Available Objects pane.
§ The Available Objects pane lists the Object types
which are available in the dump file in the alphabetical order. Mouse
over Object Name and click or
to sort the Object types in ascending or descending
alphabetical order.
§ Click to
expand and list the Objects available. Only 5 objects are displayed at
a time. To view the next set of objects, click NEXT.
You can search for an object by providing a part of the object name in
the Search field and clicking
.
To select all objects displayed in the page, click
icon
adjacent to the Object Name. For example, If you select the check box
adjacent to Function (
), all
the displayed objects will be selected.
§ Click icon
corresponding to the Object Type to import all available objects of the
selected Object Type in the dump file. For example, if you click
icon corresponding to Business Hierarchies, all available
Business Hierarchies will be imported.
A confirmation message is displayed. Click OK to confirm or Cancel to skip.
§ All the selected Objects will be displayed under Selected Objects pane.
§ Click icon
corresponding to the Object Type Name to remove all selected objects of
that type. Click
icon corresponding
to an Object Name to remove that object.
§ Select the target Folder if you want to import a particular object to a specific folder from the drop-down list. If this is not specified, the object will be imported to the selected default Folder. If you have not selected the default Folder also, then the source folder in the dump file will be taken as target folder. For Catalog Publish object, the target folder is mandatory.
§ checkbox
under Include Dependency indicates dependent
objects also will be imported. Deselect the check box to import the selected
objects without the dependent objects.
§ Click icon
to display the additional parameters. Enter/Select the additional parameters
if it is required for the selected object type.
Field Name |
Description |
Sandbox Infodom |
Enter the Sandbox Information Domain name to import Sandbox. |
With Models |
Select the checkbox if you want to import all models present in the Sandbox Infodom along with the Sandbox. Deselect the check box if you want to import only the Sandbox. |
Is Response Data Required |
This is applicable only for Questionnaire migration. Select the checkbox if you want to import the responses for Questionnaire. Deselect the check box if you want to skip it. |
Application Code |
This is applicable only for Questionnaire migration. Enter the application code for which you want to import the Questionnaire data. For example, to migrate KYC related Questionnaire data, specify the application code OFS_KYC. Similarly, you can specify the application code for other applications and migrate the related Questionnaire data. |
Include Instances |
This is applicable only for PMF migration. Select the checkbox if you want to import Questionnaire related workflow instance data. Deselect the check box if you want to skip it. |
9. Click Save. The migration.properties and import_input.csv files are generated in the /ftpshare/ObjectMigration/conf folder. The Import definition will be available in the Object Migration Import Summary window.
10. Select the definition and click Import to execute ObjectMigration.sh.
11. A confirmation message is displayed. Click Ok to trigger the import process.
12. A batch will be generated and automatically executed. You can view the logs from /ftpshare/logs/<ExecutionDate>/<Infodom Name>/RUN EXECUTABLE folder.
13. Once executed, you can view the related log files from the $FIC_HOME/utility/Migration/logs location.
You can view individual Import definition details at any given point.
To view an existing Import definition:
1. From the Object Migration Import
Summary window, select the Import definition that you want to view
and click View.
The Import Objects window is displayed.
2. The Import Objects window displays the details of the selected Import definition like Migration Code, Dump Name and the objects selected for importing.
You can update the existing Import definition details except the Migration Code.
You can add more objects for importing or removing the existing objects.
To modify the Import definition:
1. From the Object Migration Import
Summary window, select the Import definition that you want to view
and click Edit.
The Import Objects window is displayed.
2. Update the required details. For more information, see Creating Export Definition.
3. Click Save and update the changes.
This option allows you to quickly create a new Import definition based on an existing Import definition. You need to provide a new Migration Code and can modify other required details.
To copy an existing Import definition:
1. From the Object Migration Import
Summary window, select the Import definition that you want to view
and click Copy.
The Import Objects window is displayed.
2. Enter a unique migration code to identify the status of the migration process.
3. Update other details if required. For more information, see Creating Export Definition.
4. Click Save.
This option allows you to delete an Import definition.
To delete an Import definition
1. From the Object Migration Import
Summary window, select the Import definition that you want to view
and click Delete.
2. A confirmation message is displayed. Click Yes. The definition gets deleted.
The following table lists the objects that are supported for implicit dependency and the dependent objects:
Base Object Name |
Dependent Objects |
DATA QUALITY RULE |
DERIVED ENTITY |
DATA QUALITY GROUP |
DATA QUALITY RULE |
DATA TRANSFORMATION |
NA |
ETL |
DATA QUALITY RULE- This is not implemented. |
DATA ENTRY FORMS AND QUERIES (DEFQ) |
NA |
ALIAS |
NA |
DERIVED ENTITY |
DATASET |
BUSINESS MEASURE |
|
BUSINESS HIERARCHY |
|
BUSINESS PROCESSOR |
|
BUSINESS MEASURE |
ALIAS |
DERIVED ENTITY |
|
BUSINESS DIMENSION |
BUSINESS HIERARCHY |
BUSINESS HIERARCHY |
DERIVED ENTITY |
BUSINESS MEASURE |
|
DATASET |
ALIAS |
DERIVED ENTITY |
|
BUSINESS PROCESSOR |
DATASET |
BUSINESS MEASURE |
|
BUSINESS PROCESSOR |
|
ESSBASE CUBE |
DATASET |
BUSINESS MEASURE |
|
BUSINESS DIMENSION |
|
ORACLE CUBE |
NA |
MAPPER |
Hierarchies |
FORMS FRAMEWORK |
Child Forms |
FORMS MENU |
FORMS and LAYOUTS |
FORMS LAYOUT |
Forms |
FORMS TAB |
NA |
FORMS PAGE |
FORMS and LAYOUTS |
RULE |
DATASET |
MEASURE |
|
HIERARCHY |
|
BUSINESS PROCESSOR |
|
DATA ELEMENT FILTER |
|
GROUP FILTER |
|
ATTRIBUTE FILTER |
|
HIERARCHY FILTER |
|
PROCESS |
EXTRACT DATA |
LOAD DATA |
|
TRANFORM DATA |
|
RULE |
|
PROCESS |
|
CUBE |
|
DATA QUALITY GROUP |
|
VARIABLE SHOCK |
|
MODEL |
|
RUN |
EXTRACT DATA |
LOAD DATA |
|
TRANFORM DATA |
|
RULE |
|
PROCESS |
|
RUN |
|
CUBE |
|
DATA QUALITY GROUP |
|
VARIABLE SHOCK |
|
MODEL |
|
DATA ELEMENT FILTER |
|
GROUP FILTER |
|
ATTRIBUTE FILTER |
|
HIERARCHY FILTER |
|
BATCH |
Not implemented |
DIMENSION |
MEMBERS |
ATTRIBUTES |
|
BUSINESS HIERARCHY |
|
ATTRIBUTES |
|
FILTER |
|
EXPRESSION |
EXPRESSION |
AMHM HIERARCHY |
Members |
SANDBOX 2 |
NA |
VARIABLE |
BUSINESS HIERARCHY |
BUSINESS MEASURE |
|
BUSINESS PROCESSOR |
|
DATASET |
|
TECHNIQUE |
NA |
VARIABLE SHOCK |
VARIABLE |
DATASET |
|
BUSINESS HIERARCHY |
|
SCENARIO |
VARIABLE SHOCK |
MODEL |
TECHNIQUE |
VARIABLE |
|
DATASET |
|
BUSINESS HIERARCHY |
|
DataElement Filter |
|
STRESS |
RUN |
SCENARIO |
|
CATALOG PUBLISH |
NA |
USER |
PROFILE |
USER GROUP |
USER |
ROLE |
FUNCTION |
FUNCTION |
NA |
PROFILE |
NA |
PMF PROCESS |
NA |
Object Name |
Object SubType ID |
DataElement Filter |
4 |
Hierarchy Filter |
8 |
Group Filter |
21 |
Attribute Filter |
25 |