Partager via


RecalculateRequest Class

Applies To: Microsoft Dynamics CRM 2013, Microsoft Dynamics CRM Online

Contains the data that is needed to recalculate system-computed values for rollup fields in the goal hierarchy.

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

// Calculate roll-up of goals.
RecalculateRequest recalculateRequest = new RecalculateRequest()
{
    Target = new EntityReference(Goal.EntityLogicalName, _parentGoalId)
};
_serviceProxy.Execute(recalculateRequest);

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 the RecalculateResponse class.

Privileges and Access Rights

To perform this action, the caller must have privileges on the Goal entity and access rights on the specified record in the Target property. For a complete list of the required privileges, see Recalculate Privileges.

Notes for Callers

Regardless which goal record is a target of the recalculate operation, the rollup fields for all goals in the specified hierarchy are updated.

Note

For each goal in the hierarchy, this operation recalculates the rollup field values that are specified in the associated rollup field (RollupField) entity records. The remaining goal-related rollup fields contain null values.

Inheritance Hierarchy

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

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

Change History

See Also

Reference

RecalculateRequest Members
Microsoft.Crm.Sdk.Messages Namespace
RecalculateResponse

Other Resources

Goal Management Entities
Sample: Roll Up Goal Data for a Custom Period Against the Target Revenue
How Role-Based Security Can Be Used to Control Access to Entities In CRM
How Instance-Based Security Can Be Used to Control Access to Entity Instances (Records) In CRM
Recalculate Privileges

Send comments about this topic to Microsoft.
© 2013 Microsoft Corporation. All rights reserved.