Lightning components - Opportunity Referral Data

Table of Contents
Overview
1. The highlights panel
2. The “top” section
3. Customer Details section
4. AWS Specific Fields section
5. Microsoft Specific Fields
6. Google Specific Fields
7. SAP Specific Fields
8. Referral Details section
9. My Company Custom Fields section
10. [Partner Name] Custom Fields section

---

Overview

This is a huge component that is supposed to display (without inline editing) the most amount of business data about the Referral to AEs. It can be placed on a Referral page. It is also a part of the Opportunity Referrals LWC that is placed on an Opportunity page. OOTB is on the Referral Lightning page.

The LWC has multiple sections and subsections, most of which are collapsible. It shows fields not only from the Referral record (centred or in the left column) but also from the related PartnerReferral record (in the right column).

Next to each field, it shows the (i) tooltip icon. If you hover over it—you will see the text that is taken from the corresponding field’s Help Text in the field definition in Salesforce Setup > Object Manager.

If the Help Text is blank—the tooltip icon is not shown next to the field. You can also edit the Help Text for any field in the package to better suit your needs.

1. The highlights panel

OOTB shows the Direction of the Referral (Incoming/Outgoing), Referral Status, Customer Name, Owner of the Referral and Integration Status with the third-party Partner (e.g. AWS, Google and Microsoft). If the Referral doesn’t have any specific partner, OOTB, there won’t be any Integration Status field placed on the highlights panel.

The list of the fields to be shown on the highlights panel can be changed to bring to the top any field on the Referral Object.

To add or remove fields on the highlights panel, the following steps must be made:

1. Click ‘Setup’ on the org where you want to update the highlights panel
2. Click ‘Object Manager’
3. Use ‘Quick Find’ to search for the ‘Referral.’
4. Click ‘Compact Layouts’ on the right panel
5. Open Referral Compact Layout that needs to be updated
6. Click ‘Edit’
7. From the list of ‘Available Fields’ on the right, select the fields to be placed on the highlights panel and then click the arrow button under the ‘Add’ title. To remove the fields select the fields on the left ‘Selected Fields’ list and click the arrow button above the ‘Remove’ title.
8. To adjust the order of the fields on the highlights panel, use the buttons next to the ‘Selected Fields’ list. The closer the field is to the top of the list, the closer it will be to the right side of the highlights panel.
9. Click ‘Save'. OOTB, the same highlights panel is visible from the Referral tab within the Opportunity Page.

2. The “top” section

It highlights some key information about the Referral (Partner Name and Customer Name) and the “shared” fields that can be edited by both you and your partner (Next Step, Notes, and Description). It also has buttons for most of the available actions, which work exactly the same as on the Referral Actions LWC. In addition, it has the Edit Referral button, which opens a standard Edit Referral modal to allow editing the Referral right from the Opportunity page.
Plus, it has the URL to open this Referral in WorkSpan, and its WorkSpan ID (Refer 2.18.2) (inbound requests populate both fields).

3. Customer Details section

It shows all the information from the Referral about the customer that you are co-selling to with your partner.

4. AWS Specific Fields section

If you are in an AWS flow, you will see this collapsible section with all the AWS-specific fields from the Referral record.

There might be AWS-specific fields that are not part of the packaged data model, and they are being sent as Partner Custom Fields. So they will be displayed in the [Partner Name]Custom Fields section instead of this section.

5. Microsoft Specific Fields

If you are in an MPC flow, you will see this collapsible section with all the MPC-specific fields.

The Help Needed from Microsoft field is from the Referral level, while Microsoft Partner Center Referral Id and Microsoft Partner Center Referral Link are from the Partner Referral.

There might be MPC-specific fields that are not part of the packaged data model, and they are being sent as Partner Custom Fields. So they will be displayed in the [Partner Name]Custom Fields instead of this section.

6. Google Specific Fields

If you are in a Google flow, you will see this collapsible section with all the Google-specific fields.

The Google Lead Id, Google Region Code, Google Approval Notes, Google Region Code, Google Rejection Comments, and Google Review Date fields are from the Partner Referral, whereas others are from Rerrefal.

There might be Google-specific fields that are not part of the packaged data model, and they are being sent as Partner Custom Fields. So they will be displayed in the [Partner Name] Custom Fields instead of this section.

7. SAP Specific Fields

In a SAP flow, you will see this collapsible section with all the partner-specific fields.

All the fields in this section are from Partner Referral.

8. Referral Details section

It shows data from the Referral record and from the related Partner Referral record. It is laid out side-by-side so you can easily compare your information (left column) with your partner’s information (right column), as long as your partner shares it with you in WorkSpan. It is broken into 5 subsections.

8.1. The “main” subsection

It shows the main sales details from you and from your partner.

8.2. Currency fields

The main subsection contains some currency fields (Deal Size and Forecast Value) which are unique due to the difference in currency handling between WorkSpan and Salesforce. Here’s how the XXX Currency fields are considered when rendering the Opportunity Referral Data LWC:

1. If the XXX Currency field is empty, then the LWC will render the currency of the Referral record (which is defined in the Company Settings if the multicurrency is not enabled or in the standard CurrencyISOCode field if it is enabled).

2. If the XXX Currency field contains a valid currency code, then Opportunity Referral Data LWC will render it regardless of the currency of the Referral record.

3. If the XXX Currency field contains a currency code that Salesforce doesn’t recognize, then Opportunity Referral Data LWC will prepend its literal value to the currency amount regardless of the currency of the Referral record.

8.3. Referral Contact Details subsection

This collapsible subsection shows contact details for the persons involved from your and your partner’s side.

8.4. The “status” subsection

It shows some technical details about the referral from you and your partner to help you track how things are going on their side.

8.5. The “tracking” subsection

Shows two fields (Referral Expiration Date and Referral Sub-Status) only from the Referral record (i.e., only your company details, not your partner’s).

8.6. Additional Details subsection

This collapsible subsection shows some more technical details from the Referral record  (i.e. only your company details, not your partner’s).

9. My Company Custom Fields section

This section shows all the custom fields you created in your org on the Referral object (see here). It is only displayed if you have created any custom fields.

10. [Partner Name] Custom Fields section

This section shows all the custom fields that your partner has created on their side and shared with you.

This data is stored as plain text {value, name} pairs in the Partner Custom Fields field on the Partner Referral record and is parsed out and prettified dynamically by the LWC.

If no custom fields were sent from WorkSpan, this section will not appear at all.