Group-by Connector
Overview
The Group-by connector is a system provided connector that can be used to group the entity data of other connector entities. Grouped entity data is collated into multi-valued fields.
Technical Requirements
There are no explicit requirements for this connector following installation.
Usage
A Group-by connector reads entity data from its configured target connector, but cannot perform any update actions. Updating must be performed on the target connector itself, which can be then be imported by the Group-by connector.
| Reading | Yes |
| Writing | No |
| Deleting | No |
| Polling | Yes |
Schema
Fields in a Group-by connector schema will imported from the target connector. The imported will be adjusted in the following ways.
| Field | Imported field |
|---|---|
| Fields configured to group on | Same type (must already be single-valued type), set to read-only, set to key (must already be required). |
| Fields of type Binary | Omitted if not selected as a grouping field as multi-valued binary is not a supported field type. |
| All other fields | Converted to the corresponding multi-valued type if a single-valued type, set to read-only, required. |
WARNING
Group-by connector operation is determined by the configured schema, with the connector configuration only used to generate the schema when it is imported. Group-by connector schema fields can not be added or modified, and only non-key fields can be deleted. If you wish to modify the schema, adjust the connector configuration, clear the connector schema and re-import the schema from the target connector.
Configuration
The Group-by connector has the following configuration options.
| Name | Description |
|---|---|
| Target Connector | The connector to read entities from for grouping. |
The connector must also be configured with at least one field to group on. Only fields that are of single value types and are required can be grouped on.
