Configure Workspace ONE Notebook settings using the configuration key and configuration value pairs. The steps provided in this page are applicable to assign the Notebook application for verisons 1.3 and below using the console versions of 2001 and below.
These configurations are set as a part of the SDK profile that you are planning to use for Notebook. If you are using the default SDK profile, set the application configurations by navigating to .
For example:
If you are using the custom SDK profile, and choose the profile(s) that you have created for iOS and Android Notebook.
For example:
Account & Key Settings
| Configuration Key | Value Type | Configuration Value | Description |
|---|---|---|---|
| {"exchangeURL":" URL"} | string | Specify the EWS URL. Use this format: https://server.domain.com/EWS/Exchange.asmx. | This configuration key is required. Allows user to synchronize notes with Exchange server. |
| {"userEmail": "{EmailAddress}" } | string | Provide a valid user email. | Enter the email address. This configuration key is required. The {EmailAddress} lookup value is supported. |
| {"userName": "{EmailDomain}\\{EmailUserName}" } | string | Enter the domain or username. | Provide a username for exchange server authentication.
The {EmailUserName} lookup value is supported. Lookup value is available for Domain/Username as {EmailDomain}\\{EmailUserName} OR {EmailAddress}.
Note: For NTML auth it’s specified in Domain\UserName format.
|
| {"PolicyAllowLogging":"true"} | Boolean | True - enabled False - deactivate |
This is a crash reporting data collection admin policy that controls the application reporting diagnostic data, which can be used to troubleshoot crash issues and provide support. If set to true, privacy manager allows the user to activate reporting. |
| {"PolicyAllowMetrics":"true"} | Boolean | True - enabled False - deactivate |
Set to True to enable data collection for Workspace ONE Notebook experience improvement. |
| ("PrivacyPolicyLink":"true"} | string | Example: https://www.acme.com | Provide the Policy URL that you want your users to visit when your company's privacy policy is selected from the privacy notice. |
| {"DisplayPrivacyDialog":1} | Integer | 1 - enabled (default) 0 - deactivate |
When set to 1 (enabled), Workspace ONE Notebook displays a privacy notice to the users about the data that is collected and the permissions that are required on the device for the app to function. If you do not set this configuration key, by default the privacy dialog will be shown. |
OAuth-based Authentication
Add the following key value pair to enable the OAuth-based authentication with Exchange server.
| Configuration Key | Value Type | Configuration Value | Description |
|---|---|---|---|
| {"AccountUseOauth":"true"} | Boolean | False - deactivate (default) True - enabled |
Set to true to activate the OAuth-based authentication support with Exchange server. |
Modern Authentication through WKWebView
| Configuration Key | Value Type | Configuration Value | Description |
|---|---|---|---|
| {"AccountUseWebviewForOauth":"true"} | Boolean | True - activated False - deactivated |
When set to True, the oauth flow is presented using a WKWebView instead of SFSafariViewController.
Note: The AccountUseWebviewForOauth key can be applied for managed accounts on Exchange server On- Premise or Office 365.
|
Configure Certificate-Based Authentication with Exchange
To activate CBA with Exchange Server, add the following key under the Custom Settings in the UEM console.
| Configuration Key | Value Type | Configuration Value | Description |
|---|---|---|---|
| {"AccountUseCBA":"true"} | Boolean | False - deactivated (default) True - activated |
Set this vale to true to activate Certificate Based Auth |
| {"AccountUseDualAuth":"true"} | Boolean | False - deactivated (default) True - activated |
Set this value to true to activate Dual authentication (CBA and Basic). |
Kerberos Authentication
Add the following key, to enable Kerberos authentication.
| Configuration Key | Value Type | Configuration Value | Description |
|---|---|---|---|
| {"enableKerberos":"true"} | Boolean | False - deactivated (default) True - activated |
Set this value to true to enable Kerberos authentication. |
App Features
If a configuration key is not set, the default value listed below will be reflected in the Notebook application behavior.
| Configuration Key | Value Type | Configuration Value | Description |
|---|---|---|---|
| {"allowGallery":"true"} | Boolean | True - activated (default) False - deactivated |
Enables or deactivates access and use of the device image gallery |
| {"allowVoiceRecordings":"true"} | Boolean | True - activated (default) False - deactivated |
Enables or deactivates the use of audio recording. |
| {"allowDocumentScanner":"true"} | Boolean | True - activated (default) False - deactivated |
(iOS only) Enables or deactivates the document scanning feature. |
| {"allowHyperlinks":"true"} | Boolean | True - activated (default) False - deactivated |
(iOS only) Allow users to enter hyperlinks. |
| {"allowAnnotations":"true"} | Boolean | True - activated (default) False - deactivated |
(iOS only) Allows the use of handwriting and highlighter tools. |
| {"allowAttachments":"true"} | Boolean | True - activated (default) False - deactivate |
Enables or deactivates note attachments feature. When deactivated, no attachment types are allowed. |
Enable Support for SEG
| Configuration Key | Value Type | Configuration Value | Description |
|---|---|---|---|
| {"EasDeviceIdentifier":"EasDeviceIdentifier"} | String | {EasDeviceIdentifier} |
Device identifier to allowlists traffic by SEG and traffic proxied. |
