Connection types
Connection types are the reusable configuration blocks. Each type allows the framework to connect to specific technology and requires a different set of input parameters.
The connection types are prefix based on a connectivity category:
| Prefix | Category |
|---|---|
| db | Database connectivity |
| fwk | Framework capabilities |
| host | Operating system connectivity |
| http | Http-based connectivity |
| repo | Repository connectivity |
The table provides an overview of all connection types. Additional details on the parameters per connection type are provided below.
| Connection Type | Description |
|---|---|
| db.db2 | IBM DB2 Database Connection |
| db.dremio | Dremio Database Connection |
| db.drill | Apache Drill Database Connection |
| db.h2 | H2 Database Connection |
| db.mariadb | MariaDB Database Connection |
| db.mssql | Microsoft SQL Database Connection |
| db.mysql | MySql Database Connection |
| db.netezza | Netezza Database Connection |
| db.oracle | Oracle Database Connection |
| db.postgresql | Postgresql Database Connection |
| db.presto | Presto Database Connection |
| db.sqlite | SQLite Database Connection |
| db.teradata | Teradata Database Connection |
| fwk.alias | Connection alias only to be used for impersonation |
| host.linux | Linux-Based Operating System Connection |
| host.unix | Unix-Based Operating System Connection |
| host.windows | Windows-Based Operating System Connection |
| http.host | Http Host Connection |
| repo.artifactory | Artifactory Repository Connection |
| socket | socket Connection |
db.db2
Description: IBM DB2 Database Connection
| Parameter | Description | Type | Mandatory |
|---|---|---|---|
| host | The host name of the server where the database is running | string | Y |
| port | The port number for connecting to the host | number | Y |
| database | The database name to connect to | string | Y |
| user | The user name to connect to the database | string | Y |
| password | The encrypted password to connect to the database | string | Y |
db.dremio
Description: Dremio Database Connection
| Parameter | Description | Type | Mandatory |
|---|---|---|---|
| host | The host name of the server where the database is located | string | Y |
| port | The port number for connecting to the host | number | Y |
| mode | The connection mode to use: direct, zookeeper | string | Y |
| cluster | The optional cluster name if connection mode is zookeeper | string | N |
| schema | The schema name in the catalog to connect to | string | N |
| user | The user name to connect to the database | string | Y |
| password | The encrypted password to connect to the database | string | N |
db.drill
Description: Apache Drill Database Connection
| Parameter | Description | Type | Mandatory |
|---|---|---|---|
| mode | The connection mode to use: drillbit, zookeeper | string | Y |
| cluster | The drillbit or zookeeper nodes including optional ports: node[:port],node[:port],etc | string | Y |
| directory | Optional drill directory in zookeeper which by default is drill | string | N |
| clusterId | Optional cluster Id which by default is drillbits1 | string | N |
| schema | Optional name of a storage plugin configuration to use as the default for queries | string | N |
| tries | Optional tries parameter for drillbit connections | string | N |
db.h2
Description: H2 Database Connection
| Parameter | Description | Type | Mandatory |
|---|---|---|---|
| host | The host name of the server where the database file is located | string | N |
| type | The type of h2 database (embedded/server/memory) | string | Y |
| name | The name of the h2 database (memory) | string | N |
| port | The port number for connecting to the host | number | N |
| path | The path where the database is stored | string | N |
| file | The database file name to connect to | string | Y |
| user | The user name to connect to the database | string | N |
| password | The encrypted password to connect to the database | string | N |
db.mariadb
Description: MariaDB Database Connection
| Parameter | Description | Type | Mandatory |
|---|---|---|---|
| host | The host name of the server where the database is running | string | Y |
| port | The port number for connecting to the host | number | Y |
| database | The database name to connect to | string | Y |
| user | The user name to connect to the database | string | Y |
| password | The encrypted password to connect to the database | string | Y |
db.mssql
Description: Microsoft SQL Database Connection
| Parameter | Description | Type | Mandatory |
|---|---|---|---|
| host | The host name of the server where the database is running | string | Y |
| port | The port number for connecting to the host | number | Y |
| database | The database name to connect to | string | Y |
| user | The user name to connect to the database | string | Y |
| password | The encrypted password to connect to the database | string | Y |
db.mysql
Description: MySql Database Connection
| Parameter | Description | Type | Mandatory |
|---|---|---|---|
| host | The host name of the server where the database is running | string | Y |
| port | The port number for connecting to the host | number | Y |
| schema | The schema name to connect to the database | string | Y |
| user | The user name to connect to the database | string | Y |
| password | The encrypted password to connect to the database | string | Y |
db.netezza
Description: Netezza Database Connection
| Parameter | Description | Type | Mandatory |
|---|---|---|---|
| host | The host name of the server where the database is running | string | Y |
| port | The port number for connecting to the host | number | Y |
| database | The database name to connect to | string | Y |
| user | The user name to connect to the database | string | Y |
| password | The encrypted password to connect to the database | string | Y |
db.oracle
Description: Oracle Database Connection
| Parameter | Description | Type | Mandatory |
|---|---|---|---|
| host | The host name of the server where the database is running | string | Y |
| port | The port number for connecting to the host | number | Y |
| tnsalias | The TNS Alias name to connect to the database | string | N |
| user | The user name to connect to the database | string | Y |
| password | The encrypted password to connect to the database | string | Y |
| service | The Service name to connect to the database | string | N |
db.postgresql
Description: Postgresql Database Connection
| Parameter | Description | Type | Mandatory |
|---|---|---|---|
| host | The host name of the server where the database is running | string | Y |
| port | The port number for connecting to the host | number | Y |
| database | The database name to connect to | string | Y |
| user | The user name to connect to the database | string | Y |
| password | The encrypted password to connect to the database | string | Y |
db.presto
Description: Presto Database Connection
| Parameter | Description | Type | Mandatory |
|---|---|---|---|
| host | The host name of the server where the database file is located | string | Y |
| port | The port number for connecting to the host | number | Y |
| catalog | The catalog name to connect to | string | N |
| schema | The schema name in the catalog to connect to | string | N |
| user | The user name to connect to the database | string | Y |
| password | The encrypted password to connect to the database | string | N |
db.sqlite
Description: SQLite Database Connection
| Parameter | Description | Type | Mandatory |
|---|---|---|---|
| filePath | The file path where the database is stored | string | Y |
| fileName | The file name of the the database | string | Y |
db.teradata
Description: Teradata Database Connection
| Parameter | Description | Type | Mandatory |
|---|---|---|---|
| host | The host name of the server where the database is running | string | Y |
| port | The port number for connecting to the host | number | Y |
| database | The database name to connect to | string | Y |
| user | The user name to connect to the database | string | Y |
| password | The encrypted password to connect to the database | string | Y |
fwk.alias
Description: Connection alias only to be used for impersonation
| Parameter | Description | Type | Mandatory |
|---|---|---|---|
| type | The connection type that is impersonated | string | Y |
host.linux
Description: Linux-Based Operating System Connection
| Parameter | Description | Type | Mandatory |
|---|---|---|---|
| host | The host name to connect to | string | Y |
| port | The port number for connecting to the host | number | Y |
| user | The user name to connect to the host | string | Y |
| password | The encrypted password to connect to the host | string | Y |
| tempPath | The temporary path on the host name that can be used by the solution | string | N |
| simulateTerminal | Flag indicating if a terminal needs to be simulated when connecting | string | N |
| jumphostConnections | Connection names that need to be used as jump host for connecting | string | N |
| allowLocalhostExecution | Flag indicating if processes are allowed to run as localhost on the automation engine | string | N |
host.unix
Description: Unix-Based Operating System Connection
| Parameter | Description | Type | Mandatory |
|---|---|---|---|
| host | The host name to connect to | string | Y |
| port | The port number for connecting to the host | number | Y |
| user | The user name to connect to the host | string | Y |
| password | The encrypted password to connect to the host | string | Y |
| tempPath | The temporary path on the host name that can be used by the solution | string | N |
| simulateTerminal | Flag indicating if a terminal needs to be simulated when connecting | string | N |
| jumphostConnections | Connection names that need to be used as jump host for connecting | string | N |
| allowLocalhostExecution | Flag indicating if processes are allowed to run as localhost on the automation engine | string | N |
host.windows
Description: Windows-Based Operating System Connection
| Parameter | Description | Type | Mandatory |
|---|---|---|---|
| host | The host name to connect to | string | Y |
| tempPath | The temporary path on the host name that can be used by the solution | string | N |
http.host
Description: Http Host Connection
| Parameter | Description | Type | Mandatory |
|---|---|---|---|
| url | The connection URL | string | Y |
repo.artifactory
Description: Artifactory Repository Connection
| Parameter | Description | Type | Mandatory |
|---|---|---|---|
| url | The connection URL for the instance | string | Y |
| user | The user name to connect to the database | string | Y |
| password | The encrypted password to connect to the database | string | Y |
| repository | The repository name within the instance to connect to | string | N |
socket
Description: socket Connection
| Parameter | Description | Type | Mandatory |
|---|---|---|---|
| hostname | The host name | string | Y |
| port | The port number | string | Y |