Difference between revisions of "UBIK Studio Basics"
(→Metaproperties) |
(→Options) |
||
| Line 5: | Line 5: | ||
== Prerequisites == | == Prerequisites == | ||
=== Options === | === Options === | ||
| − | [[File:USB_Options.png|thumb|upright|alt={{UBIK}} Studio | + | [[File:USB_Options.png|thumb|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. | 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. | ||
Revision as of 11:03, 19 December 2012
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.
Contents
Prerequisites
Options
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
- DataBase: SQL database name
- DataSource: SQL server instance (specify a server via hostname, UNC, IP, ...)
- User: SQL user name
- Password: SQL user password
Take care that the specified SQL user has appropriate permissions on the database.
Additional options are
- LiveMode: True / False
- RecordLifeTime: Integer (default -1)
Working Area and Controls
The starting window is split into 3 parts, each .
The UBIK® Studio provides a set of user controls for manipulating objects and data. Find a short list what each control is designated for
| Control | Description |
|---|---|
| „Class Browser“ | Navigate through the metaclasses and instances |
| „Class Details“ | Design metaclasses |
| „Content Editor“ | Create and edit instances |
| „Code Editor“ | Implement customer specific functionality |
| „Relation Editor“ | Relate objects and edit relational data |
| „Object Explorer“ | Display and edit properties of objects (list style) |
| „Object Editor“ | Graphical editor for changing object properties |
| „Workflow Designer“ | Design customer specific workflows |
Each of the 3 areas can hold an arbitrary amount of controls, which provide different functionality for object creation/modification.
Clicking an empty tab strip in one of these areas will bring up a context menu, that allows you to create a new tabpage hosting one of the follwoing controls:
Display and edit classes hierarchically
Show additional information for classes, such as attributes
Display and edit object properties
Execute C# code using UBIK objects
Display and edit properties and instances
Display and edit event-triggered code on UBIK classes
Display and edit relations and their content
Furthermore every control has it´s Views.
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
| 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
- 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
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 metaclasses 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 metraproperty” 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
- - Numer 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
- - Numer 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 Add metaproperty button button in the menu
- By clicking on the Add metaproperty button button the user has to navigate through the hierarchy to the appropriate metaproperty
