CreateWorkflowFromTemplateRequest Class

Artikkeli
10/20/2016

Applies To: Dynamics CRM 2015

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)

Inheritance Hierarchy

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

Syntax

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

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

[<Sealed>]
[<DataContractAttribute(Namespace = "https://schemas.microsoft.com/crm/2011/Contracts")>]
type CreateWorkflowFromTemplateRequest = 
    class
        inherit OrganizationRequest
    end

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

Constructors

	Name	Description
	CreateWorkflowFromTemplateRequest()	Initializes a new instance of the CreateWorkflowFromTemplateRequest class.

Properties

	Name	Description
	ExtensionData	Gets or sets the structure that contains extra data. Optional.(Inherited from OrganizationRequest.)
	Item[String]	Gets or sets the indexer for the Parameters collection.(Inherited from OrganizationRequest.)
	Parameters	Gets or sets the collection of parameters for the request. Required, but is supplied by derived classes.(Inherited from OrganizationRequest.)
	RequestId	Gets or sets the ID of an asynchronous operation (system job). Optional. (Inherited from OrganizationRequest.)
	RequestName	Gets or sets the name of the request. Required, but is supplied by derived classes.(Inherited from OrganizationRequest.)
	WorkflowName	Gets or sets the name of the new workflow. Required.
	WorkflowTemplateId	Gets or sets the ID of the workflow template. Required.

Methods

	Name	Description
	Equals(Object)	(Inherited from Object.)
	GetHashCode()	(Inherited from Object.)
	GetType()	(Inherited from Object.)
	ToString()	(Inherited from Object.)

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 message privileges.

Examples

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 = new OrganizationServiceProxy(serverConfig.OrganizationUri, serverConfig.HomeRealmUri,
                                                     serverConfig.Credentials, serverConfig.DeviceCredentials))
{
    // 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);
}

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.

Jaa