Use an External Client App

To create the canvas app in your org, configure the Canvas plugin for an external client app.

  1. In Salesforce, from Setup, enter Apps in the Quick Find box, then select App Manager.

  2. Click New External Client App.

  3. In the External Client App Name field, enter Hello World.

  4. Accept the default API Name of Hello_World. This is the internal name of the canvas app and can’t be changed after you save it.

  5. In the Contact Email field, enter your email address.

  6. Select one of these options in the Distribution State field.

    • Local: Develop an external client app for your local org
    • Packaged: Develop an external client app for packaging and distribution

  7. In the Logo Image URL field, enter https://localhost:8443/images/salesforce.png. This is the default Salesforce “No Software” image. This image appears on the installation screen and on the detail screen for the app.

  8. In the Icon URL field, enter https://localhost:8443/examples/hello-world/logo.png. This is the default Salesforce “No Software” image.

    This is the image that appears next to the app name in the user interface. If you leave this field blank, a default cloud image appears next to the app name.

  9. In the API (Enable OAuth Settings) section, select Enable OAuth.

  10. In the Callback URL field, enter https://localhost:8443/sdk/callback.html.

  11. In the OAuth Scopes field, select Access the identity URL service (id, profile, email, address, phone) from the Available OAuth Scopes list and move it to the Selected OAuth Scopes list.

  12. In the Canvas App Settings section, select Enable Canvas.

  13. In the Canvas App URL field, enter https://localhost:8443/examples/hello-world/index.jsp.

  14. In the Access Method field, select Signed Request (POST).

  15. In the Locations field, select Lightning Component from the Available list and move it to the Selected list.

  16. Click Create

    After the canvas app is saved, the detail page appears.

  17. In the Settings tab, expand the OAuth Settings section, and click Consumer Key and Secret. Then, verify your identity.

  18. Select the consumer secret value and press Ctrl+c (Windows) to copy it. The consumer secret is used in the app to authenticate.

  19. Go to the command window and stop the Jetty Web server by pressing Ctrl+c (Windows). At the prompt, enter Y.

  20. Create an environment variable named CANVAS_CONSUMER_SECRET and set that value to the consumer secret you just copied. To do this in Windows, in the command window, enter set CANVAS_CONSUMER_SECRET=value_you_just_copied.

    If you’re using Unix/OS X, set the environment variable with the command export CANVAS_CONSUMER_SECRET=value_you_just_copied.

    The “hello world” page (c:\SalesforceCanvasFrameworkSDK\src\main\webapp\examples\hello-world\index.jsp) uses the consumer secret, as shown in the following code:

  21. Restart the Web server by entering this command: target\bin\webapp.bat (Windows) or sh target/bin/webapp (Unix/OS X).

See Also