RecurrenceRule Entity Metadata

  • Article

[Applies to: Microsoft Dynamics CRM 2011]

The following information is for the recurrence rule entity in a default, uncustomized installation of Microsoft Dynamics CRM. The schema name and early bound class for this entity is RecurrenceRule.

To view the entity metadata for your organization, install the Metadata Browser solution described in Browse the Metadata for Your Organization.

In This Topic

Entity Metadata

Privilege Metadata

Attribute Metadata

One-to-Many Relationships

Many-to-Many Relationships

Many-to-One Relationships

Entity Metadata

The following table shows the metadata for the recurrence rule entity.

Entity metadata property Value

OTC

4250

EntityLogicalName

recurrencerule

DisplayName

Recurrence Rule

DisplayCollectionName

Recurrence Rules

IsCustomizable

False

OwnershipType

UserOwned

AutoRouteToOwnerQueue

False

CanBeInManyToMany

False

CanBePrimaryEntityInRelationship

False

CanBeRelatedEntityInRelationship

False

CanCreateAttributes

False

CanCreateCharts

False

CanCreateForms

False

CanCreateViews

False

CanModifyAdditionalSettings

False

CanTriggerWorkflow

False

IsActivity

False

IsActivityParty

False

IsAuditEnabled

False

IsAvailableOffline

True

IsChildEntity

False

IsConnectionsEnabled

canmodifyconnectionsettings

IsCustomEntity

False

IsDocumentManagementEnabled

False

IsDuplicateDetectionEnabled

False

IsEnabledForCharts

False

IsImportable

False

IsIntersect

False

IsMailMergeEnabled

False

IsManaged

True

IsMappable

False

IsReadingPaneEnabled

True

IsRenameable

False

IsValidForAdvancedFind

False

IsValidForQueue

False

IsVisibleInMobile

False

PrimaryIdAttribute

ruleid

PrimaryNameAttribute

ReportViewName

Description

Recurrence Rule represents the pattern of incidence of recurring entities.

Privilege Metadata

The following table shows the privilege metadata for the recurrence rule entity.

PrivilegeName

Id

Type

CanBeBasic

CanBeDeep

CanBeGlobal

CanBeLocal

prvAppendActivity

78777c10-09ab-4326-b4c8-cf5729702937

Append

True

True

True

True

prvAppendToActivity

6ec8e901-d770-44c0-8f12-d07425f638bd

AppendTo

True

True

True

True

prvAssignActivity

8b99344e-ebbf-4f84-8438-e1e34d194de9

Assign

True

True

True

True

prvCreateActivity

091df793-fe5e-44d4-b4ca-7e3f580c4664

Create

True

True

True

True

prvDeleteActivity

bb4457f2-9b45-4482-a95a-7adef25f388a

Delete

True

True

True

True

prvReadActivity

650c14fe-3521-45fe-a000-84138688e45d

Read

True

True

True

True

prvShareActivity

b5f2ee06-d359-4495-bbda-312aae1c6b1e

Share

True

True

True

True

prvWriteActivity

0dc8f72c-57d5-4b4d-8892-fe6aac0e4b81

Write

True

True

True

True

Attribute Metadata

The following table shows the attribute metadata for the recurrence rule entity.

LogicalName SchemaName Type RequiredLevel IsValidForCreate IsValidForRead IsValidForUpdate CanBeSecuredForCreate CanBeSecuredForRead CanBeSecuredForUpdate IsCustomizable IsAuditEnabled IsManaged IsPrimaryId IsPrimaryName IsRenameable IsSecured IsValidForAdvancedFind DisplayName DeprecatedVersion Description

createdby

CreatedBy

Lookup

None

False

True

False

False

False

False

False

False

True

False

False

False

False

True

Created By

Unique identifier of the user who created the recurrence rule.

createdon

CreatedOn

DateTime

None

False

True

False

False

False

False

False

False

True

False

False

False

False

True

Created On

Date and time when the recurrence rule was created.

createdonbehalfby

CreatedOnBehalfBy

Lookup

None

False

True

False

False

False

False

False

False

True

False

False

False

False

True

Created By (Delegate)

Unique identifier of the delegate user who created the recurrence rule.

dayofmonth

DayOfMonth

Integer

None

True

True

True

False

False

False

False

True

True

False

False

False

False

False

Day Of Month

The day of the month on which the recurring appointment or task occurs.

daysofweekmask

DaysOfWeekMask

Integer

None

True

True

True

False

False

False

False

True

True

False

False

False

False

False

Days Of Week Mask

Bitmask representing the days of the week on which the recurring appointment or task occurs.

duration

Duration

Integer

None

True

True

True

False

False

False

False

True

True

False

False

False

False

False

Duration

Duration of the recurrence pattern in minutes.

effectiveenddate

EffectiveEndDate

DateTime

None

True

True

True

False

False

False

False

True

True

False

False

False

False

False

Effective End Date

The actual end date for expansion of the recurrence pattern.

effectivestartdate

EffectiveStartDate

DateTime

None

True

True

True

False

False

False

False

True

True

False

False

False

False

False

Effective Start Date

The actual start date for expansion of the recurrence pattern.

endtime

EndTime

DateTime

None

True

True

True

False

False

False

False

True

True

False

False

False

False

False

End Time

End time of the associated activity.

firstdayofweek

FirstDayOfWeek

Integer

None

True

True

False

False

False

False

False

True

True

False

False

False

False

False

First Day Of Week

First day Of week for the recurrence pattern.

instance

Instance

Picklist

None

True

True

True

False

False

False

False

True

True

False

False

False

False

False

Instance

Specifies the count for which the recurrence pattern is valid for a given interval.

interval

Interval

Integer

None

True

True

True

False

False

False

False

True

True

False

False

False

False

False

Interval

Number of units of a given recurrence type between occurrences.

isnthmonthly

IsNthMonthly

Boolean

SystemRequired

True

True

True

False

False

False

False

True

True

False

False

False

False

True

Nth Monthly

Specifies whether the monthly recurrence pattern is Nth monthly, valid only for monthly recurrence.

isnthyearly

IsNthYearly

Boolean

SystemRequired

True

True

True

False

False

False

False

True

True

False

False

False

False

True

Nth Yearly

Specifies whether the yearly recurrence pattern is Nth yearly, valid only for yearly recurrence.

isregenerate

IsRegenerate

Boolean

SystemRequired

True

True

True

False

False

False

False

True

True

False

False

False

False

True

Regenerate

Valid only for task type recurrence,indicates whether task should be regenerated.

isweekdaypattern

IsWeekDayPattern

Boolean

SystemRequired

True

True

True

False

False

False

False

True

True

False

False

False

False

True

Every Weekday

Specifies whether the weekly recurrence pattern is actually a daily every weekday pattern, valid only for weekly recurrence.

modifiedby

ModifiedBy

Lookup

None

False

True

False

False

False

False

False

False

True

False

False

False

False

True

Modified By

Unique identifier of the user who last modified the recurrence rule.

modifiedon

ModifiedOn

DateTime

None

False

True

False

False

False

False

False

False

True

False

False

False

False

True

Modified On

Date and time when the recurrence rule was last modified.

modifiedonbehalfby

ModifiedOnBehalfBy

Lookup

None

False

True

False

False

False

False

False

False

True

False

False

False

False

True

Created By (Delegate)

Unique identifier of the delegate user who modified the recurrence rule.

monthofyear

MonthOfYear

Picklist

None

True

True

True

False

False

False

False

True

True

False

False

False

False

False

Month Of Year

Specifies the month of the year valid for the recurrence pattern.

objectid

ObjectId

Lookup

None

True

True

True

False

False

False

False

True

True

False

False

False

False

False

Regarding

Unique identifier of the object with which the recurrence rule is associated.

occurrences

Occurrences

Integer

None

True

True

True

False

False

False

False

True

True

False

False

False

False

False

Occurrences

Number of occurrences of the recurrence pattern.

ownerid

OwnerId

Owner

SystemRequired

True

True

False

False

False

False

False

True

True

False

False

False

False

True

Owner

Unique identifier of the user or team who owns the recurrence rule.

owningbusinessunit

OwningBusinessUnit

Lookup

None

False

True

False

False

False

False

False

False

True

False

False

False

False

False

Owning Business Unit

Unique identifier of the business unit that owns the recurrence rule.

owningteam

OwningTeam

Lookup

None

False

True

False

False

False

False

False

False

True

False

False

False

False

True

Owning Team

owninguser

OwningUser

Lookup

None

False

True

False

False

False

False

False

False

True

False

False

False

False

True

Owning User

patternenddate

PatternEndDate

DateTime

None

True

True

True

False

False

False

False

True

True

False

False

False

False

True

Recurrence Range End

End date of the Recurrence Range.

patternendtype

PatternEndType

Picklist

SystemRequired

True

True

True

False

False

False

False

True

True

False

False

False

False

True

Pattern End Type

Pattern End Type of a recurring series.

patternstartdate

PatternStartDate

DateTime

ApplicationRequired

True

True

True

False

False

False

False

True

True

False

False

False

False

True

Recurrence Range Start

Start date of the Recurrence Range.

recurrencepatterntype

RecurrencePatternType

Picklist

SystemRequired

True

True

True

False

False

False

False

True

True

False

False

False

False

True

Recurrence Pattern

Type of Recurrence.

ruleid

RuleId

Uniqueidentifier

SystemRequired

True

True

False

False

False

False

False

False

True

True

False

False

False

False

Recurrence Rule

Unique identifier of the entity associated with recurrence rule.

starttime

StartTime

DateTime

None

True

True

True

False

False

False

False

True

True

False

False

False

False

False

Start Time

Start time of the recurring activity.

versionnumber

VersionNumber

BigInt

None

False

True

False

False

False

False

False

False

True

False

False

False

False

False

One-to-Many Relationships

The following table shows the entities that are the referencing entity in a one-to-many relationship with the recurrence rule entity.

Relationship schema name Referencing entity

recurrencerule_recurringappointmentmaster

recurringappointmentmaster

Many-to-Many Relationships

There are no many-to-many relationships for the recurrence rule entity.

Many-to-One Relationships

The following table shows the entities that are the referenced entity in a many-to-one relationship with the recurrence rule entity.

Relationship schema name Referencing entity

activity_pointer_recurrencerule

activitypointer

business_unit_recurrencerule

businessunit

owner_recurrencerules

owner

lk_recurrencerule_modifiedby

systemuser

lk_recurrencerule_createdby

systemuser

lk_recurrencerulebase_createdonbehalfby

systemuser

lk_recurrencerulebase_modifiedonbehalfby

systemuser

See Also

Reference

EntityMetadata
AttributeMetadata
OneToManyRelationshipMetadata
ManyToManyRelationshipMetadata

Concepts

RecurrenceRule Entity Messages and Methods
RecurrenceRule Entity Privileges

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