Summary: This document provides information about the CAST Imaging ETL extension and how to install it.
The CAST Imaging ETL extension contains the CAST Imaging data export/import tools as a standalone extension. This component has its own lifecycle, separate to CAST Imaging allowing new features and bugs to be fixed without needing to wait for a new release of CAST Imaging.
What is provided in the extension?
The extension is provided as a ZIP file. When unzipped, the following files and folders are available. These files and folders will be used to patch the corresponding ETL files embedded in your CAST Imaging installation:
When should you install this extension?
This extension provides bug fixes and new features for the ETL tool embedded in CAST Imaging, therefore:
- The CAST Imaging ETL extension will be released only when bugs need to be fixed or new features need to be added which were not available in the most recent funcrel release of CAST Imaging.
- Release numbers of the CAST Imaging ETL extension will reflect the release numbering of CAST Imaging, therefore, and for example, release 2.1.1-funcrel and 2.1.2-funcrel of CAST Imaging ETL contain bug fixes and new features that were not available in the ETL tool embedded in the 2.1.0-funcrel release of CAST Imaging.
- When the next funcrel release of CAST Imaging is published, this will include any bug fixes or new features for the ETL tool embedded in CAST Imaging that were implemented in CAST Imaging ETL extension releases since the previous CAST Imaging funcrel release, plus any additional new features or bug fixes.
With the above information in mind, there is no obligation to install the CAST Imaging ETL extension unless there is a specific bug fix or new feature provided in it which you need to take advantage of and which is not available in the release of CAST Imaging that you are currently using.
Do not install an older release of the CAST Imaging ETL extension into a more recent install of CAST Imaging, for example, installing CAST Imaging ETL 2.2.1-funcrel into CAST Imaging 2.3.0-funcrel. This is in effect a downgrade and recovery is not possible.
This extension is designed to use with CAST Imaging on the following operating systems:
|Microsoft Windows traditional installer|
|Docker for Windows|
|Docker for Linux|
The extension can be used to patch the following releases of CAST Imaging:
|CAST Imaging ETL extension||CAST Imaging|
|1.1.x, 2.1.x||2.0.x, 2.1.x|
Prerequisites and information
|Installation location||The extension must be installed on the server where your existing Microsoft Windows CAST Imaging installation is installed - the extension contains files and folders that will be used to patch the corresponding ETL files provided in the CAST Imaging installation.|
|Elevated Administrator right||The batch installation file must be run using a CMD prompt which has been run with elevated Administrator rights.|
|CAST Imaging System - imaging-ETL service|
The installation process will stop and restart the CAST Imaging System - imaging-ETL service.
Step 1 - perform a backup of the imagingetl folder (optional)
The extension will patch a set of files and folders in your current CAST Imaging installation, as such, if CAST Support have instructed you to make any custom changes in the folder listed below, CAST recommends backing up the folder before you start the installation process (simply make a copy of the folder and all its contents and store it in an unrelated location). The folder is located here:
Step 2 - download the extension
You can obtain the extension from https://extend.castsoftware.com/#/extension?id=com.castsoftware.imaging.etl&version=latest.
Step 3 - unzip the extension
Unzip the downloaded extension on the server hosting your existing installation of CAST Imaging.
Step 4 - run the batch installation file
Open a CMD (command) prompt with elevated administrator rights (right click CMD and choose Run as administrator) and move to the location of the unzipped extension. Run the ImagingSystem_ETL_installer.bat file located at the root of the unzipped extension:
The installation process will then start. The CAST Imaging System - imaging-ETL service will be stopped and then restarted during the installation process.
Follow the instructions in Automation tool export and import process to perform a new data export/import using the new ETL tools.