Skip to content
  • There are no suggestions because the search field is empty.

SalesLink PSE Integration

All about SalesLink’s integration with Caterpillar Prioritized Service Events (PSEs).

In This Article

    Introduction

    Prioritized Service Events, or PSEs, are proactive maintenance alerts generated by Caterpillar and communicated to equipment dealers who deal in Caterpillar products. The purpose of a PSE is to identify potential machine issues before they escalate into downtime, and to give equipment dealers the ability to sell preventative maintenance work to their customers.

    PSEs are an important source of parts and service leads for equipment dealers. As such, Texada SalesLink has the ability to ingest Caterpillar PSEs and use them to generate SalesLink Opportunities. 

    The following article contains everything you need to know about SalesLink’s PSE integration, including setup, configuration, and tips for working with Caterpillar-generated leads in SalesLink.

    SalesLink supports two kinds of PSEs: Sales PSEs and Marketing PSEs (MPSEs). Support for MPSEs was added in the 2024.1107 version of Texada CloudLink. Watch the video below to learn more.

    Back to top

    Implementation

    The ability to import Sales PSEs from Caterpillar is included in SalesLink. If you are unsure whether your system has the ability to ingest PSEs, or would like to enable this functionality, please reach out to your Texada account representative.

    Back to top

    Enable Marketing PSEs

    Before Marketing PSEs can be imported into SalesLink, Caterpillar and Texada must establish an API connection. This can be accomplished by submitting a support ticket through Caterpillar’s Aftermarket Sales or Marketing Communities (ASC or AMC):

    1. Log in to either the ASC or AMC and select Support → Contact Us → New from the top menu to submit a support ticket.
    2. Include the following information in the New Case window:
      1. Subject: <Dealer Code> Request to enable Marketing PSE connection - Texada Dealer
      2. Description: Request to enable the Marketing PSE connection via API for Dealer X
    3. Click “Save” to submit your request. Caterpillar will now work with Texada to create a Marketing PSE connection. You will be contacted once your system is ready to start importing MPSEs.

    Back to top

    Importing PSEs

    Importing PSEs from Caterpillar into SalesLink requires access to Caterpillar’s Aftermarket Sales Community (ASC) for Sales PSEs, or Aftermarket Marketing Community (AMC) for Marketing PSEs. Using these tools, you can manually trigger PSEs to be brought into SalesLink.

    Back to top

    Import Sales PSEs

    To import Sales PSEs from Caterpillar’s ASC into SalesLink, follow the steps below.

    1. Log in to Caterpillar ASC and navigate to Sales PSEs → Available PSEs in the top menu.
    2. Use the filters on the Available PSEs screen to select the Sales PSEs to be processed.
    3. Scroll down to the Sales Prioritized Service Events table at the bottom of the Available PSEs screen. Click the down arrow in the top-right corner of the table, then select “Process PSEs”.
    4. Click “Send” to queue the selected Sales PSEs for importing.

    PSE leads are imported into SalesLink daily at 6:00am system time (the timezone of your CloudLink system as established during the onboarding process). Any Sales PSEs queued using the process above will be brought into SalesLink during the next daily import.

    When imported, Sales PSEs will be assigned to the first PSSR of the Opportunity’s Customer for the Division specified on the PSE.

    Back to top

    Import Marketing PSEs

    In order to import MPSEs into SalesLink, the “Enable CAT PSE Marketing Leads” configuration key must be enabled in CloudLink Console.

    To import MPSEs into SalesLink, follow the steps below.

    1. Log in to Caterpillar AMC and navigate to Marketing PSEs → Available PSEs in the top menu.
    2. Use the filters on the Available PSEs screen to select the MPSEs to be processed.
    3. Scroll down to the Overview table at the bottom of the Available PSEs screen. Click the down arrow in the top-right corner of the table, then select “Process PSEs”.
    4. Click “Send” to queue the selected MPSEs for importing.

    PSE leads are imported into SalesLink daily at 6:00am system time (the timezone of your CloudLink system as established during the onboarding process). Any MPSEs queued using the process above will be brought into SalesLink during the next daily import.

    When they are imported, MPSEs will be unassigned. You can bulk reassign these Leads via the Manage - Opportunity, Activity and Issue Status secured module. See “Bulk Update Opportunities” for more information.

    Back to top

    Auto-Distribution

    For dealers who would like to automatically import Sales and Marketing PSEs into SalesLink, Caterpillar offers an auto-distribution option. Once set up, auto-distribution allows PSEs to be imported daily without the need to access the AMC or ASC.

    If you are interested in auto-distribution, please contact your Caterpillar Marketing and Sales Operations Representative (MSOR).

    Back to top

    Exporting PSEs

    PSE leads are exported to Caterpillar daily at 5:30am system time (the timezone of your CloudLink system as established during the onboarding process). In order to be exported to Caterpillar, opportunities must fulfill a number of conditions depending on their origin (dealer or Caterpillar) and type (sales or marketing).

    The following table describes which opportunities are eligible for exporting. If an opportunity meets ALL of the listed criteria, it will be exported to Caterpillar. For detailed information on which PSE data is sent to Caterpillar, see “Appendix A: PSE Data Exported to Caterpillar”.

    Dealer-Originated Sales Opportunities

    Caterpillar-Originated Sales Opportunities

    Caterpillar-Originated Marketing Opportunities*

    Scenario 1 - Regular update:

    • Opportunity Type:
      Parts OR Service
    • Manufacturer:
      Caterpillar
    • Opportunity Stage:
      NOT Lead, No Lead
    • PSE Type:
      NOT empty

    Scenario 1 - Regular update:

    Opportunity Type:
    Parts OR Service
    • Opportunity Stage:
      NOT Lead

    Scenario 1 - A lead has been converted into an opportunity:

    • Lead’s stage has just been changed to an active stage that converted it into an opportunity (outstanding, development, proposal, etc.)

    Scenario 2 - The opportunity has been set to “No Lead”:

    • Opportunity’s stage has just been changed to “No Lead” for the first time

    Scenario 2 - The opportunity’s associated campaign record has been updated:

    Opportunity Stage: NOT Lead
    • The name, start date, or end date of the Opportunity’s associated campaign record has changed

    Scenario 3 - The opportunity has been won:

    • Opportunity has an associated campaign
    • Opportunity’s stage has just been changed to “Won” for the first time

    *Dealer-Originated Marketing Opportunities are NEVER exported to Caterpillar.

    Back to top

    Working with PSEs

    The following section contains information about how to work with Caterpillar-generated Opportunities in SalesLink.

    Back to top

    PSE Type

    The PSE type with which a SalesLink Opportunity is associated is indicated by the “PSE Type” field on the Add New Opportunity and Opportunity details pages:

    The behavior of this field is highly conditional based on your system settings and the properties of the Opportunity itself:

    • The PSE Type field will only appear for dealer-generated Parts and Service Opportunities with a Product Make of “CATERPILLAR”. It is not possible for a SalesLink user to change the PSE Type of Caterpillar-originated Opportunities.
    • Whether the PSE Type field is hidden, optional, or mandatory is determined by the “PSE Type Field Visibility” configuration key.
    • Whether a PSE Type field is automatically selected based on the Product Category or Commodity is determined by the “Map product category and product commodity to PSE Type” configuration key.

    PSE Type and OEM Lead Type

    It is important to distinguish between the PSE Type field described above and the OEM Lead Type field on the Lead details page.

    • PSE Type is used for outbound communication from SalesLink to Caterpillar and reflects how your organization classifies the opportunity for reporting and exporting purposes.
    • OEM Lead Type is an inbound value sent directly from Caterpillar when a PSE is generated and is displayed exactly as received. OEM Lead Type values are not controlled, mapped, or edited by dealers in SalesLink, and they may not directly correspond to the PSE Type options available for dealer-created opportunities. See “SalesLink - OEM Lead Type” for more information about this field.

    Previously created records

    Changes to available PSE Types affect newly created opportunities and newly imported PSE leads only. Existing opportunities and historical PSE records will continue to display the PSE Type values that were set at the time they were created.

    As a result, you may see PSE Type values on older records that are no longer available for selection on new opportunities. This behavior is expected and ensures historical data remains unchanged.

    Back to top

    Mapping Product Categories and Commodities to PSE Types

     

    If the “Map product category and product commodity to PSE Type” configuration key is enabled, the PSE Type field will be set automatically based on the Product Category (for Service Opportunities) or Commodity (for Parts Opportunities). This feature is incredibly useful, as it eliminates the need for your SalesLink users to manually select a PSE Type, and ensures that the correct PSE Type will be selected in all cases.

    The mapping of Categories and Commodities to PSE Types is managed via the Manage - PSE Type Mapping secured module. See “Manage - PSE Type Mapping” for more information.

    When mapping Categories and Commodities to PSE Types, it is important to remember the following:

    • Creating a mapping with a Category / Commodity but no PSE Type will cause matching Opportunities to be given a blank PSE Type value. As a result, these Opportunities will not be exported to Caterpillar.
    • As long as the “Map product category and product commodity to PSE Type” configuration key is enabled, editing an existing PSE mapping will retroactively change the PSE Type of ALL matching Opportunities that meet the following criteria: 
        • Type: Parts or Service
        • Origin: Dealer-created
        • Stage: Open
        • Make: Caterpillar
    Back to top

    Outstanding Leads

    The Outstanding Leads page provides SalesLink users with an easy way to view Opportunities originating from Sales and Marketing PSE Leads. After navigating to this page, select “CAT PSE Lead - Marketing” and/or “CAT PSE Lead - Sales” from the “Source” drop-down to view outstanding Leads grouped by age and assignee.

    Click on any of the hyperlinked numbers in the table to view matching Leads in list view.

    Back to top

    Opportunity Pipeline

    The Opportunity Pipeline page provides more options for viewing PSE leads. One such method involves switching to the “By Sources” tab and checking the “Lead” checkbox. After applying this filter, you will see a CAT PSE Lead - Marketing and a CAT PSE Lead - Sales row in the pipeline. 

    Click any of the hyperlinked numbers in these rows to view a list of Opportunities for that time period.

    Back to top

    Opportunity Details

    The “Source” field on the Opportunity Details page allows you to see the origin of a given SalesLink Opportunity, and as such, identify Opportunities created from Sales and Marketing PSEs.

    Opportunities with a Source of “CAT PSE Lead - Marketing” are restricted to having an Additional Source of “Campaign response”. Opportunities with a Source of “CAT PSE Lead - Sales” may have a blank Additional Source, or an Additional Source of “Campaign response”.

    Back to top 

    Bulk Update Opportunities

    SalesLink Leads and Opportunities can be edited in bulk with the help of the Manage - Opportunity, Activity and Issue Status secured module in SalesLink - Executive. This module provides filtering options for Opportunities originating from Sales and Marketing PSE leads, allowing you to target these Opportunities for bulk updates.

    After navigating to this module, set the Report Type to “Opportunity”. Open the “Source” drop-down, then either scroll down or begin typing into the filter bar to locate the “CAT PSE Lead - Marketing” or “CAT PSE Lead - Sales” options. Select one or both of these options to see a list of Caterpillar-originated Opportunities that you can edit in bulk.

    Back to top

    Manage PSE Opportunity Source Group

    The Source Group of Sales and Marketing PSE Opportunities can be modified via the Manage - Opportunity Source secured module in SalesLink - Executive. See “Manage - Opportunity Source” for more information.

    Back to top

    Configuration Keys

    The following section lists configuration keys that affect the behavior of PSEs in SalesLink. These configuration keys can be viewed and managed in CloudLink Console; see “Manage Configuration Keys” for more information.

    Back to top

    Enable CAT PSE Marketing Leads

    Key: ckCommon.CAT.PSE.MarketingLeads.Enable

    This key determines whether or not CAT marketing PSE leads (MPSEs) will be imported into SalesLink.

    Back to top

    Map product category and product commodity to PSE Type

    Key: ckCommon.PSEOpportunity.MapProductCategoryToPSEType

    This key determines whether or not the PSE Type of SalesLink Opportunities will be automatically set based on the Product Category and Commodity mappings established in the Manage - PSE Type Mapping secured module.

    • (1) Disabled
      • The PSE Type of SalesLink Opportunities will not be set automatically. 
      • SalesLink users will be able to set this value manually via the Opportunity details screen.
    • (2) Enabled
      • The PSE Type of SalesLink Opportunities will be set based on the mappings established in the Manage - PSE Type Mapping secured module.
        • For Service Opportunities, PSE Type of will be set based on Product Category.
        • For Parts Opportunities, PSE Type of will be set based on Commodity.
      • If a mapping is found for the Opportunity’s Category / Commodity, its PSE Type will be set automatically, and SalesLink users will not be able to edit this value.
      • If no mapping exists for the Opportunity’s Category / Commodity, its PSE Type will be left blank, and SalesLink users will be able to set this value manually via the Opportunity details screen.

    Notes

    • Enabling this configuration key will NOT automatically update the PSE Type of existing Opportunities. 
    • Editing an Opportunity’s Product Category / Commodity while this key is enabled WILL update its PSE Type if a mapping is found. Note that this update will only occur once the “Save” button is clicked:
    • If you want to retroactively update the PSE Type of existing Opportunities without editing them individually, this can be accomplished by updating the mapping on the PSE Type Mapping Management screen.
    Back to top

    PSE Type Field Visibility

    Key: ckCommon.Opportunity.CATType.Show

    This key determines the visibility and behavior of the “PSE Type” field on the Add New Opportunity screen.

    • (1) Hide: The PSE Type field will not be displayed. A PSE Type will still be set in the background if the Opportunity’s Product Category / Commodity matches one of the mappings established in the Manage - PSE Type Mapping secured module.
    • (2) Show (Mandatory): The PSE Type field will be displayed, and it will be mandatory to select a PSE Type in order to create an Opportunity.
    • (3) Show (Optional): The PSE Type field will be displayed, and will be optional.
    Back to top

    PSE Type - Behavior Flowchart

    The following flowchart describes the behavior of the “PSE Type” field on the Add New Opportunity page based on the running values of the “PSE Type Field Visibility” and “Map product category and product commodity to PSE Type” configuration keys.

    Click to view the full-sized image.

    PSE Type Field Behavior Flowchart

    Back to top

    Appendix A: PSE Data Exported to Caterpillar

    The following table shows the information exported to Caterpillar for each PSE during the daily export process.

    • The SalesLink Field Name column shows the field’s name in SalesLink’s user interface. These are the default labels for these fields; the labels in your system may vary. If this value is blank, the field is not visible in SalesLink; this could indicate that it is stored in your system’s database, or is derived at the time of exporting.
    • The Caterpillar API Field Name column shows the name of the Caterpillar field to which the SalesLink field is matched.
    • The Marketing PSEs, Caterpillar-originated Sales PSEs, and Dealer-originated Sales PSEs columns indicate whether the field is optional, required, or not included (blank) when exporting that type of PSE.

    SalesLink Field Name

    Caterpillar API Field Name

    Description

    Marketing PSEs

    Caterpillar- originated Sales PSEs

    Dealer- originated Sales PSEs

     

    channel

    The deal’s marketing channel.

    Example: Email

    Optional

       

    Reason

    closedWonReason

    The reason the deal was Closed with a status of Won.

    Example: Provided additional discount of 10%

     

    Optional

     

    End Date

    dealerCampaignEndDate

    The end date of the campaign to which the PSE belongs.

    Example: 9/23/2021

    Required

       

    Campaign Name

    dealerCampaignName

    The name of the campaign to which the PSE belongs.

    Example: Rebuild Campaign

    Required

       

    Start Date

    dealerCampaignStartDate

    The start date of the campaign to which the PSE belongs.

    Example: 7/20/2021

    Required

       
     

    dealerCode

    The Group Dealer Code of the Dealer with whom the prioritized lead is shared.

    Example: J111

    Required

    Required

    Required

    Customer

    dealerCustomerNumber

    The customer’s unique ID in your system.

    Example: AB-1234

       

    Required

    Customer Profile → Expenditures → select expenditure type/date → Invoice Number

    dealerInvoiceNumber

    Service invoice number.

    Example: INV123SD54

    Optional

    Optional

    Optional

    Opp No

    dealerLeadId

    The lead’s unique ID in your system. 

    Example: A123BDFGF-4533

    Required

    Required

    Required

    Opp No

    dealerOpportunityId

    The opportunity’s unique ID in your system. Required when a PSE is converted into an opportunity.

    Example: 9XDE123FGF-1232

    Required

    Optional

    Required

    Stage

    dealerOpportunityStage

    The opportunity’s stage. 

    Example: Dealer Closed Won

    Required

    Optional

    Required

     

    dealerPSE

    Indicates whether this opportunity is dealer-originated. Always FALSE for Marketing PSEs.

    Example: FALSE

    Required

    Required

    Required

     

    dealerSalesRepNumber

    The ID of the opportunity’s Sales Rep. Required when a lead is converted into an opportunity.

    Example: J43433

     

    Optional

    Required

    Description

    description

    The lead’s description.

    Example: SMU 17933: CPT (54 WW - avg DN 218K$)

       

    Required

    isoCurrencyCode

    The lead’s currency code.

    Example: USD

    Required

    Required

    Required

     

    jobCode

    The lead’s job code.

    Example: 02A

       

    Optional

    Source

    leadSource

    The lead’s source.

    Example: Customer Call

       

    Required

     

    leadStatus

    The lead’s notification status.

    Example: Dealer ACCEPTED

     

    Required

     

    Est. Revenue / Dealer Parts Purchased Est Amt.

    opportunityAmount

    The opportunity’s potential revenue amount. Required when a lead is converted into an opportunity.

    Example: 142410

    Optional

    Optional

    Required

    Entered By

    opportunityCreationDate

    The opportunity’s creation date in your system.

    Example: 8/10/2021

       

    Required

     

    opportunityClosedDate

    The date the opportunity was closed in your system. Required if the opportunity is Closed.

    Example: 8/10/2021

       

    Required

    Reason

    primaryLostReason

    The reason why the opportunity was lost.

    Example: Geo/Political

     

    Optional

    Optional

     

    prioritizedServiceEventId

    The ID of the prioritized lead from Caterpillar’s CRM.

    Example: 0CE949BD-62EF-49DE-98D5-1DB6987556AB

    Required

    Required

     

    Quote

    quoteId

    The ID of the quote created for the opportunity.

    Example: QT12344

       

    Optional

    Probability Of Closing

    rating

    Rating of lead

    Example: High, Low and Medium

     

    Optional

     

    Comment

    rejectionComments

    Comments on why the deal was rejected. Required if rejectionReason = 'Other (Please Provide Details)'.

    Example: Customer not in territory

     

    Optional

     

    Reason

    rejectionReason

    For leads with a status of Rejected, the reason for the rejection.

    Example: Invalid Lead

     

    Optional

     

    Comment

    secondaryLostReason

    The secondary reason for losing the opportunity. Required if primaryLostReason = 'Other (Please Provide Details)'.

    Example: Change of Ownership

     

    Optional

    Optional

    Serial Number

    serialNumber

    The asset’s serial number.

    Example: AZX00660

       

    Required

     

    smcsCode

    The asset’s SMCS code.

    Example: 3030

       

    Optional

    Est. Delivery

    targetDate

    Target date of closure. Required when a lead is converted into an opportunity.

    Example: 9/23/2021

     

    Optional

    Required

    PSE Type

    type

    The lead’s event type.

    Example: Rebuild

       

    Required

    WO No

    workOrderNumber

    The ID of the work order associated with the lead.

    Example: GI16488

    Required

    Required

    Required

    Back to top

    Currency Codes and Conversion

    When importing PSEs from Caterpillar, the currency in which the lead’s value is expressed can be selected via the “Currency” drop-down. The currency in which a lead was imported can be found in the lead’s Notes section in SalesLink, under “ISO Currency Code”.

    SalesLink expects all monetary values to be expressed in your system’s primary currency. For this reason, it is strongly advised to import PSEs from Caterpillar in your primary currency. If you do not convert leads into your primary currency at the time of importing, you will need to manually update their values in SalesLink to ensure accuracy.

    PSEs will always be exported to Caterpillar in your system’s primary currency, as indicated by the value of the “isoCurrencyCode” field.

    The below scenarios illustrate how currency conversion affects importing PSEs:

    Scenario 1 (Incorrect): Your organization’s primary currency is SGD. A PSE is imported from Caterpillar in USD.

    • Result: The value of the PSE in SalesLink is assumed to be in SGD, but is actually in USD. Therefore, the value is slightly incorrect. 
    • Solution: The value of the PSE in SalesLink needs to be manually converted from USD to SGD.

    Scenario 2 (Correct): Your organization’s primary currency is SGD. A PSE is imported from Caterpillar in SGD.

    • Result: The value of the PSE in SalesLink is correctly assumed to be in SGD. Therefore, the value is correct.

    Back to top

    Work Order Number and Invoice Number

    The logic used to determine value of the workOrderNumber and dealerInvoiceNumber fields exported to Caterpillar is as follows.

    Scenario 1: The PSE Lead IS linked to a Quote in Parts & Service Quoting (PSQ).

    • workOrderNumber will be set to the Work Order number of the Work Order associated with the Quote.
    • dealerInvoiceNumber will be set to the Invoice number of the Invoice associated with the Quote, if one exists.

    This logic will apply even if a Work Order number has been manually specified for the PSE Lead. In other words, PSQ Quotes will always take precedence over manually-specified Work Order numbers.

    When a PSE Lead associated with a PSQ Quote is Won, its information will be exported to Caterpillar one final time. Following this, no further updates will be sent.

    Scenario 2: The PSE Lead IS NOT linked to a Quote in Parts & Service Quoting (PSQ), and a Work Order number HAS been manually specified.

    • workOrderNumber will be set to the manually-specified Work Order number.
    • dealerInvoiceNumber will be set to the Invoice number of the Invoice associated with the manually-specified Work Order, if one exists. If no Invoice exists, dealerInvoiceNumber will be blank while workOrderNumber will still be exported.

    Scenario 3: The PSE Lead IS NOT linked to a Quote in Parts & Service Quoting (PSQ), and a Work Order number HAS NOT been manually specified.

    • workOrderNumber will be blank.
    • dealerInvoiceNumber will be blank.

    Back to top

    Opportunity Amount

    The logic used to determine the value of the opportunityAmount field exported to Caterpillar is as follows.

    Scenario 1: The PSE Lead IS linked to a Quote in Parts & Service Quoting (PSQ).

    • opportunityAmount will be set to the total amount quoted in PSQ.

    Scenario 2: The PSE Lead IS NOT linked to a Quote in Parts & Service Quoting (PSQ), and the Lead’s type is ‘Parts’.

    • opportunityAmount will be set to the value of the “Est. Revenue” field at the top of the Opportunity details page.

    Scenario 3: The PSE Lead IS NOT linked to a Quote in Parts & Service Quoting (PSQ), the Lead’s type is ‘Service’, and ‘Dealer Parts Purchased’ is set to ‘Yes’.

    • opportunityAmount will be set to the value of the “Est Amt.” field to the right of the “Dealer Parts Purchased” field on the Opportunity details page. If this field is blank, opportunityAmount will be exported as 0.

    Scenario 4: The PSE Lead IS NOT linked to a Quote in Parts & Service Quoting (PSQ), the Lead’s type is ‘Service’, and ‘Dealer Parts Purchased’ is set to ‘No’.

    • opportunityAmount will be set to the value of the “Est. Revenue” field at the top of the Opportunity details page.

    Note that the “Dealer Parts Purchased” field may be hidden in some systems. If you do not see this field on the Opportunity details page and would like it to be visible, please contact Texada support.

    The below video summarizes the logic surrounding the opportunityAmount field.


    Back to top