When you create your own TIBCO Scribe® Online Connector, you have two options for deploying it. If you want your Connector to be available in the TIBCO Scribe® Online Marketplace, you can work with TIBCO to have your Connector certified. If you just want to install your Connector on a specific On-Premise Agent, you can do that yourself by copying the Connector and its supporting files to a special folder under the Agent installation folder. For testing or production purposes, you can manually install a Connector that is not downloadable from the Marketplace.
Notes:
- Connectors installed in this manual way are not propagated to other Agents within your TIBCO Scribe® Online Organization. You need to install the Connector on every Agent that needs the Connector.
- This manual deployment option is only available for On-Premise Agents where you have access to the file system to create the folder and copy the Connector files. This manual deployment is not available for Cloud Agents.
- The Connector must be installed in its own folder under the "Connectors" folder.
NOTE: Connector sub-directory names must not contain the word connectors. Using connectors in the sub-directory name prevents TIBCO Scribe® Online from finding the Connector and displaying it in the drop-down on the Connection dialog. Errors are generated in the Agent logs indicating that the Connector cannot be found.
- If this is a new Connector, it must have a unique ID compared to other Connectors.
- If it is a new version of an existing Connector, the version number must be incremented in the Connector. If a connector with the same ID exists in the marketplace with the same version number, it could overwrite the local copy of the Connector you just installed.
To Manually Deploy The Connector For The First Time
- Stop the Scribe Agent Service for the Agent where you want to install the Connector.
- If you have an instance of the Connector already installed on this Agent, move the parent folder for the Connector and all child files to another folder besides the “Connectors” folder. Note: Renaming the folder does not hide it and causes a silent conflict.
- The new files must go into an appropriate sub folder under "C:\Program Files (x86)\Scribe Software\Scribe Online Agent\Connectors".
- Right-click all of the DLLs and mark them Unprotected. If you copied the files from the internet, the operating system may have set the status of the files to a protected state without telling you.
- Restart the Windows service for the Agent.
On a first time installation, when the Agent starts it will detect a new sub-folder under Connectors, and set up the Connector for use in the Organization where the Agent resides. Note that it might take a couple minutes for the Connector to be available to create a connection in TIBCO Scribe® Online.
NOTE: If you cannot see the Connector in the drop-down list in the Connection dialog, the DLLs may be blocked. See
Cannot See Custom Connector in Scribe Online.