Skip to content

Adding Custom Settings into Workspace ONE UEM

To add custom settings into Workspace ONE UEM. follow these steps: 1. Go to: Groups & Settings > All Settings > Apps > Settings & Policies > Settings. 2. Enable Custom Settings. 3. Enter your desired custom settings in the Custom Settings field. 4. Save your changes.

Structure of Custom Settings Using JSON

When entering custom settings, you can use JSON format. Make sure your JSON is properly structured and valid.

Example JSON Custom Settings:

{ 
    "PolicyAllowCrashReporting": true,
    "CaptureDEXData": true,
    "DEXData": {
        "Version": 1.0,
        "BatteryData": {
            "EventsToDisable": ["charging_state_change"]
        }
    }
    ...
}

Common SDK Configuration Keys for Intelligence SDK

When configuring the Workspace ONE SDK through Custom Settings, specific key/value pairs can be used to for Intelligence SDK:

PolicyAllowCrashReporting

Type: Boolean (true or false)

Description: Used to enable / disable Intelligence SDK

Example: 

{
  "PolicyAllowCrashReporting": true
}

CaptureDEXData

Type: Boolean (true or false)

Description: Used to enable / disable the DEX portion of IntelSDK. This flag is void if PolicyAllowCrashReporting is not true.

Example: 

{
  "CaptureDEXData": false
}

DEXData

Type: Object (JSON)

Description: Used for setting the privacy configuration JSON container for all DEX granular controls.

Example: 

{
  "DEXData": {
    "Version": 1.0,
    "BatteryData": {
      "EventsToDisable": ["charging_state_change"]
    },
    "DeviceData": {
      "EventsToDisable": []
    },
    "NetworkData": {
      "EventsToDisable": ["network_change"]
    },
    "AppUsageData": {
      "DisableAll": false
    }
  } 
}

Integrating Custom Settings into Intelligence SDK using Workspace One SDK APIs

Once custom settings are configured in Workspace ONE UEM, your application can pull these settings at runtime.

In this example, the custom settings are retrieved from Workspace ONE UEM.

Example (Android)

private fun fetchSettings() {
    SDKFetchSettingsHelper(context).fetchSDKSettings(context,
        object : ISdkFetchSettingsListener {
            override fun onSuccess(configuration: BaseConfiguration?) {
                val customSettings = configuration?.getValuesWithKeyStartWith(
                    SDKConfigurationKeys.TYPE_CUSTOM_SETTINGS,
                    SDKConfigurationKeys.CUSTOM_SETTINGS
                )
                ...
            }

            override fun onFailure(result: TaskResult?) {}
        }
    )
}

Example (iOS)

- (void) receivedProfiles: (NSArray *) profiles {
    AWCustomPayload *custom = [[profiles firstObject] customPayload];
    NSString *customSettings = custom.settings;
    ...
}

For more details about the structure of the privacy configuration and its purpose, see Android Telemetry Privacy Configuration and iOS Telemetry Privacy Configuration.