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:

  1. Status (string)
  2. Customer (string)

  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.

Fields for all connector functions:

nameThe name of the connector
is savedOnce a connector is saved the inputs and outputs can no longer be modified
inputsThe composition of variable types an app must provide to call the connector function
outputsThe composition of variable types an app can expect to receive from the connector function.

Additional fields for SQL connector functions:

Use multiple rowsA boolean value that indicates whether the expected output is a single object matching the defined outputs, or an array of objects matching the defined ouput.
QueryThe 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:

HTTP Request MethodOne of: GET, HEAD, POST, PUT, PATCH, DELETE more info
AuthenticationIf the authentication is unset at the connector level, it can be set at the function level.
Request HeadersA list of request header key/value pairs. These values can utilize input values.
URL PathThe path portion of the HTTP request. The path can utilize input values.
Query ParametersA list of key/value pairs that are added to the query portion of the request URL. These values can utilize input values.
Request BodyThe request body can be one of four types: JSON, form URL-encoded, plain text or XML. The request body can utilize input values.
Response BodyWhether the response body is JSON or XML. This setting determined how extracts are used to determine output values.
Outputs extractorsFor HTTP connectors each output must also define the extractor for retrieiving the data from the body, header or cookie of the HTTP response.


QA-T57Variable Widget : 02 - Record View: Compound variables can be used with triggers
QA-T148Add Function to SQL Connector
QA-T240Add several functions to HTTP Connector