This guide is intended for new users of Cloud Studio, Jitterbit's web-based project design application. This guide covers the basics of getting started by creating a new project from scratch and provides an overview of project design concepts.
For a comprehensive guide and step-by-step walkthrough, sign up for the Introduction to Jitterbit Harmony Cloud Studio on Jitterbit University. As part of this course, you can also reference the supplemental Lab Training Manual for Hands-On Modules covering a variety of use cases to help get you started.
Jitterbit Marketplace also provides hundreds of pre-built projects by offering Cloud Studio Integration Recipes and Cloud Studio Process Templates. To get started with an existing recipe or template, see Starting a Recipe or Template Project.
Accessing Cloud Studio
Cloud Studio is accessed directly through the Jitterbit Harmony Portal.
From the Harmony Portal landing page, click the Cloud Studio application card:
Cloud Studio opens on the project index, where you can create your first project, next.
Creating a Project
The project index shows a repository of all your Cloud Studio projects. The first time you access Cloud Studio, this screen is blank. Click New Project to get started:
Fill out basic information for your project and then click Start Designing to open the project designer, next.
Designing a Project
On opening a project, the project designer interface is displayed. This interface includes three parts: the project pane, design canvas, and design component palette, as shown in the example below for a project that has already been designed:
Generally, you design workflows — or collections of operations grouped for the convenience of the user — within the design canvas using the tools provided in the component palette, project pane, and on the design canvas itself.
The next sections walk through the basic design process:
- Establish Connectivity
- Create Operation Steps to Interact with Endpoints, Transform Data, or Use Scripts
- Chain Operations Together Using Operation Actions
- Deploy and Run Operations
The component palette provides access to connectivity resources. Here, connectors provide the interface entering user-provided input such as credentials to create a connection. Within the component palette, the Connectors filter shows the types of connectors that can be configured:
Each connector is represented by a folder with the connector icon, beneath which is the connector name. Click a connector to open a configuration screen to set up a new connection for access to a particular data resource:
For detailed instructions on completing the configuration, see each specific connection under Connectors. Each time you configure a new connection, you must do so from the connector blocks accessible in the Connectors filter.
The Endpoints filter shows the configured connections, which can be edited by double-clicking the connection in the palette:
Once a connection has been created, click it to reveal the types of activities — interactions with an endpoint — that can be configured for that connection. You can then drag the activities to operations on the design canvas where you configure them:
An endpoint refers to a specific connection and its activities. The activities are added to an operation and then configured as sources or targets within the operation. For reference, this diagram shows the relationship between connectors, connections, activities, and endpoints:
Create Operation Steps to Interact with Endpoints, Transform Data, or Use Scripts
Operations that define what the integration should do are created by adding and configuring operation steps, made up of activities, transformations, and/or scripts, on the design canvas.
To add activities, drag and drop them from the component palette to the component block (with a plus sign) on the canvas:
Then double-click the activity on the canvas or click it and select View/Edit to configure it as described for each specific activity under Connectors:
To add additional activities, drag them from the component palette to an operation on the canvas. A common configuration is to configure one activity as the source of data, and a second activity to its right as the target of data.
You may also want to add transformations or scripts to an operation. Transformations are used when you want to transform data prior to reaching its target. Scripts can be used within transformations on target fields and nodes to apply specified logic or conditions to the data. Scripts can also be used as optional steps within an operation for a variety of purposes, such as error handling or looping through data records.
To add transformations and scripts, hover to the left or right of the existing blocks and click the component block to open a menu with options to add a script or a transformation:
To rename operations, click the operation name and enter the new name:
Chain Operations Together Using Operation Actions
After more than one operation is created, you can configure operation actions to trigger other operations to run, send emails, or write messages to the log after an operation succeeds or fails.
To configure these actions, click the actions menu icon in the top right of an operation and select Settings:
On the Actions tab of the settings, select the condition that should trigger the action, what action should be taken, and any additional parameters such as what other operation should be configured to run. For details, see Operation Actions.
Once these actions are configured, lines appear on the design canvas to visually indicate any "on success" (green lines) and "on failure" (red lines) actions. An operation being kicked off based on operation actions is said to be downstream of an upstream operation before it.
Deploy and Run Operations
After you have developed a chain of operations, you can deploy it to the Harmony Agent and execute it. To deploy and run an operation, click the actions menu icon in the top right of an operation and select Deploy and Run:
Any operations that are downstream of the operation being deployed and executed are also included.
Instead of manual execution, you can also configure operations to run on a schedule or an API trigger. For more information, see Operation Deployment and Execution.
After the project is executed, you can validate proper behavior by viewing logs. To view logs for a particular operation and downstream operations, click the actions menu icon in the top right of an operation and select View Logs. For more information see Operation Logs.
While you design a project, refer to the in-depth information organized by topic under Cloud Studio:
- Projects: Learn basics about project permissions, collaboration, and saving, and about how to create, configure, deploy, migrate, export, import, and delete projects.
- Project Components: Browse information about what project components exist and what shared actions you can take with each component.
- Workflows: Find information about creating, deploying, and deleting workflows, dependencies, and what makes a workflow valid.
- Operations: Reference details on creating operations; configuring operation settings such as actions, options, and schedules; viewing operation logs; deploying and executing operations; viewing dependencies and deleting operations; and what makes an operation valid.
- Connectors: Refer to endpoint-specific documentation on configuring connections and activities to connect to and interact with a specific endpoint.
- Transformations: Read up on the basics and learn the intricacies of mapping data inputs to the desired target output.
- Schemas: Get introduced to the various types of schemas and learn how to tell when to use them.
- Scripts: Discover the flexibility and power of scripts to transform data, perform calculations, or perform logic validation within operations or transformations.
- Functions: Look up descriptions and examples of functions that are able to be used in scripts to enhance and refine data processes.
- Variables: Check out the different types of variables and how they can help you be more efficient in designing a project.
- Notifications: See how to customize email messages that can be triggered on success or failure of an operation or called from a script.
- Plugins: Educate yourself on how you can extend Harmony's native capabilities using Jitterbit- or user-provided plugins.
Last updated: Jan 13, 2021
- No labels