# mulesoft CloudHub Connector - Full Documentation

<!-- document id=fad71c2365e854b7d8d64484e3a4b40176ea09866272ab1162e570ce9916eb0e url=/mulesoft/current/en-us/cloudhub-connector/latest/index.md -->

---
product: CloudHub Connector
version: 1.2
is-latest-version: true
---

# CloudHub Connector 1.2

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

Anypoint Connector for CloudHub (CloudHub Connector) enables you to connect to the CloudHub API from
your Mule application.

For information about compatibility and fixed issues, see the
[CloudHub Connector Release Notes](https://docs.mulesoft.com/release-notes/connector/cloudhub-connector-release-notes-mule-4).

> [!NOTE] CloudHub Connector is supported only on CloudHub 1.0. CloudHub Connector isn’t supported
> on CloudHub 2.0 or Runtime Fabric. For more information about feature comparison, see
> [Features of CloudHub 2.0](https://docs.mulesoft.com/cloudhub-2/ch2-features).

## Create the CloudHub Configuration

CloudHub Connector connections use the following authentication types:

- Basic Authentication  
  Uses a username and password for authentication

- OAuth Client Credentials  
  Delegates user authentication to the service hosting the user account

The basic CloudHub configuration has the following properties:

- Connection Provider  
  One of the authentication types (Basic Authentication or OAuth Client Credentials)

- Credentials  
  Depending on the authentication type selected, you must specify your username and password or
  client ID and client secret.

- Environment  
  The CloudHub environment to use. By default this is the environment defined as the default in
  Anypoint Platform.

CloudHub Configuration using Basic Authentication example:

```xml
<cloudhub:config name="CloudHub_Config_Basic_Auth" >
  <cloudhub:connection username="${ch.username}" password="${ch.password}" />
</cloudhub:config>
```

CloudHub Configuration using OAuth Client Credentials Authentication example:

```xml
<cloudhub:config name="CloudHub_Config_OAuth_Client_Credentials" >
  <cloudhub:oauth-client-credentials-connection clientId="${ch.clientId}" clientSecret="${ch.clientSecret}" />
</cloudhub:config>
```

## POM File Information

If you create your app outside of Anypoint Studio, update your POM file as follows:

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

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

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

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

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

3.  In Exchange, search for `cloudhub`.

4.  Click **Dependency Snippets**.

## List Available Environments

After the credentials are configured correctly, you can retrieve the available environments for
easier configuration.

![Available Environments](/mulesoft/current/en-us/cloudhub-connector/latest/_images/cloudhub-environments-value-provider.gif)

CloudHub Connector is sometimes unable to fetch the available environments from the `/account` API
endpoint, resulting in an empty dropdown list. If you are using the **OAuth Client Credentials**
connection type, the **Environment** field is optional so an empty dropdown list should not cause
any issues.

> [!NOTE] The dropdown list will be populated with those environments belonging to the main business
> group of the configured credential’s user. To use an environment from a child business group, that
> the same user has access to, manually specify its ID on either this field or corresponding XML
> attribute.

## Use the CloudHub Environment

To specify the app deployment environment, use the [`environment.id`](#environment.id-sysprop)
system property.

Using the deployment environment

```xml
<cloudhub:config name="CloudHub_Config" >
  <cloudhub:connection
  username="${ch.username}"
  password="${ch.password}"
  environment="${environment.id}"/>
</cloudhub:config>
```

## Creating a Notification

To create a notification, the user must have the Runtime Manager `Read application` permission for
the specified environment.

For information about assigning permissions to users, see
[Granting Permissions and Roles to Users](https://docs.mulesoft.com/access-management/users#granting-permissions-and-roles-to-users).

To create a notification, use the Create Notification operation. This operation requires the
notification message and the associated domain. You can specify the domain using the
[`domain`](#domain-sysprop) system property.

You can also configure:

- **Custom properties**

  An open object to provide additional information about the created notification

- **Priority**

  Specify the priority of the notification:

  - ERROR

  - INFO

  - WARN

- Transaction ID

  The transaction ID associated with the created notification

```xml
<flow name="cloudhub-connector-flows" >
  <cloudhub:create-notification domain="some-application-name" config-ref="CloudHub_Config"
  transactionId="#[uuid()]" priority="WARN">
   <cloudhub:message >
     <![CDATA[#["Problem occurred trying to process customer data"]]]>
   </cloudhub:message>
   <cloudhub:custom-properties >
     <![CDATA[#[output application/java
---
{
 "customer-id" : "ASD-123",
 "date" : now()
}]]]></cloudhub:custom-properties>
  </cloudhub:create-notification>
 </flow>
```

![Creating a Notification](/mulesoft/current/en-us/cloudhub-connector/latest/_images/cloudhub-create-notification.png)

Figure 1. Configuring in Studio

## List Notifications

To consume notifications, use the List Notifications operation.

This operation requires only that you specify the domain from which to retrieve notifications. You
can specify the domain using the [`domain`](#domain-sysprop) system property.

You can also configure:

- Limit

  Specifies the number of notifications to retrieve (default `-1`, which indicates all available
  notifications)

- Status

  Filters the notifications to retrieve as unread, read, or all (default `unread`, which retrieves
  only notifications marked as unread

- Search

  Retrieves only notifications that contain the specified text

```xml
<cloudhub:list-notifications config-ref="CloudHub_Config" domain="some-application-name"/>
```

![Listing Notifications](/mulesoft/current/en-us/cloudhub-connector/latest/_images/cloudhub-list-notifications.png)

Figure 2. Configuring in Studio

This operation returns a list of notifications with the following structure:

```yaml
Notification:
  type: object
  properties:
    id: string
    domain: string
    priority?: string
    read: boolean
    readOn?: datetime
    createdAt: datetime
    href: string
    properties: object
```

## Mark a Notification as Read

Use the Mark Notification operation to mark the notification as read.

After a notification is consumed, mark a notification as read so that the next time notifications
are read, only the unread ones are retrieved.

The Mark Notification operation requires only the notification ID, which you can obtain from the
`id` property of a [Notification object](#notification-object).

Example of marking notifications as read

```xml
<cloudhub:list-notifications config-ref="CloudHub_Config" domain="some-application-name"/>
<foreach>
  <cloudhub:mark-notification markAs="READ" config-ref="CloudHub_Config" notificationId="#[payload.id]"/>
</foreach>
```

## List Applications

Using the connector, you can retrieve all available applications in the given environment. No
configuration is required.

```xml
<cloudhub:list-applications config-ref="CloudHub_Config"/>
```

You can customize how information is retrieved to get less or more information about the
applications.

## Retrieve an Application

The connector retrieves information about an application’s deployment. The only required
configuration is to specify the domain and the application name. You can specify the domain using
the [`domain`](#domain-sysprop) system property.

```xml
<cloudhub:get-application domain="some-application-name" config-ref="CloudHub_Config"/>
```

This operation returns all information about the application deployment.

## Useful CloudHub System Properties

<table><colgroup><col> <col> <col></colgroup><thead><tr><th>Name</th><th>Information</th><th>Usage</th></tr></thead><tbody><tr><td><p><a id="domain-sysprop"></a>Domain</p></td><td><p>The name of the domain where the application is deployed in CloudHub.</p></td><td><p>${domain}</p></td></tr><tr><td><p><a id="environment.id-sysprop"></a>Environment</p></td><td><p>The ID of the environment where the application is deployed.</p></td><td><p>${environment.id}</p></td></tr></tbody></table>

## See Also

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

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

- [CloudHub Connector Reference](https://docs.mulesoft.com/cloudhub-connector/latest/cloudhub-connector-ref)

- [CloudHub Connector in Anypoint Exchange](https://www.mulesoft.com/exchange/com.mulesoft.connectors/mule-cloudhub-connector/)

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

<!-- document id=77af8f3c4ca1d41ccc865b83d4ceeb8d007c632b0dc5d4a82ddb23a842f21b9c url=/mulesoft/current/en-us/cloudhub-connector/latest/cloudhub-connector-ref.md -->

---
product: CloudHub Connector
version: 1.2
is-latest-version: true
---

# CloudHub Connector 1.2 Reference

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

Anypoint Connector for CloudHub enables you to create and list notifications and to retrieve the
status of created applications that are deployed to CloudHub.

Release Notes:
[CloudHub Connector Release Notes](https://docs.mulesoft.com/release-notes/connector/cloudhub-connector-release-notes-mule-4)

## Configurations

---

### Default Configuration

Default configuration

#### 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><ul><li><p><a href="#config_connection">Basic Authentication</a></p></li><li><p><a href="#Config_OauthClientCredentials">OAuth Client Credentials</a></p></li></ul></div></div></td><td><p>Connection types for this configuration.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Name</p></td><td><div><div><p>String</p></div></div></td><td><p>ID used to reference this configuration.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Expiration Policy</p></td><td><div><div><p><a href="#ExpirationPolicy">Expiration Policy</a></p></div></div></td><td><p>Configures the minimum amount of time that a dynamic configuration instance can remain idle before Mule considers it eligible for expiration. This does not mean that the platform expires the instance at the exact moment that it becomes eligible. Mule purges the instances as appropriate.</p></td><td></td><td></td></tr></tbody></table>

#### Connection Types

##### Basic Authentication

Basic connection provider that provides CloudHub connection.

###### 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>Username</p></td><td><div><div><p>String</p></div></div></td><td><p>Username of the Anypoint Platform Account</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Password</p></td><td><div><div><p>String</p></div></div></td><td><p>Password of the Anypoint Platform Account</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Environment</p></td><td><div><div><p>String</p></div></div></td><td><p>Optionally specifies the Anypoint Platform environment to use: by default, the environment defined as the default in Anypoint Platform.</p></td><td></td><td></td></tr><tr><td><p>Anypoint Platform URL</p></td><td><div><div><p>String</p></div></div></td><td><p>Enables you to change between the US Anypoint Platform and the EU Anypoint Platform, if required.</p></td><td><p><code>https://anypoint.mulesoft.com</code></p></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>Configures a reconnection strategy to use when a connector operation fails to connect to an external server.</p></td><td></td><td></td></tr></tbody></table>

##### OAuth Client Credentials

Connection provider that provides CloudHub connection.

###### 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>Anypoint Platform URL</p></td><td><div><div><p>String</p></div></div></td><td><p>Enables you to change between the US Anypoint Platform and the EU Anypoint Platform, if required.</p></td><td><p><code>https://anypoint.mulesoft.com</code></p></td><td></td></tr><tr><td><p>Client Id</p></td><td><div><div><p>String</p></div></div></td><td><p>OAuth client ID, as registered with the service provider.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Client Secret</p></td><td><div><div><p>String</p></div></div></td><td><p>OAuth client secret, as registered with the service provider.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Environment</p></td><td><div><div><p>String</p></div></div></td><td><p>Optionally specifies the Anypoint Platform environment to use: by default, the environment defined as the default in Anypoint Platform.</p></td><td></td><td></td></tr><tr><td><p>Reconnection</p></td><td><div><div><p><a href="#Reconnection">Reconnection</a></p></div></div></td><td><p>Configures a reconnection strategy to use when a connector operation fails to connect to an external server.</p></td><td></td><td></td></tr></tbody></table>

#### Associated Operations

- [Create Notification](#createNotification)

- [Get Application](#getApplication)

- [List Applications](#listApplications)

- [List Notifications](#listNotifications)

- [Mark Notification](#markNotification)

## Operations

### Create Notification

`<cloudhub:create-notification>`

Creates a new Notification

#### 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>Domain</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the application to bind the new notification</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Message</p></td><td><div><div><p>String</p></div></div></td><td><p>Notification’s message</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Custom Properties</p></td><td><div><div><p>Object</p></div></div></td><td><p>Additional properties for the notification</p></td><td></td><td></td></tr><tr><td><p>Priority</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>ERROR</p></li><li><p>INFO</p></li><li><p>WARN</p></li></ul></div></div></td><td><p>Priority of the notification to create.</p></td><td></td><td></td></tr><tr><td><p>Transaction Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Transaction ID for the Notification</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>Name of the configuration to use to execute this component.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Error Mappings</p></td><td><div><div><p>Array of <a href="#ErrorMapping">Error Mapping</a></p></div></div></td><td><p>Set of error mappings.</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="#reconnect-forever">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>

#### For Configurations

- [Default Configuration](#config)

#### Throws

- CLOUDHUB:CONNECTIVITY

- CLOUDHUB:EXECUTION

- CLOUDHUB:RETRY\_EXHAUSTED

### Get Application

`<cloudhub:get-application>`

Retrieves a single application by name.

#### 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>Domain</p></td><td><div><div><p>String</p></div></div></td><td><p>The name of the application</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#repeatable-in-memory-stream">Repeatable In Memory Stream</a></p></li><li><p><a href="#repeatable-file-store-stream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configure if repeatable streams should be used and their behavior</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 on which the operation’s output will be placed</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 that will be evaluated against the operation’s output and the outcome of that expression will be stored in the target variable</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Error Mappings</p></td><td><div><div><p>Array of <a href="#ErrorMapping">Error Mapping</a></p></div></div></td><td><p>Set of error mappings.</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="#reconnect-forever">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><strong>Type</strong></p></td><td><div><div><p>Any</p></div></div></td></tr></tbody></table>

#### For Configurations

- [Default Configuration](#config)

#### Throws

- CLOUDHUB:CONNECTIVITY

- CLOUDHUB:EXECUTION

- CLOUDHUB:RETRY\_EXHAUSTED

### List Applications

`<cloudhub:list-applications>`

Retrieves all applications in the specified environment.

#### 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>Retrieve Log Levels</p></td><td><div><div><p>Boolean</p></div></div></td><td><p>Whether should retrieve Application log levels</p></td><td><p>true</p></td><td></td></tr><tr><td><p>Retrieve Tracking Settings</p></td><td><div><div><p>Boolean</p></div></div></td><td><p>Whether should retrieve Application tracking settings</p></td><td><p>true</p></td><td></td></tr><tr><td><p>Retrieve IP Addresses</p></td><td><div><div><p>Boolean</p></div></div></td><td><p>Whether should retrieve Application IP Addresses</p></td><td><p>true</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#repeatable-in-memory-stream">Repeatable In Memory Stream</a></p></li><li><p><a href="#repeatable-file-store-stream">Repeatable File Store Stream</a></p></li><li><p>non-repeatable-stream</p></li></ul></div></div></td><td><p>Configure if repeatable streams should be used and their behavior</p></td><td></td><td></td></tr><tr><td><p>Retrieve Statistics</p></td><td><div><div><p>Boolean</p></div></div></td><td><p>Whether should retrieve Application statistics</p></td><td><p>false</p></td><td></td></tr><tr><td><p>Period</p></td><td><div><div><p>Number</p></div></div></td><td><p>Time of statistics to gather</p></td><td><p>1</p></td><td></td></tr><tr><td><p>Period Time 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>Time Unit of the period</p></td><td><p>HOURS</p></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 on which the operation’s output will be placed</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 that will be evaluated against the operation’s output and the outcome of that expression will be stored in the target variable</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Error Mappings</p></td><td><div><div><p>Array of <a href="#ErrorMapping">Error Mapping</a></p></div></div></td><td><p>Set of error mappings.</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="#reconnect-forever">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><strong>Type</strong></p></td><td><div><div><p>Any</p></div></div></td></tr></tbody></table>

#### For Configurations

- [Default Configuration](#config)

#### Throws

- CLOUDHUB:CONNECTIVITY

- CLOUDHUB:EXECUTION

- CLOUDHUB:RETRY\_EXHAUSTED

### List Notifications

`<cloudhub:list-notifications>`

Lists all the available notifications for a giver domain.

#### 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>Domain</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the application to gather notifications from</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Limit</p></td><td><div><div><p>Number</p></div></div></td><td><p>Number of notifications to retrieve. -1 means everything available.</p></td><td><p>-1</p></td><td></td></tr><tr><td><p>Page Size</p></td><td><div><div><p>Number</p></div></div></td><td><p>Size of the page to retrieve per iteration. This only should be changed for performance purposes.</p></td><td><p>25</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Streaming Strategy</p></td><td><div><div><ul><li><p><a href="#repeatable-in-memory-iterable">Repeatable In Memory Iterable</a></p></li><li><p><a href="#repeatable-file-store-iterable">Repeatable File Store Iterable</a></p></li><li><p>non-repeatable-iterable</p></li></ul></div></div></td><td><p>Configure if repeatable streams should be used and their behavior</p></td><td></td><td></td></tr><tr><td><p>Status</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>READ</p></li><li><p>UNREAD</p></li><li><p>ALL</p></li></ul></div></div></td><td><p>Filters the notifications by status. Read, Unread or All.</p></td><td><p>UNREAD</p></td><td></td></tr><tr><td><p>Search</p></td><td><div><div><p>String</p></div></div></td><td><p>If specified, only return notifications where the message contains this string. (Case Insensitive)</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 on which the operation’s output will be placed</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 that will be evaluated against the operation’s output and the outcome of that expression will be stored in the target variable</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Error Mappings</p></td><td><div><div><p>Array of <a href="#ErrorMapping">Error Mapping</a></p></div></div></td><td><p>Set of error mappings.</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="#reconnect-forever">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><strong>Type</strong></p></td><td><div><div><p>Array of <a href="#Notification">Notification</a></p></div></div></td></tr></tbody></table>

#### For Configurations

- [Default Configuration](#config)

#### Throws

- CLOUDHUB:CONNECTIVITY

- CLOUDHUB:EXECUTION

### Mark Notification

`<cloudhub:mark-notification>`

Marks a notification as Read or Unread.

#### 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>Notification Id</p></td><td><div><div><p>String</p></div></div></td><td><p>ID of the notification</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Mark As</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>READ</p></li><li><p>UNREAD</p></li></ul></div></div></td><td><p>Action to do. Mark as Read or Unread</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Error Mappings</p></td><td><div><div><p>Array of <a href="#ErrorMapping">Error Mapping</a></p></div></div></td><td><p>Set of error mappings.</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="#reconnect-forever">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>

#### For Configurations

- [Default Configuration](#config)

#### Throws

- CLOUDHUB:CONNECTIVITY

- CLOUDHUB:EXECUTION

- CLOUDHUB:RETRY\_EXHAUSTED

## Types

### 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>Fails Deployment</p></td><td><div><div><p>Boolean</p></div></div></td><td><p>When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment will fail if the test doesn’t pass after exhausting the associated reconnection strategy</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="#reconnect-forever">Reconnect Forever</a></p></li></ul></div></div></td><td><p>The reconnection strategy to use</p></td><td></td><td></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 to reconnect (in milliseconds).</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>The number of reconnection attempts to make.</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 runs in a separate, non-blocking thread.</p></div></div></td><td><div><div><p>true</p></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 runs in a separate, non-blocking thread.</p></div></div></td><td><div><div><p>true</p></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>Max Idle Time</p></td><td><div><div><p>Number</p></div></div></td><td><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></td><td></td><td></td></tr><tr><td><p>Time 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 maxIdleTime attribute</p></td><td></td><td></td></tr></tbody></table>

### Error Mapping

<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>Source</p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>ANY</p></li><li><p>REDELIVERY_EXHAUSTED</p></li><li><p>TRANSFORMATION</p></li><li><p>EXPRESSION</p></li><li><p>SECURITY</p></li><li><p>CLIENT_SECURITY</p></li><li><p>SERVER_SECURITY</p></li><li><p>ROUTING</p></li><li><p>CONNECTIVITY</p></li><li><p>RETRY_EXHAUSTED</p></li><li><p>TIMEOUT</p></li></ul></div></div></td><td><p>Source.</p></td><td></td><td></td></tr><tr><td><p>Target</p></td><td><div><div><p>String</p></div></div></td><td><p>Target.</p></td><td></td><td><p>x</p></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>Initial Buffer Size</p></td><td><div><div><p>Number</p></div></div></td><td><p>This is the amount of memory that will be allocated in order to consume the stream and provide random access to it. If the stream contains more data than can be fit into this buffer, then the buffer expands according to the bufferSizeIncrement attribute, with an upper limit of maxInMemorySize.</p></td><td></td><td></td></tr><tr><td><p>Buffer Size Increment</p></td><td><div><div><p>Number</p></div></div></td><td><p>This is by how much will be buffer size expands if it exceeds its initial size. Setting a value of zero or lower will mean that the buffer should not expand, meaning that a STREAM_MAXIMUM_SIZE_EXCEEDED error will be raised when the buffer gets full.</p></td><td></td><td></td></tr><tr><td><p>Max Buffer Size</p></td><td><div><div><p>Number</p></div></div></td><td><p>This is the maximum amount of memory that will be used. If more than that is used then a STREAM_MAXIMUM_SIZE_EXCEEDED error will be raised. A value lower or equal to zero means no limit.</p></td><td></td><td></td></tr><tr><td><p>Buffer Unit</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><p>The unit in which all these attributes are expressed</p></td><td></td><td></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>Max In Memory Size</p></td><td><div><div><p>Number</p></div></div></td><td><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></td><td></td><td></td></tr><tr><td><p>Buffer Unit</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><p>The unit in which maxInMemorySize is expressed</p></td><td></td><td></td></tr></tbody></table>

### Notification

<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>Id</p></td><td><div><div><p>String</p></div></div></td><td></td><td></td><td><p>x</p></td></tr><tr><td><p>Domain</p></td><td><div><div><p>String</p></div></div></td><td></td><td></td><td><p>x</p></td></tr><tr><td><p>Message</p></td><td><div><div><p>String</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Priority</p></td><td><div><div><p>String</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Properties</p></td><td><div><div><p>Any</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Read</p></td><td><div><div><p>Boolean</p></div></div></td><td></td><td></td><td><p>x</p></td></tr><tr><td><p>Read On</p></td><td><div><div><p>DateTime</p></div></div></td><td></td><td></td><td></td></tr><tr><td><p>Created At</p></td><td><div><div><p>DateTime</p></div></div></td><td></td><td></td><td><p>x</p></td></tr><tr><td><p>Href</p></td><td><div><div><p>String</p></div></div></td><td></td><td></td><td><p>x</p></td></tr></tbody></table>

### Repeatable In Memory Iterable

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

### Repeatable File Store Iterable

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Max In Memory Size</p></td><td><div><div><p>Number</p></div></div></td><td><p>This is the maximum amount of instances that will be kept in memory. If more than that is required, then it will start to buffer the content on disk.</p></td><td></td><td></td></tr><tr><td><p>Buffer Unit</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><p>The unit in which maxInMemorySize is expressed</p></td><td></td><td></td></tr></tbody></table>

## See Also

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