This documentation is archived and is not being maintained.

Workflow Entity Capabilities

Forefront
banner art

[Applies to: Microsoft Dynamics CRM 4.0]

Find the latest SDK documentation: CRM 2015 SDK

This entity represents a series of interrelated action steps and the workflow rules that drive the transition between these steps. A workflow process defines the actions the workflow should take at each step and the workflow rules the workflow should use to evaluate when to go to the next step.

The class for this entity is workflow. For this class, you can use the messages listed in the following table with the Execute method.

MessageDescription
AssignUse this message to assign a workflow to another user.

The information that is needed to assign the entity instance is specified in the TargetOwnedWorkflow class.

CreateUse this message to create a workflow.

The information that is needed to create the entity instance is specified in the TargetCreateWorkflow class.

You can also call the Create method.

CreateWorkflowFromTemplateUse this message to create a workflow from a workflow template.
DeleteUse this message to delete a workflow.

The entity instance to delete is specified in the TargetDeleteWorkflow class.

You can also call the Delete method.

ExecuteWorkflowUse this message to execute a workflow.
GrantAccessUse this message to share a workflow with another security principal (user or team).

The information that is needed to grant access to the entity instance is specified in the TargetOwnedWorkflow class.

ModifyAccessUse this message to change the access rights for a workflow previously shared with another security principal (user or team).

The information that is needed to modify access to the entity instance is specified in the TargetOwnedWorkflow class.

RetrieveUse this message to retrieve a workflow.

The entity instance to retrieve is specified in the TargetRetrieveWorkflow class.

You can also call the Retrieve method.

RetrieveMultipleUse this message to retrieve a collection of workflows.

The query expression that describes the entity instances to retrieve is specified in the Query property of this request.

You can also call the RetrieveMultiple method.

RetrievePrincipalAccessUse this message to retrieve the access the specified security principal (user or team) has to a workflow.

The entity instance to retrieve is specified in the TargetOwnedWorkflow class.

RetrieveSharedPrincipalsAndAccessUse this message to retrieve all the security principals (users or teams) that have access to a workflow, together with their access rights to the workflow.

The entity instance to retrieve is specified in the TargetOwnedWorkflow class.

RevokeAccessUse this message to remove all access to a workflow for the specified security principal (user or team).

The information that is needed to revoke access to the entity instance is specified in the TargetOwnedWorkflow class.

SetStateDynamicEntityUse this message to set the state of a workflow using a DynamicEntity instance.

The possible states are defined in the WorkflowState enumeration.

SetStateWorkflow Use this message to set the state of a workflow.

The possible states are defined in the WorkflowState enumeration.

UpdateUse this message to update a workflow.

The entity instance to update is specified in the TargetUpdateWorkflow class.

You can also use the Update method.


See Also

Concepts

Other Resources


© 2010 Microsoft Corporation. All rights reserved.


Show: