MindTouch Community Portal
Logged in: Logged in as: Log in
Register
Search:
Page last modified 12:06, 23 Jun 2010 by coreyg
MindTouch Community Portal > App Catalog > Salesforce Connector
Page Notifications Off
Was this page helpful?

Salesforce Connector

    Vendor MindTouch
    Type Native
    Categories Crm
    Requires MindTouch 8.08 or later
    OS Restriction None
    Status Stable
    License Standard/Enterprise
    SID (service id) sid://mindtouch.com/std/2008/05/salesforce
    Assembly mindtouch.salesforce

    Install Extension

    URL of your MindTouch install (ex: http://www.mindtouch.com)
        

     

    Table of Contents

    1. 1. Description
    2. 2. Functions
      1. 2.1. salesforce.Account(id : str) : map
      2. 2.2. salesforce.Accounts(filter : map, max : num, offset : num) : list
      3. 2.3. salesforce.Case(id : str) : map
      4. 2.4. salesforce.Cases(filter : map, max : num, offset : num) : list
      5. 2.5. salesforce.Contact(id : str) : map
      6. 2.6. salesforce.Contacts(filter : map, max : num, offset : num) : list
      7. 2.7. salesforce.Lead(id : str) : map
      8. 2.8. salesforce.Leads(filter : map, max : num, offset : num) : list
      9. 2.9. salesforce.Opportunities(filter : map, max : num, offset : num) : list
      10. 2.10. salesforce.Opportunity(id : str) : map
      11. 2.11. salesforce.Record(query : str) : map
      12. 2.12. salesforce.RecordList(query : str) : list
      13. 2.13. salesforce.Report(foldername : str, name : str) : list
      14. 2.14. salesforce.ReportList(foldername : str) : list
      15. 2.15. salesforce.Schema(sobject : str) : map
      16. 2.16. salesforce.Task(id : str) : map
      17. 2.17. salesforce.Tasks(filter : map, max : num, offset : num) : list
      18. 2.18. salesforce.User(id : str) : map
      19. 2.19. salesforce.Users(filter : map, max : num, offset : num) : list
    3. 3. Samples
      1. 3.1. Advanced Samples
    4. 4. Troubleshooting

    Description

    This extension contains functions for displaying data from Salesforce.

    See also How to add an extension, Using the Extension Dialog, Learn about DekiScript, Extensions Directory.

    Configuration:

    The Salesforce Connector requires a Salesforce account with API access.  Please confirm with Salesforce if your account has API access.

    Before the Salesforce extension can be used, it must be configured with the access information to the Salesforce account. 

    Config Key Description
    username Salesforce account username.
    password Salesforce account password with security token.
    cache-ttl Optional. Query cache time in seconds. (default: 15 minutes)

     

     The password field requires the salesforce.com security token for the suer account specified in the username key. The format should be [PASSWORD][SALESFORCE SECURITY TOKEN]  it will look something like

    PassworDxNsmiadwqHquGy4qUcBZR2IN

    The security token is user specific. If you  do not know your security token you must reset it on salesforce.com and  SalesForce will email the you a new token.  

    Setup > Personal Information > Reset My Security Token

    SecurityTokenReset.png

     

    Functions

    salesforce.Account(id : str) : map

    Retrieve an Account object from Salesforce, given its Id.

     

    • id  (optional): Account ID 

    salesforce.Accounts(filter : map, max : num, offset : num) : list

    Retrieve a list of Account objects from Salesforce.

    • filter (optional): Query filter in form of name-value pairs (default: none)
    • max (optional): Max results to return (default: 100)
    • offset (optional): Get records starting from record no. 'offset' (default: 0)

    salesforce.Case(id : str) : map

    Retrieve a Case object from Salesforce, given its Id.

    • id (optional): Case ID

    salesforce.Cases(filter : map, max : num, offset : num) : list

    Retrieve a list of Case objects from Salesforce.

    • filter (optional): Query filter in form of name-value pairs (default: none)
    • max (optional): Max results to return (default: 100)
    • offset (optional): Get records starting from record no. 'offset' (default: 0)

    salesforce.Contact(id : str) : map

    Retrieve a Contact object from Salesforce, given its Id.

    • id (optional): Contact ID

    salesforce.Contacts(filter : map, max : num, offset : num) : list

    Retrieve a list of Contact objects from Salesforce.

    • filter (optional): Query filter in form of name-value pairs (default: none)
    • max (optional): Max results to return (default: 100)
    • offset (optional): Get records starting from record no. 'offset' (default: 0)

    salesforce.Lead(id : str) : map

    Retrieve a Lead object from Salesforce, given its Id.

    • id (optional): Lead ID

    salesforce.Leads(filter : map, max : num, offset : num) : list

    Retrieve a list of Lead objects from Salesforce.

    • filter (optional): Query filter in form of name-value pairs (default: none)
    • max (optional): Max results to return (default: 100)
    • offset (optional): Get records starting from record no. 'offset' (default: 0)

    salesforce.Opportunities(filter : map, max : num, offset : num) : list

    Retrieve a list of Opportunity objects from Salesforce.

    • filter (optional): Query filter in form of name-value pairs (default: none)
    • max (optional): Max results to return (default: 100)
    • offset (optional): Get records starting from record no. 'offset' (default: 0)

    salesforce.Opportunity(id : str) : map

    Retrieve an Opportunity object from Salesforce, given its Id.

    • id (optional): Opportunity ID

    salesforce.Record(query : str) : map

    Get the first record from a Salesforce query.

    • query: SOQL query

    salesforce.RecordList(query : str) : list

    Collect all records from a Salesforce query.

    • query: SOQL query

    salesforce.Report(foldername : str, name : str) : list

    Retrieve a report from Salesforce.

    salesforce.ReportList(foldername : str) : list

    Retrieve a list of available reports from Salesforce.

    • foldername (optional): Show only reports in this folder. (default: show all)

    salesforce.Schema(sobject : str) : map

    Get the schema for a Salesforce object.

    • sobject: Salesforce object name

    salesforce.Task(id : str) : map

    Retrieve a Task object from Salesforce, given its Id.

    • id (optional): Task ID

    salesforce.Tasks(filter : map, max : num, offset : num) : list

    Retrieve a list of Task objects from Salesforce.

    • filter (optional): Query filter in form of name-value pairs (default: none)
    • max (optional): Max results to return (default: 100)
    • offset (optional): Get records starting from record no. 'offset' (default: 0)

    salesforce.User(id : str) : map

    Retrieve a User object from Salesforce, given its Id.

    • id (optional): User ID

    salesforce.Users(filter : map, max : num, offset : num) : list

    Retrieve a list of User objects from Salesforce.

    • filter (optional): Query filter in form of name-value pairs (default: none)
    • max (optional): Max results to return (default: 100)
    • offset (optional): Get records starting from record no. 'offset' (default: 0)

     

     

    Samples

    All invocations of Salesforce are available through the Extension dialog which can be accessed through the editor.  Also in the bottom right corner of the editor when you are in edit mode you can click Extensions and see all functions tied to this extension.

     

      Output 
     {{ salesforce.Lead{id: "00Q5000000SRiKO"} }}

     

    		 { Campaign_Type__c : "None", Company : "Fake Company",  CreatedById : "005500000010izQAAQ", CreatedDate : "Wed, 21 Apr 2010 23:30:44 GMT", Dead_Review__c : false, FirstName : "Joe", HasOptedOutOfEmail : false, Id : "00Q5000000SRiKOEA1", IsConverted : false, IsDeleted : false, IsUnreadByOwner : false, LastModifiedById : "005500000010izQAAQ", LastModifiedDate : "Wed, 21 Apr 2010 23:30:44 GMT", LastName : "Shmoe", Lead_Number__c : "44809", Mass_Update72109__c : false, Mass_Update__c : false,  Name : "Joe Shmoe", On_Demand__c : false, OwnerId : "005500000010izQAAQ", RecordTypeId : "012500000001D5oAAE", Round_Robin_ID__c : 1, Score_Current__c : 0, SFGA__CorrelationID__c : "none", SFGA__Correlation_Data__c : "none", SFGA__Web_Source__c : "none", Status : "New", SystemModstamp : "Wed, 21 Apr 2010 23:30:44 GMT" }

     

     

    {{ salesforce.ReportList{foldername: "Administrative Reports"} }}
    		 [ { FolderName : "Administrative Reports", Locator : "/00O?rt=32&retURL=%2Fservlet%2Fservlet.ReportList&t=active&c=FN&c=LN&c=RO&c=PR&c=UN&c=LL&duel0=FN%2CLN%2CRO%2CPR%2CUN%2CLL&details=yes", Name : "All Active Users" }, { FolderName : "Administrative Reports", Locator : "/00O?rt=32&retURL=%2Fservlet%2Fservlet.ReportList&colDt_q=last7&t=thisweek&c=LL&c=FN&c=LN&c=CN&c=DEP&c=DIV&c=TI&c=UN&duel0=LL%2CFN%2CLN%2CCN%2CDEP%2CDIV%2CTI%2CUN&sortdir=down&sort=LAST_LOGIN&details=yes", Name : "Users Logged in This Week" }, { FolderName : "Administrative Reports", Locator : "/00O?rt=48&retURL=%2Fservlet%2Fservlet.ReportList&break0=FOLDER_NAME&c=DOC_NAME&c=DOC_TYPE&c=DOC_DESC&c=DOC_INTERNAL&c=DOC_AUTHOR&c=DOC_LENGTH&s=DOC_LENGTH&sortdir=down&sort=DOC_LASTUPDATE&duel0=DOC_NAME%2CDOC_TYPE%2CDOC_LENGTH%2CDOC_INTERNAL%2CDOC_AUTHOR%2CDOC_DESC&details=yes&format=t", Name : "Documents" }, { FolderName : "Administrative Reports", Locator : "/00O?rt=97&retURL=%2Fservlet%2Fservlet.ReportList&break0=ProcessName&c=CreatedDate&c=SubmittedBy&c=TargetEntity&c=TargetType&c=Actor&duel0=CreatedDate&scope=organization&details=yes&format=t", Name : "All Pending Approval Requests" }, { FolderName : "Administrative Reports", Locator : "/00O?rt=104&retURL=%2Fservlet%2Fservlet.ReportList&c=UN&c=FULL_NAME&c=EM&c=CID&c=TS&c=CC&duel0=FULL_NAME%2CUN%2CEM&scope=organization&details=yes", Name : "API Usage Last 7 Days" } ]


     

    Troubleshooting

    If you receive the following error with the Salesforce connector:  

    The Salesforce Connector requires a Salesforce account with API access.  Please confirm with Salesforce if your account has API access.

    This means that the Salesforce account doesn't have API access which is required for the Connector to work.  Please contact Salesforce for more details on getting API access. 

    Was this page helpful?
    Tag page
    What links here

    Files 1

    Attach file or image
    FileVersionSizeModified 
    You must login to post a comment.
    MindTouch Social Knowledge Base

    Copyright © 2011 MindTouch, Inc. Powered by