Connector Classifications

Introduction

Connectors are documented individually but can be classified by their use:

• API: Use the API connector in conjunction with a Jitterbit Custom API that is configured through the API Manager.
• Short-Term Storage: Use the Local Storage, Temporary Storage, or Variable connectors for temporary storage of files.
• Long-Term Storage: Use the File Share, FTP, or Database connectors for long-term or permanent storage of files.
• Service-Based: Use the HTTP or SOAP connectors for connecting to web services that don't already have an application connector or that you want to connect to using a standards-based web service.
• Application: Use these connectors as the recommended way to connect to a specific application, such as NetSuite, Salesforce, ServiceNow, or Workday.

Connectors can also be differentiated by how their schemas are defined:

• Server-Based versus File-Based: These terms are used in addition to the classifications listed above to refer to connectors that automatically fetch a schema from the endpoint (server-based) versus those where you provide the schema yourself (file-based).
  

Connector Use

These connector classifications are by the type of use of the connector.

API

This connector is used in conjunction with a Jitterbit Custom API that is configured through the API Manager. Unlike other connectors, the API connection is a preconfigured endpoint whose associated activities include Request and Response activities. Schemas are defined by files provided by the user.

Short-Term Storage

These connectors are typically used when you want to store files temporarily for use in a downstream operation. Associated activities include Read and Write activities. However, written files cannot be relied on to be present after operation execution, with the exception of Local Storage with some additional configuration. Schemas are defined by files provided by the user.

Long-Term Storage

These connectors are typically used for long-term or permanent storage of files. Associated activities include Read and Write activities. Schemas are defined by files provided by the user.

Service-Based

These connectors are used with a service that provides the metadata needed for the connection and activities. In the case of HTTP/REST services, you research and test the service, and then you provide the schemas within each activity. In the case of SOAP services, this metadata is provided in a Web Service Definition Language (WSDL) file and schemas are queried from the service.

Application

These connectors are used for interaction with specific applications, incorporating application-specific logic for connecting to the endpoint and for various activities that are unique to each endpoint. Schemas are queried from each application.

In addition, these connectors are application connectors:

• Custom connectors created with Connector Builder
• Custom connectors created with the Connector SDK
• Gzip (Though this connector doesn't connect to an application, its schemas are fixed and it follows all valid operation patterns for an application connector.)

Additional application-specific connectors are being added with each new Harmony release and are updated here over time.

Connector Schema Definition

In addition to the above connector classifications by use, connectors can also be referred to based on how their schemas are defined.

Server-based Versus File-based

Connectors can be referred to as server-based or file-based depending on how their schemas are defined:

• A server-based endpoint refers to an endpoint whose schemas are generated directly from the endpoint, such as is the case with Database, NetSuite, Salesforce, and ServiceMax endpoints, as well as many application-specific endpoints and some custom endpoints.

• In contrast, a file-based endpoint refers to an endpoint whose schemas are provided by the user, such as API, File Share, FTP, HTTP, Local Storage, SOAP, Temporary Storage, and Variable endpoints.

To learn more about schema caching and refreshing for both types, see Schema Regeneration.