Subject: Formatting Notices using C++
This is a little outdated, but should give you a leg up…
Calendar Entry Fields
Field Name
Type
Values
Comments
Required?
$BusyName
text
fully distinguished username
Person that is busy for that timeslot. You could get it from @Username, but because of delegation we use the Owner field in the Calendar Profile
Only if you want the free time system to show this person as busy for this calendar entry
$NoPurge
date/time
EndDateTime
Prevents the note from being purged by replication before the appointment has occurred
Recommended
$REF
text
UNID of the parent
This field exists on repeat instances and subsequent notice documents. (For repeat instances, the parent holds the rules, RepeatDates, and RepeatIds of each instance in the repeat set.)
Only if the doc is supposed to be a response
$RefOptions
text
“1”
Ordinarily if you save a response doc with a form that is designated as type Document, the $Ref is deleted and the doc will no longer be a response. This tells Notes that although the form which this doc uses (Appointment) is of type Document, continue to treat it as a response.
Only if the doc is supposed to act as a response although its document type is “Document” (in our case, it is required only for repeat instances)
$BusyPriority
text
“1” = Busy
“2” = Not Busy
Tells the scheduler whether this appointment is considered busy time or free time
If there is a $BusyName but no $BusyPriority the free time system still sees this time as busy
AppointmentType
text
“0” = Personal Appointment
“1” = Anniversary
“2” = Event
“3” = Meeting
“4” = Reminder
Controls HideWhens and other processing
Yes
Body
richtext
BookFreeTime
text
“1” = Time is free
“0” or “” = Time is booked
Default is “0”. If set to “1”, the $BusyPriority field is set to “2” otherwise the $BusyPriority is set to “1”. Tells the scheduler if you are busy or free during that time.
CalendarDateTime
date/time
StartDateTime
Causes something to show up in the Calendar view.
Only if you want the document to appear in the Calendar View of the mail file
Chair
text
fully distinguished name of the Owner of the mail file that originated the Calendar Entry
Helps to identify who originated this doc
Yes
CopyTo
textlist
Used for sending notices to OptionalAttendees
DocAuthors
authornames
fully distinguished username
The person who created the document
Duration
number
Number of days an event spans
Only if AppointmentType is event
EndDateTime
date/time
The end date & time of the meeting. Created from combining StartDate and TimeRange
For all AppointmentTypes except reminder
ExcludeFromView
text
“D”
Prevents appointments that are not sent from showing up in the drafts view
Unless you want the appointment to appear in the Drafts view
Form
text
“Appointment”
Determines what form to display the doc with
Yes
From
text
fully distinguished username
The person who created or who sent it. May include @domain
Yes
FromDomain
text
If sent from a different domain, the domain route will be in this field (posted by router)
NoticeType
text
“I” = Invitation (original)
“U” = Update (originator reschedules)
“C” = Cancel (by originator)
“D” = Delegator notifying originator
“S” = StatusUpdate (by originator)
“N” = Confirmation (by originator)
“J” = Originator declining counter
“A” = Accept (by invitee)
“R” = Decline (by invitee)
“L” = Delegator notifying delegate
“T” = Counter Proposal (by invitee)
“P” = Pencilin (by invitee)
Notices sometimes get converted to Calendar Entries. This is the value it had while it was a notice.
OptionalAttendees
textlist
Full names of optional invitees. These are the names as “corrected” (expanded?) by the mailer.
OrgConfidential
text
“” = False
“1” = True
If True the $PublicAccess field is sent to “”, otherwise the $PublicAccess item is set to “1”
OrgDontDoubleBook
text
“” = False
“1” = True
Causes conflict checking to occur. This item gets sets only if the appropriate setting in the profile document for that appointment type is set
Only if you want to check for conflicts
OrgRepeat
text
“1” = this is a repeating appointment
If it is not a repeating appointment, this field will not be present. See below for more on repeating appointments.
OrgTable
text
“C0” = Calendar (set for appointment)
“T0” = ToDo
“H0” = Calls
“P0” = Planner (set for event)
“D0” = Address
“N0” = Notepad
“A0” = Anniversary (set for anniversary)
Only “C0” is used
Yes
PostedDate
date/time
Mailer creates this when you send it
Principal
text
fully distinguished username
Owner of mail db in which it was created
Yes
Recipients
textlist
Who mail got sent to - posted by router
RequiredAttendees
textlist
Full names of required invitees. These are the names as “corrected” (expanded?) by the mailer.
Only on invitations
RequiredResources
textlist
List of resources that have been invited to a meeting
ReserveRoom
text
“1” = Reserve room from Reservation’s db
“” = no room needed
Indicates if a room needs to be invited
Room
text
Name of room to reserve
Only if ReserveRoom = “1”
SendTo
textlist
Who you are going to send notices to
Only if you are going to send this document
SequenceNum
number
Set to 1 on an original invite. Incremented on any reschedule. (see below for discussion)
Yes
StartDate
date
The date of the appointment, used in data entry.
Yes
StartDateTime
date/time
The start date/time of the appointment. We generate it by combining StartDate with either ReminderTime or TimeRange
Yes
Subject
text
Appointment description. This is what shows in the view (more lengthy text goes in the Body field)
Recommended
TimeRange
date/time range
StartTime - EndTime. Used for data entry.
_ViewIcon
number
Indicates which view icon to use
Only if you want a view icon to display
Uninvited
text list
People who were uninvited or were removed via the Freetime dialog