Last modified on 20 July 2026, at 06:11

Difference between revisions of "UBIK Studio Manual"

(Created page with "==Connect to a Database== 220px 220px Important: Database, Datasource, Password and User; Click Apply and OK; It is also...")
 
(→‎8. Scopes and display in the Client)
 
(138 intermediate revisions by the same user not shown)
Line 1: Line 1:
−
==Connect to a Database==
+
==1. Connect to a Database==
 +
The Options dialog can be opened via the icon located in the top-left toolbar, directly below the main menu bar.
 +
<div style="margin-top: 20px;">
 +
[[File:Manual2.png|thumb|none|left|300px|link=]]
 +
</div>
 +
<br>
  
−
[[File:manual.png|thumb|220px]]
+
<div style="float:left; margin: 0 20px 15px 0;">
−
[[File:manual2.png|thumb|220px]]
+
[[File:Manual.png|thumb|none|400px|link=]]
 +
</div>
 +
Click Apply and OK. It is also possible to run UBIK Studio using "WindowsAuthentication". To do this, the option in the "WindowsAuthentication" column must be set to "true" (in which case the username and password fields do not need to be filled in).
 +
<br style="clear:both" />
  
−
Important: Database, Datasource, Password and User; Click Apply and OK; It is also possible to run Ubik Studio using WindowsAuthentication. To do this, the option in the "WindowsAuthentication" column must be set to "true" (in which case the username and password fields do not need to be filled in).
+
Important:
 +
* Database
 +
* Datasource
 +
* Password
 +
* User
  
 +
<br style="clear:both" />
  
−
==Create Metaclasses and Properties==
 
  
−
[[File:metaclass1.png|thumb|220px]]
 
−
[[File:metaclass2.png|thumb|220px]]
 
−
To create a new metaclass, right-click on "NAMEDBASECLASS" -> "Derive new object". When the newly created metaclass is opened in an ObjectEditor, the properties of the metaclass can be edited. The name and description are mandatory fields, and it is recommended to write the name in uppercase letters. The namespace is optional, and there is also a checkbox for selecting multilanguage. To save the changes, first click in a new line and then select the floppy disk icon.
 
−
[[File:metaclass3.png|thumb|220px]]
 
−
[[File:metaclass4.png|thumb|220px]]
 
−
To add properties to a metaclass, CUSTOMMETAPROPERTIES are required. To access the CUSTOMMETAPROPERTY, switch to the Content area in the ClassBrowser. Then, drag Custom -> Main -> Base -> CUSTOMMETAPROPERTY into the BulkEditor. When creating a new property, first specify the name and description. Next, define the namespace and the data type.
 
−
[[File:metaclass5.png|thumb|220px]]
 
−
To add the newly created properties to a metaclass, drag the corresponding metaclass into the ClassDetails Editor. Then, drag the desired properties from CUSTOMMETAPROPERTY into the metaclass.
 
  
 +
==2. Create Metaclasses and Properties==
 +
MetaClasses define new object types within the UBIK® data model, while [[MetaProperty|MetaProperties]] define the corresponding attributes of these object types. Creating Custom [[MetaClass|MetaClasses]] and [[MetaProperty|MetaProperties]] is what allows the data model to be extended beyond the standard objects to meet customer-specific requirements.
 +
<br>
 +
To create a new metaclass, right-click on "NAMEDBASECLASS" > "Derive new object".
 +
<div style="margin-bottom: 20px;">
 +
{| style="margin-left: 0;"
 +
| [[File:Metaclass1.png|thumb|none|280px|link=]]
 +
| style="width:20px;" |
 +
| [[File:Metaclass2.png|thumb|none|280px|link=]]
 +
|}
 +
</div>
 +
<br>
 +
<div style="float:left; margin: 0 20px 15px 0;">
 +
[[File:Metaclass3.png|thumb|none|220px|link=]]
 +
</div>
 +
When the newly created metaclass is opened in an [[Object_Editor|ObjectEditor]], the properties of the Metaclass can be edited. The Name and Description are mandatory fields, and it is recommended to write the name in uppercase letters. The Namespace is optional, and there is also a checkbox for selecting multilanguage. To save the changes, first click in a new line and then select the floppy disk icon.
 +
<br style="clear:both" />
  
−
==Creating SelectiveList and SelectiveItem==
+
<div style="margin-bottom: 20px;">
−
To add a list to a property, you must first switch to the Content View [PF4.1]. Then, select Custom > List > SELECTIVELIST and drag it into a Bulk Editor (to access the Content View, switch to the "Content" area in the Class Browser – see screenshot). When creating the list, use the same data type as that of the corresponding metaproperty.
+
{| style="margin-left: 0;"
−
[[File:SLL1.png|thumb|220px]]
+
| [[File:Metaclass5.png|thumb|none|550px|link=]]
−
[[File:SLL2.png|thumb|220px]]
+
</div>
−
To create SelectiveItems, navigate to Custom > List > SELECTIVEITEM and drag SELECTIVEITEM into a BulkEditor.
+
To add properties to a metaclass, CUSTOMMETAPROPERTIES are required. To access the CUSTOMMETAPROPERTY, switch to the Content view in the ClassBrowser. Then, drag Custom -> Main -> Base -> CUSTOMMETAPROPERTY into the BulkEditor. When creating a new property, first specify the name and description. Next, define the namespace and the data type.
−
[[File:SLL3.png|thumb|220px]]
+
<br style="clear:both" />
−
[[File:SLL4.png|thumb|220px]]
+
 
−
To add SelectiveItems to a list, the previously created list must be opened in a RelationEditor. To do this, for example, drag Custom->List->SELECTIVELIST->Custom->ANLEITUNG into the RelationEditor.                                                                                    
+
<div style="margin-bottom: 20px;">
−
Then, drag the SelectiveItems from the BulkEditor into the corresponding list.
+
{| style="margin-left: 0;"
−
[[File:SLL5.png|thumb|220px]]
+
| [[File:Metaclass4.png|thumb|none|550px|link=]]
 +
</div>
 +
To add the newly created Properties to a Metaclass, drag the corresponding Metaclass into the [[Class_Details|ClassDetails Editor]]. Then, drag the desired Properties from CUSTOMMETAPROPERTY into the Metaclass.
 +
<br style="clear:both" />
 +
 
 +
[[Category:Pages with broken file links|UBIK Studio Manual]]
 +
 
 +
==3. Creating SelectiveList and SelectiveItem==
 +
A [[SELECTIVELIST|SelectiveList]] provides a predefined list of selectable values that users can choose from instead of entering free text. Each individual entry in this list is represented as a [[SELECTIVEITEM|SelectiveItem]].
 +
To add a list to a property, you must first switch to the Content View. Then, select Custom > List > SELECTIVELIST and drag it into a Bulk Editor (to access the Content View, switch to the "Content View" in the [[Class_Browser|Class Browser]] – see screenshot). When creating the list, use the same data type as that of the corresponding Metaproperty.
 +
 
 +
<div style="margin-top: 20px;">
 +
[[File:SLL2.png|thumb|none|left|400px|link=]]
 +
</div>
 +
<div style="margin-top: 15px;">
 +
[[File:SLL1.png|thumb|none|left|700px|link=]]
 +
</div>
 +
<br>
 +
 
 +
To create SelectiveItems, navigate to Custom > List > SELECTIVEITEM and drag SELECTIVEITEM into a [[Bulk_Editor|BulkEditor]].
 +
<div style="margin-top: 0px;">
 +
[[File:SLL4.png|thumb|none|left|400px|link=]]
 +
</div>
 +
<div style="margin-top: 15px;">
 +
[[File:SLL3.png|thumb|none|left|700px|link=]]
 +
</div>
 +
<br>
 +
<br>
 +
To add SelectiveItems to a list, the previously created list must be opened in a [[Relation_Editor|RelationEditor]]. To do this, for example, drag Custom->List->SELECTIVELIST->Custom->ANLEITUNG into the RelationEditor. Then, drag the SelectiveItems from the [[Bulk_Editor|BulkEditor]] into the corresponding list.
 +
 
 +
<div style="margin-top: 10px;">
 +
[[File:SLL5.png|thumb|none|left|700px|link=]]
 +
</div>
 +
<br>
 
To add the list to the property, select the previously created list in the SELECTIVELIST column of CUSTOMMETAPROPERTY.
 
To add the list to the property, select the previously created list in the SELECTIVELIST column of CUSTOMMETAPROPERTY.
−
[[File:SLL6.png|thumb|220px]]
 
  
 +
<div style="margin-top: 10px;">
 +
[[File:SLL6.png|thumb|none|left|700px|link=]]
 +
</div>
  
−
==Create References and Links==
+
[[Category:Pages with broken file links|UBIK Studio Manual]]
−
To create a reference, navigate to Custom->Reference and drag Custom->Reference->REFERENCE into the BulkEditor (to access the content view, you must switch to the content area in the ClassBrowser). Then, specify the name, description, namespace, and TargetType. When creating a new reference—for example, REF_ANLEITUNG—the corresponding metaclass ANLEITUNG must be set as the TargetType.
+
−
[[File:REF1.png|thumb|220px]]
+
−
[[File:REF2.png|thumb|220px]]
+
−
To create link properties, drag CUSTOMMETAPROPERTY into a BulkEditor. Select "Guid" as the data type. Then, assign the previously created reference—for example, REF_ANLEITUNG—to the reference field.
+
−
[[File:REF3.png|thumb|220px]]
+
−
The metaclass referenced by the link property must be dragged into a ClassDetails editor. Subsequently, the link property is assigned to the corresponding metaclass under MetaProperties.
+
−
[[File:REF4.png|thumb|220px]]
+
  
 +
==4. Create References and Links==
 +
References define which object types a connection (link) may point to, while links, implemented as a property of type Guid, actually establish this connection between two instances. Both elements are required to model directed relationships between objects within the UBIK® data model, e.g. to point from one object to another without needing a fixed parent-child structure.
 +
To create a Reference, navigate to Custom->Reference and drag Custom->Reference->REFERENCE into the BulkEditor (to access the content view, you must switch to the content area in the ClassBrowser). Then, specify the Name, Description, Namespace, and TargetType. When creating a new reference—for example, REF_ANLEITUNG—the corresponding metaclass ANLEITUNG must be set as the TargetType.
 +
[[File:createReferencesAndLinks1.png|thumb|400px|left]]
  
−
==Create View==
+
 
−
To create ReferenceViewItems, drag Custom->View->REFERENCEVIEWITEM into a BulkEditor (To access the Content-View, switch to the Content area in the ClassBrowser).
+
<br style="clear:both" />
−
[[File:VI1.png|thumb|220px]]
+
<br>
−
Create a new instance of a ReferenceViewItem using the Bulk Editor. Specify the name of the reference property in the "Reference" cell. Select the "Reverse" checkbox if the ReferenceViewItem is to be evaluated in reverse (right-to-left) order. Assign a query instance of the ReferenceViewItem to the "Reversereftype" attribute—either by dragging and dropping a metaclass object onto the cell or by selecting the desired metaclass from the dialog box that appears when you double-click the field.
+
<br>
−
[[File:VI2.png|thumb|220px]]
+
To create link Properties, drag CUSTOMMETAPROPERTY into a [[Bulk_Editor|BulkEditor]]. Select "Guid" as the data type. Then, assign the previously created Reference—for example, REF_ANLEITUNG to the Reference field.
−
To add the ReferenceViewItem to the view, open the corresponding view in the RelationEditor: Custom->View->VIEW->CUSTOM->CUSTOM->TEMPLATE->VIE_01. The ReferenceViewItem can then be assigned to the view.
+
 
−
[[File:VI3.png|thumb|220px]]
+
<div style="margin-top: 10px;">
 +
[[File:REF3.png|none|left|thumb|700px|link=]]
 +
</div>
 +
<br>
 +
The Metaclass referenced by the link Property must be dragged into a ClassDetails editor. Subsequently, the link Property is assigned to the corresponding metaclass under MetaProperties.
 +
 
 +
<div style="margin-top: 10px;">
 +
[[File:REF4.png|thumb|none|left|700px|link=]]
 +
</div>
 +
 
 +
[[Category:Pages with broken file links|UBIK Studio Manual]]
 +
 
 +
==5. [[HowTo:Create_a_new_View|Create View]]==
 +
A View defines a hierarchical display of objects, where the associated [[VIEWITEMS|ViewItems]] determine how hierarchy levels are built starting from the View`s root objects.
 +
To create [[HowTo:Create_a_new_ReferenceViewItem_automatically|ReferenceViewItems]], drag Custom->View->REFERENCEVIEWITEM into a BulkEditor (To access the Content-View, switch to the Content area in the ClassBrowser).
 +
<div style="float:left; margin: 0 20px 15px 0;">
 +
[[File:VI1.png|thumb|none|270px|link=]]
 +
</div>
 +
Create a new instance of a ReferenceViewItem using the Bulk Editor. Specify the Name of the Reference Property in the "Reference" cell. Select the "Reverse" checkbox if the ReferenceViewItem is to be evaluated in reverse (right-to-left) order. Assign a query instance of the ReferenceViewItem to the "Reversereftype" attribute—either by dragging and dropping a metaclass object onto the cell or by selecting the desired metaclass from the dialog box that appears when you double-click the field. <div style="margin-top: 10px;"> [[File:ReferenceViewItemBulkEditor.png|thumb|none|right|700px|link=]]
 +
<br style="clear:both" />
 +
 
 +
</div>
 +
To add the ReferenceViewItem to the view, open the corresponding view in the RelationEditor: Custom -> View -> VIEW -> CUSTOM -> CUSTOM -> TEMPLATE -> VIE_01. The ReferenceViewItem can then be assigned to the view.
 +
<div style="margin-top: 10px;">
 +
[[File:createViewRelationEditor.png|thumb|none|left|700px|link=]]
 +
</div>
 +
<br style="clear:both" />
 
To correctly display data in hierarchical structures such as trees or nested lists, a view must retrieve the root objects (root elements) of the first level. This ensures that the view has the entry point for navigation and that child elements are referenced correctly. To create a RootObject, the MetaClass must be dragged into the BulkEditor. Then, an object can be created. This object must then be dragged onto the MetaClass in the Relation Editor.
 
To correctly display data in hierarchical structures such as trees or nested lists, a view must retrieve the root objects (root elements) of the first level. This ensures that the view has the entry point for navigation and that child elements are referenced correctly. To create a RootObject, the MetaClass must be dragged into the BulkEditor. Then, an object can be created. This object must then be dragged onto the MetaClass in the Relation Editor.
−
[[File:VI4.png|thumb|220px]]
+
<div style="margin-top: 10px;">
 +
[[File:VI4.png|thumb|none|left|700px|link=]]
 +
</div>
  
 +
[[Category:Pages with broken file links|UBIK Studio Manual]]
  
−
==Rebuild==
+
==6. Rebuild==
 +
A Rebuild ccompiles the modified customizing (MetaClasses, MetaProperties and associated custom code) into a new assembly, so that the changes made take effect in UBIK Studio and on the UBIK server.
 
To rebuild the customization, a rebuild process must be performed first. A rebuild recompiles all components of the UBIK data model, generates the required .NET assemblies and database objects, and ensures that all changes are applied consistently.
 
To rebuild the customization, a rebuild process must be performed first. A rebuild recompiles all components of the UBIK data model, generates the required .NET assemblies and database objects, and ensures that all changes are applied consistently.
−
[[File:RB1.png|thumb|220px]]
+
 
 
Once the rebuild is complete, first click the left icon (Syntax Check) and then the right icon (Compile and Release).
 
Once the rebuild is complete, first click the left icon (Syntax Check) and then the right icon (Compile and Release).
−
[[File:RB2.png|thumb|220px]]
+
 
 
The program then restarts automatically.
 
The program then restarts automatically.
  
 +
<div style="margin-top: 25px;">
 +
{| style="margin-left: 0;"
 +
| [[File:RB1.png|thumb|none|330px|link=]]
 +
| style="width:30px;" |
 +
| [[File:RB2.png|thumb|none|330px|link=]]
 +
|}
 +
</div>
  
−
==View Test Environment==
+
[[Category:Pages with broken file links|UBIK Studio Manual]]
 +
 
 +
==7. [[View_Test_Environment|View Test Environment]]==
 +
The View Test Environment allows a configured View to be tested directly in UBIK Studio, to verify that the defined root objects and ViewItems build the desired hierarchy correctly before the View is used in production.
 
To test the Customizing, select the "View Test Environment" option from the Tools menu.
 
To test the Customizing, select the "View Test Environment" option from the Tools menu.
−
[[File:VTE1.png|thumb|220px]]
+
 
 
A window opens where the desired view can be selected from the drop-down menu. The root object should then be visible. A new object can be created by right-clicking on the object, though the triangle next to the name must be expanded first.
 
A window opens where the desired view can be selected from the drop-down menu. The root object should then be visible. A new object can be created by right-clicking on the object, though the triangle next to the name must be expanded first.
−
[[File:VTE2.png|thumb|220px]]
 
−
The properties can be edited in the newly opened window.
 
  
 +
The Properties can be edited in the newly opened window.
  
−
==Scopes and display in the client==
+
<div style="margin-top: 25px;">
−
To display the content in the client, open Custom->ACM->CONTEXT->CUSTOM->CUSTOM TEMPLATE. The context can then be viewed (to access the content view, switch to the Content pane in the ClassBrowser).
+
{| style="margin-left: 0;"
−
[[File:SC1.png|thumb|220px]]
+
| [[File:VTE1.png|thumb|none|330px|link=]]
−
Ubik Studio offers an automated feature that helps when creating MetaClassScopes. To use it, drag the metaclasses onto the context. After dragging, a small window appears with the option "Add fitting Scope to Context," which you should select. The MetaClassScope configuration will then open. Here, you can change settings such as visibility or lock status. Once everything is configured, confirm with "OK." You can view this configuration in Custom->ACM->Scopes->METACLASSSCOPES (to access the content view, you must switch to the Content section in the ClassBrowser).
+
| style="width:30px;" |
−
[[File:SC2.png|thumb|220px]]
+
| [[File:VTE2.png|thumb|none|330px|link=]]
−
To ensure the object can be created later, the Default Context is dragged into the RelationEditor. There, the ContextScope is expanded using the plus symbol, and the Meta Class Scope [PF12.1] is selected. Another window opens, allowing the "Creation enabled" option to be activated.
+
|}
−
[[File:SC3.png|thumb|220px]]
+
</div>
−
All objects/classes/tasks/etc. that should later be visible in the client must be included in the context.
+
−
To edit the visibility of individual properties within the scopes, the Default Context is required in the RelationEditor. There, the ContextScope is expanded, the plus symbol next to the desired MetaClassScope is clicked to reveal the MetaProperties, and selecting a property opens a new window where visibility, lock status, priority, and sort order can be configured.
+
−
[[File:SC4.png|thumb|220px]]
+
−
To create MetaClassScopes manually, the METACLASSSCOPE must be dragged into a Bulk Editor[PF14.1] (CUSTOM -> ACM -> SCOPES -> METACLASSCOPE).
+
−
[[File:SC5.png|thumb|220px]]
+
−
New MetaClassScopes can be created in the Bulk Editor. The name and description should be formatted as MCS_..., with the name being capitalized. The MetaClass from which the scope should be created is dragged into the MetaClass column.
+
−
[[File:SC6.png|thumb|220px]]
+
−
Once the scope has been created, the newly created scope is dragged onto the context open in the Relation Editor.
+
−
[[File:SC7.png|thumb|220px]]
+
−
As a final step, the properties are dragged from the open bulk editor of the MetaClass into the context opened by the relation editor (by clicking on the first column next to the desired names, the entire row can be selected and moved).
+
−
[[File:SC8.png|thumb|220px]]
+
  
 +
[[Category:Pages with broken file links|UBIK Studio Manual]]
 +
 +
==8. Scopes and display in the Client==
 +
Scopes define which MetaClasses, Properties, and queries are published to the mobile UBIK® Client, thereby determining which objects and information are actually displayed to the user there.
 +
 +
To display the content in the client, navigate to Custom -> ACM -> CONTEXT -> CUSTOM -> CUSTOM TEMPLATE. The context can then be inspected (to access the Content view, switch to the Content section in the Class Browser). UBIK Studio provides an automatism that assists in [[HowTo:Create_a_new_MetaClassScope|creating MetaClassScopes]]: to use it, drag the desired MetaClass onto the Context. After dropping it, a small window appears with the option "Add fitting Scope to Context", which should be selected.
 +
 +
<div style="text-align:left;margin-top: 10px; margin-bottom: 20px;">
 +
[[File:SC1.png|thumb|none|left|650px|link=]]
 +
</div>
 +
 +
Danach öffnet sich die MetaClassScope – Configuration. Dort kann z.B. die Visibility oder der Lockstatus verändert werden. Wenn alles eingestellt ist, mit „OK" bestätigen. Diesen kann man in Custom->ACM->Scopes->METACLASSSCOPES einsehen.
 +
 +
<div style="text-align:left;margin-top: 10px; margin-bottom: 25px;">
 +
[[File:SC2.png|thumb|none|left|600px|link=]]
 +
</div>
 +
 +
To make the object creatable later on, the Default Context is dragged into the Relation Editor. There, the ContextScope is expanded via the plus icon, and the MetaClassScope is selected. This opens another window in which the "Creation enabled" option can be activated.
 +
 +
<div style="text-align:left;margin-top: 10px; margin-bottom: 20px;">
 +
[[File:SC3.png|thumb|none|left|550px|link=]]
 +
</div>
 +
 +
All objects/classes/tasks/etc. that should later be visible in the client must be contained within the Context.
 +
To edit the visibility of individual properties within the Scopes, the Default Context is required in the Relation Editor. There, the ContextScope is expanded, then the plus icon next to the desired MetaClassScope is opened to reveal the MetaProperties. Selecting a property opens a new window in which the visibility, lock status, priority, and sort order can be configured.
 +
 +
<div style="text-align:left;margin-top: 10px; margin-bottom: 20px;">
 +
[[File:SC4.png|thumb|none|left|550px|link=]]
 +
</div>
 +
 +
[[Category:Pages with broken file links|UBIK Studio Manual]]
 +
 +
==9. Release Metadefinitions==
 +
Only after releasing the Metadefinitions are changes to the Metamodel — such as newly created MetaClasses, MetaProperties, or Scopes — published from Sandbox mode and thereby actually made available to the client and other Studio instances.
 +
 +
Select Tools from the menu bar and then open the [[ACM_Manager|ACM Manager]].
  
−
==Release Metadefinitions==
 
−
Select Tools from the menu bar and then open the ACM Manager.
 
−
[[File:MDR1.png|thumb|220px]]
 
 
After opening the dialog window, two context areas are displayed: "Context objects" and "Custom Context objects." Only the "Custom Context objects" area is relevant for the subsequent steps. Expand the "Custom Context objects" area until the desired context is visible, and select it with a single mouse click. Then, perform the following actions in the toolbar in the order specified: Evaluate Temporary Meta Definitions -> Clear Released Meta Definitions (this icon appears only after the context has been successfully rebuilt at least once) -> Release Meta Definitions. Ensure that the actions are performed sequentially and in the specified order.
 
After opening the dialog window, two context areas are displayed: "Context objects" and "Custom Context objects." Only the "Custom Context objects" area is relevant for the subsequent steps. Expand the "Custom Context objects" area until the desired context is visible, and select it with a single mouse click. Then, perform the following actions in the toolbar in the order specified: Evaluate Temporary Meta Definitions -> Clear Released Meta Definitions (this icon appears only after the context has been successfully rebuilt at least once) -> Release Meta Definitions. Ensure that the actions are performed sequentially and in the specified order.
−
[[File:MDR2.png|thumb|220px]]
 
  
 +
<div style="margin-top: 25px;">
 +
{| style="margin-left: 0;"
 +
| [[File:MDR1.png|none|330px|thumb|link=]]
 +
| style="width:30px;" |
 +
| [[File:MDR2.png|none|330px|thumb|link=]]
 +
|}
 +
</div>
 +
 +
[[Category:Pages with broken file links|UBIK Studio Manual]]
 +
 +
==10. Create User==
 +
Custom->Main->User->LOGIN is dragged into a BulkEditor. Subsequently, the Name and Description can be specified, with the LoginName being populated automatically once the name has been entered.
 +
<br style="clear:both" />
 +
 +
{| style="margin-left: 0;"
 +
| [[File:USER1.png|thumb|none|330px]]
 +
| [[File:USER2.png|thumb|none|900px]]
 +
|}
 +
 +
[[Category:Pages with broken file links|UBIK Studio Manual]]
  
−
==Create User==
+
==11. Create Workpackages and Tasks==
−
Custom->Main->User->LOGIN is dragged into a BulkEditor. Subsequently, the name and description can be specified, with the LoginName being populated automatically once the name has been entered.
+
Workpackages and Tasks are the MRO (Maintenance, Repair and Operations) objects used to structure work to be carried out: a Workpackage groups the individual Tasks through which users report progress, results, and completion of work in the UBIK® client.
−
[[File:US1.png|thumb|220px]]
+
−
[[File:US2.png|thumb|220px]]
+
  
 +
Navigate the hierarchy to "WORKPACKAGES MRO workpackages." Right-click this item and select "Derive new Object" to create a new Metaclass for a new type of Workpackage. The Workpackage Name can subsequently be adjusted in the ObjectEditor. The Name should be entered in uppercase letters; the Description field can be filled in as desired, and there is also an option to enable multilingual support.
 +
{| style="margin-left: 0;"
 +
| [[File:WorkPackage1.png|thumb|none|220px]]
 +
| style="width:20px;" |
 +
| [[File:createWorkpackagesAndTasks.png|thumb|none|300px]]
 +
|}
 +
<br>
 +
<br>
 +
To create a new task, use "TASK MRO tasks." Again, right-click and select "Derive new object" to create the metaclass. The task type is determined by the data type; for example, a Texttask requires an additional value Property of type "string," whereas a check task requires a value Property of type "bool." This value Property is then dragged from the CUSTOMMETAPROPERTIES onto the Metaclass opened in the RelationEditor.
 +
[[File:WP2.png|thumb|none|500px]]
 +
<br style="clear:both" />
 +
By deriving from the TASK MRO task, the task inherits the classification of the parent object. This classification determines the type assigned to the newly created task. You can view the required Property in the Class Details; to do this, select the cube icon at the top. Then, open the "Task Classification Object"; color-coded markers (red and green) will indicate whether specific Properties still need to be added.
 +
<br style="clear:both" />
 +
{| style="margin-left: 0;"
 +
| [[File:WP3.png|thumb|none|330px]]
 +
| [[File:WP4.png|thumb|none|330px]]
 +
|}
  
−
==Create Workpackages and Tasks==
+
[[Category:Pages with broken file links|UBIK Studio Manual]]
−
Navigate the hierarchy to "WORKPACKAGES MRO workpackages." Right-click this item and select "Derive new Object" to create a new metaclass for a new type of work package [PF20.1][PF20.2]. The work package name can subsequently be adjusted in the ObjectEditor. The name should be entered in uppercase letters; the description field can be filled in as desired, and there is also an option to enable multilingual support. To create a new task, use "TASK MRO tasks." Again, right-click and select "Derive new object" to create the metaclass. The task type is determined by the data type; for example, a text task requires an additional value property of type "string," whereas a check task requires a value property of type "bool." This value property is then dragged from the CUSTOMMETAPROPERTIES onto the metaclass opened in the RelationEditor.
+
−
[[File:WP1.png|thumb|220px]]
+
−
[[File:WP2.png|thumb|220px]]
+
−
By deriving from the TASK MRO task, the task inherits the classification of the parent object. This classification determines the type assigned to the newly created task. You can view the required property in the Class Details; to do this, select the cube icon at the top. Then, open the "Task Classification Object"; color-coded markers (red and green) will indicate whether specific properties still need to be added.
+
−
[[File:WP3.png|thumb|220px]]
+
−
[[File:WP4.png|thumb|220px]]
+
  
 +
==12. Editors==
 +
{| class="wikitable"
 +
! Editor !! Description
 +
|-
 +
| '''[[Class_Browser|Class Browser]]''' || Navigate through metaclasses and instances; create and delete them.
 +
|-
 +
| '''[[Class_Details|Class Details]]''' || Configure metaclass details; add or remove metaproperties and classifications.
 +
|-
 +
| '''[[Bulk_Editor|Bulk Editor]]''' || Create and edit multiple instances of a metaclass in a tabular format.
 +
|-
 +
| '''[[Code_Editor|Code Editor]]''' || Add small code snippets to any metaclass. For example: automatically generate a name based on today's date and the company name when a new batch is created.
 +
|-
 +
| '''[[Relation_Editor|Relation Editor]]''' || Link objects and edit relational data.
 +
|-
 +
| '''[[Object_Explorer|Object Explorer]]''' || View and edit all visible object properties (list view).
 +
|-
 +
| '''[[Object_Editor|Object Editor]]''' || Edit the property values of a single object.
 +
|-
 +
| '''[[Workflow_Editor|Workflow Editor]]''' || View, design, and execute custom workflows.
 +
|}
  
−
==Editors==
+
[[Category:Pages with broken file links|UBIK Studio Manual]]
−
Class Browser: Navigate through metaclasses and instances; create and delete them.
+
−
Class Details: Configure metaclass details; add or remove metaproperties and classifications.
+
−
Bulk Editor: Create and edit multiple instances of a metaclass in a tabular format.
+
−
Code Editor: Add small code snippets to any metaclass. For example: automatically generate a name based on today's date and the company name when a new batch is created.
+
−
Relation Editor: Link objects and edit relational data.
+
−
Object Explorer: View and edit all visible object properties (list view).
+
−
Object Editor: Edit the property values ​​of a single object.
+
−
Workflow Editor: View, design, and execute custom workflows.
+

Latest revision as of 06:11, 20 July 2026

1. Connect to a Database

The Options dialog can be opened via the icon located in the top-left toolbar, directly below the main menu bar.

Manual2.png


Manual.png

Click Apply and OK. It is also possible to run UBIK Studio using "WindowsAuthentication". To do this, the option in the "WindowsAuthentication" column must be set to "true" (in which case the username and password fields do not need to be filled in).

Important:

  • Database
  • Datasource
  • Password
  • User



2. Create Metaclasses and Properties

MetaClasses define new object types within the UBIK® data model, while MetaProperties define the corresponding attributes of these object types. Creating Custom MetaClasses and MetaProperties is what allows the data model to be extended beyond the standard objects to meet customer-specific requirements.
To create a new metaclass, right-click on "NAMEDBASECLASS" > "Derive new object".

Metaclass1.png
Metaclass2.png


Metaclass3.png

When the newly created metaclass is opened in an ObjectEditor, the properties of the Metaclass can be edited. The Name and Description are mandatory fields, and it is recommended to write the name in uppercase letters. The Namespace is optional, and there is also a checkbox for selecting multilanguage. To save the changes, first click in a new line and then select the floppy disk icon.

Metaclass5.png

To add properties to a metaclass, CUSTOMMETAPROPERTIES are required. To access the CUSTOMMETAPROPERTY, switch to the Content view in the ClassBrowser. Then, drag Custom -> Main -> Base -> CUSTOMMETAPROPERTY into the BulkEditor. When creating a new property, first specify the name and description. Next, define the namespace and the data type.

Metaclass4.png

To add the newly created Properties to a Metaclass, drag the corresponding Metaclass into the ClassDetails Editor. Then, drag the desired Properties from CUSTOMMETAPROPERTY into the Metaclass.

3. Creating SelectiveList and SelectiveItem

A SelectiveList provides a predefined list of selectable values that users can choose from instead of entering free text. Each individual entry in this list is represented as a SelectiveItem. To add a list to a property, you must first switch to the Content View. Then, select Custom > List > SELECTIVELIST and drag it into a Bulk Editor (to access the Content View, switch to the "Content View" in the Class Browser – see screenshot). When creating the list, use the same data type as that of the corresponding Metaproperty.

SLL2.png
SLL1.png


To create SelectiveItems, navigate to Custom > List > SELECTIVEITEM and drag SELECTIVEITEM into a BulkEditor.

SLL4.png
SLL3.png



To add SelectiveItems to a list, the previously created list must be opened in a RelationEditor. To do this, for example, drag Custom->List->SELECTIVELIST->Custom->ANLEITUNG into the RelationEditor. Then, drag the SelectiveItems from the BulkEditor into the corresponding list.

SLL5.png


To add the list to the property, select the previously created list in the SELECTIVELIST column of CUSTOMMETAPROPERTY.

SLL6.png

4. Create References and Links

References define which object types a connection (link) may point to, while links, implemented as a property of type Guid, actually establish this connection between two instances. Both elements are required to model directed relationships between objects within the UBIK® data model, e.g. to point from one object to another without needing a fixed parent-child structure. To create a Reference, navigate to Custom->Reference and drag Custom->Reference->REFERENCE into the BulkEditor (to access the content view, you must switch to the content area in the ClassBrowser). Then, specify the Name, Description, Namespace, and TargetType. When creating a new reference—for example, REF_ANLEITUNG—the corresponding metaclass ANLEITUNG must be set as the TargetType.

CreateReferencesAndLinks1.png





To create link Properties, drag CUSTOMMETAPROPERTY into a BulkEditor. Select "Guid" as the data type. Then, assign the previously created Reference—for example, REF_ANLEITUNG to the Reference field.

REF3.png


The Metaclass referenced by the link Property must be dragged into a ClassDetails editor. Subsequently, the link Property is assigned to the corresponding metaclass under MetaProperties.

REF4.png

5. Create View

A View defines a hierarchical display of objects, where the associated ViewItems determine how hierarchy levels are built starting from the View`s root objects. To create ReferenceViewItems, drag Custom->View->REFERENCEVIEWITEM into a BulkEditor (To access the Content-View, switch to the Content area in the ClassBrowser).

VI1.png
Create a new instance of a ReferenceViewItem using the Bulk Editor. Specify the Name of the Reference Property in the "Reference" cell. Select the "Reverse" checkbox if the ReferenceViewItem is to be evaluated in reverse (right-to-left) order. Assign a query instance of the ReferenceViewItem to the "Reversereftype" attribute—either by dragging and dropping a metaclass object onto the cell or by selecting the desired metaclass from the dialog box that appears when you double-click the field.
ReferenceViewItemBulkEditor.png


To add the ReferenceViewItem to the view, open the corresponding view in the RelationEditor: Custom -> View -> VIEW -> CUSTOM -> CUSTOM -> TEMPLATE -> VIE_01. The ReferenceViewItem can then be assigned to the view.

CreateViewRelationEditor.png


To correctly display data in hierarchical structures such as trees or nested lists, a view must retrieve the root objects (root elements) of the first level. This ensures that the view has the entry point for navigation and that child elements are referenced correctly. To create a RootObject, the MetaClass must be dragged into the BulkEditor. Then, an object can be created. This object must then be dragged onto the MetaClass in the Relation Editor.

VI4.png

6. Rebuild

A Rebuild ccompiles the modified customizing (MetaClasses, MetaProperties and associated custom code) into a new assembly, so that the changes made take effect in UBIK Studio and on the UBIK server. To rebuild the customization, a rebuild process must be performed first. A rebuild recompiles all components of the UBIK data model, generates the required .NET assemblies and database objects, and ensures that all changes are applied consistently.

Once the rebuild is complete, first click the left icon (Syntax Check) and then the right icon (Compile and Release).

The program then restarts automatically.

RB1.png
RB2.png

7. View Test Environment

The View Test Environment allows a configured View to be tested directly in UBIK Studio, to verify that the defined root objects and ViewItems build the desired hierarchy correctly before the View is used in production. To test the Customizing, select the "View Test Environment" option from the Tools menu.

A window opens where the desired view can be selected from the drop-down menu. The root object should then be visible. A new object can be created by right-clicking on the object, though the triangle next to the name must be expanded first.

The Properties can be edited in the newly opened window.

VTE1.png
VTE2.png

8. Scopes and display in the Client

Scopes define which MetaClasses, Properties, and queries are published to the mobile UBIK® Client, thereby determining which objects and information are actually displayed to the user there.

To display the content in the client, navigate to Custom -> ACM -> CONTEXT -> CUSTOM -> CUSTOM TEMPLATE. The context can then be inspected (to access the Content view, switch to the Content section in the Class Browser). UBIK Studio provides an automatism that assists in creating MetaClassScopes: to use it, drag the desired MetaClass onto the Context. After dropping it, a small window appears with the option "Add fitting Scope to Context", which should be selected.

SC1.png

Danach öffnet sich die MetaClassScope – Configuration. Dort kann z.B. die Visibility oder der Lockstatus verändert werden. Wenn alles eingestellt ist, mit „OK" bestätigen. Diesen kann man in Custom->ACM->Scopes->METACLASSSCOPES einsehen.

SC2.png

To make the object creatable later on, the Default Context is dragged into the Relation Editor. There, the ContextScope is expanded via the plus icon, and the MetaClassScope is selected. This opens another window in which the "Creation enabled" option can be activated.

SC3.png

All objects/classes/tasks/etc. that should later be visible in the client must be contained within the Context. To edit the visibility of individual properties within the Scopes, the Default Context is required in the Relation Editor. There, the ContextScope is expanded, then the plus icon next to the desired MetaClassScope is opened to reveal the MetaProperties. Selecting a property opens a new window in which the visibility, lock status, priority, and sort order can be configured.

SC4.png

9. Release Metadefinitions

Only after releasing the Metadefinitions are changes to the Metamodel — such as newly created MetaClasses, MetaProperties, or Scopes — published from Sandbox mode and thereby actually made available to the client and other Studio instances.

Select Tools from the menu bar and then open the ACM Manager.

After opening the dialog window, two context areas are displayed: "Context objects" and "Custom Context objects." Only the "Custom Context objects" area is relevant for the subsequent steps. Expand the "Custom Context objects" area until the desired context is visible, and select it with a single mouse click. Then, perform the following actions in the toolbar in the order specified: Evaluate Temporary Meta Definitions -> Clear Released Meta Definitions (this icon appears only after the context has been successfully rebuilt at least once) -> Release Meta Definitions. Ensure that the actions are performed sequentially and in the specified order.

MDR1.png
MDR2.png

10. Create User

Custom->Main->User->LOGIN is dragged into a BulkEditor. Subsequently, the Name and Description can be specified, with the LoginName being populated automatically once the name has been entered.

USER1.png
USER2.png

11. Create Workpackages and Tasks

Workpackages and Tasks are the MRO (Maintenance, Repair and Operations) objects used to structure work to be carried out: a Workpackage groups the individual Tasks through which users report progress, results, and completion of work in the UBIK® client.

Navigate the hierarchy to "WORKPACKAGES MRO workpackages." Right-click this item and select "Derive new Object" to create a new Metaclass for a new type of Workpackage. The Workpackage Name can subsequently be adjusted in the ObjectEditor. The Name should be entered in uppercase letters; the Description field can be filled in as desired, and there is also an option to enable multilingual support.

WorkPackage1.png
CreateWorkpackagesAndTasks.png



To create a new task, use "TASK MRO tasks." Again, right-click and select "Derive new object" to create the metaclass. The task type is determined by the data type; for example, a Texttask requires an additional value Property of type "string," whereas a check task requires a value Property of type "bool." This value Property is then dragged from the CUSTOMMETAPROPERTIES onto the Metaclass opened in the RelationEditor.

WP2.png


By deriving from the TASK MRO task, the task inherits the classification of the parent object. This classification determines the type assigned to the newly created task. You can view the required Property in the Class Details; to do this, select the cube icon at the top. Then, open the "Task Classification Object"; color-coded markers (red and green) will indicate whether specific Properties still need to be added.

WP3.png
WP4.png

12. Editors

Editor Description
Class Browser Navigate through metaclasses and instances; create and delete them.
Class Details Configure metaclass details; add or remove metaproperties and classifications.
Bulk Editor Create and edit multiple instances of a metaclass in a tabular format.
Code Editor Add small code snippets to any metaclass. For example: automatically generate a name based on today's date and the company name when a new batch is created.
Relation Editor Link objects and edit relational data.
Object Explorer View and edit all visible object properties (list view).
Object Editor Edit the property values of a single object.
Workflow Editor View, design, and execute custom workflows.