Sideloading a Sphere Configuration File

General

As an alternative to entering application settings directly on the clients, we allow devices running holo|one sphere to have settings sideloaded, either manually, or from a centralized MDM/MAM source - for example, Microsoft Intune.

Setup Procedure

The general setup procedure for setting up the configuration file is

Create a file named sphere_user_config.json based on the template shown below, and replace the values in the template to match your desired settings.
Load the sphere_user_config.json file to the respective folder, depending on the device platform. Note, these folders will not exist if holo|one sphere is not already installed

Platform	Folder	Notes
Android	/storage/emulated/0/Android/data/sphere/files	This applies for the majority of Android devices. For older devices the location may be on the SD card if present.
iOS	/var/mobile/Containers/Data/Application/<GUID>/Documents
PC Standalone	C:\Users\<USER>\AppData\LocalLow\holo one\sphere
Universal Windows Platform (Microsoft HoloLens)	<USER>\AppData\Local\Packages\sphere\LocalState

Launch holo|one sphere
- If sphere is already open, you will need to exit it and restart it

Configurable Setting Fields

The following fields can be configured in order to autopopulate values on application startup. If an invalid value is present or a value is missing entirely, it will be ignored.

A sample configuration file is shown at the end of this page

Field	Description	Valid Values
`url` (proxy)	The proxy url and port	n/a
`username` (proxy)	The proxy username	n/a
`password` (proxy)	The proxy password	n/a
`default_login`	Default login flow used	`sphere` `thinkreality`
`thinkreality_organization`	The thinkreality organization name that the user belongs to	Should be all lowercase, e.g. `holoone`
`sphere_region`	The sphere or LCP region that your organization belongs to	`na` - North America `eu` - Europe `cn` - China
`language`	The display language of the application	`en` - English `de` - German `zh` - Simplified Chinese

For language and region, if options have been chosen manually the application settings will defer to these chosen values and the settings in the configuration file will not be used.

Additional Notes for Proxies

With respect to the configuration file proxy settings, there are a couple additional considerations:

For <HOST>, you can user either a domain or IP address
If there is no username or password provided, the just leave them as empty quotation pairs, i.e. "username": ""
If the user is already logged in prior to the configuration file sideloading, they will need to log out first for the proxy to be picked up
If configured correctly, holo|one sphere should automatically pick up the proxy settings file when launched
- To confirm, the proxy settings button icon will turn blue if there is a valid proxy detected. A valid proxy however, does not mean that the proxy credentials or url are correct, just that they are valid entries.

For information on connecting to proxies manually in the client application, please refer to the following pages:

Proxy Connection Template

JSON

{
  "proxy": {
    "url":"http://<HOST>:<PORT>",
    "username":"<USERNAME>",
    "password":"<PASSWORD>"
  },
  "default_login": null,
  "thinkreality_organization": null,
  "sphere_region": null,
  "language": null
}