Open apps, forms, views, dialogs, and reports with a URL
URL addressable elements enable you to include links to apps, forms, views, dialogs, and reports in other applications.
Note
URL addressable apps, forms, views, dialogs, and reports cannot bypass the security. Only licensed users, based on their security roles, can access the data and the records they see.
App Urls
Note
Embedding a model-driven application within an IFrame in another application is not supported.
You can open any model-driven application using the AppModule.UniqueName or AppModule.AppModuleId values.
You can retrieve these values using Web API using the following query:
GET [Organization URI]/api/data/v9.1/appmodules?$select=appmoduleid,uniquename
More information: Query data using the Web API
You can use either the appname or appid query parameters with the Unique Name or AppModuleId values respectively, but you cannot use both at the same time.
Using Unique Name
Append the appname query parameter to the main.aspx page to open the app using the Unique Name.
https://myorg.crm.dynamics.com/main.aspx?appname={UniqueName}
For example, if the Unique Name is msdyn_SolutionHealthHub, you can open this app using this URL:
https://myorg.crm.dynamics.com/main.aspx?appname=msdyn_SolutionHealthHub
Using AppModuleId
Append the appid query parameter to the main.aspx page to open the app using the AppModuleId.
https://myorg.crm.dynamics.com/main.aspx?appid={AppModuleId}
For example:
https://myorg.crm.dynamics.com/main.aspx?appid=12fd1cf3-e06e-e911-a95f-000d3a13c42a
URL addressable forms and views
All forms and views are displayed in the main.aspx page. Query string parameters passed to this page control what will be displayed. For example:
To open an account record form for where the id is {91330924-802A-4B0D-A900-34FD9D790829}:
https://myorg.crm.dynamics.com/main.aspx?etn=account&pagetype=entityrecord&id=%7B91330924-802A-4B0D-A900-34FD9D790829%7D
To open the Closed Opportunities view:
https://myorg.crm.dynamics.com/main.aspx?etn=opportunity&pagetype=entitylist&viewid=%7b00000000-0000-0000-00AA-000010003006%7d&viewtype=1039
To open the Active Contacts view with no navigation bar or command bar
https://myorg.crm.dynamics.com/main.aspx?etn=contact&pagetype=entitylist&viewid={00000000-0000-0000-00AA-000010001004}&viewtype=1039&navbar=off&cmdbar=false
Note
- Use
Xrm.Navigation.navigateTo orXrm.Navigation.openForm when you open forms programmatically within the application by using web resources. Do not usewindow.open. - Outside the application, where pages do not have access to the
Xrm.Navigation.openFormorXrm.Navigation.navigateTofunctions, usewindow.openor a link to open a specific record or form for a table. Displaying a form within an IFrame embedded in another form is not supported.
You will typically use the getClientUrl method to retrieve the organization root Url for Model-driven apps.
Query string parameters for the Main.aspx page
Tip
To get the id value for any record, use the Send a Link button the command bar. The following is an example of what will be opened in your email application:
<https://mycrm/myOrg/main.aspx?etc=4&id=%7b899D4FCF-F4D3-E011-9D26-00155DBA3819%7d&pagetype=entityrecord>.
The id parameter passed to the URL is the encoded id value for the record. In this example the id value is {899D4FCF-F4D3-E011-9D26-00155DBA3819}. The encoded version of the GUID substitutes opening and closing brackets { and } with %7B and %7D, respectively,
The following are the query string parameters used with the main.aspx page to open forms or views:
| Parameter | Description |
|---|---|
| etn | The logical name of the table. Important: Do not use the etc (table type code) parameter that contains an integer code for the table. This integer code varies for custom tables in different organizations. |
| extraqs | Optional for forms. This parameter contains encoded parameters within this parameter. Use this parameter to pass values to a form. For more information, see Set column values using parameters passed to a form. When a table has more than one form defined, you can use this parameter to specify which form to open by passing the encoded parameter formid with the value equal to the ID value of the form. For example, to open a form with the ID of '6009c1fe-ae99-4a41-a59f-a6f1cf8b9daf', include this value in the extraqs parameter: formid%3D6009c1fe-ae99-4a41-a59f-a6f1cf8b9daf%0D%0A. |
| pagetype | The type of page. There are two possible values: - entityrecord Displays a record form. - entitylist Displays an view. |
| id | Optional for forms. Use this when you open a specific table record. Pass in the encoded GUID identifier for the table. The encoded version of the GUID substitutes opening and closing brackets "{" and "}" with "%7B" and "%7D", respectively, for example {91330924-802A-4B0D-A900-34FD9D790829} is %7B91330924-802A-4B0D-A900-34FD9D790829%7D. |
| viewid | Required for views. This is the ID of the savedquery or userquery table record that defines the view. The easiest way to get the URL for a view is to copy it. For more information, see Copy the URL for a View. |
| viewtype | Defines the view type. Possible values are as follows: - 1039 Use for a system view. The viewid represents the Id of a savedquery record.- 4230 Use for a personal view. The viewid represents the Id of a userquery record. |
navbar |
Controls whether the navigation bar is displayed and whether application navigation is available using the areas and subareas defined in the sitemap. - onThe navigation bar is displayed. This is the default behavior if the navbar parameter is not used.- offThe navigation bar is not displayed. People can navigate using other user interface elements or the back and forward buttons. - entityOn a form, only the navigation options for related tables are available. After navigating to a related table, a back button is displayed in the navigation bar to allow returning to the original record. |
cmdbar |
Controls whether the command bar is displayed. Note: This capability supports requirements for the Unified Service Desk application. Using this to display a form within an IFrame embedded in another form is not supported. - trueThe command bar is displayed. This is the default. - falseThe command bar is hidden. |
Copy the URL for a View
Many views in model-driven apps let a user copy the URL for a particular view or send an email with the URL for a particular view embedded in the message. This feature makes communication between users easier, and exposes a way for you to gain access to a URL for a view that users can include in another application, such as a SharePoint site.
Note
Do not use this URL to include the view in application navigation using the site map. For more information, see Display a view in the application navigation using the Site Map.
The page displayed by the URL includes the full view. This includes the ribbon, but does not include the application navigation.
Get the URL for a View
Open the view you want to use.
On the command bar, click on Actions and then click Email a Link.
Paste the link into Notepad and edit it to extract only the URL part of the text that you want.
Note
- Views that use the user context as a parameter, such as My Accounts, cannot be copied.
- The GUID that represents system views for system tables will be the same for each installation. The GUID for custom tables and custom views will be unique for each installation.
Display a view in the application navigation using the Site Map
When you customize the application navigation using the site map, do not use the view URL that you copied from the application using the steps in Copy the URL for a view to set as the URL.
That URL displays a page that includes the ribbon and produces undesirable results if used in a <SubArea> Url parameter.
To display a list of table records within the application for a SubArea set the table column value. This displays the default view for that table and provides the correct title and icon.
However, if you want to have a SubArea element that uses a specific initial default view, use the following Url pattern.
Url="/main.aspx?appid=e2bc1066-488f-eb11-b1ac-000d3a56ead9&pagetype=entitylist&etn=account&viewid=%7b<GUID value of view id>%7d"
When you use this URL, you must also specify appropriate values for <Titles> and <Descriptions>, and specify an icon for the table.
Note
If you specify the view using the /main.aspx page, the view selector will still be shown. If the user changes the view, Model-driven apps remembers the user's most recent selection and the initial default view displays after they close and re-open their browser.
Opening a dialog process by using a URL
Important
Dialogs are deprecated. You should replace dialogs with business process flows or canvas apps. More information: Replace dialogs with business process flows or canvas apps
A common customization is to enable a user to open a specific dialog process in the context of a specific record. For example, you might want to add a custom button to the ribbon for a specific table using the id value for current record as an input parameter for the dialog process.
To open a dialog you need the following:
The unique identifier for the dialog.
The logical name for the table the dialog is created for.
The unique identifier for the record you want to have the dialog run against.
Tip
To get the unique identifier for the dialog, navigate to Settings, in the default solution select Processes. Select a process and then in the Actions options on the command bar, click Copy a Link. This will copy a link to edit the dialog to your clipboard, for example, [organization url]/sfa/workflow/edit.aspx?id=%7b6A6E93C9-1FE6-4C07-91A9-E0E2A7C70976%7d.
The following sample shows the URL and query string parameters to open a dialog:
[organization url]/cs/dialog/rundialog.aspx?DialogId=[dialog unique identifier]&EntityName=[table logical name]&ObjectId=[unique identifier for the record]
For example, to open the dialog with id ={6A6E93C9-1FE6-4C07-91A9-E0E2A7C70976} with the account record id = {40C9ADFD-90A8-DF11-840E-00155DBA380F}, use the URL in the following example.
[organization url]/cs/dialog/rundialog.aspx?DialogId=%7b6A6E93C9-1FE6-4C07-91A9-E0E2A7C70976%7d&EntityName=account&ObjectId=%7b40C9ADFD-90A8-DF11-840E-00155DBA380F%7d
Tip
If a dialog process is opened from a link, the Finish button may not work. The data will be saved, but the user will need to click the Close button on the window to close it. This is because other browsers do not provide a window.close method if the window is not opened using JavaScript from another window. When possible, use JavaScript and the window.open method to open dialog processes rather than simply providing links.
You can create a JavaScript function to open the dialog as shown in the following example:
function openDialogProcess(dialogId, entityName, objectId)
{
var url = Xrm.Page.context.getClientUrl() +
"/cs/dialog/rundialog.aspx?DialogId=" +
dialogId + "&EntityName=" +
entityName + "&ObjectId=" +
objectId;
window.open(url);
}
Opening a Report by using a URL
You can open a report by passing appropriate parameter values to the following URL: [organization url]/crmreports/viewer/viewer.aspx.
This URL accepts the following parameters:
action
Two possible values for this parameter are run or filter. When run is used, the report will be displayed using the default filters. When filter is used, the report will display a filter that the user can edit before choosing the Run Report button to view the report.
helpID
This parameter is optional. For reports that are included with model-driven apps the value in this parameter allows the Help button to display appropriate content about this report when Help on This Page is chosen. The value should correspond to the report FileName value.
id
This parameter is the report ReportId value.
The following examples show URLs that can be used to open reports in model-driven apps.
Open the Neglected Cases report using the default filter:
[organization url]/crmreports/viewer/viewer.aspx?action=run&helpID=Neglected%20Cases.rdl&id=%7b8c9f3e6f-7839-e211-831e-00155db7d98f%7d
Open the Top Knowledge Base Articles report and prompt the user to set filter values:
[organization url]/crmreports/viewer/viewer.aspx?action=filter&helpID=Top%20Knowledge%20Base%20Articles.rdl&id=%7bd84ec390-7839-e211-831e-00155db7d98f%7d
The following function shows how to properly encode values in the URL:
function getReportURL(action,fileName,id) {
var orgUrl = GetGlobalContext().getClientUrl();
var reportUrl = orgUrl +
"/crmreports/viewer/viewer.aspx?action=" +
encodeURIComponent(action) +
"&helpID=" +
encodeURIComponent(fileName) +
"&id=%7b" +
encodeURIComponent(id) +
"%7d";
return reportUrl;
}
See also
Set column values using parameters passed to a form
Xrm.Navigation.openUrl
Configure a form to accept custom querystring parameters
Customize the ribbon
Client scripting using JavaScript
Web resources
Change application navigation using the SiteMap
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for