Sample: Specify a queue item to work on (early bound)
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. It can be found in the following location in the download package:
SampleCode\CS\BusinessDataModel\BusinessManagement\AssignQueueItemWorker.cs
SampleCode\VB\BusinessDataModel\BusinessManagement\AssignQueueItemWorker.vb
Note
This sample for the Queue entity was not updated for changes introduced with Microsoft Dynamics CRM 2013 Service Pack 1 (SP1) and Microsoft Dynamics CRM Online Spring ‘14. While it continues to work, it doesn’t represent the best practices to use with queues in the most recent release. More information: Enhancements to queues with Microsoft Dynamics CRM 2013 service pack 1 (on-premises) and Microsoft Dynamics CRM Online Spring ‘14
Rather than setting the WorkerId, you can use PickFromQueueRequest.
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 specify a user who will work on a queue item.
Example
using System;
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 Microsoft.Xrm.Sdk;
using Microsoft.Xrm.Sdk.Query;
// This namespace is found in Microsoft.Crm.Sdk.Proxy.dll assembly
// found in the SDK\bin folder.
using Microsoft.Crm.Sdk.Messages;
using Microsoft.Xrm.Sdk.Client;
namespace Microsoft.Crm.Sdk.Samples
{
/// <summary>
/// This sample shows how to assign queue item work to some user.
/// </summary>
public class AssignQueueItemWorker
{
#region Class Level Members
/// <summary>
/// Stores the organization service proxy.
/// </summary>
private OrganizationServiceProxy _serviceProxy;
// Define the IDs needed for this sample.
private Guid _queueItemId;
private Guid _letterId;
private Guid _queueId;
#endregion Class Level Members
#region How To Sample Code
/// <summary>
/// This method first connects to the Organization service.
/// Initiate method to create any entity records that this sample requires.
/// Retrieves new owner's details.
/// Update the queue item record to assign it to new owner.
/// Optionally delete any entity records that were created for this sample.
/// <para name="organizationFriendlyName">The friendly name of the
/// target organization.</para>
/// <para name="discoveryServer">The name of the discovery server.</para>
/// <param name="promptForDelete">Indicates whether to prompt the user to
/// delete the records created in this sample.</param>
/// </summary>
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();
// Retrieve the user information.
WhoAmIRequest whoAmIRequest = new WhoAmIRequest();
WhoAmIResponse whoAmIResponse = (WhoAmIResponse)_serviceProxy.Execute(
whoAmIRequest);
ColumnSet columnSet = new ColumnSet("fullname");
SystemUser currentUser = (SystemUser)_serviceProxy.Retrieve(
SystemUser.EntityLogicalName,
whoAmIResponse.UserId, columnSet);
String currentUserName = currentUser.FullName;
// Create an instance of an existing queueitem in order to specify
// the user that will be working on it.
QueueItem queueItem = new QueueItem
{
QueueItemId = _queueItemId,
WorkerId = new EntityReference(SystemUser.EntityLogicalName,
whoAmIResponse.UserId)
};
_serviceProxy.Update(queueItem);
Console.WriteLine("The letter queue item is queued for new owner {0}.",
currentUserName);
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.
/// Create a queue record.
/// Create a letter record.
/// Create a queue item for queue record.
/// </summary>
public void CreateRequiredRecords()
{
// Create a queue instance and set its property values.
Queue newQueue = new Queue
{
Name = "Example Queue.",
Description = "This is an example queue.",
};
// Create a new queue and store its returned GUID in a variable
// for later use.
_queueId = _serviceProxy.Create(newQueue);
Console.WriteLine("Created {0}.", newQueue.Name);
Letter newLetter = new Letter
{
Description = "Example Letter"
};
_letterId = _serviceProxy.Create(newLetter);
Console.WriteLine("Created {0}.", newLetter.Description);
// Create a new instance of a queueitem and initialize its
// properties.
QueueItem item = new QueueItem
{
QueueId = new EntityReference(Queue.EntityLogicalName, _queueId),
ObjectId = new EntityReference(Letter.EntityLogicalName, _letterId)
};
// Create the queueitem on the server, which will associate
// the letter with the queue.
_queueItemId = _serviceProxy.Create(item);
Console.WriteLine("Created the letter queue item for the queue.");
return;
}
/// <summary>
/// Deletes any entity records that were created for this sample.
/// <param name="prompt">Indicates whether to prompt the user to
/// delete the records created in this sample.</param>
/// </summary>
public void DeleteRequiredRecords(bool prompt)
{
bool deleteRecords = true;
if (prompt)
{
Console.WriteLine("\nDo you want these entity records deleted? (y/n)");
String answer = Console.ReadLine();
deleteRecords = (answer.StartsWith("y") || answer.StartsWith("Y"));
}
if (deleteRecords)
{
_serviceProxy.Delete(QueueItem.EntityLogicalName, _queueItemId);
_serviceProxy.Delete(Letter.EntityLogicalName, _letterId);
_serviceProxy.Delete(Queue.EntityLogicalName, _queueId);
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();
AssignQueueItemWorker app = new AssignQueueItemWorker();
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");
}
}
}
// Additional exceptions to catch: SecurityTokenValidationException, ExpiredSecurityTokenException,
// SecurityAccessDeniedException, MessageSecurityException, and SecurityNegotiationException.
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
' This namespace is found in Microsoft.Crm.Sdk.Proxy.dll assembly
' found in the SDK\bin folder.
Imports Microsoft.Crm.Sdk.Messages
Imports Microsoft.Xrm.Sdk.Client
Namespace Microsoft.Crm.Sdk.Samples
''' <summary>
''' This sample shows how to assign queue item work to some user.
''' </summary>
Public Class AssignQueueItemWorker
#Region "Class Level Members"
''' <summary>
''' Stores the organization service proxy.
''' </summary>
Private _serviceProxy As OrganizationServiceProxy
' Define the IDs needed for this sample.
Private _queueItemId As Guid
Private _letterId As Guid
Private _queueId As Guid
#End Region ' Class Level Members
#Region "How To Sample Code"
''' <summary>
''' This method first connects to the Organization service.
''' Initiate method to create any entity records that this sample requires.
''' Retrieves new owner's details.
''' Update the queue item record to assign it to new owner.
''' Optionally delete any entity records that were created for this sample.
''' <para name="organizationFriendlyName">The friendly name of the
''' target organization.</para>
''' <para name="discoveryServer">The name of the discovery server.</para>
''' <param name="promptForDelete">Indicates whether to prompt the user to
''' delete the records created in this sample.</param>
''' </summary>
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()
' Retrieve the user information.
Dim whoAmIRequest As New WhoAmIRequest()
Dim whoAmIResponse As WhoAmIResponse = CType(_serviceProxy.Execute(whoAmIRequest), WhoAmIResponse)
Dim columnSet As New ColumnSet("fullname")
Dim currentUser As SystemUser = CType(_serviceProxy.Retrieve(SystemUser.EntityLogicalName, _
whoAmIResponse.UserId, columnSet), SystemUser)
Dim currentUserName As String = currentUser.FullName
' Create an instance of an existing queueitem in order to specify
' the user that will be working on it.
Dim queueItem As QueueItem = New QueueItem With {.QueueItemId = _queueItemId, .WorkerId = _
New EntityReference(SystemUser.EntityLogicalName, whoAmIResponse.UserId)}
_serviceProxy.Update(queueItem)
Console.WriteLine("The letter queue item is queued for new owner {0}.", currentUserName)
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.
''' Create a queue record.
''' Create a letter record.
''' Create a queue item for queue record.
''' </summary>
Public Sub CreateRequiredRecords()
' Create a queue instance and set its property values.
Dim newQueue As Queue = New Queue With {.Name = "Example Queue.", .Description = "This is an example queue."}
' Create a new queue and store its returned GUID in a variable
' for later use.
_queueId = _serviceProxy.Create(newQueue)
Console.WriteLine("Created {0}.", newQueue.Name)
Dim newLetter As Letter = New Letter With {.Description = "Example Letter"}
_letterId = _serviceProxy.Create(newLetter)
Console.WriteLine("Created {0}.", newLetter.Description)
' Create a new instance of a queueitem and initialize its
' properties.
Dim item As QueueItem = New QueueItem With { _
.QueueId = New EntityReference(Queue.EntityLogicalName, _queueId), _
.ObjectId = New EntityReference(Letter.EntityLogicalName, _letterId)}
' Create the queueitem on the server, which will associate
' the letter with the queue.
_queueItemId = _serviceProxy.Create(item)
Console.WriteLine("Created the letter queue item for the queue.")
Return
End Sub
''' <summary>
''' Deletes any entity records that were created for this sample.
''' <param name="prompt">Indicates whether to prompt the user to
''' delete the records created in this sample.</param>
''' </summary>
Public Sub DeleteRequiredRecords(ByVal prompt As Boolean)
Dim deleteRecords As Boolean = True
If prompt Then
Console.WriteLine(vbLf & "Do you want these entity records deleted? (y/n)")
Dim answer As String = Console.ReadLine()
deleteRecords = (answer.StartsWith("y") OrElse answer.StartsWith("Y"))
End If
If deleteRecords Then
_serviceProxy.Delete(QueueItem.EntityLogicalName, _queueItemId)
_serviceProxy.Delete(Letter.EntityLogicalName, _letterId)
_serviceProxy.Delete(Queue.EntityLogicalName, _queueId)
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 AssignQueueItemWorker()
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
' Additional exceptions to catch: SecurityTokenValidationException, ExpiredSecurityTokenException,
' SecurityAccessDeniedException, MessageSecurityException, and SecurityNegotiationException.
Finally
Console.WriteLine("Press <Enter> to exit.")
Console.ReadLine()
End Try
End Sub
#End Region ' Main
End Class
End Namespace
See Also
Sample code for queue entities
Queue entities
Sample: Release a queue item to the queue using (early bound)