TIBCO Scribe® SDK Overview

TIBCO Scribe® has developed a universal method to allow most APIs to talk in a common protocol. Our SDK contains several tools that make it easy to implement a connection to virtually any API. Once a “Connector” is available, business users can leverage our simple but powerful visual “drag and drop” design environment to create and manage complex custom solutions without coding.

TIBCO Scribe® provides additional features to end users to manage the entire integration life-cycle including: provisioning, deploying, managing configuration, and monitoring executions as a complete end-to-end integration solution.

Getting Started Options

The TIBCO Scribe® Marketplace has extensive library of Connectors, provided both by TIBCO Scribe® and third-parties, to a large number of commonly used applications such as Salesforce, Oracle, and Microsoft Dynamics 365. If you don’t find a Connector in our marketplace to solve your integration problem, we provide you with a set of tools to build your own.

There are two options provided in the SDK to get you started on your Connector development projects, the Fast Connector Framework (FCF) and the Connector Development Kit (CDK).

The Fast Connector Framework is a light weight development kit designed to allow a developer or Business Analyst with limited knowledge of TIBCO Scribe® to create a basic Connector in hours instead of days. Inside the FCF there are two frameworks available:

  • Integration Framework — Build a basic Connector that uses JSON or XML to communicate with the external APIs of your applications and underlying datastores. Use this simple Connector to easily query or perform operations on an external system from TIBCO Scribe®.
  • Messaging Framework — Setup a Connector that parses inbound messages, also known as Webhooks, to TIBCO Scribe® from an external system.

The other more complex option for creating a Connector is our Connector Development Kit (CDK), which supports implementing Connections to almost any API.

Prerequisites

Technical business users are able to use the FCF to deploy simple Connectors. For more complex integration needs, a developer can use the CDK. Refer to the limitations of the FCF to determine the best path for your organization. See Fast Connector Framework (FCF).

TIBCO recommends that anyone trying to leverage the CDK be competent in .NET development and have a thorough understanding of the application API or technology to which you are connecting via TIBCO Scribe®. Developers will also benefit from ancillary skills with web services, relational databases, and testing.

Additional skills should include general API / SDK development experience using C#, or Visual Basic; and supporting tools. All sample code and examples are written in C#.

Developers do not require previous experience with TIBCO Scribe® technologies, architecture, or internal data structures.

Requirements

To develop a TIBCO Scribe® Connector with the CDK, requires the following development environment:

  • Microsoft .Net 4.7.2

Some sample project scripts included in the SDK require Microsoft SQL Server. If your site does not use Microsoft SQL Server, you can download a free copy of Microsoft SQL Server Express.

Considerations

TIBCO Scribe® Connectors can be as feature rich as the API of the target system allows. When you are designing your Connector, there are some things you should consider in advance. See Connector Design Considerations for a detailed list.

TIBCO Scribe® Developer Programs

To create a Connector that is available to users outside of your Organization, review the following: 

TIBCO Community

In the Cloud Software Group Community, you can access a Knowledge Base and Discussion Forums called Answers to learn and share information about TIBCO Scribe®, TIBCO Cloud™ Integration, and TIBCO Scribe® Connectors.

Disclaimer

Copyright © 2023 Cloud Software Group, Inc. All Rights Reserved.

No Support. You acknowledge that TIBCO will not provide any maintenance or support for this software. You have no right to receive any upgrades, patches, enhancements, bug fixes, new versions or new releases of the software.

Internal Use Only License Grant. TIBCO hereby grants you a limited, non‐transferable, non‐exclusive license to use the software solely for your internal business purposes. The name of TIBCO Software Inc. may not be used to endorse or promote products derived from this software without specific prior written permission of TIBCO Software Inc.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT OWNERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

See

Fast Connector Framework (FCF)

Connector Development Kit (CDK)