PropagateByExpressionRequest Class

Article
06/20/2014

Applies To: Microsoft Dynamics CRM 2013, Microsoft 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.

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 PropagateByExpressionRequest
    Inherits OrganizationRequest

[DataContractAttribute(Namespace="https://schemas.microsoft.com/crm/2011/Contracts")] 
public sealed class PropagateByExpressionRequest : 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.

/// <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. " _
        & "Please verify in Web app manually: " _
        & vbLf & request.FriendlyName & vbLf _
        & "Press enter to continue....")
    System.Console.ReadLine()
    Return bulkOpId

End Function

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

Notes for Callers

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

Inheritance Hierarchy

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

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),

PropagateByExpressionRequest Class

Syntax

Example

Remarks

Inheritance Hierarchy

Thread Safety

Platforms

Development Platforms

Target Platforms

Change History

See Also

Reference

Other Resources

Additional resources