Product Catalog

Overview

Sugar's Product Catalog and its supporting modules allow you to define, categorize, and organize a list of all products or services that your organization sells or supports. Products within the Product Catalog can be broadly classified into product types, such as Software and Hardware. Each product type can be further organized into several product categories. For example, the software product type can contain product categories such as Spreadsheets and Word Processors. You can also create sub-categories within a category. Users can define the details of their products within the following products-related modules:

This documentation will cover information and actions specific to the above modules. For instructions concerning views and actions which are common across most Sugar modules, such as creating, editing, and deleting records, please refer to the Working With Records section of this page.

Please note that you will only be able to see product-related records as allowed by your license type, team membership, assigned roles, and user access type. For more information, please refer to the referenced documentation in the Administration Guide.

Product Catalog

Product Catalog Fields

The Product Catalog contains a number of stock fields that come out-of-the-box with Sugar. For information on using and editing various field types, refer to the User Interface documentation. The definitions below are suggested meanings for the fields, but the fields can be leveraged differently to best meet your organization's needs. Fields can be altered, added, or removed via Admin > Studio. For more information on configuring fields, please refer to the Studio documentation in the Administration Guide.

¹ For more information on service-related fields in Sugar Sell, refer to the Services and Renewable Revenue Line Items section of the Opportunities documentation in the Application Guide.

Product Status

The Product Catalog module contains a Status field that controls the availability of each product catalog record when relating it to another record. By default, the Status field has three options: Active, Inactive, and Retired. When the status of a product record is "Active", it will be displayed in the Product Catalog and Product Catalog Quick Picks dashlets. Product Catalog relate fields are filtered to display records with a status of "Active". To select a record with a status of "Inactive" or "Retired", the filter can be removed via the Search and Select drawer.

Note: Sugar admin users can add or modify status values in Studio, but the Active status cannot be removed. For more information on editing dropdown values via the Dropdown Editor, please refer to the Editing Dropdown Lists section of the Developer Tools documentation.

Product Categories

The Product Categories module allows you to create categories to group records under a Product Type. This is one of the levels of organization you can use for the products and services that your organization offers, and will contain multiple entries from the product catalog.

Product Category Fields

The Product Category module contains four stock fields that come out-of-the-box with Sugar. For information on using and editing various field types, refer to the User Interface documentation. The definitions below are suggested meanings for the fields.

Ordering Product Categories

The Order field in the Product Categories module defines the order in which the categories appear in the Product Catalog dashlet. When viewing the dashlet, the product category records without a value in the Parent Category field will display in ascending order based on the numbers entered in the Order field. Product category records with a parent category defined will display as sub-folders in ascending order based on the numbers entered in the Order field. If multiple categories have the same order number, they will display in alphabetical order. Records with an empty Order value will display alphabetically after the final ordered record.

Product Types

The Product Types module controls the Type dropdown list in the Product Catalog fields. In addition to product categories, the product type allows you to define the classification of a product or service that is being offered on a product catalog record.

Product Type Fields

The Product Types module contains three stock fields that come out-of-the-box with Sugar. For information on using and editing various field types, refer to the User Interface documentation. The definitions below are suggested meanings for the fields.

Ordering Product Types

The Order field in Product Types defines the order of the different type options when viewing the Type dropdown list of a Product Catalog record. The Order field allows you to organize what order the dropdown list will display, with 1 being the highest on the list and moving down as the order number rises. When creating new product type record options, the Order field will automatically increment to the next number in the list, thereby adding the new option to the bottom of the list. The Order field can be overwritten with another number if you would like to manually re-order the options.

Manufacturers

The Manufacturers module controls and maintains the Manufacturer Name field in the Product Catalog module. The Manufacturer Name field allows you to select from a list of the manufacturers you use to classify your products and specify from which manufacturer they are produced.

Manufacturer Fields

The Manufacturers module contains three stock fields that come out-of-the-box with Sugar. For information on using and editing various field types, refer to the User Interface documentation. The below definitions are suggested meanings for the fields.

Ordering Manufacturers

The Order field in the module defines the order in which the manufacturer options are displayed in the corresponding Manufacturer Name field of the Product Catalog module. Enter the numeric value (e.g., 1, 2, 3) in the manufacturer record's Order field to determine the order it will display in the corresponding field list (Manufacturer Name). For example, a manufacturer record with an order value of "1" will display at the top of the list followed by the next value (e.g., 2), and so forth. When creating new manufacturer records, the Order field will automatically increment to the next number in the list, thereby adding the new option to the bottom of the list. The Order field can be overwritten with another number if you would like to manually re-order the options.

Working With Products-Related Modules

The Product Catalog and supporting modules use Sugar's Sidecar user interface. The following sections detail menus, views, and actions common to Sidecar modules and contain links to additional information within the page or links to the User Interface documentation.

Menus

Sugar modules contain various options that are available via menus in the module tab, list view, and record view. The following sections present each menu type and its options with links to more information about each option in the User Interface documentation or, for module-specific functionality, within this page.

Module Tab Menus

Click the Product Catalog module tab in the navigation bar to access the Product Catalog list view. You may also click the three-dots menu in the Product Catalog module tab to display the Actions, Recently Viewed, and Favorites menus. The Actions menu allows you to perform important operations within the module. The Recently Viewed menu displays the list of records you most recently viewed. The Favorites menu displays the list of records you most recently marked as favorites.

From the Product Catalog's module tab menu, you can also access the supporting modules of Manufacturers, Product Categories, and Product Types. By navigating to any of these modules, you can access their respective module tabs, which in turn will offer the option to return to any of the other supporting modules. 

The Actions menus in the module tab for the Product Catalog and its supporting modules will allow you to perform the following operations:

List View Menus

The list view displays all records meeting the current search criteria. You can view the basic details of each record within the field columns. Users with administrator or developer access have the ability to change what fields are visible in the list view via Admin > Studio. For more information on editing layouts, please refer to the Studio documentation.

Mass Actions Menu

The Mass Actions menu to the right of the checkbox option allows you to perform various actions on the currently selected records.

The options in the Mass Actions menu allow you to perform the following operations:

Record Actions Menu

The Record Actions menu to the right of each record's Preview button allows users to edit, follow, or delete specific records directly from the list view.

The options in the Record Actions menu allow you to perform the following operations:

Record View Actions Menu

The record view displays thorough record information including all record fields. The record view can be reached by clicking a record's link in the list view. You have the ability to change the record view by configuring the layout via Admin > Studio. For more information on editing layouts, please refer to the Studio documentation.

The Actions menu on the top right of each record view allows you to perform various actions on the current record. 

The options in the Actions menu allow you to perform the following operations:

Common Views and Actions

The following links will open specific sections of the User Interface documentation where you can read about views and actions that are common across most Sidecar modules.

In the table below, the left column contains links to the User Interface page covering topics that are applicable to all Sidecar modules. The right column has links to sections of the current page that cover topics specific to product catalog records.