Managing web components
The InCountry Data Residency for Salesforce package provides the following web components:
- InCountry Activities
- InCountry Activity Highlights Panel
- InCountry Activity Record Detail
- InCountry Activity Related List Single
- InCountry History Report
- InCountry List View
- InCountry Notes & Attachments
- InCountry Opportunity Products
- InCountry Record Detail
- InCountry Record Duplicates
- InCountry Highlights Panel
- InCountry Record History
- InCountry Related List Quick Links
- InCountry Related List Single
- InCountry Search Panel
- InCountry Search Tab
- InCountry Search Box
- InCountry Search Results
- InCountry Settings (legacy)
InCountry Activities
Description
The InCountry Activities component is a replacement for the native Salesforce component - Activities. This component renders the list of activities in chronological order in breakdown by activity type.
When needed
Display fields with open activities and activity history on the record.
Configuring the InCountry Activities component
In Lightning App Builder, drag the component to the layout.
Select the component to open the settings in the right part of the screen.
In the Additional activity description fields box, list names of fields to display on the component. (Optionally)
In the Set Component Visibility expand block, click + Add Filter. Define the filtration criteria for the component visibility on the layout according to your needs.
Activate the page layout.
InCountry Activity Highlights Panel
note
The InCountry Activity Highlights Panel component is displayed for the Task and Event Salesforce objects in the record details view only.
Description
The InCountry Activity Highlights Panel component is a replacement for the native Salesforce component - Highlights Panel presented for the activity object. This component renders the header that contains page-level actions and the block of key activity fields.
note
This component should be used only for the Task and Event objects instead of the InCountry Highlights Panel component.
When needed
Display key information for specific activities, such as tasks and events.
Configuring the InCountry Activity Highlights Panel component
In Lightning App Builder, drag the component to the layout.
Select the component to open the settings in the right part of the screen.
In the Set Component Visibility expand block, click + Add Filter. Define the filtration criteria for the component visibility on the layout according to your needs.
Activate the page layout.
InCountry Activity Record Detail
note
The InCountry Activity Record Detail component is displayed in the record details view only.
Description
The InCountry Activity Record Detail is a replacement for the native Salesforce component - Record Detail which should be configured specifically for the Activity object. This component renders the block of fields displaying the activity record information.
When needed
Display fields with sensitive and generic information about records pertaining to the Activity object.
Configuring the InCountry Activity Record Detail component
In Lightning App Builder, drag the component to the layout.
Select the component to open the settings in the right part of the screen.
In the Set Component Visibility expand block, click + Add Filter. Define the filtration criteria for the component visibility on the layout according to your needs.
Activate the page layout.
InCountry Activity Related List Single
note
The InCountry Activity Related List Single component is displayed in the record details view only.
Description
The InCountry Activity Related List Single component is a replacement for the native Salesforce component - Related List Single displayed for the Activity object. This component renders a list of related activities for a record.
When needed
Display a list of related records for an activity.
Configuring the InCountry Activity Related List Single component
In Lightning App Builder, drag the component to the layout.
Select the component to open the settings in the right part of the screen.
In the Field API Name box, enter the API name of the lookup field to display the Salesforce object (for example
whatID
,whoID
). For the details, please see documentation.In the Object API Name box, enter the Salesforce Activity object whose data you want to display (for example
Task
,Event
).In the Field Set API Name box, enter the API name of the Field Set. The field set defines which fields will be displayed on the component. The field set can be created in Object Manager. If you want to use the standard InCountry Field Set, add a namespace (for example
testInCountry1__default
).Select the related list type:
Default - display a default related list type.
Basic List - display records as a list.
Tile - display records as a tile.
In the Set Component Visibility expand block, click + Add Filter. Define the filtration criteria for the component visibility on the layout according to your needs.
Activate the page layout.
InCountry History Report
Description
The InCountry History Report component displays a historical report on record changes.
When needed
Display a historical report on record changes.
Configuring the InCountry History Report component
In Lightning App Builder, drag the component to the layout.
Select the component to open the settings in the right part of the screen.
In the Set Component Visibility expand block, click + Add Filter. Define the filtration criteria for the component visibility on the layout according to your needs.
Activate the page layout.
InCountry List View
Description
The InCountry List View component is a replacement for the native Salesforce component - List View. This component renders the list of records with regulated data and allows you to scroll down the list of these records.
When needed
Display a list of records with regulated data queried from the InCountry platform.
Configuring the InCountry List View component
In Lightning App Builder, drag the component to the layout.
Select the component to open the settings in the right part of the screen.
In the Object API name box, enter the Salesforce object whose data you want to display.
In the Set Component Visibility expand block, click + Add Filter. Define the filtration criteria for the component visibility on the layout according to your needs.
Activate the page layout.
InCountry Notes & Attachments
note
The InCountry Notes & Attachments component is displayed in the record details view only.
Description
The InCountry Notes & Attachments component allows you to view, download and upload files pertaining to the currently opened Salesforce record. Such attachments are managed on the InCountry platform and are not physically stored in Salesforce according to the compliance requirements.
When needed
Manage attachments in a compliant way in Salesforce.
Configuring the InCountry Notes & Attachments component
In Lightning App Builder, drag the component to the layout.
Select the component to open the settings in the right part of the screen.
In the Set Component Visibility expand block, click + Add Filter. Define the filtration criteria for the component visibility on the layout according to your needs.
Activate the page layout.
InCountry Opportunity Products
note
The InCountry Opportunity Products component is displayed in the record details view only.
Description
The InCountry Opportunity Products component renders all product records associated with the opened opportunity.
When needed
Display products related to a specific opportunity.
Configuring the InCountry Opportunity Products component
In Lightning App Builder, drag the component to the layout.
Select the component to open the settings in the right part of the screen.
In the Set Component Visibility expand block, click + Add Filter. Define the filtration criteria for the component visibility on the layout according to your needs.
Activate the page layout.
InCountry Record Detail
note
The InCountry Record Detail component is displayed in the record details view only.
Description
The InCountry Record Detail component is a replacement for the native Salesforce component - Record Detail. This component renders the block of fields displaying the record information.
When needed
Display fields with sensitive and generic information about records pertaining to a specific Salesforce object.
Configuring the InCountry Record Detail component
In Lightning App Builder, drag the component to the layout.
Select the component to open the settings in the right part of the screen.
In the component property editor, check the box Enable Google Search in Address Fields if you want to enable address lookup using Google Maps.
In the Set Component Visibility expand block, click + Add Filter. Define the filtration criteria for the component visibility on the layout according to your needs.
Activate the page layout.
InCountry Record Duplicates
note
The InCountry Record Duplicates component is displayed in the record details view only.
Description
The InCountry Record Duplicates component renders the duplicate records for the currently opened record.
It checks record duplicates stored on the InCountry platform with the resident function taking a record identifier for a check.
warning
The InCountry Record Duplicates component cannot be used without the InCountry Highlights Panel and InCountry Record Detail components, otherwise duplicates are not displayed.
When needed
Display duplicate records for a specific Salesforce record.
Configuring the InCountry Record Duplicates component
In Lightning App Builder, drag the component to the layout.
Select the component to open the settings in the right part of the screen.
In the Function name to find duplicates box, enter the resident function name to find duplicates.
In the Set Component Visibility expand block, click + Add Filter. Define the filtration criteria for the component visibility on the layout according to your needs.
Activate the page layout.
InCountry Highlights Panel
Description
The InCountry Highlights Panel component renders the header that contains page-level actions.
When needed
Display links to perform quick actions on the record.
Configuring the InCountry Highlights Panel component
In Lightning App Builder, drag the component to the layout.
Select the component to open the settings in the right part of the screen.
In the Set Component Visibility expand block, click + Add Filter. Define the filtration criteria for the component visibility on the layout according to your needs.
Activate the page layout.
InCountry Record History
note
The InCountry Record History component is displayed in the record details view only.
Description
The InCountry Record History component is a replacement for the native Salesforce component - Related List Single. This component renders records related to the record history.
When needed
Display the record history.
Configuring the InCountry Record History component
In Lightning App Builder, drag the component to the layout.
Select the component to open the settings in the right part of the screen.
In the Set Component Visibility expand block, click + Add Filter. Define the filtration criteria for the component visibility on the layout according to your needs.
Activate the page layout.
InCountry Related List Quick Links
Description
The InCountry Related List Quick Links component is a replacement for the native Salesforce component - Related List Quick Links. This component renders multiple links to preview related list data.
When needed
Display the links to view all the related list columns without opening the View All page.
Configuring the InCountry Related List Quick Links component
In Lightning App Builder, drag the component to the layout.
Select the component to open the settings in the right part of the screen.
In the Limit of records box, specify the maximal number of records to display.
In the Set Component Visibility expand block, click + Add Filter. Define the filtration criteria for the component visibility on the layout according to your needs.
Activate the page layout.
InCountry Related List Single
note
The InCountry Related List Single component is displayed in the record details view only.
Description
The InCountry Related List Single component is a replacement for the native Salesforce component - Related List Single. This component shows a list of related records for a specific Salesforce record.
note
The InCountry Related List Single component does not support the Activity and Opportunity products since these objects have special components.
When needed
Display a list of related records for a specific Salesforce record.
Configuring the InCountry Related List Single component
In Lightning App Builder, drag the component to the layout.
Select the component to open the settings in the right part of the screen.
In the Child Object’s Lookup field API Name box, enter the API name of the lookup field from the child object to display the Salesforce object (for example
AccountID
).In the Child Object’s API Name box, enter the Salesforce object whose data you want to display (for example
Contact
).In the Child Object’s Field Set API name box, enter the API name of the field set from the child object. A field set defines which fields will be displayed on the component. A field set can be created in Object Manager. If you want to use the standard InCountry Field Set, add a namespace (for example
testInCountry1__default
).Select the related list type:
Default - display a default related list type.
Basic List - display as List.
Tile - display as Tile.
In the Set Component Visibility expand block, click + Add Filter. Define the filtration criteria for the component visibility on the layout according to your needs.
Activate the page layout.
Configuring the InCountry Related List Single component for the Campaign Member object
Creating a field set for the Campaign Member object
A field set defines which fields will be displayed on the component. To create a field set for the Campaign Member object, follow these instructions:
From Setup, select Object Manager.
On the list with objects, search for the
CampaignMember
custom object by its system name and click it. The actual object name may vary depending on the package version.On the sidebar, click Field Sets.
In the top right part of the screen, click New.
In the Field Set Label box, enter the label of the field set for the Campaign Member object.
In the Field Set Name box, enter the API name of the field set for the Campaign Member object.
In the Where is this used? box, enter description where the field set is used for the Campaign Member object.
When complete, click Save.
Click the down arrow icon next to the field set you created and select Edit.
Drag the Status field to the layout of the form to add the Status field to the field set.
Click Save.
note
The Status field is required for operation of the InCountry Related List Single component for the Campaign Member object.
Adding the InCountry Related List Single component for the Campaign Member object
In Lightning App Builder, drag the component to the layout.
Select the component to open the settings in the right part of the screen.
In the Child Object’s Lookup field API Name box, enter
CampaignID
.In the Child Object’s API Name box, enter
CampaignMember
.In the Child Object’s Field Set API name box, enter the API name of the field set you created.
Select the related list type:
Default - display a default related list type.
Basic List - display as a list of records.
Tile - display as a tile of records.
In the Set Component Visibility expand block, click + Add Filter. Define the filtration criteria for the component visibility on the layout according to your needs.
Activate the page layout.
InCountry Search Panel
Description
The InCountry Search Panel component renders a search panel to look up records stored on the InCountry platform.
When needed
Display a search panel to look up records stored on the InCountry platform.
Configuring the InCountry Search Panel component
In Lightning App Builder, drag the component to the layout.
Select the component to open the settings in the right part of the screen.
In the Set Component Visibility expand block, click + Add Filter. Define the filtration criteria for the component visibility on the layout according to your needs.
Activate the page layout.
InCountry Search Tab
Description
The InCountry Search Tab component renders a tab to look up records stored on the InCountry platform.
note
The InCountry Search Tab component is used as a container for the InCountry Search Box and InCountry Search Results components. You need to place both components into this container. Without adding the InCountry Search Results component, no search results are displayed in the InCountry Search Tab component.
When needed
Perform record lookup across the InCountry platform.
Configuring the InCountry Search Tab component
In Lightning App Builder, drag the component to the layout.
Select the component to open the settings in the right part of the screen.
In the Set Component Visibility expand block, click + Add Filter. Define the filtration criteria for the component visibility on the layout according to your needs.
Activate the page layout.
InCountry Search Box
Description
This component allows you to search records on the InCountry platform. The results are shown in the InCountry Search Results component.
note
The InCountry Search Box component cannot be used without the InCountry Search Results component, otherwise search results are not displayed.
When needed
Look up regulated records stored on the InCountry platform.
Configuring the InCountry Search Box component
In Lightning App Builder, drag the component to the layout.
Select the component to open the settings in the right part of the screen.
In the Set Component Visibility expand block, click + Add Filter. Define the filtration criteria for the component visibility on the layout according to your needs.
Activate the page layout.
InCountry Search Results
Description
This component renders search results of the regulated records stored on the InCountry platform.
note
The InCountry Search Results component cannot be used without the InCountry Search Box component, otherwise search results are not be displayed.
When needed
Display search results of the regulated records stored on the InCountry platform.
Configuring the InCountry Search Results component
In Lightning App Builder, drag the component to the layout.
Select the component to open the settings in the right part of the screen.
Select the view to render search results:
Table - display results in a table.
Tile - display results as a tile.
In the Set Component Visibility expand block, click + Add Filter. Define the filtration criteria for the component visibility on the layout according to your needs.
Activate the page layout.
InCountry Settings (legacy)
Description
The InCountry Settings (legacy) component renders the configuration section to manage data regulation policies and protected fields in the InCountry Data Residency for Salesforce package.
When needed
Display the configuration section to manage data regulation policies and protected fields.
Configuring the InCountry Settings (legacy) component
In Lightning App Builder, drag the component to the layout.
Select the component to open the settings in the right part of the screen.
In the Set Component Visibility expand block, click + Add Filter. Define the filtration criteria for the component visibility on the layout according to your needs.
Activate the page layout.