# Ehcache

{% hint style="info" %}
The content of this documentation is under revision and may change. We appreciate your understanding as we work to improve it.
{% endhint %}

**Ehcache** performs caching operations using Ehcache.

## **Parameters**

Take a look at the configuration options for the component. Parameters supported by [Double Braces expressions](/documentation/connectors-and-triggers/double-braces/overview.md) are marked with `(DB)`.

### **General tab**

<table data-full-width="true"><thead><tr><th>Parameter</th><th>Description</th><th>Default value</th><th>Data type</th></tr></thead><tbody><tr><td><strong>Cache Name</strong> <code>(DB)</code></td><td>The cache name.</td><td>N/A</td><td>string</td></tr><tr><td><strong>Fail On Error</strong></td><td>If the option is activated, the pipeline's execution with an error will be interrupted. Otherwise, the pipeline execution proceeds, but the result will show a false value for the <code>"success"</code> property.</td><td>False</td><td>Boolean</td></tr></tbody></table>

### **Optional tab**

<table data-full-width="true"><thead><tr><th>Parameter</th><th>Description</th><th>Default value</th><th>Data type</th></tr></thead><tbody><tr><td><strong>Configuration Uri</strong> <code>(DB)</code></td><td>URI pointing to the location of the Ehcache XML configuration file.</td><td>N/A</td><td>String</td></tr><tr><td><strong>Create Cache If Not Exist</strong></td><td>If active, a cache is automatically created if it doesn’t exist.</td><td>True</td><td>Boolean</td></tr><tr><td><strong>Action</strong> <code>(DB)</code></td><td>To configure the default cache action. If an action is set in the message header, then the operation from the header takes precedence.</td><td>N/A</td><td>String</td></tr><tr><td><strong>Key</strong> <code>(DB)</code></td><td>To configure the default action key. If a key is set in the message header, then the key from the header takes precedence.</td><td>N/A</td><td>JSON</td></tr><tr><td><strong>Configurations</strong> <code>(DB)</code></td><td>A map of the cache configuration to be used to create caches.</td><td>N/A</td><td>JSON</td></tr><tr><td><strong>Key Type</strong> <code>(DB)</code></td><td>The cache key type. Default is java.lang.Object.</td><td>N/A</td><td>String</td></tr><tr><td><strong>Value Type</strong> <code>(DB)</code></td><td>The cache value type. Default is java.lang.Object.</td><td>N/A</td><td>String</td></tr></tbody></table>

### **Headers tab**

<table data-full-width="true"><thead><tr><th>Parameter</th><th>Description</th><th>Default value</th><th>Data type</th></tr></thead><tbody><tr><td><strong>Action</strong> <code>(DB)</code></td><td>The operation to be performed on the cache. Valid options are: CLEAR</td><td>PUT</td><td>PUT_ALL</td></tr><tr><td><strong>Action Has Result</strong></td><td>Activate if the action has a result.</td><td>False</td><td>Boolean</td></tr><tr><td><strong>Action Succeeded</strong></td><td>Activate if the action was successful.</td><td>False</td><td>Boolean</td></tr><tr><td><strong>Key</strong> <code>(DB)</code></td><td>The cache key used for an action.</td><td>N/A</td><td>JSON</td></tr><tr><td><strong>Keys</strong> <code>(DB)</code></td><td>A list of keys, used in PUT_ALL</td><td>GET_ALL</td><td>REMOVE_ALL</td></tr><tr><td><strong>Value</strong> <code>(DB)</code></td><td>The value to put in the cache or the result of an operation.</td><td>N/A</td><td>JSON</td></tr><tr><td><strong>Old Value</strong> <code>(DB)</code></td><td>The old value associated with a key in actions such as PUT_IF_ABSENT, or the Object that is used for comparison in actions such as REPLACE.</td><td>N/A</td><td>JSON</td></tr></tbody></table>

### **Documentation tab**

<table data-full-width="true"><thead><tr><th>Parameter</th><th>Description</th><th>Default value</th><th>Data type</th></tr></thead><tbody><tr><td><strong>Documentation</strong></td><td>Section for documenting any necessary information about the connector configuration and business rules.</td><td>N/A</td><td>String</td></tr></tbody></table>


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.digibee.com/documentation/connectors-and-triggers/connectors/structured-data/ehcache.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.