Using the ETL Development Kit for managing custom ETLs
The ETL Development Kit (EDK) is a command line utility that you can use for managing custom ETLs. You can create a custom ETL module in Perl or Java, and it can be a simple extractor, database extractor, or parser. The utility can be used on Windows and Linux systems.
Using the EDK, you can achieve the following goals:
- Create custom ETL modules in Perl or Java programming language.
- Modify existing ETL packages (created using Integration Studio or EDK) and repackage them.
- Activate ETL packages so that they can be used in Capacity Optimization deployment.
- Deactivate deployed ETL packages.
The commands to import, activate, and deactivate are available only when you apply Service Pack 1 (11.5.01) of TrueSight Capacity Optimization 11.5.
The ETL Development kit requires Java JDK or JRE 1.8 or later (Ensure that you set the PATH environment variable).
To create, modify, and activate custom ETL packages
Following procedure is illustrated with an example to create database extractor in Java.
To deactivate custom ETL packages
When the deployed ETL package is no longer needed, you can deactivate it using the EDK. You can reactivate it when needed.
After deactivation, the custom module is removed from the list of ETL modules that are available to the TrueSight Capacity Optimization administrators for creating a new ETL instance. Any ETL instance that was created using this custom module is still displayed in the list of ETLs, but you won't be able to run the ETL until you activate it again.
Navigate to the <project_path>/output folder.
Run the following command to deactivate the package:
.\coetl.cmd --deactivate <project_path>\output\<project_name>.etl.pkg
./coetl.sh --deactivate <project_path>/output/<project_name>.etl.pkg
.\coetl.cmd --deactivate development\MonitoringDatabaseETLProject\output\ETLProject.etl.pkg
./coetl.sh --deactivate development/MonitoringDatabaseETLProject/output/ETLProject.etl.pkg
Similar to the activation command, if you rename the generated key file or save it in a folder different from the EDK root folder, specify the API key while deactivating the package.