View source for UBIK Studio Basics

{{UBIK}} Studio is the server application and administrative tool for creating and modifying {{UBIK}} object models. Transfer your entitiy-relationship-model into {{UBIK}} MetaClasses and MetaProperties and build up necessary relations. It is also the instrument of your choice to manage instances of MetaClasses, edit their property values and create actual relations between instance objects. This section will provide you with more information on the user interface.

[[File:METACLASS.png|thumb|220px|upright|alt={{UBIK}} metaclass|{{UBIK}} metaclass]]
[[File:INSTANCE.png|thumb|220px|upright|alt={{UBIK}} instance|{{UBIK}} instance]]
== Prerequisites ==
=== Options ===
[[File:USB_Options.png|thumb|220px|upright|alt={{UBIK}} Studio settings|{{UBIK}} Studio settings]]
Locate and click the menu ''Edit->Options''. Press the ''Apply'' or ''OK'' Button when you're finished changing the settings, or ''Cancel'' if you don't want your changes to be saved. The settings are user-specific and will be stored in your local windows user profile.

In the options you can configure your database connection by the following parameters
* <b>DataBase</b>: SQL database name
* <b>DataSource</b>: SQL server instance (specify a server via hostname, UNC, IP, ...)
* <b>User</b>: SQL user name
* <b>Password</b>: SQL user password

Take care that the specified SQL user has appropriate permissions on the database.

Additional options are
* <b>LiveMode</b>: True / False
* <b>RecordLifeTime</b>: Integer (default -1)


=== Working area and controls ===
[[File:USB_Studio.png|thumb|220px|upright|alt={{UBIK}} Studio main window|{{UBIK}} Studio main window]]
The main window of {{UBIK}} Studio is split into 3 sections, where each of the 3 areas can hold an arbitrary amount of controls. The arrangement of the controls is user specific and can be saved. In addition to the predefined sections, the user interface can be extended with working windows, where each working window can again hold any amount of controls:

:''View -> New Working Window'' or {{key press|Ctrl|W}}

However, such working windows are considered temporary and are therefore not made persistent when the layout is saved.





Each control provides different functionality for object creation/modification. Clicking the header of an empty tab strip in one of these areas with the left mouse button will bring up a context menu, that allows you to create a new tab page hosting one of the following controls:


[[File:USB_ControlsOverview.png|thumb|220px|upright|alt={{UBIK}} Studio controls|{{UBIK}} Studio controls]]

{| class="wikitable"
|-
! Control !! Description
|-
| ''[[Class Browser]]''|| Navigate through the MetaClasses and instances
|-
| ''[[Class Details]]''|| Design MetaClasses
|-
| ''[[Bulk Editor]]''|| Create and edit instances
|-
| ''[[Code Editor]]''|| Implement customer specific functionality
|-
| ''[[Relation Editor]]''|| Relate objects and edit relational data
|-
| ''[[Object Explorer]]''|| Display and edit all exposed properties of objects (list style)
|-
| ''[[Object Editor]]''|| Graphical editor for changing object properties
|-
| ''[[Workflow Designer]]''|| Design and assign customer specific workflows
|}

=== Editing objects in general ===
Basically there are various ways to edit objects in the {{UBIK}} database, each applicable for both, meta- and content objects. Use the following controls to edit
{| class="wikitable"
|-
! Property !! Control
|-
| Basic properties|| “Object Editor”, “Object Explorer”, “Content Editor”
|-
| Relational data|| “Relation Editor”
|-
| MetaClass details|| “Class Details”
|-
| Events / object methods|| “Code Editor"
|}
All controls require a similar workflow
<div style="border: 1px solid black;">
# Open the control
# Set the object to be edited to the control via dragging the object and dropping it onto the control’s tab
# The corresponding edit functionality will be available then
</div>


=== Creating and editing instances ===

== MetaClasses ==

=== Create new MetaClass ===
# Create a new MetaClass via „Derive new object“ from the context menu
# Open the control “Object Editor”
# Set the newly created MetaClass to the control
# Set name, description and namespace
# Save the changes

=== Technical implementation ===
The system creates a new instance of “CUSTOMMETACLASS” and sets the “INHERIT” property to the MetaClass the context menu was opened at. New derivates can be created for any system MetaClasss as “BASECLASS”, “REFERENCE”, “SELECTIVELIST”, … etc.

== MetaProperties ==

=== Create new MetaProperty ===
A new MetaProperty can be created and automatically assigned to a MetaClass via the “Create new MetaProperty ” workflow. This workflow guides the user through the creation and configuration procedure of a MetaProperty and relates it to the selected MetaClass .

# Start Workflow “System / Create new MetaProperty ” from the context menu
# Set at least name, description and data type
# Change the MetaProperty ’s category if necessary
# Save the changes
# Optional configuration:
:: - Reference
:: - Selective list
:: - Unit item
:: - Format
:: - Validation flag
:: - Number of index keys
:: - Default values
:: - Initial values

=== Technical implementation ===
Without the workflow the user has to complete the following steps:

Step 1: Create new MetaProperty instance
# Navigate to the MetaClass “CUSTOMMETAPROPERTY”
# Create a new instance
# Set at least name, description and data type
# Change the MetaProperty’s category if necessary
# Save the changes
# Optional configuration:
:: - Reference
:: - Selective list
:: - Unit item
:: - Format
:: - Validation flag
:: - Number of index keys
:: - Default values
:: - Initial values

Step 2: Relate the instance of MetaProperty to a MetaClass 
# Open the control “Class Details”
# Set the designated MetaClass to the control
# Add the MetaProperty either by dragging and dropping the MetaProperty's instance onto the MetaClass or by clicking the [[File:PlusGreen.png|20px|Add MetaProperty button]] button in the menu
# By clicking on the [[File:PlusGreen.png|20px|Add MetaProperty button]] button the user has to navigate through the hierarchy to the appropriate MetaProperty 

===Inheritance===
----

===Classification===
----