Google Docs Connection¶

Introduction¶

A Google Docs connection, created using the Google Docs connector, establishes access to Google Docs. Once a connection is configured, you can create instances of Google Docs 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).

Important

To use the Google Docs connector, you will need credentials that allow you to access the Google Docs API, as described in Google Docs Prerequisites.

Create or Edit a Google Docs Connection¶

A new Google Docs connection is created using the Google Docs 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 Google Docs 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 Google Docs Connection¶

Each user interface element of the Google Docs connection configuration screen is described below.

Google Docs 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 Google Docs connection and must not contain forward slashes / or colons :. This name is also used to identify the Google Docs endpoint, which refers to both a specific connection and its activities.
Project ID: Enter the project_id provided by the credentials JSON file as described in Google Docs Prerequisites.
Client Email: Enter the client_email provided by the credentials JSON file as described in Google Docs Prerequisites.
Private Key String: Enter the private_key provided by the credentials JSON file as described in Google Docs Prerequisites.
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 Google Docs 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:

Create Docs: Creates documents and places them into Google Docs and is intended to be used as a target in an operation.
Update Docs: Updates Google Docs documents and is intended to be used as a target in an operation.
Get Docs: Retrieves Google Docs documents and is intended to be used as a source in an operation.