Overview
The mobile app displays a default list of configuration options on the Settings screen. You can also add custom settings to this list that deliver data back to your server. Saving these custom settings allows you to provide users with greater control over their experience.
How It Works
The Platform manages the Settings screen by combining standard system fields with an optional form you define in App Manager.
Default Settings
The mobile app provides several standard fields to all users independent of any custom configuration.
Theme: This field allows users to choose the app’s theme. Options include:
Light mode
Dark mode
Use Device Setting (default)
This preference is stored on the server and persists across different devices and logins.
Dashboard Layout: This field allows users to choose the Dashboard display to suit device size and orientation. Options include:
Auto (default)
Always 1 Column
Always 2 Columns
This setting persists across logins but is hardware-specific; therefore, it does not persist across different devices.
NOTE: The Dashboard Layout setting is only available in mobile app version 1.61 and newer.
Document History: This field allows users to set the in-app document retention period to 7, 14, or 30 days. This setting is maintained locally and reset upon user logout.
Temperature Unit: This field allows users to toggle between Celsius and Fahrenheit (Android only). This setting is maintained locally and reset upon user logout.
Send Diagnostics: This button allows users to transmit device-level diagnostics to Eleos when requested for technical investigations.
NOTE: The Send Diagnostics button is only available in mobile app version 1.62 and newer.
Custom Settings
Custom settings allow you to extend the Settings screen with fields specific to your integration. The Platform treats these settings as opaque, allowing you to modify the behavior of your integration based on these stored values. For instance, you could allow users to toggle periodic reminders or define a specific number of days for load history.
NOTE: To implement custom settings, you must create a form within App Manager containing a field for each setting you wish to expose.
Updates and Persistence
The Platform does not persistently store custom settings. Your backend system must maintain these values in a database or other storage solution.
When a user modifies a custom setting, the mobile app sends a PUT request containing the updated values to your authentication handler. Your server must store these values and reflect the updates in the custom property of all subsequent authentication responses.
IMPORTANT: You must ensure your server accurately captures and returns updated values, or the mobile app will revert to previous settings during the next session.
Authentication Requirements
Your user authentication response must include the custom_settings_form_code to match the form code created in App Manager. The custom property returns the initial values for each setting, where each key matches the corresponding field code within the form.
Example:
{
"api_token": "example-ab33493",
"custom": {
"REMINDERS": true,
"LOAD-HISTORY": "30"
},
"custom_settings_form_code": "MY-SETTINGS"
}