Changes

UBIK Studio Basics

3,749 bytes added, 10:59, 22 December 2020
/* Database specific settings */
The following arguments can be passed to and will be recognized by the UBIK.Studio.exe:
{| class="wikitable" | width = "50100%"
|-
! Parameter!! Purpose
| ''-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 ===
In the options you can configure your database connection by the following parameters
{| class="wikitable" | width = "50100%"
|-
! Parameter!! Purpose
| ''Language''|| Set the desired database language in [http://en.wikipedia.org/wiki/ISO_639-1 ISO639-1] syntax
|-
| ''UserWindowsAuthentication''|| If set to true, the user and password parameter are ignored and UBIK tries to connect to the SQL Server user nameusing the Windows credentials. {{Version/ServerSince|2.5.1}}
|-
| ''User''|| 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 = "50100%"
|-
! Parameter!! Purpose
|-
| ''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
|-
|}
 
 
 
===Database specific settings===
The following parameters can be read, respectively edited here
{| class="wikitable" | width = "50100%"
|-
! Parameter!! Purpose
| ''Root-Metaclass for metaclasses''|| readonly; The MetaClass where new MetaClass will derive from
|-
| ''SessionManagementType''|| Configure the type of sessionmanagement 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 use a LAS or GAS, the 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==
The top area of {{UBIK}} Studio features a menu strip:
{| class="wikitable" | width = "50100%"
|-
! 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
| ''Exit'' ||-|| Closes {{UBIK}} Studio
|-
| rowspan = "35" | ''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''|| ''Customize'' ||-|| No purpose yet
|-
| ''View Test Environment...'' ||-{{key press|F6}}|| Opens the [[View Test Environment]] window
|-
| ''Interface Manager...'' ||-|| Opens the [[Interface Manager]] window|-| ''Who-Bert'' ||{{key press|F12F10}}|| Opens the [[Debugger|Code and Workflow debuggingInterface 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 = "24" | ''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 = "23" | ''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
|-
| ''UBIK Class DocumentationAbout'' ||-|| Opens the help file a dialog with the {{UBIK}} Class DocumentationVersion and [[Licensing]] information
|-
|}
The very bottom of the {{UBIK}} Studio window displays a status strip, providing the following information, from left to right:
{| class="wikitable" | width = "50100%"
|-
! 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 ===
====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 = "50100%"
|-
! Control !! Preview !! Purpose
| ''[[Workflow Editor]]''|| [[File:UI_WorkflowEditor.png|220x140px]] || View, design and run customer specific workflows
|}
 
All controls in the {{UBIK}} working area offer the following interaction functionality:
* Close a control by right clicking the tab header and selecting the ''Close'' menu item.
{{Hint|Drag&Drop with the right mouse button to only set the context object of a control, without connecting ListenTo!}}{{Hint|Drag&Drop an object at an empty tab strip will let you select the control afterwards and subsequently sets the context object}}  
===User rights===
====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.
{{Attention|Be careful, manipulating system objects might results in instability of {{UBIK}} Studio or other {{UBIK}} components!}}
 
 
 
==See also==
* [[:Category:UBIK Studio Controlscontrols|Studio controls]]* [[HowTo:Install_UBIK_Studio|How to install UBIK Studio Controls]]* [[UBIK_Console]] {{Category/Version|2.5.1}}
[[Category:2.5.1|UBIK StudioBasics]][[Category:Studio|UBIK Studio Basics]]
1,514
edits