You are here

Home » API reference » Salesforce Suite 7.3

README.txt in Salesforce Suite 7.3

Same filename and directory in other branches
  1. 8.4 README.txt
  2. 8.3 README.txt
  3. 5.2 README.txt
  4. 5 README.txt
  5. 6.2 README.txt
  6. 7 README.txt
  7. 7.2 README.txt
  8. 5.0.x README.txt
ABOUT
-----
  This module suite implements a mapping functionality between Salesforce
  objects and Drupal entities. In other words, for each of your supported Drupal
  entities (e.g. node, user, or entities supported by extensions), you can 
  assign Salesforce objects that will be created / updated when the entity is
  saved. For each such assignment, you choose which Drupal and Salesforce fields
  should be mapped to one another.

  This suite also includes an API architecture which allows for additional
  modules to be easily plugged in (e.g. for webforms, contact form submits,
  etc).
  
  For a more detailed description of each component module, see below.


REQUIREMENTS
------------
  1) You need a Salesforce account. Developers can register here:
  http://www.developerforce.com/events/regular/registration.php

  2) You will need to create a remote application/connected app for
  authorization. In Salesforce go to Your Name > Setup > Create > Apps then
  create a new Connected App. Set the callback URL to:
  https://<your site>/salesforce/oauth_callback  (must use SSL)

  Select at least 'Perform requests on your behalf at any time' for OAuth Scope
  as well as the appropriate other scopes for your application.

  Additional information:
  https://help.salesforce.com/help/doc/en/remoteaccess_about.htm

  3) Your site needs to be SSL enabled to authorize the remote application using
  OAUTH.

  4) If using the SOAP API, PHP to have been compiled with SOAP web services and
  OpenSSL support, as per:
  
  http://php.net/soap
  http://php.net/openssl

  5) Required modules
     Entity API - http://drupal.org/project/entity
     Libraries, only for SOAP API - http://drupal.org/project/libraries


MODULES:
--------

  Salesforce (salesforce):
    OAUTH2 authorization and wrapper around the Salesforce REST API.

  Salesforce Mapping (salesforce_mapping)
    Map Drupal entities to Salesforce fields, including field level mapping.

  Salesforce Push (salesforce_push):
    Push Drupal entity updates into Salesforce.

  Salesforce Pull (salesforce_pull):
    Pull Salesforce object updates into Drupal.

  Salesforce Soap (salesforce_soap):
    Lightweight wrapper around the SOAP API, using the OAUTH access token, to
    fill in functional gaps missing in the REST API. Requires the Salesforce PHP
    Toolkit.

NOTES:

  Addressfield Options
    Salesforce provides a formatting plugin for addressfield which converts the
    "Thoroughfare" field to a text area. Enabling this option will make it much
    easier to sync addressfield data to Salesforce multi-line addressfields.

  Dates
    For Drupal date fields with start and end dates, salesforce_pull will fail
    unless you are using a version of Date that includes commit 7faeea3.

    To avoid potential timezone conversion errors, try setting your date field
    to "No timezone conversion".

File

README.txt
View source 
  1. 

  2. ABOUT

  3. -----

  4.   This module suite implements a mapping functionality between Salesforce

  5.   objects and Drupal entities. In other words, for each of your supported Drupal

  6.   entities (e.g. node, user, or entities supported by extensions), you can 

  7.   assign Salesforce objects that will be created / updated when the entity is

  8.   saved. For each such assignment, you choose which Drupal and Salesforce fields

  9.   should be mapped to one another.

  10. 

  11.   This suite also includes an API architecture which allows for additional

  12.   modules to be easily plugged in (e.g. for webforms, contact form submits,

  13.   etc).

  14.   

  15.   For a more detailed description of each component module, see below.

  16. 

  17. 

  18. REQUIREMENTS

  19. ------------

  20.   1) You need a Salesforce account. Developers can register here:

  21.   http://www.developerforce.com/events/regular/registration.php

  22. 

  23.   2) You will need to create a remote application/connected app for

  24.   authorization. In Salesforce go to Your Name > Setup > Create > Apps then

  25.   create a new Connected App. Set the callback URL to:

  26.   https:///salesforce/oauth_callback  (must use SSL)

  27. 

  28.   Select at least 'Perform requests on your behalf at any time' for OAuth Scope

  29.   as well as the appropriate other scopes for your application.

  30. 

  31.   Additional information:

  32.   https://help.salesforce.com/help/doc/en/remoteaccess_about.htm

  33. 

  34.   3) Your site needs to be SSL enabled to authorize the remote application using

  35.   OAUTH.

  36. 

  37.   4) If using the SOAP API, PHP to have been compiled with SOAP web services and

  38.   OpenSSL support, as per:

  39.   

  40.   http://php.net/soap

  41.   http://php.net/openssl

  42. 

  43.   5) Required modules

  44.      Entity API - http://drupal.org/project/entity

  45.      Libraries, only for SOAP API - http://drupal.org/project/libraries

  46. 

  47. 

  48. MODULES:

  49. --------

  50. 

  51.   Salesforce (salesforce):

  52.     OAUTH2 authorization and wrapper around the Salesforce REST API.

  53. 

  54.   Salesforce Mapping (salesforce_mapping)

  55.     Map Drupal entities to Salesforce fields, including field level mapping.

  56. 

  57.   Salesforce Push (salesforce_push):

  58.     Push Drupal entity updates into Salesforce.

  59. 

  60.   Salesforce Pull (salesforce_pull):

  61.     Pull Salesforce object updates into Drupal.

  62. 

  63.   Salesforce Soap (salesforce_soap):

  64.     Lightweight wrapper around the SOAP API, using the OAUTH access token, to

  65.     fill in functional gaps missing in the REST API. Requires the Salesforce PHP

  66.     Toolkit.

  67. 

  68. NOTES:

  69. 

  70.   Addressfield Options

  71.     Salesforce provides a formatting plugin for addressfield which converts the

  72.     "Thoroughfare" field to a text area. Enabling this option will make it much

  73.     easier to sync addressfield data to Salesforce multi-line addressfields.

  74. 

  75.   Dates

  76.     For Drupal date fields with start and end dates, salesforce_pull will fail

  77.     unless you are using a version of Date that includes commit 7faeea3.

  78. 

  79.     To avoid potential timezone conversion errors, try setting your date field

  80.     to "No timezone conversion".