A pre-defined connection configuration is a YAML file that includes specifications for Analytics Database connection profiles. A pre-defined connection configuration is useful in environments where:
- You require a fixed or static set of Analytics Database connections.
- The administrator wants to control or pre-configure Analytics Database connections.
When you start the JupyterLab or the Docker container, the system reads the pre-defined connection configuration (YAML file).
Here is the template of pre-defined connection configuration (YAML file) for reference:
# Pre-defined connection and configuration file connectionProfiles: # List of connection profiles - connectionName: # required: name of connection, must be unique databaseHostOrIP: # required: host name or IP address of SQL Engine databaseUserName: # optional: database username for this connection defaultDatabase: # optional: default database for this connection dbviews: ViewsVX # optional: specifies whether to show only the objects visible to current user or not creationOption: Create # optional: "create" profile if it does not exist, "update" existing profile with same name, "delete" existing profile vallocation: # optional: location of Vantage Analytics Library if installed connectionProperties: # optional: driver properties for connection cop: coplast: encryptdata: dbsport: log: logmech: sip_support: tmode: # copy/paste above for additional connection profiles - connectionName: databaseHostOrIP: databaseUserName: defaultDatabase: dbviews: ViewsVX creationOption: Create vallocation: connectionProperties: cop: coplast: encryptdata: dbsport: log: logmech: TD2 sip_support: tmode: connectionManagementAllowed: True # optional: indicates after starting whether you can create, modify and delete connection profiles or not
You can specify the optional property connectionManagementAllowed in the YAML file to manage the connection profiles when running in the user interface. Set the property value:
- True: This allows you to create, update, and delete connection profiles in the user interface when JupyterLab is running.
- False: This allows you to use only the connection profiles configured in the YAML file. You cannot create, update, or delete connection profiles in the user interface when JupyterLab is running.
Specify the pre-defined connections in the following two ways: