diff --git a/README.txt b/README.txt index 4286d3e..4ab6228 100644 --- a/README.txt +++ b/README.txt @@ -19,7 +19,7 @@ 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 + 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. @@ -27,34 +27,34 @@ ABOUT 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 MODULES.txt. 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) You will need to download your organization's generated Enterprise WSDL file. This must be + 2) You will need to download your organization's generated Enterprise WSDL file. This must be uploaded to the site prior to entering the connection information. (see WORKING WITH WSDL FILES) 3) PHP to have been compiled with SOAP web services and OpenSSL support, as per: - + http://php.net/soap http://php.net/openssl 4) Required modules Chaos Tool Suite - http://drupal.org/project/ctools - Libraries API - http://drupal.org/project/libraries 5) Recommended modules AES encryption - http://drupal.org/project/aes (see SOME NOTES ABOUT SECURITY) + Libraries API - http://drupal.org/project/libraries INSTALLATION AND CONFIGURATION @@ -69,7 +69,7 @@ INSTALLATION AND CONFIGURATION You can also use drush make: $ drush make salesforce.make.example - + Project homepage: https://github.com/developerforce/Force.com-Toolkit-for-PHP @@ -91,13 +91,13 @@ INSTALLATION AND CONFIGURATION (admin/config/salesforce/wsdl). 6) Enter the username, password, and security token with which you want the module to connect - to Salesforce on the module's main settings page (admin/config/salesforce). + to Salesforce on the module's main settings page (admin/config/salesforce). - It is recommended to use an "API user", distinct from any of the regular users of your + It is recommended to use an "API user", distinct from any of the regular users of your Salesforce installation, so that the actions taking by your Drupal integration with Salesforce can be distinguished from those of your regular Salesforce users. - 7) While still on admin/config/salesforce, click on the "Fieldmaps" tab, and create a fieldmap + 7) While still on admin/config/salesforce, click on the "Fieldmaps" tab, and create a fieldmap between Drupal entities and Salesforce objects. Default fieldmaps for users and nodes have been created for an example. @@ -108,7 +108,7 @@ INSTALLATION AND CONFIGURATION UPDATING / REINSTALLING / ENABLING / DISABLING ---------------------------------------------- - If you have previously installed this module on your Drupal site and are + 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. @@ -117,7 +117,7 @@ UPDATING / REINSTALLING / ENABLING / DISABLING or use the following drush command: "drush up salesforce" ### Upgrading from 6.x or older - + Currently there is no upgrade path from the 6.x-2.x to 7.x-2.x branch of the module. You would have to recreate all fieldmaps and linkages manually. If you would like to help create an upgrade path, see http://drupal.org/node/1199022. @@ -125,23 +125,23 @@ UPDATING / REINSTALLING / ENABLING / DISABLING PREMATCHING ----------- The module sf_prematch provides administrators the ability to set up duplicate - prevention criteria on each fieldmap. When sf_permatch is enabled, - administrators will be directed to set up matching criteria after creating a - fieldmap. Each time a Salesforce export is triggered, this criteria will be - used to identify any pre-existing records. If any matching record is found, - the matched record will be updated instead of a new record being created. The - impetus for this is to reduce the database management workload for + prevention criteria on each fieldmap. When sf_permatch is enabled, + administrators will be directed to set up matching criteria after creating a + fieldmap. Each time a Salesforce export is triggered, this criteria will be + used to identify any pre-existing records. If any matching record is found, + the matched record will be updated instead of a new record being created. The + impetus for this is to reduce the database management workload for Salesforce.com administrators. EXPORT QUEUE ------------ - The module sf_queue implements a queueing system for exports. Since Salesforce - API's create and update functions can modify up to 200 records at a time, this - module offers significant efficiencies for users trying to minimize their API - usage. Further, if an account's API limit is exceeded, the queue provides a - fail-safe so that data is not lost. Failed API transactions will be queued for - future reprocessing. In addition, sf_queue is highly configurable to allow + The module sf_queue implements a queueing system for exports. Since Salesforce + API's create and update functions can modify up to 200 records at a time, this + module offers significant efficiencies for users trying to minimize their API + usage. Further, if an account's API limit is exceeded, the queue provides a + fail-safe so that data is not lost. Failed API transactions will be queued for + future reprocessing. In addition, sf_queue is highly configurable to allow administrators maximum flexibility in setting up the queue. @@ -200,22 +200,22 @@ NOTIFICATIONS the notification endpoint: http://example.com/sf_notifications/endpoint - + Configuring Salesforce Outbound Messages and Workflow is outside the scope of this documentation. - + SF_notifications will expose your existing fieldmaps to function as handlers for notifications. You can configure which of your fieldmaps should be active, and set conditions upon which the Notifications will be used to create Drupal objects. One application of Notifications is to implement full - two-way synchronization between Salesforce and Drupal. + two-way synchronization between Salesforce and Drupal. EXTENDING ---------- - In addition to out of the box support for various FieldAPI fields (in sf_entity), - an extensible framework is available for developers to build or alter support for contrib - modules. See sf_contrib for examples and best practices, as well as hooks.php + In addition to out of the box support for various FieldAPI fields (in sf_entity), + an extensible framework is available for developers to build or alter support for contrib + modules. See sf_contrib for examples and best practices, as well as hooks.php for documentation of the available integration points. diff --git a/salesforce_api/salesforce_api.info b/salesforce_api/salesforce_api.info index c2b63a4..2eb959c 100644 --- a/salesforce_api/salesforce_api.info +++ b/salesforce_api/salesforce_api.info @@ -1,7 +1,6 @@ name = Salesforce API -description = Defines an API that enables modules to interact with the Salesforce server. (STABLE) +description = Defines an API that enables modules to interact with the Salesforce server. dependencies[] = ctools -dependencies[] = libraries package = Salesforce core = 7.x configure = admin/config/services/salesforce diff --git a/salesforce_api/salesforce_api.module b/salesforce_api/salesforce_api.module index d7be3ed..d2ab6d1 100644 --- a/salesforce_api/salesforce_api.module +++ b/salesforce_api/salesforce_api.module @@ -11,7 +11,12 @@ define('SALESFORCE_API_CURRENT_VERSION', 1); // Define default directory paths for the Toolkit and WSDL files. define('SALESFORCE_DIR', drupal_get_path('module', 'salesforce_api')); -define('SALESFORCE_DIR_TOOLKIT', libraries_get_path('salesforce') . '/toolkit'); +if (function_exists('libraries_get_path')) { + $toolkit_path = libraries_get_path('salesforce') . '/toolkit'; +} else { + $toolkit_path = 'sites/all/libraries/salesforce/toolkit'; +} +define('SALESFORCE_DIR_TOOLKIT', $toolkit_path); define('SALESFORCE_DIR_SOAPCLIENT', SALESFORCE_DIR_TOOLKIT . '/soapclient'); define('SALESFORCE_DIR_WSDL', SALESFORCE_DIR . '/wsdl');