Jitterbit Harmony Square Connector¶
Summary¶
The Square connector for Jitterbit Harmony Cloud Studio provides an interface for entering user-provided input such as credentials to create an authenticated Square connection. That connection provides the foundation to configure associated Square connector activities that interact with the connection. Together, a specific Square connection and its activities are referred to as a Square endpoint.
Supported API Versions and Prerequisites¶
The Square connector uses the Square REST API. Refer to the API documentation for information on the schema fields.
The Square 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.
Connector Overview¶
This connector is used to first configure a Square connection, establishing access to Square, and then used to configure one or more Square activities associated with that connection as a source or target within an operation:
-
Query Activity: Retrieves customers from a Square connection and is used as a source in an operation.
-
Create Activity: Creates new customers at a Square connection and is used as a target in an operation.
-
Update Activity: Updates existing customers at a Square connection and is used as a target in an operation.
-
Delete Activity: Deletes existing customers from a Square connection and is used as a target in an operation.
The Square connector uses the Square REST API. Refer to the API documentation for information on the schema fields.
The Square connector requires the use of an agent version 10.1 or later.
Together, a specific Square connection and its activities are referred to as a Square endpoint. Once a connection is configured, activities associated with the endpoint are available from the Endpoints filter:
Note
Verbose logging can be enabled for this connector when it is used with a Private Agent. See Verbose Logging for Connectors for details.
Invoke verbose logging for this connector using this configuration entry:
<logger name="org.jitterbit.connector.verbose.logging.square" level="DEBUG"/>
Note
This connector is a Connector SDK-based connector, which may be referred to by Jitterbit when communicating changes made to connectors built with the Connector SDK.
Square Registration¶
As the connection will be an application that interfaces with Square, you will need a Personal Access Token to access the Square server. See Square Registration for details.
Accessing the Connector¶
The Square connector is accessed from the Connectivity tab of the design component palette by using the Show dropdown to filter on Connectors.
Once a connection is configured, activities associated with the endpoint are available by using the Show dropdown to filter on Endpoints and then clicking the Square connection block: