IBM®
Skip to main content
    Country/region select      Terms of use
 
 
   
     Home      Products      Services & solutions      Support & downloads      My account     
 
developerWorks
AIX and UNIX
Information Mgmt
Lotus
New to Lotus
Products
How to buy
Downloads
Live demos
Technical library
Training
Support
Forums & community
Events
Rational
Tivoli
WebSphere
Java™ technology
Linux
Open source
SOA and Web services
Web development
XML
My developerWorks
About dW
Submit content
Feedback



developerWorks  >  Lotus  >  Technical Library
developerWorks

[back to "Integrating C&S into a group application"]

Table 1: Fields that appear on documents in the Calendar view
Field NameTypeValuesCommentsRequired?
$BusyNametextfully distinguished usernamePerson that is busy for that timeslot. You could get it from @Username, but because of delegation we use the Owner field in the Calendar ProfileOnly if you want the free time system to show this person as busy for this calendar entry
$NoPurgedate/timeEndDateTimePrevents the note from being purged by replication before the appointment has occurredRecommended
$REFtextUNID of the parentThis 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
$RefOptionstext"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)
$BusyPrioritytext"1" = Busy
"2" = Not Busy
Tells the scheduler whether this appointment is considered busy time or free timeIf there is a $BusyName but no $BusyPriority the free time system still sees this time as busy
AppointmentTypetext"0" = Personal Appointment
"1" = Anniversary
"2" = Event
"3" = Meeting
"4" = Reminder
Controls HideWhens and other processingYes
Bodyrichtext
BookFreeTimetext"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.
CalendarDateTimedate/timeStartDateTimeCauses something to show up in the Calendar view.Only if you want the document to appear in the Calendar View of the mail file
Chairtextfully distinguished name of the Owner of the mail file that originated the Calendar EntryHelps to identify who originated this docYes
CopyTotextlistUsed for sending notices to OptionalAttendees
DocAuthorsauthornamesfully distinguished usernameThe person who created the document
DurationnumberNumber of days an event spansOnly if AppointmentType is event
EndDateTimedate/timeThe end date & time of the meeting. Created from combining StartDate and TimeRangeFor all AppointmentTypes except reminder
ExcludeFromViewtext"D"Prevents appointments that are not sent from showing up in the drafts viewUnless you want the appointment to appear in the Drafts view
Formtext"Appointment"Determines what form to display the doc withYes
Fromtextfully distinguished usernameThe person who created or who sent it. May include @domainYes
FromDomaintextIf sent from a different domain, the domain route will be in this field (posted by router)
NoticeTypetext"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.
OptionalAttendeestextlistFull names of optional invitees. These are the names as "corrected" (expanded?) by the mailer.
OrgConfidentialtext"" = False
"1" = True
If True the $PublicAccess field is sent to "", otherwise the $PublicAccess item is set to "1"
OrgDontDoubleBooktext"" = 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 setOnly if you want to check for conflicts
OrgRepeattext"1" = this is a repeating appointmentIf it is not a repeating appointment, this field will not be present. See below for more on repeating appointments.
OrgTabletext"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 usedYes
PostedDatedate/timeMailer creates this when you send it
Principaltextfully distinguished usernameOwner of mail db in which it was createdYes
RecipientstextlistWho mail got sent to - posted by router
RequiredAttendeestextlistFull names of required invitees. These are the names as "corrected" (expanded?) by the mailer.Only on invitations
RequiredResourcestextlistList of resources that have been invited to a meeting
ReserveRoomtext"1" = Reserve room from Reservation's db
"" = no room needed
Indicates if a room needs to be invited
RoomtextName of room to reserveOnly if ReserveRoom = "1"
SendTotextlistWho you are going to send notices toOnly if you are going to send this document
SequenceNumnumberSet to 1 on an original invite. Incremented on any reschedule. (see below for discussion)Yes
StartDatedateThe date of the appointment, used in data entry.Yes
StartDateTimedate/timeThe start date/time of the appointment. We generate it by combining StartDate with either ReminderTime or TimeRangeYes
SubjecttextAppointment description. This is what shows in the view (more lengthy text goes in the Body field)Recommended
TimeRangedate/time rangeStartTime - EndTime. Used for data entry.
_ViewIconnumberIndicates which view icon to useOnly if you want a view icon to display
Uninvitedtext listPeople who were uninvited or were removed via the Freetime dialog

Copyright 1997 Iris Associates, Inc. All rights reserved.
    About IBM Privacy Contact