This chapter describes LDAP object classes and attributes for Communications Express and the Personal Address Book for Communications Express.
The chapter is divided into two sections:
One object class is used to provision Communications Express: sunUCPreferences.
The attributes used to provision Communications Express are as follows.
Used to extend a user entry with attributes required for storing Communications Express preferences.
top
auxiliary
Unknown
None
sunUCTheme,sunUCDefaultEmailHandler,sunUCDateFormat,sunUCDateDelimiter,sunUCTimeFormat,sunUCTimeZone,sunUCExtendedUserPrefs:,sunUCExtendedUserPrefs:,sunUCInitialized,sunAbInitialized,sunAbInitialized,sunCalInitialized
These Object Classes describe the attributes used in the entry which serves as the base of every user's Personal Store (Address Book collection). Root entries for a user's address book store are created using the structural object class. The following object classes are used to create address book entries. These object classes include nodes for creating the address book store, contact entries, group entries and resource entries.
Communications Express 6.2
Used to create the root node of an address book store root node for a user.
top
structural
Unknown
piMaxStoreEntries, piDefaultAB, lastPurgeDate
Messaging Server 6.0 with LDAP Schema 2
Used to create a basic address book entry. This entry is extended by piAddressBook and piLocalBook object classes.
top
structural
Unknown
displayName, multilineDescription, piLastModifiedBy
Used to store the access control values for an address book entry and book type. This class is typically used to extend an address book node created using piAddressBook object class and the attributes are used to specify access control granted by a user to other users.
piTypeBook
auxiliary
Unknown
None
piReader, piWriter, piDeleter, piCreator, abBookType
Used to store the attributes necessary for a remote address book server. These are typically corporate address books shared by users and have shared and read-only access.
piTypeBook
auxiliary
Unknown
None
All address book entries are created using this structural object class. The basic entry can be further extended by specific object classes for users (to represent an individual contact entry) and groups (to represent an address book group).
top
structural
Unknown
displayName, memberOfPIGroup, multilineDescription, piLastModifiedBy, memberOfPIBook, deleted, piPEntryXMLData, piPEntryTextData, attachment
Used to extend the base entry created by piEntry. Entries extended using this object class are used to represent an individual contact entry.
piEntry
structural
Unknown
None
piBackPointer, givenName, sn, middleName, nickname, jobTitle, company, ou, campus, building, floor, officeNumber, piPhone1, piPhone2, piPhone3,piPhone4,piPhone5, piPhone1Type,piPhone2Type,piPhone3Type,piPhone4Type,piPhone5Type,piAdditionalPhone,piEmail1,piEmail2,piEmail3,piEmail1Type,piEmail2Type,piEmail3Type,piEmail1CN,piEmail2CN,piEmail3CN,piEmail1TransType,piEmail2TransType,piEmail3TransType,piWebsite1,piWebsite2,piWebsite1Descr,piWebsite2Descr,inetCalendar,inetFreeBusy,piIM1ID,piIM2ID,piIM3ID,piIM1Service,piIM2Service,piIM3Service,homePostalAdddress,homeCity,homeState,homePostalCode,homeCountry,homePOBox,workPostalAddress,workCity,workState,workPostalCode,workCountry,workPOBox,otherPostalAddress,otherCity,otherState,otherPostalCode,otherCountry,otherPOBox,anniversary,dateOfBirthotherDate,otherDateDescr,mailingAddress,photoURL,notes,assistantName,department,fullName,gender,location,manager,profession,spouse,suffix,title,alarmflag,alarmstatus,alarmtime,alarmtopic
Used to extend the base entry created by piEntry. Entries extended using this object class are used to represent an address book group entry.
piEntry
structural
None
piEmail1, piWebsite1, piWebsite1Descr,inetCalendar,inetFreeBusy
Used to create an entry to represent a conference room entry. This object class is intended to be used for entries in the users’ personal address book store. The corresponding object class used in the corporate LDAP to represent a generic resource entry (including a conference room) is icsCalendarResource.
Since users may find resources in the corporate LDAP directory and decide to add them to their personal address book, you need to map the values from icsCalendarResource to the attributes in piTypeABConferenceRoom. As of now, calendar server has no typing information in the icsCalendarResource entry to indicate what type of resource is represented by LDAP entry. Hence we should assume that the corporate entry is for a conference room. The following table shows the mapping of attributes.
Table 7–1 Mapping of attributes
icsCalendarResouce |
piTypeABConferenceRoom/piEntry |
---|---|
cn |
displayName |
description |
multilineDescription |
icsCapacity |
sunConfRoomCapacity |
none |
campus |
none |
building |
none |
floor |
none |
officeNumber |
icsCalendar |
inetCalendar |
none |
inetFreeBusy |
icsContact |
contactPerson |
piEntry
structural
Unknown
None
telephoneNumber, sunConfRoomCapacity, building,floor,officeNumber,inetCalendar,contactPerson
The following attributes are used by Communications Express to provision users
Communications Services 6 2006Q2 Communications Express
Single-value
Specifies the name of user interface theme used to display all localizable resources. The list of resources include text labels, icons, color schemes, and so on. Communications Express 6.0 supports only domain-wide themes and not user-specific themes.
Unknown
Communications Services 6 2006Q2 Communications Express
Single-value
Specifies the default mail handler for all mail links. The valid values are as follows:
uc - If the value is uc, Communication Express' mail compose feature is used to compose a new message.
desktop - If the value is desktop, the default mailto: handler as specified by the desktop operating system is used to compose a new message.
Unknown
Communications Services 6 2006Q2 Communications Express
Single-value
Specifies date display and input format. Valid formats are: Y/M/D, M/D/Y and D/M/Y.
Unknown
Communications Services 6 2006Q2 Communications Express
Single-value
Delimiter is the character that separates date, month and year in the date. The options available are: “.”, “/”, “-”.
Unknown
Communications Services 6 2006Q2 Communications Express
Single-value
Specifies the time display format. Valid formats are: 12 hour clock, 24 hour clock
Unknown
Communications Services 6 2006Q2 Communications Express
Single-value
Specifies the time zone used to normalize all time/date information in the client.
Unknown
Communications Services 6 2006Q2 Communications Express
Single-value
Used to extend stored client preferences.
Unknown
Communications Services 6 2006Q2 Communications Express
Single-value
Specifies whether the user has previously logged into Communications Express. When a user logs in for the first time, this value is set to true. If this entry is absent in LDAP, the value is set to false.
Unknown
Communications Services 6 2006Q2 Communications Express
Single-value
Specifies if the user has previously logged into the address book component of the client. When a user logs in for the very first time, this value is set to true. This value is set to false if the entry is not present in the LDAP.
Unknown
Communications Services 6 2006Q2 Communications Express
Single-value
Specifies if the user has previously logged into calendar. When a user logs in for the first time, this value is set to true. This value is set to false if the entry is not present in the LDAP.
Unknown
The following attributes are used by Communications Express Address Book to provision users in an LDAP Schema 2 directory:
Communications Services 6 2006Q2 Communications Express
Single-value
Specifies the address book owner’s ID. It is assigned this UID from the user entry available in the Corporate Directory
Unknown
Communications Services 6 2006Q2 Communications Express
Single-value
Specifies the maximum number of entries that can be created in the store.
Unknown
Communications Services 6 2006Q2 Communications Express
Single-value
Specifies the location of default address book or category in which all new entries in the address book are stored.
Unknown
Communications Services 6 2006Q2 Communications Express
Single-value
Species the last purge cycle date.
Unknown
Communications Services 6 2006Q2 Communications Express
Single-value
Unique “d” used for entry. The 128 bit UID is generated by address book server and never displayed.
Unknown
Communications Services 6 2006Q2 Communications Express
Single-value
Address Book supports three piBookTypes. These are: abook, imbook, or pbook.
Unknown
Communications Services 6 2006Q2 Communications Express
Single-value
Specifies the name of the address book used.
Unknown
Communications Services 6 2006Q2 Communications Express
Single-value
Specifies the detailed description associated with address book.
Unknown
Communications Services 6 2006Q2 Communications Express
Single-value
Stores the identifier of the user modifying this entry.
Unknown
Communications Services 6 2006Q2 Communications Express
Multi-valued
Allows users to read entries in the address book. The owner of the address book store is implicitly granted read, write, modify and delete permissions.
Unknown
Communications Services 6 2006Q2 Communications Express
Multiple-value
Allows users to add or modify entries in an address book. The owner of the address book store is implicitly granted read, write, modify and delete permissions.
Unknown
Communications Services 6 2006Q2 Communications Express
Multiple-value
Allows users to delete entries in an address book.
Unknown
Communications Services 6 2006Q2 Communications Express
Multi-valued
Allows users to create entries in an address book.
Unknown
Communications Services 6 2006Q2 Communications Express
Single-value
An address book can either be user-defined or set up from a system-defined type. Currently three system-defined categories are supported, namely, favorites, subscribed, and user-defined. The category display name is stored in displayName attribute of the piTypeBook object class. Only user defined abBookType can be deleted by users.
Unknown
Communications Services 6 2006Q2 Communications Express
Single-value
Specifies the LDAP URL for a remote address book. For each user, a piRemoteBook node is created for each remote book defined for the domain.
Unknown
Communications Services 6 2006Q2 Communications Express
Single-value
Specifies the display name for the entry.
Unknown
Communications Services 6 2006Q2 Communications Express
Multi-valued
Specifies the piEntryID of each group that is entry is present.
Unknown
Communications Services 6 2006Q2 Communications Express
Single-value
Specifies the URL that identifies recipient(s) of request-to-be-added to messages
Unknown
Communications Services 6 2006Q2 Communications Express
Single-value
Specifies the ID of a person that modifies the entry.
Unknown
Communications Services 6 2006Q2 Communications Express
Multi-valued
Specifies the piEntryID of each address book that this entry belongs to.
Unknown
Communications Services 6 2006Q2 Communications Express
Single-value
Specifies the deletion flag.
Unknown
Communications Services 6 2006Q2 Communications Express
Multi-valued
Specifies the XML data
Unknown
Communications Services 6 2006Q2 Communications Express
Multi-valued
Specifies the generic Text type data to keep extended attributes, which are typically free-floating <index1\>|<index2\>|<index3\>
Unknown
Communications Services 6 2006Q2 Communications Express
Single-value
Specifies the URL information.
Unknown
Communications Services 6 2006Q2 Communications Express
Single-value
None available
Unknown
Communications Services 6 2006Q2 Communications Express
Single-value
None available
Unknown
Communications Services 6 2006Q2 Communications Express
Multi-valued
Specifies the LDAP URL that points to the directory entry containing information on this person.
Unknown
Communications Services 6 2006Q2 Communications Express
Single-value
Specifies the contact’s first name
Unknown
Communications Services 6 2006Q2 Communications Express
Single-value
Specifies the contact’s last name.
Unknown
Communications Services 6 2006Q2 Communications Express
Single-value
Specifies the contact’s middle name.
Unknown
Communications Services 6 2006Q2 Communications Express
Single-value
Specifies a short name associated with the contact. This must be unique amongst all contacts in any address book store.
Unknown
Communications Services 6 2006Q2 Communications Express
Single-value
Specifies the contact’s job title.
Unknown
Communications Services 6 2006Q2 Communications Express
Single-value
Specifies the contact’s company.
Unknown
Communications Services 6 2006Q2 Communications Express
Single-value
Specifies the organization or department that the contact belongs to
Unknown
Communications Services 6 2006Q2 Communications Express
Single-value
Specifies the physical location of the person.
Unknown
Communications Services 6 2006Q2 Communications Express
Single-value
Specifies the physical location of the person.
Unknown
Communications Services 6 2006Q2 Communications Express
Single-value
Specifies the floor of the building that the person occupies. .
Unknown
Communications Services 6 2006Q2 Communications Express
Single-value
Specifies the office number
Unknown
Communications Services 6 2006Q2 Communications Express
Single-value
Specifies the primary phone number for this user
Unknown
Communications Services 6 2006Q2 Communications Express
Single-value
Stores the store other phone numbers of the contact. The corresponding piPhonenTypeattribute is used to determine that what the number represents
Unknown
Communications Services 6 2006Q2 Communications Express
Single-value
Stores the store other phone numbers of the contact. The corresponding piPhonenType attribute is used to determine that what the number represents
Unknown
Communications Services 6 2006Q2 Communications Express
Single-value
Stores the store other phone numbers of the contact. The corresponding piPhonenType attribute is used to determine that what the number represents
Unknown
Communications Services 6 2006Q2 Communications Express
Single-value
Stores the store other phone numbers of the contact. The corresponding piPhonenType attribute is used to determine that what the number represents
Unknown
Communications Services 6 2006Q2 Communications Express
Single-value
Specifies the phone
Unknown
Communications Services 6 2006Q2 Communications Express
Single-value
Specifies the phone
Unknown
Communications Services 6 2006Q2 Communications Express
Single-value
Specifies the phone
Unknown
Communications Services 6 2006Q2 Communications Express
Single-value
Specifies the phone
Unknown
Communications Services 6 2006Q2 Communications Express
Single-value
Specifies the phone
Unknown
Communications Services 6 2006Q2 Communications Express
Single-value
Specifies the additional phone
Unknown
Communications Services 6 2006Q2 Communications Express
Single-value
Specifies the contact’s primary Email address.
Unknown
Communications Services 6 2006Q2 Communications Express
Single-value
piEmail2 through piEmail3 are used to store other email addresses of the contact. The corresponding piEmailnType attribute is used to determine the type of the email address.
Unknown
Communications Services 6 2006Q2 Communications Express
Single-value
Specifies how the addresses are stored.
Unknown
Communications Services 6 2006Q2 Communications Express
Single-value
None available
Unknown
Communications Services 6 2006Q2 Communications Express
Single-value
None available
Unknown
Communications Services 6 2006Q2 Communications Express
Single-value
None available
Unknown
Communications Services 6 2006Q2 Communications Express
Single-value
Specifies the email display name
Unknown
Communications Services 6 2006Q2 Communications Express
Single-value
Specifies the other email display name
Unknown
Communications Services 6 2006Q2 Communications Express
Single-value
Specifies the other email display name
Unknown
Communications Services 6 2006Q2 Communications Express
Single-value
Email1 Transport Type
Unknown
Communications Services 6 2006Q2 Communications Express
Single-value
None available
Unknown
Communications Services 6 2006Q2 Communications Express
Single-value
None available
Unknown
Communications Services 6 2006Q2 Communications Express
Single-value
Specifies the URL of the primary web-site associated with the person.
Unknown
Communications Services 6 2006Q2 Communications Express
Single-value
Specifies the URL of secondary web-site associated with the person.
Unknown
Communications Services 6 2006Q2 Communications Express
Single-value
Specifies the description associated with piWebsite1
Unknown
Communications Services 6 2006Q2 Communications Express
Single-value
Specifies the description associated with piWebsite2
Unknown
Communications Services 6 2006Q2 Communications Express
Multi-valued
Specifies the URL of the person. The format of this URL is:
ics:///?calid=<calid\>
Unknown
Communications Services 6 2006Q2 Communications Express
Single-value
Specifies the URL usually used to see the calendar free-busy time for a user
Unknown
Communications Services 6 2006Q2 Communications Express
Single-value
Specifies the contact’s primary IM identifier
Unknown
Communications Services 6 2006Q2 Communications Express
Single-value
Specifies the contact’s other IM identifier
Unknown
Communications Services 6 2006Q2 Communications Express
Single-value
Specifies the contact’s other IM identifier
Unknown
Communications Services 6 2006Q2 Communications Express
Single-value
Specifies the type of IM service associated with the contacts IM identifier specified in the piIM1ID attribute.
Unknown
Communications Services 6 2006Q2 Communications Express
Single-value
Specifies the type of IM service associated with the contacts specified by the IM identifier in the piIM2ID attribute.
Unknown
Communications Services 6 2006Q2 Communications Express
Single-value
Specifies the type of IM service associated with the contacts specified by the IM identifier in the piIM3ID attribute.
Unknown
Communications Services 6 2006Q2 Communications Express
Single-value
Specifies the contacts home address
Unknown
Communications Services 6 2006Q2 Communications Express
Single-value
Specifies the contacts city
Unknown
Communications Services 6 2006Q2 Communications Express
Single-value
Definition
Specifies the contact's state
Unknown
Communications Services 6 2006Q2 Communications Express
Single-value
Specifies the home postal code of the contact
Unknown
Communications Services 6 2006Q2 Communications Express
Single-value
Specifies the contact's home country
Unknown
Communications Services 6 2006Q2 Communications Express
Single-value
Specifies the contact's home PO BOX
Unknown
Communications Services 6 2006Q2 Communications Express
Single-value
Specifies the contact's work postal address
Unknown
Communications Services 6 2006Q2 Communications Express
Single-value
Specifies the contact’s work city.
Unknown
Communications Services 6 2006Q2 Communications Express
Single-value
Specifies the contact’s work state.
Unknown
Communications Services 6 2006Q2 Communications Express
Single-value
Specifies the postal code of the contact’s workplace
Unknown
Communications Services 6 2006Q2 Communications Express
Single-value
Specifies the country of work
Unknown
Communications Services 6 2006Q2 Communications Express
Single-value
Specifies the PO BOX.
Unknown
Communications Services 6 2006Q2 Communications Express
Single-value
Specifies the other postal address.
Unknown
Communications Services 6 2006Q2 Communications Express
Single-value
Specifies the other city
Unknown
Communications Services 6 2006Q2 Communications Express
Single-value
Specifies the other state
Unknown
Communications Services 6 2006Q2 Communications Express
Single-value
Specifies the other postal code
Unknown
Communications Services 6 2006Q2 Communications Express
Single-value
Specifies the other country
Unknown
Communications Services 6 2006Q2 Communications Express
Single-value
Specifies the other PO Box
Unknown
Communications Services 6 2006Q2 Communications Express
Single-value
Specifies the anniversary date.
Unknown
Communications Services 6 2006Q2 Communications Express
Single-value
Specifies the date of birth.
Unknown
Communications Services 6 2006Q2 Communications Express
Single-value
Specifies the other date
Unknown
Communications Services 6 2006Q2 Communications Express
Single-value
Specifies the other date description
Unknown
Communications Services 6 2006Q2 Communications Express
Single-value
Specifies the mailing address, that could be work/home/other
Unknown
Communications Services 6 2006Q2 Communications Express
Single-value
Specifies the HTTP URL that points to a picture of this person.
Unknown
Communications Services 6 2006Q2 Communications Express
Single-value
Specifies the notes associated with this contact
Unknown
Communications Services 6 2006Q2 Communications Express
Single-value
Specifies the name of the assistant
Unknown
Communications Services 6 2006Q2 Communications Express
Single-value
Specifies the Contact
Unknown
Communications Services 6 2006Q2 Communications Express
Single-value
Specifies the contact's work department
Unknown
Communications Services 6 2006Q2 Communications Express
Single-value
Specifies the person’s full name.
Unknown
Communications Services 6 2006Q2 Communications Express
Single-value
Specifies the gender.
Unknown
Communications Services 6 2006Q2 Communications Express
Single-value
Specifies the contact location.
Unknown
Communications Services 6 2006Q2 Communications Express
Single-value
Specifies the manager’s name
Unknown
Communications Services 6 2006Q2 Communications Express
Single-value
Specifies the contact's profession
Unknown
Communications Services 6 2006Q2 Communications Express
Single-value
Specifies the contact's spouse
Unknown
Communications Services 6 2006Q2 Communications Express
Single-value
Specifies suffixes such as Jr., Sr.
Unknown
Communications Services 6 2006Q2 Communications Express
Single-value
Specifies titles such as Mr., Mrs. etc.
Unknown
Communications Services 6 2006Q2 Communications Express
Single-value
Specifies whether the alarm is set.
Unknown
Communications Services 6 2006Q2 Communications Express
Single-value
Specifies whether the status is completed, where 1 represents completed and 0- represents that the activity is not yet started
Unknown
Communications Services 6 2006Q2 Communications Express
Single-value
Specifies the UTC formatted date/time
Unknown
Communications Services 6 2006Q2 Communications Express
Single-value
Specifies the follow up status
Unknown
Communications Services 6 2006Q2 Communications Express
-
Specifies the Email address of the group. If this is not specified, the message sent to a group are sent to all group members.
Unknown
Communications Services 6 2006Q2 Communications Express
Single-value
Specifies the URL of the web-site associated with group
Unknown
Communications Services 6 2006Q2 Communications Express
Single-value
Specifies the descriptions associated with website1.
Unknown
Communications Services 6 2006Q2 Communications Express
Single-value
Specifies the URL used when inviting this group. If this is not specified, all members of the group are sent invitations to meetings by default
Unknown
Communications Services 6 2006Q2 Communications Express
Single-value
Specifies the URL used to see the calendar free-busy time for a person
Unknown
Communications Services 6 2006Q2 Communications Express
Single-value
Specifies the telephone number of the conference room.
Unknown
Communications Services 6 2006Q2 Communications Express
Single-value
Specifies the number that represents the maximum occupants of who could be in the room.
Unknown
Communications Services 6 2006Q2 Communications Express
Single-value
Specifies the Building
Unknown
Communications Services 6 2006Q2 Communications Express
Single-value
Specifies the Floor in the Building
Unknown
Communications Services 6 2006Q2 Communications Express
Single-value
Specifies the Office Number
Unknown
Communications Services 6 2006Q2 Communications Express
Single-value
Specifies the calendar URL of the resource. The syntax for this attribute is: ics:///<uid\>[@<domain\>]:[<opt_cal_name\>]
Unknown
Communications Services 6 2006Q2 Communications Express
Multi-valued
Specifies the person who needs to be contacted to use the conference room
Unknown