Guidelines on working with embedded canvas apps

Having walked through all of the challenges, here is a list of guidelines and best practices to help ensure a good experience with embedded canvas apps.

• Embedded canvas apps are only supported with Unified Interface model-driven apps.
• You can now embed up to three canvas apps per form.
• Always use a required field that will have a value to ensure the app refreshes in response to data changes on the host form.
• The canvas app custom control is only supported for use with the Web client type. and not Phone and Tablet.
• They are not displayed when creating a new record since they need a record context to be passed to them.
• The ModelDrivenFormIntegration.Item object is read-only. Use the CDS connector to write data back.
• Existing canvas apps can now be embedded by populating the App ID in the canvas app control & using the Customize button.
• When moving from one environment to another, move the solution (which has the apps), do not copy the environments.
• They need to be shared with the users who are expected to see the app within the host form.
• Publishing the host form does not automatically publish the embedded canvas app.
• The embedded canvas app should be in the same solution as the model-driven form.
• PCF controls might be a better option if the controls need to be reused across different model-driven and canvas apps.
• They can now interact with the host form
  • Navigating the host form to another main form.
  • Navigating the host form to a view.
  • Opening a quick create form.
  • Refreshing the host form.
  • Saving the data on the host form.