{{UBIK}} Studio is the server application and administrative tool for creating and modifying {{UBIK}} object models. Transfer It enables you to transfer your entitiyentity-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 objectsviews and queries. This section will provide you with more information on the user interface.[[File:UI_Studio.png|thumb|220px|{{UBIK}} Studio]]
[[File:METACLASS.png|thumb|220px|upright|alt={{UBIK}} metaclass|{{UBIK}} metaclass]]
[[File:INSTANCE.png|thumb|220px|upright|alt={{UBIK}} instance|{{UBIK}} instance]]
== Prerequisites ==
===Command line arguments===
The following arguments can be passed to and will be recognized by the UBIK.Studio.exe:
{| class="wikitable" | width = "100%"
|-
! Parameter!! Purpose
|-
| ''-NOCUSTOM''|| Don't attempt to load the customized object code
|-
| ''-NOCUSTOMUI''|| Don't attempt to load the customized UI elements
|-
| ''-CUSTOMVERSION:version''|| Attempt to load a specific deployed ''version'' of the customizing instead of the currently released one. Use this option if you want to test a specific customizing, without releasing it to all users.
|-
| ''-CONNECTDB''|| Connects automatically to the most recently used database
|-
| ''-IGNOREUSAM''|| Ignores the Session Authorization and uses a fallback session if no authorization is granted by the [[USAM|Session]]
|-
| ''-DBMAINTENANCE:activity''|| Starts {{UBIK}} Studio in maintenance mode. Possible activities are:
1 = recompiling of system structures; 2 = recreate MetaProperty views; 3 = recompile database; 4=Transfer Data to Attributes.
Please do not use this option if you do not have any knowledge about these activities.
|-|-
|}
{{Attention|Setting these command line arguments might changes the expected behavior of a data model significantly!}}
=== Options ===
[[File:UI_UBIKStudioOptions.png|thumb|220px|upright|alt={{UBIK}} Studio settings|{{UBIK}} Studio settings]]
Locate and click the menu ''Edit File → Options''. Press {{key press|Apply}} or {{key press|OK}} when you're finished changing the settingsoptions, or {{key press|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
{| class="wikitable" | width = "100%"
|-
! Parameter!! Purpose
| ''AutoConnect''|| If set to true, the system will attempt to automatically connect to the configured database on start up
|-
| ''DataBase''|| The name of your the instance on the SQL Server
|-
| ''DataSource''|| The name of the SQL server instance Server (specify a server via host name, UNC, IP, ...)
|-
| ''Language''|| Set the desired database language in [http://en.wikipedia.org/wiki/ISO_639-1 ISO639-1] syntax
|-
| ''UserWindowsAuthentication''|| SQL If set to true, the user nameand password parameter are ignored and UBIK tries to connect to the SQL Server using the Windows credentials. {{Version/ServerSince|2.5.1}}
|-
| ''PasswordUser''|| SQL Server user name. Only used when WindowsAuthentication is set to false.|-| ''Password''|| SQL Server password. Only used when WindowsAuthentication is set to false.
|-
|}
Additional options are
{| class="wikitable" | width = "100%"
|-
! Parameter!! Purpose
|-
| ''LiveMode''|| Use the relational database structure (true) or the Sandbox structure (false) |-| ''RecordLifeTime''|| Set how long records are valid before the they will be requeried for changes by the corekernel; -1 to turn off
|-
| ''AutoSaveTime''|| Set how often {{UBIK}} Studio should save all unsaved objects automatically, in minutes; -1 to turn off
|-
| ''NotifyOnError''|| Displays a notification if an error occurs; false to turn off
|-
| ''NotifyOnWarning''|| Displays a notification if a warning occurs; false to turn off
|-
|}
===Command line arguments===
The following arguments can be passed to and will be recognized by the UBIK.Studio.exe:
===Database specific settings===Once successfully connected to a database, the menu item ''Database → {database name} settings...'' becomes visible. As the name already states, these are settings that are specific to the very database you are connected to, hence changes also only apply to it. The following parameters can be read, respectively edited here {| class="wikitable" | width = "100%"
|-
! Parameter!! Purpose
|-
| ''-NOCUSTOMFile store mode''|| Donreadonly; 't attempt to load the customized object code'UNC'' for a regular filesystem, ''Cloud'' for a cloud storage
|-
| ''-NOCUSTOMUIData path''|| Don't attempt The path to load the customized UI elementsroot directory of the data storage for this database in ''UNC'' mode; In ''Cloud'' mode the path can be defined as a relative path within the specified cloud container, this parameter can be left empty when using its root directory level.
|-
| ''CloudStorageAccount''|| The name of your storage account from your cloud service provider; only evaluated if ''File store mode'' is ''Cloud''|-CUSTOMVERSION:version| ''CloudStorageKey''|| Attempt The authorization key from your cloud service provider to load a specific deployed access your cloud storage; only evaluated if ''versionFile store mode'' is ''Cloud''|-| ''Cloud container name''|| The name of the customizing instead root cloud container where files for this database will be placed; only evaluated if ''File store mode'' is ''Cloud''|-| ''Language count''|| readonly; The number of the languages currently released one. Use configured in {{UBIK}}|-| ''Date format''|| The date/time format to use in this option if you want database in [http://en.wikipedia.org/wiki/ISO_8601 ISO8601] syntax|-| ''Root-Metaclass for Metaproperties''|| readonly; The MetaClass where new Metaproperties will derive from|-| ''Root-Metaclass for metaclasses''|| readonly; The MetaClass where new MetaClass will derive from|-| ''SessionManagementType''|| Configure the type of session management that must be used by all UBIK sessions: 0 = Single Local Management, 1 = LAS, 2 = GAS|-| ''SessionServiceUrl[:Port]''|| If the SessionManagementType is configured to test use a specific customizingLAS or GAS, without releasing it to all usersthe ServiceUrl of the AS must be configure here. In the case of an Local management, this setting is ignored.<br />The port number ''Port'' must be specified only if other than 443 (default for https). |-| ''BinariesDeployment''|| Configure if the customizing binaries are distributed via a server file share or database.|-| ''LocalFileDeployment''|| Configure if the local file documents are distributed via a server file share or database.|-| ''Database TimeZone''|| Configure the time zone informatoin date - values are stored in the sql database.The default value is UTC
|-
|}
[[Category:2.5.1|UBIK Studio Basics]]
[[Category:Studio|UBIK Studio Basics]]
==Working with {{UBIK}} Studio==
=== Menu and status strip Basic UI elements ===
====Menu and toolbar====
The top area of {{UBIK}} Studio features a menu strip:
{| class="wikitable" | width = "100%"
|-
! Menu!!Menu item!!Shortcut!! Purpose
|-
| rowspan = "6" | ''File'' || ''New'' || {{key press|Ctrl|N}} || No purpose yet
|-
| ''Open Database'' ||{{key press|Ctrl|O}} || Clicking the item itself will attempt to open the last configured database connection, its sub menu items will show the most recently used connections
|-
| ''Clear recent list'' ||-|| Clears the list of recently used database connections
|-
| ''Save All'' || {{key press|Ctrl|S}} || Saves all unsaved objects of the current session to the database
|-
| ''Options...'' ||-|| Opens the [[#Options|Options]] dialog
|-
| ''Exit'' ||-|| Closes {{UBIK}} Studio
|-
| rowspan = "5" | ''Database''
|-
| ''{database name} settings...'' ||-|| Opens the [[#Database specific settings|specific settings dialog for the currently connected database]]; will only appear once you successfully connected to a database
|-
| ''Manage Database...'' ||-|| Opens the [[Database Manager|Management dialog for the current database]]; will also appear if connection to the database failed
|-
| ''Sessions...'' ||-|| Opens the [[Session Manager|Management dialog for the current database sessions]]; this menu entry is only available if there is session management configured in the database settings
|-
| ''Custom System Objects...'' ||-|| Opens the [[Custom System Objects Dialog|Management dialog for custom system objects]]; will only appear once you successfully connected to a database
|-
| rowspan = "2" | ''Build''|| ''Rebuild...'' ||{{key press|F6}}|| Assembles the entire customizing code and displays the result in the [[Compiler|compiler window]]
|-
| ''Rebuild and download...'' ||{{key press|Ctrl|F6}} || Assembles the entire customizing code and attempts to deploy it according to the current database settings
|-
| rowspan = "5" | ''Tools''
|-
| ''View Test Environment...'' ||{{key press|F6}}|| Opens the [[View Test Environment]] window
|-
| ''Interface Manager...'' ||{{key press|F10}}|| Opens the [[Interface Manager]] window
|-
| ''ACM Manager...'' ||{{key press|F11}}|| Opens the [[ACM Manager]] window
|-
| ''Who-Bert'' ||{{key press|F12}}|| Opens the [[Debugger|Code and Workflow debugging]] window
|-
| rowspan = "4" | ''View''|| ''New Working Window'' ||{{key press|Ctrl|W}}|| Opens a new working window to host additional controls
|-
| ''Unsaved Objects Hierarchy'' ||{{key press|Ctrl|U}}|| Opens a window showing all currently changed, yet unsaved objects in a hierarchical style
|-
| ''Plugins'' ||-|| Opens the [[Plugin Modules]] window showing all currently loaded UBIK Plugins
|-
| ''Event Tracer'' ||-|| Opens the [[Event Tracer]] window showing all events (errors, warnings, messages) that occured while running the Studio session
|-
| rowspan = "3" | ''Help''|| ''UBIK Wiki'' ||{{key press|F1}}|| Opens the {{UBIK}} Wiki, meaning the root of this document
|-
| ''UBIK Class Documentation'' ||{{key press|Ctrl|F1}}|| Opens the help file with the {{UBIK}} Class Documentation
|-
| ''About'' ||-|| Opens a dialog with Version and [[Licensing]] information
|-
|}
====Status strip====
The very bottom of the {{UBIK}} Studio window displays a status strip displays , providing the following information, from left to right:
{| class="wikitable" | width = "100%"
|-
! Initial value!! Purpose
| ''CULTURE''|| Current language and culture in [http://en.wikipedia.org/wiki/ISO_639-1 ISO639-1] format
|-
| ''SESSION MANAGEMENT TYPE''|| Displays the type of session management in the current database; Doubleclicking the item opens the [[Session_Manager|Session Manager Dialog]] for all sessions in the current database if a multi-session management type is used|-| ''SESSION''|| Displays the name of the [[login|Login]] of the current [[session|Session]]; Right click on this item to switch into [[#Admin mode|Admin mode]]
|-
|}
=== Status Notification ===
[[File:UI_StatusNotification.png|thumb|220px|upright|alt={{UBIK}} Studio status notification|{{UBIK}} Studio status notification]]
{{UBIK}} Studio informs the user about important events happening within the UBIK system.Therefore the Status strip has a notification area on the right showing a yellow notification icon once there has occured an event the user should be aware of. These events are warning and error messages or also a reminder from the {{UBIK}} Customizing Control to rebuild changed customizing code in order to provide the expected system behaviour. If there is a certain action involved to handle this notification, it is possible to get there immediately (e.g. open the [[Event Tracer]] window to review a warning) by clicking on the notification icon itself.
=== Working area and controls ===
[[File:UI_UBIKStudio.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 savedin 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 {{key press|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:
[[File:UI_UBIKControlsOverview.png|thumb|220px|upright|alt={{UBIK}} Studio controls|{{UBIK}} Studio controls]]
{| class="wikitable" | width = "100%"
|-
! Control !! DescriptionPreview !! Purpose
|-
| ''[[Class Browser]]''|| [[File:UI_ClassBrowser.png|220x140px]] || Navigate through the , create and delete MetaClasses and instances
|-
| ''[[Class Details]]''|| [[File:UI_ClassDetails.png|220x140px]] || Design MetaClassesin their details; add/remove MetaProperties and classifications
|-
| ''[[Bulk Editor]]''|| [[File:UI_BulkEditor.png|220x140px]] || Create and edit multiple instancesof a MetaClass in table style
|-
| ''[[Code Editor]]''|| [[File:UI_CodeEditor.png|220x140px]] || Implement customer MetaClass specific functionalityusing C#
|-
| ''[[Relation Editor]]''|| [[File:UI_RelationEditor.png|220x140px]] || Relate objects to each others and edit relational data
|-
| ''[[Object Explorer]]''|| [[File:UI_ObjectExplorer.png|220x140px]] || Display and edit all exposed properties of objects (list style)
|-
| ''[[Object Editor]]''|| Graphical editor for changing [[File:UI_ObjectEditor.png|220x140px]] || Edit the property values of a single object properties
|-
| ''[[Workflow DesignerEditor]]''|| Design [[File:UI_WorkflowEditor.png|220x140px]] || View, design and assign run customer specific workflows
|}
=== Editing objects in general ===Basically there are various ways to edit objects All controls in the {{UBIK}} database, each applicable for both, meta- and content objects. Use working area offer the following controls to editinteraction functionality: {| class="wikitable"* Set a control as [[ListenTo]] source of another control by dragging an object from the source control and drop it on the header of the hosting tab of the target control|-! Property !! Control|-| Basic properties|| * Release ListenTo by clicking the respective header and selecting the ''Object Editor'', ''Object Explorer'', ''Content EditorListenTo: control name''menu item|-| Relational data|| * Reconnect to the last known ListenTo source (if applicable) by selecting the ''Relation EditorReconnect to:''menu item|-| MetaClass details|| ''Class Details''|-| Events / object methods|| ''Code Editor''|}All controls require * Close a similar workflow # Open the control# Set by right clicking the object to be edited to the control via dragging the object tab header and dropping it onto selecting the header of the control’s tab# The corresponding edit functionality will be available then === Creating and editing instances === == MetaClasses ==''Close'' menu item.
=== Create new MetaClass ===# Create a new MetaClass via ''Derive new object'' from {{Hint|Drag&Drop with the right mouse button to only set the context menu# Open the object of a control ''Object Editor'', without connecting ListenTo}}# Set the newly created MetaClass to {{Hint|Drag&Drop an object at an empty tab strip will let you select the control# Set name, description afterwards and namespace# Save subsequently sets the changescontext object}}
=== 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.
===InheritanceUser rights===As of now, {{UBIK}} Studio doesn't feature a real user management system for designing data models. Although there is a distinction made between an admin and a non----admin user, with the very purpose of protecting system objects against unintended manipulation.
===Classification===----Link to Extended However, {{UBIK Metaclasses for Data Modelling}} fetches the current Windows user and creates the environment with this credentials, storing the login information on a [[Session|session]] object.
== MetaProperties ==Admin mode====[[File:UI_Property_editable_05.PNG|220 px|thumb|border|alt=Admin mode|Admin mode]]Right click on the user name in the status strip and select the menu item ''Admin mode'' to switch all active controls to [[Admin mode|admin mode]]. As long as you are in admin mode, the user name in the status strip will appear red.
=== 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 {{Attention|Be careful, manipulating system objects might results in instability of a MetaProperty and relates it to the selected MetaClass .{{UBIK}} Studio or other {{UBIK}} components!}}
# 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==See also==# Add the MetaProperty either by dragging and dropping the MetaProperty's instance onto the MetaClass or by clicking the * [[File:IC_PlusGreen.pngCategory:Studio controls|20px|Add MetaProperty buttonStudio controls]] button in the menu# By clicking on the * [[FileHowTo:IC_PlusGreen.pngInstall_UBIK_Studio|20px|Add MetaProperty buttonHow to install UBIK Studio]]* [[UBIK_Console]] 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{{Category/Version|2. zumindest einmal angeklickt, werden. Bei Verwendung der CLS_TASK Klassifizierung wird dieses Objekt als Finished gekennzeichnet, sobald ALLE solch konfigurierten MetaEigenschaften validiert sind5.1}}
[[Category:2.5.1|UBIK StudioBasics]][[Category:Studio|UBIK Studio Basics]]