Scribe Tech Tour Presentation on Scribe Online CDK and API Overview and extending Scribe Online

1. Scribe Online CDK and API Overview
Extending Scribe Online

2. 4
Session Abstract
With Scribe Online, connecting with new endpoints for integration or
interacting with the application from an external program are within
your reach by using Scribe Online tools. In this presentation we will
give you examples of common use cases for extending Scribe Online
and an overview of the developer tools and resources available to help
you get the job done.

3. 5
Agenda
• Creating your own connector for Scribe Online
◦ Define what a connector is and what it does
◦ Why would you want to build a connector
◦ Using the Fast Connector Framework and the CDK
• Scribe Online API
◦ Use cases for using the API
◦ API interactive documentation in the Swagger framework
◦ New APIs available with new version of Scribe Online

4. Scribe Online Connector Overview

5. 7
Simplified Connector Architecture and Capabilities
• Authentication – Getting
Scribe Online logged in to
the endpoint
• Metadata – Collecting
metadata from the endpoint
and communicating with
Scribe Online for
presentation in the app
• Query – Return a set of
records from an endpoint
• Execute Operations –
Create, Update, or Delete
operations when the job
runs

6. 8
Why Build a Connector
• Project requires access to an application or endpoint that Scribe
Online does not have a connector for
◦ data service
◦ application API
◦ technology layer
• Purpose build a basic connector for that one project
• You use the connector on multiple projects

7. Fast Connector Framework
For basic connectors

8. 10
What is the Fast Connector Framework?
• A programming framework for developers or business analysts with
limited knowledge of Scribe Online to build a basic connector in days
not weeks
• A Visual Studio solution/extension for creating a connector,
developed in C#
• Tedious connector coding is pre-built (i.e. serialization, conversions,
connector connection UI, commands, error reporting, etc.)
• Simplifies connectivity/authentication, GET/POST/PUT code

9. 11
Fast Connector Framework Use Cases
• For proof of concept projects or purpose built connectors with simple
needs for cloud or SaaS apps:
◦ REST and simple HTTP (not built for SOAP)
◦ Basic Authentication only (no OAuth support)
◦ Queries with simple filters, AND only, no OR, equals operator only
• Block types: query, lookup, fetch
◦ Relationships not supported, no parent or child data
◦ Create operations, can be adapted to do Update, no Deletes
• Basic metadata support for entity names, field names, and data types

10. 12
Fast Connector Framework Requirements
• Prerequisites
◦ Knowledge of simple HTTP web services, JSON
◦ Developers do not require previous experience with Scribe Online
technologies, architecture, or internal data structures
• Requirements
◦ Microsoft Visual Studio 2013 or higher (works with Community)
◦ Microsoft .Net Framework 4.5
◦ A trial or paid subscription to Scribe Online Integration Services (IS)
◦ API of the application being accessed must support simple HTTP web services
◦ Base URL for the API
◦ Credentials for the API

11. 14
Introducing Scribe Labs
• While looking for faster, better ways to create connectors, we’ve built
samples that we’d like to share.
• Some Available today in the Scribe Online Marketplace – links available
for details and Data Sheet.
• Experimental in Nature – some using the Fast Framework – all indicated
with the flask.
• Free – offered “as is”, while we will try to assist, they have not received
the same amount of attention as Scribe Connectors.
• Looking for feedback and if they should become full fledged Scribe
Connectors.

12. 15
Scribe Lab Connectors
SMTP – Email Connector
FileStream - moving binary data when mapping data from
one datastore to another
Nextcaller – advanced caller ID
SMS – Text Messaging
Zillow - Real Estate Listings

13. 16
Fast Connector Framework Resources
• Online help
• Visual Studio extension (FastConnectorWizard.vsix)
• Sample connector project with White Pages web service
• Video tutorial
• Available October
• Accessed through the Scribe Online CDK online help
http://help.scribesoft.com/cdk/en
• Postman - https://www.getpostman.com
• Fiddler - http://www.telerik.com/fiddler

14. 17
Postman
• No
programming
• Explore and
test HTTP APIs

15. 18
Fast Connector Framework Methodology
Use Postman to learn how to interact with the REST web service without programming
Create and test your calls using Postman
Set up your calls in the Fast Connector Framework
Compile install your connector on a local Scribe Online agent
Test the connector through Scribe Online
Use Fiddler to inspect calls through Scribe online that error and compare to calls made using Postman

16. Connector Development Kit
For more complex connectors

17. 20
CDK Connector Use Cases
• For more complex use cases
◦ Legacy apps and APIs
◦ Multi-part calls
◦ Queries with multiple filters
• Use of the OR operator
• Use of >, <, <>, starts with, etc.
◦ Relationships
◦ Full support for all operation types: Create, Read, Update, Delete
◦ Not restricted to REST and simple HTTP
• Connectors can be controlled by the creator and monetized

18. 21
CDK Resources
• CDK Help - http://www.scribesoft.com/helpcenter/prod/cdk/en/
◦ Key concepts defined explained
◦ Design recommendations for developing connectors for different Scribe
Online services
◦ Diagrams showing interaction between agents and connector methods
◦ Object level documentation
• Sample Projects
◦ Fully functioning source code and projects for RS Source, RS Target, and IS
connectors
• Unit tests
◦ Unit test programs for testing the connector before it is deployed and
before user acceptance testing
• Free online video training from Scribe engineers

19. 22
Third Party Connectors Created with the CDK
Marketplace Connectors
Dispatch
Melissa Data Services
Exact
Intacct
Private Connectors
JIRA
EventBrite
ServiceNow
Google Calendar

20. 23
FCF vs. CDK
Fast Connector
Framework
• Limited development
skills
• REST/HTTP
• JSON/XML payloads
• Simple GET/POST/PUT
calls
Connector
Development Kit
• Experienced developer with
web service experience
• Any API*
• Any payload*
• Batch Processing
• API complex array responses
• Dynamic metadata
discovery*
And more…

21. Scribe Online API

22. 25
Scribe Online REST API
• The Scribe Online API enables you to write code that performs many
of the common operations normally performed through the Scribe
Online user intervace.
• The API objects, functionality, and workflow are similar to that of the
Scribe Online user interface.
• Often, the best way to understand how to accomplish a given task
using the Scribe Online API is to understand the steps required to
achieve the same goal using the Scribe Online interface.

23. 26
Why Use the Scribe Online API
• Deploy solutions
• Run solutions on demand from outside of Scribe Online
• Run solutions from your own scheduler or trigger
• Manage solutions
◦ enable or disable solutions
◦ query execution history

24. 27
Scribe Online API Capability
• Provisioning Agents
• Inviting and uninviting Users
• Installing and uninstalling
Marketplace Connectors
• Creating and testing Connections
• Creating IS and RS Solutions
• Cloning existing IS Solutions
• Enabling or disabling Maps in a
Solution
• Assigning and reassigning Agents to
Solutions
• Running and scheduling Solutions
• Reviewing Solution execution
• Rerunning failed Executions
• Reviewing row usage

25. © 2015 Scribe Software Corporation. All rights reserved. 28

26. © 2015 Scribe Software Corporation. All rights reserved. 29

27. 30
Scribe Online API Technical Details
• Uses SSL (HTTPS) to ensure all data is secure
• Uses HTTP Basic Authentication to validate API users
• Validates that API users have the same rights and restrictions as they do in the
Scribe Online user interface for all Organization-based methods
• Uses Scribe Online interface entities, such as Agents, Solutions, and Maps, as
REST resources that exchange data with the API as JSON objects
• Supports CRUD operations using standard HTTP verbs:
◦ POST
◦ GET
◦ PUT
◦ DELETE

28. 31
New API Endpoints
• As part of a new implementation of Scribe Online using HTML5 we
will be using the API extensively from the new app. These new API
endpoints will be publically available.
◦ Lookup Tables: create, modify values, do lookups
◦ Connection Metadata: return entity names, return entity
relationships
◦ Maps: return a list of maps, edit a map, delete a map

29. Quick API Tutorial on the Swagger Framework

30. 33
Swagger Framework
• Documentation more easily
maintained because it is created
from the code
• Discoverable

31. 34
Swagger Framework
• Interactive
• Hands on learning

32. 35
Try the Scribe Online API
• Enable API access for
your Scribe Online
Organization.
• Get your Organization
ID.

33. 36
Try the Scribe Online API
• https://dev.scribesoft.com/api/
• Enter your Scribe Online
credentials.
• Click SET.
• There is no user feedback
until you try an API; so be
sure to enter the correct
credentials.

34. 37
Try the Scribe Online API
• Select the API to Return a list
of solutions.
• Enter the orgID.
• Click Try it out!.

35. 38
Try the Scribe Online API
• View the solution
information in Response
Body.
• Copy the solution id.

36. 39
Try the Scribe Online API
• Select the API to
Return
information about
a solution
schedule.
• Enter the orgId.
• Paste the
solutionID.
• Click Try it out!.

37. 40
Try the Scribe Online API
• View the solution
schedule status in
Response Body.

38. 41
Wrap Up
• Scribe Online is extensible and the barrier may be lower than you
think
• You can create your own connectors for Scribe Online
◦ Use the Fast Connector Framework for simple connector
requirements with REST or HTTP
◦ Use the CDK for more complex connectors
• API can be used to control Scribe Online
• More APIs are being added as we build out Scribe Online v2

39. Thank You!