Plugins¶
The work the Double Agent Connector does when Seeq asks comes from plugins: small Java packages, built against a published interface. The connector stays the same; what it does is what its plugins provide.
What a plugin provides¶
A plugin provides named actions, of three kinds:
| Kind | Selected by | What it does |
|---|---|---|
| Signal action | a signal in Seeq | returns samples |
| Condition action | a condition in Seeq | returns capsules: the periods that match its rules, with their properties |
| Work action | a condition in Seeq | does work that returns no data (writes a file, produces a report, tells another system); each run comes back as a capsule and is recorded on the agent's host |
Each action also says how far its results are final, which decides what Seeq caches: final once computed, never final (asked for again on every view), or final up to a period before now. See Certainty and Caching in Seeq.
Why plugins¶
- Your logic stays yours. A plugin can be kept in your own source control, built by your team or by Endeavor Engineering for you. Endeavor Engineering ships and licenses the framework; the logic, and the data it uses, stay with you.
- Only installed work runs. Each plugin provides named actions. A request from Seeq can only select one of them, never supply its own. What can run is decided on the agent's side, by what is installed there.
- Independent of Seeq versions, by default. The plugin interface has no Seeq types, so a plugin built only on it does not need rebuilding when the connector moves to a newer Seeq software development kit (SDK). A plugin that needs more of Seeq can use the Seeq SDK through the agent, and must then be built for the connector's Seeq version; the connector checks this when it loads the plugin and refuses one that does not match.
Two ways to ship a plugin¶
- As a file on the agent's host. The plugin's file (a Java archive,
.jar) is copied into the connector's plugin folder. At its next start, the agent loads it and records each plugin it found, with its name, version, vendor and actions; requests from Seeq can then select its actions. Plugins are replaced with the agent stopped. This keeps your logic in your own repository, built and released on your schedule. - Built into the connector. The same plugin compiled into the connector, so there is one product to install. This is how Endeavor Engineering could ship capabilities with the connector, each enabled by license.
Either way, each plugin runs inside the agent's process, with a time limit on each request.
Licensing¶
The license sets how many plugins the connector loads, alongside how many datasources it may use; a plugin built into the connector counts the same as one installed as a file. If more plugins are installed than the license covers, the connector says so and writes a license request for the number installed, the same way it does for datasources. Ask Endeavor Engineering about the terms.
Who builds them¶
- Endeavor Engineering, to your requirements, in your environment and your source control if you prefer.
- Your team, against the published interface. Instructions for developing plugins will be published here with the interface.
A demonstration plugin, built in its own repository as a customer's plugin would be, shows each kind end to end on Seeq's Example Data: a signal multiplied by a factor, the periods above a threshold, a condition shifted in time, and a snapshot of recent data written to a file on the agent's host, with the same signal also declared settled, never final, and final up to an hour ago.