Scribe Online is a powerful platform, a collection of tools, a data integration solution, and much more. Scribe 101 breaks down and defines each Scribe Online component in common terms to help you take advantage of all the flexibility Scribe Online has to offer.
Scribe’s goal was to come up with an easy way for business users to configure a method for different applications to talk to each other without having to write their own code.
See our Benefits of Using An Integration Platform as a Service(iPaaS) for ISVs video for additional information or refer to the Platform section below the video to read about all of the Scribe Online Components.
- User Interface — Our Responsive HTML5 user interface provides advanced design features enabling business users to create Solutions that move or manipulate data from any number of source or target applications or technology solutions. The UI includes monitoring and administration tools. Scribe Online UI features and functions are available through the Web API.
- Web API — Scribe’s RESTful API is the key to communicating with the platform. The Web API is used by Scribe Online Agents, the UI, and other applications to control every aspect of the platform. This allows developers to create or extend their own User Interface by embedding logic to perform any Scribe Online function. The end user is not required to use the Scribe Online UI or even know Scribe is involved.
You can run the Reference Application against your Scribe Online trial Organization to see how it works. See Web API — Reference Application Example — Advanced Provisioning, Configuration, And Simple Monitoring 401 or access the application directly: Reference Application.
- Agents — Lightweight Windows services that can be deployed locally or in the Scribe Online Cloud. Agents communicate with the Scribe Online Cloud using the Web API and connect to a service bus to be in live contact with the platform. Local Agents use an outbound connection to communicate with the Cloud from a local installation site eliminating the need to open your firewall to inbound traffic. Further security restrictions are possible in this scenario. Agents handle all data integration jobs and, depending on the source/target data, a local Agent install provides better performance. Using a local Agent provides the added benefit of creating your own code, installing it on the Agent, and running it using that Agent to connect to a custom data source.
- Built-in REST JSON Endpoints — Out of the box, without any code, users can configure an integration end-point to consume JSON and use it to kick off a process and return results. These are Request/Reply Solutions and are used when a reply is needed. See Webhook Support.
- Connectors — A Connector is a piece of software used to move data between specific applications using those applications' APIs. Connectors are installed on the Agent through the Web API, the UI, or manually on a local Agent. They are responsible for authentication to the third-party system, gathering metadata used to design Solutions, and transforming metadata into the format needed. Once a Connector is installed, the user can configure a Connection, which is the configuration of the parameters required by the Connector to connect to the datastore for a specific application, such as. user name, URL, etc.
Today there are over 100+ Connectors created by Scribe or other developers. Scribe created Connectors are maintained and regularly updated. Third-party developers are responsible for the upkeep and support of the Connectors they publish. To see a list of our existing Connectors, see our Connector Marketplace.
Connectors can be distributed through the Scribe Marketplace, making them available for other users of the platform, or privately where the Organization that owns the Connector authorizes another Organization to use it.
If you install a Connector on a local Agent, the Connector does not need to be placed in the Scribe Marketplace, but it cannot be easily provided to other Agents. Placing a Connector in the Scribe Marketplace makes it available for easy installation on both a local Agent and the Scribe Cloud Agent.
Scribe employees have created Sample Scribe Labs Connectors as fun projects or prototypes, some of which exist in the Scribe Marketplace. These Sample Connectors are available in GitLab and anyone is welcome to take these Sample Scribe Labs Connectors, modify them, and repurpose and publish them. Scribe considers them open source examples.
- Software Development Kit (SDK) — Contains the following tools to create Connectors.
- Fast Connector Framework — A great jumping off place for a simple Connector that supports JSON/XML, with some are limitations.
- Connector Development Kit (CDK) — A full blown toolkit used to connect to any api using any method of authentication or transport. Examples and samples are provided in our GItLab repository, plus we have extensive documentation, tutorials, a developer forum, and other resources available to get you started quickly.
- Core — Responsible for handling communications between the Web API and Agents and storing configuration and status. The Core makes it easy to manage separate Organizations that contain their own agents, installed Connectors, configured connections to data sources, and other administrative features. Organizations can be stand-alone, or grouped under a parent account in parent/child configuration a to provide group licensing options.
- Licensing — Scribe is licensed by Organization, the number of Connections configured, and the tier of connections for Scribe created Connectors. There is no cost to a developer.
- Sandbox Development Account — Full version of the entire platform available for a developer to use when creating a Connector or implementing functions of the Web API. Limitations do exist on the amount of data that can be transferred and should not be used as a production environment.
- Solutions — Solutions are the glue that brings Agents, Connectors, Connection information, run instructions, and data mapping together. These objects function in concert to move data from one datastore to another.
- Maps/Blocks — A Map is a visual representation of the instructions needed to integrate your data.
A business user without any coding experience can easily use the drag and drop interface to create customized integrations. Metadata gathered by the Connector is exposed through the user interface during the Map design process. Map and Block properties can also be configured using the Web API.