Xrm.Utility (Client API reference)

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

Provides a container for useful methods.


Method Description
closeProgressIndicator Closes a progress dialog box.
getAllowedStatusTransitions Returns the valid state transitions for the specified entity type and state code.
getEntityMetadata Returns the entity metadata for the specified entity.
getGlobalContext Gets the global context.
getLearningPathAttributeName Returns the name of the DOM attribute expected by the Learning Path (guided help) Content Designer for identifying UI controls in the Dynamics 365 for Customer Engagement apps form.
getResourceString Returns the localized string for a given key associated with the specified web resource.
invokeProcessAction Invokes an action based on the specified parameters.
lookupObjects Opens a lookup control to select one or more items.
refreshParentGrid Refreshes the parent grid containing the specified record.
showProgressIndicator Displays a progress dialog with the specified message.

Deprecated methods

The following table lists the new methods you should use instead of the deprecated methods in the Xrm.Utility namespace. These methods were deprecated in Dynamics 365 for Customer Engagement apps version 9.0.

Deprecated Method New method to be used
Xrm.Utility.alertDialog Xrm.Navigation.openAlertDialog
Xrm.Utility.confirmDialog Xrm.Navigation.openConfirmDialog
Xrm.Utility.getBarcodeValue Xrm.Device.getBarcodeValue
Xrm.Utility.getCurrentPosition Xrm.Device.getCurrentPosition
Xrm.Utility.openEntityForm Xrm.Navigation.openForm
Xrm.Utility.openQuickCreate Xrm.Navigation.openForm
Xrm.Utility.openWebResource Xrm.Navigation.openWebResource

More information: Deprecated client APIs

Client API execution context

Client API Xrm object

Client API reference