Quick start guide for legacy package
About this document
This document provides a step-by-step guide on how to get started with the legacy package supporting the trigger-based replication model.
Prerequisites
Before installing the package, you need to check and enable the following prerequisites:
Chatter
- This is a required feature for the package installation. It is used in the InCountry debugging tool.
Orders
- This is a required feature for the package installation. Enable Orders only if you need to regulate this object.
Package installation
note
For the details on package installation, please ๐ check our documentation.
Log in to your Salesforce instance.
Create the installation URL for the InCountry Data Residency for Salesforce package by combining the following:
Address of your Salesforce instance:
https://{your-salesforce}.lightning.force.com/
.Package URL path:
packaging/installPackage.apexp?p0=04t3R000000c4QQQQI
(example)
Install the InCountry Data Residency for Salesforce package for Salesforce administrators.
note
Contact your Technical Account Manager to get the installation URL to the latest package version.
The resulting URL address for package installation should be similar to the following pattern:
https://{your-salesforce}.lightning.force.com/packaging/installPackage.apexp?p0=04t3R000000c4QQQQI
Assigning permission sets
note
For the details on management of permission sets, please ๐ check our documentation.
Navigate to Setup > Administration > Users > Permission Sets.
Assign the
InCountry User
andInCountry Admin
permission sets to appropriate Salesforce users.
Enabling Identity Provider
note
If you encounter the Data Not Available error, please check whether the Identity Provider is enabled in your Salesforce organization.
Navigate to Setup > Settings > Identity > Identity Provider.
Click Enable Identity Provider. This action will generate a self-signed certificate.
Select the recently created self-signed certificate and click Save.
Upon confirmation in the prompted dialog box, you will see details of the identity provider setup.
Now you can proceed with the registration of the certificate.
note
Please do not share details of the identity provider setup with InCountry or any third party.
Configuring Remote Site settings
Navigate to Setup > Security > Remote Site Settings.
Click New Remote Site.
Enter the provided REST endpoint (for example,
https://sa-restapi-mt-01.api.incountry.io/
) into the Remote Site URL box.
warning
Please consider that the REST endpoint differs depending on the country where your regulated data is stored.
Setting up OAuth2 authentication and authorization
Before configuring OAuth2 authorization for the package, you need to create an account on the InCountry Portal.
Please follow these steps:
Configure an authentication provider for a Salesforce organization.
Create a custom metadata type for a REST API endpoint.
Register named credentials in a Salesforce organization.
Configure a custom metadata type for a Salesforce organization.
Configuring data regulation policies
note
For the details on configuration of data regulation policies, please ๐ check our documentation.
Select Settings.
Select the Salesforce object.
Select the data regulation policy.
Select the restriction type for the Salesforce object.
Specify the country for storing regulated data of the current Salesforce object.
Click Add.
Configuring protected fields
note
For the details on the configuration of protected fields, please ๐ check our documentation.
Select Settings.
Select the Salesforce object.
Click Add Field.
Select the field that will be treated as protected, select the hash function, and adjust optional parameters if needed.
Click Add.
Additional configuration
Create Apex triggers for each Salesforce object having protected fields with regulated data.
Add the Poller component on Detail View.
Using the application
Once you have configured the application correctly, you can proceed with the management of records containing regulated data in Salesforce.
If you use the replication data regulation policy, your user experience will not differ from the native user experience in Salesforce.