SugarCRM SupportKnowledge BaseStudio and Module Builder

Studio and Module Builder

The Studio and Module Builder section includes topics covering creating, modifying, and troubleshooting custom fields, relationships, dropdown lists, and modules via Sugar's Studio and Module Builder tools.


  • Best Practices When Building Custom Modules

    Sugar provides two tools for building and maintaining custom module configurations: Module Builder and Studio. As an administrator of Sugar, it is important to understand the strengths of both tools so that you have a sound development process as you look to build on Sugar's framework.

  • Adding a Blank (NULL) Value as the First Value of a Dropdown List

    Sugar® allows you to add a blank (NULL) value as the first field of a dropdown list via Studio and the Dropdown Editor. The blank value should be the first item of the list so that when the dropdown list is used for a required field, the user will be forced to make a selection rather than allowing the field default to a non-null value. This article will cover how to add a blank (NULL) value to a dropdown list via Studio and the Dropdown Editor.

  • Adding a Field to Mass Update

    Mass updating in Sugar® allows users to easily update multiple records at one time from the module's list view. Out of the box, there are a number of stock fields that are enabled for mass update. However, there may be occasions when you need to enable this option for other fields in Sugar. This article will cover how to enable fields and relationship fields for mass update Some fields can be enabled via Admin > Studio while others will require code-level customization.

  • Adding a Google Map to a Module

    Sugar has the capability to generate webpage images such as Google maps for users to view the location of their clients. Administrators in Sugar can add an IFrame field via Admin > Studio in order to generate the Google map based on the client's address on record. Google maps can be added to any module (Custom and Stock) that has an address type field in it.

  • Adding Custom Modules to Lead Conversion

    Sugar enables you to convert leads into contacts, opportunities, and accounts after you have evaluated and qualified them. The Convert Lead page allows you to convert a lead to a contact, with the option to create an account and opportunity as well as activities. Additionally, you can add any custom modules that have been installed or created to the lead conversion page.

  • Adding Fields to a Module's Change Log

    Sugar's change log allows users to view the history of changes made to audited fields. The change log is available via the module's record view (for Sidecar modules) or detail view (for Legacy modules). Fields must be marked as "Audit" in Admin > Studio in order to have changes tracked in the change log. In addition, beginning with version 7.0.0, fields marked as "Audit" will also generate update posts in the activity stream for Sidecar modules (e.g. Accounts and Contacts) whenever the field gets updated in a record. This article will cover how to mark a field for "Audit" in Studio to add it to a module's change log.

  • Changing a Dropdown Option's Database Name

    While utilizing Sugar®, there may be occasions where you may need to change an existing list item in your dropdown list. For example, you might need to alter the dropdown options available when setting an account's type. There are two components to dropdown list items, the item name and the display label. The display label is what Sugar displays in the application and can be edited any time via Admin > Dropdown Editor. The item name is what Sugar stores in the database and cannot be edited after creation.

  • Changing the Default Direction for 'Schedule Call'

    When scheduling a call, the Direction field defaults to "Inbound". If your organization primarily performs outbound calls, this article explains how to change the default value of the Direction field.

  • Converting a DropDown Field to a TextField

    As part of configuring Sugar® to match your business process, you may initially create various dropdown fields. As time goes by, you may need to add more values to your dropdown lists to keep up with the growth and change in your business. Before you know it, a dropdown field may not seem like the best solution as you need more customizable and general values. To better suit your needs, you may decide to convert this dropdown field into a text field. This article covers how to move an existing dropdown field's value to a new text field using Sugar's import tool.

  • Converting a Multiselect Field to a Dropdown Field

    Both multiselect and dropdown fields allow users to select from a list of options when editing the field. The field types differ, however, in that multiselect fields allow multiple options to be set while dropdowns only allow for one. There may be occasions where you wish to convert an existing multiselect field to a dropdown field to better suit your business needs. This article covers how to convert an existing multiselect field to a dropdown field in Sugar.

  • Copying Fields Automatically in Lead Conversion

    The Leads module is often used to track less-developed relationships with individuals, often in conjunction with a qualification process that results in leads being converted to accounts, contacts, opportunities, etc. While Sugar automatically carries over most stock lead fields, you need to take additional steps for conversion to carry over any custom fields you have added to the leads module. This article covers how to make additional fields copy over to related modules (e.g. Accounts, Contacts, and Opportunities) during lead conversion.

  • Creating a Custom Module With Module Builder

    From time to time the modules offered out of the box don't fully encompass your needs, and it may be time to explore building a custom module

  • Creating Dependent Dropdown Lists

    Dropdown fields in Sugar® are fields where users can choose a value from a list of values when creating or editing records. A dependent dropdown field is essentially the same except that the list of values is dynamic and dependent on a parent dropdown. Dependent dropdowns usually represent category and sub-category scenarios. The first, parent dropdown's value controls which options are available to choose in the second, dependent dropdown. This article covers how to create a dependent dropdown field and configure the options that appear for each value of the parent dropdown.

  • Creating a Dropdown Field

    Use dropdown fields to provide a predefined list of values that your users will need to select from when creating or editing records.

  • Creating a Flex Relate Field

    Linking various pieces of information together is a vital function of CRM. Sugar provides three different ways you can create connections between modules: relationships, relate fields, and flex relate fields.

  • Creating a Relate Field

    Linking various pieces of information together is a vital function of CRM. Sugar provides three different ways you can create connections between modules: relationships, relate fields, and flex relate fields. This article explains how to create a relate field in Sugar. For more information about each of these three types of connections, including a thorough description of relate fields, please refer to the article Introduction to Relationships and Relate Fields.

  • Creating a Relationship

    Linking various pieces of information together is a vital function of CRM. Sugar provides three different ways you can create connections between modules: relationships, relate fields, and flex relate fields.

  • Creating Role-Based Dropdown Lists

    Role-based dropdown lists enable administrators to control the dropdown options that are available for users to select when creating or editing records. The options users should be able to select may vary among users depending on their function in the organization. For example, users associated with the marketing or sales roles may see more sales-related dropdown values than users in a customer support role. This article covers how to create a role-based dropdown list and modify the list of options available for users to select based on their assigned role.

  • Creating Role-Based Record Views

    Role-based views provide a way for administrators to set unique layouts for users depending on their role. In organizations of all sizes, employees may need to view and modify different data in a single Sugar record. With role-based views, managers can see a different record view layout than their direct reports while marketing and salespeople can see more sales-related fields than users in a customer support role.

  • Editing a Module's Dashlet in Sugar 6

    Sugar® dashlets allow users to get a quick view of assigned records, activities, reports etc. directly on their home page. Sugar administrators have the ability to easily edit each dashlet's filter and display layouts using Studio. Every user is also able to configure their dashlets based on personal preference from their home page. For more information on configuring dashlets on the home page, please refer to the Home documentation.

  • Editing a Module's Dashlet in Sugar 7

    Sugar® dashlets let users get a quick view of various records, activities, reports, etc. from their home pages or intelligence panes. Every user in Sugar can easily customize their dashlets to meet their individual needs. List view dashlets are a type of dashlet which displays tables of records. When configuring these dashlets, users can choose the column fields the dashlet will display as well as build filters controlling which records will show.

  • Editing a Module's Labels

    As a Sugar administrator, you can easily alter the displayed label for a module or for any field within a module to better match your business needs and vocabulary.

  • Editing a Module's Layouts

    Sugar® offers administrators and users a wide range of configuration, and one of the most common changes administrators will perform is editing the various layouts in Studio to suit their organization's needs and processes. For more information regarding the various layouts and how to edit them, please refer to the Studio documentation.

  • Editing a Module's Search Filters Layout

    Each Sugar module's list view includes the ability to filter based on various field values. While certain fields are available for searching by default, admin users can use Studio to add or remove fields on search layouts. This enables each module's search capabilities to be tailored to your organization's needs. For more information about searching individual modules via list view, please refer to the Search documentation.

  • Editing a Module's Subpanels

    Every record's detailview will display subpanels which list related records from other modules. The fields displayed on these subpanel as well as the label of each subpanel can be easily modified through Studio so that your users have visibility to the most important fields for your organization.

  • Introduction to Relationships and Relate Fields

    Linking various pieces of information together is a vital function of CRM. Sugar® provides three different ways to create connections between modules:

  • Making a Field Required for Import

  • Making a Field Required or Unrequired

    Sugar® administrators have the ability to mark a field as required in Studio to ensure that a value is provided for a particular field when a record is created or modified. Please note that all field types except for "HTML" and "Checkbox" can be made required in Sugar. Once a field is marked as required, Sugar will not allow a user to save the record unless the required field contains a value.

  • Making a Subpanel or ListView Field Clickable

    There may be times when a field appears in a list view or subpanel which is not a hyperlink though you would like for it to link to a related record. This article will walk through how to make a field that is normally not clickable into a clickable link.

  • Setting Starting Numbers for Quotes, Cases, and Bugs

    The Quotes, Cases, and Bugs modules include a stock number field (e.g. Quote number) to help identify and distinguish each record in the module. When a new record is created and saved in Sugar®, the number field automatically increments based on the last created record's number. By default, the first quotes, cases, and bugs created in Sugar start at "1", but administrators can easily alter the starting number based on their organization's needs via Admin > Studio.

  • Sugar Logic

    The Sugar Logic section of the Knowledge Base includes articles covering the use of dependent and calculated fields. Topics range from introductory information to example Sugar Logic formulas, to detailed walkthroughs of how to construct various fields and formulas.

  • Troubleshooting Address Fields Appearing Twice

    feature enhancement

  • Troubleshooting Case Number Field No Longer Read-Only

    After removing the case number field from the Cases module editview, the field is not read-only if it is added back to the layout.

  • Troubleshooting Errors When Deploying Modules From Module Builder

    On-site instances running on Windows with IIS 7.5 which have WinCache enabled may encounter an error when deploying custom modules via Admin > Module Builder. This article covers troubleshooting this error. For more information on deploying custom modules in Sugar, please refer to the Module Builder documentation.

  • Troubleshooting Fields Not Available in Reports

    In Sugar's commercial editions, reports are a valuable tool that is able to access the fields of most stock or custom modules. You may find, however, that a particular field is missing from the Available Fields panel when building a report.

  • Troubleshooting New Field Not Displaying in Layouts

    When a new field has been created in Studio, the field needs to be added to the relevant layouts so that it can be viewed and used. If you have added the new field to your layouts via Studio, but it still does not appear in your layouts after clicking Save & Deploy, there are several possible solutions.

  • Troubleshooting Projects Pop-up Not Respecting Studio Changes

    There may be occasions where changes made to the PopupView layouts (Popup Search and Popup ListView) for the Projects module in Studio do not display in the Projects module as expected after clicking "Save & Deploy". This article will cover how to resolve this issue in order for the changes made in Studio to be reflected in the Projects module.

  • Troubleshooting Studio List View Changes Not Taking Effect

    You have customized the listview layout via Admin > Studio, but the changes you made do not appear on the module's listview. Odds are that you did not do anything wrong, but you may have a saved search criteria in the module that is preventing the changes from appearing on the listview. Sugar automatically saves your search criteria when leaving the module, then re-populates the search fields the next time you return. This article will go over common solutions in troubleshooting Studio listview changes not appearing in the module's listview.

  • Troubleshooting the "My Forecast" Dashlet

    Dashlets displaying forecasting information, such as closed deals, are incorrectly returning a $0 amount.

  • Understanding Module Builder's Functions

    Module Builder is a very useful and versatile part of Sugar. With Module Builder, Sugar administrators and developers have the ability to build custom modules to fulfill any needs that are not covered by the out-of-the-box Sugar modules (Accounts, Contacts, Opportunities, Cases, etc.). This article will cover the various options for working with the custom module package when it is finished being built in Module Builder.

  • Understanding Relationship Creation Options

    In Sugar, relationships can be created in either Module Builder (custom module) or Studio (custom and stock module). When a relationship is created via Admin > Studio, relate fields and subpanels are automatically created to represent a two-way relationship between the modules. When a related module record is selected in the relate field or subpanel, a relationship is established between the primary module record and the related module record. This article will go over the different types of relationships and how to create new relationships in Sugar.

Last modified: 08/31/2016 05:56pm