UBIK Actions - Revision history

NWE: /* Purpose */

2025-11-14T11:10:45Z

‎Purpose

NWE at 13:36, 25 September 2024

2024-09-25T13:36:40Z

NWE: /* Purpose */

2024-09-25T13:31:09Z

‎Purpose

NWE: /* IUBIKAction Interface and SYSREL_METACLASS_ACTION Relationship */

2024-09-25T13:28:30Z

‎IUBIKAction Interface and SYSREL_METACLASS_ACTION Relationship

NWE: /* Triggering {{UBIK}} Actions */

2024-09-25T13:24:38Z

‎Triggering {{UBIK}} Actions

NWE: /* IUBIKAction Interface and SYSREL_METACLASS_ACTION Relationship */

2023-12-12T13:43:28Z

‎IUBIKAction Interface and SYSREL_METACLASS_ACTION Relationship

NWE at 21:49, 11 December 2023

2023-12-11T21:49:26Z

NWE at 21:49, 11 December 2023

2023-12-11T21:49:08Z

NWE at 21:29, 11 December 2023

2023-12-11T21:29:20Z

NWE at 21:28, 11 December 2023

2023-12-11T21:28:46Z

@@ Line 6: / Line 6: @@
 UBIK.Studio's Class Browser provides available Actions in the context menu for MetaClasses and instances{{Version/ServerSince|4.8.0}}.
 In earlier {{UBIK}} versions, Workflows were used for this purpose. However, since {{UBIK}} version 4, Microsoft WF workflows have fallen increasingly out of favor because support for WF Workflows was abandoned in Microsoft's netstandard framework, which {{UBIK}} relies on. Thus, {{UBIK}} Actions can be seen as the designated replacement for WF Workflows in {{UBIK}}.
 = Configuration of {{UBIK}} Actions =

@@ Line 4: / Line 4: @@
 In some cases it is required to define a range of actions to be available for a {{UBIK}} MetaClass or instance. For example, if the user should be provided with a custom selection of actions to perform for an object.
 {{UBIK}} Actions are the representation of such an executable action, and they can be put into relation to a MetaClass, so that one can evaluate a list of eligible actions for any MetaClass.
-[[Category:Actions|UBIK Actions]]
+UBIK.Studio's Class Browser provides available Actions in the context menu for MetaClasses and instances{{Version/ServerSince|4.8.0}}.
-[[Category:Coding|UBIK Actions]]
-[[Category:Workflow|UBIK Actions]]
+In earlier {{UBIK}} versions, Workflows were used for this purpose. However, since {{UBIK}} version 4, Microsoft WF workflows have fallen increasingly out of favor because support for WF Workflows was abandoned in Microsoft's netstandard framework, which {{UBIK}} relies on. Thus, {{UBIK}} Actions can be seen as the designated replacement for WF Workflows in {{UBIK}}.
 = Configuration of {{UBIK}} Actions =
@@ Line 42: / Line 40: @@
 Further, the {{UBIK}} Relationship ''SYSREL_METACLASS_ACTION'' is used to relate MetaClasses to any {{UBIK}} object implementing the interface described above.
-'''MetaClass.Actions and MetaClass.AllActions'''
+'''MetaClass.Actions and MetaClass.AllActions''' {{Version/ServerSince|4.8.0}}
 As a result of a successful configuration, the "Actions" C# property on the MetaClass will return a list of all directly configured actions. Further, "AllActions" will return also all inherited actions.
-[[Category:Actions|UBIK Actions]]
-[[Category:Coding|UBIK Actions]]
-[[Category:Workflow|UBIK Actions]]
 == The ACTION MetaClass ==

@@ Line 4: / Line 4: @@
 In some cases it is required to define a range of actions to be available for a {{UBIK}} MetaClass or instance. For example, if the user should be provided with a custom selection of actions to perform for an object.
 {{UBIK}} Actions are the representation of such an executable action, and they can be put into relation to a MetaClass, so that one can evaluate a list of eligible actions for any MetaClass.
 In earlier {{UBIK}} versions, Workflows were used for this purpose. However, since {{UBIK}} version 4, Microsoft WF workflows have fallen increasingly out of favor because support for WF Workflows was abandoned in Microsoft's netstandard framework, which {{UBIK}} relies on. Thus, {{UBIK}} Actions can be seen as the designated replacement for WF Workflows in {{UBIK}}.
 = Configuration of {{UBIK}} Actions =

@@ Line 26: / Line 26: @@
          bool IsApplicable(BaseClass obj);
          void Perform(BaseClass obj);
+     }
+}
@@ Line 35: / Line 36: @@
 Further, the {{UBIK}} Relationship ''SYSREL_METACLASS_ACTION'' is used to relate MetaClasses to any {{UBIK}} object implementing the interface described above.
 [[Category:Actions|UBIK Actions]]

@@ Line 67: / Line 67: @@
 = Triggering {{UBIK}} Actions =
-{{UBIK}} Actions are available in some of our products' UI, for example in the MaTaP AdminTool's context menu for project instances. However, they can also be accessed programmatically, for example with the following snippet executing all actions for an instance:
+{{UBIK}} Actions are available in some of our products' UI, for example in UBIK.Studio's context menu in the Class Browser, and UBIK.MaTaP.AdminTool's context menu for project instances. However, they can also be accessed programmatically, for example with the following snippet executing all actions for an instance:
 <syntaxhighlight lang="csharp">
 public void PerformAllRelevantActions(BaseClass instance)

@@ Line 22: / Line 22: @@
 namespace UBIK.Kernel
+{
-     public interface IUBIKAction
+     public interface IUBIKAction : IUBIKObject
+     {
          bool IsApplicable(BaseClass obj);
@@ Line 35: / Line 35: @@
 Further, the {{UBIK}} Relationship ''SYSREL_METACLASS_ACTION'' is used to relate MetaClasses to any {{UBIK}} object implementing the interface described above.
 == The ACTION MetaClass ==

@@ Line 6: / Line 6: @@
 In earlier {{UBIK}} versions, Workflows were used for this purpose. However, since {{UBIK}} version 4, Microsoft WF workflows have fallen increasingly out of favor because support for WF Workflows was abandoned in Microsoft's netstandard framework, which {{UBIK}} relies on. Thus, {{UBIK}} Actions can be seen as the designated replacement for WF Workflows in {{UBIK}}.
-= E-R Model =
+= Configuration of {{{UBIK}} Actions =
 The core of {{UBIK}} Actions consists of a C# interface and a relationship between MetaClasses and Actions.
 Additionally, there are several convenience utilities to accommodate the definition and configuration of Actions.
 == IUBIKAction Interface and SYSREL_METACLASS_ACTION Relationship ==
 The IUBIKAction interface guarantees the following methods:
 <syntaxhighlight lang="csharp">
@@ Line 22: / Line 29: @@
+}
 </syntaxhighlight>
 To add the IUBIKAction C# interface to the custom code of a {{UBIK}} MetaClass, the classification SYSCLS_ACTION can be assigned to a MetaClass that should define Actions.
-The ACTION MetaClass has this classification by default and provides a basic implementation for the configuration of a target method. Similar to the obsolete Workflow MetaClass, it provides Boolean properties to flag an Action either for instances or MetaClasses. Also, it has two string properties for the identification of a target method and the class it is defined in:
 {| class="wikitable" style="float:none" align="left"
@@ Line 46: / Line 58: @@
 The {{UBIK}} object to perform this action for must be specified for the target class and method, and the target class and method must be accessible. This means both the class and the method must be public. Also, either the method or the class constructor must take a ''BaseClass'' as a parameter. Static methods and classes are also supported. In case of a non-static method, the owning class must have a public constructor without parameters or with a single ''BaseClass'' parameter.
 The DLL containing the target method ({{UBIK}} custom code is also supported) must be available to {{UBIK}}, for example in the ''Injection'' folder.
 = Triggering {{UBIK}} Actions =

@@ Line 28: / Line 28: @@
 The ACTION MetaClass has this classification by default and provides a basic implementation for the configuration of a target method. Similar to the obsolete Workflow MetaClass, it provides Boolean properties to flag an Action either for instances or MetaClasses. Also, it has two string properties for the identification of a target method and the class it is defined in:
-{| class="wikitable" style="margin:auto;float:none;" align="left"
+{| class="wikitable" style="float:none" align="left"
 |+ ACTION properties
 |-