Project Exports and Imports¶
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. Once you have a JSON project export, it can be imported into any organization.
Exporting a Project¶
The Export or Export Project options are accessible from these locations:
- The Projects page (see Card View or List View in Projects).
- The project toolbar (see Project Actions Menu in Project Toolbar).
On selecting Export or Export Project, the project export screen opens, where you choose the export options and generate the project as a JSON file:
Include Credentials: Includes in the exported project the values specified within credentials fields of project component configuration screens.
The specific configuration fields that are treated as credentials fields vary by project component. They often include fields such as passwords or security tokens. Developers of custom connectors using the Connector SDK can designate such fields with either of these attributes:
"secret": "true": Designates only that the field is treated as a credentials field. The field's value is encrypted in the project export.
"widgetHint": "password": Designates that the field is treated as a credentials field and also masks the value in the Cloud Studio UI by replacing each character with a black bullet. The field's value is encrypted in the project export.
The values of project variables themselves are not treated as credentials, even if the Hide Value option is selected in the UI (see Project Variables). Instead, whether project variable values are included is controlled with the Include Project Variable Values selection.
If a project variable is used in a credentials field (regardless of whether Include Project Variable Values is selected), the credentials field's
"value"is the encrypted value of the square bracket syntax representation of the project variable name and any other input, if present.
When Include Credentials is not selected, the credentials field's
"value"is not included in the project export, except if a project variable is used in a credentials field. In that case, the non-encrypted clear text input of the credentials field is included. This may be of concern if the credentials field uses any other input along with the project variable, though this use case is unusual. For example, a field input of
[pv_password]1234suffixwould be included in the project export as
Include Email Notifications: Includes email notifications in the exported project. This option applies to all email notifications in a project, regardless of whether they are configured with operation actions to run on success, failure, or SOAP fault or if they are referenced in a script.
Include Project Variable Values: Includes project variable default values in the exported project.
The values of project variables configured with the Hide Value option (see Project Variables) are encrypted in the project export.
Include Schedules: Includes operation schedules in the exported project.
Export: Generates and downloads the project as a JSON file. By default, the JSON file name uses the name of the project.
An exported project does not retain the project history.
Importing a Project¶
To begin the import process, from the Projects page, click Import to get started:
On the next screen, you import the project:
If the project being imported uses connectors that are available only on Private Agents, those connectors will be disabled after import to Cloud Agents.
Project File: Use the Browse button to browse to a project JSON file that has been exported from Cloud Studio.
If the project uses any custom connectors, they must exist in the organization prior to importing the project. To export a Connector Builder connector and import it in another organization, see Connector Builder Exports and Imports. To install a Connector SDK connector in another organization, see Implementing a Harmony Connector.
On selecting a file, these fields become available:
Project Name: The project name is prepopulated from the JSON file. To use a different name, you can edit it here. The project name must meet these criteria:
Be unique for each environment.
Cannot already be in use as a Design Studio project name in the same environment.
Organization: Use the dropdown to select the organization that you want to import the project to. If you have only one organization, it is 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 are 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 on success, failure, or SOAP fault or if they are referenced in a script. To exclude email notifications from being imported, clear the checkbox.
References to an email notification component in a script are not removed even if email notifications are excluded, 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 are included when the project is imported. To exclude schedules from being imported, clear the checkbox.
After the project is imported, it is not yet deployed. When you are ready to deploy, see Project Deployment.