Skip to main content

Celonis Product Documentation

Smartsheet (Action Flows)

The Smarsheet modules allows you to watch, create, update, list, and/or delete folders, sheets, rows, and workspaces in your Smartsheet account.

Prerequisites

  • A Smartsheet account

To use Smartsheet with Execution Management System, it is necessary to have a Smartsheet account. If you do not have one, you can create a Smartsheet account at https://app.smartsheet.com/b/home?.

Connecting Smartsheet to Execution Management System

1. Go to Execution Management System and open the Smarsheet module's Create a connection dialog.

61f27a40457ca.gif

2. Enter the connection and click Continue.

3. Confirm the dialog by clicking the Allow button.

61f27a42a4d65.png

The connection has been established.

Triggers

Triggers when a sheet or row is created, updated or deleted.

Required Permissions: ADMIN_WEBHOOKS

Webhook Name

Enter the webhook name.

Connection

Establish a connection to your Smartsheet account

Triggers when a new row is added.

Required Permissions: READ_SHEETS

Connection

Establish a connection to your Smartsheet account

Sheet

Select the sheet you want to watch.

Limit

The maximum number of sheets Execution Management System should return during one Action Flow execution cycle.

Actions

Creates a copy of the specified folder.

Required Permissions: ADMIN_WORKSPACES

Connection

Establish a connection to your Smartsheet account

Folder ID

Select the Folder ID you want to copy.

Destination

Select the location where you want to copy the folder.

Name

Enter the new name for the folder.

Include

Select the options you want to include in the folder:

  • Attachments

  • Cell links

  • Data

  • Discussions

  • Filters

  • Forms

  • Rule recipients

  • Rules

  • Shares

Creates a copy of the specified sheet.

Required Permissions: CREATE_SHEETS

Connection

Establish a connection to your Smartsheet account

Sheet ID

Select the Sheet ID you want to copy

Destination

Select the location where you want to copy the sheet.

Name

Enter a new name for the sheet.

Include

Select the options you want to include:

  • Attachments

  • Cell links

  • Data

  • Discussions

  • Filters

  • Forms

  • Rule recipients

  • Rules

  • Shares

Creates a copy of the specified workspace.

Required Permissions: ADMIN_WORKSPACES

Connection

Establish a connection to your Smartsheet account

Workspace ID

Select the Workspace ID you want to copy.

Name

Enter a new name for the workspace.

Include

Select the options to include in the workspace:

  • Attachments

  • Cell links

  • Data

  • Discussions

  • Filters

  • Forms

  • Rule recipients

  • Rules

  • Shares

Creates a folder. A folder can be created in the user's sheets folder (Home), in another folder, or in a workspace.

Required Permissions: ADMIN_WORKSPACES

Connection

Establish a connection to your Smartsheet account

Where to create a folder

Select the location where to create the folder:

  • Home (top-level)

  • Folder

    Select the destination folder location.

  • Workspace

    Select the Destination Workspace.

  • Folder in Workspace

    Select the workspace and folder location.

Name

Enter the name of the folder.

Inserts a row into the specified sheet.

Required Permissions: WRITE_SHEETS

Connection

Establish a connection to your Smartsheet account

Sheet

Select the sheet in which you want to create a row.

Task Name

Enter the task name to add in the row.

Due Date

Enter the date by which the task must be completed.

Done

Select Yes if the task is completed:

  • Yes

  • No

  • Not defined

Assigned To

Enter the person's name to whom the task is assigned.

Status

Enter the status of the task.

Comments

Enter the details of the comments.

Inserts a row to the specified sheet. User this module if you need to map the Sheet ID.

Required Permissions: WRITE_SHEETS

Connection

Establish a connection to your Smartsheet account

Sheet ID

Enter the Sheet ID to which you want to add the row.

Columns

Add the columns:

  • Add Item

    Text: Enter the column name.

Creates a sheet.

Required Permissions: CREATE_SHEETS

Connection

Establish a connection to your Smartsheet account

Where to create a folder

Select the folder in which you want to create the sheet.

Name

Enter a name for the sheet.

Columns

Add the columns:

  • Primary

    Select if this is the primary column.

  • Title

    Enter the name of the column.

  • Type

    Select the column Type.

  • Options

    Add the options.

  • Width

    Enter the column width in pixels.

Creates a workspace.

Required Permissions: ADMIN_WORKSPACES

Connection

Establish a connection to your Smartsheet account

Name

Enter the name of the workspace.

Deletes the specified folder ( and its contents).

Required Permissions: ADMIN_WORKSPACES

Connection

Establish a connection to your Smartsheet account

Folder ID

Select the Folder ID you want to delete.

Deletes the specified row.

Required Permissions: WRITE_SHEETS

Connection

Establish a connection to your Smartsheet account

Sheet

Select the sheet whose rows you want to delete.

Row ID

Select the Row ID you want to delete.

Deletes the specified sheet.

Required Permissions: DELETE_SHEETS

Connection

Establish a connection to your Smartsheet account

Sheet ID

Select the Sheet ID you want to delete.

Deletes the specified workspace.

Required Permissions: ADMIN_WORKSPACES

Connection

Establish a connection to your Smartsheet account

Workspace ID

Select the Workspace ID you want to delete.

Gets the specified folder (and lists its contents).

Required Permissions: READ_SHEETS

Connection

Establish a connection to your Smartsheet account

Folder ID

Select the Folder ID whose details you want to retrieve.

Gets the specified row.

Required Permissions: READ_SHEETS

Connection

Establish a connection to your Smartsheet account

Sheet

Select the sheet whose row details you want to retrieve.

Row ID

Select the Row ID whose details you want to retrieve.

When the Sheet field has been mapped, then Cells (array) must be used for mapping the cells from the Get a Row module. Do not use Cells (collection)!

The reason is that the Sheet field is dynamic, without static value so it is not possible to load values during the Action Flow creation.The Cells (collection) will be then for every Sheet ID different, therefore it cannot be used for mapping.

Gets the specified sheet.

Required Permissions: READ_SHEETS

Connection

Establish a connection to your Smartsheet account

Sheet ID

Select the Sheet ID whose details you want to retrieve.

Gets the current user information.

Required Permissions: READ_USERS

Connection

Establish a connection to your Smartsheet account

Gets the specified workspace (and lists its contents).

Required Permissions: READ_SHEETS

Connection

Establish a connection to your Smartsheet account

Workspace ID

Select the Workspace ID whose details you want to retrieve.

Moves the specified folder to a new location.

Required Permissions: ADMIN_WORKSPACES

Connection

Establish a connection to your Smartsheet account

Folder ID

Select the Folder ID you want to move.

Destination

Select the destination to where you want to move the folder:

  • Home (top-level)

  • Folder

    Select the folder location.

  • Workspace

    Select the Destination Workspace.

  • Folder in Workspace

    Select the workspace and folder location.

Moves the specified sheet to a new location.

Required Permissions: CREATE_SHEETS

Connection

Establish a connection to your Sheetsmart account.

Sheet ID

Select the Sheet ID you want to move.

Destination

Select the destination to where you want to move the sheet:

  • Home (top-level)

  • Folder

    Select the folder location.

  • Workspace

    Select the Destination Workspace.

  • Folder in Workspace

    Select the workspace and folder location.

Updates the specified folder.

Required Permissions: ADMIN_WORKSPACES

Connection

Establish a connection to your Smartsheet account.

Folder ID

Select the Folder ID you want to update.

Name

Enter a new name for the folder.

Updates the specified row.

Required Permissions: WRITE_SHEETS

Connection

Establish a connection to your Sheetsmart account.

Sheet

Select the sheet whose rows you want to update.

Row ID

Select the Row ID you want to update.

Task Name

Enter a new task name.

Due Date

Enter a new date by which the task must be completed.

Done

Select Yes if the task is completed:

  • Yes

  • No

  • Not defined

Assigned To

Enter the person's name to whom the task is assigned.

Status

Enter the status of the task.

Comments

Enter the details of the comments.

Updates the specified Workspace.

Required Permissions: ADMIN_WORKSPACES

Connection

Establish a connection to your Smartsheet account

Workspace ID

Select the Workspace ID you want to update.

Name

Enter a new name for the workspace.

Moves rows from one sheet to (the bottom of ) another sheet.

Required Permissions: WRITE_SHEETS

Connection

Establish a connection to your Sheetsmart account.

From Sheet

Select the sheet whose rows you want to move to another sheet.

To Sheet

Select the sheet to copy the rows.

Row IDs

Add the Row IDs to move from one sheet to another:

  • Text

    Enter the Row ID.

Ignore rows not found

Select Yes to ignore the rows found in the sheet where you want to copy the rows:

  • Yes

  • No

  • Not defined

Include

Include the following:

  • Attachments

  • Discussions

Updates a row in the specified sheet. Use this module if you need to map the Sheet ID.

Required Permissions: WRITE_SHEETS

Connection

Establish a connection to your Smartsheet account

Sheet ID

Select the Sheet ID whose row you want to update.

Row ID

Select the Row ID you want to update.

Column

Add the column:

  • Text

    Enter the details of the column.

Updates cells in a specified sheet.

Required Permissions: WRITE_SHEETS

Connection

Establish a connection to your Smartsheet account

Sheet

Select the Sheet whose cells you want to update.

Row ID

Select the Row ID whose cells you want to update.

Cells

Add the cells:

  • Column ID

    Select the Column ID whose cell you want to update.

  • Value

    Enter the details of the cell.

Change status of the webhook to enabled.

Connection

Establish a connection to your Smartsheet account

Webhook ID

Select the Webhook ID you want to update.

Performs an arbitrary authorized API call.

Connection

Establish a connection to your Smartsheet account

URL

Enter a path relative to https://api.smartsheet.com/2.0/. e.g.sheets

For the list of available endpoints, refer to the Smartsheet 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.

Example - Sheets

Following API call returns all sheets:

61f27a43c7407.png

Matches of the search can be found in the module's Output under Bundle > Body > data. In our example, 3 sheets were returned:

61f27a44d47d4.png
Searches

Searches all sheets that the user can access for the specified text.

Required Permissions: READ_SHEETS

Connection

Establish a connection to your Smartsheet account

Search

Enter the text to perform the search.

Filters

Select the option to filter the information you are looking for:

  • Attachments

  • Cell Data

  • Comments

  • Folder names

  • Profile fields

  • Report names

  • Sheet names

  • Sight names

  • Template names

  • Workspace names

Number of Returned Results

The maximum number of search results Execution Management System should return during one Action Flow execution cycle.

Searches a sheet for the specified text.

Required Permissions: READ_SHEETS

Connection

Establish a connection to your Smartsheet account

Search

Enter the text to perform the search in the sheet.

Sheet

Select the sheet in which you want to perform the search.

Number of Returned Results

The maximum number of sheets Execution Management System should return during one Action Flow execution cycle.