Configuring connectors
Connector configuration is performed through the Plugin administration page and is organized into two levels.
The Connector utilities plugin page offers a centralized overview of all installed connectors, their instances, and their executions, in read-only mode.
Each connector also provides its own dedicated administration page. These pages are used to configure connector-specific settings and to manage connector instances.
Important
Connector instances should always be managed through the administration page of the corresponding connector. Direct modifications to the underlying classes are not recommended and may lead to inconsistent configurations.
Connector utilities
The Connector utilities plugin page provides an overview of all installed connector plugins.
For each connector, the corresponding administration section is displayed inside a dedicated panel. These sections can be expanded or collapsed independently, making it possible to focus on a specific connector while still maintaining visibility over the overall connector landscape. It also allows to execute the connectors and to easily be redirected to the corresponding page.
In addition to connector administration, the page also allows to change the number of days that should pass before the
ConnectorRun cards are deleted by the maintenance job.
Connector administration page
Each connector provides a dedicated administration page where its instances can be managed and monitored.
The component consists of a grid built based on the subclass of the class ConnectorSource of the specific plugin. In
this grid, all the instances of the connector are shown and can be created, modified or deleted. Two more columns are
added which show the status and the date of the last execution of each instance, to have immediate feedback of the
current state of the connector. Lastly, each row has an icon that allows to execute the instance on the spot.
The top bar is composed of:
- Add button: allows the creation of cards, only enabled if in edit mode
- Search bar: filters the grid
- Refresh button: refreshes the grid
- Configuration button: opens a popup with the plugin's configuration, and if in edit mode allows to change them
- Batch execution button: starts the batch execution for the connector (executes all active instances in sequence)
- Redirection button: redirects to the tasks menu where the task that automatically executes the connector each day is present
When clicking a row of the grid, it is expanded with all the information of the card and with another section reporting all the executions of the instance. In the top right, there are some icons that allow to see the card's history, update the Active attribute in one click, edit the card and delete the card.
Connector Configuration
Each connector exposes a configuration dialog accessible through the configuration button in the administration page.
Besides connector-specific settings, all connectors support a common set of configuration options:
| Config | Default | Description | Notes |
|---|---|---|---|
| Error handling strategy | Accumulate errors | Allows to choose the error handling strategy | Possible values: Accumulate errors, Terminate handler, Terminate gate (see Error handling strategy) |
| Skip system branch | false | Allows to ignore the system branch during connector execution, if not needed | |
| Skip application branch | true | Allows to ignore the application branch during connector execution, if not needed | |
| Execute branches in parallel | true | If enabled, the connector will execute both branches simultaneously. Otherwise, branches will be executed sequentially | |
| Application gate name | Name of the gate to execute to start the application branch |
Error handling strategy
The Error handling strategy option defines how the connector behaves when an error occurs during its execution:
- Accumulate errors: the error is recorded and the reading of the current instance continues
- Terminate handler: the reading of the current instance is stopped and the execution moves on to the next instance
- Terminate gate: the whole execution is stopped