Skip to end of metadata
Go to start of metadata

Introduction

A Google Sheets update sheets activity updates a spreadsheet at a Google Sheets connection and is used as a target in an operation. After configuring a Google Sheets connection, you can configure as many Google Sheets activities as you like for each Google Sheets connection.

Creating a Google Sheets Activity

From the design canvas, open the Connectivity tab of the design component palette:

Connectivity tab

Within the Endpoints filter, click the Google Sheets connection block to display activities that are available to be used with a Google Sheets connection:

Connectivity tab

To create an activity that can be configured, the activity must first be added to an operation on the design canvas. To add an activity to an operation, drag the activity block from the palette to the operation.

For more information about the parts of an operation and adding activities to operations, see Operation Creation and Configuration.

Accessing Menu Actions

After a Google Sheets activity has been added to an operation, menu actions for that activity are accessible from the project pane in either the Workflows or the Components tabs, and from the design canvas:

  • Project Pane: In the Workflows or Components tab of the project pane, hover over an activity name and click the actions menu icon to open the actions menu.

  • Design Canvas: Within the operation, click an existing activity block to open the actions menu.

Each of these menu actions is available:

  • View/Edit: This opens the activity configuration screen for you to configure the activity. For details, see Configuring a Google Sheets Update Sheets Activity later on this page.

  • Delete: This is used to permanently delete the activity.

  • Rename: This positions the cursor on the activity name in the project pane for you to make edits.

  • View Dependencies: This changes the view in the project pane to display any other parts of the project that the activity is dependent on.

  • Remove: Available only from the actions menu on the design canvas, this removes the activity as a step in the operation without deleting it from the project. When you remove an activity that is adjacent to a transformation, if schemas are provided within that activity, they will no longer be referenced by the transformation. Removed components can be accessed or permanently deleted from the project pane.

  • Deploy: This deploys the activity and any components it is dependent on.

  • Configurable Deploy: This opens the deployment screen, where you can select project components to deploy.

  • Add to group: This opens a prompt to create a new custom group or to add the component to an existing group.

  • Duplicate: This creates a copy of the activity as a new, unreferenced component. Upon creating the component copy, the cursor is positioned on the component name within the project pane for you to rename the component.

Configuring a Google Sheets Update Sheets Activity

Follow these steps to configure a Google Sheets update sheets activity:

  • Step 1 – Enter Basic Information
  • Step 2 – Review Data Schema

Step 1 – Enter Basic Information

Connectivity tab

TIP: Fields with a variable icon Variable icon support using global variables, project variables, and Jitterbit variables. Begin typing an open square bracket [ into the field or click the variable icon to display existing variables to choose from.

  • Name: Enter a name to use to identify the Google Sheets update sheets activity. The name must be unique for each update sheets activity and must not contain forward slashes (/) or colons (:).

  • Number of Columns: Enter the number of columns to be used when creating the spreadsheet (optional); if not provided, the default value of 26 is used.

  • 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 Discard Changes to close the configuration without saving changes made to any step. A message will ask you to confirm that you want to discard changes.

Step 2 – Review Data Schema

Connectivity tab

  • Data Schema: The request and response data schemas from Google Sheets will be displayed. If the operation uses a transformation, the data schemas will be displayed again later during the transformation mapping process, where you can map to target fields using source objects, scripts, variables, custom values, and more.

    The Google Sheets connector uses the Google Sheets API v4. Refer to the API documentation for information on the schema fields and practices for manipulating Google Sheets.

    • Request:

      Request Schema Field/NodeGoogle API Field/Method, typeNotes
      updateSheetsRequestspreadsheets.updateRequest to update a spreadsheet
      spreadsheetIdspreadsheetIdID of the spreadsheet to be updated
      titletitleSheet title
      requestnodeEach request is one of findReplaceRequest, addSheetRequest, updateSheetRequest, deleteSheetRequest, deleteCellRequest, or updateCellRequest
      findReplaceRequestFindReplaceRequestFinds and replaces data in cells over a range, sheet, or all sheets
      findStringThe value to search
      replacementStringThe value to use as the replacement
      matchCaseBooleanTrue if the search is case sensitive
      searchByRegexBooleanTrue if the find value is a regex. The regular expression and replacement should follow Java regex rules.
      matchEntireCellBooleanTrue if the find value should match the entire cell
      includeFormulasBooleanTrue if the search should include cells with formulas. False to skip cells with formulas.
      unionFieldsnodeUnion field scope: The scope over which to find/replace; one of SheetID, allSheets, or gridRange must be set
      SheetIDIntegerThe sheet to find/replace over
      allSheetsBooleanTrue to find/replace over all sheets
      gridRangeGridRangeA range on a sheet
      SheetIDIntegerThe sheet this range is on
      startRowIndexIntegerThe start row (inclusive) of the range, or not set if unbounded
      endRowIndexIntegerThe end row (exclusive) of the range, or not set if unbounded
      startColumnIndexIntegerThe start column (inclusive) of the range, or not set if unbounded
      endColumnIndexIntegerThe end column (exclusive) of the range, or not set if unbounded
      addSheetRequestAddSheetRequestAdds a new sheet
      SheetIDStringThe ID of the sheet; must be non-negative; this field cannot be changed once set
      titleStringThe name of the sheet
      indexIntegerThe index of the sheet within the spreadsheet
      hiddenBooleanTrue if the sheet is hidden in the UI, false if it's visible
      rightToLeftBooleanTrue if the sheet is an RTL (right-to-left language) sheet instead of an LTR (left-to-right language) sheet
      gridPropertiesGridPropertiesProperties of a grid
      rowCountIntegerThe number of rows in the grid
      columnCountIntegerThe number of columns in the grid
      frozenRowCountIntegerThe number of rows that are frozen in the grid
      frozenColumnCountIntegerThe number of columns that are frozen in the grid
      hideGridLinesBooleanTrue if the grid isn't showing gridlines in the UI
      rowGroupControlAfterBooleanTrue if the row grouping control toggle is shown after the group
      columnGroupControlAfterBooleanTrue if the column grouping control toggle is shown after the group
      updateSheetRequestnodeSheet to be updated
      SheetIDStringThe ID of the sheet; must be non-negative; this field cannot be changed once set
      titleStringThe name of the sheet
      indexIntegerThe index of the sheet within the spreadsheet
      hiddenBooleanTrue if the sheet is hidden in the UI, false if it's visible
      rightToLeftBooleanTrue if the sheet is an RTL (right-to-left language) sheet instead of an LTR (left-to-right language) sheet
      gridPropertiesGridPropertiesProperties of a grid
      rowCountIntegerThe number of rows in the grid
      columnCountIntegerThe number of columns in the grid
      frozenRowCountIntegerThe number of rows that are frozen in the grid
      frozenColumnCountIntegerThe number of columns that are frozen in the grid
      hideGridLinesBooleanTrue if the grid isn't showing gridlines in the UI
      rowGroupControlAfterBooleanTrue if the row grouping control toggle is shown after the group
      columnGroupControlAfterBooleanTrue if the column grouping control toggle is shown after the group
      deleteSheetRequestDeleteSheetRequestThe value to search
      SheetIDIntegerThe ID of the sheet to delete
      deleteCellRequestnodeCells to be deleted
      gridRangeGridRangeA range on a sheet
      SheetIDIntegerThe sheet this range is on
      startRowIndexIntegerThe start row (inclusive) of the range, or not set if unbounded
      endRowIndexIntegerThe end row (exclusive) of the range, or not set if unbounded
      startColumnIndexIntegerThe start column (inclusive) of the range, or not set if unbounded
      endColumnIndexIntegerThe end column (exclusive) of the range, or not set if unbounded
      shiftDimensionnodeHow to shift the remaining cells when deleting cells
      dimensionDimensionString, either 'ROWS' or 'COLUMNS'; indicates which dimension an operation should apply to
      updateCellRequestUpdateCellsRequestCells to be updated
      gridRangeGridRangeA range on a sheet
      SheetIDIntegerThe sheet this range is on
      startRowIndexIntegerThe start row (inclusive) of the range, or not set if unbounded
      endRowIndexIntegerThe end row (exclusive) of the range, or not set if unbounded
      startColumnIndexIntegerThe start column (inclusive) of the range, or not set if unbounded
      endColumnIndexIntegerThe end column (exclusive) of the range, or not set if unbounded
      dataGridDataNode representing the data for the sheet for updating
      rowRowDataNode representing a row of the sheet for updating
      A…Zn/aString data for columns of a sheet; by default, 26 columns
    • Response:

      Response Schema Field/NodeGoogle API FieldNotes
      updateSheetsResponsen/aResponse from creating the spreadsheet
      spreadsheetIdspreadsheetIdID of the newly-updated spreadsheet
      sheetsn/aNode representing the spreadsheet
      propertiesn/aNode representing the properties returned
      coden/aError code returned (if any)
      messagen/aMessage returned upon creation (if any)
  • Add Plugin(s): Plugins are Jitterbit- or user-provided applications that extend Harmony's native capabilities. To apply a plugin to the activity, click to expand this section and select the checkbox next to the plugin to be used. For additional instructions on using plugins, including details on setting any required variables used by the plugin, see Plugins Added to an Activity.

  • 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 Discard Changes to close the configuration without saving changes made to any step. A message will ask you to confirm that you want to discard changes.

Next Steps

After configuring a Google Sheets update sheets activity, complete the configuration of the operation by adding and configuring other activities, transformations, or scripts as operation steps. You can also configure an operation's operation settings, which include the ability to chain operations together that are in the same or different workflows.

Google Sheets update sheets activities can be used as a target with these operation patterns:

Other patterns are not valid using Google Sheets update sheets activities. See the validation patterns on the Operation Validity page.

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.

On This Page

Last updated:  Dec 20, 2019

  • No labels