Configure Workspace app using Unified Endpoint Management solutions
Starting with the 23.3.0 version, Citrix Workspace app for iOS supports admin configuration of the Workspace app using AppConfig-based key-value pairs using Unified Endpoint Management (UEM) solutions.
How to configure
To configure your Workspace Store URL using Unified Endpoint Management solutions, follow these steps:
Note:
For demonstrative purposes, Microsoft Intune is used as the UEM solution in this example. The steps below and UI shown differs depending on your UEM provider.
- Sign in to your Unified Endpoint Management (UEM) provider.
- Add the Citrix Workspace app that you want to manage by your UEM provider. You can upload the app by using your UEM provider’s portal to enable management by your UEM provider. Alternatively, you can link to the app in the App Store.
- Create an app configuration policy for your app.
-
Add a key and value pair to the XML property list and fill in the following values:
-
key:
url
-
value type:
String
-
value: your store URL (for example,
prodcwa.cloud.com
)
-
key:
Limitations
- If a cloud store is already set up, and the administrator configures a new cloud store, your existing cloud store is deleted. It also deletes any associated data or settings of the existing cloud store. You receive a notification in Citrix Workspace. You must then sign in again so that the new cloud store is added to Citrix Workspace.
- The above statement only applies to existing cloud stores. If an on-prem store is already configured and the admin configures a new cloud or on-prem store, then the new store is added and no deletion occurs.
- To apply new configurations, you must force-quit and restart the Citrix Workspace app.
Enhancements to Unified Endpoint Management solutions
Starting with the 23.4.5 version, Citrix Workspace app for iOS supports a couple more configurations using AppConfig-based key-value pairs to configure the Citrix Workspace app. Previously, administrators could configure Store URLs. Now, administrators can restrict end users to modify Store URLs and control how the app appears.
The following are the details:
Configuration key | Value type | Configuration value |
---|---|---|
url |
String |
The store URL. For example, prodcwa.cloud.com
|
storeType |
Integer |
|
restrict_user_store_modification |
Boolean |
|
Support for configuring device name through UEM
Starting with the 24.3.5 version, Citrix Workspace app for iOS enables administrators to assign and identify device names based on user groups through Unified Endpoint Management (UEM).
To configure the device name using UEM, do the following steps:
Note:
For demonstrative purposes, Microsoft Intune is used as the UEM solution in this example. The steps below and the UI shown differ depending on your UEM provider.
- Sign in to your UEM provider.
- Add Citrix Workspace app that you want to manage by your UEM provider. You can upload the app by using your UEM provider’s portal to enable management by your UEM provider. Alternatively, you can link to the app in the App Store.
- Create an app configuration policy for your app.
- Add a key and value pair to the XML property list and fill in the following values:
- key: deviceName
- value type: String
- value: Name of the device (for example, MY_IPHONE_Device)
Support for configuring Citrix Workspace app settings through UEM
Previously, you can only configure the store URL in the Citrix Workspace app using the Unified Endpoint Management (UEM).
Starting with the 24.7.0 version, you can also configure the Citrix Workspace app settings on the managed devices using any UEM solution that is deployed in your infrastructure.
Note:
As an administrator, if you have an option of configuring the Citrix Workspace app settings using UEM and Global App Configuration service (GACS), UEM always takes a higher preference over GACS.
The following is a sample json file to configure the Citrix Workspace app settings:
<dict>
<key>stores</key>
<array>
<dict>
<key>url</key>
<string>https://teststore.cloud.com</string>
<key>storeType</key>
<integer>1</integer>
<key>displayName</key>
<string>Cloud Store 1</string>
<key>appSettings</key>
<array>
<dict>
<key>category</key>
<string>audio</string>
<key>userOverride</key>
<false/>
<key>settings</key>
<array>
<dict>
<key>name</key>
<string>settings_audio_stream</string>
<key>value</key>
<true/>
</dict>
</array>
</dict>
<dict>
<key>category</key>
<string>authentication</string>
<key>userOverride</key>
<false/>
<key>settings</key>
<array>
<dict>
<key>name</key>
<string>settings_auth_web_browser</string>
<key>value</key>
<string>embedded</string>
</dict>
</array>
</dict>
</array>
</dict>
<dict>
<key>url</key>
<string>https://teststore.cloud.com</string>
<key>storeType</key>
<integer>1</integer>
<key>displayName</key>
<string>StoreFront1</string>
<key>appSettings</key>
<array>
<dict>
<key>category</key>
<string>audio</string>
<key>userOverride</key>
<false/>
<key>settings</key>
<array>
<dict>
<key>name</key>
<string>settings_audio_stream</string>
<key>value</key>
<false/>
</dict>
</array>
</dict>
<dict>
<key>category</key>
<string>authentication</string>
<key>userOverride</key>
<false/>
<key>settings</key>
<array>
<dict>
<key>name</key>
<string>settings_auth_web_browser</string>
<key>value</key>
<string>system</string>
</dict>
</array>
</dict>
</array>
</dict>
</array>
<key>storesToDelete</key>
<array>
<string>test.cldblr.com</string>
<string>test.cloud.com</string>
</array>
<key>restrict_user_store_modification</key>
<false/>
</dict>
<!--NeedCopy-->
Note:
The
userOverride
flag allows the user to modify the Citrix Workspace app settings. If theuserOverride
flag is set to true, the user can change the settings. If theuserOverride
flag is set to false for any settings, then the user can’t modify it in the Citrix Workspace app settings.
Key value pair table
The following table provides the key value pair information:
Note:
You must add settings that are specific to a category in one block under that category.
Category | Setting | Description | Key | Value | Value Type | Default value |
---|---|---|---|---|---|---|
audio | Audio | Provides access to users to turn the audio on or off from the virtual app or desktop. | settings_audio_stream | true/false | Boolean | TRUE |
keyboard | Use Unicode Keyboard | Allows users to use a standard Unicode keyboard. | settings_use_unicode_keyboard | true/false | Boolean | TRUE |
keyboard | Automatic keyboard | Enables or disables the automatic display of the keyboard in a session. | settings_automatic_keyboard | true/false | Boolean | TRUE |
keyboard | Keyboard Layout Sync | Allows users to switch to a preferred keyboard layout on the device. | settings_keyboard_layout_sync | true/false | Boolean | FALSE |
keyboard | Use Custom Keyboards | Allows users to use third-party keyboards that are downloaded in the virtual session. | settings_allow_keyboard_extensions | true/false | Boolean | FALSE |
display | Session Resolution | Allows users to select the screen resolution. | settings_resolution | 0–9 | Integer | 5 (iPad) 3 (iPhone) |
display | Presentation Mode | Allows you to use your iOS device as a trackpad to control your session while using an external display. | settings_presentation_mode | true/false | Boolean | FALSE |
display | External Display | Connects an external display to the device. | settings_external_display | true/false | Boolean | TRUE |
advanced | Strict Certificate Validation | Enforces stricter control on server certificate validation. | settings_strictCertValidation | true/false | Boolean | FALSE |
advanced | TLS Versions | Allows users to change their TLS settings for troubleshooting purposes. | settings_tlsVersion | 0–3 | Integer | 0 |
advanced | Use Native Combo Box | Enables the use of the iOS native selection feature. | settings_native_combobox | true/false | Boolean | TRUE |
advanced | Touch Enable (iPAD only) | Enables touch for all apps and desktops, including those that do not have the touch option enabled natively. | settings_multitouch_on | true/false | Boolean | true (iPad) false (iPhone) |
advanced | Fullscreen View | Allows you to view your apps and desktops in full screen. | settings_mobile_window_fullscreen | true/false | Boolean | true (iPad) false (iPhone) |
advanced | Reconnect upon Login | Allows a session to automatically reconnect when a new account is added or during sign-in. | settings_reconnect_logon | true/false | Boolean | FALSE |
advanced | Reconnect upon Refresh | Automatically reconnects to a session launched from another device upon refresh of the apps or desktops on the second device. | settings_reconnect_refresh | true/false | Boolean | FALSE |
advanced | Enable HTTP Proxy | Allows you to use the HTTP proxy for a session. | settings_use_local_proxy | true/false | Boolean | TRUE |
advanced | Use derived credentials | Allows to use derived credentials. | setting_useDerivedCredentials | true/false | Boolean | FALSE |
advanced | Smart Card in session | Allows the use of a smart card device within a session. This setting doesn’t allow users to authenticate to the session. | settings_usesSmartCardInsideSession | true/false | Boolean | FALSE |
advanced | Allow EDT | Enables adaptive transport support. | settings_allowUdp | true/false | Boolean | TRUE |
advanced | Auto Tablet Mode | Enables to launch the virtual session in tablet mode, when there is no external keyboard or mouse detected. | settings_enableTabModeSwitch | true/false | Boolean | TRUE |
advanced | Keep the Display On | Keep the screen on. | settings_stay_awake | true/false | Boolean | FALSE |
advanced | Use iPAD storage | Allows you to access local drives on your device. | settings_client_drive | true/false | Boolean | false |
X1 Mouse | Allow X1 Mouse | Allows you to switch access to your Citrix X1 Mouse. | settings_allow_X1_mouse | true/false | Boolean | FALSE |
X1 Mouse | Citrix X1 Mouse speed | Allows users to control the speed of the mouse cursor within the virtual session. | settings_x1MouseSpeed | 1,2 | Integer | 200 (iPadPro) 100 (All other devices) |
X1 Mouse | Use remote cursor image forCitrix X1 Mouse | Makes the cursor match the app or desktop within a session. For example, if the cursor is over a text box, it changes to match the text box. | settings_X1_mouse_server_side_cursor | true/false | Boolean | TRUE |
authentication | Web Browser for Authentication | Allows you to identify usage of SafariViewController instead of WKWeb on the device. | settings_auth_web_browser | system/embedded | string | Embedded |
thirdPartyServices | LaunchDarkly | Enables the LaunchDarkly flag on the Citrix Workspace app features. | enableLaunchDarkly | true/false | Boolean | true (non-EU regions) |