Entries and attribute fields

his appendix describes entry types and the required and optional attribute fields for each type of entry. Most of the attribute fields are optional, however, almost every entry type requires at least one complete attribute field before the entry can be saved.

This appendix includes:

Schema checking

Schema checking within the Directory Server assures that entries in the directory have the required fields to be uniquely identifiable. When schema checking is on, the default setting, the required attribute fields for an entry must be completed before the entry can be saved. If schema checking is off, the required fields do not need to be completed. In any case, optional attribute fields can be filled in at any time or left blank. If a required field is not filled in when schema checking is on, you will receive an object class violation error and the entry cannot be saved. Use the following entry descriptions to determine which attribute fields are required for each entry type.

Entry type definition

Entry types are used to describe the kinds of information that you can store with the entry. The properties are listed as attribute fields for the entry. Each entry has a defined set of required and optional attribute fields. These attribute fields store the information about each entry. When schema checking is on, entries must have their required attribute fields completed in order to save the new entry.

Attribute field definition

Attribute fields are used to store information about each entry. Each attribute consists of an attribute label and an attribute value. The attribute label identifies the class of information given by that attribute (for example, telephone number). The attribute value would be the particular instance of information appearing in that entry (for example, 555-1999).

Each attribute field has a format; that is, a set of possible values for that field. For example, a telephone number attribute field expects input that contains only numbers and hyphens (-). Entering letters into the telephone attribute field may cause errors within the directory. The Directory Server performs searches based on the information in attribute fields, so it is important to enter the correct type of information. This chapter will explain the acceptable format for each attribute field.

Entry types

The following section describes the entry types available within the Directory Server. The entry types accessible in the Directory Server are:

Person

Defines entries for a person.

Required attributes

A person entry requires the following attribute fields. When schema checking is on, an object class violation error will occur if these attribute fields are not given values when adding an entry to the directory tree.

Optional attributes

The following attribute fields are optional. They can be filled out at any time or left empty.

Group

Defines entries for a list of people in a group.

Required attributes

A group entry requires the following attribute fields. When schema checking is on, an object class violation error will occur if this attribute field is not given a value when adding an entry to the directory tree.

Optional attributes

The following attribute fields are optional. They can be filled out at any time or left empty.

Organizational Unit

Defines entries for organizational units.

Required attributes

An organizational unit entry requires the following attribute fields. When schema checking is on, an object class violation error will occur if this attribute field is not given a value when adding an entry to the directory tree.

Optional attributes

The following attribute fields are optional. They can be filled out at any time or left empty.

Organizations

Defines entries that represent organizations

Required attributes

An organization entry requires the following attribute fields. When schema checking is on, an object class violation error will occur if this attribute field is not given a value when adding an entry to the directory tree.

Optional attributes

The following attribute fields are optional. They can be filled out at any time or left empty.

Attribute fields

The following defines the attribute fields used to describe an entry in the directory tree. Refer to Entry types to determine which attribute fields are required and allowed for each entry.

Each attribute field has an internal ID that you can use with search filters. For example, the internal ID for the Full Name attribute field is cn. When you enter a search filter in Smart Search, use the internal ID (cn) rather than the attribute field name (Full Name):

    cn=Smith Fukuda
Some attribute fields also have a second, abbreviated internal ID. For example, the Full Name field has two internal IDs: commonName and cn. You can use either name in a search filter.

Each attribute field also has a corresponding format that describes the nature of the information held by that attribute. The possible formats are:

Admin
Identifies the entry's secretary or administrative assistant. For example:

    Admin: Howard Benson
Internal attribute ID:      secretary
Format:      cis

Business Category
Identifies the type of business in which the entry is engaged. This should be a broad generalization such as is made at the corporate division level. For example:

    Business Category: Engineering 
Internal attribute ID:      businessCategory
Format:      cis

Car License#
Identifies the entry's automobile license plate number. For example:

    Car License#: 6ABC246
Internal attribute ID:      carLicense
Format:      cis

Dept#
Identifies the entry's department number. For example:

    Dept#: 2604
Internal attribute ID:      departmentNumber
Format:      cis

Description
Describes the entry. For people and organizations this often includes their role or work assignment. For example:

    Description: Quality control inspector for the ME2873 product line.
Internal attribute ID:      description
Format:      cis

E-Mail Address
Identifies the entry's E-Mail address. For example:

    E-Mail Address: banderson@aceindustry.com
Internal attribute ID:      mail
Format:      cis

Emp#
Identifies the entry's employee number. For example:

    Emp#: 15300
Internal attribute ID:      employeeNumber
Format:      cis

Fax
Identifies the fax number at which the entry can be reached. For example:

    Fax: 415-555-1212
Internal attribute ID:      facsimileTelephoneNumber or fax
Format:      tel

First Name
Identifies the entry's given, or first, name. For example:

    First Name: Bill
Internal attribute ID:      givenName
Format:      cis

Full Name
Identifies the entry's common name or full name. For example:

    Full Name: Bill Anderson
Internal attribute ID:      commonName or cn
Format:      cis

Group Members
Identifies the distinguished names for each member of the group. For example:

    Group Members: cn=John Doe, o=Netscape Communications Corp., c=US
Internal attribute ID:      member
Format:      dn

Last Name
Identifies the entry's surname or last name. For example:

    Last Name: Anderson
Internal attribute ID:      surname or sn
Format:      cis

Location
Identifies the county, city, or other geographical area in which the entry is located or in some other way associated with. For example:

    Location: Santa Clara
Internal attribute ID:      localityName or l
Format:      cis

Mailing Address
Identifies the entry's mailing address. This field is intended to include multiple lines. For example:

    Mailing Address:
    1234 Ridgeway Drive
    Santa Clara, CA 99555
Internal attribute ID:      postalAddress
Format:      cis

Manager
Identifies the distinguished name of the person's manager. For example:

    Manager: cn=Jane Doe, ou=Quality Control, o=Ace Industry, c=US
Internal attribute ID:      manager
Format:      dn

Mobile Phone
Identifies the entry's mobile or cellular phone number. For example:

    Mobile Phone: 415-555-4321
Internal attribute ID:      mobileTelephoneNumber or mobile
Format:      tel

Name
Identifies the name of the group. For example:

    Name: Customer Assessment Team
Internal attribute ID:      commonName or cn
Format:      cis

Organization Name
Identifies the name of the organization. For example:

    Organization Name: Ace Industries, Inc.
Internal attribute ID:      organizationName or o
Format:      cis

Owner
Identifies the distinguished name (dn) of the person that is responsible for the entry. For example:

    Owner: cn=John Smith, o=Netscape Communications Corp., c=US
Internal attribute ID:      owner
Format:      dn

Pager
Identifies the entry's pager phone number. For example:

    Pager: 415-555-6789
Internal attribute ID:      pagerTelephoneNumber or pager
Format:      tel

Phone
Identifies the entry's phone number. For example:

    Phone: 415-555-2233
Internal attribute ID:      telephoneNumber
Format:      tel

Room Number
Identifies the entry's office number. For example:

    Room Number: 230
Internal attribute ID:      roomNumber
Format:      cis

See Also
Identifies another Directory Server entry that may have related information to this entry. For example:

    See Also: cn=Quality Control Inspectors, ou=manufacturing, o=Ace Industry, c=US
Internal attribute ID:      seeAlso
Format:      dn

Title
Identifies the entry's title. For example:

    Title: Senior QC Inspector
Internal attribute ID:      title
Format:      cis

Unit Name (or Organizational Unit)
Identifies the name of an organizational unit. For example:

    Unit Name: Marketing
Internal attribute ID:      organizationalUnitName or ou
Format:      cis

URL
Specifies a Uniform Resource Location (URL) that is relevant in some way to the entry. Values placed in the attribute should consist of a URL optionally followed by one or more space characters and a label. For example:

    URL: http://home.netscape.com [Netscape corporations's home page]
Internal attribute ID:      labeledURI
Format:      cis

User ID
Identifies the entry's userid (that is, their login ID). For example:

    User ID: banderson
Internal attribute ID:      userid or uid
Format:      cis