Tuesday, January 19, 2016

How to add ColleagueSDK to Visual Studio

ColleagueSDK for .NET allows you to add DataContract and Transactions from Colleague to your VS projects. You will need this if you want to compile/customize Ellucian Self Service. In this post I will use ColleagueSDK for .NET version 1.8 and MS 2013.

First, you can download the installer from SA Valet.


Run the .exe file and you will have this folder created.


Run ColleagueDataContractGenerator.vsix and the VS extension will be added to your local Microsoft Visual Studio. ColleagueSDK no longer supports VS 2010 and only supports 2012 and 2013 so far. Make sure you have one of those installed first.

To add Colleague parameters, double click on CollSDKParamsEditor.exe. You will see the editor as following:


Click on Help/View Help if you need help filling out the screen. This form requires similar information you use to login to Colleague Studio. Once you're done, hit File/Save to save your configuration file that you can then use in your VS project.

After the extension has been added to VS, you should be able to add DataContract or Colleague Transaction to your VS project.