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.


2 comments:

  1. Hello Duong
    I'm hoping you're still getting these notifications. :-)

    We are moving our on-prem Colleague to AWS and we're having trouble getting our .NET applications that connect to Colleague working. We think there is a setting on the AWS instance that doesn't match our on-prem instance regarding Colleague SDK. Our .NET applications are failing to connect to Colleague AWS, giving this error message.

    "You entered an invalid username or password. Please try again.(10002)"

    But the usernames and passwords are the same on AWS. Any help would be greatly appreciated.

    ReplyDelete
    Replies
    1. Hi there!

      Your account showed up as anonymous so I have no way to contact you beside leaving a comment here. It's been a while since anyone read and left comments on my blog :)

      There could be a few reasons why your .NET applications can't connect to Colleague. The error (10002) may not indicate actual root cause of it. The application may not be able to reach your Colleague AWS instance because there are more hoops to go through. I would try to ping the Colleague AWS instance from the machine your .NET applications are running on. Are you able to connect to the Colleague AWS instance from Visual Studio? You should be able to verify the connection from the SDK whether or not you can connect.

      Since this is most likely a networking/configuration issue, I would try to verify the appropriate public ports are open from your Colleague AWS instance.

      Hope that helped,

      Duong

      Delete