Contact Us 1-800-596-4880
  1. Homepage
  2. Tableau Connector (1.0.0)

  3. Tableau Connector Reference

All Connectors

Tableau Connector 1.0 Reference

Configurations

Hyper configuration

This configuration provides users access to the HyperAPI Java library developed by Tableau. Users can create, update, and delete hyper files locally.

Hyper Configuration requires you to provide a path to the hyperd executable file. It is not possible to use Hyper Configuration and its operations in CloudHub because CloudHub does not allow executing external code due to security reasons.

Parameters

Name Type Description Default Value Required

Name

String

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

x

Connection

Hyper Connection

Connection types for this configuration.

x

Name

String

ID used to reference this configuration.

x

Expiration Policy

Expiration Policy

Configures the minimum amount of time that a dynamic configuration instance can remain idle before Mule considers it eligible for expiration.

Connection Types

Hyper Connection
Parameters
Name Type Description Default Value Required

Working Directory

String

Directory that is considered the root of every relative path used with this connector. If not provided, the value defaults to the value of the user.home system property. If that system property is not set, then the connector fails to initialize.

Hyperd Directory

String

Directory that makes the hyperd executable.

Telemetry

Enumeration, one of:

  • SEND_USAGE_DATA_TO_TABLEAU

  • DO_NOT_SEND_USAGE_DATA_TO_TABLEAU

HyperProcess is instructed to send telemetry on the Hyper API usage to Tableau.

Reconnection

Reconnection

Configures a reconnection strategy to use when a connector operation fails to connect to an external server.

Supported Operations

Rest Configuration

This configuration provides users access to the Rest API exposed by Tableau. All of the operations executed over the Rest API are bound to this configuration.

Parameters

Name Type Description Default Value Required

Name

String

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

x

Connection

Connection types for this configuration.

x

Read Timeout

Number

Defines the default amount of time to wait for a response when executing an operation.

30

Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout value.

SECONDS

Name

String

ID used to reference this configuration.

x

Expiration Policy

Expiration Policy

Configures the minimum amount of time that a dynamic configuration instance can remain idle before Mule considers it eligible for expiration.

Connection Types

Basic Authentication
Parameters
Name Type Description Default Value Required

Server URL

String

URL of the Tableau server.

x

API version

String

API version to use.

x

Content URL

String

Content URL (subpath) of the site you sign into.

x

Connection Timeout

Number

How long the connector waits before timing out when establishing a connection to the remote service. Values that are less than one millisecond are converted to 0.

-1

Connection Timeout unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Connection Timeout field.

SECONDS

Proxy configuration

Proxy Configuration

Configures a proxy for outbound connections.

Username

String

Username used to initialize the session.

x

Password

String

Password used to authenticate the user.

x

TLS configuration

TLS

Configures TLS. If using the HTTPS protocol, you must configure TLS.

Reconnection

Reconnection

Configures a reconnection strategy to use when a connector operation fails to connect to an external server.
PAT Authentication

Personal access tokens enable Tableau Server users to create long-lived authentication tokens. After obtaining the authentication token, send the token with each subsequent request to the X-Tableau-Auth header.

Parameters
Name Type Description Default Value Required

Server URL

String

URL of the Tableau server.

x

API version

String

API version to use.

x

Content URL

String

Content URL (subpath) of the site you sign into.

x

Connection Timeout

Number

How long the connector waits before timing out when establishing a connection to the remote service. Values that are less than one millisecond are converted to 0.

-1

Connection Timeout unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Connection Timeout field.

SECONDS

Proxy configuration

Proxy Configuration

Configures a proxy for outbound connections.

Personal Access Token Name

String

Personal access token name defined in the Tableau server UI. The personal access token name and personal access token secret are mutually exclusive with the Username and Password fields.

x

Personal Access Token Secret

String

Personal access token secret defined in the Tableau UI. The personal access token name and personal access token secret are mutually exclusive with the Username and Password fields.

x

TLS configuration

TLS

Configures TLS. If using the HTTPS protocol, you must configure TLS.

Reconnection

Reconnection

Configures a reconnection strategy to use when a connector operation fails to connect to an external server.

Supported Operations

Supported Sources

Create hyper file

<tableau-specialist:create-hyper-file>

Creates an empty hyper file based on the column definition provided by the user.

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Output Hyper file name

String

Name of the hyper file to create.

x

Schema name

String

Name of the schema that creates the table.

Table name

String

Name of the table.

x

Columns

Array of Column Definition

List of columns defined in the table.

x

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Reconnection Strategy

Retry strategy in case of connectivity errors.

For Configurations

Throws

  • TABLEAU-SPECIALIST:CONNECTIVITY

  • TABLEAU-SPECIALIST:FILE_DOESNT_EXIST

  • TABLEAU-SPECIALIST:FILE_IS_NOT_DIRECTORY

  • TABLEAU-SPECIALIST:HYPER_EXCEPTION

  • TABLEAU-SPECIALIST:ILLEGAL_PATH

  • TABLEAU-SPECIALIST:RETRY_EXHAUSTED

Insert data to hyper file from csv

<tableau-specialist:insert-data-to-hyper-file-from-csv>

Populates a hyper file from an existing CSV document.

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Hyper file name

String

Name of the hyper file.

x

Schema name

String

Name of the schema.

Table name

String

Name of the table.

x

Columns

Array of Column Definition

List of columns defined in the table.

x

CSV file path

String

Path to the CSV file.

x

CSV NULL column

String

Defines what the CSV file uses to represent null values.

x

CSV delimiter

String

Defines what the CSV file uses as a delimiter.

x

CSV header

Boolean

Specifies whether the CSV file contains a header.

false

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Target Variable

String

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

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Number

For Configurations

Throws

  • TABLEAU-SPECIALIST:CONNECTIVITY

  • TABLEAU-SPECIALIST:FILE_DOESNT_EXIST

  • TABLEAU-SPECIALIST:FILE_IS_NOT_DIRECTORY

  • TABLEAU-SPECIALIST:HYPER_EXCEPTION

  • TABLEAU-SPECIALIST:ILLEGAL_PATH

  • TABLEAU-SPECIALIST:RETRY_EXHAUSTED

Insert data to hyper file

<tableau-specialist:insert-data-to-hyper-file>

Inserts data into a table belonging to a hyper file.

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Hyper file name

String

Name of the hyper file that contains the inserted data.

x

SQL query

String

SQL command used to insert the data into the table from the hyper file.

x

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Target Variable

String

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

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Number

For Configurations

Throws

  • TABLEAU-SPECIALIST:CONNECTIVITY

  • TABLEAU-SPECIALIST:FILE_DOESNT_EXIST

  • TABLEAU-SPECIALIST:FILE_IS_NOT_DIRECTORY

  • TABLEAU-SPECIALIST:HYPER_EXCEPTION

  • TABLEAU-SPECIALIST:ILLEGAL_PATH

  • TABLEAU-SPECIALIST:RETRY_EXHAUSTED

Query Data From Hyper File

<tableau-specialist:query-data-from-hyper-file>

Queries data from tables belonging to a hyper file.

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Hyper file name

String

Name of the hyper file that contains the queried data.

x

SQL query

String

SQL query that selects data from the hyper file.

x

Target Variable

String

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

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Array of Object

For Configurations

Throws

  • TABLEAU-SPECIALIST:CONNECTIVITY

  • TABLEAU-SPECIALIST:FILE_DOESNT_EXIST

  • TABLEAU-SPECIALIST:FILE_IS_NOT_DIRECTORY

  • TABLEAU-SPECIALIST:HYPER_EXCEPTION

  • TABLEAU-SPECIALIST:ILLEGAL_PATH

  • TABLEAU-SPECIALIST:RETRY_EXHAUSTED

Update data from hyper file

<tableau-specialist:update-data-from-hyper-file>

Updates data from tables into a .hyper file by sending SQL queries.

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Hyper file path

String

Name of the hyper file that is updated.

x

SQL query

String

SQL command used to update the data in the table from the hyper file.

x

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

Target Variable

String

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

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Number

For Configurations

Throws

  • TABLEAU-SPECIALIST:CONNECTIVITY

  • TABLEAU-SPECIALIST:FILE_DOESNT_EXIST

  • TABLEAU-SPECIALIST:FILE_IS_NOT_DIRECTORY

  • TABLEAU-SPECIALIST:HYPER_EXCEPTION

  • TABLEAU-SPECIALIST:ILLEGAL_PATH

  • TABLEAU-SPECIALIST:RETRY_EXHAUSTED

Append to file upload

<tableau-specialist:append-to-file-upload>

Uploads a block of data and appends it to the data that is already uploaded.

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

File Content

Any

Content of the file to upload is included in a MIME multipart message.

#[payload]

Upload Session Id

String

ID of the upload session. You get this value when you start an upload session using the Initiate file upload operation.

x

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. The default is to use repeatable streams.

Target Variable

String

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

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Binary

Attributes Type

Binary

For Configurations

Throws

  • TABLEAU-SPECIALIST:CONNECTIVITY

  • TABLEAU-SPECIALIST:FILE_SIZE_TOO_LARGE

  • TABLEAU-SPECIALIST:FILE_UPLOAD_NOT_FOUND

  • TABLEAU-SPECIALIST:FORBIDDEN

  • TABLEAU-SPECIALIST:INSUFFICIENT_SITE_STORAGE_REMAINING

  • TABLEAU-SPECIALIST:MALFORMED_REQUEST_BODY

  • TABLEAU-SPECIALIST:MISSING_FILE_DATA

  • TABLEAU-SPECIALIST:NOT_A_PUBLISHER

  • TABLEAU-SPECIALIST:RETRY_EXHAUSTED

  • TABLEAU-SPECIALIST:TIMEOUT

  • TABLEAU-SPECIALIST:UPLOAD_FAILURE

Create project

<tableau-specialist:create-project>

Creates a project on the site. You can also create project hierarchies by creating a project under the specified parent project on the site.

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Publish value

Boolean

Specifies whether to publish the sample workbooks provided by Tableau to the project.

false

Content

Any

InputStream containing specific attributes for this operation.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. The default is to use repeatable streams.

Target Variable

String

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

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Binary

Attributes Type

Binary

For Configurations

Throws

  • TABLEAU-SPECIALIST:BAD_REQUEST

  • TABLEAU-SPECIALIST:BAD_REQUEST_PERMISSION

  • TABLEAU-SPECIALIST:CONNECTIVITY

  • TABLEAU-SPECIALIST:FORBIDDEN

  • TABLEAU-SPECIALIST:INSUFFICIENT_SITE_STORAGE_REMAINING

  • TABLEAU-SPECIALIST:INVALID_REQUEST_METHOD

  • TABLEAU-SPECIALIST:PROJECT_NAME_CONFLICT

  • TABLEAU-SPECIALIST:RETRY_EXHAUSTED

  • TABLEAU-SPECIALIST:SITE_NOT_FOUND

  • TABLEAU-SPECIALIST:TIMEOUT

Delete project

<tableau-specialist:delete-project>

Deletes the specified project from the site. When a project is deleted, all of its assets are also deleted, such as its associated workbooks, data sources, project view options, and rights. Use this operation with caution.

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Project ID

String

ID of the project to delete.

x

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. The default is to use repeatable streams.

Target Variable

String

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

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Binary

Attributes Type

Binary

For Configurations

Throws

  • TABLEAU-SPECIALIST:CONNECTIVITY

  • TABLEAU-SPECIALIST:DELETION_FORBIDDEN

  • TABLEAU-SPECIALIST:FORBIDDEN

  • TABLEAU-SPECIALIST:INSUFFICIENT_SITE_STORAGE_REMAINING

  • TABLEAU-SPECIALIST:PROJECT_NOT_FOUND

  • TABLEAU-SPECIALIST:RETRY_EXHAUSTED

  • TABLEAU-SPECIALIST:TIMEOUT

Initiate file upload

<tableau-specialist:initiate-file-upload>

Initiates the upload process for a file.

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. The default is to use repeatable streams.

Target Variable

String

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

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Binary

Attributes Type

Binary

For Configurations

Throws

  • TABLEAU-SPECIALIST:ACCESS_TO_FAVORITES_FORBIDDEN

  • TABLEAU-SPECIALIST:CONNECTIVITY

  • TABLEAU-SPECIALIST:FORBIDDEN

  • TABLEAU-SPECIALIST:INSUFFICIENT_SITE_STORAGE_REMAINING

  • TABLEAU-SPECIALIST:RETRY_EXHAUSTED

  • TABLEAU-SPECIALIST:TIMEOUT

Publish datasource

<tableau-specialist:publish-datasource>

Publishes a data source to the site, or appends data to an existing data source. To make other changes to a published data source, call Update Data Source or Update Data Source Connection.

Use this operation in the following ways:

  • Publish a data source in a single request. You must include the content of the data source file in the body of the request. The maximum size of a file that can be published in a single request is 64 MB. To avoid timing out the publishing process, use the asJob parameter to make data source publication asynchronous.

  • Publish a data source in multiple requests. You must initiate a file upload by calling Initiate File Upload, sending portions of the file to the server using Append to File Upload, and then committing the upload by calling Publish Data Source. In this case, Publish Data Source does not contain the file to publish.

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Overwrite flag

Boolean

Set to true to overwrite a data source that has the same name. Set to false to ensure failure if the specified data source already exists.

false

As job value

Boolean

Specifies whether to publish data sources asynchronously.

false

Append flag

Boolean

Set to true to append the data that is published to an existing data source with the same name. If set to true but the data source doesn’t already exist, the operation will fail.

false

Datasource Request Options

One of:

Datasource object.

x

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. The default is to use repeatable streams.

Target Variable

String

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

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Binary

Attributes Type

Binary

For Configurations

Throws

  • TABLEAU-SPECIALIST:CONNECTIVITY

  • TABLEAU-SPECIALIST:DATA_SOURCE_NOT_FOUND

  • TABLEAU-SPECIALIST:FORBIDDEN

  • TABLEAU-SPECIALIST:INCOMPATIBLE_OVERWRITE_AND_APPEND_VALUES

  • TABLEAU-SPECIALIST:INSUFFICIENT_SITE_STORAGE_REMAINING

  • TABLEAU-SPECIALIST:INVALID_ASK_DATA_ENABLEMENT

  • TABLEAU-SPECIALIST:INVALID_FILE_NAME_FILE_TYPE

  • TABLEAU-SPECIALIST:PUBLISHING_ERROR

  • TABLEAU-SPECIALIST:RETRY_EXHAUSTED

  • TABLEAU-SPECIALIST:TIMEOUT

Publish workbook

<tableau-specialist:publish-workbook>

Publishes a workbook onto the site. To make changes to a published workbook, call Update Workbook or Update Workbook Connection.

Use this operation in the following ways:

  • Publish a workbook in a single request. You must include the content of the workbook file in the body of the request. The maximum size of a file that can be published in a single request is 64 MB. To avoid timing out the publishing process, use the asJob parameter to make workbook publication asynchronous.

  • Publish a workbook in multiple requests. You must initiate a file upload by calling Initiate File Upload, sending portions of the file to the server using Append to File Upload, and then committing the upload by calling Publish Workbook. In this case, Publish Workbook does not contain the file to publish.

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Overwrite flag

Boolean

Set to true to overwrite a data source that has the same name. Set to false to ensure failure if the specified data source already exists.

false

As job value

Boolean

Specifies whether to publish data sources asynchronously.

false

Skip connection

Boolean

If set to true, the Tableau server does not check if a non-published connection of a workbook is reachable. Publishing will succeed but unchecked connection issues may result in a non-functioning workbook.

false

Workbook Request Options

One of:

Workbook object.

x

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. The default is to use repeatable streams.

Target Variable

String

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

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Binary

Attributes Type

Binary

For Configurations

Throws

  • TABLEAU-SPECIALIST:CONCURRENT_UPDATE

  • TABLEAU-SPECIALIST:CONNECTIVITY

  • TABLEAU-SPECIALIST:FAILED_CONNECTION_CHECK

  • TABLEAU-SPECIALIST:FORBIDDEN

  • TABLEAU-SPECIALIST:INSUFFICIENT_SITE_STORAGE_REMAINING

  • TABLEAU-SPECIALIST:MISSING_OR_INVALID_FILE_TYPE

  • TABLEAU-SPECIALIST:PUBLISHING_OVERWRITE

  • TABLEAU-SPECIALIST:RETRY_EXHAUSTED

  • TABLEAU-SPECIALIST:TIMEOUT

  • TABLEAU-SPECIALIST:WORKBOOK_NOT_FOUND

Query projects

<tableau-specialist:query-projects>

Returns a list of projects on the specified site, with optional parameters for specifying the paging of large results.

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Page Size

Number

Number of items to return in one response. The minimum is 1 and the maximum is 1000.

100

Filter Expression

Array of Filter Expression

Expression that specifies a subset of data sources to return.

Sort Expression

Array of Sort Expression

Expression that specifies the order in which to return user information.

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. The default is to use repeatable streams.

Target Variable

String

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

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Array of Object

For Configurations

Throws

  • TABLEAU-SPECIALIST:CONNECTIVITY

  • TABLEAU-SPECIALIST:FORBIDDEN

  • TABLEAU-SPECIALIST:INSUFFICIENT_SITE_STORAGE_REMAINING

  • TABLEAU-SPECIALIST:INVALID_PAGE_NUMBER

  • TABLEAU-SPECIALIST:INVALID_PAGE_SIZE

  • TABLEAU-SPECIALIST:PAGE_SIZE_LIMIT_EXCEEDED

  • TABLEAU-SPECIALIST:TIMEOUT

Update project

<tableau-specialist:update-project>

Updates a project on the specified site.

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Project ID

String

ID of the project to update.

x

Publish value

Boolean

Specifies whether to publish the sample workbooks provided by Tableau to the project.

false

Content

Any

InputStream containing specific attributes for this operation.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. The default is to use repeatable streams.

Target Variable

String

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

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Binary

Attributes Type

Binary

For Configurations

Throws

  • TABLEAU-SPECIALIST:CONNECTIVITY

  • TABLEAU-SPECIALIST:FORBIDDEN

  • TABLEAU-SPECIALIST:INSUFFICIENT_SITE_STORAGE_REMAINING

  • TABLEAU-SPECIALIST:PROJECT_ID_MISMATCH

  • TABLEAU-SPECIALIST:RETRY_EXHAUSTED

  • TABLEAU-SPECIALIST:TIMEOUT

  • TABLEAU-SPECIALIST:UPDATE_FORBIDDEN

  • TABLEAU-SPECIALIST:UPDATE_FORBIDDEN_PERMISSION

Sources

On New Or Modified Data Source

<tableau-specialist:new-or-modified-datasource-listener>

Initiates a flow when a data source is created or updated.

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Since

String

Date in the yyyy-MM-dd’T’HH:mm:ss’Z' format, for example, 2014-01-01T00:00:00Z. If this field is empty, this operation retrieves the selected objects from the time the Mule app is started.

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Primary Node Only

Boolean

Determines whether to execute this source on only the primary node when running Mule instances in a cluster.

Scheduling Strategy

scheduling-strategy

Configures the scheduler that triggers the polling.

x

Redelivery Policy

Redelivery Policy

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

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Object

Attributes Type

Any

For Configurations

Types

Reconnection

Configures a reconnection strategy for an operation.

Field Type Description Default Value Required

Fails Deployment

Boolean

What to do if, when an app is deployed, a connectivity test does not pass after exhausting the associated reconnection strategy:

  • true

    Allow the deployment to fail.

  • false

    Ignore the results of the connectivity test.

Reconnection Strategy

Reconnection strategy to use.

Reconnect

Configures a standard reconnection strategy, which specifies how often to reconnect and how many reconnection attempts the connector source or operation can make.

Field Type Description Default Value Required

Frequency

Number

How often to attempt to reconnect, in milliseconds.

Blocking

Boolean

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

Count

Number

How many reconnection attempts the Mule app can make.

Reconnect Forever

Configures a forever reconnection strategy by which the connector source or operation attempts to reconnect at a specified frequency for as long as the Mule app runs.

Field Type Description Default Value Required

Frequency

Number

How often to attempt to reconnect, in milliseconds.

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

Configures the maximum amount of time that a dynamic configuration instance can remain idle before Mule considers it eligible for expiration.

Time Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Max Idle Time field.

Column Definition

Field Type Description Default Value Required

Column Name

String

Name of the column.

x

Column Type

Enumeration, one of:

  • UNSUPPORTED

  • BOOL

  • BIG_INT

  • SMALL_INT

  • INT

  • NUMERIC

  • DOUBLE

  • OID

  • BYTES

  • TEXT

  • VARCHAR

  • CHAR

  • JSON

  • DATE

  • INTERVAL

  • TIME

  • TIMESTAMP

  • TIMESTAMP_TZ

  • GEOGRAPHY

x

Column Nullability

Enumeration, one of:

  • NULLABLE

  • NOT_NULLABLE

Type of the column.

x

Column Collation

String

Collation of the column.

Numeric Scale

Number

Numeric scale of the column.

Numeric Precision

Number

Numeric precision of the column.

Length

Number

Length of the column.

Proxy Configuration

Configures the settings used to connect through a proxy.

Field Type Description Default Value Required

Host

String

Hostname or IP address of the proxy server.

x

Port

Number

Port of the proxy server.

x

Username

String

Username to authenticate against the proxy server.

Password

String

Password to authenticate against the proxy server.

TLS

Configures TLS to provide secure communications for the Mule app.

Field Type Description Default Value Required

Enabled Protocols

String

Comma-separated list of protocols enabled for this context.

Enabled Cipher Suites

String

Comma-separated list of cipher suites enabled for this context.

Trust Store

Truststore

Configures the TLS truststore.

Key Store

Keystore

Configures the TLS keystore.

Revocation Check

Configures a revocation checking mechanism.

Truststore

Configures the truststore for TLS.

Field Type Description Default Value Required

Path

String

Path to the truststore. Mule resolves the path relative to the current classpath and file system, if possible.

Password

String

Password used to protect the truststore.

Type

String

Type of truststore.

Algorithm

String

Encryption algorithm that the truststore uses.

Insecure

Boolean

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

Keystore

Configures the keystore for the TLS protocol. The keystore you generate contains a private key and a public certificate.

Field Type Description Default Value Required

Path

String

Path to the keystore. Mule resolves the path relative to the current classpath and file system, if possible.

Type

String

Type of store used.

Alias

String

Alias of the key to use when the keystore contains multiple private keys. By default, Mule uses the first key in the file.

Key Password

String

Password used to protect the private key.

Password

String

Password used to protect the keystore.

Algorithm

String

Encryption algorithm that the keystore uses.

Standard Revocation Check

Configures standard revocation checks for TLS certificates.

Field Type Description Default Value Required

Only End Entities

Boolean

Which elements to verify in the certificate chain:

  • true

    Verify only the last element in the certificate chain.

  • false

    Verify all elements in the certificate chain.

Prefer Crls

Boolean

How to check certificate validity:

  • true

    Check the Certification Revocation List (CRL) for certificate validity.

  • false

    Use the Online Certificate Status Protocol (OCSP) to check certificate validity.

No Fallback

Boolean

Whether to use the secondary method to check certificate validity:

  • true

    Use the method that wasn’t specified in the Prefer Crls field (the secondary method) to check certificate validity.

  • false

    Do not use the secondary method to check certificate validity.

Soft Fail

Boolean

What to do if the revocation server can’t be reached or is busy:

  • true

    Avoid verification failure.

  • false

    Allow the verification to fail.

Custom OCSP Responder

Configures a custom OCSP responder for certification revocation checks.

Field Type Description Default Value Required

Url

String

URL of the OCSP responder.

Cert Alias

String

Alias of the signing certificate for the OCSP response. If specified, the alias must be in the truststore.

CRL File

Specifies the location of the certification revocation list (CRL) file.

Field Type Description Default Value Required

Path

String

Path to the CRL file.

Redelivery Policy

Configures the redelivery policy for executing requests that generate errors. You can add a redelivery policy to any source in a flow.

Field Type Description Default Value Required

Max Redelivery Count

Number

Maximum number of times that a redelivered request can be processed unsuccessfully before returning a REDELIVERY_EXHAUSTED error.

Message Digest Algorithm

String

Secure hashing algorithm to use if the Use Secure Hash field is true. If the payload of the message is a Java object, Mule ignores this value and returns the value that the payload’s hashCode() returned.

Message Identifier

Redelivery Policy Message Identifier

Defines which strategy is used to identify the messages.

Object Store

ObjectStore

Configures the object store that stores the redelivery counter for each message.

Redelivery Policy Message Identifier

Configures how to identify a redelivered message and how to find out when the message was redelivered.

Field Type Description Default Value Required

Use Secure Hash

Boolean

If true, Mule uses a secure hash algorithm to identify a redelivered message.

Id Expression

String

One or more expressions that determine when a message was redelivered. You can set this property only if the Use Secure Hash field is false.

Repeatable In Memory Stream

Configures the in-memory streaming strategy by which the request fails if the data exceeds the MAX buffer size. Always run performance tests to find the optimal buffer size for your specific use case.

Field Type Description Default Value Required

Initial Buffer Size

Number

Initial amount of memory to allocate to the data stream. If the streamed data exceeds this value, the buffer expands by Buffer Size Increment, with an upper limit of 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.

Max Buffer Size

Number

Maximum size of the buffer. If the buffer size exceeds this value, Mule raises a STREAM_MAXIMUM_SIZE_EXCEEDED error. A value of less than or equal to 0 means no limit.

Buffer Unit

Enumeration, one of:

  • BYTE

  • KB

  • MB

  • GB

Unit for the Initial Buffer Size, Buffer Size Increment, and Buffer Unit fields.

Repeatable File Store Stream

Configures the repeatable file-store streaming strategy by which Mule keeps a portion of the stream content in memory. If the stream content is larger than the configured buffer size, Mule backs up the buffer’s content to disk and then clears the memory.

Field Type Description Default Value Required

In Memory Size

Number

Maximum amount of memory that the stream can use for data. If the amount of memory exceeds this value, Mule buffers the content to disk. To optimize performance:

  • Configure a larger buffer size to avoid the number of times Mule needs to write the buffer on disk. This increases performance, but it also limits the number of concurrent requests your application can process, because it requires additional memory.

  • Configure a smaller buffer size to decrease memory load at the expense of response time.

Buffer Unit

Enumeration, one of:

  • BYTE

  • KB

  • MB

  • GB

Unit for the In Memory Size field.

Filter Expression

Field Type Description Default Value Required

Field Name

String

Name of the field.

x

Operator

String

Name of the operator.

x

Value

String

Name of the value.

x

Sort Expression

Field Type Description Default Value Required

Field Name

String

Name of the field.

x

Direction

Enumeration, one of:

  • ASC

  • DESC

Type of direction.

x

Repeatable In Memory Iterable

Field Type Description Default Value Required

Initial Buffer Size

Number

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 Buffer Size Increment field, with an upper limit of Max In Memory Size.

100

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.

100

Max Buffer Size

Number

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

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

Unit for the In Memory Objects field.

Publish Workbook Request Body

Field Type Description Default Value Required

Workbook File Content

Binary

File content of the workbook.

Workbook Attributes

Binary

Attributes of the workbook.

#[payload]

Workbook File Name

String

File name of the workbook.

Publish Workbook Request Session Id

Field Type Description Default Value Required

Upload Session Id

String

Upload session ID for Publish workbook.

Workbook Attributes

Binary

Attributes of the workbook.

#[payload]

Workbook File Type

Enumeration, one of:

  • TWB

  • TWBX

File type of the workbook.

Publish Datasource Request Body

Field Type Description Default Value Required

Datasource File Content

Binary

File content of the datasource.

Datasource Attributes

Binary

Attributes of the datasource.

#[payload]

Datasource File Name

String

File name of the datasource.

Publish Datasource Request Session Id

Field Type Description Default Value Required

Upload Session Id

String

Upload session ID for Publish datasource.

Datasource Attributes

Binary

Attributes of the datasource.

#[payload]

Datasource File Type

Enumeration, one of:

  • HYPER

  • TDS

  • TDSX

  • TDE

File type of the datasource.

See Also

Back to top
View on GitHub