Open forms, views, and dashboards in Customer Engagement mobile client with a URL
Use the new application handler for Customer Engagement mobile clients to directly link to Customer Engagement forms, views, and dashboards from external applications so that when you click on the link in an external application, the target element opens in Dynamics 365 for phones or Dynamics 365 for tablets. You can also open an empty form for creating an entity record.
If you are already signed in to your Customer Engagement instance in Dynamics 365 for phones or Dynamics 365 for tablets, the target record is displayed in the mobile client when you click the link in external application. Otherwise, you’re prompted to sign in to your Dynamics 365 Customer Engagement (on-premises) instance in the Customer Engagement mobile client, and upon doing so, the target element is displayed. You must have Dynamics 365 for phones or Dynamics 365 for tablets installed on your mobile device to use this feature.
Query string parameters for the URL
Use the following application handler and query string parameters to compose the URL.
ms-dynamicsxrm://?pagetype=<VALUE>&etn=<VALUE>&id=<VALUE>
The query string parameters shown in the following table are used.
Query string parameter | Description |
---|---|
pagetype | Specify the page type to open. Valid values are entity , view , dashboard , and create .This parameter is required. |
etn | Specify the logical name of the entity for which you want to open or create a record. Logical name of entities are in lowercase, and defined in the EntityMetadata.LogicalName property. This parameter is required if the pagetype parameter is set to entity , view , or create . |
id | Specify the ID of the entity, view, or dashboard record that you want to open. This parameter is required if the pagetype parameter is set to entity or dashboard .It is optional if the pagetype parameter is set to view . If you do not specify the view ID, the default view for the entity specified in the etn parameter is displayed. |
Example URLs
Here are some example URLs for opening forms, views, and dashboards.
Action | Example URL |
---|---|
Open an account entity with account record ID as 91330924-802A-4B0D-A900-34FD9D790829 | ms-dynamicsxrm://?pagetype=entity&etn=account&id=91330924-802A-4B0D-A900-34FD9D790829 |
Open a view with the view record ID as 899D4FCF-F4D3-E011-9D26-00155DBA3819 for the contact entity | ms-dynamicsxrm://?pagetype=view&etn=contact&id=899D4FCF-F4D3-E011-9D26-00155DBA3819 |
Open a default view for the account entity | ms-dynamicsxrm://?pagetype=view&etn=account |
Open a dashboard with the dashboard record ID as 2E3D0841-FA6D-DF11-986C-00155D2E3002 | ms-dynamicsxrm://?pagetype=dashboard&id=2E3D0841-FA6D-DF11-986C-00155D2E3002 |
Open a form for creating an account record | ms-dynamicsxrm://?pagetype=create&etn=account |
See also
Open Forms, Views, Dialogs and Reports with a URL
Extend Dynamics 365 Customer Engagement (on-premises) on the client