Upsert® Themes

Prerequisites

System requirements for installation

Supported Versions

• 12.x

Supported Editions

• Sell
• Serve
• Enterprise
• Professional

Supported Databases

• MySQL
• MSSQL
• Oracle
• DB2

Supported Languages

• English

Overview

Upsert^® Themes is a theme management tool that provides the ability to customize the default colors of Sugar’s navigation bar, primary buttons, hyperlinks, and border color.

Upsert^® Themes is available to all administrative users.

Installation

Once you complete your order for the Upsert^® Themes plug-in, you should receive an email with instructions to download the necessary file. Complete these steps to install the plug-in to your Sugar instance:

1. Log in to your Sugar instance as an admin user
2. Go to Admin > Module Loader
3. Select the Upsert^® Themes ZIP file and click ‘Upload’
4. Click the ‘Install’ button
5. Review the license agreement, toggle the option to ‘Accept’, and click ‘Commit’

Once the installation completes, proceed to the ‘Configuration’ section.

Configuration

Once Upsert^® Themes is installed, you will need to enter your license key to enable functionality on the Configurations page.

Configuring the License

Enable the functionality of the plugin via the following steps:

1. Go to Admin > Upsert^® Themes > Configuration Settings

2. Enter the subscription key that you received via email from your initial purchase

   Note: If you installed and configured other Upsert^® plug-ins, the license key will prepopulate into this screen and not require re-entry

3. Click ‘Save’

Validating the License

If access to the Upsert^® Themes functionality is interrupted, you can manually validate your license with the following steps:

1. Go to Admin > Upsert^® Themes > Configuration Settings

2. In the right pane, click ‘Validate License’

3. If successful, the status will be updated to ‘Enabled’ and the service start and end dates will be populated.

If unsuccessful, there will be a message indicating the reason for the failure with further instructions. **Note: **The server hosting your Sugar instance must be able to reach https://upsertconsulting.com to validate your license successfully.

Status

In order to utilize the Upsert^® Themes functionality, confirm that the ‘Status’ field is set to ‘Enabled’.

Utilization

Administrative users access Upsert^® Themes for creating, updating, and deleting themes by navigating to Admin > Upsert^® Themes > Themes.

Non-administrative users will be able to access Upsert^® Themes for viewing purposes only from their navigation bar by clicking the ‘Themes’ tab.

Creating Themes

1. Click ‘Create’ on the Themes module page.

2. Complete the fields for the theme:

   1. URL: The URL in which the theme will be applied. \ **Note: **The URL field will strip away any leading ‘http://’ , ‘https://’, or ‘www’ when the record is saved. The URL field will also convert all the alphabetic characters to lowercase when the record is saved.
   2. Platform: The platform of the sugar instance.
   3. Watermark: The characters that will be displayed as a watermark on the page.

   4. Watermark Placement: The area of the screen where the watermark will be positioned. The placement options are as follows:

      1. Bottom: Along the bottom of the page starting from the left-hand side of the page.
      2. Left: Along the left-hand side of the page starting from the top of the page.
      3. Right: Along the right-hand side of the page starting from the bottom of the page.

      **Note: **This field will only be visible if the Watermark field is populated.

   5. Border Color: The color of the loading bar under the MegaMenu while the page is loading.

   6. Navigation Bar: The background color of the MegaMenu.
   7. Primary Button: The background color of the primary button.
   8. Link Color: The text color of links and the border color of fields in focus.

When clicking on the Border Color, Navigation Bar, Primary Button, or Link Color fields, a color picker will display for assistance in selecting a color.

If you already know the hexadecimal color value of the color you would like to use, you may enter that value in the field. Otherwise, you may use the sliders in the color picker to select a color. A preview of the color will be displayed under the color picker.

After selecting a color, its hexadecimal color value will be populated in the field and the color preview box to the right of the field will display the selected color.

Applying Custom Themes

For a theme to be applied to the user’s Sugar instance, a few criteria must be met:

1. The plug-in must be enabled in the Configuration Settings
2. The URL field must exactly match the URL of the Sugar instance
3. The platform field must match the platform of the Sugar instance
4. If the previous criteria are met, the theme will be applied to the instance upon clicking ‘Save’
5. Once saved, the theme will be displayed to all users with access to the instance \ **Note: **Themes will only be displayed to users viewing Sugar in ‘Light’ mode

Restoring the Default Theme

In the event that you would like the restore the Sugar instance back to the original theme:

1. On the record view of the theme click ‘Edit’
2. Click ‘Restore Default Values’ in the edit view

Clicking the button will populate the Border Color, Navigation Bar, Primary Button, and Link Color fields with their default values \

**Note: **The Watermark and Watermark placement fields will not be updated by clicking ‘Restore Default Values’. Please manually edit these values as desired.

3. Click ‘Save’ to finalize your changes

Temporarily Restore the Default Theme

If an issue arises where you would like to stop the custom theme from being displayed but would like to reapply the theme at a later time (i.e. upgrading Sugar version, troubleshooting issues) you can disable the theme in the plugin’s Configuration Settings.

Upon clicking ‘Save’ the custom theme will be disabled and the instance will be restored to the default theme. Unlike using the ‘Restore Default Values’ button in the record view of the theme, once the plugin is disabled any watermark present in the custom theme will not be displayed.

To reapply the custom theme, change the ‘Status’ to ‘Enabled’, click ‘Save’, and the custom theme will be re-applied to the instance.

Uninstalling the Plug-In

Follow the steps below to remove the plug-in from your Sugar instance.

1. Log in to your Sugar instance as an admin user
2. Go to Admin > Studio
3. Go to Admin > Module Loader
4. Locate the ‘Upsert^® themes for SugarCRM’ package in the list of installed packages and click ‘Uninstall’
5. Select the desired option for handling the related database tables:
   1. Do Not Remove Tables - You either want to upgrade the plug-in to a newer release or you want to retain the Themes audit log data.
   2. Remove Tables - You want all data associated with the plug-in to be deleted and you have no intention of upgrading.
6. Click ‘Next’

The uninstall will process and provide confirmation upon successful completion.