You are currently reviewing an older revision of this page.

Sugar 11.0 (Q2 2021) Customization Guide

Purpose

The purpose of this document is to provide insight to Sugar Developers for upgrading custom Sugar code, extensions, and integrations to the Sugar 11.0 (Q2 2021) release. This guide focuses on changes in Sugar 11.0 (Q2 2021) that could cause an immediate impact on Sugar customizations and integrations built for Sugar 10.3 (Q1 2021).

Sugar Instance Upgrade Path

The upgrade path for 11.0.0-preview.1 and 11.0.0-preview.2 (this "Preview") is from 10.3 (Q1 '21). There will be no upgrade path from 11.0.0-preview.1 and 11.0.0-preview.2 to the GA version of the Sugar Q2 2021 releases.

Cloud and On-Premise Sugar Release

For those looking to upgrade from Sugar 10.0, you will be catching up with additional content released last Q3 '20, Q4 '20< and Q1 '21. In addition to this guide, please review the Sugar 10.1, Sugar 10.2, and Sugar 10.3 migration guides and Sugar 10.1, Sugar 10.2, and Sugar 10.3 release notes on the Sugar Support site to get a full view of changes since Sugar 10.0. This is not an exhaustive list of everything we did for Sugar 11.0 - just the items that we thought would be important for a developer to take note of. Check this post often as I will be adding more features, fixes, and updates to the list right up until we go live with the GA release!

Expected to Affect Few Developers

This section explains items expected to have a low impact on Sugar customizations and integrations when migrated to Sugar 11.0. It is expected that these items will affect few developers. This release addressed many smaller bug fixes and UI changes. There are not many issues that require special attention from a development standpoint. You may want to take note of the following regarding your customizations before you upgrade:

  • The /Administration/license/limits GET API endpoint has been updated to additionally return the license type, the number of available seats by license type, and a license limit flag. It is still the case that only admin users may call this endpoint.

  • Application now enforces Content Security Policies that block embedding content from untrusted domains.

  • This will mostly affect iFrames. If you have any iFrames with external content in your Sugar instance, you will need to add those domains to the Content Security Policy Settings Admin module. If you do not whitelist the domains, the iFrame will display an error message. Visit this article for more information on CSP. Note all images are trusted so you may still embed images from other sites - just not scripts, iframes, etc.

  • When you add a new CSP setting or update it, settings will take effect immediately on the admin’s machine. Other users will be prompted with an informational message to reload their page to see changes.

  • Module Loader has been updated to accept a CSP whitelist. The syntax is 'csp' => ['default-src' => '*.mashable.com']. In that example we are telling our instance of Sugar to accept all content from mashable.com.

  • In activity stream comments, embedded videos and rich html created by including a link to a URL will not be supported. Image previews will still appear

  • Added new /Administration/settings/validateIPAddress GET endpoint that will return the "Validate IP Address" configuration parameter value.

  • Added new /Dashboards/<id>/restore-tab-metadata?dashboard={$dashboard}&tab_index={$tabIndex}&dashboard_module={$dashboardModule} PUT endpoint. The purpose of this endpoint is to restore metadata for a specific tab on a tabbed dashboard.

  • Added new /SugarLive/config POST endpoint to save the config settings for SugarLive module.

  • For Sugar 11.0, the supported DB2 version is 11.5. Previously supported version was 11.1

  • In all of Sugar’s sidecar modules, we've re-labeled the "Create" label on filters to "Build Filter". If they have already customized the label to be something other than "Create", the customization will be respected.

  • We've removed mkto_lead_score & mkto_sync from SugarBPM prohibited list so that customers can use it with the new Marketo Sugar Integrate based integration

  • Wherever you can add field evaluations in SugarBPM, multi-select fields have a new option "Does Not Include Any" in addition to the existing options "is, is not, changes, changes from, changes to, and is one of"

  • "Teams" field is now a multi-select (previously single-select/radio) when setting BPM criteria, and evaluations now allow "Includes Any" and "Does Not Include Any" in addition to the existing options "is” and “is not”

  • We've combined the 2 separate discount fields to 1 field set for QLIs

  • On the quote worksheet, we've re-labeled "Line Item:" (for QLIs) to instead read "Product" because we missed it in 10.2 when we changed the QLI labels in other places.

  • The prediction pipeline will refresh lead and opportunity scores for SugarPredict fields periodically (initially every 24 hours but more frequently over time).

  • The Email Templates module has been converted from BWC to Sidecar
  • "Cases" has been added to the list of modules that you can pull vars from in Email Templates (not previously available)
  • TinyMCE was updated in the following places :
    • Compose Email Templates
    • Compose Email
    • Compose Archived Email
    • Create Email Signature
    • Knowledge Base Articles
    • Knowledge Base Templates
    • Process Email Templates Design View
  • Record View Dashboards will have new out-of-the-box default Record View Dashlets that are more appropriate given the number of features we have added to Core Sugar over the years
    • For modules with already defined Record View dashboards and their respective dashlets, we do nothing.
    • For modules with no defined or undeleted Record View dashboards and their respective dashlets, we will show default ones.
  • All EMPTY dashboards (home pages, intelligence panes) now show a message "No Dashboard Configured" and the placeholder images with button to create a dashboard
  • Updates to visibility of Product Catalog for various users that don't have access to Quotes
    • For users with no Access to the Opportunity, the Product Catalog dashlet will not be shown on the Record View side-panel.
    • For users with no Quotes access, the Quick Picks dashlet will not be shown on the Record View side-panel.
    • And lastly, for users with no Product Catalog access, show outlines of Product Related dashlets with the no access message in the dashlet box.
  • Prior to 11.0, extension files were read by date-modified, potentially causing the files to load in an unintended order when migrating environments. To resolve this issue, a new orderMapping.php Extension file has been added as of 11.0 to preserve the order based on the real modification dates even when the instance files are moved. Example orderMapFile:

    <?php
$extensionOrderMap = array (
  'Ext/LogicHooks/pmse.php' => 
  array (
    'md5' => 'ww5k551fgzve14b7abc123456xxx3214',
    'mtime' => 1610370805, // mtime timestamp that the file had during the last Extension rebuild
    'is_override' => false,
  ),
  'Ext/LogicHooks/SugarMetricHooks.php' => 
  array (
    'md5' => 'abc12360l213pbf0fsfjfv456xxx3214',
    'mtime' => 1610370805,
    'is_override' => false,
  ),
  'Ext/LogicHooks/activitystream.php' => 
  array (
    'md5' => 'abc123456xx899an3uctfidln1nx3214',
    'mtime' => 1610370805,
    'is_override' => false,
  ),
  'Ext/LogicHooks/sugarconnect.php' => 
  array (
    'md5' => '3ynyjkqooja986oxabc123456xxx3214',
    'mtime' => 1610370805,
    'is_override' => false,
  ),
  'Ext/LogicHooks/fts.php' => 
  array (
    'md5' => 'abc123456xxx3214z2eiqnlf80vezkfg',
    'mtime' => 1610370805,
    'is_override' => false,
  ),
);