Once you have installed the InCountry for Salesforce package, you need to complete its initial setup, so it can make data requests to REST SDK.
Upon successful installation, the InCountry for Salesforce package creates two user accounts for work, as follows:
InCountry Admin - can administer the InCountry Salesforce package and set up data regulation policies for Salesforce objects.
InCountry User - can work within the InCountry interface and manage Salesforce objects.
You need to assign regular Salesforce users to each the InCountry-specific user account depending on their roles within your organization. Each user account can be associated with multiple users. Users who are not assigned to the InCountry Admin or InCountry User account will not be able to load the InCountry interface in Salesforce.
From Setup, click Users and then select Permission sets.
On the list with users, locate the user named as InCountry User or InCountry Admin.
Click this user.
On the opened page, click Manage Assignments.
Within the opened permission set you can view users who attribute to InCountry User or InCountry Admin. They will be able to work within the InCountry for Salesforce app according to the granted permission level.
Here you can manage users, as follows:
- Adding users to the permission set
- Removing users from the permission set
Adding users to the permission set
Within the opened InCountry User permission set, click Add Assignments.
On the All Users page, select users that you want to assign to the InCountry User permission set.
Removing users from the permission set
Within the opened InCountry User or InCountry Admin permission set, select users that you want to remove the assignment from.
Click Remove Assignments.
InCountry REST Endpoint management
The InCountry for Salesforce package pre-defines the REST endpoints for data communication between Salesforce and the InCountry Platform. You can manage these REST endpoints if needed and change them for some custom ones.
From Setup, click Custom Code, then select Custom Metadata Types.
On the Custom Metadata Types page, locate the
InCountryRestApiEndpointobject and click Manage Records.
On the opened InCountryRestApiEndpoint page, locate the country which REST API endpoint you want to modify.
For the required country, click Edit.
On the opened page, you can modify the following:
- Label - enter the label of the country in the ISO format (upper case).
- InCountryRestApiEndpoint Name - enter the label of the country in the ISO format (upper case).
- Country - select the country from the prompted variants.
- Endpoint - specify another InCountry REST API endpoint in the target country. Contact the InCountry team to get the actual endpoint address.
- Default - check the box to use the current InCountry REST API endpoint as default for all data requests.
- Token - enter the token name as '
- CertificateNameServerless - enter the name of the certificate for serverless functions. You need to enter the name of the certificate which was issued for serverless functions without the *.JKS file extension, so that only the certificate name remains. The pattern for this looks like '
- CertificateNameApi - enter the certificate name for performing requests from the backend. This is applicable to the replication model. The name of such certificate is individual for each customer.
- CertificateNameRest - enter the certificate name for performing REST API requests from the frontend. Such requests are performed through the dedicated
/sfendpoint of InCountry REST API and authorization of such requests is executed with a JWT token. This is applicable to the redaction model. The name of such certificate is individual for each customer.
- CertificateNameBatch - name of the certificate for batch data operations. You need to enter the name of the certificate which was issued for batch operations without the *.JKS file extension, so that only the certificate name remains. The pattern for this looks like '
When complete, click Save.
Please avoid modifying these parameters if not needed.
To create a new InCountry REST endpoint:
Initiate the management of records within the
Above the table with REST endpoints, locate the New button and click it.
On the opened page, fill out details for the REST endpoint as described above for management of REST endpoints. To get the actual address of REST endpoint, please contact the InCountry team.
When complete, click Save.
The InCountry for Salesforce package requires certificates to perform the client-side requests to InCountry REST SDK. All the certificates must be provided in the JKS format.
You need to upload the following certificates:
incountry- the generic certificate for performing data requests to the InCountry Platform. This is a required certificate.
serverless- the certificate to perform serverless functions. This is an optional certificate.
batch- the certificate to perform batch data operations (for data migration). This is an optional certificate.
You will have to specify the certificate names in the corresponding InCountry REST API endpoints. Depending on your setup, some certificate may not be needed.
Get a certificate from InCountry.
From Setup, click Security, then select Certificate and Key Management.
On the Certificate and Key Management page, click Import from Keystore.
Select the certificate file and enter the keystore password.
Once you have uploaded the certificates, the InCountry for Salesforce app is ready for operation.
Management of InCountry flags
The InCountry for Salesforce app package introduces a set of custom metadata types, so called flags. These flags regulate the activation of specific features within the package.
- From Setup, click Custom Code, then select Custom Metadata Types.
- On the Custom Metadata Types page, locate the
InCountry Flagobject and click Manage Records. The list with flags opens, as follows:
The list of InCountry flags includes the following:
- CountryISOFromUserProfile - this flag regulates the fetching of the country location from the user profile, otherwise it is determined automatically from the IP address.
- EnableRangeKeyFilter - this flag regulates the usage of the range key filter for searching for numeric values within the specified range.
- PIIFieldsAutoConfiguration - this flag regulates the automatic configuration of the PII fields for Salesforce objects based on the common patterns.
To enable or disable the flag:
- On the list with flags, locate the flag which you want to enable or disable.
- Click the flag name.
- On the opened page, click Edit.
- Select or clear the IsEnabled box.
- Click Save.