Microsoft Excel Online Connector 1.0 Reference

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://docs.microsoft.com/en-us/connectors/excelonline/

Configurations


Authorization Code Config

Parameters

Name Type Description Default Value Required

Name

String

Name for this configuration. Connectors reference the configuration with this name.

x

Connection

The connection types to provide to this configuration.

x

Response Timeout

Number

Response timeout for the request. The ones specified here will overwrite the default ones specified in the config.

30

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Response timeout unit for the request. The ones specified here will overwrite the default ones specified in the config.

SECONDS

Encoding

String

Canonical name of the encoding. See Oracle’s supported encodings at https://docs.oracle.com/javase/7/docs/technotes/guides/intl/encoding.doc.html.

Name

String

The identifier of this element used to reference it in other components

x

Expiration Policy

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.

Connection Types

OAuth v2.0 Authorization Code
Parameters
Name Type Description Default Value Required

Proxy configuration

Proxy configuration for the connector.

Response Type

String

Specifies the method to use to send the resulting token back to your app. It must be query.

query

TLS configuration

TLS

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.

Reconnection

When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy.

Consumer Key

String

OAuth consumerKey as registered with the service provider.

x

Consumer Secret

String

OAuth consumerSecret as registered with the service provider.

x

Authorization Url

String

The service provider’s authorization endpoint URL.

https://login.microsoftonline.com/{tenant}/oauth2/v2.0/authorize

Access Token Url

String

The service provider’s accessToken endpoint URL.

https://login.microsoftonline.com/{tenant}/oauth2/v2.0/token

Scopes

String

The OAuth scopes to request during the OAuth dance. If not provided, this value defaults to those in the annotation.

Resource Owner Id

String

The resourceOwnerId that each component should use if it is not otherwise referenced.

Before

String

Name of a flow to execute immediately before starting the OAuth dance.

After

String

Name of a flow to execute immediately after an accessToken is received.

Listener Config

String

A reference to an <http:listener-config /> to use to create the listener that receives the access token callback endpoint.

x

Callback Path

String

Path of the access token callback endpoint.

x

Authorize Path

String

Path of the local HTTP endpoint that triggers the OAuth dance.

x

External Callback Url

String

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.

Object Store

String

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.

Operations

Add Chart

<excel:add-chart>

Creates a new chart.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Workbook Id

String

The ID of the workbook.

x

Worksheet Name

String

The name of the worksheet.

x

Chart Body

Any

The body of the chart to add.

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Response timeout

Number

Response timeout for the request. The ones specified here will overwrite the default ones specified in the config.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Response timeout unit for the request. The ones specified here will overwrite the default ones specified in the config.

Custom headers

Object

Custom headers that the request will include. The ones specified here will overwrite the default ones specified in the config.

Custom query parameters

Object

Custom query parameters that the request will include. The ones specified here will overwrite the default ones specified in the config.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

Binary

For Configurations

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 Item2

<excel:add-named-item2>

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

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Workbook Id

String

The ID of the workbook where rows are added.

x

Name

String

The name of the named item.

x

Reference

String

The formula or the range that the name will refer to.

x

Workbook Id

String

The comment associated with the named item.

x

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Response timeout

Number

Response timeout for the request. The ones specified here will overwrite the default ones specified in the config.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Response timeout unit for the request. The ones specified here will overwrite the default ones specified in the config.

Custom headers

Object

Custom headers that the request will include. The ones specified here will overwrite the default ones specified in the config.

Custom query parameters

Object

Custom query parameters that the request will include. The ones specified here will overwrite the default ones specified in the config.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

Binary

For Configurations

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

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Workbook Id

String

The ID of the workbook.

x

Worksheet Name

String

The Id of the worksheet.

Name

String

The name of the named item.

x

Reference

String

The formula or the range that the name will refer to.

x

Workbook Id

String

The comment associated with the named item.

x

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Response timeout

Number

Response timeout for the request. The ones specified here will overwrite the default ones specified in the config.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Response timeout unit for the request. The ones specified here will overwrite the default ones specified in the config.

Custom headers

Object

Custom headers that the request will include. The ones specified here will overwrite the default ones specified in the config.

Custom query parameters

Object

Custom query parameters that the request will include. The ones specified here will overwrite the default ones specified in the config.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

Binary

For Configurations

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

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Workbook Id

String

The ID of the workbook where rows are added.

x

Worksheet Name

String

The name of the worksheet where the table is located.

Table Name/Id

String

The ID of the table.

x

Rows

Any

The rows to be added.

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Response timeout

Number

Response timeout for the request. The ones specified here will overwrite the default ones specified in the config.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Response timeout unit for the request. The ones specified here will overwrite the default ones specified in the config.

Custom headers

Object

Custom headers that the request will include. The ones specified here will overwrite the default ones specified in the config.

Custom query parameters

Object

Custom query parameters that the request will include. The ones specified here will overwrite the default ones specified in the config.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

Binary

For Configurations

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

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Workbook Id

String

The ID of the workbook where rows are added.

x

Worksheet Name

String

The name of the worksheet where the table is located.

Table Address

String

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.

x

Has Headers

Boolean

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 false, Excel will automatically generate the header by shifting the data down by one row.

false

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Response timeout

Number

Response timeout for the request. The ones specified here will overwrite the default ones specified in the config.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Response timeout unit for the request. The ones specified here will overwrite the default ones specified in the config.

Custom headers

Object

Custom headers that the request will include. The ones specified here will overwrite the default ones specified in the config.

Custom query parameters

Object

Custom query parameters that the request will include. The ones specified here will overwrite the default ones specified in the config.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

Binary

For Configurations

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

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Workbook Id

String

The workbook ID where the worksheet is located.

x

Worksheet Name

String

The worksheet name.

x

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Response timeout

Number

Response timeout for the request. The ones specified here will overwrite the default ones specified in the config.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Response timeout unit for the request. The ones specified here will overwrite the default ones specified in the config.

Custom headers

Object

Custom headers that the request will include. The ones specified here will overwrite the default ones specified in the config.

Custom query parameters

Object

Custom query parameters that the request will include. The ones specified here will overwrite the default ones specified in the config.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

Binary

For Configurations

Throws

  • EXCEL:CONNECTIVITY

  • EXCEL:RETRY_EXHAUSTED

Calculate Workbook Application

<excel:calculate-workbook-application>

Recalculate all currently opened workbooks in Microsoft Excel.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Workbook Id

String

The ID of the workbook.

x

Calculation Type

Enumeration, one of:

  • FULL

  • RECALCULATE

  • FULLREBUILD

The calculation type to use.

x

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Response timeout

Number

Response timeout for the request. The ones specified here will overwrite the default ones specified in the config.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Response timeout unit for the request. The ones specified here will overwrite the default ones specified in the config.

Custom headers

Object

Custom headers that the request will include. The ones specified here will overwrite the default ones specified in the config.

Custom query parameters

Object

Custom query parameters that the request will include. The ones specified here will overwrite the default ones specified in the config.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

Binary

For Configurations

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

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Workbook Id

String

The ID of the workbook. where the component is located.

x

Worksheet Name

String

The name of the worksheet.

x

Chart Name/Id

String

The ID or the name of the chart.

x

Position Body

Any

The position body.

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Select

String

Properties to retrieve in the response.

Expand

String

The response will include information regarding the specified relationship.

Filter

String

Retrieves a subset of a collection.

Order By

String

Specifies the sort order of the items returned.

Search

String

Restricts the results of a request to match a search criteria.

Response timeout

Number

Response timeout for the request. The ones specified here will overwrite the default ones specified in the config.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Response timeout unit for the request. The ones specified here will overwrite the default ones specified in the config.

Custom headers

Object

Custom headers that the request will include. The ones specified here will overwrite the default ones specified in the config.

Custom query parameters

Object

Custom query parameters that the request will include. The ones specified here will overwrite the default ones specified in the config.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

Binary

For Configurations

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

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Workbook Id

String

The ID of the workbook. where the component is located.

x

Worksheet Name

String

The name of the worksheet where the component is located.

x

Chart Name

String

The name of the chart.

x

Chart Series Body

Any

The series body of the chart.

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Response timeout

Number

Response timeout for the request. The ones specified here will overwrite the default ones specified in the config.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Response timeout unit for the request. The ones specified here will overwrite the default ones specified in the config.

Custom headers

Object

Custom headers that the request will include. The ones specified here will overwrite the default ones specified in the config.

Custom query parameters

Object

Custom query parameters that the request will include. The ones specified here will overwrite the default ones specified in the config.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

Binary

For Configurations

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

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Workbook Id

String

The ID of the workbook. where columns are located.

x

Worksheet Name

String

The name of the worksheet where the columns are located.

Table Name/Id

String

The ID of the table.

x

Column Content

Any

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Response timeout

Number

Response timeout for the request. The ones specified here will overwrite the default ones specified in the config.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Response timeout unit for the request. The ones specified here will overwrite the default ones specified in the config.

Custom headers

Object

Custom headers that the request will include. The ones specified here will overwrite the default ones specified in the config.

Custom query parameters

Object

Custom query parameters that the request will include. The ones specified here will overwrite the default ones specified in the config.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

Binary

For Configurations

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

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Workbook Id

String

The ID of the workbook. where the component is located.

x

Worksheet Name

String

The name of the worksheet.

x

Chart Name/Id

String

The ID or the name of chart.

x

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Response timeout

Number

Response timeout for the request. The ones specified here will overwrite the default ones specified in the config.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Response timeout unit for the request. The ones specified here will overwrite the default ones specified in the config.

Custom headers

Object

Custom headers that the request will include. The ones specified here will overwrite the default ones specified in the config.

Custom query parameters

Object

Custom query parameters that the request will include. The ones specified here will overwrite the default ones specified in the config.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

Binary

For Configurations

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

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Workbook Id

String

The ID of the workbook. from where the row will be deleted.

x

Worksheet Name

String

The name of the worksheet where the rows are located.

Table Name/Id

String

The ID of the table.

x

Row Index

Number

The index of the row to be deleted.

x

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Response timeout

Number

Response timeout for the request. The ones specified here will overwrite the default ones specified in the config.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Response timeout unit for the request. The ones specified here will overwrite the default ones specified in the config.

Custom headers

Object

Custom headers that the request will include. The ones specified here will overwrite the default ones specified in the config.

Custom query parameters

Object

Custom query parameters that the request will include. The ones specified here will overwrite the default ones specified in the config.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

Binary

For Configurations

Throws

  • EXCEL:CONNECTIVITY

  • EXCEL:RETRY_EXHAUSTED

Delete Table

<excel:delete-table>

Deletes a row from the table.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Workbook Id

String

The ID of the workbook. where table is located.

x

Worksheet Name

String

The name of the worksheet where the table is located.

Table Name/Id

String

The ID of the table.

x

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Response timeout

Number

Response timeout for the request. The ones specified here will overwrite the default ones specified in the config.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Response timeout unit for the request. The ones specified here will overwrite the default ones specified in the config.

Custom headers

Object

Custom headers that the request will include. The ones specified here will overwrite the default ones specified in the config.

Custom query parameters

Object

Custom query parameters that the request will include. The ones specified here will overwrite the default ones specified in the config.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

Binary

For Configurations

Throws

  • EXCEL:CONNECTIVITY

  • EXCEL:RETRY_EXHAUSTED

Delete Worksheet

<excel:delete-worksheet>

Deletes a worksheet from the workbook.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Workbook Id

String

The workbook ID where the worksheet is located.

x

Worksheet Name

String

The worksheet name to delete.

x

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Response timeout

Number

Response timeout for the request. The ones specified here will overwrite the default ones specified in the config.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Response timeout unit for the request. The ones specified here will overwrite the default ones specified in the config.

Custom headers

Object

Custom headers that the request will include. The ones specified here will overwrite the default ones specified in the config.

Custom query parameters

Object

Custom query parameters that the request will include. The ones specified here will overwrite the default ones specified in the config.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

Binary

For Configurations

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

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Workbook Id

String

The workbook ID where the worksheet is located.

x

Worksheet Name

String

The worksheet name to retrieve.

x

Row

Number

The row value of the cell.

x

Column

Number

The column value of the cell.

x

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Response timeout

Number

Response timeout for the request. The ones specified here will overwrite the default ones specified in the config.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Response timeout unit for the request. The ones specified here will overwrite the default ones specified in the config.

Custom headers

Object

Custom headers that the request will include. The ones specified here will overwrite the default ones specified in the config.

Custom query parameters

Object

Custom query parameters that the request will include. The ones specified here will overwrite the default ones specified in the config.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

Binary

For Configurations

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

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Workbook Id

String

The ID of the workbook. where the component is located.

x

Worksheet Name

String

The name of the worksheet.

x

Chart Name/Id

String

Corresponding chart ID or name to retrieve.

x

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Select

String

Properties to retrieve in the response.

Expand

String

The response will include information regarding the specified relationship.

Filter

String

Retrieves a subset of a collection.

Order By

String

Specifies the sort order of the items returned.

Search

String

Restricts the results of a request to match a search criteria.

Response timeout

Number

Response timeout for the request. The ones specified here will overwrite the default ones specified in the config.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Response timeout unit for the request. The ones specified here will overwrite the default ones specified in the config.

Custom headers

Object

Custom headers that the request will include. The ones specified here will overwrite the default ones specified in the config.

Custom query parameters

Object

Custom query parameters that the request will include. The ones specified here will overwrite the default ones specified in the config.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

Binary

For Configurations

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

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Workbook Id

String

The ID of the workbook. where the component is located.

x

Worksheet Name

String

The name of the worksheet.

x

Chart Name/Id

String

The ID or the name of chart.

x

Width

String

The width of the image.

x

Height

String

The height of the image.

x

Fitting Mode

String

The fitting mode of the image.

x

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Response timeout

Number

Response timeout for the request. The ones specified here will overwrite the default ones specified in the config.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Response timeout unit for the request. The ones specified here will overwrite the default ones specified in the config.

Custom headers

Object

Custom headers that the request will include. The ones specified here will overwrite the default ones specified in the config.

Custom query parameters

Object

Custom query parameters that the request will include. The ones specified here will overwrite the default ones specified in the config.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

Binary

For Configurations

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>

Retrieves the properties and relationships of the chart object.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Workbook Id

String

The workbookId where chart is located.

x

Worksheet Name

String

The name of the worksheet.

x

Chart Name/Id

String

Corresponding chart name to retrieve.

x

Request Body

Any

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Select

String

Properties to retrieve in the response.

Expand

String

The response will include information regarding the specified relationship.

Filter

String

Retrieves a subset of a collection.

Order By

String

Specifies the sort order of the items returned.

Search

String

Restricts the results of a request to match a search criteria.

Response timeout

Number

Response timeout for the request. The ones specified here will overwrite the default ones specified in the config.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Response timeout unit for the request. The ones specified here will overwrite the default ones specified in the config.

Custom headers

Object

Custom headers that the request will include. The ones specified here will overwrite the default ones specified in the config.

Custom query parameters

Object

Custom query parameters that the request will include. The ones specified here will overwrite the default ones specified in the config.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

Binary

For Configurations

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

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Workbook Id

String

The ID of the workbook.

x

Worksheet Name

String

The name of the worksheet where the component is located.

Count

Number

The number of columns to include in the resulting range.

1

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Response timeout

Number

Response timeout for the request. The ones specified here will overwrite the default ones specified in the config.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Response timeout unit for the request. The ones specified here will overwrite the default ones specified in the config.

Custom headers

Object

Custom headers that the request will include. The ones specified here will overwrite the default ones specified in the config.

Custom query parameters

Object

Custom query parameters that the request will include. The ones specified here will overwrite the default ones specified in the config.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

Binary

For Configurations

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

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Workbook Id

String

The ID of the workbook.

x

Worksheet Name

String

The name of the worksheet where the component is located.

Count

Number

The number of columns to include in the resulting range.

1

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Response timeout

Number

Response timeout for the request. The ones specified here will overwrite the default ones specified in the config.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Response timeout unit for the request. The ones specified here will overwrite the default ones specified in the config.

Custom headers

Object

Custom headers that the request will include. The ones specified here will overwrite the default ones specified in the config.

Custom query parameters

Object

Custom query parameters that the request will include. The ones specified here will overwrite the default ones specified in the config.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

Binary

For Configurations

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

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Workbook Id

String

The ID of the workbook where rows are added.

x

Name

String

The name of the named item.

x

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Response timeout

Number

Response timeout for the request. The ones specified here will overwrite the default ones specified in the config.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Response timeout unit for the request. The ones specified here will overwrite the default ones specified in the config.

Custom headers

Object

Custom headers that the request will include. The ones specified here will overwrite the default ones specified in the config.

Custom query parameters

Object

Custom query parameters that the request will include. The ones specified here will overwrite the default ones specified in the config.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

Binary

For Configurations

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

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Workbook Id

String

The ID of the workbook.

x

Name

String

The name.

Worksheet Name

String

The name of the worksheet.

Address

String

The address.

Table Name/Id

String

The ID of the table.

Column Name/Id

String

The ID of the column.

Row Offset

Number

The number of rows by which the range is offset. Positive values are offset downward and negative values are offset upward.

x

Column Offset

Number

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.

x

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Response timeout

Number

Response timeout for the request. The ones specified here will overwrite the default ones specified in the config.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Response timeout unit for the request. The ones specified here will overwrite the default ones specified in the config.

Custom headers

Object

Custom headers that the request will include. The ones specified here will overwrite the default ones specified in the config.

Custom query parameters

Object

Custom query parameters that the request will include. The ones specified here will overwrite the default ones specified in the config.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

Binary

For Configurations

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

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Workbook Id

String

The ID of the workbook.

x

Worksheet Name

String

The name of the worksheet.

Table Name/Id

String

The ID of the table.

Address

String

The address.

Column Name/Id

String

The ID of the column.

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Select

String

Properties to retrieve in the response.

Expand

String

The response will include information regarding the specified relationship.

Filter

String

Retrieves a subset of a collection.

Order By

String

Specifies the sort order of the items returned.

Search

String

Restricts the results of a request to match a search criteria.

Response timeout

Number

Response timeout for the request. The ones specified here will overwrite the default ones specified in the config.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Response timeout unit for the request. The ones specified here will overwrite the default ones specified in the config.

Custom headers

Object

Custom headers that the request will include. The ones specified here will overwrite the default ones specified in the config.

Custom query parameters

Object

Custom query parameters that the request will include. The ones specified here will overwrite the default ones specified in the config.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

Binary

For Configurations

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

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Workbook Id

String

The ID of the workbook.

x

Name

String

The name.

Worksheet Name

String

The name of the worksheet.

Address

String

The address.

Table Name/Id

String

The ID of the table.

Column Name/Id

String

The ID or name of the column.

Row number

Number

Row number of the cell to be retrieved. Zero-indexed.

x

Column Number

Number

Column number of the cell to be retrieved. Zero-indexed.

x

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Response timeout

Number

Response timeout for the request. The ones specified here will overwrite the default ones specified in the config.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Response timeout unit for the request. The ones specified here will overwrite the default ones specified in the config.

Custom headers

Object

Custom headers that the request will include. The ones specified here will overwrite the default ones specified in the config.

Custom query parameters

Object

Custom query parameters that the request will include. The ones specified here will overwrite the default ones specified in the config.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

Binary

For Configurations

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

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Workbook Id

String

The ID of the workbook.

x

Name

String

The name.

Worksheet Name

String

The name of the worksheet.

Address

String

The address.

Table Name/Id

String

The ID of the table.

Column Name/Id

String

The ID or name of the column.

Column Number

Number

Column number of the cell to be retrieved. Zero-indexed.

x

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Response timeout

Number

Response timeout for the request. The ones specified here will overwrite the default ones specified in the config.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Response timeout unit for the request. The ones specified here will overwrite the default ones specified in the config.

Custom headers

Object

Custom headers that the request will include. The ones specified here will overwrite the default ones specified in the config.

Custom query parameters

Object

Custom query parameters that the request will include. The ones specified here will overwrite the default ones specified in the config.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

Binary

For Configurations

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

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Workbook Id

String

The ID of the workbook.

x

Name

String

The name.

Worksheet Name

String

The name of the worksheet.

Address

String

The address.

Table Name/Id

String

The ID of the table.

Column Name/Id

String

The ID or name of the column.

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Response timeout

Number

Response timeout for the request. The ones specified here will overwrite the default ones specified in the config.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Response timeout unit for the request. The ones specified here will overwrite the default ones specified in the config.

Custom headers

Object

Custom headers that the request will include. The ones specified here will overwrite the default ones specified in the config.

Custom query parameters

Object

Custom query parameters that the request will include. The ones specified here will overwrite the default ones specified in the config.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

Binary

For Configurations

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

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Workbook Id

String

The ID of the workbook.

x

Name

String

The name.

Worksheet Name

String

The name of the worksheet.

Address

String

The address.

Table Name/Id

String

The ID of the table.

Column Name/Id

String

The ID or name of the column.

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Response timeout

Number

Response timeout for the request. The ones specified here will overwrite the default ones specified in the config.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Response timeout unit for the request. The ones specified here will overwrite the default ones specified in the config.

Custom headers

Object

Custom headers that the request will include. The ones specified here will overwrite the default ones specified in the config.

Custom query parameters

Object

Custom query parameters that the request will include. The ones specified here will overwrite the default ones specified in the config.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

Binary

For Configurations

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

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Workbook Id

String

The ID of the workbook.

x

Name

String

The name.

Worksheet Name

String

The name of the worksheet.

Address

String

The address.

Table Name/Id

String

The ID of the table.

Column Name/Id

String

The ID or name of the column.

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Response timeout

Number

Response timeout for the request. The ones specified here will overwrite the default ones specified in the config.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Response timeout unit for the request. The ones specified here will overwrite the default ones specified in the config.

Custom headers

Object

Custom headers that the request will include. The ones specified here will overwrite the default ones specified in the config.

Custom query parameters

Object

Custom query parameters that the request will include. The ones specified here will overwrite the default ones specified in the config.

Select

String

Properties to retrieve in the response.

Expand

String

The response will include information regarding the specified relationship.

Filter

String

Retrieves a subset of a collection.

Order By

String

Specifies the sort order of the items returned.

Search

String

Restricts the results of a request to match a search criteria.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

Binary

For Configurations

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

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Workbook Id

String

The ID of the workbook.

x

Name

String

The name.

Worksheet Name

String

The name of the worksheet.

Address

String

The address.

Table Name/Id

String

The ID of the table.

Column Name/Id

String

The ID or name of the column.

Another Range

String

The range object or address or range name.

x

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Response timeout

Number

Response timeout for the request. The ones specified here will overwrite the default ones specified in the config.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Response timeout unit for the request. The ones specified here will overwrite the default ones specified in the config.

Custom headers

Object

Custom headers that the request will include. The ones specified here will overwrite the default ones specified in the config.

Custom query parameters

Object

Custom query parameters that the request will include. The ones specified here will overwrite the default ones specified in the config.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

Binary

For Configurations

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

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Workbook Id

String

The ID of the workbook.

x

Name

String

The name.

Worksheet Name

String

The name of the worksheet.

Address

String

The address.

Table Name/Id

String

The ID of the table.

Column Name/Id

String

The ID or name of the column.

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Response timeout

Number

Response timeout for the request. The ones specified here will overwrite the default ones specified in the config.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Response timeout unit for the request. The ones specified here will overwrite the default ones specified in the config.

Custom headers

Object

Custom headers that the request will include. The ones specified here will overwrite the default ones specified in the config.

Custom query parameters

Object

Custom query parameters that the request will include. The ones specified here will overwrite the default ones specified in the config.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

Binary

For Configurations

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

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Workbook Id

String

The ID of the workbook.

x

Name

String

The name.

Worksheet Name

String

The name of the worksheet.

Address

String

The address.

Table Name/Id

String

The ID of the table.

Column Name/Id

String

The ID or name of the column.

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Response timeout

Number

Response timeout for the request. The ones specified here will overwrite the default ones specified in the config.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Response timeout unit for the request. The ones specified here will overwrite the default ones specified in the config.

Custom headers

Object

Custom headers that the request will include. The ones specified here will overwrite the default ones specified in the config.

Custom query parameters

Object

Custom query parameters that the request will include. The ones specified here will overwrite the default ones specified in the config.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

Binary

For Configurations

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

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Workbook Id

String

The ID of the workbook.

x

Name

String

The name

Worksheet Name

String

The name of the worksheet.

Address

String

The address.

Table Name/Id

String

The ID of the table.

Column Name/Id

String

The ID or name of the column.

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Response timeout

Number

Response timeout for the request. The ones specified here will overwrite the default ones specified in the config.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Response timeout unit for the request. The ones specified here will overwrite the default ones specified in the config.

Custom headers

Object

Custom headers that the request will include. The ones specified here will overwrite the default ones specified in the config.

Custom query parameters

Object

Custom query parameters that the request will include. The ones specified here will overwrite the default ones specified in the config.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

Binary

For Configurations

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

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Workbook Id

String

The ID of the workbook.

x

Name

String

The name.

Worksheet Name

String

The name of the worksheet.

Address

String

The address.

Table Name/Id

String

The ID of the table.

Column Name/Id

String

The ID or name of the column.

Row Number

Number

Row number of the range to be retrieved. Zero-indexed.

x

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Response timeout

Number

Response timeout for the request. The ones specified here will overwrite the default ones specified in the config.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Response timeout unit for the request. The ones specified here will overwrite the default ones specified in the config.

Custom headers

Object

Custom headers that the request will include. The ones specified here will overwrite the default ones specified in the config.

Custom query parameters

Object

Custom query parameters that the request will include. The ones specified here will overwrite the default ones specified in the config.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

Binary

For Configurations

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

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Workbook Id

String

The ID of the workbook.

x

Worksheet Name

String

The name of the worksheet.

Address

String

The address.

x

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Response timeout

Number

Response timeout for the request. The ones specified here will overwrite the default ones specified in the config.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Response timeout unit for the request. The ones specified here will overwrite the default ones specified in the config.

Custom headers

Object

Custom headers that the request will include. The ones specified here will overwrite the default ones specified in the config.

Custom query parameters

Object

Custom query parameters that the request will include. The ones specified here will overwrite the default ones specified in the config.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

Binary

For Configurations

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

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Workbook Id

String

The ID of the workbook.

x

Worksheet Name

String

The name of the worksheet.

Delta Rows

Number

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.

x

Delta Columns

Number

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.

x

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Response timeout

Number

Response timeout for the request. The ones specified here will overwrite the default ones specified in the config.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Response timeout unit for the request. The ones specified here will overwrite the default ones specified in the config.

Custom headers

Object

Custom headers that the request will include. The ones specified here will overwrite the default ones specified in the config.

Custom query parameters

Object

Custom query parameters that the request will include. The ones specified here will overwrite the default ones specified in the config.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

Binary

For Configurations

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

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Workbook Id

String

The ID of the workbook. where rows are located.

x

Worksheet Name

String

The name of the worksheet where the rows are located.

Table Name/Id

String

The ID of the table.

x

Row Index

Number

The index of the row to retrieve.

x

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Response timeout

Number

Response timeout for the request. The ones specified here will overwrite the default ones specified in the config.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Response timeout unit for the request. The ones specified here will overwrite the default ones specified in the config.

Custom headers

Object

Custom headers that the request will include. The ones specified here will overwrite the default ones specified in the config.

Custom query parameters

Object

Custom query parameters that the request will include. The ones specified here will overwrite the default ones specified in the config.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

Binary

For Configurations

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

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Workbook Id

String

The ID of the workbook.

x

Worksheet Name

String

The name of the worksheet.

Count

Number

The number of rows to include in the resulting range.

1

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Response timeout

Number

Response timeout for the request. The ones specified here will overwrite the default ones specified in the config.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Response timeout unit for the request. The ones specified here will overwrite the default ones specified in the config.

Custom headers

Object

Custom headers that the request will include. The ones specified here will overwrite the default ones specified in the config.

Custom query parameters

Object

Custom query parameters that the request will include. The ones specified here will overwrite the default ones specified in the config.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

Binary

For Configurations

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

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Workbook Id

String

The ID of the workbook.

x

Worksheet Name

String

The name of the worksheet.

Count

Number

The number of rows to include in the resulting range.

1

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Response timeout

Number

Response timeout for the request. The ones specified here will overwrite the default ones specified in the config.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Response timeout unit for the request. The ones specified here will overwrite the default ones specified in the config.

Custom headers

Object

Custom headers that the request will include. The ones specified here will overwrite the default ones specified in the config.

Custom query parameters

Object

Custom query parameters that the request will include. The ones specified here will overwrite the default ones specified in the config.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

Binary

For Configurations

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

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Workbook Id

String

The ID of the workbook. where table is located.

x

Worksheet Name

String

The name of the worksheet where the table is located.

Table Name/Id

String

The ID of the table.

x

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Response timeout

Number

Response timeout for the request. The ones specified here will overwrite the default ones specified in the config.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Response timeout unit for the request. The ones specified here will overwrite the default ones specified in the config.

Custom headers

Object

Custom headers that the request will include. The ones specified here will overwrite the default ones specified in the config.

Custom query parameters

Object

Custom query parameters that the request will include. The ones specified here will overwrite the default ones specified in the config.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

Binary

For Configurations

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

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Workbook Id

String

The ID of the workbook.

x

Worksheet Name

String

The name of the worksheet.

Table Name/Id

String

The ID of the table.

x

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Response timeout

Number

Response timeout for the request. The ones specified here will overwrite the default ones specified in the config.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Response timeout unit for the request. The ones specified here will overwrite the default ones specified in the config.

Custom headers

Object

Custom headers that the request will include. The ones specified here will overwrite the default ones specified in the config.

Custom query parameters

Object

Custom query parameters that the request will include. The ones specified here will overwrite the default ones specified in the config.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

Binary

For Configurations

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

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Workbook Id

String

The workbook ID where the worksheet is located.

x

Worksheet Name

String

The worksheet name to retrieve.

x

Values Only

Boolean

Considers only cells with values as used cells (ignores formatting).

false

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Response timeout

Number

Response timeout for the request. The ones specified here will overwrite the default ones specified in the config.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Response timeout unit for the request. The ones specified here will overwrite the default ones specified in the config.

Custom headers

Object

Custom headers that the request will include. The ones specified here will overwrite the default ones specified in the config.

Custom query parameters

Object

Custom query parameters that the request will include. The ones specified here will overwrite the default ones specified in the config.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

Binary

For Configurations

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

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Workbook Id

String

The ID of the workbook. the application will retrieve.

x

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Response timeout

Number

Response timeout for the request. The ones specified here will overwrite the default ones specified in the config.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Response timeout unit for the request. The ones specified here will overwrite the default ones specified in the config.

Custom headers

Object

Custom headers that the request will include. The ones specified here will overwrite the default ones specified in the config.

Custom query parameters

Object

Custom query parameters that the request will include. The ones specified here will overwrite the default ones specified in the config.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

Binary

For Configurations

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

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Workbook Id

String

The ID of the workbook. where the comment is located.

x

Comment Id

String

The ID of the comment to retrieve.

x

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Response timeout

Number

Response timeout for the request. The ones specified here will overwrite the default ones specified in the config.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Response timeout unit for the request. The ones specified here will overwrite the default ones specified in the config.

Custom headers

Object

Custom headers that the request will include. The ones specified here will overwrite the default ones specified in the config.

Custom query parameters

Object

Custom query parameters that the request will include. The ones specified here will overwrite the default ones specified in the config.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

Binary

For Configurations

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

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Workbook Id

String

The workbook ID where the worksheet is located.

x

Workbook Id

String

The worksheet name to retrieve.

x

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Response timeout

Number

Response timeout for the request. The ones specified here will overwrite the default ones specified in the config.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Response timeout unit for the request. The ones specified here will overwrite the default ones specified in the config.

Custom headers

Object

Custom headers that the request will include. The ones specified here will overwrite the default ones specified in the config.

Custom query parameters

Object

Custom query parameters that the request will include. The ones specified here will overwrite the default ones specified in the config.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

Binary

For Configurations

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

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Workbook Id

String

The ID of the workbook.

x

Name

String

The name.

Worksheet Name

String

The name of the worksheet.

Address

String

The address.

Table Name/Id

String

The ID of the table.

Column Name/Id

String

The ID or name of the column.

Shift

Enumeration, one of:

  • DOWN

  • RIGHT

Specifies which way to shift the cells. The possible values are: Down, Right.

x

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Response timeout

Number

Response timeout for the request. The ones specified here will overwrite the default ones specified in the config.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Response timeout unit for the request. The ones specified here will overwrite the default ones specified in the config.

Custom headers

Object

Custom headers that the request will include. The ones specified here will overwrite the default ones specified in the config.

Custom query parameters

Object

Custom query parameters that the request will include. The ones specified here will overwrite the default ones specified in the config.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

Binary

For Configurations

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

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Workbook Id

String

The ID of the workbook. where the component is located.

x

Worksheet Name

String

The name of the worksheet where the component is located.

x

Chart Name

String

The name of the worksheet where the component is located.

x

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Select

String

Properties to retrieve in the response.

Expand

String

The response will include information regarding the specified relationship.

Filter

String

Retrieves a subset of a collection.

Order By

String

Specifies the sort order of the items returned.

Search

String

Restricts the results of a request to match a search criteria.

Page size

Number

The size of the pages retrieved by the query.

100

Response timeout

Number

Response timeout for the request. The ones specified here will overwrite the default ones specified in the config.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Response timeout unit for the request. The ones specified here will overwrite the default ones specified in the config.

Custom headers

Object

Custom headers that the request will include. The ones specified here will overwrite the default ones specified in the config.

Custom query parameters

Object

Custom query parameters that the request will include. The ones specified here will overwrite the default ones specified in the config.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Array of Any

For Configurations

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

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Workbook Id

String

The ID of the workbook. where the component is located.

x

Worksheet Name

String

The name of the worksheet where the component is located.

x

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Select

String

Properties to retrieve in the response.

Expand

String

The response will include information regarding the specified relationship.

Filter

String

Retrieves a subset of a collection.

Order By

String

Specifies the sort order of the items returned.

Search

String

Restricts the results of a request to match a search criteria.

Page size

Number

The size of the pages retrieved by the query.

100

Response timeout

Number

Response timeout for the request. The ones specified here will overwrite the default ones specified in the config.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Response timeout unit for the request. The ones specified here will overwrite the default ones specified in the config.

Custom headers

Object

Custom headers that the request will include. The ones specified here will overwrite the default ones specified in the config.

Custom query parameters

Object

Custom query parameters that the request will include. The ones specified here will overwrite the default ones specified in the config.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Array of Any

For Configurations

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

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Workbook Id

String

The ID of the workbook.

x

Worksheet Name

String

The name of the worksheet.

Table Name/Id

String

The ID of the table.

x

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Select

String

Properties to retrieve in the response.

Expand

String

The response will include information regarding the specified relationship.

Filter

String

Retrieves a subset of a collection.

Order By

String

Specifies the sort order of the items returned.

Search

String

Restricts the results of a request to match a search criteria.

Page size

Number

The size of the pages retrieved by the query.

100

Response timeout

Number

Response timeout for the request. The ones specified here will overwrite the default ones specified in the config.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Response timeout unit for the request. The ones specified here will overwrite the default ones specified in the config.

Custom headers

Object

Custom headers that the request will include. The ones specified here will overwrite the default ones specified in the config.

Custom query parameters

Object

Custom query parameters that the request will include. The ones specified here will overwrite the default ones specified in the config.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Any

For Configurations

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

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Workbook Id

String

The ID of the workbook where rows are added.

x

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Response timeout

Number

Response timeout for the request. The ones specified here will overwrite the default ones specified in the config.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Response timeout unit for the request. The ones specified here will overwrite the default ones specified in the config.

Custom headers

Object

Custom headers that the request will include. The ones specified here will overwrite the default ones specified in the config.

Custom query parameters

Object

Custom query parameters that the request will include. The ones specified here will overwrite the default ones specified in the config.

Select

String

Properties to retrieve in the response.

Expand

String

The response will include information regarding the specified relationship.

Filter

String

Retrieves a subset of a collection.

Order By

String

Specifies the sort order of the items returned.

Search

String

Restricts the results of a request to match a search criteria.

Page size

Number

The size of the pages retrieved by the query.

100

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Array of Any

For Configurations

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

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Workbook Id

String

The ID of the workbook.

x

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Select

String

Properties to retrieve in the response.

Expand

String

The response will include information regarding the specified relationship.

Filter

String

Retrieves a subset of a collection.

Order By

String

Specifies the sort order of the items returned.

Search

String

Restricts the results of a request to match a search criteria.

Page size

Number

The size of the pages retrieved by the query.

100

Response timeout

Number

Response timeout for the request. The ones specified here will overwrite the default ones specified in the config.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Response timeout unit for the request. The ones specified here will overwrite the default ones specified in the config.

Custom headers

Object

Custom headers that the request will include. The ones specified here will overwrite the default ones specified in the config.

Custom query parameters

Object

Custom query parameters that the request will include. The ones specified here will overwrite the default ones specified in the config.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Array of Any

For Configurations

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

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Workbook Id

String

The workbook ID where the worksheet is located.

x

Worksheet Name/Name

String

The worksheet name to retrieve.

x

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Select

String

Properties to retrieve in the response.

Expand

String

The response will include information regarding the specified relationship.

Filter

String

Retrieves a subset of a collection.

Order By

String

Specifies the sort order of the items returned.

Search

String

Restricts the results of a request to match a search criteria.

Page size

Number

The size of the pages retrieved by the query.

100

Response timeout

Number

Response timeout for the request. The ones specified here will overwrite the default ones specified in the config.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Response timeout unit for the request. The ones specified here will overwrite the default ones specified in the config.

Custom headers

Object

Custom headers that the request will include. The ones specified here will overwrite the default ones specified in the config.

Custom query parameters

Object

Custom query parameters that the request will include. The ones specified here will overwrite the default ones specified in the config.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Any

For Configurations

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

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Workbook Id

String

The ID of the workbook where rows are added.

x

Worksheet Name

String

The name of the worksheet where the table is located.

Table Name/Id

String

The ID of the table.

x

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Select

String

Properties to retrieve in the response.

Expand

String

The response will include information regarding the specified relationship.

Filter

String

Retrieves a subset of a collection.

Order By

String

Specifies the sort order of the items returned.

Search

String

Restricts the results of a request to match a search criteria.

Page size

Number

The size of the pages retrieved by the query.

100

Response timeout

Number

Response timeout for the request. The ones specified here will overwrite the default ones specified in the config.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Response timeout unit for the request. The ones specified here will overwrite the default ones specified in the config.

Custom headers

Object

Custom headers that the request will include. The ones specified here will overwrite the default ones specified in the config.

Custom query parameters

Object

Custom query parameters that the request will include. The ones specified here will overwrite the default ones specified in the config.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Any

For Configurations

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

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Workbook Id

String

The ID of the workbook.

x

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Select

String

Properties to retrieve in the response.

Expand

String

The response will include information regarding the specified relationship.

Filter

String

Retrieves a subset of a collection.

Order By

String

Specifies the sort order of the items returned.

Search

String

Restricts the results of a request to match a search criteria.

Page size

Number

The size of the pages retrieved by the query.

100

Response timeout

Number

Response timeout for the request. The ones specified here will overwrite the default ones specified in the config.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Response timeout unit for the request. The ones specified here will overwrite the default ones specified in the config.

Custom headers

Object

Custom headers that the request will include. The ones specified here will overwrite the default ones specified in the config.

Custom query parameters

Object

Custom query parameters that the request will include. The ones specified here will overwrite the default ones specified in the config.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Array of Any

For Configurations

List Workbook Comments

<excel:list-workbook-comments>

Retrieves a list of workbookComment objects.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Workbook Id

String

The ID of the workbook where the comments are listed from.

x

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Select

String

Properties to retrieve in the response.

Expand

String

The response will include information regarding the specified relationship.

Filter

String

Retrieves a subset of a collection.

Order By

String

Specifies the sort order of the items returned.

Search

String

Restricts the results of a request to match a search criteria.

Page size

Number

The size of the pages retrieved by the query.

100

Response timeout

Number

Response timeout for the request. The ones specified here will overwrite the default ones specified in the config.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Response timeout unit for the request. The ones specified here will overwrite the default ones specified in the config.

Custom headers

Object

Custom headers that the request will include. The ones specified here will overwrite the default ones specified in the config.

Custom query parameters

Object

Custom query parameters that the request will include. The ones specified here will overwrite the default ones specified in the config.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Any

For Configurations

List Worksheet

<excel:list-worksheet>

Retrieves a list of worksheet objects.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Workbook Id

String

The workbook ID where the worksheet is located.

x

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Response timeout

Number

Response timeout for the request. The ones specified here will overwrite the default ones specified in the config.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Response timeout unit for the request. The ones specified here will overwrite the default ones specified in the config.

Custom headers

Object

Custom headers that the request will include. The ones specified here will overwrite the default ones specified in the config.

Custom query parameters

Object

Custom query parameters that the request will include. The ones specified here will overwrite the default ones specified in the config.

Select

String

Properties to retrieve in the response.

Expand

String

The response will include information regarding the specified relationship.

Filter

String

Retrieves a subset of a collection.

Order By

String

Specifies the sort order of the items returned.

Search

String

Restricts the results of a request to match a search criteria.

Page size

Number

The size of the pages retrieved by the query.

100

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Array of Any

For Configurations

Range Bounding Rect

<excel:range-bounding-rect>

Gets the smallest range object that encompasses the given ranges.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Workbook Id

String

The ID of the workbook.

x

Name

String

The name.

Worksheet Name

String

The name of the worksheet.

Address

String

The address.

Table Name/Id

String

The ID of the table.

Column Name/Id

String

The ID or name of the column.

Another Range

String

The range object or address or range name.

x

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Response timeout

Number

Response timeout for the request. The ones specified here will overwrite the default ones specified in the config.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Response timeout unit for the request. The ones specified here will overwrite the default ones specified in the config.

Custom headers

Object

Custom headers that the request will include. The ones specified here will overwrite the default ones specified in the config.

Custom query parameters

Object

Custom query parameters that the request will include. The ones specified here will overwrite the default ones specified in the config.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

Binary

For Configurations

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

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Workbook Id

String

The ID of the workbook.

x

Name

String

The name.

Worksheet Name

String

The name of the worksheet.

Address

String

The address.

Table Name/Id

String

The ID of the table.

Column Name/Id

String

The ID or name of the column.

Apply To

Enumeration, one of:

  • ALL

  • FORMATS

  • CONTENTS

Determines the type of clear action. The possible values are: All, Formats, Contents.

ALL

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Response timeout

Number

Response timeout for the request. The ones specified here will overwrite the default ones specified in the config.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Response timeout unit for the request. The ones specified here will overwrite the default ones specified in the config.

Custom headers

Object

Custom headers that the request will include. The ones specified here will overwrite the default ones specified in the config.

Custom query parameters

Object

Custom query parameters that the request will include. The ones specified here will overwrite the default ones specified in the config.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

Binary

For Configurations

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

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Workbook Id

String

The ID of the workbook.

x

Name

String

The name.

Worksheet Name

String

The name of the worksheet.

Address

String

The address.

Table Name/Id

String

The ID of the table.

Column Name/Id

String

The ID or name of the column.

Shift

Enumeration, one of:

  • UP

  • LEFT

Specifies which way to shift the cells. The possible values are: Up, Left.

x

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Response timeout

Number

Response timeout for the request. The ones specified here will overwrite the default ones specified in the config.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Response timeout unit for the request. The ones specified here will overwrite the default ones specified in the config.

Custom headers

Object

Custom headers that the request will include. The ones specified here will overwrite the default ones specified in the config.

Custom query parameters

Object

Custom query parameters that the request will include. The ones specified here will overwrite the default ones specified in the config.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

Binary

For Configurations

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

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Workbook Id

String

The ID of the workbook where the worksheet is located.

x

Name

String

The name of the range.

Worksheet Name

String

The name of the worksheet.

Address

String

The address of the range.

Table Name/Id

String

The ID of the table.

Column Name/Id

String

The ID of the column.

Values Only

Boolean

Considers only cells with values as used cells.

false

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Response timeout

Number

Response timeout for the request. The ones specified here will overwrite the default ones specified in the config.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Response timeout unit for the request. The ones specified here will overwrite the default ones specified in the config.

Custom headers

Object

Custom headers that the request will include. The ones specified here will overwrite the default ones specified in the config.

Custom query parameters

Object

Custom query parameters that the request will include. The ones specified here will overwrite the default ones specified in the config.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

Binary

For Configurations

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

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Workbook Id

String

The ID of the workbook.

x

Name

String

The name.

Worksheet Name

String

The name of the worksheet.

Address

String

The address.

Table Name/Id

String

The ID of the table.

Column Name/Id

String

The ID or name of the column.

Across

Boolean

Set true to merge cells in each row of the specified range as separate merged cells.

false

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Response timeout

Number

Response timeout for the request. The ones specified here will overwrite the default ones specified in the config.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Response timeout unit for the request. The ones specified here will overwrite the default ones specified in the config.

Custom headers

Object

Custom headers that the request will include. The ones specified here will overwrite the default ones specified in the config.

Custom query parameters

Object

Custom query parameters that the request will include. The ones specified here will overwrite the default ones specified in the config.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

Binary

For Configurations

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

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Workbook Id

String

The ID of the workbook.

x

Name

String

The name.

Worksheet Name

String

The name of the worksheet.

Address

String

The address.

Table Name/Id

String

The ID of the table.

Column Name/Id

String

The ID or name of the column.

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Response timeout

Number

Response timeout for the request. The ones specified here will overwrite the default ones specified in the config.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Response timeout unit for the request. The ones specified here will overwrite the default ones specified in the config.

Custom headers

Object

Custom headers that the request will include. The ones specified here will overwrite the default ones specified in the config.

Custom query parameters

Object

Custom query parameters that the request will include. The ones specified here will overwrite the default ones specified in the config.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

Binary

For Configurations

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

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Workbook Id

String

The ID of the workbook. where the component is located.

x

Worksheet Name

String

The name of the worksheet where the component is located.

x

Chart Name/Id

String

Corresponding chart ID or name to retrieve.

x

Source Body

Any

Corresponding chart source body.

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Select

String

Properties to retrieve in the response.

Expand

String

The response will include information regarding the specified relationship.

Filter

String

Retrieves a subset of a collection.

Order By

String

Specifies the sort order of the items returned.

Search

String

Restricts the results of a request to match a search criteria.

Response timeout

Number

Response timeout for the request. The ones specified here will overwrite the default ones specified in the config.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Response timeout unit for the request. The ones specified here will overwrite the default ones specified in the config.

Custom headers

Object

Custom headers that the request will include. The ones specified here will overwrite the default ones specified in the config.

Custom query parameters

Object

Custom query parameters that the request will include. The ones specified here will overwrite the default ones specified in the config.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

Binary

For Configurations

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

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Resource Owner Id

String

The ID of the resource owner of which access must be invalidated.

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

For Configurations

Update Chart

<excel:update-chart>

Update the properties of a chart object.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Workbook Id

String

The ID of the workbook. where the component is located.

x

Worksheet Name

String

The name of the worksheet where the component is located.

x

Chart Name/Id

String

Corresponding chart ID or name to retrieve.

x

Chart Body

Any

In the request body, supply the values for relevant fields that should be updated.

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Response timeout

Number

Response timeout for the request. The ones specified here will overwrite the default ones specified in the config.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Response timeout unit for the request. The ones specified here will overwrite the default ones specified in the config.

Custom headers

Object

Custom headers that the request will include. The ones specified here will overwrite the default ones specified in the config.

Custom query parameters

Object

Custom query parameters that the request will include. The ones specified here will overwrite the default ones specified in the config.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

Binary

For Configurations

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

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Workbook Id

String

The ID of the workbook where rows are added.

x

Name

String

The name of the named item.

x

Body

Any

Supplies the values for relevant fields that should be updated.

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Response timeout

Number

Response timeout for the request. The ones specified here will overwrite the default ones specified in the config.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Response timeout unit for the request. The ones specified here will overwrite the default ones specified in the config.

Custom headers

Object

Custom headers that the request will include. The ones specified here will overwrite the default ones specified in the config.

Custom query parameters

Object

Custom query parameters that the request will include. The ones specified here will overwrite the default ones specified in the config.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

Binary

For Configurations

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

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Workbook Id

String

The ID of the workbook.

x

Name

String

The name.

Worksheet Name

String

The name of the worksheet.

Address

String

The address.

Table Name/Id

String

The ID of the table.

Column Name/Id

String

The ID or name of the column.

Range Body

Any

Supply the values for relevant fields that should be updated.

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Response timeout

Number

Response timeout for the request. The ones specified here will overwrite the default ones specified in the config.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Response timeout unit for the request. The ones specified here will overwrite the default ones specified in the config.

Custom headers

Object

Custom headers that the request will include. The ones specified here will overwrite the default ones specified in the config.

Custom query parameters

Object

Custom query parameters that the request will include. The ones specified here will overwrite the default ones specified in the config.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

Binary

For Configurations

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

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Workbook Id

String

The ID of the workbook.

x

Name

String

The name.

Worksheet Name

String

The name of the worksheet.

Address

String

The address.

Table Name/Id

String

The ID of the table.

Column Name/Id

String

The ID or name of the column.

Range Format Body

Any

Supplies the values for relevant fields that should be updated.

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Response timeout

Number

Response timeout for the request. The ones specified here will overwrite the default ones specified in the config.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Response timeout unit for the request. The ones specified here will overwrite the default ones specified in the config.

Custom headers

Object

Custom headers that the request will include. The ones specified here will overwrite the default ones specified in the config.

Custom query parameters

Object

Custom query parameters that the request will include. The ones specified here will overwrite the default ones specified in the config.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

Binary

For Configurations

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

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Workbook Id

String

The ID of the workbook where rows are added.

x

Worksheet Name

String

The name of the worksheet where the table is located.

Table Name/Id

String

The ID of the table.

x

Row Index

Number

The index of the row to update.

x

Columns

Binary

The columns to add.

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Response timeout

Number

Response timeout for the request. The ones specified here will overwrite the default ones specified in the config.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Response timeout unit for the request. The ones specified here will overwrite the default ones specified in the config.

Custom headers

Object

Custom headers that the request will include. The ones specified here will overwrite the default ones specified in the config.

Custom query parameters

Object

Custom query parameters that the request will include. The ones specified here will overwrite the default ones specified in the config.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

Binary

For Configurations

Throws

  • EXCEL:CONNECTIVITY

  • EXCEL:RETRY_EXHAUSTED

Update Table

<excel:update-table>

Update the properties of a table object.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Workbook Id

String

The ID of the workbook.

x

Worksheet Name

String

The name of the worksheet.

Table Name/Id

String

The ID of the table. to be updated.

x

Table Content

Any

The new content of the table.

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Response timeout

Number

Response timeout for the request. The ones specified here will overwrite the default ones specified in the config.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Response timeout unit for the request. The ones specified here will overwrite the default ones specified in the config.

Custom headers

Object

Custom headers that the request will include. The ones specified here will overwrite the default ones specified in the config.

Custom query parameters

Object

Custom query parameters that the request will include. The ones specified here will overwrite the default ones specified in the config.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

Binary

For Configurations

Throws

  • EXCEL:CONNECTIVITY

  • EXCEL:RETRY_EXHAUSTED

Update Worksheet

<excel:update-worksheet>

Update the properties of a worksheet object.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Workbook Id

String

The workbook ID where the worksheet is located.

x

Worksheet Name

String

The worksheet name to retrieve.

x

Worksheet Content

Any

#[payload]

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Response timeout

Number

Response timeout for the request. The ones specified here will overwrite the default ones specified in the config.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Response timeout unit for the request. The ones specified here will overwrite the default ones specified in the config.

Custom headers

Object

Custom headers that the request will include. The ones specified here will overwrite the default ones specified in the config.

Custom query parameters

Object

Custom query parameters that the request will include. The ones specified here will overwrite the default ones specified in the config.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

Binary

For Configurations

Throws

  • EXCEL:CONNECTIVITY

  • EXCEL:RETRY_EXHAUSTED

Sources

On New Row Listener

<excel:new-row-listener>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Workbook Id

String

The ID of the workbook.

x

Worksheet Name

String

The name of the worksheet.

x

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Primary Node Only

Boolean

Whether this source should only be executed on the primary node when running in a cluster.

Scheduling Strategy

scheduling-strategy

Configures the scheduler that triggers the polling.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Redelivery Policy

Defines a policy for processing the redelivery of the same message

Response timeout

Number

Response timeout for the request. The ones specified here will overwrite the default ones specified in the config.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Response timeout unit for the request. The ones specified here will overwrite the default ones specified in the config.

Custom headers

Object

Custom headers that the request will include. The ones specified here will overwrite the default ones specified in the config.

Custom query parameters

Object

Custom query parameters that the request will include. The ones specified here will overwrite the default ones specified in the config.

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Any

For Configurations

On New Worksheet Listener

<excel:new-worksheet-listener>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Workbook Id

String

The ID of the workbook.

x

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Primary Node Only

Boolean

Whether this source should only be executed on the primary node when running in a cluster.

Scheduling Strategy

scheduling-strategy

Configures the scheduler that triggers the polling.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Redelivery Policy

Defines a policy for processing the redelivery of the same message.

Response timeout

Number

Response timeout for the request. The ones specified here will overwrite the default ones specified in the config.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Response timeout unit for the request. The ones specified here will overwrite the default ones specified in the config.

Custom headers

Object

Custom headers that the request will include. The ones specified here will overwrite the default ones specified in the config.

Custom query parameters

Object

Custom query parameters that the request will include. The ones specified here will overwrite the default ones specified in the config.

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Any

For Configurations

On Updated Row Listener

<excel:updated-row-listener>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Workbook Id

String

The ID of the workbook.

x

Worksheet Name

String

The name of the worksheet.

x

Include New Rows

Boolean

false

Columns To Monitor

Array of String

List of columns which will be monitored for updated data. For example, some possible values are A, B, C, AA, or BB.

Config Ref

ConfigurationProvider

The name of the configuration to use to execute this component.

x

Primary Node Only

Boolean

Whether this source should only be executed on the primary node when running in a cluster.

Scheduling Strategy

scheduling-strategy

Configures the scheduler that triggers the polling.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Redelivery Policy

Defines a policy for processing the redelivery of the same message.

Response timeout

Number

Response timeout for the request. The ones specified here will overwrite the default ones specified in the config.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Response timeout unit for the request. The ones specified here will overwrite the default ones specified in the config.

Custom headers

Object

Custom headers that the request will include. The ones specified here will overwrite the default ones specified in the config.

Custom query parameters

Object

Custom query parameters that the request will include. The ones specified here will overwrite the default ones specified in the config.

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Any

For Configurations

Types

Proxy Configuration

Field Type Description Default Value Required

Host

String

Host where the proxy requests are sent.

x

Port

Number

Port where the proxy requests are sent.

x

Username

String

The username to authenticate against the proxy.

Password

String

The password to authenticate against the proxy.

TLS

Field Type Description Default Value Required

Enabled Protocols

String

A comma-separated list of protocols enabled for this context.

Enabled Cipher Suites

String

A comma-separated list of cipher suites enabled for this context.

Trust Store

Key Store

Revocation Check

Trust Store

Field Type Description Default Value Required

Path

String

The location (which will be resolved relative to the current classpath and file system, if possible) of the truststore.

Password

String

The password used to protect the truststore.

Type

String

The type of truststore used.

Algorithm

String

The algorithm used by the truststore.

Insecure

Boolean

If true, Mule stops performing certificate validations. This can make connections vulnerable to attacks.

Keystore

Field Type Description Default Value Required

Path

String

The location (which will be resolved relative to the current classpath and file system, if possible) of the keystore.

Type

String

Type of keystore used.

Alias

String

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.

Key Password

String

Password used to protect the private key.

Password

String

Password used to protect the keystore.

Algorithm

String

Algorithm used by the keystore.

Standard Revocation Check

Field Type Description Default Value Required

Only End Entities

Boolean

Only verify the last element of the certificate chain.

Prefer Crls

Boolean

Try CRL instead of OCSP first.

No Fallback

Boolean

Do not use the secondary checking method (the one not selected before).

Soft Fail

Boolean

Avoid verification failure when the revocation server can not be reached or is busy.

Custom OCSP Responder

Field Type Description Default Value Required

Url

String

The URL of the OCSP responder.

Cert Alias

String

Alias of the signing certificate for the OCSP response (must be in the truststore), if present.

CRL File

Field Type Description Default Value Required

Path

String

The path to the CRL file.

Reconnection

Field Type Description Default Value Required

Fails Deployment

Boolean

When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy.

Reconnection Strategy

The reconnection strategy to use.

Reconnect

Field Type Description Default Value Required

Frequency

Number

How often in milliseconds to reconnect.

Blocking

Boolean

If false, the reconnection strategy will run in a separate, non-blocking thread.

Count

Number

How many reconnection attempts to make.

Reconnect Forever

Field Type Description Default Value Required

Frequency

Number

How often in milliseconds to reconnect.

Blocking

Boolean

If false, the reconnection strategy will run in a separate, non-blocking thread.

Expiration Policy

Field Type Description Default Value Required

Max Idle Time

Number

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.

Time Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit that qualifies the Max Idle Time attribute.

Repeatable In Memory Stream

Field Type Description Default Value Required

Initial Buffer Size

Number

Initial amount of memory to allocate to the memory stream. If the stream data exceeds this value, the buffer expands by Buffer Size Increment, with an upper limit Max In Memory Size value.

Buffer Size Increment

Number

Amount by which the buffer size expands if it exceeds its initial size. Setting a value of 0 or lower specifies that the buffer can’t expand. Mule raises a STREAM_MAXIMUM_SIZE_EXCEEDED error when the buffer gets full.

Max Buffer Size

Number

Maximum size of the buffer. A value less than or equal to 0 means no limit.

Buffer Unit

Enumeration, one of:

  • BYTE

  • KB

  • MB

  • GB

The unit in which all these attributes are expressed

Repeatable File Store Stream

Field Type Description Default Value Required

In Memory Size

Number

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.

Buffer Unit

Enumeration, one of:

  • BYTE

  • KB

  • MB

  • GB

The unit in which maxInMemorySize is expressed

Redelivery Policy

Field Type Description Default Value Required

Max Redelivery Count

Number

The maximum number of times a message can be redelivered and processed unsuccessfully before triggering process-failed-message

Message Digest Algorithm

String

The secure hashing algorithm to use. If not set, the default is SHA-256.

Message Identifier

Defines which strategy is used to identify the messages.

Object Store

ObjectStore

The object store where the redelivery counter for each message is stored.

Redelivery Policy Message Identifier

Field Type Description Default Value Required

Use Secure Hash

Boolean

Whether to use a secure hash algorithm to identify a redelivered message.

Id Expression

String

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.

Repeatable In Memory Iterable

Field Type Description Default Value Required

Initial Buffer Size

Number

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.

Buffer Size Increment

Number

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.

Max Buffer Size

Number

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.

Repeatable File Store Iterable

Field Type Description Default Value Required

In Memory Objects

Number

The maximum amount of instances to keep in memory. If more than that is required, content on the disk is buffered.

Buffer Unit

Enumeration, one of:

  • BYTE

  • KB

  • MB

  • GB

The unit in which maxInMemorySize is expressed