Skip to end of metadata
Go to start of metadata

Introduction

The project pane's Components tab is one of two tabs accessible in the project pane. (The other tab is the Workflows tab.)

The Components tab displays all of the components in the open project grouped by component category.

Component Categories

Each of these top-level categories is displayed, regardless of whether it contains any components:

  • Custom Groups: Custom groups are an organizational tool to help organize project components (see Component Groups). After creating a custom group, its user-defined name is displayed as a subcategory under Custom Groups. Under each custom group, any components contained within the custom group are listed.
  • Files: All file schemas are listed (see Schemas).
  • Endpoints: An endpoint refers to a specific connection and its activities, created using connectors (see Connectors).

    After creating an activity instance associated with a connection, the endpoint type is displayed as a subcategory under Endpoints, followed by the number of endpoints of that type in parentheses. For example, Database Endpoints (2). Connections are not displayed or counted unless at least one activity has been created from them.

    The user-defined connection name is displayed as an additional subcategory under the endpoint type, followed by the number of activity instances that have been created from each connection in parentheses. For example, Oracle (4).

    Under each connection, the name of each activity instance is preceded by square brackets containing the type of interaction with the data resource that is specific to the activity type. On the same line, this is followed by the user-defined activity name. For example, [Database_Insert] Insert Customers.

  • Operations: All operations are listed (see Operations).
  • Scripts: All project component scripts are listed (see Scripts). Scripts created on target fields or nodes in a transformation are not project components, as they are considered part of the transformation component.
  • Transformations: All transformations are listed (see Transformations).
  • Project Variables: All project variables are listed (see Project Variables).
  • Global Variables: All global variables are listed (see Global Variables).
  • Emails: All email notifications are listed (see Email Notifications).
  • Schedules: All operation schedules are listed (see Operation Schedules).

Searching and Filtering

Along the top of the Components tab, you can search and filter components to limit those displayed in this tab.

Searching

To search within the Components tab, use the search box to enter a single keyword or keyword string. The categories are automatically expanded to show components where the keyword string appears. The keyword string becomes bold and purple within the name of the component:

To clear the search, click the remove icon .

Filtering

To filter by project component, use the filter icon  dropdown to select from one of these filter options:

  • All: Show all components in the current project.
  • Undeployed: Show only components in the current project that have not yet been deployed or have been modified after they have been deployed.
  • Orphaned: Show only components that are not referenced by other components or workflows in the current project. Orphaned components are displayed with an unreferenced (broken link) icon  regardless of whether this filter is selected. Orphaned components are also referred to as unreferenced or unused components.

    NOTE: The orphaned classification is based on the project as it currently exists in the Cloud Studio project designer and doesn't take into account whether components have been deployed to Harmony.
  • Invalid: Show only components in the current project that are invalid. Invalid components are not able to be deployed. Validation criteria are described in Component Validity. This filter may be useful to identify invalid components that are also orphaned in case you want to delete the unreferenced component instead of resolving errors.

Once a filter is applied, a filter label is displayed below the filter icon:

To return to the All view, click the remove icon  next to the filter label.

Expanding and Selecting Items

To expand or collapse all categories at once, double-click the category name or the disclosure triangles   next to the category. To expand or collapse individual categories, use a single click.

As you work on projects, Cloud Studio remembers the display states that a given user was last using for a given project, including whether the categories in the project pane are expanded or collapsed.

When a category is expanded, click a component within the category to select it. A selected component is displayed with a gray background:

If the component is also referenced on the design canvas, the first instance of it is scrolled into view.

Categories themselves cannot be selected.

Viewing Validity Errors and References

Visual indications of component validity and the number of other components that reference a component are displayed as described below.

Validity Errors

When using the Highlight Invalid Items option on the design canvas or when filtering on Invalid items, an error icon  is displayed next to invalid components, whose names appear in italics and the color red:

You can view the validation errors associated with invalid components as described in Component Validity and Operation Validity.

References

A component can be referenced by other components or workflows throughout the project.

The number of components that reference the component is indicated by the presence or absence of icons to the left of the component name:

  • A component that is not referenced by any other components or workflows in the project is known as an orphaned component, and is displayed with an unreferenced (broken link) icon .
  • A component that is referenced by only one other component or workflow is displayed without any visual indicator.
  • A component that is referenced by multiple components — or an operation that is referenced by component(s) and a workflow, or by multiple components — has the number of components it is referenced by displayed inside a circle .

Further details are provided in Component Reuse and Operation Reuse.

Actions Menus

To open a menu of actions to take on each component category or component, do one of these:

  • Right-click the category or component.
  • Hover over the category or component, and then click the actions menu icon .

The actions available in each menu depend on the context and vary according to the category or component.

NOTE: The Custom Groups category and components displayed within them are covered in Component Groups.

Category Actions Menu

Some actions are available only on certain categories, as detailed below. The images below display the actions menus for the Scripts category (left image) and for the Endpoints category (right image):

Scripts Category Actions Menu

Endpoints Category Actions Menu


Menu ItemDescription

Create New creates a new, unreferenced component of the respective type in the category.

This action is available on the categories Scripts, TransformationsProject Variables, Emails, and Schedules.

On creating the component, the component configuration screen opens for you to configure the component.

Paste Component Type: Places the cut or copied component that is on your clipboard, thereby creating a duplicate of the component as a new, unreferenced component (see Component Reuse).

This action is available on Files, Endpoints, Operations, Scripts, Transformations, Project Variables, Emails, and Schedules. It is enabled only when you have a component of the corresponding type on your clipboard.

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

Delete Unused permanently deletes components in the category that aren't referenced by any other components in the current project (see Component Dependencies, Deletion, and Removal).

This action is available on Files, Endpoints, Operations, Scripts, Transformations, Project Variables, Global VariablesEmails, and Schedules. It is enabled only when the category contains unreferenced components, displayed with an unreferenced (broken link) icon .

Component Actions Menu

Some actions are available only on certain types of components, as detailed in the subsections below:

  • OperationsThe actions menu for operations (shown in the left image) has unique items such as Settings, Run, and View Logs and unique sub-menus for Duplicate and Deploy. It also includes common actions such as Cut, Copy, Rename, View Dependencies, Add to Group, Delete, and Remove.
  • Files, Activities, Scripts, Transformations, Project Variables, Global Variables, Emails, and SchedulesThe actions menus for these components share many of the same actions, such as View/Edit, Cut, Copy, Duplicate, Deploy, Rename, View Dependencies, Add to Group, Delete, and Remove. A script's actions menu (shown in the middle image) shows all available actions. Some of these actions are not available on all components, as described in this section.
  • ConnectionsThe actions menu for a connection (shown in the right image) has the View/Edit and Test actions.

Operation Actions Menu

Script Actions Menu

Connection Actions Menu


Operations

These items are available in an operation's actions menu:

Menu ItemDescription

Settings opens the operation settings, containing three tabs:

  • Schedules: Create and apply schedules to automatically run operations (see Operation Schedules).
  • Actions: Configure actions to take on success or failure of the operation (see Operation Actions).
  • Options: Set options such as when the operation will time out, what to log and the timeframe for logging, when the operation will run, or whether to use chunking (see Operation Options).

Cut places a copy of the operation on your clipboard and deletes the original operation from the project (see Operation Reuse).

Copy places a copy of the operation on your clipboard (see Operation Reuse).


Duplicate shows these menu actions (see Operation Reuse):

  • With Step References: Duplicates the operation only. The duplicate operation contains references to each of the original operation steps. 
  • With Step Copies: Duplicates the operation and components referenced as operation steps. New components are created for each operation step and are referenced by the duplicated operation.

Deploy shows these menu actions:

Run runs an already-deployed operation and any downstream (linked) operations (see Operation Deployment and Execution).

View Logs opens the operation log screen, which includes logs for this operation and any child operations that have been deployed and executed (see Operation Logs).

Rename positions the cursor on the operation name for you to make any edits as necessary.

View Dependencies changes the view in the project pane to display any other parts of the project that the specific operation is dependent on (see Operation Dependencies, Deletion, and Removal).

Add to Group opens a dialog to create a new custom group or to add the component to an existing group (see Component Groups).

Delete permanently deletes the component (see Operation Dependencies, Deletion, and Removal).

Remove removes references to the component from the design canvas. This action is functional only when used on an operation that is in a workflow (see Operation Dependencies, Deletion, and Removal).

Files, Activities, Scripts, Transformations, Project Variables, Global Variables, Emails, and Schedules

The actions menus for these components share many of the same actions:

Menu ItemDescription

View/Edit opens the configuration screen for activities listed in an endpoint type subcategory under Endpoints, and components in the Scripts, Transformations, Project VariablesEmails, and Schedules categories. (This action is not available for components in the Files or Global Variables categories.)

The component configuration screen can also be opened by double-clicking a component name.

For details on configuration, refer to the respective component under Connectors, Scripts, Project Variables, Transformations, Notifications, or Operation Schedules.

Cut places a copy of the component on your clipboard and deletes the original component from the project (see Component Reuse). This action is available for activities listed in an endpoint type subcategory under Endpoints, and components in the Files, Scripts, Transformations, Project VariablesEmails, and Schedules categories. (This action is not available in the Global Variables category.)

Copy places a copy of the component on your clipboard (see Component Reuse). This action is available for activities listed in an endpoint type subcategory under Endpoints, and components in the Files, Scripts, Transformations, Project VariablesEmails, and Schedules categories. (This action is not available in the Global Variables category.)

Duplicate creates a new, unreferenced component using the same configuration as the original component (see Component Reuse). This action is available for activities listed in an endpoint type subcategory under Endpoints, and components in the Scripts, Project VariablesEmails, and Schedules categories. (This action is not available for components in the Files, Transformations, or Global Variables categories.)

Deploy shows these menu actions:

  • Deploy: Deploys the component and any components it is dependent on (see Component Deployment).
  • Configurable Deploy: Opens the deployment screen, where you can select components to deploy (see Component Deployment).

Rename positions the cursor on the component name for you to make any edits as necessary. This action is available for activities listed in an endpoint type subcategory under Endpoints, and components in the FilesScripts, Transformations, Project VariablesEmails, and Schedules categories. (This action is not available in the Global Variables category.)

View Dependencies changes the view in the project pane to display any other parts of the project that the specific component is dependent on (see Component Dependencies, Deletion, and Removal).

Add to Group opens a dialog to create a new custom group or to add the component to an existing group (see Component Groups).

Delete permanently deletes the component (see Component Dependencies, Deletion, and Removal). This action is available for activities listed in an endpoint type subcategory under Endpoints, and components in the Files, Scripts, Transformations, Project VariablesEmails, and Schedules categories. (This action is not available in the Global Variables category.)

Remove removes references to the component from the design canvas. This action is available for activities listed in an endpoint type subcategory under Endpoints, and components in the Scripts, Transformations, Project VariablesEmails, and Schedules categories. (This action is not available for components in the Files or Global Variables categories.) It is functional only when used on an activity, transformation, or script that is referenced as a step in an operation, or when used on an email notification that is configured with an operation action (see Component Dependencies, Deletion, and Removal).

Connections

Connections are listed in an endpoint type subcategory under Endpoints. The actions menu for a connection has the View/Edit and Test actions:

Menu ItemDescription

View/Edit opens the configuration screen for the connection (see documentation on the specific endpoint connection under Connectors).

Test tests the connection. This action is the same as clicking the Test button available in a connection configuration screen (see documentation on the specific endpoint connection under Connectors).

  • No labels