Sugar Portal

Overview

The Sugar Portal is used by customers to access and view specific information in your instance or create new records in your instance. The portal allows customers with valid login credentials to access cases , bugs , and knowledge base records, and the ability to update their contact information and manage newsletter subscriptions. Via Admin > Sugar Portal, Administrators can configure the look and feel of the portal and update the layout configurations for the different forms in the portal.

For more information on installing the portal, please review the Portal Installation Guide .

For more information on how a Sugar user can interface with the portal, please review the Portal Deployment User Guide .

For more information on how your customers can interface with the portal, please review the Portal User Guide .

Upload Style Sheet

Upload Stylesheet is used to include a custom stylesheet on all the Sugar Portal pages that modifies the look and feel of the Portal to better match the site where the Portal is embedded. This means that the portal can be used as an iFrame on to your website, instead of customers directly accessing the portal URL.

By default, company logos are not displayed on the Portal (other than the "powered by SugarCRM" logo). This can be modified by CSS. If a CSS file with the following contents is uploaded via the upload stylesheet, the defined logo will appear both in the upper right of every page as well as above the login form. The URL to the logo can be replaced by any image URL.

/* show a logo in the upper right of every page */



body {

background-image: url('http://www.mywebsite.com/company_logo.png');

background-repeat: no-repeat;

background-attachment: fixed;

background-position: right top;

background-size: 200px;

}



/*add a company logo to the login form */



.loginForm {

background-image: url('http://www.mywebsite.com/company_logo.png');

background-repeat: no-repeat;

background-position: center 6px;

background-size: 200px;

padding-top: 25px;

}

A custom CSS style sheet can be uploaded for your portal using the following steps:

  1. Navigate to the Upload Style Sheet menu via Admin > Sugar Portal
  2. Use the file selector to choose a file from your computer which contains the CSS for your portal and click the box to the right of the file chooser when you are complete
  3. You can preview the CSS changes in the preview area at the bottom of the page to ensure your CSS is working properly before syncing your changes to the portal

After your changes are complete, follow the instructions in Sync Portal to push the changes to your portal. Changes to the CSS style sheet are effective only after the synchronization between Sugar Portal and your Sugar instance.

Sync Portal

The portal and your Sugar instance are two separate installations, so changes made in Sugar need to be sent to the portal before they take effect. As an added layer of security, the sync process requires you to re-enter your user name and password to verify you admin rights. To sync the portal, please follow the following steps:

  1. Navigate to the Sync Portal menu of Admin > Sugar Portal
  2. Enter the URL for your portal on the line provided and click "Go"
  3. You will be asked to re-enter your Sugar user name and password, and then click "Begin Sync" to sync your changes to the portal
  4. After the sync completes, you will receive a notice confirming the sync is complete and the changes from Admin > Sugar Portal have been pushed to the portal

Layouts

Sugar Portal Editor allows you to manipulate the edit view , detail view , and list view of the modules customers see in the portal. These layouts are configured with stock fields when the portal is initially enabled, but as additional fields are created in Studio , you may want to add these fields to your portal layouts as they have been added to the Sugar layouts in Studio. The layouts that can be edited for the portal for each module are explained below:

Module Editable Layouts
Bug Tracker

Edit View
Detail View
List View

Cases

Edit View
Detail View
List View

Knowledge Base

Detail View
List View

Leads

Edit View

Note: The leads edit view layout defines the registration form for new portal users

Edit View

The Portal edit view is the view that will be used by customers when creating a case or bug report, or when registering for the portal and thereby creating a lead record in your instance. The editor allows you to drag and drop fields into the layout to add or rearrange the page. Fields can be removed from the layout by dragging and dropping them on the recycling bin icon. After the layout is set up the way you would like for it to be accessed by customers, click "Save & Deploy" which will prepare the changes to be synced to the portal. After clicking "Save & Deploy" you will have to sync the portal to push the changes to the portal for your customers. If you would like to save your work, but not prepare the changes for sync, simply click "Save". For more information on editing the edit view layout, review the Studio section of this documentation.

Detail View

The Portal detail view is the view that will be used by customers when viewing a case, bug, or Knowledge Base article. The editor allows you to drag and drop fields into the layout to add or rearrange the page. Fields can be removed from the layout by dragging and dropping them on the recycling bin icon. After the layout is set up the way you would like for it to be accessed by customers, click "Save & Deploy" which will prepare the changes to be synced to the portal. After clicking "Save & Deploy" you will have to sync the portal to push the changes to the portal for your customers. If you would like to save your work, but not prepare the changes for sync, simply click "Save". For more information on editing the detail view layout, review the Studio section of this documentation.

List View

The Portal list view is the view that will be used by customers when viewing the list of all bugs, cases, or Knowledge Base articles. The editor allows you to drag and drop fields into the layout’s "Default" column and rearrange their order. Fields can be removed from the layout by dragging and dropping them to the "Hidden" column . After the layout is set up the way you would like for it to be accessed by customers, click "Save & Deploy" which will prepare the changes to be synced to the portal. After clicking "Save & Deploy" you will have to sync the portal to push the changes to the portal for your customers. For more information on editing the list view layout, review the Studio section of this documentation.

Note: Clicking the pencil to the right of any field will allow you to edit the name of the field as it shows on the portal and also the percentage of the list view layout that you would like to take the field to take.