Client-Side Context Reference

Note
Deprecated. The global getAuthenticationHeader is still available for backwards compatibility for Microsoft Dynamics CRM 4.0 scripts that are upgraded. Scripts using the SOAP endpoint for web resources or the REST endpoint for web resources do not require this function for authentication.

Returns the encoded SOAP header necessary to used for Microsoft Dynamics CRM 4.0 web service calls using JScript. For more information about using the Microsoft Dynamics CRM 4.0 web services see the Accessing Microsoft Dynamics CRM Web Services topic in the Microsoft Dynamics CRM 4.0 SDK.

Return Value

Type: String

Go To Top

Returns the base URL that was used to access the application.

This method is new in Microsoft Dynamics CRM 2011 Update Rollup 12 and the Microsoft Dynamics CRM December 2012 Service Update.

The values returned will resemble those listed in the following table.

Return Value

Type: String

Go To Top

Returns a string representing the current Microsoft Office Outlook theme chosen by the user.

context.getCurrentTheme()

Return Value

Type: String

Use this information to select an appropriate theme for your HTML and Silverlight web resources when viewed in the Microsoft Dynamics CRM for Microsoft Office Outlook client. The following table lists the values that may be returned from this method.

 

Value	Theme
default	Microsoft Dynamics CRM web application
Office12Blue	Microsoft Dynamics CRM for Outlook 2007 or 2010 Blue Theme
Office14Silver	Microsoft Dynamics CRM for Outlook 2007 or 2010 Silver or Black Theme

Go To Top

Returns the LCID value that represents the Microsoft Dynamics CRM Language Pack that is the base language for the organization.

context.getOrgLcid()

Return Value

Type: Number

Example: 1033 indicates the English language. Valid locale ID values can be found at Locale ID (LCID) Chart.

JScript

Copy

1033

Go To Top

Returns the unique text value of the organization’s name.

context.getOrgUniqueName()

Return Value

Type: String

Example: This corresponds to the organization name value

JScript

Copy

"adventureworkscycle"

Go To Top

Returns a dictionary object of key value pairs that represent the query string arguments that were passed to the page.

context.getQueryStringParameters()

Return Value

Type: String

Go To Top

Note
Deprecated. Use getClientUrl instead. This method is deprecated as of Microsoft Dynamics CRM 2011 Update Rollup 12 and the Microsoft Dynamics CRM December 2012 Service Update.

Returns the base server URL. The format of this URL can change depending on whether the user is connected to on-premises Microsoft Dynamics CRM 2011, Microsoft Dynamics CRM Online, or working offline with Microsoft Dynamics CRM for Microsoft Office Outlook with Offline Access.

context.getServerUrl()

Return Value

Type: String

Example: While the user is connected to the network using on-premises Microsoft Dynamics CRM 2011, the value is:

JScript

Copy

"http://[server name]/adventureworkscycle"

When the user is working offline with Microsoft Dynamics CRM for Microsoft Office Outlook with Offline Access the organization name is not included and the value is:

Copy

"http://localhost:2525"

Note
Microsoft Dynamics CRM Online returns a string that includes a trailing forward slash character. If two consecutive forward slash characters are used in a URL to open a form, the ribbon will not display. To prevent this, always trim the trailing forward slash character so that your code will work the same for Microsoft Dynamics CRM Online and on-premises Microsoft Dynamics CRM 2011.

The following example show how to trim a trailing forward slash character if it exists.

JScript

Copy

if (serverUrl.match(/\/$/))
{ 
serverUrl = serverUrl.substring(0, serverUrl.length - 1);
}

Note

The URL returned is the standard URL used to access the application. If you access the server locally using http://localhost or use an IP address instead of the actual name of the server, this will not be reflected in the value returned by this function. This means that if you are making web service calls or accessing web resources, the browser will apply security settings that apply to requests that cross domains. To avoid this, always connect to Microsoft Dynamics CRM using the getClientUrl method..

Go To Top

Returns the GUID of the SystemUser.Id value for the current user.

context.getUserId()

Return Value

Type: String

Example:

JScript

Copy

"{B05EC7CE-5D51-DF11-97E0-00155DB232D0}"

Go To Top

Returns the LCID value that represents the Microsoft Dynamics CRM Language Pack that is the user selected as their preferred language.

context.getUserLcid()

Return Value

Type: Number

Example: 1041 indicates the Japanese language. Valid locale ID values can be found at Locale ID (LCID) Chart.

JScript

Copy

1041

Go To Top

Returns an array of strings that represent the GUID values of each of the security roles that the user is associated with. This method does not return GUID values that represent team security roles that the user may belong to.

For more information about security roles, see How Role-Based Security Can Be Used to Control Access to Entities in Microsoft Dynamics CRM.

context.getUserRoles()

Return Value

Type: Array

Example: This user has only one security role associated with their user account. The JSON representation of this array with a single value is:

JScript

Copy

["cf4cc7ce-5d51-df11-97e0-00155db232d0"]

Go To Top

Returns a Boolean value indicating if the user is using Microsoft Dynamics CRM for Microsoft Office Outlook.

context.isOutlookClient()

Return Value

Type: Boolean

Go To Top

Returns a Boolean value that indicates whether the user is connected to the Microsoft Dynamics CRM server while using Microsoft Dynamics CRM for Microsoft Office Outlook with Offline Access. When this function returns false, the user is working offline without a connection to the server.

context.isOutlookOnline()

Return Value

Type: Boolean

Go To Top

Prepends the organization name to the specified path.

context.prependOrgName(sPath)

Arguments

Type: String

A local path to a resource.

Return Value

Type: String

The value returned follows this pattern:

Copy

"/"+ OrgName + sPath

Go To Top