Welcome to a 5-part series that will discuss the Software Development Kit (SDK) for Connector for Microsoft Dynamics. This first post provides an overview of the Connector SDK. In future posts, you will learn more about:’
Overview of the Connector SDK
Connector for Microsoft Dynamics SKD contains templates and sample code to help third-party developers and partners extend and customize Connector. The templates help developers write their own Adapters and ObjectProviders, and the sample code provides an example of how to consume the API functions. The first section of this post explains what is and is not included in this SDK, what the sample code uses as a “model service,” and information about Connector.
The SDK includes Visual Studio templates that are inside a Visual Studio Installer. All you need to do is run the .VSI file and it will guide you through installing the new templates in Visual Studio. You will be able to find these templates under the “Dynamics” category in the “New Project” and “New Item” dialogue boxes.
The SDK includes a project template for a Connector project. This includes a generic adapter template as well as an ObjectConfig folder with a README.txt file explaining how to use the ObjectConfig folder. There are also the following item templates:
However, that’s not all the SDK includes. It also provides a complete SampleAdapter that includes an Adapter, two ObjectProviders (SampleCustomer and SampleUofMSchedule), the necessary Web Service reference, and ObjectProvider configuration files.
The sample adapter project uses the Microsoft Dynamics GP 10.0 Web Service as a model service., The GP Web Services provide a good example of how the Adapter can interface with any information system to extend the Microsoft Dynamics CRM Adapter System.
The Connector components can be found in the installation folder, which by default is $(ProgramFiles)\Microsoft Dynamics\Microsoft Dynamics Adapter\.
If you changed this location at installation time you will need to manually add references to the SDK assemblies to your Visual Studio project. However, if you installed Connector in the default location the templates and sample code will automatically reference the required DLL files.
The two DLL files that must be referenced in your Visual Studio project are:
To proceed with the project, you must have these DLLs listed as references in your project.
Getting support for Connector Software Development Kit
Connector for Microsoft Dynamics Software Developer Kit (SDK) is provided with support from Microsoft. Technical support is restricted to Adapters created for Microsoft Dynamics products only. Any Adapters created to work with other non-Dynamics applications aren’t supported. You can use the same email and phone resources noted above to get Connector SDK support.