サンプル: キュー アイテムのキューへの解放 (事前バインド)
公開日: 2016年11月
対象: Dynamics CRM 2015
このサンプル コードは、Microsoft Dynamics CRM 2015 および Microsoft Dynamics CRM Online 2015 更新プログラム 向けです。Microsoft Dynamics CRM SDK パッケージをダウンロードします。 このサンプル コードは、ダウンロード パッケージの次の場所にあります。
SampleCode\CS\BusinessDataModel\BusinessManagement\RemoveQueueItemWorker.cs
要件
この SDK で提供するサンプル コードを実行するために必要な要件については、「サンプルとヘルパー コードの使用」を参照してください。
使用例
このサンプルは、ReleaseToQueueRequest を使用して、ユーザーが作業しているキュー アイテムとそのユーザーの関連付けを解除し、キュー アイテムを解放してキューに戻す方法を示します。
例
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;
using Microsoft.Xrm.Sdk.Discovery;
// 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 release queued object from worker's queue.
/// </summary>
public class RemoveQueueItemWorker
{
#region Class Level Members
// Define the IDs needed for this sample.
private Guid _queueItemId;
private Guid _letterId;
private Guid _queueId;
private OrganizationServiceProxy _serviceProxy;
#endregion Class Level Members
#region How To Sample Code
/// <summary>
/// Create and configure the organization service proxy.
/// Initiate method to create any entity records that this sample requires.
/// Remove worker from queue item to release queued object
/// which user is working on.
/// 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 = new OrganizationServiceProxy(serverConfig.OrganizationUri, serverConfig.HomeRealmUri, serverConfig.Credentials, serverConfig.DeviceCredentials))
{
// This statement is required to enable early-bound type support.
_serviceProxy.EnableProxyTypes();
CreateRequiredRecords();
// Remove worker from queue item to release queued object
// from worker's queue using ReleaseToQueueRequest
ReleaseToQueueRequest releaseToQueueRequest = new ReleaseToQueueRequest
{
QueueItemId = _queueItemId
};
_serviceProxy.Execute(releaseToQueueRequest);
Console.WriteLine("Released the queued object from worker queue.");
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.
/// Retrieves new owner's details.
/// Update the queue item record to assign it to new owner.
/// </summary>
public void CreateRequiredRecords()
{
// Create a private queue instance and set its property values.
Queue newQueue = new Queue
{
Name = "Example Queue.",
Description = "This is an example queue.",
QueueViewType = new OptionSetValue((int)QueueQueueViewType.Private)
};
// 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.");
// 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);
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();
RemoveQueueItemWorker app = new RemoveQueueItemWorker();
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
}
}
関連項目
キュー エンティティのサンプル コード
キュー エンティティ
© 2017 Microsoft. All rights reserved. 著作権