You are here

Home » API reference » Salesforce Suite 7

README.txt in Salesforce Suite 7

Same filename in this branch
  1. 7 README.txt
  2. 7 salesforce_api/toolkit/README.txt
  3. 7 salesforce_api/wsdl/README.txt
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.3 README.txt
  7. 7.2 README.txt
  8. 5.0.x README.txt
SALESFORCE MODULE

This module utilizes Salesforce's Enterprise SOAP client and generic WSDL
functionality to allow you to work with custom fields without having to
download your own WSDL file.

It also includes an API architecture which allows for additional modules to
be easily plugged in (e.g. for webforms, contact form submits, etc).


REQUIREMENTS:

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

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

You will need to know your login data and your security token.

2) PHP needs the SOAP web services kit installed, as per:

http://php.net/soap


INSTALLATION:

1) Download, uncompress and situate the module as per usual.

2) Download the salesforce PHP toolkit version 13:

   http://wiki.apexdevnet.com/index.php/PHP_Toolkit

   Place the "soapclient" directory withinin the "toolkit" directory within the
   Drupal module's "salesforce_api directory". You should end up with something
   like: sites/all/modules/salesforce/salesforce_api/toolkit/soapclient

3) Enable the module on admin/build/modules along with at least one of the
   object modules (salesfoce_node, salesfoce_user). Node is the usual place to
   start.


UPDATING / REINSTALLING / ENABLING / DISABLING:

Since this module does not yet have a stable release, there is no upgrade path
neither between Drupal versions nor between dev versions. If you have previously
installed this module on your Drupal site and are upgrading, you need to do the
following to update the module.

0) ALWAYS backup your site's code and your database.

1) Disable salesforce_api, sf_node, and sf_user.

2) Remove the salesforce directory from the filesystem.

3) Drop any salesforce database tables (salesforce_object_map, salesforce_field_map, etc.)

4) Remove the entries in "system" database table for salesforce_api, sf_node, and sf_user
e.g. DELETE FROM system WHERE name IN ('salesforce_api', 'sf_node', 'sf_user').

5) Download or CVS checkout the latest version of salesforce module and re-enable.


QUICKSTART:

1) Visit admin/settings/salesforce and enter your login information in the
   "Salesforce API Settings" fieldset. Save that configuration.

2) Click on the "Fieldmaps" local task, and create a fieldmap between Drupal and
   Salesforce objects.

3) If you left the "automatic" box checked, the next time a Drupal object is
   created, it will create a corresponding object in Salesforce. Alternatively,
   you can click the "salesforce" tab on any node which you've established a
   mapping for and manually create a Salesforce object for it.


WORKING WITH WSDL FILES

Salesforce module will use a default .wsdl file
(salesforce_api/toolkit/soapclient/enterprise.wsdl.xml). Alternatively, you can
supply your own enterprise wsdl file by placing it in the salesforce_api/wsdl/
directory (salesforce_api/wsdl/enterprise.wsdl - no .xml at the end of the file
name).

When switching between wsdl files, keep in mind that PHP's SoapClient is caching
wsdl information. You can turn off caching of wsdl information by adding this
line to your settings.php:

ini_set('soap.wsdl_cache_enabled',  '0');

You can control the life time of your cache by adding this line to your
settings.php:

ini_set('soap.wsdl_cache_ttl',      '0');

For more information on SoapClient refer to http://php.net/manual/en/book.soap.php


REPORTING BUGS

Bug reports should adhere to Drupal standards.
Please review the issue queue at http://drupal.org/project/issues/salesforce before
creating a new issue.

Before creating a new issue, please:

* Use latest code from CVS on a *new* Drupal install
* Include the PHP error message
* Turn on "log all salesforce activity" and include any relevant watchdog errors
* Install a generated WSDL file and Clear your WSDL cache (see WORKING WITH WSDL FILES)
* Confirm php's SOAP support
* Confirm whether you were able to successfully:
  - Connect to Salesforce
  - Save credentials
  - Login to https://login.salesforce.com/ with those credentials
  - Load the test/demo page
  - Create a fieldmap
* Include system information, including operating system, php version, apache version

File

README.txt
View source 
  1. 

  2. SALESFORCE MODULE

  3. 

  4. This module utilizes Salesforce's Enterprise SOAP client and generic WSDL

  5. functionality to allow you to work with custom fields without having to

  6. download your own WSDL file.

  7. 

  8. It also includes an API architecture which allows for additional modules to

  9. be easily plugged in (e.g. for webforms, contact form submits, etc).

  10. 

  11. 

  12. REQUIREMENTS:

  13. 

  14. 1) You need a salesforce account. Developers can register here:

  15. 

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

  17. 

  18. You will need to know your login data and your security token.

  19. 

  20. 2) PHP needs the SOAP web services kit installed, as per:

  21. 

  22. http://php.net/soap

  23. 

  24. 

  25. INSTALLATION:

  26. 

  27. 1) Download, uncompress and situate the module as per usual.

  28. 

  29. 2) Download the salesforce PHP toolkit version 13:

  30. 

  31.    http://wiki.apexdevnet.com/index.php/PHP_Toolkit

  32. 

  33.    Place the "soapclient" directory withinin the "toolkit" directory within the

  34.    Drupal module's "salesforce_api directory". You should end up with something

  35.    like: sites/all/modules/salesforce/salesforce_api/toolkit/soapclient

  36. 

  37. 3) Enable the module on admin/build/modules along with at least one of the

  38.    object modules (salesfoce_node, salesfoce_user). Node is the usual place to

  39.    start.

  40. 

  41. 

  42. UPDATING / REINSTALLING / ENABLING / DISABLING:

  43. 

  44. Since this module does not yet have a stable release, there is no upgrade path

  45. neither between Drupal versions nor between dev versions. If you have previously

  46. installed this module on your Drupal site and are upgrading, you need to do the

  47. following to update the module.

  48. 

  49. 0) ALWAYS backup your site's code and your database.

  50. 

  51. 1) Disable salesforce_api, sf_node, and sf_user.

  52. 

  53. 2) Remove the salesforce directory from the filesystem.

  54. 

  55. 3) Drop any salesforce database tables (salesforce_object_map, salesforce_field_map, etc.)

  56. 

  57. 4) Remove the entries in "system" database table for salesforce_api, sf_node, and sf_user

  58. e.g. DELETE FROM system WHERE name IN ('salesforce_api', 'sf_node', 'sf_user').

  59. 

  60. 5) Download or CVS checkout the latest version of salesforce module and re-enable.

  61. 

  62. 

  63. QUICKSTART:

  64. 

  65. 1) Visit admin/settings/salesforce and enter your login information in the

  66.    "Salesforce API Settings" fieldset. Save that configuration.

  67. 

  68. 2) Click on the "Fieldmaps" local task, and create a fieldmap between Drupal and

  69.    Salesforce objects.

  70. 

  71. 3) If you left the "automatic" box checked, the next time a Drupal object is

  72.    created, it will create a corresponding object in Salesforce. Alternatively,

  73.    you can click the "salesforce" tab on any node which you've established a

  74.    mapping for and manually create a Salesforce object for it.

  75. 

  76. 

  77. WORKING WITH WSDL FILES

  78. 

  79. Salesforce module will use a default .wsdl file

  80. (salesforce_api/toolkit/soapclient/enterprise.wsdl.xml). Alternatively, you can

  81. supply your own enterprise wsdl file by placing it in the salesforce_api/wsdl/

  82. directory (salesforce_api/wsdl/enterprise.wsdl - no .xml at the end of the file

  83. name).

  84. 

  85. When switching between wsdl files, keep in mind that PHP's SoapClient is caching

  86. wsdl information. You can turn off caching of wsdl information by adding this

  87. line to your settings.php:

  88. 

  89. ini_set('soap.wsdl_cache_enabled',  '0');

  90. 

  91. You can control the life time of your cache by adding this line to your

  92. settings.php:

  93. 

  94. ini_set('soap.wsdl_cache_ttl',      '0');

  95. 

  96. For more information on SoapClient refer to http://php.net/manual/en/book.soap.php

  97. 

  98. 

  99. REPORTING BUGS

  100. 

  101. Bug reports should adhere to Drupal standards.

  102. Please review the issue queue at http://drupal.org/project/issues/salesforce before

  103. creating a new issue.

  104. 

  105. Before creating a new issue, please:

  106. 

  107. * Use latest code from CVS on a *new* Drupal install

  108. * Include the PHP error message

  109. * Turn on "log all salesforce activity" and include any relevant watchdog errors

  110. * Install a generated WSDL file and Clear your WSDL cache (see WORKING WITH WSDL FILES)

  111. * Confirm php's SOAP support

  112. * Confirm whether you were able to successfully:

  113.   - Connect to Salesforce

  114.   - Save credentials

  115.   - Login to https://login.salesforce.com/ with those credentials

  116.   - Load the test/demo page

  117.   - Create a fieldmap

  118. * Include system information, including operating system, php version, apache version