SugarCRM SupportProduct GuidesSugar Versions9.29.2 EnterpriseSugar Enterprise 9.2 Administration GuideDeveloper ToolsSugar Portal
This release is only available for SugarCloud customers.

Sugar Portal

Overview

The Sugar Portal is a powerful tool that allows Sugar users to interact with customers and share information related to multiple modules (Bugs, Cases, Knowledge Base). The portal allows customers to log in and review information directly from your Sugar instance and perform actions such as submitting cases and bugs, communicating with your employees regarding the cases and bugs, as well as reviewing knowledge base articles. Please note that in order to enable the portal for your instance, the Enable Portal option must be enabled via Admin > Sugar Portal. This will enable a Portal API User in Admin > User Management which must be left enabled in order for portal users to authenticate. This documentation covers the basics on how to configure the various portal settings, the look and feel of the portal, as well as configure the layout for the available modules (e.g. Cases, Bugs) in the portal.

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

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

Note: The Cases and Bugs modules are not available for Sugar Sell users. For more information on license types and the functionality available for each, refer to the User Management documentation. 

Configure Portal

The Configure Portal page allows administrators to enable the portal as well as configure different aspects of the portal interface such as enabling/disabling modules, defining the number of records to display per list view results set, etc. For more information on how these settings are applied in the portal, refer to the Portal User Guide.

SugarPortal ConfigurePortal2

The following settings are available to configure when setting up your portal:

Field Description
Enable portal

Enable the checkbox to have the portal enabled for customers. After enabling the portal and clicking "Save", the portal URL will appear under the checkbox which is where you can access the portal for your instance.

Number of records to display on list

Enter the maximum number of records to display per list view results set in the portal. By default, this is set to 20 records per results set.
Note: This value must be no greater than 100.

Default assigned for new portal registrations

Select the Sugar user that will be assigned to the contact records created from the portal registrations.

Portal Modules

Select which modules will appear in the portal's navigation bar by dragging and dropping the module between the Displayed Modules and Hidden Modules column. You can also designate the order of the modules displayed in the navigation bar by selecting the module in the Displayed Modules column and moving it up or down. 
Note: If you wish to completely remove access to the module from the portal, then you will need to disable access to the module via Admin > Role Management for the Customer Self-Service Portal Role. For more information on roles, refer to the Role Management documentation. 

Logomark URL

Enter the URL to a custom logomark image that you wish to display on the navigation bar at the top of the portal.  
Note: The image must have a publicly accessible URL and cannot be uploaded from your local machine. The recommended logomark dimensions are 22 x 22 pixels. Any image that is larger in either direction will be scaled down to these dimensions.  

Logomark Preview

Displays a preview of the custom logomark image. 

Logo URL

Enter the URL to a custom logo image that will appear on the login page of the portal. If no logo image is added, then the logomark image will be used instead.  
Note: The Logomark URL field must be completed first before you can enter in the Logo URL. The image must have a publicly accessible URL and cannot be uploaded from your local machine. The recommended logo width is 200 pixels. Any image that is larger in either direction will be scaled down to these dimensions.

Logo Preview  Displays a preview of the custom logo image.  
Portal Contact Information

Enter the company's contact information (i.e. phone, email, URL) that will be available to portal users requiring additional assistance logging into their account. This information can be accessed by clicking the Forgot Username link on the Forgot Password screen or clicking the "Did not get an email?" link after the portal user submits their username to initiate their password reset.
Note: At least one field must be configured in order for the contact option to be available in the portal. 

Please note that enabling the Sugar portal will create a Customer Self-Service Portal Role and enable a Portal API user in Admin > User Management which must be left enabled in order for portal users to authenticate. The information viewable in the portal can be updated and restricted by Sugar users as allowed by team membership, user access type, and assigned roles. For more information on teams and roles, please refer to the Team Management and Role Management documentation in the Administration guide.

Please do not delete the Customer Self-Service Portal Role or the Portal API user as they are system-generated based on portal activation. If the portal role or user is accidentally deleted, then please disable and re-enable the Sugar Portal to recreate them.

Note: Hiding a module (e.g. Knowledge Base) via Admin > Display Modules and Subpanels will not remove the module from the portal. You will need to disable access to the module via Admin > Role Management for the Customer Self-Service Portal Role in order to remove it from the portal. For more information on roles, refer to the Role Management documentation. 

Theme Portal

The Sugar Portal Editor allows you to change the colors of the navigation bar, the line beneath the navigation bar, as well as the buttons/links in the Sugar portal to match your company's color scheme. 

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

  • Border Color : The border line beneath the navigation bar.
  • Navigation Bar : The navigation bar at the top of the portal screen consisting of the module tabs and logomark.
  • Primary Button : The buttons (e.g. Create, Save) on the portal page such as "Create"/"Save", as well as the links.

To change the color of one of the elements, click the text box to the right of the current color which will display a color picker tool. Use the slider in the color spectrum bar on the right to select the color group, and then choose the desired shade from the color chart on the left. The selected color will be shown below in the horizontal bar. Click anywhere on the Configure Portal Theme page to confirm your chosen color for the given element.
SugarPortal ConfigurePortalTheme

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

Once you have selected your color, the preview pane to the right will display how the elements will appear in the portal. Once you have chosen your desired theme colors, click "Save & Deploy" to push the changes to your portal.

If you do not like the color changes being made while editing, you can simply click the Reset button to return to your most recently saved color options. You can also click the Restore Default Theme button if you wish to restore the theme back to the default out-of-the-box colors.

Layouts

The Sugar Portal Editor also allows you to configure the record view and list view layouts for the Cases, Bugs, and Knowledge Base modules in the portal. You can also configure the Contacts record view layout to control what fields to display in the portal user's profile. Please note that both stock and custom fields that appear in Admin > Studio are available to add to the portal layouts.

Record View

The portal record view displays key record information including all relevant fields for the module (e.g. Knowledge Base) and the user's profile. The editor allows you to add a field to the Record View layout by dragging the field from the list of fields in the Toolbox to a "(filler)" location on the layout per your preference. You can also change the location of existing fields in the layout by dragging and dropping the field to a different location on the layout. To remove a field from the layout, simply drag and drop the field(s) from the layout to the trash bin in the Toolbox. Please note that changes to the Record View layout will also affect what fields appear when a portal user previews a record (e.g. knowledge base) in the portal. Once the layout is finalized, click "Save & Deploy" to preserve your changes and deploy it to the portal. You can also click "Save" if you wish to preserve the changes but not deploy the changes to the portal. For more information on editing the record view layout, refer to the Studio documentation. 
SugarPortalEditor RVLayout

List View

The portal list view displays all records that meet the current search criteria in the Cases, Bugs, and/or Knowledge Base modules that the portal users can access. The editor allows you to drag and drop fields between the Default, Available, and Hidden columns as follows: 

  • Default : Drag fields into the Default column to display them in the default List View layout. To change the left-to-right order of the fields displayed on the list view (or right-to-left for users viewing an RTL language), drag and drop the fields up or down within the Default list. 
  • Available : Drag fields into the Available column to make them available for portal users to personalize their view of the list view layout without making them part of the default layout. Portal users will be able to click the Column Selection icon to the far right of the list view column headers to see the list of available fields.
  • Hidden : Drag fields into the Hidden column to hide them from portal users in the module's list view. 

You can also modify the label and width for a field by clicking the Pencil icon to the right of each field and entering the new field label and selecting the width (e.g. small, medium) of the field column in the list view.

Once the list view layout is finalized, click "Save & Deploy" to preserve your changes and deploy it to the portal. For more information on editing the list view layout, refer to the Studio documentation.
SugarPortalEditor LVLayout

Last modified: 2019-10-04 22:44:36