Difference between revisions of "HowTo:Create UBIK Plugin"
m |
m |
||
Line 65: | Line 65: | ||
|} | |} | ||
− | + | = Example = | |
<source lang="csharp"> | <source lang="csharp"> | ||
[Export(typeof(UBIK.Injection.IUbikPlugin))] | [Export(typeof(UBIK.Injection.IUbikPlugin))] | ||
Line 85: | Line 85: | ||
== Supported Plugin Types == | == Supported Plugin Types == | ||
* [[HowTo:Create_UBIK_Workflow_Activity_Plugin|UBIK Workflow Activity Plugin]] | * [[HowTo:Create_UBIK_Workflow_Activity_Plugin|UBIK Workflow Activity Plugin]] | ||
+ | |||
+ | <headertabs /> | ||
== See also == | == See also == |
Revision as of 11:22, 3 August 2016
UBIK® Plugins are dynamically loaded into the UBIK® Kernel via the Injection Management using the Microsoft Extensibility Framework (MEF).
Basic Prerequisites
If you want to create a plugin which can be loaded into UBIK® you have to include references to
- System.ComponentModel.Composition
- UBIK.Injection
UBIK® Injection Management provides access to all the basic features used by the Kernel to identifiy and categorize the available plugins. This management is provided by a library called UBIK.Injection.
Interface: IUbikPlugin
The plugin must implement the UBIK.Injection.IUbikPlugin interface and has to be registered for MEF composition by defining the export contract via an attribute.
[Export(typeof(UBIK.Injection.IUbikPlugin))]
public class TestPlugin : UBIK.Injection.IUbikPlugin
{
}
public class TestPlugin : UBIK.Injection.IUbikPlugin
{
}
Interface: IUbikInjectionMetaData
Managing plugins correctly presumes the following information, as defined by the interface UBIK.Injection.IUbikInjectionMetaData.
[ExportMetadata("ID", "C149402E-BC86-46D6-8D1B-63C86894EA77")]
[ExportMetadata("Type", typeof(TestPlugin))]
[ExportMetadata("Name", "TestPlugin" )]
[ExportMetadata("Description", "Tests the injection management")]
[ExportMetadata("Version", 1)]
[ExportMetadata("Company", "Augmensys GmbH")]
[ExportMetadata("Type", typeof(TestPlugin))]
[ExportMetadata("Name", "TestPlugin" )]
[ExportMetadata("Description", "Tests the injection management")]
[ExportMetadata("Version", 1)]
[ExportMetadata("Company", "Augmensys GmbH")]
Mandatory information
Name | Type | Description |
---|---|---|
ID | String | Unique ID of the plugin |
Type | System.Type | Systemtype of the plugin; used for filtering the plugins during loading. |
Optional information
Name | Type | Description |
---|---|---|
Name | String | Name of the plugin (for UI Presentation) |
Description | String | Name of the plugin (for UI Presentation) |
Version | Integer | Version of the plugin. As there are more plugins with the same ID, only the plugin with the highest Version is available. |
TargetApplication | PluginTargetApplication | Possibility to limit the plugin for a single type of application. |
MinimumKernelVersion | String | Minimum required Kernel version: Format x.x.x.x |
MinimumDatabaseVersion | String | Minimum required Database version: Format x.x.x.x |
Company | String | Information about the Company (for UI Presentation) |
Copyright | String | Copyright Information (for UI Presentation) |