Sitecore for Salesforce Connector FAQ

Where can I find S4S code examples?
We created the Starter Kit so you can quickly learn how to implement S4S functionality. If you are only interested in looking at basic code usage please download the S4S simple code examples document
What is the S4S Starter Kit?
The Starter Kit is included in the S4S package so developers can see how to create a range of simple implementations using C# code. We recommend the Starter Kit be installed in a clean instance of Sitecore and used for prototyping your functionality against a Salesforce.com sandbox instance.
Can I use S4S through a proxy?
S4S supports the use of a proxy server. To learn more about configuring the connection string for proxy use please read the S4S simple proxy code examples document.
Does S4S support caching?
Yes, caching is important because Salesforce.com imposes limits on how much data can pass through the Salesforce Partner API. There are several reasons for this but mainly because Salesforce.com is a multi-tenant environment. S4S caching is completed on two levels, metadata and entity. With metadata caching, S4S caches the schema data. This data is the list of field and data types of the Salesforce object being used. Because S4S caches these objects, it does not need to get their properties from Salesforce.com before formulating a query. This improves performance and lowers the data volume through the Partner API. Alternatively, S4S entity caching is where S4S can retrieve any object from Salesforce.com and add it to a local cache with a settable expiry time. When the entity cache expires after the requested duration, it is easy to programmatically refresh the cache with new data. The entity cache can also be refreshed regularly using the Sitecore Scheduler.
Can I change the auto-created Sitecore login name in Salesforce to something else?
A Sitecore user name is automatically created in the Salesforce Contact Sitecore section when a new Contact is added. The Salesforce field name is SitecoreUsername__c. By default the value inserted into this field is a combination of the Contacts first name and last name. If this combination is not unique, a suffix is automatically added. You can change this behaviour to use another Salesforce field (like email address) by going to Salesforce.com > Setup > Develop > Custom Settings > Manage S4S Settings. Once in the Edit Settings screen, create or edit the "DefaultSitecoreUsernameField" custom setting name to another Salesforce field name like "Email".
How can I prevent a "Field does not exist" error when setting a custom field?
It may be that the Salesforce user who is connected through the session does not have access to the custom field. You can verify this using a tool like Force.com explorer. If you connect as the same user and then expand the object fields you should be able to find the custom field and use it in a test SOQL query. If it isn't visible in the Force.com explorer check the Field-Level Security setting for the profile of the current user. If the field still isn't visible please check your C# code against the examples in the S4S simple code examples document.
Can I be sure S4S will successfully deploy to our Salesforce instance?
When you install S4S into Salesforce it makes very few changes:
  • A new section with custom fields is added to the Contact and Account objects
  • Insert and update triggers are created for the Contact and Account objects
Because the triggers are written in APEX, they need to have associated test methods written against them (for the 75% code coverage rules). If the test methods fail, the S4S installation package will automatically “back out”. Other than a pre-existing custom field with the same name, we cannot think of a good reason why this would happen. If a problem was encountered, you (or FuseIT) can easily access the trigger code to determine the cause of any issue. If this explanation is still a concern and you have an Enterprise or Unlimited Edition of Salesforce you can ask Salesforce for additional Sandboxes and test the package install in one of those.
What should I do if I encounter an issue with S4S?
FuseIT are very keen to learn about any errors you may discover with S4S. Please supply us with the following information:
  • Description of the issue and steps to reproduce.
  • Screenshot or details of the Stack Trace.
  • Version of FuseIT.Sitecore.SalesforceConnector.dll you are using (right click file and view properties).
  • Log file detailing the error. Log files are usually located in the \data\logs folder. For detailed logging, go to the log4net section of Web.Config, change the priority value to "DEBUG" then re-run the test. Remember to change the setting back after you have finished.
This information will help us solve the problem as soon as possible.
I lose my Salesforce session when using an ASP.NET control. Why is this happening?
This anomaly relates to the Sitecore layout pipeline, not S4S, and typically coincides with post backs to the server to change the page contents, like transitioning from the view to edit mode or paginating. The page loads, but the session state is lost. Please ensure the web control you are using is listed in the "typesthatshouldnotbeexpanded" section of Web.Config.
How do I handle the Salesforce Security Token in S4S.config?
The security token allows S4S to establish a Salesforce Session. There are several ways to handle the security token:
  • Don't use it. Instead, add your server IP to the Salesforce Organisations trusted IP address ranges (Salesforce > Setup > Security Controls > Network Access). Adding a trusted IP address range requires elevated administrator privileges.
  • Append the Security Token to the password like "password=egPassword12lG0I7QExample0pOkshUtY0aA".
  • Add the Security Token as a token key like "password=egPassword12;token=lG0I7QExample0pOkshUtY0aA".
For more information, please see Security Token and Resetting Your Security Token
What causes the S4S license to expire?
When unlicensed S4S will run for 30 days against a Salesforce.com production org after the build date executing S4S assembly. After 30 days, if interogated, S4S will shut down with a licensing error (it will not break the website). Licensing S4S will resurrect the functionality. For development and evaluation purposes, unlicensed S4S wll run for one year against a Salesforce.com Sandbox Org. You can look at the Sitecore log file (in the data\logs\ folder) to determine how many days are remaining. Look for the "Number of evaluation days left" entry.
What are the S4S license keys?
FuseIT generate the S4S license keys using an encrpyted composite of several strings including your production Salesforce.com Organization ID, the web server domain names you want to use, and internal FuseIT keys specific to your company. To find the Salesforce.com Organization ID, log into your production instance of Salesforce.com > Setup > Company Profile > Company Information and see the ID in the right column. Your company domains names can be found listed in the IIS Site Bindings section on your production web server - you will need to supply the port number if not port 80. Please call to discuss if you have other requirements. After submitting these details to FuseIT you will be issued S4S license keys to add to the S4S.Config file in your Sitecore installation. Each domain name has a matching key.
How is S4S Licensed?
S4S licensing is on a per domain basis - you let us know what domains you want to use it on and we issue licenses for those domains. This gives you the flexibility to deploy it to localhost, development, test, preproduction, staging and production environments. Only one primary production domain should be nominated. For us to generate an S4S license key, you will also need to provide your production Salesforce Organization ID as we use that in the license generating process. Please see the licensing detail document for more detail around finding this information.
Can I license S4S against multiple domains?
If you have Sitecore working with multiple domain names that point to a single Saleforce instance, an alternative licensed model is used. In this approach, a new build is required that has your Salesforce.com Organization ID embedded. Please talk to FuseIT for this licensing - the fee remains the same.
After licensing S4S, why is the log file still saying S4S is in evaluation mode?
This warning message appears in the Sitecore log files like:
  • INFO FuseIT.Sitecore.Salesforce.Licensing - LicenseId = Server Host Name = 'subdomain.test.mydomain.com' Version = '1.5.2011.950' Assembly File Version='1.5.2011.963'
  • INFO FuseIT.Sitecore.Salesforce.Licensing - LicenseId = '007E000000IiGBd111'. Salesforce Org Id = '00EF0000000ABCDEF1'
  • INFO FuseIT.Sitecore.Salesforce.Licensing - FuseIT Sitecore Salesforce license - Number of evaluation days left = 29
  • WARN Warn : FuseIT.Sitecore.Salesforce.Licensing - Your FuseIT Sitecore Salesforce license will soon expire on the 20-10-2011 00:00:00

    If this occurs in production and you have already applied the license keys to the S4S.Config file, the problem will almost certainly be a mismatch (or additional whitespace) between the Server Host Name submitted for licensing and the actual Server Host Name in IIS where S4S resides. Please see the licensing detail document for more detail around finding this information.

    If this occurs outside production the likely cause is you are connecting to a Salesforce Sandbox Org but using the production key in S4S.Config. In this situation, the log file message is normal. 


    • Find out more!

    Contact us now for a no obligation live demo of S4S.