Accelerate the Value of Data

Configure your Salesforce Connector Profile

Learn how to configure your Salesforce connector profile for your Reltio tenant using this endpoint.

You manage data synchronization between Salesforce and the Reltio platform with the Salesforce Connector profile.

Configure or create a Salesforce connector profile to map data fields between the two systems with the endpoint below. For information on configuration endpoints, see topic Salesforce Connector Configuration API

Request

POST {Salesforce connector URL}\configuration\{tenantId}\{profileName}

Use the parameters added for the Request task, listed in Table 1: Request Parameters.

Table 1. Request Parameters
Parameter Required Description
HeadersAuthorizationYesThe Access Token in format "Bearer <accessToken>". For more information, see Authentication API)
Content-TypeYesThe value must be "Content-Type: application/json".
QuerytenantIdYesDefines the ID of the tenant.
QueryprofileNameYesDefines the name of the Profile.

If this profile name already exists, the request overwrites the previous profile but retains the original ReltioSQS property . Otherwise it create a new profile.

QuerygenerateDefaultMappingYesDefines the default mapping, which is generated. The possible values are true or false. The default value is false. The parameter will be processed only for new profiles. The default mapping may be generated only if tenant contains the source configuration/sources/Salesforce.
BodyYes
{
    "statisticsEnabled": true,
    "salesforce": {
        "namespace": "rtsync",
        "loginUrl": "<sfdcLoginUrl>",
        "user": "<sfdcServiceUser>",
        "password": "<sfdcServicePassword>",
        "pollTime": <300 by default, not required>
	"checkFieldsChanged": <true/false>
    },
    "reltio": {
        "tenantUrl": "<tenanApiUrl | https://env.reltio.com/reltio/api/tenantId",
        "authUrl": "<authUrl | https://auth-stg.reltio.com - not required>",
        "username": "<reltiServiceUser - not required>", //
        "password": "<reltiService - not required>",
        "authToken": "<cmVsdGlvX3VpOm1ha2l0YQ== not required>",
        "batchSize": <50 by default, not required>,
        "maxapicall": <300 by default, not required>,
    },
    "reporting": {
        "email": "some.email@example.com",
        "reportConnection": true
         "logSyncErrors": true
    }
}

Use the parameters added for Salesforce profile configuration listed in Table 2: Parameters for Salesforce Profile Configuration.

Table 2. Parameters for Salesforce Profile Configuration
ParameterRequiredDescription
statisticsEnableNoEnables statistics for a tenant and profile. This parameter is set to false by default.
Note: The Events API doesn't work if statistics are disabled.
namespaceNoDefines the name of the namespace.
loginUrlYesDefines the Salesforce URL.
userYesDefines the Salesforce service user.
passwordYesDefines the Password for a salesforce user.
pollTime NoDefines the time in seconds to poll Salesforce for changes. The default value is 300.
checkFieldsChanged No
Determines whether the Reltio Integration for Salesforce generates an event when at least one mapping field is changed in the Salesforce Connector profile:
  • True - Event is generated
  • False - Event isn't generated (default)
Note: After you set this parameter, resync the Reltio Integration for Salesforce from Reltio Control panel. Reltio Integration for Salesforce gathers the changed field details, creates an event to synchronize the data between Salesforce and Reltio, and generates a list.

Use the parameters added for Reltio profile configuration listed in Table 3: Parameters for Reltio Profile configuration.

Table 3. Parameters for Reltio Profile configuration
ParameterRequiredDescription
tenantUrlYesDefines the URL of the Tenant.
authUrlNoDefines the authorization server URL. For more information, see Reltio Integration for Salesforce Profile Validation.
usernameNoDefines the username of the Reltio service users.
passwordNoDefines the password of the Reltio service users.
authTokenNoDefines an Authentication token. For more information, see Reltio Integration for Salesforce Profile Validation.
batchSizeNoDefines the number of entities to process at a time. The default value of the parameter is 50.
maxapicallNoDefines the maximum number of API requests made to Reltio.
deltaFilteringNo If true, the connector only processes events with updates to attributes available in the mapping, ignoring the events with no updates to mapped attributes. The default value of the parameter false.
Use the parameters added for the Reporting profile configuration listed in Table 3: Parameters for Reporting Profile configuration.
Table 4. Parameters for Reporting Profile configuration
ParameterRequiredDescription
emailNoDefines a valid email for sending the notifications.The connector supports email notifications about connection problems and/or configuration changes for specific profiles.
reportConnectionNoDefines the values depending upon which the connector sends the emails. If the value of the parameter is true, the connector sends the emails regarding the connection problems to the profile owner.

This is an optional parameter. By default, the parameter is set to false.

reportProfileChangesNoDepending upon the value of this parameter, the connector sends the emails regarding the changes in the profile configuration.

If the value of the parameter is true, the connector sends the emails for the changes in the profile configuration settings (tenantUrl, loginUrl, user) to the profile owner. This is an optional parameter. By default, the value of the parameter is false.

logSyncErrorsNoEnables Reltio for logging Salesforce synchronization errors. This is an optional parameter. The possible values of the parameter are true and false. By default, the value of the parameter is false.
logSyncErrorsToActivityLogNoActivates reporting to the Reltio Activity Log. It allows you to notify the tenant and particular entity in case of synchronization. By default, the value of the parameter is set as false.

Response


Success: 200 status: {profileName} has been updated}
Error: 400 Bad Request, { error: {reason}}

For more information, see Salesforce Connector API Error Codes.