Square v2 Connection¶

Introduction¶

A Square v2 connection, created using the Square v2 connector, establishes access to Square v2. Once a connection is configured, you can create instances of Square v2 activities associated with that connection to be used either as sources (to provide data in an operation) or as targets (to consume data in an operation).

Create or Edit a Square v2 Connection¶

A new Square v2 connection is created using the Square v2 connector from one of these locations:

The design component palette's Connections tab (see Design Component Palette).
The Global Connections page (see Create a Global Connection in Global Connections).

An existing Square v2 connection can be edited from these locations:

The design component palette's Connections tab (see Design Component Palette).
The project pane's Components tab (see Component Actions Menu in Project Pane Components Tab).
The Global Connections page (see Edit a Global Connection in Global Connections).

Configure a Square v2 Connection¶

Each user interface element of the Square v2 connection configuration screen is described below.

Square v2 connection configuration

Tip

Fields with a variable icon support using global variables, project variables, and Jitterbit variables. Begin either by typing an open square bracket [ into the field or by clicking the variable icon to display a list of the existing variables to choose from.

Connection Name: Enter a name to use to identify the connection. The name must be unique for each Square v2 connection and must not contain forward slashes / or colons :. This name is also used to identify the Square v2 endpoint, which refers to both a specific connection and its activities.
Environment: Select the Square environment, either Production or Sandbox.
Access Token: Enter the personal access token for the associated Environment.
Use Proxy Settings (Private Agent Only): When using a Private Agent, this setting can be selected to use Private Agent proxy settings.
Test: Click to verify the connection using the provided configuration. When the connection is tested, the latest version of the connector is downloaded by the agent(s) in the agent group associated with the current environment. This connector supports suspending the download of the latest connector version by using the Disable Auto Connector Update organization policy.
Save Changes: Click to save and close the connection configuration.
Discard Changes: After making changes to a new or existing configuration, click to close the configuration without saving. A message asks you to confirm that you want to discard changes.
Delete: After opening an existing connection configuration, click to permanently delete the connection from the project and close the configuration (see Component Dependencies, Deletion, and Removal). A message asks you to confirm that you want to delete the connection.

Next Steps¶

After a Square v2 connection has been created, you place an activity type on the design canvas to create activity instances to be used either as sources (to provide data in an operation) or as targets (to consume data in an operation).

Menu actions for a connection and its activity types are accessible from the project pane and design component palette. For details, see Actions Menus in Connector Basics.

These activity types are available:

Read: Retrieves all object data from Square and is intended to be used as a source in an operation.
Query: Retrieves specified object data from Square and is intended to be used as a source in an operation.
Create: Creates object data in Square and is intended to be used as a target in an operation.
Update: Updates object data in Square and is intended to be used as a target in an operation.
Delete: Deletes object data from Square and is intended to be used as a target in an operation.