Exporting project assets

You can share assets in a project with others by exporting them.

Requirements and restrictions

Required role
You need Admin or Editor role in the project to export project assets.
Restrictions
  • You cannot export assets larger than 1024 MB from the projects user interface. To export assets up to 5 GB, use the asset command with the Cloud Pak for Data command line interface (cpd-cli).
  • Project name, description, tags, and members are not exported.
  • You cannot export job run metadata. Job run information is not available after you import.
  • Personal credentials for a connection are not exported. You must unlock the connection after importing it before you can use it.
  • If your project is marked as sensitive, you can't export data assets, connections or connected data from the project.
  • Be mindful when selecting assets to always also include the dependencies of those assets. Dependencies might include the data assets or connections for a data flow, a notebook, connected data, metadata imports, data quality definitions and rules, or jobs. There is no check for dependencies. If you don't include the dependencies, subsequent project imports do not work.
  • You can only share assets across projects created in the same experience and platform. You cannot export project assets from an experience on IBM Cloud and import them into a project on IBM Software Hub.
  • You cannot export data quality information that is associated with a data quality rule.
  • Any connections that are created from a custom JDBC connector do not work if you import the project into a different instance of the experience. An administrator must delete the connection and re-create the custom JDBC connector in the new instance.

Asset types

Project asset types you can export:

  • Code package
  • Connected data asset
  • Connection
  • Data asset from a file
  • Data Privacy flow
  • Data Refinery flow
  • Folder asset
  • Jobs
  • Metadata enrichment
  • Metadata import
  • Parameter set
  • Pipeline
  • Visualization

Exporting project assets to desktop

Exporting project assets packs what you select into a single ZIP file that can be shared like any other file.

To export project assets to desktop:

  1. Open the project you want to export assets from.

  2. Check whether the assets that you include in your export, for example notebooks or connections, contain credentials or other sensitive information that you don't want to share. Remove sensitive information before you begin the export. Only private connection credentials are removed automatically.

  3. Optional. Add information to the readme using the Document editor on the Overview page of your project about the assets that you include in the export. For example, you can give a brief description of the assets and how they are used.

  4. Click the Export icon Export from the project toolbar.

  5. Select the assets to add. You can filter by asset type or customize the project export settings by selecting preferences (the settings icon to the right of the window title) which are applied each time you export the project.

    Note that you can currently only select up to 1000 assets and the size of the export file can't exceed 1 GB in size.

  6. Optional: Change the name of the project export file.

  7. You must supply a password if:

    • You want to export connections that have shared credentials. Note that this password must be provided to decrypt these credentials on project import.
    • You want to export connections that have Mask sensitive credentials retrieved through API calls set to On. Without a password, connections that mask sensitive credentials retrieved through API calls are not exported.

  8. Click Export. Do not leave the page while the export is running.

    When you export to desktop, the file is saved to the Downloads folder by default. If a ZIP file with the same name already exists, the existing file isn't overwritten.

    Ensure that your browser settings download the ZIP file to the desktop as a .zip file and not as a folder. Compressing this folder to enable project import leads to an error. Note also that you cannot manually add other assets to an exported project ZIP file on your desktop.

    The status of a project export is tracked on the project's Overview page.

Learn more

Importing a project