Using Common Resource Templates

Sugar provides a library of common resource templates you can use to help more quickly transform fields provided by some of the most frequently used types of adapters into single, normalized resources. For more information about Common Resources and how to utilize and create them, see Introduction to Common Resources and Creating Common Resources.

To use a Common Resource template, you have to clone it from the Common Resource Templates catalog into a new Common Resource, select your adapters and services, and edit the fields. See Cloning a Common Resource Template to learn more.

Accessing the Common Resources Template Catalog

  1. Log in to Sugar and navigate to the Common Resources page.
  2. On the Common Resources Catalog page, click the Resource Templates tab.
  3. Hover over a Common Resource template and do one of the following:
    • Click Overview to see the Common Resource's description, fields, and data types.
    • Click Mappings to clone the Common Resource, or to see the Common Resource's name and URL, system level fields, and mapped adapters.

Common Resource Overview tab

On this tab, you can view the following information about the Common Resource template:

Section
Definition
NameThe name of the Common Resource. You cannot edit the name of a Common Resource template, but you can clone the template into a new Common Resource and give it a custom name.
DescriptionA description of the Common Resource's functionality and purpose
Mapped AdaptersIcons indicating the adapters the Common Resource is pre-mapped to
Fields and Data Types tableThe fields mapped to the adapters included in the Common Resource

Common Resources Mappings tab

On this tab, you can clone the Common Resource template and view the following information about it:

Section
Definition
Common Resource Name and URLThe name of the Common Resource and the URL path where it is accessed
System Level FieldsThe fields mapped at the system level of the Common Resource. When cloning a Common Resource template, you can select the level at which the system level fields will be set. See Cloning a Common Resource Template to learn more.
Mapped AdaptersAdapter cards indicating the adapter instances premapped to in the Common Resource template. To see which system level fields of the adapter the Common Resource template will transform, hover over an adapter card and click View.

Cloning a Common Resource Template

  1. Navigate to the Mappings tab of the Common Resource template and click Clone.
  2. Search for and select the adapters you want to include in the Common Resource, and then click Next. You can also click the check box next to the Adapter Name column header to select all listed adapters.
  3. Select the level at which the system fields should be created in the Common Resource, and then click Next.
  4. Enter a unique name for your Common Resource, and then click Save.
  5. Your new Common Resource now appears in the My Resources list and is ready for transformations. See  Mapping and Transforming Fields to learn more about transformations.

Known issue: if you clone a Common Resource template into a new Common Resource, you cannot delete the new Common Resource and will receive an error. We are aware of this issue and are working to resolve it. As a workaround, clone the Common Resource template into a new Common Resource, give it a unique name, and ignore the Common Resource you want to delete. As a best practice, consider renaming the Common Resource you are trying to delete with a junk name, e.g. DoNotUseThisCommon Resource, until it can be deleted.

About Levels

Within Common Resources, the available fields are defined within a hierarchy of three levels, each with their own sets of privileges and access: organization, account, and instance. Fields defined at the account level are inherited by all users associated with a specific account, while fields defined at the instance level only apply to a specific adapter instance. See Introduction to Common Resources to learn more.

Available Common Resource Templates

These Common Resource templates are available in the Resource Template catalog. This list will be updated as new Common Resource templates are added; keep checking this space for new resources.

  • /companies

    Description: The Companies Common Resource template provides a pre-mapped, common data interface into several cloud marketing and CRM services. It represents a company made in a crm or marketing system that can be applied to a customer's account. This template provides one unified RESTful Resource that allows you to interact with the companies objects associated with the adapters below.

    Mapped Adapters:

    1. Salesforce Sales Cloud
    2. Oracle Eloqua
    3. HubSpot Marketing
    4. HubSpot CRM
    5. SugarCRM
    6. Microsoft Dynamics CRM
  • /basic-contacts

    Description: The Contacts Common Resource template provides a pre-mapped, common data interface into several cloud marketing and CRM services. It represents a simplified contact made in a crm or marketing system that can be applied to a customer's account. This template provides one unified RESTful Resource that allows you to interact with the contact objects associated with the adapters below.

    Mapped Adapters:

    1. Salesforce Sales Cloud
    2. Oracle Eloqua
    3. HubSpot Marketing
    4. HubSpot CRM
    5. SugarCRM
    6. Netsuite CRM 2018 Release 1
  • /basic-leads

    Description: The Leads Common Resource template provides a pre-mapped, common data interface into several cloud marketing and CRM services. It represents a simplified lead made in a crm or marketing system that can be applied to a customer's account. This template provides one, unified RESTful Resource that allows you to interact with the lead objects associated with the adapters below.

    Mapped Adapters:

    1. Salesforce Sales Cloud
    2. Marketo
    3. HubSpot CRM
    4. SugarCRM
  • /leads

    Description: The Leads Common Resource template provides a pre-mapped, common data interface into several cloud marketing and CRM services. It represents a lead made in a crm or marketing system that can be applied to a customer's account. This template provides one, unified RESTful Resource that allows you to interact with the lead objects associated with the adapters below.

    Mapped Adapters:

    1. Salesforce Sales Cloud
    2. Marketo
    3. HubSpot CRM
    4. SugarCRM
  • /contacts

    Description: The Contacts Common Resource template provides a pre-mapped, common data interface into several cloud marketing and CRM services. It represents a contact made in a crm or marketing system that can be applied to a customer's account. This template provides one, unified RESTful Resource that allows you to interact with the contact objects associated with the adapters below.

    Mapped Adapters:

    1. Salesforce Sales Cloud
    2. Oracle Eloqua
    3. HubSpot Marketing
    4. HubSpot CRM
    5. SugarCRM
    6. Netsuite CRM 2018 Release 1
    7. Bullhorn
  • /basic-companies

    Description: The Companies Common Resource template provides a pre-mapped, common data interface into several cloud marketing and CRM services. It represents a simplified company made in a crm or marketing system that can be applied to a customer's account. This template provides one, unified RESTful Resource that allows you to interact with the companies objects associated with the adapters below.

    Mapped Adapters:

    1. Salesforce Sales Cloud
    2. Oracle Eloqua
    3. HubSpot Marketing
    4. Marketo
    5. dynamicscrm
    6. HubSpot CRM
    7. SugarCRM