Jump to: navigation, search

Difference between revisions of "UBIK Plugin Design"

(→‎Exporting a C# solution for the plugin)
m (→‎Adding other objects to the configuration)
 
(18 intermediate revisions by 2 users not shown)
Line 1: Line 1:
−
The {{UBIK}} Plugin Design feature allows users to create a {{UBIK}} Plugin C# solution, including system definitions purely from customizing in {{UBIK}} Studio.  
+
The {{UBIK}} Plugin Design feature allows users to create a {{UBIK}} Plugin C# solution, including system definitions purely from customizing in {{UBIK}} Studio.{{Version/ServerSince|5.0.0}}
 +
 
 +
== Usage ==
 +
=== Creation of a new Plugin Design Configuration ===
 +
[[File:Plugin_Design_Configuration_instance.png|300px|thumb|Creating a plugin design configuration instance]]
 +
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.
 +
 
 +
=== Adding MetaClasses to the configuration ===
 +
[[File:Metaclass_Added.png|300px|thumb|Adding a MetaClass to the configuration]]
 +
Custom MetaClasses can be added to the plugin configuration using the "SYSREL_PLUGINDESIGNCONFIG_METACLASS" relation in the Relation Editor.
 +
 
 +
=== Adding other objects to the configuration ===
 +
In the initial version of this feature, we're assuming that your MetaClasses are the center of your customizing; everything else will be detected as a dependency of those. E.g., if you're using a MetaProperty in a MetaClass you related to the Plugin Design Configuration instance, it will also be contained in the generated C# solution. The same is true for all other (supported) kinds of objects. The Plugin Design feature is subject of active development, so most likely there will be more detailed control about the things contained in the designated Plugin in the next versions.
 +
 
 +
[[Category:Actions|UBIK Plugin Design]]
 +
[[Category:Coding|UBIK Plugin Design]]
 +
[[Category:How-To|UBIK Plugin Design]]
 +
[[Category:Module|UBIK Plugin Design]]
 +
[[Category:Plugin|UBIK Plugin Design]]
 +
[[Category:Studio tools|UBIK Plugin Design]]
 +
[[Category:Version 5.0|UBIK Plugin Design]]
 +
 
 +
=== Exporting a C# solution for the plugin ===
 +
[[File:Plugin_Generation_Trigger.png|220px|thumb|right|Trigger the C# solution generation]]
 +
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:PluginResult.png|300px|thumb|Resulting C# solution in Visual Studio]]
 +
 
 +
[[Category:Actions|UBIK Plugin Design]]
 +
[[Category:Coding|UBIK Plugin Design]]
 +
[[Category:How-To|UBIK Plugin Design]]
 +
[[Category:Module|UBIK Plugin Design]]
 +
[[Category:Plugin|UBIK Plugin Design]]
 +
[[Category:Studio tools|UBIK Plugin Design]]
 +
[[Category:Version 5.0|UBIK Plugin Design]]
  
 
== Supported capabilities ==
 
== Supported capabilities ==
  
−
{| class="wikitable"
+
{| class="wikitable" style="width:600px"
 
! Feature
 
! Feature
 
! Version
 
! Version
 
|-
 
|-
−
| Generation of a basic Plugin project including the Module and a SystemDefinitions stub
+
| Generation of a basic Plugin project,<br/>including the Module and a SystemDefinitions stub
 
| 5.0 Initial Release
 
| 5.0 Initial Release
 
|-
 
|-
Line 17: Line 53:
 
|-
 
|-
 
| Custom Class Code
 
| Custom Class Code
−
| 5.0 Service Pack
+
| 5.0 Initial Release
 
|-
 
|-
 
| Custom Code Library
 
| Custom Code Library
−
| 5.0 Service Pack
+
| 5.0 Initial Release
 
|-
 
|-
 
| Classifications
 
| Classifications
−
| 5.0 Service Pack
+
| 5.0 Initial Release
 
|-
 
|-
 
| Relations
 
| Relations
−
| 5.0 Service Pack
+
| 5.0 Initial Release
 +
|-
 +
| Selective Lists and Selective Items
 +
| 5.0 Initial Release
 
|-
 
|-
 
| References
 
| References
Line 34: Line 73:
 
| 5.0 Service Pack
 
| 5.0 Service Pack
 
|-
 
|-
−
| Selective Lists and Selective Items
+
| MetaProxies and MetaProxyProperties
−
| 5.0 Service Pack
+
| 5.1 Initial Release
 
|}
 
|}
  
−
== Usage ==
+
[[Category:Actions|UBIK Plugin Design]]
−
 
+
[[Category:Coding|UBIK Plugin Design]]
−
=== Creation of a new Plugin Design Configuration ===
+
[[Category:How-To|UBIK Plugin Design]]
−
The feature is accessible through the "System.PluginDesign.PLUGIN_DESIGN_CONFIGURATION" metaclass in UBIK Studio.
+
[[Category:Module|UBIK Plugin Design]]
−
A new Plugin Design Configuration instance can be created in the Bulk Editor to define a custom plugin context.
+
[[Category:Plugin|UBIK Plugin Design]]
−
[[File:Plugin_Design_Configuration_instance.png|220px|thumb|right|Class Browser context menu]]
+
[[Category:Studio tools|UBIK Plugin Design]]
−
 
+
[[Category:Version 5.0|UBIK Plugin Design]]
−
=== 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|300px|thumb|down|C# solution in Visual Studio]]
+
−
 
+
−
[[Category:Pages with broken file links|UBIK Plugin Design]]
+
  
 
== See also ==
 
== See also ==
Line 67: Line 92:
 
*[[HowTo:Provide_system_definitions_with_a_custom_plugin]]
 
*[[HowTo:Provide_system_definitions_with_a_custom_plugin]]
  
−
[[Category:Pages with broken file links|UBIK Plugin Design]]
+
[[Category:Actions|UBIK Plugin Design]]
 +
[[Category:Coding|UBIK Plugin Design]]
 +
[[Category:How-To|UBIK Plugin Design]]
 +
[[Category:Module|UBIK Plugin Design]]
 +
[[Category:Plugin|UBIK Plugin Design]]
 +
[[Category:Studio tools|UBIK Plugin Design]]
 +
[[Category:Version 5.0|UBIK Plugin Design]]

Latest revision as of 15:28, 14 October 2025

The UBIK® Plugin Design feature allows users to create a UBIK® Plugin C# solution, including system definitions purely from customizing in UBIK® Studio.

Usage

Creation of a new Plugin Design Configuration

Creating a plugin design configuration instance

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.

Adding MetaClasses to the configuration

Adding a MetaClass to the configuration

Custom MetaClasses can be added to the plugin configuration using the "SYSREL_PLUGINDESIGNCONFIG_METACLASS" relation in the Relation Editor.

Adding other objects to the configuration

In the initial version of this feature, we're assuming that your MetaClasses are the center of your customizing; everything else will be detected as a dependency of those. E.g., if you're using a MetaProperty in a MetaClass you related to the Plugin Design Configuration instance, it will also be contained in the generated C# solution. The same is true for all other (supported) kinds of objects. The Plugin Design feature is subject of active development, so most likely there will be more detailed control about the things contained in the designated Plugin in the next versions.

Exporting a C# solution for the plugin

Trigger the C# solution generation

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.

Resulting C# solution in Visual Studio

Supported capabilities

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 Initial Release
Custom Code Library 5.0 Initial Release
Classifications 5.0 Initial Release
Relations 5.0 Initial Release
Selective Lists and Selective Items 5.0 Initial Release
References 5.0 Service Pack
Units and Unit Items 5.0 Service Pack
MetaProxies and MetaProxyProperties 5.1 Initial Release

See also

Retrieved from "https://wiki.augmensys.com/index.php?title=UBIK_Plugin_Design&oldid=29037"