MailMergeTemplate Entity Metadata

  • Article

[Applies to: Microsoft Dynamics CRM 2011]

The following information is for the mail merge template entity in a default, uncustomized installation of Microsoft Dynamics CRM. The schema name and early bound class for this entity is MailMergeTemplate.

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 mail merge template entity.

Metadata property Value

EntityLogicalName

mailmergetemplate

DisplayName

Mail Merge Template

DisplayCollectionName

Mail Merge Templates

OTC

9106

OwnershipType

UserOwned

IsCustomizable

True

IsIntersect

False

AutoRouteToOwnerQueue

False

CanBeInManyToMany

True

CanBePrimaryEntityInRelationship

True

CanBeRelatedEntityInRelationship

True

CanCreateAttributes

True

CanCreateCharts

False

CanCreateForms

True

CanCreateViews

True

CanModifyAdditionalSettings

True

CanTriggerWorkflow

True

IsActivity

False

IsActivityParty

False

IsAuditEnabled

False

IsAvailableOffline

True

IsChildEntity

False

IsConnectionsEnabled

canmodifyconnectionsettings

IsCustomEntity

False

IsDocumentManagementEnabled

False

IsDuplicateDetectionEnabled

False

IsEnabledForCharts

False

IsImportable

False

IsMailMergeEnabled

False

IsManaged

True

IsMappable

True

IsReadingPaneEnabled

True

IsRenameable

True

IsValidForAdvancedFind

True

IsValidForQueue

False

IsVisibleInMobile

False

PrimaryIdAttribute

mailmergetemplateid

PrimaryNameAttribute

name

ReportViewName

FilteredMailMergeTemplate

RecurrenceBaseEntityLogicalName

Description

Template for a mail merge document that contains the standard attributes of that document.

Privilege Metadata

The following table shows the privilege metadata for the mail merge template entity.

PrivilegeName Id Type CanBeBasic CanBeDeep CanBeGlobal CanBeLocal

prvAppendMailMergeTemplate

422187bb-aaa0-4539-b8a5-be9d68291776

Append

True

True

True

True

prvAppendToMailMergeTemplate

947f72b5-8e18-47b4-acaa-9638ccc5ea3c

AppendTo

True

True

True

True

prvAssignMailMergeTemplate

94080062-e5be-4a4e-ad41-6295a881fe9d

Assign

True

True

True

True

prvCreateMailMergeTemplate

88ec96ce-3a2b-4822-9375-e016a4127fc2

Create

True

True

True

True

prvDeleteMailMergeTemplate

5978156a-b329-434d-94cf-e77ab08356d1

Delete

True

True

True

True

prvPublishOrgMailMergeTemplate

ac3cc10e-f735-4f34-95e4-097ec2ab478b

None

False

False

True

False

prvReadMailMergeTemplate

933babb9-6e0b-4b63-8196-c2acc272dc7f

Read

True

True

True

True

prvShareMailMergeTemplate

297d73ae-8278-4d60-b3b3-227950b2e6c6

Share

True

True

True

True

prvWriteMailMergeTemplate

2e3a99ab-ec46-4a22-8dac-726e58a1d0f4

Write

True

True

True

True

Attribute Metadata

The following table shows the attribute metadata for the mail merge template entity.

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

body

Body

Body

String

None

True

True

True

True

False

False

False

False

True

True

False

False

True

False

True

Body text of the mail merge template.

componentstate

ComponentState

Component State

Picklist

SystemRequired

True

False

True

False

False

False

False

False

False

True

False

False

False

False

False

For internal use only.

createdby

CreatedBy

Created By

Lookup

None

True

False

True

False

False

False

False

False

False

True

False

False

True

False

True

Unique identifier of the user who created the mail merge template.

createdon

CreatedOn

Created On

DateTime

None

True

False

True

False

False

False

False

False

False

True

False

False

True

False

True

Date and time when the mail merge template was created.

createdonbehalfby

CreatedOnBehalfBy

Created By (Delegate)

Lookup

None

True

False

True

False

False

False

False

False

False

True

False

False

True

False

True

Unique identifier of the delegate user who created the mailmergetemplate.

defaultfilter

DefaultFilter

Default filter

String

None

True

True

True

True

False

False

False

False

True

True

False

False

True

False

True

Default data fields associated with the mail merge template.

description

Description

Description

String

None

True

True

True

True

False

False

False

False

True

True

False

False

True

False

True

Description of the mail merge template.

documentformat

DocumentFormat

Document Format

Picklist

None

True

True

True

True

False

False

False

False

True

True

False

False

True

False

True

Version of the Microsoft Office Word XML format used by the template.

exchangerate

ExchangeRate

Exchange Rate

Decimal

None

True

False

True

False

False

False

False

False

True

True

False

False

True

False

True

Exchange rate for the currency associated with the mailmergetemplate with respect to the base currency.

filename

FileName

File Name

String

None

True

True

True

True

False

False

False

False

True

True

False

False

True

False

True

File name of the mail merge template.

filesize

FileSize

File Size (Bytes)

Integer

None

True

False

True

False

False

False

False

False

True

True

False

False

True

False

True

File size of the mail merge template.

iscustomizable

IsCustomizable

Customizable

ManagedProperty

SystemRequired

False

True

True

True

False

False

False

False

False

True

False

False

False

False

False

Information that specifies whether this component can be customized.

ismanaged

IsManaged

Is Managed

Boolean

SystemRequired

True

False

True

False

False

False

False

False

True

True

False

False

False

False

False

Indicates whether the solution component is part of a managed solution.

ispersonal

IsPersonal

Viewable By

Boolean

SystemRequired

True

True

True

True

False

False

False

False

True

True

False

False

True

False

True

Information about whether the mail merge template is personal or is available to all users.

languagecode

LanguageCode

Language

Integer

None

True

True

True

True

False

False

False

False

True

True

False

False

True

False

True

Language of the mail merge template.

mailmergetemplateid

MailMergeTemplateId

Mail Merge Template

Uniqueidentifier

SystemRequired

True

True

True

False

False

False

False

False

False

True

True

False

True

False

True

Unique identifier of the mail merge template.

mailmergetemplateidunique

MailMergeTemplateIdUnique

Uniqueidentifier

SystemRequired

False

False

True

False

False

False

False

False

False

True

False

False

False

False

False

For internal use only.

mailmergetype

MailMergeType

Mail Merge Type

Picklist

None

True

True

True

True

False

False

False

False

True

True

False

False

True

False

True

Drop-down list for selecting the type of the mail merge.

mimetype

MimeType

Mime Type

String

None

True

True

True

True

False

False

False

False

True

True

False

False

True

False

True

MIME type of the mail merge template.

modifiedby

ModifiedBy

Modified By

Lookup

None

True

False

True

False

False

False

False

False

False

True

False

False

True

False

True

Unique identifier of the user who last modified the mail merge template.

modifiedon

ModifiedOn

Modified On

DateTime

None

True

False

True

False

False

False

False

False

False

True

False

False

True

False

True

Date and time when the mail merge template was last modified.

modifiedonbehalfby

ModifiedOnBehalfBy

Modified By (Delegate)

Lookup

None

True

False

True

False

False

False

False

False

False

True

False

False

True

False

True

Unique identifier of the delegate user who last modified the mailmergetemplate.

name

Name

Name

String

SystemRequired

True

True

True

True

False

False

False

False

True

True

False

True

True

False

True

Name of the mail merge template.

overwritetime

OverwriteTime

Record Overwrite Time

DateTime

SystemRequired

True

False

True

False

False

False

False

False

False

True

False

False

False

False

False

For internal use only.

ownerid

OwnerId

Owner

Owner

SystemRequired

True

True

True

False

False

False

False

False

True

True

False

False

True

False

True

Unique identifier of the user or team who owns the mail merge template.

owningbusinessunit

OwningBusinessUnit

Owning Business Unit

Lookup

None

True

False

True

False

False

False

False

False

False

True

False

False

False

False

False

Unique identifier of the business unit that owns the mail merge template.

owningteam

OwningTeam

Owning Team

Lookup

None

True

False

True

False

False

False

False

False

False

True

False

False

False

False

False

Unique identifier of the team who owns the mail merge template.

owninguser

OwningUser

Owning User

Lookup

None

True

False

True

False

False

False

False

False

False

True

False

False

False

False

False

Unique identifier of the user who owns the mail merge template.

parameterxml

ParameterXml

Parameter Xml

String

None

True

False

True

False

False

False

False

False

True

True

False

False

True

False

True

Parameter Xml.

solutionid

SolutionId

Solution

Uniqueidentifier

SystemRequired

False

False

True

False

False

False

False

False

False

True

False

False

False

False

False

Unique identifier of the associated solution.

statecode

StateCode

Status

State

SystemRequired

True

False

True

False

False

False

False

False

True

True

False

False

True

False

True

Status of the mail merge template.

statuscode

StatusCode

Status Reason

Status

None

True

True

True

True

False

False

False

False

True

True

False

False

True

False

True

Reason for the status of the mail merge template.

supportingsolutionid

SupportingSolutionId

Solution

Uniqueidentifier

None

False

False

False

False

False

False

False

False

False

True

False

False

False

False

False

For internal use only.

templatetypecode

TemplateTypeCode

Associated Entity

EntityName

SystemRequired

True

True

True

True

False

False

False

False

True

True

False

False

True

False

True

Type of mail merge template.

timezoneruleversionnumber

TimeZoneRuleVersionNumber

Time Zone Rule Version Number

Integer

None

True

True

True

True

False

False

False

False

False

True

False

False

False

False

False

For internal use only.

transactioncurrencyid

TransactionCurrencyId

Currency

Lookup

None

True

True

True

True

False

False

False

False

True

True

False

False

True

False

True

Unique identifier of the currency associated with the mailmergetemplate.

utcconversiontimezonecode

UTCConversionTimeZoneCode

UTC Conversion Time Zone Code

Integer

None

True

True

True

True

False

False

False

False

False

True

False

False

False

False

False

Time zone code that was in use when the record was created.

versionnumber

VersionNumber

Version Number

BigInt

None

False

False

True

False

False

False

False

False

False

True

False

False

False

False

False

Version number of the mail merge template.

One-to-Many Relationships

The following table shows the entities that are the referencing entity in a one-to-many relationship with the mail merge template entity.

Relationship schema name Referencing Entity

MailMergeTemplate_AsyncOperations

asyncoperation

mailmergetemplate_principalobjectattributeaccess

principalobjectattributeaccess

MailMergeTemplate_ProcessSessions

processsession

userentityinstancedata_mailmergetemplate

userentityinstancedata

Many-to-Many Relationships

There are no many-to-many relationships for the mail merge template entity.

Many-to-One Relationships

The following table shows the entities that are the referenced entity in a many-to-one relationship with the mail merge template entity.

Relationship schema name Referenced Entity

business_unit_mailmergetemplates

businessunit

owner_mailmergetemplates

owner

lk_mailmergetemplatebase_createdby

systemuser

lk_mailmergetemplatebase_modifiedby

systemuser

lk_mailmergetemplate_modifiedonbehalfby

systemuser

lk_mailmergetemplate_createdonbehalfby

systemuser

TransactionCurrency_MailMergeTemplate

transactioncurrency

See Also

Reference

EntityMetadata
AttributeMetadata
OneToManyRelationshipMetadata
ManyToManyRelationshipMetadata

Concepts

MailMergeTemplate Entity Messages and Methods
MailMergeTemplate Entity Privileges

Other Resources

Activity Entities

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