Calendar and Scheduling

Chapter 12-15

Calendar and Scheduling

Item Name

Description

Constant

CopyTo

Fully distinguished name(s) of the Optional invitee(s).
Mail recipient field.
Primary names for the CC recipients.
Contains the names of the optional invitees to which this workflow message is being sent.

SendTo

Fully distinguished name(s) of the Primary invitee(s)
Mail recipient field.
Primary names for the To recipients.
Contains the names of the required invitees to which this workflow message is being sent. Or, in the case of a response, the Chairs address.

BlindCopyTo

Fully distinguished name(s) of FYI invitee(s).
Mail recipient field.
Primary names for the Bcc recipients. Each recipient is only able to see their own name in this field.

Introduction

Calendar and scheduling features are available through the C API. This section will focus on how to add an appointment or a meeting invitation to a User's schedule, delete a scheduled event from a User's schedule and query a User's busy/free time information. Please refer to the sample program, misc\schedule for coding details.

Components of Calendar and Scheduling

Appointment:

The following items comprise an appointment note in a User's schedule maintained in the User's mail database.


Item Name	DataType	Description	Constant

$Alarm	Number	Alarm is on. C&S field that controls whether the alarm is set for the entry. This item is mutually exclusive with $AlarmDisabled, so if $AlarmDisabled is set, $Alarm must not be set. The only valid value is 1; the item should not be present otherwise. Note: When generating a repeating CS note set, this item can be in repeat parent but is not required.
$AlarmDescription	Text	Shows up when alarm rings. The text to display when the alarm triggers. Created only if Notify Me is checked, that is. if the field Alarms has value 1. Note: When generating a repeating CS note set, this item can be in repeat parent but is not required.
$AlarmOffset	Number	x minutes before or after StartDateTime. The offset, in minutes by default, from the StartTime of the entry that the alarm should be triggered. Positive offsets are after the start time; negative offsets are before the start time. This item is used only if the alarm is relative to the start time of the entry and must not exist if there is an $AlarmTime item. Its not of any use if $Alarm (or Alarm) item is not present or set properly (or if the alarm is to trigger at a specific time). Created only if Notify Me is checked, that is, the field value Alarms has value 1. Note: When generating a repeating CS note set, this item can be in repeat parent but is not required.
$BusyName	Text	Fully distinguished username of person that is busy. Indicates who the entry is for and whose busytime it should affect. Must be a single canonical name of a user or resource. This item must not be present on repeat C&S parent documents. It should only appear on the actual calendar entries and not on every child document. For example, it should not appear on an Accept notice from Invitees in the Chairs mail file but it must appear on the actual calendar entries in the Invitees mail file.	MAIL_APPT_BUSYNAME_ITEM
$BusyPriority	Text	Tells scheduler if time is busy or free. Indicates how the entry should be reflected in busytime and thus presented in the busytime search UI. Only one value is permitted on any given entry. If the item or a value are missing, the entry will default to Busy. Valid values are: "" = Busy (Only found on Notes 4.5 entries) 1 = Busy (Default on calendar entries from 5.0 or later) 2 = Not-busy. The entity will appear available even though there is a possible entry on the calendar. This is typically used for "Pencilled-in", "Tentative" and "Cancelled" entries. The item must not be present on repeating C&S parent documents.	MAIL_APPT_BUSYNAME_ITEM
$CSVersion	Text	This item is used to determine what version a cs document was created in. Used to indicate that the entry was generated by a "2nd generation" C&S template. Notes version 5 and later: Must be "2" by default. This item is not present on pre-R5-generated entries. Valid values are: 0 = Pre-R5 entry 2 = R5 or later
$NoPurge	Date/Time	End date/time (prevents note from being purged). Core: This item prevents the note from being purged by replication before the schedule event has occurred. Use ConvertTextToTIMEDATE for the ending time string. For example: ConvertTextToTIMEDATE("03/16/2000 05:00 PM"). Set to latest EndDateTime in the repeat instance document. On repeat parent, set to latest EndDateTime of entire meeting set.	FIELD_NOPURGE
$PublicAccess	Text	Private or public accessible. Marks the entry as a public doc. Used to make the entry public. Lotus Notes C&S is based on allowing designees (for example, Administrative Assistants) to see a users calendar but not their mail file. It does this by making C&S entries public. All C&S entries should have this, unless the user marks the entry private (the field does not appear in such entries). Note that, if Mark Private was unchecked the first time it was saved, this item exists on both parent and response; however, if Mark Private was checked the first time it was saved and unchecked later, the item does not exist on the parent doc.
_ViewIcon	Number	Scheduled event Icon displayed. The icon to display in the calendar views for the entry. Valid values are: 9 = Event 10 = Confirmation or Reminder 33 = Reschedule 38 = Counter decline 39 = Counter 63 = Anniversary 71 = Repaired or obsoleted entry (new for 8.5) 81 = Cancel 82 = Completed 83 = Accept 84 = Decline or Delegator response 133 = Invitation or Delegate Invitation 157 = Uninvited or Removed 158 = Meeting 160 = Appointment 168 = Task
AppointmentType	Text	Type of scheduled event. Indicates what kind of calendar entry this is. Valid values are: 0 = Appointment 1 = Anniversary or Personal ToDo 2 = Event or Group ToDo 3 = Meeting 4 = Reminder
apptUNID	Text	UNID of the scheduled event. A text version of the entry's original/actual UNID. Generally this item should be the UNID converted to text, but it could also be the iCalendar UID or some other value. This also makes iCalendar support (introduced in Notes version 6) easier since it maps directly onto iCalendar's UID property.
Body	Rich Text or MIME-PART	Detailed description of the scheduled event. The description of the appointment. This can be in Rich Text format or HTML format; however, auxiliary processes such as the IMAP server behave better when it is in RichText format.
BookFreeTime	Text	Correspond to the "Pencil in" check box in the Notes UI. User interface field. Indicates whether an entry is displayed as penciled in. It is used by the template but it is not used by the busytime system which relies on the $BusyPriority item. This should be kept in sync with the $BusyPriority item. Value is 1 if Pencil-In has been checked. Value is otherwise.
CalendarDateTime	Date/Time List	Causes appointment to show up in Calendar View. A date & time value as to when the entry should show up in the calendar view. Mainly, the presence of this item indicates that it belongs in the Calendar view and when it should appear.
CHAIR	Text	Fully distinguished name of the mail file owner. Name of the user who is chairing or organizing the entry. This should be the canonical name of the calendar owner when a meeting is created from Lotus Notes. It can be an Internet address when meeting is created from outside Notes.
EndDate	Date/Time	End date/time of the scheduled event. The UTC date & time at which the entry ends. It is derived from EndDateTime and is typically the same for non-repeating entries. In the rescheduling case, this will be the new date (& time) to which the base instance is being moved.
EndDateTime	Date/Time List	End date/time of the scheduled event. The UTC date & time at which the entry ends. The number of values in this item must match the number of values in the StartDateTime item.	MAIL_APPT_ENDTIME_ITEM
EndTime	Date/Time	End date/time of the scheduled event. The UTC date & time the entry ends. It is derived from EndDateTime and is typically the same for non-repeating entries. This is a separate item from EndDate, even though they both share the same information, because a UI change for Notes R5 to split the combo Date/Time picker into two separate items requires two separate items.
ExcludeFromView	Text List	Prevents non sent appts from showing up in drafts view. The view(s) to exclude the note from in the mail file. The values are not actual view names but some shorthand abbreviations of them (or their aliases). Valid values (for C&S at least) are: A = All Documents (aka $All) view D = Drafts S = Sent
From	Text	Fully distinguished username. Contains the username of the user who created the document. For example, when an assistant creates an invitation, the From item has their name. In contrast, the Principal item contains name of the owner of the mail database from which mail was created. Of course, the values may the same.	MAIL_FROM_ITEM
Form	Text	What form to display. The name of the form used for display. The value for a room or resource document should be Resource The value for a site document is SiteProfile The value for a room reservation request should be Notice. The Rooms & Resource Manager will change it to Reservation	FIELD_FORM
ORGTABLE	Text	Set for the scheduled event. Tells Lotus Organizer in which section an entry should be displayed. Since Organizer can have > 1 calendar, Notes defaults to using the first one by always putting a "0" in the second character of this items value. The leading character is used to indicate the type of entry. Valid first character values: "C0" = Calendar entry "T0" = To Do entry "H0" = Calls entry "P0" = All Day Event / Planner entry "D0" = Address entry "N0" = Notepad entry "A0" = Anniversary entry
Principal	Text	Fully distinguished name of the mail file owner. The fully distinguished username of the owner of the mail database from which mail is being created. In contrast, the From item is the name of the person, such as an assistant, creating mail. The items may be the same value.
SEQUENCENUM	Number	Keeps the scheduled event ordered. Sequence number of event notice. It is incremented when a change in start or end time occurs. When SequenceNum is changed, all the recipients must accept/decline again. Changing cosmetic things like the Subject is not grounds for increasing. Replies to a different SequenceNum are not valid and are ignored by the Chair as stale information. Initial Value: 1	MAIL_APPT_SEQUENCE_ITEM
StartDate	Date/Time	Start date/time of the scheduled event. The UTC date (& time) the entry begins. It is derived from StartDateTime and is typically the same for non-repeating entries. This is a separate item from StartTime, even though both share the same information, because a UI change for R5 to split the combo Date/Time picker into two separate items requires two separate items.
StartDateTime	Date/Time List	Start date/time of the scheduled event. The UTC date & time the entry begins. The number of values in this item must match the number of values in the EndDateTime item.	MAIL_APPT_STARTTIME_ITEM
StartTime	Date/Time	Start date/time of the scheduled event. The UTC (date &) time the entry begins. It is derived from StartDateTime and is typically the same for non-repeating entries. This is a separate item from StartDate, even though both share the same information, because a UI change for R5 to split the combo Date/Time picker into two separate items requires two separate items.
Subject	Text	Brief description of the scheduled event. The Subject of the notice (prefix + topic + date/time). Prefixes can be: Invitation: Accepted: Tentative: Declined: Countered: Delegated: Invitation (Delegated): Information Update - when this is an update, the Chair indicates what is being updated, such as Description has been changed.	MAIL_SUBJECT_ITEM
$AlarmDisabled	Number	Created only if an alarm was enabled and then disabled by clicking on Disable. Note that item is not created if user unchecks Notify me. Field value is 1 when the alarm is disabled. This item is mutually exclusive with $Alarm, so if $Alarm is set, $AlarmDisabled must not be set. Note: When generating a repeating CS note set, this item can be in repeat parent but is not required.
$AlarmMemoOptions	Text	A flag indicating to whom an email notification should be sent. This item controls whether the $AlarmSendTo value is used (even if it is set). While the data type is for a string, only the first character of this item is used for determining what kind of email notice may be sent: 0 = None. This indicates that no email notifications are to be sent. (In reality, field value is if the option is not checked.) 1 = Event participants only. This indicates that email notifications are sent only to the participants of record on the entry and no one else. May be obsolete. 2 = Listed names. This indicates that the name(s) in $AlarmSendTo are to be sent an email notification triggering. Created only if Notify Me is checked, that is, the field Alarms has value 1. Field value is 2 if Send mail with entry title and description is checked in Alarm Settings. Note: Item is not removed if the alarm is disabled. Note: When generating a repeating CS note set, this item can be in repeat parent but is not required.
$AlarmSendTo	Text	The list of users (or groups) to whom an email notification should be sent when the alarm triggers. Created only if Notify Me is checked, that is, the field value Alarms has value 1. Note: When generating a repeating CS note set, this item can be in repeat parent but is not required.
$AlarmSound	Text	The name of the sound to play when the alarm triggers. This is not the path to a .WAV or other sound file; rather, it is the system name for a sound, at least on Win32 clients. Created only if Notify Me is checked, that is, the field value Alarms has value 1. Note: When generating a repeating CS note set, this item can be in repeat parent but is not required.
$AlarmUnit	Text	Indicates the unit of time that the $AlarmOffset is in the default unit (if no value here is specified), in minutes. Created only if Notify Me is checked, that is, the field value Alarms has value 1. Note: When generating a repeating CS note set, this item can be in repeat parent but is not required. Valid values are: M = Minutes (Default) H = Hours D = Days Any other values are ignored, and the default is used instead.
$AltPrincipal	Text	Alternate name of the mail file owner. Used when more than one language is present. On workflow messages, this is the alternate name for the owner of the mail file sending the notice. When there is no alternate name available, this item is set from item Principal.
$ApprovalList	Text	A list of users who are allowed to do busytime lookups on a particular user. This item is used only on calendar profiles.
$AvailableDays	Text	This item corresponds to the checkboxes allowing the user to choose which days of the week they work. The resulting item will be a list containing the days of the week that they work.
$CSCopyItems	Text list	Item list used to send custom items on normal C&S workflow messages. Any item names included in the text list will be copied from the current document on to all workflow messages that get sent. Usage: Add field names that you wish to add to room reservations.
$CSFlagsRepaired	Text	This appears on entries that the client has repaired/obsoleted. It is the original value of the $CSFlags item. New for 8.5
$CSTrack	Text list	Summary field This item is used to track the flow of CS Notice items to help analyze any CS problem reports. It records each action and client version used for that action, as well as time and date stamps. Note: Customized templates or applications should add to the end of the list to help triaging any problems.
$CSWISL	Text list	Watched Item Sequence List. Notes tracks when certain items are updated in the Note. When update is sent, C&S code of recipient can decide if sender or recipient has new version of item. Watched items are: $S- Subject $L- Location $B- Body $R- Room $E- Resource Notes 7 additions: $M OnlineMeeting $O OnlinePlaceToReserve $W MeetingPassword See also UpdateSeq
$ExpandGroups	Text	Mail field. Used by the Mailer to decide if local people and groups should be expanded. It is 'On' by default. Valid values are: 0 = Do not expand groups 1 = Expand local groups only 2 = Expand public groups only (default) 3 = Expand local and public groups
$FromPreferredLanguage	Text	The preferred language of the originating mail database. IBM Lotus Sametime needs this item to be able to properly set the localization string for the meeting.
$LangChair	Text	Language of AltChair.
$NameLanguageTags	Text	The language used. Value for English is en.
$LangPrincipal	Text	The language used for $AltPrincipal
$LangReservedBy	Text	The language used for ReservedBy
$PreventReplies	Text	Indicates whether or not Chair wants replies back. If the to convey "Do not reply" is 1, all other values (including no item at all) mean the Chair is expecting a reply.
Alarms	Text	User interface field. Value is 1 when an alarm is enabled and is when alarm is disabled or was never enabled.
AllowBusyAccess	Text / Text List	Calendar profile / R&R room profile item Value is a list of canonical names of entities allowed to access the busytime of the entity whose profile this list appears on. The names in the list should not contain any domain names. A value of means anyone.
AllowBusyDetailAccess	Text / Text List	Calendar profile / R&R room profile item New for 6.0 Value is a list of caonical names of entities allowed to access the detailed information in busytime of the entity whose profile this list appears on. A value of means anyone.
AllowControversialFields	Text	Calendar profile / R&R room profile item New for 6.0 Value indicates if items deemed to be potentially sensitive may be harvested as part of detail harvesting in busytime. The list of what items are deemed to be harvested if this setting is enabled are found in the ControversialFields item. Value(s): = No (Default) 0 = No 1 = Yes
AltBlindCopyTo	Text List	Mail recipient field Alternate names for the Bcc recipients. Defaults to primary name when the alternate name is unavailable. This list must be kept in sync with the BlindCopyTo field.
AltChair	Text	Alternate Name of the owner.
AltCopyTo		Mail recipient field. Alternate names for the Cc recipients. Defaults to primary name when the alternate name is unavailable. This list must be kept in sync with the CopyTo field.
AltDelegator	Text	Alternate name of the calendar owner of delegator.
AltDelegeeName	Text	Alternate name of the person being delegated to.
AltFYINames	Text List	C&S attendee field. Alternate names for users who are not involved in a meeting, but should be aware of it. Only available for the Chair. This list must be kept in sync with the FYIAttendees field.
AltOptionalNames	Text List	C&S attendee field. Alternate names for users who may participate in a meeting. This list must be kept in sync with the OptionalAttendees field.
AltRequiredNames	Text List	C&S attendee field. The alternate name(s) of required users (To) on the entry. For R5 and later, this list contains the alternate name(s) of any required attendees to an entry. It is organized similar to mail alternate names. IMPORTANT: This list must be kept in sync with the RequiredAttendees field.
AltSendTo	Text List	Mail recipient field. Alternate names for the To recipients. Defaults to primary name when the alternate name is unavailable. This list must be kept in sync with the SendTo field.
AppendEndTime	Date/Time	Has same value as EndTime.
AppendStartTime	Date/Time	Overrides the StartTime value for an entry. This value, if found, is used to change the calculated start time of an entry.
AppointmentLead	Text	The default amount of time before an Appointment starts that the alarm should trigger. The value MUST be in minutes and no other unit. The value is only of use when SetAlarmAppointment = 1. This item is used only on calendar profiles.
ApptUNIDURL	Text	The URL used to attend the online meeting place on the Online meeting server. Calculated during the save process. Default: value is ""
AssignedTo	Text	A list of users a task is assigned to. This is the task equivalent of RequiredAttendees and should be treated correspondingly.
AssignedState	Text	Used by tasks for communicating status.
AudioAndVideoFlag	Text	R&R room profile item The audio/video options flag for Sametime meetings. Valid valuesare: "0" - None (Default) "1" - Audio and/or Video settings
AudioFlag	Text	R&R room profile item The audio only option flag for Sametime meetings. Valid values are: "" - None (Default) "1" - Audio only
AudioVideoFlags	Text	The audio/video options for Sametime meetings. Valid values are: "0" = None (Default) "1" = Audio only 2 = Audio and Video
AudioVideoSelectionList	Text	R&R room profile item This R&R setting only applies to "Online" R&R types. For regular rooms or resources the value must be: "" (Default)
AutoProcessForwardTo	Text/Text list	R&R room profile item Stored on the room or resource profile document in the R&R dB. Performs the same function as ResourceOwner on a reservation request. See ResourceOwner.
AutoProcessType	Text	Calendar profile / R&R room profile item Indicates what kind of owner restriction, if any, exists for a room or resource. Indicates the autoprocessing settings for a user when on a Calendar profile. Not all values are valid for all profile docs. Value(s) are: 0 = None (R&R) / Automatically process meeting invitations from all users (Calendar) 1 = Only the Owner can book (R&R) / Delegate meeting invitations to the following person, the list is specified in AutoProcessUserList (Calendar) 2 = Only people on specified list can book. See AutoProcessUserList (R&R) / Automatically process meeting invitations from specified users (Calendar) 3 = Only people on list can book via autoprocess; others need owner approval (R&R) 4 = Not used 5 = Inbox management: Calendar managed by another . New with R6 and may be obsolete now. 6 = Forward notifications of invites to specified users. New to R6. (Calendar) 7 = Just like 0 and 2 in that you automatically process meeting requests. Supports using AutoProcessFromType to decide which requests to do (Anyone/Only Some/Anyone but). Only really used for "Anyone but" because we map "Anyone" and "Only Some" to0 and 2 on-disk respectively to maximize backwards compatibility. New with R6. (Calendar) 8 = Just like 1 in that you specify a delegate for your meetings requests. Supports using AutoProcessFromType to decide which requests to do (Anyone/Only Some/Anyone but). Used for "Only Some" and "Anyone but" but not "Anyone" because we map "Anyone" to 1 on-disk to maximize backwards compatibility. New with R6. (Calendar) D = Disabled (R&R) / No autoprocessing of invitations (Calendar).
AutoProcessUserList	Text/Text list	R&R room profile item List of the names of the only users (or groups) which are allowed to reserve a Specific People or Autoprocess type of room without requiring owner approval.
AutoRemoveFromInbox		Calendar Profile Item. A user preference to NOT see replies in their Inbox. If a user selects this option, replies are automatically removed from Inbox (but are still visible in the Meetings view).
AutoReminder	Text	R&R site option Indicates if the Autoreminder feature is enabled or for the site. If not enabled then all the other autoreminder settings are ignored. Valid values are: "On" = Autoreminders are enabled "Off" = Autoreminders are disabled
AVSlctLst	Text/Text list	R&R room option Default for non-Sametime rooms is . Default for Sametime rooms is 1
Broadcast	Text	Indicates whether the Chair wants to receive any responses. Valid values are: 1 = Broadcast, do not RSVP Any other value = RSVP (Default)
CalForwardChairNotificationTo	Text list	C&S preference item Indicates whom notices should be forwarded to when the Chair receives a response back. This is for managed Calendars where another user or users need to be notified of a response back to the Chair.
CalForwardInviteeNotificationTo	Text list	C&S preference item Indicates whom notices should be forwarded to when the user receives a C&S workflow message from a Chair. This is for managed Calendars where another user or users need to be notified of a new C&S notice or update from a meeting Chair.
CalForwardPrivateMode	Text list	C&S preference item Indicates what level of information should be included on a forwarded notice. Values are: 0 = None. Do not forward / notify. 1 = Hide details. Only send a summary. 2 = Full details. Send a complete copy (subject of entry, etc).
Capacity	Number	R&R room option / C&S workflow item On an room document the value indcates the capacity of a room can hold. If a reservation request exceedes the capacity of a room it will still be accepted; the Acceptance notice the Chair receives will include a note indicating this since not all invitees may be physically attending. On a reservation request the value indicates the number of meeting participants. The value is compared against the value of the specified room in order to warn the Chair if they have possibly exceeded the capacity. Values should be positive integer values.
Categories	Text	Category picked or entered by the user.
ChairDomain	Text	Notes domain of the user who is chairing or organizing the entry. If Chair is in Internet format, then this item is empty.
CommonNameResourceName	Text	R&R room option The friendly or common name part of the room or resource name.
ConferenceDatabase	Text	R&R room option The name of the Sametime conference database where the request will be forwarded to by the Rooms & Resource Manager. It appears on ALL room or resource documents even if they are not a Sametime entry. Value must be stconf.nsf
ControversialFields	Text/Text list	Calendar profile / R&R room profile item New for 6.0 Value indicates which controversial or potentially sensitive items the user will allow to be harvested into busytime. This typically means meeting subjects which can contain information that not everyone should be able to see (eg: Teleconference information). The list is only used if AllowControversialFields item is set to 1 and detail harvesting has been enabled on the Default Domain Configuration doc in the NAB. Default:
DeclineReason	Text	The reason why a room reservation request was declined by a Room Owner. Default:
DelegateToList	Text list	Text list of delegees in the order in which they were delegated. The original invitee is not on the list. This can be an Internet address.
DeliveredDate	Date/Time	The date/time stamp when the notice was delivered to the invitees inbox or the R&R database. This value is set by the Domino mail Router.
DeliveryPriority	Text	The delivery priority chosen by the user (High\|H, Low\|L, Normal\|N)
DeliveryReport	Text	The Delivery Report options chosen by the user (None\|0, Only on Failure\|1, Confirm Delivery\|2, Trace Entire Path\|3)
Encrypt	Text	Security mail option Encrypt. Value is 0 when not chosen by the user and 1 when chosen.
EndTimeZone	Text	The Notes timezone string for the EndDateTime. Time zone strings are in the following format: Fixed Time Zone: Z=$DO=0$ZX=0$ZN= Zone with daylight savings: Z=$DO=1;$DL= > $ZX=0$ZN=
EnterBlindCopyTo	Text list	C&S attendee field. Primary names for potential users who are not involved in a meeting but should be aware of it. Only available for the Chair. Present only on a draft meeting and mutually exclusive to FYIAttendees field.
EnterCopyTo	Text list	C&S attendee field. Primary names for potential users who may participate in a meeting. Present only on a draft meeting and mutually exclusive to OptionalAttendees field.
EnterSendTo	Text list	C&S attendee field. Primary names for potential users who are required to participate in a meeting. Present only on a draft meeting and mutually exclusive to RequiredAttendees field.
ExcludeFromAll	Text	C&S preference item. Indicates that C&S entries should be excluded from the All Documents view of the mail file. A 1 indicates C&S entries should be hidden. and will cause a A to be added to the ExcludeFromView item on the not.
ExpandedList	Text/Text list	R&R room option The expanded contents of AutoProcessUserList item. If the AutoProcessUserList only contains users then the two items will be the same.
ExpandedOwners	Text/Text list	R&R room option The expanded contents of AutoProcessForwardTo item. If the AutoProcessForwardTo only contains users then the two items will be the same.
ExternalAddress	Text/Text list	R&R room option The name of the mail-in database entry where the Rooms & Resource Manager should forward the request for a Sametime meeting. The value should match the name given to the stscnf.nsf entry in the Domino Directory. Default value for non-Sametime entries is .
FromDomain	Text	Contains the Notes domain of the user who created the document. This is normally put on by client mailer code.
FYIAttendees	Text list	C&S attendee field. Primary names for users who are not involved in a meeting but should be aware of it. Only available for the Chair.
HowCreated	Text	R&R Site option Indicates which kinds of reservations should generate autoreminder notices, if the autoreminder feature is enabled. Valid values are: "0" = All reservations "1" = Direct book reservations only.
INetFrom	Text	RFC822 email address corresponding to From item.
InetBlindCopyTo	Text list	Mail recipient field. Internet addresses for the Bcc or FYI recipients. Defaults to . when the Internet address is unavailable. This list must be kept in sync with the BlindCopyTo field.
InetCopyTo	Text list	Mail recipient field. Internet addresses for the Cc recipients. Defaults to . when the Internet address is unavailable. This list must be kept in sync with the CopyTo field.
INetFYINames	Text list	C&S attendee field. Internet addresses for users who are not involved in a meeting but should be aware of it. Only available for the Chair. This list must be kept in sync with the FYIAttendees field.
INetOptionalNames	Text list	C&S attendee field. Internet addresses for users who may participate in a meeting. This list must be kept in sync with the OptionalAttendees field.
INetRequiredNames	Text list	C&S attendee field. Internet addresses for users who are required to participate in a meeting. This list must be kept in sync with the RequiredAttendees field.
InetSendTo	Text list	Mail recipient field. Internet addresses for the To recipients. Defaults to . when the Internet address is unavailable. This list must be kept in sync with the SendTo field.
KeepPosted	Text	Determines whether participant wants to be kept notified of updates. This setting is on reply to Chair for decline and delegation. 0 = Do not want further updates (Default if missing) 1 = Do want further updates
LimitDate	Date / Time	R&R room option This setting indicates what the last allowed reservable date is for a room or resource. All reservations beyond that date will be declined by the Rooms & Resource Manager.
LimitDays	Number	R&R room option This setting indicates the number of days out that a room or resource is allowed to be reserved. All reservations beyond that number of days will be declined by the Rooms & Resource Manager. Since this value constitutes a moving value, one that needs to change each day, the Update Blocker Documents Agent must be enabled and configured properly for this kind of limit to work properly. The value must be a positive integer value.
LimitDD	Text	R&R room option Admins can limit how far out R&R reservations can be made. This setting on the room or resource profile doc indicates that some limit setting has been enabled. The actual kind of limit is determined by the LimitHow item. This setting has no effect or relevance for SameTime type resources.
LimitHow	Text	R&R room option This setting indicates what kind of future booking limit has been set on a room or resource. Values are: 1 = Limit by days. The actual number of days ahead is set in the LimitDays item. 2 = Limit by date. The actual last reservable date is set in the LimitDate item.
Location	Text	The location where the entry will occur. This value may be specified by the user or constructed by the template if the user enters no value but some Room & Resource data exists on the entry. The value is not fixed or governed by any rules; it may be some arbitrary information or data inserted by the template. Trying to parse the value for some semanticly usable data may or may not be possible. Instead, the desired data should be parsed from the other items on the entry.
Logo	Text	This is the background design on regular mail. Inherited by C&S note but is not used. The value specifies the sending users default letterhead value and is of the base format of stdNotesLtr# where # is some number.
MailOptions	Text	Value appears to be always 0 in this context.
MeetingType	Text	One of the Sametime meeting types. Valid values are: "1" - Collaboration "2" - Moderated "3" Broadcast Default: "1" in Notes 6 and 7 Default: 2 in Notes 8
MeetingPassword	Text	Online Meeting password if used.
Moderator	Text	The canonical name of the moderator of the Sametime meeting. Note: This does not have to be the same person who schedules the meeting.
NDays1	Text	R&R site option Used to indiciate how many days prior to a event the first autoreminder should be sent if the autoreminders are configured to be sent Daily. The value is ignored if the autoreminder is set to Weekly. See the SendWhen item.
NDays2	Text	R&R site option Used to indiciate how many days prior to a event the second autoreminder should be sent if the autoreminders are configured to be sent Daily. The value is ignored if the autoreminder is set to Weekly. See the SendWhen item. A value of "0" means no second autoreminder should be sent.
NDays3	Text	R&R site option Used to indiciate how many days prior to a event the third autoreminder should be sent if the autoreminders are configured to be sent Daily. The value is ignored if the autoreminder is set to Weekly. See the SendWhen item. A value of "0" means no third autoreminder should be sent.
NewEndDateTime	Date/Time	The counter-proposed UTC end datetime for a new DueDate or EndDate.
NewEndTimeZone	Date/Time	The Notes timezone string for the NewEndDateTime. Time zone strings are in the following format: Fixed Time Zone: Z=$DO=0$ZX=0$ZN= Zone with daylight saving: Z=$DO=1;$DL= > $ZX=0$ZN=
NewStartDateTime	Date/Time	The counter-proposed UTC start date and time for a new StartTime. Although this information could be merged into one item with NewStartTime, there are R5 historical reasons for the creation of StartDate and StartTime, so two items are needed to convey the counter proposal to the Chair. Since tasks have no StartTime, there is no equivalent for it on tasks.
NewStartTimeZone	Date/Time	The Notes time zone string for the NewStartDate Time zone strings are in the following format: Fixed Time Zone: Z=$DO=0$ZX=0$ZN= Zone with daylight saving: Z=$DO=1;$DL= > $ZX=0$ZN=
NoticeTypeRepaired	Text	The original NoticeType item value of a repaired / obsoleted entry. Valid values are the same as those for NoticeType. New for 8.5.
OnlineMeeting	Text	If meeting is an online meeting, value field is 1.
OnlinePlace	Text	Name of the online place found in the Domino Directory. Note that this is where the name is stored after processing has occurred. Valid values are: Taken from the list of Online meeting places in the Domino Directory (in canonical format).
OnlinePlaceToReserve	Text	Name of the online place found in the Domino Directory. Note that this is where the name is stored before processing has occurred. Valid values are: Taken from the list of Online meeting places in the Domino Directory.
OrgConfidential	Text	Indicates whether the entry is private or not . This was also shared with the Lotus Organizer product. Value is if Mark Private is not checked, and 1 if it is checked.
OrgRepeat	Text	Indicates whether the entry repeats. See also Repeats field. Value is 1 if entry is a repeating one, and if it is not.
OrgState	Text	C&S item for Lotus Organizer Indicates the type of entity the that this was created for: Users, Rooms, Resources or a Sametime meeting. It was added in R5 to support Lotus Organizer. It is currently only present for backwards compatibility. Valid values are: "0" = A person "5" = A room "6" = A resource "7" = A Sametime meeting
OrgStatus	Text	C&S item for Lotus Organizer from here: ../images/Calendar_and_Scheduling827.gif Sent on a Status Update notice to an invitee telling them they are either required to attend or removed from a meeting invitation. is currently only present for backwards compatibility Valid values are: 2 = Accepted 5 = Removed
OriginalDelegator	Text	Owner of calendar who was original invitee for this delegation chain. This can be an Internet address.
OriginalEndDate	Date/Time	The original UTC end date & time of the repeat instance that is being rescheduled. This is necessary when the user reschedules a single (or run of) repeating entry so that they know which one to use as the base reference point.
OriginalEndTimeZone	Text	The Notes timezone string for TimeZones strings are in the following format: Fixed Time Zone: Z=$DO=0$ZX=0$ZN= Zone with daylight saving: Z=$DO=1;$DL= > $ZX=0$ZN=
OriginalStartDate	Date/Time	The name of this item is misleading. It is not the original S Useful in the case of rescheduling. Do not put on a repeat parent doc.
OriginalStartTimeZone	Text	The Notes TimeZones strings are in the following format: Fixed Time Zone: Z=$DO=0$ZX=0$ZN= Zone with daylight savings: Z=$DO=1;$DL= > $ZX=0$ZN=
ParentRepeatDates	Date/Time	The current set of repeating dates & times, including all reschedules to that point. See RepeatDates for more details on the usage (although its use on a parent document may be slightly different).
ParentRepeatInstanceDates	Date/Time	The original set of repeating dates & times from when the entry was created. See RepeatInstanceDates for more details on the usage (although its use on a parent document may be slightly different).
PostedDate	Date/Time	The client stamps this date/time on Note when it is mailed. This item is used by R&R to distinguish a request sent from a users Calendar from a directly booked request.
Presenters	Text	User
PreventCounter	Text	Indicates that the Chair does not want any counter proposals. Valid values are: 1 = Do not allow the invitees to counter propose All other values (including missing) = Allow it
PreventDelegate	Text	Used to indicate the Chair does not want to allow any delegation by invitees. Valid values are: 1 = Do not allow the invitees to delegate All other values (including missing) = Allow it
PreventRepliesFromInbox	Text	C&S preference item Indicates what kinds of C&S documents the user wants displayed in their Inbox. Values are: 0 = Display All Notices 1 = Display All Except Responses 2 = Display No C&S docs in Inbox (they only show in the miniview)
Purpose	Text	The purpose of the room or resource reservation. Same as the Topic field for reservations created from the Calendar. This is the item used in the R&R template for direct-booked reservations
RepeatAdjust	Text	Text list describing the days/dates that the rule should use to calculate the list of repeat dates & times (for example, Monday, 1st of the Month). Currently only repeat types W (Weekly) and M (Monthly) require this parameter. In Notes version 4, this item was 0 based, so Sunday (for weekly entries) was 0, and so on. This is legacy now and may not be changed without seriously impacting backward compatibility. When dealing with D (Repeat by Month Date) repeats, the list is 1 based and is the list of dates in the month that the entry should repeat. Negative values must not be used here. If you want to have "The 2nd-to-last day" of the month, then use "2" here and set RepeatFromEnd to 1. This exists only in the Repeat Parent document and on Notice sent to original invitees. It is informational only, since the UI of the Chair used this information to generate the original repeat dates item.
RepeatCustom	Text	A hard-coded list of dates used mainly for custom repeating entries. Used by the UI code to set custom dates. Once repeat is saved, the items are copied to RepeatDates. This exists only in the Repeat Parent document and on Notice sent to original invitees. It is informational only, since the UI of the Chair used this information to generate the original repeat dates item.
RepeatDates	Date/Time	The set of repeating dates & (start) times at which the entry repeats. The end date & times are not specified on another item; rather, they are derived by shifting the list of start date & times by the entrys duration. The presence of this item or of OrgRepeat is what truly signifies an entry is repeating, not any other checks. Note: This exists only in the Parent Doc. Important: This serves as the key when a lookup is performed on the ($RepeatLookup) view, in the code. This is a peer item to ParentRepeatDates and, depending on some scenarios, one item may be used in place of the other. When creating an outgoing message, this item is the backup to RepeatInstanceDates. If RepeatInstanceDates is not present, then RepeatDates is sent instead.
RepeatEndDates	Date/Time	When a repeating meeting is accepted, the repeat end dates are generated on parent repeat document. They are the corresponding end dates for the dates found in RepeatDates item.
RepeatFor	Number	The number of RepeatForUnits for which the entry repeats This value is a positive integer. Any zero or negative values are automatically treated as 1. Does not have any significance when repeat to date is chosen. This exists only in the Repeat Parent document and on Notice sent to original invitees. It is informational only, since the UI of the Chair used this information to generate the original repeat dates item.
RepeatForUnit	Text	The unit of time that the repeat rule is for. Further defined by RepeatUnit value. This exists only in the Repeat Parent document and on Notice sent to original invitees. It is informational only, since the UI of the Chair used this information to generate the original repeat dates item. Valid values are: = Custom D = Daily M = Monthly W = Weekly Y = Yearly
RepeatFromEnd	Text	Flag indicating whether the monthly repeat is from the end of the month instead of the start of the month. Valid values are: 1 = Start from the end (that is, values in RepeatAdjust are relative to the end of the month). All other values (or missing) = Start from the beginning of the month This exists only in the Repeat Parent Document and on Notice sent to original invitees. It is informational only, since the UI of the Chair used this information to generate the original repeat dates item.
RepeatHow	Text	Indicates how the user wanted the repeat set to be terminated, either by count or by explicit date. Valid values are: F = "For"; indicates a count was desired U = "Until"; indicates that an explicit repeat end date/time was desired. The desired date/time is in RepeatUntil. This exists only in the Repeat Parent Document and on Notice sent to original invitees. It is informational only, since the UI of the Chair used this information to generate the original repeat dates item.
RepeatIds	Text list	A list of UNID(s) of the response documents. One for each repeat instance. Note: Exists only in the Repeat Parent document. In Notes 6, this exists only for Repeating All Day Events.
RepeatInstanceDates	Date/Time list	The set of dates & times that are affected by the message that they are on. For repeating entries this may be a single date & time if just a single instance is being, say, rescheduled; or it may be a list of dates & times if a range of entries is affected, such as canceling this and all future instances. This item is copied at creation from RepeatDates so that it can become a snapshot of the original set of dates & times. This is a peer item to ParentRepeatInstanceDates and, depending on some scenarios, one item may be used in place of the other. When an outgoing message is created, this item is the primary to RepeatDates. If RepeatInstanceDates is not present, then RepeatDates is sent instead. The number of items in this list must match the number of entries in the StartDateTime and EndDateTime items of a repeating meeting.
RepeatInterval	Text	The interval at which the rule applies. Only positive integer values are valid. The value is used in conjunction with RepeatUnit to calculate the next repeat date for an entry. This exists only in the Repeat Parent document and on Notice sent to original invitees. It is informational only, since the UI of the Chair used this information to generate the original repeat dates item.
Repeats	Text	Indicates whether the entry repeats. Value is 1 if entry is repeating and if it is not. See also OrgRepeat field.
RepeatStartDate		The starting date of the repeating entries. The starting time is actually pulled from either the StartTime item (or from EndTime / DueDateTime when calculating the proper end time). This exists only in the Repeat Parent document and on Notice sent to original invitees. It is informational only, since the UI of the Chair used this information to generate the original repeat dates item.
RepeatUnit	Text	The unit of time over which the entry repeats. This exists only in the Repeat Parent document and on Notice sent to original invitees. It is informational only, since the UI of the Chair used this information to generate the original repeat dates item. Valid values are: C = Custom set of explicit dates D = Daily MD = Monthly by date (that is, the 1st of each month) MP = Monthly by day (that is, the 1st Monday of each month) Y = Yearly
RepeatUntil	Date/Time	The UTC date (& time) up to which the entry set repeats. Since Notes does not currently have the concept of a repeat set that occurs more than once a day (for example, Repeat @ 9AM and 3PM every day for a week"), the time sub value is not used or necessarily set properly. This item is meaningful only if the RepeatHow is set to repeat how until. This exists only in the Repeat Parent document and on Notice sent to original invitees. It is informational only, since the UI of the Chair used this information to generate the original repeat dates item.
RepeatWeekends	Text	Indicate what, if anything, should happen to a repeat instance that occurs on a weekend. This items value is checked only in some cases of repeating entries. As of Notes R5, this item is used only if the entry is Daily (D), Monthly (D only), or Yearly (Y); all other types of repeat sets cause this value not to be useful. This exists only in the Repeat Parent Document and on Notice sent to original invitees. It is informational only, since the UI of the Chair used this information to generate the original repeat dates item. Valid values are: D = Dont move weekend occurrence F = Move weekend occurrence to previous workday, presumably Friday M = Move weekend occurrence to next workday, presumably Monday N = Move weekend occurrence to closest workday (forward or backward) X = Remove weekend occurrence from the repeat set
RequiredAttendees	Text list	C&S attendee field. Primary names for users who are required to participate in a meeting.
RequiredResources	Text list	C&S attendee field. A list of resources the Chair wants/needs to have. Notes version 4: For repeating entries, this entry is stored on the parent document. Version 5 and later: For repeating entries, this entry is stored on the individual child document(s).
RescheduleEndDateTimes	Date/Time list	C&S workflow message. The set of EndDateTimes for the repeat set to which this invitee is being invited after notice is applied. For example, if the invitee is being invited to only the last three days of the repeat meeting, then RescheduleEndDateTimes contains the new end datetime values for the last three dates of the repeat set. For other actions such as Cancel, Remove, and Update, the set of EndDateTimes for the repeat set determines what dates should be used when this action is applied.
RescheduleInstanceDates	Date/Time list	C&S workflow message. The initial set of DateTimes values for the repeat set over which this action should be applied. This set must be in sync with RescheduleEndDateTime and RescheduleStartDateTime. For example, if the invitee is being invited to only the last three days of the repeat meeting, then RescheduleInstanceDates contains the initial datetime values for the last three dates of the repeat set.
RescheduleStartDateTimes	Date/Time list	C&S workflow message. The set of StartDateTimes for the repeat set to which this invitee is being invited after notice is applied. For example, if the invitee is being invited only to the last three days of the repeat meeting, then RescheduleStartDateTimes contains the new start datetime values for the last three dates of the repeat set. For other actions such as Cancel, Remove, and Update, the set of EndDateTimes for the repeat set determines what dates should be used when this action is applied.
RescheduleWhich	Text	Indicates which repeat entry or range of entries is being modified/cancelled. This is for backward compatibility. If the recipient is Notes 6 and later, then the information in RescheduleStartDateTimes, RescheduleEndDateTimes, and RescheduleInstanceDates is used instead. Valid values are: 0 = Current (single) instance only 1 = All instances 2 = Current and all previous 3 = Current and all future -1 = User-cancelled modifying repeat
ResourceOwner	Text/Text list	R&R owner list Used on R&R documents Value indicates the name(s) of any room or resource owner(s) whose approval is required for a reservation request.
Resources	Text	User interface field. Value is always in this context, since no resources can be picked for Appointments. (See Meetings)
ResourceName	Text	R&R item Used on R&R related documents to indicate which room or resource the document is for. The item is single valued as a separate document is created if multiple rooms or resources are involved. Value indicates the canonical room or resource associated with the workflow message.
ResourceType	Text	R&R type indicator. Used on R&R documents only. Value indicates the type of resource specified in ResourceName. Values are: 1 = Room 2 = Resource There is no 3 for Online (Sametime) Meetings because those entries are never stored in the R&R dB. They are forwarded along to the Sametime Server and are not kept in the R&R database.
RestrictAttendance	Text	Indicates whether the online meeting is restricted to only those people/groups in the restricted list. Default is 0.
RestrictToInviteList	Text	The list of users/groups that are allowed to attend this online meeting. Valid values are: The list of names are the people/groups in the From, Moderator, SendTo, CopyTo, BlindcopyTo fields.
ReturnReceipt	Text	Indicates whether user wants a return receipt. Value is 1 when user has picked return receipt and otherwise.
RmRsrList	Text list	R&R site option Value indicates which specific rooms or resources have are configured to be subject to sending of autoreminders when the feature is enabled. The list is ignored if the RRChoice item is not set to "1".
Room	Text	C&S Attendee field. The fully qualified name of the room (Roomname/site) for mailing notices to the Resource Reservation database.
RoomToReserve	Text	User interface field. Value is always in this context, since no rooms can be picked for Appointments. (See Meetings)
RQStatus	Text	Rooms & Resource Request Status New to 7.0 All newly created room reservation requests should have a value of T Valid values are: T = Request is tentative. Awaiting Room Owner or Rooms & Resource Manager approval. A = Request has been approved by Rooms & Resource Manager. R = Request has been rejected by a Room Owner or the Rooms & Resource Manager. If the Room Owner provided a reason it will be saved in the DeclineReason item.
RRChoice	Text	R&R site option Value indicates which rooms or resources should be subject to sending of autoreminders when the feature is enabled. Valid values are: "0" = All rooms / resources "1" = Particular rooms / resources. The selected names are stored in the RmRsrList item.
SametimeServer	Text	Name of the Sametime server on which the online meeting takes place. Values: Taken from the Domino Directory.
SametimeType	Text	Calendar profile setting. Type of Sametime server the user wants to default to when scheduling online meetings. Valid values are: 0 = Sametime meeting (Default) 1 = Sametime Unyte meeting
SendWhen	Text	R&R site option Used to indiciate if autoreminders, when enabled, should be sent weeky or daily. Valid values are: "0" = Weekly (Default) "1" = Daily
SendAttachments	Text	Indicates whether the people who are invited to the meeting receive the attachments that will appear in the online meeting. Default: "0"
Sign	Text	Allows the user to Sign the entry for security purposes.
Site	Text	R&R item Stored on each reservation request to incidate the Site of the room or resource being requested. The value matchs the last component value of the room or resource name. So if a room or resource is renamed, this value needs to be updated to match any change.
StartTimeZone	Text	The Notes timezone string for the StartDateTime. Time zone strings are in the following format: Fixed Time Zone: Z=$DO=0$ZX=0$ZN= Zone with daylight saving: Z=$DO=1;$DL= > $ZX=0$ZN=
StartWeek	Text	R&R site option Used to indicate which day the week starts on and thus when weekly autoreminders should be sent.
StorageFYINames	Text list	C&S attendee field Mail formatting preferences for users who are not involved in a meeting but should be aware of it. Defaults to 1 or . when the preference is unavailable. Only available for the Chair. Formatting types are: 0 Prefers Notes Rich Text 1 Keep in senders format (no preference) 2 Prefers MIME . (Period) Keep in senders format (no preference) This list must be kept in sync with the FYIAttendees field.
StorageOptionalNames	Text list	C&S attendee field Mail formatting preferences for users who may participate in a meeting. Defaults to 1 or . when the preference is unavailable. Formatting types are: 0 Prefers Notes Rich Text 1 Keep in senders format (no preference) 2 Prefers MIME . (Period) Keep in senders format (no preference) This list must be kept in sync with the OptionalAttendees field.
StorageRequiredNames	Text list	C&S attendee field Mail formatting preferences for users who are required to participate in a meeting. Defaults to 1 or . when the preference is unavailable. Formatting types are: 0 Prefers Notes Rich Text 1 Keep in senders format (no preference) 2 Prefers MIME . (Period) Keep in senders format (no preference) This list must be kept in sync with the RequiredAttendees field. This item can be overloaded in version 6 and later, to contain a copy of the RescheduleInstanceDates item, due to backward compatibility with R5. When an R5 user accepts, StorageRequiredNames is sent back on the acceptance, allowing the Chair to know what days the invitee is accepting.
STPermissions	Text list	Sametime Unyte setting Setting to control who can attend the Sametime meeting. Valid values are: 0 = Limit attendance to only meeting invitees 1 = Open meeting to all users
STPermPresent	Text list	Sametime Unyte setting Setting to indicate who will be allowed to present content during the Sametime Unyte meeting. Valid values are: 0 = All participants have permission to present content.
STRecordMeeting	Text list	Sametime Unyte setting Setting to indicate if the Sametime meeting should be recorded or not. Valid values are: 1 = Record this meeting so others can replay it later
STRoomName	Text list	Sametime Unyte setting Textual label that the Chair has given to their Sametime Unyte meeting. This label is used to identify which Sametime settings are to be used on the calendar entry.
STServiceInfo	Text list	Sametime Unyte setting Valid values are:
STUnyteConferenceID	Text/Text list	Sametime Unyte setting The Sametime Unyte conference password. This setting is stored on both the Calendar Profile (for creating new online meetings easily) and on any workflow documents where the chair has scheduled a Sametime Unyte meeting. For backwards compatability this value is also stuffed into the MeetingPassword item.
STUnyteConferenceURL	Text/Text list	Sametime Unyte setting The Sametime Unyte conference URL. This setting is stored on both the Calendar Profile (for creating new online meetings easily) and on any workflow documents where the chair has scheduled a Sametime Unyte meeting. For backwards compatability this value is also stuffed into the ApptUNIDURL item.
TaskLead	Text	The default amount of time before an Task starts (or ends) that the alarm should trigger. The value MUST be in days, NOT minutes as the value is automatically adjusted internally before use. The value is only of use when SetAlarmTask = 1. This item is used only on calendar profiles.
TaskType		Identifies the kind of task this is. Valid values are: 1 = Personal task and personal todo 2 = Group task and group todo
Topic	Text	The original Subject as entered by the Chair. This item is only on workflow meeting messages.
UpdateSeq	Text	Indicates sequence of updated items in note. Tracks non-date/time changes (eg: Subject, Location). Always greater than or equal to the SequenceNum item. This value is tied to the entries in the $CSWISL item.
WhiteBoardContent	Composite	The attachments that are presented in the white board during the online meeting. Values: Files that the user chooses. (Note: works in conjunction with $FILE field.)

Use NSFItemAppend API to add each item to the appointment note.

Meeting Invitation:

Established meeting invitation note:

The items described above for creating an Appointment note, and
The following items.

Meeting invitation event note:

Meeting invitation originator sends the meeting invitation to invitees
Invitee counters the meeting time
Meeting invitation originator re-schedules the meeting
Invitee accepts the meeting invitation
Invitee declines the meeting invitation
Invitee delegate the meeting invitation
Meeting invitation originator confirms the meeting
Meeting invitation originator cancels the meeting

See the Summary of Invitation Event Note Itemssection for summarized information.


Item Name	Description	Constant

$CSFlags	Mainly used for repeating entries; Determines what type of repeating entry a document is. Flags used to control C&S operations. Multiple values are allowed; they are simply concatenated into a single string. Valid values are: c = Repeat instances have been created (only appears on repeat parent) e = Document is a repeat exception h = Document is a Holiday document created by the Import Holiday agent i = Document is a repeating instance m = Document is a repeating workflow message. This is the most commonly used value and must be on any repeating entry. r = Document is a request for information u = Document is updated information w = Event is workflow enabled
_ViewIcon2	Secondary icon to display in a view column. The icon to display in the calendar views for the entry. Valid values are: 11 = Blue informational icon. Indicates that the message contains a personal comment from the sender. 33 = Reschedule
Delegator	Fully distinguished name of the delegator. Owner of calendar who is delegator. This can be an Internet address.
Delegee	Fully distinguished name of the person being delegated to. Person being delegated to. This can be an Internet address.
FormToUse	Only used by UI when sending a notice with additional comments
NewEndDate	New End date/time of the scheduled event. The counter-proposed UTC end date (not time) for a new DueDate or EndDate.
NewEndTime	New End date/time of the scheduled event. The counter-proposed UTC end time (not date) for a new EndDate. Since tasks have no EndTime, there is no equivalent for it.
NewStartDate	New Start date/time of the scheduled event. The counter-proposed UTC end date (not time) for a new StartDate. Although this information could be merged into one item with NewStartTime, there are Notes R5 historical reasons for the creation of StartDate and StartTime, so two items are needed to convey the counter proposal to the Chair.
NewStartTime	New Start date/time of the scheduled event. The counter-proposed UTC end time (not date) for a new StartTime. Although this information could be merged into one item with NewStartTime, there are R5 historical reasons for the creation of StartDate and StartTime, so two items are needed to convey the counter proposal to the Chair. Since tasks have no StartTime, there is no equivalent for it on tasks.
NoticeType	Type of the notice. Type of notice being sent. While the data type is for a string, only the first character of this item is used for determining what kind of notice it is. For R&R in R7 or later, the only valid values to use are I on the initial invitation or U on an update / reschedule notice. The Rooms & Resource Manager will handle changing it when the request is processed. Valid values are: A = User accepted request B = Chair has accepted a counter proposal C = Chair cancelled event D = User is delegating request; sent to Chair E = Participant would like fresh copy of event. Notice is refreshed info from Chair or Update info from Chair. When participant is requesting info, the $CSFlags contains r. When Chair is responding to request, the $CSFlags contains u. If Chair is merely sending an update, $CSFlags will not contain either of these flags. F = User has completed request G = User wants to add event to calendar (may not be stored on disk, only in memory use.) H = User is deleting event I = Invitation request J = Chair declines a counter-proposal request K = Chair is sending updated info to all invitees L = User is delegating request; Notice is sent to delegee N = Event is being confirmed by Chair P = User has tentatively accepted the invitation R = User declined the invitation S = Status update from Chair T = User is counter-proposing request U = Chair has rescheduled the event W = Waiting for reply from user X = Placeholder for "Extended NoticeType"; may not be in actual use. Y = Chair wants to remove rooms/resources Z = User has been removed (may not be stored on disk, only in memory use.)
OptionalAttendees	Fully distinguished name(s) of the Optional invitee(s). C&S attendee field. Primary names for users who may participate in a meeting.
Recipients	Complete list of invitees.
Requiredattendees	Fully distinguished name(s) of thePrimary invitee(s). C&S attendee field. Primary names for users who may participate in a meeting.
StatusUpdate	Details of the event status. Contains the comment when doing Accept/Decline with comment or when the Chair is rescheduling with comment.
$Ref	The UNID of the parent document. Since the parent document should have a UNID equivalent to the ApptUNID, use the ApptUNID to create the $Ref item. Do not put $Ref on a parent document.
$RefOptions	Value is 1. This must only be on Note if $Ref is on Note. Do not put $RefOptions on a note that does not contain a $Ref item.
$Revisions	List of date/time stamps on which the document was revised. Item does not exist if document has not been revised.
$Seal	The seal when the Encrypt option is chosen under Delivery options / Security Options.
$SealData	The seal data when the Encrypt option is chosen under Delivery options / Security Options. When the owner chooses the option to encrypt mail, the body item of the document is encrypted and put into this item.
$Signature	Digital signature of the items on the document. Item exists if the Chair chose Sign Delivery options / Security Options when sending the notice.
$SMTPKeepNotesItems	Mail field This is a note to the mailer to store X-Notes-items in MIME stream when sending via SMTP. Value is 1.
$SrvrHldy	Server Holiday This item is used to mark an entry as a Holiday that was imported from the server. If the item exists, the entry is some kind of Holiday otherwise it is not. There are no defined valid values. The presence of this item alone indicates it is imported from a Holiday set.
$StorageBcc	Mail recipient field. Mail formatting preferences for the Bcc recipients. Defaults to 1 or . when the preference is unavailable. This list must be kept in sync with the BlindCopyTo field. Valid values are: 0 Prefers Notes Rich Text 1 Keep in senders format (no preference) 2 Prefers MIME . (Period) Keep in senders format (no preference)
$StorageCc	Mail recipient field. Mail formatting preferences for the Cc recipients. Defaults to 1 or . when the preference is unavailable. This list must be kept in sync with the CopyTo field. Valid values are: 0 Prefers Notes Rich Text 1 Keep in senders format (no preference) 2 Prefers MIME . (Period) Keep in senders format (no preference)
$StorageTo	Mail recipient field. Mail formatting preferences for the To recipients. Defaults to 1 or . when the preference is unavailable. This list must be kept in sync with the SendTo field. Valid values are: 0 Prefers Notes Rich Text 1 Keep in senders format (No preference) 2 Prefers MIME . (Period) Keep in senders format (No preference)
$Times1	Hours that the user works on Sunday. This item is used only on calendar profiles.
$Times2	Hours that the user works on Monday. This item is used only on calendar profiles.
$Times3	Hours that the user works on Tuesday. This item is used only on calendar profiles.
$Times4	Hours that the user works on Wednesday. This item is used only on calendar profiles
$Times5	Hours that the user works on Thursday. This item is used only on calendar profiles.
$Times6	Hours that the user works on Friday. This item is used only on calendar profiles.
$Times7	Hoursthat the user works on Satuday. This item is used only on calendar profiles.
$UpdatedBy	List of user names who modified the document.

^Legend:

⁽¹⁾

^{denotes a note to be modified or created for the current "event owner" when the given event occurs.}

⁽²⁾

^{denotes a message note to be sent out when}

^{the given event occurs.}

⁽³⁾

^{denotes a message note to be sent to meeting invitation originator when the delegating event occurs.}

⁽⁴⁾

^{denotes a message note to be sent to delegee when the delegating event occurs.}

--

^{- indicates the item is not required for the given event.}

italic font

^{- indicates the description of the item value.}

NULL

^{- indicates a NULL value.}

helv font

^{- indicates the text string of the item value.}

	Invita- tion		Counter- ing		Re- schedule	Accept- ing
	⁽¹⁾	⁽²⁾	⁽¹⁾	⁽²⁾	⁽²⁾	⁽¹⁾	⁽²⁾
$BusyName	current user	--	current user	--	--	current user	--
$BusyPriority	1	--	2	--	--	1	--
$CSFlags	--	--	--	w	w	--	w
$REF	--	--	--	yes	yes	--	yes
_ViewIcon	158	133	39	39	33	158	83
_ViewIcon2							11
CopyTo	NULL	yes	yes	yes	yes	yes	yes
Delegator	--	--	--	--	--	--	--
Delegee	--	--	yes	--	--	--	--
Form	appointment	notice	notice	notice	notice	notice	appointment
FormToUse							notice
NewEndDate	--	--	yes	yes	--	--	--
NewEndTime	--	--	yes	yes	--	--	--
NewStartDate	--	--	yes	yes	--	--	--
NewStartTime	--	--	yes	yes	--	--	--
NoticeType	--	I	T	T	U	A	A
Recipients	yes	--	--	--	--	--	--
SEQUENCENUM	1	1	1	1	3	1	3
StatusUpdate	--	--	yes	-	-	yes	yes
	⁽¹⁾	⁽²⁾	⁽¹⁾	⁽²⁾	⁽²⁾	⁽¹⁾	⁽²⁾
	Invita- tion		Counter- ing		Re- schedule	Accept- ing

	Declin- ing			Delegat- ing		Cancelled	Confirm- ed
	⁽¹⁾	⁽²⁾	⁽¹⁾	⁽³⁾	⁽⁴⁾	⁽²⁾	⁽²⁾
$BusyName	current user	--	current user	--	--	--	--
$BusyPriority	2	--	2	--	--	--	--
$CSFlags	--	w	--	w	w	w	w
$REF	--	yes	--	yes	--	yes	yes
_ViewIcon	84	84	84	84	133	81	10
_ViewIcon2						11	11
CopyTo	yes	yes	yes	yes	yes	yes	yes
Delegator	--	--	--	--	yes	--	--
Delegee	yes	--	yes	yes	--	--	--
Form	notice	notice	notice	notice	notice	(ReplyNotice)	notice
FormToUse	--	--	--	--	--	notice	notice
NewEndDate	yes	--	yes	--	--	--	--
NewEndTime	yes	--	yes	--	--	--	--
NewStartDate	yes	--	yes	--	--	--	--
NewStartTime	yes	--	yes	--	--	--	--
NoticeType	R	R	D	D	L	C	N
Recipients	--	--	--	--	--	--	--
SEQUENCENUM	1	1	1	1	1	3	3
StatusUpdate	yes	--	yes	--	--	yes	yes
	⁽¹⁾	⁽²⁾	⁽¹⁾	⁽³⁾	⁽⁴⁾	⁽²⁾	⁽²⁾
	Declin- ing			Delegat- ing		Cancelled	Confirm- ed

The following sections describe each of the items alphabetically.

$Alarm
The $Alarm item is of type TYPE_NUMBER and indicates the alarm is on. Set this value to 1.

$AlarmOffset
The $AlarmOffset item is of type TYPE_NUMBER and indicates when the alarm should ring (negative = x minutes before StartDateTime or positive = x minutes after).

$BusyName
The $BusyName item is of type TYPE_TEXT and contains the fully distinguished username of the person that is busy in that timeslot (ex. CN=Jane Doe/OU=CAM/O=Lotus) .

$BusyPriority
The $BusyPriority item is of type TYPE_TEXT and tells the scheduler whether this schedule event should be considered busy or free time:

"1" = Busy Value
"2" = Not Busy

$CSFlags
The $CSFlags item is of type TYPE_TEXT.

"m"= R5 repeat message
"i" = R5 repeat instance

$CSVersion
The $CSVersion item is of type TYPE_TEXT.

Non existent for 4.5/4.6 documents
"2" = R5 documents

$NoPurge
The $NoPurge item is of type TYPE_TIME and contains the ending date/time. This item prevents the note from being purged by replication before the schedule event has occurred. Use ConvertTextToTIMEDATE for the ending time string (ex. "03/16/2000 05:00 pm").

$PublicAccess
The $PublicAccess item is of type TYPE_TEXT and indicates if this scheduled event can be viewed by public:

"1" indicates this scheduled event can be viewed by the public
Skip this item to mark it as Private

_ViewIcon
The _ViewIcon item is of type TYPE_NUMBER and indicates what view icon to use. When creating an appointment, set this value to 160. See the Summary of Invitation Event Note Itemssection for the used value when creating a meeting invitation.

_ViewIcon2
The _ViewIcon2 item is of type TYPE_NUMBER. It is the secondary icon to display in a view column. See the Summary of Invitation Event Note Itemssection for the used value when creating a meeting invitation.

AppointmentType
The AppointmentType item is of type TYPE_TEXT and can be one of the following values:

"0" = Personal Appointment
"1" = Anniversary
"2" = Event
"3" = Meeting Invitation
"4" = Reminder

apptUNID
The apptUNID item is of type TYPE_TEXT and contains the Universal NoteID of the scheduled event.

Body
The Body item is of type TYPE_COMPOSITE and contains the scheduled event's detailed description.

BookFreeTime
The BookFreeTime item is of type TYPE_TEXT. It is the "Pencil in" check box in the Notes UI:

"" = the not checked "Pencil in" check box
"1" = the checked "Pencil in" check box

CalendarDateTime
The CalendarDateTime is of type TYPE_TIME and contains the start date/time of the appointment. Adding this item to the note causes the scheduled time to show up in the calendar view. Use ConvertTextToTIMEDATE for CalendarDateTime string (ex. "03/16/2000 09:00 am").

CHAIR
The CHAIR item is of type TYPE_TEXT and contains the fully distinguished username of the owner of the mail database that created the calendar entry (ex. CN=Jane Doe/OU=CAM/O=Lotus) .

CopyTo
The CopyTo item is of type TYPE_TEXT or TYPE_TEXTLIST and contains the scheduled event's optional invitee(s).

Delegator
The Delegator item is of type TYPE_TEXT and contains the fully distinguished username of the person delegating the event.

Delegee
The Delegee item is of type TYPE_TEXT and contains the fully distinguished username of the person the event is delegated to.

EndDate
The EndDate is of type TYPE_TIME and is the end date/time of the scheduled event. Use ConvertTextToTIMEDATE for CalendarDateTime string (ex. "03/16/2000 05:00 pm"). It is mainly used in the UI to display a single instance of a value from a multi-valued EndDateTime item. It is also used in some of the Calendar view display columns.

EndDateTime
The EndDateTime is of type TYPE_TIME or TYPE_TIME_RANGE and contains the end date/time of the scheduled event. Use ConvertTextToTIMEDATE for EndDateTime string (ex. "03/16/2000 05:00 pm").

EndTime
The EndTime is of type TYPE_TIME and contains the end date/time of the scheduled event. Use ConvertTextToTIMEDATE for CalendarDateTime string (ex. "03/16/2000 05:00 pm"). It is mainly used in the UI to display a single instance of a value from a multi-valued EndDateTime item. It is also used in some of the Calendar view display columns.

ExcludeFromView
The ExcludeFromView item is of type TYPE_TEXT and prevents the scheduled events that are not sent from showing up in the drafts view. The value of this item is "D".

Form
The Form item is of type TYPE_TEXT and determines what form to display. Set this value to "Appointment" when creating an appointment. When creating a meeting invitation, see the Summary of Invitation Event Note Itemssectionfor the required value.

FormToUse
The FormToUse item is of type TYPE_TEXT.

From
The From item is of type TYPE_TEXT and contains the fully distinguished username who created or sent it (ex. CN=Jane Doe/OU=CAM/O=Lotus).

NewEndDate
The NewEndDate is of type TYPE_TIME and is the new end date/time of the scheduled event.

NewEndTime
The NewEndTime is of type TYPE_TIME and is the new end date/time of the scheduled event.

NewStartDate
The NewStartDate is of type TYPE_TIME and is the new start date/time of the scheduled event.

NewStartTime
The NewStartTime is of type TYPE_TIME and is the new start date/time of the scheduled event.

NoticeType
The NoticeType item is of type TYPE_TEXT and can be one of the following values:

"I" = Invitation
"U" = Rescheduled
"C" = Cancelled
"N" = Confirmed
"A" = Accepted
"R" = Declined
"T" = Countered
"D" = Delegated
"L" = Delegate Invited

OptionalAttendees
The OptionalAttendees item is of type TYPE_TEXT and contains the fully distinguished username of the Optional invitees (ex. CN=Jane Doe/OU=CAM/O=Lotus).

ORGTABLE
The ORGTABLE item is of type TYPE_TEXT. It is set to "C0" for Calendar.

Principal
The Principal item is of type TYPE_TEXT and contains the fully distinguished username of the owner of the mail database (ex. CN=Jane Doe/OU=CAM/O=Lotus).

Recipients
The Recipients item is of type TYPE_TEXT or TYPE_TEXTLIST and contains the fully distinguished username(s) of all the invitees (ex. CN=Jane Doe/OU=CAM/O=Lotus).

RequiredAttendees
The RequiredAttendees item is of type TYPE_TEXT and contains the fully distinguished username of the Primary invitees (ex. CN=Jane Doe/OU=CAM/O=Lotus).

SendTo
The SendTo item is of type TYPE_TEXT or TYPE_TEXTLIST and contains the scheduled event's primary invitee(s).

SEQUENCENUM
The SEQUENCENUM item is of type TYPE_NUMBER and keeps the scheduled events ordered. Set this value to 1 initially.

StartDate
The StartDate is of type TYPE_TIME and is the start date/time of the scheduled event. Use ConvertTextToTIMEDATE for CalendarDateTime string (ex. "03/16/2000 09:00 am"). It is mainly used in the UI to display a single instance of a value from a multi-valued StartDateTime item. It is also used in some of the Calendar view display columns.

StartDateTime
The StartDateTime is of type TYPE_TIME or TYPE_TIME_RANGE and contains the start date/time of the scheduled event. Use ConvertTextToTIMEDATE for StartDateTime string (ex. "03/16/2000 09:00 am").

StartTime
The StartTime is of type TYPE_TIME and is the start date/time of the scheduled event. Use ConvertTextToTIMEDATE for CalendarDateTime string (ex. "03/16/2000 09:00 am"). It is mainly used in the UI to display a single instance of a value from a multi-valued StartDateTime item. It is also used in some of the Calendar view display columns.

StatusUpdate
The StatusUpdate item is of type TYPE_COMPOSITE and contains the scheduled event's status description.

Subject
The Subject item is of type TYPE_TEXT and contains the scheduled event's brief description.

Adding a Scheduled Event to a User's Schedule

This section describes how to use the C API to add an appointment or a meeting invitation to a User's schedule. Following are the basic steps and the corresponding API functions to perform this task. For details, refer to the AddSchedule() routine in the SCHEDULE sample program in the misc\schedule directory.

Note: The specified scheduled event time must be within a day's boundary.

1. Open the mail database (as specified on the command line) for a specified User. (NSFDbOpen)

2. Create a Note in the database (NSFNoteCreate).

3. Set the NOTE CLASS to NOTE_CLASS_DOCUMENT (NSFNoteSetInfo).

4. Allocate a buffer for data to copy each item's value to (OSMemAlloc).

5. Add each of the appropriate Items mentioned in the Components of Calendar and Scheduling section to the Note (NSFItemAppend).

6. Update the Note (NSFNoteUpdate).

7. Free the data buffer (OSMemFree).

8. Close the Note and the Database.

Deleting a Scheduled Event from a User's Schedule

This section describes how to use the C API to delete a scheduled event from a User's schedule. Following are the basic steps and the corresponding API functions to perform this task. For details, refer to the ScheduleTask() routine in the SCHEDULE sample program in the misc\schedule directory.

1. Create an empty text list data structure. (ListAllocate).

2. Add the current user to the list (ListAddEntry).

3. Retrieve the user's schedule container (SchRetrieve).

4. Get the first schedule in the container (SchContainer_GetFirstSchedule).

5. Get the busy time information from the schedule (Schedule_ExtractBusyTimeRange).

6. Attempt to find the "scheduled event to delete" time in the data returned.

7. If the time is found get the schedule list of the user (Schedule_ExtractSchedList).

8. Attempt to find the scheduled event time in the schedule list returned.

9. If the entry is found delete the note.

Query a User's Busy/Free Time Information

This section describes how to use the C API to query a user's busy/free time information. Following are the basic steps and the corresponding API functions to perform this task. For details, refer to the ScheduleTask() routine in the SCHEDULE sample program in the misc\schedule directory.

Note: The specified time range may extend past a day's boundary.

1. Create an empty text list data structur (ListAllocate).

2. Add the current user to the list (ListAddEntry).

3. Retrieve the user's schedule container (SchRetrieve).

4. Get the first schedule in the container (SchContainer_GetFirstSchedule).

5. Get the free time information from the schedule (Schedule_ExtractFreeTimeRange).

6. Get the busy time information from the schedule (Schedule_ExtractBusyTimeRange).