UBIK Wiki Test / Augmensys - User contributions [en]

Version 3.5 (Server)

2022-08-08T14:16:34Z

MKR: Added Web Service Build 10

{| class="wikitable sortable" | width = "300"
|-
! Version !! Release Date
|-
| 3.5.0 || 2020.04.09
|-
|}

= Initial Release =
=== New features ===
* UBIK supports sending additional information for an uploaded file to the server
** [[SYSCLS_FILEDETAILSCLASSIFICATION|File Details classification object]]
* UBIK Supports Downloading of 3D Models now
** [[SYSCLS_ARCHIVECLASSIFICATION|Archive classification object]]
** [[SYSCLS_3DMODELCLASSIFICATION|3D Model classification object]]
* UBIK provides distribution of UI Customizing objects
** [[SYSCLS_UI_CUSTOMIZING|UI Customizingclassification object]]
* Every relation between UserGroup (left) and Login (right) will be used as basement for Rights Evaluation.
* UBIK supports MetaQueryScopes and MetaQueryViewItems now. This provides the possibility to define Online Queries (for Views and in ACM) just as you do for instances by configuring their MetaClasses.
* UBIK provides a set of Methods with a simplyfied interface designed to be used from external systems (e.g. IOT use case)
** [[UBIK_Web_ServiceV264]]
* UBIK provides the possibility to add Attributes to any Live Value. This feature can be used by the implementation of a Live Value Servers. It is possible to transport any specific Live Value Information (Property, QualityInformation, etc). to the clients using UBIK Standard.
* User Rights can be applied for Selective Items now. The rights evaluation happens during the assembling of the MetaDefintiions. If the current user does not have the right to see one Selective Item, it is removed from the Metadefinitions. If a SelectiveList does not have one single visible item, the entire list and all its references to it are removed.
* A new method (EvaluateBaseChildrenCollectionExt) on the UBIK ViewItems gives access to the current UBIK Session which provides a full set of new possibilities when customizing the children collection depending on (e.g.) the current login.
* UBIK provides a Numeric [[Sequence_Generator|Sequence Generator]] now. It gives the possibility to create unique sequential ids for different number groups.
* Verbose Logging is now available for Importing and Exporting Data using the Interface Administration.
* UBIK Supports MultiLine Geography objects now
* UBIK provides new Workflow Activities for Web Based Actions:
** [[Authenticate_(Activity)|Authenticate]]
** [[RESTGet_(Activity)|REST Get]]
** [[RESTPost_(Activity)|REST Post]]
* UBIK supports two new types of Geography objects used for routing and navigation
** [[SYSCLS_GEO_MULTI_LINE|Multi Line Classification]]
** [[SYSCLS_ROUTING_GRAPH|Routing Graph Classification]]

=== Bugfixes ===
* Change Log Values for Properties without a VTS are delivered with the correct date now.
* A problem with configured Initial Values is solved now. It is possible to define them on both, the MetaProperty itself or on the relation between a MetaClass and a MetaProperty.
* UBIK Supports Initial - Index values now.
* WebService does not deliver false entries for ChangeLogs (happened with ViewCache being online) any more.
* The Database Maintenance Window was (sometimes) not able to connect to the database. This problem is solved now.

=== Enhancements ===
* Closed security gaps in the UBIK WebService
* Creation of a Reference does not create a "fake" Warning any more.
* UBIK provides the possibility to access the Content of an internal document as Base64 string (read and write).
* UBIK WebService persists and delivers information about the validation timestamp and validation user now (per property)
* The [[Activity:CreatePushScope (Activity)|CreatePushScope]] Activity supports the usage of Authentication Tokens now.
* The WebService Switch "UBIK.Service.EnableViewCache" is not supported any more. A ViewCache-Creation must be triggered via existing mechanims and does not trigger itself any more.
* UBIK Compiler includes System.DirectoryServices.AccountManagement.dll now This enables the customizer to compile AD and LDAP specific code.
* Improved management of Query Instances gains more customizability and better performance

= Build History Web Service =
* 3.5.0 Build 1 on 2020.04.08
** Initial release.
* 3.5.0 Build 2 on 2020.04.16
** Installed OSI Pi Plugin does not create log entries saying "Unable to load one or more of the requested types" when being loaded on the Web Service any more.
** Replaced outdated json binaries.
* 3.5.0 Build 3 on 2020.07.01
** Web Service Rights evaluation updates on users being removed from a user group during runtime now
** Mobile session ID can be persisted in Database now
** Fixed: Creating too many Change Logs in parallel caused the system to crash
* 3.5.0 Build 4 on 2020.07.24
** A problem with autonomous properties not being calculated when performing a branch download is solved now.
** A problem with Childinfo Classification properties not being propertly calculated is solved now.
** Providing [[SYSCLS_MAPSHAPE|Map Shape Classification Object]]
* 3.5.0 Build 6 on 2020.11.05
** A performance problem when initializing the ViewCache in combination with classified items is solved now
* 3.5.0 Build 7 on 2021.03.18
** Internal optimizations for higher performance.
** Support of System Selective Lists.
** A bug in providing Childowner - Info in combination with an active ViewCache is fixed now
**A bug in the Web.config probing paths is fixed now
* 3.5.0 Build 8 on 2021.10.11
** A bug causing possible data loss when committing changes from the clients is solved now.
** Improved performance when evaluating user rights and user group rights.
* 3.5.0 Build 9 on 2022.07.20
** Includes Newtonsoft.JSON (newjson) endpoints for compatibility with clients >= 4.0.
* 3.5.0 Build 10 on 2022.08.08
** Downgraded included Newtonsoft.JSON version to 12.0.3 to stay compatible with most plugins.

= Build History UBIK.Studio =
* 3.5.0 Build 1 on 2020.04.08
** Initial release.
* 3.5.0 Build 2 on 2020.04.20
** Restart of UBIK.Studio after releasing the customizing does not create Log Entries any more.
** UBIK.Studio creates Symbols files (*.pdb) when compiling the customizing now. They can be used for debugging the custom code.
** When running as a Windows service, EnterpriseService now properly manages the automatic plugin execution.
* 3.5.0 Build 3 on 2020.07.01
** Stopping and restarting of UBIK Enterprise Service caused a problem. This is fixed now.
** Fixed: Creating too many Change Logs in parallel caused the system to crash
** An issue with file names when compiling Customizing - Symbol files (for local debugging) is solved now
* 3.5.0 Build 4 on 2020.07.23
** Providing [[SYSCLS_MAPSHAPE|Map Shape Classification Object]]
* 3.5.0 Build 5 on 2020.07.30
** Trial licensing checks against local time to avoid the otherwise necessary server connection now.
* 3.5.0 Build 6 on 2020.11.05
** Having more than 500 Metaproperties in the database caused an irritating issue when trying to set the MetaProxy Property Target. This issue is solved now.
* 3.5.0 Build 7 on 2021.03.19
** Double clicking an instance in the Class Browser having an open Bulk Editor does not crash UBIK.Studio any more
** SQL Update Scripts (to Version 3.5) are compatible with SQL Server 2012 now.

= Build History UBIK.Plugins =
* 3.5.0 Build 1 on 2020.04.08
** Initial release.
* 3.5.0 Build 2 on 2020.04.22
** Added two new Plugins (Syncfusion.Compression.Base.dll) and (Syncfusion.Pdf.Base.dll).
* 3.5.0 Build 3 on 2020.07.23
** Added a new Plugin (UBIK.Interface.Module.SAP) and it's dependencies (SAPInterface.dll, SAPInterface.XmlSerializer.dll).
** The MRO plugins provide a fix for autonomous properties being filled when performing a branch download.
* 3.5.0 Build 4 on 2020.08.07
** Added Float64/Float16/Int16 support to OsiPi Plugin.
* 3.5.0 Build 6 on 2020.11.06
** Added support for Basic authentication in OsiPi Plugin
<headertabs />

{{Category/Version2|{{PAGENAME}}}}

[[Category:Version 3.5|Version 3.5 (Server)]]

Converters In Mobile

2022-06-21T13:34:30Z

MKR: Removed converter that clearly doesn't exist

:''See also: [[XAML#Converters|Converters in UWP/WinX]]''

'''Converters''' are used to prepare application data to format a UI defined by a XAML markup. These converters make it possible to show elements only when specific conditions (like data being available) are met. This allows the creation of a good UI with XAML code only, improving code readability while also decreasing code complexity.

This page explains how to properly use converters for customizing the UBIK Xamarin User Interface. Furthermore, all available converters are listed to provide a good reference.

= Definition =
In Xamarin, before converters can be used, they need to be defined in the page's ''Resources'' tag. Make sure to include the <code>UBIK.CPL.Converters</code> namespace in the namespace definitions!
The following example shows how the <code>NullToBoolConverter</code> can be defined:
<syntaxhighlight lang="xml">
<ContentView x:Class="UBIK.CPL.Resources.UBIKChildArea"
xmlns="http://xamarin.com/schemas/2014/forms"
xmlns:x="http://schemas.microsoft.com/winfx/2009/xaml"
xmlns:converters="clr-namespace:UBIK.CPL.Converters;assembly=UBIK.CPL">
<ContentView.Resources>
<ResourceDictionary>
<converters:NullToBoolConverter x:Key="NullToBool" />
</ResourceDictionary>
</ContentView.Resources>



</ContentView>
</syntaxhighlight>
The key ''NullToBool'' makes this converter accessible from the customizing in this page.
== Definition With Properties ==
In the following example, which is the same example from above, the '''StringFormatConverter''' will be additionally defined. To add more formatting possibilities, it has two extra properties, which need to be prefilled during initialization. Henceforth, these properties can be prefilled with static values or with static references.
<syntaxhighlight lang="xml">
<ContentView x:Class="UBIK.CPL.Resources.UBIKChildArea"
xmlns="http://xamarin.com/schemas/2014/forms"
xmlns:x="http://schemas.microsoft.com/winfx/2009/xaml"
xmlns:converters="clr-namespace:UBIK.CPL.Converters;assembly=UBIK.CPL">
<ContentView.Resources>
<ResourceDictionary>
<converters:NullToBoolConverter x:Key="NullToBool" />
<converters:StringFormatConverter x:Key="Formatter" Parameter1="5" Parameter2="{Binding Children.Items.Count}" />
</ResourceDictionary>
</ContentView.Resources>



</ContentView>
</syntaxhighlight>
Whereever this converter is used within the file it was defined in, ''Formatter'' will always have its ''Parameter1'' set to ''5'' and its ''Parameter2'' to the number of children of the currently viewed UBIK object. If this behavior is not intended, consider defining another ''StringFormatConverter'' with a '''different Key''' in the same way as shown above.<br/>
See below to find out how to use this converter!
= Usage =
A converter can only be used in conjunction with a <code>{Binding}</code>. The following is an easy example, showing how the ''NullToBool'' converter, defined above, can be used.
<syntaxhighlight lang="xml">
<Label Text="My Text" IsVisible="{Binding MyBindableProperty, Converter={StaticResource NullToBool}}"/>
</syntaxhighlight>
If '''MyBindableProperty''' is ''null'' or an empty string, the converter will return '''true''', making the Label visible!
== Parameter ==
Some converters accept a '''ConverterParameter''', that passes additional information. Closely read the description of the available converters to find out which accept or even require a parameter to work properly. In Ubik, some converters accept a string parameter, consisting of multiple individual parameters separated by <code>|</code>.

An example of this behavior is the '''ContainsToBoolConverter''', which checks if the current value is contained within a collection of values (passed as the ''parameter''):
<syntaxhighlight lang="xml">
<Label Text="My Text" IsVisible="{Binding MyValue, Converter={StaticResource ContainsToBool}, ConverterParameter=1|2|3|4|5|6|7|8|9}"/>
</syntaxhighlight>
The label will only be visible if the ''MyValue'' property (which is expected to parse as an Integer in this example) is one of the values of the parameter.<br/>
Again, to get the converter working, don't forget to define it in the page's resources!

== FallbackValue ==
In some rare cases, a converter might not return anything desired (like ''null'') if some condition doesn't work out as it should (e.g. ''value'' is ''null''). To still be able to get a usable return value, it's possible to define a '''FallbackValue'''.

== Example Usage of StringFormatConverter ==
This converter can take up to two additional parameters during definition. Please see [[#Definition With Properties|Definition With Properties]] for more information!
<syntaxhighlight lang="xml">
<Label Text="{Binding MyValue, Converter={StaticResource Formatter}, ConverterParameter=The Value of my value is \{0\}\, compared to \{1\} and \{2\}!}"/>
</syntaxhighlight>
It's important to note that special characters, like <code><nowiki>{</nowiki></code>, <code><nowiki>}</nowiki></code> and <code><nowiki>,</nowiki></code>, need to be escaped using a <code><nowiki>\</nowiki></code>, else the expression will be wrongly interpreted (and nothing happens)!

The text of the '''ConverterParameter''' will be analyzed, and any occurrance (including duplicates) of <code><nowiki>{0}</nowiki></code>, <code><nowiki>{1}</nowiki></code> and <code><nowiki>{2}</nowiki></code> replaced with the '''binding value''', '''Formatter.Parameter1''' and '''Formatter.Parameter2''' respectively!

Make sure to note, that Xamarin Forms has a native '''[https://docs.microsoft.com/en-us/xamarin/xamarin-forms/app-fundamentals/data-binding/string-formatting StringFormat]''' option as well, that is probably way faster than using a converter for it. Furthermore, it supports formatting options!

= Data Source =
Although technically not a converter, the '''SfDataSourceExt''' control is currently on the way of replacing the '''SfDataSourceConverter''', due to improved performance.
The usage is pretty simple: Similar to the converters, it needs to be defined in the '''Page Resources'''. Then, a '''Key''' and '''Expression''', as well as an '''ItemsSource''' have to be defined. Last, but not least, the the converter can be used within the '''ItemsSource''' property of a Syncfusion '''SfListView'''. See the following example:
<syntaxhighlight lang="xml">
<ContentView x:Class="UBIK.CPL.Resources.UBIKChildArea"
xmlns="http://xamarin.com/schemas/2014/forms"
xmlns:x="http://schemas.microsoft.com/winfx/2009/xaml"
xmlns:controls="clr-namespace:UBIK.CPL.Controls;assembly=UBIK.CPL">
<ContentView.Resources>
<ResourceDictionary>
<controls:SfDataSourceExt
x:Key="MyDataSource"
ItemsSource="{Binding Children.Items}"
Expression="Item.Content.MetaUID.ToString().ToLower()=="85a50533-3817-4a0b-84cd-615b48b62565" && Item["ORGA_STATUS"]!=100" />
</ResourceDictionary>
</ContentView.Resources>
<sync:SfListView
x:Name="ListView1"
AllowSwiping="True"
ItemSize="60"
ItemTemplate="{StaticResource ChildTemplateSelector}"
ItemsSource="{Binding DisplayItems, Source={StaticResource MyDataSource}}"
LeftSwipeTemplate="{StaticResource SwipeLeftTemplateSelector}"
RightSwipeTemplate="{StaticResource SwipeRightTemplateSelector}"
SelectionMode="None">
</ContentView>
</syntaxhighlight>
Thanks to the given expression, filtering is applied once the data source is evaluated. It's important to have [https://www.advancedinstaller.com/user-guide/xml-escaped-chars.html XML special characters] correctly escaped, like the example shows.

= List of Available Converters =
The following list contains all currently available converters for UBIK Xamarin customizing.

'''Two-way''' converters can be used with two-way bindings, e.g. a text-box displaying an editable value. If the value updates in the model, the text-box text changes. If the user edits the value, the value in the model behind also gets updated.
As a clarification, '''Value''' refers to the '''Binding Value''', and '''parameter''' to the '''ConverterParameter'''!

{| class="wikitable sortable" style="width:100%"
|-
! Converter !! 2-Way !! Output Type || Input Type || Parameter Type || Description
|-
| BooleanConverter || style="text-align: center;" | ✓ || Boolean || Boolean, String || ||
Interprets a '''boolean value''' or a '''String value''' and returns it. If the value cannot be interpreted, ''false'' is returned.
|-
| BooleanInvertConverter || style="text-align: center;" | ✓ || Boolean || Boolean, String || ||
Interprets a '''boolean value''' or a '''String value''' and converts it into its '''inverted value'''. If the value cannot be interpreted, ''false'' is returned.
|-
| BooleanToFontAttributeConverter || style="text-align: center;" | ✗ || FontAttribute || Boolean || ||
Converts a '''boolean''' into a '''[https://docs.microsoft.com/en-us/dotnet/api/xamarin.forms.fontattributes?view=xamarin-forms font attribute]''' value. In detail, if the value is ''true'', the parameter is interpreted (''Bold'', ''Italic'', ''None'') and returned. The default returned font-attribute is ''None''.
|-
| ByteToImageSourceValueConverter || style="text-align: center;" | ✗ || ImageSource || Byte[ ],<br/>Byte Stream || ||
Converts a '''byte stream''' value into an '''image source'''.
|-
| ChildAreaTemplateConverter || style="text-align: center;" | ✗ || Child<wbr/>Area<wbr/>Template || Content<wbr/>ViewModel || ||
Returns a '''ChildAreaTemplate''' from a '''Content<wbr/>ViewModel''' or ''null'' if the ViewModel cannot be interpreted.
|-
| ChildItem<wbr/>SelectionMode<wbr/>To<wbr/>SfListView<wbr/>SelectionMode<wbr/>Converter || style="text-align: center;" | ✓ || [https://help.syncfusion.com/cr/cref_files/xamarin/Syncfusion.SfListView.XForms~Syncfusion.ListView.XForms.SfListView~SelectionMode.html ListView<wbr/>SelectionMode] || ChildItem<wbr/>SelectionMode || ||
Converts a '''ChildItem<wbr/>SelectionMode''' to a Syncfusion '''[https://help.syncfusion.com/cr/cref_files/xamarin/Syncfusion.SfListView.XForms~Syncfusion.ListView.XForms.SfListView~SelectionMode.html ListView<wbr/>SelectionMode]'''. Default is "Single".
|-
| ClassificationToBoolConverter || style="text-align: center;" | ✗ || Boolean || ContentViewModel || ||
Returns a '''boolean''' indicating whether the given '''ContentViewModel''' is successfully classified.
|-
| ContainsToBoolConverter || style="text-align: center;" | ✗ || Boolean || String,<br/>Guid,<br/>Object || ||
Checks if the delivered value is '''contained''' within a collection of values (delivered in the parameter, seperated with <code><nowiki>|</nowiki></code>). If the value is contained, ''true'' will be returned, else ''false''. The functionality is similar to the ''ContainsToVisibilityConverter'' in the WinX project.
|-
| ContainsToInvertedBoolConverter || style="text-align: center;" | ✗ || Boolean || String,<br/>Guid,<br/>Object || ||
Same as the ''ContainsToBoolConverter'', but with '''inverted output'''.
|-
| ContentAreaTeamplateConverter || style="text-align: center;" | ✗ || UBIKContentArea || ContentViewModel || || This converter is '''not yet finished''' and just returns the ''UBIKContentArea'' if the value is a ''ContentViewModel''.
|-
| StringToDateTimeTypesConverter || style="text-align: center;" | ✓ || [https://docs.microsoft.com/en-us/dotnet/api/system.datetime DateTime], [https://docs.microsoft.com/en-us/dotnet/api/system.timespan TimeSpan] || String || ||
Converts a String to the correct DateType, which can be either '''[https://docs.microsoft.com/en-us/dotnet/api/system.datetime DateTime]''' or '''[https://docs.microsoft.com/en-us/dotnet/api/system.timespan TimeSpan]'''. If the value cannot be interpreted, the unchanged String value is returned. The Converter can also be used to convert DateTime or TimeSpan into a string. The Format will be determined by the current culture.
|-
| DateTimeOffsetToDateConverter || style="text-align: center;" | ✓ || [https://docs.microsoft.com/en-us/dotnet/api/system.datetime DateTime] || [https://docs.microsoft.com/en-us/dotnet/api/system.datetimeoffset DateTimeOffset] || ||
Converts a '''[https://docs.microsoft.com/en-us/dotnet/api/system.datetimeoffset DateTimeOffset]''' to the correct '''[https://docs.microsoft.com/en-us/dotnet/api/system.datetime DateTime]''', applied to the current date and time. If the value cannot be interpreted, a new ''DateTime'', generated from the device's current time (<code>DateTime.Now</code>) is returned.
|-
| DateTimeToFromNowStringConverter || style="text-align: center;" | ✗ || String || [https://docs.microsoft.com/en-us/dotnet/api/system.datetime DateTime] || ||
Returns a '''[https://docs.microsoft.com/en-us/dotnet/api/system.datetime DateTime]''' into a human-readable and easily understandable ''string message'' (the last applying one will be taken):
* Less than 5 minutes in the past: ''Just now''
* Less than 10 minutes in the past: ''A few minutes ago''
* Less than 1 hour in the past: ''An hour ago''
* Less than 23 Hours in the past: ''Some hours ago''
* Less than 1 day in the past: ''Yesterday''
* More than 1 day in the past: The ''DateTime'' value formatted according to the device's localization rules.
* Not interpretable: ''???''
|-
| DebugConverter || style="text-align: center;" | ✓ || Object || Object || ||
A converter returning the given value for '''debug reasons'''.
|-
| DistanceToStringConverter || style="text-align: center;" | ✗ || String || Double || ||
Returns the given value interpreted as '''length'''. Values are returned in kilometers with two comma digits (e.g. 2.84km), values smaller than 1km are returned as meters and ''NaN'' will be returned as ''infinity''. If the value cannot be interpreted, an empty string will be returned.
|-
| EqualityToBoolConverter || style="text-align: center;" | ✗ || Boolean || Object,<br/>String || Object,<br/>String ||
Returns ''true'' if the given value and parameter are '''equal to each other''', ''false'' otherwise.
|-
| EqualityToInvertedBoolConverter || style="text-align: center;" | ✗ || Boolean || Object,<br/>String || Object,<br/>String ||
Returns ''true'' if the given value and parameter are '''not equal to each other''', ''false'' otherwise.
|-
| SelectionChangedEventArgsConverter || style="text-align: center;" | ✗ || [https://docs.microsoft.com/en-us/dotnet/api/system.windows.controls.selectionchangedeventargs List<wbr/>Selection<wbr/>Changed<wbr/>EventArgs] || [https://help.syncfusion.com/cr/cref_files/xamarin/Syncfusion.SfListView.XForms~Syncfusion.ListView.XForms.ItemSelectionChangedEventArgs.html Item<wbr/>Selection<wbr/>Changed<wbr/>EventArgs] || ||
Converts an Syncfusion '''[https://help.syncfusion.com/cr/cref_files/xamarin/Syncfusion.SfListView.XForms~Syncfusion.ListView.XForms.ItemSelectionChangedEventArgs.html Item<wbr/>Selection<wbr/>Changed<wbr/>EventArgs]''' to a '''[https://docs.microsoft.com/en-us/dotnet/api/system.windows.controls.selectionchangedeventargs List<wbr/>Selection<wbr/>Changed<wbr/>EventArgs]'''. <br/>The use-case of this converter is highly specific.
|-
| FilterCriterionToValueConverter || style="text-align: center;" | ✓ || String || FilterCriterion || ||
Converts a [[Property_Based_Content_Filters|'''FilterCriterion''']] to its value. The functionality is similar to UWP's FilterCriterionToValueConverter.
|-
| GuidPropertyValueConverter || style="text-align: center;" | ✓ || String || Guid || Binding, where source is ContentViewModel ||
Returns the '''first item''' of the parameter's ''Source-ViewModel'' that '''matches the given GUID''' value. If none is found, ''null'' is returned.
|-
| IntToColorConverter || style="text-align: center;" | ✗ || Color || Integer || ||
Converts an ARGB '''integer''' value to a '''color'''. If the value cannot be interpreted, the converter tries to parse the parameter as a ''color'' to return it. If everything fails, ''transparent'' is returned.
|-
| ItemCountToBoolConverter || style="text-align: center;" | ✗ || Boolean || Integer || Integer ||
This converter has a '''property''' to set the '''boolean return value''', called ''LesserOrEqualReturnValue''. This property-value will be returned if the given value is '''smaller than or equal to''' the threshold (parameter, defaults to 0). If the value is '''bigger than''' the threshold, the '''inverted''' ''LesserOrEqualReturnValue'' will be returned.<br/>
In any other case (like the value cannot be interpreted), ''false'' is returned, so it's a good idea to set the converter's property in a way that the return is only ''true'' if you need it.
|-
| ItemCountToOverflowConverter || style="text-align: center;" | ✗ || String || Integer || Integer || Creates a '''human-readable text''' indicating '''how many items are available'''. The value will be interpreted as the '''total item count''' and the parameter as '''overflow threshold''' (defaults to 99). <br/>If there are more items than the overflow, the overflow value with a + sign will be returned (e.g. 99+). If not, the value itself will be returned. If everything fails, ''null'' is returned.
|-
| NullToBoolConverter || style="text-align: center;" | ✓ || Boolean || Object,<br/>String|| ||
''Null'' or an '''empty string''' value get converted to ''true'', and everything else to ''false''.
|-
| NullToInvertedBoolConverter || style="text-align: center;" | ✓ || Boolean || Object,<br/>String || ||
''Null'' or an '''empty string''' value get converted to ''false'', and everything else to ''true''.
|-
| PathToImageSourceValueConverter || style="text-align: center;" | ✗ || Image Source || String || ||
Reads the '''path''' provided as parameter and creates an '''image source''' from it.
|-
| PercentageToProgressConverter || style="text-align: center;" | ✗ || Double || Integer,<br/>Double || ||
The '''numeric value''' (int or double), interpreted as '''percentage from 0 to 100''', get converted to a '''progress level''' (0 to 1). Values outside this range will be contained.
|-
| PropertyNameExistsToBoolConverter || style="text-align: center;" | ✗ || Boolean (Nullable) || ContentViewModel,<br/>IContent || ||
Converts a property to a '''boolean''' based on its '''existence'''. If it exists, ''true'' will be returned, else ''false'' or ''null'' (if something couldn't be properly interpreted).
|-
| PropertyNameExistsToInvertedBoolConverter || style="text-align: center;" | ✗ || Boolean (Nullable) || ContentViewModel,<br/>IContent || ||
Converts a property to a '''boolean''' based on its '''existence'''. If it exists, ''false'' will be returned, else ''true'' or ''null'' (if something couldn't be properly interpreted).
|-
| RootAreaTemplateConverter || style="text-align: center;" | ✗ || ContentView || Object || ||
If the provided value is '''not null''', the '''UBIKRootArea template''' will be returned.
|-
| SelectiveItemToValueConverter || style="text-align: center;" | ✓ || Boolean,<br/>String,<br/>Integer,<br/>Double,<br/>DateTime,<br/>Guid,<br/>FileReferenceData,<br/>GeoData,<br/>Object || Boolean,<br/>String,<br/>Integer,<br/>Double,<br/>DateTime,<br/>Guid,<br/>FileReferenceData,<br/>GeoData,<br/>Object || Binding, where source is ContentViewModel ||
Converts a '''item''' of a '''selective list''' to its value. If none is found, the passed ''value'' will be returned.
|-
| SelectiveListToItemsConverter || style="text-align: center;" | ✗ || List of PropertyItems || IPropertyItem || ||
Returns all items from a selective list.
|-
| SfDataSourceConverter || style="text-align: center;" | ✗ || DataSource (for ListView) || Double || String (Expression) ||
It's an advanced converter used for '''loading items''' and '''applying filters''' on it. It replaces to ''CollectionToViewConverter'' from the WinX.UWP project. The data source can be directly used with a ''[https://help.syncfusion.com/xamarin/sflistview/overview SfListView]''.<br/><br/>
'''This converter is obsolete!'''<br/>Use '''SfDataSourceExt''' (see [[#Data Source|Data Source]]) instead!
|-
| StringContainsToBoolConverter || style="text-align: center;" | ✗ || Boolean || String || String ||
Returns a '''boolean''' indicating whether the parameter string is included in the value string.
|-
| StringContainsToInvertedBoolConverter || style="text-align: center;" | ✗ || Boolean || String || String ||
Same as the ''StringContainsToBoolConverter'' but with '''inverted output'''.
|-
| StringFormatConverter || style="text-align: center;" | ✗ || String || Object || String || Allows the creation of a '''nicely formatted ''string'' message''', similar to [https://docs.microsoft.com/en-us/dotnet/api/system.string.format C#'s String.Format method].<br/>The value will be interpreted as the <code><nowiki>{0}</nowiki></code> element, and the parameter is the template string (e.g. <code><nowiki>The total count is: {0}!</nowiki></code>. Up to two additional parameters, named ''Parameter1'' and ''Parameter2'', can be defined at the converter declaration. Adding formatting options to the <code><nowiki>{0}</nowiki></code> notation is not possible.<br/><br/>
'''Attention''', using the native '''[https://docs.microsoft.com/en-us/xamarin/xamarin-forms/app-fundamentals/data-binding/string-formatting StringFormat]''' option is not only faster, but it also offers more customizability of the value!<br/>
You might still want to use the ''StringFormatConverter'' in rare cases, though!
|-
| ToStringFormatConverter || style="text-align: center;" | ✗ || String || Double,<br/>Float,<br/>Integer,<br/>DateTime,<br/>String || String || Converts '''primitives''' or '''[https://docs.microsoft.com/en-us/dotnet/api/system.datetime DateTime]''' to string and allows the application of '''[https://docs.microsoft.com/en-us/dotnet/standard/base-types/standard-numeric-format-strings formatting options]''' (as parameter). <br/>Adding a <code>.</code> to the end of the format-parameter allows '''[https://docs.microsoft.com/en-us/dotnet/api/system.math.truncate truncation]''' of all decimal places.
|-
| TypeNameToBoolConverter || style="text-align: center;" | ✗ || Boolean || Object || String || Returns ''true'' if the type name of the value is present in the parameter-string (seperated by <code><nowiki>|</nowiki></code>).
|-
| TypeNameToInvertedBoolConverter || style="text-align: center;" | ✗ || Boolean || Object || String || Inverted ''TypeNameTo<wbr/>BoolConverter''.
|-
| DataTemplateItemTemplateSelectorConverter || style="text-align: center;" | ✗ || ChildItem<wbr/>Template<wbr/>Selector || String || String || Chooses what '''ChildItem<wbr/>Template<wbr/>Selector''' to return. Having a parameter with the content "Small" returns the small item template selector.
|-
| DataTemplateItemsPanelConverter || style="text-align: center;" | ✗ || ItemsPanelTemplate || Query<wbr/>Details<wbr/>Page<wbr/>ViewModel || || Chooses what '''ItemPanel<wbr/>Template''' to return. Having a parameter with the content "Small" returns the small item template selector.
|}

[[Category:Client | XAML | Xamarin]]

[[Category:Client|Converters In Xamarin]]
[[Category:Xamarin|Converters In Xamarin]]

Managed App Configuration

2022-04-25T12:30:22Z

MKR: Updated number of max profiles from 9 to 25

In enterprise environments, there are sometimes hundreds of employee phones centrally managed by some EMM (Enterprise Mobility Management) software. This not only allows to limit the apps available for use (via a company-internal store ("Company App Store")) and remotely wipe devices (in the case of lost devices and fired employees), it also allows you to remotely set configurations of these apps to ease user experience. There are different types of management, like fully managed phones that belong to the company but also privately-owned phones with a work profile.

Starting with [[Version_4.0_Xamarin| App Version 4.0.0]], the {{UBIK}} Xamarin app will support managed app configuration for configuring profiles. That removes the need to manually copy over a Ubik Profile to every phone and importing it before its users can use Ubik. Historically, there was also the need to deploy the customizing ("XAML") before the app could be properly used, however, this has been solved already with the help of the [[Deploy_UI_Customizings_(Client)|XAML rollout feature]].

== Function ==
The new '''''profile rollout''''' feature allows for the rollout of up to 25 individual [[Settings|Ubik Profiles]]. The configuration supports the [https://appconfig.org/ AppConfig.org] standard, allowing compatibility to almost every EMM software. During the application start, the current configuration values are read and profiles created (with <code>.managed.profile</code> ending). All profiles created by the system will be updated to the current configuration during the startup phase, allowing recently configured profiles to appear and no longer configured profiles to be removed. Other profiles added to the Ubik application will not be affected by this system (except they have a <code>.managed.profile</code> ending for some unknown reason). Clearing all profiles also clears the configured profiles, and the app needs to be restarted for them to update.

On Android, the system makes use of the Android Restrictions System. On iOS, the NSUserDefaults System is used. These libraries are native to the system and widely supported.

== Configuration==
Microsoft Intune is just one of the EMM systems that will work with Ubik. This is the system that Augmensys uses for internal testing. For other EMM systems, the process will be similar.

For Intune, an Application Configuration Policy can be defined. It is possible to limit the scope of this policy to groups, devices, and even device management types. In the Configuration Designer, the desired values can be chosen, but for Ubik, all of them do the same and only differ by the number. For other EMM systems, this might be different, but you should end up with something similar-looking:

[[File:managed-app-configuration.png|thumb|none|750px|Screenshot of creating an App Configuration for Ubik in Microsoft Intune/Endpoint. Note that in the right panel the items to configure can be chosen.|center]]

It is currently possible to define 25 Ubik profiles using this technology.

All that's necessary to get the profile rolled out is to open a profile in your favorite text editor (we recommend Visual Studio Code or Notepad++) and copy the entire content into the configuration value. If your EMM system doesn't want to paste in multi-line strings, use an XML-minifier first.

[[Category:Version 4.0|Managed App Configuration]]
[[Category:Xamarin|Managed App Configuration]]

Version 4.1 (Xamarin)

2021-12-22T10:52:15Z

MKR: SetValueCommand no longer working

= Release Notes =

== Release ==

== Beta ==

== Preview ==

=== 4.0.? on 2021-??-?? {{key press|App Center}} ===
* The app's default profile is now only generated during app startup when no other profiles are detected.
* Xamarin Android now supports [[Managed_App_Configuration|managed app configuration]] for rolling out up to 9 Ubik profiles in an enterprise environment.
* Some security related improvements.
** The app now informs the web service to terminate the user session upon logout or app closing.
** The app no longer allows self signed server certificates.
* The app's entire login page is now customizable.
** As a result, the old feature which allows customizers to configure the background image of the login page (bg_portrait.png/bg_landscape.png) is removed. Because it only worked for Xamarin.UWP and can now be done with regular XAML customizing.
* Fixed an issue where unnecessary messages are logged. ("Message is null")
* UBIK clients are now able to log all webservice communication related activities (in UBIKWebserviceDebug.log) for better trouble shooting. It can also be turned off using the EnableSyncLogging setting in the profiles.

== Known issues ==

= XAML Notes =

== XAML changes ==
Since there has been a major UI redesign in this version, quite a lot of changes in XAML code (especially bindings) are involved. We have striven to maintain backward compatibility, but some changes either are simply unavoidable or their long term benefits outweigh the efforts required this one time.

=== Converters ===
* Under namespace UBIK.CPL.Converters, SelectiveItemToValueConverter is renamed as PropertyValueToSelectiveItemConverter to properly reflect what it does.

=== UBIKContentArea ===
* Changed from "Properties.Items" to "Properties.VisibleItems" in bindings because Items/AllItems now also include those system/invisible ones that users are not supposed to see.

=== UBIKThemes ===
* Removed "Content.", "OwnerModel." from bindings in DateTemplate "UBIKPropertyItem".
* "SetValueCommand" is no longer available and replaced with "SetPropertyValueCommand".

[[Category:Client|Version 4.0 Xamarin]]
[[Category:Version 4.0|Version 4.0 Xamarin]]
[[Category:Version 4.0 Xamarin|Version 4.0 Xamarin]]
[[Category:Xamarin|Version 4.0 Xamarin]]

=== UBIKEditNA ===
* Prefixed bindings "EnableNAOption" & "NotApplicable" with "PropertyViewModel.".

=== Editor related templates ===
{{Hint|The changes are quite extensive and, therefore, we recommended you taking the default templates from the app and re-customize them from there.}}

The affected list of templates include: UBIKEditDateTime, UBIKEditDouble, UBIKEditInt, UBIKEditGuid, UBIKEditGeo, UBIKEditBool, UBIKEditString.
* Changed from "PropertyItem" to "PropertyViewModel" in bindings;
* Prefixed bindings "EnableNAOption", "NotApplicable", "Unit" & "ShowComboBox" with "PropertyViewModel.";
* Changed from "PropertyValue" to "PropertyViewModel.ValueItem.PropertyValue" in bindings;
* Prefixed binding "FilterQueryResults.Items" with "PropertyViewModel."; (UBIKEditGuid)
* Changed from "ViewGuidObjectCommand" to "NavigateToGuidCommand". (UBIKEditGuid)

<headertabs />

{{Category/Version2|{{PAGENAME}}}}

[[Category:Client|Version 4.0 Xamarin]]
[[Category:Version 4.0|Version 4.0 Xamarin]]
[[Category:Xamarin|Version 4.0 Xamarin]]

Service Logins

2021-11-11T14:50:51Z

MKR:

Service Logins allow for easy management of credentials to third-party systems. They were introduced in server version 3.6. {{Version/ServerSince|3.6.0}}

== Problem ==
Service Logins are an easy solution to one problem, that occurs almost every time an interface to a third-party system is required: Where to put the credentials? If the interface makes use of Windows Authentication, it's no issue, as <code>WebClient.UseDefaultCredentials</code> will make use of the user the program/service opened. However, in almost all other cases, there's no way around either putting the credentials into the custom code (insecure, as it can be decompiled rather easily...) or creating properties on some MetaClass (that will be plain-text). <code>EncryptedText</code> properties won't work, as there's no way of getting to the plain-text password (that's required for the login to the external system) without using Reflection.

== Features ==
<code>SERVICE_LOGIN</code> is the root class of the system, deriving directly from <code>SYSTEM_OBJECT</code>. This MetaClass and its derivates are located in the namespace <code>System.Main.ServiceLogin</code>. In addition to that, there are derivates for the following derivates located in the namespace <code>Custom.Main.ServiceLogin</code>. These are intended to be used by customizers because of their ease of access by code (same class name as MetaClass name).
{| class="wikitable"
|'''MetaClass'''
|'''Properties'''
|-
|
<code>SERVICE_LOGIN</code>
|
''No Properties''
|-
|
<code>TOKEN_AUTH_SERVICE_LOGIN</code>
|
* <code>TOKEN</code> *
|-
|
<code>BASIC_AUTH_SERVICE_LOGIN</code>
|
* <code>USERNAME</code>
* <code>PASSWORD</code> *
|-
|
<code>WINDOWS_AUTH_SERVICE_LOGIN</code>
|
* <code>DOMAIN</code>
* <code>USERNAME</code>
* <code>PASSWORD</code> *
|-
|
<code>OAUTH2_AUTH_SERVICE_LOGIN</code>
|
* <code>TENANT_ID</code>
* <code>CLIENT_ID</code>
* <code>CLIENT_SECRET</code> *
* <code>CLIENT_CERTIFICATE</code> *
* <code>IDP_URL</code>
* <code>GRANT_TYPE</code>
* <code>SCOPE</code>
|}

The fields with the asterisk (*) are password fields that encrypt the text and store the result in the database. To get the decrypted counterpart, the C# field <code><SECRETNAME>_DECRYPTED</code> (e.g. <code>TOKEN_DECRYPTED</code>) needs to be accessed. All of the ServiceLogin-related properties can be accessed via custom code (or interface code, respectively) either using <code>PascalCase</code> or <code>SCREAMING_SNAKE_CASE</code>.

Service Logins

2021-11-11T14:49:46Z

2021-09-20T06:57:52Z

MKR:

Live Values

2021-09-16T07:06:27Z

MKR:

[[File:livevalues_xamarin.jpg |thumb|border|alt= Live values in Xamarin|Live values in Xamarin]]
[[File:livevalues_winx.png |thumb|border|alt= Live values in WinX|Live values in WinX]]
Live values are properties that update with a configured frequency. These properties contain information about reliability, measurement quality, and synchronization, as well as custom data (attributes). Real-time data, originating from various systems, can be delivered to the clients with minimum delay.

The Android, Xamarin and WinX clients display live values alongside other properties, and they are also shown on the [[Map View|map view]] upon selecting the specific object.

Also check out the [[HowTo:Implementing_Live_Values|Guide for Implementing Live Values]].

== Content Browser ==
The row for live value properties differs only slightly from normal property rows. On the left of the property value, below the description, is a connectivity indicator icon (reminding of the connectivity icon from cell phones). The more current the property value and the better its quality is, the better the connectivity is indicated. If all bars are greyed out and a small red cross is shown, the last update happened very long ago or no update was received at all, or the measurement quality is bad. For detailed information about that, a detailed dialog is necessary.

=== Connectivity Indicator ===
[[File:UI_android_live_values_freshness_indicators.png |thumb|border|alt= States of the connectivity indicator|States of the connectivity indicator]]

The connectivity indicator has the following states, from left to right:
* Good
* Questionable
* Bad

Note that the connectivity indicator combines the freshness and the measurement quality of the live value, thus describing the overall reliability of the value instead of just how recent it is.

The following gallery gives an overview of the possible synchronization states of live value property rows.

<gallery widths="200" heights="360">
File:UI_android_live_values_row_new.png| Reliable live values (Android)
File:UI_WinX_live_values_row_new.png| Reliable live values (Windows)
File:UI_WinX_live_values_detailsrow_new.png| Reliable live values in the document/details view (Windows)
</gallery>

==Map view==
[[File:UI_android_live_values_map_view.png |thumb|border|alt= Live values map view|Live values map view (Android)]]
[[File:UI_WinX_live_values_map_view.png |thumb|border|alt= Live values map view|Live values map view (Windows)]]

Upon clicking a correctly configured object within the map view, properties are shown within the opened dialog. It is important to know, that only '''High priority''' properties are shown here, altering the [[Settings#List of settings|priority threshold]] setting may change the visibility of the live property in the map view.

{{Clear}}
{{Category/Version|2.5.0}}

== Detail dialog ==
The freshness is very crucial in order to know whether the live property value can be trusted, but there are other influences like how good the measurement itself was. These information gets displayed via a dialog, the user can upon clicking the [[Live Values#Freshness Indicator |freshness indicator]] symbol both in the content Browser or the map view.
Within the dialog, several detailed information can be seen:

{| class="wikitable" | width = "75%"
|-
! Description!! Information
|-
| ''Live Value''|| Provides the same information as the row itself, namely value and as an icon the connectivity indicator.
|-
| ''Recentness''|| Displays how long ago the last synchronization was, based on the internal freshness evaluation system.
|-
| ''Last Synchronization''|| Displays the exact timestamp of the last successful synchronization, out of this, the recentness is evaluated.
|-
| ''Measurement time stamp''|| Measurement time stamp provided by the measurement unit itself (for instance a pressure measurement unit). It should not be trusted entirely since device time and measurement until time could have a huge difference.
|-
| ''Measurement quality''|| Quality information provided by the measurement unit or data collecting instance (e.g. OPCUA Server) which together with the "Recentness" gets combined to evaluate the [[Live Values#Freshness Indicator |freshness indicator]]. In addition, a more detailed description of the measurement gets displayed if available.
|-
|}

Some examples how such a detailed information dialog looks like in the following gallery:

<gallery widths="200" heights="360">
File:UI_android_live_values_dialog_new.png| Fresh live values (Android)
File:UI_windows_live_values_dialog_new.png| Fresh live values (WinX)
</gallery>

== Attributes {{Version/WinXSince|3.6}} {{Version/ServerSince|2.6.4}} ==
[[File:attributes.png |thumb|Attributes in the detail dialog (WinX)]]
Attributes are additional data that are sent to clients with every value update. They can be customized where the live values are generated (in the plugin) to contain the unit, formatted value, description, etc.

They were introduced in Service Version 2.6.4 and Client Version 3.6.

== Accessing from XAML ==
Live values can be easily accessed from XAML, as long as the view model has a reference to the '''Properties''' collection.

=== Displaying all Live Values ===
This XAML code will generate a list of all live values of this object:
<syntaxhighlight lang="xml">
<ListView ItemsSource="{Binding Properties.ImportantLiveItems}">
<ListView.ItemTemplate>
<DataTemplate>
<Grid Width="100" Height="40">
<FontIcon FontFamily="Segoe MDL2 Assets" Glyph="{Binding Content.LiveValueQualitySymbol}" HorizontalAlignment="Left"/>
<TextBlock Text="{Binding Content.DisplayValue}" HorizontalAlignment="Right"/>
</Grid>
</DataTemplate>
</ListView.ItemTemplate>
</ListView>
</syntaxhighlight>

=== Accessing Single Value ===
This code binds the value of the '''LMP_FLOW''' LiveValue-MetaProperty to a <code>TextBlock</code>:
<syntaxhighlight lang="xml">
<TextBlock Text="{Binding Properties.ImportantLiveItems[LMP_FLOW].Content.Value}"/>
</syntaxhighlight>

Furthermore, you can bind to:
* Description
* QualitySymbol
* Age
* LastSync
* TimeStamp
* Attributes (see below) {{Version/WinXSince|3.6}} {{Version/ServerSince|2.6.4}}

=== Binding to Attributes {{Version/WinXSince|3.6}} {{Version/ServerSince|2.6.4}} ===
Attributes can be bound to similarly as to the individual value:
<syntaxhighlight lang="xml">
<TextBlock Text="{Binding Properties.ImportantLiveItems[LMP_FLOW].Content.Attributes[Unit].Value}"/>
</syntaxhighlight>

The following data are available for each attribute:
* Value
* Key
* Description

==== Further Attributes ====
Custom attributes can be defined in the corresponding '''Live Value Interface''', with some of them pre-defined in the corresponding interfaces.

As an example, the [[OSIPI_(Plugin)|OSIPI Plugin]] defines an Attribute called '''FORMATTED''', which contains the ''Value'' already pre-formatted according to [https://livelibrary.osisoft.com/LiveLibrary/content/en/webparts-v4/GUID-13DC1C74-40B9-4FFE-B0B2-FCD204D8C337#addHistory=true&filename=GUID-A467C65F-C7C1-439D-AB26-7C360DB61865.xml&docid=GUID-13DC1C74-40B9-4FFE-B0B2-FCD204D8C337&inner_id=&tid=&query=&scope=&resource=&toc=false&eventType=lcContent.loadDocGUID-13DC1C74-40B9-4FFE-B0B2-FCD204D8C337 OsiPi's Specification]. In the ''Server-Configuration'', it's possible to adjust the formatting [https://docs.microsoft.com/en-us/dotnet/api/system.globalization.cultureinfo Culture] and leading-zeroes trimming.

[[Category:2.5.0|Live Values]]
[[Category:3.6.|Live Values]]
[[Category:Android|Live Values]]
[[Category:WinX|Live Values]]
[[Category:Xamarin|Live Values]]
[[Category:Live Values|Live Values]]

Live Values

2021-09-16T07:05:56Z

MKR:

[[File:livevalues_xamarin.jpg |thumb|border|alt= Live values in Xamarin|Live values in Xamarin]]
[[File:livevalues_winx.png |thumb|border|alt= Live values in WinX|Live values in WinX]]
Live values are properties that update with a configured frequency. These properties contain information about reliability, measurement quality, and synchronization, as well as custom data (attributes). Real-time data, originating from various systems, can be delivered to the clients with minimum delay.

The Android, Xamarin and WinX clients display live values alongside other properties, and they are also shown on the [[Map View|map view]] upon selecting the specific object.

Also check out the [[HowTo:Implementing_Live_Values|Guide for Implementing Live Values]].

== Content Browser ==
The row for live value properties differs only slightly from normal property rows. On the left of the property value, below the description, is a connectivity indicator icon (reminding of the connectivity icon from cell phones). The more current the property value and the better its quality is, the better the connectivity is indicated. If all bars are greyed out and a small red cross is shown, the last update happened very long ago or no update was received at all, or the measurement quality is bad. For detailed information about that, a detailed dialog is necessary.

=== Connectivity Indicator ===
[[File:UI_android_live_values_freshness_indicators.png |thumb|border|alt= States of the connectivity indicator|States of the connectivity indicator]]

The connectivity indicator has the following states, from left to right:
* Good
* Questionable
* Bad

Note that the connectivity indicator combines the freshness and the measurement quality of the live value, thus describing the overall reliability of the value instead of just how recent it is.

The following gallery gives an overview of the possible synchronization states of live value property rows.

<gallery widths="200" heights="360">
File:UI_android_live_values_row_new.png| Reliable live values (Android)
File:UI_WinX_live_values_row_new.png| Reliable live values (Windows)
File:UI_WinX_live_values_detailsrow_new.png| Reliable live values in the document/details view (Windows)
</gallery>

==Map view==
[[File:UI_android_live_values_map_view.png |thumb|border|alt= Live values map view|Live values map view (Android)]]
[[File:UI_WinX_live_values_map_view.png |thumb|border|alt= Live values map view|Live values map view (Windows)]]

Upon clicking a correctly configured object within the map view, properties are shown within the opened dialog. It is important to know, that only '''High priority''' properties are shown here, altering the [[Settings#List of settings|priority threshold]] setting may change the visibility of the live property in the map view.

{{Clear}}
{{Category/Version|2.5.0}}

== Detail dialog ==
The freshness is very crucial in order to know whether the live property value can be trusted, but there are other influences like how good the measurement itself was. These information gets displayed via a dialog, the user can upon clicking the [[Live Values#Freshness Indicator |freshness indicator]] symbol both in the content Browser or the map view.
Within the dialog, several detailed information can be seen:

{| class="wikitable" | width = "75%"
|-
! Description!! Information
|-
| ''Live Value''|| Provides the same information as the row itself, namely value and as an icon the connectivity indicator.
|-
| ''Recentness''|| Displays how long ago the last synchronization was, based on the internal freshness evaluation system.
|-
| ''Last Synchronization''|| Displays the exact timestamp of the last successful synchronization, out of this, the recentness is evaluated.
|-
| ''Measurement time stamp''|| Measurement time stamp provided by the measurement unit itself (for instance a pressure measurement unit). It should not be trusted entirely since device time and measurement until time could have a huge difference.
|-
| ''Measurement quality''|| Quality information provided by the measurement unit or data collecting instance (e.g. OPCUA Server) which together with the "Recentness" gets combined to evaluate the [[Live Values#Freshness Indicator |freshness indicator]]. In addition, a more detailed description of the measurement gets displayed if available.
|-
|}

Some examples how such a detailed information dialog looks like in the following gallery:

<gallery widths="200" heights="360">
File:UI_android_live_values_dialog_new.png| Fresh live values (Android)
File:UI_windows_live_values_dialog_new.png| Fresh live values (WinX)
</gallery>

== Attributes {{Version/WinXSince|3.6}} {{Version/ServerSince|2.6.4}} ==
[[File:attributes.png |thumb|Attributes in the detail dialog (WinX)]]
Attributes are additional data that are sent to clients with every value update. They can be customized where the live values are generated (in the plugin) to contain the unit, formatted value, description, etc.

They were introduced in Service Version 2.6.4 and Client Version 3.6.

== Accessing from XAML ==
Live values can be easily accessed from XAML, as long as the view model has a reference to the '''Properties''' collection.

=== Displaying all Live Values ===
This XAML code will generate a list of all live values of this object:
<syntaxhighlight lang="xml">
<ListView ItemsSource="{Binding Properties.ImportantLiveItems}">
<ListView.ItemTemplate>
<DataTemplate>
<Grid Width="100" Height="40">
<FontIcon FontFamily="Segoe MDL2 Assets" Glyph="{Binding Content.LiveValueQualitySymbol}" HorizontalAlignment="Left"/>
<TextBlock Text="{Binding Content.DisplayValue}" HorizontalAlignment="Right"/>
</Grid>
</DataTemplate>
</ListView.ItemTemplate>
</ListView>
</syntaxhighlight>

=== Accessing Single Value ===
This code binds the value of the '''LMP_FLOW''' LiveValue-MetaProperty to a <code>TextBlock</code>:
<syntaxhighlight lang="xml">
<TextBlock Text="{Binding Properties.ImportantLiveItems[LMP_FLOW].Content.Value}"/>
</syntaxhighlight>

Furthermore, you can bind to:
* Description
* QualitySymbol
* Age
* LastSync
* TimeStamp
* Attributes (see below) {{Version/WinXSince|3.6}} {{Version/ServerSince|2.6.4}}

=== Binding to Attributes {{Version/WinXSince|3.6}} {{Version/ServerSince|2.6.4}} ===
Attributes can be bound to similarly as to the individual value:
<syntaxhighlight lang="xml">
<TextBlock Text="{Binding Properties.ImportantLiveItems[LMP_FLOW].Content.Attributes[Unit].Value}"/>
</syntaxhighlight>

The following data are available for each attribute:
* Value
* Key
* Description

==== Further Attributes ====
Custom attributes can be defined in the corresponding '''Live Value Interface''', with some of them pre-defined in the corresponding interfaces.

As an example, the [[OSIPI_(Plugin)|OSIPI Plugin]] defines an Attribute called '''FORMATTED''', which contains the ''Value'' already pre-formatted according to [https://livelibrary.osisoft.com/LiveLibrary/content/en/webparts-v4/GUID-13DC1C74-40B9-4FFE-B0B2-FCD204D8C337#addHistory=true&filename=GUID-A467C65F-C7C1-439D-AB26-7C360DB61865.xml&docid=GUID-13DC1C74-40B9-4FFE-B0B2-FCD204D8C337&inner_id=&tid=&query=&scope=&resource=&toc=false&eventType=lcContent.loadDocGUID-13DC1C74-40B9-4FFE-B0B2-FCD204D8C337 OsiPi's Specification]. In the ''Server-Configuration'', it's possible to adjust the formatting [https://docs.microsoft.com/en-us/dotnet/api/system.globalization.cultureinfo Culture] and leading-zeroes trimming.

[[Category:2.5.0|Live Values]]
[[Category:3.6.|Live Values]]
[[Category:Android|Live Values]]
[[Category:WinX|Live Values]]
[[Category:Xamarin|Live Values]]

OSIPI (Plugin)

2021-09-16T07:05:32Z

MKR:

The OSIPI interface module enables support for reading data from [https://www.osisoft.com/pi-system/ OSIsoft PI systems] as well as data from the [https://docs.osisoft.com/bundle/ocs/page/ocs-content-portal-overview.html OSIsoft Cloud Services] and provides them as [[Live_Values]] within Ubik.

== Features ==
The module allows live data from the Data Archive to be read via both the '''PI Web API''' as well as from the '''OCS system'''{{Version/ServerSince|3.6.0}}.

Furthermore, it supports:
* Values of multiple types
* Configuration of multiple server instances to handle multiple sources simultaneously
* Correct value formatting according to the docs{{Version/ServerSince|3.5.0}}

== Prerequesites ==
They vary slightly by the type of interface. For the common things, you need a functioning Ubik Server setup (Studio, Database, and Web Service).

=== PIWebAPI===
To be able to successfully set up the system, the Ubik server/development machine needs access to the OSIPI instance. This can be easily checked in the web browser by navigating to the provided URL. [https://techsupport.osisoft.com/Documentation/PI-Web-API/help.html OSIsoft's PiWebAPI] is a [https://en.wikipedia.org/wiki/Representational_state_transfer REST API], from which the plugin reads data.

=== OCS API===
The Ubik server/development machine needs access to the OCS server, which usually means internet access, as it's somewhere in the cloud. The API uses OpenID Connect for authentication, and the Ubik module supports the [https://docs.microsoft.com/en-us/azure/active-directory/develop/v2-oauth2-client-creds-grant-flow OAuth2 Client Credentials Flow] only, so make sure to have a valid <code>TenantID</code>, <code>ClientID</code> and <code>ClientSecret</code> ready.

== Configuration in Ubik ==
Live value servers get added to instances of the '''OSIPI_SERVER''' metaclass, whereas the data points are objects of the '''OSIPI_DATAPOINT''' metaclass. <br/>
With that difference in mind, follow this guide: [[HowTo:Implementing_Live_Values]].

Not all data types of OSIPI are available to be configured in Ubik. The following table shows the matches:
{| class="wikitable"
|'''OSIPI Data Type'''
|'''Ubik Data Type'''
|-
|<code>Digital</code>
|<code>Integer</code> (0 or 1)
|-
|<code>String</code>
|<code>String</code>
|-
|<code>Int16</code> {{Version/ServerSince|3.5.0}}
|<code>Integer</code>
|-
|<code>Int32</code>
|<code>Integer</code>
|-
|<code>Float16</code> {{Version/ServerSince|3.5.0}}
|<code>Float</code>
|-
|<code>Float32</code>
|<code>Float</code>
|-
|<code>Float64</code> {{Version/ServerSince|3.5.0}}
|<code>Float</code>
|}

The same is true for the '''OCS API''', nullables are not yet supported.

=== Authentication ===
The following authentication methods are supported.

==== PI Web API ====
The OSIPI plugin supports two types of authentication for the '''PIWebAPI''':
* Basic {{Version/ServerSince|3.5.0}}
* Current User/Windows Authentication

In the case of '''Basic authentication''', put the credentials in the respective fields <code>LOGINNAME</code> and <code>PASSWORD</code>. Be aware that domain backslashes might need to be doubled, thanks to their escaping nature, e.g.: <code>DOMAIN\\USER</code>

If you leave the <code>LOGINNAME</code> field empty, the client tries to authenticate against the OSIPI server with <code>[https://docs.microsoft.com/en-us/dotnet/api/system.net.webclient.usedefaultcredentials WebClient.UseDefaultCredentials]</code>. Should this be the authentication of your choice, be aware that the Ubik Studio/Enterprise Service/Web Service needs to be started as that user that has access to the PI system.

Also, make sure that <code>USE_OCS</code> is '''not''' checked.

==== OCS API ====
Only one type of authentication is supported for the '''OCS API''':
* OAuth2.0/OpenID Connect Client Credentials Flow

For that, make sure to fill up the required fields <code>TENANT_ID</code>, <code>CLIENT_ID</code>, <code>CLIENT_SECRET</code>, <code>API_VERSION</code>, <code>OCS_NAMESPACE</code> and make sure that <code>USE_OCS</code> is checked.

== Attributes {{Version/WinXSince|3.6}} {{Version/XamarinSince|1.1}} {{Version/ServerSince|3.5.0}} ==
The Ubik OSIPI Plugin also supports [[Live_Values#Attributes|Live Value Attributes]], which can be [[Live_Values#Binding_to_Attributes|bound to directly from XAML]]. Not all attributes are delivered for all live values.
{| class="wikitable"
|'''Live Value Attribute'''
|'''Description'''
|-
|<code>UNIT</code>
|The unit of the OSIPI datapoint from OSIPI.

This attribute is only available if the unit from OSIPI is not empty.
|-
|<code>FORMATTED</code>
|The value in the format ''{Value} {Unit}'', with the option to set the [https://docs.microsoft.com/en-us/dotnet/api/system.globalization.cultureinfo value formatting culture] (with the <code>FORMATTING_CULTURE</code> field on the ''OSIPI_SERVER''). There is also an option to trim leading zeroes (with the <code>TRIM_LEADING_ZEROES</code> field), however, this is only available with the '''PIWEBAPI'''. This functionality is available in Ubik.Server 3.5.x as well, however, the fields <code>FORMATTING_CULTURE</code> and <code>TRIM_LEADING_ZEROES</code> are not generated automatically. This was repaired in 3.6.0.

This attribute is only available when the live value is numeric.
|-
|<code>DIGITS</code>
|The [https://www.google.com/url?sa=t&rct=j&q=&esrc=s&source=web&cd=1&cad=rja&uact=8&ved=2ahUKEwjFrLe1vaPlAhXQDmMBHYFUBycQFjAAegQIAxAB&url=https%3A%2F%2Flivelibrary.osisoft.com%2FLiveLibrary%2Fcontent%2Fen%2Fwebparts-v4%2FGUID-13DC1C74-40B9-4FFE-B0B2-FCD204D8C337&usg=AOvVaw2Zg1surxOxQ9sAedVz70DG OSIPI display digits] described.

This attribute is only available when the live value is numeric and only when using the '''PIWEBAPI'''.
|}

[[Category:OSIPI|OSIPI (Plugin)]]
[[Category:Live Values|OSIPI (Plugin)]]

Category:Live Values

2021-09-16T07:05:27Z

MKR: Created page with "Category:Interfacing"

[[Category:Interfacing]]

OSIPI (Plugin)

2021-09-16T07:04:52Z

MKR:

2021-09-14T12:29:29Z

MKR: Fixed Spelling mistakes in release notes

{| class="wikitable sortable" | width = "300"
|-
! Version !! Release Date
|-
| 3.6.0 || 2021.??.??
|-
|}

= Initial Release =
=== New features ===
* {{UBIK}} View Items provide the possibility to configure the data that should be (pre)loaded by a View when initiating a View Cache. Using this mechanism gives the customizer a very powerful instrument to tailor the preloading behavior for project specific needs.
* {{UBIK}} View Cache Launcher has a possibility to configure a timespan in which the launcher stays inactive (See [[View_Cache_Launcher]]).
* {{UBIK}} Contexts can derive from each other now. Using this technique can reduce the amount of necessary work when configuring ACM and much more important, will increase maintainability.
* {{UBIK}} Views can derive from each other now. Using this technique can reduce the amount of necessary work when configuring Views and much more important, will increase maintainability.
* {{UBIK}} provides the possibility to distribute customizing related binaries via the database now. They do not need to be stored on a server file share any more.
* {{UBIK}} supports Shape files for for representing geospatial vector data on the map now (https://wiki.openstreetmap.org/wiki/Shapefiles)
** [[SYSCLS_MAPSHAPE|Map Shape Classification Object]]
* {{UBIK}} supports the configuration of objects being automatically synced (make offline available) on clients
** [[SYSCLS_OFFLINE_SYNC_CONFIGURATION|Offline Sync Configuration Classification Object]]
* Improved Group Rights Evaluation
** WebServer Setting UBIK.Service.GroupRightsUpdateIntervall provides the possibility to configure the reload interval fully independend from the Validity Periode now
** A possibility to trigger a reload of the UserGroups, Logins and their rights via Custom Code is provided now.
** The reload of UserGroups, Logins and their rights is managed in the background now, which improves the WebServer performance
* {{UBIK}} provides a set of new features to provide the client with additional information about the current Login
** {{UBIK}} Web Service provides the possibility to fetch detail information about the current login
** If configured, the current login is delivered as part of the infrastructure. The data can be easily be used by the client then
** The Classification [[SYSCLS_LOGIN|Login Classification]] identifies logins as such. The classification does not insist on the Passwordhash Property any more.
* {{UBIK}} supports clients working with and sending data from different time zones
** A database settings gives the possibility to configure the timezone date - values are stored in the database (downward compatibility)
* Added [[Data_Import_Service]], a new externally triggered customizable {{UBIK}} Interface
* {{UBIK}} provides a new classification to define documents as media documents (photo, video, audio)
** [[SYSCLS_MEDIAFILEDOCUMENT|Media Document Classification]]
* {{UBIK}} Webservices provides a data import service for standardized imports now.
* UBIK supports the definition of Logins being limited to login via specific Operation Systems (e.g. an Android User can only login using an Android device but cannot login using Windows or iOS)

=== Bugfixes ===
* A problem with autonomous properties not being filled when performing a branch download is solved now.
* Relation Editor uses the correct Icons when displaying MetaProperties now (consistent to Details View).
* DisplayList uses the correct Icons when displaying MetaProperties now.
* Having more than 500 Metaproperties in the database caused an irritating issue when trying to set the MetaProxy Property Target. This issue is solved now.
* System Selective Lists can be sent to the client now.
* A bug in providing Childowner - Info in combination with an active ViewCache is fixed now.
* Customized Property Values do not interfere with the change of properties on the Web Service any more.
* A bug with incorrect classtype in the NUMERIC_SEQUENCE instance is fixed now.
* An issue with remaining MetaProperties (in the Sandbox-table) after Metaclass is released is fixed now.
* Sequential (MRO) Tasks forward their progress to their owners corretly now

=== Enhancements ===
* OPC/UA Live Values do support Attributes now
* The Login method persists Device Ids (sent from the clients) in UBIK now
* UBIK provides the possibility to inject your own Credentials Authentication mechanism now. This opens UBIK to use any user authentication system in the backend.
* UBIK uses a new logging solution. See [[Serilog]] for details.
* SQL Logging mechanism is more easier to enable and the entries are extended showing
** Elapsed time
** Affected records
** Transaction start and end
** Occurred errors
* The UBIK Kernel allows deploying a locally staged customizing (without having the need to recompile it first) now.
* UBIK WebService provides detailed information about View Cache data including its loading performance
* Compiling the customizing does not copy symbol files to the project share anymore
* Staging (local compile) does not create a symbol file for the UI Customizing anymore.
* Staging (local compile) the customizing provides a symbol and the source file now. This is a prerequisite for debugging the customizing.
* Internal optimizations reduce the number of database accesses by far. This results in higher performance.
* UBIK uses Global error handling
* The UBIK Hotspotting Module supports processing new pdf Annotations now as well.
* The UBIK Hotspotting Module provides a new API for easing the processing of data.
* The UBIK Hotspotting Module triggers a Thumbnail update of the changed documents now.
* More performant object saving.
* Update mechanism provide LDAP System Metaclasses and their properties now.
* The Ubik Interface Module Excel provides workflow activities to import data from MS Excel files.
* UBIK Clients terminate their tokens when logging out now (erroneous SessionManagement).

[[Category:Version 3.6|Version 3.6(Server)]]

= Build History Web Service =

= Build History UBIK.Studio =

= Build History UBIK.Plugins =

<headertabs />

{{Category/Version2|{{PAGENAME}}}}

[[Category:Version 3.6|Version 3.6(Server)]]

Version 4.1 (Xamarin)

2021-08-23T14:28:48Z

MKR:

Version 4.1 (Xamarin)

2021-08-23T14:27:22Z

MKR: Fixed Version Tag...

Managed App Configuration

2021-08-23T14:26:27Z

MKR:

In enterprise environments, there are sometimes hundreds of employee phones centrally managed by some EMM (Enterprise Mobility Management) software. This not only allows to limit the apps available for use (via a company-internal store ("Company App Store")) and remotely wipe devices (in the case of lost devices and fired employees), it also allows you to remotely set configurations of these apps to ease user experience. There are different types of management, like fully managed phones that belong to the company but also privately-owned phones with a work profile.

Starting with [[Version_4.0_Xamarin| App Version 4.0.0]], the {{UBIK}} Xamarin app will support managed app configuration for configuring profiles. That removes the need to manually copy over a Ubik Profile to every phone and importing it before its users can use Ubik. Historically, there was also the need to deploy the customizing ("XAML") before the app could be properly used, however, this has been solved already with the help of the [[Deploy_UI_Customizings_(Client)|XAML rollout feature]].

== Function ==
The new '''''profile rollout''''' feature allows for the rollout of up to 9 individual [[Settings|Ubik Profiles]]. The configuration supports the [https://appconfig.org/ AppConfig.org] standard, allowing compatibility to almost every EMM software. During the application start, the current configuration values are read and profiles created (with <code>.managed.profile</code> ending). All profiles created by the system will be updated to the current configuration during the startup phase, allowing recently configured profiles to appear and no longer configured profiles to be removed. Other profiles added to the Ubik application will not be affected by this system (except they have a <code>.managed.profile</code> ending for some unknown reason). Clearing all profiles also clears the configured profiles, and the app needs to be restarted for them to update.

On Android, the system makes use of the Android Restrictions System. On iOS, the NSUserDefaults System is used. These libraries are native to the system and widely supported.

== Configuration==
Microsoft Intune is just one of the EMM systems that will work with Ubik. This is the system that Augmensys uses for internal testing. For other EMM systems, the process will be similar.

For Intune, an Application Configuration Policy can be defined. It is possible to limit the scope of this policy to groups, devices, and even device management types. In the Configuration Designer, the desired values can be chosen, but for Ubik, all of them do the same and only differ by the number. For other EMM systems, this might be different, but you should end up with something similar-looking:

[[File:managed-app-configuration.png|thumb|none|750px|Screenshot of creating an App Configuration for Ubik in Microsoft Intune/Endpoint. Note that in the right panel the items to configure can be chosen.|center]]

It is currently possible to define 9 Ubik profiles using this technology.

All that's necessary to get the profile rolled out is to open a profile in your favorite text editor (we recommend Visual Studio Code or Notepad++) and copy the entire content into the configuration value. If your EMM system doesn't want to paste in multi-line strings, use an XML-minifier first.

[[Category:Version 4.0|Managed App Configuration]]
[[Category:Xamarin|Managed App Configuration]]

2021-01-21T15:07:17Z

MKR: