UBIK Wiki / Augmensys - User contributions [en]

UBIK Client Getting Started

2026-08-18T09:34:20Z

JKN:

= [[Client_Feature_Table]] (Link) =

= UBIK.UWP (UBIK.WinX) =
=== [[UBIK_WinX_Client_Basics|Basics about UBIK.UWP]] ===
=== [[XAML_Basics]] ===
=== Hot topics ===
* [[XAML_Changes_in_UBIK_WinX_3.5#Filtering_by_expressions|Configure content filtering in XAML customizing]]
* [[EvalExpression|Using result of an expression for data binding]]
* [[Developer_Mode|Tool for trouble shooting & more]]

=== [[:Category:WinX|All pages in this category]] ===

= UBIK.Mobile =
=== [[XAML_Basics]] ===
=== Hot topics ===
* [[Xamarin_XAML#Content_filtering|Configure content filtering in XAML customizing]]
* [[EvalExpression|Using result of an expression for data binding]]
* [[Xamarin_XAML#Default_XAMLs|Getting default XAML resources]]

=== [[:Category:Xamarin|All pages in this category]] ===

= UBIK.Hololens =
=== [[UBIK HoloLens Client Basics]] ===
=== [[UBIK HoloLens 2 Client Basics]] ===
=== [[:Category:HoloLens|All pages in this category]] ===

= UBIK.Android =
{{DeprecatedStartTag}}
=== [[UBIK_Client_Basics|Basics about UBIK.Android]] ===
=== [[:Category:Android|All pages in this category]] ===

[[Category:Client|UBIK Client Getting Started]]
[[Category:Mobile|UBIK Client Getting Started]]

HowTo:Switch to Offline Mode

2026-06-23T13:48:52Z

JKN:

{{DeprecatedStartTag}}

First make sure the root object(s) is/are fetched from the service.

There are three ways to initiate this process.

== Switch to offline mode through action bar ==
# Open the [[UBIK Client Basics#Navigation Drawer|navigation drawer]];
# Press the offline button;<br/>[[File:UI_Android_Offline_Button_In_Nav_Drawer.png|200 px|border|alt=Offline Button|Offline Button]]
# A dialog listing all the root objects should be shown now. Users can select any of these objects/branches to work with in offline mode.<br/>[[File:UI_Android_SelectForOffline.jpg|300 px|border|alt=Select Branch(es) for Offline|Select Branch(es) for Offline]]

Depending on users' selections, there are two follow-up scenarios.

=== Nothing selected ===
If nothing is selected when {{key press|OK}} is pressed, the client will switch to offline mode immediately.

=== Root object(s) selected ===
# If any root object is selected when {{key press|OK}} is pressed, the client will start to prepare the necessary branches.
# At the end of offline preparation, a dialog will be shown to indicate so. And the client should also be switched to offline.<br/>[[File:UI_Android_OfflinePreparationFinished.jpg|300 px|border|alt=End of Offline Preparation|End of Offline Preparation]]

== Manually change sync mode in {{UBIK}} settings ==
# Go to [[Settings|Settings]];
# Find setting '''SyncMode''' and change its value to offline
# The branch selection dialog should show up. Please refer to step 3 and the further steps in [[#Switch to offline mode through action bar|Switch to offline mode through action bar]].

== Start offline mode from context aware action bar ==
It is also possible to select an arbitrary branch (not necessarily starting from the root) to prepare for offline mode. This can be done in the following steps:
# Browse to any object whose child branch (including itself) is to be prepared;
# Press the '''Prepare Branch for Offline''' button in the context aware action bar;<br/>[[File:UI_Android_BranchDownloadIcon.jpg|500 px|border|alt=Context Aware Action Icon for Branch Download|Context Aware Action Icon for Branch Download]]
# The preparation of the branch should start right away. Once it is finished, offline mode should be activated with a dialog informing the users.

== See also ==
* [[Sync Mode]]

[[Category:Android|Switch to Offline Mode]]
[[Category:How-To|Switch to Offline Mode]]

HowTo:Save Settings as Presets

2026-06-23T13:48:27Z

JKN:

{{DeprecatedStartTag}}

In order to save all the settings into a [[Preset|preset]], users have to login first.

After logging in, perform the following steps:
# Go to [[Settings]]
# Press {{key press|Save PreSet as}} at the bottom of the screen<br/>[[File:UI_HowTo_Save_Settings_As_Presets_01.jpg|220 px|border|alt=Save preset as|Save preset as]]
# Enter a name for the new preset<br/>[[File:UI_HowTo_Save_Settings_As_Presets_02.jpg|300px|border|alt=Enter name for preset|Enter name for preset]]
# Press {{key press|OK}} to save
# If a preset with the same name already exists, either:<br/>[[File:UI_HowTo_Save_Settings_As_Presets_03.jpg|300 px|border|alt=Confirm to overwrite|Confirm to overwrite]]
#* Press {{key press|OK}} to overwrite the existing one or
#* Press {{key press|Cancel}} and start over with a different name.

== See also ==
* [[HowTo:Load Presets]]

[[Category:Android|Save Settings as Presets]]
[[Category:How-To|Save Settings as Presets]]

RFID tags

2026-06-23T13:47:44Z

JKN: /* Android (obsolete) */

In order for the users to find objects more efficiently, {{UBIK}} objects can be marked with values for RFID/NFC codes. Whenever a user scans an RFID code, the resulting code value can be used to find all matching objects, namely objects that have the [[#Technical_background|right property]].

{{Hint|[http://en.wikipedia.org/wiki/Near_field_communication NFC] stands for "Near Field Communication" and is a set of ideas and technologies for data transfer between devices, typically in close distances.
Technically, it is based on [http://en.wikipedia.org/wiki/Radio-frequency_identification RFID] ("Radio-Frequency Identification"), which describes specific technical solutions.}}

Amongst the use cases for NFC, there is communication between smartphones and other devices, but also the scanning of RFID tags.

The {{UBIK}} RFID scanning feature specifically is the ability to scan RFID tags in order to identify {{UBIK}} objects.

<br/>

= WinX/Mobile Internal Scanner =

Availability: {{Version/WinXSince|2.5.4}}

== Supported RFID Tags ==

There are three types of RFID markers supported by {{UBIK}}:
* NfcA (RFID standard: ISO-14443A)
* NfcB (RFID standard: ISO-14443B)
* NfcV (RFID standard: ISO-15693)

{{UBIK}} WinX scans these tags for an NDEF message. Tags which are not NDEF formatted are not supported by the WinX client.
{{UBIK}} Mobile instead just looks for the serial numbers of the tags and use them for searching.

=== Choose which information to use from a tag {{Version/XamarinSince|4.9}} ===
Starting from version 4.9 (Mobile only), it's possible to choose whether you want to use the NDEF message or the serial number of a scanned tag. The relevant setting in the profile is [[Settings#Scan|"UseNdefMessage"]].

{{Attention|This settings determines which information to use in all NFC/RFID usecases in the client, e.g. [[#Presenting_results_of_a_search|scan to search]], [[#Scan_to_input_mode|scan to input]], [[MRO_Objects_(Client)#Supervisor_Task|supervisor task]].}}
{{Hint|If "UseNdefMessage" is set to true and there is no text NDEF message available in the scanned tag, the client does nothing except logging. A text NDEF message is one with a record of mime type "text/plain". Although type Uri is also considered text according to our testing.}}

== Supported Devices ==
When your client supports NFC, you can see this by opening the side menu. If NFC is supported, a NFC button should be enabled.

== Scanning an RFID tag ==
[[File:NFCButton.jpeg|thumb|alt=Scanning for NFC tag|Scanning for NFC tag]]
A NFC Scan button is shown in the Global App Bar if the device is capable of scanning NFC tags. Pressing the NFC Scan button enables/disables NFC scanning throughout the whole application. That means once the NFC scanning is activated, one can use the application just as usually while {{UBIK}} scans for NFC tags in the background.

== Presenting results of a search ==
Once a tag is successfully scanned, an object search is executed.
# if no objects are found a message is popping up at the right side of the screen.
# if more than one object is found the results are represented in a separate view (dialog in WinX, side panel in Mobile) along with their matching probability. One can than select one object that should be opened in the content browser.
# if exactly one object is found, this object is directly opened in the content browser.

<gallery widths="400" heights="400">
File:NFCResultNotFound.jpeg|alt=No object found message|No object found message
File:NFCResultFound.jpeg|alt=Multiple search results dialog|Multiple search results
</gallery>

== Search modes ==

{{UBIK}} provides two modes for searching objects: [[Sync Mode#Possible sync modes|online and offline]].

=== Searching offline ===

In any case (regardless of the network connection and [[Sync Mode|sync mode]]), {{UBIK}} always goes through all the objects currently available on the device and find the ones that match the scanned results.

=== Searching online ===

When the Internet is avaiable and {{UBIK}} is not running under offline mode, the search result is enhanced by online search. This means any objects that match the scanned results can be found even if they don't yet exist locally.

== Multiple codes on a single object {{Version/WinXSince|4.4}}{{Version/XamarinSince|4.4}} ==
It's possible have multiple NFC/RFID codes on a single object. This allows the same object to be found when you scan any of those codes.
For [[SYSCLS_OBJECTWITHRFIDTAGS|such objects]], the general scan and potentially the search behaviors are exactly the same as those with only a single code. For example, if an object with multiple codes is found when you scan one of the codes, it could also get unlocked.

== Scan to input mode {{Version/XamarinSince|4.2}} ==
Instead of performing object searches for scan results, {{UBIK}} can also use the scan results as input for property value editing. In this so called scan to input mode, no searches are performed.

At the moment, there is no standard UI to control this mode. However, it can be easily customized. The two relevant properties are:
* AppStatus.ToggleNfcScanToInput: Controls the scan to input mode. True to turn it on, false to turn it off so that it returns to the default scan to search mode. This value automatically resets to the default value false when a property edit session ends;
* AppStatus.NfcScanToInputResult: The last NFC/RFID scan result while scan to input mode is on. This value gets automatically cleared when a property edit session ends.

{{Hint|Except on iOS, the scan to input mode doesn't override the overall NFC/RFID toggle (AppStatus.ToggleNFCScanning) which controls whether {{UBIK}} should scan NFC/RFID tags. It's different on iOS simply because scanning is performed in a session in general and gets turned off automatically after a scan. }}

== Classifications ==

In order for objects to be identifiable through RFID, they have to carry the [[SYSCLS OBJECTWITHRFIDTAG]] classification or (optional) the new [[SYSCLS OBJECTWITHRFIDTAGS]] {{Version/ServerSince|4.4.0}}.

The service query used for online searching is [[SYSCLS RFIDTAGSCANQUERY]].

== See also ==
* [[SYSCLS OBJECTWITHRFIDTAG]]
* [[SYSCLS OBJECTWITHRFIDTAGS]]
* [[SYSCLS RFIDTAGSCANQUERY]]

= WinX External Scanner =

Since {{Version/WinX|3.6.0}} it is possible to use external Bluetooth RFID Readers for Scanning RFID Tags.

== Preliminaries ==

To use an external Bluetooth RFID Reader within {{UBIK}}, the device has to be brought into the Bluetooth SPP (Serial Port Profile) Mode first. Check the manual of the device on how to do that. Once SPP is active, the reader has to be paired with the {{UBIK}} host device. Afterwards it can be used for scanning RFID Tags.

== RFID Configuration File ==

Information needed for communicating with an external Bluetooth RFID Reader are stored in a ".rfconfig file". This file has to be placed in the local RFIDConfiguration folder: ''{AppData}\LocalState\RFIDConfiguration\.rfconfig''. The name of the ".rfconfig" file is irrelevant. The configuration file contains the following information:

{| class="wikitable" | width = "100%"
|-
! Information !! Type !! Description
|-
| ScannerIdentifier || String || The Bluetooth Name of the RFID Scanner.
|-
| DefaultScanning || Boolean (true,false)|| Specifies wheter scanning is active as default or not.
|-
| IgnoreReply || Boolean (true,false) || Some Scanners might send reply messages once a Blue-tooth Command was applied. If IgnoreReply is set to true, these messages aren´t used for further processing.
|-
| Substring || String of format: x,y || Extracts a substring of the scanned RFID Tag for further processing. x…index of the first character y… length of the substring
|-
| Replace || String of format: x,y || Replaces a character of the scanned RFID Tag for further processing. x…old character y…new character
|-
| StartCommands || List of Strings || List of Bluetooth Commands that are send to the RFID Reader when scanning is started.
|-
| ScanningCommands || List of Strings || List of Bluetooth Commands that are send to the RFID Reader when a Tag got scanned.
|-
| StopCommands || List of Strings || List of Bluetooth Commands that are send to the RFID Reader when scanning is stoped.
|-
|}

The ScannerIdentifier is typically the Bluetooth Name of the RFID Scanner. In some cases however it might deviate from the Bluetooth Name. The correct ScannerIdentifier can the be found in “Windows Settings>Devices and Printers>Right click on the Bluetooth Device>Properties>Services”.
Bluetooth Commands are ASCII Strings which can be send to the RFID Reader in the SPP Mode in order to configure the device. These commands can be found in the documentation of the respective RFID Reader. Often they are terminated with a stop character like “\r”.
An example of an .rfconfig file is given below. Note that elements of the configuration file have to be ordered alphabetically.

<source lang="xml">
<?xml version="1.0" encoding="utf-8"?>
<RFIDConfiguration xmlns="UBIK.AR.RFID"
xmlns:i="http://www.w3.org/2001/XMLSchema-instance"
xmlns:a="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<DefaultScanning>false</DefaultScanning>
<IgnoreReply>true</IgnoreReply>
<Replace>),=</Replace>
<ScannerIdentifier>RNI-SPP</ScannerIdentifier>
<ScanningCommands>
<a:string>cw 0E,01\r</a:string>
</ScanningCommands>
<StartCommands>
<a:string>cw 04,00\r</a:string>
<a:string>cw 0E,01\r</a:string>
</StartCommands>
<StopCommands>
<a:string>cw 0E,01\r</a:string>
</StopCommands>
<Substring>0,18</Substring>
</RFIDConfiguration>
</source>

== Start Scanning ==

There are two possibilities to start scanning using the configured RFID Reader: Either scanning is active per default (see RFID Configuration) or by pressing the RFID Scan button in the GlobalAppBar. <br/>

[[File:NotConnected.PNG]]<br/>

When pressing the RFID Scan button UBIK tries to establish a Bluetooth connection to the RFID Reader. This is indicated by a Progress Ring on top of the RFID Scan button. If no connection could be established, the RFID Scan button falls back to its original state.<br/>

[[File:Connecting.PNG]]<br/>

If a connection was successful, the RFID Scan button appears toggled. Afterwards the StartCommands of the RFID Configuration are applied and UBIK starts to listen for Messages from the Bluetooth RFID Reader. That means one can use the application just as usually while UBIK® scans for RFID Tags in the background.<br/>

[[File:Connected.PNG]]<br/>

== Scanning ==

Once scanning was successfully started as described above, UBIK is continuously listening for new Messages from the RFID Reader. When a RFID Tag gets scanned, the result is received and manipulated based on the RFID Configuration. If the Substring option is configured properly, a substring of the Message is extracted and used for further processing. If the Replace option is configured properly specified characters are replaced. Afterwards processing an action is triggered for the received Message. If a string editor is currently opened, the Message is written into the property field of the editor (Teach-In). Otherwise an object search is triggered. UBIK is then searching for Objects classified as [[SYSCLS_OBJECTWITHRFIDTAG]] having the scanned content as the RFIDTag property value. Finally the ScanningCommands defined in the RFID Configuration are applied.

== Stop Scanning ==

Scanning can be stopped manually by pressing the RFID Scan button in the GlobalAppBar or simply by switching off the RFID Reader. UBIK will notice the device got disconnected and will indicate so using the RFID Scan button state. If the RFID Reader is disconnected by pressing the RFID Scan button manually, StopCommands defined in the RFID Configuration are applied.

== Troubleshooting ==

The RFID Scan Button is not visible. Check the following:
* Is there a .rfconfig file in the specified RFIDConfiguration folder?
* Is the .rfconfig file formatted properly?
* Are the elements of the .rfconfig file ordered alphabetically?
* Are the elements of the .rfconfig file of the correct type?
* Is the RFID Reader running in Bluetooth SPP Mode?
* Is the RFID Reader paired with the host device?
* In the .rfconfig file, does the specified ScannerIdentifier match the Bluetooth name of the RFID Reader?

Its not possible to start scanning. Check the following:
* Is the RFID Reader on and in the proximity of the host device?
* Try to restart scanning by again pressing the button
* Try to restart the RFID Reader
* Try to restart UBIK

UBIK does not find any RFID Objects. Check the following:
* Is the RFID Reader properly configured (Some readers need to get pre-configured using Bluetooth Commands in order to send scanned RFID Tags to UBIK – Check the manual)
* Try to open a String editor and scan a RFID Tag. Is the scanned message as expected?
* Are the Objects of interest classified as SYSCLS_OBJECTWITHRFIDCODE?
* Are the Objects of interest properly configured (property value equals the associated RFID Tag)?
* If no Online Query is defined, are the Objects of interest available locally?

= Android (obsolete) =
{{DeprecatedStartTag}}

Availability: {{Version/AndroidSince|2.4.2}}

== Supported RFID Tags ==

There are three types of RFID markers supported by {{UBIK}}:

{| class="wikitable" | width = "75%"
|-
! Standard!! Tested Tag technologies
|-
| NfcA (RFID standard: ISO-14443A) {{Version/AndroidSince|2.4.2}} || EV1(MFOUL11), NTAG 216, NTAG 210, NTAG 213
|-
| NfcB (RFID standard: ISO-14443B) {{Version/AndroidSince|2.4.5}} || -
|-
| NfcV (RFID standard: ISO-15693) {{Version/AndroidSince|2.4.5}} || ICode SLIX(SL2S2002), ICode SLI(SL2ICS20)
|-
|}

== NFC Scan Result Type ==
Depending on the [[Settings#AR_settings|NFC Scan Result Type]] setting, {{UBIK}} can extract different types of information from a scanned RFID tag:

{| class="wikitable" | width = "100%"
|-
! NFC Scan Result Type !! Comment
|-
| Identifier (Hexadecimal) {{Version/AndroidSince|2.4.2}} || Extracts the write-protected identifier of a scanned tag in hexadecimal form. The identifier is given by the manufacturer and can´t be manipulated.
|-
| Content (Hexadecimal) {{Version/AndroidSince|3.0.0}} || Extracts the raw content of a scanned tag in hexadecimal form. Not supported on the Getac Z710. NfcB tags are not supported.
|-
| Content (ASCII) {{Version/AndroidSince|3.0.0}} || Extracts the raw content of a scanned tag in ASCII form. Not supported on the Getac Z710. NfcB tags are not supported.
|-
| Content (NDEF) {{Version/AndroidSince|3.0.0}} || Extracts NDEF messages of type "Text" or "text/plain" from a scanned tag. Not supported on the Getac Z710.
|-
|}

== Configurable start screen RFID button ==

In order to use this feature, a RFID scanning entry point is provided using a [[HowTo:Configure_Start_Screen_Content#Buttons|configurable start start screen button]].
The following xml shows an example start screen configuration including RFID scanning entry point:

<source lang="xml">
<StartScreenConfiguration>
<Tab caption="Content">
<ContentBrowserButton caption="Content Browser"/>
<RFIDScanButton caption="RFID Scan" />
</Tab>
</StartScreenConfiguration>
</source>
{{Clear}}

== Scanning an RFID tag ==
[[File:rfid_button_on_startscreen.jpg|thumb|alt=RFID button on Start Screen|RFID button on Start Screen]]
[[File:Scanning.jpg|thumb|alt=Scanning for RFID tag|Scanning for RFID tag]]
Once the RFID button in the start screen is clicked, the corresponding RFID scanner starts. The user is then able to scan RFID tags continuously.
{{Clear}}

== Presenting results of a search ==
[[File:Scanned_searching.jpg|thumb|alt=Searching for Objects|Searching for Objects]]
[[File:Scanned_search_result.jpg|thumb|alt=Displaying Objects|Displaying Objects]]
[[File:Scanned_no_result.jpg|thumb|alt=No corresponding Objects|No corresponding Objects]]
Once the ID of the tag is scanned, {{UBIK}} starts searching for objects with the scanned RFID.
# During the search, the list might show a searching text before any objects are found;
# If any objects are found, they will be displayed in a list. The users can then browse to any of the objects for more information by clicking on the objects;
# If no objects are found, the list will show a corresponding text.
{{Clear}}
== Searching Mechanism ==

{{UBIK}} provides two mechanisms for searching objects: [[Sync Mode#Possible sync modes|online and offline]].

=== Searching offline ===

In any case (regardless of the network connection and [[Sync Mode|sync mode]]), {{UBIK}} always goes through all the objects currently available on the device and find the ones that match the scanned results.

=== Searching online ===

When the Internet is available and {{UBIK}} is not running under offline mode, the search result is enhanced by online search. This means any objects that match the scanned results can be found even if they don't yet exist locally.

== Technical background ==

In order for objects to be identifiable through RFID, they have to carry the [[SYSCLS OBJECTWITHRFIDTAG]] classification.

The service query used for online searching is [[SYSCLS RFIDTAGSCANQUERY]].

{{Clear}}

== See also ==
* [[SYSCLS OBJECTWITHRFIDTAG]]
* [[SYSCLS RFIDTAGSCANQUERY]]

{{Category/Version|2.4.0}}

<headertabs/>

[[Category:2.4.0|RFID tags]]
[[Category:Android|RFID tags]]
[[Category:Mobile|RFID tags]]
[[Category:Version 2.5|RFID tags]]
[[Category:Version 3.0|RFID tags]]
[[Category:WinX|RFID tags]]

Restricted Login Dialog

2026-06-23T13:47:03Z

JKN:

{{DeprecatedStartTag}}

For confidentiality reason, users are required to login before they have access to most of the {{UBIK}} features. Since the free configuration of settings by the user could be a common source of problems, the possibility to predefine them via a web service and make them not alterable via the client is introduced through a restricted login screen.

== Accessing Restricted login dialog ==
[[File:Loginscreen_loaded_successfully.png|thumb|alt=Login dialog|Start screen]]
Near the bottom of the start menu which users see immediately after launching {{UBIK}} application, there is a {{key press|Login}} button. Clicking it opens the login dialog.
{{Clear}}

== Logging in ==
[[File:Login_restricted_screen_without_remember.png|thumb|alt=Login dialog|Login dialog]]
In the login dialog, users can only choose their name and type in the password to identify themselves. If the authentication is successful, the dialog will be dismissed and users will have access to all the {{UBIK}} features. Otherwise, the error details will be given in the [[#Authentication messages|authentication messages]].
The settings which were configurable in the normal login dialog are predefined and not accessible by the user. Therefore the interface changed and the {{key press|Load PreSet}} button has disappeared.

In order to visualize whether the predefined settings were loaded, a notification appears indicating if the settings were loaded or an error has occured. Possible notifications are:

{| class="wikitable sortable" | width = "75%"
|-
! Notification || Reasons of occurrence
|-
| ''Settings successfully loaded''|| Everything went fine, data is loaded
|-
| ''Check local server configuration''|| The local source.conf file does not contain a valid URL or does not exist
|-
| ''Error loading PreSets''|| There are no settings defined on the webservice
|-
|}

In the case that there is no web service defined either as static URL in the code or via the source.conf file, the normal login dialog is shown instead of the notification.
{{clear}}

== Authentication messages ==

=== Password missing ===
[[File:Login_restricted_screen_password_empty.png|thumb|alt=No password| No password]]
[[File:Login_restricted_screen_password_wrong.png|thumb|alt=Wrong password| Wrong password]]
When users try to login without passwords, the indicating message says "Type the password for this account."

=== Invalid Password ===

When the password being used is invalid, the indicating message says "The password isn't valid. Please try again."

=== Web service messages ===
[[File:Login_restricted_screen_authenticating.png|thumb|alt=Authenticating|Authenticating]]
In case an error occurred while/when the client sends a request to the web service for authentication, a message detailing the reason for failure will be displayed according to the following

{| class="wikitable" | width = "75%"
|-
! Cause!! Message displayed
|-
| ''Invalid satellite''|| The satellite isn't valid.
|-
| ''Locked satellite''|| The satellite is locked.
|-
| ''Service unavailable''|| The service is unavailable.
|-
| ''Service maintenance''|| The service is in maintenance.
|-
| ''Internal error''|| An internal error occurred at server side.
|-
| ''Unknown error''|| An error occurred at service side.
|-
| ''Authorization error''|| An authorization error occurred. Erroneous HTTP status code 401.
|-
| ''Service not found''|| The service couldn't be called. Please check the configuration. Erroneous HTTP status code 404.
|-
|}
{{Clear}}
{{Hint|Verification of username and password happens only if the [[Web_Service_Configuration|web service]] is configured accordingly.}}
{{Clear}}
{{Hint|Detailed failed login error messages Available since {{Version/Android|2.4.1}}}}

{{Clear}}

== Remembering passwords ==
(Available since {{Version/Android|2.4.1}})
[[File:Login_restricted_screen_remembered.png|thumb|alt=Login dialog for remembered user|Login dialog for remembered user]]

{{UBIK}} allows users to remember their passwords for easy login. In the login dialog, there’s an extra checkbox below the password field. Once a user has successfully logged in with it checked, he/she will be remembered. During next time’s login, as soon as the same username is selected, {{UBIK}} detects the remembered state and updates the password field ("*****" regardless of what the real password is) and the checkbox. Similarly, users can uncheck the checkbox to forget their remembered states.

{{Attention|The user and password can only be remembered / forgotten if the login is successful.}}
{{Hint|It is possible to enter a password even when the user is remembered. In this case, the entered password will be used for login.}}

== Offline Login ==
Once a user has successfully logged in online, the account is remembered locally and an offline login can be done.
{{Attention|The same password the online login succeeded with has to be used for subsequent offline logins.
So even if the authentication web service is not password-restrictive, the client always is.}}
{{Attention|For the UBIK WinX client, offline login only is possible if the user data is sent to the client via the web service first. The logins have to be configured in the ACM infrastructure therefore.}}

== Settings ==
[[File:Login_restricted_screen_settings.png|thumb|alt=Settings grayed|Settings not longer editable]]
The main target of the new login activity was to ensure, that the user can not unintentionally change the settings of the application. Therefore, the possibility to change the settings via the menu-entry settings is as consequence of that no longer editable. What has been preserved is the possibility to save the settings as file, in order to share them with a support person easily.

== See also ==
* [[Login_Dialog]]
* [[Settings]]

[[Category:Android|Restricted Login Dialog]]

Preset

2026-06-23T13:45:57Z

JKN:

{{DeprecatedStartTag}}

A preset is a collection of [[Settings|{{UBIK}} settings]]. It provides users a convenient way of switching between different sets of settings.

Users have the following options to cope with presets:
# Save all the current settings into a preset;
# Load an existing preset and apply the setting values to the current ones.

== Technical Background ==

=== Prior to version 2.4.0 ===

Presets are stored in the following directory as [http://en.wikipedia.org/wiki/JSON JSON] files.

'''/Android/data/APP_PACKAGE_NAME/files/preset_folder''' on the public internal storage (Google calls that the "Primary External Storage"), which is NOT the SD-card.

{| class="wikitable" | width = "50%"
|-
! Parameter!! Purpose
|-
| ''APP_PACKAGE_NAME''|| is the concatenation of "com.augmensys.ubik." and the application name, e.g. ''demo'', ''manualtest'', ''companyname'' etc.
|}

=== Starting from version 2.4.0 ===

Presets are stored under a new location: '''/UBIK/preset_folder''' on the public internal storage (Google calls that the "Primary External Storage"), which is NOT the SD-card.

{{hint|In addition, the stored presets are shared between different {{UBIK}} apps and will no longer be removed after apps' uninstallation.}}

== See also ==

* [[HowTo:Save Settings as Presets]]
* [[HowTo:Load Presets]]

[[Category:Android|Preset]]

POI dialog

2026-06-23T13:44:32Z

JKN:

{{DeprecatedStartTag}}

[[File:content_dialog.png|thumb|alt=POI dialog|POI dialog]]
[[File:UI_UBIK_Android_POI_Dialog_With_Properties.jpg|thumb|alt=POI dialog with important properties|POI dialog with important properties]]
A [[HowTo:Declare_an_Object_as_Point_of_Interest_(POI) | POI]] dialog is used for displaying information of the POI object.
Such a dialog contains the following elements:
* Title, which displays the name of the object;
* Descriptive text, which displays the description of the object;
* Property list, which displays the important properties of the object or nothing if there are none. {{Version/AndroidSince|2.4.4}}
{{Hint|Properties with priorities higher/bigger than the [[Settings#User_specific_settings|PriorityThreshold]] are considered important.}}
* Browse button, which shows the POI object in a {{UBIK}} content browser;
* Navigate button, which opens a third-party application and navigate to the POI object's geo location;
* Open group button, which opens the [[POI_Groups|POI group]].
{{Hint|The navigate button will not be available/visible if the POI object does not have any geo information. Similarly, the group related button will not be available if the object is not a group.}}

To close the dialog, the user can click anywhere else on the map.

== POI Info window ==
[[File:UI_UBIK_Android_POI_Info_Window.png|thumb|alt=POI Info window|POI Info window]]
In later versions the POI dialog is replaced by a new POI Info window in the map. {{Version/AndroidSince|2.5.5}}

Compared to the dialog the Info window has the following characteristics.
* It is anchored to the POI on the map and moves with the latter when the user pans the map;
* It is not dismissed the same way like the dialog. Instead, the user has to click/tap the same POI again or the {{key press|X}} button to close it;
* It is possible to have multiple Info windows open at the same time;
* If an object is shown as multiple POIs (E.g., an object is a [[SYSCLS_GEO|geo object]] and at the same time a [[Geographies|geography object]]), only one Info window will be shown for these POIs (anchored to whichever the user clicks/taps).

[[Category:Android|POI dialog]]
[[Category:Client|POI dialog]]
[[Category:POI|POI dialog]]

HowTo:Make a Document ready for Redlining

2026-06-23T13:42:27Z

JKN: /* Android */

The [[Documents_(UBIK_Android)#Redlining|redlining]] feature creates a copy of the [[DOCUMENT|document]] and opens it for editing with any installed 3rd party application. Enabling redlining for certain document objects requires that the following criteria are met:

= Studio =
'''Criterion 1:''' A [[FILEDOCUMENT|file document]] [[MetaClass]] is prepared for Redlining
# Set the [[SYSCLS_REDLINEDFILE]] classification on a [[MetaClass]] for [[FILEDOCUMENT|file documents]] using the {{Class_Details}} control (the MetaClass must derive from [[FILEDOCUMENT]])<br/>[[File:UI_HowTo_Prepare_a_Document_for_Redlining_01.png|330 px|border|alt=Redlined document|Redlined document classification]]
# Check if all required MetaProperties are implemented

'''Criterion 2:''' File documents can be created as child objects of other file documents
# Create a new relation between the MetaClasse of the original file document and the redlined file document<br/>[[File:UI_HowTo_Prepare_a_Document_for_Redlining_02.png|700 px|border|alt=Create relation|Create relation]]

'''Criterion 3:''' [[:Category:Views|View items]] for the (redlined) file document exist
# Create the view items for the file documents if they do not already exist (existing view items for file documents might be sufficient)
# Relate the view items to the according [[View]] and test the result in the [[View Test Environment]] (redlined documents can be created as child objects of other documents)

'''Criterion 4:''' [[CONTEXTSCOPE|Context scopes]] for the redlined file document exist and such file [[Documents_(UBIK_Android)#Creating_Documents|document can be created]] on the {{UBIK Client|mobile client}}
# Create a context scope for the redlined file document (an existing context scope for file documents might be sufficient<br/>[[File:UI_HowTo_Prepare_a_Document_for_Redlining_03.png|700 px|border|alt=Create context scopes|Create context scopes]]
# Enable the creation of the document on the {{UBIK Client}} and configure at least the ''Description'' property in the [[ACM]]<br/>[[File:UI_HowTo_Prepare_a_Document_for_Redlining_04.png|500 px|border|alt=Create context scopes|Create context scopes]]
# If a thumbnail should be displayed on the mobile client configure the ''Thumbnail'' property as well

= Android =
{{DeprecatedStartTag}}

Once the configuration has been completely accomplished on the server side the '''Redline Document''' function should be available on the mobile client.
# Long-click a document's thumbnail [[UBIK_Client_Basics#Content_Browser|Content Browser]]
# Access the menu and choose '''Redline Document'''<br/>[[File:UI_HowTo_Prepare_a_Document_for_Redlining_05.png|200 px|border|alt=Redline document|Redline document]]

<headertabs />

== See also ==
* [[HowTo:Assign a Classification to a MetaClass]]
* [[HowTo:Add a MetaProperty to a MetaClass]]

[[Category:Android|Make a Document ready for Redlining]]
[[Category:Document|Make a Document ready for Redlining]]
[[Category:How-To|Make a Document ready for Redlining]]

Login Dialog

2026-06-23T13:41:58Z

JKN:

{{DeprecatedStartTag}}

For confidentiality reason, users are required to login before they have access to most of the {{UBIK}} features.

== Accessing login dialog ==
[[File:UI_Android_LoginButtonInStartMenu.jpg|thumb|alt=Login button in the start menu|Login button in the start menu]]
Near the bottom of the start menu which users see immediately after launching {{UBIK}} application, there is a {{key press|Login}} button. Clicking it opens the login dialog.
{{Clear}}

== Logging in ==
[[File:UI_Android_LoginDialog.jpg|thumb|alt=Login dialog|Login dialog]]
In the login dialog, users can provide their credentials to identify themselves. If the authentication is successful, the dialog will be dismissed and users will have access to all the {{UBIK}} features. Otherwise, the error details will be given in the [[#Authentication messages|authentication messages]].

=== Logging in with the current UBIK settings ===
[[File:UI_Android_LoginProgressDialog.jpg|thumb|alt=User authentication in progress|User authentication in progress]]
If all the [[UBIK_Client_Basics#Options|{{UBIK}} setting]] values are already configured correctly before login, users can simply click {{key press|Login}} in the dialog. During the time of authentication, there will be a progress dialog displayed. Once users' identities are confirmed, both dialogs will be dismissed.

=== Logging in with a selected [[Preset]] ===
[[File:UI_Android_LoadPresetDuringLogin.jpg|thumb|alt=Selecting a preset before login|Selecting a preset before login]]
It is also possible to specify a collection of setting values to use before login. In this case, simply click {{key press|Load Preset}}. A preset selection dialog will then be shown.
After choosing the desired preset, users can click {{key press|Login}} in the selection dialog to trigger the authentication.

==== PreSet can not be loaded ====

[[HowTo:Load_Presets#PreSet can not be loaded|PreSets can not be loaded]] eventually. If this happens when attempting to login, a notification is shown and the user is navigated back to the login dialog after pressing {{key press |Login}}. Settings are not changed if the PreSet was erroneous.
{{Clear}}

== Authentication messages ==
=== No user input ===
[[File:UI_Android_LoginDialogNoInput.jpg|thumb|alt=Before any user input|Before any user input]]
When users try to login with no input at all, the indicating message says "Please enter your username and password."

=== Password missing ===
[[File:UI_Android_LoginDialogNoPassword.jpg|thumb|alt=Password missing|Password missing]]
When users try to login with only usernames but not passwords, the indicating message says "Type the password for this account."

=== Invalid user credentials ===
[[File:invalid_username.jpg|thumb|alt=Invalid username entered|Invalid username entered]]
[[File:invalid_password.jpg|thumb|alt=Invalid password entered|Invalid password entered]]
When the usernames being used is invalid, the indicating message says "The username isn't valid. Please try again.". Also when the password being used is invalid, the indicating message says "The password isn't valid. Please try again."

{{Attention|Usernames are not case sensitive, which means "Admin" and "admin" designate the same account.}}

{{Hint|Verification of username and password happens only if the [[Web_Service_Configuration|web service]] is configured to use [[USAM]].}}

=== Offline login: Unkown user credentials ===
When logging in without network access, the client tries to compare the given credentials to a successful, earlier login. If this fails (even if the credentials would be correct when tried against the server) the offline login is unsuccessful. A respective message is shown to the user: "Offline login failed: There was no previous login with the given credentials. Please try to login when connected to the server!".

=== Web service messages ===
In case an error occurred while/when the client sends a request to the web service for authentication, a message detailing the reason for failure will be displayed according to the following
{| class="wikitable" | width = "65%"
|-
! Cause!! Message displayed
|-
| ''Invalid satellite''|| The satellite isn't valid.
|-
| ''Locked satellite''|| The satellite is locked.
|-
| ''Service unavailable''|| The service is unavailable.
|-
| ''Service maintenance''|| The service is in maintenance.
|-
| ''Internal error''|| An internal error occurred at server side.
|-
| ''Unknown error''|| An error occurred at service side.
|-
| ''Authorization error''|| An authorization error occurred. Erroneous HTTP status code 401.
|-
| ''Service not found''|| The service couldn't be called. Please check the configuration. Erroneous HTTP status code 404.
|-
|}

{{Hint|Detailed failed login error messages available since {{Version/Android|2.4.1}}}}
{{Clear}}

== Remembering passwords ==
(Available since {{Version/Android|2.4.1}})
[[File:UI_Android_Login_Remembered_Password.jpg|thumb|alt=Login dialog for a remembered user|Login dialog for a remembered user]]

{{UBIK}} allows users to remember their passwords for easy login. In the login dialog, there’s an extra checkbox below the password field. Once a user has successfully logged in with it checked, he/she will be remembered. During next time’s login, as soon as the same username is entered and the focus leaves the name field, {{UBIK}} detects the remembered state and updates the password field ("*****" regardless of what the real password is) and the checkbox. Similarly, users can uncheck the checkbox to forget their remembered states.

{{Attention|The user and password can only be remembered / forgotten if the login is successful.}}
{{Hint|It is possible to enter a password even when the user is remembered. In this case, the entered password will be used for login.}}

== Offline Login ==
Once a user has successfully logged in online, the account is remembered locally and an offline login can be done.
{{Attention|The same password the online login succeeded with has to be used for subsequent offline logins. <br/>So even if the authentication web service is not password-restrictive, the client always is.}}
{{Attention|For the UBIK WinX client, offline login only is possible if the user data is sent to the client via the web service first. The logins have to be configured in the ACM infrastructure therefore.}}

== See also ==
* [[HowTo:Load Presets]]

[[Category:Android|Login Dialog]]

HowTo:Load Presets

2026-06-23T13:40:58Z

JKN:

{{DeprecatedStartTag}}

In order to apply previously defined setting values, presets can be loaded.

== The preset selection dialog ==
[[Preset|Presets]] can be loaded using the preset selection dialog.

The correct PreSet is indicated as loaded both as title in the [[Settings]] and when opening the {{key press|Load PreSet}} dialog. If there are changes, this is also reflected by a symbolic pencil next tos the preset name. {{Version/AndroidSince|2.4.6}}

=== Load a preset via the settings activity ===
# Go to [[Settings]]
# Press {{key press|Load PreSet}} at the bottom of the screen<br/>[[File:UI_HowTo_Save_Settings_As_Presets_01.jpg|200 px|border|alt=Load preset|Load preset]]
# Choose a preset by tapping the row
# Press {{key press|OK}}<br/>[[File:UI_Android_LoadPresetDuringLogin.jpg|340 px|border|alt=Selecting a preset before login|Selecting a preset before login]]

=== Load a preset via the login dialog ===
# Open [[Login Dialog]]
# Enter username and password
# Press {{key press|Load PreSet}} next to {{key press|Login}}<br/>[[File:UI_Android_LoginDialog.jpg|240 px|border|alt=Login dialog|Login dialog]]
# Choose a preset by tapping the row
# Press {{key press|OK}}<br/>[[File:UI_Android_LoadPresetDuringLogin.jpg|340 px|border|alt=Selecting a preset before login|Selecting a preset before login]]

=== Icons ===
Each icon within the loadPreSet dialog and the Settings activities headline has a different meaning.

* The pencil indicates that the current settings differ from the settings defined in the currently loaded PreSet. Upon entering the loadPreSet dialog, an extra row with the name of the currently loaded preset with this pencil symbol is shown and selectable.
* The offline symbol (white rectangle with a black shutdown symbol in it) indicates that the preset is stored locally on the device.
* The online symbol (white rectangle with a black mouse pointer in it) indicates that the preset is fetched online via the [[Serverside_Account_Configuration]]. <br/> [[File:UI_load_preset_with_changed_preset.png|340 px|border|alt=Load Preset dialog with changed PreSet|Load Preset dialog with changed PreSet]]

=== PreSet can not be loaded ===
It is possible under special circumstances, that a PreSet file can not be loaded (e.g. if the file is modified manually). In that case, a notification is shown.

== See also ==
* [[Login Dialog]]
* [[HowTo:Save Settings as Presets]]

[[Category:Android|Load Presets]]
[[Category:How-To|Load Presets]]

HowTo:Customize Status LED on Mobile Client

2026-06-23T13:39:34Z

JKN:

{{DeprecatedStartTag}}

It is possible to customize the [[Status Colour LED (UBIK Android)|status LED]] for applications on a mobile device. This can be done by simply placing/replacing the image file '''status_led.png''' in the [[UI_Configuration_(Mobile_Client)|UI Configurations folder]].

{{Hint|The recommended max resolution/dimension of the image file is 48x48 pixels for phones and 72x72 pixels for tablets. Once the image size exceeds the row height, the views might not be displayed in an optimal way.}}

{{Hint|The color of the image will affect the final color of the status LED. Therefore, it is recommended to use an image with light colors such as grey or white.}}

The customization can be achieved through the following steps:

# Launch any file browser application;
# Choose an image file to be used as the status LED, rename it to '''status_led.png''';
# Navigate to the predefined directory, create it if not found;
# Place the renamed file under the selected directory, replace the old file with the same name if exists.

<gallery widths="300" heights="150">
File:UI_Android_Default_Status_LED.jpg|Default Status LED (Status Color: Orange)
File:UI_Android_Custom_Status_LED.jpg|Custom Status LED (Status Color: Orange)
</gallery>

== See also ==
* [[UI_Configuration_(Mobile_Client)]]
* [[HowTo:Make_an_Object_show_a_Status_LED]]

[[Category:Android|Customize Status LED on Mobile Client]]
[[Category:How-To|Customize Status LED on Mobile Client]]
[[Category:Publishing|Customize Status LED on Mobile Client]]

HowTo:Configure Start Screen Content

2026-06-23T13:39:11Z

JKN:

{{DeprecatedStartTag}}

== Introduction ==
The Dynamic Configurable start screen feature allows the {{UBIK}} user to tailor the buttons on the start screen according to the needs of the customer.

== Setup ==
* The first step is to configure the start screen data using an xml in order for {{UBIK}} to recognize the different tabs and buttons. The xml file, which must have the name '''css_config.xml''', should be placed in the [[UI_Configuration_(Mobile_Client)|UI Configurations folder]].

* After the folder is configured, the next step is to validate the XML configuration file against the [http://wiki.augmensys.com/index.php/File:Start_Screen_Configuration_Schema.zip schema] using an online validator. A solution can be found at [http://www.utilities-online.info/xsdvalidation/ Online XML Schema Validator].
The following xml shows an example configuration (also can be downloaded as {{FileLink|Start_Screen_Configuration.zip|Start_Screen_Configuration.zip}} an xml file):
<source lang="xml">
<StartScreenConfiguration>
<Tab caption="Content">
<ContentBrowserButton caption="Content Browser"/>
<ContentBrowserButton caption="Events" UBIK-UID="31aaa5c9-85dd-4243-9cf8-89d712d32405" iconPath="events.png"/>
</Tab>

<Tab caption="AR1">
<MapsButton/>
<POIViewButton caption="AR View"/>
<CustomIntentButton caption="Map of Linz" iconPath="linz.png">
<TargetURI>
https://www.google.com/maps/place/Linz/@48.295065,14.327405,12z/data=!3m1!4b1!4m2!3m1!1s0x47739595fa99854d:0x7c53292c577975c4
</TargetURI>
</CustomIntentButton>
<CustomIntentButton caption="Skype">
<TargetClass>
com.skype.raider.Main
</TargetClass>
</CustomIntentButton>
<CustomIntentButton caption="Maps">
<TargetClass>
com.augmensys.ubik.demo.lib.ui.activities.ar.map.UBIKMapActivityDemo
</TargetClass>
</CustomIntentButton>
<TargetMapsButton caption="Flow Controller 213" UBIK-UID="2ccd91c0-9cee-42f3-9d1d-be745908457d"/>
</Tab>

<Tab caption="AR2">
<IDMarkerScanButton caption="ID Marker Scan"/>
<QRCodeScanButton caption="QR Code Scan"/>
<ConfigurableARButton caption="Configurable AR"/>
<ConfigurableImageMarkerButton caption="Configurable Image Marker"/>
<ARNavigationButton caption="Flow Controller 213" UBIK-UID="2ccd91c0-9cee-42f3-9d1d-be745908457d"/>
<NavigationMapsButton caption="Flow Controller 213" UBIK-UID="2ccd91c0-9cee-42f3-9d1d-be745908457d"/>
<DemoMapsButton caption="Flow Controller 213" UBIK-UID="2ccd91c0-9cee-42f3-9d1d-be745908457d"/>
<RFIDScanButton caption="RFID Scan" />
</Tab>
</StartScreenConfiguration>
</source>

{{Hint|The config file has to be named '''css_config.xml'''. }}

== Tab groups ==
The user can configure tab groups in the XML. They will be used as groupings for buttons.

== Buttons ==
Buttons should be placed inside tab elements and can be parameterized. Buttons are configurable in terms of
* Icon (Parameter: ''iconPath'')
* Caption (Parameter: ''caption'')
* Group/tab (name of tab group)
* Object UID if needed (Parameter: ''UBIK-UID'')

{{Hint|The icons are specified by their relative paths under '''''SD_CARD''/Android/data/''APP_PACKAGE_NAME''/files/UIConfigurations/CSSButtonIcons''' }}

The supported button types are as follows:

<gallery heights="100">
File:UI_Android_CSS_Buttons_Content_Browser.jpg‎|Content Browser Button
File:UI_Android_CSS_Buttons_Custom_Intent.png‎|Custom Intent Button
File:UI_Android_CSS_Buttons_Maps.jpg|Maps Button
File:UI_Android_CSS_Buttons_Maps.jpg|Target Maps Button
File:UI_Android_CSS_Buttons_ID_Marker_Scan.jpg|ID Marker Scan Button
File:UI_Android_CSS_Buttons_QR_Code_Scan.jpg|QR Code Scan Button
File:UI_Android_CSS_Buttons_POI_View.jpg|POI View Button
File:UI_Android_CSS_Buttons_Config_AR.jpg|Configurable AR Button
File:UI_Android_CSS_Buttons_Config_Image.jpg|Configurable Image Marker Button
File:UI_Android_CSS_Buttons_Nav_Maps.jpg|Navigation Button
File:UI_Android_CSS_Buttons_AR_Navigation.jpg|AR Navigation Button
File:UI_Android_CSS_Buttons_Barcode.png|Barcode Scan Button
File:UI_Android_CSS_Buttons_RFID_Scan.jpg|RFID Scan Button
File:UI_Android_CSS_Buttons_OCR_Scan.png|OCR Scan Button {{Version/AndroidSince|2.5.0}}
</gallery>

{| class="wikitable sortable" | width = "70%"
|-
! Button!! Purpose !! Parameters
|-
| ''ContentBrowserButton''|| Opens a content browser for displaying an object or the root if no object/uid is specified. || ''UBIK-UID'': UID of object to be shown on map
|-
| ''[[Custom_Intent_Button|CustomIntentButton]]'' || Launches a certain application or URI for the specified intent (using a customized intent URI or target class). || ''TargetClass'': name of an activity or an application<br />''TargetURI'': link information
|-
| ''MapsButton''|| Opens {{UBIK}} map. || -
|-
| ''TargetMapsButton''|| Opens {{UBIK}} map for a target object. || ''UBIK-UID'': UID of object to be shown on map
|-
| ''ID MarkerScanButton''|| Starts ID marker scanning. || -
|-
| ''QRScanButton''|| Starts QR code scanning. || -
|-
| ''POIViewButton''|| Opens {{UBIK}} POI view. || -
|-
| ''ConfigurableARButton''|| Opens the ID marker 3D view. || -
|-
| ''ConfigurableImageMarkerButton''|| Opens the markerless view. || -
|-
| ''ARNavigationPOIViewButton''|| Opens {{UBIK}} POI view with the AR navigation support. || ''UBIK-UID'': UID of object to be navigated to
|-
| ''ARNavigationMapsButton''|| Opens {{UBIK}} map for the specified object.Starts navigating to the specified object. || ''UBIK-UID'': UID of object to be navigated to
|-
| ''BarcodeScanButton''|| Starts barcode scanning. || -
|-
| ''RFIDScanButton''|| Starts RFID scanning. || -
|-
| ''OCRScanButton''|| Starts OCR scanning. {{Version/AndroidSince|2.5.0}} || -
|}

=== Color of Buttons ===

If no user is logged in the buttons are de-saturated. Once a user is logged in the buttons are colored according to following behaviour:
* If default buttons are used the buttons are colored programmatically. The button and the color can be customized by the Development.
* If custom buttons are used (specified by the parameter "iconPath") the original color of the button is retained.

== Configuration guidelines ==

* See [[UI_Configuration_(Mobile_Client)]]
* The '''maximum number of tabs is 6'''. Once this limit is exceeded, the configuration is invalid and won't be shown.
* The captions of tabs are optional. In case there's only one tab, the tab will be invisible.
* The '''buttons''' should always be '''nested inside tabs'''. Otherwise, the configuration is also invalid.
* Captions and icons of buttons are optional. Default values are used for the unspecified ones.
* While configuring the [[Custom Intent Button|custom intent button]], one should always specify one and only one of the target class and the target URI. Otherwise, the button is invalid and an error will be shown.
* The configuration of the ''UBIK-UID'' parameter should always be specified for AR Navigation POI View Button, AR Navigation Maps Button, Demo Maps Button and Target Maps Button.

{{Attention|The configuration is only applied when the app starts. Close the app completely (not only move it to the background) and restart it to make sure the configuration is read.}}

== Results ==
The result is that the tabs and buttons configured in the XML file will be visible and open the right activity once they are clicked.

The following screenshots demonstrate the results of the example XML configuration.
<br/>[[File:UI_Android_CSS_Buttons_Tab1.png|500px|border|alt=The First Tab|The First Tab]]
<br/>[[File:UI_Android_CSS_Buttons_Tab2.png|500px|border|alt=The Second Tab|The Second Tab]]
<br/>[[File:UI_Android_CSS_Buttons_Tab3.png|500px|border|alt=The Third Tab|The Third Tab]]

After users log in, the buttons are enabled and colored. Upon being clicked, they should trigger different actions.
<br/>[[File:UI_Android_CSS_Buttons_After_Login.png|500px|border|alt=Buttons After Login|Buttons After Login]]

== See also ==
* [[UI_Configuration_(Mobile_Client)]]
* [[Custom_Intent_Button]]

[[Category:Android|Configure Start Screen Content]]
[[Category:How-To|Configure Start Screen Content]]
[[Category:Publishing|Configure Start Screen Content]]

HowTo:Customize Logo and Background on Mobile Client

2026-06-23T13:37:42Z

JKN:

{{DeprecatedStartTag}}

[[File:bg_landscape.png|thumb|Template background landscape]]
[[File:bg_portrait.png|thumb|Template background portrait]]

It is possible to customize logo and background images for {{UBIK}} Android.

== Configuration ==

In order to configure images, place the required files under the [[UI_Configuration_(Mobile_Client)|UI Configurations folder]].

== File requirements ==

The following files can be used:

{| class="wikitable" | width = "50%"
|-
! Parameter!! Purpose !! Recommended Resolution (px)
|-
| ''bg_landscape.png''|| background for landscape mode || 1000x447
|-
| ''bg_portrait.png''|| background for portrait mode || 600x871
|-
| ''icon.png''|| logo to display in the ActionBar || 48x48
|}

{{Hint|The resolution values are for a device with a 1000x600 pixels screen like the Getac Z710; the values may vary for other devices with different screen resolutions}}

The customization can be achieved through the following steps:

# Launch any file browser application;
# Choose image files to be used as logo and/or background, rename them according to the default naming;
# Navigate to the predefined directory, create it if not found;
# Place the renamed files under the selected directory, replace the old files with the same names if exist.

== See also ==
* [[UI_Configuration_(Mobile_Client)]]

[[Category:Android|Customize Logo & Background on Mobile Client]]
[[Category:How-To|Customize Logo & Background on Mobile Client]]
[[Category:Publishing|Customize Logo & Background on Mobile Client]]

Custom Intent Button

2026-06-23T13:37:20Z

JKN:

{{DeprecatedStartTag}}

The Custom Intent Button is a button with special parameters defined. Namely the target class parameter, and the target URI parameter. In order for the Custom Intent Button to work as intended, either the Target Class or Target URI should be specified, but not both. Also they shouldn’t be both undefined for the same button instance.
== Target Class ==
The Target Class parameter is used to specify the name of an activity or an application to launch when the button is clicked. In the case that an internal {{UBIK}} activity is to be launched, the full activity name has to be included. As in the following example.
<source lang="xml">
<StartScreenConfiguration>
<Tab caption="AR1">
<CustomIntentButton caption="Maps">
<TargetClass>
com.augmensys.ubik.demo.lib.ui.activities.ar.map.UBIKMapActivityDemo
</TargetClass>
</CustomIntentButton>
</Tab>
</StartScreenConfiguration>
</source>

Only the activities that are stated as a main entry point for {{UBIK}} can be used as target classes. <br/>
In the case that an application is to be launched, the main entry point class name has to be specified, as in the following example if Skype application is to be launched.

<source lang="xml">
<StartScreenConfiguration>
<Tab caption="AR1">
<CustomIntentButton caption="Skype">
<TargetClass>
com.skype.raider.Main
</TargetClass>
</CustomIntentButton>
</Tab>
</StartScreenConfiguration>
</source>

== Target URI ==
The target URI parameter, used to specify the URI of the resource to launch when the button is clicked. As in the following example.

<source lang="xml">
<StartScreenConfiguration>
<Tab caption="AR1">
<CustomIntentButton caption="Map of Linz" iconPath="linz.png">
<TargetURI>
https://www.google.com/maps/place/Linz/@48.295065,14.327405,12z/data=!3m1!4b1!4m2!3m1!1s0x47739595fa99854d:0x7c53292c577975c4
</TargetURI>
</CustomIntentButton>
</Tab>
</StartScreenConfiguration>
</source>

[[Category:Android|Custom Intent Button]]
[[Category:How-To|Custom Intent Button]]
[[Category:Publishing|Custom Intent Button]]

Query Objects (UBIK Android)

2026-06-23T13:36:56Z

JKN:

{{DeprecatedStartTag}}

A query is a certain [[SYSCLS QUERY|classified]] {{UBIK}} object which allows users to [[QUERY#Content_queries|find objects by criteria]].

== UI for query objects ==
[[File:UI_Android_Query_Properties.jpg|thumb|alt= Properties of a Query Object|Properties of a Query Object]]
[[File:UI_Android_Query_Results.jpg|thumb|alt= Results of a Query|Results of a Query]]

A query object has the same UI representation as regular objects. However, once a user clicks on it, instead of showing its children, the client will show its properties, namely all the criteria of the query.

The property list view of a query object is also similar to those of regular objects. But an {{key press|OK}} button is available below the list. Once it is clicked, the query will be executed with the current property/criterion values. Meanwhile, the {{UBIK}} will switch to the content list view, ready to display the results of the query.

== See also ==
* [[HowTo:Find_Objects_by_Query]]
* [[SYSCLS_QUERY]] (Classification)

[[Category:Android|Query Objects (UBIK Android)]]

Commissioning Objects (UBIK Android)

2026-06-23T13:36:23Z

JKN:

{{DeprecatedStartTag}}

[[File:UI_new_commissioning_task.png|190px|thumb|border|alt= UI Representation of Commissioning Task Objects|UI Representation of Commissioning Task Objects]]

{{Attention|Since Version 3.0.0 {{Version/AndroidSince|3.0.0}} Commissioning Objects are handled as [[MRO_Objects_(Client)]]}}

A [[SYSCLS_COMMISSIONINGCHECK|commissioning task]] is a special task object, which displays properties defining the status of the check on the row level directly.

There are two types of commissioning tasks,
* '''state relevant''' tasks which are indicated by a (solid/hollow) check symbol at the left side of the row as well as the "Not Applicable" icon. The later icon is a circle with a diagonal line in it at the end of the row.
* '''non state relevant''' tasks, which can be seen as some kind of informational object which do not have a status. This line is indicated by a white "i" as icon and does not have the "Not Applicable" icon.

All commissioning tasks, no matter of what type, are intended to be nested into a parent object called [[SYSCLS_COMMISSIONINGWORKPACKAGE|commissioning workpackage]], which provides the functionality to close all underlying tasks and synchronize them with the server (triggering some optional workflow).

{{Hint|A commissioning task is finished only if a value is entered or the ''Not applicable'' icon is toggled accordingly.<br/>
Any value not equal to null is a valid property value, which means that also a value '''false''' for a boolean property is valid.<br/>
The boolean status is reflected through the checkbox' color: dark blue if it has not been set yet, white if set and white / empty if it is false.}}

== Task types ==
=== Information commissioning task ===
This task is indicated by the white "i" in front of the row. It is intended to hold further information for the user, like additional photos or just a note for the engineer which is not relevant for the status of the whole commissioning process. Nevertheless, it is possible to give it a value like the other tasks which is of course synchronized with the server at least if the commissioning workpackage gets finished.

=== State relevant commissioning task ===
All tasks, for example checking whether a functional plan is available or specific values have to be entered, are handled with this type. It is also possible to check a task as ''Not Applicable'' if it is not possible to be done at the moment but should be seen as finished regarding the work package.

The leading icon indicates the completion status of the task. A task is finished once the value is not null '''OR''' the ''Not Applicable'' icon is toggled. It is possible both, to fill out a task's property and toggle it as ''Not Applicable''.

== Commissioning work package ==
[[File:UI_commissioning_big_picture.png|220px|thumb|border|alt= Architecture of status calculation|Architecture of status calculation]]

A work package contains tasks of the above mentioned types. Once navigated to a work package an icon and a button are shown at the bottom of the screen. This button visualizes the overall status evaluated of all status of the underlying state relevant commissioning tasks. This means that, as long as at least a single child task is not finished the whole workpackage is regarded as (technically) not finished. The icon within the button visualizes the work package's status which is again a property assigned to the work package. This leads to four possible states of a work package:

# Workpackage status OPEN | technical status OPEN
# Workpackage status FINISHED | technical status OPEN
# Workpackage status OPEN | technical status FINISHED
# Workpackage status FINISHED | technical status FINISHED

Clicking the button at the bottom attempts to switch the workpackage status. If the workpackage is changed from '''open''' to '''finished''', it triggers a sync of the whole work package. For all state relevant tasks which have not be set an editor will pop up allowing the user to enter the missing value. Cancelling the dialog leaves the task's value empty.

{{Attention|Up to now, it is possible to change commissioning tasks even if the work package is finished already.}}

{{Hint|If a commissioning work package does not contain any commissioning checks or if they are not yet fetched from the server, the technical status displayed at the bottom left corner is '''Finished'''!}}

The following images should give an overview about possible states occuring upon using this feature:

<gallery widths="200" heights="310">
File:UI_new_commissioning_task.png|New commissioning workpackage (status 1)
File:UI_commissioning_task_not_done_properly.png|Open commissioning workpackage with open child tasks (status 1)
File:UI_commissioning_during_finishing_with_applicable.png|Convenience method for not technically finished tasks upon closing workpackage. Tasks can be marked as not applicable during finishing workpackages; The delete button is removed. {{Version/AndroidSince|2.5.2}}
File:UI_commissioning_task_finished_not_properly.png|Finished commissioning workpackage with open child tasks (status 2)
File:UI_commissioning_task_done_properly.png|Open commissioning workpackage with technically finished tasks (status 3)
File:UI_commissioning_task_finished_properly.png|Finished commissioning workpackage with technically finished tasks (status 4)
</gallery>

== Technical Background ==

The status of work packages is essentially an Integer property. Currently its value definitions are as follows.
* Anything not greater than (≤) 0 indicates the package is open;
* Anything not less than (≥) 1 indicates the package is finished.

== See also ==
* [[SYSCLS_COMMISSIONINGCHECK]] (Classification)
* [[SYSCLS_COMMISSIONINGOPTIONALCHECK]] (Classification)
* [[SYSCLS_COMMISSIONINGWORKPACKAGE]] (Classification)

[[Category:Android|Commissioning Objects (UBIK Android)]]

Child Document Indicator

2026-06-23T13:35:46Z

JKN:

{{DeprecatedStartTag}}

For [[SYSCLS_DOCUMENTOWNER|document owners]], it is possible to know their total numbers of child documents without either
* Showing these child documents;
* Or even having these child documents available on the client.
Instead, number indicators are shown alongside these objects.

{{Hint|These indicators display the sums of the number of child documents available on the server and the number of child documents created locally but not yet committed.}}

== Indicators on thumbnails ==
[[File:UI_Android_Redlining_Children_Count.png|thumb|Numbers of child documents displayed as overlays]]
[[File:UI_WinX_Document_Children_Count.png|thumb|Numbers of child documents displayed as overlays]]
If these document owners are documents themselves and are displayed as thumbnails, the child document indicators are displayed on the top-right corner of the thumbnails.

== Indicators on objects ==
[[File:UI_WinX_Children_Count.png|thumb|Numbers of child documents displayed ]]
The child document indicators are displayed on the top-right side of the child object presentation.

{{Category/Version|2.4.0}}

[[Category:2.4.0|Child Document Indicator]]
[[Category:Android|Child Document Indicator]]
[[Category:Push|Child Document Indicator]]

HowTo:Finish/Reset a Task (UBIK Android)

2026-06-23T13:34:57Z

JKN:

{{DeprecatedStartTag}}

== Finish a Task ==
# When a task is open, browse to its content list view or its property list view;
# Click the Checkbox or {{key press|Finish}};<br/>[[File:UI_Android_Finish_Task_Through_Checkbox.jpg|300 px|border|alt=Click the Checkbox to Finish a Task|Click the Checkbox to Finish a Task]][[File:UI_Android_Finish_Task_Through_Button.jpg|300 px|border|alt=Click the Button to Finish a Task|Click the Button to Finish a Task]]
# Enter values for the follow-up property editors and press {{key press|OK}} one after another (if there's more than one property to be edited);<br/>[[File:UI_Android_Finish_Task_Entering_Values.jpg|300 px|border|alt=Enter Values to Finish a Task|Enter Values to Finish a Task]]

{{Attention|Users will remain at the same view where they try to finish the task. In case {{UBIK}} is in [[Sync Mode#Possible sync modes|automatic mode]], the finished task will be immediately committed if user finishes it through a click on the Checkbox.}}

== Reset a Task ==
# When a task is finished, browse to its content list view or its property list view;
# Click the Checkbox or {{key press|Reset}};<br/>[[File:UI_Android_Reset_Task_Through_Checkbox.jpg|300 px|border|alt=Click the Checkbox to Reset a Task|Click the Checkbox to Reset a Task]][[File:UI_Android_Reset_Task_Through_Button.jpg|300 px|border|alt=Click the Button to Reset a Task|Click the Button to Reset a Task]]

{{Attention|Similarly, users will remain at the same view and the reset task will be committed in the same manner.}}

== See also ==
* [[Task Objects (UBIK Android)]]

[[Category:Android|Finish/Reset a Task (UBIK Android)]]
[[Category:How-To|Finish/Reset a Task (UBIK Android)]]

Task Objects (UBIK Android)

2026-06-23T13:34:41Z

JKN:

{{DeprecatedStartTag}}

A task is a certain [[SYSCLS TASK|classified]] {{UBIK}} object which poses an overall status (Finished / Open).
A task is considered as finished if all the [[SYSCLS_TASK#Validated_MetaProperties|dedicated]] properties are validated. Otherwise, it is considered as open.

{{Attention|A property is validated as soon as the user confirms the editing, e.g. through the {{key press|OK}} in a property editor. This has nothing to do with the property value, meaning a property can be validated even if its value is null.}}

== UI for task objects ==
[[File:UI_Android_Task_Objects.jpg|thumb|alt= UI Representation of Task Objects|UI Representation of Task Objects]]

In addition to the basic descriptive text and icon, a Checkbox is displayed for every task object. And the checked/unchecked state corresponds to the finish/open status of tasks.

When a user clicks on the Checkbox of a task, {{UBIK}} proceeds to either [[HowTo:Finish/Reset a Task (UBIK Android)|finish the task or reset the task]] depending on its current status.

When a user clicks on the remaining parts of a task, e.g. the descriptive text, {{UBIK}} proceeds to display all its properties in a [[UBIK Client Basics#Content Browser|Content Browser]].

== See also ==
* [[HowTo:Declare an Object as Task]]
* [[HowTo:Finish/Reset a Task (UBIK Android)]]
* [[SYSCLS_TASK]] (Classification)

[[Category:Android|Task Objects (UBIK Android)]]

Status LED

2026-06-23T13:34:20Z

JKN:

{{DeprecatedStartTag}}

Status LEDs are shown in [[UBIK_Client_Basics|{{UBIK}} Android]] client's [[UBIK_Client_Basics#Content_Browser|Content Browser]] for objects with status information, namely classified by at least one of the following classifications:
* [[SYSCLS_STATUSCOLOR|Status color classification]]
* [[SYSCLS_OBJECT_WTIH_STATUSICON|Object with status icon classification]]

== Status icon ==
The status LED is essentially a status icon image with different coloring. Which icon to display is determined in the following way.
* It there is a server configured status icon for an object (namely the object is classified by the object with status icon classification), that icon is displayed as the status LED; {{Version/AndroidSince|2.5.1}}
* Otherwise, {{UBIK}} searches for a [[HowTo:Customize_Status_LED_on_Mobile_Client|locally/client configured status icon]] to display;
* If none of the above exists, a default icon is displayed.
{{Hint|If the server configured icon is corrupted for some reason (e.g. not delivered from the server correctly), the status led will try to display the client configured icon or the default one.}}

== Status color ==
If an object is classified by the status color classification and has a valid status color, the color value is used to colorize/tint the icon displayed in the status LED. Otherwise, the icon will be displayed in its original color.

== UI representation ==

=== Action bar ===
When the currently browsed object has status information, a status LED is shown as an overlay on the content icon in the action bar. {{Version/AndroidSince|2.5.1}}

<gallery widths="300" heights="200">
File:UI_TechSpec_UBIKClient_StatusLed_InActionBar.png|Status LED in Action Bar
</gallery>

=== Object list ===
In the ContentBrowser's object list (either root list or child list) the status LED is shown for respectively configured objects.

<gallery widths="300" heights="200">
File:UI_TechSpec_UBIKClient_StatusLed_Appearance.png|Status LED in Content Row
</gallery>

=== Changing the icon or the colour ===

If the property isn't hidden or write-protected, the colour can be changed by editing the respective property.
Same goes for the actual icon.

Another possibility is the respective properties being hidden but adjusted automatically by customizing, either on the server or on the client (programmatic customizing is required for the latter).

<gallery widths="300" heights="200">
File:UI_TechSpec_UBIKClient_StatusLed_ChangeColour.png|Editing the Status Color
</gallery>

== Technical ==

=== Status color classification ===
Details of the classification UUID and the relevant property STATUSCOLOR can be found [[SYSCLS_STATUSCOLOR|here]].

The STATUSCOLOR property has to be an integer property describing the RGB value of the status color as a decimal number.

=== Object with status icon classification ===
Details of the classification UUID and the relevant property STATUSICONID can be found [[SYSCLS_OBJECT_WTIH_STATUSICON|here]].

The STATUSICONID property has to contain the Guid of an object classified by the status icon classification.

=== Status icon classification ===
Details of the classification UUID and the relevant property STATUSICON can be found [[SYSCLS_STATUSICON|here]].

The STATUSICON property has to contain the byte stream of the icon image.

== See also ==
* [[HowTo:Make_an_Object_show_a_Status_LED]]
* [[HowTo:Customize_Status_LED_on_Mobile_Client]]
* [[SYSCLS_STATUSCOLOR]]
* [[SYSCLS_OBJECT_WTIH_STATUSICON]]
* [[SYSCLS_STATUSICON]]

{{Category/Version|2.5.1}}

[[Category:2.5.1|Status LED]]
[[Category:Android|Status LED]]
[[Category:Client|Status LED]]

HowTo:Create a new Document (UBIK Android)

2026-06-23T13:33:34Z

JKN:

{{DeprecatedStartTag}}

This article describes how to create {{UBIK}} [[Document]] objects on the [[UBIK_Client_Basics|{{UBIK}} Android]] client.

== Prerequisites ==

Since {{UBIK}} objects on the Android client are arranged in a hierarchy, every object (except [[UBIK_Client_Basics#Content_Browser|root]] and [[Infrastructure Content (UBIK Client)|infrastructure ]]objects) have parents and, eventually, children.
Therefore, in order to create any kind of object on the {{UBIK}} Android client, a legitimate parent is needed.

It is necessary to configure this possibility in the [[Application Context Management]] (ACM) using the {{UBIK Studio}}.
You can find more information on publishing content on the mobile application in [[HowTo:Make an Object appear on the Mobile Client]].

More precisely, a [[MetaClass]] configured in the ACM can have so-called "possible child classes". If one of those is a document MetaClass, you can create such a document object as a child of an object which has the respective parent MetaClass. A MetaClass is a document, when it has a document classification.

For more information on documents on the Android client, please refer to [[Documents (UBIK Android)]].

== Navigation to the desired parent object ==

As described above, a new object can only be created "under" a legitimate parent object.
Hence, the first step to the creation of a new object on the {{UBIK}} client is to browse the ''Content Browser'' and navigate to the desired parent object.

On the following, first two screenshots, you can see the ''Content Browser'' icon on the start screen and what the object list looks like.

<gallery widths="200" heights="200">
File:UI_TechSpec_UBIKClient_Document_01.png|Content Browser Icon
File:UI_TechSpec_UBIKClient_Document_02.png|Object List
</gallery>

For all successive levels (once an object is selected), the ''Content Browser'' displays not only the three tabs ''Children'', ''Properties'' and ''Documents'', but also context-sensitive actions.
Browse down the hierarchy until you reach the parent object you want to attach a document to.

<gallery widths="200" heights="200">
File:UI_TechSpec_UBIKClient_Content_Browser.png|Content Browser
</gallery>

== Using the Context Action for Content Creation ==

As mentioned, the ''Content Browser'' provides context sensitive actions for a currently viewed object.
On the following screenshot, you can see the overflow menu button (three dots) which is displayed when the context action icons don't fit on the screen.
In this case a click on it opens a dialog containing all the available context actions.

<gallery widths="200" heights="200">
File:UI_TechSpec_UBIKClient_Context_Action.png|Context Action - Create new Content or Take a Picture
</gallery>

If you are using a tablet or the portrait orientation, the respective actions might be displayed as icons next to the tab view as well.

However, to create a new content object, you can either choose an object type (its MetaClass) or directly take a picture using the camera.
If there are multiple "picture MetaClasses", you will be asked to choose one, though.

<gallery widths="200" heights="200">
File:UI_TechSpec_UBIKClient_Content_Creation_Choose_Type.png|Choose Content Type
</gallery>

== Choosing a File ==

Now, the actual file the document object refers to is addressed.

If the MetaClass you chose in the previous step was a non-document MetaClass, this step is skipped.
Also, if you chose to take a picture, this step is replaced by the camera activity to create the file by taking a picture.

Normally you get to choose a file though, and this is done using any third-party file browser already installed on the device.
If multiple file browsers are installed, you have to select one, as the following screenshot shows.

<gallery widths="200" heights="200">
File:UI_TechSpec_UBIKClient_Choose_Intent_Receiver.png|Choose a File Browser
</gallery>

Depending on the file browser, the process of choosing a file might differ, so there is no screenshot fo this (but I think you'll succeed nonetheless).

== Finishing the Creation ==

After a file was selected, you can edit the properties of the newly created object or even cancel the creation.
If everything is as desired, you can finish the content creation with a click on the {{key press|OK}} button.

<gallery widths="200" heights="200">
File:UI_TechSpec_UBIKClient_Content_Creation_Edit_Content.png|Edit the new Object
</gallery>

The newly created content should now be visible as a new document object in the thumbnail grid view (or if it wasn't a document, in the children list).

<gallery widths="200" heights="200">
File:UI_TechSpec_UBIKClient_Content_Browser_New Document.png|The new Document
</gallery>

== Committing the new Document ==

Now it just has to be committed to the server and it will come back with a thumbnail and a description (if the ACM and the customizing is configured that way).
This commit happens automatically in online mode but has to be done manually if manual mode is active (by clicking on the commit button ("upload" arrow) in the action bar.
Congratulations!

[[Category:Android|Create a new Document (UBIK Android)]]
[[Category:Document|Create a new Document (UBIK Android)]]
[[Category:How-To|Create a new Document (UBIK Android)]]

HowTo:Install UBIK Client Certificate

2026-06-23T13:33:11Z

JKN:

{{DeprecatedStartTag}}

Setting up a client certificate for using a secure channel to the [[Web_Service|web service]].

= Android =

=== Manual installation ===
One can add server certificates to the {{UBIK Android}} application in addition to the pre-installed certificates, using a button in the ''Info'' menu. {{Version/AndroidSince|2.3.1}}

# Copy the certificate to your device's SD card where you can find it easily.
# Open the UBIK Android application.
# Press the ''Home'' button in the ''Action Bar''.
# Press the ''Info'' button in the drop-down menu.
# On the Info screen, press the ''Install Certificate'' button.
# Select a file browser in order to select the certificate file.
# Choose the certificate file you earlier copied to the device's SD card.

If the adding was successful, a toast message confirming the installation will appear. Else, the toast's text will indicate an error.

The certificate will be stored in a '''BouncyCastle''' keystore on the device's file system (path: ''SD-Card/UBIK/Certificates'').
This means you can copy this keystore and reuse it on another device by pasting it there!

{{Attention|A file browser app has to be installed on your device in order to select the certificate file from the SD-card.}}

=== Automatic Import ===
One can place certificate files in a predefined folder in order for them to be imported automatically when the app starts up the next time. {{Version/AndroidSince|2.5.1}}

The folder depends on the application:
<pre>
<sd-card>/Android/data/com.augmensys.ubik.<custom_app>/files/cert
</pre>

=== Certificate list ===
[[File:UBIK_Android_UI_Info_Activity_Certificate_List.png|400 px|thumb|border|alt=Certificate List|Certificate List]]

In the Info screen, there is a button {{key press|Show certificates}} that opens a list of all installed certificates, displaying their subject and expiry date. {{Version/AndroidSince|2.5.1}}

{{Attention|The certificate has to be provided as a X.509 DER encoded file, e.g. *.cer}}
{{Hint|The certificate will remain on the device even if the application is reinstalled.}}

{{Clear}}

= WinX / Web =
The clients, either WinX or Web, need to have a certificate installed if the connection to the web service should use secure communication (HTTPS). This certificate can either be a root authority certificate, a self-signed or any other public key certificate from a certificate authority enabling a secured connection between the web service and the clients.

If you already have a public key certificate available you can use this on the clients and web service. Otherwise you can create a certificate as described in [[HowTo:Create_UBIK_Web_Service_Certificates]].

As the {{UBIK Web}} client connects to the content server similar as any mobile client it needs also to be authorized using a certificate. Hence, whatever machine hosts the {{UBIK Web}} client application needs to have the certificate installed.

=== Install Root Authority Certificate ===
To import the certificate, start the certificate manager by entering ''Manage computer certificates'' in the Windows Start Screen (alternatively, start the program ''certmgr''):
# Go to section ''Trusted Root Certification Authorities'' and open the context menu.
# Click on ''All Tasks''
# Use ''Import...'' to import the Root Certificate provided as ''*.cer'' file.<br />[[File:UI_ClientCertification_ImportRootCertificate.png|700 px|Windows Certificaties Manager]]

<headertabs />
== See also ==
* [[HowTo:Install_UBIK_Web_Service|Install {{UBIK}} Web Service]]
* [[Web_Service_Configuration|Web Service Configuration]]

{{Category/Version|2.5.1}}

[[Category:2.5.1|Install UBIK Client Certificate]]
[[Category:Android|Install UBIK Client Certificate]]
[[Category:How-To|Install UBIK Client Certificate]]
[[Category:Installing|Install UBIK Client Certificate]]
[[Category:WinX|Install UBIK Client Certificate]]

HowTo:Install UBIK Client Certificate

2026-06-23T13:32:17Z

JKN: /* Android */

Setting up a client certificate for using a secure channel to the [[Web_Service|web service]].

= Android =

=== Manual installation ===
One can add server certificates to the {{UBIK Android}} application in addition to the pre-installed certificates, using a button in the ''Info'' menu. {{Version/AndroidSince|2.3.1}}

# Copy the certificate to your device's SD card where you can find it easily.
# Open the UBIK Android application.
# Press the ''Home'' button in the ''Action Bar''.
# Press the ''Info'' button in the drop-down menu.
# On the Info screen, press the ''Install Certificate'' button.
# Select a file browser in order to select the certificate file.
# Choose the certificate file you earlier copied to the device's SD card.

If the adding was successful, a toast message confirming the installation will appear. Else, the toast's text will indicate an error.

The certificate will be stored in a '''BouncyCastle''' keystore on the device's file system (path: ''SD-Card/UBIK/Certificates'').
This means you can copy this keystore and reuse it on another device by pasting it there!

{{Attention|A file browser app has to be installed on your device in order to select the certificate file from the SD-card.}}

=== Automatic Import ===
One can place certificate files in a predefined folder in order for them to be imported automatically when the app starts up the next time. {{Version/AndroidSince|2.5.1}}

The folder depends on the application:
<pre>
<sd-card>/Android/data/com.augmensys.ubik.<custom_app>/files/cert
</pre>

=== Certificate list ===
[[File:UBIK_Android_UI_Info_Activity_Certificate_List.png|400 px|thumb|border|alt=Certificate List|Certificate List]]

In the Info screen, there is a button {{key press|Show certificates}} that opens a list of all installed certificates, displaying their subject and expiry date. {{Version/AndroidSince|2.5.1}}

{{Attention|The certificate has to be provided as a X.509 DER encoded file, e.g. *.cer}}
{{Hint|The certificate will remain on the device even if the application is reinstalled.}}

{{Clear}}

[[Category:2.5.1|Install UBIK Client Certificate]]
[[Category:Android|Install UBIK Client Certificate]]
[[Category:How-To|Install UBIK Client Certificate]]
[[Category:Installing|Install UBIK Client Certificate]]
[[Category:WinX|Install UBIK Client Certificate]]

= WinX / Web =
The clients, either WinX or Web, need to have a certificate installed if the connection to the web service should use secure communication (HTTPS). This certificate can either be a root authority certificate, a self-signed or any other public key certificate from a certificate authority enabling a secured connection between the web service and the clients.

If you already have a public key certificate available you can use this on the clients and web service. Otherwise you can create a certificate as described in [[HowTo:Create_UBIK_Web_Service_Certificates]].

As the {{UBIK Web}} client connects to the content server similar as any mobile client it needs also to be authorized using a certificate. Hence, whatever machine hosts the {{UBIK Web}} client application needs to have the certificate installed.

=== Install Root Authority Certificate ===
To import the certificate, start the certificate manager by entering ''Manage computer certificates'' in the Windows Start Screen (alternatively, start the program ''certmgr''):
# Go to section ''Trusted Root Certification Authorities'' and open the context menu.
# Click on ''All Tasks''
# Use ''Import...'' to import the Root Certificate provided as ''*.cer'' file.<br />[[File:UI_ClientCertification_ImportRootCertificate.png|700 px|Windows Certificaties Manager]]

<headertabs />
== See also ==
* [[HowTo:Install_UBIK_Web_Service|Install {{UBIK}} Web Service]]
* [[Web_Service_Configuration|Web Service Configuration]]

{{Category/Version|2.5.1}}

[[Category:2.5.1|Install UBIK Client Certificate]]
[[Category:Android|Install UBIK Client Certificate]]
[[Category:How-To|Install UBIK Client Certificate]]
[[Category:Installing|Install UBIK Client Certificate]]
[[Category:WinX|Install UBIK Client Certificate]]

HowTo:Install UBIK Client Certificate

2026-06-23T13:31:46Z

JKN: /* Android */

Setting up a client certificate for using a secure channel to the [[Web_Service|web service]].

= Android =
{{DeprecatedStartTag}}
=== Manual installation ===
One can add server certificates to the {{UBIK Android}} application in addition to the pre-installed certificates, using a button in the ''Info'' menu. {{Version/AndroidSince|2.3.1}}

# Copy the certificate to your device's SD card where you can find it easily.
# Open the UBIK Android application.
# Press the ''Home'' button in the ''Action Bar''.
# Press the ''Info'' button in the drop-down menu.
# On the Info screen, press the ''Install Certificate'' button.
# Select a file browser in order to select the certificate file.
# Choose the certificate file you earlier copied to the device's SD card.

If the adding was successful, a toast message confirming the installation will appear. Else, the toast's text will indicate an error.

The certificate will be stored in a '''BouncyCastle''' keystore on the device's file system (path: ''SD-Card/UBIK/Certificates'').
This means you can copy this keystore and reuse it on another device by pasting it there!

{{Attention|A file browser app has to be installed on your device in order to select the certificate file from the SD-card.}}

=== Automatic Import ===
One can place certificate files in a predefined folder in order for them to be imported automatically when the app starts up the next time. {{Version/AndroidSince|2.5.1}}

The folder depends on the application:
<pre>
<sd-card>/Android/data/com.augmensys.ubik.<custom_app>/files/cert
</pre>

=== Certificate list ===
[[File:UBIK_Android_UI_Info_Activity_Certificate_List.png|400 px|thumb|border|alt=Certificate List|Certificate List]]

In the Info screen, there is a button {{key press|Show certificates}} that opens a list of all installed certificates, displaying their subject and expiry date. {{Version/AndroidSince|2.5.1}}

{{Attention|The certificate has to be provided as a X.509 DER encoded file, e.g. *.cer}}
{{Hint|The certificate will remain on the device even if the application is reinstalled.}}

{{Clear}}

[[Category:2.5.1|Install UBIK Client Certificate]]
[[Category:Android|Install UBIK Client Certificate]]
[[Category:How-To|Install UBIK Client Certificate]]
[[Category:Installing|Install UBIK Client Certificate]]
[[Category:WinX|Install UBIK Client Certificate]]

= WinX / Web =
The clients, either WinX or Web, need to have a certificate installed if the connection to the web service should use secure communication (HTTPS). This certificate can either be a root authority certificate, a self-signed or any other public key certificate from a certificate authority enabling a secured connection between the web service and the clients.

If you already have a public key certificate available you can use this on the clients and web service. Otherwise you can create a certificate as described in [[HowTo:Create_UBIK_Web_Service_Certificates]].

As the {{UBIK Web}} client connects to the content server similar as any mobile client it needs also to be authorized using a certificate. Hence, whatever machine hosts the {{UBIK Web}} client application needs to have the certificate installed.

=== Install Root Authority Certificate ===
To import the certificate, start the certificate manager by entering ''Manage computer certificates'' in the Windows Start Screen (alternatively, start the program ''certmgr''):
# Go to section ''Trusted Root Certification Authorities'' and open the context menu.
# Click on ''All Tasks''
# Use ''Import...'' to import the Root Certificate provided as ''*.cer'' file.<br />[[File:UI_ClientCertification_ImportRootCertificate.png|700 px|Windows Certificaties Manager]]

<headertabs />
== See also ==
* [[HowTo:Install_UBIK_Web_Service|Install {{UBIK}} Web Service]]
* [[Web_Service_Configuration|Web Service Configuration]]

{{Category/Version|2.5.1}}

[[Category:2.5.1|Install UBIK Client Certificate]]
[[Category:Android|Install UBIK Client Certificate]]
[[Category:How-To|Install UBIK Client Certificate]]
[[Category:Installing|Install UBIK Client Certificate]]
[[Category:WinX|Install UBIK Client Certificate]]

AI Assist

2026-06-17T09:47:15Z

JKN: /* General */

{{UBIK_Labs_Disclaimer}}
{{Attention|AI Support is currently a preview feature and not available in an official product release. Please contact us to get access to a respective version!}}

== General ==
All AI functionality in {{UBIK}} requires Internet connectivity, so there is no offline support for these features. The AI features are based and built for an Azure OpenAI deployment with a '''GPT4.1 or higher''' model, other models are currently not supported.

== Configuration ==

===Mobile===
Configuration of the AI can be achieved by a designated object in the infrastructure of the App/Context of the use case that needs AI support. The object needs to have the UID <code>D4F3E8C2-5B6A-4F2A-9C1E-1234567890AB</code> and carry a string property with the name <code>AICONFIG</code>. On this property a JSON configuration can be stored, that has the following structure:

<source lang="xml">
{
"API_URI": "https://api.example.com/v1/ai",
"API_KEY": "your-api-key-here",
"AddToPrompt": ""
}
</source>

* <code>API_URI</code> The URL to your Azure OpenAI endpoint
* <code>API_KEY</code> The API key of your Azure OpenAI deployment
* <code>AddToPrompt</code> A natural text you want to add to the system prompt, which can be used to fine tune the AI. '''Example:''' for the Context AI Assistant it could be set to ''"Add 'Your friendly AI Assistant.' in a random language to every ResponseText"''. From there on, every reply from the AI would be amendend with this phrase translated into a language of it's choice.

===Web===
For WebClients, the configuration must be stored in appconfig.json:

<source lang="xml">
"AI": {
"API_URI": "https://api.example.com/v1/ai",
"API_KEY": "your-api-key-here",
"AddToPrompt": ""
}
</source>

{{Attention|If there's no configuration found, the AI features will not work and you will get a respective message in the chat window!}}

== BPM AI Assistant ==
This is an assistant trained for creating checklist in BPM format, in conjunction with upcoming graphical Procedure Designer for Web Clients.

== Context AI Assistant ==
This is an assistant for mobile clients, that allows to discuss the current context object (the object the user currently looks at on the mobile device) with the AI. It is also capable of modifying properties of this context object, in the name of the currently logged in user. In addition, it can leverage the client's free text search to answer questions beyond its current context.

=== XAML customizing ===

{{Attention|The AIAssistant control is currently only available for AI-enabled [[Version 5.0 (MAUI)|MAUI]] clients!}}

The AIAssistant needs to be placed somewhere in [[XAML]] customizing, this example shows how to put it in an additional tab after the default Children, Properties and Documents tab in ''UBIKContentArea.xamlx'':

<source lang="xml">
xmlns:ai="clr-namespace:UBIK.MAUI.Controls.AI;assembly=UBIK.MAUI"
<tabView:SfTabItem>
<tabView:SfTabItem.ImageSource>
<FontImageSource Glyph="" FontFamily="{StaticResource FASymbols}"/>
</tabView:SfTabItem.ImageSource>
<tabView:SfTabItem.Content>
<ai:AIAssistant />
</tabView:SfTabItem.Content>
<tabView:SfTabItem.Triggers>
<DataTrigger TargetType="tabView:SfTabItem" Binding="{Binding SelectedIndex, Source={x:Reference ContentTabs}}" Value="3">
<Setter Property="Header" Value="AI Assistant" />
</DataTrigger>
</tabView:SfTabItem.Triggers>
</tabView:SfTabItem>
</source>

AI Assist

2026-06-17T09:30:07Z

JKN: /* Configuration */

{{UBIK_Labs_Disclaimer}}
{{Attention|AI Support is currently a preview feature and not available in an official product release. Please contact us to get access to a respective version!}}

== General ==
All AI functionality in {{UBIK}} requires Internet connectivity, so there is no offline support for these features. The AI features are based and built for an Azure OpenAI deployment with a GPT4.1 model, other models are currently not supported.

== Configuration ==

===Mobile===
Configuration of the AI can be achieved by a designated object in the infrastructure of the App/Context of the use case that needs AI support. The object needs to have the UID <code>D4F3E8C2-5B6A-4F2A-9C1E-1234567890AB</code> and carry a string property with the name <code>AICONFIG</code>. On this property a JSON configuration can be stored, that has the following structure:

<source lang="xml">
{
"API_URI": "https://api.example.com/v1/ai",
"API_KEY": "your-api-key-here",
"AddToPrompt": ""
}
</source>

* <code>API_URI</code> The URL to your Azure OpenAI endpoint
* <code>API_KEY</code> The API key of your Azure OpenAI deployment
* <code>AddToPrompt</code> A natural text you want to add to the system prompt, which can be used to fine tune the AI. '''Example:''' for the Context AI Assistant it could be set to ''"Add 'Your friendly AI Assistant.' in a random language to every ResponseText"''. From there on, every reply from the AI would be amendend with this phrase translated into a language of it's choice.

===Web===
For WebClients, the configuration must be stored in appconfig.json:

<source lang="xml">
"AI": {
"API_URI": "https://api.example.com/v1/ai",
"API_KEY": "your-api-key-here",
"AddToPrompt": ""
}
</source>

{{Attention|If there's no configuration found, the AI features will not work and you will get a respective message in the chat window!}}

== BPM AI Assistant ==
This is an assistant trained for creating checklist in BPM format, in conjunction with upcoming graphical Procedure Designer for Web Clients.

== Context AI Assistant ==
This is an assistant for mobile clients, that allows to discuss the current context object (the object the user currently looks at on the mobile device) with the AI. It is also capable of modifying properties of this context object, in the name of the currently logged in user. In addition, it can leverage the client's free text search to answer questions beyond its current context.

=== XAML customizing ===

{{Attention|The AIAssistant control is currently only available for AI-enabled [[Version 5.0 (MAUI)|MAUI]] clients!}}

The AIAssistant needs to be placed somewhere in [[XAML]] customizing, this example shows how to put it in an additional tab after the default Children, Properties and Documents tab in ''UBIKContentArea.xamlx'':

<source lang="xml">
xmlns:ai="clr-namespace:UBIK.MAUI.Controls.AI;assembly=UBIK.MAUI"
<tabView:SfTabItem>
<tabView:SfTabItem.ImageSource>
<FontImageSource Glyph="" FontFamily="{StaticResource FASymbols}"/>
</tabView:SfTabItem.ImageSource>
<tabView:SfTabItem.Content>
<ai:AIAssistant />
</tabView:SfTabItem.Content>
<tabView:SfTabItem.Triggers>
<DataTrigger TargetType="tabView:SfTabItem" Binding="{Binding SelectedIndex, Source={x:Reference ContentTabs}}" Value="3">
<Setter Property="Header" Value="AI Assistant" />
</DataTrigger>
</tabView:SfTabItem.Triggers>
</tabView:SfTabItem>
</source>

AI Assist

2026-05-19T12:50:31Z

JKN: /* Context AI Assistant */

{{UBIK_Labs_Disclaimer}}
{{Attention|AI Support is currently a preview feature and not available in an official product release. Please contact us to get access to a respective version!}}

== General ==
All AI functionality in {{UBIK}} requires Internet connectivity, so there is no offline support for these features. The AI features are based and built for an Azure OpenAI deployment with a GPT4.1 model, other models are currently not supported.

== Configuration ==
Configuration of the AI can be achieved by a designated object in the infrastructure of the App/Context of the use case that needs AI support. The object needs to have the UID <code>D4F3E8C2-5B6A-4F2A-9C1E-1234567890AB</code> and carry a string property with the name <code>AICONFIG</code>. On this property a JSON configuration can be stored, that has the following structure:

<source lang="xml">
{
"API_URI": "https://api.example.com/v1/ai",
"API_KEY": "your-api-key-here",
"AddToPrompt": ""
}
</source>

* <code>API_URI</code> The URL to your Azure OpenAI endpoint
* <code>API_KEY</code> The API key of your Azure OpenAI deployment
* <code>AddToPrompt</code> A natural text you want to add to the system prompt, which can be used to fine tune the AI. '''Example:''' for the Context AI Assistant it could be set to ''"Add 'Your friendly AI Assistant.' in a random language to every ResponseText"''. From there on, every reply from the AI would be amendend with this phrase translated into a language of it's choice.

{{Attention|If there's no configuration object found in the infrastructure, the AI features will not work and you will get a respective message in the chat window!}}

== BPM AI Assistant ==
This is an assistant trained for creating checklist in BPM format, in conjunction with upcoming graphical Procedure Designer for Web Clients.

== Context AI Assistant ==
This is an assistant for mobile clients, that allows to discuss the current context object (the object the user currently looks at on the mobile device) with the AI. It is also capable of modifying properties of this context object, in the name of the currently logged in user. In addition, it can leverage the client's free text search to answer questions beyond its current context.

=== XAML customizing ===

{{Attention|The AIAssistant control is currently only available for AI-enabled [[Version 5.0 (MAUI)|MAUI]] clients!}}

The AIAssistant needs to be placed somewhere in [[XAML]] customizing, this example shows how to put it in an additional tab after the default Children, Properties and Documents tab in ''UBIKContentArea.xamlx'':

<source lang="xml">
xmlns:ai="clr-namespace:UBIK.MAUI.Controls.AI;assembly=UBIK.MAUI"
<tabView:SfTabItem>
<tabView:SfTabItem.ImageSource>
<FontImageSource Glyph="" FontFamily="{StaticResource FASymbols}"/>
</tabView:SfTabItem.ImageSource>
<tabView:SfTabItem.Content>
<ai:AIAssistant />
</tabView:SfTabItem.Content>
<tabView:SfTabItem.Triggers>
<DataTrigger TargetType="tabView:SfTabItem" Binding="{Binding SelectedIndex, Source={x:Reference ContentTabs}}" Value="3">
<Setter Property="Header" Value="AI Assistant" />
</DataTrigger>
</tabView:SfTabItem.Triggers>
</tabView:SfTabItem>
</source>

AI Assist

2026-05-19T12:47:53Z

JKN: /* Configuration */

{{UBIK_Labs_Disclaimer}}
{{Attention|AI Support is currently a preview feature and not available in an official product release. Please contact us to get access to a respective version!}}

== General ==
All AI functionality in {{UBIK}} requires Internet connectivity, so there is no offline support for these features. The AI features are based and built for an Azure OpenAI deployment with a GPT4.1 model, other models are currently not supported.

== Configuration ==
Configuration of the AI can be achieved by a designated object in the infrastructure of the App/Context of the use case that needs AI support. The object needs to have the UID <code>D4F3E8C2-5B6A-4F2A-9C1E-1234567890AB</code> and carry a string property with the name <code>AICONFIG</code>. On this property a JSON configuration can be stored, that has the following structure:

<source lang="xml">
{
"API_URI": "https://api.example.com/v1/ai",
"API_KEY": "your-api-key-here",
"AddToPrompt": ""
}
</source>

* <code>API_URI</code> The URL to your Azure OpenAI endpoint
* <code>API_KEY</code> The API key of your Azure OpenAI deployment
* <code>AddToPrompt</code> A natural text you want to add to the system prompt, which can be used to fine tune the AI. '''Example:''' for the Context AI Assistant it could be set to ''"Add 'Your friendly AI Assistant.' in a random language to every ResponseText"''. From there on, every reply from the AI would be amendend with this phrase translated into a language of it's choice.

{{Attention|If there's no configuration object found in the infrastructure, the AI features will not work and you will get a respective message in the chat window!}}

== BPM AI Assistant ==
This is an assistant trained for creating checklist in BPM format, in conjunction with upcoming graphical Procedure Designer for Web Clients.

== Context AI Assistant ==
This is an assistant for mobile clients, that allows to discuss the current context object (the object the user currently looks at on teh mobile device) with the AI. It is also capable of modifying properties of this context object, in the name of the currently logged in user.

=== XAML customizing ===

{{Attention|The AIAssistant control is currently only available for AI-enabled [[Version 5.0 (MAUI)|MAUI]] clients!}}

The AIAssistant needs to be placed somewhere in [[XAML]] customizing, this example shows how to put it in an additional tab after the default Children, Properties and Documents tab in ''UBIKContentArea.xamlx'':

<source lang="xml">
xmlns:ai="clr-namespace:UBIK.MAUI.Controls.AI;assembly=UBIK.MAUI"
<tabView:SfTabItem>
<tabView:SfTabItem.ImageSource>
<FontImageSource Glyph="" FontFamily="{StaticResource FASymbols}"/>
</tabView:SfTabItem.ImageSource>
<tabView:SfTabItem.Content>
<ai:AIAssistant />
</tabView:SfTabItem.Content>
<tabView:SfTabItem.Triggers>
<DataTrigger TargetType="tabView:SfTabItem" Binding="{Binding SelectedIndex, Source={x:Reference ContentTabs}}" Value="3">
<Setter Property="Header" Value="AI Assistant" />
</DataTrigger>
</tabView:SfTabItem.Triggers>
</tabView:SfTabItem>
</source>

What is UBIK

2026-03-04T12:23:54Z

JKN:

{{otherlang
| title=What is UBIK
| de=Was ist UBIK
}}

{{UBIK}} is a powerful platform for creating Augmented Reality–enabled mobile solutions designed for industrial environments.

It enables the development of flexible, high‑performance object models that unify data from virtually any source—whether imported once, synchronized regularly, or retrieved on demand. These models are published through a WebService and can be consumed by {{UBIK}} mobile devices, which overlay geo‑ or marker-referenced information as intuitive AR bubbles directly in the camera view.

[[File:IL_ProjectFlow.png|500px]]

=={{UBIK}} Highlights==

[[Design object-oriented data models]]
*Use [[Polymorphism]] and [[inheritance]] to build rich, reusable [[UBIK objects|UBIK object]] models
*Define arbitrary [[relations]] between objects
*Implement runtime behavior in [[:Category:Coding|native code]] or visual [[:Category:Workflow|Workflows]]
*Configure [[Views]] to shape how users experience the objects

[[Release data model]]
*[[Compiler|Compile]] object models into native code and relational structures
*Navigate data object‑oriented while benefiting from the integrity and performance of an RDBMS
*Deploy to on‑premise infrastructure, the cloud, or hybrid environments

[[Interface to data sources]]
*Integrate using standard [[:Category:Interfacing|interfaces]] such as ISO15926
*Create custom interface plugins for any available data source
*Use [[Proxy|proxies]] to manage data versions and consistency
*Control interface behavior and data consolidation workflows

[[Publish data model]]
*Define [[Application Context Management|application contexts]] and role‑based access
*Link contexts to views for tailored user experiences
*Push updates to mobile devices instantly

[[Use data in the field]]
*Aim a mobile device at objects to access information instantly
*Drill down into detailed data—fast, secure, and always up‑to‑date
*Work with the full published data model directly on the device
*Edit information on site and sync it back to the server and source systems
*Capture photos or voice notes to enrich your data
*Teach in new objects directly in the field using geo‑positioning

[[Category:UBIK|What is UBIK]]

What is UBIK

2026-03-04T12:22:57Z

JKN:

{{otherlang
| title=What is UBIK
| de=Was ist UBIK
}}

{{UBIK}} is a powerful platform for creating Augmented Reality–enabled mobile solutions designed for industrial environments.

It enables the development of flexible, high‑performance object models that unify data from virtually any source—whether imported once, synchronized regularly, or retrieved on demand. These models are published through a WebService and can be consumed by {{UBIK}} mobile devices, which overlay geo‑referenced information as intuitive AR bubbles directly in the camera view.

[[File:IL_ProjectFlow.png|500px]]

=={{UBIK}} Highlights==

[[Design object-oriented data models]]
*Use [[Polymorphism]] and [[inheritance]] to build rich, reusable [[UBIK objects|UBIK object]] models
*Define arbitrary [[relations]] between objects
*Implement runtime behavior in [[:Category:Coding|native code]] or visual [[:Category:Workflow|Workflows]]
*Configure [[Views]] to shape how users experience the objects

[[Release data model]]
*[[Compiler|Compile]] object models into native code and relational structures
*Navigate data object‑oriented while benefiting from the integrity and performance of an RDBMS
*Deploy to on‑premise infrastructure, the cloud, or hybrid environments

[[Interface to data sources]]
*Integrate using standard [[:Category:Interfacing|interfaces]] such as ISO15926
*Create custom interface plugins for any available data source
*Use [[Proxy|proxies]] to manage data versions and consistency
*Control interface behavior and data consolidation workflows

[[Publish data model]]
*Define [[Application Context Management|application contexts]] and role‑based access
*Link contexts to views for tailored user experiences
*Push updates to mobile devices instantly

[[Use data in the field]]
*Aim a mobile device at objects to access information instantly
*Drill down into detailed data—fast, secure, and always up‑to‑date
*Work with the full published data model directly on the device
*Edit information on site and sync it back to the server and source systems
*Capture photos or voice notes to enrich your data
*Teach in new objects directly in the field using geo‑positioning

[[Category:UBIK|What is UBIK]]

What is UBIK

2026-02-04T15:57:01Z

JKN:

{{otherlang
| title=What is UBIK
| de=Was ist UBIK
}}

{{UBIK}} is a comprehensive product for enabling Augmented Reality supported mobile solutions in industrial environments.

It allows the creation of flexible, high performance object models that are capable of consolidating data from almost any sources, either as a onetime effort, on a frequent basis or just on demand whenever it is needed. These models are exposed to a WebService and can be subscribed by {{UBIK}} mobile devices, which crossfade the objects as bubbles into the camera view, based on their geo-position.

[[File:IL_ProjectFlow.png|500px]]

=={{UBIK}} Features==

[[Design object-oriented data models]]
*Use [[Polymorphism]] and [[inheritance]] to create [[UBIK objects]]
*Define arbitrary [[relations]] between objects
*Program runtime behavior of your objects in [[:Category:Coding|native code]] or visual [[:Category:Workflow|Workflows]]
*Configure [[Views]] to control how users see the objects

[[Release data model]]
*[[Compiler|Compile]] object model to native code and relational data
*Navigate through data still object-oriented, but with the integrity and performance of an RDBMS
*Deploy to on-premise infrastructure and/or the cloud

[[Interface to data sources]]
*Leverage standard [[:Category:Interfacing|interfaces]], i.e. ISO15926
*Create custom interface plugins, to any available source
*Use [[Proxy|proxies]] to control your data versions
*Manage interface behavior and consolidation workflows

[[Publish data model]]
*Define [[Application Context Management|contexts for applications]] and/or roles
*Link contexts to views
*Interact with mobile devices at the push of a button

[[Use data in the field]]
*Aim mobile device on objects and get information instantly
*Zoom into more detailed information, fast and secure
*Have access to the full published data model of the server
*Edit data in the field and save it back to the server, thus even to the sources
*Record pictures or voice messages and enrich your data input
*Teach in new objects directly in the field, based on your geo-position

[[Category:UBIK|What is UBIK]]

AI Assist

2025-11-13T10:52:23Z

JKN:

{{Attention|AI Support is currently a preview feature and not available in an official product release. Please contact us to get access to a respective version!}}

== General ==
All AI functionality in {{UBIK}} requires Internet connectivity, so there is no offline support for these features. The AI features are based and built for an Azure OpenAI deployment with a GPT4.1 model, other models are currently not supported.

== Configuration ==
Configuration of the AI can be achieved by a designated object in the infrastructure of the App/Context of the use case that needs AI support. The object needs to have the UID <code>D4F3E8C2-5B6A-4F2A-9C1E-1234567890AB</code> and carry a string property with the name <code>AICONFIG</code>. On this property a JSON configuration can be stored, that has the following structure:

<source lang="xml">
{
"API_URI": "https://api.example.com/v1/ai",
"API_KEY": "your-api-key-here",
"AddToPrompt": ""
}
</source>

* <code>API_URI</code> The URL to your Azure OpenAI endpoint
* <code>API_KEY</code> The API key of your Azure OpenAI deployment
* <code>AddToPrompt</code> A natural text you want to add to the system prompt, which can be used to fine tune the AI. '''Example:''' for the Context AI Assistant it could be set to ''"Add 'Your friendly AI Assistant.' in a random language to every ResponseText"''. From there on, every reply from the AI would be amendend with this phrase translated into a language of it's choice.

{{Attention|If there's no configuration object found in the infrastructure, the AI will fall back to use Augmensys' demo OpenAI deployment!}}

== BPM AI Assistant ==
This is an assistant trained for creating checklist in BPM format, in conjunction with upcoming graphical Procedure Designer for Web Clients.

== Context AI Assistant ==
This is an assistant for mobile clients, that allows to discuss the current context object (the object the user currently looks at on teh mobile device) with the AI. It is also capable of modifying properties of this context object, in the name of the currently logged in user.

=== XAML customizing ===

{{Attention|The AIAssistant control is currently only available for AI-enabled [[Version 5.0 (MAUI)|MAUI]] clients!}}

The AIAssistant needs to be placed somewhere in [[XAML]] customizing, this example shows how to put it in an additional tab after the default Children, Properties and Documents tab in ''UBIKContentArea.xamlx'':

<source lang="xml">
xmlns:ai="clr-namespace:UBIK.MAUI.Controls.AI;assembly=UBIK.MAUI"
<tabView:SfTabItem>
<tabView:SfTabItem.ImageSource>
<FontImageSource Glyph="" FontFamily="{StaticResource FASymbols}"/>
</tabView:SfTabItem.ImageSource>
<tabView:SfTabItem.Content>
<ai:AIAssistant />
</tabView:SfTabItem.Content>
<tabView:SfTabItem.Triggers>
<DataTrigger TargetType="tabView:SfTabItem" Binding="{Binding SelectedIndex, Source={x:Reference ContentTabs}}" Value="3">
<Setter Property="Header" Value="AI Assistant" />
</DataTrigger>
</tabView:SfTabItem.Triggers>
</tabView:SfTabItem>
</source>

AI Assist

2025-11-13T09:52:07Z

JKN: /* Configuration */

{{Attention|AI Support is currently a preview feature and not available in an official product release. Please contact us to get access to a respective version!}}

== General ==
All AI functionality in {{UBIK}} requires Internet connectivity, so there is no offline support for these features. The AI features are based and built for an Azure OpenAI deployment with a GPT4.1 model, other models are currently not supported.

== Configuration ==
Configuration of the AI can be achieved by a designated object in the infrastructure of the App/Context of the use case that needs AI support. The object needs to have the UID <code>D4F3E8C2-5B6A-4F2A-9C1E-1234567890AB</code> and carry a string property with the name <code>AICONFIG</code>. On this property a JSON configuration can be stored, that has the following structure:

<source lang="xml">
{
"API_URI": "https://api.example.com/v1/ai",
"API_KEY": "your-api-key-here",
"AddToPrompt": ""
}
</source>

* <code>API_URI</code> The URL to your Azure OpenAI endpoint
* <code>API_KEY</code> The API key of your Azure OpenAI deployment
* <code>AddToPrompt</code> A natural text you want to add to the system prompt, which can be used to fine tune the AI. '''Example:''' for the Context AI Assistant it could be set to ''"Add 'Your friendly AI Assistant.' in a random language to every ResponseText"''. From there on, every reply from the AI would be amendend with this phrase translated into a language of it's choice.

== BPM AI Assistant ==
This is an assistant trained for creating checklist in BPM format, in conjunction with upcoming graphical Procedure Designer for Web Clients.

== Context AI Assistant ==
This is an assistant for mobile clients, that allows to discuss the current context object (the object the user currently looks at on teh mobile device) with the AI. It is also capable of modifying properties of this context object, in the name of the currently logged in user.

=== XAML customizing ===

{{Attention|The AIAssistant control is currently only available for AI-enabled [[Version 5.0 (MAUI)|MAUI]] clients!}}

The AIAssistant needs to be placed somewhere in [[XAML]] customizing, this example shows how to put it in an additional tab after the default Children, Properties and Documents tab in ''UBIKContentArea.xamlx'':

<source lang="xml">
xmlns:ai="clr-namespace:UBIK.MAUI.Controls.AI;assembly=UBIK.MAUI"
<tabView:SfTabItem>
<tabView:SfTabItem.ImageSource>
<FontImageSource Glyph="" FontFamily="{StaticResource FASymbols}"/>
</tabView:SfTabItem.ImageSource>
<tabView:SfTabItem.Content>
<ai:AIAssistant />
</tabView:SfTabItem.Content>
<tabView:SfTabItem.Triggers>
<DataTrigger TargetType="tabView:SfTabItem" Binding="{Binding SelectedIndex, Source={x:Reference ContentTabs}}" Value="3">
<Setter Property="Header" Value="AI Assistant" />
</DataTrigger>
</tabView:SfTabItem.Triggers>
</tabView:SfTabItem>
</source>

AI Assist

2025-11-13T09:49:58Z

JKN:

{{Attention|AI Support is currently a preview feature and not available in an official product release. Please contact us to get access to a respective version!}}

== General ==
All AI functionality in {{UBIK}} requires Internet connectivity, so there is no offline support for these features. The AI features are based and built for an Azure OpenAI deployment with a GPT4.1 model, other models are currently not supported.

== Configuration ==
Configuration of the AI can be achieved by a designated object in the infrastructure of the App/Context of the use case that needs AI support. The object needs to have the UID <code>D4F3E8C2-5B6A-4F2A-9C1E-1234567890AB</code> and carry a string property with the name <code>AICONFIG</code>. On this property a JSON configuration can be stored, that has the following structure:

<source lang="xml">
{
"API_URI": "https://api.example.com/v1/ai",
"API_KEY": "your-api-key-here",
"AddToPrompt": ""
}
</source>

* <code>API_URI</code> The URL to your Azure OpenAI endpoint
* <code>API_KEY</code> The API key of your Azure OpenAI deployment
* <code>AddToPrompt</code> A natural text you want to add to the system prompt, which can be used to fine tune the AI. Example: for the Context AI Assistant it could be set to ''"Add 'Your friendly AI Assistant.' in a random language to every ResponseText"''. From there on, every reply from the AI would be amendend with this phrase translated into a language f it's choice.

== BPM AI Assistant ==
This is an assistant trained for creating checklist in BPM format, in conjunction with upcoming graphical Procedure Designer for Web Clients.

== Context AI Assistant ==
This is an assistant for mobile clients, that allows to discuss the current context object (the object the user currently looks at on teh mobile device) with the AI. It is also capable of modifying properties of this context object, in the name of the currently logged in user.

=== XAML customizing ===

{{Attention|The AIAssistant control is currently only available for AI-enabled [[Version 5.0 (MAUI)|MAUI]] clients!}}

The AIAssistant needs to be placed somewhere in [[XAML]] customizing, this example shows how to put it in an additional tab after the default Children, Properties and Documents tab in ''UBIKContentArea.xamlx'':

<source lang="xml">
xmlns:ai="clr-namespace:UBIK.MAUI.Controls.AI;assembly=UBIK.MAUI"
<tabView:SfTabItem>
<tabView:SfTabItem.ImageSource>
<FontImageSource Glyph="" FontFamily="{StaticResource FASymbols}"/>
</tabView:SfTabItem.ImageSource>
<tabView:SfTabItem.Content>
<ai:AIAssistant />
</tabView:SfTabItem.Content>
<tabView:SfTabItem.Triggers>
<DataTrigger TargetType="tabView:SfTabItem" Binding="{Binding SelectedIndex, Source={x:Reference ContentTabs}}" Value="3">
<Setter Property="Header" Value="AI Assistant" />
</DataTrigger>
</tabView:SfTabItem.Triggers>
</tabView:SfTabItem>
</source>

AI Assist

2025-11-13T09:45:00Z

JKN: Created page with "{{Attention|AI Support is currently a preview feature and not available in an official product release. Please contact us to get access to a respective version!}} == General..."

{{Attention|AI Support is currently a preview feature and not available in an official product release. Please contact us to get access to a respective version!}}

== General ==
All AI functionality in {{UBIK}} requires Internet connectivity, so there is no offline support for these features.

== Configuration ==
Configuration of the AI can be achieved by a designated object in the infrastructure of the App/Context of the use case that needs AI support. The object needs to have the UID <code>D4F3E8C2-5B6A-4F2A-9C1E-1234567890AB</code> and carry a string property with the name <code>AICONFIG</code>. On this property a JSON configuration can be stored, that has the following structure:

<source lang="xml">
{
"API_URI": "https://api.example.com/v1/ai",
"API_KEY": "your-api-key-here",
"AddToPrompt": ""
}
</source>

* <code>API_URI</code> The URL to your Azure OpenAI endpoint
* <code>API_KEY</code> The API key of your Azure OpenAI deployment
* <code>AddToPrompt</code> A natural text you want to add to the system prompt, which can be used to fine tune the AI. Example: for the Context AI Assistant it could be set to ''"Add 'Your friendly AI Assistant.' in a random language to every ResponseText"''. From there on, every reply from the AI would be amendend with this phrase translated into a language f it's choice.

== BPM AI Assistant ==
This is an assistant trained for creating checklist in BPM format, in conjunction with upcoming graphical Procedure Designer for Web Clients.

== Context AI Assistant ==
This is an assistant for mobile clients, that allows to discuss the current context object (the object the user currently looks at on teh mobile device) with the AI. It is also capable of modifying properties of this context object, in the name of the currently logged in user.

=== XAML customizing ===

{{Attention|The AIAssistant control is currently only available for AI-enabled [[Version 5.0 (MAUI)|MAUI]] clients!}}

The AIAssistant needs to be placed somewhere in [[XAML]] customizing, this example shows how to put it in an additional tab after the default Children, Properties and Documents tab in ''UBIKContentArea.xamlx'':

<source lang="xml">
xmlns:ai="clr-namespace:UBIK.MAUI.Controls.AI;assembly=UBIK.MAUI"
<tabView:SfTabItem>
<tabView:SfTabItem.ImageSource>
<FontImageSource Glyph="" FontFamily="{StaticResource FASymbols}"/>
</tabView:SfTabItem.ImageSource>
<tabView:SfTabItem.Content>
<ai:AIAssistant />
</tabView:SfTabItem.Content>
<tabView:SfTabItem.Triggers>
<DataTrigger TargetType="tabView:SfTabItem" Binding="{Binding SelectedIndex, Source={x:Reference ContentTabs}}" Value="3">
<Setter Property="Header" Value="AI Assistant" />
</DataTrigger>
</tabView:SfTabItem.Triggers>
</tabView:SfTabItem>
</source>

Version 5

2025-11-13T09:07:30Z

JKN:

<noinclude>{{RoadmapDetailHeader}}</noinclude>

{{RoadmapDetailItem
| version=5.1
| date= December 2025
| status={{RoadmapChip-Announced|Future}}
| content=
{{RoadmapDetailFeature | product={{RoadmapChip-Studio}} | feature=Extended Plugin C# solution generation| descr=Possibility to design MetaClasses, MetaProperties and Custom Code for a UBIK plugin and generate a C# solution for it. }}
{{RoadmapDetailFeature | product={{RoadmapChip-Mobile}} | feature=Map view in mobile MAUI client | descr= }}
{{RoadmapDetailFeature | product={{RoadmapChip-Mobile}} | feature=Charts in mobile MAUI client | descr= }}
{{RoadmapDetailFeature | product={{RoadmapChip-Mobile}} | feature=Native push in mobile MAUI client | descr= }}
{{RoadmapDetailFeature | product={{RoadmapChip-Mobile}} | feature=POI view in mobile MAUI client | descr= }}
{{RoadmapDetailFeature | product={{RoadmapChip-Mobile}} | feature=Location service in mobile MAUI client | descr= }}
{{RoadmapDetailFeature | product={{RoadmapChip-Client}} | feature=Better control over file upload size | descr= }}
{{RoadmapDetailFeature | product={{RoadmapChip-Client}} | feature=Harder-to-miss branch download summary | descr= }}
{{RoadmapDetailFeature | product={{RoadmapChip-Client}} | feature=Improved save button design | descr= }}
}}

{{RoadmapDetailItem
| version=5.0
| date= September 2025
| status={{RoadmapChip-Announced|Current}}
| content=
{{RoadmapDetailFeature | product={{RoadmapChip-Studio}} | feature=Basic Plugin C# solution generation| descr=Possibility to configure plugins in UBIK.Studio, and to generate a C# solution from this configuration. }}
{{RoadmapDetailFeature | product={{RoadmapChip-Server}} | feature=Server MRO Procedures | descr=Introduces server-side support for managing and executing MRO (Maintenance, Repair, Overhaul) procedures. }}
{{RoadmapDetailFeature | product={{RoadmapChip-Mobile}} | feature=Mobile UBIK .NET MAUI Client | descr=Modernized UBIK mobile application built with .NET MAUI for cross-platform compatibility and improved performance. }}
{{RoadmapDetailFeature | product={{RoadmapChip-Client}} | feature=Improved branch download performance | descr=Improved the branch download performance especially when there are duplicate objects in multiple branches. }}
{{RoadmapDetailFeature | product={{RoadmapChip-Studio}} | feature=Studio Iterative Instance Data Transfer in SmartStudio | descr=Enables transferring instance data between environments or projects using iterative and controlled processes. }}
{{RoadmapDetailFeature | product={{RoadmapChip-Studio}} | feature=Studio Text-Markup Annotations support opacity now | descr=Annotations in SmartStudio now support opacity settings for better visual clarity and flexibility. }}
{{RoadmapDetailFeature | product={{RoadmapChip-Server}} | feature=Server UBIK supports the Exclusive Checkout Query now | descr=Enhances UBIK's versioning control with support for exclusive checkouts via query. }}
{{RoadmapDetailFeature | product={{RoadmapChip-Server}} | feature=Server Extended Archon License Information | descr=Archon licenses now include more detailed metadata and management information on the server. }}
{{RoadmapDetailFeature | product={{RoadmapChip-CUI}} | feature=Log CUI Web Request V2 | descr=Improved logging of CUI web requests for better traceability and debugging. }}
{{RoadmapDetailFeature | product={{RoadmapChip-Server}} | feature=Server UBIK Traits | descr=New support for defining and using Traits in the UBIK Server model - "Lightweight Properties" }}
{{RoadmapDetailFeature | product={{RoadmapChip-MaTaP}} | feature=MaTaP Blind List Management | descr=Adds functionality for blind list handling in MaTaP, improving confidentiality and targeting. }}
{{RoadmapDetailFeature | product={{RoadmapChip-Studio}} | feature=Bulk Editor UID Column | descr=A UID column can now be shown in UBIK.Studio's BulkEditor. }}
{{RoadmapDetailFeature | product={{RoadmapChip-Studio}} | feature=Load & Save Code in WhoBert | descr=WhoBert now provides a rich "Load & Save Code" feature. }}
}}

[[Category:Client|Version 5]]
[[Category:Release notes|Version 5]]
[[Category:Roadmap|Version 5]]
[[Category:Server|Version 5]]

Version 5.0 (Mobile)

2025-09-30T15:53:07Z

JKN: /* Known issues */

{{Attention|Existing pre 5.0 XAMLs are not compatible with UBIK Mobile client 5.0. Please refer to [[HowTo:Convert_Xamarin_XAMLs_to_Maui]] for migrating them to the new client.}}

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

{{Attention|The minimum supported OS versions are:
* Android 9;
* iOS 12.}}

== 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|Android: Store Preview}}: Available through Google Play Store's [https://play.google.com/store/apps/details?id=com.augmensys.ubik.go invitation link].

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

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

{{key press|Windows: Store Preview}}: The mobile Windows client is not an official product and is only distributed as test versions upon request and/or in our [https://release.augmensys.com/download/modules/client/mobile/ release portal].
<br/>

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

= Release Notes =

== Release ==

=== 5.0.? on 2025-10-? {{key press|Android: Store}}{{key press|iOS: Store}} ===
* Updated the notification message about branch download to avoid misunderstanding. When a branch download is in progress, you can work with the offline data which is already available at the time of the download, but any communication with the content server will be scheduled after the branch download is finished.

=== 5.0.209 on 2025-09-27 {{key press|Android: Store}} 5.0.207 on 2025-09-25 {{key press|iOS: Store}} ===
* UBIK GO is the cutting-edge evolution of Augmensys' trusted mobile client — rebuilt from the ground up with a modern architecture that unlocks unprecedented flexibility.
* Improved the branch download performance especially when there are duplicate objects in multiple branches.
* Updated some translations.
* Updated the default Demo profile.
* Fixed an issue that triggered a license warning even on a failed login.
* Fixed an issue where the wizard is shown again when you navigate to a new but saved object offline.
* Fixed an issue where duplicate notifications are shown when you scan an NFC tag for a supervisor task and no fitting supervisor is found.

== Known issues ==
* When changing the device orientation during attaching a photo on iOS, the app gets stuck. This is an issue Microsoft confirmed in .NET9 and will fix in .NET10.
* When editing Guid Link properties, you can no longer further edit the filtering if there are predefined filter parameters (such as the [[Dynamic_Selective_List_(Client)#Dependency_property_values|dependency property values in dynamic selective lists]]). This is because those parameters are to be enforced by design and should not be changed by users. In the future, we might consider a finer level of control over which parameters can be edited in such cases.
* 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.
* The periodic execution of background pushes is not guaranteed on iOS.
* There are still some [[Annotation_and_HotSpot#Known_issues|known issues with free text and text markup annotations]].
* It is currently not possible to select which camera to use for AR views (e.g. scan page) on Windows.
* SfPullToRefresh was removed due to [[Mobile_XAML#Issues_with_SfPullToRefresh_in_Mobile_client|existing issues]], and replaced with a Refresh option in the Context menu.
<br/>

[[Category:Client|Version 5.0 (Mobile)]]
[[Category:Mobile|Version 5.0 (Mobile)]]
[[Category:Version 5.0|Version 5.0 (Mobile)]]

= ⚠️ XAML Notes =
Due to the change of the underlying XAML technology, the existing XAMLs for the old mobile clients (pre 5.0) are no longer compatible. Please refer to [[HowTo:Convert_Xamarin_XAMLs_to_Maui]] for migrating them to the new client.

<headertabs />

[[Category:Client|Version 5.0 (Mobile)]]
[[Category:Mobile|Version 5.0 (Mobile)]]
[[Category:Version 5.0|Version 5.0 (Mobile)]]

HowTo:Install UBIK Database

2025-07-03T14:42:24Z

JKN:

All content and configuration data of {{UBIK}} is managed in a [http://www.microsoft.com/en-us/sqlserver/default.aspx Microsoft SQL] database (2012 or newer). Once the SQL server engines is installed successfully, an administrator can set up a new {{UBIK}} database simple using the available release database.

[[File:UI_SettingUpUBIKDatabase_01.png|thumb|alt=Microsoft SQL Server Management Studio|Microsoft SQL Server Management Studio]]
== Setting up {{UBIK}} database ==
# Start the ''Microsoft SQL Server Management Studio'' and connect to the database server
# Navigate to ''Databases'' and right click on ''Databases''→ select ''New database...''
# Right click on the newly created database and choose ''Tasks → Restore → Database'' from the context menu
## Choose the newly created database in the setting ''In database''
## Choose the copied backup file in ''From media''
## Check ''Restore'' of the according backup set <br/> [[File:Restore Database.PNG| 440px|border]]
# Switch to the options-slider and check ''Overwriting actual data'' (if necessary)
# Finish the process by clicking {{key press|OK}}

{{Attention|Use maintenance plans for periodic backup of your own and the system databases!}}

== Requirements ==
=== Database user ===
The database user configured in {{UBIK}} Studio used to connect to the database needs
* to have the role ''sys.admin'' assigned
* to be marked as ''Database owner'' (dbo) of the according {{UBIK}} database

=== Windows firewall ===
For a non-local SQL server make sure that the SQL server port (default: 1433) is unlocked by the Windows firewall Inbound and Exbound rules.

== See also ==
* [[FAQ:Installation_and_Configuration#Network|FAQ: Installation and Configuration / Network]]

[[Category:How-To|Install UBIK Database]]
[[Category:Installing|Install UBIK Database]]

XAML Tips

2025-05-14T09:23:27Z

JKN: /* Default Tab Selection */

== Attachable behaviors ==
It's quite often that you need to attach behaviors to certain XAML elements. For example, on a Grid, you want to attach a behavior which executes a command upon a Tapped event, or you want to execute a command when a certain property on a UBIK object changes.

Notice that in the following examples, "Interactivity" and "Core" are both namespaces and you have to make sure that they are defined at the root of your XAMLs:

<source lang = "xml">
<DataTemplate
...
xmlns:Core="using:Microsoft.Xaml.Interactions.Core"
xmlns:Interactivity="using:Microsoft.Xaml.Interactivity">
...
</DataTemplate>
</source>
<br>

=== Event Triggered ===
With an EventTriggerBehavior, you can react on changes/events of UI Elements:

<source lang = "xml">
<Grid>
<Interactivity:Interaction.Behaviors>
<Core:EventTriggerBehavior EventName="Tapped">
<Core:InvokeCommandAction Command="{Binding NavigateToChildrenCommand}" />
</Core:EventTriggerBehavior>
</Interactivity:Interaction.Behaviors>
</Grid>
</source>
<br>

=== Data Triggered ===
If you want to react on changes of the underlying data (ViewModel), you can use DataTriggerBehavior instead. The following example, when used in the ''UBIKSplashArea'' template, automatically navigates to the root objects once the login process is finished and the user was successfully authenticated:

<source lang = "xml">
<Grid>
<Interactivity:Interaction.Behaviors>
<Core:DataTriggerBehavior Binding="{Binding IsLoggedIn}" Value="True">
<Core:InvokeCommandAction Command="{Binding NavigateToRootPageCommand}" />
</Core:DataTriggerBehavior>
</Interactivity:Interaction.Behaviors>
</Grid>
</source>
<br>
<br>

== Content creation ==
=== Child item creation ===
{{Version/WinXSince|3.5.5}}
To directly create an object on a child of the current object, you can define a Button as follows. The method "Item.IsTypeCreationAllowed" used in the expression gets the uid of the type that should be created below a child, if a child does not allow the creation of that type underneath it, the child will be hidden in the selection dialog. To actually create the object, the "CreateChildItemCommand" needs to be passed a KeyValueList with two parameters: The Parent-key is the UID or the ContentViewModel of the child underneath the object should be created, the Type-key is the type of object which should be created--this should match the uid passed to the "Item.IsTypeCreationAllowed" method.

<source lang = "xml">
xmlns:uc="using:UBIK.WinX.Controls"
xmlns:cv="using:UBIK.WinX.UI.CollectionView"
</source>

<source lang = "xml">
<x:String x:Key="PlantMap">Item.IsTypeCreationAllowed("21fc990a-d064-4bee-8d48-3293351f827a")</x:String>
<cv:ListCollectionView x:Key="PlantMapView" Expression="{StaticResource PlantMap}" ItemsSource="{Binding Children.Items}" />

<AppBarButton>
<AppBarButton.Flyout>
<Flyout Placement="Full">
<ListView ItemsSource="{Binding Source={StaticResource PlantMapView}}">
<ListView.ItemTemplate>
<DataTemplate>
<Button Content="{Binding Header}" Command="{Binding CreateChildItemCommand}" x:Name="CreateButton" Tag="{Binding}">
<Button.CommandParameter>
<uc:KeyValueList>
<uc:KeyValueParameter Key="Parent" Value="6D733909-1742-4110-8619-237849BFE453"/>
<uc:KeyValueParameter Key="Type" Value="21fc990a-d064-4bee-8d48-3293351f827a"/>
</uc:KeyValueList>
</Button.CommandParameter>
</Button>
</DataTemplate>
</ListView.ItemTemplate>
</ListView>
</Flyout>
</AppBarButton.Flyout>
</AppBarButton>
</source>

<source lang = "xml">
<x:String x:Key="PlantMap">Item.IsTypeCreationAllowed("21fc990a-d064-4bee-8d48-3293351f827a")</x:String>
<cv:ListCollectionView x:Key="PlantMapView" Expression="{StaticResource PlantMap}" ItemsSource="{Binding Children.Items}" />

<AppBarButton>
<AppBarButton.Flyout>
<Flyout Placement="Full">
<ListView ItemsSource="{Binding Source={StaticResource PlantMapView}}">
<ListView.ItemTemplate>
<DataTemplate>
<Button Content="{Binding Header}" Command="{Binding CreateChildItemCommand}" x:Name="CreateButton" Tag="{Binding}">
<Button.CommandParameter>
<uc:KeyValueList>
<uc:KeyValueParameter Key="Parent" Value="{Binding Tag, ElementName=CreateButton}"/>
<uc:KeyValueParameter Key="Type" Value="21fc990a-d064-4bee-8d48-3293351f827a"/>
</uc:KeyValueList>
</Button.CommandParameter>
</Button>
</DataTemplate>
</ListView.ItemTemplate>
</ListView>
</Flyout>
</AppBarButton.Flyout>
</AppBarButton>
</source>

<br/>
Additionally, the following optional parameters can be added as well.
* CreateOnly (optional, defaults to false): When set to true, the client will not automatically navigate to the created content, rather automatically save and commit it. If set to true, this overrides the following parameters;
* AutoNavigate (optional, defaults to true): When set to false, the client will not automatically navigate to the created content;
* AutoCommit (optional, defaults to false): When set to true, the change(s) will be saved to the local cache and the database, and then committed to the server.
<br>

=== Creating multiple documents ===
To upload multiple documents at once, the CreateChildItemsCommand can be used. The list of supported command parameters are similar to those of the CreateChildItemCommand (single item). Except that anything other than AutoNavigate=false and AutoCommit=true do not make sense in multi-creation scenario. Therefore, those parameters are fixed and any received from XAML will be ignored.


<source lang = "xml">
<Button ...
xmlns:uc="using:UBIK.WinX.Controls"
Command="{Binding CreateChildItemsCommand}"
Content="Create multiple documents">
<Button.CommandParameter>
<uc:KeyValueList>
<uc:KeyValueParameter Key="Type" Value="6170a068-2314-4444-ad62-0da99769a048" />
</uc:KeyValueList>
</Button.CommandParameter>
</Button>
</source>

<br>
<br>

=== Disable FilloutCriteria ===
{{Version/WinXSince|3.5}}
To enable/disable the automatic filtering of a query based on the ParentObject, there is the possibility to specify EnableFillOutCriteria--if it is not set, it defaults to false. Additionaly "SkipDialog" can be set to true, to not display a dialog.

<source lang="xml">
<Grid x:Name="selectionGrid" Tag="{Binding MetaUID}">
<Interactivity:Interaction.Behaviors>
<Core:EventTriggerBehavior EventName="Tapped">
<Core:InvokeCommandAction Command="{Binding ElementName=ChildAreaGrid, Path=DataContext.AddTemplatableDataCommand}" >
<Core:InvokeCommandAction.CommandParameter>
<uc:KeyValueList>
<uc:KeyValueParameter Key="Uid" Value="{Binding Tag,ElementName=selectionGrid}"/>
<uc:KeyValueParameter Key="EnableFillOutCriteria" Value="false"/>
<uc:KeyValueParameter Key="SkipDialog" Value="false"/>
</uc:KeyValueList>
</Core:InvokeCommandAction.CommandParameter>
</Core:InvokeCommandAction>
</Core:EventTriggerBehavior>
</Interactivity:Interaction.Behaviors>
</Grid>
</source>
<br>
<br>

== Hotspotting ==
{{Attention|To use a binding in the KeyValueParameter, it has to be applied like in the example provided here: [[KeyValueList]]}}
The hotspotting command is used for hotspotting as well as for annotating, to configure the button for hotspotting, the commandparameter "Mode" should be set to "HotSpotting", for annotating the "Mode" should be "Annotate". The parameter commit is optional, if set to true, the changes get automatically persisted when leaving the editing mode.

<source lang = "xml">
<AppBarToggleButton
IsChecked="{Binding EditingAnnotation, Mode=TwoWay}"
IsEnabled="{Binding IsAnnotatable}"
Command="{Binding HotSpottingCommand}">
<AppBarToggleButton.CommandParameter>
<uc:KeyValueList>
<uc:KeyValueParameter Key="Mode" Value="Annotate"/>
<uc:KeyValueParameter Key="Commit" Value="true"/>
</uc:KeyValueList>
</AppBarToggleButton.CommandParameter>
</AppBarToggleButton>
</source>
<br>
<br>

== Remember scroll positions of list views ==

=== Version 3.7 & later {{Version/WinXSince|3.7}} ===
Starting from this version,
* The precision of scroll position remembering is improved(by pixel offsets instead of by items);
* It also works for other scrollable lists (instead of just for content object lists).
<br />
To enable this feature, you should make sure the following.
* The SelectionBoundListView is used instead of the standard ListView. Its {{UBIK}} namespace is <code>UBIK.WinX.Controls</code>;
* The SelectionBoundListView's <code>RememberScrollPosition</code> property is not set to "false"; (It's "true" by default.)
* The SelectionBoundListView's <code>x:Name</code> property value is unique.
<br>

=== Version 3.6 {{Version/WinXSince|3.6}} ===
The UBIK-Client does include a function to remember the position in a list (ListView) when navigating away from it. This function is only available when the list (ListView) has a unique name as a property (x:Name). When browsing back to the previously visited list UBIK scrolls back to the last position. The function does not save scroll positions over different sessions.
Implementing the function to remember the scroll position in a ListView one has to consider that the list elements (Children) could depend on a other UI-element. If the list elements do depend on a other UI-elemente, this element has to be created above the ListView in the XAML.

<source lang = "xml">
<DataTemplate xmlns:behaviors="using:UBIK.WinX.Behaviors" xmlns:uc="using:UBIK.WinX.Controls">
...
<uc:SelectionBoundListView x:Name="ChildListView">
<Interactivity:Interaction.Behaviors>
<behaviors:FirstVisibleItemPersistenceBehavior FirstVisibleItems="{Binding ScrollItems}" />
</Interactivity:Interaction.Behaviors>
</uc:SelectionBoundListView>
</DataTemplate>
</source>
<br>
<br>

== MultiBinding {{Version/WinXSince|3.6}} ==
Very often we want to display some UI elements (e.g. a Grid) depending on whether multiple criteria are met. It's much easier to achieve this by using a MultiBindingBehavior like the following.
<source lang = "xml">
<DataTemplate
xmlns:Interactivity="using:Microsoft.Xaml.Interactivity"
xmlns:behaviors="using:UBIK.WinX.Behaviors">
...
<Grid>
<Interactivity:Interaction.Behaviors>
<behaviors:MultiBindingBehavior Converter="{StaticResource VisLogicAndConverter}" PropertyName="Visibility">
<behaviors:MultiBindingItem Value="{Binding MassEditViewModel, Converter={StaticResource NullToVisConverter}}" />
<behaviors:MultiBindingItem Value="{Binding Documents.Items.Count, Converter={StaticResource ItemCountToVisConverter}}" />
</behaviors:MultiBindingBehavior>
</Interactivity:Interaction.Behaviors>
</Grid>
</DataTemplate>
</source>
The behavior makes sure the container Grid is set to Visibile only if the mass editing mode is not turned on (MassEditViewModel is null) and the context object has child document(s) (Documents.Items.Count is greater than 0. You can combine any number of binding results (MultiBindingItem) using the VisLogicAndConverter (the name should be self explanatory).
<br>
<br>

== Other Commands ==
=== InvokeOnItemsCommand {{Version/WinXSince|3.6}} ===
Available on all ListViewModels, this command allows executing a specified command on a collection of list items. It can be used in combination with features such as [[Mass_Edit_(UBIK_WinX)|mass editing]] and [[XAML_Changes_in_UBIK_WinX_3.5#After_3.5|expression based collection filtering]]. Examples for both combinations are provided below.

{{Attention|The command specified through the "Command" parameter is executed on list items and, therefore, must be available in the list item contexts (view models). If in doubt, the [[Developer_Mode|developer mode]] can be used to inspect if a command is available in a certain context.}}

{{Hint|Parameter "Command" and "SelectedItemsOnly" are specific to the InvokeOnItemsCommand. What other parameters to define or whether to define them at all depends on the type of command to be executed on the items.}}
<br>

==== Invoke on selected items ====
{{Attention|To use a binding in the KeyValueParameter, it has to be applied like in the example provided here: [[KeyValueList]]}}
This example demonstrates how you can use the mass editing feature to select certain objects from the child list and then execute the SetPropertyValueCommand for those selected.
* The example code assumes that the child objects have an editable property called "VALUE" and tries to set 50 as their value;
* You should insert the following code snippet into the default UBIKChildArea template;
* If the parameter "SelectedItemsOnly" is missed or set to "False", the command will be executed on all child items;
* To enable selection, click on the "Mass Edit" button below the property list.
<br />

<tabs>
<tab name="UWP">
<source lang = "xml">
<Button
xmlns:example="using:UBIK.WinX.Controls"
Command="{Binding Children.InvokeOnItemsCommand}"
Content="Set to 50%">
<Button.CommandParameter>
<example:KeyValueList>
<example:KeyValueParameter Key="Command" Value="SetPropertyValueCommand" />
<example:KeyValueParameter Key="SelectedItemsOnly" Value="False" />
<example:KeyValueParameter Key="PropertyName" Value="VALUE" />
<example:KeyValueParameter Key="PropertyValue">
<example:KeyValueParameter.Value>
<x:Double>50</x:Double>
</example:KeyValueParameter.Value>
</example:KeyValueParameter>
</example:KeyValueList>
</Button.CommandParameter>
</Button>
</source>
</tab>

<tab name="Xamarin">
<source lang = "xml">
<Button
xmlns:example="clr-namespace:UBIK.CPL.Classes;assembly=UBIK.CPL"
Command="{Binding Children.InvokeOnItemsCommand}"
Text="Set to 50%">
<Button.CommandParameter>
<example:KeyValueList>
<example:KeyValueParameter Key="Command" Value="SetPropertyValueCommand" />
<example:KeyValueParameter Key="SelectedItemsOnly" Value="False" />
<example:KeyValueParameter Key="PropertyName" Value="VALUE" />
<example:KeyValueParameter Key="PropertyValue">
<example:KeyValueParameter.Value>
<x:Double>50</x:Double>
</example:KeyValueParameter.Value>
</example:KeyValueParameter>
</example:KeyValueList>
</Button.CommandParameter>
</Button>
</source>
</tab>
</tabs>
<br>
<br>

==== Invoke on filtered results ====
{{Attention|To use a binding in the KeyValueParameter, it has to be applied like in the example provided here: [[KeyValueList]]}}

* First, you need to setup a filtered list
**UWP: Setup a ListCollectionView in the Resources section of a UI element (e.g. Grid). This list is only available/visible within that UI element (the Grid in this case).
**Xamarin: Setup a String with a filtering expression & a SfDataSourceExt in the ResourceDictionary of the ContentView. For the Expression property of the SfDataSourceExt refer to the created expression String.

* The ItemsSource uses Children.Items. Use the [[Developer_Mode|developer mode]] if necessary to find out if this is available where you intend to define the list;
* The example expression filters for any items that don't contain the text "EXAMPLE" in their Title texts. You can filter differently by altering the expression.
<br />

<tabs>
<tab name="UWP">
<source lang = "xml">
<Grid xmlns:CV="using:UBIK.WinX.UI.CollectionView">
<Grid.Resources>
<CV:ListCollectionView
x:Key="Filtered"
Expression="!Item.Title.Contains("EXAMPLE")"
ItemsSource="{Binding Children.Items}" />
</Grid.Resources>
...
</Grid>
</source>
</tab>

<tab name="Xamarin">
<source lang = "xml">
<ContentView
xmlns:controls="clr-namespace:UBIK.CPL.Controls;assembly=UBIK.CPL"
...>
<ContentView.Resources>
<ResourceDictionary>
<x:String x:Key="Expresssion">!Item.Title.Contains("EXAMLPLE")</x:String>
<controls:SfDataSourceExt x:Key="Filtered" Expression="{StaticResource Expresssion}" ItemsSource="{Binding Children.Items}" />
</ResourceDictionary>
</ContentView.Resources>
</ContentView>
</source>
</tab>
</tabs>

<br />
With the filtered list configured, you can then insert the following code snippet to execute the SetPropertyValueCommand for the filtered result items.
* The example code assumes that the child objects have an editable property called "VALUE" and tries to set 50 as their value;
* The "Filtered" refers to the ListCollectionView (UWP) or SfDataSourceExt (Xamarin) configured above.
<br />

<tabs>
<tab name="UWP">
<source lang = "xml">
<AppBarButton
xmlns:example="using:UBIK.WinX.Controls"
Command="{Binding Source={StaticResource Filtered}, Path=ListViewModel.InvokeOnItemsCommand}"
Icon="AllApps"
Label="Set to 50"
Style="{ThemeResource UBIKActionAppBarButton}">
<AppBarButton.CommandParameter>
<example:KeyValueList>
<example:KeyValueParameter Key="Command" Value="SetPropertyValueCommand" />
<example:KeyValueParameter Key="PropertyName" Value="VALUE" />
<example:KeyValueParameter Key="PropertyValue" Value="50" />
</example:KeyValueList>
</AppBarButton.CommandParameter>
</AppBarButton>
</source>
</tab>

<tab name="Xamarin">
<source lang = "xml">
<Button
xmlns:example="clr-namespace:UBIK.CPL.Classes;assembly=UBIK.CPL"
Command="{Binding Source={StaticResource Filtered}, Path=ListViewModel.InvokeOnItemsCommand}"
Text="Set to 50">
<Button.CommandParameter>
<example:KeyValueList>
<example:KeyValueParameter Key="Command" Value="SetPropertyValueCommand" />
<example:KeyValueParameter Key="PropertyName" Value="VALUE" />
<example:KeyValueParameter Key="PropertyValue" Value="50" />
</example:KeyValueList>
</Button.CommandParameter>
</Button>
</source>
</tab>
</tabs>

{{Attention|The binding <code>ListViewModel.InvokeOnItemsCommand</code> should be updated to <code>BulkOperation.InvokeOnItemsCommand</code> starting from version 4.3.}}
<br>

==== Support for old styled commands ====
Some old commands might not support KeyValueLists as parameters. In that case, just define the parameter value under the "CommandParameter" key, e.g.
<br />
<source lang = "xml"><example:KeyValueParameter Key="CommandParameter" Value="some string value for example" /></source>.
This single value is then passed as the command parameter instead of the entire KeyValueList.
<br>
<br>

=== SetPropertyValueCommand {{Version/WinXSince|3.6}} ===
{{Attention|To use a binding in the KeyValueParameter, it has to be applied like in the example provided here: [[KeyValueList]]}}

This command existed before but was implemented differently. In the newer version(s), it is improved to provide customizers more control over the things that happen during/after the property value changes.
The available command parameters are:
* PropertyName: the name of the property to set a new value to;
* PropertyValue: the value to be set to the above mentioned property;
* OnlyForUnvalidated (optional, defaults to false): When set to true, the value will only be set if the property is not yet validated;
* AutoSave (optional, defaults to false): When set to true, the change(s) will be saved to the local cache and database;
* AutoCommit (optional, defaults to false): When set to true, the change(s) will be committed to the server.

{{Hint|There's no way to commit changes without saving them locally first. Therefore, the "AutoSave" parameter will be ignored when "AutoCommit" is set to true.}}

Here's an example of the command usage. It tries to set the property called "VALUE" to a double value 50 regardless of its current state and then automatically save and commit the change.
<br />
<source lang = "xml">
xmlns:example="using:UBIK.WinX.Controls"
...
<Button
Command="{Binding SetPropertyValueCommand}"
Style="{StaticResource UBIKButtonStyle}"
Content="Set Property">
<Button.CommandParameter>
<controls:KeyValueList>
<controls:KeyValueParameter Key="PropertyName" Value="MP_PROPERTY" />
<controls:KeyValueParameter Key="PropertyValue" Value="My Value" />
<controls:KeyValueParameter Key="OnlyForUnvalidated" Value="false" />
<controls:KeyValueParameter Key="AutoSave" Value="true" />
<controls:KeyValueParameter Key="AutoCommit" Value="true" />
</controls:KeyValueList>
</Button.CommandParameter>
</Button>
</source>

{{Hint|For simple types, you can try writing them in the text format like <nowiki><controls:KeyValueParameter Key="PropertyValue" Value="50"/></nowiki> and {{UBIK}} will try to find the right type. For advanced property types, it is advised to provide typed values like <nowiki><x:Boolean>true</x:Boolean></nowiki>.}}
<br>

==== Set a Binding as PropertyValue ====
There is a known issue in XAML where Behaviors and KeyValueLists do not inherit the binding context of the control they are attached to. Simply put, trying to use a binding directly in the PropertyValue part of the command; '''<nowiki><controls:KeyValueParameter Key="PropertyValue" Value="{Binding BindingPath}" /></nowiki>''', would lead to the client setting the value of MP_PROPERTY to null.

Luckily, there is a simple way to link this Binding to a context. Using the above example as a foundation, adapt the button as shown below:
<source lang = "xml">
<Button
x:Name="SetDynamicPropertyButton"
Tag="{Binding}"
... >
<Button.CommandParameter>
<controls:KeyValueList>
...
<controls:KeyValueParameter Key="PropertyValue" Value="{Binding Tag.BindingPath, ElementName=SetDynamicPropertyButton}" />
...
</controls:KeyValueList>
</Button.CommandParameter>
</Button>
</source>

The above code uses the x:Name of the button to specify the viewmodel from which we wish to begin our binding path.<br>
You do not need to follow this exact syntax, all that is necessary is to provide a connection to the BindingContext of an observable control.

==== Set Current DateTime ====
The current DateTime stamp can be retrieved from '''AppStatus.LiveDateTime'''.<br>
Since the known issue described in the section above prevents direct binding to this, below are examples for how to implement it.

<tabs>
<tab name="UWP">
<source lang = "xml">
xmlns:example="using:UBIK.WinX.Controls"
...
<Button
x:Name="SetCurrentDateTimeButton"
Tag="{Binding}"
Command="{Binding SetPropertyValueCommand}"
Style="{StaticResource UBIKButtonStyle}"
Content="Set Property">
<Button.CommandParameter>
<controls:KeyValueList>
<controls:KeyValueParameter Key="PropertyName" Value="MP_PROPERTY" />
<controls:KeyValueParameter Key="PropertyValue" Value="{Binding Tag.AppStatus.LiveDateTime, ElementName=SetCurrentDateTimeButton}" />
<controls:KeyValueParameter Key="OnlyForUnvalidated" Value="false" />
<controls:KeyValueParameter Key="AutoSave" Value="true" />
<controls:KeyValueParameter Key="AutoCommit" Value="true" />
</controls:KeyValueList>
</Button.CommandParameter>
</Button>
</source>
{{Hint|The DateTime can be set to the desired format by adding a StringFormatConverter to the LiveDateTime binding:<br><nowiki>"{Binding Tag.AppStatus.LiveDateTime, ElementName=SetCurrentDateTimeButton, </nowiki>'''<nowiki>Converter={StaticResource StringFormatConverter}, ConverterParameter={0:yyyy-MM-dd HH:mm}</nowiki>'''<nowiki>}" </nowiki>.}}
</tab>
<tab name="Xamarin">
<Button
x:Name="SetCurrentDateTimeButton"
Command="{Binding SetPropertyValueCommand}"
Text="Set Property">
<Button.CommandParameter>
<classes:KeyValueList>
<classes:KeyValueParameter Key="PropertyName" Value="MP_PROPERTY" />
<classes:KeyValueParameter Key="PropertyValue" Value="{Binding BindingContext.AppStatus.LiveDateTime, Source={x:Reference SetCurrentDateTimeButton}}" />
<classes:KeyValueParameter Key="OnlyForUnvalidated" Value="false" />
<classes:KeyValueParameter Key="AutoSave" Value="true" />
<classes:KeyValueParameter Key="AutoCommit" Value="true" />
</classes:KeyValueList>
</Button.CommandParameter>
</Button>
</tab>
</tabs>

<br>

=== SaveAndCommitCommand ===
With the ''SaveAndCommitCommand'' it is possible to save and commit unsaved changes on a ContentViewModel.

* ForceCommit CommandParameter (optional, defaults to false): Normally when the App is in Online mode, changes are automatically committed when saved. This is not the case when the App is in Manual mode. Setting the ''ForceCommit'' parameter to true makes it possible to commit the changes when saved in Manual mode.
* {{Version/WinXSince|4.7}} {{Version/XamarinSince|4.7}} PropertyNameToSave CommandParameter (optional, defaults to null): Delivers the Property Name as String of a specific Property that should be saved. E.g. when called via PropertyViewModel.ResetCommand or PropertyViewModel.DeleteCommand, the ''PropertyNameToSave'' parameter is used to only apply the SaveAndCommitCommand on the related PropertyViewModel called from, and not on other unsaved changes on this ContentViewModel.
<br/>
<tabs>
<tab name="UWP">
<source lang = "xml">
<Button
xmlns:example="using:UBIK.WinX.Controls"
Command="{Binding SaveAndCommitCommand}">
<Button.CommandParameter>
<example:KeyValueList>
<example:KeyValueParameter Key="ForceCommit" Value="True" />
</example:KeyValueList>
</Button.CommandParameter>
</Button>
</source>
</tab>
<tab name="Xamarin">
<source lang = "xml">
<Button
xmlns:example="using:clr-namespace:UBIK.CPL.Classes;assembly=UBIK.CPL"
Command="{Binding SaveAndCommitCommand}">
<Button.CommandParameter>
<example:KeyValueList>
<example:KeyValueParameter Key="ForceCommit" Value="True" />
</example:KeyValueList>
</Button.CommandParameter>
</Button>
</source>
</tab>
</tabs>
<br>

=== DisplayViewCommand ===
This command can be used to [[Custom_View_(Client)|display cutom views]].
<br>

=== TeachInCommand ===
With the '''TeachInCommand''' you're allowed to set your device's current location ("teach-in", "TeachIn") as the value of the context object's [[SYSCLS_GEO|geo property]].
This command is available in both '''ContentViewModel''' and '''PropertyViewModel'''.
* ContentViewModel.TeachInCommand: If possible, sets the current location of the device as the value of the context object's [[SYSCLS_GEO|geo property]]. Saves and commits the change;
* PropertyViewModel.TeachInCommand: If possible, sets the current location of the device as the value of the current property if it's a geo property (not necessarily the [[SYSCLS_GEO|geo property]]). Addtionally supports a boolean command parameter:
** False (default): The change is not automatically saved.
** True: The change is saved.
<br/> {{hint| Make sure you use the correct binding path for your command depending on your current context view model. E.g., if the context view model is already the ContentViewModel then your binding path should simply be TeachInCommand. You can use the [[Developer_Mode|developer mode]] to find out the current view model in a view.}}
<br>

===UpdateArbitraryObjectCommand {{Version/WinXSince|4.7}}===
The "UpdateArbitraryObjectCommand" is responsible for updating an arbitrary object based on a set of provided parameters. The command is accessible in the AppStatusViewModel (as '''ViewModel.AppStatus''').
<br />
The available command parameters are:
* Uid (Mandatory): UID of the object to be updated;
* UpdateChildDepth (Optional): Child depth/level to update (defaults to 1);
* UpdateParentDepth (Optional): Parent depth/level to update (defaults to 0);
* UpdateIgnoreExpiry (Optional): Ignore update expiry (defaults to false);

{{Hint|Note that if you set the UpdateChildDepth property to "-1" you are also able to update a whole branch with this command.}}

Here is an example of the command usage:
<br />
<tabs>
<tab name="UWP">
<source lang = "xml">
<Button ...
xmlns:uc="using:UBIK.WinX.Controls"
Command="{Binding UpdateArbitraryObjectCommand}"
Content="Update Arbitrary Object">
<Button.CommandParameter>
<uc:KeyValueList>
<uc:KeyValueParameter Key="Uid" Value="...valid UID..." />
<uc:KeyValueParameter Key="UpdateChildDepth" Value="2" />
<uc:KeyValueParameter Key="UpdateParentDepth" Value="0" />
<uc:KeyValueParameter Key="UpdateIgnoreExpiry" Value="true" />
</uc:KeyValueList>
</Button.CommandParameter>
</Button>
</source>
</tab>

<tab name="Xamarin">
<source lang = "xml">
<Button ...
xmlns:uc="using:clr-namespace:UBIK.CPL.Classes;assembly=UBIK.CPL"
Command="{Binding UpdateArbitraryObjectCommand}"
Content="Update Arbitrary Object">
<Button.CommandParameter>
<uc:KeyValueList>
<uc:KeyValueParameter Key="Uid" Value="...valid UID..." />
<uc:KeyValueParameter Key="UpdateChildDepth" Value="2" />
<uc:KeyValueParameter Key="UpdateParentDepth" Value="0" />
<uc:KeyValueParameter Key="UpdateIgnoreExpiry" Value="true" />
</uc:KeyValueList>
</Button.CommandParameter>
</Button>
</source>
</tab>
</tabs>
<br>

=== Access to an arbitrary object {{Version/WinXSince|4.6}} {{Version/XamarinSince|4.6}} ===
With the ObjectByUID feature it is possible to access any local arbitrary object by its UID and, for example, display a value of it.
It can be accessed from ContentViewModel, AuthenticationViewModel, and RootPageViewModel levels.

To display a string of e.g. a property of an arbitrary object from ContentViewModel, AuthenticationViewModel & RootPageViewModel, the following syntax can be used in related XAMLs:
<tabs>
<tab name="UWP">
<source lang = "xml">
<TextBlock Text="{Binding ObjectByUID[paste-your-uid].Properties.VisibleItems[add-your-property-name].DisplayValue}" />
</source>
</tab>

<tab name="Xamarin">
<source lang = "xml">
<Label Text="{Binding ObjectByUID[paste-your-uid].Properties.VisibleItems[add-your-property-name].DisplayValue}" />
</source>
</tab>
</tabs>

For Property Dialogs the CallingViewModel prefix is needed to access an arbitrary object:
<tabs>
<tab name="UWP">
<source lang = "xml">
<TextBlock Text="{Binding CallingViewModel.ObjectByUID[paste-your-uid].Properties.VisibleItems[add-your-property-name].DisplayValue}" />
</source>
</tab>

<tab name="Xamarin">
<source lang = "xml">
<Label Text="{Binding CallingViewModel.ObjectByUID[paste-your-uid].Properties.VisibleItems[add-your-property-name].DisplayValue}" />
</source>
</tab>
</tabs>
<br>
<br>

==== Localizing UI Texts ====
The most efficient practice is to use pre-localized texts from the standard client, however, this is not always possible, especially in custom UIs. The ObjectByUID indexer was therefore initially developed as a technique to allow localization of custom UI label texts.

The concept is to create an infrastructure object that carries metaproperties for localized texts, then bind to this infrastructure object using ObjectByUID, and bind to a specific metaproperty to receive it's localized Description text as follows:
<source lang = "xml">
"{Binding ObjectByUID[paste-your-uid].Properties.VisibleItems[add-your-property-name].Description}"
</source>

From here there are two approaches; the database-leaning one is to add one metaproperty per UI label, and simply bind to the Description of it. However, this shifts maintenance effort to the UBIK Studio after the initial adding of the label in XAML. Another approach would be to use the metaproperty to provide a "tag" that the xaml customizer can then use to differentiate between hardcoded labels.

A third approach would be to create one infrastructure object per label, however, this can lead to many objects being loaded upon startup.

{| class="wikitable"
|-
! Approach !! Implementation !! Maintenance Effort !! Recommendation
|-
| One metaproperty per UI Label || Bind the label text to the metaproperty Description || Database / UBIK Studio || Recommended for UWP, customizings with fewer UI texts, finalized customizings.
|-
| One metaproperty delivering a localization "tag" (such as: "EN" / "DE") || Use something like DataTrigger (Xamarin) to hardcode a different localized text per tag (such as: "eg." / "zb.") || XAML || Recommended for Xamarin, highly customized UIs with many texts, customizings that tend to change often.
|}
<br>
<br>

== Showing Images and Icons ==
In UBIK, there are two types of image;
* The thumbnail image assigned to a UBIK object, delivered using the <nowiki>{Binding Icon...}</nowiki> binding, in combination with a ByteToImageConverter. Examples can commonly be found on UBIKChildItem templates.
* Custom image shown with a specific purpose, such as a company logo or icon on a button/UI element.
<br>

==== Paths as string resources ====
When using custom images in your UI, it is a good idea not to hardcode path data into your Image control but instead to create a string resource in UBIKThemes that holds the image path, and use this string resource in your Image control. The benefit of the indirect connection between image file and usage is that the "file is in use" issue (sometimes experienced when either manual, or auto-deployment of xamls, tries to change image files when UBIK is running) is avoided this way.

Sample:
<tabs>
<tab name="UWP">
'''UBIKThemes:'''
<source lang = "xml"><x:String x:Key="MainLogo">ms-appdata:///local/xaml/Images/MainLogo.png</x:String>
</source>
<br>
'''Usage:'''
<source lang = "xml">
<Image
x:Name="LogoImage"
Height="32"
Stretch="Uniform"
Source="{Binding Source={StaticResource MainLogo}, Converter={StaticResource PathToImageConverter}}" />
</source>
</tab>

<tab name="Xamarin">
'''UBIKThemes:'''
<source lang = "xml">
<x:String x:Key="Logo_Image">IMG_Logo.png</x:String>
</source>
<br>
'''Usage:'''
<source lang = "xml">
xmlns:customimage="clr-namespace:UBIK.CPL.Controls;assembly=UBIK.CPL"
...
<customimage:FileImage
HeightRequest="140"
Aspect="AspectFit"
FileName="{StaticResource BorealisLogo_Image}"
FolderName="xaml" />
</source>
</tab>
</tabs>
<br>

=== Icons ===
UBIK comes equipped with a collection of icons that can be easily used in your customizing. [[Icon_Font|Here is an indepth explanation on usage]].

In the case that you require an icon that is not included in our icon font file, there is the possibility to use SVG path data to render your required icon in the UI.
<br>

==== Custom Icons ====
Here referring to icons which are not included as standard icons un UBIK.

'''Path data''' is a collection of points, which combined together form a vector image. Vector images, compared to raster images like a PNG or JPG, are scalable, because they are always rendered from path data, and not from a bitmap, which has to be stretched or squished to fit your defined size.

Described below two approaches. The UWP approach involves adding an SVG icon file to your xaml project and render it using an Image control. The Xamarin approach shows how to use svg data directly using a Path control.
<br>

<tabs>
<tab name="UWP">
<source lang = "xml">
<Image Width="14" Height="14" Margin="0,0,0,1">
<Image.Source >
<SvgImageSource UriSource="{StaticResource PP_Issued}" />
</Image.Source>
</Image>
</tab>

<tab name="Xamarin">
The first step is to generate path data for your icon. The easiest way is to download the [https://apps.microsoft.com/detail/9wzdncrdxf41?hl=en-US&gl=US| Character Map] tool from Microsoft. This can be used to browse all installed icon files for your icon of choice. Once selected, use Tools > Xaml / Xamarin Forms to show various useful aspects of the icon. In this case, the Path Icon option can be used to generate a Path control that can be pasted directly in your xaml as follows:
<br>
<source lang = "xml">
<Path Fill="{StaticResource UBIKAccentColor}" Data="F1 M 8.75 1.25 L 18.75 1.25 L 18.75 18.75 L 1.25 18.75 L 1.25 8.75 L 5 8.75 L 5 6.25 L 1.25 6.25 L 1.25 1.25 L 6.25 1.25 L 6.25 5 L 8.75 5 Z M 10 2.5 L 10 5 L 12.5 5 L 12.5 2.5 Z M 2.5 5 L 5 5 L 5 2.5 L 2.5 2.5 Z M 6.25 6.25 L 6.25 8.75 L 8.75 8.75 L 8.75 6.25 Z M 2.5 10 L 2.5 12.5 L 5 12.5 L 5 10 Z M 17.5 17.5 L 17.5 2.5 L 13.75 2.5 L 13.75 6.25 L 10 6.25 L 10 10 L 6.25 10 L 6.25 13.75 L 2.5 13.75 L 2.5 17.5 Z " />
</source>
<br>

Once you have your Path control, you can customize it as [https://learn.microsoft.com/en-us/previous-versions/xamarin/xamarin-forms/user-interface/shapes/path| documented by Microsoft]. Path data generated using the above method will most likely need a Fill attribute, for example <nowiki>Fill="{StaticResource UBIKAccentColor}"</nowiki>.

{{Hint|More complicated icons will have longer and more complicated paths.}}
</tab>
</tabs>
<br>
<br>

== TabView ==

=== UI virtualization ===
When using the TabView control in your XAML code, UI virtualization can greatly improve initial loading performance, based on the scenario.Here's how to enable it:

<tabs>
<tab name="Xamarin">
<source lang = "xml">
<tabView:SfTabView EnableVirtualization="true">
...
</tabView:SfTabView>
</source>
</tab>
</tabs>

=== Default Tab Selection ===
The tab selection in UBIKContentView defaults to the first tab, which is Children objects. However, for cases where it makes more sense to display Properties or Documents by default, it is possible to change the tab selection using the following classifications:
* [[SYSCLS_SHOWDOCUMENTS]]
* [[SYSCLS_SHOWPROPERTIES]]

<tabs>
<tab name="UWP">
Adding the classification to a metaclass is enough for UWP.
</tab>
<tab name="Xamarin">
Xamarin currently requires additional customizing to make use of the TabSelector property. One approach is to add a DataTrigger to the SfTabView found in UBIKContentArea that is triggered by the value of the TabSelector property, as shown below;
<source lang = "xml">
<tabView:SfTabView VisibleHeaderCount="3" >

<tabView:SfTabView.Triggers>
<DataTrigger TargetType="tabView:SfTabView" Binding="{Binding TabSelector}" Value="PropertiesTab">
<Setter Property="SelectedIndex" Value="1"/>
</DataTrigger>
<DataTrigger TargetType="tabView:SfTabView" Binding="{Binding TabSelector}" Value="DocumentsTab">
<Setter Property="SelectedIndex" Value="2"/>
</DataTrigger>
</tabView:SfTabView.Triggers>
</tabView:SfTabView>
</source>
</tab>
</tabs>
<br>
<br>

[[Category:Client|XAML Tips]]
[[Category:WinX|XAML Tips]]
[[Category:XAML|XAML Tips]]
[[Category:Xamarin|XAML Tips]]

== FlipView ==

=== UI virtualization ===
When using the FlipView control in your XAML code, it's better to enable [https://docs.microsoft.com/en-us/windows/uwp/debug-test-perf/optimize-gridview-and-listview#ui-virtualization UI virtualization]. The difference in performance gets more obvious as the number of items in the FlipView increases. Here's how to enable it.

<source lang = "xml">
<FlipView
...
VirtualizingStackPanel.VirtualizationMode="Standard">
<Flipview.ItemsPanel>
<ItemsPanelTemplate>
<VirtualizingStackPanel Orientation="Horizontal" />
</ItemsPanelTemplate>
</Flipview.ItemsPanel>
</FlipView>
</source>

VirtualizingStackPanel.VirtualizationMode offers two possibilities: Standard & Recycling. In case you are interested, here are their [https://docs.microsoft.com/en-us/dotnet/api/system.windows.controls.virtualizationmode?view=netframework-4.7.2 differences].

=== Auto saving {{Version/WinXSince|4.6}} ===
Unsaved changes on the document (e.g. Annotations) are gonna be saved and committed automatically when flipping the page in the FlipView.

{{Attention|Changes are lost when leaving the page without flipping the document first.}}

{{Version/WinXSince|4.7}} {{Version/XamarinSince|4.7}} If you want to keep the changes when leaving the page by e.g. navigating away without flipping the document first, there is a boolean property called ''AutoSaveDocumentsOnPageClose'' (default value: false) which enables this behavior. It can be activated by adding the property to (or editing it in) the custom UBIKThemes as follows:
<tabs>
<tab name="UWP">
<source lang = "xml">
<x:String x:Key="AutoSaveDocumentsOnPageClose">true</x:String>
</source>
</tab>

<tab name="Xamarin">
<source lang = "xml">
<x:String x:Key="AutoSaveDocumentsOnPageClose">true</x:String>
</source>
</tab>
</tabs>

== Device and Platform Responsiveness ==
{{UnderConstructionStart}}
<br>
Although '''OnPlatform''' and '''OnIdiom''' are used in Xamarin, the following wiki article is valid from MAUI 5.0 (add version flag), as the syntax changed.

'''OnPlatform''' can be used to define different property values based on the platform. Valid Platform names are:
* iOS
* Android
* WinUI (for MAUI Windows)
* further ones see [https://learn.microsoft.com/en-us/dotnet/maui/platform-integration/customize-ui-appearance?view=net-maui-9.0#customize-ui-appearance-with-a-markup-extension-based-on-the-platform here]
<br>
'''OnIdom''' can be used to define different property values based on the device type (e.g. Phone, Tablet, Desktop).

When it comes to the proper syntax, we should stick with the approaches mentioned in the [https://learn.microsoft.com/en-us/dotnet/maui/platform-integration/customize-ui-appearance?view=net-maui-9.0 official documentation].
Means, we should '''avoid''' using the single-tag syntax like ''<OnPlatform Android="..." iOS="..." />'' or ''<OnIdiom Phone="..." Desktop="..." />''.

Instead, we should either use the '''multi-tag syntax''' or the '''inline syntax''' for OnPlatform / OnIdiom.

==== Multi-tag syntax ====
Here it is mandatory to add '''x:TypeArguments="TheType"''' with the proper type to OnPlatfrom/OnIdiom. ''Default="..."'' is optional.
<tabs>
<tab name="OnPlatform">
<source lang = "XML">
<OnPlatform x:TypeArguments="Thickness" Default="20">
<On Platform="iOS, WinUI" Value="0,20,0,0" />
<On Platform="Android" Value="10,20,20,10" />
</OnPlatform>
</source>
</tab>
<tab name="OnIdiom">
<source lang = "XML">
<OnIdiom x:TypeArguments="Thickness" Default="20">
<OnIdiom.Desktop>0,60,0,0</OnIdiom.Desktop>
</OnIdiom>
</source>
</tab>
</tabs>

If OnPlatform Values contain multiple subtags, the following syntax can be used:
<source lang = "XML">
<ControlTemplate x:Key="ExampleControlTemplate">
<Grid>
<OnPlatform x:TypeArguments="View">
<On Platform="Android">
<Button
...
Text="Button A" />
...
</On>
<On Platform="iOS">
<Button
...
Text="Button B" />
...
</On>
<On Platform="WinUI">
<Grid>
<Button
...
Text="Button C" />
<Label Text="Example" />
...
</Grid>
</On>
</OnPlatform>
</Grid>
</ControlTemplate>
</source>

{{Attention|When using ''GridLength'' as a type in OnPlatform/OnIdiom, it should only be used in combination with the inline syntax.}}

==== Inline syntax ====
When using the inline syntax, the type should not be specified. ''Default='' is optional.
<tabs>
<tab name="OnPlatform">
<source lang = "XML">
<BoxView Color="{OnPlatform Default=Yellow, iOS=Red, Android=Green}" />
</source>
</tab>
<tab name="OnIdiom">
<source lang = "XML">
<BoxView Color="{OnIdiom Default=Yellow, Phone=Red, Tablet=Green}" />
</source>
</tab>
</tabs>

If the value contains any special characters like '''"''' or ''',''' or a '''string''' when using the OnIdiom or OnPlatform inline variant, it needs to be wrapped between ' '. But be careful with using apostrophes - when using them around curly brackets {} it can lead to an error.
<tabs>
<tab name="Don't">
<source lang = "XML">
Margin="{OnIdiom 10,2, Phone=2,0}"
</source>
</tab>
<tab name="Instead do">
<source lang = "XML">
Margin="{OnIdiom '10,2', Phone='2,0'}"
</source>
</tab>
</tabs>

=== Complex values ===
If the OnPlatform/OnIdiom value contains a '''Binding''', '''StaticResource''' or any other complex value in curly brackets, it is recommended to use the '''inline syntax'''. Although there is no official documentation, it seems to work according to our experience. However, the multi-tag syntax doesn't seem to work always for such cases. DynamicResource values seem not to be supported in OnIdiom / OnPlatform.

<tabs>
<tab name="Don't">
<source lang = "XML">
<OnIdiom x:TypeArguments="..." Default="{Binding ...}">
<OnIdiom.Phone>{Binding ...}</OnIdiom.Phone>
</OnIdiom>
</source>
</tab>
<tab name="Instead do">
<source lang = "XML">
Header="{OnIdiom Default={Binding ...}, Phone={Binding ...}}"
</source>
</tab>
</tabs>

{{Attention|Unreliable Support: Behavior may vary when using bindings or complex resources. Although it seems to work with the inline syntax according to our experiences, it is recommended to test these edge cases thoroughly.}}

{{UnderConstructionEnd}}

[[Category:Client|XAML Tips]]
[[Category:WinX|XAML Tips]]
[[Category:XAML|XAML Tips]]
[[Category:Xamarin|XAML Tips]]

UBIK Client Foundation (UCF)

2025-02-03T10:49:38Z

JKN:

The {{UBIK}} Client Foundation (UCF) is the Client SDK of {{UBIK}}, and therefore the foundation of any client that communicates with a {{UBIK}} server. The UCF can be used to develop own/custom {{UBIK}} clients, for a broad range of operating systems and devices.
The UCF is designed in a modular way, so that the user of the SDK is enabled to initialize only the features, that a client implementation requires. A Web Client for example, typically doesn't need offline support or NFC features, whereas a Tablet Client on the other hand, would typically benefit greatly from these modules.

==Versioning==
UCF is versioned together with its released {{UBIK}} client, which means e.g. that the UCF Version 4.8 is also contained in all {{UBIK}} clients of version 4.8 - hence the release notes of that very version also apply to the UCF.

==Architecture==
The UCF strongly embraces the [[XAML Basics#MVVM|MVVM]] architectural pattern, so it is highly recommended to familiarize yourself with that pattern before starting development. Also, the UCF is inherently asynchronous, thus it is also recommended to bring some experience with asynchronous programming patterns.

==Prerequisites==
It is recommened to use Microsoft Visual Studio for UBIK UCF development. The UCF packages can be obtained in [https://www.nuget.org/packages/UBIK.UCF/ various versions from nuget.org].

==Getting started==
There are Tutorial projects for several different Platforms available, including Console, Web (Blazor Server), Android, iOS and Windows Apps (Xamarin Forms), as well as Hololens 2 (Unity). All Tutorials are hosted in a [https://github.com/augmensys private GitHub repository], where UBIK customers with a valid maintenance contract will get access upon request.

[[Category:Client|UBIK Client Foundation (UCF)]]
[[Category:UCF|UBIK Client Foundation (UCF)]]

UBIK Client Foundation (UCF)

2025-01-27T12:09:05Z

JKN:

UBIK Client Foundation (UCF)

2025-01-27T12:07:01Z

JKN:

The {{UBIK}} Client Foundation (UCF) is the Client SDK of {{UBIK}}, and therefore the foundation of any client that communicates with a {{UBIK}} server. The UCF is designed in a modular way, so that the user of the SDK is enabled to initialize only the features, that a client implementation requires. A Web Client for example, typically doesn't need offline support or NFC features, whereas a Tablet Client on the other hand, would typically benefit greatly from these modules.

==Versioning==
UCF is versioned together with its released {{UBIK}} client, which means e.g. that the UCF Version 4.8 is also contained in all {{UBIK}} clients of version 4.8 - hence the release notes of that very version also apply to the UCF.

==Architecture==
The UCF strongly embraces the [[XAML Basics#MVVM|MVVM]] architectural pattern, so it is highly recommended to familiarize yourself with that pattern before starting development. Also, the UCF is inherently asynchronous, thus it is also recommended to bring some experience with asynchronous programming patterns.

==Prerequisites==
It is recommened to use Microsoft Visual Studio for UBIK UCF development. The UCF packages can be obtained in [https://www.nuget.org/packages/UBIK.UCF/ various versions from nuget.org].

==Getting started==
There are Tutorial projects for several different Platforms available, including Console, Web (Blazor Server), Android, iOS and Windows Apps (Xamarin Forms), as well as Hololens 2 (Unity). All Tutorials are hosted in a [https://github.com/augmensys private GitHub repository], where UBIK customers with a valid maintenance contract will get access upon request.

[[Category:Client|UBIK Client Foundation (UCF)]]

UBIK Client Foundation (UCF)

2025-01-27T11:59:22Z

JKN:

The {{UBIK}} Client Foundation (UCF) is the Client SDK of {{UBIK}}, and therefore the foundation of any client that communicates with a {{UBIK}} server. The UCF is designed in a modular way, so that the user of the SDK is enabled to initialize only the features, that a client implementation requires. A Web Client for example, typically doesn't need offline support or NFC features, whereas a Tablet Client on the other hand, would typically benefit greatly from these modules.

==Versioning==
UCF is versioned together with its released {{UBIK}} client, which means e.g. that the UCF Version 4.8 is also contained in all {{UBIK}} clients of version 4.8 - hence the release notes of that very version also apply to the UCF.

==Prerequisites==
It is recommened to use Microsoft Visual Studio for UBIK UCF development. The UCF packages can be obtained in [https://www.nuget.org/packages/UBIK.UCF/ various versions from nuget.org].

==Getting started==
There are Tutorial projects for several different Platforms available, including Console, Web (Blazor Server), Android, iOS and Windows Apps (Xamarin Forms), as well as Hololens 2 (Unity). All Tutorials are hosted in a [https://github.com/augmensys private GitHub repository], where UBIK customers with a valid maintenance contract will get access upon request.

[[Category:Client|UBIK Client Foundation (UCF)]]

UBIK Client Foundation (UCF)

2025-01-27T10:40:33Z

JKN:

UBIK Client Foundation (UCF)

2025-01-27T10:19:58Z

JKN: Created page with "The {{UBIK}} Client Foundation (UCF) is the Client SDK of {{UBIK}}, and therefore the foundation of any client that communicates with a {{UBIK}} server. The UCF is designed in..."

Category:UCF

2025-01-27T10:19:44Z

JKN: Created page with "Category:Client"

[[Category:Client]]

Category:Development

2025-01-27T10:19:38Z

JKN: Created page with "Category:Client"

[[Category:Client]]

Deploy UI Customizings (Client)

2024-11-28T07:19:44Z

JKN:

As a crucial part of the {{UBIK}} client, it is often the case that a set of UI customizings, once finished, is needed on multiple devices. Therefore, the deployment is an important step.

== Location of UI customizing ==
UBIK clients use the same <code>[CurrentUserFolder]\AppData\Packages\AugmensysGmbH.UBIK.[ClientType]\LocalState\XAML</code> folder as the root of all UI customizings.
* [CurrentUserFolder] is something like "C:\Users\UserName";
* [ClientType] is either UWP or Xamarin.

=== Profile specific customizing {{Version/XamarinSince|1.2}} ===
In some scenarios, a user might want to switch between two different sets of UI customizings depending on the selected profile. To achieve this, the customizing files need to be deployed accordingly.

Every profile has a field called "Name", which not only decides how it's displayed, but also tells the client under which sub folder it should look for profile specific customizings. Imagine a profile named "Demo_V3", the client first tries to find a "Demo_V3" sub folder under the [[#Location_of_UI_customizing|root XAML folder]]. If it finds none, it then uses those under the root.

{{Hint|There's also another field called "Customizing" in a profile. If specified, it overrules the "Name" field when it comes to the profile specific customizing folder. This is usually only used if you want different profiles to share the same set of customizings.}}

== Manual deployment ==
This is an obvious approach of deploying UI customizings. From a {{UBIK}} perspective, this can be
* Manually copying/pasting the UI customizing files (XAMLs, images, etc.) to the desired devices;
* Other 3rd-party (e.g. customers' private rollout infrastructure) automated deployment systems.

=== Import UI customizing ===
Since it's impossible to copy/paste files to the app data folder with UBIK.Xamarin for Android and iOS, those clients provide an alternative option to "Import Customizing" in the general settings.
* You can import a single XAML file which then ends up under the [[#Location_of_UI_customizing|root XAML folder]];
* You can also import a zip archive of many XAML files at once.
** With a zip archive, its content (files and folders) is unpacked under the [[#Location_of_UI_customizing|root XAML folder]] '''with the folder structure of the archive preserved'''. This is important because of the [[#Profile_specific_customizing|profile specific customizing]] feature.

== {{UBIK}} server deployment ==
{{Version/WinXSince|3.7}} {{Version/XamarinSince|1.1}} {{UBIK}} provides a new solution where UI customizings can be deployed from {{UBIK}} servers to the clients the same way content can be fetched.

=== Technical concept ===
The UI customizings are delivered from {{UBIK}} servers to clients in the form of [[SYSCLS_UI_CUSTOMIZING|archive documents]] which contains the following.
* The archive files containing the packed UI customizing files;
* The version of the UI customizings.

=== Client scenario ===
Once a {{UBIK}} client connects to a server and downloads such a customizing archive, it unpacks the archive file the same way it does during a [[#Import_UI_customizing|manual import]].
* If a folder or a file at the root level of the archive already has a same-named counterpart in the client's XAML folder, the existing one is first removed before the one from the archive gets unpacked;
** {{Version/WinXSince|4.7}} {{Version/XamarinSince|4.7}} A copy of the zip archive will be saved to the Documents/UIArchive folder.
* Once the archive is unpacked, the client tries to reload the UI customizings. If a set is found for the currently selected profile, one should see the changes in the UI;
* Most likely, you would want to include a certain folder structure in the archive to achieve [[#Profile_specific_customizing|profile specific customizing]].

=== Some other details ===
* The download of a document file is not always automatically done in {{UBIK}} clients.
** If the archive document is a part of the infrastructure objects, its file is automatically downloaded during login (as long as the client is in online/auto sync mode);
** Otherwise, one has to either navigate to that document or download a branch containing that document.
* One can deploy multiple sets of UI customizings in a single archive document by placing them under corresponding folders. Theoretically, it's okay to configure and deliver multiple archive documents to the clients since the content will be unpacked just the same. However, it's our recommendation to use a single archive document not only because it's simpler, but also see below;
[[File:UI_WinX_Customizing_Version.png|thumb|alt=Customizing Version|Customizing Version]]
* The version information of the UI customizings is available on the archive document and is displayed together with the client version at the bottom of the login page. Currently there's no additional UI to display a list of versions, so the version of a randomly chosen archive will be displayed in case multiple are present. Also, the version information only becomes available after a user logins in (which grants access to the content).

=== Known Issues ===
Sometimes, unpacking UI customizing archives might fail because the app cannot overwrite some files which are being used in the current UI. A typical example of this is related to using the Image control.
In the example below, an image file "UBIK.png" under the "Demo" customizing folder is referenced by an Image control. If such a control is displayed while an archive containing a set of UI customizings with the same name "Demo" is received on the client, the unpacking will fail because the UI is still holding onto the file, which blocks the unpacking.
<syntaxhighlight lang="xml">
<Grid>
<Image ...
Source="ms-appdata:///local/xaml/Demo/Images/UBIK.png" />
</Grid>
</syntaxhighlight>
This tends to happen with image files used in the login/home page since that's where users are most likely at when UI customizing archives are received. In such cases, one can use the following converter technique so that the image files can be safely deleted even when they are being displayed.
<syntaxhighlight lang="xml">
<Grid>
<Grid.Resources>
<x:String x:Key="logo">ms-appdata:///local/xaml/Demo/Images/UBIK.png</x:String>
</Grid.Resources>
<Image ...
Source="{Binding Source={StaticResource logo}, Converter={StaticResource PathToImageConverter}}" />
</Grid>
</syntaxhighlight>
{{Attention|The converter essentially creates a copy of the image file in the device memory. While solving the deletion problem, it does add up the memory consumption. So one should be cautious about using this converter too much especially when the images are relatively large.}}
{{Hint|An easy way to verify whether the failing of unpack is related to the deletion is to check in Windows Explorer whether there are files that can not be manually deleted in the target unpakcing folder before closing the {{UBIK}} app. If that's the case, please check the customizings and see if there's any reference to those files that can not be deleted. When the problem is not solvable with the above mentioned technique, please [https://support.augmensys.net/scp/index.php create a ticket with sufficient details] or manually delete the files after closing the app.}}

== Delete UI customizings ==
In UWP, customizing files can be deleted manually in the app data folder.

Similar to the importing scenario, it's impossible to delete customizing files from the app data folder with UBIK.Xamarin for Android and iOS, those clients provide an alternative option to "Delete Customizing" in the general settings (not yet available on UWP).
* {{Version/XamarinSince|4.7}} All customizing files for all users will be cleared.
* Versions before 4.7: to properly clear all customizing related files it is necessary to "Delete files" additionally to "Delete Customizing" (Note: with "Delete files" all online documents will be cleared).

[[Category:Client|Deploy UI Customizings (Client)]]
[[Category:WinX|Deploy UI Customizings (Client)]]
[[Category:Xamarin|Deploy UI Customizings (Client)]]
[[Category:XAML|Deploy UI Customizings (Client)]]

MROCLS MRO SUPERVISOR

2024-10-17T10:50:50Z

JKN: /* See also */

{{ClassificationInfoBox
| title = MRO Supervisor Classification Object
| name = {{PAGENAMEE}}
| inheritance = SYSCLS_OBJECTWITHRFIDTAG
| namespace = System.MRO
| purpose = Classify a User as a Supervisor to let him approve Supervisor Tasks.
| version = 4.8.1+
| id = {1DD7076B-7E27-422D-8317-315EED8CCBB1}
}}

If a Login object is classified as Supervisor it can act as such in the device based 4-eyes acceptance workflow.
Only Supervisors are allowed to finish Supervisor Tasks.

== MetaProperties ==
{| class="wikitable" width=50%
|-
! width=30% | Name !! width=20% | Data type !! Comment
|-
| PERMISSIONS|| {{string}} || Concatenated string to define permissions (codes) that are required to open this task.
|-
| PIN_HASH|| {{string}} || String property storing the hash code of the entered pin.
|}

[[Category:4.8.1|MROCLS MRO SUPERVISOR]]
[[Category:Classifications|MROCLS MRO SUPERVISOR]]

== See also ==
* [[MROCLS_MRO_SUPERVISOR_TASK|Supervisor Task]]
* [[MRO_Objects_(Client)#Supervisor_Task]]

{{Category/Version|4.8.1}}

[[Category:4.8.1|MROCLS MRO SUPERVISOR]]
[[Category:Classifications|MROCLS MRO SUPERVISOR]]

MROCLS MRO SUPERVISOR TASK

2024-10-17T10:50:28Z

JKN: /* See also */

{{ClassificationInfoBox
| title = MRO Supervisor Task Classification Object
| name = {{PAGENAMEE}}
| inheritance = MROCLS_MRO_TASK
| namespace = System.MRO
| purpose = Classify a task as a Supervisor Task to let only Supervisors approve this task.
| version = 4.8.1+
| id = {C63511FA-4852-4FE7-B5BC-4247136B8B8E}
}}

If a task object is classified as Supervisor Task, it will mark a task as supervisor - task. This means, that this task may only be edited by a supervisor who has to identify himself using a RFID token and a PIN based verification. This task fullfills the requirements of a device based/shared 4-eyes acceptance workflow.

== MetaProperties ==
{| class="wikitable" width=50%
|-
! width=30% | Name !! width=20% | Data type !! Comment
|-
| PERMISSIONS|| {{string}} || Concatenated string to define permissions (codes) that are required to open this task.
|-
| SUPERVISOR|| {{guid}} || Reference to the supervisor login that finished the Task.
|}
== See also ==
* [[MROCLS_MRO_SUPERVISOR|Supervisor]]
* [[MRO_Objects_(Client)#Supervisor_Task]]

{{Category/Version|4.8.1}}

[[Category:4.8.1|MROCLS MRO SUPERVISOR TASK]]
[[Category:Classifications|MROCLS MRO SUPERVISOR TASK]]