You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Current »

Review the Additional Information for using Salesforce Connector.


Salesforce Security Token


You are given a security token the first time you log into Salesforce. Don't know your security token?

To reset it:

  1. Click on your username in the top right section
  2. Choose "My Settings" from the menu
  3. Click "Personal"
  4. Click "Reset your security token" and follow the steps provided



This steps will send to your user email the info with the "Security Token" like: 


Salesforce App


  1. In your Salesforce Server, go to the Setup page

  2. Go to Build / Create / Apps 
      

             

  3. In this new page, click on New Connected Apps 
     

             

  4. Fill the Basic Information:

    1. Connected App Name
    2. API Name
    3. Contact Email



  5. In the API (Enable OAuth Settings):

    1. Check "Enable OAuth Settings"
    2. Set the "Callback Url"
    3. Select the "Selected OAuth Scopes"



  6. Save the application
  7. In the next screen you can copy the "Consumer Key" and the "Consumer Secret" information.

                


Salesforce Consumer Key and Consumer Secret



Once you created your "Connected App" you can get the "Consumer Key" if you go to Setup / Build / Create / Apps and select your connected app.

  • Copy the "Consumer Key"
  • To get the "Consumer Secret" click in "Click to reveal"


Salesforce sQueries File


This document represents the data retrieved from Salesforce using SOQL, please modify this document only if you know the available fields and types of the sObject you want to modified, and you know how to use SOQL.

Each sObject tag represents a element type inside Salesforce, following the structure of this sObjects will be explain (please use the API Name for every field, you can check it in the setup/customize/<item>/fields section in Salesforce).


## Attributes ##
     
For each sObject it can be up to three attributes:
     
    * @type = Name of the a specific element type inside Saleforce (Not Optional)
    * @attachment = Boolean flag which indicates if this element type can have attachments. If not specified the default is false (Optional)
    * @nested = Boolean flag which indicates if this sObject has nested subfields for the specified references. If not specified the default is false (Optional)
     
## Children ##
     
Each sObject can have up to two children:
 
    * fields =  These are the fields that will be retrieved by the connector
    * nested = Indicates the fields to retrieve for a reference (all the fields that ends with "Id" e.g ParentId)
         
## Nested ##
     
To uses nested subfields you put subFields(<{name-of-the-reference}>) at the end of the fields inside fields tag
     
Inside the nested you put a tag with the name of the reference () and the reference's fields in this way:
     
    <name-of-the-reference>{name-of-the-reference}.Field1, {name-of-the-reference}.Field2, ...</name-of-the-reference>
         
In the case the reference can be map to many types you can do:
         
    <name-of-the-reference>
        TYPEOF {name-of-the-reference}
            WHEN {Type1} THEN Field1, Field2, ...
            WHEN {Type2} THEN FieldA
            WHEN {Type3} THEN FieldX1
        ELSE FieldDefault
        END
    </name-of-the-reference>

  • The sQueries.xml is a template document from which the user can decide the fields to crawl, each SQueries.xml can be different for each Salesforce and is responsibility of the developer in charge of the installation of the connector to update or modify this document.
  • sQuieres.xml can use the SOQL TYPEOF, but this SOQL needs to be activated in the Salesforce environment.


  • No labels