HowTo:Configure the ACM - Revision history

NWE at 15:00, 20 November 2019

2019-11-20T15:00:13Z

NWE at 14:45, 20 November 2019

2019-11-20T14:45:07Z

NWE: /* {{UBIK}} SmartStudio */

2019-11-20T13:21:55Z

‎{{UBIK}} SmartStudio

NWE: /* {{UBIK}} Studio */

2019-11-20T13:20:54Z

‎{{UBIK}} Studio

NWE: /* {{UBIK}} Studio */

2019-11-20T13:16:25Z

‎{{UBIK}} Studio

NWE: /* {{UBIK}} Studio */

2016-12-15T15:31:21Z

‎{{UBIK}} Studio

NWE at 15:29, 15 December 2016

2016-12-15T15:29:36Z

NWE at 15:28, 15 December 2016

2016-12-15T15:28:46Z

NWE at 15:27, 15 December 2016

2016-12-15T15:27:38Z

NWE: /* {{UBIK}} SmartStudio */

2016-12-15T14:26:49Z

‎{{UBIK}} SmartStudio

@@ Line 9: / Line 9: @@
 # Create a new project or open an existing one.
 # If necessary, design new Meta Classes (for objects to provide to the client) using the Inheritance Graph or connect to a {{UBIK}} environment (database) and use the Meta Classes defined there.
 # Open a new Application Graph worksheet.
-# Create Application and Context objects and connect them.
+# Add a Application by dragging it into the worksheet from a picker (existing Apps) or the toolbox (new App), available to the left of the worksheet area.
-# Use drag & drop to define Scopes for previously created Meta Classes (available in pickers on the left side).
+# Add a Context by dragging it into the worksheet from a picker (existing Contexts) or the toolbox (new Context), available to the left of the worksheet area.
-# Connect the Scopes in order to define the hierarchy. Also connect at least one Scope to the Context as a child.
+# Connect the Context to the Application by dragging a connection between the two.
-# If necessary, define queries for the root and infrastructure objects and connect them to the Context as input elements.
+# In order to support the object you want to make appear on the mobile client, add a Scope by dragging a compatible MetaClass into the worksheet from a picker (existing MetaClasses) or the toolbox (new MetaClasses), available to the left of the worksheet area. Such a Scope is a configuration for all instances of the respective MetaClass delivered to the mobile client.
-# Make sure the target {{UBIK}} environment is connected.
+# Configure the Scope by adjusting the access rights for its MetaProperties.
-# Save the new Application Graph to the {{UBIK}} environment (database) using the context menu or the menu bar above the worksheet area.
+# Connect the Scope to the Context. This means, instances of the scoped MetaClass will be presentable as root objects (first navigation level on the mobile client).
 # Open the {{UBIK}} environment page and select the ACM management sub-section.
-# Publish the Meta Definitions.
+# Select the relevant Application and Context, and assemble and publish the Meta Definitions.
 # Restart the {{UBIK}} web services.
 # Test the results using any {{UBIK}} satellite.
 === {{UBIK}} Studio ===
@@ Line 44: / Line 49: @@
 # Restart the {{UBIK}} web services.
 # Test the results using any {{UBIK}} satellite.

@@ Line 15: / Line 15: @@
 # If necessary, define queries for the root and infrastructure objects and connect them to the Context as input elements.
 # Make sure the target {{UBIK}} environment is connected.
-# Perform the staging process for saving the new Application Graph to the {{UBIK}} environment (database).
+# Save the new Application Graph to the {{UBIK}} environment (database) using the context menu or the menu bar above the worksheet area.
 # Open the {{UBIK}} environment page and select the ACM management sub-section.
 # Publish the Meta Definitions.
@@ Line 21: / Line 21: @@
 # Test the results using any {{UBIK}} satellite.
-[[Category:How-To|Configure the ACM]]
-[[Category:Publishing|Configure the ACM]]
-[[Category:Studio|Configure the ACM]]
-[[Category:Web service|Configure the ACM]]
 === {{UBIK}} Studio ===
@@ Line 45: / Line 45: @@
 # Test the results using any {{UBIK}} satellite.
-[[Category:How-To|Configure the ACM]]
-[[Category:Publishing|Configure the ACM]]
-[[Category:Studio|Configure the ACM]]
-[[Category:Web service|Configure the ACM]]
 === See also ===

@@ Line 4: / Line 4: @@
 === {{UBIK}} SmartStudio ===
-With [[SmartStudio|{{UBIK}} SmartStudio]], you can assemble the whole ACM graphically; the technical details are edited automatically by {{UBIK}} SmartStudio, so it is significantly less work (you don't have to care about View Items at all, you just create Scopes and connect them, using drag & drop). On the other hand, only 1 : N connections can be created using {{UBIK}} SmartStudio (at least for the alpha version at the time this article was created!).
+With [[SmartStudio|{{UBIK}} SmartStudio]], you can assemble the whole ACM graphically; the technical details are edited automatically by {{UBIK}} SmartStudio, so it is significantly less work (e.g., you don't have to care about View Items at all, you just create Scopes and connect them, using drag & drop).
-{{UBIK}} SmartStudio tries to satisfy all common, major use cases in a comfortable manner, at the cost of detail functionality. The set of relevant features will be maintained in future versions.
 # Open {{UBIK}} SmartStudio.
@@ Line 21: / Line 20: @@
 # Restart the {{UBIK}} web services.
 # Test the results using any {{UBIK}} satellite.
 === {{UBIK}} Studio ===

@@ Line 23: / Line 23: @@
 === {{UBIK}} Studio ===
-[[UBIK_Studio|{{UBIK}} Studio]] provides a higher grade of technical detail and more possibilities. If you cannot satisfy your demands using {{UBIK}} SmartStudio, you can use {{UBIK}} Studio.
+[[UBIK_Studio|{{UBIK}} Studio]] provides more basic tools, providing the full range of {{UBIK}} data model features, but perhaps less comfortably so.
 # Start {{UBIK}} Studio and connect to a database.

@@ Line 23: / Line 23: @@
 === {{UBIK}} Studio ===
-[[UBIK_Studio|{{UBIK}} Studio]] provides a higher grade of technical detail and more possibilities. If you cannot satisfy your demands using {{UBIK}} SmartStudio, e.g. if you need to create N : M connections, you can use {{UBIK}} Studio.
+[[UBIK_Studio|{{UBIK}} Studio]] provides a higher grade of technical detail and more possibilities. If you cannot satisfy your demands using {{UBIK}} SmartStudio, you can use {{UBIK}} Studio.
 # Start {{UBIK}} Studio and connect to a database.

@@ Line 3: / Line 3: @@
 This page describes how to configure the ACM using {{UBIK}} Studio or {{UBIK}} SmartStudio, including creating Application and Context, Scopes, View and View Items and publishing the Meta Definitions.
-=== {{UBIK}} [[SmartStudio]] ===
+=== {{UBIK}} SmartStudio ===
-With {{UBIK}} [[SmartStudio]], you can assemble the whole ACM graphically; the technical details are edited automatically by {{UBIK}} SmartStudio, so it is significantly less work (you don't have to care about View Items at all, you just create Scopes and connect them, using drag & drop). On the other hand, only 1 : N connections can be created using {{UBIK}} SmartStudio (at least for the alpha version at the time this article was created!).
+With [[SmartStudio|{{UBIK}} SmartStudio]], you can assemble the whole ACM graphically; the technical details are edited automatically by {{UBIK}} SmartStudio, so it is significantly less work (you don't have to care about View Items at all, you just create Scopes and connect them, using drag & drop). On the other hand, only 1 : N connections can be created using {{UBIK}} SmartStudio (at least for the alpha version at the time this article was created!).
 {{UBIK}} SmartStudio tries to satisfy all common, major use cases in a comfortable manner, at the cost of detail functionality. The set of relevant features will be maintained in future versions.

@@ Line 1: / Line 1: @@
 The [[Application_Context_Management|ACM (Application Context Management)]] is about controlling how {{UBIK}} satellites see data provided by the {{UBIK}} environment via web service (or the web client).
-This page describes how the ACM works and how to actually configure it using {{UBIK}} Studio or {{UBIK}} SmartStudio, including creating Application and Context, Scopes, View and View Items and publishing the Meta Definitions.
+This page describes how to configure the ACM using {{UBIK}} Studio or {{UBIK}} SmartStudio, including creating Application and Context, Scopes, View and View Items and publishing the Meta Definitions.
-−
-== How the ACM works ==
-Technically, the ACM can be explained separating the following topics:
-* Application and Context
-* Scopes
-* View and View Items
-* Meta Definitions
-−
-=== Application and Context ===
-An Application is used to identify Contexts. A Context is used to identify a View and all relevant Scopes. {{UBIK}} satellites use these two in order to identify the View that provides data for them, as well as the Scopes that decide what the data looks like. The Application's and Context's names have to be configured in the client's settings.
-One could say the Context is the central object in every ACM configuration, connecting all the details.
-−
-=== Scopes ===
-Scopes define what a {{UBIK}} object and its properties look like to a {{UBIK}} satellite. Let's say we have a pump with a lot of properties (that can be used for automatic data processing), but these properties aren't of much use to a human user. In this case, if I publish such pump objects to the user's mobile client (aka. {{UBIK}} satellite) via ACM, I probably want to give the user a more convenient, specialized version of these objects, containing only useful properties. With Scopes, one can define what an abstract content object should look like. One could say, they are post-processing filters for Meta Classes. Specifically, you can define which properties are visible, decide which classifications are published and configure rights (e.g. for writing a property value or creating instance objects for the Scope).
-−
-=== View and View Items ===
-The View defines the hierarchical representation of all objects that should be available. The object's look & feel is described by Scopes, but the connection between those objects is described by the View. For example, if I have a root object ''Station A'' and as its child, I have an object ''Unit A.1'', then the View describes that ''Unit A.1'' is a child of ''Station A''.
-Technically, the view uses View Items in order to describe the connection of objects. View Items are defined for a Meta Class, e.g. for the Meta Class ''Station'', and can provide the children for specific instances of such a Meta Class. In our example, if we have a View Item responsible for getting the Unit-children of a Station, for ''Station A'' (which is an instance of the scope ''Station'') it would retrieve ''Unit A.1''.
-There are different types of View Items, depending on how the children should be resolved technically. The following types exist:
-* Reference View Item (only 1 : N relations)
-* Relation View Item (N : M relations possible)
-* Query View Item (complex, custom child evaluation possible)
-Reference View Items use a reference from each child to the parent in order to evaluate the children in a backward manner.
-Relation View Items use relations from parents to children, where each parent can have multiple children and vice-versa, every child can have multiple parents.
-Query View Items use a query to evaluate the children, but the parent object has to be the respective query object.
-A View can have multiple view items for the same Meta Class (target type) in order to make a complex structure possible.
-−
-=== Meta Definitions ===
-Last but not least, the {{UBIK}} satellites need to get Meta Definitions in order to interpret and use the content correctly. Meta Definitions describe (abstract) Meta Classes, Selective Lists, Units and rights as well as some information about the view structure, e.g. possible children of an element (in case the user wants to create a new object, like a picture for example).
-The Meta Definitions are a result of the Scopes and the View for a specific Context. The customizer (you) has to publish these Meta Definitions actively though, using the [[ACM Manager]].
-−
-[[Category:How-To|Configure the ACM]]
-[[Category:Publishing|Configure the ACM]]
-[[Category:Studio|Configure the ACM]]
-[[Category:Web service|Configure the ACM]]
-−
-== How to actually configure the ACM ==
-There are two programs you can use to configure the ACM: {{UBIK}} Studio and {{UBIK}} SmartStudio.
 === {{UBIK}} SmartStudio ===
@@ Line 59: / Line 21: @@
 # Restart the {{UBIK}} web services.
 # Test the results using any {{UBIK}} satellite.
 === {{UBIK}} Studio ===
@@ Line 83: / Line 40: @@
 # Restart the {{UBIK}} web services.
 # Test the results using any {{UBIK}} satellite.
 === See also ===