SugarCRM SupportDocumentationSugar Versions8.08.0 ProfessionalSugar Professional 8.0 Administration GuideContract Types

Contract Types

Overview

The Contract Types module in Admin > Contract Types enables you to create and manage contract types for the Contracts module. When a contract type is created, it will display in the Type Name field in the Contracts module for users to select. Please note that when a contract record is created with a specific contract type, the related documents to the contract type will also appear in the Documents subpanel of the contract record.

Only administrators or users with developer-level role access have the ability to modify the available contract types and the order in which they appear in the Type Name field. This documentation will cover the basics of the Contract Types module as well as the various options available in performing the actions related to the module.

Contract Type Fields

The Contract Types module contains two stock fields which come out-of-the-box with Sugar. Please note that Contract Type fields are not editable via Admin > Studio as the module does not exist in Studio.

Field Description
Name The name of the contract type
List Order A number to specify the order in which the contract type is displayed in the Type Name field in the Contracts module

Working With Contract Types

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. The sections following this Working With Contract Types section describe Contract Types-specific behaviors and functionality. 

Content Link Description
Creating Contract Types
    Basic Contract Type Creation

The Creating Records section covers the method of creating new contract type records, including via the Create button in the Contract Types module.

Viewing Contract Types
    Viewing via List View
    Viewing via Record View
    Viewing via Recently Viewed
    Viewing via Preview

The Viewing Records section describes the various methods of viewing contract type records, including via the Contract Types list view and record view, the Recently Viewed menu in the Contract Types module tab, and previewing contract types in the right hand side panel.

Searching for Contract Types
    List View Search
        Creating a Filter
        Saving a Filter
The Searching for Records section provides an introduction to list view search, which searches and filters within the Contract Types module.
Contract Types List View    
    Total Record Count    
    Create Button
    List View Search
    Checkbox Selection
    Mass Actions Menu
    Column Reordering
    Column Resizing
    Column Sorting
    Column Selection
    Preview
    Record Actions Menu
    More Contract Types
    Intelligence Pane
The List View section walks through the many elements of the Contract Types List View layout which contains a filterable list of all contract type records in Sugar. While the generic menu options are described in the User Interface sections linked to the left, the options specifically available in the Contract Types list view are described in the List View Mass Actions Menu and List View Record Actions Menu sections of this page.
Contract Types Record View
    Next or Previous Record    
    Actions Menu
    Show More
    Subpanels
        Related Record Subpanels
        Filtering Subpanels
    Intelligence Pane
The Record View section walks through the many elements of the Contract Types Record View layout which contains detailed information about a single contract type record. While the generic menu options are described in the User Interface sections linked to the left, the options specifically available in the Contract Types record view are described in the Record View Actions Menu section of this page.  

Editing Contract Types
    Editing Inline via Record View
    Editing via Record View
    Editing Inline via List View
    Editing Fields

The Editing Records section describes the various methods of editing existing contract type records, including inline via the Contract Types record view, in full edit mode on the record view, and inline via the Contract Types list view. The Editing Fields section provides instructions for modifying the different field types available in Sugar records.
Deleting Contract Types
    Deleting via Record View
    Deleting via List View
    Mass Deleting via List View
The Deleting Records section describes the various methods of deleting unwanted contract types, including via the Contract Types record view, an individual record's Actions menu on the Contract Types list view, and the Mass Actions menu on the list view.
Exporting Contract Types The Exporting Records section provides an introduction to the export functionality which allows you to download a list of contract types and all their data as a .csv file for use outside of Sugar (e.g. in Microsoft Excel).
Finding Duplicate Contract Types The Finding Duplicate Records section provides instructions for locating duplicate contract type records. If searching on matching fields (e.g. Name) identifies one or more duplicates, they can be merged into a single record.
Merging Contract Types
    Merging via List View
The Merging Records section provides instructions for merging duplicate contract types which will combine field values and related records into a single contract type.
Sharing Contract Types The Sharing Records section provides instructions for the Share record view option which composes an email with a link to the contract type record. If the recipient is logged into Sugar, clicking the link will bring them directly to the contract type's record view.

Contract Types Menu

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

Module Tab Menus

The Contract Type module tab can be accessed by navigating to the Admin page and clicking the Contract Types link in the Contracts section. Once in the Contract Types list view, you can click the triangle in the Contract Type module tab to display the Actions and Recently Viewed menus. The Actions menu allows you to perform important operations within the module. The Recently Viewed menu displays the list of contract type records you most recently viewed.
711-moduletab

The module tab's Actions menu allows you to perform the following operations:

Menu Item Description
Create Contract Type Opens the record view layout to create a new contract type
View Contract Types Opens the list view layout to search and display contract types

List View Menus

The Contract Types list view displays all contract type records and allows for searching and filtering to locate specific contract types. You can view the basic details of each record within the field columns of the list view or click a contract type's name to open the record view. To access the module's list view, simply navigate to the Admin page and select "Contract Types" under the Contracts panel. You can also click the module's tab in the navigation bar once the Contract Types module opens.

List View Mass Actions Menu

The Mass Actions menu to the right of the checkbox option in the list header allows you to perform mass actions on all currently selected records. You can use the checkbox on each record's row to select individual contract type records or click the checkbox in the list header to select all records displayed in the current set of list view results.
711-lv-massactions 

The Mass Actions menu allows you to perform the following operations:

Menu Item Description
Merge Merge two or more duplicate contract types
Delete Delete one or more contract types at a time
Export Export one or more contract types to a CSV file

List View Record Actions Menu

The Record Actions menu to the far right of each record's row allows you to perform actions on the individual contract type directly from the list view. 
711-lv-recordactions

The list view's Record Actions menu allows you to perform the following operations:

Menu Item Description
Preview (Eye icon) Preview this contract type in the intelligence pane
Edit Edit this contract type
Delete Delete this contract type

Record View Actions Menu

The Contract Types record view displays a single contract type in full detail including its fields and subpanels of related records. To access a contract type's record view, simply click the hyperlinked contract type name in the Contract Types list view. The record view's Actions menu appears on the top right of the page and allows you to perform various operations on the current record. 
711-rv-actions

The Actions menu allows you to perform the following operations: 

Menu Item Description
Edit Edit this contract type
Share Share a link to this contract type via email
Find Duplicates Locate potential duplicates of this contract type
Copy Duplicate this contract type to create a new contract type
Delete Delete this contract type

Ordering Contract Types

When creating contract types, you will define the order in which the contract type option is displayed in the Type Name field of the Contracts module. Enter the numeric value (e.g. 1, 2, 3) in the contract type record's List Order field to determine the order it will display in the contract's Type Name field. For example, a contract type with a list order of "1" will be displayed at the top of the list followed by the next value (e.g. 2), and so forth. Please note that you can change the list order by editing the contract type via the list view or record view. 

Last modified: 2018-03-28 22:32:20