Endpoints Usage (Beta) page in Jitterbit Management Console
Overview
| Purpose | View endpoint usage data for operations that have been run within the past 12 months (on agents version 11.49 or later) |
| Location | Harmony portal menu > Management Console > Endpoint Usage (Beta) |
| Page access | Users with Admin role permission |
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:
- A third-party application or data source, or
- 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.
Note
To provide feedback on this beta feature, contact the Jitterbit Product Team.
The page consists of the following:
-
A toolbar with filters and counts.
-
An endpoint details drawer that opens when an endpoint is selected.
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.
Tip
To see how many endpoints are currently being counted toward your licensed usage in a selected month, filter by the Production environment class. A count for the current month is also displayed in the Dashboard page's Licensed vs Actual Use tile.
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
SalesforceLoginfunction are used to connect to the same endpoint with identical unique endpoint identifier information.
Note
It may take up to 1 hour for newly used endpoints to appear in this table.
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. Enterprise connectors are available as an add-on to your Harmony iPaaS subscription. To enable them, contact your Customer Success Manager.
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.
| Connector name | Endpoint unique identifier fields | License class | Usage reporting |
|---|---|---|---|
| Act! CRM | Combination of URL and Act database | Standard | |
| Act-On | OAuth client ID | Standard | |
| Active Campaign | URL | Standard | |
| Active Directory | Server | Standard | |
| Active Directory v2 | Server | Standard | |
| Acumatica | URL | Standard | |
| Acumatica v2 | URL | Standard | |
| Adobe Analytics | Global company ID | Standard | |
| ADP | OAuth client ID | Standard | |
| Airtable | Base ID | Standard | |
| Algonomy Personalization | Client ID | Standard | |
| Amazon Athena | S3 staging directory | Standard | |
| Amazon Bedrock (Beta) | Combination of Access key ID and Region | Standard | |
| Amazon Dynamo DB | AWS access key | Standard | |
| Amazon Lambda (Beta) | Combination of Access key ID and Region | Standard | |
| Amazon Marketplace | Combination of Seller ID and Use Sandbox | Standard | |
| Amazon Marketplace v2 | Seller ID | Standard | |
| Amazon Redshift | Combination of Amazon Redshift endpoint and Database name | Standard | |
| Amazon S3 | Combination of Access key ID and Region | Standard | |
| Amazon SQS | Combination of Access key ID and Region | Standard | |
| ANYMARKET | Token | Standard | |
| Apache Cassandra | Combination of Server and Database | Standard | |
| Apache CouchDB | URL | Standard | |
| Apache Kafka | Bootstrap servers | Standard | |
| Apache Parquet | URI | Standard | |
| API | — | Standard | — |
| Asana | Workspace ID | Standard | |
| Authorize.net | Combination of Login ID and Use Sandbox | Standard | |
| Authorize.net v2 | Combination of Login ID and Use Sandbox | Standard | |
| Avalara | User (Basic auth) or Account ID (License key auth) | Standard | |
| Avro | URI | Standard | |
| Azure Analysis Services | URL | Standard | |
| Azure Cosmos DB | Account endpoint | Standard | |
| Azure Data Catalog | Catalog name | Standard | |
| Azure Data Lake Storage | Account | Standard | |
| Azure OpenAI | Endpoint | Standard | |
| Azure Synapse Analytics | Combination of Server and Database | Standard | |
| Basecamp | Account ID | Standard | |
| BigCommerce | Store hash | Standard | |
| Blackbaud Raiser's Edge NXT | Subscription key | Standard | |
| BMC Helix Business Workflows | Host | Standard | |
| BMC Helix for CSP | Host | Standard | |
| BMC Helix ITSM | Host URL | Standard | |
| BMC Helix Operations Management | Server URL | Standard | |
| Box | Client ID | Standard | |
| Bullhorn CRM | Combination of Data center code and REST URL | Standard | |
| Cherwell | Host name | Standard | |
| Cloud Datastore (Beta) | — | Standard | — |
| Cloud Firestore | Project ID | Standard | |
| CockroachDB | Combination of Server and Database | Standard | |
| Confluence | URL | Standard | |
| Constant Contact | API key | Standard | |
| Correios | Correios user name | Standard | |
| Couchbase | Server | Standard | |
| Coupa | Host name | Standard | |
| Database | Combination of Server name and Database name Known issue When a Database endpoint is configured with a driver installed on private agents and the server name and database name are provided within the endpoint's Connection String field, its Endpoint unique identifier information does not display the values of the | Standard | |
| DocuSign | Combination of Integration key (Client ID) and OAuth base URL path | Standard | |
| Dynamics 365 Business Central | Combination of Organization URL and Use Sandbox | Standard | |
| Dynamics 365 Finance and Operations | Organization URL | Standard | |
| Dynamics GP | Combination of URL and Company ID | Standard | |
| Dynamics NAV | Combination of URL and Server instance | Standard | |
| Dynamics NAV v2 | Combination of URL and Server instance | Standard | |
| eBay | Combination of Ru name and Site ID and Use Sandbox | Standard | |
| eBay Analytics | Ru name | Standard | |
| EDI for Cloud | — | Standard | — |
| EDI for Cloud v2 | — | Standard | — |
| Elasticsearch | Host | Standard | |
| SMTP host or IMAP host or Host | Standard | ||
| EnterpriseDB | Combination of Server and Database | Standard | |
| Epay | Combination of User and Environment | Standard | |
| Epicor Kinetic | Combination of Server host name and Server instance | Standard | |
| Epicor Prophet 21 | Host | Standard | |
| Evernote | Combination of Enter developer token and Select service (Sandbox/Production) | Standard | |
| Exact Online | Combination of Region and Division | Standard | |
| File Share | Path | Standard | |
| Financial Edge NXT | Subscription key | Standard | |
| Freshdesk | Domain | Standard | |
| FTP | Combination of Host and Security options | Standard | |
| GitHub | GitHub personal access token | Standard | |
| Google Ad Manager | Network code | Standard | |
| Google Ads | Client customer ID | Standard | |
| Google BigQuery | Project ID | Standard | |
| Google Campaign Manager 360 | Profile ID | Standard | |
| Google Cloud Storage | Project ID | Standard | |
| Google Data Catalog | Combination of Organization ID and Project ID | Standard | |
| Google Directory | OAuth client ID | Standard | |
| Google Docs | Project ID | Standard | |
| Google Drive | Project ID | Standard | |
| Google Pub Sub | Project ID | Standard | |
| Google Search | Custom search ID | Standard | |
| Google Sheets | Project ID | Standard | |
| Google Spanner | Project ID | Standard | |
| GraphQL | URL | Standard | |
| GraphQL v2 | URL | Standard | |
| Greenplum | Combination of Server and Database | Standard | |
| Gzip | — | Standard | — |
| HDFS | Combination of Host and Path | Standard | |
| HTTP | Fully qualified domain name (FQDN) inferred from the Base URL field | Standard | |
| HTTP v2 | Fully qualified domain name (FQDN) inferred from the Base URL field | Standard | |
| HubSpot | Access token (OAuth 2.0 auth) or API key (API key auth) | Standard | |
| IBM Cloud Data Engine | Cloud object storage CRN | Standard | |
| IBM Cloud Object Storage | Cloud object storage CRN | Standard | |
| IBM Cloudant | URL | Standard | |
| IBM DB2 | Combination of Server and Database | Standard | |
| IBM Informix | Combination of Server and Database | Standard | |
| Business account ID | Standard | ||
| Intelipost | API key | Standard | |
| Jenkins | Host | Standard | |
| Jira | Hostname | Standard | |
| OAuth application | Standard | ||
| Jira Service Management | URL | Standard | |
| Jira Service Management v2 | URL | Standard | |
| Jitterbit MQ | — | Standard | — |
| JMS | Provider URL | Standard | |
| JWT | — | Standard | — |
| Kintone | URL | Standard | |
| LDAP | Hostname | Standard | |
| Linio | URL for API calls | Standard | |
| Local Storage | — | Standard | — |
| Magazine Luiza Companies | Combination of Token and Environment | Standard | |
| Magazine Luiza Shopping | Combination of API token and Environment | Standard | |
| Magento | Magento host | Standard | |
| MailChimp | API key (API key auth) or OAuth client ID (OAuth auth) | Standard | |
| Marketo | REST endpoint (REST) or SOAP endpoint (SOAP) | Standard | |
| MarkLogic | Combination of Server and Database | Standard | |
| Microsoft Access | Data source | Standard | |
| Microsoft Advertising | Account ID | Standard | |
| Microsoft Azure Files (Beta) | Storage account name | Standard | |
| Microsoft Azure Key Vault | Tenant ID | Standard | |
| Microsoft Azure Service Bus | Namespace/Hostname | Standard | |
| Microsoft Azure Table Storage | Account | Standard | |
| Microsoft Azure Table Storage v2 | Account | Standard | |
| Microsoft Bing | API key | Standard | |
| Microsoft Dataverse | Organization URL | Standard | |
| Microsoft Dataverse v2 | Organization URL | Standard | |
| Microsoft Dynamics 365 | Organization URL | Standard | |
| Microsoft Dynamics 365 Business Central v2 | Combination of Tenant ID and Environment name | Standard | |
| Microsoft Dynamics AX | Combination of Service URL and Domain name | Standard | |
| Microsoft Dynamics CRM | Combination of Organization service URL and Domain name | Standard | |
| Microsoft Entra ID | Combination of Host and Tenant-ID | Standard | |
| Microsoft Excel | URI | Standard | |
| Microsoft Excel v2 | URI | Standard | |
| Microsoft Excel Online | Combination of Workbook and Drive and Use Sandbox | Standard | |
| Microsoft Exchange | Server | Standard | |
| Microsoft Exchange v2 | Azure tenant | Standard | |
| Microsoft Office 365 | OAuth client ID | Standard | |
| Microsoft OneDrive | Azure tenant | Standard | |
| Microsoft OneNote | Azure tenant | Standard | |
| Microsoft Planner | Azure tenant | Standard | |
| Microsoft Power BI XMLA | Azure tenant | Standard | |
| Microsoft Project | URL | Standard | |
| Microsoft SharePoint 365 | Office 365 tenant URL | Standard | |
| Microsoft SharePoint Server | URL | Standard | |
| Microsoft SSAS | URL | Standard | |
| Microsoft Teams | Tenant ID | Standard | |
| Mirakl | Combination of Instance name and Environment | Standard | |
| monday.com | API token (Token) or OAuth client ID (OAuth) | Standard | |
| MongoDB | Combination of Host and Database (Form), or Inferred host and database (Connection String) | Standard | |
| MYOB | Company file ID | Standard | |
| Neo4j | Combination of Server and Database | Standard | |
| NetSuite | Account | Standard | |
| OData | OData metadata URL | Standard | |
| Odoo | URL | Standard | |
| Odoo v2 | URL | Standard | |
| OpenAI | API/Secret key | Standard | |
| Oracle Commerce Cloud | Endpoint | Standard | |
| Oracle Eloqua | Company (Basic) or OAuth client ID (OAuth) | Standard | |
| Oracle Sales Cloud | Host URL | Standard | |
| Oracle Service Cloud | URL | Standard | |
| PagerDuty | Combination of API token and Email (API token auth), or Subdomain (OAuth auth) | Standard | |
| Paylocity | Company ID | Standard | |
| PayPal | Combination of OAuth client ID (REST) or User (SOAP), and Use Sandbox | Standard | |
| PGP (Beta) | — | Standard | — |
| Ad account ID | Standard | ||
| Pipedrive | Company domain | Standard | |
| Presto | Server | Standard | |
| Quickbase | Domain | Standard | |
| QuickBooks | Combination of URL and Company file | Standard | |
| QuickBooks Time | OAuth client ID | Standard | |
| RabbitMQ | Host name | Standard | |
| Reckon Accounts Hosted | Company file | Standard | |
| Redis | Combination of Server and Logical database | Standard | |
| Ripley | Combination of API key and Environment | Standard | |
| RSS | URI | Standard | |
| Sage 50 UK | URL | Standard | |
| Sage 200 | Subscription key | Standard | |
| Sage 300 | Combination of URL and Company | Standard | |
| Sage Business Cloud Accounting | OAuth client ID | Standard | |
| Sage Intacct | Company ID | Standard | |
| Salesforce | Combination of Server host and Sandbox | Standard | |
| Salesforce Commerce Cloud | Organization ID | Standard | |
| Salesforce Einstein Analytics | Combination of Server host and Sandbox | Standard | |
| Salesforce Events | Combination of Host and Consumer key | Enterprise 1 | |
| Salesforce Marketing Cloud | Subdomain | Standard | |
| Salesforce Marketing Cloud v2 | Subdomain | Standard | |
| Salesforce Pardot | Combination of Business unit ID and Use Salesforce Sandbox | Standard | |
| Salesforce Pardot v2 | Business unit ID | Standard | |
| Salesforce Service Cloud | Combination of Server host and Sandbox | Standard | |
| SAP | Host | Enterprise 1 | |
| SAP ASE | Combination of Server and Database | Standard | |
| SAP Business ByDesign | URL | Standard | |
| SAP Business One | Combination of URL and Company DB | Standard | |
| SAP BusinessObjects BI | URL | Standard | |
| SAP Concur | Host | Standard | |
| SAP Fieldglass | Environment URL | Standard | |
| SAP Gateway | Combination of URL and Namespace | Standard | |
| SAP HANA XS Advanced | URL | Standard | |
| SAP Hybris C4C | Tenant | Standard | |
| SAP IQ | Combination of Server and Database | Standard | |
| SAP SuccessFactors | Combination of Host and Company ID | Standard | |
| SAS Data Sets | URI | Standard | |
| SAS Xpt | URI | Standard | |
| SendGrid | SendGrid API key | Standard | |
| ServiceMax | Combination of Server host and Sandbox | Standard | |
| ServiceNow | Instance | Standard | |
| ShipStation | API key | Standard | |
| Shopify | Store name | Standard | |
| SingleStore | Combination of Server and Database | Standard | |
| Slack | OAuth access token (Token-based auth / OAuth) or Bot user OAuth access token (Token-based auth / Bot user) | Standard | |
| OAuth application (Auth code grant) | Standard | ||
| SmartRecruiters | Combination of Client ID and Environment (OAuth auth), or Combination of API key and Environment (API key auth) | Standard | |
| Smartsheet | Smartsheet access token | Standard | |
| SMB | Combination of Server and Domain | Standard | |
| Snapchat Ads | Account ID | Standard | |
| Snowflake | Combination of Account and Database name | Standard | |
| SOAP | Combination of Web service URL and Service | Standard | |
| Square | Access token | Standard | |
| Square v2 | Combination of Environment and Access token | Standard | |
| Stripe | API key | Standard | |
| SugarCRM | Hostname | Standard | |
| SugarCRM v2 | Hostname | Standard | |
| SuiteCRM | URL | Standard | |
| Tally | Combination of URL and Company | Standard | |
| TaxJar | Combination of API key and Use Sandbox | Standard | |
| Temporary Storage | — | Standard | — |
| Twilio | Account SID | Standard | |
| Variable | — | Standard | — |
| Veeva Vault | URL | Standard | |
| Via B2B | Combination of Token and Environment | Standard | |
| VTEX | Combination of Account name and Environment | Standard | |
| Wave Financial | OAuth client ID (OAuth) or API token (Token) | Standard | |
| WhatsApp Business | Phone number ID | Standard | |
| WooCommerce | Combination of Host and Consumer key | Standard | |
| Workday | Combination of Workday host and Tenant | Standard | |
| Workday Prism Analytics | Combination of Workday host and Tenant | Standard | |
| xBase | Data source | Standard | |
| Xero | Tenant | Standard | |
| YAMI | Account name | Standard | |
| YouTube Analytics | Content owner ID | Standard | |
| Zendesk | Company URL | Standard | |
| Zoho Books | Organization ID | Standard | |
| Zoho Creator | OAuth client ID | Standard | |
| Zoho Projects | Portal ID | Standard | |
| Zuora | OAuth client ID | Standard |
Note
1 Enterprise connectors are available as an add-on to your Harmony iPaaS subscription. To enable them, contact your Customer Success Manager.
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:
| Connector type | Endpoint unique identifier fields | License class | Usage reporting |
|---|---|---|---|
| Autodesk Fusion Lifecycle | Host | Standard | |
| Clarizen | URL | Standard | |
| Database | Combination of Server Name and Database Name Known issue When a Database source or target is configured with a driver installed on private agents and the server name and database name are provided within the endpoint's Construct connection string manually field, its Endpoint unique identifier information does not display the values of the | Standard | |
| File Share | Combination of Path(s) and Login | Standard | |
| Four51 | Client Id | Standard | |
| FTP Site | Combination of Host and Security Options | Standard | |
| HTTP | Fully qualified domain name (FQDN) inferred from the URL field | Standard | |
| JMS | Provider URL | Standard | |
| LDAP | Hostname | Standard | |
| Microsoft Dynamics AX | Combination of Service URL and Domain Name | Standard | |
| Microsoft Dynamics CRM | Combination of Organization Service URL and Domain Name | Standard | |
| Microsoft Dynamics GP | Service URL | Standard | |
| NetSuite | Combination of Account and Consumer Key | Standard | |
| Oracle EBS | Connect URL | Enterprise 1 | |
| QuickBooks | Combination of URL and Realm Id | Standard | |
| Salesforce | Combination of Server host and Sandbox | Standard | |
| Salesforce Wave Analytics | Combination of Server host and Sandbox | Standard | |
| SAP | Host | Enterprise 1 | |
| Siebel | URL | Standard | |
| Web Service Method (SOAP) | Combination of Web Service URL and Service | Standard | |
| Workday | Web Service URL | Standard |
Note
1 Enterprise connectors are available as an add-on to your Harmony iPaaS subscription. To enable them, contact your Customer Success Manager.
Functions
The following functions, supported in both Integration Studio and Design Studio, have parameters or defaults that are considered endpoint unique identifier fields:
| Function category | Function | Endpoint unique identifier fields | Usage reporting |
|---|---|---|---|
| Integration Studio: Database Design Studio: Database | CacheLookup | Combination of Server name and Database name in the Database endpoint associated with the function's databaseId parameter | |
CallStoredProcedure | |||
DBCloseConnection | |||
DBExecute | |||
DBLoad | |||
DBLookup | |||
DBLookupAll | |||
DBRollbackTransaction | |||
DBWrite | |||
| Integration Studio: Email Design Studio: Email | SendEmail | The function's smtpServers parameter | |
SendSystemEmail | The private agent configuration file [SMTPClient] definition for DefaultSMTPServers | ||
| Integration Studio: File Design Studio: File | ArchiveFile | The underlying host value in the file-type endpoint associated with the function's sourceId or targetId parameter | |
DeleteFile | |||
DeleteFiles | |||
DirList | |||
FileList | |||
FlushAllFiles | |||
FlushFile | |||
ReadFile | |||
WriteFile | |||
| Integration Studio: LDAP | LDAPConnect | The function's hostname parameter | |
| Design Studio: LDAP | LDAPConnect | The function's hostname parameter | |
| Integration Studio: NetSuite Design Studio: Connector | NetSuiteLogin | Combination of Account and Consumer Key in the NetSuite endpoint associated with the function's netSuiteOrg parameter | |
| Integration Studio: Salesforce Design Studio: Salesforce | SalesforceLogin | Combination of Server host and Sandbox in the Salesforce endpoint associated with the function's salesforceOrg parameter |