(v7) Add Data Store Connections

Add Data Store Connections

You can add and validate data store connections on the Connections page in the UI.

You must be logged in as a user with the group privilege Manage Connections to maintain data store connection definitions.

To manually add and validate a data store connection definition using the Connections page:

1. Make sure you are logged into Composer as a user with the group privilege Manage Connections.

2. Select Connections on the top-level navigation banner or the UI menu () or select the Connections box on the Home page. The Connections page appears.

   The Connections page lists the data store connections you have defined and identifies how many data source configurations each connection uses.

3. Select Add Connection in the upper right corner of the data store connection list. The Select a Connection Type dialog appears.

   

4. Select the connection type you want to use for the connection definition. The Add <type> Connection page appears.

   

5. Optionally, change the name for the connection in the Connection Name box. A default name based on the connector is initially set by Composer.

6. The connection details required to connect to a data store vary by data store. Use the boxes on the Connection Details tab to specify the URL and other connection details and, if applicable, authentication credentials (User Name and Password boxes) required to connect to the data store. Boxes that are highlighted in red are required. Any connection requirements for a specific data store are described in the connector documentation for that data store. See the Composer Data Connector Reference.

   You can insert variables for connection parameters, if any custom attributes have been defined. See Insert Variables for Connection Parameters. In addition, if user attributes have been set up for connection parameters, they can be selected using the up and down arrows in the connection parameter box. See Use User Attributes for Connection Parameters.

7. If the Do As User box is available and you want to enable user delegation, optionally specify the custom user attribute set up for user delegation. See Apply User Delegation to a Connection.

8. This is an optional step.

   Each data source configuration specifies refresh settings for the data from the data store. If a data store connection requires special credentials in order for Composer to refresh the data source data, select the Add an Override button under Scheduler Overrides and select an override setting to use. The override settings you can specify mirror the regular data store connection settings (except for the connection definition name) and vary based on the type of data store connector used for the connection. See Composer Data Connector Reference.

   More than one override setting can be specified. Simply select the Add an Override button again and select a different setting and provide its input value. Repeat this process until all override settings required by the data store have been specified.

9. Select Validate to validate the connection. If the connection is valid, it is saved.

10. Select Back at the top of the page to return to the Connections page.

After you create a connection, you can update the Connection Details or view Data Sources associated with this connection at any time.