There are a number of custom setting objects present in the package. All of them control different areas of the product. Some of them are for general use, others more for internal use. This document provide detailed information regarding what each custom setting and related fields do.
IMPORTANT: Unless explicitly directed by Customer Support, any custom setting record should not be directly interacted with.
Overview
Name | Purpose | Visibility | Since |
It provides mapping instructions for transferring of values between Salesforce standard and custom object records | Public | 1.31 | |
It defines the level of logging that will be output (and also received by the backend) | Public | 2.119 | |
It defines the users who will receive an email alert in case the synchronization process has not run for a given time | Public | 2.22 | |
It defines the general options that influence the syncing behavior | Public | 1.4 | |
It defines which SalesWings triggers are allowed to run. | Public | 2.118 | |
It defines the options for each step of the synchronization process | Public | 2.81 |
This document will now provide detailed information regarding what each custom setting and related fields do.
SW Studio Options
It stores the general preferences that influence the synchronization behavior.
The Fields
Name | Description | Default Value | Since |
Account Aggregation | It controls whether contact tags and scores will be aggregated at the Account level. |
| 2.41 |
Apex Jobs Number Threshold | It controls the number of job execution records to keep. Each time the synchronization runs a related job record will be created containing the details of all the steps, times and records processed, as well as their completion status. |
| 2.52 |
API Endpoint | It stores the URL used to contact the SalesWings backend |
| 1.4 |
SW Activity Data | It determines whether page visits will be included in the synchronization process. When enabled SW Activity data is NOT synced |
| 2.12 |
Disable Triggers | It determines whether the send-update-to-saleswings triggers will be executed in the Salesforce org. The update consists of communicating to SalesWings when a person account, contact or lead changes name, email, favorite or owner. This is used to keep the SalesWings data in sync with the changes occurred in Salesforce |
| 1.95 |
External Requests Timeout (secs.) | It determines the maximum time in seconds Salesforce will wait in order to receive a response from SalesWings backend |
| 2.45 |
Match Accounts via Platform Events | It determines whether updates to accounts will be performed synchronously - during the batch execution - or asynchronously - by means of platform events. This option is normally disabled but it might be necessary to activate it depending on the org’s complexity. Some orgs run code that is incompatible when executed in a batch context (e.g. future events). Using platform events provides a workaround to such limitation. |
| 2.120 |
Match Contacts via Platform Events | It determines whether updates to contacts will be performed synchronously - during the batch execution - or asynchronously - by means of platform events. This option is normally disabled but it might be necessary to activate it depending on the org’s complexity. Some orgs run code that is incompatible when executed in a batch context (e.g. future events). Using platform events provides a workaround to such limitation. |
| 2.103 |
Match Leads via Platform Events | It determines whether updates to leads will be performed synchronously - during the batch execution - or asynchronously - by means of platform events. This option is normally disabled but it might be necessary to activate it depending on the org’s complexity. Some orgs run code that is incompatible when executed in a batch context (e.g. future events). Using platform events provides a workaround to such limitation. |
| 2.103 |
Opportunity Scores | It controls whether contact scores will be copied from the account and present in the opportunity associated with the said account. This option requires the enablement of the Accounts scores option. |
| 2.41 |
Opportunity Tags | It controls whether contact tags will be copied from the account and present in the opportunity associated with the said account. This option requires the enablement of the Accounts scores option. |
| 2.41 |
Sync Gap (in minutes) | It determines the amount of minutes the sync will wait before running again. |
| 1.4 |
Visit Sync Range | This field is currently unused. |
| 1.25 |
Deprecated Fields
Name | Since |
Account Score Batch Size | 2.119 |
Allow SalesWings Data Cleanup | 2.119 |
Attribute Delete Batch Size | 2.119 |
Attribute Endpoint Override | 2.119 |
Batch Size | 2.119 |
Data Truncation Enabled | 2.119 |
Disable Email Log | 2.119 |
Log Batch Size | 2.119 |
Logging Enabled | 2.119 |
Logging Endpoint | 2.119 |
Log Level | 2.119 |
Map Score Only When Modified | 2.119 |
Match Batch Size | 2.119 |
Page Count | 2.119 |
Page Size | 2.119 |
Throw Permission Exceptions | 2.119 |
Visit Sync Reset | 2.119 |
SW Studio Workflow Options
It stores the preferences of each synchronization step.
The Fields
Name | Description | Default Value | Since |
Name | It matches the name of the synchronization step as defined in the code. This value should never be touched! |
| 2.81 |
Batch Size | It determines the number of record to be processed in a given transaction. Due to Salesforce limits, org composition and amount of SalesWings data to process a value that fit all doesn’t exist. The encouraged setting is normally 200, but it can be tweaked so as to avoid hitting Salesforce limits. |
| 2.81 |
Cadence | It determines how often the step will be executed. The possible values are:
|
| 2.90 |
Internal Execution Date | This date is used for internal calculations. Internal use only! |
| 2.119 |
Is Disabled | It determines whether the step will be included in the synchronization process or not. |
| 2.119 |
Last Execution | It stores the last date the synchronization step has run successfully. |
| 2.90 |
Deprecated Fields
Name | Since |
Batch Job Name | 2.119 |
Enabled | 2.119 |
Log Threshold | 2.119 |
SW Studio Trigger Handler Routine
It controls which package triggers are allowed to run. SW Studio currently deploys triggers for the following object:
Account
Contact
Lead
The Fields
Name | Description | Default Value | Since |
Class Name | The name of the class containing the trigger logic |
| 2.118 |
Is Disabled | It determines whether the trigger runs |
| 2.118 |
JSON Options | It holds information that will be passed to the class that holds the trigger logic (to determine further behavior) |
| 3.2 |
SObject Type | The object the trigger refers to |
| 2.118 |
Sort Order | The order in which the trigger will be executed (if there are other configurations for the same object present) |
| 2.118 |
SW Studio Field Mapping
It provides mapping instructions for the transferring of values between Salesforce standard and custom object records.
The Fields
Name | Description | Default Value | Since |
Is Disabled | When ticked, the mapping is ignored and the score will only remain stored in the SW Score object. |
| 3.0 |
Name | A friendly name to uniquely describe the mapping. Since it must be unique, it is good practice to name a mapping following this convention: {0}-{1}-{2} where:
|
| 1.31 |
Default Value | Used for contact/lead mapping. The value that needs to be applied in case the the contact/lead isn’t matched by the prospect or prospect score anymore. |
| 2.1 |
Source Field API Name | The object field to read the value from |
| 1.31 |
Source Object API Name | The source object the mapping is referring to. Supported values are:
|
| 1.31 |
SW Score | Used uniquely when defining prospect score mappings. It refers to the SalesWings identifier for a given score. This value is necessary to correctly identify the right prospect score attached to the contact/lead, read its value, and copy it over into the contact/lead. |
| 2.12 |
Target Field API Name | The destination object the mapping is referring to. |
| 1.31 |
Target Object API Name | The object to write the value to |
| 1.31 |
SalesWings Prospect to Salesforce Prospect
Each SalesWings prospect received from the backend gets synchronized with its Salesforce counterpart. The mapping defines what properties get copied in which Salesforce Prospect field.
Salesforce Prospect to Contact or Lead
This mapping defines what fields get copied from the prospect to the matching contact or lead.
Salesforce Prospect Score to Contact or Lead
This mapping defines what prospect score values get copied to the matching contact or lead.
Salesforce Prospect Score to Account
This mapping defines what prospect score values get copied to the matching account:
Attribute Id: the id of the score definition (e.g. lead-score)
Source Object API Name:
Account_Score__c
Source Field API Name:
Value__c
Target Object API Name:
Account
Target Field API Name: any custom field receiving the score value
Salesforce Prospect Score to Opportunity
This mapping defines what prospect score values get copied to the matching opportunity:
Attribute Id: the id of the score definition (e.g. lead-score)
Source Object API Name:
Account_Score__c
Source Field API Name:
Value__c
Target Object API Name:
Opportunity
Target Field API Name: any custom field receiving the score value
SW Studio Notification Settings
It defines the users who will receive an email alert in case the synchronization process has not run for a given time.
This setting is of hierarchical type, which means that multiple definition can be created and assigned at:
organizational level: when defined the email alert will be sent to the user that turned the synchronization on
profile level: all the users with the associated profile will be notified
user level: the specified user will be notified
The Fields
Name | Description | Default Value | Since |
Active | It defines whether the notification rule is active. |
| 2.81 |
Notification Threshold (hours) | It defines how many hours of synchronization inactivity will have to pass before triggering the email alert |
| 2.81 |
SW Studio Logger Options
It fine controls the amount of logging output by the managed package, as well as communicating it to the backend.
Multiple profiles can be defined to tweak the logging level of specific namespaces or classes.
The Fields
Name | Description | Default Value | Since |
Appenders | The appender class names that will invoked when logging. Multiple appenders, separated by a comma, can be specified. |
| 2.119 |
Class Names | The classes that will be enabled for logging. Multiple class names, separated by a comma, can be specified. |
| 2.119 |
First Caller Override | This options will override any other logging profile defines as long as the first call to the logging framework was performed by a class belonging to the namespace specified, if any, or class names specified. |
| 2.119 |
Is Disabled | It determines whether the logging profile will be evaluated by the logging framework |
| 2.119 |
Namespaces | The namespaces that will be enabled for logging. This is a quick way to enable logging for all the classes belonging to the same namespace. Multiple namespaces, separated by a comma, can be specified. |
| 2.119 |
Threshold | The threshold level that will be considered for logging. The logging levels supported are the Salesforce ones. |
| 2.119 |
Users | The users that will be considered by the logging framework. If specified only code executed by such users will trigger the logging. Multiple users, separated by a comma, can be specified. |
| 2.119 |
The following SalesWings Custom Settings are currently obsolete:
SalesWings Trigger Option - Deprecated since 2.117.