Pass parameters to a URL by using the ribbon
Updated: November 29, 2016
Applies To: Dynamics 365 (online), Dynamics 365 (on-premises), Dynamics CRM 2016, Dynamics CRM Online
Ribbon actions are defined in the <Actions> (RibbonDiffXml) element of a <CommandDefinition> (RibbonDiffXml) element. There are several ways to pass contextual Microsoft Dynamics 365 information as query string parameters to a URL by using the ribbon.
Use a <Url> (RibbonDiffXml) element. Within the Url element, use the PassParams attribute.
Passing parameters to the target URL by using the PassParams attribute provides information to the target application about the context of the record or the user. All the parameters are passed if the ribbon control is configured by using the PassParams attribute. The following table lists the parameters that are passed.
Name of the entity. For custom entities, this includes the customization prefix, for example, new_entityname.
Entity Type Code
Integer that uniquely identifies the entity in the current organization.
Globally unique identifier (GUID) that represents a record.
Unique name of the organization.
User Language Code
Language code identifier that is used by the current user.
Organization Language Code
Language code identifier that represents the base language for the organization.
Language codes are four-digit or five-digit locale IDs. Valid locale ID values can be found at Locale ID (LCID) Chart).
We recommend that you use the entity name instead of the entity type code because the entity type code may be different between Microsoft Dynamics 365 installations.
The following sample shows shows the URL without parameters:
The following sample shows shows the parameters included when the ribbon control is presented for the account entity, for an organization called ‘AdventureWorksCycle’, when the user’s language and the organization base language is English, and the GUID for the account record is DBD5DBFB-0666-DC11-A5D9-0003FF9CE217:
You can include a querystring parameter in the URL attribute. This can be very useful if you want to open a specific Microsoft Dynamics 365 record or view by using Open forms, views, dialogs, and reports with a URL.
You will not be able to import the ribbon if the URL includes the ampersand (&) character that is used to separate multiple querystring parameters in the URL. This character makes the XML invalid. You must escape the ampersand character in the URL attribute value with "&".
Passed parameters are usually read in the target .aspx page by using the HttpRequest.QueryString property. More information: HttpRequest.QueryString Property
If the target of your URL is a Web resource, it can accept only the parameters identified in the topic Pass parameters to HTML web resources. The only opportunity to pass custom values is by including them within the data parameter. Some special handling is required to include multiple values in a single parameter. More information: Sample: Pass multiple values to a web resource through the data parameter
Microsoft Dynamics 365
© 2016 Microsoft. All rights reserved. Copyright