daylite data description - download.marketcircle.com · gets), f-script and plugins. in the merge...

Daylite Data DescriptionValid for Daylite 3.0.3 and up

Marketcircle Inc.Last Updated June 21, 2006 • Version 3.0.3

Table of Contents

Introduction 4Data Types 4

Inheritance 4

Primary Objects 5Project 5

Opportunity 8

Contact 11

Organization 16

Group 19

Task 21

Timeblock (Appointment) 23

Note 25

Secondary Objects 27Category 27

CustomRecord (Form Field) 28

CustomRecordDefinition 29

CustomRecordSet (Form) 30

CustomRecordSetDefinition 31

ElectronicAddress 32

Estimate 33

ExtraFieldNames 35

GeoAddress 36

IndustryType 37

Keyword 38

LargeData 39

LineItem 40

OpportunityStateReason 42

OpportunityType 43

OrganizationType 44

Phone 45

Pipeline 46

PipelineStage 47

PipelineStageHistory 48

ProductService 49

RegionType 51

Relationship 52

RelationshipType 53

Role 54

RoleType 55

URLReference 56

User 57

Additions to Cocoa Classes 58NSString 59

NSNumber 60

NSCalendarDate 61

NSArray 63

Daylite Data Description of 63

IntroductionThis document illustrates the three types of data elements in the Daylite Data Model. You should read the Daylite Public Developer Kit document before reading this document.

Data Types

Daylite has several data types (not to be confused with Classes). The first is the raw data that resides in the database (i.e Contact -> Firstname). The second element is relationships (i.e. Contact -> Role) and the third is derived attributes that is in ‘code’ only (i.e nextPendingTask).

When you are dealing with the Daylite Data Model, you have to be aware of what attributes you have available. For instance, when you are dealing Raw Rows at the Database Connection level, you do not have relationships or derived attributes. When you are dealing at the Object Context level you have all three.

The elements defined here are accessible from the Report Engine, the Merge Engine (Letter, HUD Wid-gets), F-Script and Plugins. In the Merge Engine, you are working above the Object Context level so you have access to all three types. In the Report Engine you typically are dealing above the Object Context, but if you are using Raw SQL as a table source, you only have access to the first type. In F-Script or Plugins, you can deal at both the Object Context level and the Database Connection level.

Inheritance

Both Primary Objects and Secondary Objects inherit from MCPObject. At the code level, both primary and secondary objects are the same and behave the same way. We’ve segmented them in primary and secondary so you and the user have an appreciation for the weight of that object in the overall Daylite concepts.


Primary ObjectsThe following pages contain data descriptions for the primary objects in Daylite.

Project

Method Return Type Description

statusCode NSNumber

startDate NSCalendarDate

sourceImportID NSString

projectID NSNumber

opportunityID NSNumber

name NSString

modifyDate NSCalendarDate

level NSNumber

lastStatusCode NSNumber

extra1 NSString

extra2 NSString

extra3 NSString

extra4 NSString

extra5 NSString

extra6 NSString

extra7 NSString

extra8 NSString

extra9 NSString

extra10 NSString

extra11 NSString

extra12 NSString

extraDate1 NSCalendarDate






extraFieldsNames ExtraFieldNames

dueDate NSCalendarDate

details NSString

currentPipelineStageID NSNumber

currentPipelineStageHistoryID NSNumber

currentPipelineID NSNumber

createdByID NSNumber

createDate NSCalendarDate

completeDate NSCalendarDate

categoryID NSNumber

assignedToID NSNumber

opportunity Opportunity

assignedTo User

category Category

createdBy User

currentPipeline Pipeline

currentPipelineStage PipelineStage

currentPipelineStageHistory PipelineStageHis-tory

correspondences Array of Correspon-dance

customRecordSets Array of CustomRe-cordSet

urlReferences Array of URLRe-fernce

keywords Array of Keyword

notes Array of Note

tasks Array of Task



timeblocks Array of Timeblock

roles Array of Role

groups Array of Group

pipelineStageHistories Array of PipelineSt-ageHistory

allKeywordsAsString NSString Same as keywordsString but puts a ‘none’ if no keywords are linked

keywordsString NSString

nextPendingTask Task

nextPendingTimeblock Timeblock

lastNote Note

lastTask Task

lastTimeblock Timeblock

pendingTasks Array of Task Uncompleted Tasks

pendingTasksCount NSNumber The number of uncompleted Tasks (faster than doing pendingTasks.count)

pendingTimeblocksCount NSNumber Count of timeblock after ‘now’. (faster than doing pendingTimeblocks.count)

pendingTimeblocks Array of Timeblock Timeblocks after now

sortedTasks Array of Task Sorted by due date

sortedTimeblocks Array of Timeblock Sorted by start date

contacts Array of Contact Convenience, handles roles and re-turns an array of contacts

allContactsAsString NSString Contact names in a string

organizations Array of Organiza-tion

Convenience, handles roles and re-turns an array of organizations

allOrganizationsAsString NSString Org names in a string

statusString NSString Human readable representation of statusCode


Opportunity


assignedTo User


cachedTotalAmount NSDecimalNumber

category Category

categoryID NSNumber


correspondences Array of Correspon-dance


createdBy User


currentPipeline Pipeline

currentPipelineID NSNumber

currentPipelineStage PipelineStage

currentPipelineStageHistory PipelineStageHis-tory

currentPipelineStageHistoryID NSNumber

currentPipelineStageID NSNumber


details NSString


estimates Array of Estimate

extra1 NSString

extra10 NSString

extra11 NSString

extra12 NSString

extra2 NSString



extra3 NSString

extra4 NSString

extra5 NSString

extra6 NSString

extra7 NSString

extra8 NSString

extra9 NSString





groups Array

keywords Array

lastOpportunityStateType NSNumber

level NSNumber

lineItems Array of LineItems


name NSString

notes Array of Note


opportunityStateReason OpportunityS-tateReason

opportunityStateReasonID NSNumber

opportunityStateType NSNumber

opportunityType OpportunityType

opportunityTypeID NSNumber

pipelineStageHistories Array of PipelineSt-ageHistory

probability NSNumber



projects Array of Project Most common way of creating this relationship is by creating Projects from an existing Opportunity.

roles Array of Role



tasks Array of Task

term LargeData

termID NSNumber


urlReferences Array of URLRefer-ence

allContactsAsString NSString

allKeywordsAsString NSString

allOrganizationsAsString NSString

allUsableDefaultEmailAddress NSString

contactRoles Array of Roles Where the destination object is a Contact

contacts Array of Contact Convenience

lastNote Note

lastTask Task

lastTimeblock Timeblock

nextPendingTask Task

nextPendingTimeblock Timeblock

organizationRoles Array or Role Where the destination object is an Organization


Convenience

pendingTasks Array of Task



pendingTimeblocks Array of Timeblock

sortedTasks Array of Task

sortedTimeblocks Array of Timeblock

statusString NSString

pendingTasksCount NSNumber

pendingTimeblocksCount NSNumber

Contact

A contact in Daylite represents a person. It does not represent a company. It is linked to a company through a role.


alias NSString

allGroupsAsString NSString Comma separated string of groups

allKeywordsAsString NSString Comma separated string of keywords

anniversaryDay NSNumber

anniversaryMonth NSNumber

anniversaryYear NSNumber

anniversaryString NSString Combination of anniversaryDay, anniversaryMonth, anniversaryYear

assignedTo User

birthDay NSNumber

birthMonth NSNumber

birthYear NSNumber

birthdayString NSString Combination of birthDay, birthMonth, birthYear

cachedName NSString Derived using firstname, middlename and lastname.

category Category

contactID NSNumber




createdBy User

customRecordSets Array of CustomRecordSet

aka Forms

defaultElectronicAddress ElectronicAddress One of the electronicAddresses

defaultGeoAddress GeoAddress One of the geoAddresses

defaultNote Note One of the notes

defaultPhone Phone One of the phones

defaultSecondPhone Phone One of the phones

defaultRole Role One of the roles and the 'default' role. This is what DayLite uses to tie a contact to an organization and the one that the user has designated as the default. The first role with an organization is the default normally. The destination of this object can only be an organization.

electronicAddresses Array of ElectronicAddress

extra1 NSString

extra2 NSString

extra3 NSString

extra4 NSString

extra5 NSString

extra6 NSString

extra7 NSString

extra8 NSString

extra9 NSString

extra10 NSString

extra11 NSString

extra12 NSString








firstname NSString

flagged NSNumber

formattedDefaultEmailAddress NSString name and email address

fromRelationships Array of Relationship

These are relationships where this object is the destination

geoAddresses Array of GeoAddress


hobbies NSString

inShortcut NSNumber


lastname NSString

lastNote Note Note with latest create date

lastTask Task Task with a Done status and the latest complete date

lastTimeblock Timeblock Timeblock with Completed status and latest end date

level NSNumber Called Priority in the UI

middlename NSString


nextPendingTask Task Next task which is uncompleted and the closest due date to today.

nextPendingTimeblock Timeblock Next timeblock closest to today

nickname NSString

notes Array of Note



notesSortedByCreateDateDescending

Array of Note Same as notes except shorted by created date in descending order

opportunities Array of Opportunity

opportunityRoles Array of Role Roles where the destinationObject is an opportunity

organizationRoles Array of Role Roles where the destinationObject is an organization

organizations Array of Organization

All organizations as gotten through all the organizationRoles

phones Array of Phone

projectRoles Array of Role Roles where the destinationObject is an project

projects Array of Project All projects gotten through projectRoles

relationshipToMe NSString

roles Array of Role

salutationString NSString


suffix NSString

tagline NSString

tasks Array of Task


toRelationships Array of Relationship

These are relationships which this object is the source

urlReferences Array of URLReference

openProjects Array of Project Projects that don't have a completeDate

openOpportunities Array of Opportunity

State is 'Open'



smartGeoAddress GeoAddress Returns the default organization's address if it is not empty, otherwise returns the contact's defaultGeoAddress

smartPhone Phone Returns the default organization's defaultPhone if it is not empty, otherwise returns the contact's defaultPhone

smartSecondPhone Phone Returns the default organization's defaultSecondPhone if it is not empty, otherwise returns the contact's defaultSecondPhone

smartElectronicAddress ElectronicAddress Returns the default organization's defaultElectronicAddress if it is not empty, otherwise returns the contact's defaultElectronicAddress

pendingTasks Array of Task Uncompleted

pendingTimeblocks Array of Timeblock Uncompleted




Organization


allContactsAsString NSString Comma separated string of contacts as gotten through roles

allGroupsAsString NSString Comma separated string of groups as gotten through groups

allKeywordsAsString NSString Comma separated string of keywords as gotten through keywords

assignedTo User aka. Owner

category Category

contacts Array of Contact


createBy User

customRecordSets Array of CustomRecordSet

aka Forms

defaultElectronicAddress ElectronicAddress One of the electronicAddresses

defaultGeoAddress GeoAddress One of the geoAddresses

defaultPhone Phone One of the phones

defaultSecondPhone Phone One of the phones

electronicAddresses Array of ElectronicAddress

extra1 NSString

extra2 NSString

extra3 NSString

extra4 NSString

extra5 NSString

extra6 NSString

extra7 NSString

extra8 NSString

extra9 NSString

extra10 NSString



extra11 NSString

extra12 NSString






fromRelationships Array of Relationship

Relationships where this object is the destination

geoAddresses Array of GeoAddress


industryType IndustryType


lastNote Note Note with latest create date

lastTask Task Task with a Done status and the latest complete date

lastTimeblock Timeblock Timeblock with Completed status and latest end date

level NSNumber Called Priority in the UI


name NSString

nextPendingTask Task Next task which is uncompleted and the closest due date to today.

nextPendingTimeblock Timeblock Next timeblock closest to today

notes Array of Note

notesSortedByCreateDateDescending

Array of Note Same as notes except shorted by created date in descending order

opportunities Array of Opportunity

organizationID NSNumber



organizationType OrganizationType

phones Array of Phone

projects Array of Project

regionType RegionType

roles Array of Role


tagline NSString

tasks Array of Task

tickerSymbol NSString

timeblocks NSString

toRelationships Array of Relationship

Relationships where this object is the source

urlReferences Array of URLReference




Group


assignedTo User


category Category

categoryID NSNumber



createdBy User



defaultNoteID NSNumber

endDate NSCalendarDate

extra1 NSString

extra10 NSString

extra11 NSString

extra12 NSString

extra2 NSString

extra3 NSString

extra4 NSString

extra5 NSString

extra6 NSString

extra7 NSString

extra8 NSString

extra9 NSString







groupID NSNumber

level NSNumber

message NSString


name NSString

note NSString The detail - not to be confused with linked notes

notes Array of Note

opportunities Array of Opportu-nity

order NSNumber


parentGroup Group

parentGroupID NSNumber




subGroups Array of Group

tasks Array of Task


urlReferences Array of URLRefer-ence


Task



allGroupsAsString NSString

allOppsAsString NSString


allProjectsAsString NSString

allTasks Array of Task This task and all subtasls

assignedTo User


category Category

categoryID NSNumber




createdBy User


details NSString


durationMinutes NSNumber


hasParentTask NSNumber

hasSubtasks NSNumber

lastStatusCode NSNumber

location NSString



order NSNumber




parentTask Task

parentTaskID NSNumber

priority NSNumber




statusCode NSNumber

subtaskCount NSNumber

subTasks Array of Task

taskID NSNumber

title NSString

typeCode NSNumber


Timeblock (Appointment)




allLinkDetailsAsString NSString

allOppsAsString NSString



assignedTo User Cover for owner (compatibility)

assignedToID NSNumber Cover for ownerID

category Category

categoryID NSNumber



createdBy User


details NSString

durationDays NSNumber

durationMinutes NSNumber

durationSeconds NSNumber

durationString NSString



location NSString

meetingMinutes LargeData

meetingMinutesLargeDataID NSNumber






owner User

ownerID NSNumber


resources Array of Resource


startAndEndDateAsString NSString

startAndEndTimeAsString NSString


statusCode NSNumber

statusString NSString

subject NSString

timeblockID NSNumber

typeCode NSNumber

typeString NSString


Note




allLinkDetailsAsString NSString

allOpportunitiesAsString NSString



assignedTo User


attributedStringRepresentation NSAttributedString

category Category



createdBy User



isEmail NSNumber

isSyncNote NSNumber

largeData LargeData

largeDataID NSNumber


noteID NSNumber



plainTextRepresentation NSString





title NSString


Secondary ObjectsCategory


active NSNumber 0 or 1

categoryID NSNumber

forContact NSNumber 0 or 1

forGroup NSNumber 0 or 1

forNote NSNumber 0 or 1

forOpportunity NSNumber 0 or 1

forOrganization NSNumber 0 or 1

forProject NSNumber 0 or 1

forTask NSNumber 0 or 1

forTimeblock NSNumber 0 or 1

name NSString


CustomRecord (Form Field)


customRecordDefinition CustomRecordDefinition

customRecordID NSNumber

humanReadableRecordValue NSString Normalizes checkbox types or returns the formatted value if a formatter is applicable

objectValue NSNumber, NSString or NSCalendarDate

recordValue converted into the appropriate object type based on the customRecordDefinition typeCode

recordValue NSString


CustomRecordDefinition



customRecordDefinitionID NSNumber

defaultValue NSString Default selection or value

details NSString

name NSString

options NSString

typeCode NSNumber 0 = Text1 = Number2 = Date3 = Time4 = DateTime5 = Float6 = Money7 = Option (popup)8 = Combobox9 = Checkbox10 = Checkbox Group

typeString NSString Description of the type


CustomRecordSet (Form)



customRecords Array of CustomRecord

customRecordSetID NSNumber

dictionaryRepresentation NSDictionary Create a dictionary from customRecords and their customRecordDefinition

name NSString


CustomRecordSetDefinition


active NSNumber


createOnAddForContact NSNumber

createOnAddForGroup NSNumber

createOnAddForOpportunity NSNumber

createOnAddForOrganization NSNumber

createOnAddForProject NSNumber

customRecordDefinitions Array

customRecordSetDefinitionID NSNumber

customRecordSets Array

details NSString

forContact NSNumber

forGroup NSNumber

forOpportunity NSNumber

forOrganization NSNumber

forProject NSNumber

isCustom NSNumber

isUniquePerObject NSNumber

name NSString


ElectronicAddress


electronicAddressID NSNumber

hasContent NSNumber 0 or 1 - Tests the appropriate value to determine if Daylite considers this empty or not

note NSString

typeString NSString

url NSString The actual address


Estimate


comment NSString



estimateID NSNumber

estimateNumber NSString

estimatePDF FileStorage

estimatePDFID NSNumber

estimateURL URLReference

estimateURLRefID NSNumber

lineItems Array


name NSString



sendToContact Contact

sendToContactID NSNumber

sendToCustom NSString

sendToOrg Organization

sendToOrgID NSNumber

sentDate NSCalendarDate

tax1 NSNumber

tax1Name NSString

tax2 NSNumber

tax2Name NSString

terms LargeData

termsID NSNumber

useCompoundSecondaryTax NSNumber



useTax1 NSNumber

useTax2 NSNumber


ExtraFieldNames


extra1 NSString

extra2 NSString

extra3 NSString

extra4 NSString

extra5 NSString

extra6 NSString

extra7 NSString

extra8 NSString

extra9 NSString

extra10 NSString

extra11 NSString

extra12 NSString

extraDate1 NSString

extraDate2 NSString

extraDate3 NSString

extraDate4 NSString

extraFieldNamesID NSNumber

typeString NSString


GeoAddress


city NSString

country NSString

directions NSString

geoAddressID NSNumber


note NSString

postalCode NSString

state NSString

street NSString

typeString NSString


IndustryType



industryTypeID NSNumber

name NSString


Keyword



forContact NSNumber

forOpportunity NSNumber 0 or 1


forProject NSNumber 0 or 1

keywordID NSNumber 0 or 1

name NSString


LargeData


rawData NSData


attributedStringRepresentation NSAttributedString


LineItem


accountNumber NSString

basePrice NSNumber

comment LargeData

costOfGoods NSNumber


currencyCode NSString

details NSString

discount NSNumber

discountTypeCode NSNumber

estimate Estimate

estimateID NSNumber

extra1 NSString

extra2 NSString

extra3 NSString

extra4 NSString

extra5 NSString


idCode NSString

image ResourceLargeData


lineItemID NSNumber

markup NSNumber

markupTypeCode NSNumber

modelCode NSString


name NSString





productService ProductService

productServiceID NSNumber

profit NSNumber

resourceLargeDataID NSNumber

sku NSString

tax1 NSNumber

tax1Name NSString

tax2 NSNumber

tax2Name NSString

taxCode NSString

typeCode NSNumber

units NSNumber

upc NSString


useTax1 NSNumber

useTax2 NSNumber


OpportunityStateReason


active NSNumber

details NSString

name NSString

opportunityStateReasonID NSNumber

opportunityStateType NSNumber


OpportunityType


active NSNumber

name NSString

opportunityTypeID NSNumber


OrganizationType


active NSNumber

name NSString

organizationTypeID NSNumber


Phone


fullPhoneNumber Type and number


phoneID NSNumber

phoneNumber NSString

typeString NSString


Pipeline


active NSNumber


currentOpportunities Array

currentProjects Array


forProject NSNumber

lowerThreshold NSNumber


name NSString

note NSString

pipelineID NSNumber

pipelineStages Array

upperThreshold NSNumber


PipelineStage



currentOpportunities Array

currentProjects Array

lowerThreshold NSNumber


name NSString

note NSString

order NSNumber

pipeline Pipeline

pipelineID NSNumber

pipelineStageID NSNumber

upperThreshold NSNumber


PipelineStageHistory



createdBy User


createdByUsername NSString



note NSString



pipeline Pipeline

pipelineID NSNumber

pipelineName NSString

pipelineStage PipelineStage

pipelineStageHistoryID NSNumber

pipelineStageID NSNumber

previousPipeline Pipeline

previousPipelineID NSNumber

previousPipelineName NSString

previousPipelineStage PipelineStage

previousPipelineStageID NSNumber

previousStageName NSString

project Project

projectID NSNumber

stageName NSString



ProductService


accountNumber NSString

active NSNumber

basePrice NSNumber

comment LargeData

costOfGoods NSNumber


currencyCode NSString

details NSString

discount NSNumber

discountTypeCode NSNumber

extra1 NSString

extra2 NSString

extra3 NSString

extra4 NSString

extra5 NSString


idCode NSString

image ResourceLargeData


lineItems Array

markup NSNumber

markupTypeCode NSNumber

modelCode NSString


name NSString

order NSNumber

privateTypeCode NSNumber



productServiceID NSNumber

profit NSNumber

resourceLargeDataID NSNumber

rootID NSNumber

sku NSString

taxCode NSString

typeCode NSNumber

units NSNumber

upc NSString



RegionType



name NSString

regionTypeID NSString


Relationship


destinationContact Contact

destinationOrganization Organization

details NSString

relationID NSNumber

relationshipType RelationshipType

sourceContact Contact

sourceOrganization Organization


RelationshipType



forContact NSNumber 0 or 1


name NSString

relationshipTypeID NSNumber

reverseName NSString


Role


contact Contact

contactID NSNumber


defaultForContact NSNumber

department NSString

detailFromContact NSString

detailFromOrganization NSString

name NSString



organization Organization

organizationID NSNumber

project Project

projectID NSNumber

roleID NSNumber

roleNameWithContactFullname NSString

roleNameWithOrganization-Name

NSString

roleType RoleType

roleTypeID NSNumber

smartName NSString


RoleType


active NSNumber

contactPlaysRoleString NSString


defaultTypeCode NSNumber

forContact NSNumber


forOrganization NSNumber

forProject NSNumber

name NSString

orgPlaysRoleString NSString

privateTypeCode NSNumber

roleTypeID NSNumber


URLReference


lastComponentOfUrl NSString Last piece of URL

name NSString Name as given by the user

note NSString

typeCode NSNumber 0 = Other1 = Web2 = File

typeString NSString

url NSString File path or URL

urlRefID NSNumber


User


active NSNumber

contact Contact A user is really a contact - this link represents the actual person

contactID NSNumber


details NSString

color NSColor Color used in Shared Calendars

isRestrictedForCharts NSNumber 0 or 1

isRestrictedForListCopyPaste NSNumber 0 or 1

isRestrictedForPalmAndAd-dressBookSync

NSNumber 0 or 1

isRestrictedForReports NSNumber 0 or 1

isRestrictedToAssignedObjects NSNumber 0 or 1

isRestrictedToDeleteObjects NSNumber 0 or 1

isRestrictedToImportAndExport NSNumber 0 or 1

isRestrictedToModifyData-basePrefrences

NSNumber 0 or 1

isRestrictedToRunScripts NSNumber 0 or 1

isRestrictedToWorkOffline NSNumber 0 or 1


userID NSNumber

username NSString


Additions to Cocoa Classes


NSString


htmlSafe NSString

rtfSafe NSString

stringByRemovingReturns NSString

stringByRemovingSurroundingWhitespace

NSString


NSNumber


localizedMoneyValue NSString Looks in System Preferences to determine what currency symbol to use and return the number and currency symbol

durationStringFromMinutes NSString

durationStringFromSeconds NSString


NSCalendarDate


dateAsBeginningOfMonth NSCalendarDate

dateAsEndOfMonth NSCalendarDate

day NSString %e

dayFullMonthYear NSString %d %B %Y

dayMonthShortYear NSString %d/%m/%y

dayMonthYear NSString %d/%m/%Y

dayShortMonthYear NSString %d %b %Y

fullMilitaryTime NSString %H:%M:%S

fullMonth NSString %B

fullMonthDayYear NSString %B %d, %Y

fullTime NSString %I:%M:%S %p

fullYear NSString %Y

lastDayOfMonth NSCalendarDate

militaryTime NSString %H:%M

month NSString %m

monthDayShortYear NSString %m/%d/%y

monthDayYear NSString %m/%d/%Y

nextDay NSCalendarDate

preferredDateFormat NSString Check System Preference for date format

preferredDateTimeFormat NSString Check System Preference for date format

preferredLongDateFormat NSString Check System Preference for date format

preferredLongDateTimeFormat NSString Check System Preference for date format

preferredMediumDateFormat NSString Check System Preference for date format



preferredTimeFormat NSString Check System Preference for date format

previousDay NSCalendarDate

shortMonth NSString %b

shortMonthDayYear NSString %b %d, %Y

shortYear NSString %y

time NSString %I:%M %p

weekDay NSString %A

yearDay NSString %j


NSArray


sumAsInteger NSNumber

sumAsFloat NSNumber

sumAsDouble NSNumber

avgAsFloat NSNumber

avgAsInteger NSNumber


daylite data description - download.marketcircle.com · gets), f-script and plugins. in the merge...

Documents