Force.com Canvas is a mechanism for consuming third-party applications within Salesforce. Its goal is to connect applications at a UI level instead of just an API level. The purpose of this GitHub repository is to provide third-party applications with a Java/JavaScript SDK and examples so you can easily integrate canvas-style applications into Salesforce, while developing in the technology and platform of your choice.

The best place to get started building canvas applications is the online developer guide.

Currently, we provide Java examples in this repository, but you can develop in whatever language you prefer. Most of the integration with Salesforce is through JavaScript and REST. You can also run and test your application locally from your own host, or from Heroku.

This SDK contains some basic Java examples. We recommend you explore the Heroku Quick Start, for additional examples in Java and Ruby.

For other examples and resources, check out the developer guide.

Below are some useful commands and links for your convenience. Before you use them, you'll need to make sure you have the necessary software installed on your computer here.

git clone git@github.com:forcedotcom/SalesforceCanvasFrameworkSDK.git cd SalesforceCanvasFrameworkSDK git submodule init git submodule update 

If you prefer, you can build and test your application locally before you push to Heroku or any other server. If you decide to test locally, you'll also need to generate a local keystore so you can do SSL.

mvn package 

This is only needed to support SSL (https) when running locally. Heroku uses piggyback SSL so it's not needed there.

 > keytool -keystore keystore -alias jetty -genkey -keyalg RSA Enter keystore password: 123456 Re-enter new password: 123456 What is your first and last name? [Unknown]: John Doe What is the name of your organizational unit? [Unknown]: myorgunit What is the name of your organization? [Unknown]: myorg What is the name of your City or Locality? [Unknown]: San Fancisco What is the name of your State or Province? [Unknown]: CA What is the two-letter country code for this unit? [Unknown]: us Is CN=salesforce.com, OU=platform, O=chimera, L=San Fancisco, ST=CA, C=us correct? [no]: yes Enter key password for <jetty> (RETURN if same as keystore password): Re-enter new password: 

If you're running and testing locally, this will start your Java Web server.

sh target/bin/webapp 

If you're running locally https://localhost:8443/examples/hello-world/index.jsp Or if you're running on Heroku https://<your-heroku-app>.herokuapp.com/examples/hello-world/index.jsp 

If you're running locally https://localhost:8443/sdk/callback.html Or if you're running on Heroku https://<your-heroku-app>.herokuapp.com/sdk/callback.html 

To commit your changes into your local git repository and push those changes to Heroku, use these commands. Note that your repository name may be diffferent than 'heroku', use git remote -v to confirm.

 git add -A git commit -m "My change comments" git push heroku master 

To access your logs on Heroku, use the following command. For more information on Heroku logs click here.

 heroku logs --tail