SugarCRM SupportDocumentationSugar Versions8.28.2 UltimateSugar Ultimate 8.2 Administration GuideDeveloper ToolsSugar Portal
This release is only available for Sugar cloud customers.

Sugar Portal


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. Administrators can configure portal settings, the look and feel of the theme, and the layout configurations via Admin > Sugar Portal.

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.

Configure Portal

Multiple settings for the portal can be edited in the Configure Portal menu in the Sugar Portal section of Admin menu. This is the first place to look when initially enabling and setting up your portal. This menu includes the following options:

Field name Description
Configure Portal

Select the "Enable" checkbox to have the portal enabled for customers. After enabling the portal and clicking "Save" at the bottom of the page, the portal URL will appear under the Enable checkbox. This is the URL where the portal for your instance can be accessed.

Logo URL

Add a URL to an image or logo to this field so that your company logo will show on the login page of the portal.

Note: The image must have a publicly accessible URL and cannot be uploaded from your local machine. The recommended size of the image is 163 × 18 pixels.

Number of records to display on list

Enter the number of how many records will show when viewing a dashlet or list view in the portal. The default number of records is 20.

Note: This value must be no greater than 100.

Default assigned for new portal registrations When a user tries to register for the portal and creates a lead in Sugar, this designation defines the user assigned to the lead.

Enabling Sugar Portal automatically creates a Customer Self-Service Portal Role and a portal API user called "Sugar Customer Support Portal" which can be viewed in the Roles and Users modules, respectively. You can use Access controls within the role to enable and/or disable the Bugs, Cases, or Knowledge Base modules for the Sugar portal. The Sugar Customer Support Portal user is used to authenticate customer requests to the portal. Please do not modify any other Access controls or the field level permissions for this role to avoid unknown and unpredictable system behavior.

Note: If the Customer Self-Service Portal Role or Sugar Customer Support Portal user are accidentally deleted, please disable and re-enable the Sugar Portal to recreate the role and user.

After the Configure Portal's save button, there may be a section of text showing a list of any modules that are currently disabled in Display Modules and Subpanels.

If a module is disabled, it will not appear in the Sugar Portal. The modules that will show here are Cases, Bugs, and Knowledge Base.

Theme Portal

Sugar Portal Editor allows you change the colors of the navigation bar, the line under the navigation bar, and the main button in each Sugar Portal page to match your company's color scheme.

The theme menu allows you to configure the following elements on the portal page:

  • Border Color : The line separating the Navigation Bar and the rest of the page.
  • Navigation Bar : The bar at the top of the screen that includes module tabs and the search bar.
  • Primary Button : The button on the page that contains the primary function, usually Save or Edit.

To change the color of one of the elements, click the text box to the right of the current color to drop down a color palette editor. Use the vertical slider on the right to select the color group, and then the shade from the main window in the center. The selected color is shown on the bottom horizontal bar. Click anywhere on the page to confirm your color for the given element.

Note: If you know the HTML hexadecimal code for your company's colors, you can manually enter this in the text box.

After selecting your colors, a preview will show on the right of the screen as to how the elements will appear in the portal. After confirming the proper colors, click "Save and Deploy" to push the changes to your portal.

If you are editing the colors and do not like your changes, click "Reset" to return to your most recently saved color options. You can also click "Restore Default Theme" to return to the Sugar stock colors (border - red, navigation bar - black, primary button - blue).


Sugar Portal Editor allows you to manipulate the record 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 them to the portal layouts to mimic other Sugar layouts in Studio.

Record View

The Portal record view will be seen by customers when creating or viewing a case or bug report and when viewing or editing contact information under their user profile.

Note: The Contacts layouts define the portal user's profile layouts.

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 onto the recycling bin icon. After the layout is configured the way you want customers to see it, click "Save & Deploy" to push the changes to the portal. If you would like to save your work, but not deploy the changes, simply click "Save". For more information on editing the record view layout, please refer to the Studio documentation. 

List View

The Portal list view will be seen 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 the order of them. 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 customers to access it, click "Save & Deploy" which will push the changes to the portal. For more information on editing the list view layout, please refer to the Studio 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.

Last modified: 2018-08-08 21:56:36