Jump to: navigation, search

Difference between revisions of "HowTo:Configure the ACM"

(→‎{{UBIK}} Studio)
 
(4 intermediate revisions by the same user not shown)
Line 4: Line 4:
  
 
=== {{UBIK}} SmartStudio ===
 
=== {{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.
 
# Open {{UBIK}} SmartStudio.
 
# Create a new project or open an existing one.  
 
# 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.
 
# 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.
 +
# Make sure there are a {{UBIK}} Environment including a database and functioning web services, as well as a content object you want to show on the mobile client.
 
# Open a new Application Graph worksheet.
 
# 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.
−
# Perform the staging process for saving the new Application Graph to the {{UBIK}} environment (database).
+
# 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).
 +
# You can add further Scopes to the Application Graph in the same manner.
 +
# Connect the Scopes in order to define the hierarchy. Instances of the right-hand scoped MetaClass will be presentable in the hierarchy level below the left-hand scoped MetaClass' instances.
 +
## Scope connections can be established by dragging connections between the output connector of the parent Scope and the input connector of the child Scope.
 +
## Configure the connections by choosing the way the instances are actually connected to each other (selecting a relation or link property). For an instance of the left-hand scoped MetaClass, the configured link property or relation will be used to find instances of the right-hand scoped MetaClass to be listed as children of the first instance on the mobile client.
 +
## If you want an object to be shown as the child of another on the mobile client, use a relation or link property to connect the two. This relation or link property can then be configured in a connection between two compatible Scopes.
 +
# Connect at least one Scope to the Context as a child. Instances of the scoped MetaClass will be presentable as root objects (first navigation level on the mobile client).
 +
# Configure a root objects Query for the Context by dragging a Query into the worksheet from a picker (existing Queries) or the toolbox (new Queries), available to the left of the worksheet area, and connecting it to the Context, using its root objects input connector. This means, the query finds all instances to show on the root level of the app. The Context must have a compatible scope connected to it in order for the instances to be displayed correctly.
 +
# Make sure the target {{UBIK}} Environment is connected.
 +
# Save the application graph to the desired {{UBIK}} Environment, using the menu bar or context menu.
 
# Open the {{UBIK}} environment page and select the ACM management sub-section.
 
# 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.
 
# Restart the {{UBIK}} web services.
 
# Test the results using any {{UBIK}} satellite.
 
# Test the results using any {{UBIK}} satellite.
  
 
=== {{UBIK}} Studio ===
 
=== {{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 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.
 
# Start {{UBIK}} Studio and connect to a database.
Line 41: Line 50:
 
# Test the results using any {{UBIK}} satellite.
 
# 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 ===
 
=== See also ===

Latest revision as of 15:00, 20 November 2019

The 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 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

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 (e.g., you don't have to care about View Items at all, you just create Scopes and connect them, using drag & drop).

  1. Open UBIK® SmartStudio.
  2. Create a new project or open an existing one.
  3. 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.
  4. Make sure there are a UBIK® Environment including a database and functioning web services, as well as a content object you want to show on the mobile client.
  5. Open a new Application Graph worksheet.
  6. 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.
  7. 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.
  8. Connect the Context to the Application by dragging a connection between the two.
  9. 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.
  10. Configure the Scope by adjusting the access rights for its MetaProperties.
  11. 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).
  12. You can add further Scopes to the Application Graph in the same manner.
  13. Connect the Scopes in order to define the hierarchy. Instances of the right-hand scoped MetaClass will be presentable in the hierarchy level below the left-hand scoped MetaClass' instances.
    1. Scope connections can be established by dragging connections between the output connector of the parent Scope and the input connector of the child Scope.
    2. Configure the connections by choosing the way the instances are actually connected to each other (selecting a relation or link property). For an instance of the left-hand scoped MetaClass, the configured link property or relation will be used to find instances of the right-hand scoped MetaClass to be listed as children of the first instance on the mobile client.
    3. If you want an object to be shown as the child of another on the mobile client, use a relation or link property to connect the two. This relation or link property can then be configured in a connection between two compatible Scopes.
  14. Connect at least one Scope to the Context as a child. Instances of the scoped MetaClass will be presentable as root objects (first navigation level on the mobile client).
  15. Configure a root objects Query for the Context by dragging a Query into the worksheet from a picker (existing Queries) or the toolbox (new Queries), available to the left of the worksheet area, and connecting it to the Context, using its root objects input connector. This means, the query finds all instances to show on the root level of the app. The Context must have a compatible scope connected to it in order for the instances to be displayed correctly.
  16. Make sure the target UBIK® Environment is connected.
  17. Save the application graph to the desired UBIK® Environment, using the menu bar or context menu.
  18. Open the UBIK® environment page and select the ACM management sub-section.
  19. Select the relevant Application and Context, and assemble and publish the Meta Definitions.
  20. Restart the UBIK® web services.
  21. Test the results using any UBIK® satellite.

UBIK® Studio

UBIK® Studio provides more basic tools, providing the full range of UBIK® data model features, but perhaps less comfortably so.

  1. Start UBIK® Studio and connect to a database.
  2. If necessary, create new Meta Classes for objects to provide to the client.
  3. Create Application, Context and View instances using the bulk editor for the respective MetaClasses (Application, Context, View).
  4. Find out which different connections your ACM hierarchy should provide; more specifically, which parent meta classes should lead to which child meta classes, and what kind of View Items you need for that (depending on how the children should be evaluated technically).
  5. If necessary, modify the Meta Classes so they can describe their parents or children. The way to do this depends on the type of View Item you're going to use, e.g. for a Reference View Item, you'll have to create a Reference and add a respective Reference Meta Property to the Meta Class that describes the children, in order for the child instances to refer to their parents using this Reference. Make sure the target type is set correctly.
  6. Create and configure View Item instances (of the System Meta Class REFERENCEVIEWITEM, RELATIONVIEWITEM or QUERYVIEWITEM) for each level of the hierarchy and every parent & child type (Meta Class) using the bulk editor.
  7. Connect the View Items to the View (see Create a new View)
  8. Create Scopes as instances of the METACLASSSCOPE System Meta Class (or QUERYSCOPE for queries).
  9. Use the Relation editor to define MetaProperties for your Scopes. Using the Relation Data inspector, you can edit rights for each property.
  10. Connect the Context to the Application and add all necessary Scopes to the Context using relations (see Create a new MetaClassScope, point 6).
  11. Connect the root and infrastructure objects and/or queries to the Context.
  12. If necessary, manage the content objects to be delivered by the ACM (e.g., create or import the data and fill in reference property values).
  13. Open the ACM Manager and publish the Context's Meta Definitions.
  14. Restart the UBIK® web services.
  15. Test the results using any UBIK® satellite.


See also

Retrieved from "https://wiki.augmensys.com/index.php?title=HowTo:Configure_the_ACM&oldid=21855"