A connector is a configuration that defines how an app can read and write to an external data store through the functions defined by that connector. Only users with the connector admin role can create, edit and delete connectors. Tulip supports two types of data sources for connectors:
- HTTP Connector - A datasource that is accessed through the https protocol.
- SQL Connector - A database that is accessed with an SQL query.
Because connectors connect Tulip to outside data sources, it is important that users are able to set up multiple Connector Environments based on the publication lifecycle of the app version implementing a given connector. For example, if the app writes to the data source, a user would want the development version of an app to connect to a different database than the published version of the app. If the connector only implements read only functions, the connection might be the same for development and production versions. Tulip allows for 3 different ways to configure environments for a connector:
- Production Only - the same connection configuration is used for development versions, published version, and pending version.
- Production & Development - Production is used for published apps, and the development and pending version of apps use the development configuration.
- Production, Staging & Development - Production is use for published apps, development is used for development, and staging is used for apps that are pending approval.
| Field | Description |
|---|
| Name | The name of the connector. Usually this will be the name of the data source the connector is connecting to. |
| Description | An optional blurb of text telling other users the intended use or other key info about the connector. |
| Image | An optional image representing the connector |
| Type | HTTP or SQL |
| Where Used | List of Apps using a connector |
| Activation Status | A boolean that determines whether the connector function is active or deactivated |
| Connector Environments Configuration | 1 of the 3 options for connector environment configuration |
| List of connector functions | The connector functions for this connector |
