Understanding OEMConfig settings

Information about configuring OEMConfig settings.

Configuration structure

The OEM configuration settings are presented in a nested structure, allowing for easier hierarchical navigation.

OEMConfig page

The OEM configuration can contain the following restrictions:

  • Primitive parameter
    • A single configurable parameter of type - String, Integer, Boolean, Choice, or MultiSelect. For example, Profile name (version), Knox License key (Knox Suite, DualDar, etc.), Debug Mode.
    • These parameters are displayed individually on the user interface with labels that are not bold.
  • Bundle
    • Collection of primitive parameters. A bundle can also contain other bundles within it forming a nested structure.
    • Bundles are displayed in bold text on the UI.
  • Bundle array
    • Collection of primitive parameters and bundles. A bundle array can also contain other bundle arrays within it forming a nested structure.
    • It allows the administrator to add new bundles by copying the configuration from an existing bundle. The newly added bundles are dynamic and can be modified or deleted as required.
    • Bundle arrays are displayed in bold text on the UI.

Actions

You can perform the following actions on the OEMConfig settings:

  • The restrictions that are not configured will display a Configure button next to them. Click Configure to configure a restriction.
    Note: If a parameter contains a predefined default value, it will be displayed, and you can configure it as required.
    configure button on the oemconfig page
  • If the administrator has configured parameters in a bundle or bundle array, a View button is displayed next to the restriction to indicate the same. Click View to view all the configurations in a bundle or bundle array.
    Note: The View button is not displayed for primitive parameters.
    view button on the oemconfig page
  • To unconfigure a parameter, click the three-dots icon next to the parameter and click Unconfigure.
    unconfigure button on the oemconfig page
  • To reset a parameter to its default value, click the three-dots icon next to the parameter, then select Reset to Default.
    reset to default button on the oemconfig page
  • To revert a parameter to its previously saved value, click the three-dots icon next to the parameter, then select Reset to Last Saved.
    reset to last saved button on oemconfig page

Navigation

You can navigate to the required parameter in the OEMConfig settings using the following methods:

  • When the administrator configures restrictions in an OEM configuration, the configured restrictions (bundle/bundle array) appear on the left pane. This provides convenient visibility and quick access to the configured parameters.
    Click on the restriction on the left pane to quickly navigate to the configured (added/modified) parameters.
    left pane on the oemconfig page
  • A breadcrumb displayed at the top of the page helps to identify the hierarchy level and easily navigate to the desired level.
    breadcrumb on the oemconfig page
  • The Search functionality has been introduced on the OEM Configuration page, which allows an administrator to search for specific restrictions and parameters by entering the corresponding name in the search box.
    search bar on the oemconfig page

Default configuration value preferences and delivery mechanism

The primitive parameters in an OEM configuration can contain associated default values. When the administrator saves an OEM configuration, the default values are delivered to the devices only under circumstances when the administrator does not explicitly assign a value.

The fundamental rule regarding default values delivery is that default values at Level 0 are always delivered. Default values at subsequent levels (Level 1 and beyond) are only delivered when the enclosing bundle is configured

Consider the following example of an OEM configuration with various levels and default values:

Level 0 Parameters Level 1 Parameters Level 2 Parameters Level 4 Parameters

String Param 1

Default Value: ABC1

     

Boolean Param 1

Default Value: False

     

Choice Param 1

     

Bundle 1

String Param 2

Default Value: ABC2

   
 

Integer Param 2

   
 

Bundle 2

String Param 3

 
   

Integer Param 3

Default Value: 3

 
   

Bundle 3

String Param 4

Default Value: ABC4

     

Integer Param 4

Default Value: 4

     

Choice Param 4

     

MultiSelect Param 4

Scenario 1

Setting: The administrator saves the OEM configuration without modifying any parameter.

Result: Since the administrator has not configured any parameters, the default parameter values at Level 0 are delivered to the device.

Scenario 2

Setting: The administrator saves the OEM configuration after modifying the value of Choice Param 1 at Level 0.

Result: The default parameter values at Level 0 and the modified value of Choice Param 1 are delivered to the device.

Scenario 3

Setting: The administrator saves the OEM configuration after modifying the value of Bundle 1 > Integer Param 2.

Result: Since the value of Integer Param 2 is changed, it indicates that this parameter has been configured, thereby marking both Integer Param 2 and Bundle 1 as configured.

When the administrator saves this OEM configuration, the following configurations are delivered to the device:

  • All the default configuration values and configured parameter values at Level 0.
  • All the default configuration values and configured parameter values in Bundle 1.

In this example, the parameters delivered to the device are, String Param 1, Boolean Param 1, Bundle1 > [ String Param 2, Integer Param 2].

Scenario 4

Setting: The administrator saves the OEM configuration after modifying Bundle1 > Bundle2 > String Param 3.

Result: Since the value of String Param 3 is changed, it is marked as configured, leading to its parent parameters being recursively marked as configured. As a result, both Bundle 2 and Bundle 1 are marked as configured.

When the administrator saves and publishes this configuration, the following configurations are delivered to the device:

  • All the default and configured parameters at Level 0.
  • All the default and configured parameters in Bundle 1.
  • All the default and configured parameters in Bundle 2.

In this example, the parameters delivered are, String Param 1, Boolean Param 1, Bundle1 > [ String Param 2, Bundle 2 > [String Param 3, Integer Param 3] ].

Review Changes

The changes made to an OEM configuration in the published state are captured in the Review Changes section. This section displays the changes in a nested structure. The configured restrictions are shown on the left pane, and clicking on a restriction displays its corresponding parameters on the right pane. Added, deleted, modified, and new restrictions are highlighted in distinct color codes for easy identification.
review changes secion in oemconfig