22 Release Management

This chapter describes the features added to ODI to support release management.

This chapter includes the following sections:

Managing ODI Releases

You can manage ODI releases using deployment archives. A deployment archive is an archived file (zip file) that contains a set of ODI objects in the form of XML files and metadata. You can create deployment archives that can be used to either initialize an ODI repository or to update a deployed ODI repository.

If ODI is integrated with a VCS, deployment archives can be created from the VCS labels. If ODI is not integrated with a VCS, deployment archives can be created from the current ODI repository.

See also, Types of Deployment Archives.

Types of Deployment Archives

You can create the following types of deployment archives in ODI:
  • Initial Deployment Archives

    Initial deployment archives contain all the ODI objects that are necessary to initialize an ODI repository. You can create an initial deployment archive and use it to deploy an ODI repository in an environment where the ODI objects are not modified, for example, in a testing or a production environment.

  • Patch Deployment Archives

    Patch deployment archives contain only the ODI objects that need to be updated in an ODI repository. You can create a patch deployment archive and use it to update an ODI repository that is already deployed. For example, when you update any ODI objects in a development environment, the updates can be applied in a testing or a production environment using a patch deployment archive.

See also:

Creating a Deployment Archive from a VCS Label.

Creating an Initial Deployment Archive from the ODI Repository.

Creating a Patch Deployment Archive from the ODI Repository.

Creating a Deployment Archive from a VCS Label

In an ODI environment that is integrated with VCS, you can create a deployment archive from a VCS label. The deployment archive will be created with the ODI objects that are included in the VCS label.

To create a deployment archive from a VCS label:

  1. Click Team> Deployment Archives> Create From VCS Label.
  2. Select the type of deployment archive that you want to create. You can choose one of the following types:
    • Initial Deployment Archive

      Contains all the objects that are necessary to initialize an ODI repository.

    • Patch Deployment Archive

      Contains only the ODI objects that need to be updated in an ODI repository.

    For more information, see Types of Deployment Archives.

  3. In the Deployment Archive Name field, enter a name for the deployment archive.
  4. In the Deployment Archive Folder Path field, specify a folder path where you want to store the deployment archive.
  5. From the Select VCS Label drop down list, select the VCS label that you want to use to create the deployment archive.
  6. In the Description field, enter a description for the deployment archive.
  7. In the Export Key field, set a export key.
  8. In the Confirm Export Key field, re-enter the export key for confirmation.
  9. Click OK.

    A success Information dialog appears.

  10. Click OK.

Creating an Initial Deployment Archive from the ODI Repository

In an ODI environment that is not integrated with VCS, you can create an initial deployment archive from the current state of the ODI repository.

This section describes how to create an initial deployment archive, which will include all the ODI objects that are required to initialize an ODI repository.

For more information, see Types of Deployment Archives.

To create an initial deployment archive from the ODI repository:

  1. Click Team> Deployment Archives> Create From Repository> Full Repository.
  2. In the Deployment Archive Name field, enter a name for the deployment archive.
  3. In the Deployment Archive Folder Path field, specify a folder path where you want to store the deployment archive.
  4. In the Description field, enter a description for the deployment archive.
  5. In the Export Key field, set a export key.
  6. In the Confirm Export Key field, re-enter the export key for confirmation.
  7. Click OK.

    A success Information dialog appears.

  8. Click OK.

Creating a Patch Deployment Archive from the ODI Repository

In an ODI environment that is not integrated with VCS, you can create a patch deployment archive with selected ODI objects from the current ODI repository.

Note:

When you create a patch deployment archive from the ODI Repository, an execution deployment archive is also created. The execution deployment archive includes only the Scenarios and Load Plans corresponding to the ODI objects that are included in the patch deployment archive.

The execution deployment archive names are prefixed with EXEC_.

This section describes how to create a patch deployment archive, which will include only the ODI objects that need to be updated in an ODI repository.

For more information, see Types of Deployment Archives.

To create a patch deployment archive from the ODI repository:

  1. Click Team> Deployment Archives> Create From Repository> Selected Objects.
  2. Select Patch Deployment Archive option.

    Note: It is necessary to select the Patch Deployment Archive option.

  3. In the Deployment Archive Name field, enter a name for the deployment archive.
  4. In the Deployment Archive Folder Path field, specify a folder path where you want to store the deployment archive.
  5. In the Description field, enter a description for the deployment archive.
  6. Select Include all security objects option if you want to include all the security objects in the deployment archive.
  7. In the Export Key field, set a export key.
  8. In the Confirm Export Key field, re-enter the export key for confirmation.
  9. Drag and drop the required ODI objects from the Designer Navigator into the Selected Objects field under Objects to be added to Deployment Archive.

    The dependent objects that will be included in the deployment archive are listed under Dependent Objects.

  10. Click OK.

    A success Information dialog appears.

  11. Click OK.

Viewing Available Deployment Archives

You can view a list of deployment archives that are available in a folder path along with their details. Double-clicking any of the deployment archives lists the contents of the deployment archive.

To view available deployment archives:

  1. Click Team> Deployment Archives> View Details.
  2. In the Deployment Archive Folder Path field, browse to the folder path where the deployment archives were created. All the deployment archives in the specified folder path are listed under List of Deployment Archives.

    Note: You cannot type the folder path, you must use the Browse button to specify the folder path.

  3. Double-click any of the deployment archives to see its contents. A list of ODI objects contained in the deployment archive is displayed.
  4. Click Close.

Initializing an ODI Repository Using an Initial Deployment Archive

You can initialize an ODI repository that is not connected to VCS with the contents of an initial deployment archive. If VCS connectivity is configured then it is assumed to be a development repository and thus the options to apply deployment archive are disabled.

Before you initialize an ODI repository, ensure that the Work repository is empty.

Note:

In situations where the ODI repository is initialized with deployment archives from multiple Work repositories, the Master repository will not be empty. In such situations, when you load the deployment archive from the second Work repository, the contents of the Master repository are overwritten.

To initialize an ODI repository using an initial deployment archive:

  1. Click Team> Deployment Archives> Initialize Deployment Archive.
  2. In the Deployment Archive Folder Path field, browse to the folder path where the deployment archive was created. All the deployment archives in the specified folder path are listed under List of Deployment Archives.

    Note: You cannot type the folder path, you must use the Browse button to specify the folder path.

  3. Select the initial deployment archive that you want to use to initialize the ODI repository.
  4. Click OK.

    If the selected deployment archive contains cipher data, you are prompted to enter the export key.

  5. Do one of the following:
    • Select Enter Export Key option and enter the export key that was used when creating the deployment archive.

    • Select Import file without cipher data option if you want to import the file without the cipher data.

  6. Click OK.

    A success Information dialog appears.

  7. Click OK.

Updating an ODI Repository Using a Patch Deployment Archive

You can update an ODI repository that is not connected to VCS with the updated ODI objects in a patch deployment archive. If VCS connectivity is configured then it is assumed to be a development repository and thus the options to apply deployment archive are disabled.

To update an ODI repository using a patch deployment archive:

  1. Click Team> Deployment Archives> Patch Deployment Archive.
  2. In the Deployment Archive Folder Path field, browse to the folder path where the deployment archive was created. All the deployment archives in the specified folder path are listed under List of Deployment Archives.

    Note: You cannot type the folder path, you must use the Browse button to specify the folder path.

  3. Select the patch deployment archive that you want to use to update the ODI repository.
  4. Select Create Rollback Deployment Archive option if you want to create a rollback deployment archive.

    Note: It is recommended to create a rollback deployment archive. If required, you can revert the changes applied by the patch deployment archive using this rollback deployment archive.

  5. In the Rollback Deployment Archive Path field, browse to a folder path where you want to create the rollback deployment archive.

    Note: The Rollback Deployment Archive Path field is enabled only if the Create Rollback Deployment Archive option is selected.

  6. Click OK.

    If the selected deployment archive contains cipher data, you are prompted to enter the export key.

  7. Do one of the following:
    • Select Enter Export Key option and enter the export key that was used when creating the deployment archive.

    • Select Import file without cipher data option to import the file without the cipher data.

  8. Click OK.

    A success Information dialog appears.

  9. Click OK.

Viewing Deployment Archives Applied in an ODI Repository

You can view the list of deployment archives applied in an ODI repository.

To view deployment archives applied in an ODI repository:

  1. Click Team> Deployment Archives> Inventory.

    The Inventory dialog appears with the list of deployment archives applied in the ODI repository.

  2. View the details of the deployment archives listed on the Inventory dialog.
  3. Click Close.

Rolling Back a Patch Deployment Archive

If you want to revert the changes applied to an ODI repository using a patch deployment archive, you can rollback the patch deployment archive.

Multiple patch deployment archives can be rolled back, provided the rollback order is maintained. For example, if you had applied patch1 and then patch 2, you must first rollback patch 2 and then patch 1.

To rollback a patch deployment archive:

  1. Click Team> Deployment Archives> Rollback.
  2. In the Deployment Archive Folder Path field, browse to the folder path where the rollback archive was created.

    Note: You cannot type the folder path, you must use the Browse button to specify the folder path.

  3. From the List of Deployment Archives, select the appropriate rollback deployment archive.
  4. Click OK.

    If the selected deployment archive contains cipher data, you are prompted to enter the export key.

  5. Do one of the following:
    • Select Enter Export Key option and enter the export key that was used when creating the deployment archive.

    • Select Import file without cipher data option to import the file without the cipher data.

  6. Click OK.

    A success Information dialog appears.

  7. Click OK.