Changes

On the Augmensys [[https://release.augmensys.com/download/modules/Studio/ release portal]], a test candidate for the beta version of {{UBIK}} Smart Studio is available. Here's the history of recent changes:

Sometimes, you don't want to design a data model but instead take it from one {{UBIK}} Environment to another, or to control in detail what you want to save to a target {{UBIK}} Environment. This is what the [[Transport Container]] is for. This worksheet gives (like the project view) features a [[Situation Editor]] giving you a detailed overview about the models it contains as well as the possibility to add or remove models, and to select a subset of the contained models and do something with it (e.g., save it to a target {{UBIK}} Environmentretain only the selected models).

=== Inheritance Graph and Application Graph ===There are multiple kinds of modelling worksheets with different responsibilities: The [[Inheritance Graph]] allows the user to create meta models. It's called "Inheritance Graph" because the MetaClasses' inheritance structure is displayed graphically.  ==== Meta Classes ====You can drop existing meta classes onto the graph in order to see the full inheritance hierarchy, classifications and meta properties. You can also drop a new meta class from the tool box picker, and proceed to model it by dropping meta properties onto it, or connecting it to other meta classes to establish an inheritance hierarchy. ==== Meta Properties ====The details of meta properties can be configured in the inspector tool for a selected meta property. The options include data type, selective list, unit, multi language, etc.Live value meta properties are supported, too. ==== Classification ====It is also possible to specify classifications for meta classes by dropping the classification onto the graph and then connecting it to the respective meta class.Classifications are not implemented immediately to prevent undesired changes. Select the connection between the classification and the meta class, and toggle the "implement classification" checkbox in the inspector tool for the connection, in order to add the classification's meta properties to the meta class.Classifications can be designed just as meta classes, but inheritance of classifications is currently not supported. ==== Relations ====Relations can be designed in the relation editor (by just connecting two instances and configuring the details on the connection), or in the application graph for scoped connections.See the respective chapter for the relation instance graph. ==== Proxies ====Proxies can be designed in the proxy graph, which is very similar to the inheritance graph. You can use a context menu command to open the proxy graph for a meta class, if a proxy exists.Create a new proxy by dropping a meta class onto the proxy graph.See the respective chapter for the meta proxy graph. === Application Graph ===The [[Application Graph]] can be used to define what the user can see on the mobile device. It's called "Application Graph" because the browsing hierarchy for the mobile application is displayed graphically. One can define specific mobile versions of MetaClasses (namely Scopes) as well as their properties and children with it. ==== App and Context ====You can create or reuse app and context objects to identify the view providing data to your satellites. Below a context, you can model the view hierarchy graphically using scopes and connections between them.The context can be configured with input queries for the root and infrastructure objects. Just drag a query onto the graph and connect it to the context's respective input connector. ==== Scopes ====A scope specifies what properties for instances of a meta class will be delivered to the satellite. E.g., for pumps we might have many properties in the data base, but on the client, we require only two of them - this can be specified using meta class scopes. You can specify whether it should be possible to create or delete instances on the scope.However, you can also use query scopes to provide an interface to a query object on the client. In order to create a query scope, hold {{key press|Shift}}) while dragging a query onto the graph. Drop meta properties on a scoped query in order to provide access to the query's properties and query items.Meta query scopes are supported as well; dropping a query meta class on the graph will result in a respective scope. ==== Connections ====In the app graph, scopes can be connected hierarchically, in order to specify: "As children for scope-A-objects, I want to see scope-B-objects".Further, you can configure how the children should be resolved for a scoped connection - should a relation be used, or a link property on a child pointing to the parent object?For query scopes, the outgoing connections are a bit simpler, because they can only target scopes that are compatible with the query filter class, and since the query delivers the children, there isn't much to configure there. For meta query scopes, no outgoing connections are shown because we cannot anticipate what query will be used at design time. However, if you provide a fitting child scope to the context, it will be used for the children of queries.

The Bulk Editor supports multi-language values, sorting, filtering, grouping, drag & drop (also for multiple rows) and copy & paste (also for multiple target cells). Also, for the Bulk Editor, a multi-instance editor tool is available (similar to the inspector tool), allowing you to edit the values for mutliple multiple selected instances. A Bulk Editor worksheet can be exported to Excel using the respective context menu item. ==== Designing Queries ==== Queries can be designed using the Bulk Editor. You can use the context menu command "Convert to Query" in order to create a query for the meta class the bulk editor currently shows instances for. Then you can add Query Items by holding the {{key press|shift}} key while dragging column headers onto the query on the top left. The query items appear next to the query and can then be configured. === Custom Code ===You can customize the behavior of {{UBIK}} programmatically. There are multiple ways to do so:* React to life cycle events of objects (e.g., do something when an object is saved)* Override properties of objects (e.g., pre-process a value before it is assigned to a property)* Override methods of objects (e.g., evaluate the user rights for an object)* Add arbitrary custom code to a meta class* Create custom workflows * Create a custom code library to be used in the rest of the customizing {{UBIK}} SmartStudio provides rich code editors supporting IntelliSense and syntax highlighting based on Roslyn. For MetaClass related customizing, you can access such editors using the Behavior inspector tool (on the right hand side if you're using the default layout), when a MetaClass is selected in the Inheritance Graph. The custom code library can be maintained using a dedicated worksheet accessible via the "Behavior" menu.

=== Project Smart Import: Comos meta data ===The Smart Model Import Worksheet can be used to import meta data XML files exported from Comos. The input is converted to Smart Models and opened in an Inheritance Graph Worksheet for further processing. One can also plan a semi-automatic import procedure, to make sure the import is processed safely and easily. After configuring the relevant steps, you will be guided through them as planned. Such a plan could be:* Show raw import data* Merge with Project data - Project wins in case of conflict (adjustable)* Save to Project* Merge with Environment data - Environment wins in case of conflict (adjustable)* Save to Environment* Finish importThe user can change the order of steps and switch them on or off.Further, the user can still do any actions manually, too.    === Smart Import: Project model import ===

Once a project is opened, there is a project page listing all the work sheets (e.g., Inheritance Graphs or Application Graphs) as well as all a [[Situation Editor]] giving you a detailed overview about the models in it contains as well as the projectpossibility to add or remove models, and to select a subset of the contained models and do something with it (e.g., retain only the selected models).

So, ==== Adding models to a project worksheet ==== Models can have multiple be selected and added to worksheets with overlapping content using Smart Studio's object pickers (i.ethe filterable, searchable and sortable list views to the left of the IDE), simply by dragging a model over to a worksheet and dropping it there.Alternatively, the [[Object Finder]] can be used to find and insert models into a worksheet. It is important to know that exist in multiple models can either originate from the connected {{UBIK}} Environment (database) or from the currently active project. We call that the "Source" of the model.Models from the project will always have a dashed border, whereas models from the {{UBIK}} Environment always have a solid border. You can remove models from the project (and all its worksheets)on the project page, or directly from a single worksheet. Changing In a worksheet , you can affect other worksheets after saving choose the change in order to keep consistency source (this happens automaticallyproject or environment)for a model. As a consequence, its details and dependencies will be updated and the model will be marked with the symbol for its source. ==== Saving Worksheets ==== Worksheets can be saved either to the connected {{UBIK}} Environment or to the currently active project. ===== ''Saving Worksheets to the Project'' ===== You can save a (selected) an active worksheet to the project using the confirm button (the icon is a hook/check symbol) in the tool bar, or using the "Save to Project" context menu item.This doesn't save the worksheet to the connected {{UBIK}} Environment.As soon as you save a worksheet to the project, all affected models in the saved worksheet will be marked as project models.

Some operations A project can take a whilehave multiple worksheets with overlapping content (i.e., for example when a lot of data is loaded into models that exist in multiple worksheets). Changing a worksheet. Such tasks can be canceled using affect other worksheets after saving the stop symbol change in order to keep consistency (this happens automatically): the toolbar or {{key press|Esc}}worksheet content is propagated to all other worksheets (and to the project), so that your project situation is consistent.

==== Merging worksheets with = ''Saving Worksheets to the {{UBIK}} environment Environment'' ===== You can save an active worksheet to the currently connected {{UBIK}} Environment busing the "Save to {{UBIK}} Environment" toolbar button or context menu item.This doesn't save the worksheet to the project.The worksheet content will be saved to the database and the results will be shown in a new worksheet.Smart Studio's object pickers will be updated with the new models. ==== Merging Worksheets ====

Wherever it might have came come from, you can save the worksheet content to either the project or the environment.However, in some cases the worksheet content needs to be combined with what you already havein order to resolve conflicts.Currently, it ===== ''Merging worksheets with the {{UBIK}} Environment'' ===== It is possible to merge a worksheet with the environment Environment ({{UBIK}} database)using the context menu (right-click on the worksheet) or the respective toolbar icon.

In case of a conflict, normally the environment "wins". E.g., if you have a metaclass meta class A deriving from another metaclass meta class B in your worksheet, but the environment specifies C as a parent of A, the result of a merge would be A deriving from C. Using the inspector, you can specify whether a worksheet should override the environment on a merge. In that case, the merge result from the example above would be A deriving from B.

==== Merging worksheets The result of such a merge is not saved yet; you can edit it and decide what to do with it - e.g., save it to the SmartStudio project ====, save it to the environment or dismiss it.

New ===== ''Merging worksheets can be added to with the SmartStudio project by saving them. In this case, the worksheet content is propagated to all other worksheets (and to the project), so that your project situation is consistent.'' =====

=== Project models ===The project's models can be selected and added to worksheets using Smart Studio's object pickers.You can remove models from also merge a worksheet with the currently active project , without saving it, using the context menu (and all its worksheets) right-click on the project page, worksheet) or directly from the respective toolbar icon.The result is a single combination between what you have defined in your worksheet (using and what the inspector).project contains already regarding that situation,In case of a worksheetconflict, you can choose normally the source (project or environment) for a model"wins". As E.g., if you have a consequencemeta class A deriving from another meta class B in your worksheet, its details and dependencies will be updated and but the model will be marked with project specifies C as a parent of A, the symbol for its sourceresult of a merge would be A deriving from C. As soon as Using the inspector, you save can specify whether a worksheet to should override the projecton a merge. In that case, all affected models will the merge result from the example above would be marked as project modelsA deriving from B.