Notes/Domino Calendaring & Scheduling field descriptions

Technote (FAQ)


Question

What fields are associated with documents used with the Calendaring & Scheduling feature of Notes/Domino?

Answer

NOTE: This document has been superseded by an extensive wiki article that is maintained with current data. Refer to "IBM Lotus Notes and Domino Calendaring & Scheduling Schema" at http://www.lotus.com/ldd/ddwiki.nsf/dx/cs_schema_toc

The table below describes each field used in IBM Lotus Notes/Domino Calendaring & Scheduling (C&S) documents, providing field type, use, and valid values as appropriate.


First, some facts about Form names and their usage:

1: Non-workflow C&S entries (Appointments, Reminders, All Day Events, Anniversaries) use the Form name "Appointment".

2: Workflow C&S entries may have 1 of 2 possible values for the Form name, depending on their current state:

    A: If the entry is "in process" (that is, if it is still in the Inbox and has not actually been acted upon), then the value it has is "Notice".
    B: If the entry is "processed" (it may be in the Inbox or not but it has already been acted upon, such as Accepting it), then the value is "Appointment".

3: Non-workflow Tasks (that is, Personal Tasks) use the Form name "Task".

4: Workflow tasks (Group Tasks) may have 1 of 2 possible values for Form, depending on their current state:
    A: If the entry is "in process" (if it is still in the Inbox and has not actually be acted upon), then the value it has is "TaskNotice".
    B: If the entry is "processed" (it may be in the Inbox or not but it has already been acted upon, such as Accepting it), then the value is "Task".

Field Description
$Alarm An alarm is configured on 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.
$AlarmDescription The text to display when the alarm triggers.
$AlarmDisabled An alarm is configured BUT disabled. This item is mutually exclusive with $Alarm so if $Alarm is set, $AlarmDisabled MUST NOT be set. The only valid value is 1; the item should NOT be present otherwise.
$AlarmMemoOption A flag to indicate to whom an email notification should be sent. This item will control whether or not 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. No email notifications are to be sent.
1 = Event participants only. Email notifications are sent only to the participants of record on the entry and no one else.
2 = Listed names. The name(s) in $AlarmSendTo are to be sent an email notification upon triggering.
$AlarmOffset 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. 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).
$AlarmSendTo The list of users (or groups) to whom an email notification should be sent when the alarm triggers.
$AlarmSound The 'name' of the sound to play when the alarm triggers. This is NOT the path to a .WAV or other sound file; it is the 'system' name for a sound.
$AlarmTime The specific time that the alarm is to trigger. This item indicates that the alarm triggers at a specific time rather than relative to the start of the entry and as such MUST not exist if there is an $AlarmOffset item.
$AlarmUnit Indicates the unit of time that the $AlarmOffset is in. The default units (if no value here is specified) is Minutes.
Valid choices are:
M = Minutes (Default)
H = Hours
D = Days
Any other values are ignored and the default Minutes is used instead.
$ApprovalList A list of users who are allowed to do busytime lookups on a particular user. This item is used only on calendar profiles.
$AvailableDays 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.
$BusyName Indicates who the entry is for and for whose busytime it should affect. MUST be a single canonical name of a user or resource.
$BusyPriority "Pencilled-in" value affecting busytime searches:
1 = Busy
2 = Transparent (free)
Default = Busy if the item is not found or is empty.
$CSFlags Flags used to control C&S operations. Multiple values are allowed; they are simply concatenated into a single string. There are at most 32 flags allowed on any entry.
Valid values are:
c = Repeat instances have been created
e = Document is a repeat exception
f = Event is managed entry
h= Holiday, placed by ImportHoliday 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 R5.x+ repeating entry
r = Document is a request for information
u = Document is updated information
w = Event is workflow enabled
$CSVersion Indicate that this entry was generated by an R5 (or "2nd generation" C&S) template.
R4.x: NOT present; MAY be '0' as well.
R5.x+: MUST be "2" by default.

This item is NOT present on pre-R5.x generated entries and may be different on R6.x or later entries if the C&S architecture changes sufficiently to warrant it.
0 = Pre R5.x entry
2 = R5.x entry; new repeating entry format
$ExpandGroups Used by the Mailer to decide if local people and groups should be expanded. It is 'On' by default.
0 = Do NOT expand groups
1 = Expand local groups only
2 = Expand public groups only
3 = Expand local and public groups
$JournalResponsibility If present, message should be journaled. The value indijournaledt should be journalled locally or on another server.
0 = Do not journal
1 = Journal locally
2 = Journal remotely
3 = Journal complete. This flag signals the message can be removed from MAIL.BOX.
$PrevBusyName Used to 'fix' a case where resource entries are moved between resources w/in the same database. Previously there was no way to indicate that a different resource/room was used and as such, they were not being 'unbooked' and made available to others. This item should appear ONLY on entries that have had their $BusyName values changed for some reason.
$PreventReplies 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. This is valid only for R5.x or later versions.
$PublicAccess Used to make the entry public. Notes C&S is based on allowing delegates (Admin Assistants) the ability to see one's Calendar but not their mail file. This is done by making C&S entries "public". ALL C&S entries should have this (unless the user desires them to be 'private').
$Times1 A TIMERANGE of hours that the user works on Sunday. This item is used only on calendar profiles.
$Times2 A TIMERANGE of hours that the user works on Monday. This item is used only on calendar profiles.
$Times3 A TIMERANGE of hours that the user works on Tuesday. This item is used only on calendar profiles.
$Times4 A TIMERANGE of hours that the user works on Wednesday. This item is used only on calendar profiles.
$Times5 A TIMERANGE of hours that the user works on Thursday. This item is used only on calendar profiles.
$Times6 A TIMERANGE of hours that the user works on Friday. This item is used only on calendar profiles.
$Times7 A TIMERANGE of hours that the user works on Saturday. This item is used only on calendar profiles.
$WorkDays A list of 1-based days (1 = Sunday, 2 = Monday, etc) that indicates what days the user works. This is mainly view related and may not be used by actual workflow code. This item is used only on calendar profiles.
_ViewIcon The icon to display in the calendar views for the entry.
9 = Event
10 = Confirmation or Reminder
11 = Information
33 = Reschedule
38 = Counter decline
39 = Counter propose
63 = Anniversary
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 = Todo
AltDelegeeName The alternate name of the reply to address/user being delegated to. This is used only when delegating an entry to someone and it contains their alternate name.
AltFYINames The alternate name(s) of FYI users on the entry. This list contains the alternate name(s) of any FYI attendees to an entry. It is organized just like mail alternate names are.
AltOptionalNames The alternate name(s) of optional users on the entry. This list contains the alternate name(s) of any optional attendees to an entry. It is organized just like mail alternate names are.
AltRequiredNames The alternate name(s) of required users on the entry. This list contains the alternate name(s) of any required attendees to an entry. It is organized just like mail alternate names are.
AnniversaryLead The default amount of time before an Anniversary starts 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 SetAlarmAnniversary = 1. This item is used only on calendar profiles.
AppendStartTime This value is used to change/override the calculated StartTime value of an entry.
AppointmentLead 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.
AppointmentType Indicates the Calendar entry type.
0 = Appointment
1 = Anniversary or Personal ToDo
2 = Event or Group ToDo
3 = Meeting
4 = Reminder
ApptUNID A textual version of the entries original/real UNID. This item was added in R5.x+ to deal with the case that 1 meeting gets sent to 2 users and can wind up with different UNIDs upon arrival (ie: 1 user Prefers MIME and 1 Prefers RTF). The solution, added some time around R5, was to tag the original entry's UNID along as a separate field that we used instead of the document's UNID. This also allows us to better deal with iCalendar and its UID. Generally this item should be the UNID converted to text but it could also be the iCalendar UID or some other value. The intent is to move away from relying on UNID values and to rely on ApptUNID instead.
ApptUNIDURL The URL used to attend the online meeting place on the Sametime server. The value is calculated during the save process. This item exists only if the Form value is "Notice" or "Appointment". Valid values are any URL and the default is "".
AssignedTo A list of users a task is assigned to. This is the task equivalent of RequiredAttendees and should be treated correspondingly.
AssignState Used by tasks for communicating status.
Attendees List of people where OrgState, OrgStatus and Optional applies to.
AudioVideoFlags The audio/video options for use by Sametime. This item exists only if the Form value is "Notice" or "Appointment". Valid values are:
"0" = None (Default)
"1" = Audio only
"2" = Video only
"3" = Audio and Video
AudioVideoSelectionList The audio/video options available to a user based on the Online meeting place. The value is calculated when a user selects an Online Meeting Place. This item exists only if the Form value is "Notice" or "Appointment".
Valid values are:
"Notice" or "Appointment". Valid values are:
"" = Default; no options specified
"Audio | 1" = Audio only
"Video | 2;" = Video only
"Audio and Video | 3;" = Audio & Video
"Audio | 1;Audio and Video | 3;" = Audio only or Audio & Video
"Video | 2;Audio and Video | 3;" = Video only or Audio & Video
AutoprocessForwardTo The name of a user to forward C&S entries to for this resource. This item is used only on calendar profiles for resources, not users.
AutoprocessMeetings Items whose presence indicates if a request has been autoprocessed or not. This item is used only on calendar profiles for resources, not users.
AutoprocessType The list of autoprocessing options the user has set. This item is used only on calendar profiles for resources, not users. Valid values are:
0 = All users can automatically process the request
1 = The request must be forwarded to the owner
2 = The request can be handled by users in AutoprocessUserList
3 = The request can be handled by a lists owner
4 = Autoprocessing is not allowed for that user
7 = Like 0 and 2 in that you automatically process meeting requests. Supports using "When a meeting invitation is received from" selection to decide which requests to do (Anyone/Any of the following people/Anyone except the following people). Really only used for "Anyone but" because we map "Anyone" and "Only Some" to 0 and 2 on-disk, respectively, to maximize backward compatibility.
8 = Use like 1 in that you specify a delegate for your meeting requests. Supports using "When a meeting invitation is received from" to decide which requests to do (Anyone/Any of the following people/Anyone except the following people). Used for "Any of the following people" and "Anyone except the following people" but not "Anyone" because we map "Anyone" to 1 on-disk to maximize backward compatibility
D = Autoprocessing is disabled
AutoprocessUserList A list of user(s) who are allowed to autoprocess resource requests. This item is used only on calendar profiles for resources, not users.
AutoRemoveFromInbox 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). This item is used only on calendar profiles.
Broadcast Used by the Chair to indicate they do not want to receive any responses back. Valid values are:
1 = Broadcast, do not RSVP
Any other value = RSVP (Default)
CalendarDateTime A date & time value when the entry should show up in the calendar view. An entry being sent to someone else MUST NOT have a CalendarDateTime on it. An entry that "no longer belongs in the calendar view" MUST NOT have a CalendarDateTime on it. Mainly, the presence of this item is used to indicate that it belongs in the Calendar view and when it should appear.
Chair The name of a user who is chairing or organizing the entry. MUST be a single canonical name of a user and NOT a list.
ChairDomain The Chairperson's Notes domain. This is necessary for doing C&S across multiple domains.
CompletedDateTime The UTC (Coordinated Universal Time) date and time a task was completed.
ConferenceDatabase The name of the Notes database on the Sametime server where the online meeting documents will be stored. This item exists only if the Form value is "Notice" or "Appointment". The value is taken from the Domino Directory view: $OnlineMeetingPlaces. Default value is "stconf.nsf".
ConflictMeeting Indicates if the user wants to be notified if Meetings/Appointments conflict with other entries. This item is used only on calendar profiles.
DefaultDuration The default duration for entries to have. This item is used only on calendar profiles.
Delegator The name of the user who delegated the entry. Valid values are any single canonical name of any user.
Delegatee The name of the user who is being delegated the entry. Valid values are any single canonical name of any user.
DueDate The UTC date (& time) a task is due. It is derived from DueDateTime and is typically the same for non-repeating entries. For repeating entries, this will be a particular date (& time) for a single instance.
DueDateTime The UTC date & time the task is due. For repeating entries, this will be a TIMERANGE that contains the list of all due dates & times.
DueState A tasks current 'due' state. Valid values are:
0 = Overdue; the DueDate is in the past
1 = Currently due; the StartDate is in the past
2 = Future; the StartDate is in the future
EnableAlarms User's preference if they want automatic alarms enabled at all. This item is used only on calendar profiles.
EndDate 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 EndTime even though they both share the same information because a user interface (UI) change for R5 to split the 'combo' Date/Time picker into 2 separate items requires 2 separate items. For repeating entries, this will be a particular date (& time) for a single instance.
In the rescheduling case, this will be the new date (& time) the base instance is being moved to; the original date (& time) is in OriginalEndDate.
EndDateTime The UTC date & time the entry ends. For repeating entries, this will be a TIMERANGE that contains the list of all end dates & times.
EndTime 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 R5 to split the 'combo' Date/Time picker into 2 separate items requires 2 separate items. For repeating entries, this will be a particular (date &) time for a single instance.
EventLead The default amount of time before an All Day Event starts 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 SetAlarmEvent = 1. This item is used only on calendar profiles.
ExcludeFromAll Used to indicate if the user wants to exclude new calendar entries from the All Documents view. This item is used only on calendar profiles.
ExcludeFromSent Used to indicate if the user wants to exclude new calendar entries from the Sent view. This item is used only on calendar profiles.
ExcludeFromView 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 C&S are:
A = All Documents ( $All) view
D = Drafts
S = Sent
fDisplayAltTimeZone Used to flag whether or not to display an alternate timezone. MUST be either TRUE or FALSE. This item is used only on calendar profiles.
FYIAssignedTo A list of users a task is not assigned to but who should know about it. This is the task equivalent of FYIlAttendees and should be treated correspondingly.
FYIAttendees A list of users who are not involved in the scheduling process but should know about it. The value is a list of canonical names of users and/or groups. There is no workflow involved w/those listed, they are strictly told about the entry but do not participate. An example of this may be the meal service at a company so they can plan lunches accordingly for a meeting.
IncludeMailDb Used to see if we should send workflow messages to a Mail-In dB. This item is used only on calendar profiles.
INetSendTo The list of RFC822 email addresses of the RequiredAttendees. This is a list that MUST match the size of the RequiredAttendees and the values correspond to the matching entries.
KeepPosted Determines if participant wants to be kept notified of updates.
0 = Do not want further updates (Default if missing)
1 = Do want further updates
MeetingType One of the Sametime meeting types. This item only occurs if the Form value is "Notice" or "Appointment". Valid values are:
"1" = Collaboration (Default)
"2" = Moderated
"3" = Broadcast
Moderator The moderator of the Sametime meeting (Note: This does not have to be the same person who schedules the meeting). This item only occurs if the Form value is "Notice" or "Appointment". Valid values is a Notes canonical name (i.e.: "CN=Bob Doe/O=Acme").
NewDate The counter proposed UTC date (NOT time) for an entry. This was obsoleted in R5.x but for backwards compatibility, the code will automatically create this item and initialize it when talking to a pre-R5.x user/server.
NewEndDate The counter proposed UTC end date (NOT time) for a new DueDate or EndDate.
NewEndTime The counter proposed UTC end time (NOT date) for a new EndDate. Since tasks have no EndTime, there is no equivalent for it.
NewStartDate The counter proposed UTC end date (NOT time) for a new StartDate. Although this information could be merged into 1 item with NewStartTime, there are R5 historical reasons for the creation of StartDate and StartTime so we need 2 items to convey the counter proposal to the Chair.
NewStartTime The counter proposed UTC end time (NOT date) for a new StartTime. Although this information could be merged into 1 item with NewStartTime, there are R5 historical reasons for the creation of StartDate and StartTime so we need 2 items to convey the counter proposal to the Chair. Since tasks have no StartTime, there is no equivalent for it on tasks.
NewTimeRange The counter proposed UTC time (NOT date) for an entry. This was obsoleted in R5.x but for backwards compatibility, the code will automatically create this item and initialize it when talking to a pre-R5.x user/server.
NoticeType Type of notice being sent (MAIL_CS_NOTICETYPE_ITEM). 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. Valid values are:
2 = Chair is requiring user to attend
5 = Chair is removing user from list
9 = Template wants to close the outgoing notice; May NOT be stored on disk
A = User accepted request
B = Chair has accepted a counter proposal; message goes out as a "U"
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
F = User has completed request todos
G = User wants to add event to calendar; May NOT be stored on disk
H = Users is deleting event
I = Used for initial event request
J = Chair declines counter-proposal request
K = Chair is sending updated info to all invitees
L = User is delegating request; sent to delegate
N = Event is being confirmed by chair
P = User has tentatively accepted
Q = Autoresponse from R&R when lookup problem
R = User declined request
S = Status update from chair; Used strictly for removing an invitee
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/stmeetings
Z = User has been removed; May NOT be stored on disk
OnlinePlace Name of the online place found in the Domino Directory. Note: this is where the name is stored AFTER auto processing has been run. This item only occurs if the Form value is "Notice" or "Appointment". Values are taken from the list of Online meeting places in the Domino Directory and are in Notes canonical format (ie: "CN=Online1/O=Westford"). Default value is "".
OnlinePlaceToReserve Name of the online place found in the Domino Directory. Note: this is where the name is stored BEFORE auto processing has been run. This item only occurs if the Form value is "Notice" or "Appointment".Values are taken from the list of Online meeting places in the Domino Directory and are in Notes canonical format (ie: "CN=Online1/O=Westport"). Default value is "".
OptionalAssignedTo A list of users a task is optionally assigned to. This is the task equivalent of OptionalAttendees and should be treated correspondingly.
OptionalAttendees A list of users who are optionally required to participate in an event. The value is a list of canonical names of users and/or groups. There is workflow involved w/those listed, they are expected to participate.
OrgConfidential Used to tell if the entry is 'private' or not. This is also shared with Lotus Organizer. Further investigation is necessary.
OrgRepeat Used to flag an entry as repeating or not. If the OrgRepeat item is valid, this is a repeating entry.
OrgState Chairman, attendee, resource. If this is for a room, make sure we have the correct # of people. Valid values:
0 = A person
5 = A room
6 = A resource
7 = A Sametime meeting
OrgStatus These are set when the Chair sends a message to one or more attendees. They are NOT set when sending back to the Chair. Valid values are:
2 = Chair is requiring user to attend
5 = Chair is removing user from list
OrgTable This item is used to tell Lotus Organizer which section an entry should be displayed in. Since Organizer can have > 1 calendar, Notes defaults to using the first one by ALWAYS putting a "C0" into this item.
OriginalEndDate The original UTC end date & time of the repeat instance that is being rescheduled. This is necessary to have when rescheduling a single (or more) repeating entry so that Notes knows which one to use as the base reference point.
OriginalStartDate The original UTC start date & time of the repeat instance that is being rescheduled. This is necessary to have when rescheduling a single (or run of) repeating entry so that Notes knows which one to use as the base reference point.
Owner Owner field in a calendar profile. This value is used to 'reset' the $BusyName value of any workflow the user accepts (so that we have a consistent place to get it from).
ParentRepeatDates The 'current' set of repeating dates & times including all reschedules to that point. This will be different from ParentRepeatDates if entries have been rescheduled. See RepeatDates for more details on the usage (though its use on a 'parent' document MAY be slightly different).
ParentRepeatInstanceDates The 'original' set of repeating dates & times from when the entry was created. This will be different from ParentRepeatDates if entries have been rescheduled. See RepeatInstanceDates for more details on the usage (though its use on a 'parent' document MAY be slightly different).
Presenters For broadcast Sametime meetings only; the people who are allowed to present in the meeting. This item exists only if the Form value is "Notice" or "Appointment". Valid values are Notes canonical names that the user chooses (ie: "CN=Jane Doe/O=Acme"). Default value is "".
PreventCounter Used to indicate 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 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
Purpose This is used to indicate the Topic of a resource reservation. It is copied from the Topic item when updating resource reservation documents, presumably by the autoprocessing code. The value is copied only if the entry has $PublicAccess = 1 on it. Since this should always be the case, the value SHOULD always be copied.
ReminderLead The default amount of time before the scheduled time of a Reminder that the alarm should trigger. The value MUST be in minutes and not other units. The value is only of use when SetAlarmReminder = 1. This item is used only on calendar profiles.
RepeatAdjust Text list describing the days/dates the rule should use to calculate the list of repeat dates & times (ex: Monday, 1st of the Month). Not all repeat for unit types require this parameter; currently only RepeatForUnit = "W" (weekly) and RepeatForUnit = "M" (monthly).
RepeatDates The set of repeating dates & (start) times that the entry repeats for. The end date & times are not specified on another item. Rather they are derived by shifting the list of start date & times by the entry duration. The presence of this item or of OrgRepeat is what truly signifies an entry is repeating, NOT any other checks. This item was populated by the underlying code by 'exploding' the entries rule. This is a peer item to ParentRepeatDates and depending on some scenarios, one 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.
RepeatFor The number of RepeatForUnits that the entry repeats for. This value is a positive integer. Any zero or negative values are automatically treated as 1.
RepeatForUnit The 'unit' of time that the repeat rule is for. Valid values are:
C = Custom set of explicit dates
D = Daily or a particular month date when used after "M" (Repeat Monthly).
M = Monthly. If Monthly then the second character of the MUST be either "D" (repeat monthdate) or "P" (repeat monthday) making this value really either "MD" or "MP"
P = A particular month day
W = Weekly
Y = Yearly
Note: While this is a TYPE_TEXT ONLY the 1st character is currently used/checked.
RepeatFromEnd Flag to indicate if 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 (i.e., values in RepeatAdjust are relative to the end of the month)
All other values (or missing) = Start from the beginning of the month
RepeatHow Indicates 'how' the user wanted the repeat set to be terminated; 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.
RepeatInstanceDates The set of dates & times that are effected 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 effected like cancelling 'this and all future' instances. This item is copied at creating 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 may be used in place of the other. When creating an outgoing message, this item is the 'primary' to RepeatDates. If RepeatInstanceDates is not present then RepeatDates is sent instead.
RepeatInterval The interval at which the rule applies. Only positive integer values are valid. The value is used in conjunction with RepeatUnit to decide get to the next repeat date for an entry.
RepeatStartDate The starting date of the repeating entries. The starting time is actually pulled from either the StartTime item (or from EndTime / DueDateTime if calculating the proper end time).
RepeatUnit The 'unit' of time that the entry repeats over.
Valid values are:
C = Custom set of explicit dates
D = Daily or a particular month date when used after "M" (repeat monthly).
M = Monthly. If Monthly then the second character MUST be either "D" (repeat monthdate) or "P" (repeat monthday), making this value really either "MD" or "MP".
P = A particular month day
W = Weekly
Y = Yearly
RepeatUntil The UTC date (& time) that the entry set repeats until. Since Notes does not currently have the concept of a repeat set that happens more than once a day (ex: "Repeat @ 9AM and 3PM every day for a week"), the time subvalue is not used or necessarily set properly. This item is meaningful only if the RepeatHow is set to "U" (repeat until).
RepeatWeekends Indicates what, if anything, should happen to a repeat instance that occurs on a weekend. This item's value is checked only in some cases of repeating entries. As of R5.x+, this item is used only if RepeatForUnit = "D" (daily), RepeatForUnit = "M" or "MD" (monthly or monthdate) or RepeatForUnit = "Y" (yearly). All other types of repeat sets do not cause this value to be useful.
Valid values are:
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 (forwards or backwards
X = Remove weekend occurrence from the repeat set
D = UNKNOWN
RequiredAttendees A list of users who are definitely required to participate in an event. The value is a list of canonical names of users and/or groups. Those listed are definitely expected to participate.
RequiredResources Possible usage: A list of resources the Chair wants/needs to have. This item is semi interchangeable with Resources, depending on the type of Notice being sent. If Notice is "I" (initial event request) then Resources is the item to set. Otherwise, RequiredResources is the item to set. This implies there is some kind of item swapping in the template. It may be that RequiredResources is the name of the 'persistent' cache of requested resources while Resources is the current version being edited/saved.
For repeating entries, this entry is stored on the individual child document(s).
RescheduleWhich Indicates which repeat entry or range of entries is being modified/cancelled.
0 = Current (single) instance only
1 = All instances
2 = Current and all previous
3 = Current and all future
-1 = User cancelled modifying repeat
ResourceOwner The name of the user who 'owns' a resource. This item is used to indicate who must manually approve a reservation for the resource. The value must be a name of someone where the request will be forwarded to for approval/rejection.
RestrictAttendence Flag to indicate whether or not a Sametime meeting is restricted to only those people/groups in the restricted list. This item exists only if the Form value is "Notice" or "Appointment". Valid values are:
"0" = No (Default; do not restrict attendance)
"1" = Yes (Restrict attendance)
RestrictToInviteList The list of users/groups that are allowed to attend this Sametime meeting. The list of names are the people/groups in the From, Moderator, SendTo, CopyTo, BlindCopyTo fields. This item exists only if the Form value is "Notice" or "Appointment". Valid values are any list of Notes canonical names (ie: "CN=Jane Doe/O=Acme, CN=John Public/O=Acme"). Default value is ""
SametimeServer Name of the Sametime server where the meetings will take place. This item exists only if the Form value is "Notice" or "Appointment". Values are taken from the Domino Directory and are required to be in the Notes canonical format (i.e., "CN=sametimeserver.ibm.com/O=Acme"). Default value is "".
SametimeServerNetAddress The IP address of the Sametime server. This item exists only if the Form value is "Notice" or "Appointment". Values are obtained originally from the Notes directory. Valid values are any DNS name or IP address. Default value is "".
SendAttachments Flag to indicate whether or not the people who are invited to the Sametime meeting receive the attachments that will appear in the online meeting. This item exists only if the Form value is "Notice" or "Appointment". Valid values are:
"0" = No (Default)
"1" = Yes
SequenceNum Sequence number of event notice. This closely behaves the same as the iCalendar SEQUENCE property in that it is incremented when changes that affect the workflow are done such as a change in start or end time. Cosmetic and other minor changes (ex: changing text in Subject) is not grounds for increasing SequenceNum as that invalidates all the replies we get back to the old SequenceNum without any need.
Replies to a different SequenceNum are NOT valid and should not be used as the sender may be looking at an entirely different request (or repeat set). In these cases, the Chair (or the Autoprocessing agent) should send a new notice to the invitee. Care should be given when doing this, so that someone does not forge their attendance and then send a reply to trigger the Chair sending them information they should not see.
SetAlarmAnniversary Profile item to indicate whether or not to automatically set alarms on an anniversary. This item is used only on calendar profiles. Valid values are:
1 = Enable automatic alarms on anniversaries (the alarm lead time is in AnniversaryLead)
Any other value (or missing) = Disable automatic alarms on anniversaries
SetAlarmAppointment Profile item to indicate whether or not to automatically set alarms on an appointment. This item is used only on calendar profiles. Valid values are:
1 = Enable automatic alarms on appointments (the alarm lead time is in AppointmentLead)
Any other value (or missing) = Disable automatic alarms on appointments.
SetAlarmEvent Profile item to indicate whether or not to automatically set alarms on an All Day Event. This item is used only on calendar profiles. Valid values are:
1 = Enable automatic alarms on all day events (the alarm lead time is in EventLead)
Any other value (or missing) = Disable automatic alarms on all day events
SetAlarmReminder Profile item to indicate whether or not to automatically set alarms on a reminder. This item is used only on calendar profiles. Valid values are:
1 = Enable automatic alarms on reminders (the alarm lead time is in ReminderLead)
Any other value (or missing) = Disable automatic alarms on reminders.
SetAlarmTask Profile item to indicate whether or not to automatically set alarms on a task. This item is used only on calendar profiles. Valid values are:
1 = Enable automatic alarms on tasks (the alarm lead time is in TaskLead)
Any other value (or missing) = Disable automatic alarms on tasks.
StartDate 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 they both share the same information; this is because of a user interface (UI) change/requirement for R5 to split the 'combo' Date/Time picker into 2 separate items. For repeating entries, this will be a particular date (& time) for a single instance. In the rescheduling case, this will be the new date (& time) the base instance is being moved to; the original date (& time) is in OriginalStartDate.
StartDateTime The UTC date & time the entry begins. For repeating entries, this will be a time range that contains the list of all start dates & times.
StartTime 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 they both share the same information; this is because of a UI change/requirement for R5 to split the 'combo' Date/Time picker into 2 separate items. For repeating entries, this will be a particular (date &) time for a single instance.
Status The 'status' of the entry as decided by the Chair.
StatusUpdate Contains text for the "accept/decline/delegate with comment" features. Used on a response from an invitee, not on messages from the Chair to invitees; that is what the Body item is used for (also known as the "description").
Subject The 'composited', or built up, "Subject" line that should be used on emails and in some views. It is built from the entry type (Invitation, Cancel, etc) and the Topic value.
TaskLead 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
tmpRemoveNames A text list of people to remove from an entry. Once a Chair "uninvites" an invitee, their canonical name should be placed into this field so that the code can properly remove them from all the assorted lists they may be on. This item should not appear on any "on disk" note since it should be removed once the names are properly removed from the assorted lists.
tmpRepeatConflictDates A list of dates & times that are 'conflicts' and should be removed from a rule generated set of dates. This item holds a time list of dates & times that are considered to 'conflict' and should not be generated by the entries repeat rule settings. It is doubtful that this item should appear on any "ondisk" note but there is no code to remove it once the value is used.
Topic The 'base' single line description of the entry. It is used to both build up the Subject item as well as in some views or when rendering the entry itself.
Uninvited An internally maintained list of names of removed users. This list is maintained so that Notes may allow 're-inviting' of a user and can keep some prior information about them. It is found only on the Chair's copy of an entry, not on anyone else or on any invitation.
WhiteBoardContent The attachments that are presented in the white board during the online meeting. This item exists only if the Form value is "Notice" or "Appointment". Values are files that the user chooses. Note: This works in conjunction with $FILE field and the default value is no attachments.


Rate this page:

(0 users)Average rating

Document information


More support for:

Lotus End of Support Products
Lotus Notes

Software version:

6.0, 6.5, 7.0

Operating system(s):

Linux, Windows

Reference #:

1229486

Modified date:

2009-03-20

Translate my page

Machine Translation

Content navigation