In addition to configuration via the application.yml, some configuration options for Sophora Web can be changed via a dedicated configuration document, allowing to change these options on-the-fly without needing to restart the application.
The document to be used can be configured via its externalId in the application.yml, under webclient.configuration.configurationDocumentExternalId. The externalId of the default document is 'default-sophora-web-configuration'. That default document is also used as a fallback if the selected configuration document is deleted or set offline. If you want to make changes to the configuration, you have to save and publish the document for the settings to take effect.
The configuration document for Sophora Web can be edited via the Admin View in the Deskclient, under "Sophora Web Configuration", or via Sophora Web in the Toolbar under "Configuration" (only visible for admins). It can be changed on-the-fly, allowing to change configurations while Sophora Web is running. It contains the following configuration options:
| Property | Configuration |
|---|---|
| sophora:maxExcelExportDocuments | Controls the maximum number of documents that are exported in the Excel Export |
| sophora:brandingPrimaryColor | Primary Color of the custom theme for Sophora Web. If omitted, disables custom theming |
| sophora:brandingSecondaryColor | Secondary Color of the custom theme for Sophora Web. Can be omitted |
| sophora:brandingTertiaryColor | Tertiary Color of the custom theme for Sophora Web. Can be omitted |
| sophora:brandingIcon | SVG branding icon image that is displayed in the login screen and the navigation menu after login. The aspect ratio must be 1:1 |
| sophora:brandingIconAlttext | Alttext of that icon |
Theming
Sophora Web's front-end offers a default color theme with light and dark modes and, when enabled, is automatically switching to light or dark mode according to the user's system settings.
Furthermore, Sophora Web installations support custom branding themes, enabling a unique visual identity tailored to specific requirements, such as corporate branding. A configured branding theme takes precedence over the default theme. Users can switch between the default and branding themes after login; their selection is stored in the browser.
Our theming leverages Material Design, generating themes based on provided color values. For detailed information and color experimentation, please refer to the Material Design theme builder or the Material Design website. Especially the theme builder can give a useful preview of what a theme could look like in Sophora Web.
Branding is configured within the configuration document.
If only the primary color is specified, the remaining colors are automatically generated. Omitting the properties from the configuration document disables custom branding.
