WebClient User Guide

Introduction

The migration-center WebClient is a new component introduced in version 22.1.0 and serves to replace the Desktop Client in order to provide a better experience and add new features and improvements in the coming versions. It is delivered as a customized Tomcat that is installed as a windows service. The WebClient is currently compatible with Google Chrome and Microsoft Edge.

General Information

Scanners and Importers

Scanner is the term used in migration-center for an input connector. It is used to read the data that needs processing into migration-center and is the first step in a migration project.

Importer is the term used for an output connector used as the last step of the migration process. It takes care of importing the objects processed in migration-center into the target system.

Scanners or importers have a unique name, a set of configuration parameters and an optional description. They work as a job that can be run at any time and can be executed repeatedly.

Scanners and importers are created, configured, started and monitored through migration-center WebClient but the corresponding processes are executed by migration-center Job Server.

For every run a detailed history and log file are created.

History, Reports, Logs

A complete history is available for any Scanner or Importer job from the Scan Runs / Import Runs window.

This section displays a list of all runs for the selected job together with additional information, such as the number of processed objects, the status, the start and ending time.

• Version information of the migration-center Server Components the job was run with

• The parameters the job was run with

• Execution Summary that contains the total number of objects processed, the number of documents and folders scanned or imported, the count of warnings and errors that occurred during runtime.

Sign in

To connect to a migration-center database, open the WebClient URL address in the browser: https://<server-name>/mc-web-client/login

Connection Select one of the available connections to the server from the list. If no connections are available or if you want to modify an existing one, click Manage connections.

Manage connections You can create, modify and delete a connection and you can also refresh the list of existing connections.

• To create a connection, click the Add Connection + button and then, in the New Database Connection dialog box, type your Connection Name, Database Type, Host, Port number and Service Name. When finished, click CREATE.

Return to the Sign in page either by double clicking the desired connection, by right-clicking the desired connection and selecting Log in using this connection or by clicking the Back < button on the buttons bar and then logging in.

User name Type your username (default fmemc).

Password Type your password (default migration123).

When finished, click SIGN IN.

Navigate the WebClient

You can easily navigate through the migration-center WebClient sections using the sidebar on the left, as follows:

Use the WebClient

To run a migration, first you need to create a Job Server definition. You can do so in the Jobservers section.

Then, you need to:

1. Create and run a Scanner

2. Create a Migration Set

3. Define rules and apply Transformation

4. Create and run an Importer

Additionally, you can:

1. Schedule a Migration

2. Monitor Migration Jobs

Jobs

Scanners

You need to create, configure and run a scanner in order to connect to a source system.

Details

In the DETAILS tab, give your scanner a meaningful Name, then select the Type of connector from the list. Then, depending on the selected connector type, the Parameters section will be populated with the connector's specific configuration parameters.

Next, in the Location field, select the Job Server where your Scanner be executed when you run it. Optionally type a meaningful Description for your scanner.

When finished, click either:

• SAVE - if you plan to run the scan later;

• SAVE & RUN - to save and run the scanner immediately, in which case you will be prompted to enter a description for this run in the Enter Job Run Description dialog box. By default the run description is the name of the scanner and the number of which run it is.

Scan Runs

To view the history of your scanner, click the SCAN RUNS tab of a scanner.

To view a Scan Run Log select the desired scan run and either right-click it and select Download Scan Run Logs, or on the Log icon in the toolbar or by double clicking the entry.

Source Objects

You can view the metadata of the extracted documents for the entire scanner by clicking the SOURCE OBJECTS tab.

The first columns from Id to Import date are internal migration-center columns and the rest represent an attribute from your source system.

You can change the number of rows on a page and navigate between pages using the bottom toolbar.

To Filter objects based on a specific attribute, use the dropdown to the right of the toolbar. This will enable you to select one of the attributes of your objects and then search for values in that attribute.

Migsets

A migration set, or migset for short, is a grouping of Source Objects on which a set of transformation rules are applied which generates Target Objects.

Properties

Details

In the PROPERTIES tab, in the DETAILS subtab, give your MigSet a meaningful Name and optionally a Description.

In the Type dropdown, select the Source to Target system migset type (i.e. FileSystemToDCTM). Once selected, the list of all scan runs that match the Source part of the migset type are displayed under the Available list.

You can also filter which objects are included in the MigSet by using the EXCLUSIONS and the ADVANCED FILTERS subtabs.

Exclusions

In the EXCLUSIONS subtab, objects are excluded from your MigSet by choosing which attribute values should be excluded. To do so, select the desired attribute under Available attributes and use the < > arrow buttons to exclude the values.

Advanced Filters

In the ADVANCED FILTERS subtab, you can create rule based filters using operators. Select a Source Attribute, Operator, Values and Connector, the click on ADD to include them. You can also delete rule filters.

You can check your selection by going to the OBJECT PREVIEW subtab.

Object Preview

In the OBJECT PREVIEW subtab, you can see a preview of the filtered objects.

When finished, click the LOCK OBJECTS button to add the selected objects to your MigSet. This means that these objects will be locked in this migset and cannot be used in another one. Then, in the Confirm Object Selection dialog box, click Yes.

Transformation

Rules

Transformation Rules define how metadata from Source Objects is used to generate new metadata for Target Objects by using Transformation Functions. A transformation rule is equivalent to a Target Attribute after transformation.

Rule Snippets

Snippet Rules are rules whose value can be used as a step in any other normal rule.

To set a Rule as a Snippet check Snippet checkbox in the Rule Properies.

To use a Rule Snippet insert a GetSnippetRuleValue function and enter the name of the Snippet Rule you want to use.

Transformation Functions

A transformation rule can have multiple transformation functions. They can take source attributes, static strings or even previous functions as the input value and provide an output value.

See TR Function Reference page for a list of all available functions.

To add a Transformation Function:

1. Select the Transformation Rule you want to add a function to.

2. Under Transformation Methods, select the desired transformation Function you want to use and click on INSERT FUNCTION.

3. Fill the function parameters in the popup (the parameters vary depending on the function).

4. Click OK to insert the function or CANCEL to close the popup.

Multi-value Transformation Rules

Attributes from a source object can be Single Value or Multi Value (Repeating). A Transformation Rule can process both these kinds of attributes, but if the rule itself is not marked as MultiValue using the checkbox in the Rule Properties it will return only the last processed value.

A transformation function can process All values or only the value at a specific index of a repeating attribute.

After making a Transformation Rule into a multi value one, you can also return multiple functions as separate repeating values using the Result toggle.

Debug Rule

A transformation rule can be debugged by taking a sample source object and us its metadata to see the results of each step in the rule.

1. Get the ID of an object whose metadata will be used for debugging the rule.

2. Select the rule you wish to debug.

3. Enter the Object ID in the text field next to the DEBUG RULE button.

4. Click the DEBUG RULE button.

5. The value for each step is calculated based on the metadata of the selected object and displayed in the Debug Values column.

Generate Rules

Other Features

You can also Transform or Reset the objects of this migset without returning to the list of migsets.

Migset Mapping Lists

The migset mapping lists function in the same way as regular mapping lists except they are usable only in the migset they belong to.

Fore more details please see the main Mapping Lists section.

Associations

Transformation Rules are not automatically used when importing an object. They need to be associated to a Target Attribute of an Object Type in the Associations subtab of the migset.

Each Migset has a target type system rule that determines to which type an object will be associated with. This rule differs depending on the migset type. For example for any ...ToDCTM migset the rule is r_object_type.

Source Objects

You can view the source attributes of the objects in the MigSet by clicking the SOURCE OBJECTS tab.

The first columns from Id to Import date are internal migration-center columns and the rest represent an attribute from your source system.

You can change the number of rows on a page and navigate between pages using the bottom toolbar.

To filter objects based on a specific attribute, use the dropdown to the right of the toolbar. This will enable you to select one of the attributes of your objects and then search for values in that attribute.

Target Objects

You can view the attributes generated by the transformation rules of the objects in the Migset by clicking the TARGET OBJECTS tab.

Please see the Source Objects section for features common to all Objects Views, including Target Objects.

To Filter objects based on their status, use the Statuses checkboxes in the bottom toolbar.

Error Objects

You can view the objects that encountered errors during the Transform, Validate or Import phases in the MigSet by clicking the ERROR OBJECTS tab.

The Error Objects tab has features present in the Source Objects and Target Objects tab.

Importers

Importers will connect to the Target System, take the selected MigSet with Validated Objects and import them. You can monitor the progress in the Importer run history or directly in the MigSets view.

Details

In the DETAILS tab, give your Importer a meaningful Name, type or select the Importer Type from the list and complete the needed Parameters.

Next, in the Location field, select the Job Server where your Importer be executed when you run it. Optionally type a meaningful Description for your scanner.

Migset Selection

In the SELECTION tab, under AVAILABLE MIGSETS you can see MigSets with validated objects that match your target destination: for example, for an OpenText importer, only MigSets with the type ...ToOpenText will be displayed. Double-click the desired MigSet to add it to the ASSIGNED MIGSETS list to be migrated. Note that only validated objects or error objects that previously failed an import will be processed.

When finished, click either:

• SAVE - if you plan to run the import later;

• SAVE & RUN - to save and run the import immediately, in which case you will be prompted to enter a description for this run in the Enter Job Run Description dialog box. By default the run description is the name of the importer and the number of which run it is.

Import Runs

To view the history of your importer, click the IMPORT RUNS tab of an importer.

Delta Migration

Delta Migration is a feature of migration-center that allows you to migrate updates made to documents that have already been scanned and newly created documents that were not scanned yet.

This feature is possible using most available connectors.

Check the user guide for your connector to confirm if it is capable of delta migration and to see if there are any pre-requisites or limitations.

Prerequisites

You need to have the initial batch of objects scanned, transformed and imported successfully. In the target system the imported objects need to be present.

Scanning

You can start a delta migration by running either the same original scanner or any scanner that will pick up already scanned objects. If these objects have been modified since the original scan, they will be scanned again as an update object, otherwise they will be ignored. New objects, that were not scanned before will be scanned normally.

Update objects can be identified by having the is_update attribute value set to 1 or True.

MigSet

Since the original MigSet needs to be left untouched with all objects intact, and the delta migset needs the same rules, the best way to do this is to create a copy of the original migset.

Transform the migset used for the Delta Migration, as you would normally.

Importing

The Delta MigSet can be selected in the same Importer used for the original import, or in any other importer as required.

The Delta Import will create all new objects normally and it will locate already imported objects in the target system and update their metadata and content as needed.

Schedulers

A Scheduler is used to automate an end to end migration and is useful when needing to make regular delta scans and imports for a Source System that changes often.

The workflow of a Scheduler is as follows:

1. It will run the selected Scanner

2. If there are objects in the Scan Run, it will create a copy of the selected Migset, assign the Scan Run to it and Transform the objects

3. If there are Validated Objects after the transformation, it will assign the migset to the Importer and run it.

4. If Email Report is set it will send the email as configured, when the import ends.

Configuration

In the CONFIGURATION tab, configure the Details of your scanner, such as Name, Description and whether you want to set the scheduler to Active.

Next, select the Scanner, MigSet and Importer by clicking the respective buttons. The list of Migsets will be filtered to match the selected Scanner type and the list of Importers will be filtered to match the selected Migset type.

Frequency

In the FREQUENCY tab, configure the Start Date when this scheduler will be running from and either the End Date or the number of runs after which it will stop.

In the Interval section configure a timeslot and the Frequency at which the Scheduler will start.

In the Email Report section you can set an Email Address where the scheduler will send reports and whether you want the report send in case of Success or in case of Error. You also need to have an SMTP Server to use for sending the email reports.

In the IMPORTED OBJECTS tab, you can see the list of objects imported by your scheduler.

In the ERROR OBJECTS tab, you can see the list of errors that may have occurred during the scheduled migration. When finished, click Save on the top right corner.

History

In the HISTORY tab, you can see all the runs of the selected Scheduler.

To view the Imported Objects or Error Objects, select a run and click on their respective icons.

Imported Objects

Here you can view the list of Imported Objects for the selected Scheduler Run.

The Imported Objects view features are common among the other Object Views. Please see Source Objects for details.

Error Objects

Here you can view the list of Error Objects for the selected Scheduler Run.

The Error Objects view features are common among the other Object Views. Please see Source Objects for details.

Dashboard

Migration Status

The Migration Status tab of the Dashboard presents the total number of objects in your Database, divided between the 4 states: Unprocessed, In Progress, Errors and Imported.

From the dropdown menu on the left you can chose to display Numbers or Percentages on your graph.

Object Distribution

The Object Distribution tab provides more detailed reporting for specific source object types or specific Scanners.

The chart on the left shows the scanned object distribution yearly, while the chart on the right shows the scanned objects distribution monthly for a selected year.

To load all data of a source object type, first selected the required type from the Source Type dropdown and then press Load Data.

To load the data of a specific scanner, after selecting the required Source Type, press the Select Scanner button.

Object Search

You can search for any Source / Target Object in the Object Search section using values of Internal, Source or Target attributes.

Search criteria

When searching by Internal Attributes, you can select the Attribute name from a dropdown of predefined attributes. Afterwards enter the Value by which you want to search.

When searching by either Source Attributes or Target Attribtues you have to manually enter the Attribute Name. Afterwards enter the Value by which you want to search.

Start the search by clicking the Search button.

Stop the search by clicking the Cancel button that appears when a search is in progress.

Search Results

When a search query finishes, results start loading in the Objects table.

Object History

The Object History view is a list of all Scan or Import operations that an object has gone through, along with the the Job Run ID, Source ID and Target ID.

To open the view click on the collapsed header on the bottom of the screen. You can also resize it by dragging the space between the two tables.

To load the history of a specific object just select it in the results table.

To view the History Attributes of a specific operation right click it and select the View History Attributes entry in the context menu. These attributes will be either Source or Target depending on the type of the operation.

Configuration

Job Servers

A Job Server definition is needed to run jobs like scanning or importing documents.

Enter a Name, Location (where a Job Server is installed), Port (9700 by default) and a Description (optional) for your Job Server definition. When finished, click CREATE.

Object Types

Object Types in migration-center are a representation of a document or other objects in a Target System where you are importing. They are used in the Associations section of a migset and any object needs to be associated to at lest one Object Type to be able to Transform, Validate and Import it.

Adding attributes

The attributes of an object type need to match the attributes or fields in the target system in Name and Type. If the attributes do not accurately represent the target system this can result in object values passing validation and causing errors during the Import phase.

Mapping List

A Mapping List is a collection of key - value pairs that can be used in Transformation Rules using the MapValue() function.

Checking Exact Match makes the mapping list match key values only if they are exactly the same.

Using Exact Match unchecked will result in the mapValue and mutliColumnMapValue functions to match source strings that contain the key in the mapping list as a substring.

Checking Case Sensitive makes the mapping list match key values only if the case matches. Otherwise matches will be made regardless of case.

Adding entries

To delete all entries select the mapping list and click on the Clear Values icon on the mapping list values toolbar. When finished click on SAVE.

Multi Column Mapping Lists

The Multi Column Mapping List is a new feature usable only with the migration-center WebClient.

Using a Mapping List

To use a regular Mapping List, in the transformation rule select the MapValue() function. Set the value to be matched with the values in the Key column, select the Mapping List you want to use and whether or not you want the function to report a transformation error when a value is not matched.

To use a Multi Column Mapping List, in the transformation rule select the MultiColumnMapValue() function. Set the first parameters as you would for a regular mapping list and also specify the name of which Value column you want the function to return when finding a match.

Licence

Here you can enter a new License key for the migration-center database installation you are currently connected to.

About

The About section provide information on your current installation as follows:

Version of migration-center components: UI version, API version and Database version.

The Java version that is running the WebClient Apache Tomcat.

The Oracle version of the migration-center Database that you are currently connected to.

Licence Information: Licensed to and Licence validity.