# mulesoft Microsoft Excel Online Connector - Full Documentation

<!-- document id=24d929b1eb14bc3b8ccf39fa0805295aa57d7c80f09712b7901edb6438f49f38 url=/mulesoft/current/en-us/microsoft-excel-online-connector/latest/index.md -->

---
product: Microsoft Excel Online Connector
version: 1.1
is-latest-version: true
---

# Microsoft Excel Online Connector 1.1

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

Anypoint Connector for Microsoft Excel Online (Excel Online Connector) gives you access to the Excel
platform. This connector exposes the most commonly used operations provided by the Microsoft Excel
Online API.

For compatibility information and fixed issues, see the Microsoft Excel Online Connector Release
Notes.

## Before You Begin

To use this connector, you must be familiar with:

- The Microsoft Excel Online API

- Anypoint Connectors

- Mule runtime engine (Mule)

- Elements and global elements in a Mule flow

- Creating a Mule app using Anypoint Studio or Anypoint Code Builder

Before creating an app, you must have:

- Credentials to access the Excel target resource

- Anypoint Studio or Anypoint Code Builder

## Common Use Cases for the Connector

Some possible uses for this connector include:

- Sales

  - Organize your company’s sales in a spreadsheet to perform cost studies, inventory management, or
    production scheduling.

  - Create a chart of your company’s inventory and analyze that data to encourage your customers to
    buy certain items.

- Data

  - Visualize and share data regarding your customers, subscriptions, orders, charges, refunds, and
    events.

## Authentication Type

Microsoft Excel Online Connector uses the OAuth 2.0 authentication type, which delegates user
authentication to the service hosting the user account.

## Next Step

After you complete the prerequisites, you are ready to create your own app and configure the
connector using [Anypoint Studio](https://docs.mulesoft.com/microsoft-excel-online-connector/latest/microsoft-excel-online-connector-studio).

## See Also

- [Introduction to Anypoint Connectors](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors)

- [Use Exchange to Discover Connectors, Templates, and Examples](https://docs.mulesoft.com/connectors/introduction/intro-use-exchange)

- [Salesforce Help](https://help.salesforce.com)

<!-- document id=cef0ccc259a8cc0a0960f5983e07020e4543b20765e1c72aa0e6b69ba9363d71 url=/mulesoft/current/en-us/microsoft-excel-online-connector/latest/microsoft-excel-online-connector-examples.md -->

---
product: Microsoft Excel Online Connector
version: 1.1
is-latest-version: true
---

# Microsoft Excel Online Connector 1.1 Examples

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

This example shows you how to use Microsoft Excel Online Connector to perform the following actions:

- [Add a worksheet](#add-a-worksheet)

- [List a worksheet](#list-a-worksheet)

- [Update a worksheet](#update-a-worksheet)

- [Delete a worksheet](#delete-a-worksheet)

## Configure OAuth Authorization

Because this connector uses OAuth to secure connections, you must specify OAuth field values, such
as client credentials, keys, and OAuth-related URLs. To do this:

- Create a configuration file for the OAuth connection.

- Configure the OAuth-related global elements.

- Configure a global element for the properties file.

### Create a Configuration File for the OAuth Connection

Create a configuration file for the OAuth connection that includes properties for the
`Authorization Code` grant type:

1.  Create a file named `mule-app.properties` in the `/src/main/resources/` folder.

2.  In the `mule-app.properties` file, create a set of properties for the `Authorization Code` grant
    type, similar to the ones that follow, replacing the bracketed text (including the brackets)
    with the correct values for your OAuth configuration:

    config.oauth.authorization.code.consumerKey=<consumerKey>
    config.oauth.authorization.code.consumerSecret=<consumerSecret>
    config.oauth.authorization.code.authorizationUrl=<authorizationUrl>
    config.oauth.authorization.code.accessTokenUrl=<accessTokenUrl>

For more information about creating a properties file, see
[Configuring Property Placeholders](https://docs.mulesoft.com/mule-runtime/latest/mule-app-properties-to-configure).

### Configure the OAuth Global Elements

Configure global elements for the `OAuth_Authorization_Code_Config` file:

1.  Create a new Mule project.

2.  In the **Mule Palette** view, click **Search in Exchange** and enter `microsoft excel`.

3.  Add **Microsoft Excel Online Connector** to the **Selected modules** section and click
    **Finish**.

4.  Click the **Global Elements** tab and click **Create**.

5.  Select **Connector Configuration > Microsoft Excel Online Authorization Code Config** and click
    **OK**.

6.  Enter the following values:

    <table><colgroup><col> <col></colgroup><thead><tr><th>Field</th><th>Value</th></tr></thead><tbody><tr><td><p>Name</p></td><td><p><code>OAuth_Authorization_Code_Config</code></p></td></tr><tr><td><p>Consumer key</p></td><td><p><code>${config.oauth.authorization.code.consumerKey}</code></p></td></tr><tr><td><p>Consumer secret</p></td><td><p><code>${config.oauth.authorization.code.consumerSecret}</code></p></td></tr><tr><td><p>Authorization url</p></td><td><p><code>${config.oauth.authorization.code.authorizationUrl}</code></p></td></tr><tr><td><p>Access token url</p></td><td><p><code>${config.oauth.authorization.code.accessTokenUrl}</code></p></td></tr><tr><td><p>Scopes</p></td><td><p>Leave the default: <code>https://graph.microsoft.com/.default</code></p></td></tr><tr><td><p>Listener config</p></td><td><p><code>auth</code></p></td></tr><tr><td><p>Callback path</p></td><td><p><code>/callback</code></p></td></tr><tr><td><p>Authorize path</p></td><td><p><code>authorizePath</code></p></td></tr><tr><td><p>External callback url</p></td><td><p><code>http://localhost:8083/callback</code></p></td></tr></tbody></table>

7.  Click **OK**.

### Configure a Global Element for the Properties File

Configure a global element for the `mule-app.properties` file so that Mule knows where to find it:

1.  Click the **Global Elements** tab and click **Create**.

2.  In the **Choose Global Type** dialog, select **Configuration properties** and click **OK**.

3.  In the **File** field, enter `mule.app.properties`.

4.  Click **OK**.

## Add a Worksheet

The following screenshot shows the Studio app flow for adding a new worksheet:

![Add Worksheet Studio flow](/mulesoft/current/en-us/microsoft-excel-online-connector/latest/_images/microsoft-excel-online-add-worksheet.png)

Figure 1. Use a flow like this one to add a new worksheet.

Adding a new worksheet involves configuring an HTTP **Listener** component, **Transform Message**
component, **Add worksheet** operation, and **Logger** component.

To create the flow:

1.  Create a new Mule project in Studio.

2.  In the **Mule Palette** view, search for **HTTP** and select the **Listener** operation.

3.  Drag the **Listener** operation onto the canvas.

4.  In the **Listener** configuration, click **+** next to the **Connector configuration** field to
    add a global element.

5.  Accept the defaults.

6.  In the HTTP properties window, set the **Path** field to `/create`.

### Add the Transform Message Component

The first **Transform Message** component creates a template for the input used to create the team:

1.  In the **Mule Palette** view, search for **transform message**.

2.  Drag the **Transform Message** component onto the canvas, to the right of the **Listener**
    component.

3.  In the **Transform Message** configuration, overlay the brackets in the **Output** section with
    this XML:

    ```xml
    <ee:set-payload ><![CDATA[%dw 2.0
    output application/json
    ---
    {
    	workbookId: attributes.queryParams.workbookID,
    	worsheetname: attributes.queryParams.worksheetName
    }]]></ee:set-payload>
    ```

### Add the Add Worksheet Operation

The **Add Worksheet** operation creates a new worksheet based on user input:

1.  Drag the **Add worksheet** operation onto the canvas, to the right of the **Transform Message**
    component.

2.  In the Add worksheet configuration, click the **Connector configuration** dropdown and select
    **Microsoft-Excel-Online-Authorization-Code-Config**.

3.  Select **Microsoft\_Excel\_Online\_Authorization\_Code\_Config** as the global element type and
    click **OK**.

4.  Configure the following fields in the Add worksheet properties window:

    <table><colgroup><col> <col></colgroup><thead><tr><th>Field</th><th>Value</th></tr></thead><tbody><tr><td><p>Workbook Id</p></td><td><p><code>payload.workbookId</code></p></td></tr><tr><td><p>Worksheet Name</p></td><td><p><code>payload.worsheetname</code></p></td></tr></tbody></table>

## List a Worksheet

Create a second flow to list a worksheet. Use the **List worksheet** operation in this flow:

![List Worksheet Studio flow](/mulesoft/current/en-us/microsoft-excel-online-connector/latest/_images/microsoft-excel-online-list-worksheet.png)

Figure 2. Use a flow like this one to list a worksheet.

## Update a Worksheet

Create a third flow to update information about a worksheet. Use the **Update worksheet** operation
in this flow:

![Update Worksheet Studio flow](/mulesoft/current/en-us/microsoft-excel-online-connector/latest/_images/microsoft-excel-online-update-worksheet.png)

Figure 3. Use a flow like this one to update information about a worksheet.

## Delete a Worksheet

Create a fourth flow to delete a worksheet. Use the **Delete worksheet** operation in this flow:

![Delete Worksheet Studio flow](/mulesoft/current/en-us/microsoft-excel-online-connector/latest/_images/microsoft-excel-online-delete-worksheet.png)

Figure 4. Use a flow like this one to delete a worksheet.

## Run the App

To run the app:

1.  Right-click the project in Package Explorer and select **Run As > Mule Application**.

2.  After the app deploys, open a web browser.

3.  Enter the following URL to start the OAuth dance: `http://localhost:8081/authorize`.

4.  In the login screen, enter the login information used to access Microsoft Excel Online and click
    **Login**.

5.  Click **Allow**.

6.  Initiate a flow by entering the associated URL, as shown in the following table:

    <table><colgroup><col> <col> <col></colgroup><thead><tr><th>Flow</th><th>URL</th><th>Notes</th></tr></thead><tbody><tr><td><p>Add a worksheet</p></td><td><p><code><a href="http://localhost:8081/create?workbookID={workbookID}&amp;worksheetName={worksheetName}">http://localhost:8081/create?workbookID={workbookID}&amp;worksheetName={worksheetName}</a></code></p></td><td></td></tr><tr><td><p>List a worksheet</p></td><td><p><code><a href="http://localhost:8081/list?workbookID={workbookID}">http://localhost:8081/list?workbookID={workbookID}</a></code></p></td><td></td></tr><tr><td><p>Update a worksheet</p></td><td><p><code><a href="http://localhost:8081/update?workbookID={workbookID}&amp;worksheetName={worksheetName}&amp;worksheetUpdateName={worksheetUpdateName}">http://localhost:8081/update?workbookID={workbookID}&amp;worksheetName={worksheetName}&amp;worksheetUpdateName={worksheetUpdateName}</a></code></p></td><td></td></tr><tr><td><p>Delete a worksheet</p></td><td><p><code><a href="http://localhost:8081/delete?workbookID={workbookID}&amp;worksheetName={worksheetName}">http://localhost:8081/delete?workbookID={workbookID}&amp;worksheetName={worksheetName}</a></code></p></td><td></td></tr></tbody></table>

## XML for the Examples

Paste this XML code into the **Configuration XML** tab in your project to experiment with the flows
described in the previous sections. When you paste this code, click **Yes** on the **Regenerate
'doc:id' Values** dialog.

```xml
<?xml version="1.0" encoding="UTF-8"?>

<mule xmlns:ee="http://www.mulesoft.org/schema/mule/ee/core" xmlns:excel="http://www.mulesoft.org/schema/mule/excel"
	xmlns:http="http://www.mulesoft.org/schema/mule/http"
	xmlns="http://www.mulesoft.org/schema/mule/core" xmlns:doc="http://www.mulesoft.org/schema/mule/documentation" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.mulesoft.org/schema/mule/core http://www.mulesoft.org/schema/mule/core/current/mule.xsd
http://www.mulesoft.org/schema/mule/http http://www.mulesoft.org/schema/mule/http/current/mule-http.xsd
http://www.mulesoft.org/schema/mule/excel http://www.mulesoft.org/schema/mule/excel/current/mule-excel.xsd
http://www.mulesoft.org/schema/mule/ee/core http://www.mulesoft.org/schema/mule/ee/core/current/mule-ee.xsd">
	<http:listener-config name="HTTP_Listener_config" doc:name="HTTP Listener config" doc:id="b67a7f0e-9d8f-43ee-b3d8-0a2f86fe10c5" >
		<http:listener-connection host="0.0.0.0" port="8081" />
	</http:listener-config>
	<excel:authorization-code-config name="Microsoft_Excel_Online_Authorization_Code_Config" doc:name="Microsoft Excel Online Authorization Code Config" doc:id="a03ea31c-ab5c-4508-ae87-91485d0d9201" >
		<excel:oauth-authorization-code-connection >
			<excel:oauth-authorization-code consumerKey="${consumerKey}" consumerSecret="${consumerSecret}" authorizationUrl="${authorizationUrl}" accessTokenUrl="${accessTokenUrl}" scopes="${scopes}" resourceOwnerId="${resourceOwnerId}"/>
			<excel:oauth-callback-config listenerConfig="HTTP_Listener_config" callbackPath="/callback" authorizePath="/authorize" externalCallbackUrl="http://localhost:8081/callback" />
		</excel:oauth-authorization-code-connection>
	</excel:authorization-code-config>
	<configuration-properties doc:name="Configuration properties" doc:id="2820ecc1-e8be-4b5f-8d6e-5eb3afaf1732" file="mule-app.properties" />
	<flow name="create-flow" doc:id="fcdaa88d-173a-4213-aaef-65bdcf384f03" >
		<http:listener doc:name="Listener" doc:id="f6a51e00-2be8-4524-9e39-cd4e3387b5e0" config-ref="HTTP_Listener_config" path="/create"/>
		<ee:transform doc:name="Transform Message" doc:id="f277839a-9e59-4d2a-9d53-c4d2f012ae90" >
			<ee:message >
				<ee:set-payload ><![CDATA[%dw 2.0
output application/json
---
{
	workbookId: attributes.queryParams.workbookID,
	worsheetname: attributes.queryParams.worksheetName
}]]></ee:set-payload>
			</ee:message>
		</ee:transform>
		<excel:add-worksheet doc:name="Add worksheet" doc:id="071f5319-16ae-43dc-9420-bf47479eb3d1" config-ref="Microsoft_Excel_Online_Authorization_Code_Config" workbookId="#[payload.workbookId]" worksheetName="#[payload.worsheetname]"/>
		<logger level="INFO" doc:name="Logger" doc:id="9dd54e43-357e-454d-94ff-ccace4bcb580" message="Worksheet ID : #[payload.id]"/>
	</flow>
	<flow name="list-flow" doc:id="5b1b8836-f3a2-445e-b495-c80d93dcd82d" >
		<http:listener doc:name="Listener" doc:id="0ffa794c-37a4-4c57-a14d-da7009fa504f" config-ref="HTTP_Listener_config" path="/list" />
		<ee:transform doc:name="Transform Message" doc:id="f71f89a7-0f51-44ba-9e46-18e6f8dcc8c8" >
			<ee:message >
				<ee:set-payload ><![CDATA[%dw 2.0
output application/json
---
{
	workbookId: attributes.queryParams.workbookID
}]]></ee:set-payload>
			</ee:message>
		</ee:transform>
		<excel:list-worksheet doc:name="List worksheet" doc:id="5e576012-f3a1-428a-b20f-d9d5a3442398" config-ref="Microsoft_Excel_Online_Authorization_Code_Config" workbookId="#[payload.workbookId]"/>
	</flow>
	<flow name="update-flow" doc:id="0cfe6bad-85e8-4e61-9688-52c6b37a93a8" >
		<http:listener doc:name="Listener" doc:id="6c874287-c011-4b19-b3e8-55744003f0f6" config-ref="HTTP_Listener_config" path="/update"/>
		<ee:transform doc:name="Transform Message" doc:id="d0697ad3-e842-48cd-b0c4-016dd65a712e" >
			<ee:message >
				<ee:set-payload ><![CDATA[%dw 2.0
output application/json
---
{
		name : attributes.queryParams.worksheetUpdateName
}]]></ee:set-payload>
			</ee:message>
		</ee:transform>
		<excel:update-worksheet doc:name="Update worksheet" doc:id="983a65bc-584b-4199-867d-abfb9cf09bcb" config-ref="Microsoft_Excel_Online_Authorization_Code_Config" workbookId="#[attributes.queryParams.workbookID]" worksheetId="#[attributes.queryParams.worksheetName]">
		</excel:update-worksheet>
	</flow>
	<flow name="delete-flow" doc:id="c989f49f-809c-4593-95dc-f93f8634c609" >
		<http:listener doc:name="Listener" doc:id="f6e8d004-e264-48c1-85cf-b2ce5a0135d6" config-ref="HTTP_Listener_config" path="/delete"/>
		<ee:transform doc:name="Transform Message" doc:id="ea4da82b-cd40-4bf6-b8c7-04efe280d835" >
			<ee:message >
				<ee:set-payload ><![CDATA[%dw 2.0
output application/json
---
{
	workbookId: attributes.queryParams.workbookID,
	worksheetName: attributes.queryParams.worksheetName
}]]></ee:set-payload>
			</ee:message>
		</ee:transform>
		<excel:delete-worksheet doc:name="Delete worksheet" doc:id="183fb53f-0c3d-42c2-8676-df485f9a5f43" config-ref="Microsoft_Excel_Online_Authorization_Code_Config" workbookId="#[payload.workbookId]" worksheetId="#[payload.worksheetName]"/>
	</flow>
</mule>
```

<!-- document id=349ec47f63f6985c27b29a7aad6d25683ff7c9b10b69f2a55e8d254ac2ff65e3 url=/mulesoft/current/en-us/microsoft-excel-online-connector/latest/microsoft-excel-online-connector-reference.md -->

---
product: Microsoft Excel Online Connector
version: 1.1
is-latest-version: true
---

# Microsoft Excel Online Connector 1.1 Reference

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

Anypoint Connector for Microsoft Excel Online (Excel Online Connector) gives you access to the most
commonly used operations provided by the Microsoft Excel Online API.

Microsoft Excel Online Connector API has some limitations. See the following link for more details:
[https://learn.microsoft.com/en-us/connectors/excelonline/](https://learn.microsoft.com/en-us/connectors/excelonline/)

## Configurations

---

### Authorization Code Config

#### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Name</p></td><td><p>String</p></td><td><p>Name for this configuration. Connectors reference the configuration with this name.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Connection</p></td><td><div><div><p><a href="#AuthorizationCodeConfig_OauthAuthorizationCode">OAuth v2.0 Authorization Code</a></p></div></div></td><td><p>The connection types to provide to this configuration.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>Response timeout for the request. The ones specified here will overwrite the default ones specified in the config.</p></td><td><p>30</p></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Response timeout unit for the request. The ones specified here will overwrite the default ones specified in the config.</p></td><td><p>SECONDS</p></td><td></td></tr><tr><td><p>Encoding</p></td><td><div><div><p>String</p></div></div></td><td><p>Canonical name of the encoding. See Oracle’s supported encodings at <a href="https://docs.oracle.com/javase/7/docs/technotes/guides/intl/encoding.doc.html">https://docs.oracle.com/javase/7/docs/technotes/guides/intl/encoding.doc.html</a>.</p></td><td></td><td></td></tr><tr><td><p>Name</p></td><td><div><div><p>String</p></div></div></td><td><p>The identifier of this element used to reference it in other components</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Expiration Policy</p></td><td><div><div><p><a href="#ExpirationPolicy">Expiration Policy</a></p></div></div></td><td><p>Configures the minimum amount of time that a dynamic configuration instance can remain idle before Mule considers it eligible for expiration. This does not mean that the platform expires the instance at the exact moment that it becomes eligible. Mule purges the instances as appropriate.</p></td><td></td><td></td></tr></tbody></table>

#### Connection Types

##### OAuth v2.0 Authorization Code

Use OAuth 2.0 to delegate user authentication to the service hosting the user account. For more
information, refer to
[Configuring OAuth 2.0 for Connectors](https://docs.mulesoft.com/connectors/introduction/intro-config-oauth2),
[Configuring OAuth 2.0 for Connectors on CloudHub](https://docs.mulesoft.com/connectors/introduction/intro-config-oauth2-cloudhub),
or [OAuth Support in the SDK](https://docs.mulesoft.com/mule-sdk/latest/oauth).

###### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Proxy configuration</p></td><td><div><div><p><a href="#ProxyConfiguration">Proxy Configuration</a></p></div></div></td><td><p>Proxy configuration for the connector.</p></td><td></td><td></td></tr><tr><td><p>Response Type</p></td><td><div><div><p>String</p></div></div></td><td><p>Specifies the method to use to send the resulting token back to your app. It must be <code>query</code>.</p></td><td><p>query</p></td><td></td></tr><tr><td><p>TLS configuration</p></td><td><div><div><p><a href="#Tls">TLS</a></p></div></div></td><td><p>Defines a configuration for TLS, which can be used from both the client and server sides to secure communication for the Mule app. If HTTPS is configured as the protocol, then, at a minimum, the user must configure the keystore configuration.</p></td><td></td><td></td></tr><tr><td><p>Reconnection</p></td><td><div><div><p><a href="#Reconnection">Reconnection</a></p></div></div></td><td><p>When the application is deployed, a connectivity test is performed on all connectors. If set to <code>true</code>, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy.</p></td><td></td><td></td></tr><tr><td><p>Consumer Key</p></td><td><div><div><p>String</p></div></div></td><td><p>OAuth consumerKey as registered with the service provider.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Consumer Secret</p></td><td><div><div><p>String</p></div></div></td><td><p>OAuth consumerSecret as registered with the service provider.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Authorization Url</p></td><td><div><div><p>String</p></div></div></td><td><p>The service provider’s authorization endpoint URL.</p></td><td><p>https://login.microsoftonline.com/{tenant}/oauth2/v2.0/authorize</p></td><td></td></tr><tr><td><p>Access Token Url</p></td><td><div><div><p>String</p></div></div></td><td><p>The service provider’s accessToken endpoint URL.</p></td><td><p>https://login.microsoftonline.com/{tenant}/oauth2/v2.0/token</p></td><td></td></tr><tr><td><p>Scopes</p></td><td><div><div><p>String</p></div></div></td><td><p>The OAuth scopes to request during the OAuth dance. If not provided, this value defaults to those in the annotation.</p></td><td></td><td></td></tr><tr><td><p>Resource Owner Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The resourceOwnerId that each component should use if it is not otherwise referenced.</p></td><td></td><td></td></tr><tr><td><p>Before</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of a flow to execute immediately before starting the OAuth dance.</p></td><td></td><td></td></tr><tr><td><p>After</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of a flow to execute immediately after an accessToken is received.</p></td><td></td><td></td></tr><tr><td><p>Listener Config</p></td><td><div><div><p>String</p></div></div></td><td><p>A reference to an &lt;http:listener-config /&gt; to use to create the listener that receives the access token callback endpoint.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Callback Path</p></td><td><div><div><p>String</p></div></div></td><td><p>Path of the access token callback endpoint.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Authorize Path</p></td><td><div><div><p>String</p></div></div></td><td><p>Path of the local HTTP endpoint that triggers the OAuth dance.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>External Callback Url</p></td><td><div><div><p>String</p></div></div></td><td><p>If the callback endpoint is behind a proxy or must be accessed through a non direct URL, use this parameter to tell the OAuth provider the URL to use to access the callback.</p></td><td></td><td></td></tr><tr><td><p>Object Store</p></td><td><div><div><p>String</p></div></div></td><td><p>A reference to the object store to use to store each resource owner ID’s data. If not specified, Mule automatically provisions the default one.</p></td><td></td><td></td></tr></tbody></table>

## Associated Operations

- [Add Chart](#AddChart)

- [Add Named Item](#AddNamedItem)

- [Add Named Item Formula Local](#AddNamedItemFormulaLocal)

- [Add Rows](#AddRows)

- [Add Table](#AddTable)

- [Add Worksheet](#AddWorksheet)

- [Calculate Workbook Application](#CalculateWorkbookApplication)

- [Chart Set Position](#ChartSetPosition)

- [Create Chart Series](#CreateChartSeries)

- [Create Table Column](#CreateTableColumn)

- [Delete Chart](#DeleteChart)

- [Delete Row](#DeleteRow)

- [Delete Table](#DeleteTable)

- [Delete Worksheet](#DeleteWorksheet)

- [Get Cell](#GetCell)

- [Get Chart](#GetChart)

- [Get Chart Image](#GetChartImage)

- [Get Chart Item At](#GetChartItemAt)

- [Get Columns After Range](#GetColumnsAfterRange)

- [Get Columns Before Range](#GetColumnsBeforeRange)

- [Get Named Item](#GetNamedItem)

- [Get Offset Range](#GetOffsetRange)

- [Get Range](#GetRange)

- [Get Range Cell](#GetRangeCell)

- [Get Range Column](#GetRangeColumn)

- [Get Range Entire Column](#GetRangeEntireColumn)

- [Get Range Entire Row](#GetRangeEntireRow)

- [Get Range Format](#GetRangeFormat)

- [Get Range Intersection](#GetRangeIntersection)

- [Get Range Last Cell](#GetRangeLastCell)

- [Get Range Last Column](#GetRangeLastColumn)

- [Get Range Last Row](#GetRangeLastRow)

- [Get Range Row](#GetRangeRow)

- [Get Range Visible View](#GetRangeVisibleView)

- [Get Resized Range](#GetResizedRange)

- [Get Row](#GetRow)

- [Get Rows Above Range](#GetRowsAboveRange)

- [Get Rows Below Range](#GetRowsBelowRange)

- [Get Table](#GetTable)

- [Get Table Range](#GetTableRange)

- [Get Used Range](#GetUsedRange)

- [Get Workbook Application](#GetWorkbookApplication)

- [Get Workbook Comment](#GetWorkbookComment)

- [Get Worksheet](#GetWorksheet)

- [Insert Range](#InsertRange)

- [List Chart Series](#ListChartSeries)

- [List Charts](#ListCharts)

- [List Columns](#ListColumns)

- [List Named Item](#ListNamedItem)

- [List Names](#ListNames)

- [List Pivot Tables](#ListPivotTables)

- [List Rows](#ListRows)

- [List Tables](#ListTables)

- [List Workbook Comments](#ListWorkbookComments)

- [List Worksheet](#ListWorksheet)

- [Range Bounding Rect](#RangeBoundingRect)

- [Range Clear](#RangeClear)

- [Range Delete](#RangeDelete)

- [Range Get Used Range](#RangeGetUsedRange)

- [Range Merge](#RangeMerge)

- [Range Unmerge](#RangeUnmerge)

- [Reset Chart Data](#ResetChartData)

- [Unauthorize](#Unauthorize)

- [Update Chart](#UpdateChart)

- [Update Named Item](#UpdateNamedItem)

- [Update Range](#UpdateRange)

- [Update Range Format](#UpdateRangeFormat)

- [Update Row](#UpdateRow)

- [Update Table](#UpdateTable)

- [Update Worksheet](#UpdateWorksheet)

## Associated Sources

- [On New Row Listener](#NewRowListener)

- [On New Worksheet Listener](#NewWorksheetListener)

- [On Updated Row Listener](#UpdatedRowListener)

## Operations

## Add Chart

`<excel:add-chart>`

Creates a new chart.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Workbook Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the workbook.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Worksheet Name</p></td><td><div><div><p>String</p></div></div></td><td><p>The name of the worksheet.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Chart Body</p></td><td><div><div><p>Any</p></div></div></td><td><p>The body of the chart to add.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>The name of the configuration to use to execute this component.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Response timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>Response timeout for the request. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Response timeout unit for the request. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Custom headers</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers that the request will include. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Custom query parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters that the request will include. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p>Binary</p></div></div></td></tr></tbody></table>

### For Configurations

- [Authorization Code Config](#AuthorizationCodeConfig)

### Throws

- EXCEL:BAD\_REQUEST

- EXCEL:CONNECTIVITY

- EXCEL:FORBIDDEN

- EXCEL:INVALID\_CONNECTION

- EXCEL:INVALID\_CREDENTIALS

- EXCEL:NOT\_FOUND

- EXCEL:RETRY\_EXHAUSTED

- EXCEL:SERVER\_ERROR

- EXCEL:TIMEOUT

## Add Named Item

`<excel:add-named-item>`

Adds a new name to the collection of a given scope using the user’s locale for the formula.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Workbook Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the workbook where rows are added.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Name</p></td><td><div><div><p>String</p></div></div></td><td><p>The name of the named item.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Reference</p></td><td><div><div><p>String</p></div></div></td><td><p>The formula or the range that the name will refer to.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Workbook Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The comment associated with the named item.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>The name of the configuration to use to execute this component.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Response timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>Response timeout for the request. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Response timeout unit for the request. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Custom headers</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers that the request will include. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Custom query parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters that the request will include. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p>Binary</p></div></div></td></tr></tbody></table>

### For Configurations

- [Authorization Code Config](#AuthorizationCodeConfig)

### Throws

- EXCEL:BAD\_REQUEST

- EXCEL:CONNECTIVITY

- EXCEL:FORBIDDEN

- EXCEL:INVALID\_CONNECTION

- EXCEL:INVALID\_CREDENTIALS

- EXCEL:NOT\_FOUND

- EXCEL:RETRY\_EXHAUSTED

- EXCEL:SERVER\_ERROR

- EXCEL:TIMEOUT

## Add Named Item Formula Local

`<excel:add-named-item-formula-local>`

Adds a new name to the collection of a given scope using the user’s locale for the formula.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Workbook Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the workbook.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Worksheet Name</p></td><td><div><div><p>String</p></div></div></td><td><p>The Id of the worksheet.</p></td><td></td><td></td></tr><tr><td><p>Name</p></td><td><div><div><p>String</p></div></div></td><td><p>The name of the named item.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Reference</p></td><td><div><div><p>String</p></div></div></td><td><p>The formula or the range that the name will refer to.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Workbook Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The comment associated with the named item.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>The name of the configuration to use to execute this component.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Response timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>Response timeout for the request. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Response timeout unit for the request. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Custom headers</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers that the request will include. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Custom query parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters that the request will include. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p>Binary</p></div></div></td></tr></tbody></table>

### For Configurations

- [Authorization Code Config](#AuthorizationCodeConfig)

### Throws

- EXCEL:BAD\_REQUEST

- EXCEL:CONNECTIVITY

- EXCEL:FORBIDDEN

- EXCEL:INVALID\_CONNECTION

- EXCEL:INVALID\_CREDENTIALS

- EXCEL:NOT\_FOUND

- EXCEL:RETRY\_EXHAUSTED

- EXCEL:SERVER\_ERROR

- EXCEL:TIMEOUT

## Add Rows

`<excel:add-rows>`

Adds rows to the end of the table. The API can accept data from multiple rows, so adding one row at
a time may lead to performance degradation. Batch the rows together in a single API call rather than
doing single row insertion. Experiment with the number of rows to determine the ideal number of rows
to use in a single API call.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Workbook Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the workbook where rows are added.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Worksheet Name</p></td><td><div><div><p>String</p></div></div></td><td><p>The name of the worksheet where the table is located.</p></td><td></td><td></td></tr><tr><td><p>Table Name/Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the table.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Rows</p></td><td><div><div><p>Any</p></div></div></td><td><p>The rows to be added.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>The name of the configuration to use to execute this component.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Response timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>Response timeout for the request. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Response timeout unit for the request. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Custom headers</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers that the request will include. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Custom query parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters that the request will include. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p>Binary</p></div></div></td></tr></tbody></table>

### For Configurations

- [Authorization Code Config](#AuthorizationCodeConfig)

### Throws

- EXCEL:CONNECTIVITY

- EXCEL:RETRY\_EXHAUSTED

## Add Table

`<excel:add-table>`

Creates a new table. The range source address determines which worksheet the table will be added to.
If the table cannot be added, for example, if the address is invalid or the table overlaps with
another table, an error is thrown.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Workbook Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the workbook where rows are added.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Worksheet Name</p></td><td><div><div><p>String</p></div></div></td><td><p>The name of the worksheet where the table is located.</p></td><td></td><td></td></tr><tr><td><p>Table Address</p></td><td><div><div><p>String</p></div></div></td><td><p>Address or name of the range object representing the data source. If the address does not contain a sheet name, the currently-active sheet is used.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Has Headers</p></td><td><div><div><p>Boolean</p></div></div></td><td><p>Boolean value that indicates whether the data being imported has column labels. If the source does not contain headers, for example, when this property is set to <code>false</code>, Excel will automatically generate the header by shifting the data down by one row.</p></td><td><p>false</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>The name of the configuration to use to execute this component.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Response timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>Response timeout for the request. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Response timeout unit for the request. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Custom headers</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers that the request will include. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Custom query parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters that the request will include. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p>Binary</p></div></div></td></tr></tbody></table>

### For Configurations

- [Authorization Code Config](#AuthorizationCodeConfig)

### Throws

- EXCEL:CONNECTIVITY

- EXCEL:RETRY\_EXHAUSTED

## Add Worksheet

`<excel:add-worksheet>`

Adds a new worksheet to the workbook. The worksheet is added to the end of the existing worksheets.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Workbook Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The workbook ID where the worksheet is located.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Worksheet Name</p></td><td><div><div><p>String</p></div></div></td><td><p>The worksheet name.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>The name of the configuration to use to execute this component.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Response timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>Response timeout for the request. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Response timeout unit for the request. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Custom headers</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers that the request will include. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Custom query parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters that the request will include. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p>Binary</p></div></div></td></tr></tbody></table>

### For Configurations

- [Authorization Code Config](#AuthorizationCodeConfig)

### Throws

- EXCEL:CONNECTIVITY

- EXCEL:RETRY\_EXHAUSTED

## Calculate Workbook Application

`<excel:calculate-workbook-application>`

Recalculate all currently opened workbooks in Microsoft Excel.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Workbook Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the workbook.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Calculation Type</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>FULL</p></li><li><p>RECALCULATE</p></li><li><p>FULLREBUILD</p></li></ul></div></div></td><td><p>The calculation type to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>The name of the configuration to use to execute this component.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Response timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>Response timeout for the request. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Response timeout unit for the request. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Custom headers</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers that the request will include. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Custom query parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters that the request will include. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p>Binary</p></div></div></td></tr></tbody></table>

### For Configurations

- [Authorization Code Config](#AuthorizationCodeConfig)

### Throws

- EXCEL:BAD\_REQUEST

- EXCEL:CONNECTIVITY

- EXCEL:FORBIDDEN

- EXCEL:INVALID\_CONNECTION

- EXCEL:INVALID\_CREDENTIALS

- EXCEL:NOT\_FOUND

- EXCEL:RETRY\_EXHAUSTED

- EXCEL:SERVER\_ERROR

- EXCEL:TIMEOUT

## Chart Set Position

`<excel:chart-set-position>`

Positions the chart relative to the cells on the worksheet.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Workbook Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the workbook. where the component is located.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Worksheet Name</p></td><td><div><div><p>String</p></div></div></td><td><p>The name of the worksheet.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Chart Name/Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID or the name of the chart.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Position Body</p></td><td><div><div><p>Any</p></div></div></td><td><p>The position body.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>The name of the configuration to use to execute this component.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Select</p></td><td><div><div><p>String</p></div></div></td><td><p>Properties to retrieve in the response.</p></td><td></td><td></td></tr><tr><td><p>Expand</p></td><td><div><div><p>String</p></div></div></td><td><p>The response will include information regarding the specified relationship.</p></td><td></td><td></td></tr><tr><td><p>Filter</p></td><td><div><div><p>String</p></div></div></td><td><p>Retrieves a subset of a collection.</p></td><td></td><td></td></tr><tr><td><p>Order By</p></td><td><div><div><p>String</p></div></div></td><td><p>Specifies the sort order of the items returned.</p></td><td></td><td></td></tr><tr><td><p>Search</p></td><td><div><div><p>String</p></div></div></td><td><p>Restricts the results of a request to match a search criteria.</p></td><td></td><td></td></tr><tr><td><p>Response timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>Response timeout for the request. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Response timeout unit for the request. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Custom headers</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers that the request will include. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Custom query parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters that the request will include. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p>Binary</p></div></div></td></tr></tbody></table>

### For Configurations

- [Authorization Code Config](#AuthorizationCodeConfig)

### Throws

- EXCEL:BAD\_REQUEST

- EXCEL:CONNECTIVITY

- EXCEL:FORBIDDEN

- EXCEL:INVALID\_CONNECTION

- EXCEL:INVALID\_CREDENTIALS

- EXCEL:NOT\_FOUND

- EXCEL:RETRY\_EXHAUSTED

- EXCEL:SERVER\_ERROR

- EXCEL:TIMEOUT

## Create Chart Series

`<excel:create-chart-series>`

Creates a new ChartSeries.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Workbook Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the workbook. where the component is located.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Worksheet Name</p></td><td><div><div><p>String</p></div></div></td><td><p>The name of the worksheet where the component is located.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Chart Name</p></td><td><div><div><p>String</p></div></div></td><td><p>The name of the chart.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Chart Series Body</p></td><td><div><div><p>Any</p></div></div></td><td><p>The series body of the chart.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>The name of the configuration to use to execute this component.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Response timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>Response timeout for the request. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Response timeout unit for the request. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Custom headers</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers that the request will include. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Custom query parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters that the request will include. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p>Binary</p></div></div></td></tr></tbody></table>

### For Configurations

- [Authorization Code Config](#AuthorizationCodeConfig)

### Throws

- EXCEL:BAD\_REQUEST

- EXCEL:CONNECTIVITY

- EXCEL:FORBIDDEN

- EXCEL:INVALID\_CONNECTION

- EXCEL:INVALID\_CREDENTIALS

- EXCEL:NOT\_FOUND

- EXCEL:RETRY\_EXHAUSTED

- EXCEL:SERVER\_ERROR

- EXCEL:TIMEOUT

## Create Table Column

`<excel:create-table-column>`

Creates a new column for the table.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Workbook Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the workbook. where columns are located.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Worksheet Name</p></td><td><div><div><p>String</p></div></div></td><td><p>The name of the worksheet where the columns are located.</p></td><td></td><td></td></tr><tr><td><p>Table Name/Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the table.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Column Content</p></td><td><div><div><p>Any</p></div></div></td><td></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>The name of the configuration to use to execute this component.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Response timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>Response timeout for the request. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Response timeout unit for the request. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Custom headers</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers that the request will include. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Custom query parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters that the request will include. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p>Binary</p></div></div></td></tr></tbody></table>

### For Configurations

- [Authorization Code Config](#AuthorizationCodeConfig)

### Throws

- EXCEL:BAD\_REQUEST

- EXCEL:CONNECTIVITY

- EXCEL:FORBIDDEN

- EXCEL:INVALID\_CONNECTION

- EXCEL:INVALID\_CREDENTIALS

- EXCEL:NOT\_FOUND

- EXCEL:RETRY\_EXHAUSTED

- EXCEL:SERVER\_ERROR

- EXCEL:TIMEOUT

## Delete Chart

`<excel:delete-chart>`

Deletes the chart object.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Workbook Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the workbook. where the component is located.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Worksheet Name</p></td><td><div><div><p>String</p></div></div></td><td><p>The name of the worksheet.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Chart Name/Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID or the name of chart.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>The name of the configuration to use to execute this component.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Response timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>Response timeout for the request. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Response timeout unit for the request. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Custom headers</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers that the request will include. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Custom query parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters that the request will include. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p>Binary</p></div></div></td></tr></tbody></table>

### For Configurations

- [Authorization Code Config](#AuthorizationCodeConfig)

### Throws

- EXCEL:BAD\_REQUEST

- EXCEL:CONNECTIVITY

- EXCEL:FORBIDDEN

- EXCEL:INVALID\_CONNECTION

- EXCEL:INVALID\_CREDENTIALS

- EXCEL:NOT\_FOUND

- EXCEL:RETRY\_EXHAUSTED

- EXCEL:SERVER\_ERROR

- EXCEL:TIMEOUT

## Delete Row

`<excel:delete-row>`

Deletes a row from the table.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Workbook Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the workbook. from where the row will be deleted.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Worksheet Name</p></td><td><div><div><p>String</p></div></div></td><td><p>The name of the worksheet where the rows are located.</p></td><td></td><td></td></tr><tr><td><p>Table Name/Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the table.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Row Index</p></td><td><div><div><p>Number</p></div></div></td><td><p>The index of the row to be deleted.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>The name of the configuration to use to execute this component.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Response timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>Response timeout for the request. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Response timeout unit for the request. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Custom headers</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers that the request will include. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Custom query parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters that the request will include. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p>Binary</p></div></div></td></tr></tbody></table>

### For Configurations

- [Authorization Code Config](#AuthorizationCodeConfig)

### Throws

- EXCEL:CONNECTIVITY

- EXCEL:RETRY\_EXHAUSTED

## Delete Table

`<excel:delete-table>`

Deletes a row from the table.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Workbook Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the workbook. where table is located.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Worksheet Name</p></td><td><div><div><p>String</p></div></div></td><td><p>The name of the worksheet where the table is located.</p></td><td></td><td></td></tr><tr><td><p>Table Name/Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the table.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>The name of the configuration to use to execute this component.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Response timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>Response timeout for the request. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Response timeout unit for the request. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Custom headers</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers that the request will include. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Custom query parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters that the request will include. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p>Binary</p></div></div></td></tr></tbody></table>

### For Configurations

- [Authorization Code Config](#AuthorizationCodeConfig)

### Throws

- EXCEL:CONNECTIVITY

- EXCEL:RETRY\_EXHAUSTED

## Delete Worksheet

`<excel:delete-worksheet>`

Deletes a worksheet from the workbook.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Workbook Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The workbook ID where the worksheet is located.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Worksheet Name</p></td><td><div><div><p>String</p></div></div></td><td><p>The worksheet name to delete.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>The name of the configuration to use to execute this component.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Response timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>Response timeout for the request. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Response timeout unit for the request. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Custom headers</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers that the request will include. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Custom query parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters that the request will include. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p>Binary</p></div></div></td></tr></tbody></table>

### For Configurations

- [Authorization Code Config](#AuthorizationCodeConfig)

### Throws

- EXCEL:CONNECTIVITY

- EXCEL:RETRY\_EXHAUSTED

## Get Cell

`<excel:get-cell>`

Gets the range object containing a single cell based on row and column numbers. The cell can be
outside the bounds of its parent range as long as it stays within the worksheet grid.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Workbook Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The workbook ID where the worksheet is located.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Worksheet Name</p></td><td><div><div><p>String</p></div></div></td><td><p>The worksheet name to retrieve.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Row</p></td><td><div><div><p>Number</p></div></div></td><td><p>The row value of the cell.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Column</p></td><td><div><div><p>Number</p></div></div></td><td><p>The column value of the cell.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>The name of the configuration to use to execute this component.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Response timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>Response timeout for the request. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Response timeout unit for the request. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Custom headers</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers that the request will include. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Custom query parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters that the request will include. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p>Binary</p></div></div></td></tr></tbody></table>

### For Configurations

- [Authorization Code Config](#AuthorizationCodeConfig)

### Throws

- EXCEL:BAD\_REQUEST

- EXCEL:CONNECTIVITY

- EXCEL:FORBIDDEN

- EXCEL:INVALID\_CONNECTION

- EXCEL:INVALID\_CREDENTIALS

- EXCEL:NOT\_FOUND

- EXCEL:RETRY\_EXHAUSTED

- EXCEL:SERVER\_ERROR

- EXCEL:TIMEOUT

## Get Chart

`<excel:get-chart>`

Reads the properties and relationships of a chart object.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Workbook Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the workbook. where the component is located.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Worksheet Name</p></td><td><div><div><p>String</p></div></div></td><td><p>The name of the worksheet.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Chart Name/Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Corresponding chart ID or name to retrieve.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>The name of the configuration to use to execute this component.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Select</p></td><td><div><div><p>String</p></div></div></td><td><p>Properties to retrieve in the response.</p></td><td></td><td></td></tr><tr><td><p>Expand</p></td><td><div><div><p>String</p></div></div></td><td><p>The response will include information regarding the specified relationship.</p></td><td></td><td></td></tr><tr><td><p>Filter</p></td><td><div><div><p>String</p></div></div></td><td><p>Retrieves a subset of a collection.</p></td><td></td><td></td></tr><tr><td><p>Order By</p></td><td><div><div><p>String</p></div></div></td><td><p>Specifies the sort order of the items returned.</p></td><td></td><td></td></tr><tr><td><p>Search</p></td><td><div><div><p>String</p></div></div></td><td><p>Restricts the results of a request to match a search criteria.</p></td><td></td><td></td></tr><tr><td><p>Response timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>Response timeout for the request. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Response timeout unit for the request. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Custom headers</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers that the request will include. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Custom query parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters that the request will include. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p>Binary</p></div></div></td></tr></tbody></table>

### For Configurations

- [Authorization Code Config](#AuthorizationCodeConfig)

### Throws

- EXCEL:BAD\_REQUEST

- EXCEL:CONNECTIVITY

- EXCEL:FORBIDDEN

- EXCEL:INVALID\_CONNECTION

- EXCEL:INVALID\_CREDENTIALS

- EXCEL:NOT\_FOUND

- EXCEL:RETRY\_EXHAUSTED

- EXCEL:SERVER\_ERROR

- EXCEL:TIMEOUT

## Get Chart Image

`<excel:get-chart-image>`

Renders the chart as a base64-encoded image by scaling the chart to fit the specified dimensions.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Workbook Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the workbook. where the component is located.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Worksheet Name</p></td><td><div><div><p>String</p></div></div></td><td><p>The name of the worksheet.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Chart Name/Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID or the name of chart.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Width</p></td><td><div><div><p>String</p></div></div></td><td><p>The width of the image.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Height</p></td><td><div><div><p>String</p></div></div></td><td><p>The height of the image.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Fitting Mode</p></td><td><div><div><p>String</p></div></div></td><td><p>The fitting mode of the image.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>The name of the configuration to use to execute this component.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Response timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>Response timeout for the request. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Response timeout unit for the request. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Custom headers</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers that the request will include. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Custom query parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters that the request will include. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p>Binary</p></div></div></td></tr></tbody></table>

### For Configurations

- [Authorization Code Config](#AuthorizationCodeConfig)

### Throws

- EXCEL:BAD\_REQUEST

- EXCEL:CONNECTIVITY

- EXCEL:FORBIDDEN

- EXCEL:INVALID\_CONNECTION

- EXCEL:INVALID\_CREDENTIALS

- EXCEL:NOT\_FOUND

- EXCEL:RETRY\_EXHAUSTED

- EXCEL:SERVER\_ERROR

- EXCEL:TIMEOUT

## Get Chart Item At

`<excel:get-chart-item-at>`

Gets a chart based on its position in the collection.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Workbook Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The workbookId where chart is located.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Worksheet Name</p></td><td><div><div><p>String</p></div></div></td><td><p>The name of the worksheet.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>(DEPRECATED) Chart Name/Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Corresponding chart name to retrieve.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>(DEPRECATED) Request Body</p></td><td><div><div><p>Any</p></div></div></td><td><p>Body of the request. Use the <strong>Index</strong> field instead.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Index</p></td><td><div><div><p>Number</p></div></div></td><td><p>Index value of the chart to retrieve.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>The name of the configuration to use to execute this component.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Select</p></td><td><div><div><p>String</p></div></div></td><td><p>Properties to retrieve in the response.</p></td><td></td><td></td></tr><tr><td><p>Expand</p></td><td><div><div><p>String</p></div></div></td><td><p>The response will include information regarding the specified relationship.</p></td><td></td><td></td></tr><tr><td><p>Filter</p></td><td><div><div><p>String</p></div></div></td><td><p>Retrieves a subset of a collection.</p></td><td></td><td></td></tr><tr><td><p>Order By</p></td><td><div><div><p>String</p></div></div></td><td><p>Specifies the sort order of the items returned.</p></td><td></td><td></td></tr><tr><td><p>Search</p></td><td><div><div><p>String</p></div></div></td><td><p>Restricts the results of a request to match a search criteria.</p></td><td></td><td></td></tr><tr><td><p>Response timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>Response timeout for the request. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Response timeout unit for the request. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Custom headers</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers that the request will include. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Custom query parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters that the request will include. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p>Binary</p></div></div></td></tr></tbody></table>

### For Configurations

- [Authorization Code Config](#AuthorizationCodeConfig)

### Throws

- EXCEL:BAD\_REQUEST

- EXCEL:CONNECTIVITY

- EXCEL:FORBIDDEN

- EXCEL:INVALID\_CONNECTION

- EXCEL:INVALID\_CREDENTIALS

- EXCEL:NOT\_FOUND

- EXCEL:RETRY\_EXHAUSTED

- EXCEL:SERVER\_ERROR

- EXCEL:TIMEOUT

## Get Columns After Range

`<excel:get-columns-after-range>`

Gets a certain number of columns to the right of the given range.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Workbook Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the workbook.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Worksheet Name</p></td><td><div><div><p>String</p></div></div></td><td><p>The name of the worksheet where the component is located.</p></td><td></td><td></td></tr><tr><td><p>Count</p></td><td><div><div><p>Number</p></div></div></td><td><p>The number of columns to include in the resulting range.</p></td><td><p>1</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>The name of the configuration to use to execute this component.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Response timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>Response timeout for the request. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Response timeout unit for the request. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Custom headers</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers that the request will include. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Custom query parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters that the request will include. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p>Binary</p></div></div></td></tr></tbody></table>

### For Configurations

- [Authorization Code Config](#AuthorizationCodeConfig)

### Throws

- EXCEL:BAD\_REQUEST

- EXCEL:CONNECTIVITY

- EXCEL:FORBIDDEN

- EXCEL:INVALID\_CONNECTION

- EXCEL:INVALID\_CREDENTIALS

- EXCEL:NOT\_FOUND

- EXCEL:RETRY\_EXHAUSTED

- EXCEL:SERVER\_ERROR

- EXCEL:TIMEOUT

## Get Columns Before Range

`<excel:get-columns-before-range>`

Gets a certain number of columns to the left of the given range.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Workbook Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the workbook.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Worksheet Name</p></td><td><div><div><p>String</p></div></div></td><td><p>The name of the worksheet where the component is located.</p></td><td></td><td></td></tr><tr><td><p>Count</p></td><td><div><div><p>Number</p></div></div></td><td><p>The number of columns to include in the resulting range.</p></td><td><p>1</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>The name of the configuration to use to execute this component.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Response timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>Response timeout for the request. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Response timeout unit for the request. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Custom headers</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers that the request will include. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Custom query parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters that the request will include. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p>Binary</p></div></div></td></tr></tbody></table>

### For Configurations

- [Authorization Code Config](#AuthorizationCodeConfig)

### Throws

- EXCEL:BAD\_REQUEST

- EXCEL:CONNECTIVITY

- EXCEL:FORBIDDEN

- EXCEL:INVALID\_CONNECTION

- EXCEL:INVALID\_CREDENTIALS

- EXCEL:NOT\_FOUND

- EXCEL:RETRY\_EXHAUSTED

- EXCEL:SERVER\_ERROR

- EXCEL:TIMEOUT

## Get Named Item

`<excel:get-named-item>`

Retrieves the properties and relationships of a NamedItem object.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Workbook Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the workbook where rows are added.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Name</p></td><td><div><div><p>String</p></div></div></td><td><p>The name of the named item.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>The name of the configuration to use to execute this component.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Response timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>Response timeout for the request. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Response timeout unit for the request. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Custom headers</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers that the request will include. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Custom query parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters that the request will include. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p>Binary</p></div></div></td></tr></tbody></table>

### For Configurations

- [Authorization Code Config](#AuthorizationCodeConfig)

### Throws

- EXCEL:BAD\_REQUEST

- EXCEL:CONNECTIVITY

- EXCEL:FORBIDDEN

- EXCEL:INVALID\_CONNECTION

- EXCEL:INVALID\_CREDENTIALS

- EXCEL:NOT\_FOUND

- EXCEL:RETRY\_EXHAUSTED

- EXCEL:SERVER\_ERROR

- EXCEL:TIMEOUT

## Get Offset Range

`<excel:get-offset-range>`

Gets an object that represents a range that is offset from the specified range. The dimension of the
returned range matches this range. If the resulting range is forced outside the bounds of the
worksheet grid, an exception is thrown.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Workbook Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the workbook.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Name</p></td><td><div><div><p>String</p></div></div></td><td><p>The name.</p></td><td></td><td></td></tr><tr><td><p>Worksheet Name</p></td><td><div><div><p>String</p></div></div></td><td><p>The name of the worksheet.</p></td><td></td><td></td></tr><tr><td><p>Address</p></td><td><div><div><p>String</p></div></div></td><td><p>The address.</p></td><td></td><td></td></tr><tr><td><p>Table Name/Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the table.</p></td><td></td><td></td></tr><tr><td><p>Column Name/Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the column.</p></td><td></td><td></td></tr><tr><td><p>Row Offset</p></td><td><div><div><p>Number</p></div></div></td><td><p>The number of rows by which the range is offset. Positive values are offset downward and negative values are offset upward.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Column Offset</p></td><td><div><div><p>Number</p></div></div></td><td><p>The number of columns by which the range is offset. Positive values are offset to the right and negative values are offset to the left.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>The name of the configuration to use to execute this component.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Response timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>Response timeout for the request. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Response timeout unit for the request. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Custom headers</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers that the request will include. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Custom query parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters that the request will include. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p>Binary</p></div></div></td></tr></tbody></table>

### For Configurations

- [Authorization Code Config](#AuthorizationCodeConfig)

### Throws

- EXCEL:BAD\_REQUEST

- EXCEL:CONNECTIVITY

- EXCEL:FORBIDDEN

- EXCEL:INVALID\_CONNECTION

- EXCEL:INVALID\_CREDENTIALS

- EXCEL:NOT\_FOUND

- EXCEL:RETRY\_EXHAUSTED

- EXCEL:SERVER\_ERROR

- EXCEL:TIMEOUT

## Get Range

`<excel:get-range>`

Retrieves the properties and relationships of a range object.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Workbook Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the workbook.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Worksheet Name</p></td><td><div><div><p>String</p></div></div></td><td><p>The name of the worksheet.</p></td><td></td><td></td></tr><tr><td><p>Table Name/Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the table.</p></td><td></td><td></td></tr><tr><td><p>Address</p></td><td><div><div><p>String</p></div></div></td><td><p>The address.</p></td><td></td><td></td></tr><tr><td><p>Column Name/Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the column.</p></td><td></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>The name of the configuration to use to execute this component.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Select</p></td><td><div><div><p>String</p></div></div></td><td><p>Properties to retrieve in the response.</p></td><td></td><td></td></tr><tr><td><p>Expand</p></td><td><div><div><p>String</p></div></div></td><td><p>The response will include information regarding the specified relationship.</p></td><td></td><td></td></tr><tr><td><p>Filter</p></td><td><div><div><p>String</p></div></div></td><td><p>Retrieves a subset of a collection.</p></td><td></td><td></td></tr><tr><td><p>Order By</p></td><td><div><div><p>String</p></div></div></td><td><p>Specifies the sort order of the items returned.</p></td><td></td><td></td></tr><tr><td><p>Search</p></td><td><div><div><p>String</p></div></div></td><td><p>Restricts the results of a request to match a search criteria.</p></td><td></td><td></td></tr><tr><td><p>Response timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>Response timeout for the request. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Response timeout unit for the request. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Custom headers</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers that the request will include. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Custom query parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters that the request will include. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p>Binary</p></div></div></td></tr></tbody></table>

### For Configurations

- [Authorization Code Config](#AuthorizationCodeConfig)

### Throws

- EXCEL:BAD\_REQUEST

- EXCEL:CONNECTIVITY

- EXCEL:FORBIDDEN

- EXCEL:INVALID\_CONNECTION

- EXCEL:INVALID\_CREDENTIALS

- EXCEL:NOT\_FOUND

- EXCEL:RETRY\_EXHAUSTED

- EXCEL:SERVER\_ERROR

- EXCEL:TIMEOUT

## Get Range Cell

`<excel:get-range-cell>`

Gets the range object containing a single cell based on row and column numbers. The cell can be
outside the bounds of its parent range, as long as it stays within the worksheet grid. The returned
cell is located relative to the top left cell of the range.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Workbook Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the workbook.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Name</p></td><td><div><div><p>String</p></div></div></td><td><p>The name.</p></td><td></td><td></td></tr><tr><td><p>Worksheet Name</p></td><td><div><div><p>String</p></div></div></td><td><p>The name of the worksheet.</p></td><td></td><td></td></tr><tr><td><p>Address</p></td><td><div><div><p>String</p></div></div></td><td><p>The address.</p></td><td></td><td></td></tr><tr><td><p>Table Name/Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the table.</p></td><td></td><td></td></tr><tr><td><p>Column Name/Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID or name of the column.</p></td><td></td><td></td></tr><tr><td><p>Row number</p></td><td><div><div><p>Number</p></div></div></td><td><p>Row number of the cell to be retrieved. Zero-indexed.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Column Number</p></td><td><div><div><p>Number</p></div></div></td><td><p>Column number of the cell to be retrieved. Zero-indexed.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>The name of the configuration to use to execute this component.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Response timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>Response timeout for the request. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Response timeout unit for the request. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Custom headers</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers that the request will include. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Custom query parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters that the request will include. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p>Binary</p></div></div></td></tr></tbody></table>

### For Configurations

- [Authorization Code Config](#AuthorizationCodeConfig)

### Throws

- EXCEL:BAD\_REQUEST

- EXCEL:CONNECTIVITY

- EXCEL:FORBIDDEN

- EXCEL:INVALID\_CONNECTION

- EXCEL:INVALID\_CREDENTIALS

- EXCEL:NOT\_FOUND

- EXCEL:RETRY\_EXHAUSTED

- EXCEL:SERVER\_ERROR

- EXCEL:TIMEOUT

## Get Range Column

`<excel:get-range-column>`

Gets a column contained in the range.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Workbook Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the workbook.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Name</p></td><td><div><div><p>String</p></div></div></td><td><p>The name.</p></td><td></td><td></td></tr><tr><td><p>Worksheet Name</p></td><td><div><div><p>String</p></div></div></td><td><p>The name of the worksheet.</p></td><td></td><td></td></tr><tr><td><p>Address</p></td><td><div><div><p>String</p></div></div></td><td><p>The address.</p></td><td></td><td></td></tr><tr><td><p>Table Name/Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the table.</p></td><td></td><td></td></tr><tr><td><p>Column Name/Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID or name of the column.</p></td><td></td><td></td></tr><tr><td><p>Column Number</p></td><td><div><div><p>Number</p></div></div></td><td><p>Column number of the cell to be retrieved. Zero-indexed.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>The name of the configuration to use to execute this component.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Response timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>Response timeout for the request. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Response timeout unit for the request. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Custom headers</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers that the request will include. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Custom query parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters that the request will include. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p>Binary</p></div></div></td></tr></tbody></table>

### For Configurations

- [Authorization Code Config](#AuthorizationCodeConfig)

### Throws

- EXCEL:BAD\_REQUEST

- EXCEL:CONNECTIVITY

- EXCEL:FORBIDDEN

- EXCEL:INVALID\_CONNECTION

- EXCEL:INVALID\_CREDENTIALS

- EXCEL:NOT\_FOUND

- EXCEL:RETRY\_EXHAUSTED

- EXCEL:SERVER\_ERROR

- EXCEL:TIMEOUT

## Get Range Entire Column

`<excel:get-range-entire-column>`

Gets an object that represents the entire column of the range.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Workbook Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the workbook.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Name</p></td><td><div><div><p>String</p></div></div></td><td><p>The name.</p></td><td></td><td></td></tr><tr><td><p>Worksheet Name</p></td><td><div><div><p>String</p></div></div></td><td><p>The name of the worksheet.</p></td><td></td><td></td></tr><tr><td><p>Address</p></td><td><div><div><p>String</p></div></div></td><td><p>The address.</p></td><td></td><td></td></tr><tr><td><p>Table Name/Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the table.</p></td><td></td><td></td></tr><tr><td><p>Column Name/Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID or name of the column.</p></td><td></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>The name of the configuration to use to execute this component.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Response timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>Response timeout for the request. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Response timeout unit for the request. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Custom headers</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers that the request will include. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Custom query parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters that the request will include. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p>Binary</p></div></div></td></tr></tbody></table>

### For Configurations

- [Authorization Code Config](#AuthorizationCodeConfig)

### Throws

- EXCEL:BAD\_REQUEST

- EXCEL:CONNECTIVITY

- EXCEL:FORBIDDEN

- EXCEL:INVALID\_CONNECTION

- EXCEL:INVALID\_CREDENTIALS

- EXCEL:NOT\_FOUND

- EXCEL:RETRY\_EXHAUSTED

- EXCEL:SERVER\_ERROR

- EXCEL:TIMEOUT

## Get Range Entire Row

`<excel:get-range-entire-row>`

Gets an object that represents the entire row of the range.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Workbook Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the workbook.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Name</p></td><td><div><div><p>String</p></div></div></td><td><p>The name.</p></td><td></td><td></td></tr><tr><td><p>Worksheet Name</p></td><td><div><div><p>String</p></div></div></td><td><p>The name of the worksheet.</p></td><td></td><td></td></tr><tr><td><p>Address</p></td><td><div><div><p>String</p></div></div></td><td><p>The address.</p></td><td></td><td></td></tr><tr><td><p>Table Name/Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the table.</p></td><td></td><td></td></tr><tr><td><p>Column Name/Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID or name of the column.</p></td><td></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>The name of the configuration to use to execute this component.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Response timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>Response timeout for the request. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Response timeout unit for the request. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Custom headers</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers that the request will include. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Custom query parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters that the request will include. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p>Binary</p></div></div></td></tr></tbody></table>

### For Configurations

- [Authorization Code Config](#AuthorizationCodeConfig)

### Throws

- EXCEL:BAD\_REQUEST

- EXCEL:CONNECTIVITY

- EXCEL:FORBIDDEN

- EXCEL:INVALID\_CONNECTION

- EXCEL:INVALID\_CREDENTIALS

- EXCEL:NOT\_FOUND

- EXCEL:RETRY\_EXHAUSTED

- EXCEL:SERVER\_ERROR

- EXCEL:TIMEOUT

## Get Range Format

`<excel:get-range-format>`

Retrieves the properties and relationships of the RangeFormat object.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Workbook Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the workbook.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Name</p></td><td><div><div><p>String</p></div></div></td><td><p>The name.</p></td><td></td><td></td></tr><tr><td><p>Worksheet Name</p></td><td><div><div><p>String</p></div></div></td><td><p>The name of the worksheet.</p></td><td></td><td></td></tr><tr><td><p>Address</p></td><td><div><div><p>String</p></div></div></td><td><p>The address.</p></td><td></td><td></td></tr><tr><td><p>Table Name/Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the table.</p></td><td></td><td></td></tr><tr><td><p>Column Name/Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID or name of the column.</p></td><td></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>The name of the configuration to use to execute this component.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Response timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>Response timeout for the request. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Response timeout unit for the request. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Custom headers</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers that the request will include. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Custom query parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters that the request will include. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Select</p></td><td><div><div><p>String</p></div></div></td><td><p>Properties to retrieve in the response.</p></td><td></td><td></td></tr><tr><td><p>Expand</p></td><td><div><div><p>String</p></div></div></td><td><p>The response will include information regarding the specified relationship.</p></td><td></td><td></td></tr><tr><td><p>Filter</p></td><td><div><div><p>String</p></div></div></td><td><p>Retrieves a subset of a collection.</p></td><td></td><td></td></tr><tr><td><p>Order By</p></td><td><div><div><p>String</p></div></div></td><td><p>Specifies the sort order of the items returned.</p></td><td></td><td></td></tr><tr><td><p>Search</p></td><td><div><div><p>String</p></div></div></td><td><p>Restricts the results of a request to match a search criteria.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p>Binary</p></div></div></td></tr></tbody></table>

### For Configurations

- [Authorization Code Config](#AuthorizationCodeConfig)

### Throws

- EXCEL:BAD\_REQUEST

- EXCEL:CONNECTIVITY

- EXCEL:FORBIDDEN

- EXCEL:INVALID\_CONNECTION

- EXCEL:INVALID\_CREDENTIALS

- EXCEL:NOT\_FOUND

- EXCEL:RETRY\_EXHAUSTED

- EXCEL:SERVER\_ERROR

- EXCEL:TIMEOUT

## Get Range Intersection

`<excel:get-range-intersection>`

Gets the range object that represents the rectangular intersection of the given ranges.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Workbook Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the workbook.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Name</p></td><td><div><div><p>String</p></div></div></td><td><p>The name.</p></td><td></td><td></td></tr><tr><td><p>Worksheet Name</p></td><td><div><div><p>String</p></div></div></td><td><p>The name of the worksheet.</p></td><td></td><td></td></tr><tr><td><p>Address</p></td><td><div><div><p>String</p></div></div></td><td><p>The address.</p></td><td></td><td></td></tr><tr><td><p>Table Name/Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the table.</p></td><td></td><td></td></tr><tr><td><p>Column Name/Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID or name of the column.</p></td><td></td><td></td></tr><tr><td><p>Another Range</p></td><td><div><div><p>String</p></div></div></td><td><p>The range object or address or range name.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>The name of the configuration to use to execute this component.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Response timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>Response timeout for the request. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Response timeout unit for the request. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Custom headers</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers that the request will include. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Custom query parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters that the request will include. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p>Binary</p></div></div></td></tr></tbody></table>

### For Configurations

- [Authorization Code Config](#AuthorizationCodeConfig)

### Throws

- EXCEL:BAD\_REQUEST

- EXCEL:CONNECTIVITY

- EXCEL:FORBIDDEN

- EXCEL:INVALID\_CONNECTION

- EXCEL:INVALID\_CREDENTIALS

- EXCEL:NOT\_FOUND

- EXCEL:RETRY\_EXHAUSTED

- EXCEL:SERVER\_ERROR

- EXCEL:TIMEOUT

## Get Range Last Cell

`<excel:get-range-last-cell>`

Gets the last cell within the range.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Workbook Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the workbook.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Name</p></td><td><div><div><p>String</p></div></div></td><td><p>The name.</p></td><td></td><td></td></tr><tr><td><p>Worksheet Name</p></td><td><div><div><p>String</p></div></div></td><td><p>The name of the worksheet.</p></td><td></td><td></td></tr><tr><td><p>Address</p></td><td><div><div><p>String</p></div></div></td><td><p>The address.</p></td><td></td><td></td></tr><tr><td><p>Table Name/Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the table.</p></td><td></td><td></td></tr><tr><td><p>Column Name/Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID or name of the column.</p></td><td></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>The name of the configuration to use to execute this component.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Response timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>Response timeout for the request. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Response timeout unit for the request. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Custom headers</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers that the request will include. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Custom query parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters that the request will include. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p>Binary</p></div></div></td></tr></tbody></table>

### For Configurations

- [Authorization Code Config](#AuthorizationCodeConfig)

### Throws

- EXCEL:BAD\_REQUEST

- EXCEL:CONNECTIVITY

- EXCEL:FORBIDDEN

- EXCEL:INVALID\_CONNECTION

- EXCEL:INVALID\_CREDENTIALS

- EXCEL:NOT\_FOUND

- EXCEL:RETRY\_EXHAUSTED

- EXCEL:SERVER\_ERROR

- EXCEL:TIMEOUT

## Get Range Last Column

`<excel:get-range-last-column>`

Gets the last column within the range.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Workbook Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the workbook.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Name</p></td><td><div><div><p>String</p></div></div></td><td><p>The name.</p></td><td></td><td></td></tr><tr><td><p>Worksheet Name</p></td><td><div><div><p>String</p></div></div></td><td><p>The name of the worksheet.</p></td><td></td><td></td></tr><tr><td><p>Address</p></td><td><div><div><p>String</p></div></div></td><td><p>The address.</p></td><td></td><td></td></tr><tr><td><p>Table Name/Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the table.</p></td><td></td><td></td></tr><tr><td><p>Column Name/Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID or name of the column.</p></td><td></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>The name of the configuration to use to execute this component.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Response timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>Response timeout for the request. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Response timeout unit for the request. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Custom headers</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers that the request will include. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Custom query parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters that the request will include. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p>Binary</p></div></div></td></tr></tbody></table>

### For Configurations

- [Authorization Code Config](#AuthorizationCodeConfig)

### Throws

- EXCEL:BAD\_REQUEST

- EXCEL:CONNECTIVITY

- EXCEL:FORBIDDEN

- EXCEL:INVALID\_CONNECTION

- EXCEL:INVALID\_CREDENTIALS

- EXCEL:NOT\_FOUND

- EXCEL:RETRY\_EXHAUSTED

- EXCEL:SERVER\_ERROR

- EXCEL:TIMEOUT

## Get Range Last Row

`<excel:get-range-last-row>`

Gets the last row within the range.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Workbook Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the workbook.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Name</p></td><td><div><div><p>String</p></div></div></td><td><p>The name</p></td><td></td><td></td></tr><tr><td><p>Worksheet Name</p></td><td><div><div><p>String</p></div></div></td><td><p>The name of the worksheet.</p></td><td></td><td></td></tr><tr><td><p>Address</p></td><td><div><div><p>String</p></div></div></td><td><p>The address.</p></td><td></td><td></td></tr><tr><td><p>Table Name/Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the table.</p></td><td></td><td></td></tr><tr><td><p>Column Name/Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID or name of the column.</p></td><td></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>The name of the configuration to use to execute this component.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Response timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>Response timeout for the request. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Response timeout unit for the request. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Custom headers</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers that the request will include. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Custom query parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters that the request will include. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p>Binary</p></div></div></td></tr></tbody></table>

### For Configurations

- [Authorization Code Config](#AuthorizationCodeConfig)

### Throws

- EXCEL:BAD\_REQUEST

- EXCEL:CONNECTIVITY

- EXCEL:FORBIDDEN

- EXCEL:INVALID\_CONNECTION

- EXCEL:INVALID\_CREDENTIALS

- EXCEL:NOT\_FOUND

- EXCEL:RETRY\_EXHAUSTED

- EXCEL:SERVER\_ERROR

- EXCEL:TIMEOUT

## Get Range Row

`<excel:get-range-row>`

Gets a row contained in the range.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Workbook Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the workbook.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Name</p></td><td><div><div><p>String</p></div></div></td><td><p>The name.</p></td><td></td><td></td></tr><tr><td><p>Worksheet Name</p></td><td><div><div><p>String</p></div></div></td><td><p>The name of the worksheet.</p></td><td></td><td></td></tr><tr><td><p>Address</p></td><td><div><div><p>String</p></div></div></td><td><p>The address.</p></td><td></td><td></td></tr><tr><td><p>Table Name/Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the table.</p></td><td></td><td></td></tr><tr><td><p>Column Name/Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID or name of the column.</p></td><td></td><td></td></tr><tr><td><p>Row Number</p></td><td><div><div><p>Number</p></div></div></td><td><p>Row number of the range to be retrieved. Zero-indexed.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>The name of the configuration to use to execute this component.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Response timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>Response timeout for the request. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Response timeout unit for the request. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Custom headers</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers that the request will include. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Custom query parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters that the request will include. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p>Binary</p></div></div></td></tr></tbody></table>

### For Configurations

- [Authorization Code Config](#AuthorizationCodeConfig)

### Throws

- EXCEL:BAD\_REQUEST

- EXCEL:CONNECTIVITY

- EXCEL:FORBIDDEN

- EXCEL:INVALID\_CONNECTION

- EXCEL:INVALID\_CREDENTIALS

- EXCEL:NOT\_FOUND

- EXCEL:RETRY\_EXHAUSTED

- EXCEL:SERVER\_ERROR

- EXCEL:TIMEOUT

## Get Range Visible View

`<excel:get-range-visible-view>`

Get the range visible from a filtered range.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Workbook Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the workbook.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Worksheet Name</p></td><td><div><div><p>String</p></div></div></td><td><p>The name of the worksheet.</p></td><td></td><td></td></tr><tr><td><p>Address</p></td><td><div><div><p>String</p></div></div></td><td><p>The address.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>The name of the configuration to use to execute this component.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Response timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>Response timeout for the request. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Response timeout unit for the request. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Custom headers</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers that the request will include. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Custom query parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters that the request will include. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p>Binary</p></div></div></td></tr></tbody></table>

### For Configurations

- [Authorization Code Config](#AuthorizationCodeConfig)

### Throws

- EXCEL:BAD\_REQUEST

- EXCEL:CONNECTIVITY

- EXCEL:FORBIDDEN

- EXCEL:INVALID\_CONNECTION

- EXCEL:INVALID\_CREDENTIALS

- EXCEL:NOT\_FOUND

- EXCEL:RETRY\_EXHAUSTED

- EXCEL:SERVER\_ERROR

- EXCEL:TIMEOUT

## Get Resized Range

`<excel:get-resized-range>`

Gets a range object similar to the current range object, but with the bottom-right corner expanded
or contracted by a specified number of rows and columns.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Workbook Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the workbook.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Worksheet Name</p></td><td><div><div><p>String</p></div></div></td><td><p>The name of the worksheet.</p></td><td></td><td></td></tr><tr><td><p>Delta Rows</p></td><td><div><div><p>Number</p></div></div></td><td><p>The number of rows by which to expand the bottom-right corner, relative to the current range. Use a positive number to expand the range, or a negative number to decrease it.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Delta Columns</p></td><td><div><div><p>Number</p></div></div></td><td><p>The number of columns by which to expand the bottom-right corner, relative to the current range. Use a positive number to expand the range, or a negative number to decrease it.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>The name of the configuration to use to execute this component.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Response timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>Response timeout for the request. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Response timeout unit for the request. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Custom headers</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers that the request will include. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Custom query parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters that the request will include. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p>Binary</p></div></div></td></tr></tbody></table>

### For Configurations

- [Authorization Code Config](#AuthorizationCodeConfig)

### Throws

- EXCEL:BAD\_REQUEST

- EXCEL:CONNECTIVITY

- EXCEL:FORBIDDEN

- EXCEL:INVALID\_CONNECTION

- EXCEL:INVALID\_CREDENTIALS

- EXCEL:NOT\_FOUND

- EXCEL:RETRY\_EXHAUSTED

- EXCEL:SERVER\_ERROR

- EXCEL:TIMEOUT

## Get Row

`<excel:get-row>`

Retrieves a list of TableRow objects.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Workbook Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the workbook. where rows are located.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Worksheet Name</p></td><td><div><div><p>String</p></div></div></td><td><p>The name of the worksheet where the rows are located.</p></td><td></td><td></td></tr><tr><td><p>Table Name/Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the table.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Row Index</p></td><td><div><div><p>Number</p></div></div></td><td><p>The index of the row to retrieve.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>The name of the configuration to use to execute this component.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Response timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>Response timeout for the request. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Response timeout unit for the request. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Custom headers</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers that the request will include. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Custom query parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters that the request will include. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p>Binary</p></div></div></td></tr></tbody></table>

### For Configurations

- [Authorization Code Config](#AuthorizationCodeConfig)

### Throws

- EXCEL:CONNECTIVITY

- EXCEL:RETRY\_EXHAUSTED

## Get Rows Above Range

`<excel:get-rows-above-range>`

Gets a certain number of rows above a given range.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Workbook Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the workbook.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Worksheet Name</p></td><td><div><div><p>String</p></div></div></td><td><p>The name of the worksheet.</p></td><td></td><td></td></tr><tr><td><p>Count</p></td><td><div><div><p>Number</p></div></div></td><td><p>The number of rows to include in the resulting range.</p></td><td><p>1</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>The name of the configuration to use to execute this component.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Response timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>Response timeout for the request. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Response timeout unit for the request. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Custom headers</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers that the request will include. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Custom query parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters that the request will include. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p>Binary</p></div></div></td></tr></tbody></table>

### For Configurations

- [Authorization Code Config](#AuthorizationCodeConfig)

### Throws

- EXCEL:BAD\_REQUEST

- EXCEL:CONNECTIVITY

- EXCEL:FORBIDDEN

- EXCEL:INVALID\_CONNECTION

- EXCEL:INVALID\_CREDENTIALS

- EXCEL:NOT\_FOUND

- EXCEL:RETRY\_EXHAUSTED

- EXCEL:SERVER\_ERROR

- EXCEL:TIMEOUT

## Get Rows Below Range

`<excel:get-rows-below-range>`

Gets a certain number of rows below a given range.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Workbook Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the workbook.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Worksheet Name</p></td><td><div><div><p>String</p></div></div></td><td><p>The name of the worksheet.</p></td><td></td><td></td></tr><tr><td><p>Count</p></td><td><div><div><p>Number</p></div></div></td><td><p>The number of rows to include in the resulting range.</p></td><td><p>1</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>The name of the configuration to use to execute this component.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Response timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>Response timeout for the request. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Response timeout unit for the request. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Custom headers</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers that the request will include. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Custom query parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters that the request will include. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p>Binary</p></div></div></td></tr></tbody></table>

### For Configurations

- [Authorization Code Config](#AuthorizationCodeConfig)

### Throws

- EXCEL:BAD\_REQUEST

- EXCEL:CONNECTIVITY

- EXCEL:FORBIDDEN

- EXCEL:INVALID\_CONNECTION

- EXCEL:INVALID\_CREDENTIALS

- EXCEL:NOT\_FOUND

- EXCEL:RETRY\_EXHAUSTED

- EXCEL:SERVER\_ERROR

- EXCEL:TIMEOUT

## Get Table

`<excel:get-table>`

Retrieves the properties and relationships of a table object.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Workbook Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the workbook. where table is located.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Worksheet Name</p></td><td><div><div><p>String</p></div></div></td><td><p>The name of the worksheet where the table is located.</p></td><td></td><td></td></tr><tr><td><p>Table Name/Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the table.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>The name of the configuration to use to execute this component.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Response timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>Response timeout for the request. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Response timeout unit for the request. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Custom headers</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers that the request will include. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Custom query parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters that the request will include. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p>Binary</p></div></div></td></tr></tbody></table>

### For Configurations

- [Authorization Code Config](#AuthorizationCodeConfig)

### Throws

- EXCEL:BAD\_REQUEST

- EXCEL:CONNECTIVITY

- EXCEL:FORBIDDEN

- EXCEL:INVALID\_CONNECTION

- EXCEL:INVALID\_CREDENTIALS

- EXCEL:NOT\_FOUND

- EXCEL:RETRY\_EXHAUSTED

- EXCEL:SERVER\_ERROR

- EXCEL:TIMEOUT

## Get Table Range

`<excel:get-table-range>`

Gets the range object associated with the entire table.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Workbook Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the workbook.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Worksheet Name</p></td><td><div><div><p>String</p></div></div></td><td><p>The name of the worksheet.</p></td><td></td><td></td></tr><tr><td><p>Table Name/Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the table.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>The name of the configuration to use to execute this component.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Response timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>Response timeout for the request. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Response timeout unit for the request. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Custom headers</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers that the request will include. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Custom query parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters that the request will include. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p>Binary</p></div></div></td></tr></tbody></table>

### For Configurations

- [Authorization Code Config](#AuthorizationCodeConfig)

### Throws

- EXCEL:BAD\_REQUEST

- EXCEL:CONNECTIVITY

- EXCEL:FORBIDDEN

- EXCEL:INVALID\_CONNECTION

- EXCEL:INVALID\_CREDENTIALS

- EXCEL:NOT\_FOUND

- EXCEL:RETRY\_EXHAUSTED

- EXCEL:SERVER\_ERROR

- EXCEL:TIMEOUT

## Get Used Range

`<excel:get-used-range>`

Gets the used range, which is the smallest range that encompasses any cells that have a value or
formatting assigned to them.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Workbook Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The workbook ID where the worksheet is located.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Worksheet Name</p></td><td><div><div><p>String</p></div></div></td><td><p>The worksheet name to retrieve.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Values Only</p></td><td><div><div><p>Boolean</p></div></div></td><td><p>Considers only cells with values as used cells (ignores formatting).</p></td><td><p>false</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>The name of the configuration to use to execute this component.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Response timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>Response timeout for the request. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Response timeout unit for the request. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Custom headers</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers that the request will include. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Custom query parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters that the request will include. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p>Binary</p></div></div></td></tr></tbody></table>

### For Configurations

- [Authorization Code Config](#AuthorizationCodeConfig)

### Throws

- EXCEL:BAD\_REQUEST

- EXCEL:CONNECTIVITY

- EXCEL:FORBIDDEN

- EXCEL:INVALID\_CONNECTION

- EXCEL:INVALID\_CREDENTIALS

- EXCEL:NOT\_FOUND

- EXCEL:RETRY\_EXHAUSTED

- EXCEL:SERVER\_ERROR

- EXCEL:TIMEOUT

## Get Workbook Application

`<excel:get-workbook-application>`

Retrieves the properties and relationships of a workbookApplication object.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Workbook Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the workbook. the application will retrieve.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>The name of the configuration to use to execute this component.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Response timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>Response timeout for the request. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Response timeout unit for the request. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Custom headers</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers that the request will include. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Custom query parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters that the request will include. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p>Binary</p></div></div></td></tr></tbody></table>

### For Configurations

- [Authorization Code Config](#AuthorizationCodeConfig)

### Throws

- EXCEL:BAD\_REQUEST

- EXCEL:CONNECTIVITY

- EXCEL:FORBIDDEN

- EXCEL:INVALID\_CONNECTION

- EXCEL:INVALID\_CREDENTIALS

- EXCEL:NOT\_FOUND

- EXCEL:RETRY\_EXHAUSTED

- EXCEL:SERVER\_ERROR

- EXCEL:TIMEOUT

## Get Workbook Comment

`<excel:get-workbook-comment>`

Retrieves the properties and relationships of a workbookComment object.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Workbook Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the workbook. where the comment is located.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Comment Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the comment to retrieve.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>The name of the configuration to use to execute this component.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Response timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>Response timeout for the request. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Response timeout unit for the request. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Custom headers</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers that the request will include. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Custom query parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters that the request will include. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p>Binary</p></div></div></td></tr></tbody></table>

### For Configurations

- [Authorization Code Config](#AuthorizationCodeConfig)

### Throws

- EXCEL:BAD\_REQUEST

- EXCEL:CONNECTIVITY

- EXCEL:FORBIDDEN

- EXCEL:INVALID\_CONNECTION

- EXCEL:INVALID\_CREDENTIALS

- EXCEL:NOT\_FOUND

- EXCEL:RETRY\_EXHAUSTED

- EXCEL:SERVER\_ERROR

- EXCEL:TIMEOUT

## Get Worksheet

`<excel:get-worksheet>`

Retrieves the properties and relationships of a worksheet object.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Workbook Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The workbook ID where the worksheet is located.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Workbook Name</p></td><td><div><div><p>String</p></div></div></td><td><p>The worksheet name to retrieve.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>The name of the configuration to use to execute this component.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Response timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>Response timeout for the request. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Response timeout unit for the request. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Custom headers</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers that the request will include. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Custom query parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters that the request will include. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p>Binary</p></div></div></td></tr></tbody></table>

### For Configurations

- [Authorization Code Config](#AuthorizationCodeConfig)

### Throws

- EXCEL:CONNECTIVITY

- EXCEL:RETRY\_EXHAUSTED

## Insert Range

`<excel:insert-range>`

Inserts a cell or a range of cells into the worksheet. It shifts the other cells to make space and
returns a new Range object at the now blank space.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Workbook Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the workbook.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Name</p></td><td><div><div><p>String</p></div></div></td><td><p>The name.</p></td><td></td><td></td></tr><tr><td><p>Worksheet Name</p></td><td><div><div><p>String</p></div></div></td><td><p>The name of the worksheet.</p></td><td></td><td></td></tr><tr><td><p>Address</p></td><td><div><div><p>String</p></div></div></td><td><p>The address.</p></td><td></td><td></td></tr><tr><td><p>Table Name/Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the table.</p></td><td></td><td></td></tr><tr><td><p>Column Name/Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID or name of the column.</p></td><td></td><td></td></tr><tr><td><p>Shift</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>DOWN</p></li><li><p>RIGHT</p></li></ul></div></div></td><td><p>Specifies which way to shift the cells. The possible values are: Down, Right.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>The name of the configuration to use to execute this component.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Response timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>Response timeout for the request. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Response timeout unit for the request. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Custom headers</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers that the request will include. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Custom query parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters that the request will include. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p>Binary</p></div></div></td></tr></tbody></table>

### For Configurations

- [Authorization Code Config](#AuthorizationCodeConfig)

### Throws

- EXCEL:BAD\_REQUEST

- EXCEL:CONNECTIVITY

- EXCEL:FORBIDDEN

- EXCEL:INVALID\_CONNECTION

- EXCEL:INVALID\_CREDENTIALS

- EXCEL:NOT\_FOUND

- EXCEL:RETRY\_EXHAUSTED

- EXCEL:SERVER\_ERROR

- EXCEL:TIMEOUT

## List Chart Series

`<excel:list-chart-series>`

Lists a ChartSeries.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Workbook Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the workbook. where the component is located.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Worksheet Name</p></td><td><div><div><p>String</p></div></div></td><td><p>The name of the worksheet where the component is located.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Chart Name</p></td><td><div><div><p>String</p></div></div></td><td><p>The name of the worksheet where the component is located.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>The name of the configuration to use to execute this component.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryIterable">Repeatable In Memory Iterable</a></p></li><li><p><a href="#RepeatableFileStoreIterable">Repeatable File Store Iterable</a></p></li><li><p>non-repeatable-iterable</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Select</p></td><td><div><div><p>String</p></div></div></td><td><p>Properties to retrieve in the response.</p></td><td></td><td></td></tr><tr><td><p>Expand</p></td><td><div><div><p>String</p></div></div></td><td><p>The response will include information regarding the specified relationship.</p></td><td></td><td></td></tr><tr><td><p>Filter</p></td><td><div><div><p>String</p></div></div></td><td><p>Retrieves a subset of a collection.</p></td><td></td><td></td></tr><tr><td><p>Order By</p></td><td><div><div><p>String</p></div></div></td><td><p>Specifies the sort order of the items returned.</p></td><td></td><td></td></tr><tr><td><p>Search</p></td><td><div><div><p>String</p></div></div></td><td><p>Restricts the results of a request to match a search criteria.</p></td><td></td><td></td></tr><tr><td><p>Page size</p></td><td><div><div><p>Number</p></div></div></td><td><p>The size of the pages retrieved by the query.</p></td><td><p>100</p></td><td></td></tr><tr><td><p>Response timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>Response timeout for the request. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Response timeout unit for the request. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Custom headers</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers that the request will include. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Custom query parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters that the request will include. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Array of Any</p></td></tr></tbody></table>

### For Configurations

- [Authorization Code Config](#AuthorizationCodeConfig)

### Throws

- EXCEL:BAD\_REQUEST

- EXCEL:FORBIDDEN

- EXCEL:INVALID\_CONNECTION

- EXCEL:INVALID\_CREDENTIALS

- EXCEL:NOT\_FOUND

- EXCEL:SERVER\_ERROR

- EXCEL:TIMEOUT

## List Charts

`<excel:list-charts>`

Retrieves a list of chart objects.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Workbook Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the workbook. where the component is located.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Worksheet Name</p></td><td><div><div><p>String</p></div></div></td><td><p>The name of the worksheet where the component is located.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>The name of the configuration to use to execute this component.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryIterable">Repeatable In Memory Iterable</a></p></li><li><p><a href="#RepeatableFileStoreIterable">Repeatable File Store Iterable</a></p></li><li><p>non-repeatable-iterable</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Select</p></td><td><div><div><p>String</p></div></div></td><td><p>Properties to retrieve in the response.</p></td><td></td><td></td></tr><tr><td><p>Expand</p></td><td><div><div><p>String</p></div></div></td><td><p>The response will include information regarding the specified relationship.</p></td><td></td><td></td></tr><tr><td><p>Filter</p></td><td><div><div><p>String</p></div></div></td><td><p>Retrieves a subset of a collection.</p></td><td></td><td></td></tr><tr><td><p>Order By</p></td><td><div><div><p>String</p></div></div></td><td><p>Specifies the sort order of the items returned.</p></td><td></td><td></td></tr><tr><td><p>Search</p></td><td><div><div><p>String</p></div></div></td><td><p>Restricts the results of a request to match a search criteria.</p></td><td></td><td></td></tr><tr><td><p>Page size</p></td><td><div><div><p>Number</p></div></div></td><td><p>The size of the pages retrieved by the query.</p></td><td><p>100</p></td><td></td></tr><tr><td><p>Response timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>Response timeout for the request. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Response timeout unit for the request. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Custom headers</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers that the request will include. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Custom query parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters that the request will include. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Array of Any</p></td></tr></tbody></table>

### For Configurations

- [Authorization Code Config](#AuthorizationCodeConfig)

### Throws

- EXCEL:BAD\_REQUEST

- EXCEL:FORBIDDEN

- EXCEL:INVALID\_CONNECTION

- EXCEL:INVALID\_CREDENTIALS

- EXCEL:NOT\_FOUND

- EXCEL:SERVER\_ERROR

- EXCEL:TIMEOUT

## List Columns

`<excel:list-columns>`

Retrieves a list of TableColumn objects.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Workbook Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the workbook.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Worksheet Name</p></td><td><div><div><p>String</p></div></div></td><td><p>The name of the worksheet.</p></td><td></td><td></td></tr><tr><td><p>Table Name/Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the table.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>The name of the configuration to use to execute this component.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryIterable">Repeatable In Memory Iterable</a></p></li><li><p><a href="#RepeatableFileStoreIterable">Repeatable File Store Iterable</a></p></li><li><p>non-repeatable-iterable</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Select</p></td><td><div><div><p>String</p></div></div></td><td><p>Properties to retrieve in the response.</p></td><td></td><td></td></tr><tr><td><p>Expand</p></td><td><div><div><p>String</p></div></div></td><td><p>The response will include information regarding the specified relationship.</p></td><td></td><td></td></tr><tr><td><p>Filter</p></td><td><div><div><p>String</p></div></div></td><td><p>Retrieves a subset of a collection.</p></td><td></td><td></td></tr><tr><td><p>Order By</p></td><td><div><div><p>String</p></div></div></td><td><p>Specifies the sort order of the items returned.</p></td><td></td><td></td></tr><tr><td><p>Search</p></td><td><div><div><p>String</p></div></div></td><td><p>Restricts the results of a request to match a search criteria.</p></td><td></td><td></td></tr><tr><td><p>Page size</p></td><td><div><div><p>Number</p></div></div></td><td><p>The size of the pages retrieved by the query.</p></td><td><p>100</p></td><td></td></tr><tr><td><p>Response timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>Response timeout for the request. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Response timeout unit for the request. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Custom headers</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers that the request will include. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Custom query parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters that the request will include. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr></tbody></table>

### For Configurations

- [Authorization Code Config](#AuthorizationCodeConfig)

### Throws

- EXCEL:BAD\_REQUEST

- EXCEL:FORBIDDEN

- EXCEL:INVALID\_CONNECTION

- EXCEL:INVALID\_CREDENTIALS

- EXCEL:NOT\_FOUND

- EXCEL:SERVER\_ERROR

- EXCEL:TIMEOUT

## List Named Item

`<excel:list-named-item>`

Retrieves a list of NamedItem objects.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Workbook Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the workbook where rows are added.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>The name of the configuration to use to execute this component.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryIterable">Repeatable In Memory Iterable</a></p></li><li><p><a href="#RepeatableFileStoreIterable">Repeatable File Store Iterable</a></p></li><li><p>non-repeatable-iterable</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Response timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>Response timeout for the request. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Response timeout unit for the request. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Custom headers</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers that the request will include. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Custom query parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters that the request will include. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Select</p></td><td><div><div><p>String</p></div></div></td><td><p>Properties to retrieve in the response.</p></td><td></td><td></td></tr><tr><td><p>Expand</p></td><td><div><div><p>String</p></div></div></td><td><p>The response will include information regarding the specified relationship.</p></td><td></td><td></td></tr><tr><td><p>Filter</p></td><td><div><div><p>String</p></div></div></td><td><p>Retrieves a subset of a collection.</p></td><td></td><td></td></tr><tr><td><p>Order By</p></td><td><div><div><p>String</p></div></div></td><td><p>Specifies the sort order of the items returned.</p></td><td></td><td></td></tr><tr><td><p>Search</p></td><td><div><div><p>String</p></div></div></td><td><p>Restricts the results of a request to match a search criteria.</p></td><td></td><td></td></tr><tr><td><p>Page size</p></td><td><div><div><p>Number</p></div></div></td><td><p>The size of the pages retrieved by the query.</p></td><td><p>100</p></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Array of Any</p></td></tr></tbody></table>

### For Configurations

- [Authorization Code Config](#AuthorizationCodeConfig)

### Throws

- EXCEL:BAD\_REQUEST

- EXCEL:FORBIDDEN

- EXCEL:INVALID\_CONNECTION

- EXCEL:INVALID\_CREDENTIALS

- EXCEL:NOT\_FOUND

- EXCEL:SERVER\_ERROR

- EXCEL:TIMEOUT

## List Names

`<excel:list-names>`

Retrieves a list of NamedItem objects.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Workbook Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the workbook.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>The name of the configuration to use to execute this component.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryIterable">Repeatable In Memory Iterable</a></p></li><li><p><a href="#RepeatableFileStoreIterable">Repeatable File Store Iterable</a></p></li><li><p>non-repeatable-iterable</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Select</p></td><td><div><div><p>String</p></div></div></td><td><p>Properties to retrieve in the response.</p></td><td></td><td></td></tr><tr><td><p>Expand</p></td><td><div><div><p>String</p></div></div></td><td><p>The response will include information regarding the specified relationship.</p></td><td></td><td></td></tr><tr><td><p>Filter</p></td><td><div><div><p>String</p></div></div></td><td><p>Retrieves a subset of a collection.</p></td><td></td><td></td></tr><tr><td><p>Order By</p></td><td><div><div><p>String</p></div></div></td><td><p>Specifies the sort order of the items returned.</p></td><td></td><td></td></tr><tr><td><p>Search</p></td><td><div><div><p>String</p></div></div></td><td><p>Restricts the results of a request to match a search criteria.</p></td><td></td><td></td></tr><tr><td><p>Page size</p></td><td><div><div><p>Number</p></div></div></td><td><p>The size of the pages retrieved by the query.</p></td><td><p>100</p></td><td></td></tr><tr><td><p>Response timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>Response timeout for the request. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Response timeout unit for the request. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Custom headers</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers that the request will include. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Custom query parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters that the request will include. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Array of Any</p></td></tr></tbody></table>

### For Configurations

- [Authorization Code Config](#AuthorizationCodeConfig)

### Throws

- EXCEL:BAD\_REQUEST

- EXCEL:FORBIDDEN

- EXCEL:INVALID\_CONNECTION

- EXCEL:INVALID\_CREDENTIALS

- EXCEL:NOT\_FOUND

- EXCEL:SERVER\_ERROR

- EXCEL:TIMEOUT

## List Pivot Tables

`<excel:list-pivot-tables>`

Gets a workbookPivotTable object collection.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Workbook Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The workbook ID where the worksheet is located.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Worksheet Name</p></td><td><div><div><p>String</p></div></div></td><td><p>The worksheet name to retrieve.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>The name of the configuration to use to execute this component.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryIterable">Repeatable In Memory Iterable</a></p></li><li><p><a href="#RepeatableFileStoreIterable">Repeatable File Store Iterable</a></p></li><li><p>non-repeatable-iterable</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Select</p></td><td><div><div><p>String</p></div></div></td><td><p>Properties to retrieve in the response.</p></td><td></td><td></td></tr><tr><td><p>Expand</p></td><td><div><div><p>String</p></div></div></td><td><p>The response will include information regarding the specified relationship.</p></td><td></td><td></td></tr><tr><td><p>Filter</p></td><td><div><div><p>String</p></div></div></td><td><p>Retrieves a subset of a collection.</p></td><td></td><td></td></tr><tr><td><p>Order By</p></td><td><div><div><p>String</p></div></div></td><td><p>Specifies the sort order of the items returned.</p></td><td></td><td></td></tr><tr><td><p>Search</p></td><td><div><div><p>String</p></div></div></td><td><p>Restricts the results of a request to match a search criteria.</p></td><td></td><td></td></tr><tr><td><p>Page size</p></td><td><div><div><p>Number</p></div></div></td><td><p>The size of the pages retrieved by the query.</p></td><td><p>100</p></td><td></td></tr><tr><td><p>Response timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>Response timeout for the request. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Response timeout unit for the request. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Custom headers</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers that the request will include. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Custom query parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters that the request will include. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr></tbody></table>

### For Configurations

- [Authorization Code Config](#AuthorizationCodeConfig)

### Throws

- EXCEL:BAD\_REQUEST

- EXCEL:FORBIDDEN

- EXCEL:INVALID\_CONNECTION

- EXCEL:INVALID\_CREDENTIALS

- EXCEL:NOT\_FOUND

- EXCEL:SERVER\_ERROR

- EXCEL:TIMEOUT

## List Rows

`<excel:list-rows>`

Retrieves a list of TableRow objects.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Workbook Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the workbook where rows are added.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Worksheet Name</p></td><td><div><div><p>String</p></div></div></td><td><p>The name of the worksheet where the table is located.</p></td><td></td><td></td></tr><tr><td><p>Table Name/Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the table.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>The name of the configuration to use to execute this component.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryIterable">Repeatable In Memory Iterable</a></p></li><li><p><a href="#RepeatableFileStoreIterable">Repeatable File Store Iterable</a></p></li><li><p>non-repeatable-iterable</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Select</p></td><td><div><div><p>String</p></div></div></td><td><p>Properties to retrieve in the response.</p></td><td></td><td></td></tr><tr><td><p>Expand</p></td><td><div><div><p>String</p></div></div></td><td><p>The response will include information regarding the specified relationship.</p></td><td></td><td></td></tr><tr><td><p>Filter</p></td><td><div><div><p>String</p></div></div></td><td><p>Retrieves a subset of a collection.</p></td><td></td><td></td></tr><tr><td><p>Order By</p></td><td><div><div><p>String</p></div></div></td><td><p>Specifies the sort order of the items returned.</p></td><td></td><td></td></tr><tr><td><p>Search</p></td><td><div><div><p>String</p></div></div></td><td><p>Restricts the results of a request to match a search criteria.</p></td><td></td><td></td></tr><tr><td><p>Page size</p></td><td><div><div><p>Number</p></div></div></td><td><p>The size of the pages retrieved by the query.</p></td><td><p>100</p></td><td></td></tr><tr><td><p>Response timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>Response timeout for the request. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Response timeout unit for the request. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Custom headers</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers that the request will include. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Custom query parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters that the request will include. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr></tbody></table>

### For Configurations

- [Authorization Code Config](#AuthorizationCodeConfig)

### Throws

- EXCEL:BAD\_REQUEST

- EXCEL:FORBIDDEN

- EXCEL:INVALID\_CONNECTION

- EXCEL:INVALID\_CREDENTIALS

- EXCEL:NOT\_FOUND

- EXCEL:SERVER\_ERROR

- EXCEL:TIMEOUT

## List Tables

`<excel:list-tables>`

Retrieves a list of table objects.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Workbook Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the workbook.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>The name of the configuration to use to execute this component.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryIterable">Repeatable In Memory Iterable</a></p></li><li><p><a href="#RepeatableFileStoreIterable">Repeatable File Store Iterable</a></p></li><li><p>non-repeatable-iterable</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Select</p></td><td><div><div><p>String</p></div></div></td><td><p>Properties to retrieve in the response.</p></td><td></td><td></td></tr><tr><td><p>Expand</p></td><td><div><div><p>String</p></div></div></td><td><p>The response will include information regarding the specified relationship.</p></td><td></td><td></td></tr><tr><td><p>Filter</p></td><td><div><div><p>String</p></div></div></td><td><p>Retrieves a subset of a collection.</p></td><td></td><td></td></tr><tr><td><p>Order By</p></td><td><div><div><p>String</p></div></div></td><td><p>Specifies the sort order of the items returned.</p></td><td></td><td></td></tr><tr><td><p>Search</p></td><td><div><div><p>String</p></div></div></td><td><p>Restricts the results of a request to match a search criteria.</p></td><td></td><td></td></tr><tr><td><p>Page size</p></td><td><div><div><p>Number</p></div></div></td><td><p>The size of the pages retrieved by the query.</p></td><td><p>100</p></td><td></td></tr><tr><td><p>Response timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>Response timeout for the request. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Response timeout unit for the request. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Custom headers</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers that the request will include. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Custom query parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters that the request will include. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Array of Any</p></td></tr></tbody></table>

### For Configurations

- [Authorization Code Config](#AuthorizationCodeConfig)

## List Workbook Comments

`<excel:list-workbook-comments>`

Retrieves a list of workbookComment objects.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Workbook Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the workbook where the comments are listed from.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>The name of the configuration to use to execute this component.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryIterable">Repeatable In Memory Iterable</a></p></li><li><p><a href="#RepeatableFileStoreIterable">Repeatable File Store Iterable</a></p></li><li><p>non-repeatable-iterable</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Select</p></td><td><div><div><p>String</p></div></div></td><td><p>Properties to retrieve in the response.</p></td><td></td><td></td></tr><tr><td><p>Expand</p></td><td><div><div><p>String</p></div></div></td><td><p>The response will include information regarding the specified relationship.</p></td><td></td><td></td></tr><tr><td><p>Filter</p></td><td><div><div><p>String</p></div></div></td><td><p>Retrieves a subset of a collection.</p></td><td></td><td></td></tr><tr><td><p>Order By</p></td><td><div><div><p>String</p></div></div></td><td><p>Specifies the sort order of the items returned.</p></td><td></td><td></td></tr><tr><td><p>Search</p></td><td><div><div><p>String</p></div></div></td><td><p>Restricts the results of a request to match a search criteria.</p></td><td></td><td></td></tr><tr><td><p>Page size</p></td><td><div><div><p>Number</p></div></div></td><td><p>The size of the pages retrieved by the query.</p></td><td><p>100</p></td><td></td></tr><tr><td><p>Response timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>Response timeout for the request. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Response timeout unit for the request. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Custom headers</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers that the request will include. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Custom query parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters that the request will include. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr></tbody></table>

### For Configurations

- [Authorization Code Config](#AuthorizationCodeConfig)

## List Worksheet

`<excel:list-worksheet>`

Retrieves a list of worksheet objects.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Workbook Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The workbook ID where the worksheet is located.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>The name of the configuration to use to execute this component.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryIterable">Repeatable In Memory Iterable</a></p></li><li><p><a href="#RepeatableFileStoreIterable">Repeatable File Store Iterable</a></p></li><li><p>non-repeatable-iterable</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Response timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>Response timeout for the request. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Response timeout unit for the request. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Custom headers</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers that the request will include. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Custom query parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters that the request will include. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Select</p></td><td><div><div><p>String</p></div></div></td><td><p>Properties to retrieve in the response.</p></td><td></td><td></td></tr><tr><td><p>Expand</p></td><td><div><div><p>String</p></div></div></td><td><p>The response will include information regarding the specified relationship.</p></td><td></td><td></td></tr><tr><td><p>Filter</p></td><td><div><div><p>String</p></div></div></td><td><p>Retrieves a subset of a collection.</p></td><td></td><td></td></tr><tr><td><p>Order By</p></td><td><div><div><p>String</p></div></div></td><td><p>Specifies the sort order of the items returned.</p></td><td></td><td></td></tr><tr><td><p>Search</p></td><td><div><div><p>String</p></div></div></td><td><p>Restricts the results of a request to match a search criteria.</p></td><td></td><td></td></tr><tr><td><p>Page size</p></td><td><div><div><p>Number</p></div></div></td><td><p>The size of the pages retrieved by the query.</p></td><td><p>100</p></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Array of Any</p></td></tr></tbody></table>

### For Configurations

- [Authorization Code Config](#AuthorizationCodeConfig)

## Range Bounding Rect

`<excel:range-bounding-rect>`

Gets the smallest range object that encompasses the given ranges.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Workbook Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the workbook.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Name</p></td><td><div><div><p>String</p></div></div></td><td><p>The name.</p></td><td></td><td></td></tr><tr><td><p>Worksheet Name</p></td><td><div><div><p>String</p></div></div></td><td><p>The name of the worksheet.</p></td><td></td><td></td></tr><tr><td><p>Address</p></td><td><div><div><p>String</p></div></div></td><td><p>The address.</p></td><td></td><td></td></tr><tr><td><p>Table Name/Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the table.</p></td><td></td><td></td></tr><tr><td><p>Column Name/Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID or name of the column.</p></td><td></td><td></td></tr><tr><td><p>Another Range</p></td><td><div><div><p>String</p></div></div></td><td><p>The range object or address or range name.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>The name of the configuration to use to execute this component.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Response timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>Response timeout for the request. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Response timeout unit for the request. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Custom headers</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers that the request will include. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Custom query parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters that the request will include. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p>Binary</p></div></div></td></tr></tbody></table>

### For Configurations

- [Authorization Code Config](#AuthorizationCodeConfig)

### Throws

- EXCEL:BAD\_REQUEST

- EXCEL:CONNECTIVITY

- EXCEL:FORBIDDEN

- EXCEL:INVALID\_CONNECTION

- EXCEL:INVALID\_CREDENTIALS

- EXCEL:NOT\_FOUND

- EXCEL:RETRY\_EXHAUSTED

- EXCEL:SERVER\_ERROR

- EXCEL:TIMEOUT

## Range Clear

`<excel:range-clear>`

Clears values such as range values, format, fill, or border.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Workbook Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the workbook.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Name</p></td><td><div><div><p>String</p></div></div></td><td><p>The name.</p></td><td></td><td></td></tr><tr><td><p>Worksheet Name</p></td><td><div><div><p>String</p></div></div></td><td><p>The name of the worksheet.</p></td><td></td><td></td></tr><tr><td><p>Address</p></td><td><div><div><p>String</p></div></div></td><td><p>The address.</p></td><td></td><td></td></tr><tr><td><p>Table Name/Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the table.</p></td><td></td><td></td></tr><tr><td><p>Column Name/Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID or name of the column.</p></td><td></td><td></td></tr><tr><td><p>Apply To</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>ALL</p></li><li><p>FORMATS</p></li><li><p>CONTENTS</p></li></ul></div></div></td><td><p>Determines the type of clear action. The possible values are: All, Formats, Contents.</p></td><td><p>ALL</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>The name of the configuration to use to execute this component.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Response timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>Response timeout for the request. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Response timeout unit for the request. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Custom headers</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers that the request will include. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Custom query parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters that the request will include. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p>Binary</p></div></div></td></tr></tbody></table>

### For Configurations

- [Authorization Code Config](#AuthorizationCodeConfig)

### Throws

- EXCEL:BAD\_REQUEST

- EXCEL:CONNECTIVITY

- EXCEL:FORBIDDEN

- EXCEL:INVALID\_CONNECTION

- EXCEL:INVALID\_CREDENTIALS

- EXCEL:NOT\_FOUND

- EXCEL:RETRY\_EXHAUSTED

- EXCEL:SERVER\_ERROR

- EXCEL:TIMEOUT

## Range Delete

`<excel:range-delete>`

Deletes the cells associated with the range.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Workbook Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the workbook.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Name</p></td><td><div><div><p>String</p></div></div></td><td><p>The name.</p></td><td></td><td></td></tr><tr><td><p>Worksheet Name</p></td><td><div><div><p>String</p></div></div></td><td><p>The name of the worksheet.</p></td><td></td><td></td></tr><tr><td><p>Address</p></td><td><div><div><p>String</p></div></div></td><td><p>The address.</p></td><td></td><td></td></tr><tr><td><p>Table Name/Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the table.</p></td><td></td><td></td></tr><tr><td><p>Column Name/Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID or name of the column.</p></td><td></td><td></td></tr><tr><td><p>Shift</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>UP</p></li><li><p>LEFT</p></li></ul></div></div></td><td><p>Specifies which way to shift the cells. The possible values are: Up, Left.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>The name of the configuration to use to execute this component.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Response timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>Response timeout for the request. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Response timeout unit for the request. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Custom headers</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers that the request will include. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Custom query parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters that the request will include. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p>Binary</p></div></div></td></tr></tbody></table>

### For Configurations

- [Authorization Code Config](#AuthorizationCodeConfig)

### Throws

- EXCEL:BAD\_REQUEST

- EXCEL:CONNECTIVITY

- EXCEL:FORBIDDEN

- EXCEL:INVALID\_CONNECTION

- EXCEL:INVALID\_CREDENTIALS

- EXCEL:NOT\_FOUND

- EXCEL:RETRY\_EXHAUSTED

- EXCEL:SERVER\_ERROR

- EXCEL:TIMEOUT

## Range Get Used Range

`<excel:range-get-used-range>`

Returns the used range of the given range object.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Workbook Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the workbook where the worksheet is located.</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Name</p></td><td><div><div><p>String</p></div></div></td><td><p>The name of the range.</p></td><td></td><td></td></tr><tr><td><p>Worksheet Name</p></td><td><div><div><p>String</p></div></div></td><td><p>The name of the worksheet.</p></td><td></td><td></td></tr><tr><td><p>Address</p></td><td><div><div><p>String</p></div></div></td><td><p>The address of the range.</p></td><td></td><td></td></tr><tr><td><p>Table Name/Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the table.</p></td><td></td><td></td></tr><tr><td><p>Column Name/Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the column.</p></td><td></td><td></td></tr><tr><td><p>Values Only</p></td><td><div><div><p>Boolean</p></div></div></td><td><p>Considers only cells with values as used cells.</p></td><td><p>false</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>The name of the configuration to use to execute this component.</p></td><td></td><td><p><strong>x</strong></p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Response timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>Response timeout for the request. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Response timeout unit for the request. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Custom headers</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers that the request will include. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Custom query parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters that the request will include. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><div><div><p>Any</p></div></div></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p>Binary</p></div></div></td></tr></tbody></table>

### For Configurations

- [Authorization Code Config](#AuthorizationCodeConfig)

### Throws

- EXCEL:ALREADY\_EXISTS

- EXCEL:BAD\_GATEWAY

- EXCEL:BAD\_REQUEST

- EXCEL:CONFLICT

- EXCEL:CONNECTIVITY

- EXCEL:FORBIDDEN

- EXCEL:INVALID\_CONNECTION

- EXCEL:INVALID\_CREDENTIALS

- EXCEL:INVALID\_SESSION

- EXCEL:NOT\_FOUND

- EXCEL:RETRY\_EXHAUSTED

- EXCEL:SERVER\_ERROR

- EXCEL:SERVICE\_LIMIT

- EXCEL:SERVICE\_UNAVAILABLE

- EXCEL:TIMEOUT

## Range Merge

`<excel:range-merge>`

Merges the range cells into one region in the worksheet.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Workbook Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the workbook.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Name</p></td><td><div><div><p>String</p></div></div></td><td><p>The name.</p></td><td></td><td></td></tr><tr><td><p>Worksheet Name</p></td><td><div><div><p>String</p></div></div></td><td><p>The name of the worksheet.</p></td><td></td><td></td></tr><tr><td><p>Address</p></td><td><div><div><p>String</p></div></div></td><td><p>The address.</p></td><td></td><td></td></tr><tr><td><p>Table Name/Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the table.</p></td><td></td><td></td></tr><tr><td><p>Column Name/Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID or name of the column.</p></td><td></td><td></td></tr><tr><td><p>Across</p></td><td><div><div><p>Boolean</p></div></div></td><td><p>Set <code>true</code> to merge cells in each row of the specified range as separate merged cells.</p></td><td><p>false</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>The name of the configuration to use to execute this component.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Response timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>Response timeout for the request. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Response timeout unit for the request. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Custom headers</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers that the request will include. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Custom query parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters that the request will include. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p>Binary</p></div></div></td></tr></tbody></table>

### For Configurations

- [Authorization Code Config](#AuthorizationCodeConfig)

### Throws

- EXCEL:BAD\_REQUEST

- EXCEL:CONNECTIVITY

- EXCEL:FORBIDDEN

- EXCEL:INVALID\_CONNECTION

- EXCEL:INVALID\_CREDENTIALS

- EXCEL:NOT\_FOUND

- EXCEL:RETRY\_EXHAUSTED

- EXCEL:SERVER\_ERROR

- EXCEL:TIMEOUT

## Range Unmerge

`<excel:range-unmerge>`

Unmerges the range cells into separate cells.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Workbook Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the workbook.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Name</p></td><td><div><div><p>String</p></div></div></td><td><p>The name.</p></td><td></td><td></td></tr><tr><td><p>Worksheet Name</p></td><td><div><div><p>String</p></div></div></td><td><p>The name of the worksheet.</p></td><td></td><td></td></tr><tr><td><p>Address</p></td><td><div><div><p>String</p></div></div></td><td><p>The address.</p></td><td></td><td></td></tr><tr><td><p>Table Name/Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the table.</p></td><td></td><td></td></tr><tr><td><p>Column Name/Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID or name of the column.</p></td><td></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>The name of the configuration to use to execute this component.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Response timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>Response timeout for the request. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Response timeout unit for the request. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Custom headers</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers that the request will include. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Custom query parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters that the request will include. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p>Binary</p></div></div></td></tr></tbody></table>

### For Configurations

- [Authorization Code Config](#AuthorizationCodeConfig)

### Throws

- EXCEL:BAD\_REQUEST

- EXCEL:CONNECTIVITY

- EXCEL:FORBIDDEN

- EXCEL:INVALID\_CONNECTION

- EXCEL:INVALID\_CREDENTIALS

- EXCEL:NOT\_FOUND

- EXCEL:RETRY\_EXHAUSTED

- EXCEL:SERVER\_ERROR

- EXCEL:TIMEOUT

## Reset Chart Data

`<excel:reset-chart-data>`

Resets the source data for the chart.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Workbook Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the workbook. where the component is located.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Worksheet Name</p></td><td><div><div><p>String</p></div></div></td><td><p>The name of the worksheet where the component is located.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Chart Name/Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Corresponding chart ID or name to retrieve.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Source Body</p></td><td><div><div><p>Any</p></div></div></td><td><p>Corresponding chart source body.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>The name of the configuration to use to execute this component.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Select</p></td><td><div><div><p>String</p></div></div></td><td><p>Properties to retrieve in the response.</p></td><td></td><td></td></tr><tr><td><p>Expand</p></td><td><div><div><p>String</p></div></div></td><td><p>The response will include information regarding the specified relationship.</p></td><td></td><td></td></tr><tr><td><p>Filter</p></td><td><div><div><p>String</p></div></div></td><td><p>Retrieves a subset of a collection.</p></td><td></td><td></td></tr><tr><td><p>Order By</p></td><td><div><div><p>String</p></div></div></td><td><p>Specifies the sort order of the items returned.</p></td><td></td><td></td></tr><tr><td><p>Search</p></td><td><div><div><p>String</p></div></div></td><td><p>Restricts the results of a request to match a search criteria.</p></td><td></td><td></td></tr><tr><td><p>Response timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>Response timeout for the request. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Response timeout unit for the request. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Custom headers</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers that the request will include. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Custom query parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters that the request will include. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p>Binary</p></div></div></td></tr></tbody></table>

### For Configurations

- [Authorization Code Config](#AuthorizationCodeConfig)

### Throws

- EXCEL:BAD\_REQUEST

- EXCEL:CONNECTIVITY

- EXCEL:FORBIDDEN

- EXCEL:INVALID\_CONNECTION

- EXCEL:INVALID\_CREDENTIALS

- EXCEL:NOT\_FOUND

- EXCEL:RETRY\_EXHAUSTED

- EXCEL:SERVER\_ERROR

- EXCEL:TIMEOUT

## Unauthorize

`<excel:unauthorize>`

Deletes all the access token information of a given resource owner ID so that it is impossible to
execute any operation for that user without doing the authorization dance again.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Resource Owner Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the resource owner of which access must be invalidated.</p></td><td></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>The name of the configuration to use to execute this component.</p></td><td></td><td><p>x</p></td></tr></tbody></table>

### For Configurations

- [Authorization Code Config](#AuthorizationCodeConfig)

## Update Chart

`<excel:update-chart>`

Update the properties of a chart object.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Workbook Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the workbook. where the component is located.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Worksheet Name</p></td><td><div><div><p>String</p></div></div></td><td><p>The name of the worksheet where the component is located.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Chart Name/Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Corresponding chart ID or name to retrieve.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Chart Body</p></td><td><div><div><p>Any</p></div></div></td><td><p>In the request body, supply the values for relevant fields that should be updated.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>The name of the configuration to use to execute this component.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Response timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>Response timeout for the request. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Response timeout unit for the request. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Custom headers</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers that the request will include. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Custom query parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters that the request will include. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p>Binary</p></div></div></td></tr></tbody></table>

### For Configurations

- [Authorization Code Config](#AuthorizationCodeConfig)

### Throws

- EXCEL:BAD\_REQUEST

- EXCEL:CONNECTIVITY

- EXCEL:FORBIDDEN

- EXCEL:INVALID\_CONNECTION

- EXCEL:INVALID\_CREDENTIALS

- EXCEL:NOT\_FOUND

- EXCEL:RETRY\_EXHAUSTED

- EXCEL:SERVER\_ERROR

- EXCEL:TIMEOUT

## Update Named Item

`<excel:update-named-item>`

Update the properties of the NamedItem object.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Workbook Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the workbook where rows are added.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Name</p></td><td><div><div><p>String</p></div></div></td><td><p>The name of the named item.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Body</p></td><td><div><div><p>Any</p></div></div></td><td><p>Supplies the values for relevant fields that should be updated.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>The name of the configuration to use to execute this component.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Response timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>Response timeout for the request. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Response timeout unit for the request. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Custom headers</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers that the request will include. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Custom query parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters that the request will include. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p>Binary</p></div></div></td></tr></tbody></table>

### For Configurations

- [Authorization Code Config](#AuthorizationCodeConfig)

### Throws

- EXCEL:BAD\_REQUEST

- EXCEL:CONNECTIVITY

- EXCEL:FORBIDDEN

- EXCEL:INVALID\_CONNECTION

- EXCEL:INVALID\_CREDENTIALS

- EXCEL:NOT\_FOUND

- EXCEL:RETRY\_EXHAUSTED

- EXCEL:SERVER\_ERROR

- EXCEL:TIMEOUT

## Update Range

`<excel:update-range>`

Update the properties of a range object.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Workbook Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the workbook.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Name</p></td><td><div><div><p>String</p></div></div></td><td><p>The name.</p></td><td></td><td></td></tr><tr><td><p>Worksheet Name</p></td><td><div><div><p>String</p></div></div></td><td><p>The name of the worksheet.</p></td><td></td><td></td></tr><tr><td><p>Address</p></td><td><div><div><p>String</p></div></div></td><td><p>The address.</p></td><td></td><td></td></tr><tr><td><p>Table Name/Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the table.</p></td><td></td><td></td></tr><tr><td><p>Column Name/Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID or name of the column.</p></td><td></td><td></td></tr><tr><td><p>Range Body</p></td><td><div><div><p>Any</p></div></div></td><td><p>Supply the values for relevant fields that should be updated.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>The name of the configuration to use to execute this component.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Response timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>Response timeout for the request. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Response timeout unit for the request. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Custom headers</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers that the request will include. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Custom query parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters that the request will include. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p>Binary</p></div></div></td></tr></tbody></table>

### For Configurations

- [Authorization Code Config](#AuthorizationCodeConfig)

### Throws

- EXCEL:BAD\_REQUEST

- EXCEL:CONNECTIVITY

- EXCEL:FORBIDDEN

- EXCEL:INVALID\_CONNECTION

- EXCEL:INVALID\_CREDENTIALS

- EXCEL:NOT\_FOUND

- EXCEL:RETRY\_EXHAUSTED

- EXCEL:SERVER\_ERROR

- EXCEL:TIMEOUT

## Update Range Format

`<excel:update-range-format>`

Update the properties of a RangeFormat object.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Workbook Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the workbook.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Name</p></td><td><div><div><p>String</p></div></div></td><td><p>The name.</p></td><td></td><td></td></tr><tr><td><p>Worksheet Name</p></td><td><div><div><p>String</p></div></div></td><td><p>The name of the worksheet.</p></td><td></td><td></td></tr><tr><td><p>Address</p></td><td><div><div><p>String</p></div></div></td><td><p>The address.</p></td><td></td><td></td></tr><tr><td><p>Table Name/Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the table.</p></td><td></td><td></td></tr><tr><td><p>Column Name/Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID or name of the column.</p></td><td></td><td></td></tr><tr><td><p>Range Format Body</p></td><td><div><div><p>Any</p></div></div></td><td><p>Supplies the values for relevant fields that should be updated.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>The name of the configuration to use to execute this component.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Response timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>Response timeout for the request. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Response timeout unit for the request. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Custom headers</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers that the request will include. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Custom query parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters that the request will include. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p>Binary</p></div></div></td></tr></tbody></table>

### For Configurations

- [Authorization Code Config](#AuthorizationCodeConfig)

### Throws

- EXCEL:BAD\_REQUEST

- EXCEL:CONNECTIVITY

- EXCEL:FORBIDDEN

- EXCEL:INVALID\_CONNECTION

- EXCEL:INVALID\_CREDENTIALS

- EXCEL:NOT\_FOUND

- EXCEL:RETRY\_EXHAUSTED

- EXCEL:SERVER\_ERROR

- EXCEL:TIMEOUT

## Update Row

`<excel:update-row>`

Update the row.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Workbook Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the workbook where rows are added.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Worksheet Name</p></td><td><div><div><p>String</p></div></div></td><td><p>The name of the worksheet where the table is located.</p></td><td></td><td></td></tr><tr><td><p>Table Name/Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the table.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Row Index</p></td><td><div><div><p>Number</p></div></div></td><td><p>The index of the row to update.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Columns</p></td><td><div><div><p>Binary</p></div></div></td><td><p>The columns to add.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>The name of the configuration to use to execute this component.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Response timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>Response timeout for the request. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Response timeout unit for the request. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Custom headers</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers that the request will include. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Custom query parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters that the request will include. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p>Binary</p></div></div></td></tr></tbody></table>

### For Configurations

- [Authorization Code Config](#AuthorizationCodeConfig)

### Throws

- EXCEL:CONNECTIVITY

- EXCEL:RETRY\_EXHAUSTED

## Update Table

`<excel:update-table>`

Update the properties of a table object.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Workbook Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the workbook.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Worksheet Name</p></td><td><div><div><p>String</p></div></div></td><td><p>The name of the worksheet.</p></td><td></td><td></td></tr><tr><td><p>Table Name/Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the table. to be updated.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Table Content</p></td><td><div><div><p>Any</p></div></div></td><td><p>The new content of the table.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>The name of the configuration to use to execute this component.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Response timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>Response timeout for the request. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Response timeout unit for the request. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Custom headers</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers that the request will include. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Custom query parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters that the request will include. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p>Binary</p></div></div></td></tr></tbody></table>

### For Configurations

- [Authorization Code Config](#AuthorizationCodeConfig)

### Throws

- EXCEL:CONNECTIVITY

- EXCEL:RETRY\_EXHAUSTED

## Update Worksheet

`<excel:update-worksheet>`

Update the properties of a worksheet object.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Workbook Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The workbook ID where the worksheet is located.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Worksheet Name</p></td><td><div><div><p>String</p></div></div></td><td><p>The worksheet name to retrieve.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Worksheet Content</p></td><td><div><div><p>Any</p></div></div></td><td></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>The name of the configuration to use to execute this component.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Response timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>Response timeout for the request. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Response timeout unit for the request. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Custom headers</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers that the request will include. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Custom query parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters that the request will include. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable that stores the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p>Binary</p></div></div></td></tr></tbody></table>

### For Configurations

- [Authorization Code Config](#AuthorizationCodeConfig)

### Throws

- EXCEL:CONNECTIVITY

- EXCEL:RETRY\_EXHAUSTED

## Sources

## On New Row Listener

`<excel:new-row-listener>`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Workbook Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the workbook.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Worksheet Name</p></td><td><div><div><p>String</p></div></div></td><td><p>The name of the worksheet.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>The name of the configuration to use to execute this component.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Primary Node Only</p></td><td><div><div><p>Boolean</p></div></div></td><td><p>Whether this source should only be executed on the primary node when running in a cluster.</p></td><td></td><td></td></tr><tr><td><p>Scheduling Strategy</p></td><td><div><div><p>scheduling-strategy</p></div></div></td><td><p>Configures the scheduler that triggers the polling.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Redelivery Policy</p></td><td><div><div><p><a href="#RedeliveryPolicy">Redelivery Policy</a></p></div></div></td><td><p>Defines a policy for processing the redelivery of the same message</p></td><td></td><td></td></tr><tr><td><p>Response timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>Response timeout for the request. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Response timeout unit for the request. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Custom headers</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers that the request will include. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Custom query parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters that the request will include. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr></tbody></table>

### For Configurations

- [Authorization Code Config](#AuthorizationCodeConfig)

## On New Worksheet Listener

`<excel:new-worksheet-listener>`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Workbook Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the workbook.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>The name of the configuration to use to execute this component.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Primary Node Only</p></td><td><div><div><p>Boolean</p></div></div></td><td><p>Whether this source should only be executed on the primary node when running in a cluster.</p></td><td></td><td></td></tr><tr><td><p>Scheduling Strategy</p></td><td><div><div><p>scheduling-strategy</p></div></div></td><td><p>Configures the scheduler that triggers the polling.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Redelivery Policy</p></td><td><div><div><p><a href="#RedeliveryPolicy">Redelivery Policy</a></p></div></div></td><td><p>Defines a policy for processing the redelivery of the same message.</p></td><td></td><td></td></tr><tr><td><p>Response timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>Response timeout for the request. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Response timeout unit for the request. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Custom headers</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers that the request will include. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Custom query parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters that the request will include. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr></tbody></table>

### For Configurations

- [Authorization Code Config](#AuthorizationCodeConfig)

## On Updated Row Listener

`<excel:updated-row-listener>`

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Workbook Id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the workbook.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Worksheet Name</p></td><td><div><div><p>String</p></div></div></td><td><p>The name of the worksheet.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Include New Rows</p></td><td><div><div><p>Boolean</p></div></div></td><td></td><td><p>false</p></td><td></td></tr><tr><td><p>Columns To Monitor</p></td><td><div><div><p>Array of String</p></div></div></td><td><p>List of columns which will be monitored for updated data. For example, some possible values are A, B, C, AA, or BB.</p></td><td></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>The name of the configuration to use to execute this component.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Primary Node Only</p></td><td><div><div><p>Boolean</p></div></div></td><td><p>Whether this source should only be executed on the primary node when running in a cluster.</p></td><td></td><td></td></tr><tr><td><p>Scheduling Strategy</p></td><td><div><div><p>scheduling-strategy</p></div></div></td><td><p>Configures the scheduler that triggers the polling.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configures how Mule processes streams. Repeatable streams are the default behavior.</p></td><td></td><td></td></tr><tr><td><p>Redelivery Policy</p></td><td><div><div><p><a href="#RedeliveryPolicy">Redelivery Policy</a></p></div></div></td><td><p>Defines a policy for processing the redelivery of the same message.</p></td><td></td><td></td></tr><tr><td><p>Response timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>Response timeout for the request. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>Response timeout unit for the request. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Custom headers</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom headers that the request will include. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Custom query parameters</p></td><td><div><div><p>Object</p></div></div></td><td><p>Custom query parameters that the request will include. The ones specified here will overwrite the default ones specified in the config.</p></td><td></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr></tbody></table>

### For Configurations

- [Authorization Code Config](#AuthorizationCodeConfig)

## Types

### Proxy Configuration

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Host</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Host where the proxy requests are sent.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Port</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>Port where the proxy requests are sent.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Username</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The username to authenticate against the proxy.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Password</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The password to authenticate against the proxy.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### TLS

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Enabled Protocols</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>A comma-separated list of protocols enabled for this context.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Enabled Cipher Suites</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>A comma-separated list of cipher suites enabled for this context.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Trust Store</strong></p></td><td><div><div><p><a href="#TrustStore">Trust Store</a></p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Key Store</strong></p></td><td><div><div><p><a href="#KeyStore">Keystore</a></p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Revocation Check</strong></p></td><td><div><div><ul><li><p><a href="#StandardRevocationCheck">Standard Revocation Check</a></p></li><li><p><a href="#CustomOcspResponder">Custom OCSP Responder</a></p></li><li><p><a href="#CrlFile">CRL File</a></p></li></ul></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Trust Store

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Path</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The location (which will be resolved relative to the current classpath and file system, if possible) of the truststore.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Password</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The password used to protect the truststore.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Type</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The type of truststore used.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Algorithm</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The algorithm used by the truststore.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Insecure</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>If <code>true</code>, Mule stops performing certificate validations. This can make connections vulnerable to attacks.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Keystore

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Path</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The location (which will be resolved relative to the current classpath and file system, if possible) of the keystore.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Type</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Type of keystore used.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Alias</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>When the keystore contains many private keys, this attribute indicates the alias of the key to use. If not defined, the first key in the file is used by default.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Key Password</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Password used to protect the private key.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Password</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Password used to protect the keystore.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Algorithm</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Algorithm used by the keystore.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Standard Revocation Check

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Only End Entities</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Only verify the last element of the certificate chain.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Prefer Crls</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Try CRL instead of OCSP first.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>No Fallback</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Do not use the secondary checking method (the one not selected before).</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Soft Fail</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Avoid verification failure when the revocation server can not be reached or is busy.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Custom OCSP Responder

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Url</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The URL of the OCSP responder.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Cert Alias</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Alias of the signing certificate for the OCSP response (must be in the truststore), if present.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### CRL File

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Path</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The path to the CRL file.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Reconnection

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Fails Deployment</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>When the application is deployed, a connectivity test is performed on all connectors. If set to <code>true</code>, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Reconnection Strategy</strong></p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><div><div><p>The reconnection strategy to use.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Reconnect

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Frequency</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>How often in milliseconds to reconnect.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Blocking</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>If <code>false</code>, the reconnection strategy will run in a separate, non-blocking thread.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Count</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>How many reconnection attempts to make.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Reconnect Forever

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Frequency</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>How often in milliseconds to reconnect.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Blocking</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>If <code>false</code>, the reconnection strategy will run in a separate, non-blocking thread.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Expiration Policy

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Max Idle Time</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>A scalar time value for the maximum amount of time a dynamic configuration instance should be allowed to be idle before it’s considered eligible for expiration.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Time Unit</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><div><div><p>Time unit that qualifies the <strong>Max Idle Time</strong> attribute.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Repeatable In Memory Stream

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Initial Buffer Size</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>Initial amount of memory to allocate to the memory stream. If the stream data exceeds this value, the buffer expands by <strong>Buffer Size Increment</strong>, with an upper limit <strong>Max In Memory Size value</strong>.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Buffer Size Increment</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>Amount by which the buffer size expands if it exceeds its initial size. Setting a value of <code>0</code> or lower specifies that the buffer can’t expand. Mule raises a <code>STREAM_MAXIMUM_SIZE_EXCEEDED</code> error when the buffer gets full.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Max Buffer Size</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>Maximum size of the buffer. A value less than or equal to <code>0</code> means no limit.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Buffer Unit</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>BYTE</p></li><li><p>KB</p></li><li><p>MB</p></li><li><p>GB</p></li></ul></div></div></td><td><div><div><p>The unit in which all these attributes are expressed</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Repeatable File Store Stream

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>In Memory Size</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>Defines the maximum memory that the stream should use to keep data in memory. If more than that is consumed content on the disk is buffered.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Buffer Unit</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>BYTE</p></li><li><p>KB</p></li><li><p>MB</p></li><li><p>GB</p></li></ul></div></div></td><td><div><div><p>The unit in which maxInMemorySize is expressed</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Redelivery Policy

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Max Redelivery Count</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>The maximum number of times a message can be redelivered and processed unsuccessfully before triggering process-failed-message</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Message Digest Algorithm</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The secure hashing algorithm to use. If not set, the default is SHA-256.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Message Identifier</strong></p></td><td><div><div><p><a href="#RedeliveryPolicyMessageIdentifier">Redelivery Policy Message Identifier</a></p></div></div></td><td><div><div><p>Defines which strategy is used to identify the messages.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Object Store</strong></p></td><td><div><div><p>ObjectStore</p></div></div></td><td><div><div><p>The object store where the redelivery counter for each message is stored.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Redelivery Policy Message Identifier

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Use Secure Hash</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Whether to use a secure hash algorithm to identify a redelivered message.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Id Expression</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Defines one or more expressions to use to determine when a message has been redelivered. This property may only be set if useSecureHash is false.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Repeatable In Memory Iterable

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Initial Buffer Size</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>The number of instances to initially keep in memory to consume the stream and provide random access to it. If the stream contains more data than can fit into this buffer, then the buffer expands according to the bufferSizeIncrement attribute, with an upper limit of maxInMemorySize. Default value is 100 instances.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Buffer Size Increment</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>This is by how much the buffer size expands if it exceeds its initial size. Setting a value of zero or lower means that the buffer should not expand, meaning that a STREAM_MAXIMUM_SIZE_EXCEEDED error is raised when the buffer gets full. Default value is 100 instances.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Max Buffer Size</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>The maximum amount of memory to use. If more than that is used then a STREAM_MAXIMUM_SIZE_EXCEEDED error is raised. A value lower than or equal to zero means no limit.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Repeatable File Store Iterable

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>In Memory Objects</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>The maximum amount of instances to keep in memory. If more than that is required, content on the disk is buffered.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Buffer Unit</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>BYTE</p></li><li><p>KB</p></li><li><p>MB</p></li><li><p>GB</p></li></ul></div></div></td><td><div><div><p>The unit in which maxInMemorySize is expressed</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

## See Also

- [Microsoft Excel Online Connector Overview](https://docs.mulesoft.com/microsoft-excel-online-connector/latest/)

- [Salesforce Help](https://help.salesforce.com)

<!-- document id=cf6800a91ad4b505833aae74f341dd9b7dc2423c0438eb0a52f171b07bf6faeb url=/mulesoft/current/en-us/microsoft-excel-online-connector/latest/microsoft-excel-online-connector-xml-maven.md -->

---
product: Microsoft Excel Online Connector
version: 1.1
is-latest-version: true
---

# Microsoft Excel Online Connector 1.1 XML and Maven Support

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

Although you can manually code a Mule app in XML, it is more efficient to use Anypoint Studio:

- If you manually code a Mule runtime engine (Mule) app in XML, either from the Anypoint Studio XML
  editor or from a text editor, you can access the connector from your app by adding reference
  statements to both your XML Mule flow and the Apache Maven `pom.xml` file.

- If you add the connector in Studio, Studio automatically populates the XML code with the
  connector’s namespace and schema location and it also adds a dependency to the `pom.xml` file.

## Add a Namespace for the Connector

Paste the following code inside the `<mule>` tag of the header of your configuration XML:

```xml
http://www.mulesoft.org/schema/mule/microsoft-excel-online
http://www.mulesoft.org/schema/mule/microsoft-excel-online/current/mule-excel-online.xsd
```

This example shows how the namespace statements are placed in the XML block:

```xml
<mule xmlns:ee="http://www.mulesoft.org/schema/mule/ee/core"
    xmlns:http="http://www.mulesoft.org/schema/mule/http"
	xmlns:excel="http://www.mulesoft.org/schema/mule/excel"
	xmlns="http://www.mulesoft.org/schema/mule/core"
	xmlns:doc="http://www.mulesoft.org/schema/mule/documentation"
	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
	xsi:schemaLocation="http://www.mulesoft.org/schema/mule/core
	http://www.mulesoft.org/schema/mule/core/current/mule.xsd
    http://www.mulesoft.org/schema/mule/excel
    http://www.mulesoft.org/schema/mule/excel/current/mule-excel.xsd
    http://www.mulesoft.org/schema/mule/http
    http://www.mulesoft.org/schema/mule/http/current/mule-http.xsd
    http://www.mulesoft.org/schema/mule/ee/core
    http://www.mulesoft.org/schema/mule/ee/core/current/mule-ee.xsd">
```

## Add a POM File Dependency

The Apache Maven `pom.xml` file generated by Anypoint Studio contains dependencies for a Mule app.
When you code a Mule app manually, include this XML snippet in your `pom.xml` file to enable access
to this connector:

```xml
<dependency>
  <groupId>com.mulesoft.connectors</groupId>
  <artifactId>mule4-microsoft-excel-online-connector</artifactId>
  <version>x.x.x</version>
  <classifier>mule-plugin</classifier>
</dependency>
```

Replace `x.x.x` with the version that corresponds to the connector you are using.

To obtain the most up-to-date `pom.xml` file information:

1.  Go to [Anypoint Exchange](https://www.mulesoft.com/exchange/).

2.  In Exchange, click **Login** and supply your Anypoint Platform username and password.

3.  In Exchange, search for `excel`.

4.  Select the connector.

5.  Click **Dependency Snippets** near the upper right of the screen.

## See Also

- [Introduction to Anypoint Connectors](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors)

- [Salesforce Help](https://help.salesforce.com)

<!-- document id=4eb959f52070449a74c5a23edd1b39d6cc7ef875be3bfa6b2f2c07f38550e0b0 url=/mulesoft/current/en-us/microsoft-excel-online-connector/latest/microsoft-excel-online-connector-studio.md -->

---
product: Microsoft Excel Online Connector
version: 1.1
is-latest-version: true
---

# Using Anypoint Studio to Configure Microsoft Excel Online Connector 1.1

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

Anypoint Studio (Studio) editors help you design and update your Mule applications, properties, and
configuration files.

To add and configure a connector in Studio:

1.  [Create a Mule project](#create-mule-project).

2.  [Add the connector to your Mule project](#add-connector-to-project).

3.  [Configure a source for the connector’s flow](#configure-input-source).

4.  [Add a connector operation to the flow](#add-connector-operation).

5.  [Configure a global element for the connector](#configure-global-element).

6.  [Configure the other connector fields](#configure-other-fields).

When you run the connector, you can view the app log to check for problems in real time, as
described in [View the App Log](#view-app-log).

If you are new to configuring connectors in Studio, see
[Using Anypoint Studio to Configure a Connector](https://docs.mulesoft.com/connectors/introduction/intro-config-use-studio).
If, after reading this topic, you need additional information about the connector fields, see the
[Microsoft Excel Online Connector Reference](https://docs.mulesoft.com/microsoft-excel-online-connector/latest/microsoft-excel-online-connector-reference).

## Create a Mule Project

In Studio, create a new Mule project in which to add and configure the connector:

1.  In Studio, select **File > New > Mule Project**.

2.  Enter a name for your Mule project and click **Finish**.

## Add the Connector to Your Mule Project

Add Anypoint Connector for Microsoft Excel Online (Excel Online Connector) to your Mule project to
automatically populate the XML code with the connector’s namespace and schema location and add the
required dependencies to the project’s `pom.xml` file:

1.  In the **Mule Palette** view, click **(X) Search in Exchange**.

2.  In the **Add Dependencies to Project** window, type `excel` in the search field.

3.  Click **Excel Connector** in **Available modules**.

4.  Click **Add**.

5.  Click **Finish**.

Adding a connector to a Mule project in Studio does not make that connector available to other
projects in your Studio workspace.

## Configure a Source

A source initiates a flow when a specified condition is met. You can configure one of these sources
to use with Excel Online Connector:

- HTTP Listener  
  Initiates a flow each time it receives a request on the configured host and port

- Scheduler  
  Initiates a flow when a time-based condition is met

For example, to configure an HTTP Listener source, follow these steps:

1.  In the **Mule Palette** view, select **HTTP > Listener**.

2.  Drag **Listener** to the Studio canvas.

3.  On the **Listener** configuration screen, optionally change the value of the **Display Name**
    field.

4.  Specify a value for the **Path** field.

5.  Click the plus sign (**+**) next to the **Connector configuration** field to configure a global
    element that can be used by all instances of the HTTP Listener source in the app.

6.  On the **General** tab, specify the connection information for the connector.

7.  On the **TLS** tab, optionally specify the TLS information for the connector.

8.  On the **Advanced** tab, optionally specify reconnection information, including a reconnection
    strategy.

9.  Click **Test Connection** to confirm that Mule can connect with the specified server.

10. Click **OK**.

## Add a Connector Operation to the Flow

When you add a connector operation to your flow, you are specifying an action for that connector to
perform.

To add an operation for Excel Online Connector, follow these steps:

1.  In the **Mule Palette** view, select **Excel** and then select the desired operation.

2.  Drag the operation onto the Studio canvas to the right of the source.

## Configure a Global Element for the Connector

When you configure a connector, configure a global element that all instances of that connector in
the app can use. Configuring a global element requires you to provide the authentication credentials
that the connector requires to access the target Excel Online system. Excel Online Connector
supports OAuth 2.0 authentication.

To configure the global element for Excel Online Connector, follow these steps:

1.  Select the operation in the Studio canvas.

2.  In the configuration screen for the operation, click the plus sign (**+**) next to the
    **Connector configuration** field to access the global element configuration fields.

3.  On the **General** tab, in **Connection**, select the
    [OAuth 2.0 Authorization Code](#oauth2-authorization) authentication method to configure.

    You can reference a configuration file that contains ANT-style property placeholders
    (recommended), or you can enter your authorization credentials in the global configuration
    properties. For information about the benefits of using property placeholders and how to
    configure them, see
    [Anypoint Connector Configuration](https://docs.mulesoft.com/connectors/introduction/intro-connector-configuration-overview).

4.  On the **Advanced** tab, optionally specify reconnection information, including a reconnection
    strategy.

5.  Click **Test Connection** to confirm that Mule can connect with the specified server.

6.  Click **OK**.

### OAuth 2.0 Authorization Code Authentication

Use OAuth 2.0 to delegate user authentication to the service hosting the user account. For more
information, refer to
[Configuring OAuth 2.0 for Connectors](https://docs.mulesoft.com/connectors/introduction/intro-config-oauth2),
[Configuring OAuth 2.0 for Connectors on CloudHub](https://docs.mulesoft.com/connectors/introduction/intro-config-oauth2-cloudhub),
or [OAuth Support in the SDK](https://docs.mulesoft.com/mule-sdk/latest/oauth).

Enter the following information on the **General** tab of the **Global Element Properties** screen
to configure OAuth 2.0 Authorization Code authentication:

<table><colgroup><col> <col></colgroup><thead><tr><th>Field</th><th>User Action</th></tr></thead><tbody><tr><td><p><strong>Name</strong></p></td><td><div><div><p>Enter the configuration name.</p></div></div></td></tr><tr><td><p><strong>Connection</strong></p></td><td><div><div><p>Select <strong>OAuth 2.0 Authorization Code</strong>.</p></div></div></td></tr><tr><td><p><strong>Consumer Key</strong></p></td><td><div><div><p>OAuth consumer key as registered with the Microsoft identity platform.</p></div></div></td></tr><tr><td><p><strong>Consumer Secret</strong></p></td><td><div><div><p>OAuth consumer secret that corresponds to the consumer key.</p></div></div></td></tr><tr><td><p><strong>Listener Config</strong></p></td><td><div><div><p>A reference to an <code>&lt;http:listener-config /&gt;</code> to use to create the listener that receives the access token callback endpoint.</p></div></div></td></tr><tr><td><p><strong>Callback Path</strong></p></td><td><div><div><p>Path of the access token callback endpoint.</p></div></div></td></tr><tr><td><p><strong>Authorize Path</strong></p></td><td><div><div><p>Path of the local HTTP endpoint that triggers the OAuth dance.</p></div></div></td></tr></tbody></table>

## Configure Additional Connector Fields

After you configure a global element for Excel Online Connector, configure the other required fields
for the connector. The required fields vary depending on which connector operation you use.

## View the App Log

To check for problems, you can view the app log as follows:

- If you’re running the app from Anypoint Platform, the app log output is visible in the Anypoint
  Studio console window.

- If you’re running the app using Mule from the command line, the app log output is visible in your
  OS console.

Unless the log file path is customized in the app’s log file (`log4j2.xml`), you can also view the
app log in the default location `MULE_HOME/logs/<app-name>.log`.

## See Also

- [Introduction to Anypoint Connectors](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors)

- [Using Anypoint Studio to Configure a Connector](https://docs.mulesoft.com/connectors/introduction/intro-config-use-studio)

- [Microsoft Excel Online Connector Reference](https://docs.mulesoft.com/microsoft-excel-online-connector/latest/microsoft-excel-online-connector-reference)

- [Salesforce Help](https://help.salesforce.com)