The TARGIT Migration Tool app helps migrate TARGIT documents and associated shared objects between TARGIT solutions. The main features of the app are Export and subsequent Import of selected shared documents as well as simple backup functionality.
On startup of the app, the local machine where the app is running is scanned for the presence of a TARGIT installation. If a valid TARGIT installation is found, the local solution folders can be connected directly using the first option on the opening dialog. Alternately, manual connection to TARGIT solution folders on other machines can be established by browsing to the desired folder using the second option.
Note! Migration tool always requires local administrator access, which is forced on startup. However, if connecting to solution folders using e.g. a network path, it is very important that the user running the app has full Read/Write/Modify access to the folder location.
When a valid TARGIT Server folder has been selected, the main app work area is opened. The work area consists of a Document Browser on the left, a Document Detail presentation area on the right and a function launch panel at the bottom.
The document browser is a hierarchical presentation of all documents found in the shared part of the TARGIT Virtual File System of the connected solution. Documents included are Dashboards, Bookmarks, Menu files and Slideshows. Depending on the number of files in the Virtual File System, loading the document hierarchy may take a few seconds to several minutes during which a work in progress indicator is shown.
The document browser is where documents for export are selected. The selected status of a document is changed by checking or unchecking it. Checking or unchecking a folder will recursively check or uncheck all underlying documents and folders depending on the current check status of the folder.
Clicking any document in the Document browser will update the document detail area with information about shared objects used in the document for review.
The function launch panel shows the number of documents loaded from the TARGIT Server and the number of currently selected documents. More importantly, the launch panel is where each of the available functions of the app are launched, with functions for exporting and importing documents and doing backup.
Functions - How to migrate
Migration export is a twostep process.
When documents have been selected for migration, the first step is clicking the Export button in the launch panel to begin the migration export process. When launched, the documents currently selected will be parsed for use of shared object elements, and the list of all objects to be exported as well as the list of selected documents are shown for review. Furthermore, a file browser is available for selecting the name and location of the migration package file to create. Loading the list of objects may take a few seconds to several minutes depending on the number of objects and complexity of the TARGIT solution. A progress indicator will be shown during load.
When the list appears and has been reviewed and the export target file defined, hitting the Export button will launch step two and the actual export begins. The duration of the export step will also depend on the size and complexity of the solution.
When export is complete, a message will appear, and, if successful, the TARGIT migration package is ready to be imported to a different TARGIT solution.
After connecting to the TARGIT solution that is the target for the migration import, the import process is initiated by clicking the Import button in the launch panel. When launched, a file browser is available to select the migration package to import. When the package has been selected, the import twostep process begins by clicking the Review button. Loading the migration package and comparing it to the target solution may take from a few seconds to several minutes depending on the number of objects and complexity of the target solution and the migration package. A progress indicator will be shown during load.
In the Review step, the import package is parsed and compared to the target solution to determine if decisions are needed before the import can proceed. A review list with all import objects will be shown with suggested default actions based on the comparison result between the import package and the target solution.
Ready for Import – no conflict
The document or object will be imported. This action cannot be changed.
Conflict. Please review – skip import
If the import comparison step located existing documents or objects in the migration package that already exist in the target solution, the default action will be to skip import to avoid invalidating existing documents in the solution.
Conflict. Please review – Replace existing
If the import comparison step located existing documents or objects in the migration package that already exist in the target solution, the default action can be changed to Replace existing by clicking the hyperlink button to toggle to the alternate action.
When satisfied with the actions set for each import document and object, clicking the Import button will start the update of the target solution. A progress indicator will be shown during import. When completed, a message will appear, and closing the Import window will trigger a reload of the solution settings to reflect the changes made during import.
The backup function is independent of selections made in the document browser and will back up the TARGIT Virtual File System and Settings of the connected server folder in their entirety. Having launched the backup function from the launch panel, the file browser can be used for changing the output location and file name before clicking the Backup button to run the backup process.
The backup file is a file with extension .tbak but can be extracted using normal archiving tools (zip) to restore the files.
The following documents and shared objects are supported for migration under the conditions described.
The Import comparison property describes how each shared object type is validated to determine if it already exists on the migration target solution.
Dashboards, Menus, Slideshows and Bookmarks. Document versions beginning from TARGIT Suite 2019 are supported, but current major version is highly recommended. Older document versions can also be migrated but may not include all current shared object types and formats.
Import comparison property: File tree location and name.
Regular database connections, excluding GIS, TARGIT Insight and Data Discovery connections.
Note! Security and access context for data sources used by connections may be different across multiple TARGIT installations. Therefore, subsequent adjustments to a migrated database connection may have to be made for the connection to work.
For relational and TARGIT InMemory data sources, the TARGIT data model created for the data source is migrated as part of the connection.
Import comparison property: Database connection name.
Import comparison property: User dimension ID.
For system (built-in) visualizations, specifically defined locations will be migrated. For custom visualizations, the image and locations defined will be migrated. Globally defined (non-database specific) definition files will not currently be migrated.
Import comparison property: Visualization ID.
Import comparison property: Crosstab Theme ID.
Import comparison property: Color Palette ID.
Import comparison property: Gauge name.
Import comparison property: Menu style ID.
Import comparison property: Dimension / attribute name.
Import comparison property: Measure name.
When the Migration Tool app is started, a log file is created in the common application data location on the machine where the app is installed and run, typically ..\ProgramData\TARGIT\TARGIT Migration Tool\Log\. The log file is named with the current local date and time and is used throughout the app session. In normal operation, the log will be updated with high level information about events happening during app operation. If, however, errors occur that need handling or further investigating, the log file is an important tool if support from TARGIT is required.
Since updates to files in the TARGIT solution are made during migration import, it is recommended that the TARGIT server is stopped while import operations are run to limit the risk of crossover writes and updates between the TARGIT server and Migration Tool.
Note! If the server is running during import, some changes may not be visible to users before next restart of the server.
The first step of any import operation is automatic backup of the full Virtual File System and Settings parts of the import target server. This step cannot be disabled. This ensures that any failing import run or broken files due to errors are reversible. Automated backups are stored in the common application data location on the machine where the app is installed and run, typically ..\ProgramData\TARGIT\TARGIT Migration Tool\Backup\. The backup file is a file with extension .tbak but can be extracted using normal archiving tools (zip) to restore the files.