Sample CDK Projects

To help you develop Connectors, TIBCO Software Inc. has created several sample projects that are available after you download the SDK - Connector Toolkit project. The project contains the following:

  • License.pdf — License information for using the Fast Connector Framework or the Connector Development Kit.
  • ScribeToolKitOverview.pdf — Outlines the features of the Fast Connector Integration Framework and the Connector Development Kit, and provides you with use cases to determine which tool to use when developing your own Connector.
  • Fast Connector Framework Folder — Contains the following: 
    • IntegrationFramework Folder — Contains sample projects and the Visual Studio extension needed to use the Integration Framework.
    • MessageFramework Folder – Contains sample projects and the Visual Studio extension needed to use the Messaging Framework.
  • ConnectorDevelopmentKit Folder — Contains the CDK, a sample project, and a sample database.
Sample projects are intended to be used only as reference materials, not as fully functioning Connectors. See our Disclaimer regarding usage.

Review the two PDF files. If you plan to use the Connector Development Kit open the ConnectorDeveloperKit folder inside the zip file and use the following directories to access the sample project and sample database:

Scribe.Connector.Cdk.Sample Directory

Contains the following binary files, sample Connectors, and unit test suites:

  • Binaries — Contains the Scribe.Core.ConnectorApi file.dll as well as all dependent libraries.
  • Sample Connector source code — Each subdirectory contains source code for a sample Connector. Use the sample Connectors as templates to develop your own Connectors:
    • Scribe.Connector.Cdk.Sample.RS_Source — A complete TIBCO Scribe® RS Source sample Connector.
    • Scribe.Connector.Cdk.Sample.RS_Target — A complete TIBCO Scribe® RS Target sample Connector.
    • Scribe.Connector.Cdk.Sample.SYS — A complete TIBCO Scribe® IS2 Connector.
    • Scribe.Connector.Cdk.Sample.Rest.SYS — A complete TIBCO Scribe® IS2 Connector implemented with OAuth validation and a REST Web Service.
  • Connector unit test projects — Each _Test subdirectory contains a C# unit test project for the given Connector. The unit tests allow you to validate both positive and negative use cases. Use these tests as a guide for creating your own unit tests, to confirm that your Connectors are working properly.
    • Scribe.Connector.Cdk.Sample.RS.Source_Test — Unit tests for each RS Source Connector class in the sample project: metadata provider, methods, operations, and connections.
    • Scribe.Connector.Cdk.Sample.RS_Target.Test — Unit tests for each RS Target Connector class in the sample project: methods, operations, and connections.
    • Scribe.Connector.Cdk.Sample.SYS.Test — Unit tests for each IS2 Connector class in the sample project: metadata provider, operations, queries and connections.
    • Scribe.Connector.Cdk.Sample.Rest.SYS.Test — Unit tests for each IS2 Connector class in the sample project: metadata provider, operations, queries and connections.

SampleRSSourceDatabase Directory

Contains SQL scripts to create a sample database used by the unit tests for TIBCO Scribe® RS and IS2 Connectors. See Setting Up the Sample Database for more information.

The sample database is required to run the unit tests.

See Also

Setting Up The Sample Database

Sample CDK Project Unit Tests