(v24) Insert Variables for Connection Parameters

Insert Variables for Connection Parameters

This applies to: Visual Data Discovery

Variables can be inserted for any connection parameter in a connection definition. The variables are passed to the connection string via custom attributes specified in the user definition or dynamically in the custom attributes specified in the SAML or LDAP configurations for your environment.

You can also specify user attributes for use in the connection parameters of a connection definition. See Use User Attributes for Connection Parameters.

Step 1: Define Custom Attributes for the Variables

A custom attribute must be defined for every variable you want to use. The only exceptions are the Symphony context variables ${User.composerUserName}, ${User.accountId}, and ${User.credentials}. These built-in attributes which automatically exist and can be used connect the currently logged in user.

You can define custom attributes in several ways:

• Individually for every user. If you use this method, the variable names must be the same for every user.

• Dynamically in the LDAP or SAML configurations for your Symphony instance. See Use Lightweight Directory Access Protocol (LDAP) With ComposerSymphony and Configure ComposerSymphony to Support SAML.

Details about specifying custom attribute values are provided in Specify Custom User Attributes.

Step 2: Define Connections Using Variables

Define connections using variables

1. Log in as an system admin.

2. Create or edit a connection definition. See Add Data Discovery Data Store Connections and Modify Data Discovery Data Store Connections.

3. If custom attributes have been defined, they can be directly entered in a connection parameter field on the Connections page using the following syntax:

   ${User.<custom-attribute-name>}

   The same custom attribute key name must be defined and used in all the user definitions of the users expected to use this connection.

   For example:

   

   Note: If the connector associated with the connection type for the connection definition has been defined with the User Attribute checkbox selected for the USER_NAME or the PASSWORD parameters, a custom user attribute must be defined for the user creating the connection and for any users using the connection. In this scenario, the Add Connection screen allows you to select the custom user attribute from a Select Custom Attribute drop-down menu, as shown below. Note that the custom attributes in this case are not shown using the same format as when you specify them manually. For complete information, see Use User Attributes for Connection Parameters.

   

4. Select Validate to validate the connection. If the connection is valid, you can save the connection. If invalid, make changes, then select Validate again.

5. Select Save to save the connection.