Changes
Created page with "The {{UBIK}} Plugin Design feature allows users to create a {{UBIK}} Plugin C# solution, including system definitions purely from customizing in {{UBIK}} Studio. == Suppor..."
The {{UBIK}} Plugin Design feature allows users to create a {{UBIK}} Plugin C# solution, including system definitions purely from customizing in {{UBIK}} Studio.
== Supported capabilities ==
{| class="wikitable"
! Feature
! Version
|-
| Generation of a basic Plugin project including the Module and a SystemDefinitions stub
| 5.0 Initial Release
|-
| MetaClasses
| 5.0 Initial Release
|-
| MetaProperties
| 5.0 Initial Release
|-
| Custom Class Code
| 5.0 Service Pack
|-
| Custom Code Library
| 5.0 Service Pack
|-
| Classifications
| 5.0 Service Pack
|-
| Relations
| 5.0 Service Pack
|-
| References
| 5.0 Service Pack
|-
| Units and Unit Items
| 5.0 Service Pack
|-
| Selective Lists and Selective Items
| 5.0 Service Pack
|}
== Usage ==
=== Creation of a new Plugin Design Configuration ===
The feature is accessible through the "System.PluginDesign.PLUGIN_DESIGN_CONFIGURATION" metaclass in UBIK Studio.
A new Plugin Design Configuration instance can be created in the Bulk Editor to define a custom plugin context.
[[File:Plugin_Design_Configuration_instance.png|220px|thumb|right|Class Browser context menu]]
=== Adding MetaClasses to the configuration ===
Custom metaclasses can be added to the plugin configuration using the "SYSREL_PLUGINDESIGNCONFIG_METACLASS" relation in the Relation Editor.
[[File:Metaclass_Added.png|220px|thumb|right|Class Browser context menu]]
=== Exporting a C# solution for the plugin ===
A C# solution can be generated for the plugin via context menu action in the Class Browser (content view style):
Right-click the Plugin Configuration instance, 'Start Action → "" → Create a C# solution for a custom UBIK plugin'.
This will increase the plugin version (revision), generate the C# solution and prompt the user with a save dialog for a respective .zip archive.
[[File:Plugin_Generation_Trigger.png|220px|thumb|right|Class Browser context menu]]
Below is an example of the resulting C# solution in Visual Studio:
[[File:PluginResult.png|220px|thumb|right|Class Browser context menu]]
== See also ==
*[[UBIK_Studio_Basics]]
*[[Bulk_Editor]]
*[[Relation_Editor]]
*[[UBIK_Actions]]
*[[HowTo:Provide_system_definitions_with_a_custom_plugin]]
== Supported capabilities ==
{| class="wikitable"
! Feature
! Version
|-
| Generation of a basic Plugin project including the Module and a SystemDefinitions stub
| 5.0 Initial Release
|-
| MetaClasses
| 5.0 Initial Release
|-
| MetaProperties
| 5.0 Initial Release
|-
| Custom Class Code
| 5.0 Service Pack
|-
| Custom Code Library
| 5.0 Service Pack
|-
| Classifications
| 5.0 Service Pack
|-
| Relations
| 5.0 Service Pack
|-
| References
| 5.0 Service Pack
|-
| Units and Unit Items
| 5.0 Service Pack
|-
| Selective Lists and Selective Items
| 5.0 Service Pack
|}
== Usage ==
=== Creation of a new Plugin Design Configuration ===
The feature is accessible through the "System.PluginDesign.PLUGIN_DESIGN_CONFIGURATION" metaclass in UBIK Studio.
A new Plugin Design Configuration instance can be created in the Bulk Editor to define a custom plugin context.
[[File:Plugin_Design_Configuration_instance.png|220px|thumb|right|Class Browser context menu]]
=== Adding MetaClasses to the configuration ===
Custom metaclasses can be added to the plugin configuration using the "SYSREL_PLUGINDESIGNCONFIG_METACLASS" relation in the Relation Editor.
[[File:Metaclass_Added.png|220px|thumb|right|Class Browser context menu]]
=== Exporting a C# solution for the plugin ===
A C# solution can be generated for the plugin via context menu action in the Class Browser (content view style):
Right-click the Plugin Configuration instance, 'Start Action → "" → Create a C# solution for a custom UBIK plugin'.
This will increase the plugin version (revision), generate the C# solution and prompt the user with a save dialog for a respective .zip archive.
[[File:Plugin_Generation_Trigger.png|220px|thumb|right|Class Browser context menu]]
Below is an example of the resulting C# solution in Visual Studio:
[[File:PluginResult.png|220px|thumb|right|Class Browser context menu]]
== See also ==
*[[UBIK_Studio_Basics]]
*[[Bulk_Editor]]
*[[Relation_Editor]]
*[[UBIK_Actions]]
*[[HowTo:Provide_system_definitions_with_a_custom_plugin]]
