Skip to content

Commit eebf67e

Browse files
authored
Merge pull request #5323 from segmentio/charity-dos-update
Update Salesforce doc
2 parents d1f5840 + f14b28b commit eebf67e

File tree

1 file changed

+18
-8
lines changed
  • src/connections/sources/catalog/cloud-apps/salesforce

1 file changed

+18
-8
lines changed

src/connections/sources/catalog/cloud-apps/salesforce/index.md

Lines changed: 18 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -8,15 +8,15 @@ id: 2baks93n
88

99
Take your company's analysis to the next level by **adding Salesforce as a Source to Segment.** Segment automatically collects objects like `Accounts`, `Campaigns`, and `Tasks` and loads them into your data warehouse. 
1010

11-
## Getting Started
11+
## Getting started
1212
> info ""
1313
> You can add multiple instances of this source if you have more than one Salesforce account.
1414
1515
1. From the `/sources` page in your Workspace, click `Add Source`.
1616

1717
2. Choose Salesforce.
1818

19-
3. Give the source a name, add labels, if applicable, and select the Salesforce environment you'd like to pull data from. To use data from a Salesforce sandbox environment, select **Sandbox** from the Salesforce Environment dropdown and [contact Segment Support](https://segment.com/help/contact/). The support team will configure your source to use sandbox data.
19+
3. Give the source a name, add labels, if applicable, and select the Salesforce environment you'd like to pull data from. To use data from a Salesforce sandbox environment, select **Sandbox** from the Salesforce Environment dropdown and [contact Segment Support](https://segment.com/help/contact/){:target="_blank"}. The support team will configure your source to use sandbox data.
2020

2121
4. Connect Segment to your Salesforce environment and authorize Segment to connect to it. In order for Segment to collect and sync your Salesforce data, you must enable API access for the user that you are connecting to Segment with. For more information on how to confirm or change API access for a Salesforce user, follow Salesforce's [recommended documentation](https://help.salesforce.com/articleView?id=admin_userperms.htm){:target="_blank"}.
2222

@@ -95,24 +95,34 @@ Collections are the groupings of resources Segment pulls from your source. In yo
9595
| `user_login` | object | Represents the settings that affect a user's ability to log into an organization. This object is available in API version 29.0 and later. Corresponds to [UserLogin](https://developer.salesforce.com/docs/atlas.en-us.api.meta/api/sforce_api_objects_userlogin.htm) resource in Salesforce |
9696
| `role` | object | A role in your organization. Corresponds to [UserRole](https://developer.salesforce.com/docs/atlas.en-us.api.meta/api/sforce_api_objects_userrole.htm) resource in Salesforce |
9797

98-
### Custom Objects
98+
### Custom objects
9999

100100
Select and add custom objects from the Selective Sync page in the Salesforce source settings.
101101

102-
### Deleting Records
102+
### Deleting records
103103

104104
Segment supports the use of soft deletes in Salesforce. If you perform a soft delete on a record in Salesforce, your next one to two warehouses syncs will change the value of `is_deleted` for the associated record to `True`.
105105

106106
Segment does not support hard deletes in Salesforce. Use of hard deletes will result in the data remaining in the warehouse with `is_deleted` set to `False`.
107107

108-
## Collection Properties
108+
## Collection properties
109109

110-
Segment performs a one-to-one mapping of all publicly available fields (standard and custom) from Salesforce. To see the full list of the standard fields refer to the Salesforce field documentation linked in each collection above. If you've added and selected custom fields to an existing collection, [contact Segment Support](https://segment.com/help/contact/) to configure them to sync. You do not need to include the field names.
110+
Segment performs a one-to-one mapping of all publicly available fields (standard and custom) from Salesforce. To see the full list of the standard fields refer to the Salesforce field documentation linked in each collection above.
111111

112-
## Adding Destinations
112+
## Adding destinations
113113

114114
Warehouses are the only supported destination for object-cloud sources.
115115

116+
## Historical data
117+
When a new Object/Collection is enabled, Segment automatically runs a full historical re-sync on that Object.
118+
119+
However, for custom properties/columns, Segment only populates the custom property with data that comes in after the custom field was enabled. In order to populate the new custom field(s) for records that have previously been synced, you need to initiate a manual re-sync.
120+
121+
For Salesforce, Segment uses the `SystemModstamp`(system_modstamp) field to checkpoint collections that sync incrementally. When enabled, Segment syncs collections incrementally. When disabled, Segment syncs collections fully. If you'd like to force a collection to sync fully on the next run to bring in historical data, you can disable the `SystemModstamp` field on the collection, allow the next sync to complete and then re-enable `SystemModstamp` so the collection syncs incrementally in the coming syncs.
122+
123+
If you've added and selected custom fields to an existing collection and would not like to use `SystemModstamp` to bring in historical data, [contact Segment Support](https://segment.com/help/contact/){:target="_blank"} to configure them to sync. You do not need to include the field names.
124+
125+
116126
## Troubleshooting
117127

118-
If you are syncing data from a Salesforce sandbox environment and see an "Invalid credentials" error, [contact Segment Support](https://segment.com/help/contact/), who will configure your Segment source to use sandbox data.
128+
If you are syncing data from a Salesforce sandbox environment and see an "Invalid credentials" error, [contact Segment Support](https://segment.com/help/contact/){:target="_blank"} to configure your Segment source to use sandbox data.

0 commit comments

Comments
 (0)