Connector Function
Connector functions are configured requests defined on connectors that apps can utilized for sending and receiving data to the source of the connector. They abstract over the specifics of SQL or HTTP to present a standard input and output signatures composed of known variable types. For example a function 'Get Work Orders' might have a signature such as:
INPUTS:
1. Status (string)
2. Customer (string)
OUTPUTS:
1. Array of work orders
- Delivery date (date)
- Part ID (string)
- Part count (number)App editors can use these functions in apps without worrying about complex issues such as authentication, networking, how to write queries, HTTP headers, etc. Defining how the inputs are used to retrieve the data, is different for SQL and HTTP connectors.
Response Size Limits
All HTTP and SQL response payloads are limited to:
- 20mb for Cloud Connector Host
- 50mb for On-Prem Connector Host
If exceeded, a "400 PayloadSizeLimitReachedError" error will be returned.
Fields for all connector functions:
| Name | Description |
|---|---|
| Name | The name of the connector |
| Is Saved | Once a connector function is saved the inputs and outputs can be modified only if the connector function is not being used by an App |
| Where Used | List of apps using a particular connector function |
| Inputs | The composition of variable types an app must provide to call the connector function. Data types include: Text, Integer, Float, Boolean, Datetime. |
| Outputs | The composition of variable types an app can expect to receive from the connector function. Data types include: Text, Integer, Float, Boolean, Datetime and arrays of these data types. |
| Activation Status | A boolean that determines whether the connector function is active or deactivated |
| Description | A text description provided by the user who created the function (optional) |
Additional fields for SQL connector functions:
| Field | Description |
|---|---|
| Use multiple rows | A boolean value that indicates whether the expected output is a single object matching the defined outputs, or an array of objects matching the defined output. |
| Query | The SQL query used to retrieve the data. The query can utilize connector inputs in its definition. More on SQL queries |
Additional fields for HTTP connector functions:
| Field | Description |
|---|---|
| HTTP Request Method | One of: GET, HEAD, POST, PUT, PATCH, DELETE more info |
| Authentication | If the authentication is unset at the connector level, it can be set at the function level. |
| Request Headers | A list of request header key/value pairs. These values can utilize input values. |
| URL Path | The path portion of the HTTP request. The path can utilize input values. |
| Query Parameters | A list of key/value pairs that are added to the query portion of the request URL. These values can utilize input values. |
| Request Body | The request body can be one of four types: JSON, form URL-encoded, plain text or XML. The request body can utilize input values. |
| Response Body | Whether the response body is JSON or XML. This setting determined how extracts are used to determine output values. |
| Outputs extractors | For HTTP connectors each output must also define the extractor for retrieving the data from the body, header or cookie of the HTTP response. |
| Encoding Settings | For HTTP connectors, function input for text data type can have a custom encoding schema which allows escaping non reserved characters. |
Input Encoding Settings
The inputs to connector functions of the following types can have unique encoding selected:
- Text
- Image
Text Input Encoding Options
| Type | Description |
|---|---|
| Automatic Encoding | Characters will be escaped according to the location of usage. For more information visit Tulip knowledge base |
| No Encoding | No characters will be escaped. This may cause errors in the path or query if any characters besides the following are passed through: A-Z a-z 0-9 - _ . ! ~ * ' ( ) |
| Path encoding | All characters except the following will be escaped:A-Z a-z 0-9 ; , / ? : @ & = + $ - _ . ! ~ * ' ( ) # |
| Query encoding | All characters except the following will be escaped: A-Z a-z 0-9 - _ . ! ~ * ' ( ) |
| Base64 encoding | The text will be Base64 encoded |
Image Input Encoding Options
| Type | Description | | Image URL | The url to the cloud hosted image will be used within the connector. This input can be used anywhere text can be used within function configuration. | | Base64 | The image will be encoded as base64. This input can be used anywhere text can be used within function configuration. | | File | The image will be encoded as multi-part form data. It can only be used within the files section of the payload configuration. When files are included in the payload, only JSON encoded payloads can be configured. |
Fields for read-only connector functions:
| Name | Description |
|---|---|
| Name | The name of the connector |
| Read only | Read-only connector functions are used by published apps which cannot be modified. Users with the right permissions can test the read only connector function. This states the app and the version of the app using the read-only connector function |
| Inputs | The composition of variable types an app must provide to call the connector function. Data types include: Text, Integer, Float, Boolean, Datetime. |
| Outputs | The composition of variable types an app can expect to receive from the connector function. Data types include: Text, Integer, Float, Boolean, Datetime and arrays of these data types. |
| Activation Status | A boolean that determines whether the connector function is active or deactivated |
| Description | A text description provided by the user who created the function (optional) |
Tests
| ID | Name |
|---|---|
| QA-T57 | Variable Widget : 02 - Record View: Compound variables can be used with triggers |
| QA-T148 | SQL Connectors : 02 - Add Function to SQL Connector |
| QA-T240 | HTTP Connectors : 02 - Add several functions to HTTP Connector |
| QA-T725 | HTTP Connectors : 04 - Extractors for Non-Json Formats and Cookies |
| QA-T726 | SQL Connectors : 03 - Verify different SQL Servers |
| QA-T727 | HTTP Connectors : 03 - OAuth 2 Admin/Operator |
| QA-T728 | HTTP Connectors : 05 - Non-2xx Responses |
| QA-T729 | HTTP Connectors : 06 - HTTP Connector Functions perform the same with TLS on/off |
| QA-T731 | HTTP Connectors : 07 - OAuth 2 send request data as JSON |
| QA-T810 | mobile : 12 - HTTP Connectors : 03 - OAuth 2 Admin/Operator |
| QA-T840 | HTTP Connectors : 08 - URL encoding function |