Fax Entity Metadata

  • Article

[Applies to: Microsoft Dynamics CRM 2011]

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

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

In This Section

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 fax entity.

Entity metadata property Value

OTC

4204

EntityLogicalName

fax

DisplayName

Fax

IsCustomizable

True

OwnershipType

UserOwned

IsAvailableOffline

True

AutoRouteToOwnerQueue

False

CanBeInManyToMany

True

CanBePrimaryEntityInRelationship

True

CanBeRelatedEntityInRelationship

True

CanCreateAttributes

True

CanCreateCharts

True

CanCreateForms

True

CanCreateViews

True

CanModifyAdditionalSettings

True

CanTriggerWorkflow

True

IsActivity

True

IsActivityParty

False

IsAuditEnabled

False

IsChildEntity

False

IsConnectionsEnabled

canmodifyconnectionsettings

IsCustomEntity

False

IsDocumentManagementEnabled

False

IsDuplicateDetectionEnabled

True

IsEnabledForCharts

True

IsImportable

True

IsIntersect

False

IsMailMergeEnabled

False

IsManaged

True

IsMappable

True

IsReadingPaneEnabled

True

IsRenameable

True

IsValidForAdvancedFind

True

IsValidForQueue

True

IsVisibleInMobile

False

PrimaryIdAttribute

activityid

PrimaryNameAttribute

subject

ReportViewName

FilteredFax

RecurrenceBaseEntityLogicalName

DisplayCollectionName

Faxes

Description

Activity that tracks call outcome and number of pages for a fax and optionally stores an electronic copy of the document.

Privilege Metadata

The following table shows the privilege metadata for the fax 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 fax entity.

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

activityid

ActivityId

Uniqueidentifier

SystemRequired

False

False

False

False

False

True

True

True

False

True

False

True

True

True

False

Fax

Unique identifier of the fax activity.

activitytypecode

ActivityTypeCode

EntityName

SystemRequired

False

False

False

True

False

True

True

False

False

True

False

True

False

True

False

Activity Type

Type of activity.

actualdurationminutes

ActualDurationMinutes

Integer

None

False

False

False

True

False

True

True

False

False

True

False

True

True

True

True

Duration

Actual duration of the fax activity in minutes.

actualend

ActualEnd

DateTime

None

False

False

False

True

False

True

True

False

False

True

False

True

True

True

True

Actual End

Actual end time of the fax activity.

actualstart

ActualStart

DateTime

None

False

False

False

True

False

True

True

False

False

True

False

True

True

True

True

Actual Start

Actual start time of the fax activity.

billingcode

BillingCode

String

None

False

False

False

True

False

True

True

False

False

True

False

True

True

True

True

Billing Code

Billing code associated with the sender.

category

Category

String

None

False

False

False

True

False

True

True

False

False

True

False

True

True

True

True

Category

Category of the fax activity.

coverpagename

CoverPageName

String

None

False

False

False

True

False

True

True

False

False

True

False

True

True

True

True

Cover Page Name

Name of a cover page to use when sending a fax.

createdby

CreatedBy

Lookup

None

False

False

False

False

False

True

True

False

False

True

False

True

False

True

False

Created By

Unique identifier of the user who created the fax activity.

createdon

CreatedOn

DateTime

None

False

False

False

False

False

True

True

False

False

True

False

True

False

True

False

Created On

Date and time when the fax activity was created.

createdonbehalfby

CreatedOnBehalfBy

Lookup

None

False

False

False

False

False

True

True

False

False

True

False

True

False

True

False

Created By (Delegate)

Unique identifier of the delegate user who created the fax.

description

Description

Memo

None

False

False

False

True

False

True

True

False

False

True

False

True

True

True

True

Description

Description of the fax activity.

directioncode

DirectionCode

Boolean

None

False

False

False

True

False

True

True

False

False

True

False

True

True

True

True

Direction

Direction code for the fax; incoming or outgoing.

exchangerate

ExchangeRate

Decimal

None

False

False

False

True

False

True

True

False

False

True

False

True

False

True

False

Exchange Rate

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

faxnumber

FaxNumber

String

None

False

False

False

True

False

True

True

False

False

True

False

True

True

True

True

Fax Number

Telephone number of the receiving fax equipment.

from

from

PartyList

None

False

False

False

True

False

True

True

False

False

True

False

False

True

True

True

Sender

Who the fax is from.

importsequencenumber

ImportSequenceNumber

Integer

None

False

False

False

True

False

True

True

False

False

True

False

True

True

True

False

Import Sequence Number

Unique identifier of the data import or data migration that created this record.

isbilled

IsBilled

Boolean

None

False

False

False

True

False

True

True

False

False

True

False

True

True

True

True

Is Billed

Information regarding whether the fax activity was billed as part of resolving a case.

isregularactivity

IsRegularActivity

Boolean

SystemRequired

False

False

False

True

False

True

True

False

False

True

False

True

False

True

False

Is Regular Activity

Information regarding whether the activity is a regular activity type or event type.

isworkflowcreated

IsWorkflowCreated

Boolean

None

False

False

False

True

False

True

True

False

False

True

False

True

True

True

True

Is Workflow Created

Indication of whether the fax activity was created by a workflow rule.

modifiedby

ModifiedBy

Lookup

None

False

False

False

False

False

True

True

False

False

True

False

True

False

True

False

Modified By

Unique identifier of the user who last modified the fax activity.

modifiedon

ModifiedOn

DateTime

None

False

False

False

False

False

True

True

False

False

True

False

True

False

True

False

Modified On

Date and time when the fax activity was last modified.

modifiedonbehalfby

ModifiedOnBehalfBy

Lookup

None

False

False

False

False

False

True

True

False

False

True

False

True

False

True

False

Modified By (Delegate)

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

numberofpages

NumberOfPages

Integer

None

False

False

False

True

False

True

True

False

False

True

False

True

True

True

True

Number of Pages

Number of pages in the fax.

overriddencreatedon

OverriddenCreatedOn

DateTime

None

False

False

False

True

False

True

True

False

False

True

False

True

True

True

False

Record Created On

Date and time that the record was migrated.

ownerid

OwnerId

Owner

SystemRequired

False

False

False

True

False

True

True

False

False

True

False

True

True

True

False

Owner

Unique identifier of the user or team who owns the fax activity.

owningbusinessunit

OwningBusinessUnit

Lookup

None

False

False

False

False

False

True

True

False

False

False

False

False

False

True

False

Owning Business Unit

Unique identifier of the business unit that owns the fax activity.

owningteam

OwningTeam

Lookup

None

False

False

False

False

False

True

True

False

False

True

False

True

False

True

False

Owning Team

Unique identifier of the team that owns the fax activity.

owninguser

OwningUser

Lookup

None

False

False

False

False

False

True

True

False

False

True

False

True

False

True

False

Owning User

Unique identifier of the user that owns the fax activity.

prioritycode

PriorityCode

Picklist

None

False

False

False

True

False

True

True

False

False

True

False

True

True

True

True

Priority

Priority code of the fax activity.

regardingobjectid

RegardingObjectId

Lookup

None

False

False

False

True

False

True

True

False

False

True

False

True

True

True

True

Regarding

Unique identifier of the object with which the fax activity is associated.

scheduleddurationminutes

ScheduledDurationMinutes

Integer

None

False

False

False

True

False

True

True

False

False

True

False

True

False

True

False

Scheduled Duration

Scheduled duration of the fax activity, specified in minutes.

scheduledend

ScheduledEnd

DateTime

None

False

False

False

True

False

True

True

False

False

True

False

True

True

True

True

Due Date

Scheduled end time of the fax activity.

scheduledstart

ScheduledStart

DateTime

None

False

False

False

True

False

True

True

False

False

True

False

True

True

True

True

Start Date

Scheduled start time of the fax activity.

serviceid

ServiceId

Lookup

None

False

False

False

True

False

True

True

False

False

False

False

False

True

True

True

Service

Unique identifier for an associated service.

statecode

StateCode

State

SystemRequired

False

False

False

True

False

True

True

False

False

True

False

True

False

True

False

Activity Status

Status of the fax activity.

statuscode

StatusCode

Status

None

False

False

False

True

False

True

True

False

False

True

False

True

True

True

True

Status Reason

Reason for the status of the fax activity.

subcategory

Subcategory

String

None

False

False

False

True

False

True

True

False

False

True

False

True

True

True

True

Sub-Category

Subcategory of the fax activity.

subject

Subject

String

ApplicationRequired

False

False

False

True

False

True

True

False

True

True

False

True

True

True

True

Subject

Subject associated with the fax activity.

subscriptionid

SubscriptionId

Uniqueidentifier

None

False

False

False

False

False

False

True

False

False

False

False

False

True

False

False

Subscription

For internal use only.

timezoneruleversionnumber

TimeZoneRuleVersionNumber

Integer

None

False

False

False

False

False

True

True

False

False

False

False

False

True

True

True

Time Zone Rule Version Number

For internal use only.

to

to

PartyList

None

False

False

False

True

False

True

True

False

False

True

False

False

True

True

True

Recipient

Person who is the receiver of the fax.

transactioncurrencyid

TransactionCurrencyId

Lookup

None

False

False

False

True

False

True

True

False

False

True

False

True

True

True

True

Currency

Unique identifier of the currency associated with the fax.

tsid

Tsid

String

None

False

False

False

True

False

True

True

False

False

True

False

True

True

True

True

Transmit. Station Id

Transmitting station identifier (TSID) associated with a send action.

utcconversiontimezonecode

UTCConversionTimeZoneCode

Integer

None

False

False

False

False

False

True

True

False

False

False

False

False

True

True

True

UTC Conversion Time Zone Code

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

versionnumber

VersionNumber

BigInt

None

False

False

False

False

False

False

True

False

False

False

False

False

False

True

False

Version Number

Version number of the fax.

One-to-Many Relationships

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

Relationship schema name Referencing entity

fax_activity_parties

activityparty

Fax_Annotation

annotation

Fax_AsyncOperations

asyncoperation

Fax_BulkDeleteFailures

bulkdeletefailure

fax_campaignresponse

campaignresponse

fax_connections2

connection

fax_connections1

connection

Fax_DuplicateBaseRecord

duplicaterecord

Fax_DuplicateMatchingRecord

duplicaterecord

fax_principalobjectattributeaccess

principalobjectattributeaccess

Fax_ProcessSessions

processsession

Fax_QueueItem

queueitem

userentityinstancedata_fax

userentityinstancedata

Many-to-Many Relationships

There are no many-to-many relationships for the fax entity.

Many-to-One Relationships

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

Relationship schema name Referenced entity

Account_Faxes

account

activity_pointer_fax

activitypointer

BulkOperation_Faxes

bulkoperation

business_unit_fax_activities

businessunit

Campaign_Faxes

campaign

CampaignActivity_Faxes

campaignactivity

Contact_Faxes

contact

Contract_Faxes

contract

Incident_Faxes

incident

Invoice_Faxes

invoice

Lead_Faxes

lead

msdyn_postalbum_Faxes

msdyn_postalbum

Opportunity_Faxes

opportunity

Quote_Faxes

quote

SalesOrder_Faxes

salesorder

service_faxes

service

user_fax

systemuser

lk_fax_createdonbehalfby

systemuser

lk_fax_createdby

systemuser

lk_fax_modifiedby

systemuser

lk_fax_modifiedonbehalfby

systemuser

team_fax

team

TransactionCurrency_Fax

transactioncurrency

See Also

Reference

ActivityPointer (Activity) Entity Privileges
EntityMetadata
AttributeMetadata
OneToManyRelationshipMetadata
ManyToManyRelationshipMetadata

Concepts

Task, Fax, Phone Call, and Letter Activity Entities
Fax Entity Messages and Methods

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