Join us for a deep dive into the Scribe Online CDK and Connector Development!
Scribe Online is a cloud based Data Migration & Integration tool built on top of the Azure platform and offers robust customization capabilities through it's CDK to connect to any software platform!
2. What is CDK?
CDK Basics.
Scribe Online API
Connector Development Deep Dive
Q & A.
Agenda
2015 CloudFronts Technologies LLP, All Rights Reserved.
2
4. CDK is Connector Development Kit that Scribe provides to
help you develop your own connector.
Connector is an C# program written to allow Scribe Online
users to create a common user experience to carry out
integration between two technologies.
What is CDK ?
2015 CloudFronts Technologies LLP, All Rights Reserved.
4
6. CDK Basics
2015 CloudFronts Technologies LLP, All Rights Reserved.
6
Connectors can be developed for:
- Scribe Online Replication Services (RS)
- Scribe Online Integration Services (IS)
Basic Components of Connectors
- Connector itself.
- User Interface (UI), which collects information from user.
7. CDK Basics
2015 CloudFronts Technologies LLP, All Rights Reserved.
7
Agents –
Facilitates communication between datastores. Provides secure
connection to the organization without opening security holes.
Organizations –
Represents company who is using Scribe Online.
Connections –
Login and other information used by Scribe Online needed to
connect to the datastore.
8. 2015 CloudFronts Technologies LLP, All Rights Reserved.
8
CDK Basics – Scribe Online Architecture
Cloud
agent
Web
Browser
Scribe
Cloud
On-
premise
agent
F
I
R
E
W
A
L
L
Cloud-based
Applications
On-premise
Applications
10. 2015 CloudFronts Technologies LLP, All Rights Reserved.
10
Scribe Online API
Namespaces
Core Connector API
Connector API Actions
Connector API Common
Connector API Connection UI
Connector API Cryptography
11. 2015 CloudFronts Technologies LLP, All Rights Reserved.
11
Scribe Online API
NameSpaces
Connector API Exceptions
Connector API Logger
Connector API Metadata
Connector API Query
Connector API Serialization
12. 2015 CloudFronts Technologies LLP, All Rights Reserved.
12
CDK Reference
https://help.scribesoft.com/cdk/en/index.htm
Intro about webinar
Intro about team members
Everyone will be muted
Let’s look at the agenda for the same.
What is cdk
Some CDK basics to look at
Scribe Online API
Connector Development Deep Dive by Somesh – we will be developing a sample connector where I will need to put Leads into GP from CRM
Lastly, Questions and Answers.
Let’s look at what CDK is.
CDK is…connector development kit. Scribe provides with the help of which you can develop your own connectors.
You need to build your own connector if you want to have a customized interface of how you want to integrate your source and target datastores.
Eg. Dynam GP doesn’t expose custom entities in the OOB Dynam GP connector which Scribe provides (this is coming up in 2016 though)… so I want to build my own connector to connect to my custom entities in GP.
Let’s also look at some CDK basics which we need to know to develop a connector
Agents – windows service on server to talk to the SOL without disturbing the security of the server.
Organization – company using the Scribe Online service to carry out integrations for source and target
- Connections – contains information to connect to intended data store, has details like server url, username, pass being most common.
Scribecloud – windows azure, access using web browser, source- cloud and target-on-prem…
Cloud agent for cloud based, windows service as agent on server.
Let’s look at scribe online API – it has namespaces needed to build your connector.
Core Connector API– runtime link between scribe online and target technology.
Connector API Actions – Connector specific logic and Input and Result objects.
Connector API Common – common objects throughout the connector, dataentity
Connection UI – objects used in PreConnect() to define GUI
Cryptography – encrypt/decryp
Exceptions – Connector-specific exceptions
Logger – Connector Log file
Metadata – connector capabilities, IMetadata, to support the design process.
Query – request for data by describing objects to be returned & their relationships, fields of interest, constraints of the results.
Serialization – serialize and deserialize.
Exceptions – Connector-specific exceptions
Logger – Connector Log file
Metadata – connector capabilities, IMetadata, to support the design process.
Query – request for data by describing objects to be returned & their relationships, fields of interest, constraints of the results.
Serialization – serialize and deserialize.
Thank you Priyesh for your detailed
PreConnect: PreConnect allows a connector to define the user interface (UI) that users use to create connections. There are two ways to implement Preconnect. We use Preconnect to specify any fields, such as Username, Password, or Database Name, that require user input to connect to your technology.
Provision for optional fields on the form. For e.g. Tenant ID
Once a connection has been created, Preconnect is only called again if a user re-opens the connection UI to adjust the connection settings.
Connect: This method will attempt to connect to the third-party.
It will set the IsConnected Flag, if the code is able to connect to the third party successfully.
If it is successful, we will see the message on the UI, when we run the Test Connection.
Disconnect: This method will attempt to disconnect from the third-party. Disconnect is called to instruct the Connector to close communication from its datastore and free any resources that may be associated with the connection.
ExecuteOperation: ExecuteOperation is called by Scribe Online to perform an operation, such as Create, Update, or Delete, on a given data object type, for example, an Lead. Implement as many of these operations as possible, as dictated by your data technology. These operations are passed with the OperationInput object, which describes the details of the operation, such as: matching criteria, fields to map, and other operation details.
ExecuteQuery: ExecuteQuery is called by Scribe Online as a request for specific data from the connector. The query object received by this method may include constraint information as well as information about which object or objects are being queried.
IsConnected: Gets a value indicating whether the connector is connected to its third-party
GetMetaDataProvider:
GetMetadataProvider is a required method
It is called by Scribe Online to retrieve an active instance of the Object that inherits the IMetadataProvider interface.
This allows Scribe Online to access the IMetadataProvider specific methods.
Thanks. You can reach us on the email addresses.
Also, you can follow us on twitter on ….
We will post this session tomorrow on youtube.com/cloudfronts
Once again, thank you for your time today.