UBIK Wiki Test / Augmensys - User contributions [en]

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

View Cache

2024-03-14T14:55:06Z

JKN: /* GetViewStateDetails */

The View Cache feature increases the performance of the [[web Service]] by caching the data to be published and sent to the clients. All content data as well as the hierarchies, as defined by the [[View]] and in the [[ACM]], is evaluated and cached internally. Be aware, that this data does not encompass the physical documents linked to the objects, hence the documents have to be loaded if requested from the client.

A client's request for hierarchical data, covering '''two or more hierarchy''' levels, will be handled using the cached data. Any request covering only one hierarchy level will by-pass the view cache and be treated directly. For example, browsing through the objects using the [[Content Browser]] does not use the View Cache, whereas preparing the [[HowTo:Switch_to_Offline_Mode|Offline Mode]] utilizes the cache to improve performance.

Once the cache has been initialized, its status and additional information can be retrieved by [[#Web Service Interface|web service methods]].
{{Attention|Up to now the View Cache needs to be initialized and updated manually after every (re)start of the web service. This can be done manually or by using an automatism!}}

== Using the View Cache ==
=== Initialization / Update of View Cache ===
The cache needs to be initialized after a web service has been (re)started by calling the method [[#TriggerViewStateUpdate|TriggerViewStateUpdate]].
If a client commits data via a web service having the View Cache enabled, the cached data gets updated. Consequently, any other client connected to this web service receives this updates as well.
{{Attention|Be aware, that the View Cache's scope is valid only within a web service instance. A client connected to a different web service does not receive updates happening in a different web service's View Cache.}}

=== Application Pool Settings ===
[[File:UI ApplicationPool AdvancedSettings.png|thumb|Application Pool / Advanced Settings]]
Any in-memory data of a web service, respectively an application pool, is lost whenever application pools are (automatically) recycled. Although there is no downtime during a recycle, this empties the View Cache's memory.

Due to the missing automatism for a periodic initialization or update, the default interval settings for recycling '''must''' be changed, such that the application pool and the related web services are not recycled automatically.

The according settings of the application pool are
{| class="wikitable sortable"
|-
! Setting !! Default value !! Recommended value !! Comment
|-
| {{Menu nav|Advanced Settings|Recycling|Regular Time Interval (minutes)}} || 1740 || 0 || Application pool will be recycled after this time
|-
| {{Menu nav|Advanced Settings|Process model|Idle Time-out (minutes)}}|| 20 || 0 || Application pool will be terminated after this time without any traffic
|}
{{Attention|The value of the ''Idle Time-out (in minutes)'' property must be less than the value of the ''Regular Time Interval (in minutes)'' property (Source: [https://support.microsoft.com/en-us/kb/954871 Microsoft Support]).}}

=== Testing ===
Test the View Cache's result for a single object, given by its {{Guid}}, via the method [[#TestViewState|TestViewState]].
The result will not retrieve the physical documents.

== Web Service Interface ==
Use the these web service members to gain status and runtime information of the View Cache. More detailed information and a comprehensive list of all members and data types are located in the {{UBIK}} class documentation.

=== GetViewStateInformation ===
Get information about the current state of the View Cache.
<syntaxhighlight lang="csharp">
/// <summary>
/// Gets information abut the state of view cache.
/// </summary>
/// <param name="appName">Name of the application.</param>
/// <param name="contextName">Name of the context.</param>
/// <param name="authentication">The authentication.</param>
/// <returns>Information about the state of the view cache as human readable string</returns>
[OperationContract]
[WebInvoke(UriTemplate = "GetViewStateInformation/{appName}/{contextName}/{authentication}", Method = "GET",
RequestFormat = WebMessageFormat.Json,
ResponseFormat = WebMessageFormat.Json)]
string GetViewStateInformation(string appName, string contextName, string authentication);
</syntaxhighlight>

To call this in a web browser, one can access
<syntaxhighlight lang="html4strict">
https://ContentServerAddress/ContentServicePath/GetViewStateInformation/AppName/ContextName/333b99c9-233d-41d6-848c-81fe0b13a537
</syntaxhighlight>
to fetch data. Please replace ContentServerAddress, ContentServicePath, AppName and ContextName with the actual service configs.

Once the view cache is ready, the response should say something like "Cache State <<ONLINE>>"

=== TriggerViewStateUpdate ===
Start or trigger reinitialization of the View Cache.
<syntaxhighlight lang="csharp">
/// <summary>
/// Triggers a refresh of the view cache.
/// The current cache stays valid until the new cache was fully built.
/// </summary>
/// <param name="appName">Name of the application.</param>
/// <param name="contextName">Name of the context.</param>
/// <param name="authentication">The authentication.</param>
/// <returns>true as the refresh was triggered successfully, false otherwise</returns>
[OperationContract]
[WebInvoke(UriTemplate = "TriggerViewStateUpdate/{appName}/{contextName}/{authentication}", Method = "GET",
RequestFormat = WebMessageFormat.Json,
ResponseFormat = WebMessageFormat.Json)]
bool TriggerViewStateRefresh(string appName, string contextName, string authentication);
</syntaxhighlight>

To call this in a web browser, one can access
<syntaxhighlight lang="html4strict">
https://ContentServerAddress/ContentServicePath/TriggerViewStateUpdate/AppName/ContextName/333b99c9-233d-41d6-848c-81fe0b13a537
</syntaxhighlight>
to trigger an update. Please replace ContentServerAddress, ContentServicePath, AppName and ContextName with the actual service configs.

=== GetViewStateDetails ===
Gets detail information abut the view cache, it's state and the duration for loading its components.

<syntaxhighlight lang="csharp">
/// <summary>
/// Gets detail information abut the view cache, it's state and the duration for loading its components.
/// </summary>
/// <param name="appName">Name of the application.</param>
/// <param name="contextName">Name of the context.</param>
/// <param name="authentication">The authentication.</param>
/// <returns>Detail information abut the view cache, it's state and the duration for loading its components</returns>
[OperationContract]
[WebInvoke(UriTemplate = "GetViewStateDetails/{appName}/{contextName}/{authentication}", Method = "GET",
RequestFormat = WebMessageFormat.Json,
ResponseFormat = WebMessageFormat.Json)]
UBIK.Service.DTO.V360.ViewCacheInfoItem[] GetViewStateDetails(string appName, string contextName, string authentication);
</syntaxhighlight>

To call this in a web browser, one can access
<syntaxhighlight lang="html4strict">
https://ContentServerAddress/ContentServicePath/GetViewStateDetails/AppName/ContextName/333b99c9-233d-41d6-848c-81fe0b13a537
</syntaxhighlight>
to fetch details. Please replace ContentServerAddress, ContentServicePath, AppName and ContextName with the actual service configs.

As long as the ViewCache is not initiliazed (not online yet) you will only receive details about the Data Pool and its size.

[[Category:Installing|View Cache]]
[[Category:Web service|View Cache]]

=== TestViewState===
Test the View Cache's result for a single object, without retrieving the physical documents.
<syntaxhighlight lang="csharp">
/// <summary>
/// Test member for testing the View Cache.
/// </summary>
/// <param name="appName">Name of the application.</param>
/// <param name="contextName">Name of the context.</param>
/// <param name="ownerUID">UID of the object the test should be executed for (e.g. root object). All data below this object will be delivered.</param>
/// <param name="authentication">The authentication.</param>
/// <returns>data stored in the view cache as BCHierarchyDeltaShipments</returns>
[OperationContract]
[WebInvoke(UriTemplate = "TestViewState/{appName}/{contextName}/{owneruid}/{authentication}", Method = "GET",
RequestFormat = WebMessageFormat.Json,
ResponseFormat = WebMessageFormat.Json)]
DTO.V211.BCHierarchyDeltaShipments TestViewState(string appName, string contextName, string ownerUID, string authentication);
</syntaxhighlight>

== See also ==
* [http://weblogs.asp.net/owscott/why-is-the-iis-default-app-pool-recycle-set-to-1740-minutes Why is the IIS default app pool recycle set to 1740 minutes?]

[[Category:Installing|View Cache]]
[[Category:Web service|View Cache]]

Activity:CreateOPCUAConnection (Activity)

2024-03-06T10:49:29Z

JKN: /* See also */

The CreateOPCUAConnection creates a connection to an OPC UA data source. A valid connection is the initial step in communicating with OPC sources.

=Description=
{{ActivityInfoBox
| title = Create OPC UA Connection
| name = CreateOPCUAConnection
| image = [[File:UI_Activity_CreateOPCUAConnection.png|220px]]
| imagecaption = CreateOPCUAConnection (Expanded)
| purpose = Connect to OPC UA
| category = UBIK OPC UA Interface
| returns = True if successful
| version = 2.4.1+
}}

===Arguments===

{| class="wikitable sortable" | width = "70%"
|-
! Argument!! Type !! Direction !! Purpose
|- align="left"
| SessionName|| {{String_MSDN}}|| In || Configures the session name property of an UPC UA connection. This name is transferred to the server when the connection is opened.
|- align="left"
| ApplicationName|| {{String_MSDN}}|| In || Configures the OPC UA application name property of an OPC UA connection. The application name is used to configure the OPC UA endpoint and to identify the client certificate in the Windows certification store.
|- align="left"
| ApplicationURI|| {{String_MSDN}}|| In || Configures the OPC UA application URI property of an OPC UA connection. The application URI is used to configure the OPC UA endpoint.
|- align="left"
| ProductURI|| {{String_MSDN}}|| In || Configures the OPC UA product URI property of an OPC UA connection. The product URI is used to configure the OPC UA endpoint.
|- align="left"
| TransportProfile|| OpcUaTransportProfileType|| In || Configures the transport profile to use for the client endpoint.
|- align="left"
| URL|| {{String_MSDN}}|| In || Configures the session URL property of an OPC UA connection. The session URL specifies the target point for an OPC UA connection and contains the transport protocol (i.e. TCP or HTTP) and the target address, along with optional parameters to identify specific channels on the target server.
|- align="left"
| URL_HTTP|| {{String_MSDN}}|| In || ...
|- align="left"
| URL_TCP|| {{String_MSDN}}|| In || ...
|- align="left"
| OperationTimeOut|| {{TimeSpan_MSDN}}|| In || Configures the operation timeout property of an OPC UA connection. Actions initiated by the client will time out, if they are not completed within the timeout value specified by this option. The default value is 60 seconds.
|- align="left"
| UseBinaryEncoding|| {{String_MSDN}}|| In || Configures the OPC UA connection to use the OPC UA binary encoding. If this option is configured to false, XML encoding will be used.
|- align="left"
| ClientCertificate|| X509Certificate2|| In || Configures the client certificate to use for the OPC UA connection. The client certificate will be used by the server to authenticate the client. Connections no validated successfully will be forcefully closed by the server.
|- align="left"
| [[#CertificateStoreType|CertificateStoreType]] || {{String_MSDN}}|| In || Configures the certificate store type to use for the retrieval of the client certificate when it is not directly configured. The default is to search the Windows certificate storage.
|- align="left"
| [[#CertificateStorePath|CertificateStorePath]] || {{String_MSDN}}|| In || Configures the certificate store path to use for the retrieval of the client certificate when it is not directly configured. The default is to search for certificates installed to the local machine (as opposed to the current user).
|- align="left"
| CertificateSubject|| {{String_MSDN}}|| In || Configures the subject of the client certificate when retrieving that from the certificate storage.
|- align="left"
| SecurityPolicy|| OpcUaSecurityPolicyType|| In || Configures the security policy to use for the client endpoint.
|- align="left"
| MessageSecurity|| OpcUaMessageSecurityMode|| In || Configures the message security mode to use for the client endpoint.
|- align="left"
| UserName|| {{String_MSDN}}|| In || Configures the options for a username/password style authentication.
|- align="left"
| Password|| {{String_MSDN}}|| In || Configures the options for a username/password style authentication.
|- align="left"
| Connection|| OpcUaServerConnection|| Out || returns the created connection.
|- align="left"
| Result|| {{Boolean_MSDN}}|| Out || True if successful, false if failed
|}

==== CertificateStoreType ====
* "Windows" ... for a windows certificate store,
* "Directory" ... for a directory certificate store.
==== CertificateStorePath ====
The value has to be a combination of the OPA UA ''StoreLocation'' and ''StoreNames'' constants, for example "LocalMachine\My".

Constants that identify certificate store locations.
* "CurrentUser" ... The store assigned to the current user.
* "LocalMachine" ... The store assigned to the local machine.

Constants that identify certificate store names.
* "UA Applications" ... The store used for UA application certificates.
* "UA Certificate Authorities" ... The store used for UA certificate authorities certificates.
* "My" ... The store used for personal certificates.
* "Root" ... The store used for trusted root certificate authorities.

[[Category:OPC|CreateOPCUAConnection (Activity)]]

===Usage===
This activity is used to start the communication with an OPC data source. It is a nestable activity, which means it can host any amount of sub-activities that will be processed sequentially. The hosted activities are typically [[Activity:ConfigureOPCUAVariable (Activity)|ConfigureOPCUAVariable]] activities, either as direct children but also wrapped within looping activities like ForEach or While.

=Example=
The CreateOPCUAConnection activity, as used in the larger example "Read value from OPC variable":

[[File:UI_Activity_CreateOPCUAConnection_Example.png|x700px]]

<headertabs />

==See also==
* [[OPC UA (Plugin)]]
* [[Workflow Designer]]
* [[Activity:ConfigureOPCUAVariable (Activity)]]
* [[Activity:CreateOPCUAScope (Activity)]]
* [http://documentation.unified-automation.com/uasdkdotnet/2.3.1/html/namespaceUnifiedAutomation.html UA Bundle SDK .NET]

[[Category:OPC|CreateOPCUAConnection (Activity)]]

OPC UA (Plugin)

2024-03-06T10:48:47Z

JKN:

The {{UBIK}} [http://en.wikipedia.org/wiki/OPC_Unified_Architecture OPC Unified Architecture] interface module enables interfacing between a {{UBIK}} server and any OPC UA compliant data source in a bidirectional manner.

==Prerequisites==
[[File:UI_OPCUA_Certificate.png|border|thumb|Export Certificate]]
The {{UBIK}} OPC UA components are acting as an OPC Client, therefore a secure connection to the respective OPC Server needs to be established in order to be able to communicate. The security standards that need to be applied are highly dependent on the server configuration and security infrastructure, but normally at least a client certificate needs to be issued that has to be trusted by the server:

# Open a command box on the {{UBIK}} server with administrator privileges (''"Run as administrator..."'')
# Run the program ''CreateCertifcate.exe'' from this archive {{FileLink|CreateCertificate.zip|CreateCertificate.zip}}
# Open the program ''Manage computer certificates'' (typically ''C:\WINDOWS\System32\certlm.msc'')
# Navigate to ''Personal - Certificates'' and find the certificate named ''UBIK OPCUA Interface''
# Export the certificate and trust it on your OPC server

=={{UBIK}} Activities==
{| class="wikitable sortable" | width = "50%"
|-
! Activity!! Category !! Purpose (Short)
|- align="left"
| [[Activity:CreateOPCUAConnection (Activity)|CreateOPCUAConnection]]|| UBIK OPC UA Interface || Creates a new connection to an OPC UA data source
|- align="left"
| [[Activity:ConfigureOPCUAVariable (Activity)|ConfigureOPCUAVariable]]|| UBIK OPC UA Interface || Configures a single OPC variable in a connection for later access
|- align="left"
| [[Activity:CreateOPCUAScope (Activity)|CreateOPCUAScope]]|| UBIK OPC UA Interface || Defines a scope in an OPC UA connection wherein variables can be accessed
|- align="left"
| [[Activity:AccessOPCUAVariable (Activity)|AccessOPCUAVariable]]|| UBIK OPC UA Interface || Reads or writes a single configured OPC UA variable
|- align="left"
|}

==Examples==
Download example workflow {{FileLink|OPCReadVariables.uwf|OPCReadVariables.uwf}} for use against the OPC Quickstart Data Access Server.

== See also ==
* [http://documentation.unified-automation.com/uasdkdotnet/2.3.1/html/namespaceUnifiedAutomation.html UA Bundle SDK .NET]
* [[Activity:CreateOPCUAConnection_(Activity)|CreateOPCUAConnection (Activity)]]

[[Category:OPC|OPC UA (Module)]]
[[Category:Plugin|OPC UA (Plugin)]]

HowTo:Configure Microsoft IIS for UBIK

2024-02-08T10:42:00Z

JKN: /* Certificate */

[[File:UI_10_IIS_Manager.png|thumb|220px|alt=IIS Manager|IIS Manager]]
The web server can be configured using the ''Internet Information Services (IIS) Manager'' console, which provides a graphical user interface to manage and configure the web server accordingly for the {{UBIK}} web service.

== Add Application Pool ==
An application pool is a group of one or more URLs that are served by a worker process or a set of worker processes. Application pools set boundaries for the applications they contain, which means that any applications that are running outside a given application pool cannot affect the applications in the application pool.

<gallery widths="400" heights="400" >
File:UI Application Pool.01.png|1 - Application Pool
File:UI Application Pool.02.png|2 - Application Pool
File:UI Application Pool.03.png|3 - Application Pool
</gallery>

{{Attention|If a [[#Optional:_Local_IIS_User|local user]] is used it must be set at the ''Identity'' parameter of the Application Pool.}}

== Certificate ==
A secure connection between the {{UBIK}} clients and web service requires a SSL certificate on both, the server and client. This certificate can either be a root authority certificate, or any other public key certificate from a certificate authority enabling a secured connection between the web service and the clients. Self-signed certifcates will be rejected by the client {{Version/WinXSince|4.0}} {{Version/XamarinSince|4.0}}

A new self-signed certificate can be created in the ''Internet Information Server (IIS) Manager'', exported using the export function and sent to the development team. As already mentioned, the client has to know this certificate as well, hence it need to be integrated it into the mobile application.

{{Attention|{{UBIK}} requires a valid certificate for SSL encryption, free certifcates can be obtained e.g. from [https://letsencrypt.org/ Let's Encrypt]!}}

<gallery widths="400" heights="400" >
File:UI Certificate.01.png|1 - IIS Configuration
File:UI Certificate.02.png|2 - Installed certificates
File:UI Certificate.03.png|3 - Create self-signed certificate
File:UI Certificate.05.png|4 - Import certificate
File:UI Certificate.04.png|5 - Installed certificates
</gallery>

[[Category:How-To|Configure Microsoft IIS for UBIK]]
[[Category:Installing|Configure Microsoft IIS for UBIK]]
[[Category:Pages with broken file links|Configure Microsoft IIS for UBIK]]
[[Category:Web service|Configure Microsoft IIS for UBIK]]

== Bindings ==
Web sites and services have something called ''Server Bindings'' which represent the underlying address, port, and potentially a host header that the website is accessed using. The {{UBIK}} client accesses the web service via a secured port (https), where it is necessary to configure the appropriate certificate.

===For Android Clients===
<gallery widths="400" heights="400" >
File:UI Binding.01.png|1 - Binding
File:UI Binding.02.png|2 - Binding
File:UI Binding.03.png|3 - Binding
File:UI Binding.04.png|4 - Binding
</gallery>

===For WinX and Web-Client===
<gallery widths="400" heights="400" >
File:UI Binding.01.png|1 - Binding
File:UI_Binding_Win8.02.png|2 - Binding
File:UI_Binding_Win8.01.png|3 - Binding
File:UI_Binding_Win8.02.png|4 - Binding
</gallery>

== Configure compression ==
Web service responses can be compressed in order to improve performance and reduce web traffic. This can be easily done from the web server side in IIS manager.
{{Hint|In case the compression modules are not yet installed, please refer to [[https://www.iis.net/configreference/system.webserver/httpcompression?showTreeNavigation=true this]] for instructions.}}
<gallery widths="400" heights="300" >
File:HowTo_IIS_Compression_01.png|1 - Entries for compression settings
File:HowTo_IIS_Compression_02.png|2 - Enable compression in general
File:HowTo_IIS_Compression_03.png|3 - Configure what & when to compress
File:HowTo_IIS_Compression_04.png|4 - Configure what to compress
</gallery>
* It is possible to configure when to compress service responses like shown in Figure.3. The "dynamicCompressionDisableCpuUsage" tells the service to stop compressing when the CPU load reaches above 90%; And the "dynamicCompressionEnableCpuUsage" tells the service to start compressing when the CPU load drops below 50%. These parameters should work well in most cases but can be modified if necessary;
* {{UBIK}} service responses are in formats of either "text/xml"(text/*) or "application/json". So just make sure they are configured to be compressed like shown in Figure.4. If there are no such entries, just right click and add them accordingly;
* There are 10 different levels of compression, ranging from 0~9 where 9 is most CPU intensive but produces the best compress rate. The default level is 0 and this can be changed (e.g. to level 9) with the following command (need to run the Windows console as an administrator first):
C:\Windows\System32\Inetsrv\Appcmd.exe set config -section:httpCompression -[name='gzip'].dynamicCompressionLevel:9
<gallery widths="700" heights="140" >
File:HowTo_IIS_Compression_05.png|5 - Change compression levels
</gallery>
Here are some test results of the transferred content size and duration under different compression levels.

{| class="wikitable" | width = "50%" | style="text-align:right;"
|-
! style="text-align:right;"| Compression Level !! style="text-align:right;"| Meta Definitions !! style="text-align:right;"| One Content Level !! style="text-align:right;"| Branch Download
|-
| Level 0|| 4,732,058 bytes || 23,470 bytes || 318,847,597 bytes (9 minutes)
|-
| Level 4|| 3,050,115 bytes || 7,915 bytes || 79,384,336 bytes (5 minutes)
|-
| Level 9|| 2,851,318 bytes || 5,681 bytes || 48,037,714 bytes (4 minutes)
|-
|}

As one can see from the table, compression can greatly reduce the amount of data to transfer. So theoretically, it is recommended to turn it on and use a higher compression level whenever possible. In practice, though, one has to check the following facts before making such a decision.
* CPU: Compression will require additional CPU processing power (more for higher levels).
* Network bandwidth: The lower the bandwidth, the more sense it makes to enable compression.

In the table above, one might already notice the reduction in time is not linear to the reduction in data amount. Take level 0 and level 9 for example, the time is "only" cut in half even when the data amount is reduced by 85%. These were tested with a 54Mbps bandwidth. Once we did our tests again with a 450Mbps bandwidth, the time reduction is even less (less than 6 minutes v.s. 3 minutes). If the bandwidth increases further, e.g. to Gbps, the time reduction might become negligible. Combined with a weak CPU, it is even possible that the time will be increased with higher compression levels.

Therefore, there is no general rulebooks for whether to turn on compression or not. The safest approach is still to try out different settings in the real setup.

As for the memory consumption, no observable difference was found between different compression settings (no compression and level 0 to 9) during our testing.

== Create new Web Application ==
In the ''IIS Manager'' expand the ''Default Web Site'' node and navigate through the folder structure to the folder containing the {{UBIK}} web service components.

<gallery widths="400" heights="400" >
File:UI New Service.01.png|1 - New Service
File:UI_New Service.02.png‎|2 - New Service
File:UI_New Service.03.png‎|3 - New Service
File:UI_New Service.04.png‎|4 - New Service
File:UI_New Service.05.png‎|5 - New Service
File:UI_New Service.06.png‎|6 - New Service
File:UI_New Service.07.png|7 - New Service
File:UI_New Service.08.png|8 - New Service
File:UI_New Service.09.png|9 - New Service
</gallery>

== Optional: Local IIS User ==
Create and use a local user on the web server if no appropriate domain-user is available.

{{Attention|The user has to be able to copy the customizing to its local user data directory on the machine! Hence, it also needs appropriate user permissions to the {{UBIK}} data share.}}

<gallery widths="400" heights="400" >
File:UI_Local_IIS_user.01.png|1 - Local IIS-user
File:UI_Local_IIS_user.02.png‎|2 - Local IIS-user
File:UI_Local_IIS_user.03.png‎|3 - Local IIS-user
File:UI_Local_IIS_user.04.png‎|4 - Local IIS-user
File:UI_Local_IIS_user.05.png‎|5 - Local IIS-user
File:UI_Local_IIS_user.06.png‎|6 - Local IIS-user
File:UI_Local_IIS_user.07.png|7 - Local IIS-user
File:UI_Local_IIS_user.08.png‎|8 - Local IIS-user
File:UI_Local_IIS_user.09.png‎|9 - Local IIS-user
</gallery>

== Additional prerequisites ==
* Ensure that the service ports are not blocked by a firewall.
* Ensure that port forwarding is established if needed (e.g. for Microsoft Azure Virtual Computers or servers behind a gateway)

== Testing the Web Service ==
Test the web service by entering the following URL in a browser:
<code>
<nowiki>https://<SERVER-IP>[:<PORT>]/<PATH-TO-UBIK-WEBSERVICE>/UBIKContent.svc/GetVersion</nowiki>
</code>

== Further Security Configuration & Hardening ==

=== TLS Level ===
If the {{UBIK}} WebServices are supposed to communicate with other WebServices, e.g. an interface component or an Azure Blob container for file storage, the appropriate TLS level needs to be ensured. While this can be enforced with a registry key, it is best practice to let the OS and the .NET Framework negotiate it. To enable that, the ''targetFramework'' attribute of the ''httpRuntime'' element in the ''Web.config'' file of the WebService in question (normally the {{UBIK}} content WebService) has to be set to the desired .NET Framework level, should typically be the same that the service was compiled against. So if TLS 1.2 shall be supported and default, the ''targetFramework'' needs to be set to 4.6 like in this example:

<source lang="xml">
<system.web>
<customErrors mode="Off"/>
<httpRuntime maxRequestLength="65536" targetFramework="4.6" />
<compilation debug="true"
defaultLanguage="c#"
targetFramework="4.6" />
</system.web>
</source>

The full documentation on TLS best practices with .NET can be found [https://docs.microsoft.com/en-us/dotnet/framework/network-programming/tls here].

=== Hardening ===
For hardening instructions of IIS, please follow the following best practice guidelines:
* [https://www.cisecurity.org/benchmark/microsoft_iis/ Center for Internet Security IIS Benchmark]
* [https://docs.microsoft.com/en-us/previous-versions/windows/it-pro/windows-server-2012-r2-and-2012/jj635855(v=ws.11) Security Best Practices for IIS]

[[Category:How-To|Configure Microsoft IIS for UBIK]]
[[Category:Installing|Configure Microsoft IIS for UBIK]]
[[Category:Pages with broken file links|Configure Microsoft IIS for UBIK]]
[[Category:Web service|Configure Microsoft IIS for UBIK]]

== See also ==
* [[HowTo:Install UBIK Web Service|Install {{UBIK}} Web Service]]
* [[HowTo:Install Microsoft IIS]]

[[Category:How-To|Configure Microsoft IIS for UBIK]]
[[Category:Installing|Configure Microsoft IIS for UBIK]]
[[Category:Pages with broken file links|Configure Microsoft IIS for UBIK]]
[[Category:Web service|Configure Microsoft IIS for UBIK]]

Version 4

2023-09-29T06:51:14Z

JKN:

{{RoadmapDetailHeader}}

{{RoadmapDetailItem
| version=4.7
| date=2024
| status={{RoadmapChip-Announced|Future}}
| content=
}}

{{RoadmapDetailItem
| version=4.6
| date=2024
| status={{RoadmapChip-Announced|Future}}
| content=
{{RoadmapDetailFeature | feature=Prefilter Objects with the same QR code. }}
{{RoadmapDetailFeature | product={{RoadmapChip-Xamarin}} | feature=Customizable Visibility of appbar Menu Button.}}
{{RoadmapDetailFeature | feature=Productization of MaTaP (Management Tool for Turnarounds and Projects) Features. }}
}}

{{RoadmapDetailItem
| version=4.5
| date=October 2023
| status={{RoadmapChip-Planned|In Development}}
| content=
{{RoadmapDetailFeature | product={{RoadmapChip-CUI}} | feature=Reset of Proxies. }}
{{RoadmapDetailFeature | product={{RoadmapChip-CUI}} | feature=Support of Comos Reference Documents. }}
{{RoadmapDetailFeature | product={{RoadmapChip-CUI}} | feature=Support of Comos DocObjs. }}
{{RoadmapDetailFeature | feature=Extension of Live Value Attributes. }}
{{RoadmapDetailFeature | product={{RoadmapChip-Xamarin}} | feature=Support for Bing Road Map. }}
{{RoadmapDetailFeature | product={{RoadmapChip-Xamarin}} | feature=Support Chinese Characters in Map Pins. }}
{{RoadmapDetailFeature | product={{RoadmapChip-WinX}} | feature=Auto Search and Highlight on PDF Preview. }}
}}

{{RoadmapDetailItem
| version=4.4
| date=September 2023
| status={{RoadmapChip-Released|Latest Release}}
| content=
{{RoadmapDetailFeature | product={{RoadmapChip-Mobile}} | feature=Initial SSO features. | descr=first set of SSO features are now available in the Xamarin Android client and the web client.}}
{{RoadmapDetailFeature | product={{RoadmapChip-Xamarin}} | feature=Scanning of small QR-Codes. | descr=Scanning of QR-Codes with a size of roughly 1x1cm.}}
{{RoadmapDetailFeature | feature=Lazy Loading Queries. | descr=A performance enhancing [[SYSCLS_LAZY_LOADING_QUERY|LazyLoading]] classification can be added to Queries.}}
{{RoadmapDetailFeature | product={{RoadmapChip-Studio}} | feature=Classification-Based Creation of MetaProperties. }}
{{RoadmapDetailFeature | feature=1-to-n: Optical Code Scanning. | descr=Scan multiple QR-Codes that all navigate to one UBIK object.}}
{{RoadmapDetailFeature | feature=Set current Location to Object. | descr=A TeachInCommand is now available in ContentViewModel and PropertyViewModel to set the device's current location as the geo property value.}}
{{RoadmapDetailFeature | product={{RoadmapChip-Mobile}} | feature=Focus highlight text in PDF. | descr=Highlighting of texts based on a property in a Document.}}
{{RoadmapDetailFeature | product={{RoadmapChip-iOS}} | feature=Signature Editing. | descr=Signing functionality is now also available on iOS.}}
{{RoadmapDetailFeature | product={{RoadmapChip-CUI}} | feature=Support of Non-native Comos Documents. }}
{{RoadmapDetailFeature | product={{RoadmapChip-CUI}} | feature=Import DisplayValue with Unit. | descr=CUI MetaProxy Properties support a new configuration setting called "Import Type" The default value "Standard" will import Property Values as before If set to "DisplayValue" CUI will import the Display Value including the physical Unit from a Comos Specification. Export of such MetaProxy Properties is no supported. }}
{{RoadmapDetailFeature | product={{RoadmapChip-CUI}} | feature=Support of GeoData. | descr=CUI supports the import and export of Properties of type GeoData now. For this a MetaProxyProperty of type string must be used on the MetaProxy. }}
{{RoadmapDetailFeature | product={{RoadmapChip-CUI}} | feature=Import of Date Time Values. | descr=Improvements to import of DateTime values from Comos. }}
{{RoadmapDetailFeature | product={{RoadmapChip-Xamarin}} | feature=Increase the maximum zoom factor for the PdfViewer. | descr= Zoom further into a document.}}
}}

{{RoadmapDetailItem
| version=4.3
| date=April 2023
| status={{RoadmapChip-Released|Previous Release}}
| content=
{{RoadmapDetailFeature | feature=Overriding of MetaProperties. | descr=It is now possible to override inherited MetaProperties? and MetaProxyProperties?, including relation data details. This can be done using UBIK.Studio's Class Details browser or Relation Editor, as well as using SmartStudio?'s inheritance graph and meta proxy graph.}}
{{RoadmapDetailFeature | product={{RoadmapChip-Mobile}} | feature=Extended Mass Editing / Multi Object Selection. | descr=The client now supports a multi select mode which includes actions based on multi select and mass editing properties. The multi select mode can now be turned on independently for XAML filtered lists (UWP/Xamarin) that share the same source list.}}
{{RoadmapDetailFeature | product={{RoadmapChip-Mobile}} | feature=Support of Dynamic Selective List. | descr=The dynamic selective list items are now updated even when the relevant dependency properties/objects have changes that are not yet saved.}}
{{RoadmapDetailFeature | product={{RoadmapChip-Xamarin}} | feature=In-Document Search. | descr=Activated the text search functionality for the XAMARIN PDF viewer.}}
{{RoadmapDetailFeature | product={{RoadmapChip-Android}} | feature=Background Branch Download. | descr=Branch downloads are now performed in a dedicated background service and will work while the device is locked or in sleep mode.}}
{{RoadmapDetailFeature | product={{RoadmapChip-Xamarin}} | feature=Copy mobile Device ID. | descr=Now it's possible to copy the device ID by clicking on it.}}
{{RoadmapDetailFeature | product={{RoadmapChip-Studio}} | feature=UBIK 4.3 UI Redesign. | descr=New look for UBIK Studio start page.}}
}}

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

RoadmapOverview

2023-09-29T06:50:19Z

JKN:

{{RoadmapOverview
| versionReleases=[[Version_4|View All v4 Releases]]
| content=


| latest= {{RoadmapOverviewItem | version=4.4 | date={{RoadmapChip-Released|September 2023}} | content=
* Initial SSO features.
* {{RoadmapChip-Xamarin}} Scanning of small QR-Codes.
* Lazy Loading Queries.
* {{RoadmapChip-Studio}} Classification-Based Creation of MetaProperties.
* n-to-1: Optical Code Scanning.
* Focus highlight text in PDF.
* {{RoadmapChip-iOS}} Signature Editing.
* {{RoadmapChip-CUI}} Support of Non-native Comos Documents.
* {{RoadmapChip-CUI}} Import DisplayValue with Unit.
* {{RoadmapChip-CUI}} Support of GeoData.
}}

| next= {{RoadmapOverviewItem | version=4.5 | date={{RoadmapChip-Planned|October 2023}} | content=
* {{RoadmapChip-CUI}} Reset of Proxies.
* {{RoadmapChip-CUI}} Support of Comos Reference Documents.
* {{RoadmapChip-CUI}} Support of Comos DocObjs.
* Live Value Attributes as Property Description and Unit.
* {{RoadmapChip-Xamarin}} Support Bing Road Map.
* {{RoadmapChip-Xamarin}} Support Chinese Characters in Map Pins.
* {{RoadmapChip-WinX}} Auto Search and Highlight on PDF Preview.
}}

| future01= {{RoadmapOverviewItem | version=4.6 | date={{RoadmapChip-Announced|2024}} | content=
* Prefilter Objects with the same QR code.
* {{RoadmapChip-Xamarin}} Customizable Visibility of appbar Menu Button.
* Productization of MaTaP Features.
}}

| future02= {{RoadmapOverviewItem | version=4.7 | date={{RoadmapChip-Announced}} | content=
}}


}}

[[Category:Roadmap|RoadmapOverview]]

Version 4

2023-09-29T06:49:02Z

JKN:

{{RoadmapDetailHeader}}

{{RoadmapDetailItem
| version=4.7
| date=2024
| status={{RoadmapChip-Announced|Future}}
| content=
}}

{{RoadmapDetailItem
| version=4.6
| date=2024
| status={{RoadmapChip-Announced|Future}}
| content=
{{RoadmapDetailFeature | feature=Prefilter Objects with the same QR code. }}
{{RoadmapDetailFeature | product={{RoadmapChip-Xamarin}} | feature=Customizable Visibility of appbar Menu Button.}}
{{RoadmapDetailFeature | feature=Productization of MaTaP (Management Tool for Turnarounds and Projects) Features. }}
}}

{{RoadmapDetailItem
| version=4.5
| date=October 2023
| status={{RoadmapChip-Planned|In Development}}
| content=
{{RoadmapDetailFeature | product={{RoadmapChip-CUI}} | feature=Reset of Proxies. }}
{{RoadmapDetailFeature | product={{RoadmapChip-CUI}} | feature=Support of Comos Reference Documents. }}
{{RoadmapDetailFeature | product={{RoadmapChip-CUI}} | feature=Support of Comos DocObjs. }}
{{RoadmapDetailFeature | feature=Extension of Live Value Attributes. }}
{{RoadmapDetailFeature | product={{RoadmapChip-Xamarin}} | feature=Support for Bing Road Map. }}
{{RoadmapDetailFeature | product={{RoadmapChip-Xamarin}} | feature=Support Chinese Characters in Map Pins. }}
{{RoadmapDetailFeature | product={{RoadmapChip-WinX}} | feature=Auto Search and Highlight on PDF Preview. }}
}}

{{RoadmapDetailItem
| version=4.4
| date=September 2023
| status={{RoadmapChip-Released|Latest Release}}
| content=
{{RoadmapDetailFeature | product={{RoadmapChip-Mobile}} | feature=SSO features. | descr=first set of SSO features are now available in the Xamarin Android client and the web client.}}
{{RoadmapDetailFeature | product={{RoadmapChip-Xamarin}} | feature=Scanning of small QR-Codes. | descr=Scanning of QR-Codes with a size of roughly 1x1cm.}}
{{RoadmapDetailFeature | feature=Lazy Loading Queries. | descr=A performance enhancing [[SYSCLS_LAZY_LOADING_QUERY|LazyLoading]] classification can be added to Queries.}}
{{RoadmapDetailFeature | product={{RoadmapChip-Studio}} | feature=Classification-Based Creation of MetaProperties. }}
{{RoadmapDetailFeature | feature=1-to-n: Optical Code Scanning. | descr=Scan multiple QR-Codes that all navigate to one UBIK object.}}
{{RoadmapDetailFeature | feature=Set current Location to Object. | descr=A TeachInCommand is now available in ContentViewModel and PropertyViewModel to set the device's current location as the geo property value.}}
{{RoadmapDetailFeature | product={{RoadmapChip-Mobile}} | feature=Focus highlight text in PDF. | descr=Highlighting of texts based on a property in a Document.}}
{{RoadmapDetailFeature | product={{RoadmapChip-iOS}} | feature=Signature Editing. | descr=Signing functionality is now also available on iOS.}}
{{RoadmapDetailFeature | product={{RoadmapChip-CUI}} | feature=Support of Non-native Comos Documents. }}
{{RoadmapDetailFeature | product={{RoadmapChip-CUI}} | feature=Import DisplayValue with Unit. | descr=CUI MetaProxy Properties support a new configuration setting called "Import Type" The default value "Standard" will import Property Values as before If set to "DisplayValue" CUI will import the Display Value including the physical Unit from a Comos Specification. Export of such MetaProxy Properties is no supported. }}
{{RoadmapDetailFeature | product={{RoadmapChip-CUI}} | feature=Support of GeoData. | descr=CUI supports the import and export of Properties of type GeoData now. For this a MetaProxyProperty of type string must be used on the MetaProxy. }}
{{RoadmapDetailFeature | product={{RoadmapChip-CUI}} | feature=Import of Date Time Values. | descr=Improvements to import of DateTime values from Comos. }}
{{RoadmapDetailFeature | product={{RoadmapChip-Xamarin}} | feature=Increase the maximum zoom factor for the PdfViewer. | descr= Zoom further into a document.}}
}}

{{RoadmapDetailItem
| version=4.3
| date=April 2023
| status={{RoadmapChip-Released|Previous Release}}
| content=
{{RoadmapDetailFeature | feature=Overriding of MetaProperties. | descr=It is now possible to override inherited MetaProperties? and MetaProxyProperties?, including relation data details. This can be done using UBIK.Studio's Class Details browser or Relation Editor, as well as using SmartStudio?'s inheritance graph and meta proxy graph.}}
{{RoadmapDetailFeature | product={{RoadmapChip-Mobile}} | feature=Extended Mass Editing / Multi Object Selection. | descr=The client now supports a multi select mode which includes actions based on multi select and mass editing properties. The multi select mode can now be turned on independently for XAML filtered lists (UWP/Xamarin) that share the same source list.}}
{{RoadmapDetailFeature | product={{RoadmapChip-Mobile}} | feature=Support of Dynamic Selective List. | descr=The dynamic selective list items are now updated even when the relevant dependency properties/objects have changes that are not yet saved.}}
{{RoadmapDetailFeature | product={{RoadmapChip-Xamarin}} | feature=In-Document Search. | descr=Activated the text search functionality for the XAMARIN PDF viewer.}}
{{RoadmapDetailFeature | product={{RoadmapChip-Android}} | feature=Background Branch Download. | descr=Branch downloads are now performed in a dedicated background service and will work while the device is locked or in sleep mode.}}
{{RoadmapDetailFeature | product={{RoadmapChip-Xamarin}} | feature=Copy mobile Device ID. | descr=Now it's possible to copy the device ID by clicking on it.}}
{{RoadmapDetailFeature | product={{RoadmapChip-Studio}} | feature=UBIK 4.3 UI Redesign. | descr=New look for UBIK Studio start page.}}
}}

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

Version 4.3.0 (Server)

2023-05-22T15:40:35Z

JKN:

{| class="wikitable sortable" | width = "300"
|-
! Version !! Release Date
|-
| 4.0.0.15042 BETA (Revision A) || 2022.11.17
|-
| 4.0.0.15076 BETA (Revision B) || 2022.11.23
|-
| 4.0.0.15218 BETA (Revision C) || 2022.12.14
|-
| 4.0.0.15316 BETA (Revision D) || 2023.01.02
|-
| 4.0.0.15352 BETA (Revision E) || 2023.01.10
|-
| Studio/ES/WS/Plugins: 4.0.0.15473 BETA<br>SmartStudio: 4.0.0.15356 BETA<br>Revision F: 02392026a1dc637c7d500a85b2d9eb3e3a83fc2e || 2023.02.10
|-
| Studio/ES/WS/Plugins: 4.0.0.15523 BETA<br>SmartStudio: 4.0.0.15372 BETA <br>Revision G: 08533f6b067b0b8ecc9746f09ed4df12d0b2c26e || 2023.03.03
|-
| Studio/ES/WS/Plugins: 4.0.0.15535 BETA<br>SmartStudio: 4.0.0.15373 BETA <br>Revision H: a0b38df6b075b98e3c6a2bb77d615017b42f2c56 || 2023.03.13
|-
| Studio/ES/WS/Plugins: 4.3.0.15521 <br>SmartStudio: 4.3.0.15521 <br>Revision I: 6a9a707c46af2752a2a2d69094e1b330bc0ed029 || 2023.04.11
|-
| Studio/ES/WS/Plugins/SmartStudio: 4.3.0.15534<br>Revision J: 47eec642dd0f1e5a504a2f5ce45ad92ff6a51d66 || 2023.04.25
|-
|}

{{Hint|UBIK 4.3 was released; the beta phase has ended. <br>SmartStudio will be treated as a release candidate until further notice. }}


{{Hint|[[HowTo:Transfer_Data_from_3.7_to_4.0| How To Upgrade to {{UBIK}} 4.0]]}}

= Kernel =

== Revision History ==

{| class="wikitable" | width = "300"
|-
! Revision !! Release Date !! Comment
|-
| 4.0.0.15042 (Revision A) || 2022.11.17 || Initial Release
|-
| 4.0.0.15076 (Revision B) || 2022.11.23 || Saving performance improvements
|-
| 4.0.0.15218 (Revision C) || 2022.12.14 || Several bug fixes and enhancements
|-
| 4.0.0.15316 (Revision D) || 2023.01.02 || Several improvements
|-
| 4.0.0.15352 (Revision E) || 2023.01.10 || Bug fixes
|-
| 4.0.0.15473/15356-SmartStudio (Revision F) || 2023.02.10 || Bug fixes
|-
| 4.0.0.15523/15372-SmartStudio (Revision G) || 2023.03.03 || Bug fixes
|-
| 4.0.0.15535/15373-SmartStudio (Revision H) || 2023.03.13 || Several bug fixes and enhancements
|-
| 4.3.0.15521/15521-SmartStudio (Revision I) || 2023.04.11 || Several bug fixes and enhancements
|-
| 4.3.0.15534 (Revision J) || 2023.04.25 || No Kernel changes
|-
|}

== Features ==
Revision A:
* Managed System Definitions - No SQL scripts are required to update a database anymore. For installing a new {{UBIK}} Environment, you only need an empty database and {{UBIK}} Studio or SmartStudio.
* [[Dynamic_Live_Mode|Dynamic Live Mode (DLM)]] - All MetaClasses are always in Live Mode now. If you change a MetaClass, {{UBIK}} adapts the database automatically.
* Relational Polymorphism - Override MetaProperty assignments for MetaClasses and MetaProxyProperty assignments for MetaProxies.
Revision D:
* A set of methods for hard-deleting objects from the database is now available in the IDataFactory interface:
<syntaxhighlight lang="csharp">
bool HardDeleteRecords(MetaClass mc, DateTime? markedBefore = null);
bool HardDeleteRecords(MetaClass mc, List<Guid> idsToDelete);
</syntaxhighlight>
E.g.:
<syntaxhighlight lang="csharp">
environment.UBIKDataFactory().HardDeleteRecords(metaclass);
</syntaxhighlight>

== Enhancements ==
Revision B:
* Better saving performance: The saving performance was improved, especially for individual instances via the network.
* Better bulk saving performance: The saving performance was improved, especially for many instances via the network.
Revision C:
* A base implementation for the ISystemDefinitionProvider interface was created, to make system definition version management easier for plugin developers.
* Added default instances for View, Application and Context.
* For system definitions, (read-only and customizable) property values are now accessible.
* The Kernel system definitions version was raised to 4.0.0.2.
Revision D:
* Enhanced system initialization performance for regular startups (without DB upgrade).
* The Kernel system definitions version was raised to 4.0.0.3.
* An internal performance benchmark tool for UBIK database operations was provided.
Revision G:
* Added descriptions for system meta properties.
* Consolidated all NuGet package dependencies in the server solutions.
Revision H:
* GetLinkedObject and SetLinkedObject do not ignore customized property (getter and setter) any more.
* UBIK Enterprise Service provides access to an UBIK Content Controller via it's Web Service interface. This controller can be used to create ubik objects.
Revision I:
* UBIK Kernel and data are able to process double.NaN now.
* Hotspotting provides a new method MergeToRevisionDoc now (analogue to MergeToSourceDoc)
* MRO Task Owner uses a Metareference now. Linked objects are displayed as such - and not only their UID.
* Importing a proxy which refers to itself does not create a 2nd (broken) proxy with the same external primary key. The proxy reference (to itself) is correct now.

== Bug Fixes ==
Revision C:
* An issue where document related system definitions were incomplete was fixed.
* The UIDs and ORDERs for the default languages were corrected, and Portuguese was added as a default language.
Revision D:
* Added default units and unit items to the system definitions.
Revison E:
* Fixed an issue where system selective lists yielded redundant items.
* Fixed an issue where the DeleteConfiguration class broke the customizing build.
* Removed UTS and CTS from custom code comment header for system meta classes.
Revision F:
* Fixed an issue where system objects weren't listed as instances of their meta class.
* Fixed an issue where numeric sequence objects couldn't be saved to the database.
* Added a selective list to the ByteStreamType system MetaProperty.
* Fixed several interfacing and proxy related issues.
Revision G:
* Fixed an issue where modifying an existing meta proxy property without virtual MP IDs resulted in an exception when saving.
* Fixed an issue where the default view VIE_01 was not imported correctly during instance data transfer because it existed already by default.
* Fixed the erroneous import of a custom meta property by SmartStudio because of confusion with a system property.
* Fixed an issue where meta classes with the same name (but different namespace) as an existing class couldn't be imported.
* Fixed an issue where query criteria with "LIKE" operator didn't automatically have a trailing wildcard.
* Fixed an issue where the customizing wasn't applied to some classes .
Revision H:
* Fixed a race condition (multi-threading issue) in the Kernel.
* Fixed an issue where queries didn't yield all results if the criterion value is null.
* Fixed an issue where it wasn't possible to add custom meta properties to a custom MetaClass delivered by default.
Revision I:
* Fixed an issue when importing Comos Data via the file based interface
* File based import of Comos Data takes interface timestamps in account now
* Creation of MRO Objects (with a link property) does not crash UBIK any more.
* The module based Dataabse update dialogue cannot be closed before the target versions are fully configured
* Fixed issues when using components from plugins in Workflows
Revision K:
* Importing of system configured MetaProxies and MetaProxyProperties works now.
* A bug in the calculation of MRO related values during imports is fixed now.

== Known Issues ==
* System meta classes do not have icons and international descriptions at the moment. This does not affect instances or meta classes created by the user.
* The automatic creation of database views for reporting and human readability requires further polishing.

= {{UBIK}} Studio =

== Build History ==

{| class="wikitable" | width = "300"
|-
! Revision !! Release Date !! Comment
|-
| 4.0.0.15042 (Revision A) || 2022.11.17 || Initial Release
|-
| 4.0.0.15076 (Revision B) || 2022.11.23 || Saving performance improvements
|-
| 4.0.0.15218 (Revision C) || 2022.12.14 || Several bug fixes and enhancements
|-
| 4.0.0.15316 (Revision D) || 2023.01.02 || Several improvements
|-
| 4.0.0.15352 (Revision E) || 2023.01.10 || Bug fixes
|-
| 4.0.0.15473 (Revision F) || 2023.02.10 || Bug fixes
|-
| 4.0.0.15523 (Revision G) || 2023.03.03 || Bug fixes
|-
| 4.0.0.15535 (Revision H) || 2023.03.13 || Several bug fixes and enhancements
|-
| 4.3.0.15521 (Revision I) || 2023.04.11 || Several bug fixes and enhancements
|-
| 4.3.0.15534 (Revision J) || 2023.04.25 || No Studio changes
|-
|}

== Download ==
https://release.augmensys.com/download/modules/Studio/

== Features ==
https://install.appcenter.ms/orgs/releaseportal/apps/ubik-studio/distribution_groups/releasecandidate
Revision A:
* {{UBIK}} Server Kernel version 4 compatibility.
* There is no database manager view anymore, because database management happens automatically now. Languages can be maintained using the Bulk Editor for the Language meta class.
* You can now use the Class Details browser or the Relation Editor to override inherited MetaProperties for MetaClasses, and to override inherited MetaProxyProperties for MetaProxies. This way, you can specify a different External Key for a MetaProxyProperty in the context of a specialized MetaProxy, for example.
Revision D:
* The objects in the View Browser now can be sorted in the same way as they are on the client.

== Enhancements ==
Revision C:
* For system definitions, (read-only and customizable) property values are now visible in the Bulk Editor and accessible programmatically.
Revision G:
* See Kernel, and:
* Adapted order ids for bulk editor columns
* Hide MP_IMP_UID etc. columns for meta proxy property
* Hide imp/exp columns for meta proxies

== Bug Fixes ==
Revision C:
* An issue where drag & drop in the relation editor didn't work was fixed.
* Fixed an issue where initial values weren't applied for inherited properties when creating a new instance in the Bulk Editor.
Revision D:
* See Kernel
Revision E:
* See Kernel
Revision F:
* See Kernel
Revision G:
* See Kernel, and:
* Applied several fixes to custom code compilation.
Revision I:
* An issue where the custom code library couldn't be loaded in the code editor before a customizing exists was fixed.

= {{UBIK}} SmartStudio =

== Build History ==

{| class="wikitable" | width = "300"
|-
! Revision !! Release Date !! Comment
|-
| 4.0.0.15042 (Revision A) || 2022.11.17 || Initial Release
|-
| 4.0.0.15076 (Revision B) || 2022.11.23 || Saving performance improvements
|-
| 4.0.0.15218 (Revision C) || 2022.12.14 || Several bug fixes and enhancements
|-
| 4.0.0.15316 (Revision D) || 2023.01.02 || Several improvements
|-
| 4.0.0.15352 (Revision E) || 2023.01.10 || Bug fixes
|-
| 4.0.0.15356 (Revision F) || 2023.02.10 || Bug fixes
|-
| 4.0.0.15372 (Revision G) || 2023.03.03 || Bug fixes
|-
| 4.0.0.15373 (Revision H) || 2023.03.13 || Several bug fixes and enhancements
|-
| 4.3.0.15521 (Revision I) || 2023.04.11 || Several bug fixes and enhancements
|-
| 4.3.0.15534 (Revision J) || 2023.04.25 || Smart Import bugfix
|-
|}

== Download ==
https://release.augmensys.com/download/modules/Studio/

install.appcenter.ms/orgs/releaseportal/apps/ubik-studio/distribution_groups/releasecandidate

== Features ==
Revision A:
* {{UBIK}} Server Kernel version 4 compatibility.
* [[HowTo:Transfer_Data_from_3.7_to_4.0|Data Transfer from 3.7 Environments]]
* You can now use the Inheritance Graph to override inherited MetaProperties for MetaClasses, or the Meta Proxy Graph to override inherited MetaProxyProperties for MetaProxies. This way, you can specify a different External Key for a MetaProxyProperty in the context of a specialized MetaProxy, for example.
Revision G:
* Added multilanguage flag for metaproxyproperty
* Added targetindex member for metaproxyproperty
Revision H:
* See Kernel, and:
* For the Comos meta data import, one can now specify the full name (including namespace) of a UBIK root meta class of a class to be imported, e.g. "System.NAMEDBASECLASS".

== Bug Fixes ==
Revision A:
* Fixed several issues with the loading of meta proxy properties in the Meta Proxy Graph worksheet.
Revision F:
* Fixed an issue where multi-language descriptions weren't applied to MetaProxyProperties when importing from an XML-File.
* Fixed an issue where empty selective lists, units and classes couldn't be imported from an XML-File.
Revision G:
* See Kernel, and:
* Fixed an issue with matching meta classes and meta properties.
* Turning off the change notification poller during instance data transfer to avoid errors.
* Fixed custom code library migration during instance data transfer.
Revision H:
* See Kernel, and:
* A meta proxy property for the ComosUid property is now created automatically when importing meta data from Comos.
Revision J:
* An issue where the SmartImport from Comos led to erroneous results was fixed.

= {{UBIK}} Web Services =

== Build History ==

{| class="wikitable" | width = "300"
|-
! Revision !! Release Date !! Comment
|-
| 4.0.0.15042 (Revision A) || 2022.11.17 || Initial Release
|-
| 4.0.0.15076 (Revision B) || 2022.11.23 || Saving performance improvements
|-
| 4.0.0.15218 (Revision C) || 2022.12.14 || Several bug fixes and enhancements
|-
| 4.0.0.15316 (Revision D) || 2023.01.02 || Several improvements
|-
| 4.0.0.15352 (Revision E) || 2023.01.10 || Bug fixes
|-
| 4.0.0.15473 (Revision F) || 2023.02.10 || Bug fixes
|-
| 4.0.0.15523 (Revision G) || 2023.03.03 || Bug fixes
|-
| 4.0.0.15535 (Revision H) || 2023.03.13 || Several bug fixes and enhancements
|-
| 4.3.0.15521 (Revision I) || 2023.04.11 || Several bug fixes and enhancements
|-
| 4.3.0.15534 (Revision J) || 2023.04.25 || Session management bug fix
|-
|}

== Download ==
https://release.augmensys.com/download/modules/Webservice/

== Features ==
Revision A:
* {{UBIK}} Server Kernel version 4 compatibility.

== Enhancements ==
Revision G:
* Introduced build configuration based config transforms (e.g., transform for Web.Debug.Config) to avoid erroneous release configurations.
Revision I:
* CUI Notification Endpoint uses an UBIK.Enterprise Service to save data in UBIK
* CUI Notification Endpoint provides extended logging mechanism now
* CUI Notification Endpoint provides the possibility to enable / disable logging now

== Bug Fixes ==
Revision G:
* See Kernel, and:
* Adapted push appsettings based on a contemporary project, adding missing configurations.
* Updated Client.config, which had a wrong endpoint specifying a URL instead of "d".
* Updated Service.config.
* Updated Web config base.
* Updated Bindings config base.
* Included createSymbolicLinks.cmd.
Revision J:
* UBIK Session management differs between Windows UWP and Windows Xamarin clients now. The correct UI customizing packages can be provided to the clients now.
Revision K:
* SSO Authentication manages OS Specific information now. This enables the UIcustomizing download to work again.

= {{UBIK}} Enterprise Service =

== Build History ==

{| class="wikitable" | width = "300"
|-
! Revision !! Release Date !! Comment
|-
| 4.0.0.15042 (Revision A) || 2022.11.17 || Initial Release
|-
| 4.0.0.15076 (Revision B) || 2022.11.23 || Saving performance improvements
|-
| 4.0.0.15218 (Revision C) || 2022.12.14 || Several bug fixes and enhancements
|-
| 4.0.0.15316 (Revision D) || 2023.01.02 || Several improvements
|-
| 4.0.0.15352 (Revision E) || 2023.01.10 || Bug fixes
|-
| 4.0.0.15473 (Revision F) || 2023.02.10 || Bug fixes
|-
| 4.0.0.15523 (Revision G) || 2023.03.03 || Bug fixes
|-
| 4.0.0.15535 (Revision H) || 2023.03.13 || Several bug fixes and enhancements
|-
| 4.3.0.15521 (Revision I) || 2023.04.11 || Several bug fixes and enhancements
|-
| 4.3.0.15534 (Revision J) || 2023.04.25 || No ES changes
|-
|}

== Download ==
https://release.augmensys.com/download/modules/Studio/

install.appcenter.ms/orgs/releaseportal/apps/ubik-studio/distribution_groups/releasecandidate

== Features ==
Revision A:
* {{UBIK}} Server Kernel version 4 compatibility.

== Enhancements ==
Revision C:
* Created a base system definition provider class for easier version management for plugin developers. Existing plugins were refactored respectively.

== Bug Fixes ==

<headertabs />

[[Category:Server|Version 4.0 (Server)]]
[[Category:Version 4.0|Version 4.0 (Server)]]
[[Category:Version 4.3|Version 4.3.0 (Server)]]

Getting Started

2023-03-09T10:26:45Z

JKN: /* Built-in Objects */

[[File:IL_Platform_Topology.png|thumb|220px|{{UBIK}} Topological overview]]
==Introduction==
[[File:IL_Platform_Architecture.png|thumb|220px|{{UBIK}} Platform Architecture]]
A complete {{UBIK}} System consists of a few parts that play together but have different purposes. Not every component (or access to it) is needed for each and every scenario and sometimes these components are spread over various servers and devices. The only part that is always necessary and therefore not listed in this table is the {{UBIK}} Database. The following table should provide an overview which part of {{UBIK}} has to be installed and accessible for which use case:

{| class="wikitable sortable"
|-
! Use case/Component !! {{UBIK}} Studio !! {{UBIK}} Web Services !! {{UBIK}} Enterprise Service !! {{UBIK}} Mobile Client
|-
| Data model administration || Yes || No|| No || No
|-
| Manual interfacing to 3rd party systems|| Yes || No || No || No
|-
| Automated interfacing to 3rd party systems || No || No || Yes || No
|-
| Mobile working|| No || Yes || No || Yes
|}

:''See [[HowTo:Set_up_UBIK|Set up {{UBIK}}]] for details on installation issues.''

== First Steps ==
Follow these four steps to create an {{UBIK}} application from scratch:
# [[Getting_Started#Installation|Install and configure]] according components required for the existing use case (see table above)
# [[Entity Data Model|Build up data model]] and publish tables with data
# Configure the [[ACM|Application Context Management]]
# '''Enjoy {{UBIK}}!'''

== Installation ==
=== {{UBIK}} Studio ===
[[File:UI_Studio.png|thumb|220px|{{UBIK}} Studio]]
{{UBIK}} Studio can be installed and used on a local client as well as via a Remote Desktop Connection (RDP). All the structural and content data are stored in the {{UBIK}} database managed by a Microsof SQL server. A Microsoft Internet-Information-Server (IIS) serves as platform to publish this data to the mobile device. A necessary but obvious condition is of course, that all the software packages ({{UBIK}} Studio, Microsoft SQL and IIS) can communicate between each other.

:''See [[HowTo:Install_UBIK_Studio|How to install {{UBIK}} Studio]] for help on installation issues.''
:''See [[UBIK_Studio_Basics#Options|{{UBIK}} Studio Basics]] for further details on configuration.''

=== {{UBIK}} Enterprise Service ===
The {{UBIK}} Enterprise Service is a [http://en.wikipedia.org/wiki/Windows_service Windows service] that is meant to automate {{UBIK}} interface components or interface workflows. It typically runs on a server and is triggered by changes in an arbitrary amount of folders in the file system (like new or modified files).

:''See [[HowTo:Install_UBIK_Enterprise_Service|How to install {{UBIK}} Enterprise Service]] for help on installation issues.''
:''See [[Enterprise_Service|{{UBIK}} Enterprise Service]] for further details about configuration.''

=== {{UBIK}} Web Service ===
The {{UBIK}} web services publish data from the {{UBIK}} database to mobile devices (i.e. mobile phone, tablet etc.).

:''See [[HowTo:Install_UBIK_Web_Service|How to install {{UBIK}} Web Service]] for help on installation issues.''
:''See [[:Category:Web_Service|Web Service]] for further details about configuration.''

=== {{UBIK}} Database (SQL) ===
:''See [[HowTo:Install_UBIK_Database|Set up {{UBIK}} Database]] for help on configuration issues.''

=== {{UBIK}} WinX Client ===
:''See [[HowTo:Install_UBIK_WinX_Client]] for help on installation.''

[[Category:UBIK|Getting Started]]

== Entity Data Model ==
Get to know about the relational model used in {{UBIK}} beginning from a rather figurative and abstract point of view.
:''See: [[Entity Data Model]]''

=== Built-in Objects ===
Based on the {{UBIK}} meta model a set of Metaclasses and Metaproperties have been already implemented in advance. These objects serve as root nodes for more user specific Metaclasses or containers for a range of functionality. New customer specific meta objects are derivatives of those system objects, hence implicitly inherit a set of Metaproperties and features.

The most important system objects are:
* [[:Category:Metaclasses|Metaclasses]]
* [[MetaProperty|MetaProperties]]
* [[:Category:Classifications|Classifications]]
* [[:Category:Workflow|Workflows]]
* [[:Category:Relations|Relations]]
* [[:Category:References|References]]

[[Category:UBIK|Getting Started]]

== Interfacing ==
:''See [[:Category:Interfacing|Interfacing]] for a comprehensive list of interfacing topics.''

=== Interface Manager ===
Used to configure Interface components and Interface Workflows
:''See [[Interface Manager]]''

=== Interface Toolkits ===
:''See [[SAP Interface Toolkit]]''
:''See [[XML Interface Toolkit]]''
:''See [[Interface Tools Library]]''

== Working mobile ==
:''See [[UBIK Client Basics|Client Basics]]''

== Frequently Asked Questions ==
:''See [[:Category:FAQ|FAQ]]''

== Site Map ==
:''See [[SiteMap]]''

[[Category:UBIK|Getting Started]]

Managed App Configuration

2023-01-03T14:22:14Z

JKN:

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

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

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

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

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

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

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

It is currently possible to define 25 {{UBIK}} profiles using this technology.

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

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

Version 4.2 (WinX)

2023-01-03T11:39:27Z

JKN: /* Beta */

== Important Notes ==

{{Attention|This version requires [https://en.wikipedia.org/wiki/Windows_10_version_history#Version_1809_(October_2018_Update) Windows 10 build 17763] or higher}}

= Release Notes =

== Beta ==

=== 4.2.?? on 2023-??-?? ===
* Fixed the wrong Spanish translation of "Children" (child objects).

=== 4.2.13 on 2023-01-03 ===
* Fixed an issue where profile selection wasn't working anymore

=== 4.2.12 on 2022-12-22 ===
* Disabled Undo/Redo in the in-app PDF viewer to avoid accidental lost of signature hotspots.

=== 4.2.10 on 2022-12-22 ===
* Fixed an issue where sequential successors of grouped tasks are not locked/unlocked immediately.

=== 4.2.8 on 2022-12-20 ===
* UBIK now supports a new type of MRO tasks - [[MRO_Objects_(Client)#Grouped_Task|grouped tasks]].

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

== Preview ==

=== 4.2.6 on 2022-11-21 ===
* Fixed Issue that could cause Automatic Logout to happen on resuming to the app even when Automatic Logout was not enabled.

=== 4.2.3 on 2022-11-18 ===
* Added Automatic Logout feature that triggers a logout after a defined period of user inactivity. Including handling app suspension.

== Known issues ==
* During PDF annotating/hotspotting, changes are lost if you leave the page without deselecting the changed annotation/hotspot.
<br/>

= XAML Notes =
<br/>

== XAML changes ==

<headertabs />

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

Version 4.1 (Xamarin)

2022-09-28T15:43:31Z

JKN:

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

= Release Notes =

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

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

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

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

== Release ==

=== 4.1.xx on 2022-09-xx ===
* Fixed an issue where the locked status of a (sequential) task was not updated correctly in the UI

=== 4.1.56 on 2022-09-19 {{key press|Android: Store}} ===
* Android: Fixed an issue where launching ARCore crashed the App.

=== 4.1.55 on 2022-09-09 {{key press|Android: Store}} {{key press|iOS: Store}} ===
* Added a possibility to import local database files in the app settings.
* Android: Fixed an issue where profiles sometimes can not be deployed through AppConfig.

=== 4.1.54 on 2022-09-05 {{key press|Android: Store}} {{key press|iOS: Store}} ===
* Added a navigation action to the ObjectHotSpot template.

=== 4.1.53 on 2022-08-31 {{key press|Android: Store Beta}} {{key press|iOS: Store Beta}} ===
* Fixed an issue where UBIK.Xamarin.Android sometimes gets stuck on second startups.
* Updated ARCore for UBIK.Xamarin.Android.

=== 4.1.52 on 2022-08-30 {{key press|App Center}} ===
* Fixed an issue where MRO objects are sometimes locked even though they should not be.

=== 4.1.51 on 2022-08-30 {{key press|App Center}} ===
* Fixed an issue where objects in filtered lists are not always updated properly.

=== 4.1.50 on 2022-08-22 {{key press|Android: Store}} {{key press|iOS: Store}} ===
* Fixed an issue where the config files for property based content filtering get corrupted when you update the filters.
* Some minor UI updates including icons.
* Fixed an issue where the UI doesn’t update when PropertyViewModel.LinkedLevel becomes available.

== Beta ==

=== 4.1.48 on 2022-08-17 {{key press|Android: Store Beta}} {{key press|iOS: Store Beta}} ===
* Fixed an issue where dynamic selective list items are not always updated when the dependent property values are changed.
* Fixed an issue where the app crashes when browsing properties with extremely long texts. (We now truncate a property's DisplayValue to max. 500 characters. If it's absolutely necessary, you can use DisplayValueUntruncated for the full text. Although please be aware, 900,000 characters seem to be beyond the capability of the Xamarin Forms Label control.)

=== 4.1.47 on 2022-07-20 {{key press|Android: Store Beta}} {{key press|iOS: Store Beta}} ===
* Fixed an issue where the scanner in string editors ignores the try-color-inverted-code setting.

=== 4.1.43 on 2022-07-07 {{key press|Android: Store Beta}} {{key press|iOS: Store Beta}} ===
* (iOS) Fixed an issue where the enabled state in context menu does not update properly.
* Fixed an issue where content lists are not resorted when navigating back.

== Preview ==

=== 4.1.39 on 2022-07-04 {{key press|App Center}} ===
* Fixed an issue where POIs sometimes do not update their UI (e.g. live values) until selected.
* (iOS) Fixed an issue where the menu in the content page is difficult to scroll.

=== 4.1.38 on 2022-07-01 {{key press|App Center}} ===
* Fixed an issue where the app sometimes incorrectly falls back to the default English locale when the device is set to use Chinese.
* Solved a bug which prevented users to see live value details, after leaving and reentering the page.

=== 4.1.37 on 2022-06-30 {{key press|App Center}} ===
* Small UI adjustments to e.g. editors, building level buttons, scan result texts.
* Fixed an issue where content pages flicker randomly (every time the device receives a location update).
* Fixed an issue where username and password are not properly updated when you switch profiles.
* Fixed an issue where it's sometimes difficult to click on map pins (when icons have empty parts or holes).
* Fixed an issue where a map pin is sometimes not scaled up when you show that object on the map.
* Reduced the size of map pins from 64px to 48px.
* Fixed a bug that caused OCR scanning to not work.
* Fixed an issue where the close POI group button does not work in the map page.
* Fixed an issue where outdated results are presented in most scan features such as QR code, RFID, AR marker scanning. It happens after the code related property values of the result objects have changed until a new user session.
* Fixed an issue where the scan result list doesn’t update when a new scan yields no result.
* Fixed an bug that would cause the geo data input to break when selecting and deleting the whole line.
* Solved a bug which prevented users to see live value details, after leaving and reentering the page.
* Added back the Teach-In button to Geo Editing page.
* Fixed an issue where tasks sometimes stop responding after being editing inline (e.g. user toggling the NA button).

=== 4.1.34 on 2022-06-22 {{key press|App Center}} ===
* Some UI updates including button styles, page layouts, etc.
* It's now possible for users to request [[Exclusive_Access_Content_(Client)|exclusive access]] for UBIK content to prevent others from editing it at the same time.
* Custom UBIKContentArea templates can now be chosen automatically based on [[SYSCLS_CHILDAREATEMPLATE|certain properties of the context object]].
* The [[Managed_App_Configuration|managed app configuration]] on Android now supports for rolling out up to 25 {{UBIK}} profiles in an enterprise environment.
* Some properties now need to be authenticated first before editing (Authentication Properties).
* The scroll positions of property lists are now by default also remembered (just like content lists).
* Fixed an issue when scanning QR codes with line breaks on Android/iOS.
* Fixed an issue where file (profiles, XAMLs, etc.) import fails on Android due to the outdated permission handling.
* Fixed an issue where the root list is not updated the first time with an empty database.
* Fixed an issue where the LaunchDocumentByReferenceCommand can potentially crash the client on non existing document files.

=== 4.0.13 on 2022-02-24 {{key press|App Center}} ===
* Xamarin Android now supports [[Managed_App_Configuration|managed app configuration]] for rolling out up to 9 {{UBIK}} profiles in an enterprise environment.
* [[Property_Direct_Edit_(Client)|Property direct editing]]. However, unlike in the [[Version_4.0_(WinX)#4_0|UWP 4.0]] client, direct editing is not fully enabled by default due to the limited size of the device screen.
* Some security related improvements.
** The app now informs the web service to terminate the user session upon logout or app closing.
** The app no longer allows self signed server certificates.
* {{UBIK}} clients are now able to log all webservice communication related activities (in UBIKWebserviceDebug.log) for better trouble shooting. It can also be turned off using the EnableSyncLogging setting in the profiles.
* {{UBIK}} now supports [[Camera Calibration|In-App Camera Calibration]].
* The app's entire login page is now customizable.
** As a result, the old feature which allows customizers to configure the background image of the login page (bg_portrait.png/bg_landscape.png) is removed. Because it only worked for Xamarin.UWP and can now be done with regular XAML customizing.
* The app's default profile is now only generated during app startup when no other profiles are detected.
* Fixed an issue where the Logout button sometimes disappeared.
* Fixed an issue where unnecessary messages are logged. ("Message is null")
* Fixed an issue where the SetPropertyValueCommand always saves changes regardless of the AutoSave parameter value.

== Known issues ==
* Sometimes, objects shift their positions in the lists after being edited. We found out that this is related to the 3rd party list control we use and are considering replacing it. However, this will take some more time in order to make all features we build around the control still function.

= XAML Notes =

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

=== Converters ===
* Under namespace UBIK.CPL.Converters, SelectiveItemToValueConverter is renamed as PropertyValueToSelectiveItemConverter to properly reflect what it does.
* Under namespace UBIK.CPL.Converters, a new "StringToDateTimeTypesConverter" was added. It should be used when binding to a Date/Time Property on a PropertyViewModel.

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

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

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

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

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

=== Any template having ViewModel as the data context ===
See the same named section in [https://wiki.augmensys.com/index.php?title=Version_4.0_(WinX)#4_0 Version 4.0 (WinX) - Xaml Notes]

<headertabs />

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

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

Version 4.1 (Xamarin)

2022-09-12T15:25:17Z

JKN: /* Release */

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

= Release Notes =

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

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

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

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

== Release ==

=== 4.1.xx on 2022-09-xx ===
* Fixed an issue where launching ARCore crashed the App

=== 4.1.55 on 2022-09-09 {{key press|Android: Store}} {{key press|iOS: Store}} ===
* Added a possibility to import local database files in the app settings.
* Android: Fixed an issue where profiles sometimes can not be deployed through AppConfig.

=== 4.1.54 on 2022-09-05 {{key press|Android: Store}} {{key press|iOS: Store}} ===
* Added a navigation action to the ObjectHotSpot template.

=== 4.1.53 on 2022-08-31 {{key press|Android: Store Beta}} {{key press|iOS: Store Beta}} ===
* Fixed an issue where UBIK.Xamarin.Android sometimes gets stuck on second startups.
* Updated ARCore for UBIK.Xamarin.Android.

=== 4.1.52 on 2022-08-30 {{key press|App Center}} ===
* Fixed an issue where MRO objects are sometimes locked even though they should not be.

=== 4.1.51 on 2022-08-30 {{key press|App Center}} ===
* Fixed an issue where objects in filtered lists are not always updated properly.

=== 4.1.50 on 2022-08-22 {{key press|Android: Store}} {{key press|iOS: Store}} ===
* Fixed an issue where the config files for property based content filtering get corrupted when you update the filters.
* Some minor UI updates including icons.
* Fixed an issue where the UI doesn’t update when PropertyViewModel.LinkedLevel becomes available.

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

== Beta ==

=== 4.1.48 on 2022-08-17 {{key press|Android: Store Beta}} {{key press|iOS: Store Beta}} ===
* Fixed an issue where dynamic selective list items are not always updated when the dependent property values are changed.
* Fixed an issue where the app crashes when browsing properties with extremely long texts. (We now truncate a property's DisplayValue to max. 500 characters. If it's absolutely necessary, you can use DisplayValueUntruncated for the full text. Although please be aware, 900,000 characters seem to be beyond the capability of the Xamarin Forms Label control.)

=== 4.1.47 on 2022-07-20 {{key press|Android: Store Beta}} {{key press|iOS: Store Beta}} ===
* Fixed an issue where the scanner in string editors ignores the try-color-inverted-code setting.

=== 4.1.43 on 2022-07-07 {{key press|Android: Store Beta}} {{key press|iOS: Store Beta}} ===
* (iOS) Fixed an issue where the enabled state in context menu does not update properly.
* Fixed an issue where content lists are not resorted when navigating back.

== Preview ==

=== 4.1.39 on 2022-07-04 {{key press|App Center}} ===
* Fixed an issue where POIs sometimes do not update their UI (e.g. live values) until selected.
* (iOS) Fixed an issue where the menu in the content page is difficult to scroll.

=== 4.1.38 on 2022-07-01 {{key press|App Center}} ===
* Fixed an issue where the app sometimes incorrectly falls back to the default English locale when the device is set to use Chinese.
* Solved a bug which prevented users to see live value details, after leaving and reentering the page.

=== 4.1.37 on 2022-06-30 {{key press|App Center}} ===
* Small UI adjustments to e.g. editors, building level buttons, scan result texts.
* Fixed an issue where content pages flicker randomly (every time the device receives a location update).
* Fixed an issue where username and password are not properly updated when you switch profiles.
* Fixed an issue where it's sometimes difficult to click on map pins (when icons have empty parts or holes).
* Fixed an issue where a map pin is sometimes not scaled up when you show that object on the map.
* Reduced the size of map pins from 64px to 48px.
* Fixed a bug that caused OCR scanning to not work.
* Fixed an issue where the close POI group button does not work in the map page.
* Fixed an issue where outdated results are presented in most scan features such as QR code, RFID, AR marker scanning. It happens after the code related property values of the result objects have changed until a new user session.
* Fixed an issue where the scan result list doesn’t update when a new scan yields no result.
* Fixed an bug that would cause the geo data input to break when selecting and deleting the whole line.
* Solved a bug which prevented users to see live value details, after leaving and reentering the page.
* Added back the Teach-In button to Geo Editing page.
* Fixed an issue where tasks sometimes stop responding after being editing inline (e.g. user toggling the NA button).

=== 4.1.34 on 2022-06-22 {{key press|App Center}} ===
* Some UI updates including button styles, page layouts, etc.
* It's now possible for users to request [[Exclusive_Access_Content_(Client)|exclusive access]] for UBIK content to prevent others from editing it at the same time.
* Custom UBIKContentArea templates can now be chosen automatically based on [[SYSCLS_CHILDAREATEMPLATE|certain properties of the context object]].
* The [[Managed_App_Configuration|managed app configuration]] on Android now supports for rolling out up to 25 {{UBIK}} profiles in an enterprise environment.
* Some properties now need to be authenticated first before editing (Authentication Properties).
* The scroll positions of property lists are now by default also remembered (just like content lists).
* Fixed an issue when scanning QR codes with line breaks on Android/iOS.
* Fixed an issue where file (profiles, XAMLs, etc.) import fails on Android due to the outdated permission handling.
* Fixed an issue where the root list is not updated the first time with an empty database.
* Fixed an issue where the LaunchDocumentByReferenceCommand can potentially crash the client on non existing document files.

=== 4.0.13 on 2022-02-24 {{key press|App Center}} ===
* Xamarin Android now supports [[Managed_App_Configuration|managed app configuration]] for rolling out up to 9 {{UBIK}} profiles in an enterprise environment.
* [[Property_Direct_Edit_(Client)|Property direct editing]]. However, unlike in the [[Version_4.0_(WinX)#4_0|UWP 4.0]] client, direct editing is not fully enabled by default due to the limited size of the device screen.
* Some security related improvements.
** The app now informs the web service to terminate the user session upon logout or app closing.
** The app no longer allows self signed server certificates.
* {{UBIK}} clients are now able to log all webservice communication related activities (in UBIKWebserviceDebug.log) for better trouble shooting. It can also be turned off using the EnableSyncLogging setting in the profiles.
* {{UBIK}} now supports [[Camera Calibration|In-App Camera Calibration]].
* The app's entire login page is now customizable.
** As a result, the old feature which allows customizers to configure the background image of the login page (bg_portrait.png/bg_landscape.png) is removed. Because it only worked for Xamarin.UWP and can now be done with regular XAML customizing.
* The app's default profile is now only generated during app startup when no other profiles are detected.
* Fixed an issue where the Logout button sometimes disappeared.
* Fixed an issue where unnecessary messages are logged. ("Message is null")
* Fixed an issue where the SetPropertyValueCommand always saves changes regardless of the AutoSave parameter value.

== Known issues ==
* Sometimes, objects shift their positions in the lists after being edited. We found out that this is related to the 3rd party list control we use and are considering replacing it. However, this will take some more time in order to make all features we build around the control still function.

= XAML Notes =

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

=== Converters ===
* Under namespace UBIK.CPL.Converters, SelectiveItemToValueConverter is renamed as PropertyValueToSelectiveItemConverter to properly reflect what it does.
* Under namespace UBIK.CPL.Converters, a new "StringToDateTimeTypesConverter" was added. It should be used when binding to a Date/Time Property on a PropertyViewModel.

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

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

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

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

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

=== Any template having ViewModel as the data context ===
See the same named section in [https://wiki.augmensys.com/index.php?title=Version_4.0_(WinX)#4_0 Version 4.0 (WinX) - Xaml Notes]

<headertabs />

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

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

File:Augmensys xing.png

2022-08-10T10:06:41Z

JKN: JKN uploaded a new version of File:Augmensys xing.png

File:Augmensys xing.png

2022-08-10T10:05:20Z

JKN: JKN uploaded a new version of File:Augmensys xing.png

File:UI IconClient.PNG

2022-08-10T10:03:01Z

JKN: JKN uploaded a new version of File:UI IconClient.PNG

File:UI IconStudio.png

2022-08-10T10:01:35Z

JKN: JKN uploaded a new version of File:UI IconStudio.png

List of Versions

2022-08-10T09:39:09Z

JKN:

[[File:IC_MainPage-20.png]] '''Future versions'''
<hr/>
<div class="table" style="width:100%;">
{{Item/Version|2022-??-??| {{Version/Server|4.0}}}}
{{Item/Version|2022-07-??| [[Version_4.1_Xamarin]]}}
</div>
{{Check mark}} '''Released versions'''
<hr/>
<div class="table" style="width:100%;">
{{Item/Version|2022-08-09| [[Version_3.7.0_Server]]}}
{{Item/Version|2022-07-22| {{Version/WinX|4.1}}}}
{{Item/Version|2022-05-31| [[Version_3.6.2_Server]]}}
{{Item/Version|2022-04-26| {{Version/WinX|4.0}}}}
{{Item/Version|2022-03-23| [[Version_3.6.1_Server]]}}
{{Item/Version|2022-01-19| {{Version/Server|3.6}}}}
{{Item/Version|2021-12-22| [[Version_1.3_Xamarin]]}}
{{Item/Version|2021-05-31| [[Version_1.2_Xamarin]]}}
{{Item/Version|2021-04-23| {{Version/WinX|3.8}}}}
{{Item/Version|2020-11-12| [[Version_1.1_Xamarin]]}}
{{Item/Version|2020-04-09| {{Version/Server|3.5.0}}}}
{{Item/Version|2020-03-27| {{Version/WinX|3.7}}}}
{{Item/Version|2020-02-13| {{Version/WinX|3.6}}}}
{{Item/Version|2019-11-04| [[Version_1.0_(Xamarin.iOS)]]}}
{{Item/Version|2019-10-21| [[Version_1.0_(Xamarin.Android)]]}}
{{Item/Version|2019-04-30| {{Version/WinX|3.5}}}}
{{Item/Version|2018-12-10| {{Version/Server|2.6.3}}}}
{{Item/Version|2018-12-10| {{Version/WinX|3.4}}}}
{{Item/Version|2018-10-24| {{Version/WinX|3.3}}}}
{{Item/Version|2018-07-06| {{Version/WinX|3.2.0}}}}
{{Item/Version|2018-04-19| {{Version/Android|3.0.0}}}}
{{Item/Version|2018-04-04| {{Version/Server|2.6.2}}}}
{{Item/Version|2018-03-08| {{Version/Android|2.6.0}}}}
{{Item/Version|2018-01-23| {{Version/WinX|3.1.0}}}}
{{Item/Version|2017-10-13| {{Version/WinX|3.0.0}}}}
{{Item/Version|2017-06-14| {{Version/Server|2.6.0}}}}
{{Item/Version|2017-02-13| {{Version/WinX|2.6.0}}}}
{{Item/Version|2016-07-21| {{Version/Android|2.5.5}}}}
{{Item/Version|2016-07-21| {{Version/Android|2.5.4}}}}
{{Item/Version|2016-04-01| {{Version/Android|2.5.3}}}}
{{Item/Version|2016-05-13| {{Version/WinX|2.5.2}}}}
{{Item/Version|2016-01-27| {{Version/Android|2.5.2}}}}
{{Item/Version|2015-11-25| {{Version/Web|2.5.0}}}}
{{Item/Version|2015-11-20| {{Version/Android|2.5.1}}}}
{{Item/Version|2015-11-17| {{Version/Android|2.5.0}}}}
{{Item/Version|2015-10-15| {{Version/Server|2.5.0}}}}

</div>
[[File:IC_MainPage-20.png]] '''Available Release Candidates'''
<hr/>
<div class="table" style="width:100%;">
{{Item/Version|2020-01-01| {{Version/Android|3.1.0}}}}
</div>
<hr/>
[[File:IC_MainPage-21.png]] '''[[:Category:Release notes|Previous versions]]'''

Version 4.1 (WinX)

2022-07-28T13:19:33Z

JKN:

== Important Notes ==

{{Attention|This version requires [https://en.wikipedia.org/wiki/Windows_10_version_history#Version_1809_(October_2018_Update) Windows 10 build 17763] or higher}}

= Release Notes =

== Release ==

=== 4.1.xx on 2022-07-xx ===
* Fixed an issue where HotSpots could only be created on documents that already had HotSpots before

=== 4.1.79 on 2022-07-27 {{key press|AppCenter}} ===
* Fixed an issue where dynamic selective list items are not always updated when the dependent property values are changed.

=== 4.1.78 on 2022-07-22 {{key press|Store}} ===
* Fixed an issue where the stroke width of pdf ink annotations was not in sync with the slider.

== Preview ==

=== 4.1.75 on 2022-06-24 {{key press|DevOps}} ===
* Fixed an issue where content pages flicker randomly (every time the device receives a location update).
* Fixed an issue where outdated results are presented in most scan features such as QR code, RFID, AR marker scanning. It happens after the code related property values of the result objects have changed until a new user session.
* Add a new DependencyProperty for disabling the context menu on annotations.
* Fixed wrong coordinates when hotspots are placed on existing annotations.
* Allow placing of Hotspots on existing hotspots.
* Added a new command for deleting the selected annotation.

=== 4.1.50 on 2022-06-08 {{key press|DevOps}} ===
* Fixed an issue where annotations/hotspots are not updated on content changes until a page refresh.
* Fixed an issue where resetting a signature property value might incorrectly mark it as changed (when using different types of clients).
* Fixed an issue where the legacy/obsolete portion of the ContentViewModel.SetPropertyValueCommand bypasses the property authentication.
* Fixed an issue where the edit session of a hotspot property doesn’t end when a link property is placed as the hotspot.
* Fixed an issue where the root list is not updated the first time with an empty database.

=== 4.1.43 on 2022-05-31 {{key press|AppCenter}} ===
* All AR pages are now fully customizable (including the camera view, map view, etc.).
* It's now possible for users to request [[Exclusive_Access_Content_(Client)|exclusive access]] for UBIK content to prevent others from editing it at the same time.
* The PdfViewer now uses a CommandBar that enables automatic items overflow on smaller screens.
* The PdfViewer now has a text search feature.
* Some properties now need to be authenticated first before editing ([[UBIK_WinX_Client_Basics#Authentication_Properties|Authentication Properties]]).
* The app now determines the default tab to select based on different data configurations and scenarios.
* Custom UBIKContentArea templates can now be chosen automatically based on [[SYSCLS_CONTENTAREATEMPLATE|certain properties of the context object]].
* The general locking status of an MRO task owner or work package is now inherited by all its MRO child objects. This applies to all types of locking, e.g. exclusive access, user rights, etc.

== Known issues ==
* During PDF annotating/hotspotting, changes are lost if you leave the page without deselecting the changed annotation/hotspot.
<br/>

= XAML Notes =
<br/>

== XAML changes ==
* The following templates need to be re-customized using the new default ones:
** UBIKPOIArea
** UBIKMapArea
** UBIKScanArea
** UBIKContentArea (due to significant changes to the Document section)

* UBIKChildArea now supports customizable sub-tabs for child list filter presets.

<headertabs />

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

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

Version 4.1 (WinX)

2022-07-12T09:19:35Z

JKN:

== Important Notes ==

{{Attention|This version requires [https://en.wikipedia.org/wiki/Windows_10_version_history#Version_1809_(October_2018_Update) Windows 10 build 17763] or higher}}

= Release Notes =

== Release ==

== Beta ==

== Preview ==

=== 4.1.xx on 2022-07-xx {{key press|DevOps}} ===
* Fixed an issue where the stroke width of pdf ink annotations was not in sync with the slider

=== 4.1.75 on 2022-06-24 {{key press|DevOps}} ===
* Fixed an issue where content pages flicker randomly (every time the device receives a location update).
* Fixed an issue where outdated results are presented in most scan features such as QR code, RFID, AR marker scanning. It happens after the code related property values of the result objects have changed until a new user session.
* Add a new DependencyProperty for disabling the context menu on annotations.
* Fixed wrong coordinates when hotspots are placed on existing annotations.
* Allow placing of Hotspots on existing hotspots.
* Added a new command for deleting the selected annotation.

=== 4.1.50 on 2022-06-08 {{key press|DevOps}} ===
* Fixed an issue where annotations/hotspots are not updated on content changes until a page refresh.
* Fixed an issue where resetting a signature property value might incorrectly mark it as changed (when using different types of clients).
* Fixed an issue where the legacy/obsolete portion of the ContentViewModel.SetPropertyValueCommand bypasses the property authentication.
* Fixed an issue where the edit session of a hotspot property doesn’t end when a link property is placed as the hotspot.
* Fixed an issue where the root list is not updated the first time with an empty database.

=== 4.1.43 on 2022-05-31 {{key press|AppCenter}} ===
* All AR pages are now fully customizable (including the camera view, map view, etc.).
* It's now possible for users to request [[Exclusive_Access_Content_(Client)|exclusive access]] for UBIK content to prevent others from editing it at the same time.
* The PdfViewer now uses a CommandBar that enables automatic items overflow on smaller screens.
* The PdfViewer now has a text search feature.
* Some properties now need to be authenticated first before editing ([[UBIK_WinX_Client_Basics#Authentication_Properties|Authentication Properties]]).
* The app now determines the default tab to select based on different data configurations and scenarios.
* Custom UBIKContentArea templates can now be chosen automatically based on [[SYSCLS_CONTENTAREATEMPLATE|certain properties of the context object]].
* The general locking status of an MRO task owner or work package is now inherited by all its MRO child objects. This applies to all types of locking, e.g. exclusive access, user rights, etc.

== Known issues ==
* During PDF annotating/hotspotting, changes are lost if you leave the page without deselecting the changed annotation/hotspot.
<br/>

= XAML Notes =
<br/>

== XAML changes ==
* The following templates need to be re-customized using the new default ones:
** UBIKPOIArea
** UBIKMapArea
** UBIKScanArea
** UBIKContentArea (due to significant changes to the Document section)

* UBIKChildArea now supports customizable sub-tabs for child list filter presets.

<headertabs />

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

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

Deep Linking

2022-06-14T13:01:28Z

JKN: /* URI Scheme */

{{UBIK}} clients support mobile deep linking through URI schemes and parameters.

== Security ==
To avoid bypassing the {{UBIK}} security mechanisms with deep links, it is not possible to pass any kind of user credentials or other authentication factors through these links. Instead, a profile has to be specified by name.
* If there was already a successful authentication against this profile on the mobile device and the credentials were stored, the deep linking will happen without authentication
* If there are no stored credentials for that profile, the deep link will always end up at the Authentication screen and only after successful authentication, the deep link will be executed

== URI Scheme ==
{{UBIK}} clients register themselves with the scheme <code>com.augmensys.ubik://</code> at the OS.

== Supported Actions ==

=== Navigate to a specific object {{key press|UWP}} ===
Navigation to a {{UBIK}} object is triggered by the deep link <code>NAVIGATE</code>, and supports the following parameters:

{| class="wikitable" | width = "100%"
|-
! Parameter!! Purpose
|-
| <code>profile</code>|| The name of the {{UBIK}} profile
|-
| <code>uid</code>|| The Guid of the object to navigate to
|-|-
|}

'''Example:''' <code>com.augmensys.ubik://NAVIGATE/?profile=New.Demo_V3&uid=c6d1e599-c665-408f-b4f9-bf6e64428610</code>

Deep Linking

2022-06-14T07:34:26Z

JKN: Created page with "{{UBIK}} clients support mobile deep linking through URI schemes and parameters. == Security == To avoid bypassing the {{UBIK}} security mechanisms with deep links, it is not..."

{{UBIK}} clients support mobile deep linking through URI schemes and parameters.

== Security ==
To avoid bypassing the {{UBIK}} security mechanisms with deep links, it is not possible to pass any kind of user credentials or other authentication factors through these links. Instead, a profile has to be specified by name.
* If there was already a successful authentication against this profile on the mobile device and the credentials were stored, the deep linking will happen without authentication
* If there are no stored credentials for that profile, the deep link will always end up at the Authentication screen and only after successful authentication, the deep link will be executed

== URI Scheme ==
{{UBIK}} clients register themselves with the scheme <code>com.augmnesys.ubik://</code> at the OS.

== Supported Actions ==

=== Navigate to a specific object {{key press|UWP}} ===
Navigation to a {{UBIK}} object is triggered by the deep link <code>NAVIGATE</code>, and supports the following parameters:

{| class="wikitable" | width = "100%"
|-
! Parameter!! Purpose
|-
| <code>profile</code>|| The name of the {{UBIK}} profile
|-
| <code>uid</code>|| The Guid of the object to navigate to
|-|-
|}

'''Example:''' <code>com.augmensys.ubik://NAVIGATE/?profile=New.Demo_V3&uid=c6d1e599-c665-408f-b4f9-bf6e64428610</code>

Client Feature Table

2022-06-14T07:12:46Z

JKN: /* Overview */

The following tables provide an overview about the {{UBIK}} client features and their availability on the various platforms/clients.
* If there are further introductions on a feature, you can find the links in the "Feature" column and/or on the bullet points in the platform columns;
{| class="wikitable" style="text-align: center; width: 30%; float:right; margin-left: auto; margin-right: 0px"
|+ Table Legend
|-
! Symbol !! Meaning
|-
| [[Image:IC_Bullet_Full.png|12px|link=]] || Supported and it's a link
|-
| [[Image:IC_Bullet_Full.png|8px|link=]] || Supported
|-
| [[Image:IC_Bullet_HalfFull.png|12px|link=]] || Partially supported and it's a link
|-
| [[Image:IC_Bullet_HalfFull.png|8px|link=]] || Partially supported
|-
| - || Not supported
|-
|}

<br/>

==Overview==
{| class="wikitable" style="text-align: center; width: 100%"
|-
! style="width:28%" | Feature
!! style="width:7%" | UWP/<br/>WinX
!! style="width:7%" | Xamarin
!! style="width:7%" | Web
!! style="width:7%" | Android<br/>(Obsolete)
!! style="width:44%" | Comment
|-
| Content Browser
|| [[Image:IC_Bullet_Full.png|12px|link=UBIK_WinX_Client_Basics#Content_Browser]]
|| [[Image:IC_Bullet_Full.png|8px|link=]]
|| [[Image:IC_Bullet_Full.png|8px|link=]]
|| [[Image:IC_Bullet_Full.png|12px|link=UBIK_Client_Basics#Content_Browser]]
|| Browse data and documents
|-
| UI Customizing
|| [[Image:IC_Bullet_Full.png|12px|link=XAML]]
|| [[Image:IC_Bullet_Full.png|12px|link=Xamarin_XAML]]
|| -
|| [[Image:IC_Bullet_HalfFull.png|12px|link=UI_Configuration]]
|| Customize UI using config files (e.g. XAML)
|-
| [[Developer_Mode]]
|| [[Image:IC_Bullet_Full.png|8px|link=]]
|| -
|| -
|| -
|| Utility to support UI customizing tasks
|-
| [[Deploy_UI_Customizings_(Client)|Server Side UI Distribution]]
|| [[Image:IC_Bullet_Full.png|12px|link=XAML]]
|| [[Image:IC_Bullet_Full.png|12px|link=Xamarin_XAML]]
|| -
|| -
|| Automatically distributes UI customizings to clients
|-
| [[MRO_Objects_(Client)|MRO]]
|| [[Image:IC_Bullet_Full.png|8px|link=]]
|| [[Image:IC_Bullet_Full.png|8px|link=]]
|| [[Image:IC_Bullet_Full.png|8px|link=]]
|| [[Image:IC_Bullet_Full.png|8px|link=]]
|| Tasks and work packages with progress calculation
|-
| Map View
|| [[Image:IC_Bullet_Full.png|12px|link=Map_View]]
|| [[Image:IC_Bullet_Full.png|12px|link=Map_View_(Xamarin)]]
|| -
|| [[Image:IC_Bullet_Full.png|12px|link=Map_View]]
|| View objects on a map
|-
| POI View
|| [[Image:IC_Bullet_Full.png|12px|link=POI_View]]
|| [[Image:IC_Bullet_Full.png|12px|link=POI_View_(Xamarin)]]
|| -
|| [[Image:IC_Bullet_Full.png|12px|link=POI_View]]
|| View objects in augmented reality
|-
| [[Navigation_via_Augmented_Reality|AR Navigation]]
|| [[Image:IC_Bullet_Full.png|8px|link=]]
|| [[Image:IC_Bullet_Full.png|8px|link=]]
|| -
|| [[Image:IC_Bullet_Full.png|8px|link=]]
|| Navigate to objects in augmented reality
|-
| [[AR-Marker]]
|| [[Image:IC_Bullet_Full.png|8px|link=]]
|| [[Image:IC_Bullet_Full.png|8px|link=]]
|| -
|| [[Image:IC_Bullet_Full.png|8px|link=]]
|| Aruco markers for POI display, object search, etc.
|-
| [[Optical_code|Optical Code Scanning]]
|| [[Image:IC_Bullet_Full.png|8px|link=]]
|| [[Image:IC_Bullet_Full.png|8px|link=]]
|| -
|| [[Image:IC_Bullet_Full.png|8px|link=]]
|| QR-Codes, Barcodes, ID-Markers
|-
| [[Location_Manager|Positioning]]
|| [[Image:IC_Bullet_Full.png|8px|link=]]
|| [[Image:IC_Bullet_Full.png|8px|link=]]
|| -
|| [[Image:IC_Bullet_Full.png|8px|link=]]
|| Positioning systems with pose fusion
|-
| [[Settings|Settings/Profiles/Presets]]
|| [[Image:IC_Bullet_Full.png|12px|link=UBIK_WinX_Client_Basics#Profiles]]
|| [[Image:IC_Bullet_Full.png|8px|link=]]
|| [[Image:IC_Bullet_HalfFull.png|8px|link=]]
|| [[Image:IC_Bullet_Full.png|12px|link=Preset]]
|| Settings and transferable files for settings
|-
| Server Side Profile Distribution
|| -
|| [[Image:IC_Bullet_HalfFull.png|12px|link=Managed_App_Configuration]]
|| -
|| [[Image:IC_Bullet_Full.png|12px|link=UBIK_Preset_Service]]
|| Distributes profiles to clients. Xamarin.Android only.
|-
| Remote Support
|| [[Image:IC_Bullet_Full.png|8px|link=]]
|| -
|| -
|| [[Image:IC_Bullet_Full.png|12px|link=UBIK_Client_Basics#Navigation_Drawer]]
|| Video and audio calls
|-
| Free Text Search
|| [[Image:IC_Bullet_Full.png|12px|link=Mobile_Free_Text_Search_(UBIK_WinX)]]
|| [[Image:IC_Bullet_Full.png|8px|link=]]
|| [[Image:IC_Bullet_Full.png|8px|link=]]
|| [[Image:IC_Bullet_Full.png|12px|link=Mobile_Free_Text_Search]]
|| Find objects by free text searches
|-
| [[Deep Linking|Deep Linking]]
|| [[Image:IC_Bullet_Full.png|8px|link=]]
|| [[Image:IC_Bullet_Full.png|8px|link=]]
|| -
|| [[Image:IC_Bullet_Full.png|8px|link=]]
|| Open/steer App through URI schemes
|-
|}

[[Category:Client|Client Feature Table]]

==Content Browser==

=== General ===

{| class="wikitable" style="text-align: center; width: 100%"
|-
! style="width:28%" | Feature
!! style="width:7%" | UWP/<br/>WinX
!! style="width:7%" | Xamarin
!! style="width:7%" | Web
!! style="width:7%" | Android<br/>(Obsolete)
!! style="width:44%" | Comment
|-
| Online Queries
|| [[Image:IC_Bullet_Full.png|8px|link=]]
|| [[Image:IC_Bullet_Full.png|8px|link=]]
|| [[Image:IC_Bullet_Full.png|8px|link=]]
|| [[Image:IC_Bullet_Full.png|12px|link=Query_Objects_(UBIK_Android)]]
||
|-
| Offline Queries
|| [[Image:IC_Bullet_Full.png|12px|link=Offline_Query_(UBIK_WinX)]]
|| [[Image:IC_Bullet_Full.png|8px|link=]]
|| [[Image:IC_Bullet_Full.png|8px|link=]]
|| -
||
|-
| [[Data_Replication_(UBIK_Client)|Local Data Replication]]
|| [[Image:IC Bullet Full.png|8px|link=]]
|| [[Image:IC_Bullet_HalfFull.png|8px|link=]]
|| [[Image:IC_Bullet_HalfFull.png|8px|link=]]
|| -
|| Copy / Paste and data template based replication
|-
| Dynamic Content Tabs
|| [[Image:IC_Bullet_Full.png|8px|link=]]
|| -
|| -
|| [[Image:IC_Bullet_Full.png|12px|link=UBIK_Client_Basics#Dynamic_Content_Tabs]]
|| Determines tabs based on the content
|-
| Context Aware Action Menu
|| [[Image:IC_Bullet_Full.png|8px|link=]]
|| [[Image:IC_Bullet_Full.png|8px|link=]]
|| [[Image:IC_Bullet_Full.png|8px|link=]]
|| [[Image:IC_Bullet_Full.png|8px|link=]]
||
|-
| Content Creation
|| [[Image:IC_Bullet_Full.png|8px|link=]]
|| [[Image:IC_Bullet_Full.png|8px|link=]]
|| [[Image:IC_Bullet_Full.png|8px|link=]]
|| [[Image:IC_Bullet_Full.png|8px|link=]]
||
|-
| Document Creation
|| [[Image:IC_Bullet_Full.png|8px|link=]]
|| [[Image:IC_Bullet_Full.png|8px|link=]]
|| [[Image:IC_Bullet_HalfFull.png|8px|link=]]
|| [[Image:IC_Bullet_HalfFull.png|8px|link=]]
|| Attach files or capture media
|-
| Content Deletion
|| [[Image:IC_Bullet_Full.png|8px|link=]]
|| [[Image:IC_Bullet_Full.png|8px|link=]]
|| [[Image:IC_Bullet_Full.png|8px|link=]]
|| [[Image:IC_Bullet_Full.png|8px|link=]]
||
|-
| Safety Instructions
|| -
|| -
|| -
|| [[Image:IC_Bullet_Full.png|8px|link=]]
||
|-
| [[User_Rights]]
|| [[Image:IC_Bullet_Full.png|8px|link=]]
|| [[Image:IC_Bullet_Full.png|8px|link=]]
|| [[Image:IC_Bullet_Full.png|8px|link=]]
|| [[Image:IC_Bullet_Full.png|8px|link=]]
|| Restricts which objects can be seen and/or edit per user
|-
| [[Property_Based_Content_Filters]]
|| [[Image:IC_Bullet_Full.png|8px|link=]]
|| [[Image:IC_Bullet_Full.png|8px|link=]]
|| -
|| -
|| Custom UI based filtering and sorting
|-
|}

=== Objects ===

{| class="wikitable" style="text-align: center; width: 100%"
|-
! style="width:28%" | Feature
!! style="width:7%" | UWP/<br/>WinX
!! style="width:7%" | Xamarin
!! style="width:7%" | Web
!! style="width:7%" | Android<br/>(Obsolete)
!! style="width:44%" | Comment
|-
| Icons
|| [[Image:IC_Bullet_Full.png|8px|link=]]
|| [[Image:IC_Bullet_Full.png|8px|link=]]
|| [[Image:IC_Bullet_Full.png|8px|link=]]
|| [[Image:IC_Bullet_Full.png|8px|link=]]
|| Icons from [[MetaClass]]
|-
| [[SYSCLS_SORTEDITEM|Grouping and Sorting]]
|| [[Image:IC_Bullet_Full.png|8px|link=]]
|| [[Image:IC_Bullet_Full.png|8px|link=]]
|| [[Image:IC_Bullet_Full.png|8px|link=]]
|| [[Image:IC_Bullet_Full.png|8px|link=]]
||
|-
| Direct MRO Task Editing
|| [[Image:IC_Bullet_Full.png|12px|link=Property_Direct_Edit_(Client)]]
|| [[Image:IC_Bullet_Full.png|12px|link=Property_Direct_Edit_(Client)]]
|| [[Image:IC_Bullet_Full.png|8px|link=]]
|| [[Image:IC_Bullet_HalfFull.png|12px|link=Task_Objects_(UBIK_Android)]]
|| Interact with MRO tasks without editors
|-
| [[SYSCLS_MEASUREMENTTASK|Measurement Task]]
|| [[Image:IC_Bullet_Full.png|8px|link=]]
|| [[Image:IC_Bullet_Full.png|8px|link=]]
|| [[Image:IC_Bullet_Full.png|8px|link=]]
|| [[Image:IC_Bullet_Full.png|8px|link=]]
|| MRO tasks with double value type and current/previous values
|-
| [[SYSCLS_VALUEREPORTING|Value Reporting Task]]
|| [[Image:IC_Bullet_Full.png|8px|link=]]
|| [[Image:IC_Bullet_Full.png|8px|link=]]
|| [[Image:IC_Bullet_Full.png|8px|link=]]
|| -
|| Measurement tasks with predefined value ranges
|-
| [[MRO_Objects_(Client)#Sequential_Task|Sequential Task]]
|| [[Image:IC_Bullet_Full.png|8px|link=]]
|| [[Image:IC_Bullet_Full.png|8px|link=]]
||?
|| -
|| Tasks that have predefined predecessors and/or successors
|-
| [[SYSCLS_STATUSCOLOR|Status Color]]
|| [[Image:IC_Bullet_Full.png|8px|link=]]
|| [[Image:IC_Bullet_Full.png|8px|link=]]
|| [[Image:IC_Bullet_Full.png|8px|link=]]
|| [[Image:IC_Bullet_Full.png|8px|link=]]
||
|-
| Distance Display & Sorting
|| [[Image:IC_Bullet_Full.png|8px|link=]]
|| [[Image:IC_Bullet_Full.png|8px|link=]]
|| -
|| [[Image:IC_Bullet_Full.png|8px|link=]]
||
|-
| [[Exclusive_Access_Content_(Client)|Exclusive Access Content]]
|| [[Image:IC_Bullet_Full.png|8px|link=]]
|| [[Image:IC_Bullet_Full.png|8px|link=]]
|| -
|| -
|| Check out / Release content for exclusive access
|-
| [[SYSCLS UNLOCK BY SCAN|Unlock by Scan]]
|| [[Image:IC_Bullet_Full.png|8px|link=]]
|| [[Image:IC_Bullet_Full.png|8px|link=]]
|| -
|| [[Image:IC_Bullet_Full.png|8px|link=]]
|| Objects get unlocked for a short period of time after scanned
|-
| [[SYSCLS_OBJECT_WITH_ICON|Object with Custom Icon]]
|| [[Image:IC_Bullet_Full.png|8px|link=]]
|| [[Image:IC_Bullet_Full.png|8px|link=]]
|| -
|| -
|| Icons from [[ContentClass]]
|-
| [[MRO_Objects_(Client)#MRO_objects_with_project_information_.28WinX_only.29|MRO Objects with Project Info]]
|| [[Image:IC_Bullet_Full.png|8px|link=]]
|| -
|| -
|| -
|| Gantt chart like display
|-
|}

=== Properties ===

{| class="wikitable" style="text-align: center; width: 100%"
|-
! style="width:28%" | Feature
!! style="width:7%" | UWP/<br/>WinX
!! style="width:7%" | Xamarin
!! style="width:7%" | Web
!! style="width:7%" | Android<br/>(Obsolete)
!! style="width:44%" | Comment
|-
| Property Priority
|| [[Image:IC Bullet Full.png|8px|link=]]
|| [[Image:IC Bullet Full.png|8px|link=]]
|| -
|| [[Image:IC Bullet Full.png|8px|link=]]
|| Determines the sorting of properties and affect the [[Property_Wizard_(Client)|wizard creation]]
|-
| Invisible/System Properties
|| [[Image:IC Bullet Full.png|8px|link=]]
|| [[Image:IC Bullet Full.png|8px|link=]]
|| [[Image:IC Bullet Full.png|8px|link=]]
|| [[Image:IC Bullet Full.png|8px|link=]]
|| Hide properties that aren't meant for users
|-
| Sorting
|| [[Image:IC Bullet Full.png|8px|link=]]
|| [[Image:IC Bullet Full.png|8px|link=]]
|| -
|| [[Image:IC Bullet Full.png|8px|link=]]
||
|-
| Editing
|| [[Image:IC Bullet Full.png|8px|link=]]
|| [[Image:IC Bullet Full.png|8px|link=]]
|| [[Image:IC Bullet Full.png|8px|link=]]
|| [[Image:IC Bullet Full.png|8px|link=]]
||
|-
| [[Property_Direct_Edit_(Client)|Direct Editing]]
|| [[Image:IC Bullet Full.png|8px|link=]]
|| [[Image:IC Bullet Full.png|8px|link=]]
|| [[Image:IC_Bullet_Full.png|8px|link=]]
|| -
|| Inline editing instead of editors/dialogs
|-
| [[MetaProperty#Default_value|Default and Initial Values]]
|| [[Image:IC Bullet Full.png|8px|link=]]
|| [[Image:IC Bullet Full.png|8px|link=]]
|| [[Image:IC Bullet Full.png|8px|link=]]
|| [[Image:IC Bullet Full.png|8px|link=]]
||
|-
| Value Records / Change Log
|| [[Image:IC Bullet Full.png|12px|link=UBIK_WinX_Client_Basics#Properties_with_value_records]]
|| [[Image:IC Bullet Full.png|8px|link=]]
|| -
|| [[Image:IC Bullet Full.png|8px|link=]]
|| Logging the timestamps and users of property values changes.
|-
| Value Validity Border
|| -
|| -
|| -
|| [[Image:IC Bullet Full.png|8px|link=]]
|| A value interval with warning and error boundaries.
|-
| Teach-in
|| [[Image:IC Bullet Full.png|8px|link=]]
|| [[Image:IC Bullet Full.png|8px|link=]]
|| -
|| [[Image:IC Bullet Full.png|12px|link=UBIK_Client_Basics#Teach-in_Actions]]
|| Scan to input property values
|-
| [[Live_Values]]
|| [[Image:IC Bullet Full.png|8px|link=]]
|| [[Image:IC Bullet Full.png|8px|link=]]
||
|| [[Image:IC Bullet Full.png|8px|link=]]
||
|-
| [[SYSCLS_VALUE_SERIES|Value Series]]
|| [[Image:IC Bullet Full.png|8px|link=]]
|| -
|| -
|| -
|| Chart data and display
|-
| Signature
|| [[Image:IC_Bullet_Full.png|8px|link=]]
|| [[Image:IC_Bullet_HalfFull.png|8px|link=]]
|| -
|| -
|| Digital hand written signatures. Xamarin.iOS not yet available
|-
| [[User_Rights]] on Properties
|| [[Image:IC Bullet Full.png|8px|link=]]
|| [[Image:IC Bullet Full.png|8px|link=]]
|| [[Image:IC Bullet Full.png|8px|link=]]
|| -
|| Restricts which properties can be seen and/or edit per user
|-
| [[UBIK_WinX_Client_Basics#Authentication_Properties|Property Authentication]]
|| [[Image:IC Bullet Full.png|8px|link=]]
|| [[Image:IC Bullet Full.png|8px|link=]]
|| -
|| -
|| Properties that are locked until authenticated
|-
|}

=== Documents ===

{| class="wikitable" style="text-align: center; width: 100%"
|-
! style="width:28%" | Feature
!! style="width:7%" | UWP/<br/>WinX
!! style="width:7%" | Xamarin
!! style="width:7%" | Web
!! style="width:7%" | Android<br/>(Obsolete)
!! style="width:44%" | Comment
|-
| [[SYSCLS_THUMBNAILEDFILE|Thumbnails]]
|| [[Image:IC_Bullet_Full.png|8px|link=]]
|| [[Image:IC_Bullet_Full.png|8px|link=]]
|| [[Image:IC_Bullet_Full.png|8px|link=]]
|| [[Image:IC_Bullet_Full.png|8px|link=]]
||
|-
| [[SYSCLS_URLDOCUMENT|Link/URL Documents]]
|| [[Image:IC_Bullet_Full.png|8px|link=]]
|| [[Image:IC_Bullet_Full.png|8px|link=]]
||?
|| [[Image:IC_Bullet_Full.png|8px|link=]]
||
|-
| [[SYSCLS_FILEDOCUMENT|Local Documents]]
|| [[Image:IC_Bullet_Full.png|8px|link=]]
|| [[Image:IC_Bullet_Full.png|8px|link=]]
|| [[Image:IC_Bullet_Full.png|8px|link=]]
|| [[Image:IC_Bullet_Full.png|8px|link=]]
||
|-
| [[SYSCLS_ANNOTATION|Annotations]]
|| [[Image:IC_Bullet_Full.png|8px|link=]]
|| [[Image:IC_Bullet_Full.png|8px|link=]]
|| -
|| -
||
|-
| [[HotSpotting]]
|| [[Image:IC_Bullet_Full.png|8px|link=]]
|| [[Image:IC_Bullet_Full.png|8px|link=]]
|| -
|| -
||
|-
| [[HowTo:Make_a_Document_editable_on_Mobile_Client|Editing]]
|| [[Image:IC_Bullet_Full.png|8px|link=]]
|| [[Image:IC_Bullet_Full.png|8px|link=]]
|| -
|| [[Image:IC_Bullet_Full.png|12px|link=Documents_(Client)#Editing_Documents_2]]
||
|-
| [[HowTo:Make_a_Document_ready_for_Redlining|Redlining]]
|| [[Image:IC_Bullet_Full.png|8px|link=]]
|| [[Image:IC_Bullet_Full.png|8px|link=]]
|| -
|| [[Image:IC_Bullet_Full.png|12px|link=Documents_(Client)#Redlining]]
|| Outdated and replaced by the annotation feature
|-
|}

==Navigation==

{| class="wikitable" style="text-align: center; width: 100%"
|-
! style="width:28%" | Feature
!! style="width:7%" | UWP/<br/>WinX
!! style="width:7%" | Xamarin
!! style="width:7%" | Web
!! style="width:7%" | Android<br/>(Obsolete)
!! style="width:44%" | Comment
|-
| Maps Navigation Online
|| [[Image:IC_Bullet_Full.png|8px|link=]]
|| [[Image:IC_Bullet_Full.png|8px|link=]]
|| -
|| [[Image:IC_Bullet_Full.png|8px|link=]]
|| Different map apps on different platforms
|-
| Maps Navigation Offline
|| -
|| -
|| -
|| [[Image:IC_Bullet_Full.png|8px|link=]]
|| OSM, Sygic or other apps, optionally
|-
| [[Navigation_via_Augmented_Reality|AR Navigation]]
|| [[Image:IC_Bullet_Full.png|8px|link=]]
|| [[Image:IC_Bullet_Full.png|8px|link=]]
|| -
|| [[Image:IC_Bullet_Full.png|8px|link=]]
|| Navigate to objects in augmented reality
|-
| [[AR-Marker Device Pose Estimation]]
|| [[Image:IC_Bullet_Full.png|8px|link=]]
|| [[Image:IC_Bullet_Full.png|8px|link=]]
|| -
|| [[Image:IC_Bullet_Full.png|8px|link=]]
|| Estimates device positions using AR markers
|-
| [[Beacon_Proximity]]
|| [[Image:IC_Bullet_Full.png|8px|link=]]
|| -
|| -
|| [[Image:IC_Bullet_Full.png|8px|link=]]
|| Estimates device positions using bluetooth beacons
|-
| [[Compass]]
|| [[Image:IC_Bullet_Full.png|8px|link=]]
|| [[Image:IC_Bullet_Full.png|8px|link=]]
|| -
|| [[Image:IC_Bullet_Full.png|8px|link=]]
||
|-
| [[GPS]]
|| [[Image:IC_Bullet_Full.png|8px|link=]]
|| [[Image:IC_Bullet_Full.png|8px|link=]]
|| -
|| [[Image:IC_Bullet_Full.png|8px|link=]]
||
|-
| [[Gyroscope]]
|| -
|| -
|| -
|| [[Image:IC_Bullet_Full.png|8px|link=]]
||
|-
| [[Object Proximity Positioning|Object Proximity]]
|| [[Image:IC_Bullet_Full.png|8px|link=]]
|| [[Image:IC_Bullet_Full.png|8px|link=]]
|| -
|| [[Image:IC_Bullet_Full.png|8px|link=]]
|| Uses geo positions extracted from objects (scanned or selected)
|-
| [[Step Detector]]
|| -
|| -
|| -
|| [[Image:IC_Bullet_Full.png|8px|link=]]
||
|-
| [[Routing-Graph Snapping]]
|| [[Image:IC_Bullet_Full.png|8px|link=]]
|| [[Image:IC_Bullet_Full.png|8px|link=]]
|| -
|| [[Image:IC_Bullet_Full.png|8px|link=]]
||
|-
|}

==Points of Interest==

=== Map ===

{| class="wikitable" style="text-align: center; width: 100%"
|-
! style="width:28%" | Feature
!! style="width:7%" | UWP/<br/>WinX
!! style="width:7%" | Xamarin
!! style="width:7%" | Web
!! style="width:7%" | Android<br/>(Obsolete)
!! style="width:44%" | Comment
|-
| [[HowTo:Declare_an_Object_as_Map_Item|Map Items]]
|| [[Image:IC_Bullet_Full.png|12px|link=Map_View#POI_details]]
|| [[Image:IC_Bullet_Full.png|12px|link=Map_View_(Xamarin)#Geo_POIs]]
|| -
|| [[Image:IC_Bullet_Full.png|12px|link=Map_View#POI_details]]
||
|-
| [[HowTo:Declare_an_Object_as_POI_Group|POI Groups & Buildings]]
|| [[Image:IC_Bullet_Full.png|12px|link=Map_View#Buildings_.26_Indoor_Maps]]
|| [[Image:IC_Bullet_Full.png|12px|link=Map_View_(Xamarin)#Group.2C_Building_.26_Level]]
|| -
|| [[Image:IC_Bullet_Full.png|12px|link=Map_View#Buildings_.26_Indoor_Maps]]
||
|-
| [[HowTo:Declare_an_Object_as_Map_Layer|Layers and Layer Items]]
|| [[Image:IC_Bullet_Full.png|12px|link=Map_View#Map_layers_button]]
|| -
|| -
|| [[Image:IC_Bullet_Full.png|12px|link=Map_View#Map_layers_button]]
||
|-
| [[HowTo:Create_Image_Map_Overlays|Overlays]]
|| [[Image:IC_Bullet_Full.png|12px|link=Map_View#Base_map]]
|| [[Image:IC_Bullet_Full.png|12px|link=Map_View_(Xamarin)#Map_Overlays]]
|| -
|| [[Image:IC_Bullet_Full.png|12px|link=Map_View#Base_map]]
||
|-
| [[SYSCLS_MAPSHAPE|Shapes]]
|| -
|| [[Image:IC_Bullet_Full.png|12px|link=Map_View_(Xamarin)#Map_Shapes]]
|| -
|| -
|| New MapsUI based feature
|-
| [[Geographies]]
|| [[Image:IC_Bullet_Full.png|8px|link=]]
|| -
|| -
|| [[Image:IC_Bullet_Full.png|8px|link=]]
|| UBIK proprietary solution
|-
|}

=== Augmented Reality ===

{| class="wikitable" style="text-align: center; width: 100%"
|-
! style="width:28%" | Feature
!! style="width:7%" | UWP/<br/>WinX
!! style="width:7%" | Xamarin
!! style="width:7%" | Web
!! style="width:7%" | Android<br/>(Obsolete)
!! style="width:44%" | Comment
|-
| [[HowTo:Declare_an_Object_as_Map_Item|POI Items]]
|| [[Image:IC_Bullet_Full.png|12px|link=POI_View#Billboard]]
|| [[Image:IC_Bullet_Full.png|12px|link=POI_View_(Xamarin)#Geo_POI]]
|| -
|| [[Image:IC_Bullet_Full.png|12px|link=POI_View#Billboard]]
||
|-
| [[HowTo:Declare_an_Object_as_POI_Group|POI Groups & Buildings]]
|| [[Image:IC_Bullet_Full.png|8px|link=]]
|| [[Image:IC_Bullet_Full.png|12px|link=POI_View_(Xamarin)#Group.2C_Building_.26_Level]]
|| -
|| [[Image:IC_Bullet_Full.png|8px|link=]]
||
|-
| [[HowTo:Declare_an_Object_as_Map_Layer|Layers and Layer Items]]
|| [[Image:IC_Bullet_Full.png|8px|link=]]
|| -
|| -
|| [[Image:IC_Bullet_Full.png|8px|link=]]
|| The same as in the map
|-
| POI Status Color
|| [[Image:IC_Bullet_Full.png|8px|link=]]
|| [[Image:IC_Bullet_Full.png|8px|link=]]
|| -
|| [[Image:IC_Bullet_Full.png|8px|link=]]
||
|-
|}

==Object Identification==

{| class="wikitable" style="text-align: center; width: 100%"
|-
! style="width:28%" | Feature
!! style="width:7%" | UWP/<br/>WinX
!! style="width:7%" | Xamarin
!! style="width:7%" | Web
!! style="width:7%" | Android<br/>(Obsolete)
!! style="width:44%" | Comment
|-
| [[HowTo:Make_an_Object_be_found_by_Optical_Codes|QR Code]]
|| [[Image:IC_Bullet_Full.png|12px|link=HowTo:Find_Objects_by_Optical_Codes]]
|| [[Image:IC_Bullet_Full.png|8px|link=]]
|| -
|| [[Image:IC_Bullet_Full.png|12px|link=UBIK_Client_Basics#QR_Code]]
||
|-
| [[HowTo:Make_an_Object_be_found_by_Optical_Codes|Barcode]]
|| [[Image:IC_Bullet_Full.png|12px|link=HowTo:Find_Objects_by_Optical_Codes]]
|| [[Image:IC_Bullet_Full.png|8px|link=]]
|| -
|| [[Image:IC_Bullet_Full.png|12px|link=Optical_code#Types_of_optical_codes]]
||
|-
| [[HowTo:Make_an_Object_be_found_by_Optical_Codes|ID Marker]]
|| [[Image:IC_Bullet_Full.png|8px|link=]]
|| [[Image:IC_Bullet_Full.png|8px|link=]]
|| -
|| [[Image:IC_Bullet_Full.png|12px|link=UBIK_Client_Basics#ID_Marker]]
||
|-
| RFID
|| [[Image:IC_Bullet_Full.png|12px|link=RFID_tags]]
|| [[Image:IC_Bullet_Full.png|8px|link=]]
|| -
|| [[Image:IC_Bullet_Full.png|12px|link=UBIK_Client_Basics#RFID]]
||
|-
| [[OCR]]
|| [[Image:IC_Bullet_Full.png|8px|link=]]
|| [[Image:IC_Bullet_Full.png|8px|link=]]
|| -
|| [[Image:IC_Bullet_Full.png|8px|link=]]
||
|-
| ID Marker 3D
|| -
|| -
|| -
|| [[Image:IC_Bullet_Full.png|12px|link=UBIK_Client_Basics#ID_Marker_3D]]
|| Obsolete
|-
| Markerless Image Tracking
|| -
|| -
|| -
|| [[Image:IC_Bullet_Full.png|12px|link=UBIK_Client_Basics#Markerless]]
|| Obsolete
|-
| Configurable AR Content
|| [[Image:IC_Bullet_Full.png|8px|link=]]
|| [[Image:IC_Bullet_Full.png|8px|link=]]
|| -
|| [[Image:IC_Bullet_Full.png|12px|link=HowTo:Configure_Dynamic_AR_Content]]
|| UWP and Xamarin use a new and more flexible technique (XAML)
|-
| [[AR-Marker]]
|| [[Image:IC_Bullet_Full.png|8px|link=]]
|| [[Image:IC_Bullet_Full.png|8px|link=]]
|| -
|| [[Image:IC_Bullet_Full.png|8px|link=]]
|| Aruco markers for POI display, object search, etc.
|-
| [[AR-Marker#Grouped_AR_Marker|Grouped AR Marker]]
|| [[Image:IC_Bullet_Full.png|8px|link=]]
|| [[Image:IC_Bullet_Full.png|8px|link=]]
|| -
|| -
|| To overcome the number limit of available markers
|-
|}

==Synchronization==

{| class="wikitable" style="text-align: center; width: 100%"
|-
! style="width:28%" | Feature
!! style="width:7%" | UWP/<br/>WinX
!! style="width:7%" | Xamarin
!! style="width:7%" | Web
!! style="width:7%" | Android<br/>(Obsolete)
!! style="width:44%" | Comment
|-
| Automatic Mode
|| [[Image:IC_Bullet_Full.png|8px|link=]]
|| [[Image:IC_Bullet_Full.png|8px|link=]]
|| [[Image:IC_Bullet_Full.png|8px|link=]]
|| [[Image:IC_Bullet_Full.png|12px|link=Sync_Mode|Automatic Mode]]
|| Auto sync/download, auto commit/upload
|-
| Manual Mode
|| [[Image:IC_Bullet_Full.png|8px|link=]]
|| [[Image:IC_Bullet_Full.png|8px|link=]]
|| [[Image:IC_Bullet_HalfFull.png|8px|link=]]
|| [[Image:IC_Bullet_Full.png|12px|link=Sync_Mode|Manual Mode]]
|| Auto sync/download, manual commit/upload
|-
| Offline Mode
|| [[Image:IC_Bullet_Full.png|8px|link=]]
|| [[Image:IC_Bullet_Full.png|8px|link=]]
|| -
|| [[Image:IC_Bullet_Full.png|12px|link=Sync_Mode|Offline Mode]]
|| No sync/download, no commit/upload
|-
| Branch Download
|| [[Image:IC_Bullet_Full.png|12px|link=Branch_Download]]
|| [[Image:IC_Bullet_Full.png|12px|link=Branch_Download]]
|| -
|| [[Image:IC_Bullet_Full.png|8px|link=]]
|| Make data offline available
|-
| [[Branch_Download#Automatic_Download|Configurable Automatic Branch Download]]
|| [[Image:IC_Bullet_Full.png|8px|link=]]
|| [[Image:IC_Bullet_Full.png|8px|link=]]
|| -
|| -
|| Configure data to be auto download in different manners
|-
| [[Push_Service_(Client)|Push]]
|| [[Image:IC_Bullet_Full.png|8px|link=]]
|| [[Image:IC_Bullet_Full.png|8px|link=]]
|| [[Image:IC_Bullet_Full.png|8px|link=]]
|| [[Image:IC_Bullet_Full.png|8px|link=]]
||
|-
| [[Login_View#Login_details|Login Details]]
|| [[Image:IC_Bullet_Full.png|8px|link=]]
|| [[Image:IC_Bullet_Full.png|8px|link=]]
|| -
|| -
|| Delivers login details (of users) to clients
|-
|}

== Security ==

{| class="wikitable" style="text-align: center; width: 100%"
|-
! style="width:28%" | Feature
!! style="width:7%" | UWP/<br/>WinX
!! style="width:7%" | Xamarin
!! style="width:7%" | Web
!! style="width:7%" | Android<br/>(Obsolete)
!! style="width:44%" | Comment
|-
| User Authentication
|| [[Image:IC_Bullet_Full.png|8px|link=]]
|| [[Image:IC_Bullet_Full.png|8px|link=]]
|| [[Image:IC_Bullet_Full.png|8px|link=]]
|| [[Image:IC_Bullet_Full.png|8px|link=]]
|| Resctrict login by user
|-
| Device Authentication
|| [[Image:IC_Bullet_Full.png|8px|link=]]
|| [[Image:IC_Bullet_Full.png|8px|link=]]
|| [[Image:IC_Bullet_Full.png|8px|link=]]
|| [[Image:IC_Bullet_Full.png|8px|link=]]
|| Resctrict login by device
|-
| Offline Authentication
|| [[Image:IC_Bullet_Full.png|8px|link=]]
|| [[Image:IC_Bullet_Full.png|8px|link=]]
|| -
|| [[Image:IC_Bullet_Full.png|8px|link=]]
|| Allows offline authentications after successful online ones
|-
| [[User_Rights]]
|| [[Image:IC_Bullet_Full.png|8px|link=]]
|| [[Image:IC_Bullet_Full.png|8px|link=]]
|| [[Image:IC_Bullet_Full.png|8px|link=]]
|| [[Image:IC_Bullet_Full.png|8px|link=]]
|| Restricts what data can be seen and/or edit per user
|-
| SSL/TLS Encrypted Communication (HTTPS)
|| [[Image:IC_Bullet_Full.png|8px|link=]]
|| [[Image:IC_Bullet_Full.png|8px|link=]]
|| [[Image:IC_Bullet_Full.png|8px|link=]]
|| [[Image:IC_Bullet_Full.png|8px|link=]]
|| Secured
|-
| HTTP Communication
|| [[Image:IC_Bullet_Full.png|8px|link=]]
|| [[Image:IC_Bullet_Full.png|8px|link=]]
|| [[Image:IC_Bullet_Full.png|8px|link=]]
|| [[Image:IC_Bullet_Full.png|8px|link=]]
|| Unsecured
|-
| Manage Certificates
|| -
|| -
|| -
|| [[Image:IC_Bullet_Full.png|12px|link=HowTo:Install_UBIK_Client_Certificate]]
|| Manages (server) self signed certificates in UBIK
|-
| Proxy Support
|| [[Image:IC_Bullet_Full.png|8px|link=]]
|| [[Image:IC_Bullet_Full.png|8px|link=]]
|| [[Image:IC_Bullet_Full.png|8px|link=]]
|| [[Image:IC_Bullet_Full.png|8px|link=]]
|| Uses OS proxy settings during service communications
|-
| Terminate User Sessions
|| [[Image:IC_Bullet_Full.png|8px|link=]]
|| [[Image:IC_Bullet_Full.png|8px|link=]]
|| [[Image:IC_Bullet_HalfFull.png|8px|link=]]
|| -
|| Terminates {{UBIK}} service sessions upon logout or closing
|-
|}

[[Category:Client|Client Feature Table]]

SYSCLS DYNAMIC SELECTIVE LIST CRITERION

2022-06-08T10:55:10Z

JKN:

{{ClassificationInfoBox
| title = Selective list item criterion system classification
| name = {{PAGENAMEE}}
| inheritance = [[SYSCLS_ROOT]]
| namespace = System.Classification.Lists
| purpose = Classify criteria for dynamic selective lists
| version = 3.6+
| id = {413F34A9-762A-42BC-A5F5-BB8A6EE7B160}
}}

== MetaProperties ==

{| class="wikitable" width=50%
|-
! width=30% | Name !! width=30% | Data type !! Comment
|-
| DYNAMIC_SELECTIVE_LIST || {{Guid}} || The dynamic selective list this criterion belongs to.
|-
| IS_MULTI_VALUE_STRING || {{Boolean}} || Does the dependency property contain multiple keys separated by ";"?
|-
| DEPENDENCY_CLASS || {{Guid}} || The kind of object do the items depend on - can be null.
|-
| DEPENDENCY_PROPERTY_NAME || {{String}} || The name of the property influencing what items should be available.
|-
| QUERY_CRITERION_NAME|| {{String}} || The name of the offline query criterion corresponding to this object.
|-
| IGNORE_NULL|| {{Boolean}} || Should null dependency property values be ignored (TRUE) or should only items with null keys be found in case the dependency value is null (FALSE)?
|}

== Usage ==

The purpose of this classification is to define a criterion for a dynamic selective list for the client. In combination with a [[SYSCLS_DYNAMIC_SELECTIVE_LIST|Dynamic Selective List Classification]] implementation, a dynamic selective list can be configured for a scoped meta property.

One dynamic selective list criterion describes how a offline query criterion is used to find dynamic selective items. It connects the dependency value to the offline query criterion of a dynamic selective list.

For example, if you want to have a dynamic selective list presenting a list of cars, you could select the dynamic selective items (cars in this case) by manufacturer. Depending on property value telling you the manufacturer, only matching cars should be listed.

Let's say on every car object, we have a property "manufacturer", by which we could filter the cars conveniently. Then we'd need to configure a query criterion (or just a meta property) on the dynamic selective list searching for cars by this "manufacturer" property.

The dynamic selective list criterion should tell us the name of that query criterion. Now, all we need to do is find out what manufacturer we are talking about. That's where the dependency property comes into play.

The dependency property should contain the value we are filtering for. On the dynamic selective list criterion, you can describe the name of that property. You can also describe the query criterion used to find the items, so the value and the criterion are connected.

The correct object containing the dependency property value is looked up in the ACM hierarchy, so the closest parent (relative to the object where the user should be able to see the dynamic items) with that property will be used and its value will be applied to the offline query when evaluating the dynamic selective list.

It's also possible to configure a lot of additional details, which is implied in the comments of the meta properties table above.

== See also ==
* [[SYSCLS_DYNAMIC_SELECTIVE_LIST|Dynamic Selective List Classification]]
* [[HowTo:Configure_Dynamic_Selective_Lists| How to configure Dynamic Selective Lists]]
* [[Dynamic_Selective_List_(Client)]]

[[Category:Classifications|E]]
[[Category:Version 3.6|SYSCLS DYNAMIC SELECTIVE LIST CRITERION]]

SYSCLS DYNAMIC SELECTIVE LIST

2022-06-08T10:54:54Z

JKN:

{{ClassificationInfoBox
| title = Dynamic Selective List Classification
| name = {{PAGENAMEE}}
| inheritance = [[SYSCLS_OFFLINE_QUERY|Offline Query Classification]]
| namespace = System.Classification.Lists
| purpose = Classifies an offline query as dynamic selective list
| version = 3.6+
| id = {707B6D8B-D99A-4832-82A9-5341741BE50D}
}}

== MetaProperties ==

Just the inherited one from the offline query, which is autonomous (so no need to add anything).


== Usage ==

The purpose of this classification is to define a dynamic selective list for the client. In combination with one or more [[SYSCLS_DYNAMIC_SELECTIVE_LIST_CRITERION|Dynamic Selective List Criterion Classification]] implementations, a dynamic selective list can be configured for a scoped meta property.

== See also ==
* [[SYSCLS_DYNAMIC_SELECTIVE_LIST_CRITERION|Dynamic Selective List Criterion Classification]]
* [[HowTo:Configure_Dynamic_Selective_Lists| How to configure Dynamic Selective Lists]]
* [[Dynamic_Selective_List_(Client)]]

[[Category:Classifications|SYSCLS DYNAMIC SELECTIVE LIST]]
[[Category:Version 3.6|SYSCLS DYNAMIC SELECTIVE LIST]]

Version 4.1 (Xamarin)

2022-06-03T10:57:26Z

JKN: /* 4.0.13 on 2022-02-24 {{key press|App Center}} */

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

= Release Notes =

== Release ==

== Beta ==

== Preview ==

=== 4.1.xx on 2022-0x-xx ===
* Fixed an issue when scanning QR codes with line breaks on Android/iOS.
* The [[Managed_App_Configuration|managed app configuration]] on Android now supports for rolling out up to 25 {{UBIK}} profiles in an enterprise environment.
* Some properties now need to be authenticated first before editing (Authentication Properties).

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

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

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

== Known issues ==

= XAML Notes =

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

=== Converters ===
* Under namespace UBIK.CPL.Converters, SelectiveItemToValueConverter is renamed as PropertyValueToSelectiveItemConverter to properly reflect what it does.
* Under namespace UBIK.CPL.Converters, a new "StringToDateTimeTypesConverter" was added. It should be used when binding to a Date/Time Property on a PropertyViewModel.

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

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

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

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

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

=== Any template having ViewModel as the data context ===
See the same named section in [https://wiki.augmensys.com/index.php?title=Version_4.0_(WinX)#4_0 Version 4.0 (WinX) - Xaml Notes]

<headertabs />

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

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

Version 4.1 (WinX)

2022-06-01T06:04:05Z

JKN: /* 4.1.43 on 2022-05-31 {{key press|AppCenter}} */

== Important Notes ==

{{Attention|This version requires [https://en.wikipedia.org/wiki/Windows_10_version_history#Version_1809_(October_2018_Update) Windows 10 build 17763] or higher}}

= Release Notes =

== Release ==

== Beta ==

== Preview ==

=== 4.1.43 on 2022-05-31 {{key press|AppCenter}} ===
* All AR pages are now fully customizable (including the camera view, map view, etc.).
* It's now possible for users to request [[Exclusive_Access_Content_(Client)|exclusive access]] for UBIK content to prevent others from editing it at the same time.
* The PdfViewer now uses a CommandBar that enables automatic items overflow on smaller screens.
* The PdfViewer now has a text search feature.
* Some properties now need to be authenticated first before editing ([[UBIK_WinX_Client_Basics#Authentication_Properties|Authentication Properties]]).
* The app now determines the default tab to select based on different data configurations and scenarios.
* Custom UBIKContentArea templates can now be chosen automatically based on [[SYSCLS_CONTENTAREATEMPLATE|certain properties of the context object]].
* The general locking status of an MRO task owner or work package is now inherited by all its MRO child objects. This applies to all types of locking, e.g. exclusive access, user rights, etc.

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

== Known issues ==
* During PDF annotating/hotspotting, changes are lost if you leave the page without deselecting the changed annotation/hotspot.
<br/>

= XAML Notes =
<br/>

== XAML changes ==
* The following templates need to be re-customized using the new default ones:
** UBIKPOIArea
** UBIKMapArea
** UBIKScanArea
** UBIKContentArea (due to significant changes to the Document section)

* UBIKChildArea now supports customizable sub-tabs for child list filter presets.

<headertabs />

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

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

Version 4.1 (Xamarin)

2022-05-25T10:25:06Z

JKN: /* Preview */

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

= Release Notes =

== Release ==

== Beta ==

== Preview ==

=== 4.1.xx on 2022-0x-xx ===
* Fixed an issue when scanning QR codes with line breaks on Android/iOS.
* The [[Managed_App_Configuration|managed app configuration]] on Android now supports for rolling out up to 25 {{UBIK}} profiles in an enterprise environment.

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

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

== Known issues ==

= XAML Notes =

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

=== Converters ===
* Under namespace UBIK.CPL.Converters, SelectiveItemToValueConverter is renamed as PropertyValueToSelectiveItemConverter to properly reflect what it does.
* Under namespace UBIK.CPL.Converters, a new "StringToDateTimeTypesConverter" was added. It should be used when binding to a Date/Time Property on a PropertyViewModel.

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

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

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

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

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

=== Any template having ViewModel as the data context ===
See the same named section in [https://wiki.augmensys.com/index.php?title=Version_4.0_(WinX)#4_0 Version 4.0 (WinX) - Xaml Notes]

<headertabs />

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

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