Tools - Content Enrichment Migrator

Created by Salim Frontin on Feb 11, 2022

What's new?

Please see Content Enrichment Migrator - Release Notes for more information.

Purpose

The purpose of the Content Enrichment Migrator is to copy content enrichment tools from an application in a triplet to another application in another triplet.

Content Enrichment Tools consist of :

The Content Enrichment Tool is made of an export script and an import script, both written in Groovy, and of an export batch and an import batch

  • ExportContentEnrichment.cgroovy
  • ImportContentEnrichment.cgroovy
  • export.bat
  • import.bat

The export script, launched by the export batch, will write one XML File for the Tools Before Analysis found in the source triplet, and one XML File for the Tools After Analysis.

The import script, launched by the import batch,  will generate Tools Before Analysis and Tools After Analysis in the target triplet based on these XML Files

This tool is provided by Maintenance Team, and published as an extension com.castsoftware.labs.tools.contentenrichmentmigrator

Applicable in CAST Version
Release
Yes/No
8.3.x(tick) 
Applicable RDBMS
RDBMS
Yes/No
CSS3(tick)
CSS2(tick)

Prerequisites

 Follow the below prerequisites before running the tool:

CAST-AIP

CAST-AIP must be installed on the server(s) where you launch the scripts.

BACKUPS

Take a backup of the target triplet before importing

Configuration

The export and import batch file scripts must be configured with the following variables : FLATDIR, LOGDIR, EXPORTDIR/IMPORTDIR, CONNECTION_PROFILE, APP_NAME

Configuration - export.bat

set "FLATDIR=<CAST AIP Installation PATH>"
set "LOGDIR=<Path to the log file>"
set "EXPORTDIR=<Root path of the export folder">
set "CONNECTION_PROFILE=<Source Connection Profile>"
set "APP_NAME=<Source Application Name>"

FLATDIR must be set to the CAST Installation path
LOGDIR must be set to the folder where the log file should be generated
EXPORTDIR must be set to the folder where user wants to generate the subfolder (CAST_CONTENT_ENRICHMENT) containing the XML Files 
CONNECTION_PROFILE must be set to the connection profile to the source application
APP_NAME must be set to the source application name


Configuration - import.bat

set "FLATDIR=<CAST AIP Installation PATH>"
set "LOGDIR=<Path to the log file>"
set "IMPORTDIR=<Root path of the import folder">
set "CONNECTION_PROFILE=<Target Connection Profile>"
set "APP_NAME=<Target Application Name>"

FLATDIR must be set to the CAST Installation path
LOGDIR must be set to the folder where the log file should be generated
IMPORTDIR must be set to the parent folder of the folder (CAST_CONTENT_ENRICHMENT) containing the XML Files  
CONNECTION_PROFILE must be set to the connection profile to the target application
APP_NAME must be set to the target application name

NB : Please note that EXPORTDIR and IMPORTDIR should be the same, otherwise the import script will not find the XML files generated by the export script (unless you copy them to the appropriate folder)

Copy Content Enrichment

Usage

After configuring the batches :

  1. Launch the export batch

  2. Check that some XML files were generated in folder <EXPORTDIR>\CAST_CONTENT_ENRICHMENT
    One for tools before analysis : before_tools.xml
    One for tools after analysis : after_tools.xml

  3. Launch the import batch

You can now check that the content enrichment tools were properly imported by opening CAST-MS on the target connection profile, clicking the target application and going to Content Enrichment tab.

Related Pages



Notes