Skip to Content

GraphQL Connector

Summary

The Jitterbit Harmony GraphQL Connector establishes access to GraphQL.

The GraphQL connector provides an interface for creating a GraphQL connection, the foundation used for generating instances of GraphQL activities. Activities interact with GraphQL through the connection and are intended to be used as sources (to provide data in an operation) or targets (to consume data in an operation).

The GraphQL connector is accessed from the design component palette's Connections tab (see Design Component Palette).

Note

This connector can be used only with Private Agents. In addition, it is a Connector SDK-based connector, which may be referred to by Jitterbit when communicating changes made to connectors built with the Connector SDK.

Connection Documentation

In addition to the GraphQL connection, see Jitterbit's comprehensive GraphQL connection details page. Configuration details such as these are included on that page:

  • Getting Started: Initial steps for establishing a connection.
  • Advanced Features: User-defined views and SSL configuration.
  • Data Model: The data model that the connector uses to represent the endpoint.
  • Advanced Configurations Properties: Properties that can be defined to configure a connection for both basic and advanced configurations.

Activity Documentation

Together, a specific GraphQL connection and its activities are referred to as a GraphQL endpoint:

GraphQL activity types

  • Query: Retrieves records from a table at GraphQL and is intended to be used as a source in an operation.

Prerequisites and Supported API Versions

The GraphQL connector requires the use of an agent version 10.1 or later. These agent versions automatically download the latest version of the connector when required.

This connector requires the use of a Private Agent.

Refer to the documentation for information on the schema nodes and fields.

The GraphQL connector requires additional virtual memory heapsize in order to run successfully. See these instructions on increasing the Jitterbit Tomcat heap size to adjust the heap as required.

OAuth Authentication

OAuth authentication is supported as described in Configure OAuth Connections.

Troubleshooting

If you experience issues with the GraphQL connector, these troubleshooting steps are recommended:

  1. Ensure the GraphQL connection is successful by using the Test button in the configuration screen. If the connection is not successful, the error returned may provide an indication as to the problem.

  2. Check the operation logs for any information written during execution of the operation.

  3. Enable operation debug logging for Private Agents to generate additional log files and data.

  4. Enable connector verbose logging for this connector using this specific configuration entry of logger name and level:

    <logger name="org.jitterbit.connector.verbose.logging.GraphQL" level="TRACE"/>

  5. Check the agent logs for more information.