Skip to Content

Microsoft Excel v3 (Beta) Read Rows activity in Jitterbit Studio

Introduction

A Microsoft Excel v3 (Beta) Read Rows activity, using its Microsoft Excel v3 (Beta) connection, reads rows from a worksheet and is intended to be used as a source to provide data in an operation.

Note

This connector is currently in beta. To provide feedback, contact the Jitterbit Product Team.

Create a Microsoft Excel v3 (Beta) Read Rows activity

An instance of a Microsoft Excel v3 (Beta) Read Rows activity is created from a Microsoft Excel v3 (Beta) connection using its Read Rows 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 Creating an activity instance in Component reuse.

An existing Microsoft Excel v3 (Beta) Read Rows activity can be edited from these locations:

Configure a Microsoft Excel v3 (Beta) Read Rows activity

Follow these steps to configure a Microsoft Excel v3 (Beta) Read Rows activity:

Step 1: Enter a name and select the workbook

In this step, provide a name for the activity and select the workbook to read from. Each user interface element of this step is described below.

  • 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 Microsoft Excel v3 (Beta) Read Rows activity and must not contain forward slashes / or colons :.

  • Select a workbook: This section displays workbook files available in the endpoint's configured folder.

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

    • Search: Enter a value into the search box to filter the list of workbook files. The search is not case-sensitive. If workbook files are already displayed within the table, the table results are filtered in real time with each keystroke. To reload workbook files 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 workbook files from the endpoint. This may be useful if workbook files have been added to the configured folder. This action refreshes all metadata used to build the table of workbook files displayed in the configuration.

    • Selecting a workbook: Within the table, click anywhere on a row to select a workbook. Only one workbook can be selected. The Name of each workbook file is fetched from the endpoint's configured folder.

    Tip

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

  • 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 is not 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: Select the worksheet

In this step, select the worksheet within the workbook and specify header row behavior. Each user interface element of this step is described below.

  • Select a worksheet: This section displays the worksheets available in the workbook selected in Step 1.

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

    • Search: Enter a value into the search box to filter the list of worksheets. The search is not case-sensitive. If worksheets are already displayed within the table, the table results are filtered in real time with each keystroke. To reload worksheets 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 worksheets from the endpoint. This may be useful if worksheets have been added to the workbook. This action refreshes all metadata used to build the table of worksheets displayed in the configuration.

    • Selecting a worksheet: Within the table, click anywhere on a row to select a worksheet. Only one worksheet can be selected. The Name of each worksheet is fetched from the selected workbook.

  • Specify Header Row: Select to indicate that the worksheet has a header row. Selected by default.

  • Header Row Number: Enter the row number of the header row. Accepts only numeric values. Defaults to 1. Available only when Specify Header Row is selected.

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

  • Next: Click to temporarily store the configuration for this step and continue to the next step. The configuration is not 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 3: Set read options

In this step, specify which rows to read and how blank lines and cell metadata are handled. Each user interface element of this step is described below.

  • Read By: Select how to determine which rows are read:

    • Define Rows Limit: (Default.) Reads a bounded span of full rows, set using the From and To fields.
    • Define Excel Range: Reads the specific Excel range entered in the Range field.

  • Range: Enter the Excel range to read, for example A1:D100. Available only when Read By is set to Define Excel Range.

  • From: Enter the first row number to read. Defaults to 1. Available only when Read By is set to Define Rows Limit.

  • To: Enter the last row number to read. Defaults to 100. Available only when Read By is set to Define Rows Limit.

  • Don't Read Blank Lines: Select to exclude blank rows from the rows read. Not selected by default.

  • Include Cell's Metadata: Select to include cell metadata. Not selected by default.

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

  • Next: Click to temporarily store the configuration for this step and continue to the next step. The configuration is not 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 4: Review the data schemas

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

  • Data schema: The request data schema contains either a range field or rowFrom and rowTo fields, matching the Read By selection in Step 3, together with an includeMetadata field. The response data schema returns, for each row read, the rowNumber together with a field for each column in the selected worksheet (derived from the header row).

    This data schema is inherited by adjacent transformations and is displayed again during transformation mapping.

    Note

    Data supplied in a transformation takes precedence over the activity configuration.

  • Refresh: Click the refresh icon or the word Refresh to regenerate schemas from the 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 Microsoft Excel v3 (Beta) Read Rows 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.

Microsoft Excel v3 (Beta) Read Rows 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.