Endpoints Usage (Beta) page in Jitterbit Management Console

Introduction

In your license agreement with Jitterbit, an endpoint, also referred to as an application connection, is defined as each connection between the Harmony platform and either of the following:

1. A third-party application or data source, or
2. Any unique combination of system/IP addresses.

Endpoints include any third-party applications or data sources that are connected directly or indirectly to the platform.

To see which endpoints are currently being used in your Jitterbit Harmony projects, and to navigate to their point of use in Integration Studio, use the Management Console Endpoints Usage (Beta) page.

To open the page, open the Harmony portal menu, then select Management Console > Endpoints Usage (Beta).

The page consists of the following:

• A toolbar with filters and counts.

• A table of endpoints.

• An endpoint details drawer that opens when an endpoint is selected.

Prerequisites

To view endpoint usage data, you must be a member of a role with Admin permission in the organization.

Endpoint usage data appears only for operations that have been run within the past 12 months on agents version 11.49 or later.

Toolbar

The toolbar has the following:

• A search bar: Text entered here is highlighted wherever it appears in any column in the table.

• Usage for: To filter endpoints to those used during a selected month, open the menu, then select an option.

• Environment class: To filter endpoints by one or more environment classes, open the menu, then select any number of options.

• Total endpoints: How many endpoints match the current environment class filter setting.

Endpoints table

The endpoints table shows all unique endpoints used in an Integration Studio or Design Studio operation that has been run at least once within the past 12 months on agents version 11.49 or later. It is not limited to successful operations; operations with any final operation status, including failed operations, are displayed.

A separate entry is shown for each connector or function. If multiple entries share the same endpoint unique identifier, they count as only one licensed endpoint. In such cases, the number of rows may be greater than the count of Total endpoints displayed in the top right. For example, only one licensed endpoint is counted for each of these examples:

• If both the Integration Studio HTTP and HTTP v2 connectors are used to connect to the same endpoint with identical unique endpoint identifier information.
• If both the Integration Studio and Design Studio Microsoft Dynamics CRM connectors are used to connect to the same endpoint with identical unique endpoint identifier information.
• If both the Integration Studio Salesforce connector and the SalesforceLogin function are used to connect to the same endpoint with identical unique endpoint identifier information.

The following columns appear in the endpoints table:

• Connector or Function: The type of connector or function used to create the endpoint.

• Environment class: The environment class of the environment where the endpoint is used. Only endpoints in Production-class environments count toward your license.

• Endpoint unique identifier: The endpoint's unique identifier fields and their values that qualify the endpoint as a unique endpoint. Each endpoint unique identifier field is documented in the table at the end of this page.

  Sensitive information may be hidden or masked with asterisks (******). To reveal sensitive information in a tooltip, click and hold the Reveal icon.

• Last used: The date and time the endpoint was last used in an operation executed on an 11.49 or later agent within the past 12 months.

• Actions: Hover on an endpoint to reveal this action:

  • Details: Click to reveal the endpoint details drawer.

Endpoint details drawer

When you hover on an endpoint and click the Details icon, or click an endpoint, the endpoint details drawer opens:

The following items appear in the drawer's toolbar:

• The type of connector or function used to create the endpoint.

• The endpoint unique identifier and Reveal icon to reveal sensitive information.

• Previous: View the previous endpoint in the table.

• Next: View the next endpoint in the table.

• Expand: Expand the drawer to fill the browser window.

• Close: Close the drawer.

The following columns appear in the endpoints details drawer table:

• Environment: The environment where the endpoint is used.

• Environment class: The environment class of the environment where the endpoint is used.

• Endpoint name: For most endpoints created with a connector, the endpoint's user-configured name is displayed. For endpoints created with a function, the type is listed.

  For certain Design Studio endpoints, the user-configured name of the last activity to use that endpoint in the same operation is displayed. These include Web Service Method (SOAP) and the following sources and targets: Database, File Share, FTP Site, and HTTP.

  Known issue

  For a Design Studio Salesforce endpoint, the Endpoint Name column shows the User name value of the Salesforce Org, as it is not possible for a user to configure an endpoint name.

• Project: The project where the endpoint is used.

• Operation: The operation in which the endpoint is used.

• Last used: The date and time the endpoint was last used in the operation.

• Actions: Hover on an endpoint to reveal this action:

  • Go to endpoint: If the project is an Integration Studio project, click to open the endpoint's configuration in Integration Studio.

Table features

You can sort table entries, and resize column widths:

• To sort a table in ascending order, click a column heading. Click again to reverse the sort order.

• To resize a column, drag a column's Resize bar.

Endpoint unique identifier fields

The tables below list the fields that make an endpoint unique for Integration Studio connectors, Design Studio connectors, and Functions. Note the following for these table columns:

Endpoint unique identifier fields

• When "and" is included, a unique combination of these fields' values together constitutes a unique endpoint.
• When "or" is included, a unique value in any individual field constitutes a unique endpoint.
• A dash (—) denotes that the connector does not count toward endpoint usage.

License class

• A connector's license class is either Standard or Enterprise.

Usage reporting

• A denotes that the identifier fields are active and their usage is currently reported.
• A denotes that the identifier fields are currently inactive and their usage is not currently reported. The usage of these endpoints still counts toward licensing, and Jitterbit intends to add reporting for these fields in the future.
• A dash (—) denotes that the connector does not count toward endpoint usage.
• Custom connectors created by you or a third party, such as a Jitterbit partner, do not currently have reported endpoint usage.

Integration Studio connectors

The endpoint unique identifier fields for each Integration Studio connector are provided below.

Design Studio connectors

The endpoint unique identifier fields for each Design Studio connector (also referred to as an endpoint, org, source, target, connect wizard, or recipe in the Design Studio UI) include these:

Functions

The following functions, supported in both Integration Studio and Design Studio, have parameters or defaults that are considered endpoint unique identifier fields: