Share via

CreateWorkflowFromTemplateRequest Class

  • Article

Applies To: Microsoft Dynamics CRM 2013, Microsoft Dynamics CRM Online

Contains the data that is needed to create a workflow (process) from a workflow template.

Namespace: Microsoft.Crm.Sdk.Messages
Assembly: Microsoft.Crm.Sdk.Proxy (in Microsoft.Crm.Sdk.Proxy.dll)

Syntax

'Declaration
<DataContractAttribute(Namespace:="https://schemas.microsoft.com/crm/2011/Contracts")> _
Public NotInheritable Class CreateWorkflowFromTemplateRequest
    Inherits OrganizationRequest

[DataContractAttribute(Namespace="https://schemas.microsoft.com/crm/2011/Contracts")] 
public sealed class CreateWorkflowFromTemplateRequest : OrganizationRequest

Example

The following example shows how to use this message. For this sample to work correctly, you must be connected to the server to get an IOrganizationService interface. For the complete sample, see the link later in this topic.

// 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();

    OrganizationServiceContext _orgContext = new OrganizationServiceContext(_serviceProxy);

    CreateRequiredRecords();

    CreateWorkflowFromTemplateRequest request = new CreateWorkflowFromTemplateRequest()
    {
        WorkflowName = "Workflow From Template",
        WorkflowTemplateId = _processTemplateId
    };

    // Execute request.
    CreateWorkflowFromTemplateResponse response = (CreateWorkflowFromTemplateResponse)_serviceProxy.Execute(request);
    _processId = response.Id;

    // Verify success.
    // Retrieve the name of the workflow.
    ColumnSet cols = new ColumnSet("name");
    Workflow newWorkflow = (Workflow)_serviceProxy.Retrieve(Workflow.EntityLogicalName, response.Id, cols);
    if (newWorkflow.Name == "Workflow From Template")
    {
        Console.WriteLine("Created {0}.", request.WorkflowName);
    }

    DeleteRequiredRecords(promptforDelete);
}

Remarks

Message Availability

For this message to work, the caller must be connected to the server.

Usage

Pass an instance of this class to the Execute method, which returns an instance of CreateWorkflowFromTemplateResponse.

Privileges and Access Rights

To perform this action, the caller must have privileges on the workflow entity and access rights on the record specified in the WorkflowTemplateId property. For a complete list of the privileges required, see CreateWorkflowFromTemplate Privileges.

Inheritance Hierarchy

System.Object
   Microsoft.Xrm.Sdk.OrganizationRequest
    Microsoft.Crm.Sdk.Messages.CreateWorkflowFromTemplateRequest

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Platforms

Development Platforms

Windows Server 2008, Windows Server 2012, Windows 7 (All Versions), Windows 8 (All Versions)

Target Platforms

Windows Server 2008, ,Windows Server 2012, ,Windows 7 (All Versions),

Change History

See Also

Reference

CreateWorkflowFromTemplateRequest Members
Microsoft.Crm.Sdk.Messages Namespace
CreateWorkflowFromTemplateResponse

Other Resources

Workflow and Process Entities
Workflow (Process) Entity Messages and Methods
Sample: Create a Process Using a Template

Send comments about this topic to Microsoft.
© 2013 Microsoft Corporation. All rights reserved.