# mulesoft Zuora AQuA Connector - Full Documentation

<!-- document id=ee659c94a8673d24c6f62e8bb1f3cf8ca688630be8a972c62bc20e4058b5e075 url=/mulesoft/current/en-us/zuora-aqua-connector/latest/index.md -->

---
product: Zuora AQuA Connector
version: 1.0
is-latest-version: true
---

# Zuora AQuA Connector

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

Zuora AQuA Connector v1.0.0

Anypoint Connector for Zuora AQuA (Zuora AQuA Connector) is a smart connector that is generated
using REST Connect 2.0. Zuora AQuA Connector enables you to connect to the Zuora platform and use
all the operations provided by the Zuora AQuA API, including:

- Creating a batch query

- Deleting batch query jobs by ID

- Retrieving an aggregate query using the job ID

- Retrieving batch query jobs partner project by partner project ID

- Retrieving a file by the file ID

For information about the Zuora AQuA API methods and parameters, see the Zuora AQuA API
Documentation.

## About Connectors

Anypoint connectors are Mule runtime engine (Mule) extensions that enable you to connect to APIs and
resources on external systems, such as Salesforce, Zuora AQuA, ServiceNow, and Twitter.

## Before You Begin

To use the Zuora AQuA connector, you must be familiar with Zuora AQuA, Mule, Anypoint Connectors,
Anypoint Studio, Mule concepts, elements in a Mule flow, and Global Elements.

Before creating an app, you must have access to the Zuora AQuA target resource and Anypoint
Platform. You must also understand how to create a Mule app using Anypoint Studio.

## Next Step

After you have read this topic, you are ready to create an app with
[Anypoint Studio](https://docs.mulesoft.com/zuora-aqua-connector/latest/zuora-aqua-connector-studio).

## See Also

- [Zuora AQuA connector in Anypoint Exchange](https://www.mulesoft.com/exchange/com.mulesoft.connectors/mule-zuora-aqua-connector/)

- [Zuora AQuA Release Notes](https://docs.mulesoft.com/release-notes/connector/zuora-aqua-release-notes-mule-4)

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

- [REST Connect Connector Generator](https://docs.mulesoft.com/exchange/to-deploy-using-rest-connect)

<!-- document id=99da0aab98ec43cf87795a022d8044dfb5ecc47e6adbdb4dd8bf452636a7fafd url=/mulesoft/current/en-us/zuora-aqua-connector/latest/zuora-aqua-connector-reference.md -->

---
product: Zuora AQuA Connector
version: 1.0
is-latest-version: true
---

# Zuora Aqua Connector Reference

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

Support Version: Select

Zuora AQuA Connector v1.0.0

## Configurations

---

### Config

#### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Name</p></td><td><p>String</p></td><td><p>The name for this configuration. Connectors reference the configuration with this name.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Connection</p></td><td><div><div><p><a href="#Config_Basic">Basic Connection Provider</a></p></div></div></td><td><p>The connection types to provide to this configuration.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td><p><code>1</code></p></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>A time unit that qualifies the response timeout</p></td><td><p><code>MINUTES</code></p></td><td></td></tr><tr><td><p>Name</p></td><td><div><div><p>String</p></div></div></td><td><p>The identifier of this element used to reference it in other components</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Expiration Policy</p></td><td><div><div><p><a href="#ExpirationPolicy">Expiration Policy</a></p></div></div></td><td><p>Configures the minimum amount of time that a dynamic configuration instance can remain idle before it is eligible for expiration. This does not mean that the instance expires at the exact moment that it becomes eligible. Mule purges the instances when appropriate.</p></td><td></td><td></td></tr></tbody></table>

#### Connection Types

##### Basic Connection Provider

###### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Default Headers</p></td><td><div><div><p>Array of <a href="#DefaultHeader">Default Header</a></p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Query Parameters</p></td><td><div><div><p>Array of <a href="#DefaultQueryParam">Default Query Param</a></p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Connection Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for establishing connections to the remote service</p></td><td><p><code>30</code></p></td><td></td></tr><tr><td><p>Connection Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>A time unit that qualifies the connection timeout</p></td><td><p><code>SECONDS</code></p></td><td></td></tr><tr><td><p>Use Persistent Connections</p></td><td><div><div><p>Boolean</p></div></div></td><td><p>If <code>false</code>, each connection will be closed after the first request is completed.</p></td><td><p><code>true</code></p></td><td></td></tr><tr><td><p>Max Connections</p></td><td><div><div><p>Number</p></div></div></td><td><p>The maximum number of outbound connections kept open at the same time</p></td><td><p><code>-1</code></p></td><td></td></tr><tr><td><p>Connection Idle Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>A timeout for how long a connection can remain idle before it is closed</p></td><td><p><code>30</code></p></td><td></td></tr><tr><td><p>Connection Idle Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>A time unit that qualifies the connection idle timeout</p></td><td><p>SECONDS</p></td><td></td></tr><tr><td><p>Proxy Config</p></td><td><div><div><p><a href="#Proxy">Proxy</a></p></div></div></td><td><p>Reusable configuration element for outbound connections through a proxy</p></td><td></td><td></td></tr><tr><td><p>Stream Response</p></td><td><div><div><p>Boolean</p></div></div></td><td><p>Whether or not to stream the received responses</p></td><td><p><code>false</code></p></td><td></td></tr><tr><td><p>Response Buffer Size</p></td><td><div><div><p>Number</p></div></div></td><td><p>The space (in bytes) for the buffer where the HTTP response will be stored.</p></td><td><p><code>-1</code></p></td><td></td></tr><tr><td><p>Username</p></td><td><div><div><p>String</p></div></div></td><td><p>The username to authenticate the requests</p></td><td></td><td></td></tr><tr><td><p>Password</p></td><td><div><div><p>String</p></div></div></td><td><p>The password to authenticate the requests</p></td><td></td><td></td></tr><tr><td><p>Base Uri</p></td><td><div><div><p>String</p></div></div></td><td><p>Parameter base URI, each instance or tenant gets its own</p></td><td><p><code>https://rest.apisandbox.zuora.com:443</code></p></td><td></td></tr><tr><td><p>TLS Configuration</p></td><td><div><div><p><a href="#Tls">Tls</a></p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Reconnection</p></td><td><div><div><p><a href="#Reconnection">Reconnection</a></p></div></div></td><td><p>When the application is deployed, a connectivity test is performed on all connectors. If set to <code>true</code>, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy.</p></td><td></td><td></td></tr></tbody></table>

## Operations

- [Post Query or Export Deleted Data](#CreateV1BatchQuery)

- [Delete a Running Job](#DeleteV1BatchQueryJobsById)

- [Get Job Results](#GetV1BatchQueryJobsById)

- [Get Last Job Completed](#GetV1BatchQueryJobsPartnerProjectByPartnerProject)

- [Get Results Files](#GetV1FileByFileId)

## Sources

- [Batch JobResponse Result Listener](#BatchJobResultListener)

> [!NOTE] This source (listener) uses Object Store to save watermarks. You might experience
> limitations that are specific to the Object Store implementation you are using (Object Store for
> CloudHub deployments or Object Store for on-premises deployments), so configure Object Store to
> suit your needs.  
> For more information, see
> [The Different Types of Object Stores Explained](https://help.salesforce.com/s/articleView?id=001123185&type=1).

## Post Query or Export Deleted Data

`<mule-zuora-aqua-connector:create-v1-batch-query>`

This operation makes an HTTP POST request to the `/v1/batch-query/` endpoint.

The POST query is used for:

- Export deleted data

- Post query with API version

- Post query with notification

- Post query with retrieval time

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Zuora Entity Ids</p></td><td><div><div><p>String</p></div></div></td><td><p>An entity ID. If you have Zuora Multi-entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is valid only for a single entity, or you do not have Zuora multi-entity enabled, you do not need to set this header.</p></td><td></td><td></td></tr><tr><td><p>Content</p></td><td><div><div><p>Binary</p></div></div></td><td><p>The content to use</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>The name of the configuration to use to execute this component.</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configure to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>A time unit that qualifies the response timeout.</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>The name of a variable to store the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>An expression to evaluate against the operation’s output and store the expression outcome in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors.</p></td><td></td><td></td></tr></tbody></table>

### Output

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

### For Configurations

- [Config](#Config)

### Throws

- MULE-ZUORA-AQUA-CONNECTOR:BAD\_REQUEST

- MULE-ZUORA-AQUA-CONNECTOR:CLIENT\_ERROR

- MULE-ZUORA-AQUA-CONNECTOR:CONNECTIVITY

- MULE-ZUORA-AQUA-CONNECTOR:INTERNAL\_SERVER\_ERROR

- MULE-ZUORA-AQUA-CONNECTOR:NOT\_ACCEPTABLE

- MULE-ZUORA-AQUA-CONNECTOR:NOT\_FOUND

- MULE-ZUORA-AQUA-CONNECTOR:RETRY\_EXHAUSTED

- MULE-ZUORA-AQUA-CONNECTOR:SERVER\_ERROR

- MULE-ZUORA-AQUA-CONNECTOR:SERVICE\_UNAVAILABLE

- MULE-ZUORA-AQUA-CONNECTOR:TIMEOUT

- MULE-ZUORA-AQUA-CONNECTOR:TOO\_MANY\_REQUESTS

- MULE-ZUORA-AQUA-CONNECTOR:UNAUTHORIZED

- MULE-ZUORA-AQUA-CONNECTOR:UNSUPPORTED\_MEDIA\_TYPE

## Delete a Running Job

`<mule-zuora-aqua-connector:delete-v1-batch-query-jobs-by-id>`

This REST API deletes the current job if the job is not complete. If the job is complete, an error
is thrown. This operation makes an HTTP DELETE request to the `/v1/batch-query/jobs/{id}` endpoint.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the job.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Zuora Entity Ids</p></td><td><div><div><p>String</p></div></div></td><td><p>An entity ID. If you have Zuora Multi-entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is valid only for a single entity, or you do not have Zuora multi-entity enabled, you do not need to set this header.</p></td><td></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>The name of the configuration to use to execute this component</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configure to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>A time unit that qualifies the response timeout</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>The name of a variable to store the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>An expression to evaluate against the operation’s output and store the expression outcome in the target variable</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Config](#Config)

### Throws

- MULE-ZUORA-AQUA-CONNECTOR:BAD\_REQUEST

- MULE-ZUORA-AQUA-CONNECTOR:CLIENT\_ERROR

- MULE-ZUORA-AQUA-CONNECTOR:CONNECTIVITY

- MULE-ZUORA-AQUA-CONNECTOR:INTERNAL\_SERVER\_ERROR

- MULE-ZUORA-AQUA-CONNECTOR:NOT\_ACCEPTABLE

- MULE-ZUORA-AQUA-CONNECTOR:NOT\_FOUND

- MULE-ZUORA-AQUA-CONNECTOR:RETRY\_EXHAUSTED

- MULE-ZUORA-AQUA-CONNECTOR:SERVER\_ERROR

- MULE-ZUORA-AQUA-CONNECTOR:SERVICE\_UNAVAILABLE

- MULE-ZUORA-AQUA-CONNECTOR:TIMEOUT

- MULE-ZUORA-AQUA-CONNECTOR:TOO\_MANY\_REQUESTS

- MULE-ZUORA-AQUA-CONNECTOR:UNAUTHORIZED

- MULE-ZUORA-AQUA-CONNECTOR:UNSUPPORTED\_MEDIA\_TYPE

## Get Job Results

`<mule-zuora-aqua-connector:get-v1-batch-query-jobs-by-id>`

Retrieves an aggregate query using the Job ID. This operation makes an HTTP GET request to the
/v1/batch-query/jobs/{id} endpoint

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>id</p></td><td><div><div><p>String</p></div></div></td><td><p>The ID of the job.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Zuora Entity Ids</p></td><td><div><div><p>String</p></div></div></td><td><p>An entity ID. If you have Zuora Multi-entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is valid only for a single entity, or you do not have Zuora multi-entity enabled, you do not need to set this header.</p></td><td></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>The name of the configuration to use to execute this component</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configure to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>A time unit which qualifies the Response Timeout}</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>The name of a variable to store the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>An expression to evaluate against the operation’s output and store the expression outcome in the target variable</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Config](#Config)

### Throws

- MULE-ZUORA-AQUA-CONNECTOR:BAD\_REQUEST

- MULE-ZUORA-AQUA-CONNECTOR:CLIENT\_ERROR

- MULE-ZUORA-AQUA-CONNECTOR:CONNECTIVITY

- MULE-ZUORA-AQUA-CONNECTOR:INTERNAL\_SERVER\_ERROR

- MULE-ZUORA-AQUA-CONNECTOR:NOT\_ACCEPTABLE

- MULE-ZUORA-AQUA-CONNECTOR:NOT\_FOUND

- MULE-ZUORA-AQUA-CONNECTOR:RETRY\_EXHAUSTED

- MULE-ZUORA-AQUA-CONNECTOR:SERVER\_ERROR

- MULE-ZUORA-AQUA-CONNECTOR:SERVICE\_UNAVAILABLE

- MULE-ZUORA-AQUA-CONNECTOR:TIMEOUT

- MULE-ZUORA-AQUA-CONNECTOR:TOO\_MANY\_REQUESTS

- MULE-ZUORA-AQUA-CONNECTOR:UNAUTHORIZED

- MULE-ZUORA-AQUA-CONNECTOR:UNSUPPORTED\_MEDIA\_TYPE

## Get Last Job Completed

`<mule-zuora-aqua-connector:get-v1-batch-query-jobs-partner-project-by-partner-project>`

Returns the details of the last completed job. This operation makes an HTTP GET request to the
/v1/batch-query/jobs/partner/{partner}/project/{project} endpoint

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>partner</p></td><td><div><div><p>String</p></div></div></td><td><p>The partner field indicates the unique ID of a data integration partner.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>project</p></td><td><div><div><p>String</p></div></div></td><td><p>The project field contains the unique ID of a data integration project for a particular partner.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Zuora Entity Ids</p></td><td><div><div><p>String</p></div></div></td><td><p>An entity ID. If you have Zuora Multi-entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.</p></td><td></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>The name of the configuration to use to execute this component</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configure to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>A time unit which qualifies the Response Timeout}</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>The name of a variable to store the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>An expression to evaluate against the operation’s output and store the expression outcome in the target variable</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Config](#Config)

### Throws

- MULE-ZUORA-AQUA-CONNECTOR:BAD\_REQUEST

- MULE-ZUORA-AQUA-CONNECTOR:CLIENT\_ERROR

- MULE-ZUORA-AQUA-CONNECTOR:CONNECTIVITY

- MULE-ZUORA-AQUA-CONNECTOR:INTERNAL\_SERVER\_ERROR

- MULE-ZUORA-AQUA-CONNECTOR:NOT\_ACCEPTABLE

- MULE-ZUORA-AQUA-CONNECTOR:NOT\_FOUND

- MULE-ZUORA-AQUA-CONNECTOR:RETRY\_EXHAUSTED

- MULE-ZUORA-AQUA-CONNECTOR:SERVER\_ERROR

- MULE-ZUORA-AQUA-CONNECTOR:SERVICE\_UNAVAILABLE

- MULE-ZUORA-AQUA-CONNECTOR:TIMEOUT

- MULE-ZUORA-AQUA-CONNECTOR:TOO\_MANY\_REQUESTS

- MULE-ZUORA-AQUA-CONNECTOR:UNAUTHORIZED

- MULE-ZUORA-AQUA-CONNECTOR:UNSUPPORTED\_MEDIA\_TYPE

## Get Results Files

`<mule-zuora-aqua-connector:get-v1-file-by-file-id>`

This REST API retrieves the results in the specified file format. The AQuA results files are purged
after 7 days. This operation makes an HTTP GET request to the /v1/file/{file-id} endpoint

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>File id</p></td><td><div><div><p>String</p></div></div></td><td><p>The Zuora ID of the file to retrieve.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Zuora Entity Ids</p></td><td><div><div><p>String</p></div></div></td><td><p>An entity ID. If you have Zuora Multi-entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.</p></td><td></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>The name of the configuration to use to execute this component</p></td><td></td><td></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configure to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Custom Query Parameters</p></td><td><div><div><p>Object</p></div></div></td><td></td><td><p>#[null]</p></td><td></td></tr><tr><td><p>Custom Headers</p></td><td><div><div><p>Object</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Response Timeout</p></td><td><div><div><p>Number</p></div></div></td><td><p>The timeout for request to the remote service.</p></td><td></td><td></td></tr><tr><td><p>Response Timeout Unit</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><p>A time unit which qualifies the Response Timeout}</p></td><td></td><td></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>The name of a variable to store the operation’s output.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>An expression to evaluate against the operation’s output and store the expression outcome in the target variable</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p><a href="#HttpResponseAttributes">Http Response Attributes</a></p></div></div></td></tr></tbody></table>

### For Configurations

- [Config](#Config)

### Throws

- MULE-ZUORA-AQUA-CONNECTOR:BAD\_REQUEST

- MULE-ZUORA-AQUA-CONNECTOR:CLIENT\_ERROR

- MULE-ZUORA-AQUA-CONNECTOR:CONNECTIVITY

- MULE-ZUORA-AQUA-CONNECTOR:INTERNAL\_SERVER\_ERROR

- MULE-ZUORA-AQUA-CONNECTOR:NOT\_ACCEPTABLE

- MULE-ZUORA-AQUA-CONNECTOR:NOT\_FOUND

- MULE-ZUORA-AQUA-CONNECTOR:RETRY\_EXHAUSTED

- MULE-ZUORA-AQUA-CONNECTOR:SERVER\_ERROR

- MULE-ZUORA-AQUA-CONNECTOR:SERVICE\_UNAVAILABLE

- MULE-ZUORA-AQUA-CONNECTOR:TIMEOUT

- MULE-ZUORA-AQUA-CONNECTOR:TOO\_MANY\_REQUESTS

- MULE-ZUORA-AQUA-CONNECTOR:UNAUTHORIZED

- MULE-ZUORA-AQUA-CONNECTOR:UNSUPPORTED\_MEDIA\_TYPE

## Sources

## Batch JobResponse Result Listener

`<mule-zuora-aqua-connector:batch-job-result-listener>`

Periodically polls for the status of the jobs retrieved from the given object store (filled from
PostQuery operation) and returns the results of the jobs with the expected status. This source works
ONLY with jobs sent using the PostQuery operation.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>The name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Object Store Name</p></td><td><div><div><p>String</p></div></div></td><td><p>The name of the objectStore that holds the JobId’s from the PostQuery results.</p></td><td></td><td></td></tr><tr><td><p>Entity Parameters</p></td><td><div><div><p><a href="#EntityParametersGroup">Entity Parameters Group</a></p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Expected Status</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>PENDING</p></li><li><p>EXECUTING</p></li><li><p>COMPLETED</p></li><li><p>ABORTED</p></li><li><p>CANCELLED</p></li><li><p>SUBMITTED</p></li><li><p>ERROR</p></li></ul></div></div></td><td><p>The expected status of the job to be retrieved.</p></td><td><p>COMPLETED</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>The name of the configuration to use to execute this component</p></td><td></td><td></td></tr><tr><td><p>Primary Node Only</p></td><td><div><div><p>Boolean</p></div></div></td><td><p>Whether this source should only be executed on the primary node when running in Cluster</p></td><td></td><td></td></tr><tr><td><p>Scheduling Strategy</p></td><td><div><div><p>scheduling-strategy</p></div></div></td><td><p>Configures the scheduler that triggers the polling</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#RepeatableInMemoryStream">Repeatable In Memory Stream</a></p></li><li><p><a href="#RepeatableFileStoreStream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configure to use repeatable streams.</p></td><td></td><td></td></tr><tr><td><p>Redelivery Policy</p></td><td><div><div><p><a href="#RedeliveryPolicy">Redelivery Policy</a></p></div></div></td><td><p>Defines a policy for processing the redelivery of the same message</p></td><td></td><td></td></tr><tr><td><p>Reconnection Strategy</p></td><td><div><div><ul><li><p><a href="#Reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>A retry strategy in case of connectivity errors</p></td><td></td><td></td></tr></tbody></table>

### Output

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

### For Configurations

- [Config](#Config)

## Types

### Default Header

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Key</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Value</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr></tbody></table>

### Default Query Param

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Key</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Value</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr></tbody></table>

### Proxy

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Host</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Port</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Username</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Password</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Non Proxy Hosts</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Tls

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

### Trust Store

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Path</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The location (which will be resolved relative to the current classpath and file system, if possible) of the trust store.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Password</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The password used to protect the trust store.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Type</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The type of store used.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Algorithm</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>The algorithm used by the trust store.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Insecure</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>If true, no certificate validations will be performed, rendering connections vulnerable to attacks. Use at your own risk.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Key Store

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

### Standard Revocation Check

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

### Custom Ocsp Responder

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

### Crl File

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

### Reconnection

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

### Reconnect

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

### Reconnect Forever

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

### Expiration Policy

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

### Entity Parameters Group

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Entity Id</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>An optional parameter if the Zuora customer has multiple entities (either entityId or entityName must be specified).</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Entity Name</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>An optional parameter if the Zuora customer has multiple entities (either entityId or entityName must be specified).</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Repeatable In Memory Stream

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Initial Buffer Size</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>The amount of memory to allocate to consume the stream and provide random access to it. If the stream contains more data than fits into this buffer, then the buffer expands according to the <strong>Buffer size increment</strong> attribute, with an upper limit of <strong>Max in memory size</strong>.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Buffer Size Increment</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>This specifies 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, and that a <code>STREAM_MAXIMUM_SIZE_EXCEEDED</code> error is raised when the buffer gets full.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Max Buffer Size</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>The maximum amount of memory to use. If more than that is used then a <code>STREAM_MAXIMUM_SIZE_EXCEEDED</code> error is raised. A value lower than or equal to zero means no limit.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Buffer Unit</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>BYTE</p></li><li><p>KB</p></li><li><p>MB</p></li><li><p>GB</p></li></ul></div></div></td><td><div><div><p>The unit in which all these attributes are expressed</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Repeatable File Store Stream

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

### Redelivery Policy

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

### Redelivery Policy Message Identifier

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

### Http Response Attributes

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Status Code</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Headers</strong></p></td><td><div><div><p>Object</p></div></div></td><td><div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr><tr><td><p><strong>Reason Phrase</strong></p></td><td><div><div><p>String</p></div></div></td><td><div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr></tbody></table>

<!-- document id=984651074d19a443ec2cdd79ccdf6fbf575d6d6d074dbb0160f70d5e3149d561 url=/mulesoft/current/en-us/zuora-aqua-connector/latest/zuora-aqua-connector-studio.md -->

---
product: Zuora AQuA Connector
version: 1.0
is-latest-version: true
---

# Zuora AQuA Connector Studio Configuration

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

To configure a connector in Anypoint Studio, follow this process:

1.  Add the connector to your Mule project.

2.  Configure the connector.

3.  Configure an input source for the connector.

## Add the Connector to Your project

Anypoint Studio provides two ways to add the connector to your Mule project:

- From the Exchange button in the Studio taskbar

- From the Mule Palette view

### Add the Connector Using Exchange

1.  In Studio, create a Mule Project.

2.  Click the Exchange **(X)** icon in the upper-left of the Studio task bar.

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

4.  In Exchange, search for **Zuora AQuA**.

5.  Select the connector and click **Add to project**.

6.  Follow the prompts to install the connector.

### Add the Connector in Studio

1.  In Studio, create a Mule project.

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

3.  In **Add Modules to Project**, type "Zuora AQuA" in the search field.

4.  Click this connector’s name in **Available modules**.

5.  Click **Add**.

6.  Click **Finish**.

## Configure an Input Source

Configure an input source for the connector, such as an operation for this connector, **HTTP
Listener**, or **Scheduler**.

## Configure the Connector

To configure this connector:

1.  Drag a connector operation into the Studio canvas.

2.  To create a global element for the connector, set these fields:

    - **Username**: Zuora username

    - **Password**: Zuora password

    - **Base Uri**: Base path of the AQuA API for your instance. For example:  
      `[https://rest.apisandbox.zuora.com:443/](https://rest.apisandbox.zuora.com:443/)`

      ![Global element properties window for Basic authentication](/mulesoft/current/en-us/zuora-aqua-connector/latest/_images/zuora-aqua-basic-auth-studio.png)

## Next Step

After configuring this connector in Studio, see the
[Zuora AQuA Examples](https://docs.mulesoft.com/zuora-aqua-connector/latest/zuora-aqua-connector-examples) section to experiment with the Zuora AQuA
connector.

## See Also

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

<!-- document id=a7d8a371dd6a07e1aaea6b0fa64b19850530d29188a29890ebaa5ccb568609a4 url=/mulesoft/current/en-us/zuora-aqua-connector/latest/zuora-aqua-connector-examples.md -->

---
product: Zuora AQuA Connector
version: 1.0
is-latest-version: true
---

# Zuora AQuA Examples

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

## Example: Retrieve Details for an Account

This example retrieves the account details for the specified account ID and returns them in JSON
format.

## Studio Flows

- HTTP **Listener**  
  Accepts data from HTTP requests.

- **Get last job completed**  
  Anypoint Connector for Zuora AQuA connects with Zuora and executes a query to retrieve the account
  details for the specified account ID. Add the **Get last job completed** operation to return the
  details of the last completed job.

- **Transform Message**  
  Outputs the results of the **Get last job completed** operation in JSON format.

  ![Studio flow with Listener, Get last job completed, and Transform Message](/mulesoft/current/en-us/zuora-aqua-connector/latest/_images/zuora-aqua-studio-use-case.png)

## XML Flows

Paste this XML code into Anypoint Studio to experiment with the example flow.

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

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

	<mule-zuora-aqua-connector:config name="Zuora_Connector_Config" doc:name="Zuora Connector Config" doc:id="47cc7910-f0dd-418e-87b0-a3e2e32469f3" >
		<mule-zuora-aqua-connector:basic-connection username="${config.username}" password="${config.password}" baseUri="${config.baseUri}"/>
	</mule-zuora-aqua-connector:config>

	<http:listener-config name="HTTP_Listener_config" doc:name="HTTP Listener config" doc:id="2b371bd6-fa5e-4980-bdf4-e3edd7127d51">
		<http:listener-connection host="0.0.0.0" port="8081" />
	</http:listener-config>

	<configuration-properties doc:name="Configuration properties" doc:id="369942a7-1ad3-495d-b926-0efd29f3dfcc" file="application.properties" />

	<flow name="aqua-api-get-last-completed-job-demo-flow" doc:id="7396ef55-2a5b-44c9-9b5d-7adc7360cba6" >
		<http:listener doc:name="Listener" doc:id="54613a79-d327-41e8-bb3c-75f6f59acae4" config-ref="HTTP_Listener_config" path="/get-last-completed-job"/>
		<mule-zuora-aqua-connector:get-v1-batch-query-jobs-partner-project-by-partner-project doc:name="Get last job completed" doc:id="40c9467e-4b06-4781-b9e7-dcf34837d8f7" project="#[payload.project]" config-ref="Zuora_Connector_Config" partner="#[payload.partner]"/>
		<ee:transform doc:name="Transform Message" doc:id="5a72b67b-9a1c-4f4e-897c-07fa42a698ef" >
			<ee:message >
				<ee:set-payload ><![CDATA[%dw 2.0
output application/json
---
{
}]]></ee:set-payload>
			</ee:message>
		</ee:transform>
	</flow>
</mule>
```

## See Also

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

<!-- document id=952317751504197f42e52cd23140c49a014663b32063f06c29458a2832e0ec06 url=/mulesoft/current/en-us/zuora-aqua-connector/latest/zuora-aqua-connector-xml-maven.md -->

---
product: Zuora AQuA Connector
version: 1.0
is-latest-version: true
---

# Zuora AQuA XML and Maven Support

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

If you manually code a Mule app in XML, either from the Anypoint Studio XML editor or from a text
editor, you can access the connector in your app by adding reference statements to your XML Mule
flow and in the Apache Maven POM file.

> [!NOTE] You can avoid the manual process described in this topic by using Studio. When you install
> the connector in Studio, it automatically populates the XML code with the connector’s namespace
> and schema location, and adds a dependency to the POM file.

## Add a Namespace for the Connector

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

```text
xsi:schemaLocation="
...
http://www.mulesoft.org/schema/mule/zuora-aqua-connector
http://www.mulesoft.org/schema/mule/zuora-aqua-connector/current/mule-zuora-aqua-connector.xsd"
```

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

```xml
<mule xmlns:http="http://www.mulesoft.org/schema/mule/http"
      xmlns:mule-zuora-aqua-connector="http://www.mulesoft.org/schema/mule/mule-zuora-aqua-connector"
	    xmlns="http://www.mulesoft.org/schema/mule/core"
	    xmlns:doc="http://www.mulesoft.org/schema/mule/documentation"
      xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
      xsi:schemaLocation="
               http://www.mulesoft.org/schema/mule/core
               http://www.mulesoft.org/schema/mule/core/current/mule.xsd
               http://www.mulesoft.org/schema/mule/mule-zuora-aqua-connector
               http://www.mulesoft.org/schema/ mule/mule-zuora-aqua-connector/current/mule-mule-zuora-aqua-connector.xsd
               http://www.mulesoft.org/schema/mule/http http://www.mulesoft.org/schema/mule/http/current/mule-http.xsd">
      <!-- Insert your configuration elements and your flow here -->
</mule>
```

## Add a POM File Dependency

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

```xml
<dependency>
  <groupId>com.mulesoft.connectors</groupId>
  <artifactId>mule-zuora-aqua-connector</artifactId>
  <version>x.x.x</version>
  <classifier>mule-plugin</classifier>
</dependency>
```

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

To obtain the most up-to-date `pom.xml` file information, access the connector in
[Anypoint Exchange](https://www.mulesoft.com/exchange/) and click **Dependency Snippets**.

## Next Step

After completing this section, you can try the [Zuora Examples](https://docs.mulesoft.com/zuora-aqua-connector/latest/zuora-aqua-connector-examples).

## See Also

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