Jump to: navigation, search

Difference between revisions of "Injection Management"


(Plugin Folders)
 
(42 intermediate revisions by 2 users not shown)
Line 1: Line 1:
The Injection Manamgent in {{UBIK}} provides the possibility to extend the standard functionality of {{UBIK}} on demand. This extends the system to include project a/o customer specific implementations (like project specific [[:Category:Activities|Workflow activities]]) and supports the {{UBIK}} admin to solve project/customer specific problems.
+
The Injection Manamgent in {{UBIK}} features the possibility to extend the standard functionality of {{UBIK}} if necessary. The system can include project a/o customer specific implementations (like own [[:Category:Activities|Workflow activities]]) and supports a {{UBIK}} administrator to manage project a/o customer specific requirements.
  
 
== Supported Applications ==
 
== Supported Applications ==
Injection Management is supported by following {{UBIK}} Applications:
+
Following {{UBIK}} Applications support the Injection Management:  
 
* [[UBIK Studio Basics|Studio]]
 
* [[UBIK Studio Basics|Studio]]
* [[Enterprise Service|Enterprise Server]]
+
* [[Enterprise Service|Enterprise Service]]
 
* [[Web Service]]
 
* [[Web Service]]
  
== Supported Plugin Types ==
+
== Supported Types ==
Among any custom designed types (e.g. classes including methods, properties, etc.) the following proprietary plugin types are supported:
+
Two types of add-ons can be injected into {{UBIK}} via this Injection Management techique:
* [[Create_UBIK_Workflow_Activity_Plugin|UBIK Workflow Activities]]
+
* {{UBIK}} Plugin
 +
* {{UBIK}} Module
 +
* [[HowTo:Inject_UI_into_UBIK_Studio|{{UBIK}} Studio Controls and Windows]]
  
== Plugin Folders ==
+
An '''{{UBIK}} Plugin''' is intended to provide features on a rather low level (methods used within code, [[HowTo:Create_UBIK_Workflow_Activity_Plugin|workflow activities]], web service). The scope of a plugin should not cover additional structures (Metaclasses, Metaproperties, Classifications).
Following folders are scanned for available plugins as default:
+
 
 +
An '''{{UBIK}} Module''' can also include any kind of metastructures, additional to features as a {{UBIK}} Plugin. Hence, a {{UBIK}} Module is a much more comprehensive extension of the system.
 +
 
 +
== Usage ==
 +
 
 +
=== Version 5.2.0+ ===
 +
[[File:AddPlugins_Studio.png|thumb|upright|220px|"Add Plugins" Dialog]]
 +
 
 +
The Injection folder contained in the installation folder of the respective Server product is still supported, especially for custom plugins.
 +
However, all standard plugins are now shipped with the product and there is now the possibility to just select the required plugins using a dialog{{Version/ServerSince|5.2.0}}.
 +
 
 +
This "Add Plugins" dialog will be shown when connecting to a new database for the first time, and is accessible always via UBIK.Studio's Plugins dialog.
 +
When connecting to a database, {{UBIK}} will load all plugins previously selected in the dialog, and additionally everything from the Injection folder.
 +
This means, standard Plugins needn't be maintained manually in the Injection folder anymore.
 +
<br clear="all" />
 +
 
 +
=== Version Pre-5.2.0 ===
 +
Following folders are scanned for available plugins / modules:
 
* '''[UBIK Installation Folder]\Injection'''
 
* '''[UBIK Installation Folder]\Injection'''
 
* '''%LocalAppData%\Augmensys\UBIK\CUSTOM\[Project Folder]\Injection'''
 
* '''%LocalAppData%\Augmensys\UBIK\CUSTOM\[Project Folder]\Injection'''
  
 
+
These folders must be set in the '''privatePath''' parameter of the '''probing''' element in the config file:
Additional folders can be added via the config file:
+
 
<source lang="xml">
 
<source lang="xml">
 
<runtime>
 
<runtime>
 
   <assemblyBinding xmlns="urn:schemas-microsoft-com:asm.v1">
 
   <assemblyBinding xmlns="urn:schemas-microsoft-com:asm.v1">
<probing privatePath="lib;Injection"/>
+
      <probing privatePath="lib;Injection"/>
 
   <assemblyBinding
 
   <assemblyBinding
 
</runtime>
 
</runtime>
 
</source>
 
</source>
  
== Plugins ==
+
{{Attention|The injection of plugins / modules requires that this folder is configured as ''probing'' path in the config file.}}
You cand find a list of all loaded Plugins in {{UBIKSTUDIO}} by accessing the [[Plugin Dialog]] via ''View &rarr; Plugins''
+
 
 +
== Loaded Plugins / Modules ==
 +
A list of all currently loaded and available Plugins and Modules is shown in the ''[[Plugins|View &rarr; Plugins]]'' dialog ({{UBIK Studio}} only).
  
 
== See also ==
 
== See also ==
* [[Create_UBIK_Plugin|create your own Plugin]]
+
* [[HowTo:Create_UBIK_Plugin|Create your own plugin]]
 +
* [[HowTo:Create_UBIK_Module|Create your own module]]
 +
* [[UBIK_Plugin_Design]]
 +
 
 +
{{Category/Version|2.4.0}}
  
[[Category:Injecting]]
+
[[Category:2.4.0|Injection Management]]
{{Version|2.4.1}}
+
[[Category:Injecting|Injection Management]]
 +
[[Category:Server|Injection Management]]
 +
[[Category:Version 5.2|Injection Management]]

Latest revision as of 14:18, 16 July 2026

The Injection Manamgent in UBIK® features the possibility to extend the standard functionality of UBIK® if necessary. The system can include project a/o customer specific implementations (like own Workflow activities) and supports a UBIK® administrator to manage project a/o customer specific requirements.

Supported Applications

Following UBIK® Applications support the Injection Management:

Supported Types

Two types of add-ons can be injected into UBIK® via this Injection Management techique:

An UBIK® Plugin is intended to provide features on a rather low level (methods used within code, workflow activities, web service). The scope of a plugin should not cover additional structures (Metaclasses, Metaproperties, Classifications).

An UBIK® Module can also include any kind of metastructures, additional to features as a UBIK® Plugin. Hence, a UBIK® Module is a much more comprehensive extension of the system.

Usage

Version 5.2.0+

"Add Plugins" Dialog

The Injection folder contained in the installation folder of the respective Server product is still supported, especially for custom plugins. However, all standard plugins are now shipped with the product and there is now the possibility to just select the required plugins using a dialog.

This "Add Plugins" dialog will be shown when connecting to a new database for the first time, and is accessible always via UBIK.Studio's Plugins dialog. When connecting to a database, UBIK® will load all plugins previously selected in the dialog, and additionally everything from the Injection folder. This means, standard Plugins needn't be maintained manually in the Injection folder anymore.

Version Pre-5.2.0

Following folders are scanned for available plugins / modules:

  • [UBIK Installation Folder]\Injection
  • %LocalAppData%\Augmensys\UBIK\CUSTOM\[Project Folder]\Injection

These folders must be set in the privatePath parameter of the probing element in the config file:

<runtime>
   <assemblyBinding xmlns="urn:schemas-microsoft-com:asm.v1">
      <probing privatePath="lib;Injection"/>
   <assemblyBinding
</runtime>
IC Attention.pngThe injection of plugins / modules requires that this folder is configured as probing path in the config file.

Loaded Plugins / Modules

A list of all currently loaded and available Plugins and Modules is shown in the View → Plugins dialog (UBIK® Studio only).

See also