Changing the look and feel of the Pro client in Elvis 5

The look and feel of the Pro client can be changed to match the style of the brand that the Pro client is used for, for example by matching it with the branding of a company, product or publication.

The following can be adjusted:

• The background image of the Sign In page
• The logo in the header
• The color of the header
• The highlight color (used for buttons, selections and various other small page items)
• The metadata icons
• The 'favicon' shown in a Web browser
• The 'Feedback' and 'Help' links
• Creating custom e-mail notifications for Shared Links

Figure: The default background image of the Sign In page.

Figure: A custom background image on a customized Sign In page.

Figure: The default Branding settings.

Figure: The Branding settings adjusted to match the WoodWing brand.

Changing the background of the Sign In page

Info: This feature requires Elvis 5.21 or higher.

Since Elvis 5.21, a background image is shown on the Sign In page. If needed, it can be replaced by a custom image.

The default image is stored in the following location:

<Elvis config>/plugins/active/internal/elvis_client/logos/background.jpg

Using a custom image

To use a custom image, replace the existing image by another image that is also named 'background.jpg'.

Tip: To create a background with an even color, create an image containing a single pixel of a certain color.

Changing the logo and colors

Changing the logo and colors is done through the Management console.

Note: Any changes made apply to the Pro client as well as the Brand portal.

Step 1. Access the Management Console by clicking your Avatar and choosing Management console from the menu.

Step 2. From the menu on the left of the page, choose Branding.

Step 3. Make your changes and click Apply.

Changing the metadata icons

When the user's attention needs to be drawn to specific metadata, an icon (also referred to as a 'flag') can be added as a visual indicator (a process also known as 'flagging').

Example: You may want to visually display a status or indicate that a field contains specific information such as copyright info.

Such icons appear for thumbnails in the search results and can be set for any standard metadata field or custom metadata field.

Figure: Assets in the Pro client showing icons for the Status, Approval and Copyright fields.

A default set of icons is shipped with Elvis Server and can be replaced or expanded.

For more information, see Highlighting metadata in Elvis 5 by using icons.

Changing the favicon

Info: This feature requires Elvis 5.21 or higher.

A favicon is an icon that is shown in various locations in a Web browser such as in tabs and for bookmarks.

Figure: The default favicon for Elvis.

The default icon can be changed to a custom icon by replacing the following image on Elvis Server:

<Elvis config>/plugins/active/internal/elvis_client/logos/favicon.ico

Customizing the 'Feedback' and 'Help' links

Info: This feature requires Elvis 5.22 or higher.

The 'Feedback' and 'Help' commands in the Avatar menu allow users to access the WoodWing Help Center to look up product documentation or to provide feedback about Elvis to WoodWing.

Figure: The Feedback and Help commands in the Avatar menu.

Note: In Elvis 5.21 and older as well as in all versions of the Management console, these options are shown in the header of the page, not in the Avatar menu.

By default, the following links are used:

• Feedback is linked to the Elvis 5 community using URL https://helpcenter.woodwing.com/hc/en-us/community/topics/200046016.

• Help is linked to one of the following articles, depending on which area of the Pro client is accessed:

• When the Checked-out files page is accessed, it links to Opening files for editing (file check-out and check-in) using the Pro Client of Elvis 5 using URL https://helpcenter.woodwing.com/hc/articles/206216445.

• When the Shared Links page is accessed, it links to Sharing files with others using the Pro Client of Elvis 5 using URL https://helpcenter.woodwing.com/hc/articles/205272229.

• When any other area is accessed, it links to the main Elvis 5 documentation page using URL https://helpcenter.woodwing.com/hc/categories/200142445.

The Feedback and Help options can be customized in the following ways:

Note: This only applies to the Pro client, not the Management console.

• The URL can be changed to a custom URL
• The option can be removed from the menu

Step 1. Access the cluster-config.properties.txt file on one of the Elvis nodes. See Changing the Elvis 5 Server configuration for a running cluster.

Step 2. Locate or add any of the following options and add a custom URL or leave it blank to remove the option from the Pro client:

• For the Feedback option:

elvisFeedbackUrl=

• For the Help option:

elvisGeneralDocumentationUrl=

elvisSharelinkDocumentationUrl=

elvisEditingDocumentationUrl=

elvisFeedbackUrl=
elvisGeneralDocumentationUrl=https://www.mydocumentation.com
elvisSharelinkDocumentationUrl=https://www.mydocumentation.com
elvisEditingDocumentationUrl=https://www.mydocumentation.com

Step 3. Save the file.

Creating custom e-mail notifications for Shared Links

When users upload files to a Shared link or apply an approval review on the Shared link, the user that sent out the link may receive an e-mail to be notified about this.

To modify the content of the notification e-mails, add the following options to the language file and set the desired content in the web bundle:

email.Approval.email_subject=Elvis: {0} - approval complete

email.Approval.email_body=The recipient of your shared link has finished approving or rejecting files:\n\n{0}\n\nView shared link: {1}

email.Import.email_subject=Elvis: {0} - {1} files uploaded

email.Import.email_body={0} files were uploaded to the following shared link:\n\n{1}\n\nView shared link: {2}

For more information about language files, see Managing languages in Elvis 5.

Document history

• 23 November 2018: Added section 'Creating custom e-mail notifications for Shared Links'.
• 2 October 2018: Added section 'Changing the metadata icons'.