|
| 1 | +--- |
| 2 | +title: Use deep links with Power Apps mobile| Microsoft Docs |
| 3 | +description: How to configure deep links for Power Apps mobile. |
| 4 | +author: mduelae |
| 5 | +ms.component: pa-user |
| 6 | +ms.topic: quickstart |
| 7 | +ms.date: 5/20/2022 |
| 8 | +ms.subservice: mobile |
| 9 | +ms.author: mkaur |
| 10 | +ms.custom: "" |
| 11 | +ms.reviewer: "" |
| 12 | +ms.assetid: |
| 13 | +search.audienceType: |
| 14 | + - enduser |
| 15 | +search.app: |
| 16 | + - PowerApps |
| 17 | + - D365CE |
| 18 | +searchScope: |
| 19 | + - "Power Apps" |
| 20 | +--- |
| 21 | + |
| 22 | +# Use deep links with Power Apps mobile |
| 23 | + |
| 24 | +Deep links let users move from one application to another on computers and mobile devices. Simple examples include a mobile app deep-linking to Facebook to sign in, an email address deep-linking to a mail app to compose a message, or a website deep-linking to an app store to download a related mobile app. |
| 25 | + |
| 26 | + |
| 27 | +## Supported deep links in the Power Apps mobile app |
| 28 | + |
| 29 | +You can open an `entityrecord` or an `entitylist` view in Power Apps mobile by using deep-link URLs from other apps. When you follow the link from an external app, the target element opens in Power Apps mobile |
| 30 | + |
| 31 | +If you're already signed in to your instance in the app, the target record is displayed when you follow the link from an external app. Otherwise, you're prompted to sign in to your instance in the mobile app; after you're signed in, the target element is displayed. You must have Power Apps mobile installed on your mobile device to use this feature. |
| 32 | + |
| 33 | +## Supported Urls parameters for a model-driven app |
| 34 | + |
| 35 | +Use the following application handler and query string parameters to compose the URL. |
| 36 | + |
| 37 | +Deep links for Power Apps mobile should start with the following: |
| 38 | + |
| 39 | +```ms-apps://<org-url>_<app-id>?tenantId=<tenant-id>&isShortcut=true&appType=AppModule&openApp=true&restartApp=true&forceOfflineDataSync=true``` |
| 40 | + |
| 41 | +| **Parameter** | **Description** | |
| 42 | +|----------------------|------------------------------------------------------------------------------| |
| 43 | +| <targeted-app> | <ul><li>`ms-dynamicsxrm` -> Dynamics 365 for phones</li><li> `ms-apps-fs` -> Field Service</li><li>`ms-apps-sales` -> Dynamics 365 Sales</li><li>`ms-apps` -> Power Apps<br><br>**Note**: The <ms-app> protocol only works with Power Apps. It doesn't with Dynamics 365 Sales, Field Service (Dynamics 365), or Microsoft Dynamics 365 Customer Engagement (on-premises). | |
| 44 | +| <org-url> | Connects to the correct org URL | |
| 45 | +| <app-id> | Opens the correct app module | |
| 46 | +| tenantId | Connects to the correct tenant | |
| 47 | +| forceOfflineDataSync | Ensures that data sync is triggered so that all the latest data is available | |
| 48 | + |
| 49 | + |
| 50 | +If opening an `entityrecord` form or creating a new `entityrecord`, use the following parameters: |
| 51 | + |
| 52 | +| **Parameter** | **Description** | |
| 53 | +|---------------------------------|--------------------------------------------------------------------------------------------------------| |
| 54 | +| etn=<entity-logical-name> | Designates which table to go to | |
| 55 | +| pagetype=entityrecord | Indicates that the target is a form | |
| 56 | +| extraqs=<form-id> | Designates which form to open for the `entityrecord`; if not specified, the default form will open. The `extraqs` parameter can also be used to default field values. | |
| 57 | +| id=<record-id> | Designates which specific record to go to; if left blank, the create form for the table will open | |
| 58 | + |
| 59 | +If the link goes to an `entitylist` view, add the following parameters: |
| 60 | + |
| 61 | +| **Parameter** | **Description** | |
| 62 | +|--------------------------------------------------------------|---------------------------------------------------------------------| |
| 63 | +| etn=<entity-logical-name> | Designates which table to go to | |
| 64 | +| pagetype=entitylist | Indicates that we're going to a view | |
| 65 | +| viewid=<view-id> | Designates which view to open | |
| 66 | +| Viewtype= <1039 if system view, 4230 if personal view> | Designates whether we're going to a system view or a personal view | |
| 67 | + |
| 68 | + |
| 69 | +## Supported Urls parameters for a canvas app |
| 70 | + |
| 71 | +```ms-apps:///providers/Microsoft.PowerApps/apps/<appID>?tenantId=<tenantId>``` |
| 72 | + |
| 73 | +| **Parameter** | **Description** | |
| 74 | +|----------------------|------------------------------------------------------------------------------| |
| 75 | +| <app-id> | Opens the correct app module | |
| 76 | +| <tenantId> | Connects to the correct tenant | |
| 77 | + |
0 commit comments