Project deployment

Project deployment packages can be used to back up projects or migrate projects between different environments (e.g. testing to production). As a deployment package is intended to be deployed in a new environment, it contains the Storage Zone and data source definitions, but without any passwords. The deployment package also does not contain any data from the Storage Zone, only the metadata. The deployment package also contains the project metadata and mapping information, which should be consistent with the Landing Zone tables in the new environment.

For a complete list of objects contained in the deployment package, see Exporting a project.

Creating deployment packages

This section explains how to create a project deployment package.

To create a deployment package:

1. Choose one of the following methods:

   • In the main Compose window, right-click the desired project and select Create Deployment Package from the context menu.
   • In the main Compose window, select the desired project. Then, click the Deployment toolbar button and select Create Deployment Package from the drop-down menu.

   • In the project window, select Deployment > Create Deployment Package from the project drop-down menu.

   The Create Deployment Package - <Project_Name> window opens.

2. Provide a Version number and a Description in the designated fields and then click OK.

   A ZIP file containing a JSON file (i.e. the project settings) and a readme.txt file will be saved to your browser's default download location.

   The ZIP file name is in the following format:

   <Project_Name>_deployment_<Date>__<Time>.zip

   The readme.txt file contains the following information about the deployment package: project name, export date, exporter user name, deployment version, and description.

Deploying packages

This section explains how to deploy a project deployment package. You can only deploy packages to an existing project. Therefore, before deploying a project, create a new project with the user name and password required for connecting to the Storage Zone database and the Landing Zone database (if defined) in the new environment. In addition, the Landing Zone databases in the target project must have the same display name (defined in the Compose console) as the corresponding databases in the source project. Note that as database settings are usually environment specific, the database settings in the target project will not be overwritten by those of the source project.

When deploying, Compose does not override existing connection parameters, assuming they are environment-local. This enables you to easily migrate projects from test to production, for example, without the need to change user names, passwords or IP addresses.

To deploy a project:

1. Copy the ZIP file created when you created your deployment package to a location that is accessible from the Compose machine.

2. Open Compose and choose one of the following methods:

   • In the main Compose window, select the desired project. Then, click the Deployment toolbar button and select Deploy from the drop-down menu.

   • In the project window, select Deployment > Deploy from the project drop-down menu.

   The Deploy window opens.

3. Either drag and drop the file on the window.

   -OR-

   Click Select and browse to the location of the deployment package. In the Open window, either double-click the deployment package ZIP file or select the file and click OK.

   The package details will be displayed.

4. Click Deploy to deploy the package. When prompted to replace the existing project, confirm the operation.

   The project will be deployed.