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

Introduction

A Microsoft Excel v3 (Beta) Insert Rows activity, using its Microsoft Excel v3 (Beta) connection, writes one or more rows to a worksheet and is intended to be used as a target to consume data in an operation.

Create a Microsoft Excel v3 (Beta) Insert Rows activity

An instance of a Microsoft Excel v3 (Beta) Insert Rows activity is created from a Microsoft Excel v3 (Beta) connection using its Insert 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) Insert Rows activity can be edited from these locations:

• The design canvas (see Component actions menu in Design canvas).
• The project pane's Components tab (see Component actions menu in Project pane Components tab).

Configure a Microsoft Excel v3 (Beta) Insert Rows activity

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

• Step 1: Enter a name and select the workbook
  Provide a name for the activity and select the workbook to write to.

• Step 2: Select the worksheet
  Select the worksheet within the workbook and specify header row behavior.

• Step 3: Review the data schemas
  Any request or response schemas are displayed.

Step 1: Enter a name and select the workbook

In this step, provide a name for the activity and select the workbook to write to. 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) Insert 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.

• Optional settings: Click to expand additional optional settings:

  • Continue on error: Select to continue the activity execution if an error is encountered for a dataset in a batch request. If any errors are encountered, they are written to the operation log.

• 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: 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 a field for each column in the selected worksheet (derived from the header row), together with a rowNumber field indicating the row to insert. The response data schema returns, for each processed row, the path, sheetName, and rowNumber, a status of success or error, and, when an error occurs, an error object with cause and detailedMessage fields.

  Every field in the request data schema is typed as a string, but the value actually written to each cell is determined by the cell's format, as described in How values are written to cells.

  These data schemas are inherited by adjacent transformations and are 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.

How values are written to cells

When a Microsoft Excel v3 (Beta) Insert Rows activity writes a mapped value to a cell, it determines the value's data type using the value itself and the format of the target cell, in this order:

• Formula: If the value begins with an equal sign =, it's written as a formula and evaluated by Excel when the workbook is opened. If the text after the equal sign isn't a valid formula, the activity fails with an error.

• Boolean: If the value is exactly true or false (case-insensitive), it's written as a boolean value.

• Date or time: If the cell's number format is a date or time format, the value is parsed against common date and time patterns (for example, yyyy-MM-dd or HH:mm:ss). If the value matches one of these patterns, it's written as a date value; otherwise, it's written as text.

• Percentage: If the cell's number format is a percentage format, the value (with or without a trailing %) is parsed as a number and divided by 100.

• Fraction: If the cell's number format is a fraction format and the value contains a forward slash /, the value is parsed as a numerator and denominator and written as the resulting number.

• Number: If the cell's number format is General or a numeric format and the value can be parsed as a number, it's written as a number.

• Text: Any value that doesn't match one of the data types above is written as text.

Next steps

After configuring a Microsoft Excel v3 (Beta) Insert 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) Insert Rows activities can be used as a target with these operation patterns:

• Transformation pattern
• Two-transformation pattern (as the first or second target)

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.