PropagateByExpressionRequest Class

Article
11/28/2016

Applies To: Dynamics 365 (online), Dynamics 365 (on-premises), Dynamics CRM 2016, Dynamics CRM Online

Contains the data that is needed to create a quick campaign to distribute an activity to accounts, contacts, or leads that are selected by a query.

For the Web API use thePropagateByExpression Action .

Web API support for this message was added with December 2016 update for Microsoft Dynamics 365 (online) and December 2016 Service Pack for Microsoft Dynamics 365 (on-premises) .

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.PropagateByExpressionRequest

Syntax

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

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

Constructors

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

Properties

	Name	Description
	Activity	Gets or sets the activity to be distributed. Required.
	ExecuteImmediately	Gets or sets a value that indicates whether the activity is both created and executed. Required.
	ExtensionData	Gets or sets the structure that contains extra data. Optional.(Inherited from OrganizationRequest.)
	FriendlyName	Gets or sets the user-identifiable name for the campaign. Required.
	Item[String]	Gets or sets the indexer for the Parameters collection.(Inherited from OrganizationRequest.)
	Owner	Gets or sets the owner for the activity. Required.
	OwnershipOptions	Gets or sets the ownership options for propagation. Required.
	Parameters	Gets or sets the collection of parameters for the request. Required, but is supplied by derived classes.(Inherited from OrganizationRequest.)
	PostWorkflowEvent	Gets or sets a value that indicates whether an asynchronous job is used to distribute an activity, such as an email, fax, or letter, to the members of a list. Required.
	QueryExpression	Gets or sets the query criteria to select accounts, contacts, or leads for which activities are created. Required.
	QueueId	Gets or sets the ID of the queue to which the created activities are added. Optional.
	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.)
	SendEmail	Gets or sets a value that indicates whether to send an email about the new activity. Required.
	TemplateId	Gets or sets the ID of the email 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

This message works regardless whether the caller is connected to the server or offline.

Usage

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

Privileges and Access Rights

To perform this action, the caller must have privileges on the Queue and Template entities, and on the specified entity in the Activity property. The caller must also have access rights on the specified records in the QueueId property and the TemplateId property. For a complete list of the required privileges, see PropagateByExpression message privileges.

Notes for Callers

This operation distributes activities that specify a recipient: phone call, appointment, letter, fax, or email.

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.


/// <summary>
/// This method creates a Quick Campaign for a set of accounts selected by a query
/// </summary>
/// <param name="activityEntity">
/// An object that indicates activity type for the quick campaign and 
/// contains values for each of activity that will be created
/// </param>
/// <param name="query">
/// A query that provides a list of accounts for which 
/// the quick campaign is distributed.
/// </param>
/// <param name="ownershipOption">
/// Specifies who will own the activities created by the Quick Campaign
/// The PropagationOwnershipOptions enum is used to specify value for this parameter
/// </param>
/// <param name="isPropagate">
/// Specifies whether the operation is to be executed. 
/// This input is often 'true' for Quick Campaign
/// </param>        
/// <returns></returns>
public Guid CreateAndRetrieveQuickCampaignForQueryExpression(Entity emailActivityEntity, 
    QueryExpression query, PropagationOwnershipOptions ownershipOption, bool isPropagate)
{

    // create the bulkoperation
    PropagateByExpressionRequest request = new PropagateByExpressionRequest() {
        Activity = emailActivityEntity,
        ExecuteImmediately = false, // Default value.
        FriendlyName = "Query Based Quick Campaign",
        OwnershipOptions = ownershipOption,
        QueryExpression = query,
        Owner = new EntityReference("systemuser", _currentUser),
        PostWorkflowEvent = true,
        SendEmail = false,
        TemplateId = Guid.Empty
    };

    PropagateByExpressionResponse response = 
        (PropagateByExpressionResponse)_serviceProxy.Execute(request);

    Guid bulkOpId = response.BulkOperationId;
    System.Console.WriteLine(
        "Quick Campaign with following name has been created. "
        + "Please verify in Web app manually: \n" 
        + request.FriendlyName + "\nPress enter to continue....");
    System.Console.ReadLine();
    return bulkOpId;

}


''' <summary>
''' This method creates a Quick Campaign for a set of accounts selected by a query
''' </summary>
''' <param name="activityEntity">
''' An object that indicates activity type for the quick campaign and 
''' contains values for each of activity that will be created
''' </param>
''' <param name="query">
''' A query that provides a list of accounts for which 
''' the quick campaign is distributed.
''' </param>
''' <param name="ownershipOption">
''' Specifies who will own the activities created by the Quick Campaign
''' The PropagationOwnershipOptions enum is used to specify value for this parameter
''' </param>
''' <param name="isPropagate">
''' Specifies whether the operation is to be executed. 
''' This input is often 'true' for Quick Campaign
''' </param>        
''' <returns></returns>
Public Function CreateAndRetrieveQuickCampaignForQueryExpression _
    (ByVal emailActivityEntity As Entity,
     ByVal query As QueryExpression,
     ByVal ownershipOption As PropagationOwnershipOptions,
     ByVal isPropagate As Boolean) As Guid

    ' create the bulkoperation
    Dim request As New PropagateByExpressionRequest() With
        {
            .Activity = emailActivityEntity,
            .ExecuteImmediately = False,
            .FriendlyName = "Query Based Quick Campaign",
            .OwnershipOptions = ownershipOption,
            .QueryExpression = query,
            .Owner = New EntityReference("systemuser", _currentUser),
            .PostWorkflowEvent = True,
            .SendEmail = False,
            .TemplateId = Guid.Empty
        }

    Dim response As PropagateByExpressionResponse =
        CType(_serviceProxy.Execute(request), PropagateByExpressionResponse)

    Dim bulkOpId As Guid = response.BulkOperationId
    System.Console.WriteLine(
        "Quick Campaign with following name has been created. " _
        &amp; "Please verify in Web app manually: " _
        &amp; vbLf &amp; request.FriendlyName &amp; vbLf _
        &amp; "Press enter to continue....")
    System.Console.ReadLine()
    Return bulkOpId

End Function

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.