Installing A FCF Connector

For testing purposes, you can install your Connector in your local TIBCO Scribe® directory. This makes your Connector available for your site.

  1. Stop the TIBCO Scribe® Agent Windows service.
  2. Navigate to the TIBCO Scribe® Connectors directory:

    ..\Scribe Software\TIBCO Scribe® Online Agent\Connectors\

  3. In this directory, create a new sub-directory for the Connector you want to test.

    Connector sub-directory names must not contain the word connectors. Using connectors in the sub-directory name prevents TIBCO Scribe® 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.

  4. Copy the compiled .dll file for your Connector, as well as any required supporting files into the new directory. For example, if your Connector is called ScribeSampleConnector, you need to copy the following files:
    • Scribe.Sample.Connector.dll
    • Simple.Connector.Framework.dll
    • NewtonsoftJson.dll
  5. Restart the TIBCO Scribe® Agent Windows service.
  6. After a few minutes, the Connector appears in the list of available connections in the TIBCO Scribe® user interface.
  7. Set up a connection with the newly installed Connector.
  8. Set up a TIBCO Scribe® solution that uses the new connection.

Troubleshooting

If you have installed your Connector as described in the instructions above, but you do not see the Connector in the drop-down list on the Connection dialog, the files may be blocked by your operating system. To unblock the files:

  1. Stop the TIBCO Scribe® Agent Windows service.
  2. Navigate to the TIBCO Scribe® Connectors directory:

    ..\Scribe Software\TIBCO Scribe® Online Agent\Connectors\

  3. Locate the sub-directory for the Connector you want to test.
  4. Right-click each file in the sub-directory and select Properties.
  5. On the Properties dialog, select the Unblock option on the General tab and click OK. For example, if your Connector is called ScribeSampleConnector, you need to unblock the following files:
    • ScribeSampleConnector.dll
    • ScribeSampleConnector.pdb
    • ScribeChangeHistory_Create.sql
    • ScribeDelete_Trigger.sql
  6. Restart the TIBCO Scribe® Agent Windows service.
  7. After a few minutes, the Connector appears in the list of available Connectors in the Connection dialog in the TIBCO Scribe® user interface.

If you moved the files as a compressed ZIP file, you can right-click the ZIP file and unblock all of the contents at once. Then extract the files to the correct location and use your Connector.

See the TIBCO Scribe® Help Center for more information about working with TIBCO Scribe® Agents, which describes installing an Agent, creating connections, and creating a solution.

You may also need to deploy the System.Collections.Immutable.dll. See Download And Install The System.Collections.Immutable DLL for additional information.

See Also

Fast Connector Framework (FCF)