Recurrence Pattern in Asynchronous Job Execution
[Applies to: Microsoft Dynamics CRM 4.0]
Find the latest SDK documentation: CRM 2015 SDK
You can execute asynchronous system operations one time or on a recurring basis by using a recurrence rule. Use the RecurrencePattern property to specify the recurrence rule. This property is included in the request classes of the CrmService messages that submit asynchronous jobs, such as bulk delete, or bulk detect duplicates. It is also included in the entity that represents asynchronous operations, the system job (asyncoperation) entity instance.
The following classes contain properties to set the recurrence pattern and start time:
Use the following format to set the RecurrencePattern property.
|Recurrence pattern||Frequency of job execution|
|"FREQ=DAILY;"||Once a day|
|"FREQ=HOURLY;"||Once an hour|
|"FREQ=WEEKLY;"||Once a week|
|"FREQ=YEARLY;"||Once a year|
|"FREQ=MINUTELY"||Once a minute|
Note A complete format for a recurrence rule is described in the RFC2445 Internet standard (Internet Calendaring and Scheduling Core Object Specification).
You can specify how frequently you want to repeat the recurrence rule by using an INTERVAL part of the rule. For example, to execute a job every three days, use the following format: "FREQ=DAILY;INTERVAL=3;". The INTERVAL is an optional part of the recurrence rule. If you do not specify INTERVAL, it is set to 1.
To run an asynchronous job without recurrence, set the RecurrencePattern property to String.Empty.
To specify the start time of the job execution, use the RecurrenceStartTime property or the StartDateTime property. The time is specified as CrmDateTime. If the property is not set, the start time is set to the value that is contained in the CrmDateTime.Now property.
- asyncoperation.recurrencepattern Property
- asyncoperation.recurrencestarttime Property
- BulkDeleteRequest.RecurrencePattern Property
- BulkDeleteRequest.StartDateTime Property
- BulkDetectDuplicatesRequest.RecurrencePattern Property
- BulkDetectDuplicatesRequest.RecurrenceStartTime Property