Importing And Exporting Connectors
A Connector that is not on the marketplace — one built by your own team, or sent to you by a supplier — comes as a .ocon file. You can import it, and you can export Connectors built on this Gateway, to move them between Gateways. You will need the Optima Connectors permission.
Importing
To import a Connector:
- On the Connectors page, click Import.
- Choose the
.oconfile.
The Connector will be added under Installed straight away, with a blue bar to show it was not installed from the marketplace. There is no preview, so make sure the file comes from someone you trust: a Connector's tools run Python code on the Gateway.
An imported Connector is set up in the connector editor rather than a Configure window: click Open in editor on its card. Then:
- add its credentials, which are always blank in an imported file, on the editor's Auth tab — see Auth Profiles
- fill in any Input values its tools need, in each tool's settings window — see Tools and Inputs
- install any Python packages it needs — see Python packages
- check what environment variables it reads, shown as a chip on its card
Updating An Imported Connector
An imported Connector is not updated by the marketplace. Importing a newer file does not replace the old one: it adds a second Connector beside it, with different tool names.
To move to a newer version, delete the old Connector first, then import the new file and set it up again. Assistants that had the old one will need it granting again.
Runtime Version Mismatch
If the Connector was built for a newer Python runtime than this Gateway has, a Runtime version mismatch window will say which version it needs. You can choose:
- Open runtime manager — update the runtime first. See Setting Up the Gateway.
- Import anyway — import it now. Tools that rely on the newer runtime may fail until you update.
If The Import Fails
Import Failed means the file could not be read — for example, it is not a .ocon file, it is damaged, or it is larger than 8 MB.
Exporting
You can export a Connector that was built or imported on this Gateway — not one installed from the marketplace — once it has at least one tool.
On the Connector's card, click Export as .ocon. The file will be named after the Connector and its version — for example, hr-lookup-1.0.0.ocon.
The file contains the Connector's tools, code, settings and declared packages. Credentials are never included: whoever imports it enters their own.