Skip to main content Skip to complementary content

Importing a project

You can use the import_project_repository CLI to import a project. If you import to an existing project, all of the project settings, except the project configuration items will be overridden. For information on the project configuration items, see Exporting the project configuration.

Imported projects include the following:

  • Data zone connections
  • definitions (entities and attributes)
  • Mappings between Landing Zone and Storage Zone table columns.
  • Storage Zone ETL tasks

Command syntax

ComposeCli.exe import_project_repository --project project_name --infile input_file [--password password] [--is_without_credentials] [--override_configuration] [--dont_backup_existing_project]

Parameters

Parameter Description
--project The name of the project.
--infile The full path to the input file, including the file name. This file is in JSON format (e.g. C:\file.json).
--password

The password specified with the password parameter during export.

For instructions on changing the master user password, see Changing the master user password.

See also: Moving projects from the test environment to the production environment and Import/export scenarios - When is a password required?

--is_without_credentials Use this parameter to specify to import the project settings without the encrypted fields. In this case, you will need to manually enter the project passwords in the Compose database connection settings.
--override_configuration

Use this parameter to override the existing project configuration. When importing a project, the default setting is not to override the existing project configuration.

--dont_backup_existing_project

Use this parameter to specify not to back up the existing project. By default, existing projects are backed up to the following location (and automatically restored if the import fails):

<product_dir>\data\projects\<project_name>_backup_<timestamp>

Example

ComposeCli.exe import_project_repository --project MyProject --infile file.json --password MyPassword --override_configuration --autogen

Information note

Existing Storage Zone tables and generated task statements are not imported. After the import completes, you must perform step 3 below. You may also need to perform step 1 or 2, depending on whether you changed the Storage Zone connection settings (step 1) or kept the existing connection settings (step 2).

  1. If you changed the Storage Zone connection settings after importing the project, then you need to create the tables in the new Storage Zone.
  2. If you edited the Metadata in a testing environment and then imported the project into a production environment, you need to validate and adjust the Storage Zone.
  3. Generate the Data Storage task statements.

For information on validating the Storage Zone and generating the task statements, see Creating and Managing Storage Zone Tasks .

Did this page help you?

If you find any issues with this page or its content – a typo, a missing step, or a technical error – let us know how we can improve!