Skip to end of metadata
Go to start of metadata

Introduction

You may want to export a Cloud Studio project to use as a local backup or archive, or to share a copy of the project outside of your organization. Cloud Studio project exports are in the format of a JSON file containing all of the metadata of a project. Once you have a JSON project export, it can be imported into any organization.

Exporting a Project

You can access the project export screen directly from the project index:

  • Project Index: In card view, on the back of the card, click the actions menu icon  and select Export.
  • Project Index: In list view, hover over the project row; then in the far right column, click the actions menu icon  and select Export.

In addition, the project export screen is accessible using the Export link at the bottom of the Project Settings screen. You can reach the Project Settings screen from any of these places:

  • Project Index: In card view, on the back of the card click the actions menu icon  and select Project Settings.
  • Project Index: In list view, hover over the project row; then in the far right column, click the actions menu icon  and select Project Settings.
  • Project Pane: At the top of the project pane, click the actions menu icon  and select Settings.

In the project export screen, you choose the export options and generate the project as a JSON file:

  • Include Credentials: By default, projects are exported without credentials, meaning any usernames, security tokens, or passwords specified directly within project component configurations. To include these values in the exported project, select the checkbox.
  • Include Email Notifications: By default, projects are exported without email notifications. This option applies to all email notifications in a project, regardless of whether they are configured with operation actions to run upon success, failure, or SOAP fault or if they are referenced in a script. To include email notifications in the exported project, select the checkbox.
  • Include Project Variable Values: By default, projects are exported without project variable values. To include these values in the exported project, select the checkbox.
  • Include Schedules: By default, projects are exported without operation schedules. To include operation schedules in the exported project, select the checkbox.
  • Export: Click the Export button to generate and download the JSON file with the project metadata. The JSON file name, by default, takes the name of the project.

Importing a Project

To begin the import process, from the project index, click Import to get started:

In the next screen, you import the project:

  • Project File: Use the Browse button to browse to a project JSON file that has been exported from Cloud Studio.

    TIP: If the project uses any custom connectors, they must exist in the organization or environment prior to importing the project. See Connector Builder Exports and Imports for importing a Connector Builder connector, or Implementing a Harmony Connector for installing a Connector SDK connector.

    Upon selecting a file, these fields become available:

    • Project Name: The project name will be prepopulated from the JSON file. To use a different name, you can edit it here. The project name must be unique for each environment, and cannot already be in use as a Design Studio project name in the same environment.

      NOTE: If you receive a message that a project with the same name already exists, but the project index does not show any projects with the same name, check the Management Console Projects page to ensure there are no projects that have been deployed to Harmony with the same name. If there are, and you want to rename the existing project in order to use the same name with a newly imported project, note that you must redeploy the renamed project to Harmony before you can use the same name.
    • Organization: Use the dropdown to select the organization that you want to import the project to. If you have only one organization, it will be selected by default.
    • Environment: Use the dropdown to select the environment you want to import the project into.
    • Include Email Notifications: By default, if email notifications were included as part of the project when it was exported, they will be included when the project is imported. This option applies to all email notifications in a project, regardless of whether they are configured with operation actions to run upon success, failure, or SOAP fault or if they are referenced in a script. To exclude email notifications from being imported, clear the checkbox.

      CAUTION: References to an email notification component in a script are not removed even if the component is removed, so you may need to correct any broken references after excluding emails.
    • Include Schedules: By default, if operation schedules were included as part of the project when it was exported, they will be included when the project is imported. To exclude schedules from being imported, clear the checkbox.
  • Import: Click the Import button to import the project. If the project was successfully imported, the imported project will open on the design canvas. In addition, the new project will be available from the project index.

    NOTE: After the project is imported, it is not yet deployed. When you are ready to deploy, see Project Deployment.
On This Page

Last updated:  Mar 24, 2020

  • No labels