Skip to main content

Getting Started Connector Development

One of the benefits of working with Scribe Online is how easy they make it to create connectors if one does not exist.  In this blog post we are going to look at how to get setup, if this is the first time you have made a connector for Scribe Online.  But, before we get into that, we should first make sure that a connector doesn't already exist that can handle what we need.

We can do this by looking in the Scribe Online Marketplace.  Still not seeing what you need?  Reach out to Scribe directly or ask in the Scribe forums if a connector exists for an application.  There are instances where a connector exists but is not listed in the marketplace.  An example of this is for a client that I built a connector for.  They didn't want to setup a system to run the on-premise agent, so they asked me to set up the connector to run on Scribe's cloud agent.  This meant that I had to submit the connector to Scribe for validation.  Once published the connector is in the Scribe marketplace, but hidden.  Access to it is managed from within the client's Scribe Online org.  This means that only people that ask them for access can use it.  But, unless they tell you this, you won't know it.  So, it's worth asking Scribe before starting to develop a connector, if one exists.  As mentioned before, even if one doesn't Scribe makes it really easy to create one.

In this blog post we are only going to go over what you need to get setup.  We won't be getting in depth on connector development, that will come in future posts.  You will need the following to create connectors:

I will assume that if you are reading this you are already familiar with writing code and have Visual Studio installed.  If that is the case, then all you need to do is install the GitLab extension (only needed if you are going to publish to Scribe for validation or if you don't have a current source control solution).  At this point we will now install the fast connector framework (FCF) for both messaging and integration.  To do this, go into the FastConnectorFramework folder in the CDK that you downloaded.  There you will see 2 folders, each containing a .vsix file.  With visual studio closed, double click on these files to install the extensions in Visual Studio.  Once this is done, you will see the below, when creating a new project in Visual Studio:


With this all setup we can create connectors with the FCF for integration or messaging.  We can also create connectors from scratch using the CDK.  Then we can upload them to Scribe if we want them in the marketplace or use them with the cloud agent.  In future blog posts, we will go more in-depth on connector development and the differences between using the CDK or FCF.  I just wanted to put this post out as an introduction to connector development.

Comments

Popular posts from this blog

Dynamics 365 v9 Unit Testing and .NET Confusion

Recently while creating a plugin for Dynamics 365 v9, I ran into an issue trying to connect to CRM via the tooling connector in my unit test project.  The underlying problem was that the .NET version I was using in my unit test was 4.5.2.  This was preventing me from being able to connect to CRM to create my organization service.  I updated the .NET version on my unit test project to 4.6.1 and was then finally able to connect.  I will also add that I am using the latest nuget package version for Dynamics 365 v9.

For consistence, I updated the plugin project I was working on to .NET 4.6.1.  Locally, everything was working great.  I was able to connect to CRM and make sure that all the methods I had written did what they where suppose to do using test driven development practices.

Then when publishing my plugin via the latest version of the plugin registration tool, I received an error and could not publish my plugin.  The error was due to the .NET version of my plugin project not bein…

SCRIBE Connector Development - Handling Array List

Are you working on creating a connector with SCRIBE's CDK?  In your connector do you have an array of strings or list of  strings that you need to pass?  SCRIBE makes this easy to do within the CDK and SCRIBE Online.

I came across this scenario on a connector I was creating that passes a JSON message to an API.  In the JSON message it had a list of strings for entity ID's. Here is an easy way to accomplish this:

1) Create you Property Definition as past or your Object Definition.
1: new PropertyDefinition 2: { 3: Description = "Use TOLIST() to pass in a list of entity id's.", 4: FullName = "Entity IDs", 5: IsPrimaryKey = false, 6: MaxOccurs = 1, 7: MinOccurs = 0, 8: Name = "PublishTo", 9: Nullable = true, 10: NumericPrecision = 0, 11: NumericScale = 0, 12: PresentationType = "string", 13: PropertyType = typeof(string).Name, 14: Use…