Reuse project components in Jitterbit Integration Studio

Introduction

This page describes how to reuse project components that are used as operation steps or in support of operations.

This page is organized into these sections:

• Component reuse terminology
  This section defines the terminology used to discuss component reuse. A recognition of the difference between independent components and references to those components forms the basis needed for understanding the related UI terms:
  • Duplicating a component to create a copy
  • Referencing an existing component
  • Cutting or copying components to place them on your clipboard
  • Pasting as a new component or as a reference depending on the context
• Cut and copy components
  This section describes the various places from which you can cut and copy components. Cutting a component also deletes the component or its reference from the project, depending on where it was cut from.
• Create a new component from an existing component
  This section describes the various ways in which you can create a new component from an existing component. Typically, this is done by duplicating an existing component or by cutting/copying and pasting to designated locations. Certain types of activities (Salesforce, Salesforce Service Cloud, and ServiceMax activities) always result in a new component when pasted, as reusing more than one of the same instance of these activity types is not allowed.
• Creating an activity instance
  This section describes the various ways in which you can create an activity instance as a new, independent component. This is done by dragging and dropping or by cutting/copying and pasting to designated locations.
• Create a component reference
  This section describes the various ways in which you can reference components. Certain components can be used as operation steps, while other types of components can be used in support of operations. Most of these component types can be referenced multiple times.

Details about referencing a transformation that uses a schema inherited from an activity are provided as a supplement to this page in Transformation reuse.

Reusing operations themselves is covered in Operation reuse.

Component reuse terminology

Project components as they appear in the Integration Studio UI may be either independent components or component references:

• Independent components are the discrete building blocks of a project and are contained in the project pane's Components tab. Independent components are the components in the project.
• Component references refer back to the independent components. Component references in project workflows are contained in the design canvas and in the project pane's Workflows tab. Components may also be referenced by components that are not part of any workflows.

An independent component can be reused in a project in two ways:

• Duplicating is using an existing component's configuration to create a new, independent component in a project. After you duplicate a component, any changes you make to the original independent component will not be reflected in the copy, and any changes you make to the copy will not affect the original independent component. When you duplicate a component, a new component appears in the project pane's Components tab and is an independent component in the project. A component can also be pasted between projects open in the same browser session.
• Referencing is using the same component more than once in a project and is the way you build project workflows. A component reference in a workflow is an operation, activity, transformation, script, or email notification that is visually represented on the design canvas and appears in the project pane's Workflows tab (except for email notifications). Component references can also be in other components, which may or may not be in project workflows. For example, a project variable may be referenced in the configuration of an activity used as an operation step in a project workflow, and may also be referenced in a script that itself is unreferenced by any project workflows. When you reference a component in or outside of project workflows, the reference count of the component in the project pane's Components tab is increased.

The word copy, as a noun, is used to describe a a new, independent component that has been created from an existing component.

The words cutting and copying, as actions, both place a copy of a component on your clipboard that is then used to create either an independent component or a component reference. Which of these two is created depends on the context when pasting:

• Cutting places a copy of a component on your clipboard and deletes either the original independent component or the component reference, depending on where the component was cut from:
  • If a component is cut from the project pane's Components tab, the original independent component is deleted.
  • If a component is cut from the design canvas or the project pane's Workflows tab, as the component is a reference to an original independent component, only the reference is deleted and the original independent component is left unchanged.
• Copying places a copy of a component or activity type on your clipboard. The original independent component is left unchanged. Copying and then pasting a component may result in either a new independent component or a component reference, depending on the context when pasting.
• Pasting creates either an independent component or a component reference, depending on the context when pasting. For example:
  • Pasting a component or activity type in the project pane's Components tab creates a new, independent component. Pasting an activity type creates an activity instance as a new, independent component.
  • Pasting a component in the design canvas adds a reference to the original independent component in the project workflow. (An exception: Pasting a Salesforce, Salesforce Service Cloud, or ServiceMax activity in the design canvas creates a new, independent component rather than a component reference.)
  • Pasting an activity type in the design canvas or the project pane's Workflows tab creates an activity instance as a new, independent component and adds a reference to that activity in the project workflow.

Cut and copy components

You can access the Cut and Copy menu actions from a component or activity type's actions menu in any of these places:

• Independent components in the project pane's Components tab (see Component actions menu in Project pane Components tab).
• Component references in the design canvas (see Component actions menu in Design canvas).
• Component references in the project pane's Workflows tab (see Component actions menu in Project pane Workflows tab).
• Activity types in the design component palette's Project endpoints and connectors tab (see Connection actions menu and Activity type actions menu in Design component palette).

You can also use the standard keyboard shortcuts for cut (Control+X on Windows or Linux and Command+X on macOS) and copy (Control+C on Windows or Linux and Command+C on macOS).

Cutting and copying components both place a copy of a component on your clipboard. Activity types can also be copied from the design component palette; the copy on the clipboard will be used to create a new component in the project (an activity instance).

Cutting an independent component from the project (from the project pane's Components tab) deletes the original independent component from the project. As deletion is required, cutting a component is possible only on unreferenced components. The standard dialogs for deletion are displayed as documented in Component dependencies, deletion, and removal.

Cutting a component reference from a project workflow (from the design canvas or the project pane's Workflows tab) deletes the component reference only. The original independent component is left unchanged.

Create a new component from an existing component

Creating a new, independent component from an existing, independent component is available for schemas, activities, scripts, transformations, project variables, email notifications, and schedules.

You can create a new component from these existing components by using a combination of the menu actions Cut or Copy (see Copying and cutting components above) and Paste (see Paste below) (or their keyboard shortcuts) or by using the Duplicate menu action (see Duplicate below). There are additional ways to create new Salesforce, Salesforce Service Cloud, and ServiceMax activities (see Salesforce, Salesforce Service Cloud, and ServiceMax activities below).

The default name of the new component uses the name of the original independent component appended with - Copy. Subsequent copies are further appended with an incremented number in parentheses. As project variable names cannot have spaces, hyphens, or parentheses, the default name of a duplicated project variable uses no parentheses and uses an underscore instead of the spaces and hyphen.

Paste

Once you have a copy of a component on your clipboard, you can paste it in the same project using the current browser application or browser mode where you copied it from.

A component (except for those noted below) can also be pasted between projects open in the same browser session. When pasting activities between projects, a new endpoint will be created the first time the activity is pasted. Subsequent pastes to the same project will be connected to the existing endpoint.

Cut or copy a component, and then use the Paste menu action from the component palette's actions menu in the project pane's Components tab (see Components tab actions menu in Project pane Components tab). This action is available in the Files, Endpoints, Scripts, Transformations, Project Variables, Emails, and Schedules categories, and is enabled only when you have a component of the corresponding type on your clipboard.

On creating the new component, your cursor is positioned on the component name for renaming.

Duplicate

You can access the Duplicate menu action for a component in the project from a component's actions menu in the project pane's Components tab (see Component actions menu in Project pane Components tab).

On clicking Duplicate, a new, unreferenced, independent component is created using the same configuration as the original independent component.

Salesforce, Salesforce Service Cloud, and ServiceMax activities

For Salesforce, Salesforce Service Cloud, and ServiceMax activities, you can also paste the activity on the design canvas to create a new, independent component in one of these ways:

• Select a drop zone on the design canvas, and then use its Paste menu action (see Drop zone actions menu in Design canvas) to create an activity instance in the project and add a reference to that activity instance in the project workflow.
• Select a drop zone on the design canvas, and then use the keyboard shortcut Control+V (Windows or Linux) or Command+V (macOS) to create an activity instance in the project and add a reference to that activity instance in the project workflow.

You can also drag an existing Salesforce, Salesforce Service Cloud, or ServiceMax activity from the project pane's Components tab to a component drop zone on the design canvas.

When placing the activity on the design canvas, a dialog indicates that a new, independent component will be created:

Create an activity instance

You can create an activity instance as a new, independent component by dragging and dropping (see Drag and drop below) or by using a combination of the Copy (see Cutting and and cutting components above) and Paste menu actions (see Paste below) or their keyboard shortcuts.

Drag and drop

Drag an activity type from the design component palette's Project Endpoints and Connectors or Global endpoints tabs to an operation on the design canvas:

Paste

When you copy an activity type, the copy is used to create a new, independent component in the project (an activity instance).

Once you have copied the activity type, you can paste it in the same project using the current browser application or browser mode where you copied it from. Pasting activity types between projects and browser modes is not supported.

Copy an activity type and then paste it — creating an activity instance as an independent component — in one of these ways:

• Use the Paste Activity menu action accessible from the Components tab actions menu in the project pane's Components tab (see Components tab actions menu in Project pane Components tab) to create an activity instance in the project.
• Select a drop zone on the design canvas, and then use its Paste menu action (see Drop zone actions menu in Design canvas) to create an activity instance in the project and add a reference to that activity instance in the project workflow.
• Select a drop zone on the design canvas, and then use the keyboard shortcut Control+V (Windows or Linux) or Command+V (macOS) to create an activity instance in the project and add a reference to that activity instance in the project workflow.

Create a component reference

Certain types of components can be used as operation steps, including activities, scripts, and transformations. Other types of components can be used in support of operations. Most of these component types can be referenced multiple times, as covered below.

Components used as operation steps

Certain types of activities, transformations, and scripts can be referenced multiple times as steps in an operation:

• Activities: Most activities can be referenced multiple times as operation steps. Exceptions include Salesforce, Salesforce Service Cloud, and ServiceMax activities, which cannot be referenced by more than one component. Instead, you can make a copy of a Salesforce, Salesforce Service Cloud, or ServiceMax activity to use elsewhere.
• Transformations: All transformations can be referenced multiple times as operation steps. When referencing a transformation using a schema inherited from an activity, the order in which an operation's steps are configured controls how schemas are propagated across transformation references, as described in Transformation reuse.
• Scripts: All project component scripts can be referenced multiple times as operation steps.

You can create a reference to one of these types of components as an operation step by dragging and dropping or by using a combination of the Cut or Copy and Paste menu actions or their keyboard shortcuts.

Drag and drop

Drag the component from the project pane's Components tab to an operation on the design canvas:

Paste

Once you have a copy of a component on your clipboard, you can paste it in the same project using the current browser application or browser mode where you copied it from. Pasting component references between projects and browser modes is not supported.

Cut or copy a component, select a drop zone on the design canvas, and then paste the component in one of these ways:

• Use the Paste menu action accessible from the drop zone action's menu on the design canvas (see Drop zone actions menu in Design canvas).
• Use the keyboard shortcut Control+V (Windows or Linux) or Command+V (macOS).

Components used in support of an operation

Most components that are not able to be used as steps in an operation may be able to reused or referenced in other ways. Component reuse in support of operations is covered in the documentation for each component:

• Endpoints: Endpoints in Jitterbit Script, for using certain types of existing connections and activities as arguments with Jitterbit functions
• Notifications: Email notifications, for linking an existing email message in multiple operation chains
• Operations: Operations in Jitterbit Script, for using existing operations as arguments with Jitterbit functions
• Schedules: Operation schedules, for applying existing schedules to multiple operations
• Schemas: Sample file schema, for selecting a saved schema during schema definition
• Scripts: Scripts in Jitterbit Script, for using existing scripts as arguments with Jitterbit functions
• Variables: Variables, for referencing variables that can be read any number of times

View the number of component references

Component references are counted and displayed within the project pane's Components tab.

If a component is not referenced by any of the operations inside a project's workflows, it is known as an unused component. Unused components are displayed with an unreferenced icon next to the component name.

For example, these two new scripts are not referenced by any workflow operations:

If a component is referenced only once on the design canvas, it is displayed in the project pane without any visual indicator next to the component name.

For example, these scripts are each used within a single workflow operation:

If a component is referenced multiple times on the design canvas, including within other components used on the design canvas, the number of times it is referenced by is displayed in a badge next to the component name.

In this example, the first script is referenced both within a workflow operation as well as by another script within a workflow operation, and the second script is referenced by one additional script within a workflow operation:

This count is not necessarily the number of times the component is referenced; if a component is referenced multiple times by another component, this counts as a single reference. For example:

• A project variable that is referenced several times within a script counts as having been referenced only a single time.
• A project variable that is referenced several times within an activity configuration counts as having been referenced only a single time.