Importing and exporting ETL packages

This topic contains the following sections:

Overview

This section provides you with information on importing and exporting ETL packages.

  • A BMC TrueSight Capacity Optimization installation has many Out-of-the-box ETLs.
  • As a BMC TrueSight Capacity Optimization Administrator, you can create and activate connector instances that use any of these modules.
  • When activating a connector instance, as an Administrator you can specify many parameters and configuration choices. These parameters and choices are called a run configuration.
  • If as an Administrator you want to copy an instance to another BMC TrueSight Capacity Optimization installation, you can export the run configuration to a file, called a "package", and then import that package into the other BMC TrueSight Capacity Optimization installation.

Note

When you export service ETL configuration VMware - vCenter Extractor Service ETL, the export prompts a message It's not possible to complete the export.

You can also very easily upload Custom modules created using the BMC TrueSight Capacity Optimization Development Studio to a BMC TrueSight Capacity Optimization installation by exporting the module itself, and importing it back into another BMC TrueSight Capacity Optimization installation. The sections in this topic will explain how you can accomplish this task.

You can export an ETL package by clicking Export ETL package located in the custom ETL section towards the top of the main ETL tasks page.

Additional information

In Custom ETLs you can also export/import the code and the run configuration.

Importing and exporting ETL package in Custom ETL

This section provides information on how to import and export ETL packages in Custom ETL by navigating to Administration > ETL & SYSTEM TASKS > ETL tasks.

Export an ETL package

To export an ETL package

To export an ETL package, perform the following task:

  1. Click the desired ETL in the ETL tasks table by navigating to Administration > ETL & SYSTEM TASKS and then click Export ETL package.
  2. A pop-up window will be displayed. This allows you to create a package that contains the ETL module code or the Active Run configuration, or both.
    This package can be imported in another installation of BMC TrueSight Capacity Optimization to create an equivalent ETL instance without repeating configuration steps.
    Export ETL
  3. Select the ETL you want to export:
    • Active run configuration only
    • Custom ETL module code only
    • Active run configuration and custom ETL module code
  4. Click Proceed to export the ETL.

    Note

    Consider Active run configuration and Custom ETL module code in this case.

  5. Download the <filename>.etlpkg file to your local system.

You have successfully exported the ETL package.

To import the ETL package

To import the ETL package, perform the following task:

  1. After downloading the <filename>.etlpkg file to your local system, go to the ETL tasks page and click Import ETL package.
  2. The Import ETL package page is displayed, where you can upload the downloaded ETL file.

    Note

    You can upload only the file names that begin with a letter (upper/lowercase) or number, and have maximum 254 characters except '/', '\' or  ';'.


    The following message is displayed: Successfully uploaded <filename>.etlpkg that contains custom ETL module code.
    The current module <filename> (ETL||extractor||<filename>E) is activated.

    The following image depicts the Import ETL package procedure:

    Import ETL package

  3. From the available options, select Upgrade and re-activate custom module \<filename> and click Proceed.
    The following pop-up message is displayed: This custom ETLmodule is already present in your environment. If you proceed it will be replaced in all the ETL engines.
  4. Click OK.

    The following message displayed in the Add ETL Task page: Custom ETL module <filename> successfully activated.

Importing and exporting ETL package in Out-of-box (OOTB) ETL

This section provides information how to import and export ETL package in OOTB ETL.

Additional information

In OOTP you can export only run configuration.

To export an ETL package

In OOTB ETL, you are not allowed to export the source code. To export an ETL package, perform the following task:

  1. Click on the OOTB ETL from the list.
  2. Click Export ETL package.
    The Export ETL package dialog box is displayed. 

    Export ETL
  3. To export the ETL, click Proceed.
  4. Download the <filename>.etlpkg file to your local system.

To import the ETL package

To import the ETL package, perform the following task:

  1. After downloading the .etlpkg file to your local system, go to the ETL list and click the Import ETL package option.
  2. The Import ETL package page is displayed, where you can upload the downloaded ETL file.

    Note

    • Ensure that you do not upload file names beginning with '.' or '/' as they can result in path traversal
    • BMC recommends you to use antivirus to check for the upload of malicious files


    The following message is displayed: Successfully uploaded etlpkg that contains Run configuration.
    Import ETL package

  3. From the available options, select Create a new ETL instance with imported run configuration. To import the ETL package, click Proceed.

    After you have imported the ETL package, you can edit it from the ADD ETL Task page.
Was this page helpful? Yes No Submitting... Thank you

Comments