Google Cloud Storage Connector

Whether you’re saving photos, important documents, or sharing files on GCS – this GCS Connector makes managing your digital content more convenient for intended users. It’s like having a reliable assistant for your data tasks, making things easier and more accessible.

The Google Cloud Storage (GCS) Connector is a helpful tool that simplifies how Camunda workflows interact with Google Cloud Storage.

  • Written by

  • Praveen Kumar Reddy
    Camunda Expert at Acheron
  • August 22, 2023
  • 9 mins read

What is Google Cloud Storage(GCS)

Google Cloud Storage is a cloud-based object storage service provided by Google as part of its Google Cloud Platform (GCP) suite of services. It allows individuals and organizations to store and retrieve large amounts of unstructured data, such as files, images, videos, backups, logs, and more, in a highly scalable and durable manner. Google Cloud Storage is designed to provide secure and cost-effective storage solutions for a wide range of use cases. Files are stored in Google Cloud in this flow eg. Organization->Project->Bucket->Image(files) Watch this video for more info.

What is Camunda 8

Camunda Platform 8 is a powerful tool that helps manage complex business processes involving people, systems, and devices. It allows business users to work together with developers to design and automate entire processes using flowcharts powered by BPMN (Business Process Model and Notation).

It also includes DMN (Decision Model and Notation) decision tables that help make decisions quickly, efficiently, and based on logical rules. This combination of features supports efficient workflows and decision-making at scale.

For more Info visit : Camunda 8 Platform Documentation

What is Camunda 8 Self Managed

Camunda Platform 8 Self-Managed is a version of Camunda Platform 8 that you can host and manage yourself. This gives you more control over the platform, but it also requires more technical expertise to set up and maintain. For More Info visit : Camunda 8 Platform Self-managed - Documentation

Prerequisites

To ensure a smooth setup process, we kindly recommend taking the time to understand how to configure the GCS connector runtime. You can achieve this by referring to the guide available on Acheron GCS Connector on GitHub.

How to use the GCS Connector with Camunda 8 self-managed

Configure the element template of GCS connector In Desktop modeler

  • Download the GCS element-template JSON file from GitHub
  • Follow the provided documentation to effectively configure the Element Template within the desktop modeler. This documentation will guide you through the setup process, ensuring accurate configuration.

Using the Connector in Desktop Modeler

  • Create a new BPMN diagram for Camunda 8
Camunda Modeler            
  • Create a Task and click the wrench Icon on right side to change the element
  • Search and Select the Google Cloud Storage connector element template
Search and select GCS            
  • In the connector template choose the operation type you want to perform
GCS Connector configurations          

Operations of GCS connector

Table - GCS Connector operations      

Upload file

  • This operation enables you to upload a file from your file system to a GCS bucket.
  • Kindly provide the following inputs to proceed with the operation
Table - Operation details           In the Modeler, the process appears as follows:
Modeler upload screenshot
  • Deploy the process instance
Deploy Process Instance                      
  • Start the Process Instance
Start Process Instance                      
  • As a result of this operation, the file from the specified path will be uploaded to the designated GCS bucket with its original name.

Download File

  • This operation allows downloading an object from a GCS bucket to your file system
  • To do this, specify the download file directory on your file system, the GCS bucket name, and the object name within the bucket.
Table - Download Operations           In the Modeler, the process appears as follows:
Modeler Download screenshot
  • Deploy the process and start a process Instance
  • As a result, the object from the specified bucket will be downloaded to the provided directory with original name.

Delete file

  • This operation will be able delete an object from GCS bucket
  • Provide Bucket name and object name present in it to delete from GCS
Table - Delete Operations
        In the Modeler, the process appears as follows:
  • Deploy the process and start a process Instance
  • As a result the object in the given bucket will be deleted from it
  • If there are no other objects remaining in a folder after a deletion operation, Google Cloud Storage will also delete the folder automatically.
  • This behavior helps keep your storage structure clean and free of empty folders that no longer serve a purpose.

Benefits of GCS connector

  1. Simplified Integration: The GCS Connector streamlines the integration of Camunda workflows with Google Cloud Storage. It provides a straightforward way to interact with GCS within your business processes.

  2. Efficient File Operations: The connector enables essential file operations, such as uploading, downloading, and deleting files in GCS buckets, directly from your business process workflows. This simplifies file management tasks.

  3. Workflow Automation: You can automate file-related tasks in your business process workflows. For example, you can automatically upload files generated during a process, trigger workflows when new files are added to GCS, or download files for further processing.

Use Cases of GCS connector

  1. Report Generation and Distribution: Generate reports or analytical outputs within your workflows and use the GCS Connector to store these reports in GCS. You can then trigger automated distribution to stakeholder

  2. Media Processing and Streaming: Integrate GCS with media processing workflows. For instance, store raw video files and use the connector to trigger transcoding and streaming processes.

Useful Resources

Sample BPMN file : gcs-connector.bpmn

Conclusion

In summary, the Google Cloud Storage (GCS) Connector is a helpful tool that simplifies how Camunda workflows interact with Google Cloud Storage. It streamlines tasks like saving and retrieving files in the cloud, automating data processes, and ensuring your data remains protected. Whether you're saving photos, important documents, or sharing files, this connector makes managing your digital content more convenient for everyone. It's like having a reliable assistant for your data tasks, making things easier and more accessible.

More to explore