Skip to main content

Celonis Product Documentation

Google Docs (Action Flow)

Important

Any references to third-party products or services do not constitute Celonis Product Documentation nor do they create any contractual obligations. This material is for informational purposes only and is subject to change without notice.

Celonis does not warrant the availability, accuracy, reliability, completeness, or usefulness of any information regarding the subject of third-party services or systems.

With Google Docs modules in Celonis platform you can monitor, create, edit and retrieve documents in your Google Docs account.

To use the Google Docs modules, you must have a Google account. If you do not have one, you can create a Google account at google.com.

Refer to the Google API documentation for a list of available endpoints.

Note

Celonis platform's use and transfer of information received from Google APIs to any other app will adhere to Google API Services User Data Policy.

Connect Google Docs to Celonis platform

To establish the connection:

  1. Log in to your Celonis platform account, add a Google Docs module to your Action Flow, and click Create a connection.

  2. Optional: In the Connection name field, enter a name for the connection.

  3. Optional: Switch on the Show advanced settings toggle and enter your Google Cloud Console project client credentials.

  4. Click Sign in with Google.

  5. If prompted, authenticate your account and confirm access.

You have successfully established the connection. You can now edit your Action Flow and add more Google Docs modules. If your connection requires reauthorization at any point, follow the connection renewal steps here.

Build Google Doc Action Flows

Returns document details when a new document is created or modified in the selected folder.

Connection

Establish a connection to your Google account.

Watch Documents

Select whether you want to watch created (By Created Date) or modified (By Modified Date) documents.

Choose a Drive

Select what type of drive you want to monitor.

  • My Drive

  • Shared With Me

  • Google Shared Drive (available for Workspace users only!)

Folder ID / Shared Drive

Select the folder you want to watch for created or modified documents.

Note

If you have selected the Google Shared Drive option in the field above and you are not a Workspace user, the error [400] Invalid Value is returned.

Limit

Set the maximum number of documents Celonis platform will return in one execution cycle.

Retrieves a list of documents from the selected folder.

Connection

Establish a connection to your Google account.

Watch Documents

Select whether you want to watch created (By Created Date) or modified (By Modified Date) documents.

Choose a Drive

Select the drive you want to retrieve documents from.

  • My Drive

  • Shared With Me

  • Google Shared Drive (available for Workspace users only)

Folder ID / Shared Drive

Select the folder you want to watch for created or modified documents.

Note

If you have selected the Google Shared Drive option in the field above and you are not a Workspace user, the error [400] Invalid Value is returned.

Retrieves a specified document.

Note

You may need to extend your permissions.

61d5b4e268248.png

Connection

Establish a connection to your Google account.

Get Content of a Document

Select whether you want to map the document ID of the document or select the document from the drop-down menu manually.

Choose a Drive

Select the drive you want to retrieve the document from.

  • My Drive

  • Shared With Me

  • Google Shared Drive (available for Workspace users only)

Document ID

Select or map the document you want to retrieve.

Filter

Select the object you want to be returned in the module's output.

  • Image (default)

  • Drawing

  • Chart

Note

For further mapping of these objects, please use Inline Objects Array (instead of inlineObjects). The Inline Objects Array objects are sorted in the same order they appear in the document. It will make any further processing easier.

Allows you to create a new document in the selected folder.

Connection

Establish a connection to your Google account.

Name

Enter the name of the document.

Content

Enter the content of the document. HTML is supported.

Choose a Drive

Select the drive where you want to create the document.

  • My Drive

  • Shared With Me

  • Google Shared Drive (available for Workspace users only!)

New Document's Location

Select the folder where you want to save the document.

Insert Header

Enable this option to insert the header to the document.

Insert Footer

Enable this option to insert the footer into the document.

Creates a new document from the template document where the mustache variables ({{}}) are used.

Connection

Establish a connection to your Google account.

Create a Document from a Template

  • By Mapping - select this option to map the document template.

  • By Dropdown - select this option to choose the document template from the drop-down menu.

Choose a Drive

Select the drive you want to retrieve documents from.

  • My Drive

  • Shared With Me

  • Google Shared Drive (available for Workspace users only)

Document ID

Select or map (based on the option selected above) the document with the variables ({{}}) you want to use as the template for the new document.

Values

Enter the values that will be entered instead of the variables to the new document.

Tags

Enter the tags that are contained in the document template. Do not use {{}}.

Replaced Value

Enter the value of the tag.

E.g. {{name}} variable in the source document will be displayed as the name field here, where the value can be inserted, for example, John.

Images Replacement

Enter the link to the Image Object ID (You can retrieve the image IDs by using the Get a Document module, where the IDs are contained in the array Inline Object Array) and Image URL that will replace the current image.

We recommend that you add ALT text to images in your Google document. The module will more easily recognize them.

Adding an ALT Text to the Google Docs image

1. Right-click on the image.

2. Select the ALT text option.

3. Enter the ALT text in the Title field and click OK.

61d5b4e356119.gif

After the ALT text is added to the image, the ALT text is displayed in the field name in round brackets:

61d5b4e5792f6.png

Title

Enter the name for the new document.

New Drive Location

Select the drive where you want to create the document.

  • My Drive

  • Shared With Me

  • Google Shared Drive (available for Workspace users only!)

New Document's Location

Select or map the folder where you want the document to be created.

Appends or inserts a new text to an existing document.

Connection

Establish a connection to your Google account.

Select a Document

  • By Mapping - select this option to map the document template.

  • By Dropdown - select this option to choose the document from the drop-down menu.

Choose a Drive

Select the drive that contains the document you want to insert a paragraph to.

  • My Drive

  • Shared With Me

  • Google Shared Drive (available for Workspace users only!)

Document ID

Select or map the document you want to edit.

Insert a Paragraph

Select how you want the new text to be inserted in the document.

  • By specification of location

    By index

    Index

    Enter the Index number where you would like to insert your text. The Get a Document module can be used to retrieve that number.

    61d5b4e6918ad.png

    To display all characters (including hidden) in the document, you can use the Show add-on. You can find the add-on under Add-ons > Get add-ons > search for Show and install the Show add-on.

    Inserted text

    Enter the text you want to insert to the document.

    By segment ID

    Select the header and footer you want to insert the text content to and enter the text you want to insert to the corresponding fields.

    If the header and/or footer already contains text, the new text will be added before the existing one.

  • By appending to the body of the document

    Appends entered text in the document's body content.

    Note

    The style of the new paragraph will be copied from the paragraph at the current insertion index, including lists and bullets.

  • By appending to the end of segment (Header and Footer)

    Select the header and footer you want to insert the text content to and enter the text you want to insert to the corresponding fields. If the header and/or footer already contain a text, the new text will be added after the existing one.

Inserts an image from the URL to the document.

Connection

Establish a connection to your Google account.

Select a Document

  • By Mapping - select this option to map the document template.

  • By Dropdown - select this option to choose the document from the drop-down menu.

Choose a Drive

Select the drive that contains the document you want to insert an image to.

  • My Drive

  • Shared With Me

  • Google Shared Drive (available for Workspace users only!)

Document ID

Select or map the document you want to add an image to.

Insert an Image

Select how you want the new text to be inserted in the document.

  • By specification of location

    By index

    Index

    Enter the Index number where you would like to insert the image. The Get a Document module can be used to retrieve that number.

    61d5b4e6918ad.png

    Image URL

    Enter the URL of the image you want to insert into the document.

    Note

    The maximum image size is 50 MB. Must not exceed 25 megapixels. Only PNG, JPEG or GIF format is supported.

    By segment ID

    Select the header and footer you want to insert an image to and enter the image URL to the corresponding fields. The maximum image size is 50 MB. Must not exceed 25 megapixels. Only PNG, JPEG or GIF format is supported.

  • By appending to the body of the document

    Appends a specified image in the body content of the document.

  • By appending to the end of segment (Header and Footer)

    Select the header and footer you want to insert an image to and enter the image URL you want to insert to the corresponding fields.

Height Magnitude in Points/Width Magnitude in Points

Define the size of the inserted image. The aspect ratio will be kept.

Replaces an existing image. The aspect ratio of the original image will be maintained.

Connection

Establish a connection to your Google account.

Replace an Image

  • By Mapping - select this option to map the target document and image to be replaced.

  • By Dropdown - select this option to choose the document from the drop-down menu.

Choose a Drive

Select the drive that contains the document that you want to replace an image for.

  • My Drive

  • Shared With Me

  • Google Shared Drive (available for Workspace users only!)

Document ID

Select or map the document that contains the image(s) you want to replace.

Image URLs

Body: Image No. 1

(Location: Order of the existing image in the document)

Enter the URL of the new image that will replace the existing one.

Images Replacement

Add the images that you want to replace.

Image Object ID

Map the Object ID of the image. It can be retrieved using the Get a Document module (Inline Objects Array):

Image URL

Enter the URL of the new image.

The Example

61d5b4e7b6e26.png

Finds a specified text and replaces it with the new one.

Connection

Establish a connection to your Google account.

Choose a Drive

Select the drive that contains the document that you want to replace a text of.

  • My Drive

  • Shared With Me

  • Google Shared Drive (available for Workspace users only!)

Document ID

Select or map the document that contains the text you want to replace.

Replace a Text

Finds and replaces a text within the document.

  • Old text to be replaced

    Enter the text you want to replace.

  • New text to be inserted

    Enter the new text.

Converts and downloads the selected document.

Connection

Establish a connection to your Google account.

Choose a Drive

Select the drive that contains the document you want to download.

  • My Drive

  • Shared With Me

  • Google Shared Drive (available for Workspace users only!)

Document ID

Select or map the document that contains the text you want to replace.

Type

Select the target file format of the downloaded document.

Deletes a document.

Connection

Establish a connection to your Google account.

Choose a Drive

Select the drive that contains the document you want to delete.

  • My Drive

  • Shared With Me

  • Google Shared Drive (available for Workspace users only!)

Document ID

Select or map the document you want to delete.

Allows you to perform a custom API call.

Connection

Establish a connection to your Google account.

URL

Enter a path relative to https://docs.googleapis.com/. E.g./v1/documents/{DocumentID}

For the list of available endpoints, refer to the Google Docs API Documentation.

Method

Select the HTTP method you want to use:

GET

to retrieve information for an entry.

POST

to create a new entry.

PUT

to update/replace an existing entry.

PATCH

to make a partial entry update.

DELETE

to delete an entry.

Headers

Enter the desired request headers. You don't have to add authorization headers; we already did that for you.

Query String

Enter the request query string.

Body

Enter the body content for your API call.

The following API call retrieves the details for the specified document in your Google Docs:

URL:

/v1/documents/1ujkf-GDgB0TQSYPrxbCSK4Uso54tHVMqHZEVZZxB6aY

Method:

GET

Google-docs-1.png

Details of the retrieved document can be found in the module's Output under Bundle > Body.

61d5b4e8e9e2b.png

Finds all links in the document and makes them clickable.

Connection

Establish a connection to your Google account.

Make All Links in a Document

  • By Mapping - select this option to map the target document.

  • By Dropdown - select this option to choose the document from the drop-down menu.

Choose a Drive

Select the drive that contains the document you want to update the links in.

  • My Drive

  • Shared With Me

  • Google Shared Drive (available for Workspace users only!)

Document ID

Select or map the document you want to update the links in.