|
| 1 | +--- |
| 2 | +title: Salesforce Source |
| 3 | +strat: salesforce |
| 4 | +--- |
| 5 | +Salesforce is a leader in on-demand customer relationship management. [Visit Website](http://salesforce.com) |
| 6 | + |
| 7 | +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 load them into your data warehouse. |
| 8 | + |
| 9 | +## Getting Started |
| 10 | + |
| 11 | +1. From your workspace's `/sources` page, click `add source`. |
| 12 | + |
| 13 | +2. Choose Salesforce. |
| 14 | + |
| 15 | +3. Give your source a name. |
| 16 | + |
| 17 | +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). |
| 18 | + |
| 19 | +5. Choose a data warehouse to connect Salesforce to. |
| 20 | + |
| 21 | +6. In your Salesforce source settings you can customize the source nickname and schema name. The nickname is a label used in the Segment interface, and the schema name is the namespace you query against in your warehouse. Both can be whatever you like, but we recommend sticking to something that reflects the source itself, like `Salesforce` for nickname and `sfdc`, `salesforce`, or `sfdc_prod` for the schema name. |
| 22 | + |
| 23 | + **Note:** that you can add multiple instances if you have multiple SalesForce accounts. That's why we allow you to customize the source's nickname and schema name! |
| 24 | + |
| 25 | + |
| 26 | +## Components |
| 27 | + |
| 28 | +### Sync |
| 29 | + |
| 30 | +The Salesforce source contains a sync component, which means Segment makes requests to the Salesforce API on your behalf on a 3 hour interval to pull the latest data into Segment. In the initial sync, we'll grab all the Salesforce objects (and their corresponding properties) according to the Collections Table below. Segment writes the objects into a separate schema, corresponding to the source instance's schema name you designated upon creation. For example, you name the schema `sfdc_prod`, the `leads` collection is accessible at `sfdc_prod.leads` in SQL. |
| 31 | + |
| 32 | +Our sync component uses an upsert API, so the data in your warehouse loaded using sync will reflect the latest state of the corresponding resource in Salesforce. For example, if `ticket_status` goes from `open` to `closed` between syncs, on its next sync that tickets status will be `closed`. |
| 33 | + |
| 34 | +The source syncs and warehouse syncs are independent processes. Source runs pull your data into the Segment Hub, and warehouse runs flush that data to your warehouse. Sources will sync with Segment every 3 hours. Depending on your Warehouses plan, we will push the Source data to your warehouse on the interval associated with your billing plan. |
| 35 | + |
| 36 | +## Collections |
| 37 | + |
| 38 | +Collections are the groupings of resources we pull from your source. In your warehouse, each collection gets its own table. |
| 39 | + |
| 40 | + |
| 41 | +| Collection | Type | Description | |
| 42 | +| ------ | ------ | ------ | |
| 43 | +| accounts | object | An individual account, which is an organization involved with your business (such as customers, competitors, and partners). Corresponds to [Account](https://developer.salesforce.com/docs/atlas.en-us.api.meta/api/sforce_api_objects_account.htm) resource in Salesforce | |
| 44 | +| account_contact_roles | object | The role that a given Contact plays on an Account. Corresponds to [AccountContactRole](https://developer.salesforce.com/docs/atlas.en-us.api.meta/api/sforce_api_objects_accountcontactrole.htm) resource in Salesforce | |
| 45 | +| account_tags | object | Associates a word or short phrase with an Account. Corresponds to [AccountTag](https://developer.salesforce.com/docs/atlas.en-us.api.meta/api/sforce_api_objects_accounttag.htm) resource in Salesforce | |
| 46 | +| campaigns | object | A marketing campaign, such as a direct mail promotion, webinar, or trade show. Corresponds to [Campaign](https://developer.salesforce.com/docs/atlas.en-us.api.meta/api/sforce_api_objects_campaign.htm) resource in Salesforce | |
| 47 | +| campaign_members | object | The association between a Campaign and either a Lead or Contact. Corresponds to [CampaignMember](https://developer.salesforce.com/docs/atlas.en-us.api.meta/api/sforce_api_objects_campaignmember.htm) resource in Salesforce | |
| 48 | +| campaign_shares | object | Represents a list of access levels to a Campaign along with an explanation of the access level. For example, if you have access to a record because you own it, the Access Level value is Full and Reason for Access value is Owner. Corresponds to [CampaignShare](https://developer.salesforce.com/docs/atlas.en-us.api.meta/api/sforce_api_objects_campaignshare.htm) resource in Salesforce | |
| 49 | +| campaign_tags | object | Associates a word or short phrase with a Campaign. Corresponds to [CampaignTag](https://developer.salesforce.com/docs/atlas.en-us.api.meta/api/sforce_api_objects_campaigntag.htm) resource in Salesforce | |
| 50 | +| cases | object | A customer issue such as a customer's feedback, problem, or question. Corresponds to [Case](https://developer.salesforce.com/docs/atlas.en-us.api.meta/api/sforce_api_objects_case.htm) resource in Salesforce | |
| 51 | +| case_comments | object | A comment that provides additional information about the associated Case. Corresponds to [CaseComment](https://developer.salesforce.com/docs/atlas.en-us.api.meta/api/sforce_api_objects_casecomment.htm) resource in Salesforce | |
| 52 | +| case_contact_role | object | The role that a given Contact plays on a Case. Corresponds to [CaseContactRole](https://developer.salesforce.com/docs/atlas.en-us.api.meta/api/sforce_api_objects_casecontactrole.htm) resource in Salesforce | |
| 53 | +| case_solution | object | The association between a particular Case and a particular Solution. Corresponds to [CaseSolution](https://developer.salesforce.com/docs/atlas.en-us.api.meta/api/sforce_api_objects_casesolution.htm) resource in Salesforce | |
| 54 | +| case_tags | object | Associates a word or short phrase with a Case Corresponds to [CaseTag](https://developer.salesforce.com/docs/atlas.en-us.api.meta/api/sforce_api_objects_casetag.htm) resource in Salesforce | |
| 55 | +| contacts | object | A contact, which is an individual associated with an Account. Corresponds to [Contact](https://developer.salesforce.com/docs/atlas.en-us.api.meta/api/sforce_api_objects_contact.htm) resource in Salesforce | |
| 56 | +| contact_tags | object | Associates a word or short phrase with a Contact. Corresponds to [ContactTag](https://developer.salesforce.com/docs/atlas.en-us.api.meta/api/sforce_api_objects_contacttag.htm) resource in Salesforce | |
| 57 | +| contracts | object | A contract (a business agreement) associated with an Account. Corresponds to [Contract](https://developer.salesforce.com/docs/atlas.en-us.api.meta/api/sforce_api_objects_contract.htm) resource in Salesforce | |
| 58 | +| contract_tags | object | Associates a word or short phrase with a Contract. Corresponds to [ContractTag](https://developer.salesforce.com/docs/atlas.en-us.api.meta/api/sforce_api_objects_contracttag.htm) resource in Salesforce | |
| 59 | +| dashboards | object | Represents a dashboard, which shows data from custom reports as visual components. Access is read-only. This object is available in API version 20.0 and later. Corresponds to [Dashboard](https://developer.salesforce.com/docs/atlas.en-us.api.meta/api/sforce_api_objects_dashboard.htm) resource in Salesforce | |
| 60 | +| dashboard_tags | object | Associates a word or short phrase with a Dashboard. This object is available inAPI version 20.0 and later. Corresponds to [DashboardTag](https://developer.salesforce.com/docs/atlas.en-us.api.meta/api/sforce_api_objects_dashboardtag.htm) resource in Salesforce | |
| 61 | +| documents | object | A file that a user has uploaded. Unlike Attachment objects, Documents are not attached to a parent object. Corresponds to [Document](https://developer.salesforce.com/docs/atlas.en-us.api.meta/api/sforce_api_objects_document.htm) resource in Salesforce | |
| 62 | +| document_tags | object | Associates a word or short phrase with a Document. Corresponds to [DocumentTag](https://developer.salesforce.com/docs/atlas.en-us.api.meta/api/sforce_api_objects_documenttag.htm) resource in Salesforce | |
| 63 | +| events | object | A calendar appointment event. Corresponds to [Event](https://developer.salesforce.com/docs/atlas.en-us.api.meta/api/sforce_api_objects_event.htm) resource in Salesforce | |
| 64 | +| event_tags | object | Associates a word or short phrase with an Event. Corresponds to [EventTag](https://developer.salesforce.com/docs/atlas.en-us.api.meta/api/sforce_api_objects_eventtag.htm) resource in Salesforce | |
| 65 | +| _group | object | A set of User records. Corresponds to [Group](https://developer.salesforce.com/docs/atlas.en-us.api.meta/api/sforce_api_objects_group.htm) resource in Salesforce | |
| 66 | +| leads | object | A lead, which is a prospect or potential Opportunity. Corresponds to [Lead](https://developer.salesforce.com/docs/atlas.en-us.api.meta/api/sforce_api_objects_lead.htm) resource in Salesforce | |
| 67 | +| lead_tags | object | Associates a word or short phrase with a Lead. Corresponds to [LeadTag](https://developer.salesforce.com/docs/atlas.en-us.api.meta/api/sforce_api_objects_leadtag.htm) resource in Salesforce | |
| 68 | +| names | object | Non-queryable object that provides information about foreign key traversals when the foreign key has more than one parent. Corresponds to [Name](https://developer.salesforce.com/docs/atlas.en-us.api.meta/api/sforce_api_objects_name.htm) resource in Salesforce | |
| 69 | +| notes | object | A note, which is text associated with an Attachment, Contact, Contract,Opportunity, or custom object. Corresponds to [Note](https://developer.salesforce.com/docs/atlas.en-us.api.meta/api/sforce_api_objects_note.htm) resource in Salesforce | |
| 70 | +| note_tags | object | Associates a word or short phrase with a Note. Corresponds to [NoteTag](https://developer.salesforce.com/docs/atlas.en-us.api.meta/api/sforce_api_objects_notetag.htm) resource in Salesforce | |
| 71 | +| opportunities | object | An opportunity, which is a sale or pending deal. Corresponds to [Opportunity](https://developer.salesforce.com/docs/atlas.en-us.api.meta/api/sforce_api_objects_opportunity.htm) resource in Salesforce | |
| 72 | +| opportunity_competitor | object | A competitor on an Opportunity. Corresponds to [OpportunityCompetitor](https://developer.salesforce.com/docs/atlas.en-us.api.meta/api/sforce_api_objects_opportunitycompetitor.htm) resource in Salesforce | |
| 73 | +| opportunity_contact_role | object | The role that a Contact plays on an Opportunity. Corresponds to [OpportunityContactRole](https://developer.salesforce.com/docs/atlas.en-us.api.meta/api/sforce_api_objects_opportunitycontactrole.htm) resource in Salesforce | |
| 74 | +| opportunity_field_history | object | Represents the history of changes to the values in the fields of an opportunity. Corresponds to [OpportunityFieldHistory](https://developer.salesforce.com/docs/atlas.en-us.api.meta/api/sforce_api_objects_opportunityfieldhistory.htm) resource in Salesforce | |
| 75 | +| opportunity_product | object | An opportunity line item, which is a member of the list of Product2 records associated with an Opportunity, along with other information about those products on that opportunity. Corresponds to [OpportunityLineItem](https://developer.salesforce.com/docs/atlas.en-us.api.meta/api/sforce_api_objects_opportunitylineitem.htm) resource in Salesforce | |
| 76 | +| opportunity_line_item_schedules | object | Information about the quantity, revenue distribution, and delivery dates for a particular OpportunityLineItem. Corresponds to [OpportunityLineItemSchedule](https://developer.salesforce.com/docs/atlas.en-us.api.meta/api/sforce_api_objects_opportunitylineitemschedule.htm) resource in Salesforce | |
| 77 | +| opportunity_stage | object | The stage of an Opportunity in the sales pipeline, such as New Lead, Negotiating, Pending, Closed, and so on. Corresponds to [OpportunityStage](https://developer.salesforce.com/docs/atlas.en-us.api.meta/api/sforce_api_objects_opportunitystage.htm) resource in Salesforce | |
| 78 | +| opportunity_tag | object | Associates a word or short phrase with an Opportunity. Corresponds to [OpportunityTag](https://developer.salesforce.com/docs/atlas.en-us.api.meta/api/sforce_api_objects_opportunitytag.htm) resource in Salesforce | |
| 79 | +| period | object | A fiscal period. Corresponds to [Period](https://developer.salesforce.com/docs/atlas.en-us.api.meta/api/sforce_api_objects_period.htm) resource in Salesforce | |
| 80 | +| price_books | object | A price book that contains the list of products (Product2 records) that your organization sells. Corresponds to [Pricebook2](https://developer.salesforce.com/docs/atlas.en-us.api.meta/api/sforce_api_objects_pricebook2.htm) resource in Salesforce | |
| 81 | +| price_book_entries | object | A product entry (an association between a Pricebook2 and Product2) in a price book. Corresponds to [PricebookEntry](https://developer.salesforce.com/docs/atlas.en-us.api.meta/api/sforce_api_objects_pricebookentry.htm) resource in Salesforce | |
| 82 | +| products | object | A product that your organization sells. A product is member of the list of items in a Pricebook2. Corresponds to [Product2](https://developer.salesforce.com/docs/atlas.en-us.api.meta/api/sforce_api_objects_product2.htm) resource in Salesforce | |
| 83 | +| profile | object | A profile, which defines a set of user permissions for performing different operations, such as querying, adding, updating, or deleting information. Corresponds to [Profile](https://developer.salesforce.com/docs/atlas.en-us.api.meta/api/sforce_api_objects_profile.htm) resource in Salesforce | |
| 84 | +| solutions | object | A detailed description of a customer issue and the resolution of that issue. Corresponds to [Solution](https://developer.salesforce.com/docs/atlas.en-us.api.meta/api/sforce_api_objects_solution.htm) resource in Salesforce | |
| 85 | +| solution_tags | object | Associates a word or short phrase with a Solution. Corresponds to [SolutionTag](https://developer.salesforce.com/docs/atlas.en-us.api.meta/api/sforce_api_objects_solutiontag.htm) resource in Salesforce | |
| 86 | +| tasks | object | An activity or to-do item to perform or that has been performed. Corresponds to [Task](https://developer.salesforce.com/docs/atlas.en-us.api.meta/api/sforce_api_objects_task.htm) resource in Salesforce | |
| 87 | +| task_tags | object | Associates a word or short phrase with a Task. Corresponds to [TaskTag](https://developer.salesforce.com/docs/atlas.en-us.api.meta/api/sforce_api_objects_tasktag.htm) resource in Salesforce | |
| 88 | +| users | object | A user in your organization. Corresponds to [User](https://developer.salesforce.com/docs/atlas.en-us.api.meta/api/sforce_api_objects_user.htm) resource in Salesforce | |
| 89 | +| 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 | |
| 90 | +| 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 | |
| 91 | + |
| 92 | +### Custom Objects |
| 93 | + |
| 94 | +Business tier customers can select and add custom objects from the Selective Sync page in the Salesforce source settings. |
| 95 | + |
| 96 | +Self service customers, please contact us with the [API names](https://help.salesforce.com/articleView?id=000007594&language=en_US&type=1) of the custom objects you want to add. |
| 97 | + |
| 98 | + |
| 99 | +### Deleting Records |
| 100 | + |
| 101 | +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`. |
| 102 | + |
| 103 | +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`. |
| 104 | + |
| 105 | +## Collection Properties |
| 106 | + |
| 107 | +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 custom fields to an existing collection, [contact us](https://segment.com/help/contact/) and we'll get those set up to sync. You do not need to include the field names. |
| 108 | + |
| 109 | +## Adding Destinations |
| 110 | + |
| 111 | +Warehouses are the only supported destination for object-cloud sources. |
0 commit comments