Export (0) Print
Expand All

Pass parameters to a URL by using the ribbon

Applies To: CRM 2015 on-prem, 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 CRM information as query string parameters to a URL by using the ribbon.

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.


Parameter Name Description


Entity Name

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.

Entity Type Code values are determined by the order in which an entity is created in an organization. Entity Type Codes for custom entities are usually different in different organizations.


Object GUID

Globally unique identifier (GUID) that represents a record.


Organization Name

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 CRM 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 CRM 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 "&amp;".

Passed parameters are usually read in the target .aspx page by using the HttpRequest.QueryString property. More information: http://msdn2.microsoft.com/en-us/library/system.web.httprequest.querystring.aspx

If the target of your URL is a Web resource, it can accept only the parameters identified in the topic Passing Parameters to HTMLWeb 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

See Also

Microsoft Dynamics CRM 2015 and Microsoft Dynamics CRM Online
Send comments about this topic to Microsoft.
© 2014 Microsoft Corporation. All rights reserved.
© 2015 Microsoft