Canvas Developer Guide

Getting Started
Introducing Canvas
Quick Start
Quick Start—Advanced
Prerequisites
Clone the Project from GitHub
Run the Web App Locally
Create the Canvas App
Configure Who Can Access the Canvas App
Deploy the Web App to Heroku
Deploy the Canvas External Client App to an Org
Update the Canvas App
Package the Canvas App
Configure Who Can Access the Installed Canvas App
Using Canvas
Reference
PDF

Newer Version Available

This content describes an older version of this product. View Latest

Deploy the Canvas External Client App to an Org

Deploy and retrieve your Canvas integration for the external client app with Metadata API. The Canvas plugin has its own settings files and policies file.

Before you can deploy or retrieve an external client app, set up an SFDX project.

If you created the Canvas external client app in Salesforce Setup, you can retrieve the app using Metadata API to configure the policies and then deploy your changes to your org.

  1. Retrieve your Canvas plugin files: 
    1sf project retrieve start --manifest package.xml --target-org user@example.com
  2. Make your changes in the .js-meta.xml file for the Canvas plugin. For example, to update the Canvas URL and location options, update the canvasUrl and canvasLocationOptions fields in the .ecaCanvas-meta.xml file that's located in the force-app/main/default/extlClntAppCanvasSettings folder of your SFDX project.
  3. Save the metadata files with your changes.
  4. Deploy your Canvas plugin files: 
    1sf project deploy start --manifest package.xml --target-org user@example.com
  5. Verify your changes in the External Client App Manager page in Setup.
    1. In External Client App Manager, click the name of your external client app.
    2. Go to the Settings tab and then expand the Canvas App Settings section.
    3. Check that the Canvas App URL and Locations fields show your changes.
The Canvas plugin files include the metadata for the external client app, the Canvas settings, policies, and OAuth settings. This table lists the name of the source file with its type and path, where API_Name corresponds to the API Name for the external client app.
Name Metadata Type Sample Path
API_Name ExternalClientApplication force-app/main/default/externalClientApps/API_Name.eca-meta.xml
API_Name_canvasSettings ExtlClntAppCanvasSettings force-app/main/default/extlClntAppCanvasSettings/API_Name_canvasSettings.ecaCanvas-meta.xml
API_Name_plcy ExtlClntAppConfigurablePolicies force-app/main/default/extlClntAppPolicies/API_Name_plcy.ecaPlcy-meta.xml
API_Name_glbloauth ExtlClntAppGlobalOauthSettings force-app/main/default/extlClntAppGlobalOauthSets/API_Name_glbloauth.ecaGlblOauth-meta.xml
API_Name_oauth ExtlClntAppOauthSettings force-app/main/default/extlClntAppOauthSettings/API_Name_oauth.ecaOauth-meta.xml