Microsoft.Xrm.Sdk.Workflow

A dependency on an argument entity image. Value = 9.

This type value is obsolete.

A dependency on an attribute definition. Value = 8.

A dependency on a custom entity definition. Value = 7.

A dependency on a local parameter. Value = 2.

A dependency on a primary entity image. Value = 3.

A dependency on a primary entity post image. Value = 5.

A dependency on a primary entity pre image. Value = 4.

A dependency on a related entity image. Value = 6.

A dependency on an SDK association. Value = 1.

Indicates the step has been canceled. Value = 4.

The step has failed. Value = 3.

The step is in progress. Value = 1.

The step has successfully completed. Value = 2.

Indicates the step is waiting. Value = 5.

Represents the zero XrmTimeSpan value. This field is read-only.

Initializes a new instance of the class.

For internal use only.

Type: Boolean

For internal use only.

Type: String

For internal use only.

Type: String

Initializes a new instance of the class.

Initializes an instance of the class.

The property defaults to an empty string.

Initializes an instance of the class setting the property.

Type: String. A description of the argument.

Initializes an instance of the class.

Initializes an instance of the class using an argument direction.

Type: . The argument direction.

Initializes an instance of the class.

Initializes an instance of the class with the provided serialized entity record value.

Type: String. The serialized entity record.

Initializes an instance of the class.

By default, the argument is not required.

Initializes an instance of the class with the passed value.

Type: Boolean. Set to true if the argument is required; otherwise, false

Initializes an instance of the class.

The property is set to false by default.

Initializes an instance of the class setting the property .

Type: Boolean. When true, the argument indicates the primary entity; otherwise, false

Obsolete.

Type: String Type: String Type: String

Initializes a new instance of the AttributeTargetAttribute class.

Specifies a String containing the logical name of the entity. See Remarks. Specifies a String containing the logical name of the attribute. The name of an entity is always lowercase, for example, account or new_bankaccount.

Obsolete.

Type: String. Type: String.

Initializes a new instance of the DefaultAttribute class setting the value property.

Type: String. Specifies a String containing the attribute value. If the default value is for an attribute of type lookup, a customer or an owner, then you must use the DefaultAttribute Constructor (String, String) constructor and supply the entity name.

Initializes a new instance of the DefaultAttribute class setting the value and entity name properties.

Type: String. Specifies a String containing the attribute value. Type: String. Specifies a String containing the name of the entity.

Initializes a new instance of the class.

For internal use only.

Obsolete.

Initializes a new instance of the InputAttribute class setting the name property.

Type: String. Specifies a String containing the name of the parameter that will appears in the workflow designer UI.

For internal use only.

Type: Guid. Type: Object.

For internal use only.

Type: Guid. Type: Object. Type: Guid.

For internal use only.

Type: Guid. Type: String. Type: Guid. Type: String. Type: Guid .

For internal use only.

Type: Guid.

Obsolete.

Type: String. Type: Type.

Initializes a new instance of the class.

Type: String. Specifies a String containing the name of the parameter that will appears in the process designer UI.

Initializes a new instance of the class.

Type: String. The name of the parameter that will appear in the process designer UI.

Obsolete.

Type: String.

Obsolete.

Type: String. Type: String.

Obsolete.

Type: String. Type: String. Type: Int32.

Initializes a new instance of the class.

Type: String. Specifies a String containing the name of the entity.

Obsolete.

Type: String. Type: String. Type: String. Type: String.

Initializes a new instance of the class.

Type: String. Type: Guid. Type: String.

Initializes an instance of the class.

Initializes a new instance of the XrmTimeSpan class setting the days, hours and minutes.

Type: Int32. Specifies the days for the time span. Type: Int32. Specifies the hours for the time span. Type: Int32. Specifies the minutes for the time span.

Initializes a new instance of the XrmTimeSpan class setting the years, months, days, hours and minutes.

Type: Int32. Specifies the years for the time span. Type: Int32. Specifies the months for the time span. Type: Int32. Specifies the days for the time span. Type: Int32. Specifies the hours for the time span. Type: Int32. Specifies the minutes for the time span.

Initializes a new instance of the CrmTimeSpan class setting the time span.

Type: TimeSpan. Specifies the time span.

Adds the specified date/time value to this instance.

Type: DateTime. A date/time value to add to the current instance value. Type: DateTime The resultant date and time value.

Creates an instance of a XrmTimeSpan class setting the time span members.

Type: . Specifies the time span. Type: The instance of a XrmTimeSpan class where the time span members are set.

Creates an instance of a XrmTimeSpan class setting the days, hours and minutes.

Type: Int32. Specifies the days for the time span. Type: Int32. Specifies the hours for the time span. Type: Int32. Specifies the minutes for the time span. Type: The instance of a XrmTimeSpan class where the days, hours, and minutes are set.

Creates an instance of a XrmTimeSpan class setting the years, months, days, hours and minutes.

Returns a value indicating whether this instance is equal to a specified XrmTimeSpan object.

Type: . Specifies the XrmTimeSpan instance to test for equality with the current instance. Type: Booleantrue if the value represents the same time interval as the current XrmTimeSpan structure; otherwise, false.

Returns a value indicating whether this instance is equal to a specified object.

Type: Object. Specifies the object to test for equality with the current instance. Type: Booleantrue if value is a XrmTimeSpan object that represents the same time interval as the current XrmTimeSpan structure; otherwise, false.

Returns a hash code for this instance.

Type: Int32 The hash code for this instance.

Indicates whether two XrmTimeSpan instances are equal.

Type: . Specifies a XrmTimeSpan. Type: . Specifies a XrmTimeSpan. Type: Booleantrue if the values of span1 and span2 are equal; otherwise, false.

Indicates whether two XrmTimeSpan instances are not equal.

Type: . Specifies a XrmTimeSpan. Type: . Specifies a XrmTimeSpan. Type: Booleantrue if the values of span1 and span2 are not equal; otherwise, false. Returns a Boolean type. true of the values of span1 and span2 are not equal; otherwise false.

Subtracts the specified XrmTimeSpan from this instance.

Type: DateTime. Specifies a date/time value to subtract. Type: DateTime The value resulting when the passed value is subtracted from this instance.

For internal use only.

Returns Dictionary.

For internal use only.

Returns String.

For internal use only.

Returns Dictionary.

Gets the resulting record following the assignment to a new owner.

Type: OutArgument<>The resulting record following the assignment to a new owner.

Sets the ID of the record to assign.

Type: InArgument<Guid>The ID of the record to assign.

Set the logical name of the entity specified by the property.

Type: InArgument<String>The the logical name of the entity. A workflow dependency for this entity will be added.

Sets the new owner for the record.

Type: InArgument<>The ID of the record to assign.

Gets or sets the entity instance (record).

Type: InOutArgument<>The entity instance (record). This is an entity instance of the type specified by the property. On input, the attribute values that have been set will be used to create the record. Only attribute values for attributes that are valid for create and that the user has access to create will be used, all others will be ignored. On output, this the entity instance that was created.

Gets the ID of the record that was created.

Type: OutArgument<Guid>The ID of the record that was created.

Sets the logical entity name of the record to create.

Type: InArgument<String>The logical entity name of the record to create. This must be the entity name of the record specified in the property. A workflow dependency for this entity will be added.

Gets or sets the logical name of the attribute.

Type: InArgument The logical name of the attribute.

Gets or sets the entity record from which to get the attribute value.

Type: InArgument The entity record from which to get the attribute value.

Gets or sets the logical name of the entity.

Type: InArgument The logical name of the entity. If specified, a workflow dependency for this entity will be added.

Gets or sets the type of the value to be retrieved.

Type: InArgument The type of the value to be retrieved. If no type is specified, the value is returned in it’s native type.

Gets the value of the specified entity attribute.

Type: OutArgument The value of the specified entity attribute.

Gets the entity reference for the primary entity.

Type: OutArgumentThe entity reference for the primary entity.

Sets whether the workflow execution should be suspended.

Type: InArgument Indicates whether the workflow execution should be suspended. If , workflow execution will be suspended.

Gest the callback method used when workflow execution is resumed.

Type: BookmarkCallbackThe callback method used when workflow execution is resumed.

Sets the date and time the workflow execution will resume.

Type: InArgument The date and time the workflow execution will resume.

For internal use only.

Type: String

Sets the collection of logical names of the attributes to be retrieved.

Type: InArgument The collection of logical names of the attributes to be retrieved.

Gets the retrieved entity record.

Type: OutArgument The retrieved entity record.

Sets the ID of the entity record to be retrieved.

Type: InArgument The ID of the entity record to be retrieved.

Set the logical name of the entity specified by the property.

Type: InArgument The logical name of the entity specified by the property.

Sets whether the workflow should throw an exception if the entity record does not exist.

Type: InArgument Indicates whether the workflow should throw an exception if the entity record does not exist. If not specified, this property is by default.

Gets or sets the e-mail record.

Type: InOutArgumentThe e-mail record. On input, this is an record that will be used to create the e-mail message. On output, this the email record that was created.

Gets or sets the ID of the resulting e-mail record.

Type: OutArgumentThe ID of the resulting e-mail record.

Gets or sets the e-mail record.

Type: InOutArgumentThe e-mail record. On input, this is an entity record that will be used to create the e-mail message. On output, this the email entity instance that was created.

Gets or sets the ID of the resulting e-mail.

Type: OutArgumentThe ID of the resulting e-mail.

Gets or sets the ID of the entity record with which the e-mail message is associated.

Type: InArgumentThe ID of the entity record with which the e-mail message is associated. The property is the ID of an entity record that is valid for the attribute. The property must contain the logical name of the entity type for this entity record.

Gets or sets the logical entity name of the entity represented by the property.

Type: InArgumentThe logical entity name of the entity represented by the property.

Gets or sets the ID of the e-mail template to use.

Type: InArgumentThe ID of the e-mail template to use.

Sets the logical name of the attribute.

Type: InArgument The logical name of the attribute.

Gets or sets the entity record.

Type: InOutArgument The entity record. This is a record of the type specified by the property.

Sets the logical entity name of the record specified in the property.

Type: InArgument The logical entity name of the record specified in the property. If specified, a workflow dependency for this entity will be added.

Sets the type for the value to be converted to.

Type: InArgument The type for the value to be converted to.

Sets the value for the attribute specified in the property.

Type: InArgument The value for the attribute specified in the property.

Gets the resulting entity record following the update.

Type: OutArgument The resulting entity record following the update.

Sets the ID of the entity record to update.

Type: InArgument The ID of the entity record to update.

Set the logical name of the entity specified by the property.

Type: InArgument The logical name of the entity specified by the property.

Sets the new state for the entity record.

Type: InArgument The new state for the entity record. Record state and status

Sets the new status that corresponds to the property.

Type: InArgument The new status that corresponds to the property. Must be a valid status for the specified state. Record state and status

Sets the ID of the primary entity for the child workflow.

Type: InArgument The ID of the primary entity for the child workflow.

Sets the logical name of the entity specified by the property.

Type: InArgument The logical name of the entity specified by the property.

Gets or sets the input parameters.

Type: InArgumentThe input parameters.

Sets the ID of the workflow to be started.

Type: InArgument The ID of the workflow to be started. The property corresponds to the attribute which is the primary key for the entity.

Gets or sets the record.

Type: InOutArgument The record to update. This is an entity instance of the type specified by the property. On input, the attribute values that have been set will be used update the record. Only attribute values for attributes that are valid for update and that the user has access to update will be used, all others will be ignored. On output, this is the record that was updated.

Sets the logical entity name of the record to update.

Type: InArgument The logical entity name of the record to update. This must be the name of the record specified in the property. If specified, it will be added to the workflow dependencies.

Gets the collection of activities for this workflow.

Type: Collection The collection of activities for this workflow.

Gets the callback method called when the workflow is resumed.

Type: BookmarkCallbackThe callback method called when the workflow is resumed.

Gets the callback method called when a child of this sequence completes execution.

Type: CompletionCallbackThe callback method called when a child of this sequence completes execution.

Gets the collection of workflow variables.

Type: Collection The collection of workflow variables.

Gets the description of the argument.

Type: ObjectThe description of the argument.

Gets or sets the argument’s description.

Type: StringThe argument’s description.

Gets the argument’s value.

Type: ObjectThe argument’s value.

Gets or sets the data direction of a custom attribute for an action.

Type: The data direction of a custom attribute. Value=0 (input), or 1 (output).

Gets the entity value.

Type: An entity that is passed to the workflow at run-time.

Gets or sets the entity.

Type: The serialized entity record.

Gets the argument value.

Type: ObjectThe argument value.

Gets or sets the argument value.

Type: BooleanTrue if the argument is required; otherwise, false.

Gets the primary entity for which the workflow is run.

Type: ObjectThe primary entity for which the workflow is run.

Gets a value indicating the argument is the primary entity for which the workflow is run.

Type: BooleanWhen true, the argument is the primary entity for the workflow; otherwise, false.

Obsolete.

Type: String

Obsolete.

Type: String

Obsolete.

Type: Type

Gets the logical name of the target attribute.

Type: StringThe logical name of the target attribute.

Gets the logical name of the entity.

Type: StringThe logical name of the entity. The name of an entity is always lowercase, for example, account or new_bankaccount.

Obsolete.

Type: String .

Obsolete.

Type: Type .

Gets the entity name for a value of type lookup, a customer or an owner.

Type: String The entity name for a value of type lookup, a customer or an owner. The name of an entity is always lowercase, for example, account or new_bankaccount.

Gets the default value.

Type: String The default value.

Obsolete.

Returns .

Obsolete.

Returns .

For internal use only.

Type: .

Gets the argument’s value.

Returns ObjectThe arguments value.

Gets the parent context.

Type: The parent context.

Gets the stage information of the process instance.

Type: StringThe stage information of the process instance.

Gets the process category information of the process instance: workflow or dialog.

Type: Int32 The process category information of the process instance: workflow or dialog.

Indicates how the workflow is to be executed.

Type: Int32Value = 0 (background/asynchronous), 1 (real-time). This property is obsolete. Create real-time workflows

Obsolete.

Type: Type.

Gets the name of the parameter that will appear in the process designer UI.

Type: String The name of the parameter that will appear in the process designer UI.

Obsolete.

Type: String .

Obsolete.

Type: Type .

Obsolete.

Type: Int32.

Gets the name of the entity for the attribute.

Type: String The name of the entity for the attribute. The name of an entity is always lowercase, for example, account or new_bankaccount.

Obsolete.

Type: String .

Obsolete.

Type: String .

For internal use only.

Type: String.

For internal use only.

Type: Guid .

For internal use only.

Type: String.

Gets or sets the data type of the workflow argument.

Type: TypeThe data type of the workflow argument.

Gets or sets the collection type that can contain the workflow argument.

Type: TypeThe collection type that can contain the workflow argument.

Gets or sets a description of the workflow argument.

Type: StringA description of the workflow argument.

Gets or sets the data direction of the workflow argument.

Type: Specifies if the argument is input to or output from the workflow.

Gets or sets the logical name of the primary entity that the workflow is executing for.

Type: StringThe logical name of the primary entity.

Gets or sets a name for the workflow argument.

Type: StringA name for the workflow argument.

Gets or sets if the workflow argument is required.

Type: Booleantrue if the argument is required; otherwise false.

Gets or sets whether the argument is the primary entity being supplied to the workflow.

Type: Booleantrue if the argument is the primary entity; otherwise, false.

Gets or sets the value of the workflow argument.

Type: ObjectThe value of the workflow argument.

Gets the number of whole days represented by the current XrmTimeSpan structure.

Type: Int32 The number of whole days represented by the current XrmTimeSpan structure. The value of this property is an Int32 type that is the day component of this instance. The return value can be positive or negative.

Gets the number of whole hours represented by the current XrmTimeSpan structure.

Type: Int32The number of whole hours represented by the current XrmTimeSpan structure. The value of this property is an Int32 type that is the hours component of this instance. The return value ranges from -23 through 23.

Gets the number of whole minutes represented by the current XrmTimeSpan structure.

Type: Int32 The number of whole minutes represented by the current XrmTimeSpan structure. The value of this property is an Int32 type that is the minutes component of this instance. The return value ranges from -59 through 59.

Gets the number of whole months represented by the current XrmTimeSpan structure.

Type: Int32 The number of whole months represented by the current XrmTimeSpan structure. The value of this property is an Int32 type that is the months component of this instance. The return value ranges from -12 through 12.

Gets the number of whole years represented by the current XrmTimeSpan structure.

Type: Int32 The number of whole years represented by the current XrmTimeSpan structure. The value of this property is an Int32 type that is the years component of this instance.

For internal use only.

Activity used to assign a record to a new owner or routes it to a queue.

Custom XAML workflows

Creates an record.

Custom XAML workflows

Retrieves the value of an entity attribute and converts the value to the specified type.

Custom XAML workflows

Retrieves an entity reference for the primary entity for the workflow instance.

Custom XAML workflows

Suspends the workflow until the specified date and time.

Use this activity type instead of the Windows Workflow Foundation activity. Custom XAML workflows

For internal use only.

Retrieves a record.

Custom XAML workflows

Sends an e-mail message.

Custom XAML workflows

Sends an e-mail message to a recipient using an e-mail template.

Custom XAML workflows

Sets a property (attribute) of an entity record.

Custom XAML workflows

Sets the state and status of a record.

Custom XAML workflows

Starts a child workflow.

Custom XAML workflows

Updates a record.

Custom XAML workflows

The base class for all workflows in Microsoft Dynamics 365.

Custom XAML workflows

Specifies a description for the argument.

Contains values for the argument data flow direction.

Create your own actions

Indicates the argument is a property of a message request.

Indicates the argument is a property of a message response.

Specifies the direction, either input or output, for an action argument.

An input argument becomes a custom property on the message request of an action. An output argument becomes a custom property on the message response of an action. Create your own actions

Identifies the argument is an entity to be passed to the workflow at run-time.

Specifies that the argument is required.

Create your own actions

Identifies the argument is the primary entity for which the workflow is run.

This attribute is automatically generated or added and is optional for global actions. Create your own actions

Obsolete.

Add metadata to a custom workflow activity

Contains a required attribute of a parameter picklist or status parameter types.

Process classes, attributes, and types

Obsolete.

Specifies an optional default value that is assigned to a parameter.

This attribute is optional. Process classes, attributes, and types

For internal use only.

Obsolete.

Specifies an input parameter.

Process classes, attributes, and types

For internal use only.

Represents an argument to be supplied to a workflow at run-time.

Provides access to the data associated with the process instance.

Use the IOrganization web service in a custom workflow activitySample: Azure aware custom workflow activitySample: Create a custom activitySample: Update next birthday using a custom workflow activity

Obsolete.

Specifies an output parameter.

Process classes, attributes, and types

Specifies the abstract base class used for attributes.

Process classes, attributes, and types

Obsolete.

Add metadata to a custom workflow activity

Specifies the required attribute of a parameter for lookup, customer or owner parameter types.

Note that only a single instance of this attribute can be added. Process classes, attributes, and types

Obsolete.

Add metadata to a custom workflow activity

For internal use only.

An argument to be passed to a workflow at run-time.

Contains the integer flags to set the attribute.

Contains values for the property types supported by workflows.

Sample: Create a process using a templateSample: Run a workflow

A property. Value = 0.

A property. Value = 1.

A property. Value = 2.

A property. Value = 3.

An property. Value = 4.

An property. Value = 5.

A property. Value = 6.

A property. Value = 7.

An property. Value = 8.

A property. Value = 9.

A property. Value = 10.

Contains values for the workflow step activity status.

Represents a time interval.

This is similar to System.TimeSpan but with added support for month and year.