Deploy UI Customizings (Client) - Revision history

CWI: /* Known Issues */

2025-09-25T14:24:12Z

‎Known Issues

CWI at 10:48, 23 September 2025

2025-09-23T10:48:37Z

CWI at 10:07, 18 September 2025

2025-09-18T10:07:55Z

REP: /* Known Issues */ typo

2025-02-27T14:17:04Z

‎Known Issues: typo

JKN at 07:19, 28 November 2024

2024-11-28T07:19:44Z

CWI at 13:18, 7 March 2024

2024-03-07T13:18:49Z

CWI at 13:45, 6 March 2024

2024-03-06T13:45:31Z

LGE at 14:00, 20 September 2021

2021-09-20T14:00:17Z

LGE: /* Client scenario */

2021-09-17T14:02:25Z

‎Client scenario

NWE: /* Manual deployment */

2021-07-06T10:24:31Z

‎Manual deployment

@@ Line 49: / Line 49: @@
 === 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.
+Sometimes in UWP, 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">
@@ Line 70: / Line 70: @@
 {{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 unpacking 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.}}
+[[Category:Client|Deploy UI Customizings (Client)]]
+[[Category:Mobile|Deploy UI Customizings (Client)]]
+[[Category:WinX|Deploy UI Customizings (Client)]]
+[[Category:XAML|Deploy UI Customizings (Client)]]
 == Delete UI customizings ==

@@ Line 4: / Line 4: @@
 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.
+* [ClientType] is either UWP or GO (for Mobile).
 === Profile specific customizing {{Version/XamarinSince|1.2}} ===
@@ Line 19: / Line 19: @@
 === 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.
+Since it's impossible to copy/paste files to the app data folder with UBIK Mobile 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.
@@ Line 78: / Line 78: @@
 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).
+Similar to the importing scenario, it's impossible to delete customizing files from the app data folder with UBIK Mobile 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:XAML|Deploy UI Customizings (Client)]]

@@ Line 70: / Line 70: @@
 {{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 unpacking 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.}}
-[[Category:Client|Deploy UI Customizings (Client)]]
-[[Category:WinX|Deploy UI Customizings (Client)]]
-[[Category:XAML|Deploy UI Customizings (Client)]]
-[[Category:Xamarin|Deploy UI Customizings (Client)]]
 == Delete UI customizings ==
@@ Line 84: / Line 84: @@
 [[Category:Client|Deploy UI Customizings (Client)]]
 [[Category:WinX|Deploy UI Customizings (Client)]]
 [[Category:XAML|Deploy UI Customizings (Client)]]

@@ Line 68: / Line 68: @@
 </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.}}
+{{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 unpacking 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 ==

← Older revision		Revision as of 07:19, 28 November 2024
Line 81:		Line 81:
	[[Category:WinX\|Deploy UI Customizings (Client)]]		[[Category:WinX\|Deploy UI Customizings (Client)]]
	[[Category:Xamarin\|Deploy UI Customizings (Client)]]		[[Category:Xamarin\|Deploy UI Customizings (Client)]]
		+	[[Category:XAML\|Deploy UI Customizings (Client)]]

@@ Line 23: / Line 23: @@
 * 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 ==
@@ Line 35: / Line 43: @@
 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;
 * 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]].

@@ Line 20: / Line 20: @@
 === Client scenario ===
-Once a {{UBIK}} client connects to a server and downloads such a customizing archive, it unpacks the archive file and place all its content (with the folder structures if there's any) under the client's XAML folder.
+Once a {{UBIK}} client connects to a server and downloads such a customizing archive, it unpacks the archive file and places all its content (with the folder structures if there's any) under the client's XAML folder.
 * 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;
 * 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.
 === Some other details ===

@@ Line 3: / Line 3: @@
 == 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 (at [AppInstallPath]\LocalState\XAML, where the installation path is in the user's appdata\packages directory);
+* 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.
 [[Category:Client|Deploy UI Customizings (Client)]]