Jump to: navigation, search

Difference between revisions of "HowTo:Make an Object appear on the Mobile Client"

 
(6 intermediate revisions by the same user not shown)
Line 1: Line 1:
−
Publishing an object's data, including its children, properties and documents, requires to configure the [[Application Context Management]] (ACM).
+
Publishing an object's data via the {{UBIK}} web services, potentially including its children, properties and documents, requires to configure the [[Application Context Management]] (ACM).
−
Follow the steps how to do that:
+
  
−
=== UBIK.Studio ===
+
=== {{UBIK}} Studio ===
  
 +
# Set up web services
 
# [[HowTo:Create a new Application]]
 
# [[HowTo:Create a new Application]]
 
# [[HowTo:Create a new Context]]
 
# [[HowTo:Create a new Context]]
Line 9: Line 9:
 
# [[HowTo:Create a new View]]
 
# [[HowTo:Create a new View]]
 
# [[HowTo:Create a new ViewItem]]
 
# [[HowTo:Create a new ViewItem]]
 +
# Release the meta definitions
 +
# Restart the {{UBIK}} Content web service
  
−
=== SmartStudio ===
 
  
−
Objects can be shown on the mobile client by configuring a compatible view hierarchy using SmartStudio, and connecting the object to be shown either as a root object to the Application Context, or as a child to another object. In both cases, a Scope modelling the look & feel for objects of that type needs to be provided. In the latter case, also a connection between the Scopes for the two types of objects must be provided as well.
 
  
−
Step-by-step, this is how you achieve that starting from scratch:
+
=== {{UBIK}} SmartStudio ===
  
−
# Make sure there is a {{{UBIK}}} Environment including a database and functioning web services, as well as a content object you want to show on the mobile client.
+
Objects can be shown on the mobile client by configuring a compatible view hierarchy using SmartStudio.  
−
# Open a new Application Graph worksheet.
+
This can be achieved using the Application Graph, connecting a Scope for the object to be shown either as a root scope to the Application Context (requiring a root object Query delivering the object in question), or as a child to another Scope (requiring a parent object to be available). In both cases, a Scope modelling the look & feel for objects of that type needs to be provided. If the object should be farther down the hierarchy (not a root object), also a connection between the Scopes for the object and its parent object must be provided as well.
−
# Add a Application by dragging it into the worksheet from a picker (existing Apps) or the toolbox (new App).
+
 
−
# Add a Context by dragging it into the worksheet from a picker (existing Contexts) or the toolbox (new Context).
+
# Set up web services.
−
# Connect the Context to the Application by dragging a connection between the two.
+
# Configure a view hierarchy in the Application Graph.
−
# Add a Scope by dragging a MetaClass into the worksheet from a picker (existing MetaClasses) or the toolbox (new MetaClasses). Such a Scope is a configuration for all instances of the respective MetaClass delivered to the mobile client.  
+
## Drop an application and context on the graph.
−
# Configure the Scope by adjusting the access rights for its MetaProperties.
+
## Drop scopes on the graph describing the look & feel of the objects on the mobile client.
−
# 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).
+
## Connect the scopes to the context or each other using drag & drop to establish a navigation hierarchy.
−
# Add further Scopes to the Application Graph and connect them by dragging a connection between two of them. This means, instances of the right-hand scoped MetaClass will be presentable in the hierarchy level below the left-hand scoped MetaClass' instances.
+
# Save the Application Graph to the {{UBIK}} Environment.
−
# Configure the connections (i.e., View Items) by choosing the way the instances are actually connected to each other (selecting a relation or link property). This means that 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.
+
# Publish the meta definitions to the {{UBIK}} web services.
−
# Configure a root Query for the Context by dragging a Query into the worksheet from a picker (existing Queries) or the toolbox (new Queries), 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.
+
# Restart the {{UBIK}} Content web service.
−
# 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.
+
 
−
# Save the application graph to the desired {{{UBIK}}} Environment, using the toolbar or context menu.
+
 
−
# Release the meta definitions in the Environment worksheet.
+
=== Troubleshooting ===
−
# Restart the web services.
+
 
 +
# Check whether the meta definitions were published.
 +
# Check whether the web service was restarted.
 +
# Check whether there is a scope for the object in question.
 +
# Check the visibility of the properties in case they are missing.
 +
# Check whether the object is either a root object, delivered by query or connected to its parent object correctly (scope connection in ACM and reference or relation on content).
 +
# Check for errors displayed on the client.
 +
# Check for errors logged by the web service.
  
 
=== See also ===
 
=== See also ===

Latest revision as of 15:40, 20 November 2019

Publishing an object's data via the UBIK® web services, potentially including its children, properties and documents, requires to configure the Application Context Management (ACM).

UBIK® Studio

  1. Set up web services
  2. Create a new Application
  3. Create a new Context
  4. Create a new MetaClassScope or Create a new QueryScope
  5. Create a new View
  6. Create a new ViewItem
  7. Release the meta definitions
  8. Restart the UBIK® Content web service


UBIK® SmartStudio

Objects can be shown on the mobile client by configuring a compatible view hierarchy using SmartStudio. This can be achieved using the Application Graph, connecting a Scope for the object to be shown either as a root scope to the Application Context (requiring a root object Query delivering the object in question), or as a child to another Scope (requiring a parent object to be available). In both cases, a Scope modelling the look & feel for objects of that type needs to be provided. If the object should be farther down the hierarchy (not a root object), also a connection between the Scopes for the object and its parent object must be provided as well.

  1. Set up web services.
  2. Configure a view hierarchy in the Application Graph.
    1. Drop an application and context on the graph.
    2. Drop scopes on the graph describing the look & feel of the objects on the mobile client.
    3. Connect the scopes to the context or each other using drag & drop to establish a navigation hierarchy.
  3. Save the Application Graph to the UBIK® Environment.
  4. Publish the meta definitions to the UBIK® web services.
  5. Restart the UBIK® Content web service.


Troubleshooting

  1. Check whether the meta definitions were published.
  2. Check whether the web service was restarted.
  3. Check whether there is a scope for the object in question.
  4. Check the visibility of the properties in case they are missing.
  5. Check whether the object is either a root object, delivered by query or connected to its parent object correctly (scope connection in ACM and reference or relation on content).
  6. Check for errors displayed on the client.
  7. Check for errors logged by the web service.

See also

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