Proventeq Migration Accelerator User Guide for Documentum To Oracle WebCenter Content Migration. Version: 6.4

Transcription

1 Proventeq Migration Accelerator User Guide for Documentum To Oracle WebCenter Content Migration Version: 6.4 Proventeq Ltd 24 May 2018

2 Table of Contents 1. INTRODUCTION LAUNCH APPLICATION LAUNCH MIGRATION ACCELERATOR PRODUCT ACTIVATION ONLINE ACTIVATION OFFLINE ACTIVATION UPGRADING LICENSE WORKSPACE CONFIGURATION CREATE WORKSPACE OPEN WORKSPACE DELETE WORKSPACE APPLICATION MENU WORKSPACE HOME SCREEN RIBBON INFORMATION PANE SOURCE CONNECTIONS ADD DOCUMENTUM SOURCE CONNECTION TARGET CONNECTIONS ADD ORACLE WEBCENTER CONTENT(WCC) CONNECTION MIGRATION TASKS CREATE TASK USING DEFAULT SETTINGS CREATE TASK USING EXISTING TASK EXPORT TASK SETTINGS CREATE TASK USING EXPORTED SETTING (IMPORT TASK SETTINGS) MIGRATION TASK SETTINGS CONTENT TYPE MAPPING SETTINGS METADATA MAPPING DOCUMENT CONTENT TYPE MAPPING POWERSHELL EXTENSIONS UPGRADING THE DEFAULT MODULE

3 CREATING NEW MODULES IMPORTING METADATA FROM CSV FILE TESTING POWERSHELL FUNCTIONS CUSTOM CONTENT TYPE (SOURCE CLASSIFICATION) ADD SOURCE CLASSIFICATION EDIT SOURCE CLASSIFICATION DELETE SOURCE CLASSIFICATION GENERAL SETTINGS MAPPING OPTIONS LINK RESOLUTION IN DIFFERENT FILE TYPES SHORTCUT LINK RESOLUTION INVALID CHARACTERS HANDLING FILE AND FOLDER SETTINGS RECREATE SOURCE HIERARCHY DUPLICATE FILE HANDLING DISCARD FILES WITH DUPLICATE NAMES OVERWRITE EXISTING FILES HAVING SAME NAMES CREATING NEW FILE WITH UNIQUE NAMES SECURITY MAPPINGS DISCOVERY SETTINGS DISCOVERY FILTER VERSION CONSTRAINT SECURITY EXECUTION DISCOVERY AND ANALYSIS DISCOVER ITEMS PRE-MIGRATION CHECKS POWER BI REPORTS POWER BI DESKTOP INSTALL SET UP PBI ENVIRONMENT SET UP SECURITY GENERAL DISTRIBUTION OF CONTENT PRE-MIGRATION CHECKS- VERSION CONTINUITY PRE-MIGRATION CHECKS- PATHS AND NAMES PRE-MIGRATION CHECK - FILES GENERAL USAGE OF CONTENT

4 CONTAINER ANALYSIS PROCESSING PROCESS UP TO STAGE POST PROCESSING SYNCHRONIZATION OR DELTA PROCESSING RESET ITEMS ERASE HISTORY ITEMS LIST TAB ITEMS EXPLORER GRAPH VIEW REPORTING DISCOVERY LOG REPORT PROCESSING LOG REPORT SUCCESS REPORT ERROR LOG REPORT FINAL PROCESSING REPORT PROCESS WORK ITEM LINK REPORT APPENDIX METADATA MAPPING FUNCTION LIST STRING FUNCTIONS MATH FUNCTIONS DATE FUNCTIONS MISC FUNCTIONS PMA METADATA MAPPING POWERSHELL API PRE-DEFINED VARIABLES XML HELPER MODULE HTML HELPER API

5 ABOUT THIS GUIDE This document contains detailed instructions on how to configure Proventeq Migration Accelerator, version 6.4, for migrating to Oracle WebCenter Content. For additional information about the Training, Technical Support and feedback on the documentation, please contact or raise a support ticket AUDIENCE This guide is designed for the Proventeq Migration Accelerator product users, operators, and supervisors who are familiar with the migration project and its associated migration environment. RELATED DOCUMENTS Title Version Proventeq Migration Accelerator - Installation Guide 6.4 4

6 1. INTRODUCTION Proventeq Migration Accelerator is an end-to-end solution for migrating web content, documents, records and other digital assets from File Shares, Meridio EDRM, Oracle UCM Content Server, Documentum and other ECM systems to Oracle WebCenter Content. Migration Accelerator has been designed with flexibility in mind, so it can be configured and/or extended to address any kind of content migration requirement. Migration Accelerator provides an interactive UI to verify and enhance the quality of migrated content. 5

7 2. LAUNCH APPLICATION Launch Migration Accelerator Launch the application from Desktop by double clicking Proventeq Migration Accelerator icon OR Click from Start -> All Programs ->Proventeq Migration Accelerator -> Proventeq Migration Accelerator Note: It is recommended that Proventeq Migration Accelerator application is launched using the Run as Administrator option Product Activation When running Proventeq Migration Accelerator for very first time, the user will be prompted for product activation. The product activation process verifies that the license key is valid and gives user the option to activate the product license online Online Activation On the Product Activation screen, enter License key provided and click on "Activate Online". This will authenticate the License key and register the product. Note: User must be connected to internet during product activation. FIGURE 1 - ONLINE REGISTRATION 6

8 Offline Activation On the Product Activation screen, select "Offline Activation" tab and follow the steps mentioned to do offline license activation. FIGURE 2 - OFFLINE ACTIVATION 7

9 2.3. Upgrading License If you have upgraded your license from trial version to a licensed copy, you can execute Upgrade License from the machine where the trial version of the Proventeq Migration Accelerator has been installed. You would need to un-install the trial version and install the licensed version before you can upgrade the license. After successful installation of the latest version of Proventeq Migration Accelerator, launch the application and navigate to 'License Upgrade' from the application menu. FIGURE 3 - LICENSE UPGRADE Clicking on License Upgrade will launch the Registration screen. The steps for License upgrade are the same as steps for product activation. Please refer to instruction in Section 2.2 for completing the license upgrade. 8

10 3. WORKSPACE CONFIGURATION Once registration is successful, Proventeq Migration Accelerator is ready for use and configuration Create Workspace FIGURE 4 - SELECT WORKSPACE You can create workspace by clicking on Create Workspace button and entering a unique workspace name. Clicking on Create in the Create Workspace screen will open Home screen of the newly created workspace, where you can add source connection(s) and target connection(s). Migration tasks can then be created using source and target connections. Note: Only 50 characters are allowed in the Workspace Name field and less than 200 characters in description. 9

11 3.2. Open Workspace To open an existing workspace, select a workspace from the list on the Select Workspace screen and click Open button. This will open the Home tab of selected workspace. FIGURE 5 - OPEN WORKSPACE FROM SELECT WORKSPACE SCREEN In Home screen user can add source and target connections, create Migration Tasks by mapping source container to target container and configure migration task settings. FIGURE 6 - WORKSPACE HOME SCREEN 10

12 3.3. Delete Workspace To delete an existing workspace, select a workspace from the list on the Select Workspace screen and click Delete button. This will pop up a dialogue box with option to Delete Selected Workspace or cancel delete operation. FIGURE 7 - SELECT WORKSPACE FOR DELETE 11

13 3.4. Application Menu FIGURE 8 - APPLICATION MENU Application menu appears in the upper-left corner of the window. It includes commands for Workspace such as Create Workspace and Open workspace. It also lists the recent workspaces. Clicking on "Create Workspace" will allow you to create new workspace from application menu. Clicking on "Open Workspace" will allow you to switch between workspaces. Clicking on "License Upgrade" will allow you to upgrade or request for license. See Section for "License Upgrade". "Help" opens the User guide. "About" provides details of the installed product and the licensing details. "Exit" terminates all ongoing processes and closes the application. 12

14 4. WORKSPACE HOME SCREEN The Home screen of Migration Accelerator consists of five panes as shown in the image below: (1) Ribbon (2) Information pane (3) Source Connections pane (4) Target Connections pane (5) Migration Tasks pane FIGURE 9 - WORKSPACE HOME SCREEN The controls within each pane are described in the following sections. 13

15 4.1. Ribbon Proventeq Migration Accelerator provides use of fluent Ribbon interface. Within each ribbon tab, related controls are consolidated into one area for users ease of access. By default, the Home tab is selected when a workspace is opened. The other two tabs available for a workspace are: Execution and Report FIGURE 10 - HOME TAB RIBBON FIGURE 11 - EXECUTION TAB RIBBON FIGURE 12 - REPORT TAB 4.2. Information pane It displays information for getting started with source and target configuration and migration task creation Source Connections Source Connections pane is located at the left side of the main screen, and is designed to display the added source connections along with the content hierarchy. The following table lists the operations that are available in corresponding Source connections group present on ribbon. Add Documentum Adds a new Documentum Source Connection Edit Connection Edits configuration of selected source connection 14

16 Refresh Connection Refreshes the content tree view for selected connection Add Documentum Source Connection FIGURE 13 - ADD DOCUMENTUM CONNECTION The Add Documentum icon, located in the Source Connections group of ribbon allows the user to create a source connection pointing to Documentum. User can browse Documentum Repository and select different Cabinets/Folders. The source connection can then be used to create migration task(s). The following fields need to be configured for a Documentum connection: Name: Name of connection, to uniquely identify the connection within the workspace. Server URL: REST URL of the target Documentum Content Server. This is normally the hostname/ip address of the Documentum server followed by :8080/dctmrest/services. User Name: User name for connecting to Documentum. The user should be an Administrator of Documentum. Password: Password for the above-mentioned user. User can check source and target by expanding them along with contents in Source and Target pane area as part of migration though it is not a mandatory step. 15

17 User can then either Edit Connection or Refresh Connection but these steps are not mandatory Target Connections Target Connections pane is located at the right side of the main screen, and is designed to display the user created Target connections and its content containers. Add Oracle WCC Target Connection Edit Target Connection Refresh Target Connection Opens a dialog to add a new Oracle UCM WCC Target connection Edits configuration of selected target connection Refreshes the content tree view for selected connection Click on icon, located in Target Connection ribbon group to create a target connection. This launches a new dialog Add Oracle WebCenter Content(WCC) Connection FIGURE 14 - ADD ORACLE WEBCENTER CONTENT CONNECTION 16

18 The following fields needs to be configured for an Oracle UCM WCC Connection: Name: Name of connection, to uniquely identify the connection within the workspace. Server URL: URL of the target Oracle WebCenter Content. User Name: User name for connecting to Oracle WebCenter Content. The user should be an administrator for the target Oracle WebCenter Content. Password: Password for the above mentioned user. Use UCM Profile: Selecting this checkbox will make use of the UCM profiles as the default content types for mapping. This should only be used if the UCM Server version supports profile, and profiles are being used. Default User: The default user to be used for setting Author/Editor fields in the target if the source user is not found. This field is optional. Default Security Group: Content ID Prefix: Click on the "Test Connection" button to verify that the details entered are correct. Click on the Add button to add the UCM WCC connection

19 5. MIGRATION TASKS To create migration task, select source repository/cabinet/folder and map it to target Folder and create migration task using create task menu on Ribbon or simply drag source cabinet/folder on to target folder. The migration tasks are located at the bottom of the main window, and designed to display the mapped source and target containers. FIGURE 15 - CREATE MIGRATION TASKS Create Migration Task screen shows different task settings, which will help users to 1. Create task using default task settings 2. Create Task using existing migration task 3. Create Task using exported tasks settings FIGURE 16 - CREATE MIGRATION TASK SCREEN 18

20 5.1. Create Task Using Default Settings To create a new migration task, first select the source repository/cabinet/folder that you wish to migrate. To select a repository/cabinet/folder, expand the tree in Source Connections pane and select the repository/cabinet/folder you want to migrate. Similarly expand the Target Connections tree, and select appropriate target folder within which you want the source items to be migrated. To create migration tasks, simply drag and drop a source repository/cabinet/folder (e.g. Folder) on to target container (e.g. Public or Unplaced folder). Alternatively select the folders and use the ribbon Create command button. This will create a new migration task and launch the settings screen where you can specify settings like - content type mapping settings, metadata mapping settings, general settings, content type structure mapping settings and user mapping settings for that particular Migration Task. FIGURE 17 - CREATE DEFAULT TASK All the created migration tasks are listed in the "Migration Tasks" pane. FIGURE 18 - MIGRATION TASKS - PANE 19

21 You can remove migration tasks by selecting a task from migration tasks pane and clicking on Remove command button in the ribbon. This will delete all the records of that migration task from database. The settings for an existing migration task can be edited by clicking on the Settings icon. To navigate to the Execution view, you can click on the Execute icon against a task. Alternatively, you can select the Execute tab on the ribbon control and then select the task in the Execution view. There should be at least one Migration Task should be created Create Task Using Existing Task FIGURE 19 - MIGRATION TASKS USING EXISTING TASK To create a new migration task bases on the existing task, first select the source cabinet/folder that you wish to migrate. To select a cabinet/folder, expand the tree in Source Connections pane and select the cabinet/folder you want to migrate. Similarly expand the Target Connections tree, and select appropriate target container within which you want the source items to be migrated. Now user can select the Create task using existing migration task option and select the existing task from the dropdown list, new task is created based on existing task configuration is the system. FIGURE 20 - MIGRATION TASKS USING EXISTING TASK 20

22 5.3. Export Task Settings 1. To create a task from exported task setting (XML file), first user selects the existing task from task pane and using export settings from Migration task menu export the task settings in XML format. FIGURE 21 - MIGRATION TASKS EXPORTING OF TASK SETTINGS 2. Export the existing task setting in XML format to local drive. FIGURE 22 - MIGRATION TASKS EXPORT TASK The following fields needs to be configured: File Name: Name of exported task setting file File Location: Local drive path where exported task settings file gets saved 21

23 System will pop up the below confirmation screen to export the task settings. FIGURE 23 - MIGRATION TASKS EXPORT TASK CONFIRMATION 5.4. Create Task Using Exported Setting (Import task settings) User can now import the existing task setting (exported XML file) to create a new task based on exported settings. Click on create to create new task from task settings. FIGURE 24 - MIGRATION TASKS IMPORT EXPORTED TASK SETTINGS 22

24 FIGURE 25 - MIGRATION TASKS IMPORT EXPORTED TASK SETTINGS FIGURE 26 - MIGRATION TASKS TASK CREATION FROM EXPORTED TASK SETTINGS New task is created with all existing settings and will be added to migration task pane Migration Task settings The settings screen is automatically launched when a new migration task is created. The same settings screen can also be launched when desired by clicking on the Settings icon of the migration task Content Type Mapping Settings This screen displays the default Content type mapping, source Content types which are available for mapping (i.e. not mapped already) and target content type available in target. 23

25 FIGURE 27 - CONTENT TYPE MAPPING SETTINGS - DOCUMENTUM SCREEN Note: Migration Accelerator will automatically configure default mappings as per standard rules defined in the system. But if an automatic mapping is not found e.g. for custom content types, then these need to be mapped manually. Select Source Content Type and Target Content Type from the list and then click on Map Button to map the content types. This will bring up the Metadata mappings screen for the mapped content types. Note: A source content type can only be mapped once. Mapping content types which are incompatible will result in errors during execution Metadata Mapping There are four types of metadata mappings: Target Metadata to Source Metadata Target Metadata to Constant Target Metadata to Custom Script o Iron Python Script and o Power Shell Script Target Metadata to built-in Function Target Metadata to Source Metadata: Selecting the Mapping Type as Metadata, displays all the available source metadata in the drop down, one of which can be used for mapping. 24

26 Note: Choosing incompatible metadata value may lead to load-failure Document Content Type Mapping After container content type mapping, user has to map different document content types mappings. Below figure explains dm_document -> Document content type mapping. Similarly user can map other document content types to respective document content types in Oracle WebCenter system. FIGURE 28 - METADATA MAPPING FOR DOCUMENTUM Target Metadata Mapping Type Metadata Value Name Script $MigrationItem.SI.ItemName Title Metadata Title Document Created By Function GetMappedUser{srcMetaValue} Document Modified By Function GetMappedUser(ModifiedBy) Created Metadata Created Modified Metadata Modified 25

27 Target Metadata to Constant Value: If Constant mapping type is selected, user is given an option to specifiy a constant value that will be set in the target metadata. FIGURE 29 - CONSTANT MAPPING Target Metadata to Runtime Script: This option is for advanced users. You can either write IRON Python scripts or PowerShell scripts which will be executed during transformation. Typically, the scripts will modify the value in source metadata fields, which can be passed as inputs to the scripts using variable names provided in the drop down. 26

28 FIGURE 30 - POWERSHELL SCRIPT MAPPING Target Metadata to Function: This option is for advanced users. If Function mapping type is selected, user can add inbuilt Functions or Create his/her own custom function. For example: Also you need to import a user mapping using a csv file from the User Mappings screen. Refer User Mappings for more detail. FIGURE 31 - SELECT FUNCTION SCREEN 27

29 Add Function Besides the built-in functions, the user can create own set of functions based on requirements. To Create New Function user needs to provide Function Language, Group (Optional), Name, Description (Optional), List of Parameters and respective Script for selected language. 28

30 FIGURE 32 - ADD NEW FUNCTION SCREEN 29

31 Edit Function User can edit the properties of the function in the Edit Functions Dialog. The image below shows how this Dialog looks like. FIGURE 33 - EDIT FUNCTION SCREEN 30

32 View Function User can view the properties of the function in the view Functions Dialog. The image below shows how this Dialog looks like. FIGURE 34 - VIEW FUNCTION SCREEN 31

33 Test Function User can test the script of the function in the evaluation Functions Dialog. The image below shows how this Dialog looks like. FIGURE 35 - TEST FUNCTION SCREEN 32

34 Delete an existing Function User can delete the function. The image below shows how this Dialog looks like. FIGURE 36 - DELETE FUNCTION SCREEN Note: - Please be careful when Deleting functions. 33

35 PowerShell Extensions Proventeq Migration Accelerator comes with a default PowerShell module called Proventeq.MigrationAccelerator.PowerShell.Module, which is delivered using the module manifest file Proventeq.MigrationAccelerator.PowerShell.Module.psd1. This has a default sub-module, called Proventeq.MigrationAccelerator.PowerShell.DefaultModule.psm1, which is an empty module (with one sample function). In additions to writing PowerShell rules in the client UI, Proventeq Migration Accelerator provides the option to import custom PowerShell modules. This can be done in the following ways Upgrading the default module Any custom functions and scripts can be written in the Proventeq.MigrationAccelerator.PowerShell.DefaultModule.psm1. These scripts and functions will be available in the Rule editor window in the client UI. Variables that are needed in the script during execution should be declared as a global variable e.g. $global:myvariable Creating new modules A new PowerShell module can be created and included in the Proventeq Migration Accelerator Module manifest file as a nested module. 1. Create a new PowerShell module file (PSM1 file) 2. Create new functions and scripts in this module file 1. Update the NestedModule property of Proventeq.MigrationAccelerator.PowerShell.Module.psd1 file to include this new module (e.g. MyModule.psm1). NestedModules rator.powershellmodule.psm1","mymodule.psm1") Importing metadata from CSV file Metadata can be imported into Proventeq Migration Accelerator using the method specified in Upgrading the default module section. Create a CSV file with a unique Item ID column, and columns for all the metadata associated with the item. Ensure the CSV file has headers. ID, Metadata_1, Metadata_2, Metadata_3 0001, M1_value_1, M2_Value_1, M3_Value_1 0002, M1_value_2, M2_Value_2, M3_Value_2 0003, M1_value_3, M2_Value_3, M3_Value_3 Create a global variable and import the CSV 34

36 $global:csvmetadata = Import-CSV -path <My csv path> -Key <the key column name> In the Script mapping dialog, access the metadata by selecting the appropriate row by filtering it on the unique ID. $meta = $global:csvmetadata?{$_.id eq <My unique ID>} $meta.metadata_ Testing PowerShell Functions It is recommended to test any changes made to the PowerShell module prior to launching PMA. The following steps can be executed to validate the changes, Open PowerShell console and import the Proventeq PowerShell module "C:\Program Files (x86)\proventeq\proventeq Migration Accelerator\PowerShell\Proventeq.MigrationAccelerator.Module.psd1" -Force Invoke the custom function. If a CSV was imported into a custom variable, check the value stored in the variable by typing the variable name in the console. If the values from the CSV are available in the hash table, then the module is ready to be used by Migration Accelerator 35

37 Custom Content Type (Source Classification) Add Source Classification You can add and map Custom Source Content types (Source Classification) by clicking on "Add a new source classification" icon. Each classification has its own unique set of metadata which can be mapped to appropriate target content type. FIGURE 37 - ADD NEW SOURCE CLASSIFICATION For example, Documentum saves shortcut links as document content types, whereas Oracle WebCenter saves all the shortcut links with content type as *******. So to allow migration of shortcut links, we have to create custom content type to classify Documentum shortcut links and them map the same to Oracle WebCenter ******* content type. Here Migration Accelerator provides Add a new source classification functionality in Content Type Mapping Settings screen. You can classify custom content type to a particular document type by using certain properties or classification rule. (e.g. Shortcut link is having entity type as Link in Migration Accelerator staging database, so we can refer the same as rule to classify Documentum shortcut links.) The given below steps explains how to create a Custom Content Type. 1. Select Add a New Source Classification button from respective Migration Task Setting Window. 2. Add Source Classification window should pop up; you need to provide following details to create a new source classification. a. Please Enter, Content Type Name. b. Please Select, respective Base Content Type. c. Script Language should be PowerShell. d. Script Name, it is optional, so you can give any suitable name, if desired e. Script Variables, this is optional too, and still if you desire to select any defined variable name from the drop down list, it mainly helps you to get the value out of it at runtime. 36

38 f. You could see two panels. Left panel allow you to write IronPython/PowerShell Script, and the Right panel is for Script Evaluation. g. Copy the script provided below to classify Documentum shortcut link, which you need to paste into script area at left panel. If($MigrationItem.SI.EntityType -eq "Link") {return $True } else { return $False } The Add Source Classification screen has a Script Evaluation Area. This can be used to evaluate the added scripts to verify whether they are correct. Note: The Add source classification script should evaluate to True for custom content type to work properly. Anything that evaluates to False will skip the added source classification settings. User can use any source metadata variable from the drop down list. See image below for example: FIGURE 38 - ADD NEW SOURCE CLASSIFICATION USING POWER SHELL SCRIPT 37

39 FIGURE 39 - EVALUATE SCRIPT 38

40 Edit Source Classification FIGURE 40 - EDIT SOURCE CLASSIFICATION ICON Also there is a provision to edit the custom source classifications added by user. You can select the added source classification and click on Edit source classification icon to edit the script or change the base content type. This step is not mandatory. Note: Some fields are disabled in edit mode. You may need to select the variable again if you are editing the source classification. User can then use the custom source classification to map to an appropriate target content type (e.g. Image) and map appropriate metadata(s) to target metadata(s). See Section for metadata mapping Delete Source Classification FIGURE 41 - DELETE CUSTOM SOURCE CLASSIFICATION You can also remove a custom content type which is not mapped by clicking on Delete Source Classification icon as shown in image above General Settings These general settings are provided for the "Mapping option" and "Invalid Characters Handling". You can navigate to General Settings screen by clicking on Settings icon of a Migration Task and then on General Settings tab on the Migration Task Settings screen. FIGURE 42 - GENERAL SETTINGS SCREEN 39

41 Mapping Options Mapping option allows users to specify whether to Create or Merge source contents into selected target container during migration task creation. For example, if source folder A is mapped to Target folder B (A --> B) of target then Create mapping option will create folder A under B Folder. Merge mapping option will only load items of folder excluding folder A under B Folder. FIGURE 43 - MAPPING OPTION 40

42 Link Resolution in Different File Types Link resolution is an important feature used to re-establish hyperlinks in well-known source file contents with new location of linked files in target container while performing migration activity. This feature is not mandatory for migrating content from source to target, but if required, the user can select Link Resolution option on General Settings tab and then select the file types that require link resolution, while creating a migration task. FIGURE 44 - LINK RESOLUTION The link resolution settings allow the user to select the well-known file types (with implied their extensions), that will be modified during migration. The available settings are: 1. Word.rtf,.doc and.docx 2. Excel -.xls and.xlsx 3. PowerPoint -.ppt and.pptx 4. PDF -.pdf 5. HTML -.html,.htm and.mht The link resolution feature works as follows: 1. First one need to update the regular expression patterns in the application configuration file based on the link patterns in Documentum system. E.g. DOCID Following is the regular expression key, which user needs to update. <add key="transformation.regex_groupidbasedlink" value="(?<=objectid/).*$" /> Please note that the application configuration file is included in Proventeq Migration Accelerator installation directory (typically "C:\Program Files (x86)\proventeq\proventeq Migration Accelerator\Proventeq.MigrationAccelerator.exe.config") 2. Then user needs to perform Process up to stage Transformation, where it computes information for all the items necessary to determine the target links for respective migration item. 41

43 3. Then user need to verify transformed metadata and links against metadata configuration and target location configuration. 4. Finally, user need to Process up to stage Load to migrate the files to target system after resolving links within files Shortcut Link Resolution The shortcut links resolution is an important feature used to re-establish shortcut links of documents with new location of files in target system while performing migration activity. This feature is not mandatory for migrating content from source to target, but if required, the user can select Resolve Shortcut Links option from General Settings tab. FIGURE 45 - SHORTCUT LINKS The shortcut link resolution feature works as follows: 1. Shortcut Links resolution occurs only if the above setting is enabled for respective migration task. 2. The Shortcut Link processing occurs in Post Process, where it computes information for all the items necessary to determine the new link in the first step (Process), and then loads the updated files or links in the second step (Post Process) Invalid Characters Handling UCM allows only a certain set of characters in its folder name and filename. Note that they are not the same as the rules for use in a Windows File System. The suggested approach is to search for and substitute illegal characters using some rules. FIGURE 46 - INVALID CHARACTER HANDLING 42

44 Suppose a source file name is Help & information.txt then by adding script for metadata Name of content type Documents, above invalid character & in the file name will be replaced by an underscore _ according to above settings and file will be loaded to target as Help _ information.txt. _ character in the settings can be changed to any desired custom character(s) which is valid in Oracle WebCenter naming conventions. User can proceed with the default settings from this window. 43

45 File and Folder Settings FIGURE 47 - FILE AND FOLDER SETTINGS SCREEN Recreate Source Hierarchy The File and Folder settings is used to configure structure hierarchy of items that will be loaded to target. User can proceed with the default settings from this window. FIGURE 48 - RECREATE SOURCE HIERARCHY Duplicate File Handling In Source system, there could be multiple documents with same name in the same folder. Such documents can be handled by selecting one of the options in File & Folder Settings: Discard Files with Duplicate Names Such Items will be marked as failed and will not be migrated. FIGURE 49 - FILE AND FOLDER SETTINGS DO NOT MIGRATE 44

46 Overwrite Existing Files having Same Names Using the Overwrite existing option, will delete the existing file in the target and replace it with the new file migrated with the same name. FIGURE 50 - FILE AND FOLDER SETTINGS OVERWRITE EXISTING Note: This option is not supported with the Enable Package Processing (Refer to Package Processing Settings) turned on Creating New File with Unique Names PMA will create a unique document name by appending auto incremental numbers as a file name suffix. FIGURE 51 - FILE AND FOLDER SETTINGS CREATE A NEW FILE WITH UNIQUE NAME E.g If we have total 3 files with same name as Proventeq User Guide.pdf then PMA will create unique names for them like below: Proventeq User Guide.pdf Proventeq User Guide (1).pdf Proventeq User Guide (2).pdf 45

47 Security Mappings Migration Accelerator allows items to be migrated with their security. Since source security model and entities (like users and groups) might not be compatible with the target, it is essential to map these prior to commencing the migration. The user/group and permission mappings can be imported in to Migration Accelerator. 1) User Mapping If there is no requirement to migrate item level security, but to migrate only user mappings, which will be considered for setting audit fields (E.g. Created By and Modified By), then user can import and configure User Mappings only. User can import comma delimited CSV files for User, Group and Permissions mappings by expanding Import Mappings accordion and following below steps: 1. User need to enter profile name. e.g. Documentum to Oracle WebCenter User Mapping 2. Then need to choose profile type. e.g. User Mapping, Group Mapping or Permission Mapping 3. Click on Browse button to select comma delimited CSV file of respective mapping. The spreadsheet should contain columns with a header row in the format: Mapping_Type, Source_Type, Source_Value, Target_Type, Target_Value It is important that these columns are defined as the first row of the csv file. See below for sample User Mappings. FIGURE 52 - SAMPLE USER MAPPINGS Please note that the sample User Mapping file is included in Proventeq Migration Accelerator installation directory (typically C:\Program Files (x86)\proventeq\proventeq Migration Accelerator\SampleFiles) 2. Finally, one need to click on Import Mappings button which will import all the values in the spreadsheet and display the respective mappings in Mappings pane. 46

48 FIGURE 53 - SECURITY MAPPINGS SCREEN USER MAPPINGS Please note that permission mapping and group mappings are not supported in Documentum to Oracle WebCenter Migration. 47

49 Discovery Settings Proventeq Migration Accelerator allows user to discover item based on the criteria given in the discovery filter. FIGURE 54 - DISCOVERY SETTING Discovery Filter Use the discovery filter option to filter out documents or folders. The syntax of discovery filter as below: [{"ObjectType":<ObjectType>,"Filter":"<Filter Criteria>"}] Object Types: The following Object Types are supported (User numeric values): RootFolder = 2 Item = 4 Filter: The filter criteria could be any supported DQL function or logical operators. The following functions are supported: 48

50 contains starts-with between Examples: Filter Criteria template for RootFolder with Contains function: The contains function checks whether or not a property contains a specified value in the filter Criteria. [{"ObjectType":2,"Filter":"contains(object_name, 'Di') or contains(object_name, 'A')"}] By using this filter expression, the request only returns objects whose object_name contains A. Filter Criteria template for Items with starts-with function: The starts-with function checks the starting string of a property. [{"ObjectType":4,"Filter":"starts-with(object_name, 'D')"}] By using this filter expression, the request only returns objects whose object_name starts with D. Filter Criteria template for Items with between function: The between function checks whether or not the value of a property lies between a specified range. [{"ObjectType":4,"Filter":"between(r_modify_date, date(' '), date(' '))"}] By using this filter expression, the request only returns objects whose r_modify_date is in between and no later than Version Constraint PMA supports version filtering by retrieving the latest top N versions from source system to limit the versions that are migrated to target system. If user wants to discover only the latest top N versions, they just need to put value in text box as shown below. For example, if a value of 4 is input, then only the latest 4 versions of documents will be discovered and migrated. Please note that Version Constraint not applicable for Documentum to Oracle WebCenter Migration. 49

51 Security To discover the document and folder level security, user need to select the Discover Security Information checkbox under Security heading. This ensure all the security information of source system is captured. 50

52 6. EXECUTION The Execution view is divided into 2 sections 1. Migration Tasks where all the user created migration tasks are visible with the number of items to be processed in each task. The count will be 0 prior to discovery, but will show the total items discovered post discovery. 2. Task details This section shows the details of the selected migration task. This section is split into four distinct areas a. Execution - This Execution screen parted into: i. Discovery - to discover what is on the source system. This is the first step in migration. Once the item discovery is complete, the items can be verified by clicking on Items Explorer button. ii. Pre-Migration Check - to check erroneous items/contents from discovery iii. Process - to process the items and load them onto the target system. This step can be executed only after the Discovery has been run at least once and at least 1 one item has been discovered. iv. Post Process to perform post processing actions on items to be migrated. This will be mainly used to process shortcut links or resolve links based on items migrated in Process stage. v. Reset to reset the items uploaded to target system, so that they can vi. b. Items List c. Items Explorer d. Graph View FIGURE 55 - EXECUTION SCREEN be reprocessed. Erase to delete the items migration staging database. Ideally it should be done after Reset if items are processed. After Erase user has to redo Discovery of the items in order to migrate them. 51

53 6.1. Discovery and Analysis Discover Items Select a migration task from the Migration Tasks panel on the left. Click the Discover button in the Discovery area. FIGURE 56 - START DISCOVEYR FOR SOURCE ITEMS If the task is being discovered for the first time, then user can click on "New Discovery". Migration Accelerator will start discovering items from the source system and record their status in the staging database repository. FIGURE 57 - DISCOVERY RUN OF SOURCE ITEMS 52

54 Note: Any modification done to source items after discovery is done will not reflect in Migration Accelerator unless the Discovery is run again. Once a Discovery has been run, the subsequent Discovery runs will add new items and identify the deleted/renamed items. Subsequent Processing will then apply the changes. 53

55 Pre-migration Checks Pre-migration Check feature ensure and confirms erroneous items before actual migration. FIGURE 58 - PRE-MIGRATION CHECK This feature performs the following checks against Oracle WebCenter configuration based on the rule: 1. Blocked Characters in Filenames Illegal characters in the source file/folder names. 2. Disallowed Extensions An extension that is prohibited in the target system, this is not applicable to the standard WebCenter configuration. 3. Max File Size The file size exceeds the limit supported by Oracle WebCenter. 4. Max characters in filename The item name s length exceeds the Oracle WebCenter limits. 54

56 5. Max characters in folder name - The length of a folder name exceeds the WebCenter limits. 6. Max URL length for items The URL/Path length of a parent container exceeds the WebCenter limits. 7. Max URL length for containers The length of the item s URL/Path exceeds the WebCenter limits. 8. Maximum items in folder The folder contains more items than is permitted within Oracle WebCenter. 9. Items with no name - Checks whether the Item Name is blank. 10. Items with same name as another item in a folder- Checks whether the Item Name is duplicate. 11. Items with name mismatch across version - The Item Name differs over versions of a document. 12. Items with differing extensions across versions The file extensions/formats vary over the course of a document s versions. 13. Content referenced by multiple folders The Item is filed/present in multiple folder locations. 14. Items with empty (zero byte) content - The Item has an empty file binary, meaning that no content exists. 15. Items that have been deleted or marked for deletion The Item is marked as deleted in the source system. 16. Items with content type mismatch across versions The content type varies of a document s versions. FIGURE 59 - PRE-MIGRATION CHECK WINDOW 55

57 Power BI Reports Power BI Reports harnesses the power of Microsoft Power BI and the wealth of information stored in the Migration Accelerator staging database to provide intuitive and interactive drill down reports. To view the reports for a task, select the Power BI Report from the Select a Report dropdown. Select the task for which the reports need to be generated, and click Run. This will launch Power BI with information related to that particular task. To view a complete report for the entire source system, run this report on a task that has the source mapped at the top level Power BI Desktop Install A pre requisite for this report is the installation of Microsoft Power BI Desktop. Install Microsoft Power BI Desktop from the Microsoft site Install the product in its default location. If the product is installed in a custom location, please contact Proventeq support for help with configuring the Migration Accelerator for custom path Set up PBI Environment The installation of Proventeq Migration Accelerator create a directory called Proventeq in directory (typically C:\Proventeq\PowerBI ) and its containing the.pbix and.csv file Set up security When the pbix file is launched for the first time the privacy level dialog comes up. Select the file drive and the database to have the same privacy level, e.g. Organizational FIGURE 60 - POWER BI SECURITY SETUP 56

58 General Distribution of Content This reports show the general distribution of content within the system. This includes content type distribution, mime type distribution, version documents and documents under folders. FIGURE 61 - POWER BI - GENERAL CONTENT DISTRIBUTION 57

59 Pre-Migration Checks- Version Continuity Power BI Version Continuity Reports shows the items which are qualified in different categories where Proventeq will apply certain rule and configuration to resolve these target constraints. FIGURE 62 - POWER BI PRE MIGRATION CHECK VERSION CONTINUITY 58

60 Pre-Migration Checks- Paths and Names Power BI Paths and Names Reports shows the items which are qualified in different categories where Proventeq will apply certain rule and configuration to resolve these target constraints. FIGURE 63 - POWER BI PATHS AND NAMES 59

61 Pre-Migration Check - Files Power BI Files Items Reports shows the items which are qualified in different categories where Proventeq will apply certain rule and configuration to resolve these target constrains. FIGURE 64 - POWER BI PRE MIGRATION CHECK FILES 60

62 General Usage of Content Power BI usage report shows the history of documents such as- when it has been created, modified, created date range, modified date range, created by and modified by users. FIGURE 65 - POWER BI USAGE OF CONTENT 61

63 Container Analysis Power BI Container report shows the hierarchy of the Source system. FIGURE 66 - POWER BI CONTAINER 62

64 6.2. Processing After successful discovery of all items present in the source system, click the "Process" button in the Processing area in order start migration of content. It will launch below processing parameters popup window to select different processing parameters. FIGURE 67 - CONFIGURE PROCESSING PARAMETERS Process up to Stage This popup screen will allow select below processing parameters before starting migration of content: 1. Process to stage The migration goes through below processing stages, so one has to select appropriate target processing stage from below list: a. Capture Metadata This stage captures metadata of all the items from source system. b. Classify This stage performs content classification of all items based on content type mapping defined in migration task settings. This stage may retrieve content if required in order to perform content classification. c. Filter This stage applies item filter rule in order to skip certain items in migration. d. Extract This stage performs an extract operation on source metadata if any. e. Transform This stage mainly transforms source metadata to target metadata by executing different metadata mapping rules. This stage may retrieve content if required in order to perform transformation. 63

65 f. Load This stage retrieves content if not obtained in earlier stages and performs upload of content and metadata on target system. Note: To process internal links within document it is mandatory to do transformation first then load. 2. Type of items to process This option allows to select type of items to process. E.g. Whether to process Error items, which may have failed in earlier processing attempts. 3. Throttling parameters This section allows to select below throttling parameters to be referred during processing. a. Maximum number of items to process Allows to select maximum number of items to process in current processing run. b. Maximum number of threads Allows to select maximum number of threads to be created to perform parallel processing in order to achieve necessary through-put. Once all processing parameters are selected, click on OK button to start the migration or click Cancel button to cancel the processing. Clicking on OK button, the Migration Accelerator will start processing each items based on the mapping rules defined. It will display the progress of migration in below screen. FIGURE 68 - PROCESSING COUNT OF SOURCE ITEMS Post Processing Post processing is the process where the user can perform post processing actions (like processing shortcut links) by clicking of Post Process button. Pre-requisites User should have completed with processing up to load stage and there should be some pending items or actions for post processing. E.g. on Items List tab user can see 64

66 Status Message for the shortcut links as: Link item skipped during load phase. These need to be processed using post load. Before attempting the Post Process for shortcut links, we have to make sure that necessary custom content type and metadata mappings are done. Refer section Custom Content Type (Source Classification) Then can then follow below steps in order to perform post processing: Click on the Post Process button to Post Process the shortcut links. The system will show confirmation to start the post processing. Click on Yes button. FIGURE 69 - POST PROCESSING CONFIRMATION After click on Yes button Migration Accelerator will start performing post processing actions like processing the shortcut links. It will show success and failure count of post processing items. FIGURE 70 - POST PROCESSING COUNT Once post process is completed, user can go to Items List tab and check the status of items being post processed. E.g. The shortcut links items will now show the status message as: File checked in successfully Synchronization or Delta Processing Proventeq Migration Accelerator supports one-way synchronization from Documentum to UCM. 65

67 If source contents are changed after particular task discovered and/or processed, then user needs to re-discover the same task to synchronize the updated items on the source system. Then user need to do pre-migration checks followed by processing and post processing on newly added or modified items. In Synchronization or Delta Processing, using packaging, Original document which is modified will be deleted from target in the first processing attempt and then in subsequent processing attempt, they will be migrated Reset Items The Reset functionality is available to remove items loaded on to the target system by Proventeq Migration Accelerator. From the Processing area, click the Reset button. This will pop up a Configure Processing Defaults screen where user can select the item, thread, and click on Ok button. FIGURE 71 - RESET OF ITEMS After clicking on OK button reset, reset process will remove all the items from target system. FIGURE 72 - RESET TARGET ITEMS 66

68 Warning: This will delete all the content loaded by Migration Accelerator and is not recoverable. User will have to re-run the load. This will not delete any items that were not originally loaded by Proventeq Migration Accelerator Erase Clicking on Erase button deletes all the discovered items related to the selected Migration Task from database. Any data loaded to target will remain as it is. Erase will not delete items from target system. User may require to Reset loaded items from target before clicking on Erase either button or delete items from target manually, if Erase has already been done. FIGURE 73 - START ERASE OF SELECTED TASK FIGURE 74 - ERASE ITEMS 67

69 History A History button is available on each area for Discovery and Processing. Clicking on this button brings up a screen that list all the actions that were performed on that migration task along with date the action was performed and the outcome of that particular action Items List tab Clicking on Items List tab allows user to view the complete list of items for a migration task, along with its Status Filter and Processing Run Filter. Items can be filtered on the following filter criteria: 1. All Shows all items in the migration task. This option is also the default option when none of the filters are selected. 2. Success only Shows all successfully processed items 3. Failure only Shows only the items with errors 4. Unprocessed only Shows items that have not yet been processed. The Items List screen is shown below: 68

70 FIGURE 75 - EXECUTION - ITEMS LIST FIGURE 76 - DETAILS OF MIGRATED ITEM Additionally, Processing Run filters are provided: 1. Last Processing Run - Shows item from last processing run based on the Status Filter. 2. All Items - Shows items from all processed run based on the Status Filter. Easy effort has been made with "Detail" button to cross check each source and target metadata in the product itself along with the source and target links. 69

71 6.4. Items Explorer This feature gives powerful interface for Documentum contents and a hierarchical view of item status based on the discover/process from the execution screen FIGURE 77 - ITEMS EXPLORER 70

72 6.5. Graph View Clicking on Graph View presents a graphical representation of the progress of the items and the failures. User can also filter results based on "Error Codes", "Error Messages", Mime Types" and "Source Content Types". Apart from analysing items in different phases like "Start", "Discover", "Transform" and "Load" user can also add graphs to each phase. User can add graph by either selecting a particular desired phase and clicking on "Add Graph" button, or by right clicking on the phase and selecting the desired graph type. FIGURE 78 - EXECUTION-GRAPH VIEW 71

73 7. REPORTING Migration Accelerator provides several reports where user can do in-depth analysis of the migration tasks. Clicking on the Reporting tab provides access to all available reports. To generate a report, select the report and the migration task and click the Run button. The generated report can be exported as Excel, PDF or printed copy Discovery Log Report Every time, user discovers items, a snapshot of the source system is recorded in the staging repository. This report gives full detail of items discovered in each discovery process. To generate Discovery report, select Discovery Log from Select a report drop down and select one of the Mapping for which the report has to be generated. Then click on Run. Discovery run report will show latest run statistics for every Synchronized task. Below are meaning and description of the status messages from discovery log. FIGURE 79 - REPORTING DISCOVERY REPORT Status message New Discovery from Source Modified on Source Description Item which is newly added Item which has been processed previously and modified since then Updated item has been added back after deletion Deleted on Source Blank This indicates that and item has been deleted since one of the previous discoveries. The deleted items are listed against the Discovery run which last successfully discovered the item. File was new in previous discovery and has not been processed 72

74 Same item has been added back after deletion 7.2. Processing Log Report Every time user processes items, an audit of the processing actions recorded along with the outcome of the action. This report gives full detail of items loaded or failure in each migration-processing run. To generate the Processing Log report, select Processing Log from Select a report drop down and select one of the migration task for which the report has to be generated. Then click on Run Similarly, you can generate other reports like Items Report, Mime Type Summary report and Tagging report and Process Work Item Link Reports. FIGURE 80 - REPORTING PROCESSING LOG REPORT 73

75 7.3. Success Report FIGURE 81 - REPORTING - SUCCESS REPORT 7.4. Error Log Report Error report gives the list of items failed during migration progress. To generate Error report, select Error Report from Select a report drop down and select one of the migration task for which report has to be generated. Then click on Run. This report will give you all the failed items in which stage they failed and the reason, this will help to do error analysis for failure items and take corrective action to fix them. FIGURE 82 - REPORTING ERROR REPORT 74

76 7.5. Final Processing Report Final Processing Report is the report which gives you the details of all the items that are processed, pending to process etc. To generate this report, select Final Processing Report from Select a report drop down and select one of the migration task for which report has to be generated. Then click on Run Process Work Item Link Report Process Work Item Link Report is important report, which gives you details about the link references, which are there in documents, whether it is internal links or external links. PMA support links resolution of internal links within the same discovery and will resolve the link on target. PMA does not support external links as they are out of scope of migration. To generate this report, select Work Item Link Report from Select a report drop down and select one of the migration task for which report has to be generated. Then click on Run. 75