specs/models/M_CONN_ENV
Connector Environment
A connector environment is a named configuration for how to connect to a datasource. Connector environments define the information needed to authenticate to the HTTP or SQL data source.
Fields for all connectors environments:
| Field | Description |
|---|---|
| Name | Either production, staging or development |
| Connector Host | A cloud or local computer that actually runs the connector function code. |
| Port | The communication endpoint. More info |
Additional fields for SQL connector environments:
| Field | Description |
|---|---|
| SSL | Whether to use Secure Sockets Layer. see more |
| Type | The type of database. Tulip supports: Microsoft SQL Server MySQL PostgreSQL OracleDB Snowflake DB |
| Database | The name of the database |
| User | The name of the user to authenticate the request |
| Password | The password used to authenticate the request |
Additional fields for HTTP connector environments:
| Field | Description |
|---|---|
| TLS | Whether to use Transport Layer Security. See More |
| Headers | Optional key/value pairs to include in the request header. See More |
| Authentication Type | One of 3 authentication types: No Auth: No authentication specified Basic Auth: Authenticate via username and password OAuth 2 (bearer token): Authenticate via prefix and token Oauth 2 (admin) If a connector function is called, the call will be authenticated with a Tulip user's credentials Oauth 2 (operator): If a connector function is called, the call will be authenticated with an operator's credentials that they enter after starting an app in the Tulip Player If the environment uses "Basic Auth" or any "Oauth 2" method, the appropriate credentials must also be saved for that environment. |
| Username | Required if using "Basic Auth" |
| Password | Required if using "Basic Auth" |
| Prefix | Required if using "Oauth 2 - Bearer token" |
| Token | Required if using "Oauth 2- Bearer token" |
| Redirect URL | Required if using "Oauth 2- Admin" or "Oauth 2- Operator |
| Authorization Code URL | Required if using "Oauth 2- Admin" or "Oauth 2- Operator |
| Access Token URL | Required if using "Oauth 2- Admin" or "Oauth 2- Operator |
| Client ID | Required if using "Oauth 2- Admin" or "Oauth 2- Operator |
| Client Secret | Required if using "Oauth 2- Admin" or "Oauth 2- Operator |
| Scope | Required if using "Oauth 2- Admin" or "Oauth 2- Operator |
| Send token request data as query params | A boolean value that determines whether request data will be sent as query params or in the request body |
Tests
| ID | Name |
|---|---|
| QA-T580 | Dev Mode Settings - Dev Mode Configuration |
| QA-T581 | Connectors : 06 - Environment Configuration |
Requirements
| ID | Requirement |
|---|---|
| 59 | Ability to integrate legacy equipment or devices as an IIoT end-point |
| 828 | Only approved connector configuration are available for production execution activities |