Organization Administrator's Guide
Toggle TOC panel
Theming Safe Share's web-based interfaces

Themes allow the color schemes and logos utilized throughout Safe Share for Web user interface to be customized for individual organizations, where each individual organization is associated with its own theme. (For more information about adding/configuring organizations through Safe Share Administration, see Administering organizations in the Safe Share Administrator's Guide.)

In this version of Safe Share and the Covata Platform, themes are generated using an separate tool (the Covata/WebApp Theme Builder), which is developed by Covata and is available as a locally executable npm package.

These color scheme and logo customizations are also utilized throughout:

Newly installed instances of Safe Share are pre-packaged with the Covata default theme. This theme is initially used for all organizations' Safe Share for Web and Organization Administration interfaces, email notifications, as well as the Safe Share Administration interface.

Using the WebApp Theme Builder tool, you can generate different themes - one for each organization - as well as your own default theme (aka the 'system' theme), which is used for:

  • any organization that does not have a theme defined for it,
  • the Safe Share Administration interface and
  • the My Account feature.

Visit the covata-theme-builder page (on the npm web site) for more information about obtaining and using the WebApp Theme Builder tool, as well as deploying themes to a Covata Platform instance.

Note: Other customizable aspects of Safe Share, such as the Application Name, as well as the Company Name and Copyright Notice that appear in email notifications, are configurable through the System details properties section of the Configuration page of Safe Share Administration. However, the Company Name can be customized for each organization (through the Configuration page of Organization Administration).

Themable areas of Safe Share for Web

The following diagrams indicate the themable components of Safe Share for Web's user interface that can be customized using the WebApp Theme Builder tool. These themeable components include images/logos and other properties whose values determine color-usage, each of which is indicated below by its property name in the theme.properties file.

The main Safe Share page

Themable areas of the main application page

Note: The primary-color is also used for 'waiting' / 'processing' animations, which appear for example when a file's view is being downloaded.

Dialog boxes

Themable areas of a dialog box

Themable web-based administration areas

The following diagrams indicate the themable components of Safe Share's web-based administration pages that can be customized using the WebApp Theme Builder tool. These themeable components include images/logos and other properties whose values determine color-usage, each of which is indicated below by its property name in the theme.properties file.

The Organization Administration interface

For a given organization, any of its organization-specific components of the main Safe Share page (illustrated above) that have a specific property value, also affects the equivalent component in this organization's Organization Administration interface. The following diagram shows additional components, which do not have an equivalent in the main Safe Share page/interface, but are also customized using the WebApp Theme Builder tool.

Themable areas of the Organization Administration interface

Other themable Safe Share areas

The following diagrams indicate the themable components of other areas and aspects of Safe Share (i.e. not covered above) that can be customized using the WebApp Theme Builder tool. These themeable components include images/logos and other properties whose values determine color-usage, each of which is indicated below by its property name in the theme.properties file.

Note: Only the logos/images and property values (of the theme.properties file) located inside the system theme's directory are used for the following areas.

The sign-in page

Themable areas of the sign-in page

Email notifications

Themable areas of an email notification

Note: Email notifications are themed according to the Safe Share 'area' to which the notification's content is related.
For example, email notifications about activities conducted through:

  • Safe Share Administration, such as the addition of a Safe Share administrator user account, use the system theme.
  • Organization Administration, such as the removal of a Covata user account from an organization, use the organization's theme. *
  • Activities conducted through any Safe Share application, such as sharing an item with another person, use the theme of the recipient's home/default organization. * This principle also applies to a person who is not yet registered on the Covata Platform (i.e. this person's account is created and added to an organization as a result of them being shared an item by an existing Covata user in that organization).

* If an organization's theme were not defined, then such notifications would instead use the system theme.