About SDL Studio SDK

This is the 5th part of the OpenExchange: Age of Developers series. In the previous articles I talked about how to configure your development environment and also gave some suggestion on how you can start the development for OpenExchange store. One of the steps from the development environment setup was to install the SDL Studio SDK and I think it's worth talking about it in a bit more detail.

Age of developers - table of contents###

As I release parts of this series I will update this page with links to the articles.

What is an SDK?

SDK stands for software development kit and typically is a set of software development tools that enable the creation of applications for certain software applications. What exactly an SDK contains differ between each target software applications. Sometimes it can be a set of libraries in certain programming languages, like Microsoft .Net or Java, or it can also contain a bunch of supporting tools. Typically the SDK comes as a separate download since not every user might be interested in using this type of capabilities.If you are interested to read more details you can have a look here.

What I can find inside the SDL Studio SDK?

SDL Studio SDK comes as a separate download from the standard SDL Studio application. You can get it from the developer page located here. Now let's see what goodies we get with the SDK:

Sample applications, developed in C#, to demonstrate the basic capabilities of SDL Studio API's. This applications are really good to get you started with one of the API's but please bare in mind that they don't cover the entire API's feature set so please also look for features in the documention or ask on our developer community. After the SDL Studio SDK is installed you can find the samples located under the c:\ProgramData\SDL\SDK {Version}\ folder.
Microsoft Visual Studio project templates. This templates are very useful when you start developing a new plugin for SDL Studio because you just select the template that is appropriate for the API you want to use.

What is not part of the SDL Studio SDK?

At this point you might wonder a bit why the previous section didn't mention anything about the API libraries since typically this libraries come with the SDK. The reason I didn't mention them is because they are installed together with SDL Studio. There is a simple and good reason why they are distributed with the product and this is because some of the default SDL Studio features are developed using this API's. To give you some good examples all out-of-the-box filters are developed on top of the same File Type Support Framework, also each translation provider is built using the same Translation Memory API.

Distributing the API libraries together with the product has some pros and cons. The main disadvantage is that we are not able to provide new features in the API libraries on a different pace than the product releases. A big advantage is that the API's that are used for default features are well tested and mature.

At this point I need to mention that not all API libraries are used for default features. For example the Intergration API is just a wrapper on top of internal components.

Do I need to install the SDK?

If the API libraries are distributed with the product a valid questions pops up and that is if I need to install the SDK. The answer is no but I highly recommend it. It is possible to develop a plugin for SDL Studio without having the SDK installed on your machine is just that it will take more time to setup your Visual Studio project. First of all you will have to specify all the SDL Studio API libraries you need. This is pretty straightforward task but the complicated bit is to create the .sdlplugin file. You will have to manually edit the Visual Studio project file and add the msbuild targets to create the .sdlplugin package.

Future plans

I have to say that SDL Studio SDK is kind of slim in terms of the tooling that is providing to the developers and it doesn't make too much sense to keep it in the current form. There other better ways in which we can provide the current content so the future plans are as follows:

Move sample applications to Github. This gives us a few benefits like better search-ability, improvements and fixes can be done by anyone interested not just SDL internal developers and of course it will still be available to download locally as a zip file.
Create more specific Visual Studio project templates.
Provide Visual Studio project templates as Visual Studio extension. Initially this will probably be available only for Visual Studio 2015 and based on the need we will make it available for older versions.

I believe this changes will make the SDK more open and closer to the developer. Of course when all the above points will be done the current installer will probably disappear.

Please let me know if you have any comments or questions.

Picture: kballo - SDK Bayonne