Sample: Set the state of a workflow

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\Process\Workflows\SetStateWorkflow.cs

SampleCode\VB\Process\Workflows\SetStateWorkflow.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 change the state of a workflow, through activating and deactivating it, by using the SetStateRequest message. In addition, the sample shows how to create a custom XAML workflow. A snippet showing just the key sections of the sample is shown first, followed by the Complete Sample Code.

Example

Code snippet that shows how to activate and deactivate a workflow.

var activateRequest = new SetStateRequest
{
    EntityMoniker = new EntityReference
        (Workflow.EntityLogicalName, _workflowId),
    State = new OptionSetValue((int)WorkflowState.Activated),
    Status = new OptionSetValue((int)workflow_statuscode.Activated)
};
_serviceProxy.Execute(activateRequest);

SetStateRequest deactivateRequest = new SetStateRequest
{
    EntityMoniker = 
        new EntityReference(Workflow.EntityLogicalName, _workflowId),
    State = new OptionSetValue((int)WorkflowState.Draft),
    Status = new OptionSetValue((int)workflow_statuscode.Draft)
};
_serviceProxy.Execute(deactivateRequest);

Dim activateRequest = New SetStateRequest With
                      {
                          .EntityMoniker = New EntityReference(Workflow.EntityLogicalName,
                                                               _workflowId),
                          .State = New OptionSetValue(CInt(Fix(WorkflowState.Activated))),
                          .Status = New OptionSetValue(CInt(Fix(workflow_statuscode.Activated)))
                      }
_serviceProxy.Execute(activateRequest)

Dim deactivateRequest As SetStateRequest =
    New SetStateRequest With
    {
        .EntityMoniker = New EntityReference(Workflow.EntityLogicalName, _workflowId),
        .State = New OptionSetValue(CInt(Fix(WorkflowState.Draft))),
        .Status = New OptionSetValue(CInt(Fix(workflow_statuscode.Draft)))
    }
_serviceProxy.Execute(deactivateRequest)

Example

Code snippet that shows how to create a XAML workflow.

Workflow workflow = new Workflow()
{
    Name = "CreateTaskXAML",
    Type = new OptionSetValue((int)WorkflowType.Definition),
    Category = new OptionSetValue((int)WorkflowCategory.Workflow),
    Scope = new OptionSetValue((int)WorkflowScope.User),
    LanguageCode = 1033,                // U.S. English
    TriggerOnCreate = true,
    OnDemand = true,
    PrimaryEntity = Lead.EntityLogicalName,
    Description =
        "Test workflow for the SetStateWorkflow SDK sample",
    Xaml = xamlWF
};
_workflowId = _serviceProxy.Create(workflow);

Dim workflow As New Workflow() With
    {
        .Name = "CreateTaskXAML",
        .Type = New OptionSetValue(CInt(Fix(WorkflowType.Definition))),
        .Category = New OptionSetValue(CInt(Fix(WorkflowCategory.Workflow))),
        .Scope = New OptionSetValue(CInt(Fix(WorkflowScope.User))),
        .LanguageCode = 1033,
        .TriggerOnCreate = True,
        .OnDemand = True,
        .PrimaryEntity = Lead.EntityLogicalName,
        .Description = "Test workflow for the SetStateWorkflow SDK sample",
        .Xaml = xamlWF
    }
_workflowId = _serviceProxy.Create(workflow)

For the XAML code that defines the workflow, see the Complete Sample Code.

Complete Sample Code

using System;
using System.ServiceModel;

// These namespaces are found in the Microsoft.Xrm.Sdk.dll assembly
// located in the SDK\bin folder of the SDK download.
using Microsoft.Xrm.Sdk;
using Microsoft.Xrm.Sdk.Client;
using Microsoft.Xrm.Sdk.Query;

// These namespaces are found in the Microsoft.Crm.Sdk.Proxy.dll assembly
// located in the SDK\bin folder of the SDK download.
using Microsoft.Crm.Sdk.Messages;

namespace Microsoft.Crm.Sdk.Samples
{
    /// <summary>
    /// This sample shows how to change the state of a workflow.
    /// </summary>
    /// <remarks>
    /// At run-time, you will be given the option to delete all the
    /// database records created by this program.
    /// </remarks>
    public class SetStateWorkflow
    {
        #region Class Level Members

        private Guid _workflowId;
        private OrganizationServiceProxy _serviceProxy;

        #endregion Class Level Members

        #region How To Sample Code
        /// <summary>
        /// This method first creates XAML to define the custom workflow. Afterwards, 
        /// it creates the workflow record with this XAML and then activates it. Finally 
        /// it checks if it is activated and, if so, deactivates it.
        /// </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();

                    CreateRequiredRecords();

                    // Activate the workflow.
                    Console.WriteLine("\nActivating the workflow...");
                    var activateRequest = new SetStateRequest
                    {
                        EntityMoniker = new EntityReference
                            (Workflow.EntityLogicalName, _workflowId),
                        State = new OptionSetValue((int)WorkflowState.Activated),
                        Status = new OptionSetValue((int)workflow_statuscode.Activated)
                    };
                    _serviceProxy.Execute(activateRequest);

                    // Verify that the workflow is activated.
                    Workflow retrievedWorkflow = 
                        (Workflow)_serviceProxy.Retrieve("workflow", _workflowId, new ColumnSet("statecode", "name"));

                    Console.WriteLine("The state of workflow {0} is: {1}.", retrievedWorkflow.Name, retrievedWorkflow.StateCode);

                    // Deactivate the workflow.
                    if (retrievedWorkflow.StateCode == WorkflowState.Activated)
                    {
                        Console.WriteLine("\nDeactivating the workflow...");
                        SetStateRequest deactivateRequest = new SetStateRequest
                        {
                            EntityMoniker = 
                                new EntityReference(Workflow.EntityLogicalName, _workflowId),
                            State = new OptionSetValue((int)WorkflowState.Draft),
                            Status = new OptionSetValue((int)workflow_statuscode.Draft)
                        };
                        _serviceProxy.Execute(deactivateRequest);
                    }

                    // Verify that the workflow is deactivated (in a draft state).
                    retrievedWorkflow =
                        (Workflow)_serviceProxy.Retrieve("workflow", _workflowId, new ColumnSet("statecode", "name"));

                    Console.WriteLine("The state of workflow {0} is: {1}.", retrievedWorkflow.Name, retrievedWorkflow.StateCode);

                    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;
            }
        }

        #region Public methods

        /// <summary>
        /// Creates any entity records that this sample requires.
        /// </summary>
        public void CreateRequiredRecords()
        {
            #region Create XAML

            // Define the workflow XAML.
            string xamlWF;

            // This xml defines a workflow that creates a new task when executed
            xamlWF = @"<?xml version=""1.0"" encoding=""utf-16""?>
                        <Activity x:Class=""CreateTask"" 
                                  https://schemas.microsoft.com/netfx/2009/xaml/activities"" 
                                  xmlns:mva=""clr-namespace:Microsoft.VisualBasic.Activities;assembly=System.Activities, Version=4.0.0.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35"" 
                                  xmlns:mxs=""clr-namespace:Microsoft.Xrm.Sdk;assembly=Microsoft.Xrm.Sdk, Version=5.0.0.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35"" 
                                  xmlns:mxswa=""clr-namespace:Microsoft.Xrm.Sdk.Workflow.Activities;assembly=Microsoft.Xrm.Sdk.Workflow, Version=5.0.0.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35"" 
                                  xmlns:s=""clr-namespace:System;assembly=mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089"" 
                                  xmlns:scg=""clr-namespace:System.Collections.Generic;assembly=mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089"" 
                                  xmlns:srs=""clr-namespace:System.Runtime.Serialization;assembly=System.Runtime.Serialization, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089""                                  
                                  xmlns:this=""clr-namespace:"" xmlns:x=""https://schemas.microsoft.com/winfx/2006/xaml"">
                            <x:Members>
                                <x:Property Name=""InputEntities"" Type=""InArgument(scg:IDictionary(x:String, mxs:Entity))"" />
                                <x:Property Name=""CreatedEntities"" Type=""InArgument(scg:IDictionary(x:String, mxs:Entity))"" />
                            </x:Members>
                            <this:CreateTask.InputEntities>
                                <InArgument x:TypeArguments=""scg:IDictionary(x:String, mxs:Entity)"" />
                            </this:CreateTask.InputEntities>
                            <this:CreateTask.CreatedEntities>
                              <InArgument x:TypeArguments=""scg:IDictionary(x:String, mxs:Entity)"" />
                           </this:CreateTask.CreatedEntities>
                            <mva:VisualBasic.Settings>Assembly references and imported namespaces for internal implementation</mva:VisualBasic.Settings>
                            <mxswa:Workflow>
                                <Sequence>
                                    <Assign x:TypeArguments=""mxs:Entity"" To=""[CreatedEntities(&amp;quot;newTask&amp;quot;)]"" Value=""[New Entity(&amp;quot;task&amp;quot;)]"" />
                                    <mxswa:SetEntityProperty Attribute=""subject"" Entity=""[CreatedEntities(&amp;quot;newTask&amp;quot;)]"" 
                                        EntityName=""task"" TargetType=""{x:Null}"" 
                                                       Value=""[&amp;quot;New Task&amp;quot;]"">
                                    </mxswa:SetEntityProperty>
                                    <mxswa:SetEntityProperty Attribute=""regardingobjectid"" Entity=""[CreatedEntities(&amp;quot;newTask&amp;quot;)]"" 
                                        EntityName=""task"" TargetType=""{x:Null}"" 
                                                       Value=""[New EntityReference(&amp;quot;lead&amp;quot;, New Guid(InputEntities(&amp;quot;primaryEntity&amp;quot;).Id.ToString()))]"">
                                    </mxswa:SetEntityProperty>
                                    <mxswa:CreateEntity EntityId=""{x:Null}"" Entity=""[CreatedEntities(&amp;quot;newTask&amp;quot;)]"" 
                                        EntityName=""task"" />
                                </Sequence>
                            </mxswa:Workflow>
                        </Activity>";

            #endregion Create XAML

            #region Create Workflow

            // Create the workflow
            Workflow workflow = new Workflow()
            {
                Name = "CreateTaskXAML",
                Type = new OptionSetValue((int)WorkflowType.Definition),
                Category = new OptionSetValue((int)WorkflowCategory.Workflow),
                Scope = new OptionSetValue((int)WorkflowScope.User),
                LanguageCode = 1033,                // U.S. English
                TriggerOnCreate = true,
                OnDemand = true,
                PrimaryEntity = Lead.EntityLogicalName,
                Description =
                    "Test workflow for the SetStateWorkflow SDK sample",
                Xaml = xamlWF
            };
            _workflowId = _serviceProxy.Create(workflow);

            Console.WriteLine("Created workflow {0}.", workflow.Name);

            #endregion Create Workflow
        }

        /// <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 toBeDeleted = true;

            if (prompt)
            {
                // 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)
                {
                    toBeDeleted = true;
                }
                else
                {
                    toBeDeleted = false;
                }
            }

            if (toBeDeleted)
            {
                // Delete the workflow.
                _serviceProxy.Delete(Workflow.EntityLogicalName, _workflowId);
                Console.WriteLine("The workflow has been deleted.");
            }
        }
        #endregion Public Methods

        #endregion How To Sample Code

        #region Main method

        /// <summary>
        /// Standard Main() method used by most SDK samples.
        /// </summary>
        /// <param name="args"></param>
        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();

                SetStateWorkflow app = new SetStateWorkflow();
                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 method
    }
}

Imports Microsoft.VisualBasic
Imports System
Imports System.ServiceModel

' These namespaces are found in the Microsoft.Xrm.Sdk.dll assembly
' located in the SDK\bin folder of the SDK download.
Imports Microsoft.Xrm.Sdk
Imports Microsoft.Xrm.Sdk.Client
Imports Microsoft.Xrm.Sdk.Query

' These namespaces are found in the Microsoft.Crm.Sdk.Proxy.dll assembly
' located in the SDK\bin folder of the SDK download.
Imports Microsoft.Crm.Sdk.Messages

Namespace Microsoft.Crm.Sdk.Samples
    ''' <summary>
    ''' This sample shows how to change the state of a workflow.
    ''' </summary>
    ''' <remarks>
    ''' At run-time, you will be given the option to delete all the
    ''' database records created by this program.
    ''' </remarks>
    Public Class SetStateWorkflow
        #Region "Class Level Members"

        Private _workflowId As Guid
        Private _serviceProxy As OrganizationServiceProxy

        #End Region ' Class Level Members

        #Region "How To Sample Code"
        ''' <summary>
        ''' This method first creates XAML to define the custom workflow. Afterwards, 
        ''' it creates the workflow record with this XAML and then activates it. Finally 
        ''' it checks if it is activated and, if so, deactivates it.
        ''' </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()

                    CreateRequiredRecords()

                    ' Activate the workflow.
                    Console.WriteLine(vbLf &amp; "Activating the workflow...")
                    Dim activateRequest = New SetStateRequest With
                                          {
                                              .EntityMoniker = New EntityReference(Workflow.EntityLogicalName,
                                                                                   _workflowId),
                                              .State = New OptionSetValue(CInt(Fix(WorkflowState.Activated))),
                                              .Status = New OptionSetValue(CInt(Fix(workflow_statuscode.Activated)))
                                          }
                    _serviceProxy.Execute(activateRequest)

                    ' Verify that the workflow is activated.
                    Dim retrievedWorkflow As Workflow =
                        _serviceProxy.Retrieve("workflow",
                                               _workflowId,
                                               New ColumnSet("statecode", "name")).ToEntity(Of Workflow)()

                    Console.WriteLine("The state of workflow {0} is: {1}.",
                                      retrievedWorkflow.Name,
                                      retrievedWorkflow.StateCode)

                    ' Deactivate the workflow.
                    If retrievedWorkflow.StateCode = WorkflowState.Activated Then
                        Console.WriteLine(vbLf &amp; "Deactivating the workflow...")
                        Dim deactivateRequest As SetStateRequest =
                            New SetStateRequest With
                            {
                                .EntityMoniker = New EntityReference(Workflow.EntityLogicalName, _workflowId),
                                .State = New OptionSetValue(CInt(Fix(WorkflowState.Draft))),
                                .Status = New OptionSetValue(CInt(Fix(workflow_statuscode.Draft)))
                            }
                        _serviceProxy.Execute(deactivateRequest)
                    End If

                    ' Verify that the workflow is deactivated (in a draft state).
                    retrievedWorkflow = _serviceProxy.Retrieve("workflow",
                                                               _workflowId,
                                                               New ColumnSet("statecode", "name")).ToEntity(Of Workflow)()

                    Console.WriteLine("The state of workflow {0} is: {1}.",
                                      retrievedWorkflow.Name,
                                      retrievedWorkflow.StateCode)

                    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

        #Region "Public methods"

        ''' <summary>
        ''' Creates any entity records that this sample requires.
        ''' </summary>
        Public Sub CreateRequiredRecords()
'           #Region "Create XAML"

            ' Define the workflow XAML.
            Dim xamlWF As String

            ' This xml defines a workflow that creates a new task when executed
            xamlWF = "<?xml version=""1.0"" encoding=""utf-16""?>" &amp; _
                "<Activity x:Class=""CreateTask"" " &amp; _
                "          https://schemas.microsoft.com/netfx/2009/xaml/activities"" " &amp; _
                "          xmlns:mva=""clr-namespace:Microsoft.VisualBasic.Activities;assembly=System.Activities, Version=4.0.0.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35"" " &amp; _
                "          xmlns:mxs=""clr-namespace:Microsoft.Xrm.Sdk;assembly=Microsoft.Xrm.Sdk, Version=5.0.0.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35"" " &amp; _
                "          xmlns:mxswa=""clr-namespace:Microsoft.Xrm.Sdk.Workflow.Activities;assembly=Microsoft.Xrm.Sdk.Workflow, Version=5.0.0.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35"" " &amp; _
                "          xmlns:s=""clr-namespace:System;assembly=mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089"" " &amp; _
                "          xmlns:scg=""clr-namespace:System.Collections.Generic;assembly=mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089"" " &amp; _
                "          xmlns:srs=""clr-namespace:System.Runtime.Serialization;assembly=System.Runtime.Serialization, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089"" " &amp; _
                "          xmlns:this=""clr-namespace:"" xmlns:x=""https://schemas.microsoft.com/winfx/2006/xaml"">" &amp; _
                "    <x:Members>" &amp; _
                "        <x:Property Name=""InputEntities"" Type=""InArgument(scg:IDictionary(x:String, mxs:Entity))"" />" &amp; _
                "        <x:Property Name=""CreatedEntities"" Type=""InArgument(scg:IDictionary(x:String, mxs:Entity))"" />" &amp; _
                "    </x:Members>" &amp; _
                "    <this:CreateTask.InputEntities>" &amp; _
                "        <InArgument x:TypeArguments=""scg:IDictionary(x:String, mxs:Entity)"" />" &amp; _
                "    </this:CreateTask.InputEntities>" &amp; _
                "    <this:CreateTask.CreatedEntities>" &amp; _
                "      <InArgument x:TypeArguments=""scg:IDictionary(x:String, mxs:Entity)"" />" &amp; _
                "   </this:CreateTask.CreatedEntities>" &amp; _
                "    <mva:VisualBasic.Settings>Assembly references and imported namespaces for internal implementation</mva:VisualBasic.Settings>" &amp; _
                "    <mxswa:Workflow>" &amp; _
                "        <Sequence>" &amp; _
                "            <Assign x:TypeArguments=""mxs:Entity"" To=""[CreatedEntities(&amp;quot;newTask&amp;quot;)]"" Value=""[New Entity(&amp;quot;task&amp;quot;)]"" />" &amp; _
                "            <mxswa:SetEntityProperty Attribute=""subject"" Entity=""[CreatedEntities(&amp;quot;newTask&amp;quot;)]"" " &amp; _
                "                EntityName=""task"" TargetType=""{x:Null}"" " &amp; _
                "                               Value=""[&amp;quot;New Task&amp;quot;]"">" &amp; _
                "            </mxswa:SetEntityProperty>" &amp; _
                "            <mxswa:SetEntityProperty Attribute=""regardingobjectid"" Entity=""[CreatedEntities(&amp;quot;newTask&amp;quot;)]"" " &amp; _
                "                EntityName=""task"" TargetType=""{x:Null}"" " &amp; _
                "                               Value=""[New EntityReference(&amp;quot;lead&amp;quot;, New Guid(InputEntities(&amp;quot;primaryEntity&amp;quot;).Id.ToString()))]"">" &amp; _
                "            </mxswa:SetEntityProperty>" &amp; _
                "            <mxswa:CreateEntity EntityId=""{x:Null}"" Entity=""[CreatedEntities(&amp;quot;newTask&amp;quot;)]"" " &amp; _
                "                EntityName=""task"" />" &amp; _
                "        </Sequence>" &amp; _
                "    </mxswa:Workflow>" &amp; _
                "</Activity>"

'           #End Region ' Create XAML

'           #Region "Create Workflow"

            ' Create the workflow
            Dim workflow As New Workflow() With
                {
                    .Name = "CreateTaskXAML",
                    .Type = New OptionSetValue(CInt(Fix(WorkflowType.Definition))),
                    .Category = New OptionSetValue(CInt(Fix(WorkflowCategory.Workflow))),
                    .Scope = New OptionSetValue(CInt(Fix(WorkflowScope.User))),
                    .LanguageCode = 1033,
                    .TriggerOnCreate = True,
                    .OnDemand = True,
                    .PrimaryEntity = Lead.EntityLogicalName,
                    .Description = "Test workflow for the SetStateWorkflow SDK sample",
                    .Xaml = xamlWF
                }
            _workflowId = _serviceProxy.Create(workflow)

            Console.WriteLine("Created workflow {0}.", workflow.Name)

'           #End Region ' Create Workflow
        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 toBeDeleted As Boolean = True

            If prompt Then
                ' Ask the user if the created entities should be deleted.
                Console.Write(vbLf &amp; "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
                    toBeDeleted = True
                Else
                    toBeDeleted = False
                End If
            End If

            If toBeDeleted Then
                ' Delete the workflow.
                _serviceProxy.Delete(Workflow.EntityLogicalName, _workflowId)
                Console.WriteLine("The workflow has been deleted.")
            End If
        End Sub
        #End Region ' Public Methods

        #End Region ' How To Sample Code

        #Region "Main method"

        ''' <summary>
        ''' Standard Main() method used by most SDK samples.
        ''' </summary>
        ''' <param name="args"></param>
        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 SetStateWorkflow()
                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 System.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 System.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 method
    End Class
End Namespace

See Also

SetStateRequest
IOrganizationService
Sample code for workflows
Write workflows to automate business processes
Custom XAML workflows