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:

  • Databases
  • Model definitions (entities and attributes)
  • Mappings
  • Custom ETLs
  • Data warehouse tasks
  • Data mart definitions

Command syntax

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

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>

--autogen

Use this paramter to automatically generate the imported project. If the project is imported successfully, Compose will:

  • Validate the model and adjust the data warehouse if needed
  • Create the data warehouse tables if they do not exist
  • Validate the data warehouse
  • Adjust the data warehouse if needed.

    If the "Adjust" cannot be performed automatically, the "autogen" process will be stopped.

  • Generate all data warehouse tasks.

    If Compose encounters an error while generating a data warehouse task, it will skip the problematic task and continue with the remaining tasks.

  • Create, adjust and generate all data marts

Information note

If an error is encountered during the "Create" or "Generate" operations, it is recommended to switch to the Compose Console and perform these operations manually. Doing so will generate a more detailed error message and enable you to resolve the issue.

For information on validating the data warehouse and generating the task, see Creating and managing the data warehouse . For information on generating the data mart task, see Creating and managing data marts .

Example

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

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!