Skip to Content

Smartsheet Get Sheet activity

Introduction

A Smartsheet Get Sheet activity, using its Smartsheet connection, retrieves a sheet from Smartsheet and is intended to be used as a source to provide data in an operation.

Create a Smartsheet Get Sheet activity

An instance of a Smartsheet Get Sheet activity is created from a Smartsheet connection using its Get Sheet activity type.

To create an instance of an activity, drag the activity type to the design canvas or copy the activity type and paste it on the design canvas. For details, see Create an activity instance in Component reuse.

An existing Smartsheet Get Sheet activity can be edited from these locations:

Configure a Smartsheet Get Sheet activity

Follow these steps to configure a Smartsheet Get Sheet activity:

Step 1: Enter a name and specify settings

In this step, provide a name for the activity and specify the sheet name and the number of rows to return. Each user interface element of this step is described below.

Smartsheet Get Sheet activity configuration step 1

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.

  • Name: Enter a name to identify the activity. The name must be unique for each Smartsheet Get Sheet activity and must not contain forward slashes / or colons :.

  • Enter a Sheet Name: Enter the name of the sheet.

  • Page Size: Enter the number of rows (between 1 and 100000) to retrieve from the sheet. The default value is 1000.

  • Save & Exit: If enabled, click to save the configuration for this step and close the activity configuration.

  • Next: Click to temporarily store the configuration for this step and continue to the next step. The configuration will not be saved until you click the Finished button on the last step.

  • Discard Changes: After making changes, click to close the configuration without saving changes made to any step. A message asks you to confirm that you want to discard changes.

Step 2: Review the data schemas

Any request or response schemas are displayed. Each user interface element of this step is described below.

Smartsheet Get Sheet activity configuration step 2

  • Data Schemas: These data schemas are inherited by adjacent transformations and are displayed again during transformation mapping.

    The Smartsheet connector uses the Smartsheet API 2.0. Refer to the API documentation for information on the schema nodes and fields.

    Tip

    The Data field returns a base64encoded file of the specified sheet. You can use a combination of Jitterbit's Base64Decode, BinaryToHex, and HexToString functions to convert base64binary to text:
    $smartsheetData = Base64Decode(BinaryToHex(HexToString($myData)));

  • Refresh: Click the refresh icon or the word Refresh to regenerate schemas from the Smartsheet endpoint. This action also regenerates a schema in other locations throughout the project where the same schema is referenced, such as in an adjacent transformation.

  • Back: Click to temporarily store the configuration for this step and return to the previous step.

  • Finished: Click to save the configuration for all steps and close the activity configuration.

  • Discard Changes: After making changes, click to close the configuration without saving changes made to any step. A message asks you to confirm that you want to discard changes.

Next steps

After configuring a Smartsheet Get Sheet activity, complete the configuration of the operation by adding and configuring other activities, transformations, or scripts as operation steps. You can also configure the operation settings, which include the ability to chain operations together that are in the same or different workflows.

Menu actions for an activity are accessible from the project pane and the design canvas. For details, see Activity actions menu in Connector basics.

Smartsheet Get Sheet activities can be used as a source with these operation patterns:

To use the activity with scripting functions, write the data to a temporary location and then use that temporary location in the scripting function.

When ready, deploy and run the operation and validate behavior by checking the operation logs.