Sample: Assign a user-owned dashboard to another user
Applies To: Dynamics CRM 2013
This sample code is for Microsoft Dynamics CRM 2013 and Microsoft Dynamics CRM Online. Download the Microsoft Dynamics CRM SDK package. This code can be found in the following location in the download package:
SampleCode\CS\VisualizationsAndDashboards\AssignDashboardToUser.cs
SampleCode\VB\VisualizationsAndDashboards\AssignDashboardToUser.vb
Requirements
For more information about the requirements for running the sample code provided in this SDK, see Use the sample and helper code.
Demonstrates
This sample shows how to assign a user-owned dashboard to another user by using the AssignRequest message. Because you can’t delete a user-owned dashboard that is assigned to another user, this sample shows how to use impersonation to delete the user-owned dashboard.
Example
using System;
using System.Linq;
using System.ServiceModel;
using System.ServiceModel.Description;
// These namespaces are found in the Microsoft.Xrm.Sdk.dll assembly
// found in the SDK\bin folder.
using System.Xml.Linq;
using Microsoft.Xrm.Sdk;
using Microsoft.Xrm.Sdk.Query;
using Microsoft.Xrm.Sdk.Discovery;
using Microsoft.Xrm.Sdk.Client;
// This namespace is found in Microsoft.Crm.Sdk.Proxy.dll assembly
// found in the SDK\bin folder.
using Microsoft.Crm.Sdk.Messages;
using System.DirectoryServices;
using System.Threading;
namespace Microsoft.Crm.Sdk.Samples
{
public class AssignDashboardToUser
{
#region Class Level Members
/// <summary>
/// Stores the organization service proxy.
/// </summary>
private OrganizationServiceProxy _serviceProxy;
// Define the IDs needed for this sample.
private Guid _userDashboardId;
private Guid _otherUserId;
#endregion Class Level Members
#region How To Sample Code
/// <summary>
/// This method first connects to the Organization service. Afterwards,
/// a user dashbaord is assigned to another user.
/// </summary>
/// <param name="serverConfig">Contains server connection information.</param>
/// <param name="promptforDelete">When True, the user will be prompted to delete all
/// created entities.</param>
public void Run(ServerConnection.Configuration serverConfig, bool promptForDelete)
{
try
{
// Connect to the Organization service.
// The using statement assures that the service proxy will be properly disposed.
using (_serviceProxy = ServerConnection.GetOrganizationProxy(serverConfig))
{
// This statement is required to enable early-bound type support.
_serviceProxy.EnableProxyTypes();
// Call the method to create any data that this sample requires.
CreateRequiredRecords();
AssignRequest assignRequest = new AssignRequest
{
Assignee = new EntityReference
{
LogicalName = SystemUser.EntityLogicalName,
// Here we could assign the visualization to the newly created user
Id = _otherUserId
},
Target = new EntityReference
{
LogicalName = UserForm.EntityLogicalName,
Id = _userDashboardId
}
};
_serviceProxy.Execute(assignRequest);
Console.WriteLine("The user dashboard has been assigned to Kevin Cook.");
DeleteRequiredRecords(promptForDelete);
}
}
// Catch any service fault exceptions that Microsoft Dynamics CRM throws.
catch (FaultException<Microsoft.Xrm.Sdk.OrganizationServiceFault>)
{
// You can handle an exception here or pass it back to the calling method.
throw;
}
}
/// <summary>
/// This method creates any entity records that this sample requires.
/// Creates the dashboard.
/// </summary>
public void CreateRequiredRecords()
{
//Grab the default public view for opportunities.
QueryExpression mySavedQuery = new QueryExpression
{
ColumnSet = new ColumnSet("savedqueryid"),
EntityName = SavedQuery.EntityLogicalName,
Criteria = new FilterExpression
{
Conditions =
{
new ConditionExpression
{
AttributeName = "isdefault",
Operator = ConditionOperator.Equal,
Values = {true}
},
new ConditionExpression
{
AttributeName = "querytype",
Operator = ConditionOperator.Equal,
Values = {0}
},
new ConditionExpression
{
AttributeName = "returnedtypecode",
Operator = ConditionOperator.Equal,
Values = {Opportunity.EntityTypeCode}
}
}
}
};
//This query should return one and only one result.
SavedQuery defaultOpportunityQuery = _serviceProxy.RetrieveMultiple(mySavedQuery)
.Entities.Select(x => (SavedQuery)x).FirstOrDefault();
// Retrieve visualizations out of the system.
// This sample assumes that you have the "Top Opportunities"
// visualization that is installed with Microsoft Dynamics CRM.
QueryByAttribute visualizationQuery = new QueryByAttribute
{
EntityName = SavedQueryVisualization.EntityLogicalName,
ColumnSet = new ColumnSet("savedqueryvisualizationid"),
Attributes = { "name" },
//If you do not have this visualization, you will need to change
//this line.
Values = { "Top Opportunities" }
};
SavedQueryVisualization visualization = _serviceProxy.RetrieveMultiple(visualizationQuery).
Entities.Select(x => (SavedQueryVisualization)x).FirstOrDefault();
//This is the language code for U.S. English. If you are running this code
//in a different locale, you will need to modify this value.
int languageCode = 1033;
//We set up our dashboard and specify the FormXml. Refer to the
//FormXml schema in the Microsoft Dynamics CRM SDK for more information.
UserForm dashboard = new UserForm
{
Name = "Sample User Dashboard",
Description = "Sample user-owned dashboard.",
FormXml = String.Format(@"<form>
<tabs>
<tab name='Test Dashboard' verticallayout='true'>
<labels>
<label description='Sample User Dashboard' languagecode='{0}' />
</labels>
<columns>
<column width='100%'>
<sections>
<section name='Information Section'
showlabel='false' showbar='false'
columns='111'>
<labels>
<label description='Information Section'
languagecode='{0}' />
</labels>
<rows>
<row>
<cell colspan='1' rowspan='10'
showlabel='false'>
<labels>
<label description='Top Opportunities - 1'
languagecode='{0}' />
</labels>
<control id='Top10Opportunities'
classid='{{E7A81278-8635-4d9e-8D4D-59480B391C5B}}'>
<parameters>
<ViewId>{1}</ViewId>
<IsUserView>false</IsUserView>
<RelationshipName />
<TargetEntityType>opportunity</TargetEntityType>
<AutoExpand>Fixed</AutoExpand>
<EnableQuickFind>false</EnableQuickFind>
<EnableViewPicker>false</EnableViewPicker>
<EnableJumpBar>false</EnableJumpBar>
<ChartGridMode>Chart</ChartGridMode>
<VisualizationId>{2}</VisualizationId>
<EnableChartPicker>false</EnableChartPicker>
<RecordsPerPage>10</RecordsPerPage>
</parameters>
</control>
</cell>
<cell colspan='1' rowspan='10'
showlabel='false'>
<labels>
<label description='Top Opportunities - 2'
languagecode='{0}' />
</labels>
<control id='Top10Opportunities2'
classid='{{E7A81278-8635-4d9e-8D4D-59480B391C5B}}'>
<parameters>
<ViewId>{1}</ViewId>
<IsUserView>false</IsUserView>
<RelationshipName />
<TargetEntityType>opportunity</TargetEntityType>
<AutoExpand>Fixed</AutoExpand>
<EnableQuickFind>false</EnableQuickFind>
<EnableViewPicker>false</EnableViewPicker>
<EnableJumpBar>false</EnableJumpBar>
<ChartGridMode>Grid</ChartGridMode>
<VisualizationId>{2}</VisualizationId>
<EnableChartPicker>false</EnableChartPicker>
<RecordsPerPage>10</RecordsPerPage>
</parameters>
</control>
</cell>
</row>
<row />
<row />
<row />
<row />
<row />
<row />
<row />
<row />
<row />
</rows>
</section>
</sections>
</column>
</columns>
</tab>
</tabs>
</form>",
languageCode,
defaultOpportunityQuery.SavedQueryId.Value.ToString("B"),
visualization.SavedQueryVisualizationId.Value.ToString("B"))
};
_userDashboardId = _serviceProxy.Create(dashboard);
Console.WriteLine("Created {0}.", dashboard.Name);
// Create another user to whom the dashboard will be assigned.
_otherUserId = SystemUserProvider.RetrieveSalesManager(_serviceProxy);
}
/// <summary>
/// Deletes the entity record that was created for this sample.
/// <param name="prompt">Indicates whether to prompt the user
/// to delete the entity created in this sample.</param>
/// The system user named "Kevin Cook" that was created by this sample will
/// continue to exist on your system because system users cannot be deleted
/// in Microsoft Dynamics CRM. They can only be enabled or disabled.
/// </summary>
public void DeleteRequiredRecords(bool prompt)
{
if (!prompt) return;
// Ask the user if the created entities should be deleted.
Console.Write("\nDo you want these entity records deleted? (y/n) [y]: ");
String answer = Console.ReadLine();
if (answer.StartsWith("y") || answer.StartsWith("Y") || answer == String.Empty)
{
// Delete action doesn't work on the UserForm instance if it is assigned
// to a user other than current user.
// So as a workaround, we are impersonating the actual owner of
// the UserForm instance to complete the delete action.
// To impersonate another user, set the OrganizationServiceProxy.CallerId
// property to the ID of the other user.
_serviceProxy.CallerId = _otherUserId;
_serviceProxy.Delete(UserForm.EntityLogicalName, _userDashboardId);
Console.WriteLine("Entity records have been deleted.");
}
}
#endregion How To Sample Code
#region Main
/// <summary>
/// Main. Runs the sample and provides error output.
/// <param name="args">Array of arguments to Main method.</param>
/// </summary>
static public void Main(string[] args)
{
try
{
// Obtain the target organization's Web address and client logon
// credentials from the user.
ServerConnection serverConnect = new ServerConnection();
ServerConnection.Configuration config = serverConnect.GetServerConfiguration();
AssignDashboardToUser app = new AssignDashboardToUser();
app.Run(config, true);
}
catch (FaultException<Microsoft.Xrm.Sdk.OrganizationServiceFault> ex)
{
Console.WriteLine("The application terminated with an error.");
Console.WriteLine("Timestamp: {0}", ex.Detail.Timestamp);
Console.WriteLine("Code: {0}", ex.Detail.ErrorCode);
Console.WriteLine("Message: {0}", ex.Detail.Message);
Console.WriteLine("Plugin Trace: {0}", ex.Detail.TraceText);
Console.WriteLine("Inner Fault: {0}",
null == ex.Detail.InnerFault ? "No Inner Fault" : "Has Inner Fault");
}
catch (System.TimeoutException ex)
{
Console.WriteLine("The application terminated with an error.");
Console.WriteLine("Message: {0}", ex.Message);
Console.WriteLine("Stack Trace: {0}", ex.StackTrace);
Console.WriteLine("Inner Fault: {0}",
null == ex.InnerException.Message ? "No Inner Fault" : ex.InnerException.Message);
}
catch (System.Exception ex)
{
Console.WriteLine("The application terminated with an error.");
Console.WriteLine(ex.Message);
// Display the details of the inner exception.
if (ex.InnerException != null)
{
Console.WriteLine(ex.InnerException.Message);
FaultException<Microsoft.Xrm.Sdk.OrganizationServiceFault> fe =
ex.InnerException
as FaultException<Microsoft.Xrm.Sdk.OrganizationServiceFault>;
if (fe != null)
{
Console.WriteLine("Timestamp: {0}", fe.Detail.Timestamp);
Console.WriteLine("Code: {0}", fe.Detail.ErrorCode);
Console.WriteLine("Message: {0}", fe.Detail.Message);
Console.WriteLine("Plugin Trace: {0}", fe.Detail.TraceText);
Console.WriteLine("Inner Fault: {0}",
null == fe.Detail.InnerFault ? "No Inner Fault" : "Has Inner Fault");
}
}
}
finally
{
Console.WriteLine("Press <Enter> to exit.");
Console.ReadLine();
}
}
#endregion Main
}
}
Imports System.ServiceModel
Imports System.ServiceModel.Description
' These namespaces are found in the Microsoft.Xrm.Sdk.dll assembly
' found in the SDK\bin folder.
Imports Microsoft.Xrm.Sdk
Imports Microsoft.Xrm.Sdk.Query
Imports Microsoft.Xrm.Sdk.Discovery
Imports Microsoft.Xrm.Sdk.Client
' This namespace is found in Microsoft.Crm.Sdk.Proxy.dll assembly
' found in the SDK\bin folder.
Imports Microsoft.Crm.Sdk.Messages
Imports System.DirectoryServices
Imports System.Threading
Namespace Microsoft.Crm.Sdk.Samples
Public Class AssignDashboardToUser
#Region "Class Level Members "
''' <summary>
''' Stores the organization service proxy.
''' </summary>
Private _serviceProxy As OrganizationServiceProxy
' Define the IDs needed for this sample.
Private _userDashboardId As Guid
Private _otherUserId As Guid
#End Region ' Class Level Members
#Region "How To Sample Code"
''' <summary>
''' This method first connects to the Organization service. Afterwards,
''' a user dashbaord is assigned to another user.
''' </summary>
''' <param name="serverConfig">Contains server connection information.</param>
''' <param name="promptforDelete">When True, the user will be prompted to delete all
''' created entities.</param>
Public Sub Run(ByVal serverConfig As ServerConnection.Configuration, ByVal promptForDelete As Boolean)
Try
' Connect to the Organization service.
' The using statement assures that the service proxy will be properly disposed.
_serviceProxy = ServerConnection.GetOrganizationProxy(serverConfig)
Using _serviceProxy
' This statement is required to enable early-bound type support.
_serviceProxy.EnableProxyTypes()
' Call the method to create any data that this sample requires.
CreateRequiredRecords()
Dim assignRequest As AssignRequest = New AssignRequest With
{
.Assignee = New EntityReference With
{
.LogicalName = SystemUser.EntityLogicalName,
.Id = _otherUserId
},
.Target = New EntityReference With
{
.LogicalName = UserForm.EntityLogicalName,
.Id = _userDashboardId
}
}
' Here we could assign the visualization to the newly created user
_serviceProxy.Execute(assignRequest)
Console.WriteLine("The user dashboard has been assigned to Kevin Cook.")
DeleteRequiredRecords(promptForDelete)
End Using
' Catch any service fault exceptions that Microsoft Dynamics CRM throws.
Catch fe As FaultException(Of Microsoft.Xrm.Sdk.OrganizationServiceFault)
' You can handle an exception here or pass it back to the calling method.
Throw
End Try
End Sub
''' <summary>
''' This method creates any entity records that this sample requires.
''' Creates the dashboard.
''' </summary>
Public Sub CreateRequiredRecords()
'Grab the default public view for opportunities.
Dim mySavedQuery As QueryExpression = New QueryExpression With
{
.ColumnSet = New ColumnSet("savedqueryid"),
.EntityName = SavedQuery.EntityLogicalName
}
mySavedQuery.Criteria = New FilterExpression()
mySavedQuery.Criteria.AddCondition("isdefault", ConditionOperator.Equal, {True})
mySavedQuery.Criteria.AddCondition("querytype", ConditionOperator.Equal, {0})
mySavedQuery.Criteria.AddCondition("returnedtypecode", ConditionOperator.Equal, {Opportunity.EntityTypeCode})
'This query should return one and only one result.
Dim defaultOpportunityQuery As SavedQuery = _serviceProxy.RetrieveMultiple(mySavedQuery).
Entities.Select(Function(x) CType(x, SavedQuery)).FirstOrDefault()
' Retrieve visualizations out of the system.
' This sample assumes that you have the "Top Opportunities"
' visualization that is installed with Microsoft Dynamics CRM.
Dim visualizationQuery As QueryByAttribute = New QueryByAttribute With
{
.EntityName = SavedQueryVisualization.EntityLogicalName,
.ColumnSet = New ColumnSet("savedqueryvisualizationid")
}
visualizationQuery.Attributes.Add("name")
visualizationQuery.Values.Add("Top Opportunities")
'If you do not have this visualization, you will need to change
'this line.
Dim visualization As SavedQueryVisualization = _serviceProxy.RetrieveMultiple(visualizationQuery).
Entities.Select(Function(x) CType(x, SavedQueryVisualization)).FirstOrDefault()
'This is the language code for U.S. English. If you are running this code
'in a different locale, you will need to modify this value.
Dim languageCode As Integer = 1033
'We set up our dashboard and specify the FormXml. Refer to the
'FormXml schema in the Microsoft Dynamics CRM SDK for more information.
Dim dashboard As UserForm =
New UserForm With
{
.Name = "Sample User Dashboard",
.Description = "Sample user-owned dashboard.",
.FormXml = String.Format(
"<form> " _
+ "<tabs> " _
+ "<tab name='Test Dashboard' verticallayout='true'> " _
+ "<labels> " _
+ "<label " _
+ "description='Sample User Dashboard' " _
+ "languagecode='{0}' /> " _
+ "</labels> " _
+ "<columns> " _
+ "<column width='100%'> " _
+ "<sections> " _
+ "<section name='Information Section' " _
+ "showlabel='false' " _
+ "showbar='false' columns='111'> " _
+ "<labels> " _
+ "<label " _
+ "description='Information Section' " _
+ "languagecode='{0}' /> " _
+ "</labels> " _
+ "<rows> " _
+ "<row> " _
+ "<cell colspan='1' " _
+ "rowspan='10' " _
+ "showlabel='false'> " _
+ "<labels> " _
+ "<label " _
+ "description='Top Opportunities - 1' " _
+ "languagecode='{0}' /> " _
+ "</labels> " _
+ "<control " _
+ "id='Top10Opportunities' " _
+ "classid='{{E7A81278-8635-4d9e-8D4D-59480B391C5B}}'> " _
+ "<parameters> " _
+ "<ViewId>{1}</ViewId> " _
+ "<IsUserView>false</IsUserView> " _
+ "<RelationshipName /> " _
+ "<TargetEntityType>opportunity</TargetEntityType> " _
+ "<AutoExpand>Fixed</AutoExpand> " _
+ "<EnableQuickFind>false</EnableQuickFind> " _
+ "<EnableViewPicker>false</EnableViewPicker> " _
+ "<EnableJumpBar>false</EnableJumpBar> " _
+ "<ChartGridMode>Chart</ChartGridMode> " _
+ "<VisualizationId>{2}</VisualizationId> " _
+ "<EnableChartPicker>false</EnableChartPicker> " _
+ "<RecordsPerPage>10</RecordsPerPage> " _
+ "</parameters> " _
+ "</control> " _
+ "</cell> " _
+ "<cell colspan='1' " _
+ "rowspan='10' " _
+ "showlabel='false'> " _
+ "<labels> " _
+ "<label " _
+ "description='Top Opportunities - 2' " _
+ "languagecode='{0}' /> " _
+ "</labels> " _
+ "<control " _
+ "id='Top10Opportunities2' " _
+ "classid='{{E7A81278-8635-4d9e-8D4D-59480B391C5B}}'> " _
+ "<parameters> " _
+ "<ViewId>{1}</ViewId> " _
+ "<IsUserView>false</IsUserView> " _
+ "<RelationshipName /> " _
+ "<TargetEntityType>opportunity</TargetEntityType> " _
+ "<AutoExpand>Fixed</AutoExpand> " _
+ "<EnableQuickFind>false</EnableQuickFind> " _
+ "<EnableViewPicker>false</EnableViewPicker> " _
+ "<EnableJumpBar>false</EnableJumpBar> " _
+ "<ChartGridMode>Grid</ChartGridMode> " _
+ "<VisualizationId>{2}</VisualizationId> " _
+ "<EnableChartPicker>false</EnableChartPicker> " _
+ "<RecordsPerPage>10</RecordsPerPage> " _
+ "</parameters> " _
+ "</control> " _
+ "</cell> " _
+ "</row> " _
+ "<row /> " _
+ "<row /> " _
+ "<row /> " _
+ "<row /> " _
+ "<row /> " _
+ "<row /> " _
+ "<row /> " _
+ "<row /> " _
+ "<row /> " _
+ "</rows> " _
+ "</section> " _
+ "</sections> " _
+ "</column> " _
+ "</columns> " _
+ "</tab> " _
+ "</tabs> " _
+ "</form>",
languageCode,
defaultOpportunityQuery.SavedQueryId.Value.ToString("B"),
visualization.SavedQueryVisualizationId.Value.ToString("B"))
}
_userDashboardId = _serviceProxy.Create(dashboard)
Console.WriteLine("Created {0}.", dashboard.Name)
' Create another user to whom the dashboard will be assigned.
_otherUserId = SystemUserProvider.RetrieveSalesManager(_serviceProxy)
End Sub
''' <summary>
''' Deletes the entity record that was created for this sample.
''' <param name="prompt">Indicates whether to prompt the user
''' to delete the entity created in this sample.</param>
''' The system user named "Kevin Cook" that was created by this sample will
''' continue to exist on your system because system users cannot be deleted
''' in Microsoft Dynamics CRM. They can only be enabled or disabled.
''' </summary>
Public Sub DeleteRequiredRecords(ByVal prompt As Boolean)
If Not prompt Then
Return
End If
' Ask the user if the created entities should be deleted.
Console.Write(vbLf & "Do you want these entity records deleted? (y/n) [y]: ")
Dim answer As String = Console.ReadLine()
If answer.StartsWith("y") OrElse answer.StartsWith("Y") OrElse answer = String.Empty Then
' Delete action doesn't work on the UserForm instance if it is assigned
' to a user other than current user.
' So as a workaround, we are impersonating the actual owner of
' the UserForm instance to complete the delete action.
' To impersonate another user, set the OrganizationServiceProxy.CallerId
' property to the ID of the other user.
_serviceProxy.CallerId = _otherUserId
_serviceProxy.Delete(UserForm.EntityLogicalName, _userDashboardId)
Console.WriteLine("Entity records have been deleted.")
End If
End Sub
#End Region ' How To Sample Code
#Region "Main"
''' <summary>
''' Main. Runs the sample and provides error output.
''' <param name="args">Array of arguments to Main method.</param>
''' </summary>
Public Shared Sub Main(ByVal args() As String)
Try
' Obtain the target organization's Web address and client logon
' credentials from the user.
Dim serverConnect As New ServerConnection()
Dim config As ServerConnection.Configuration = serverConnect.GetServerConfiguration()
Dim app As New AssignDashboardToUser()
app.Run(config, True)
Catch ex As FaultException(Of Microsoft.Xrm.Sdk.OrganizationServiceFault)
Console.WriteLine("The application terminated with an error.")
Console.WriteLine("Timestamp: {0}", ex.Detail.Timestamp)
Console.WriteLine("Code: {0}", ex.Detail.ErrorCode)
Console.WriteLine("Message: {0}", ex.Detail.Message)
Console.WriteLine("Plugin Trace: {0}", ex.Detail.TraceText)
Console.WriteLine("Inner Fault: {0}", If(Nothing Is ex.Detail.InnerFault, "No Inner Fault", "Has Inner Fault"))
Catch ex As TimeoutException
Console.WriteLine("The application terminated with an error.")
Console.WriteLine("Message: {0}", ex.Message)
Console.WriteLine("Stack Trace: {0}", ex.StackTrace)
Console.WriteLine("Inner Fault: {0}", If(Nothing Is ex.InnerException.Message, "No Inner Fault", ex.InnerException.Message))
Catch ex As Exception
Console.WriteLine("The application terminated with an error.")
Console.WriteLine(ex.Message)
' Display the details of the inner exception.
If ex.InnerException IsNot Nothing Then
Console.WriteLine(ex.InnerException.Message)
Dim fe As FaultException(Of Microsoft.Xrm.Sdk.OrganizationServiceFault) =
TryCast(ex.InnerException, FaultException(Of Microsoft.Xrm.Sdk.OrganizationServiceFault))
If fe IsNot Nothing Then
Console.WriteLine("Timestamp: {0}", fe.Detail.Timestamp)
Console.WriteLine("Code: {0}", fe.Detail.ErrorCode)
Console.WriteLine("Message: {0}", fe.Detail.Message)
Console.WriteLine("Plugin Trace: {0}", fe.Detail.TraceText)
Console.WriteLine("Inner Fault: {0}", If(Nothing Is fe.Detail.InnerFault, "No Inner Fault", "Has Inner Fault"))
End If
End If
Finally
Console.WriteLine("Press <Enter> to exit.")
Console.ReadLine()
End Try
End Sub
#End Region ' Main
End Class
End Namespace