Cloud Firestore connection

Introduction

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

A new Cloud Firestore connection is created using the Cloud Firestore connector from one of these locations:

The design component palette's Project endpoints and connectors tab (see Design component palette).
The Global Connections page (see Create a global endpoint in Global Connections).

An existing Cloud Firestore connection can be edited from these locations:

The design component palette's Project endpoints and connectors 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 endpoint in Global Connections).

Configure a Cloud Firestore connection

Each user interface element of the Cloud Firestore connection configuration screen is described below.

Cloud Firestore 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 Cloud Firestore connection and must not contain forward slashes / or colons :. This name is also used to identify the Cloud Firestore 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 Cloud Firestore prerequisites.
Client Email: Enter the client_email provided by the credentials JSON file, as described in Cloud Firestore prerequisites.
Client ID: Enter the client_id provided by the credentials JSON file, as described in Cloud Firestore prerequisites.
Private Key ID: Enter the private_key_id provided by the credentials JSON file, as described in Cloud Firestore prerequisites.
Private Key: Enter the private_key provided by the credentials JSON file, as described in Cloud Firestore prerequisites. The private key should be entered in this format:

-----BEGIN PRIVATE KEY-----<private_key>-----END PRIVATE KEY-----

Note

Any newline characters (\n) present in the private_key string must be replaced with a carriage return in the Private Key field. Otherwise, an error will occur when testing the connection.
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.

Possible connection errors

These are possible connection errors and their solutions:

Error	Cause	Solution
`An error occurred: com.google.common.base.Preconditions.checkArgument(ZLjava/lang/String;CLjava/lang/Object;)V`	The agent version is too old.	Ensure the agent version being used is version 10.60 or later.
`An error occurred: java.io.IOException: Invalid PKCS#8 data`	Newline characters (`\n`) are present in the Private Key.	Replace any newline characters with a carriage return.

Next steps

After a Cloud Firestore 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:

Query: Queries documents within a collection in Cloud Firestore and is intended to be used as a source in an operation.
Create: Creates documents within a collection in Cloud Firestore and is intended to be used as a target in an operation.
Update: Updates documents within a collection in Cloud Firestore and is intended to be used as a target in an operation.
Delete: Deletes documents within a collection from Cloud Firestore and is intended to be used as a target in an operation.