Skip to Content

Smartsheet Import Sheet activity in Jitterbit Studio

Introduction

A Smartsheet Import Sheet activity, using its Smartsheet connection, imports a sheet into Smartsheet and is intended to be used as a target to consume data in an operation.

Create a Smartsheet Import Sheet activity

An instance of a Smartsheet Import Sheet activity is created from a Smartsheet connection using its Import 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 or tool instance in Component reuse.

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

Configure a Smartsheet Import Sheet activity

Follow these steps to configure a Smartsheet Import Sheet activity:

Step 1: Enter a name and specify settings

In this step, provide a name for the activity and specify a workspace, sheet name, and file type. Each user interface element of this step is described below.

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 menu listing existing variables to choose from.

  • Endpoint menu: If you have multiple endpoints of the same connector type configured, a menu at the top of the screen displays the current endpoint name. Click the menu to switch to a different endpoint. For more information, see Change the assigned endpoint in Configuration screens.

    • Edit endpoint: Appears when you hover over the current endpoint name. Click to edit the currently selected endpoint's connection configuration.

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

  • Choose option: Specify how to identify the workspace to import the sheet into, either Enter workspace ID or Select a workspace.

    A workspace can also be specified in the request transformation. If a workspace is specified in more than one place, this order of precedence is followed:

    1. A workspace provided in the request transformation overrides both options below.
    2. A workspace entered in the Workspace ID field overrides a workspace selected from the Select a workspace list, even if Select a workspace is the selected option.
    3. A workspace selected from the Select a workspace list has the lowest precedence.

  • Enter workspace ID: (Default.) Select this option to manually enter the ID of the workspace to import the sheet into:

    • Workspace ID: Enter the ID of the workspace. Leave this field blank to import the sheet into your Smartsheet home Sheets folder.

  • Select a workspace: Select this option to choose from a list of workspaces retrieved from the Smartsheet endpoint:

    • Select a workspace: This section displays workspaces available in the Smartsheet endpoint.

      • Selected workspace: After a workspace is selected, it is listed here.

      • Search: Enter any column's value into the search box to filter the list of workspaces. The search is not case-sensitive. If workspaces are already displayed within the table, the table results are filtered in real time with each keystroke. To reload workspaces from the endpoint when searching, enter search criteria and then refresh, as described below.

      • Refresh: Click the refresh icon or the word Refresh to reload workspaces from the Smartsheet endpoint. This may be useful if workspaces have been added. This action refreshes all metadata used to build the table of workspaces displayed in the configuration.

      • Selecting a workspace: Within the table, click anywhere on a row to select a workspace. Only one workspace can be selected. The information available for each workspace is fetched from the Smartsheet endpoint:

        • Workspace Name: The name of the workspace.

        • Workspace ID: The ID of the workspace.

    Important

    This activity supports listing up to 100 workspaces in the table. If your credentials enable access to over 100 workspaces, manually enter the Workspace ID or supply it in the request transformation.

    If the table does not populate with available workspaces, the Smartsheet connection may not be successful. Ensure you are connected by reopening the connection and retesting the credentials.

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

  • File Type to Import: Select a file type for the sheet, either CSV or XLSX.

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

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

    Note

    Data supplied in a transformation takes precedence over the activity configuration. The Workspace ID can be provided or overridden in the request transformation.

    The Data field must be a base64binary containing the contents of the sheet. You can use a combination of Jitterbit's Base64Encode, HexToBinary, and StringToHex functions to convert data to base64binary:
    $smartsheetData = Base64Encode(HexToBinary(StringToHex($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 Import Sheet activity, complete the configuration of the operation by adding and configuring other activities or tools 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 Import Sheet activities can be used as a target 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.