Pass parameters to a URL by using the ribbon

Applies to Dynamics 365 for Customer Engagement apps version 9.x

Ribbon actions are defined in the <Actions> element of a <CommandDefinition> element. There are several ways to pass contextual Dynamics 365 for Customer Engagement Customer Engagement information as query string parameters to a URL by using the ribbon.

  • Use a <Url> element. Within the Url element, use the PassParams attribute.

  • Use a <Url> element together with a <CrmParameter> element. When used from a Url element, the name attribute value must be set.

  • Use a <JavaScriptFunction> element together with a <CrmParameter> element.

Use the PassParams attribute to set dynamic values

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
typename Entity Name Name of the entity. For custom entities, this includes the customization prefix, for example, new_entityname.
type Entity Type Code Integer that uniquely identifies the entity in the current organization. Note: 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.
id Object GUID Globally unique identifier (GUID) that represents a record.
orgname Organization Name Unique name of the organization.
userlcid User Language Code Language code identifier that is used by the current user.
orglcid 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).

Note

We recommend that you use the entity name instead of the entity type code because the entity type code may be different between Dynamics 365 for Customer Engagement installations.

Example

The following sample shows the URL without parameters:

http://myserver/mypage.aspx  

The following sample 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:

http://myserver/mypage.aspx?orgname=AdventureWorksCycle&userlcid=1033&orglcid=1033&type=1&typename=account&id=%7BDBD5DBFB-0666-DC11-A5D9-0003FF9CE217%7D  

Use a Querystring parameter in the URL

You can include a querystring parameter in the URL attribute. This can be very useful if you want to open a specific Dynamics 365 for Customer Engagement record or view by using Open forms, views, dialogs, and reports with a URL.

Note

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 "&".

Reading passed parameters

Passed parameters are usually read in the target .aspx page by using the HttpRequest.QueryString property. More information: HttpRequest.QueryString Property

Note

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: Passing Multiple Values to a Web Page Web Resource Through the Data Parameter

See also

Customize commands and the ribbon
Open Forms And Views with a URL
Define Ribbon Tab Display Rules
Sample: Export Ribbon Definitions