Version 4.4 (WinX)

2023-07-24T10:55:43Z

BLE: /* 4.4.? on 2023-07-? {{key press|App Center}} */

Version 4.4 (Xamarin)

2023-07-24T10:55:23Z

BLE: /* 4.4.? on 2023-07-? {{key press|App Center}} */

{{Attention|UBIK 4 clients can only connect to {{UBIK}} Servers of [[Version 3.6(Server)|version 3.6]] and higher!}}

== Availability ==
{{key press|Android: Store}}{{key press|iOS: Store}}: Publicly available in Google Play Store / Apple App Store.

{{key press|Android: Store Beta}}: Publicly available in Google Play Store as beta versions. You can opt in or out of the beta at any time in the store.

{{key press|iOS: Store Beta}}: Available through Apple App Store's [https://testflight.apple.com/join/ijGm4j2h invitation link].

{{key press|UWP: App Center}}{{key press|Android: App Center}}{{key press|iOS: App Center}}: Available to those who have access to the Augmensys App Center.
 

{{Attention|Some customized XAMLs might need an update to work properly. These changes are marked with a ⚠️}}

= Release Notes =

== Preview ==

=== 4.4.? on 2023-07-? {{key press|App Center}} ===
* PDF annotations are now automatically saved when you close the page just like with other regular content.
* Fixed an issue where work packages can not be confirmed because the calculated progress is only close to 100% due to the lost of precision.
* Fixed an issue where values do not get saved/committed when clicking on the check button of a task item.
* Fixed an issue where the client incorrectly updates/saves hotspots on PDF documents (e.g. even when you simply browse to a PDF document).
* Fixed an issue where PDF annotations and hotspots are incorrectly locked to users who created them but later log in with the same usernames in different cases.
* Fixed an issue where property based content filtering would not apply after pressing the apply filter button.
* Fixed an issue where PDF (horizontal) text search highlights are sometimes poorly positioned.
* Fixed an issue where profiles could not be loaded when the name of the profile was too long.
* Fixed an issue where after editing authentication properties an unwanted backward navigation occurred.
* Fixed an issue where you can not open the settings page on the first start of a freshly installed app.
* Fixed some UI issues when trying to edit GeoData or DateTime Properties.

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

=== 4.4.19 on 2023-07-07 {{key press|iOS: App Center}} ===
=== 4.4.18 on 2023-07-07 {{key press|Android: App Center}} {{key press|UWP: App Center}} ===
* Fixed an issue where it's impossible to open settings again after deleting all profiles.
* (Android) Fixed an issue where the app hangs on first start after installation.
* Fixed an issue where the app freezes upon logging out of certain services.
* Fixed an issue where downloading grouped sequential tasks can lead to app crashes.
* Fixed an issue where browsing to self linking objects lead to app crashes.

=== 4.4.16 on 2023-06-22 {{key press|App Center}} ===
* Fixed an issue where updates of a content list sometimes leave a meaningless item in that list (strange message at the end of the list).

=== 4.4.15 on 2023-06-21 {{key press|App Center}} ===
* Fixed an issue where it's impossible to start capturing a photo (or other media types).

=== 4.4.14 on 2023-06-21 {{key press|App Center}} ===
* The app can now [[Documents_(Client)#PDF_Text_Search|automatically search for predefined texts when opening certain PDF documents]].
* Increased the maximum zoom factor of the internal PDF viewer from 400% to 2000%.
* Fixed some issues where the status update results of sequential tasks are incorrect under certain circumstances.
* Fixed an issue where deleting/changing certain inputs during property editing is no possible.
* Fixed an issue where persisting property based filters might lead to some unexpected errors.

=== 4.4.12 on 2023-06-06 {{key press|iOS: App Center}} ===
* (iOS) Fixed an issue where the selected camera is not applied in camera views.

=== 4.4.9 on 2023-06-05 {{key press|App Center}} ===
* Fixed an issue where existing hand drawing signatures do not get displayed on devices with certain aspect ratios.

=== 4.4.7 on 2023-06-05 {{key press|App Center}} ===
* (iOS) The digital hand drawing signature property editing feature is now also supported on iOS.
* Added the Lazy Loading Query Classification that can prevent unwanted re-evaluation of queries.
* A [[XAML_Tips#TeachInCommand|TeachInCommand]] is now available in ContentViewModel and PropertyViewModel to set the device's current location as the geo property value.
* Certain objects can now carry multiple scan codes ([[SYSCLS_OBJECTWITHIDMARKERS|optical]] or [[SYSCLS_OBJECTWITHRFIDTAGS|RFID]]) so that scanning any one of them finds the object.
* Added settings to allow selecting cameras, resolutions and zoom values (if supported).
* (iOS) Fixed an issue where the app sometimes crashes after you annotate a PDF document and navigate back.
* Fixed an issue where your choice of color appears not applied to PDF ink annotations.
* Fixed an issue where the import of broken profiles was not prevented properly.
* Fixed an issue where the embedded PDF viewer's horizontal scrollbar does not allow you to view the entire page when pages have different dimensions.
* (UWP) Fixed an issue where digital signatures can only be drawn using a mouse, but not with a finger.

== Known issues ==

* Sometimes, objects shift their positions in the lists after being edited. We found out that this is related to the 3rd party list control we use and are considering replacing it. However, this will take some more time in order to make all features we build around the control still function.
* Currently, the Samsung keyboard doesn't show {{key press|,}} at all, regardless of the current language/locale setting of the device. Please use a different virtual keyboard (e.g. Gboard from Google) instead if {{key press|.}} is unacceptable.

 

= ⚠️ XAML Notes =

=== ⚠️ IsStickyFooter Issue ===
* When using a DataTrigger to set the properties of a footer for a ListView, the sequence of the properties inside the DataTrigger might matter in some cases. It seems to occur since Version 4.4 due to a Syncfusion update and could lead to the page not being rendered properly and appearing empty. If you encounter such an issue please workaround by adding the IsStickyFooter Property Setter on top inside the DataTrigger. For details, please [[Xamarin_XAML#DataTrigger_to_set_Footer_Properties_in_a_ListView|read this]].

<headertabs />

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

Push Service (Client)

2022-09-30T09:07:33Z

BLE: /* Background polling service */

The {{UBIK}} push service is a mechanism to ensure the clients always receive certain information pushed by the [[UBIK Push Web Service|push web service]].

The client part of the push service runs in the background, independently of the content service. When active, it periodically polls the push web service for new updates. Once such updates are received, the clients react accordingly based on the information contained in them. Some examples are updating content and switching clients into different [[Sync Mode|sync modes]].

== Push service settings ==
The following settings are used in order for the push service to function properly.
{| class="wikitable" | width = "50%"
|-
! Name!! Purpose
|-
| ''PushServerName''|| Name of the server to connect to for push updates
|-
| ''PushPortNumber''|| Port number to use when connecting to the push server (optional)
|-
| ''UBIKPushService''|| Name of the UBIK push service
|-
| ''ActivatePushService''|| Whether {{UBIK}} should run with/without the push service. {{Version/AndroidSince|2.4.1}}
|-
|}

{{Hint|Changing the value of '''ActivatePushService''' could potentially [[HowTo:Start/Stop_Push_Service_(UBIK_Android)|start/stop the push service]].}}

== Background polling service ==
As mentioned, a background polling service is responsible for communicating with the push web service and getting push updates.
This service is started once users successfully log in and will keep running until they are logged out.

{{Hint|On Android and iOS the Polling will continue while UBIK is in the background and/or the device is asleep, but at a deduced frequency. On Android it is around 15 minutes. On iOS it depends on how much the App is used, the frequency can range from 15 minutes to a couple of hours. {{Version/XamarinSince|4.2}} }}

There are two types of push communication involved here, namely
* Updating push parameters;
* Updating push data

=== Updating push parameters ===
There are different [[UBIK Push Web Service#Push Criteria|push criteria]] that define which data should be pushed to which clients.
As a result, the push web service requires a set of push parameters which can be used to check against these criteria.

The client polling service, in order to always get the intended push data, has to keep this set of parameters up-to-date and use them in the push data updating.

During maintaining the push parameters, the following information might be collected by {{UBIK}} and used as the parameter values:
* User name;
* Device ID;
* {{UBIK}} application name and context name;
* Current location;
* etc.

=== Updating push data ===
The main job of the service is to get push data once it's ready to be pushed from the server. And the service is not interested in getting push data it has received before.

To achieve this, the service repeats (e.g. every 10 seconds) the following tasks:
# Frequently sending the client's actively maintained push parameters (types and values) and the last push status ID to the push web service;
# Recording the status ID in the received push update as the last push status ID;
# Passing on the data in the received push update so that {{UBIK}} can process it.

[[Category:2.4.0|Push Service (Client)]]
[[Category:Android|Push Service (Client)]]
[[Category:Push|Push Service (Client)]]
[[Category:WinX|Push Service (Client)]]

== Processing push data ==
[[File:UI_Android_Push_Data_Received_Notification.jpg|thumb|alt=Notification for Received Push Data|Notification for Received Push Data]]

After receiving push data, {{UBIK}} processes it and potentially performs different follow-up tasks.

The currently known types of push data and their intended client actions are described in the following subsections.

=== Updating content hierarchy ===
Upon receiving such push data, {{UBIK}} tries to update the content hierarchy as the parameters in the push data indicate. This can lead to various scenarios such as:
* Update of a single object;
* Removal of a single object;
* Update of a single object and all its children;
* Update of root objects;
* Update of infrastructures;
* etc.

In case there are uncommitted changes involved in the update, {{UBIK}} performs the update while preserving the changes. This applies for all the sync modes.

=== Updating Meta Definitions ===
[[File:UI_Android_Push_Update_MetaDef_Uncommitted_Conflict.jpg|thumb|alt=Error Notification for Conflict during Updating Meta Definitions|Error Notification for Conflict during Updating Meta Definitions]]

Upon receiving such push data, {{UBIK}} tries to update all the Meta Definitions. If the update is successful, root objects and infrastructures are then updated as well, and {{UBIK}} is automatically switched to the automatic sync mode.

In case there are uncommitted changes, the followings apply depending on the sync mode at that point of time.
* Automatic mode: Changes are committed automatically and the updates are done afterwards;
* Other modes: Updates can not proceed (changes will be lost otherwise) and an error notification is shown.

Meta definition pushes are not yet supported by the WinX client.

=== Updating device status ===
[[File:UI_Android_Push_Maintenance_Uncommitted_Conflict.jpg|thumb|alt=Error Dialog for Conflict during Preparing for Maintenance|Error Dialog for Conflict during Preparing for Maintenance]]

Upon receiving such push data, {{UBIK}} tries to update the status of the device. Currently, the only known status is maintenance. This means the server will be under maintenance and unreachable soon. Therefore, {{UBIK}} should be switched to offline mode.

In case there are uncommitted changes, the followings apply depending on the sync mode at that point of time.
* Automatic mode: Changes are committed automatically and {{UBIK}} is switched to offline mode;
* Other modes: A dialog is shown to let the users decide whether to commit their changes or not. Changes are, of course, only committed with users' consent. But {{UBIK}} is switched to offline mode either way.

Device status pushes are not yet supported by the WinX client.

=== Popup dialogs ===
There are three sub types of this push: {{Version/AndroidSince|2.4.5}}
<gallery widths="200" heights="200">
File:UI_Android_Push_Popup_Emergency.jpg|Emergency popup
File:UI_Android_Push_Popup_Failure.jpg|Failure popup
File:UI_Android_Push_Popup_Important_Info.jpg|Important information popup
</gallery>
Upon receiving such a push, a dialog with the corresponding style is shown to the user. All these popups can also contain a content/document. In either case, the associated object will be downloaded as soon as the push is received and the button text will be updated accordingly. The possible button states are:
* {{key press|OK}}: If the popup contains only text;
* {{key press|Waiting}}/{{key press|Downloading}}/{{key press|Detail}}: If there is an object associated and the download is pending/on-going/successful;
* {{key press|Close}}: If the associated object somehow cannot be downloaded. The detailed error(s) is/are displayed as notification(s) in this case.
Once the user has confirmed the popup by clicking the {{key press|OK}}/{{key press|Detail}} button, it is considered successful and won’t be received again. In the case of a {{key press|Detail}} button, the associated object is opened in either the {{UBIK}} [[UBIK_Client_Basics#Content_Browser|content browser]] or a third party document viewer.
{{Hint|Users can only dismiss the dialog by clicking the {{key press|OK}}/{{key press|Detail}}/{{key press|Close}} button. The Android back button is disabled when such a popup dialog is shown.}}
{{Clear}}

Popup dialog pushes are not yet supported by the WinX client.

=== Reacting to processing errors ===
In the push scenarios described above, once a conflict is detected and can not be resolved (e.g. updating Meta Definitions when there are uncommitted changes in manual sync mode), that particular push is considered as failed to be processed.

During the next push update, all the failed pushes will be reported to the push web service. The result of this is {{UBIK}} will get these failed pushes again along with the new pushes (if there are any). However, all successful pushes in the previous push update will not be delivered again.

== Push related errors ==
Just like for the content service, various errors can happen when the push service is running. For example,
* The push web service is unreachable due to misconfigurations in the settings;
* Users are denied of accessing the push web service due to invalid credentials;
* The client push service is incompatible with the push web service due to version differences;
* etc.

In case such an error occurs, a notification is shown to inform the users so that they can either fix the issue or contact the administrators.

== See also ==
* [[UBIK Push Web Service]]
* [[Sync Mode]]
* [[Activity:PushPopUpMessage_(Activity)]]

{{Category/Version|2.4.0}}

[[Category:2.4.0|Push Service (Client)]]
[[Category:Android|Push Service (Client)]]
[[Category:Push|Push Service (Client)]]
[[Category:WinX|Push Service (Client)]]

UBIK WinX Client Basics

2022-04-21T14:53:17Z

BLE: /* Properties */

{{UBIK}} Client is the mobile application for viewing and modifying data, showing documents, starting navigation, visualizing POIs and much more.

Client applications are available for Android and WinX, however the features available on each of the platform dependent applications might differ. An overview of the available features can be found in the [[Client_Feature_Table|feature comparison table]].

== Login ==
Users need to login in order to access confidential data, this can be done in the [[Login View]].

=== Confirm login ===
{{Version/WinXSince|3.6}}
Certain pages might require to confirm the login data, even if the user is already logged in. This can be done in the following way: The CheckUserOfflineCommand needs to be called with the username and password as parameter, if the login was valid, the CheckUserOfflineSuccess boolean property is set to true, which causes the text "Login confirmed" to appear in the example.

<source lang = "xml">
<TextBox
x:Name="Sign01User"
DataContext="{Binding AuthenticationViewModel, Source={StaticResource Locator}}"
PlaceholderText="User"
Text="{Binding UserName}" />
<PasswordBox
x:Name="Sign01PW"
DataContext="{Binding AuthenticationViewModel, Source={StaticResource Locator}}"
PlaceholderText="Password" />
<Button
Command="{Binding CheckUserOfflineCommand}"
Content="Confirm login"
DataContext="{Binding AuthenticationViewModel, Source={StaticResource Locator}}">
<Button.CommandParameter>
<uc:KeyValueList>
<uc:KeyValueParameter Key="UserName" Value="{Binding ElementName=Sign01User, Path=Text}" />
<uc:KeyValueParameter Key="Password" Value="{Binding ElementName=Sign01PW, Path=Password}" />
</uc:KeyValueList>
</Button.CommandParameter>
</Button>
<TextBlock Text="Login confirmed" Visibility="{Binding AuthenticationViewModel.CheckUserOfflineSuccess, Source={StaticResource Locator}, FallbackValue=false, Converter={StaticResource BoolToVisConverter}}" />
</source>

== Profiles ==
Profiles are used to store connection information for {{UBIK}} services. It specifies the location where to find the service along with other useful informations. Profiles are stored by UBIK whenever the user created connection information and stored it in the settings. However, profiles can also be created and edited with any text editor. Possible settings to be defined are:
* InternalConnectionSettings: Connections settings how to connect to the Content and the USAM service that has been set up.
** Application: the [[APPLICATION]] to use with the service
** AuthenticationPort: Port Number of the authentication (USAM) service (default: 777)
** AuthenticationProtocol: Protocol of the authentication service (default: https)
** AuthenticationServer: the ip address of the authentication server
** AuthenticationService: the path to the authentication service
** ContentPort: Port Number of the content service (default: 777)
** ContentProtocol: Protocol of the content service (default: https)
** ContentServer: the ip address of the content server
** ContentService: the path to the content service
** Context: the [[CONTEXT]] to use with the service
** SyncMode: the used sync mode (Online [= Auto], Manual, Offline; default:Online)
* IsDefault: true, if the profile should be the default profile
* Name: the name of the profile (will also be used to identify the database)
** If the profile name contains invalid characters like: /, ", <, >, ... they will be replaced with %_
* Project: the project name. Use this to share a single project name with more than one profile. If the project is defined, all profile with the same project will share one database.
* Customizing: the XAML subfolder to use for customized UI. This parameter can be used to share one single XAML customizing folder for multiple profiles.
* ShowHiddenSettings: show hidden settings (feault: false)

Example:
<source lang = "xml">
<?xml version="1.0" encoding="utf-8"?>
<Profile xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/UBIK.WinX.Settings">
<Customizing>MYAPPLICATIONUI</Customizing>
<Description i:nil="true" />
<InternalConnectionSettings>
<Application>APP_DEMO</Application>
<AuthenticationPort>777</AuthenticationPort>
<AuthenticationProtocol>https</AuthenticationProtocol>
<AuthenticationServer>80.243.175.50</AuthenticationServer>
<AuthenticationService>UBIK/DBG/AUG/DEMO.250/USAM/USAM.svc</AuthenticationService>
<ContentPort>777</ContentPort>
<ContentProtocol>https</ContentProtocol>
<ContentServer>80.243.175.50</ContentServer>
<ContentService>UBIK/DBG/AUG/DEMO.250/CONTENT/UBIKContent.svc</ContentService>
<Context>CXT_DEMO</Context>
<SyncMode>Online</SyncMode>
</InternalConnectionSettings>
<IsDefault>true</IsDefault>
<Name>DEMO.250.AT</Name>
<Project>DEMO.250</Project>
<ShowHiddenSettings>false</ShowHiddenSettings>
</Profile>
</source>

== Content Browser ==
Allows to navigate through the entire data model in a hierarchical manner, as it is published by the server.

Initially, a list of objects ("root objects") is shown. Upon selecting an object, a new browser is opened for that object, showing details about it. When an object is selected in the content browser, it is called the browser's context. For such a contextual object, child objects and selected properties are shown. Also, there is a context menu providing actions related to the currently selected object.

=== Status Bar ===
[[File:UI_WinX_DbSavingIndicator.PNG|300 px|thumb|border|alt=Saving Symbol|Saving Symbol]]
{{Version/WinXSince|2.5.4}}Whenever content is being saved into the local database (for example, after a branch is downloaded from the server), there will be a blinking symbol indicating the saving activity is happening in the background.
During that time, the user is advised to not logout or close the app because the content might be lost otherwise. However, it is okay to undertake other tasks such as browsing, editing or downloading branches.

=== Child Page ===

[[File:ChildPage.PNG|400 px|thumb|border|alt=Child Page|Child Page]]

The child page shows the context of a selected object.

The global status bar shows the icon, the name and the description of the selected object. An arrow on the left side allows the user to navigate back to the parent object. On the right side the currently logged-in user is indicated. By clicking on the username one is able to navigate back to the home screen or log off.

The right side of the child page shows child objects of the current object. Each child object is represented by an icon, a name and a description.

On the left side of the child page the current object´s high priority properties are shown. By clicking on a live value property, the live value details dialog opens. By clicking on an editable [[UBIK_WinX_Client_Basics#High_priority_properties| high priority property]], an editor opens {{Version/WinXSince|2.5.4}}. If a property was edited a save button is shown in the lower left corner, allowing the user to commit the changes. If a property of a query object was edited an evaluate button is shown in the lower left corner, allowing the user to run the query with the changed propery.

=== Details Page ===

=== Context Menu ===

=== Objects ===

==== Root objects vs child objects ====

The first entry point in the ''Content Browser'' is the list of root objects.

==== Task objects ====

==== Query objects ====

==== Safety relevant objects ====

==== Commissioning objects ====

==== Locked objects ====

=== Properties ===

==== Authentication Properties ====
Authentication Properties are properties which need a user authentication (through a passwordfield) to be edited.

==== Live value properties ====

==== High priority properties ====
High priority properties are properties having a priority higher than the [[Settings#Content |priority threshold]].

==== Selective List Properties ====

==== Properties with value records {{Version/WinXSince|2.5.4}} ====
[[File:UI_WinX_PropertyWithValueRecords.png|thumb|A property with value records]]
[[File:UI_WinX_PropertyValueRecords.png|thumb|Property value records dialog]]
In addition to its value, a property might also bring along a series of value records showing "who changed the value at what time".

When such records exist, the property row shows a special symbol on the right side. After a right click (with mouse) or a long tap (with touch) on the property row, a dialog will be shown to present these records (sorted by their time, recent ones on top).

==== String properties with length restrictions ====
A string property can be configured with a [[MetaProperty#Text_2|length restriction]]. The client property editing UI doesn't allow users to confirm values exceeding the limit.

{{Clear}}

==== Editors ====

===== Geo Editor & Teach In =====

==== Guid editor ====
[[File:Guid_property_dialog.PNG|thumb|border|alt=Guid property editor dialog|Guid property editor dialog]]

To edit Guid properties (that do not have a selective list available), we have implemented a special system. Since a Guid property always just contains the Guid as a reference to another object, we can use a query to find the object we want to assign to this property.

When the Guid property has a FilterQuery datamember (which should contain the guid of a query), it will become editable through this query. Note that this FilterQuery guid will not actually be visible in the client. All this should be setup in the backend, the client has no control over this.

When clicking an editable Guid property, you will see a dialog with up to 3 extra buttons added (see image):

;View Object
:This button will be enabled when there is a valid guid assigned to the property. Clicking this button will immediately navigate to the referenced object.
;Edit Property
:If the property has a valid FilterQuery assigned to it, clicking this button will launch that query. If no FilterQuery is assigned, this button will be invisible.
;Clear Property Value
:If the property has a guid assigned, the user can press this button to reset the value back to empty.

Additionally, if a valid FilterQuery is assigned, the user will see the results of that query ''inline'', if the query delivers 200 results or fewer. The user can select an item from this horizontally scrollable list, and press "OK" to assign the UID of the selected object to the Guid property. This is useful for cases where the user does not want to jump into the full query to be able to select an object.

If the user does choose to launch the full query page (or if the query returns over 200 objects), they can click any of the displayed items in the query's child list. When clicking one of them, it will immediately be set as the reference in the original Guid property. To cancel selecting an item (and stop editing the property), simply navigate to any other page (by pressing back, using navigation bar, etc).

{{hint|'''Skipping the dialog'''
If editing the property in a query page without having to go through the dialog is desired, one can customize the boolean variable "SkipQueryDialog" in UBIKThemes.xaml. If none can be found, simply add the following line into its "Default" ResourceDictionary.
<source lang = "xml"><x:Boolean x:Key="SkipQueryDialog">True</x:Boolean></source>
}}

[[Category:Pages with broken file links|UBIK WinX Client Basics]]
[[Category:WinX|UBIK WinX Client Basics]]

=== Documents ===
UBIK supports and displays document objects and a bunch of actions related to them (editing, redlining, creation, thumbnails, ...).

==== Fit Mode{{Version/WinXSince|3.5}} ====
By default, documents are displayed in their original dimensions. But administrators can also [[SYSCLS_DOCUMENT_FITMODE|configure different fit modes]] for each document. The following demonstrates how documents can look under different fit modes.

{| class="wikitable" | width = "100%" style="text-align: center;"
|-
! Unspecified / Unscaled / Default !! Fit to container !! Fit to width !! Fit to height
|-
| [[File:UI_WinX_FitMode_Unspecified_Small.png|240x225px]] || [[File:UI_WinX_FitMode_Container_Small.png|240x225px]] || [[File:UI_WinX_FitMode_Width_Small.png|240x225px]] || [[File:UI_WinX_FitMode_Height_Small.png|240x225px]]
|-
| [[File:UI_WinX_FitMode_Unspecified_Large.png|240x225px]] || [[File:UI_WinX_FitMode_Container_Large.png|240x225px]] || [[File:UI_WinX_FitMode_Width_Large.png|240x225px]] || [[File:UI_WinX_FitMode_Height_Large.png|240x225px]]
|}

{{Attention|When using a FlipView for documents in your customized XAMLs, you need to additionally [[XAML_Tips#Fit_mode|apply the fit mode]] by yourself. }}
{{Attention|This feature currently only works for PDFs (it is not supported for Images). }}
{{Hint|Double tapping on a document toggles the display between "Fit to width" and the fit mode that document is configured with.}}

[[Category:Pages with broken file links|UBIK WinX Client Basics]]
[[Category:WinX|UBIK WinX Client Basics]]

==== Customizing Possibilities ====

==== Editing{{Version/WinXSince|2.5.4}} ====
[[File:UI_WinX_EditDocumentButton.png|thumb|Button to edit a document]]
For [[SYSCLS_EDITABLEDOCUMENT|editable documents]], there is an {{key press|edit}} button in the bottom app bar. It allows the user to edit a document file using the default app of the OS. If a file is changed during the edit, the same {{key press|save}} button appears just like it does for content with changed properties.
{{Hint|Similar to saving, other app features also apply on edited documents. For example, reverting local changes for an edited document will throw away the changed document file and restore it to the server version.}}
[[File:UI_WinX_EditDocumentOverlayButton.png|thumb|Edit button in thumbnail overlay]]
An alternative way to start editing is to right click on a document's thumbnail, which brings up an overlay of buttons, and then select the {{key press|edit}} button. The difference here is that there is no {{key press|save}} button and any changes are automatically saved (and committed if in online mode).
{{Clear}}

==== Offline availability ====
When a user selects a branch to bring offline, files of all document objects underneath are downloaded in principle. However, they can also be selectively configured to be ignored with a [[SYSCLS_OFFLINE_AVAILABLE_DOCUMENT|classification]] on the server-side. Once a document is classified as offline available, the document file will not be removed when the storage for already synchronized document files is cleared.
{{Hint|This is not to be confused with the accessibility related to [[User_Rights|user rights]]. The logic here is "some documents '''do not have to''' be downloaded", not "some documents '''can not''' be downloaded/accessed". In other words, a user can browse to and open the document regardless of this configuration.}}

==== Clear Online Documents ====
By clearing the online documents, it is possible to free up system memory if needed. It can be triggered by pressing the button "Clear online documents" in the general settings tab. Online documents are documents already uploaded to the server. They can be downloaded anytime agian when the client is connected to the server. However, documents classified as offline available will not be affected and will always stay on the device.

== AR Features ==

=== POI View ===
Brings up the POI View|Augmented Reality view and displays Points of Interest (POI's) related to the current location of the mobile device.

=== Markerless ===

=== Map View ===
Opens the Map View and displays Points of Interest (POI's) related to the current location of the mobile device.

== Positioning ==
{{UBIK}} clients use a [[Location_Manager|Location Manager]] in order to gain knowledge about their position, so it can help the user navigate to his/her target.

The user can choose one of different positioning modes optimized for different environments.
Most of them incorporate multiple technologies for calculating positions or checking their reliability.

=== Positioning modes ===

* ''Use all'' - uses all available position sources
* ''LLA only mode'' - used for positioning using markers only
* ''Beacon Proximity mode'' - uses iBeacon proximity and LLA only

=== Technologies ===

==== GPS ====
GPS is used as a primary positioning input source for outdoor areas. Its precision depends on the environment and satellite availability. With good circumstances, the accuracy varies between 1 and 10 meters.

==== LLA markers ====
LLA markers basically are QR codes with location data encoded into them - which can be used for positioning when they are scanned.

==== Object Proximity Positioning ====
The location of nearby Geo-Objects can be used for positioning.

The position of a Geo-Object can be used manually by pushing the button {{key press|Use Location}} in the [[UBIK_WinX_Client_Basics#Context_Menu|Context Menu]].

The geo information of an object gets used automatically if exactly one single object is found through scanning. If more objects are found, their geo information doesn´t get used. Scanning includes [[UBIK Client Basics#Bar Code|Bar Code]], [[UBIK Client Basics#QR Code|QR Code]], [[UBIK Client Basics#OCR|OCR]] and [[UBIK Client Basics#RFID|RFID]]. The automatic use of Geo-Object´s location can be turned off by disabling the "EnableObjectProximityPositioning" setting.

==== Beacon-Proximity Positioning ====
The Beacon Proximity Mode detects if the user is in the proximity of a beacon. The proximity region is defined by a proximity distance which creates a sphere around the beacon. Whenever the calculated distance to a beacon is smaller than the proximity distance, the user is supposed to be at the position of the beacon. If multiple regions intersect the user is supposed to be at the position of the nearest beacon.
In order to use Beacon Proximity as a Positioning System, Bluetooth Low Energy has to be available and enabled on the mobile device. If a new environment should be equipped with iBeacon-Positioning, an expert has to mount iBeacons on known positions and calibrate the propagation factor of these beacons. Proximity beacons can be configured using [[SYSCLS_PROXIMITY_BEACON]]. {{Version/WinXSince|UWP}}

== Finding Objects ==
=== Free Text Search ===

=== ID Marker ===

=== QR Code ===

=== Bar Code ===

=== RFID Code ===
Provides a fast and convenient way for users to find objects that are identifiable through [[RFID tags|RFID tags]].

=== OCR ===

== Linked objects ==
{{Version/WinXSince|3.6}}
It is possible to display values of linked objects by using the "LinkedLevel" property. An example can be seen here, where Items[0] is a Guid property linking to another object. The ItemsControl then binds to the Properties of the linked object.

<source lang = "xml">
<Grid DataContext="{Binding Properties.Items[0].LinkedLevel}">
<ItemsControl ItemsSource="{Binding Properties.AllItems}" />
</Grid>
</source>

[[Category:Pages with broken file links|UBIK WinX Client Basics]]
[[Category:WinX|UBIK WinX Client Basics]]

== See also ==
* [[Client_Feature_Table]]

[[Category:Pages with broken file links|UBIK WinX Client Basics]]
[[Category:WinX|UBIK WinX Client Basics]]

SYSCLS REQUIRE AUTHENTICATION

2022-04-21T12:03:21Z

BLE:

{{ClassificationInfoBox
| title = Require Authentication Classification Object
| name = {{PAGENAMEE}}
| inheritance = -
| namespace = System.Classification.Content
| purpose = Classify properties as properties requiring authentication before being edited
| version = 3.6.2+
| id = {B3F15445-0867-4EE7-8D29-2B2BC9665EE0 }
}}

If a property is classified as/with require access, UBIK clients will force the user to authenticate themselves before being allowed to edit the property value.

{{Category/Version|3.6.2}}

[[Category:3.6.2|SYSCLS REQUIRE AUTHENTICATION]]
[[Category:Classifications|SYSCLS REQUIRE AUTHENTICATION]]

Settings

2022-04-14T13:09:59Z

BLE: /* Location */

=Android=

Settings list provides a list of all the settings that control the client environment, giving the user the possibility to display and configure these settings. The settings are ordered according to theme, the part of environment it's responsible for controlling. Within each theme the settings are sorted alphabetically. Mandatory settings are indicated with a {{key press|*}} next to the name.

== Available settings ==
All users have at least access to all settings statet in [[#List of settings|List of settings]]. Additional settings, namely the [[#AR settings|AR settings]] or [[#Demo settings|Demo settings]] are only available if the regarding plugin is part of the application built. {{Tip/Version|Since version 2.5.0 the former system of global settings and user-specific settings has been replaced by user-specific settings only.}}

=== List of settings ===

The basic stock of settings includes:

{| class="wikitable" | width = "75%"
|-
! Name!! Purpose
|-
| ''AuthServerName''|| The name of the server to connect to for user authentication
|-
| ''AuthPortNumber''|| The port number to use when connecting to the authentication server (optional)
|-
| ''AuthProtocol''|| The protocol to use for authentication over the Internet (e.g.: HTTPS). {{Version/AndroidSince|2.4.2}}
|-
| ''UBIKAuthContentService''|| The name of the UBIK authentication service
|-
| ''MemoryUsage''|| Whether {{UBIK}} should [[Memory Usage (Android)|lazy load]] or [[Memory Usage (Android)|eager load]] all the content. {{Version/AndroidSince|2.4.0}}
|-
| ''Protocol''|| The protocol to use for data communication over the Internet (e.g.: HTTPS)
|-
| ''PortNumber''|| The port number to use when connecting to the content server (optional)
|-
| ''PriorityThreshold''|| Any property with a priority number greater than this integer setting value is regarded as a high priority property and is highlighted when being displayed
|-
| ''UpdateExpirySeconds''|| The number of seconds one has to wait before the same update will be considered necessary. If an update of certain content has just ended successfully and is requested again within the amount of time configured in this setting, the client simply dismisses the new request. However, this setting does not affect [[Forced Updates in Manual Synchronization Mode]].
|-
| ''SyncMode''|| The possible values are '''Automatic''', '''Manual Commit''' and '''Offline'''. For more details, please refer to [[Sync Mode]].
|-
| ''ShowSystemProperties''|| If set to true, all properties will be displayed; otherwise, only the ones that are marked as [[METACLASSSCOPE#Visibility|visible]].
|-
| ''UBIKContextName''|| The {{UBIK}} [[CONTEXT]] name
|-
| ''UBIKApplicationName''|| The {{UBIK}} [[APPLICATION]] name
|-
| ''UBIKContentService''|| The name of the {{UBIK}} content service
|-
| ''ServerName''|| The name of the server to connect to for fetching content
|-
| ''ExpectSingleSearchResult''|| If checked, single search results will be displayed in the ContentBrowser immediately instead of being shown in the result list. Available since {{Version/Android|2.5.0}}
|-
|}

=== AR settings ===
The AR plugin has additional settings:

{| class="wikitable" | width = "75%"
|-
! Name!! Purpose
|-
| ''CompassOffsetDegrees'' || The offset in degrees to change the magnetic north and therefore the orientation of the device (global setting).
|-
| ''Pose Estimation Systems''|| The different pose estimation systems considered in the [[Location Manager]] can be activated or deactivated with this setting.
|-
| ''SpatialiteDbPath''|| The path to the sqlite database containing the routing graph. It will be looked for on the public internal storage (Google calls that the "Primary External Storage"), which is NOT the SD-card.
|-
| ''StandardMapZoomLevel''|| Specifies the zoom level, which should be applied when using the zoom features of the [[Map_View]].
|-
| ''DefaultMapZoomLocation''|| Specifies the position, which should be zoomed to when opening the [[Map_View]] after login.
|-
| ''ContentDistanceFilterThreshold''|| The threshold in meters up to which billboards are displayed in Augmented Reality activities; also influences the scaling of billboards depending on their distance. {{Version/AndroidSince|2.5.4}}
|-
| ''NFC Scan Result Type''|| Specifies the type of information, which should be extracted from scanned [[RFID tags]]. {{Version/AndroidSince|3.0.0}}
|-
|}

=== Demo settings ===

Additionally, the demo application and its unique user specific settings are listed as follows

{| class="wikitable" | width = "75%"
|-
! Name!! Purpose
|-
| ''NumberPropertyEditor''|| Whether to use the normal keyboard or the [[UBIK Number Pickers]] for editing numeric properties
|-
| ''CurrentAltitude''|| The (mock) altitude in meters to use in Augmented Reality activities, for non-manual locations (e.g. GPS, since the altutide for this is too inaccurate)
|-
| ''AltitudeOffset''|| The offset in meters to add to the current altitude in Augmented Reality activities (used for configuration of the device height)
|-
| ''ContentDistanceFilterThreshold''|| The threshold in meters up to which billboards are displayed in Augmented Reality activities
|-
| ''SupportIntentTarget''|| The actual Uri / Activity class / app package to be opened as an Android intent when the support action is triggered. {{Version/AndroidSince|2.5.2}}
|-
| ''SupportIntentType''|| The type of the target (URI/APP_PACKAGE/ACTIVITY_CLASS) to be opened as an Android intent when the support action is triggered. {{Version/AndroidSince|2.5.2}}
|-
|}

== Characteristics of settings ==

Settings have the following characteristics and behavior within the application:
* Available and editable before and after the login.
* Changes done before login are applied to the next user who attempts to login.
** This goes for applying presets as well.
** After applying a preset, changes of settings are also applied.
** The settings defined are not just used by the user as new settings configuration, but are merged with the settings the user already has, and are overriding them.
* Changes after login are saved for the user currently logged in. After logout and new login, they are restored, merged with the settings changed before login if there are some and finally they get applied to the user.
* If a completely new user attempts to login without defining settings before or loading a preset, the default values of the settings as defined for the respective app are used.

== PreSet actions ==

=== Load PreSets ===

The {{key press|Load PreSet}} button can be used to [[HowTo:Load Presets]] onto the settings.

=== Save PreSets ===

The {{key press|Save PreSet}} button that is only available after login, can be used to [[HowTo:Save Settings as Presets]].

= WinX =

There are several categories of settings, each providing a group of configurable options for (a) specific feature(s).

== General ==
This initial section in the Profile description contains some general settings.
{| class="wikitable" | width = "75%"
|-
! Name!! Purpose
|-
| ''AutoBranchSync''|| Denotes whether the automatic branch download below an object will be synchronized automatically or not. It is set to "false" by default.
|-
| ''AutoBranchSyncPeriod''|| Denotes the period for automatic branch synchronization in minutes. Its value is set to "0" by default, when the ''AutoBranchSync'' is set to false. Otherwise it should take an other figure.
|-
| ''BranchDownloadSubLevels''|| Determines how a branch download is performed. If not configured (equals to '''0''' by default), an entire branch is downloaded in one attempt. If set to 1 for example, the 1st level children of the selected root is first analyzed, then sub branch downloads are performed for each of the children. Basically the higher the number, the more "fragmented" the branch download becomes. This usually increases the overall download time, but can be helpful for scenarios like really large branches or unstable networks since it has a better chance of finishing smaller individual downloads.
|-
| ''Customizing''|| Denote your specific folder for XAMLs that depict how the Content is displayed, here. If, by default, the value is set to ''i:nil='''true''''', then the specific XAML folder is denoted by the name of the Profile at the bottom of the Profile Description.
|-
| ''UICompatibilityLevel''|| Determines which UI versions the client app should try to be compatible with. In major version updates, UI redesigns can happen and sometimes old UI components might even be completely removed. For example, the app bars are removed since {{Version/WinXSince|4.0}} (level 400) because their features are embedded into other parts of the new UI. For those who want to stick with the previous UI for a while, this setting just needs to set to a level earlier, e.g. 380.
|-
| ''ExpertMode''|| This boolean field denotes whether the Metadefinitions are loaded whenever the Profile of the App is loaded anew or not. By default the value is set to '''false''', i.e. the Metadefinitions are only loaded when the Application is initialized the first time, or when all data has been purged.
|-
|}

{{Attention|The UICompatibilityLevel setting tells the client app to be compatible to the specified versions of the UI if possible. This doesn't mean all existing UI customizings are still supported in newer versions of the app. In fact, any feature where this setting has an effect will explicitly mention it. Otherwise, you should always check the "XAML Notes" tab of each version's release note page.}}

== Connection ==
This section contains properties to denote the internal connection settings of the App.
{| class="wikitable" | width = "75%"
|-
! Name!! Purpose
|-
|''Application'' || Denotes the name of the Application that will be run, e.g. one could use ''YourApp'' as the name for an Application.
|-
|''AuthenticationPort'' || Denotes the Port used on the Authentication Server. Default values might be: ''443; 777; 888;''
|-
|''AuthenticationProtocol'' || Denotes which Transfer Protocol for Authentication might be used. By default ''https'' is used.
|-
|''AuthenticationServer'' || Denotes the Authentication Server, e.g. ''your.auth-server.net'' could be used.
|-
|''AuthenticationService'' || Denotes the path on the Authentication Server to the Authentication Service File, e.g. the path might be ''YourFolder/YourApp/USAM/USAM.svc''. In this case the User System Authentication Manager (USAM) is used.
|-
|''AuthenticationServiceConfig'' || WSHttpBinding (the default value) or BasicHttpBinding. It should be set according to the [[Configuration_Files/Services.config|webservice configuration]].
|-
|''ConnectionTimeOut'' || Denotes the time in seconds when a web service call is dropped by the app. It's necessary so that the app doesn't wait indefinitely in events such as connection lost. The default value is ''300'' seconds. If you know your individual web service calls will take longer, the value should be increased accordingly.
|-
|''ContentPort'' || Denotes the Port used on the Content Server. Default values might be: ''443; 777; 888;'' Often it is the same port as for the one for the Authentication Server.
|-
|''ContentProtocol'' || Denotes which Transfer Protocol for the Content might be used. By default ''https'' is used.
|-
|''ContentServer'' || Denotes the Content Server, e.g. ''your.content-server.net'' could be used. Could be the same server as the Authentication Server.
|-
|''ContentService'' || Denotes the path on the Content Server to the Content Service File, e.g. the path might be ''YourFolder/YourApp/CONTENT/UBIKContent.svc''. Make sure that the path points to the ''UBIKContent.svc'' file.
|-
| ''ContentServiceConfig''|| WSHttpBinding (the default value) or BasicHttpBinding. It should be set according to the [[Configuration_Files/Services.config|webservice configuration]].
|-
|''Context'' || Denotes the name of the Context, e.g. ''CXT_YourApp_001''. This context is specified inside UBIK and all the different Metadefintions are loaded from it.
|-
|''SignalingServer'' || Denotes the Server for Remote Support.
|-
|''SyncMode'' || Denotes the Synchronization Mode of the Application. Possible Values are: Online, Offline, Auto; by default the SyncMode is set to ''Online''.
|-
|}

== Content ==
These internal content settings control the behaviors and activities of the content data.
{| class="wikitable" | width = "75%"
|-
! Name!! Purpose
|-
|''AutoSaveMode'' || If this boolean field is set ''true'' changed Objects will be saved automatically when users leave the relevant pages. Otherwise, the User will see a save button and be asked to save the changes when leaving the relevant pages.
|-
|''ChildPageChildrenPortion'' || Denotes the Portion of the visible Content Page Area that is split between the Children of an Object and its Properties. Usually the value is between ''0'' and ''100''. By default it is normally set to ''67'', i.e. taking two thirds of the Content Page Area to display Children of a given Object.
|-
|''ChildPagePropertyPortion'' || Denotes the Portion of the visible Content Page Area that is split between the Properties of an Object and its Children . Usually the value is between ''0'' and ''100''. By default it is normally set to ''33'', i. e. taking one third of the Content Page Area to display Properties of a given Object.
|-
|''DetailsPageChildrenPortion'' || Denotes the Portion of the visible Details Page Area that is split between the Children of an Object and its Properties. Usually the value is between ''0'' and ''100''. By default it is normally set to ''67'', i.e. taking two thirds of the Details Page Area to display Children of a given Object.
|-
|''DetailsPagePropertyPortion'' || Denotes the Portion of the visible Details Page Area that is split between the Properties of an Object and its Children . Usually the value is between ''0'' and ''100''. By default it is normally set to ''33'', i. e. taking one third of the Details Page Area to display Properties of a given Object.
|-
|''DocumentInternalMode'' || Denotes whether a Document is truly displayed only inside of the Application, then the boolean field should be set to ''true''. If there should be a preview of the Document available inside the Application only and the Document is to be opened by an external Application, the boolean field should be set to ''false''. By default the field is set to ''false''.
|-
|''DocumentPageChildrenPortion'' || Denotes the Portion of the visible Document Page Area that is split between a Document lying beneath an Object and its Properties. Usually the value is between ''0'' and ''100''. By default it is normally set to ''80'', i.e. taking 80% of the Document Page Area to display a Document connected to a given Object.
|-
|''DocumentPagePropertyPortion'' || Denotes the Portion of the visible Document Page Area that is split between the Properties of an Object and a Document belonging to it . Usually the value is between ''0'' and ''100''. By default it is normally set to ''20'', i. e. taking 20% of the Document Page Area to display Properties of a Document belonging to a given Object.
|-
|''DocumentPagePropertyWidth'' || Denotes the maximum width (in pixels) that Properties of a Document can take when a Document belonging to an Object is displayed. By default the value is ''300 px''.
|-
|''EnableSyncLogging'' || Denotes whether a logging of different events, e.g. loading an object, changing a Property on an Object, etc. should take place. By default this boolean field is set to ''true''.
|-
|''EnableAutoBranchDownload'' || Denotes whether [[Branch_Download#Automatic_Download|auto branch download]] should be allowed. By default this boolean field is set to 'false''.
|-
|''GeoDistanceSorting'' || Denotes whether the Children of an Object should be displayed in a ranking of geographic distance to the Parent Object. By default this boolean field is set ti ''true''.
|-
|''NextLevelClassificationPreload'' || When set to false, provides the possibility to override the effect of [[SYSCLS_PRELOAD_CHILDREN]], namely to prevent the preload. See the link for more details.
|-
| ''PriorityThreshold''|| Any property with a priority number greater than this integer setting value is regarded as a high priority property and is highlighted when being displayed
|-
| ''Update Expiry''|| Determines how long (in seconds) freshly updated content becomes outdated and will be updated again when the user browses to it.
|-
| ''[[Content_Logging#Log_setting|Content Logging'']]|| Determines whether certain content related activities should be recorded as log files.
|-
|}

== Push==
These internal push settings control the behaviors and activities of pushed data. For general information see [[Push Service (Client)|{{UBIK}} Push Service]].
{| class="wikitable" | width = "75%"
|-
! Name!! Purpose
|-
|''ActivatePush'' || This boolean field denotes whether new resp. changed data should be pushed to other clients, which might be running the Application at the same time, or not.
|-
|''PushPollingIntervalSeconds'' || Denotes the interval in seconds for the client to retrieve newly pushed data from the server.
|-
|''PushPort'' || Denotes the Port Number to use when connecting to the Push Server (optional), might be set to the same Port number as the Content Port Number.
|-
|''PushProtocol'' || Denotes which Transfer Protocol for the Push might be used. By default ''https'' is used.
|-
|''PushServer'' || Denotes the Push Server, e.g. ''your.push-server.net'' could be used. Could be the same server as the Content Server.
|-
|''PushService'' || Denotes the path on the Push Server to the Push Service File, e.g. the path might be ''YourFolder/YourApp/PUSH/UBIKPush.svc''. Make sure that the path points to the ''UBIKPush.svc'' file.
|-
|''ShowPushMessage'' || This boolean field denotes whether the User is informed about an occurring Push, or not. By default it is set to ''false''.
|-
|}

== Scan==
These internal scan settings control the behaviors and activities of scanned data.
{| class="wikitable" | width = "75%"
|-
! Name!! Purpose
|-
|''CurrentBarcodeFormats'' || Refers to a Microsoft definition for QR Codes, denoted in [http://schemas.microsoft.com/2003/10/Serialization/Arrays]
|-
|''CurrentOCRProfileIndex'' || Specifies a certain OCR Profile. Yet, in the client in the camera settings you can also specify the OCR Profile.
|-
|''PostProcessRegex'' || If this field is set to ''true'', you can specify how a text based Code has to look like in the client settings.
|-
|''ScanARMarker'' || This boolean field denotes whether an ARMarker can be scanned and will be recognized.
|-
|''ScanCodes'' || This boolean field denotes whether 2D-Codes, e.g. Barcode, QRCode, etc. can be scanned and will be recognized.
|-
|''ScanOCR'' || This boolean field denotes whether an OCRMarker can be scanned and will be recognized.
|-
|''UnlockByScanTimeOut'' || This numeric field denotes whether a normally locked object can be unlocked for changes for a certain amount of time (in seconds).
|-
|''CodesTryInverted'' || This boolean field denotes whether the client should try to scan color inverted 2D codes. The default value is "false".
|-
|}

== Session==
These internal session settings control the behaviors and activities of a session.
{| class="wikitable" | width = "75%"
|-
! Name!! Purpose
|-
|''AlternativeViewMode'' || By default this boolean field is set to ''false''. If set ''true'', it denotes that there is more than one View mode available.
|-
|''ZoomedInMode'' || If this boolean flag is set true, the Children of an Object are shown as Tiles. Otherwise they are shown as List items.
|-
|}

== Final Settings ==
These final settings control the behaviors and activities of a profile.
{| class="wikitable" | width = "75%"
|-
! Name!! Purpose
|-
|''IsFavorite'' || This boolean field denotes whether the Profile will be shown as a favourite on top of a list when there are also other Profiles in the Application client available.
|-
|''LastUsed'' || Contains a Timestamp when this profile was used the last time.
|-
|''MultiUserMode'' || When set to ''false'', {{UBIK}} can only remember a single user per profile and will automatically log that user in when a profile is selected. When set to ''true'', the credential remembering feature becomes unavailable. However, this is no longer relevant {{Version/WinXSince|3.6}} because the new version(s) can remember multiple users per profile.
|-
|''Name'' || This field denotes the name of the Profile. Note: If there is no special folder named in the ''Customizing'' field, then this name here will also be taken to retrieve the XAMLs from the according Folder with the same name.
|-
|''Project'' || This field can name a special project. It might be common to have the carry the same name as the ''Name'' field. Carrying the value ''i:nil=true'' means that ...
|-
|''ShowHiddenSettings'' || By default this boolean field is set to ''false'', i.e. no hidden settings are shown.
|-
|}

== Augmented Reality ==

== Maps ==
These settings control the behaviors of the [[Map View|map]] throughout the app.
{| class="wikitable" | width = "75%"
|-
! Name!! Purpose
|-
| ''Map Type''|| Determines which base map image will be used in the map.
|-
| ''Default Zoom Level''|| Controls how closely zoomed in the map should be whenever it is shown.
|-
|}

== Video ==
{| class="wikitable" | width = "75%"
|-
! Name!! Purpose
|-
| ''Camera Device''|| Specifies which camera to use in the app.
|-
| ''Camera Resolution''|| Specifies which camera resolution to use in the app.
|-
|}
{{Hint|The camera preview window in the settings is hidden when the camera is currently in use in e.g. the POI view or the scan view. However, a user can still change the relevant settings and see the immediate results.}}

== Location ==
{| class="wikitable" | width = "75%"
|-
! Name!! Purpose
|-
| ''Calibration Heading''|| Specifies the heading that is used when manually calibrating the orientation sensor.
|-
| ''Location Mode''|| Specifies the Location Mode.
|-
| ''Use PoseFusion''|| Specifies whether PoseFusion is used or not.
|-
|}

<headertabs/>

[[Category:Client|Settings]]

Location Manager

2022-04-14T13:02:45Z

BLE: /* WinX */

=Android=

The Location Manager aims to calculate the device pose (position and orientation) as accurate as possible using various input sources. The performance of pose estimation can be characterised by the following measures:

* Accuracy --> describes the average offset between real and estimated device pose
* Standard Deviation --> describes to which extend the estimated pose “jumps” around the real device pose
* Update Rate --> describes how often the device pose can be updated.

To maximise the performance, the Location Manager combines and filters estimated poses from various Pose Estimation Systems based on their estimated error levels. Pose Estimation systems can be activated and deactivated using the [[Settings#AR_settings|Pose Estimation Systems Setting]]. Currently the following pose estimation systems are available:

{| class="wikitable" | width = "50%" style="text-align: center;"
|-
! Name !! Estimated Quantity !! Required Sensor Technology
|-
| [[AR-Marker Device Pose Estimation|AR-Marker]] || Position and Orientation || Camera
|-
| [[Beacon Proximity|Beacon Proximity]] || Position || Bluetooth Low Energy (Bluetooth 4.0)
|-
| [[Compass|Compass]] || Orientation || Accelerometer and Magnetometer
|-
| [[GPS|GPS]] || Position || GPS Sensor
|-
| [[Gyroscope|Gyroscope]] || Orientation|| Gyroscope Sensor
|-
| [[Object Proximity Positioning|Object Proximity]] || Position || none
|-
| [[Step Detector|Step Detector]] || Position || Step Detector Sensor
|-
| [[Routing-Graph Snapping|Routing-Graph Snapping]] || Position || none
|}

Besides the stated systems, the user can utilize the position of GEO-Objects by clicking the {{key press|Use Location}} button in the [[UBIK Client Basics#Context Menu|Context Menu]]. Pose estimation is started once the device pose is requested by another part of the application (e.g. [[POI_View|POI View]], [[Map_View|Map View]], [[UBIK_Client_Basics#Content Browser|Content Browser]]). If the specific device does not possess the required sensor technology of an active pose estimation system, a notification is shown.

== Working Principle ==

Internally the Location Managers uses an Extended Kalman Filter to combine and filter pose estimation systems, based on their probabilistic error levels. Each Pose Estimation System is therefore associated with a variance level (squared standard deviation), describing the expected uncertainty. Precise systems, such as [[AR-Marker]], are associated with a lower variance than inaccurate systems such as [[GPS]].

The Kalman Filter keeps track of the current device pose (= best estimate) and the associated uncerctainty. The operation is subdivided into two stages: Prediction and Correction.
In the Prediction stage, the next pose (in time) is estimated using the [[Step Detector]] and [[Gyroscope]] Pose Estimation System. At this stage the uncertainty of the current device pose is increased, based on the elapsed time. If no [[Gyroscope]] or [[Step Detector]] is available only the uncertainty is increased.
As soon as a measurement from other Pose Estimation Systems is received, the current device pose is combined with the measured pose, based on their probabilistic error levels. The combined pose then serves again as the basement for the next prediction.
Consequently the Kalman Filter not only combines various Pose Estimation Systems based on their expected performance, but also accounts for the elapsed time between updates, reflecting the behavior of human walk.

[[File:EKF.png|700 px|center|thumb|alt=Extended Kalman Filter|Extended Kalman Filter]]

[[Category:Android|Location Manager]]
[[Category:WinX|Location Manager]]

== Best Practices ==
[[AR-Marker]] and [[Gyroscope]] are the most precise pose estimation systems. Thus it is adviced to activate them in any case. Especially in the proximity of POIs [[AR-Marker]] should be deployed, to provide a good AR-experience. Furthermore it is recommended to activate the [[Step Detector]] in scenarios, where the mobile device points into walking direction (i.e. the operator is not expected to walk sideward).
In indoor environments and environments with strong magnetic fields the [[Compass]] and [[GPS]] Pose Estimation Systems should be deactivated. [[Routing-Graph Snapping]] should only be activated and configured where the user is in the proximity of the graph (e.g. on corridors).

[[Category:Android|Location Manager]]
[[Category:WinX|Location Manager]]

=WinX=
The Location Manager controls the different positioning services that are available for mobile devices.

== PoseFusion ==
There is a toggle for using the Posefusion functionality.

== Possible Positioning Modes ==
There are three different modes available for the Location Manager. The names and defined behaviors of the three modes are:

{| class="wikitable sortable"
|-
! style="width:150px" | Mode !! style="width:100px" | [[GPS]] !! style="width:100px | [[Object Proximity Positioning|LLA]] !! style="width:100px | [[Beacon Proximity]]
|-
| USE_ALL || class="centeredCell" | {{bullet_full}} || class="centeredCell" | {{bullet_full}} || class="centeredCell" | {{bullet_empty}}
|-
| LLA_ONLY_MODE || class="centeredCell" | {{bullet_empty}} || class="centeredCell" | {{bullet_full}} || class="centeredCell" | {{bullet_empty}}
|-
| BEACON_PROXIMITY_MODE || class="centeredCell" | {{bullet_empty}} || class="centeredCell" | {{bullet_full}} || class="centeredCell" | {{bullet_full}}
|}

<headertabs/>
{{Clear}}

[[Category:Android|Location Manager]]
[[Category:WinX|Location Manager]]

Location Manager

2022-04-13T12:59:51Z

BLE: /* Possible Positioning Modes */

=Android=

The Location Manager aims to calculate the device pose (position and orientation) as accurate as possible using various input sources. The performance of pose estimation can be characterised by the following measures:

* Accuracy --> describes the average offset between real and estimated device pose
* Standard Deviation --> describes to which extend the estimated pose “jumps” around the real device pose
* Update Rate --> describes how often the device pose can be updated.

To maximise the performance, the Location Manager combines and filters estimated poses from various Pose Estimation Systems based on their estimated error levels. Pose Estimation systems can be activated and deactivated using the [[Settings#AR_settings|Pose Estimation Systems Setting]]. Currently the following pose estimation systems are available:

{| class="wikitable" | width = "50%" style="text-align: center;"
|-
! Name !! Estimated Quantity !! Required Sensor Technology
|-
| [[AR-Marker Device Pose Estimation|AR-Marker]] || Position and Orientation || Camera
|-
| [[Beacon Proximity|Beacon Proximity]] || Position || Bluetooth Low Energy (Bluetooth 4.0)
|-
| [[Compass|Compass]] || Orientation || Accelerometer and Magnetometer
|-
| [[GPS|GPS]] || Position || GPS Sensor
|-
| [[Gyroscope|Gyroscope]] || Orientation|| Gyroscope Sensor
|-
| [[Object Proximity Positioning|Object Proximity]] || Position || none
|-
| [[Step Detector|Step Detector]] || Position || Step Detector Sensor
|-
| [[Routing-Graph Snapping|Routing-Graph Snapping]] || Position || none
|}

Besides the stated systems, the user can utilize the position of GEO-Objects by clicking the {{key press|Use Location}} button in the [[UBIK Client Basics#Context Menu|Context Menu]]. Pose estimation is started once the device pose is requested by another part of the application (e.g. [[POI_View|POI View]], [[Map_View|Map View]], [[UBIK_Client_Basics#Content Browser|Content Browser]]). If the specific device does not possess the required sensor technology of an active pose estimation system, a notification is shown.

== Working Principle ==

Internally the Location Managers uses an Extended Kalman Filter to combine and filter pose estimation systems, based on their probabilistic error levels. Each Pose Estimation System is therefore associated with a variance level (squared standard deviation), describing the expected uncertainty. Precise systems, such as [[AR-Marker]], are associated with a lower variance than inaccurate systems such as [[GPS]].

The Kalman Filter keeps track of the current device pose (= best estimate) and the associated uncerctainty. The operation is subdivided into two stages: Prediction and Correction.
In the Prediction stage, the next pose (in time) is estimated using the [[Step Detector]] and [[Gyroscope]] Pose Estimation System. At this stage the uncertainty of the current device pose is increased, based on the elapsed time. If no [[Gyroscope]] or [[Step Detector]] is available only the uncertainty is increased.
As soon as a measurement from other Pose Estimation Systems is received, the current device pose is combined with the measured pose, based on their probabilistic error levels. The combined pose then serves again as the basement for the next prediction.
Consequently the Kalman Filter not only combines various Pose Estimation Systems based on their expected performance, but also accounts for the elapsed time between updates, reflecting the behavior of human walk.

[[File:EKF.png|700 px|center|thumb|alt=Extended Kalman Filter|Extended Kalman Filter]]

[[Category:Android|Location Manager]]
[[Category:WinX|Location Manager]]

== Best Practices ==
[[AR-Marker]] and [[Gyroscope]] are the most precise pose estimation systems. Thus it is adviced to activate them in any case. Especially in the proximity of POIs [[AR-Marker]] should be deployed, to provide a good AR-experience. Furthermore it is recommended to activate the [[Step Detector]] in scenarios, where the mobile device points into walking direction (i.e. the operator is not expected to walk sideward).
In indoor environments and environments with strong magnetic fields the [[Compass]] and [[GPS]] Pose Estimation Systems should be deactivated. [[Routing-Graph Snapping]] should only be activated and configured where the user is in the proximity of the graph (e.g. on corridors).

[[Category:Android|Location Manager]]
[[Category:WinX|Location Manager]]

=WinX=
The Location Manager controlls the different positioning services that are available for mobile devices.

== Possible Positioning Modes ==
There are three different modes available for the Location Manager. Additionally there is a Toggle for using the Posefusion functionality.
The names and defined behaviors of the three modes are:

{| class="wikitable sortable"
|-
! style="width:150px" | Mode !! style="width:100px" | [[GPS]] !! style="width:100px | [[Object Proximity Positioning|LLA]] !! style="width:100px | [[Beacon Proximity]]
|-
| USE_ALL || class="centeredCell" | {{bullet_full}} || class="centeredCell" | {{bullet_full}} || class="centeredCell" | {{bullet_empty}}
|-
| LLA_ONLY_MODE || class="centeredCell" | {{bullet_empty}} || class="centeredCell" | {{bullet_full}} || class="centeredCell" | {{bullet_empty}}
|-
| BEACON_PROXIMITY_MODE || class="centeredCell" | {{bullet_empty}} || class="centeredCell" | {{bullet_full}} || class="centeredCell" | {{bullet_full}}
|}

<headertabs/>
{{Clear}}

[[Category:Android|Location Manager]]
[[Category:WinX|Location Manager]]

Version 4.1 (Xamarin)

2022-02-21T15:23:20Z

BLE: /* 4.0.? on 2021-??-?? {{key press|App Center}} */

= Release Notes =

== Release ==

== Beta ==

== Preview ==

=== 4.0.? on 2022-??-?? {{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.

[[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]]

== 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.
* Under namespace UBIK.CPL.Converters, a new "StringToDateTimeTypesConverter" was added. It should be used when binding to a Date/Time Property on a PropertyViewModel.

[[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]]

=== 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]]

Version 4.0 (WinX)

2022-02-21T15:21:00Z

BLE: /* 4.0.? on 2021-??-?? {{key press|DevOps}} */

= Release Notes =

== Release ==

== Beta ==

== Preview ==

=== 4.0.? on 2022-??-?? {{key press|DevOps}} ===
* The app's default profile is now only generated during app startup when no other profiles are detected.
* Added a button in the developer mode to unpack and get all default XAML resources.
* 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.
* Moved some properties from GlobalStatusBarViewModel to AppStatusViewModel.
* The develop mode now also applies to the open dialog.
* Fixed an issue where the app can get into an invalid state if a user manages to browse to e.g. the root object page during a logout process.
* Improved the app performance when deleting large amount of data (which happens when e.g. evaluating online queries).
* Most features in the old app's top & bottom bars can now be used in customized UI. See [[Version_4.0_(WinX)#App_bars|XAML Notes - App bars]].
* 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.
* Fixed some misbehaviors in the signature editor. For example, the signing isn't properly disabled after the countdown ends when a stroke is not yet finished.

[[Category:Client|Version 4.0 (WinX)]]
[[Category:Version 4.0|Version 4.0 (WinX)]]
[[Category:WinX|Version 4.0 (WinX)]]

== Known issues ==

= XAML Notes =
 
It is highly recommended to start new UI customizings based on the default resources in {{UBIK}} 4. [[Developer_Mode#Features|Here]] is how you can get them from the app. Some major changes are listed below, please see every item for detailed information and whether your existing customizings will still work.

== Obsolete resources ==
Some of the UI resources from the older versions no longer exist or are not used anymore.

=== Converters ===
* PropertyItemToValueConverter is removed since it was not used at all. (This should not be used in any XAML customizings, If it is, please consider using alternatives or contact us.)
* StringToDateTimeTypesConverter was added. It should be used when Binding to a Date/Time property on a PropertyViewModel.

[[Category:Client|Version 4.0 (WinX)]]
[[Category:Version 4.0|Version 4.0 (WinX)]]
[[Category:WinX|Version 4.0 (WinX)]]

=== App bars ===
These are the top and bottom bars that you bring out by mouse right clicks. The various buttons in them are now included in other parts of the new UI, meaning the bars are now unnecessary and no longer displayed. The custom templates used in these bars include the following.
* UBIKChildAction;
* UBIKPageAction.
For those who still want to use the old UI with these bars, [[Settings#General|UICompatibilityLevel]] should be set to lower than 400 in the profile.

=== Child templates in UBIKGlobalStatusBar and UBIKGlobalBottomBar ===
The UBIKGlobalStatusBar and the UBIKGlobalBottomBar are redesigned and no longer use the following child templates.
* UBIKTopLeft;
* UBIKTopCenter;
* UBIKTopRight;
* UBIKBottomLeft;
* UBIKBottomRight.
This means such existing child templates in your project setups will not have any effect in {{UBIK}} 4, unless you still have the two parent/container templates customized where they are explicitly referenced.

== 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.

=== UBIKChildPageAction ===
* The Visibility of <AppBarButton x:Name="SaveButton" ... /> now adjusts according to setting "Content -> enable auto save mode". Nothing will be broken if your existing XAMLs are not updated. However, the saving behavior might not match what's described in [[Settings#Content|Content -> AutoSaveMode]].

=== UBIKPropertyArea/UBIKContentArea ===
* The ItemsSource and property count now use the result of an [[EvalExpression]]. Mass editing will no longer work or the count will be incorrect if not updated;
* 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.

=== UBIKPropertyItem/UBIKPriorityPropertyItem ===
* PriorityPropertyClickedCommand/PriorityPropertyRightClickedCommand are deleted since they are the same as PropertyClickedCommand/PropertyRightClickedCommand. You should use the latter instead;
* Removed "Content.", "OwnerModel." from bindings.

=== UBIKGlobalStatusBar ===
Some properties are moved from GlobalStatusBarViewModel to AppStatusViewModel.
* "{Binding ProgressIndicator, ...}" is changed to "{Binding AppStatus.ProgressIndicator, ...}"
* "{Binding LoginState, ...}" is changed to "{Binding AppStatus.LoginState, ...}"
* "{Binding WritingToDB, ....]" is changed to "{Binding AppStatus.WritingToDB, ...}"
* "{Binding TaskCount, ....]" is changed to "{Binding AppStatus.TaskCount, ...}"

=== UBIKPropertyValueRecordDialog ===
* Changed from "PropertyItem" to "PropertyViewModel" in bindings.

=== 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.}}

First of all for UBIKEditDateTime, UBIKEditDouble, UBIKEditInt, UBIKEditGuid, UBIKEditChart, UBIKEditGeo, UBIKEditBool, UBIKEditString.
* Changed from "EditDialogViewModel.PropertyItem" to "PropertyViewModel" in bindings;
* Changed from "EditDialogViewModel" to "PropertyViewModel" in bindings;
* Changed from "EditDialogViewModel.DeletePressedCommand" to "PropertyViewModel.DeleteValueCommand" in a binding; (UBIKEditGuid)
* Prefixed "EditDialogViewModel" with "PropertyViewModel." in the binding of <Button x:Name="TeachInButton" />; (UBIKEditGeo)
* UBIKEditString was renamed from UBIKEdit.
* UBIKEditDateTime now needs the StringToDateTimeTypesConverter when Binding to a value on a PropertyViewModel.

Then for UBIKEditDialogButtons, UBIKEditDialogHeader, UBIKEditDialogNACheck.
* Changed from "PropertyItem.Content.DisplayStrings" to "PropertyViewModel.OwnerObject.DisplayStrings" in bindings; (UBIKEditDialogHeader)
* Changed from "PropertyItem" to "PropertyViewModel" in bindings;
* Prefixed bindings "EnableNAOption", "NotApplicable", "ValueDefinitions", "ValueDefinition", "EnableMultiValueEditing" & "CanExecuteConfirmEditCommand" with "PropertyViewModel.".

<headertabs />

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

[[Category:Client|Version 4.0 (WinX)]]
[[Category:Version 4.0|Version 4.0 (WinX)]]
[[Category:WinX|Version 4.0 (WinX)]]

Converters In Mobile

2022-02-21T12:26:13Z

BLE: /* List of Available Converters */

:''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. 
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. 
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[ ], Byte Stream || ||
Converts a '''byte stream''' value into an '''image source'''.
|-
| ChildAreaTemplateConverter || style="text-align: center;" | ✗ || ChildAreaTemplate || ContentViewModel || ||
Returns a '''ChildAreaTemplate''' from a '''ContentViewModel''' or ''null'' if the ViewModel cannot be interpreted.
|-
| ChildItemSelectionModeToSfListViewSelectionModeConverter || style="text-align: center;" | ✓ || [https://help.syncfusion.com/cr/cref_files/xamarin/Syncfusion.SfListView.XForms~Syncfusion.ListView.XForms.SfListView~SelectionMode.html ListViewSelectionMode] || ChildItemSelectionMode || ||
Converts a '''ChildItemSelectionMode''' to a Syncfusion '''[https://help.syncfusion.com/cr/cref_files/xamarin/Syncfusion.SfListView.XForms~Syncfusion.ListView.XForms.SfListView~SelectionMode.html ListViewSelectionMode]'''. 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, Guid, 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, Guid, 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, String || Object, String ||
Returns ''true'' if the given value and parameter are '''equal to each other''', ''false'' otherwise.
|-
| EqualityToInvertedBoolConverter || style="text-align: center;" | ✗ || Boolean || Object, String || Object, 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 ListSelectionChangedEventArgs] || [https://help.syncfusion.com/cr/cref_files/xamarin/Syncfusion.SfListView.XForms~Syncfusion.ListView.XForms.ItemSelectionChangedEventArgs.html ItemSelectionChangedEventArgs] || ||
Converts an Syncfusion '''[https://help.syncfusion.com/cr/cref_files/xamarin/Syncfusion.SfListView.XForms~Syncfusion.ListView.XForms.ItemSelectionChangedEventArgs.html ItemSelectionChangedEventArgs]''' to a '''[https://docs.microsoft.com/en-us/dotnet/api/system.windows.controls.selectionchangedeventargs ListSelectionChangedEventArgs]'''. 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. 
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). 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, String|| ||
''Null'' or an '''empty string''' value get converted to ''true'', and everything else to ''false''.
|-
| NullToInvertedBoolConverter || style="text-align: center;" | ✓ || Boolean || Object, 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, 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, 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, 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, String, Integer, Double, DateTime, Guid, FileReferenceData, GeoData, Object || Boolean, String, Integer, Double, DateTime, Guid, FileReferenceData, GeoData, 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]''. 
'''This converter is obsolete!''' 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]. 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. 
'''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! 
You might still want to use the ''StringFormatConverter'' in rare cases, though!
|-
| ToStringFormatConverter || style="text-align: center;" | ✗ || String || Double, Float, Integer, DateTime, 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). 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.
|-
| ToTypeConverter || style="text-align: center;" | ✗ || Object || Object || String || Attempts to convert value to the Type specified in parameter, returning the value.
|-
| 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 ''TypeNameToBoolConverter''.
|-
| DataTemplateItemTemplateSelectorConverter || style="text-align: center;" | ✗ || ChildItemTemplateSelector || String || String || Chooses what '''ChildItemTemplateSelector''' to return. Having a parameter with the content "Small" returns the small item template selector.
|-
| DataTemplateItemsPanelConverter || style="text-align: center;" | ✗ || ItemsPanelTemplate || QueryDetailsPageViewModel || || Chooses what '''ItemPanelTemplate''' 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]]

Version 3.6 (Server)

2022-02-21T09:10:27Z

BLE:

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

= 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 anymore.
* {{UBIK}} supports Shape files 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 independent 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 detailed 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 anymore.
* {{UBIK}} supports clients working with and sending data from different time zones
** A database setting gives the possibility to configure the timezone data - 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 log in using Windows or iOS)
* Extended the {{UBIK}} [[OSIPI_(Plugin)|OSIPI Plugin]] to be able to read data from the [https://docs.osisoft.com/bundle/ocs/page/ocs-content-portal-overview.html OSIsoft Cloud Services (OCS)].
* There is a new customizable event "OnBeforeRevertUnsavedChanges" which is triggered just before unsaved changes of one object get reverted
* UBIK Interface management provides a possibility to schedule the execution of an interface task now
* {{UBIK}} supports to change the type (MetaClass) of an instance event if it was already created. This provides a full set of new possibilities for the customizing as well as being able to react on new/changed project requirements
** The mechanism to convert the type of one instance is used when importing proxies via the new member (FindOrPrepareProxy) on the Proxymanager.
* {{UBIK}} now provides [[ServiceLogins]], a solution for managing service credentials to third-party systems easily and securely.
* [[HowTo:Configure_Dynamic_Selective_Lists|Dynamic Selective Lists]]
* {{UBIK}} supports to configure the min and max length of string properties now (https://wiki.augmensys.com/index.php?title=MetaProperty#Text_2).

=== 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 with 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 anymore.
* 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 correctly now
* A potential problem occuring during the start of UBIK.Studio was fixed
* The object replication feature supports the enabled - property feature now.
* The processing of Command Files on the Enterprise Server was improved and runs less error prone

=== 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 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 Excel Module provides workflow activities to import data from MS Excel files.
* UBIK Clients terminate their tokens when logging out now (erroneous SessionManagement).
* The UBIK OLEDB Module now always uses the provider MSOLEDBSQL, instead of the deprecated SQLOLEDB.
* The relation replication feature provides the possibility to configure (using customizing code) for every single Relation Item whether it should be replicated or not.
* TLS 1.2 is now supported by the Web Services automatically, provided that .NET Framework 4.6.1 is installed on the server.
* A set of new Custom - Metaclasses are provided via the database update now:
** CustomAbstractScopeMetaClass
** CustomDocumentReplicationConfigurationMetaClass
** CustomInstanceReplicationConfigurationMetaClass
** CustomMetaQueryScopeMetaClass
** CustomMetaQueryViewItemMetaClass
** CustomRelationReplicationConfigurationMetaClass
** CustomReplicationConfigurationMetaClass

= Build History Web Service =
* 3.6.0 Build 13704 on 2022.01.18
** Initial release.
* 3.6.0 Build 13820 on 2022.02.18
** A problem in Property.DisplayValue was fixed
** A problem when preloading of RelationViewItems (View Cache) is solved now

= Build History UBIK.Studio =
* 3.6.0 Build 13704 on 2022.01.18
** Initial release.
* 3.6.0 Build 13820 on 2022.02.18
** A problem in Property.DisplayValue was fixed
** A problem when preloading of RelationViewItems (View Cache) is solved now
** Importing of dead Links via the Interface Execution could lead to crashes. This problem is solved now.
** The Proxy property UBIK_UID Property is filled after updating to 3.6.0 now
** The orphaned Relation MetaClass "SYSREL_ADMINRIGHTS" gets deleted when updating to 3.6.0 now

= Build History UBIK.Plugins =
* 3.6.0 Build 13704 on 2022.01.18
** Initial release.

<headertabs />

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

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

Version 3.6 (Server)

2022-02-21T08:45:46Z

BLE: /* New features */

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

= 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 anymore.
* {{UBIK}} supports Shape files 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 independent 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 detailed 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 anymore.
* {{UBIK}} supports clients working with and sending data from different time zones
** A database setting gives the possibility to configure the timezone data - 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 log in using Windows or iOS)
* Extended the {{UBIK}} [[OSIPI_(Plugin)|OSIPI Plugin]] to be able to read data from the [https://docs.osisoft.com/bundle/ocs/page/ocs-content-portal-overview.html OSIsoft Cloud Services (OCS)].
* There is a new customizable event "OnBeforeRevertUnsavedChanges" which is triggered just before unsaved changes of one object get reverted
* UBIK Interface management provdies a possibility to schedule the execution of an interface task now
* {{UBIK}} supports to the change the type (MetaClass) of an instance event if it was already created. This provides a full set of new possibilities for the customizing as well as being able to react on new/changed project requirements
** The mechanism to convert the type of one instance is used when importing proxies via the new member (FindOrPrepareProxy) on the Proxymanager.
* {{UBIK}} now provides [[ServiceLogins]], a solution for managing service credentials to third-party systems easily and securely.
* [[HowTo:Configure_Dynamic_Selective_Lists|Dynamic Selective Lists]]
* {{UBIK}} supports to configure the min and max length of string properties now (https://wiki.augmensys.com/index.php?title=MetaProperty#Text_2).

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

=== 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 with 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 anymore.
* 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 correctly now
* A potential problem occuring during the start UBIK.Studio was fixed
* The object replication feature supports the enabled - property feature now.
* The processing of Command Files on the Enterprise Server was improved and runs less error prone

=== 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 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 Excel Module provides workflow activities to import data from MS Excel files.
* UBIK Clients terminate their tokens when logging out now (erroneous SessionManagement).
* The UBIK OLEDB Module now always uses the provider MSOLEDBSQL, instead of the deprecated SQLOLEDB.
* The relation replication feature provdies the possibility to configure (using customizing code) for every single Relation Item whether it should be replicated or not.
* TLS 1.2 is now supported by the Web Services automatically, provided that .NET Framework 4.6.1 is installed on the server.
* A set of new Custom - Metaclasses are provided via the database update now:
** CustomAbstractScopeMetaClass
** CustomDocumentReplicationConfigurationMetaClass
** CustomInstanceReplicationConfigurationMetaClass
** CustomMetaQueryScopeMetaClass
** CustomMetaQueryViewItemMetaClass
** CustomRelationReplicationConfigurationMetaClass
** CustomReplicationConfigurationMetaClass

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

= Build History Web Service =
* 3.6.0 Build 13704 on 2022.01.18
** Initial release.
* 3.6.0 Build 13820 on 2022.02.18
** A problem in Property.DisplayValue was fixed
** A problem when preloading of RelationViewItems (View Cache) is solved now

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

= Build History UBIK.Studio =
* 3.6.0 Build 13704 on 2022.01.18
** Initial release.
* 3.6.0 Build 13820 on 2022.02.18
** A problem in Property.DisplayValue was fixed
** A problem when preloading of RelationViewItems (View Cache) is solved now
** Importing of dead Links via the Interface Execution could lead to crashes. This problem is solved now.
** The Proxy property UBIK_UID Property is filled after updating to 3.6.0 now
** The orphaned Relation MetaClass "SYSREL_ADMINRIGHTS" gets deleted when updating to 3.6.0 now

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

= Build History UBIK.Plugins =
* 3.6.0 Build 13704 on 2022.01.18
** Initial release.

<headertabs />

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

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

Version 4.0 (WinX)

2022-02-16T08:54:41Z

BLE: /* Editor related templates */

= Release Notes =

== Release ==

== Beta ==

== Preview ==

=== 4.0.? on 2021-??-?? {{key press|DevOps}} ===
* The app's default profile is now only generated during app startup when no other profiles are detected.
* Added a button in the developer mode to unpack and get all default XAML resources.
* 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.
* Moved some properties from GlobalStatusBarViewModel to AppStatusViewModel.
* The develop mode now also applies to the open dialog.
* Fixed an issue where the app can get into an invalid state if a user manages to browse to e.g. the root object page during a logout process.
* Improved the app performance when deleting large amount of data (which happens when e.g. evaluating online queries).
* Most features in the old app's top & bottom bars can now be used in customized UI. See [[Version_4.0_(WinX)#App_bars|XAML Notes - App bars]].
* 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.
* Fixed some misbehaviors in the signature editor. For example, the signing isn't properly disabled after the countdown ends when a stroke is not yet finished.

== Known issues ==

= XAML Notes =
 
It is highly recommended to start new UI customizings based on the default resources in {{UBIK}} 4. [[Developer_Mode#Features|Here]] is how you can get them from the app. Some major changes are listed below, please see every item for detailed information and whether your existing customizings will still work.

== Obsolete resources ==
Some of the UI resources from the older versions no longer exist or are not used anymore.

=== Converters ===
* PropertyItemToValueConverter is removed since it was not used at all. (This should not be used in any XAML customizings, If it is, please consider using alternatives or contact us.)
* StringToDateTimeTypesConverter was added. It should be used when Binding to a Date/Time property on a PropertyViewModel.

[[Category:Client|Version 4.0 (WinX)]]
[[Category:Version 4.0|Version 4.0 (WinX)]]
[[Category:WinX|Version 4.0 (WinX)]]

=== App bars ===
These are the top and bottom bars that you bring out by mouse right clicks. The various buttons in them are now included in other parts of the new UI, meaning the bars are now unnecessary and no longer displayed. The custom templates used in these bars include the following.
* UBIKChildAction;
* UBIKPageAction.
For those who still want to use the old UI with these bars, [[Settings#General|UICompatibilityLevel]] should be set to lower than 400 in the profile.

=== Child templates in UBIKGlobalStatusBar and UBIKGlobalBottomBar ===
The UBIKGlobalStatusBar and the UBIKGlobalBottomBar are redesigned and no longer use the following child templates.
* UBIKTopLeft;
* UBIKTopCenter;
* UBIKTopRight;
* UBIKBottomLeft;
* UBIKBottomRight.
This means such existing child templates in your project setups will not have any effect in {{UBIK}} 4, unless you still have the two parent/container templates customized where they are explicitly referenced.

== 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.

=== UBIKChildPageAction ===
* The Visibility of <AppBarButton x:Name="SaveButton" ... /> now adjusts according to setting "Content -> enable auto save mode". Nothing will be broken if your existing XAMLs are not updated. However, the saving behavior might not match what's described in [[Settings#Content|Content -> AutoSaveMode]].

=== UBIKPropertyArea/UBIKContentArea ===
* The ItemsSource and property count now use the result of an [[EvalExpression]]. Mass editing will no longer work or the count will be incorrect if not updated;
* 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.

=== UBIKPropertyItem/UBIKPriorityPropertyItem ===
* PriorityPropertyClickedCommand/PriorityPropertyRightClickedCommand are deleted since they are the same as PropertyClickedCommand/PropertyRightClickedCommand. You should use the latter instead;
* Removed "Content.", "OwnerModel." from bindings.

=== UBIKGlobalStatusBar ===
Some properties are moved from GlobalStatusBarViewModel to AppStatusViewModel.
* "{Binding ProgressIndicator, ...}" is changed to "{Binding AppStatus.ProgressIndicator, ...}"
* "{Binding LoginState, ...}" is changed to "{Binding AppStatus.LoginState, ...}"
* "{Binding WritingToDB, ....]" is changed to "{Binding AppStatus.WritingToDB, ...}"
* "{Binding TaskCount, ....]" is changed to "{Binding AppStatus.TaskCount, ...}"

=== UBIKPropertyValueRecordDialog ===
* Changed from "PropertyItem" to "PropertyViewModel" in bindings.

=== 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.}}

First of all for UBIKEditDateTime, UBIKEditDouble, UBIKEditInt, UBIKEditGuid, UBIKEditChart, UBIKEditGeo, UBIKEditBool, UBIKEditString.
* Changed from "EditDialogViewModel.PropertyItem" to "PropertyViewModel" in bindings;
* Changed from "EditDialogViewModel" to "PropertyViewModel" in bindings;
* Changed from "EditDialogViewModel.DeletePressedCommand" to "PropertyViewModel.DeleteValueCommand" in a binding; (UBIKEditGuid)
* Prefixed "EditDialogViewModel" with "PropertyViewModel." in the binding of <Button x:Name="TeachInButton" />; (UBIKEditGeo)
* UBIKEditString was renamed from UBIKEdit.
* UBIKEditDateTime now needs the StringToDateTimeTypesConverter when Binding to a value on a PropertyViewModel.

Then for UBIKEditDialogButtons, UBIKEditDialogHeader, UBIKEditDialogNACheck.
* Changed from "PropertyItem.Content.DisplayStrings" to "PropertyViewModel.OwnerObject.DisplayStrings" in bindings; (UBIKEditDialogHeader)
* Changed from "PropertyItem" to "PropertyViewModel" in bindings;
* Prefixed bindings "EnableNAOption", "NotApplicable", "ValueDefinitions", "ValueDefinition", "EnableMultiValueEditing" & "CanExecuteConfirmEditCommand" with "PropertyViewModel.".

<headertabs />

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

[[Category:Client|Version 4.0 (WinX)]]
[[Category:Version 4.0|Version 4.0 (WinX)]]
[[Category:WinX|Version 4.0 (WinX)]]

Version 4.0 (WinX)

BLE: /* Supported property types */

== Overview ==
Property direct editing (also known as inline editing) aims to provide a more efficient way for users to edit properties, especially when such tasks are performed frequently.

Generally speaking, direct editing skips the additional dialogs or pages presented in regular editing and allows users to directly interact with the UI displaying properties. For example, a text box type of control can be used to both display the value of a property and accept modifications of the value from the user.

== Supported property types ==
In {{UBIK}}, we provide default templates for some most frequently used property types. However, you can use your own templates, controls, etc. as you like to deal with these property types or even more (as long as you can find suitable UI controls for dealing with these types).
<tabs>
<tab name="UWP">
They are accessible as DataTemplates from UBIKThemes.xaml (use the [[Developer_Mode]] to find the default copy) and the syntax in XAML is <code>{StaticResource TEMPLATE_NAME}</code>. Just like other such templates, they can be customized by overriding the DataTemplates with respective keys in UBIKThemes.xaml.
</tab>

<tab name="Xamarin">
They are accessible as DataTemplates from UBIKThemes.xamlx and the syntax in XAML is <code>{DynamicResource TEMPLATE_NAME}</code>. Just like such templates, they can be customized by providing your own DataTemplate resources (with the keys of TEMPLATE_NAME) in UBIKThemes.xamlx.
</tab>
</tabs>

=== For Properties: ===
* String/Text: named as UBIKPropertyDirectItemString.
* Integer: named as UBIKPropertyDirectItemInt.
* Double: named as UBIKPropertyDirectItemDouble.
* Boolean: named as UBIKPropertyDirectItemBool.
* Guid: named as UBIKPropertyDirectItemGuid.
* DateTime: named as UBIKPropertyDirectItemDateTime.
* GeoData: named as UBIKPropertyDirectItemGeoData.
* With selective list items: named as UBIKPropertyDirectItemList.

=== For MRO-Tasks: ===
* String/Text: named as UBIKTaskPropertyString.
* Integer: named as UBIKTaskPropertyInt.
* Double: named as UBIKTaskPropertyDouble.
* Boolean: named as UBIKTaskPropertyBool.
* Guid: named as UBIKTaskPropertyGuid.
* DateTime: named as UBIKTaskPropertyDateTime.
* GeoData: named as UBIKTaskPropertyGeoData.
* With selective list items: named as UBIKTaskPropertyList.

[[Category:Client|Property Direct Edit (Client)]]
[[Category:Version 4.0|Property Direct Edit (Client)]]
[[Category:WinX|Property Direct Edit (Client)]]
[[Category:Xamarin|Property Direct Edit (Client)]]

== PropertyViewModel ==
This is the view model for every single {{UBIK}} property and also the basement for property direct editing (and regular editing alike). For example, a certain named PropertyViewModel (with the name of PROPERTY_NAME) of the context object in a content page is accessible as <code>{Binding Properties.VisibleItems[PROPERTY_NAME]}</code>.

[[File:UBIK_Xamarin_UI_Template_PropertyDirectItemString_Debug_NotInEditing.png|thumb|A test template for direct editing a String property (Xamarin)]]
[[File:UBIK_Xamarin_UI_Template_PropertyDirectItemString_Debug_InEditing.png|thumb|The same template now in edit mode (Xamarin)]]
In the example demonstrated in the screenshot where a test template is used to enable direct editing of a String/Text typed property, the following members of the PropertyViewModel are involved.
* '''InEditing''': This is the boolean member indicating whether the PropertyViewModel is currently in edit mode. It can be used to decide whether the UI should display the DisplayValue text or present a text box for user input;
* '''Description''': This is the description of the underlying property/meta property;
* '''ValueItem.PropertyValue''': This is the value of property stored at the PropertyViewModel which can differ from the underlying property value because there can be editing changes not yet confirmed/saved. It can be read from and written to by the text box;
* '''DisplayValue''': This is the textual version of ValueItem.PropertyValue used for displaying when the InEditing is false;
* '''StartDirectEditCommand''': Sets InEdit to true and starts the direct editing session. In the example, this is linked to the tapped event of the entire template area;
* '''ConfirmEditCommand''': Confirms the edit and sets InEdit to false. Even if the property value is not changed, this will give the property a new validation timestamp, technically modifying the property;
* '''SaveAndCommitCommand''': In addition to confirming the edit, this also saves the changes to the underlying property, saves the owner object and attempts to commit it if the sync mode allows;
* '''ResetCommand''': Resets the underlying property to its last known server state, saves the owner object and attempts to commit it if the sync mode allows;
* '''DiscardChangeCommand''': Discards all changes made at the PropertyViewModel level that not yet saved to the underlying property;
* '''DeleteValueCommand''': Sets the underlying property's value(s) to null and erases its validation timestamp, saves the owner object and attempts to commit it if the sync mode allows;
* '''CancelEditCommand''': Cancels the current editing session and discards all changes made at the PropertyViewModel level '''in that session''' (different from DiscardChangeCommand).

{{Hint|Once again, you can use the [[Developer_Mode]] to find out more about the PropertyViewModel, like where they are available and how they can be accessed in XAML, or what other members are available underneath, etc.}}

== Relevant types ==
Here are some types created for the purpose of property direct editing.

=== PropertyDirectItemTemplateSelector ===

This is used in a ListView-like control where item templates should be specified, in this case property item templates specifically. It determines the different DataTemplates to be used for direct editing PropertyViewModels according to their property types. For types that have default {{UBIK}} direct editing support, the template names follow the pattern of "UBIKPropertyDirectItemXXX" where XXX is the type name, e.g. String, DateTime, List, etc.

For types that do not come with default direct editing support, the selector uses the "UBIKPropertyItem" template in which editor dialogs are shown instead.

<tabs>
<tab name="UWP">
Namespace <code>xmlns:tpl="using:UBIK.WinX.Templates"</code>
</tab>

<tab name="Xamarin">
Namespace <code>xmlns:resources="clr-namespace:UBIK.CPL.Resources;assembly=UBIK.CPL"</code>
</tab>
</tabs>

=== TaskPropertyTemplateSelector ===

By default, [[MRO_Objects_(Client)#Task|MRO tasks]] have direct editing enabled for their task related properties in the "UBIKTaskItem" template. This template selector determines the different DataTemplates to be used for direct editing PropertyViewModels according to their property types. For types that have default {{UBIK}} direct editing support, the template names follow the pattern of "UBIKTaskPropertyXXX" where XXX is the type name, e.g. String, DateTime, List, etc.

For types that do not come with default direct editing support, the selector uses the "UBIKTaskProperty" template in which editor dialogs are shown instead.

<tabs>
<tab name="UWP">
Namespace <code>xmlns:tpl="using:UBIK.WinX.Templates"</code>
</tab>

<tab name="Xamarin">
Namespace <code>xmlns:resources="clr-namespace:UBIK.CPL.Resources;assembly=UBIK.CPL"</code>
</tab>
</tabs>

=== ComboBoxItemTemplateSelector (UWP only) ===

By default, a ComboBox uses the same template for the selected item (when closed) as well as the drop down items (when opened), which is not always wanted. This template selector allows you to use different templates for these two types of items.

Namespace <code>xmlns:tpl="using:UBIK.WinX.Templates"</code>
<source lang = "xml">
<tpl:ComboBoxItemTemplateSelector x:Key="ComboBoxItemTemplateSelector" DropDownItemTemplate="{StaticResource XXX}" ComboBoxSectionItemTemplate="{StaticResource XXX}" />
</source>
* DropDownItemTemplate: for the dop down items (when opened)
* ComboBoxSectionItemTemplate: for the selected item (when closed)

=== Behaviors and controls ===
<tabs>
<tab name="UWP">
The KeyEventTriggerBehavior is a specialized version of the EventTriggerBehavior in the way that it sets the event to KeyDown by default and allows customizers to define which key (KeyName) should trigger the action(s).
<source lang = "xml">
<TextBox ...
xmlns:Core="using:Microsoft.Xaml.Interactions.Core"
xmlns:Interactivity="using:Microsoft.Xaml.Interactivity"
xmlns:behaviours="using:UBIK.WinX.Behaviors">
<Interactivity:Interaction.Behaviors>
<behaviours:KeyEventTriggerBehavior KeyName="Enter">
<Core:InvokeCommandAction Command="{Binding ConfirmEditCommand}" />
</behaviours:KeyEventTriggerBehavior>
<behaviours:KeyEventTriggerBehavior KeyName="Escape">
<Core:InvokeCommandAction Command="{Binding CancelEditCommand}" />
</behaviours:KeyEventTriggerBehavior>
</Interactivity:Interaction.Behaviors>
</TextBox>
</source>
</tab>

<tab name="Xamarin">
The SelectAllEntry optionally accepts two commands (ReturnCommand & EscapeCommand) to execute when a user inputs the return key {{key press|Enter}} and the escape key {{key press|Esc}} respecitively.
<source lang = "xml">
<Grid xmlns:renderers="clr-namespace:UBIK.CPL.Platform.Renderers;assembly=UBIK.CPL">
<renderers:SelectAllEntry ...
ReturnCommand="{Binding ConfirmEditCommand}"
EscapeCommand="{Binding CancelEditCommand}" />
</Grid>
</source>
</tab>
</tabs>

[[Category:Client|Property Direct Edit (Client)]]
[[Category:Version 4.0|Property Direct Edit (Client)]]
[[Category:WinX|Property Direct Edit (Client)]]
[[Category:Xamarin|Property Direct Edit (Client)]]