--- schema_version: "1" id: a6fce8a6a17f48a890fa17222b8e06d9ba1269a48326e9969e950be888689921 title: Using Anypoint Studio to Configure Redis Connector 5.7 collection: mulesoft version: current locale: en-us portal_url: https://docs.salesforce.com/mulesoft/current/en-us/redis-connector/5.7/redis-connector-studio.md canonical_url: https://docs.mulesoft.com/redis-connector/5.7/redis-connector-studio source_site: docs.mulesoft.com content_type: documentation content_hash: 704332117e9059317a311c3046f9fc4600b40ad89bd7afeb4e154b356c71910d description: MuleSoft Documentation Site release: "5.7" latest: false --- --- product: Redis Connector version: 5.7 --- # Using Anypoint Studio to Configure Redis Connector 5.7 > For the full documentation index, see: https://docs.mulesoft.com/llms.txt > [!NOTE] Where possible, we changed noninclusive terms to align with our company value of Equality. > We maintained certain terms to avoid any effect on customer implementations. Anypoint Studio (Studio) editors help you design and update your Mule applications, properties, and configuration files. To add and configure a connector in Studio: 1. [Create a Mule project](#create-mule-project). 2. [Add the connector to your Mule project](#add-connector-to-project). 3. [Configure an input source for the connector’s flow](#configure-input-source). 4. [Add a connector operation to the flow](#add-connector-operation). 5. [Configure a global element for the connector](#configure-global-element). When you run your app, you can view the app log as described in [View the App Log](#view-app-log). If you are new to configuring connectors in Studio, see [Using Anypoint Studio to Configure a Connector](https://docs.mulesoft.com/connectors/introduction/intro-config-use-studio). If, after reading this topic, you need additional information about the connector fields, see the [Redis Connector Reference](https://docs.mulesoft.com/redis-connector/5.7/redis-connector-reference). ## Create a Mule Project In Studio, create a new Mule project in which to add and configure the connector: 1. In Studio, select **File > New > Mule Project**. 2. Enter a name for your Mule project and click **Finish**. ## Add the Connector to Your Mule Project Add Aynpoint Connector for Redis to your Mule project to automatically populate the XML code with the connector’s namespace and schema location and add the required dependencies to the project’s `pom.xml` file: 1. In the **Mule Palette** view, click **(X) Search in Exchange**. 2. In **Add Dependencies to Project**, type `redis` in the search field. 3. Click **Redis Connector** in **Available modules**. 4. Click **Add**. 5. Click **Finish**. Adding a connector to a Mule project in Studio does not make that connector available to other projects in your Studio workspace. ## Configure an Input Source An input source initiates a flow when a specified condition is met. You can configure one of these input sources to use with Redis Connector: - **Subscribe** Enables the Mule app to listen to specified channels - **HTTP Listener** Initiates a flow each time it receives a request on the configured host and port - **Scheduler** Initiates a flow when a time-based condition is met For example, to configure the **Subscribe** input source, follow these steps: 1. In the **Mule Palette** view, select **Redis > Subscribe**. 2. Drag **Subscribe** to the Studio canvas. 3. On the **Subscribe** configuration screen, optionally change the value of the **Display Name** field. 4. In **Channels** provide a list of Redis channel names or globbing patterns. ## Add a Connector Operation to the Flow When you add a connector operation to your flow, you immediately define a specific operation for that connector to perform. To add an operation for Redis Connector, follow these steps: 1. In the **Mule Palette** view, select **Redis** and then select the desired operation. 2. Drag the operation onto the Studio canvas to the right of the input source. ## Configure a Global Element for the Connector When you configure a connector, it’s best to configure a global element that all instances of that connector in the app can use. Configuring a global element requires you to provide the authentication credentials the connector uses to access the target Redis system. Redis Connector supports global elements for clustered Redis configurations and non-clustered Redis configurations. 1. Select the operation in the Studio canvas. 2. In the configuration screen for the operation, click the plus sign (+) next to the **Connector configuration** field to configure a global element that can be used by all instances of Redis Connector in the app. When you configure a global element, you can reference a configuration file that contains ANT-style property placeholders (recommended), or you can enter your authorization credentials in the global configuration properties. For information about the benefits of using property placeholders and how to configure them, see [Anypoint Connector Configuration](https://docs.mulesoft.com/connectors/introduction/intro-connector-configuration-overview). 3. On the **Connection** tab, select the connection type: - **[Clustered](#clustered-config)** - **[NonClustered](#nonclustered-config)** - **[Sentinel](#sentinel-config)** 4. Click **Test Connection** to confirm that Mule can connect with the specified server. 5. Click **OK**. ### Clustered Redis Configuration Enter the following information on the **General** tab of the **Global Element Properties** screen to configure a Clustered connection: ![Configuration fields for Redis clustered connection type](/mulesoft/current/en-us/redis-connector/5.7/_images/redis-basic-config-clustered.png) 1. In **Name**, enter a name for the configuration. 2. In **Connection**, select **Clustered** to use the connector with a clustered Redis configuration. 3. Enter values for the following fields: - **Cluster hosts** Comma-separated list for all Redis cluster hosts using the format `host:port` - **Connection timeout** Optional connection timeout value, in milliseconds - **Entry Ttl** Optional default time-to-live value to set on keys stored through the connector - **Password** Redis password for server authentication - **Username** Optional Redis ACL username for Redis 6 and later ACL-based authentication. When set, the connector authenticates using the `AUTH ` form. When empty, the connector falls back to the legacy `AUTH ` form. 4. Click **Test Connection**. 5. Click **OK**. ### Nonclustered Redis Configuration Enter the following information on the **General** tab of the **Global Element Properties** screen to configure a non-clustered connection: ![Configuration fields for Redis non-clustered connection type](/mulesoft/current/en-us/redis-connector/5.7/_images/redis-basic-config.png) 1. In **Name**, enter a name for the configuration. 2. In **Connection**, select **NonClustered** to use the connector with a non-clustered Redis configuration. 3. Enter values for the following fields: - **Host** Host for the Redis server - **Port** Port on which the non-clustered server is running **Connection Timeout** Optional connection timeout value, in milliseconds - **Entry Ttl** Optional default time-to-live value to set on keys stored through the connector. - **Password** Password for server authentication. - **Username** Optional Redis ACL username for Redis 6 and later ACL-based authentication. When set, the connector authenticates using the `AUTH ` form. When empty, the connector falls back to the legacy `AUTH ` form. 4. Click **Test Connection**. 5. Click **OK**. ## Sentinel Configuration Sentinel provides a high-availability solution in case of failure on your Redis cluster. To configure a Sentinel connection: 1. On the **General** tab of the **Global Element Properties**, enter a name for the configuration. 2. In **Connection**, select **Sentinel** to use the connector with a non-clustered Redis configuration. 3. Enter values for the following fields: - **Sentinels hosts** Sentinel addresses that monitor the Redis master host to which the connector will connect - **Master name** Name of the Redis master for which Sentinel discovers and returns the address of the master instance to connect to - **Sentinel password** Password for Sentinel server authentication - **Sentinel username** Optional Redis ACL username for authenticating to the Sentinel processes (Redis 6.2 and later). When set, the connector uses `AUTH ` to authenticate with each Sentinel. When empty, falls back to the legacy `AUTH ` form. - **Index** Index of the database that the pool uses - **Password** Password for Redis server authentication - **Username** Optional Redis ACL username for Redis 6 and later ACL-based authentication on the master. When set, the connector authenticates using the `AUTH ` form. When empty, the connector falls back to the legacy `AUTH ` form. - **Entry ttl** Optional default time-to-live value to set on keys stored through the connector 4. Click **Test Connection**. 5. Click **OK**. ### TLS Configuration To enable and configure TLS for your app: 1. In the **Connection** section for the configuration, click the **Security** tab. 2. To configure a truststore, in **TLS Configuration**, select **Edit inline** and provide the following values: - **Path** Location of the truststore file. - **Password** Password for the truststore file. - **Type** File format of the truststore file. - **Algorithm** Algorithm the truststore uses. - **Insecure** Boolean that determines whether or not to validate the truststore. If set to `true`, no validation occurs. The default value is `false`. 3. To configure a keystore, enter the following values: - **Type** Optionally specify the file format of the keystore file. The default value is `JKS`. - **Path** Optionally specify the location of the keystore file. This can be used for two-way authentication for the connector. - **Alias** Attribute that indicates the alias of the key to use when the keystore contains many private keys. If not defined, the first key in the file is used by default. - **Key password** Key manager password, which is the password for the private key inside the keystore. - **Password** Store password for the keystore file. This is required only if the **Key Store Location** is configured. - **Algorithm** Algorithm used in the keystore. 4. Click **Test Connection**. 5. Click **OK**. ## View the App Log You can view the app log for the connector as follows: - If you’re running the app from the Anypoint Platform, the output is visible in the Anypoint Studio **Console** window. - If you’re running the app using Mule from the command line, the app log is visible in your OS console. Unless the log file path was customized in the app’s log file (`log4j2.xml`), you can also view the app log in `MULE_HOME/logs/.log`. For more information about the app log, see [Configuring Logging](https://docs.mulesoft.com/mule-runtime/latest/logging-in-mule). ## Next Step After you configure a global element and connection information, configure the other fields for the connector. ## See Also - [Introduction to Anypoint Connectors](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors) - [Salesforce Help](https://help.salesforce.com)