Project Creation and Configuration

Introduction

This page describes how to create and configure a new project from within Cloud Studio, how to open an existing project, how to edit the configuration settings of existing projects, and how to delete existing projects.

New Cloud Studio projects can also be created by using Cloud Studio Integration Recipes or Cloud Studio Process Templates provided through Jitterbit Marketplace. For information on creating a new Cloud Studio project from Marketplace, see Starting a Recipe or Template Project.

Creating a New Project

New projects are created from My Projects page, also referred to as the project index. This page contains a repository of accessible Cloud Studio projects. If no projects are accessible in the selected organization, none are listed.

To create a new Cloud Studio project, click New Project:

On clicking New Project, the project configuration screen opens. Two tabs are available, General and Deploy:

• General: Specify general information about the project, including the project name, environment, and description:

  

  • Project Name: Enter a name to use to identify the project. 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. If a project with the same name already exists in the Jitterbit Harmony cloud, go to the Management Console > Projects page to manage the deployed project.

  • Environment: Use the dropdown to select an existing environment where you want to create the project. Organization administrators can set up new environments through the Management Console > Environments page.

    NOTE: If you do not see a newly created environment available to select, refresh the project index page to force a reloading of environments.

  • Description: Enter an optional description for the project. This description will appear in the project index and may be useful to help project collaborators understand the project.

• Deploy: Configure project-level deployment settings, which are able to be set only by users with a combination of the organization role Admin permission and environment Write access (see Jitterbit Harmony Permissions and Access). For users without the appropriate role permission, this message is displayed: "There is no requirement provided by your organization."
  

  NOTE: These settings are not available to be configured at the organization level.

  

  • Require Comments When Deploying: Select to require that each time this project is deployed, a dialog is presented that requires a comment to be added.
  • Require Tags When Deploying: Select to require that each time this project is deployed, a dialog is presented that requires a tag to be added.
  • HTTP Validation Rule: Disabling this setting is not normally required. For more information see HTTP Validation Rule Errors in Operation Validity.

Click Start Designing to submit the new project information and proceed to the project designer:

This action stores the new project in Cloud Studio; however, note that the project is not yet deployed (see Project Deployment).

Opening an Existing Project

Existing projects are displayed in the project index filtered by environment. Use the Filter By dropdown to select a different environment for your selected organization:

Existing projects can be opened from either project card view or project list view. For details on all available options available in each of these views, see Project Index.

• Project Index Card View: Click the card view icon  to enter card view. Then hover over a project card and select View/Edit to open the project in the project designer:

  

• Project Index List View: Click the list view icon  to enter list view. Then hover over the empty cell in the column labeled with an actions menu icon  and click the edit icon  to open the project in the project designer:

  

Editing Project Settings

A project is first configured during project creation, covered earlier on this page. After a project is created, you can edit the project settings to make changes to the project name or description, or to export or delete the project.

The Project Settings option is accessible from these locations:

• The project index (see Card View or List View in Project Index).
• The project toolbar (see Project Actions Menu in Project Toolbar).

This opens the project configuration screen. Two tabs are available, General and Deploy:

• General: View general information about the project, and make changes to the project name or description:

  

  • Project Name: Edit the name used to identify the project. 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: When renaming a project that has previously been deployed, the new project name is automatically deployed and updated in Jitterbit Harmony. No other part of the project besides the name is automatically deployed.

  • Description: Edit the project description. This description will appear in the project index and may be useful to help project collaborators understand the project.

  • Environment: The environment that the project resides within (specified during project creation or migration).

  • Agent Group: The Agent Group associated with the environment that the project resides within (specified in the Management Console).
  • Created On: The date and time that the project was created.

• Deploy: Configure project-level deployment settings, which are able to be set only by users with a combination of the organization role Admin permission and environment Write access (see Jitterbit Harmony Permissions and Access). For users without the appropriate role permission, a message indicates what settings are enabled. (When no deployment settings are enabled, this message is displayed: "There is no requirement provided by your organization.")

  NOTE: These settings are not available to be configured at the organization level.

  

  • Require Comments When Deploying: Select to require that each time this project is deployed, a dialog is presented that requires a comment to be added.
  • Require Tags When Deploying: Select to require that each time this project is deployed, a dialog is presented that requires a tag to be added.
  • HTTP Validation Rule: Disabling this setting is not normally required. For more information see HTTP Validation Rule Errors in Operation Validity.

These buttons or links are available along the bottom of the project configuration screen:

• Save: Saves and closes the project configuration. This button will be enabled only after you have made changes to existing settings.

• Cancel: Closes the project configuration without saving.

• Export: Generates and initiates a download of a JSON file of the Cloud Studio project. A project export can be used, for example, as a project backup or to share a copy of the project. For details, see Project Exports and Imports.

• Delete: Permanently deletes the project from the environment in Cloud Studio and the Harmony cloud (see Deleting a Project later on this page).

Deleting a Project

Deleting a project permanently deletes the project from the environment in Cloud Studio and the Harmony cloud, including any deployed projects.

The Delete option is accessible from these locations:

• The project settings (see Editing Project Settings earlier on this page).
• The project index (see Card View or List View in Project Index).

On clicking Delete, a confirmation message asks you to confirm that you want to delete the project:

If the project you are attempting to delete has been migrated, it cannot be deleted until you first delete all projects farther down the migration chain (see Migration Chain in Project Migration). After clicking Continue in the Delete Project dialog, a second dialog indicates that the project cannot be deleted because it has dependent projects:

To resolve, first delete all projects farther down that migration chain, and then try to delete this project again.