Skip to Content

Cloud Firestore Connector

Summary

The Harmony Cloud Firestore Connector establishes access to Google Cloud Firestore.

The Cloud Firestore connector provides an interface for creating a Cloud Firestore connection, the foundation used for generating instances of Cloud Firestore activities. These activities, once configured, interact with Google Cloud Firestore through the connection.

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

Connector Overview

This connector is used to first configure a Cloud Firestore connection. Activity types associated with that connection are then used to create instances of activities that are intended to be used as sources (to provide data in an operation) or targets (to consume data in an operation).

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

Cloud Firestore activity types

  • 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.

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.

Prerequisites and Supported API Versions

The Cloud Firestore connector requires the use of an agent version 10.60 or later. These agent versions automatically download the latest version of the connector when required.

The Cloud Firestore connector uses the Google Firebase JavaScript SDK v8. Refer to the documentation for information on the schema nodes and fields.

To use the Cloud Firestore connector, you must create a service account, grant roles, and obtain certain credentials in the Google Cloud Platform as described in Cloud Firestore Prerequisites.

Troubleshooting

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

  1. Click the Test button in the connection configuration to ensure the connection is successful and to ensure the latest version of the connector is downloaded to the agent (unless using the Disable Auto Connector Update organization policy).

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

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

  4. If using Private Agents, you can check the agent logs for more information.