Sample: Basic plug-in
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:
SDK\SampleCode\CS\Plug-ins\FollowupPlugin.cs
SDK\SampleCode\VB\Plug-ins\FollowupPlugin.vb
Requirements
Register this plug-in for an account entity, on the Create message, and in asynchronous mode. Alternately, you can register the plug-in on a post-event in the sandbox.
Demonstrates
This sample shows how to write a basic plug-in that can access the Microsoft Dynamics CRM organization Web service.
The plug-in creates a task activity after a new account is created. The activity reminds the user to follow-up with the new account customer one week after the account was created.
Example
using System;
using System.ServiceModel;
// Microsoft Dynamics CRM namespace(s)
using Microsoft.Xrm.Sdk;
namespace Microsoft.Crm.Sdk.Samples
{
public class FollowupPlugin: IPlugin
{
/// <summary>
/// A plug-in that creates a follow-up task activity when a new account is created.
/// </summary>
/// <remarks>Register this plug-in on the Create message, account entity,
/// and asynchronous mode.
/// </remarks>
public void Execute(IServiceProvider serviceProvider)
{
//Extract the tracing service for use in debugging sandboxed plug-ins.
ITracingService tracingService =
(ITracingService)serviceProvider.GetService(typeof(ITracingService));
// Obtain the execution context from the service provider.
IPluginExecutionContext context = (IPluginExecutionContext)
serviceProvider.GetService(typeof(IPluginExecutionContext));
// The InputParameters collection contains all the data passed in the message request.
if (context.InputParameters.Contains("Target") &&
context.InputParameters["Target"] is Entity)
{
// Obtain the target entity from the input parameters.
Entity entity = (Entity)context.InputParameters["Target"];
// Verify that the target entity represents an account.
// If not, this plug-in was not registered correctly.
if (entity.LogicalName != "account")
return;
try
{
// Create a task activity to follow up with the account customer in 7 days.
Entity followup = new Entity("task");
followup["subject"] = "Send e-mail to the new customer.";
followup["description"] =
"Follow up with the customer. Check if there are any new issues that need resolution.";
followup["scheduledstart"] = DateTime.Now.AddDays(7);
followup["scheduledend"] = DateTime.Now.AddDays(7);
followup["category"] = context.PrimaryEntityName;
// Refer to the account in the task activity.
if (context.OutputParameters.Contains("id"))
{
Guid regardingobjectid = new Guid(context.OutputParameters["id"].ToString());
string regardingobjectidType = "account";
followup["regardingobjectid"] =
new EntityReference(regardingobjectidType, regardingobjectid);
}
// Obtain the organization service reference.
IOrganizationServiceFactory serviceFactory = (IOrganizationServiceFactory)serviceProvider.GetService(typeof(IOrganizationServiceFactory));
IOrganizationService service = serviceFactory.CreateOrganizationService(context.UserId);
// Create the task in Microsoft Dynamics CRM.
tracingService.Trace("FollowupPlugin: Creating the task activity.");
service.Create(followup);
}
catch (FaultException<OrganizationServiceFault> ex)
{
throw new InvalidPluginExecutionException("An error occurred in the FollupupPlugin plug-in.", ex);
}
catch (Exception ex)
{
tracingService.Trace("FollowupPlugin: {0}", ex.ToString());
throw;
}
}
}
}
}
Imports System.ServiceModel
' Microsoft Dynamics CRM namespace(s)
Imports Microsoft.Xrm.Sdk
Namespace Microsoft.Crm.Sdk.Samples
Public Class FollowupPlugin
Implements IPlugin
''' <summary>
''' A plug-in that creates a follow-up task activity when a new account is created.
''' </summary>
''' <remarks>Register this plug-in on the Create message, account entity,
''' and asynchronous mode.
''' </remarks>
Public Sub Execute(ByVal serviceProvider As IServiceProvider) _
Implements IPlugin.Execute
'Extract the tracing service for use in debugging sandboxed plug-ins.
Dim tracingService As ITracingService =
CType(serviceProvider.GetService(GetType(ITracingService)),
ITracingService)
' Obtain the execution context from the service provider.
Dim context As IPluginExecutionContext =
CType(serviceProvider.GetService(GetType(IPluginExecutionContext)),
IPluginExecutionContext)
' The InputParameters collection contains all the data passed in the message request.
If context.InputParameters.Contains("Target") AndAlso
TypeOf context.InputParameters("Target") Is Entity Then
' Obtain the target entity from the input parameters.
Dim entity As Entity = CType(context.InputParameters("Target"), Entity)
' Verify that the target entity represents an account.
' If not, this plug-in was not registered correctly.
If entity.LogicalName.Equals("account") Then
Try
' Create a task activity to follow up with the account customer in 7 days.
Dim followup As New Entity("task")
followup("subject") = "Send e-mail to the new customer."
followup("description") = "Follow up with the customer. " _
& "Check if there are any new issues that need resolution."
followup("scheduledstart") = Date.Now.AddDays(7)
followup("scheduledend") = Date.Now.AddDays(7)
followup("category") = context.PrimaryEntityName
' Refer to the account in the task activity.
If context.OutputParameters.Contains("id") Then
Dim regardingobjectid As _
New Guid(context.OutputParameters("id").ToString())
Dim regardingobjectidType As String = "account"
followup("regardingobjectid") =
New EntityReference(regardingobjectidType,
regardingobjectid)
End If
' Obtain the organization service reference.
Dim serviceFactory As IOrganizationServiceFactory =
CType(serviceProvider.GetService(GetType(IOrganizationServiceFactory)),
IOrganizationServiceFactory)
Dim service As IOrganizationService =
serviceFactory.CreateOrganizationService(context.UserId)
' Create the task in Microsoft Dynamics CRM.
tracingService.Trace("FollowupPlugin: Creating the task activity.")
service.Create(followup)
Catch ex As FaultException(Of OrganizationServiceFault)
Throw New InvalidPluginExecutionException(
"An error occurred in the FollupupPlugin plug-in.", ex)
Catch ex As Exception
tracingService.Trace("FollowupPlugin: {0}", ex.ToString())
Throw
End Try
End If
End If
End Sub
End Class
End Namespace
See Also
IPlugin
IPluginExecutionContext
ITracingService
IOrganizationServiceFactory
Plug-in development
Sample: Web access from a sandboxed plug-in
Write a plug-in
Register and Deploy Plug-Ins
Event execution pipeline