Free cookie consent management tool by TermsFeed Policy Generator
wiki:Documentation/Howto/ImplementAHLWebAppPlugin

Version 3 (modified by dglaser, 9 years ago) (diff)

--

How to Implement A New HeuristicLab WebApp Plugin

  1. How to Implement A New HeuristicLab WebApp Plugin
    1. A new project
    2. Configuring the project
      1. References
      2. Folder structure
    3. Creating the Plugin definition file
    4. Example Plugin
      1. WebApi
      2. WebApp
        1. View
        2. Controller
        3. Service

In the following Guide we will create a simple HeuristicLab WebApp plugin.

A new project

We will now create a new Visual Studio project which will become the WebApp plugin.

  • In Visual Studio select "File > New > Project..." or press <Ctrl+Shift+N>
  • Use the "Class Library" template
  • Use "HeuristicLab.Services.WebApp.Example" as name

/raw-attachment/wiki/Documentation/Howto/ImplementAHLWebAppPlugin/create_project_vs.PNG

Configuring the project

References

Every plugin has at least a reference to Microsoft ASP.NET Web API, which is needed to create a controller.

  • Open the NuGet Package Manager and add a reference to Microsoft ASP.NET Web API

/raw-attachment/wiki/Documentation/Howto/ImplementAHLWebAppPlugin/nuget_project_references.PNG

  • If database access is required, add project references to HeuristicLab.Services.Hive and HeuristicLabServices.DataAccess
  • Set the "Copy Local" property on these references to false. This references are provided by the WebApp and thus don't have to be deployed with every plugin.

/raw-attachment/wiki/Documentation/Howto/ImplementAHLWebAppPlugin/references.PNG

Folder structure

Creating the Plugin definition file

TODO

Example Plugin

TODO

WebApi

TODO

WebApp

TODO

View

TODO

Controller

TODO

Service

TODO

Attachments (5)

Download all attachments as: .zip