In addition to the application.yml file, several Sophora Web settings can be managed via a dedicated configuration document. This allows you to update options on the fly without restarting the application.
The document in use is specified by its External ID in application.yml under webclient.configuration.configurationDocumentExternalId. The default ID is 'default-sophora-web-configuration'. This default document also serves as a fallback if the active configuration document is deleted or taken offline.
Editing the configuration document
You must have administrative privileges to edit the configuration document.
- In the navigation pane, click the Configuration icon.
- Select Sophora Web Configurations.
Overview
The configuration document includes the following settings:
| Name | Property | Configuration | |
|---|---|---|---|
| Export | Maximum number of documents per Excel export | sophora:maxExcelExportDocuments | Controls the maximum number of documents that can be exported at once. |
| Theming | Primary color | sophora:brandingPrimaryColor | The main color for the custom theme. Disables custom theming if omitted. |
| Theming | Secondary color | sophora:brandingSecondaryColor | The secondary color for the custom theme (optional). |
| Theming | Tertiary color | sophora:brandingTertiaryColor | The tertiary color for the custom theme (optional). |
| Branding | SVG branding icon | sophora:brandingIcon | SVG icon displayed on the login screen and main navigation menu. Requires a 1:1 aspect ratio. |
| Branding | SVG branding icon alt text | sophora:brandingIconAlttext | Alt text for the branding SVG icon. |
Structure Appearance Configuration
Under Structure appearance configuration, you can use table to configure settings on a per-site basis:
- Name: The name of the section. Appears as the browser tab title (HTML title) and serves as the image alt text.
- Color: The color representing the section. Used to highlight document cards and the editor for documents within the configured site.
- Structure section: The specific site to which the configuration applies.
- Icon: The icon representing the section, displayed in the editor for documents within the configured site. Requires a 1:1 aspect ratio.
Theming
Sophora Web features a default color theme that supports light and dark modes, automatically switching based on the user's system preferences.
In addition, installations support custom branding themes for corporate identities. A custom theme overrides the default theme, though users can toggle between the default and custom branding after logging in (their preference is saved in the browser).
Theming leverages Material Design to generate color palettes based on your configured primary, secondary, and tertiary colors:
- If only the Primary color is specified, secondary and tertiary colors are automatically generated.
- Omitting color properties entirely disables custom branding.
- You can test and preview color schemes using the Material Design theme builder.
