Difference between revisions of "UBIK Studio Basics"

Revision as of 16:02, 11 March 2013

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.

Prerequisites

Options

UBIK^® Studio settings

Locate and click the menu Edit → Options. Press Apply or OK 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

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

Additional options are

Command line arguments

The following arguments can be passed to and will be recognized by the UBIK.Studio.exe:

Working with UBIK^® Studio

Basic UI elements

Menu and toolbar

The top area of UBIK^® Studio features a menu strip:

Status strip

The status strip displays the following information, from left to right:

Working area and controls

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 the user's profile. 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 Ctrl+W

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

Using and connecting controls

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:

UBIK^® Studio controls

All controls in the UBIK^® working area offer the following interaction functionality:

• Set a control as ListenTo source of another control by dragging an object from it with the left mouse button and dropping it to the header of the hosting tab of the target control
• Perform the same procedure with the right mouse button to only set the context object of the target control, but not its ListenTo source
• Release ListenTo by clicking the respective header and selecting the ListenTo: control name menu item
• Reconnect to the last ListenTo source by selecting the Reconnect to: control name menu item
• Close a control by right clicking the tab header and selecting the Close menu item.

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

All controls require a similar workflow

1. Open the control
2. Set the object to be edited to the control via dragging the object and dropping it onto the header of the control’s tab
3. The corresponding edit functionality will be available then

Creating and editing instances

MetaClasses

Create new MetaClass

1. Create a new MetaClass via Derive new object from the context menu
2. Open the control Object Editor
3. Set the newly created MetaClass to the control
4. Set name, description and namespace
5. 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.

Inheritance

Classification

Link to Extended UBIK Metaclasses for Data Modelling

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 .

1. Start Workflow “System / Create new MetaProperty ” from the context menu
2. Set at least name, description and data type
3. Change the MetaProperty ’s category if necessary
4. Save the changes
5. 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

1. Navigate to the MetaClass “CUSTOMMETAPROPERTY”
2. Create a new instance
3. Set at least name, description and data type
4. Change the MetaProperty’s category if necessary
5. Save the changes
6. 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

1. Open the control “Class Details”
2. Set the designated MetaClass to the control
3. Add the MetaProperty either by dragging and dropping the MetaProperty's instance onto the MetaClass or by clicking the button in the menu
4. By clicking on the button the user has to navigate through the hierarchy to the appropriate MetaProperty

Settings

NEEDSVALIDATION

• explizite Speicherung des Validierungszeitstempels
• zB Verwendung am Client: der Wert dieser Eigenschaft muss am Client validiert, dh. zumindest einmal angeklickt, werden. Bei Verwendung der CLS_TASK Klassifizierung wird dieses Objekt als Finished gekennzeichnet, sobald ALLE solch konfigurierten MetaEigenschaften validiert sind.