Page tree
Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 6 Next »

Summary: Information about the Delivery Folder Migration Tool, a tool required during the process of importing applications into AIP Console from CAST Management Studio.

What's new?

See Delivery Folder Migration Tool - Release Notes for more information.

What is the Delivery Folder Migration Tool?

The Delivery Folder Migration Tool is a tool that is required during the process of importing applications into AIP Console from CAST Management Studio.

CAST AIP Console uses a different format of Delivery folder (since version 1.13) than the format that is used in legacy deployments of CAST AIP using CAST Management Studio. Therefore, before an application can be imported into AIP Console, the files stored in the existing Delivery folder relative to the Applications to be imported, must be transformed into the format that the AIP Console can understand.

Therefore, this tool serves two purposes:

  • it will first copy the files for the selected Applications stored in the existing Delivery folder configured in CAST Management Studio into the Delivery folder configured for the target AIP Node where the application will be managed.
  • it will then transform these files into a structure that AIP Console can understand
  • the existing Delivery folder remains unchanged

Existing and AIP Console Delivery folder formats

The following image shows the structure of the existing and AIP Console Delivery folder formats. In essence, the new format allows each Application to have a specific "plugins" folder, which in turn allows more flexibility with regard to the extensions that can be used with an Application:

Usage instructions

Instructions for using the tool are provided in Import an Application managed with CAST Management Studio into AIP Console.

Technical information

Applications skipped in migration

The following Applications will be skipped during the migration process

  • Any Applications that have no delivered source code
  • Applications that have a duplicate management ID in index.xml (this file is located in the existing Delivery folder)
  • Applications whose management ID is not present in the Management schema
  • Applications with duplicate management IDs at schema level (same management ID present in different schema or across server)
  • Applications present in the Management schema whose schema name is not in align with site_name in the sys_site table

Errors / warnings

The following errors or warnings may be generated when using the tool:

Error / warnings

InformationCategory
ERROR --- old delivery folder does not exist - C:\OldLocationEnter valid and existing old delivery folder location.Input Validation Error
ERROR --- new delivery folder does not exist - C:\NewLocationEnter valid and existing new delivery folder location.Input Validation Error
ERROR --- Config file should be a valid json file.Config file provided should be json format (.json).Input Validation Error
ERROR --- Old Delivery Folder should have index fileOld delivery folder should have index file.Input Validation Error

ERROR --- size of new directory is less than that of old directory

There is not enough space in new delivery folder. Check the size.Input Validation Error

WARN --- Schema Doesn't have CMS_PREF_SOURCES relation

This occurs when schema do not have table 'cms_pref_location'CastMSDatabaseConnection
WARN --- Schema Name is not matching with Site_Name from Sys_site table hence excluded from migrationDifference in schema name fetched from database provided in config file and site_name in sys_site table. Applications with this issue will not be migrated. CastMSDatabaseConnection
WARN --- Please remove one MNGT schema for the MNGT id to proceed furtherThis occurs when same management id is present in more than one management schema.CastMSDatabaseConnection

Files generated

In addition to splitted application folders, the tool generates the below files at new delivery folder location after run is completed

tracking.properties- This file contains summary of the run with below attributes :

AttributeDescription
ProcessCompletedThe value is true if the process is completed successfulyy else false
Skipped.Applications.DuplicateMngtID.NameSkipped Application Info that have duplicate management id
LatestMigratedApplicationIDlatest id of application which is migrated.
Size.oldDeliveryFolderrepresents size of old delivery folder
Skipped.Applications.Undelivered.NameSkipped Application Info that are undelivered
Count.Applications.toBeMigratedcount of eligible application that is to be migrated
Size.newDeliveryFolderrepresents size of new delivery folder
Count.Applications.skippedcount of skipped application that are not migrated
Count.Applications.overallcount of overall application present in index.xml file
Count.Applications.migratedcount of application that are migrated after the process is completed.
Skipped.Applications.MissingMngtID.NameSkipped Application Info whose management ID is not present in database across schema/server


ApplicationInfo : This text file contains the detailed info of Application that are skipped in migration process.

delivery-folder-migration-tool-logs : This file contains complete log.

index.xml This is created directly under new delivery folder location that contains mapping of uuid and app name for all the migrated application. Sample as below : 

When user rerun the migration.bat file these migrated apps are read from this index.xml file and skipped in next run.

This prevents the repopulation of new delivery folder with existing applications in each run.

Key Points : 

In case of abrupt failure at any application while migration, the application mapping will not be populated in newDeliveryFolder location index.xml file.

  • No labels