Export (0) Print
Expand All

Attribute Descriptions

Office 2007

This section describes the Active Directory schema attributes that are added by Office Communications Server 2007. New attributes added by Office Communications Server are noted. The naming convention for attributes begins with the name of the class to which the attribute belongs, followed by the qualifier for that attribute.

For example, if an attribute that specifies the version number of the server must be added to the Archive class, the naming convention is shown in Table 5.

Table 5.   Example of naming convention for attributes

Class Name Attribute Name

msRTCSIP-Archive

msRTCSIP-ArchiveVersion

An existing attribute in Active Directory is now associated with the new msRTCSIP-Archive and msRTCSIP-Pool classes. This attribute specifies the FQDN of a pool as registered in DNS.

A valid value for each segment is 63 characters; a valid value for the entire FQDN is 255 characters.

This attribute contains the string representation of the distinguished name of the object in another forest that corresponds to this object. This attribute is used for distribution group expansion and auto-attendance. This attribute is defined in the default Active Directory schema for Windows 2003 R2.

In order to avoid requiring an upgrade of Active Directory to Windows 2003 R2, Office Communications Server schema preparation extends the Windows 2000 or Windows 2003 schema with this attribute definition.

This attribute specifies the global default within the forest boundary for whether all users’ communications are to be archived. This is enforced by the Archiving Agent layer.

The range of values for this attribute is as follows:

  • TRUE: Archive all users
  • FALSE: Do not archive all users

This attribute globally controls, within the forest boundary, how users’ communications within an internal network are archived.

Live Communications Server 2005 behavior (now retired)

The range of values for this attribute is as follows:

  • 0: Archive the message body [bit 0]
  • 1: Do not archive the message body [bit 0]

Office Communications Server 2007 behavior

The range of values for this attribute is as follows:

  • 0: ArchiveFederationDefaultWithoutBody (retired)
  • 1-2: ArchiveInternalCommunications
  • 3-4: ArchiveFederatedCommunications
  • 5: RecordPresenceRegistrations
  • 6: RecordIMCallDetails
  • 7: RecordGroupIMCallDetails
  • 8: RecordFileTransferInstances
  • 9: RecordAudioCallDetails
  • 10: RecordVideoCallDetails
  • 11: RecordRemoteAssistanceCallDetails
  • 12: RecordApplicationSharingDetails
  • 13: RecordMeetingInstantiations
  • 14: RecordMeetingJoins
  • 15: RecordDataJoins
  • 16: RecordAVJoins

This attribute is an integer used as a bit field to control whether a single user’s communications are to be archived. This control is enforced by the Archiving Agent layer. It is marked for global catalog replication.

The scope of this attribute is specific to a single user or contact. The valid values (and associated bit positions) in Office Communications Server are as follows:

  • 0: Do not archive (no bit set)
  • 1: Retired (bit position 0)
  • 2: Retired (bit position 1)
  • 4: Archive internal communications (bit position 2)
  • 8: Archive federated communications (bit position 3)

Previously valid values in Live Communications Server 2005 are as follows:

  • 0:Use the default value defined by msRTCSIP-ArchiveDefault and msRTCSIP-ArchiveFederation in this order of precedence:
    • 1: Archive
    • 2: Do not archive
    • 3: Archive without the message body

This attribute is reserved for future use.

This attribute defines the version of the Archiving Service. This attribute is a monotonously increasing integer type that increments with each official product release.

The possible valid values are:

  • Undefined: Live Communications Server 2003
  • Undefined: Live Communications Server 2005
  • Undefined: Live Communications Server 2005 with SP1
  • 3: Office Communications Server 2007

This attribute specifies the FQDN of the back-end server of the pool. Because there can only be a single back-end server per pool, this is a single-valued attribute.

The valid value for each segment is 63 characters; the valid value for the entire FQDN is 255 characters.

This Boolean attribute defines whether the phone usage is a default usage. If this attribute is set to TRUE, the phone usage is a default usage and cannot be deleted by the administrator. If this attribute is set to FALSE, the usage can be deleted.

This single-valued attribute contains the distinguished name of a location profile class object assigned to it. This is the forward link. The corresponding backward link is msRTCSIP-ServerReferenceBL.

This Boolean attribute specifies whether the policy is a default policy. The policy is a default policy when set to TRUE.

This attribute specifies the fully qualified domain name (FQDN) of either the server running Office Communications Server, Access Edge Server, if directly accessible, or of the hardware load balancer for an array of servers running Access Edge Server. If the servers running Access Edge Server are accessible only through one or more Directors, this attribute specifies the FQDN and, optionally, the port number of the Director or of the hardware load balancer serving an array of Directors.

The valid value for each segment is 63 characters; the valid value for the entire FQDN is 255 characters.

This attribute represents the port number that should be used to connect to the server running Office Communications Server Access Edge Server.

The valid value is an integer value specifying the port to be used. The default value is 5061.

This attribute represents the default presence subscription time-out period.

This attribute represents the default registration time-out window.

This attribute represents the default roaming data subscription time-out window.

This single-valued UNICODE string attribute contains a friendly description of this phone route or normalization rule.

This attribute is reserved for future use.

This attribute represents a domain configured for the Registrar.

This attribute is reserved for future use.

This attribute specifies the FQDN of the server running Access Edge Server.

The valid value for each segment is 63 characters; the valid value for the entire FQDN is 255 characters.

This attribute controls whether a server generates a Best Effort NOTIFY (BENOTIFY) request, instead of a NOTIFY request, in response to a SUBSCRIBE request from a client. BENOTIFY is a performance-enhancing extension to the subscribe notification handshake where the server generates BENOTIFY requests, instead of regular NOTIFY requests. The performance benefit is that a BENOTIFY request does not require a 200 OK response from the client as the NOTIFY request does.

The valid values are TRUE or FALSE.

Bb663647.note(en-us,office.12).gifNote:
Live Communications Server 2003 does not support BENOTIFY requests. To interoperate with server applications written with the Live Communications Server 2003 server API running on Live Communications Server 2005 and third-party servers, BENOTIFY requests can be disabled by setting its value to FALSE. BENOTIFY is not currently part of the IETF (Internet Engineering Task Force) SIP standardization process.

This attribute is a global switch that IT administrators use to configure whether users are allowed to communicate with users from other organizations. It enables an administrator to overwrite an individual user’s FederationEnabled attribute. This attribute can be useful to help protect the internal network from Internet attacks that may be caused by worms, viruses, or targeted attacks on the company.

The valid value types are as follows:

  • 1: Enabled for public IM connectivity
  • 2: Reserved
  • 4: Reserved
  • 8: Reserved
  • 16: RCC (remote call control) Enabled [Telephony]
  • 64: AllowOrganizeMeetingWithAnonymousParticipants (allow users to invite anonymous users to meetings
  • 128: UCEnabled (enable users for unified communications)
  • 256: EnabledForEnhancedPresence (enable user for public IM connectivity)
  • 512: RemoteCallControlDualMode
  • 1024: Enabled auto-attendant (enables the use of auto attendant)

This attribute indicates whether the Enterprise Services are loaded on the given server.

This attribute is reserved for future use.

This attribute controls whether a single user is enabled for Federation. It is enforced by the Enterprise Services layer. It is marked for global catalog replication.

The valid values are TRUE or FALSE.

This attribute is a multi-valued list of the domain names of all Enterprise Edition Servers associated with a pool.

This multi-valued string attribute contains a list of gateways and ports (per gateway).

This attribute stores name:value pairs. The already-defined name:value pair is for the "allow polling for presence" setting.

This attribute controls whether a single user is enabled for outside user access. It is enforced by the Enterprise Services layer. It is marked for global catalog replication.

The valid values are TRUE or FALSE.

This single-valued attribute contains the device ID (either the SIP URI or the TEL URI of the phone the user controls) used by Microsoft Office Communicator for telephony. This attribute is marked for Global Catalog replication and is indexed. In Office Communications Server 2007, if a user is enabled for Enterprise voice, this attribute stores the E.164 normalized version of the user’s phone number.

This single-valued attribute contains the SIP URI of the CSTA-SIP gateway server. This attribute is marked for Global Catalog replication but is not indexed.

This multi-valued attribute contains a list of local normalization distinguished names associated with this location profile. The type of this attribute is a distinguished name binary. There is a one-to-many relationship between location profile and local normalization rules. The ordering of the list of local normalization distinguished names must be maintained in the order specified by the administrator. The preservation of order is maintained by the binary portion of the distinguished name binary, which specifies the order index.

The corresponding back link attribute is msRTCSIP-LocationProfileBL.

This single-valued attribute contains a friendly name for the location profile that indicates which location this profile represents. Because there can be multiple location profiles, the administrator needs a way to distinguish between different profiles.

This multi-valued attribute contains a list of location profile distinguished names. This attribute specifies the back link to one or more location profiles. This attribute corresponds to the forward link msRTCSIP-LocalNormalizationLinks.

This attribute represents the maximum number of outstanding search requests per server.

The attribute represents the maximum number of subscriptions per user.

This attribute represents the maximum subscription time-out window.

This attribute represents the maximum registrations time-out window.

This attribute represents the maximum roaming data subscriptions time-out window.

This attribute is reserved for future use.

This attribute is a service connection point attribute under the computer class that specifies a link back to the MCU Factory to which it belongs. This service connection point and attribute is created for every Microsoft MCU. Each Microsoft MCU must find the back-end server of the pool to which it belongs, in order to retrieve pool-level settings from it.

The value of this attribute is the distinguished name of the MCU Factory. This is a single-valued attribute and marked for global catalog replication.

This is a multi-string reserved attribute. Settings stored in this attribute are represented as name=value pairs. Currently defined name=value pairs are:

  • FactoryURL = <URL>

This is a single-valued attribute that contains the distinguished name of a single MCU factory associated with a pool.

This attribute is a single-valued string that specifies the GUID of the MCU factory provider. Based on the GUID value, the MCU factory process determines whether to service this MCU type. If the GUID value is {F0810510-424F-46ef-84FE-6CC720DF1791}, then the MCU factory process (available by default in Office Communications Server) will process it. For any other GUID value, the MCU factory process will not service the MCU type.

This attribute is a multi-valued list of distinguished names. This attribute contains a list of all MCU servers of the same type and vendor associated with this MCU factory. The valid value for each segment is 63 characters; the valid value for the entire FQDN is 255 characters.

This attribute is a single-valued string that specifies the medium the MCU can handle.

Supported valid types are:

  • "meeting"
  • "audio-video"
  • "chat"
  • "phone-conf"

This attribute is a single-valued string that specifies an MCU vendor’s name. All Microsoft MCUs will specify this attribute to be "Microsoft Corporation."

This attribute defines different meeting options that are enabled globally for all users or contact objects. This attribute is a bit-mask value of integer type.

The valid values are as follows:

  • Enable all users to organize meetings: bits 1 and 2.
  • Enable all users to organize external meetings: bits 3 and 4.

This attribute specifies the distinguished name of the policy the administrator has assigned for this user as a single-valued attribute.

This attribute represents the minimum presence subscription time-out window.

This attribute represents the minimum registration time-out window.

This attribute represents the minimum roaming data subscription time-out window.

This attribute represents the allowed number of devices on which a user can register for SIP communications and subscribe to presence.

This attribute specifies the different options that are enabled for the user or contact object. This attribute is a bit-mask value of type integer. Each option is represented by a bit. This attribute is marked for Global Catalog replication.

The valid value types are as follows:

  • 1: Enabled for public IM connectivity
  • 2: Reserved
  • 4: Reserved
  • 8: Reserved
  • 16: RCC (remote call control) Enabled [Telephony]
  • 64: AllowOrganizeMeetingWithAnonymousParticipants (allow users to invite anonymous users to meetings
  • 128: UCEnabled (enable users for unified communications)
  • 256: EnabledForEnhancedPresence (enable user for public IM connectivity)
  • 512: RemoteCallControlDualMode
  • 1024: Enabled auto-attendant (enables the use of auto attendant)

This attribute is used in resource and central forest topologies to enable single sign-on when a user’s ObjectSID from the Windows NT principal account is copied into this attribute of the corresponding user or contact object in the resource or central forest. Communicator Web Access searches for a user in Active Directory using this attribute or the user’s ObjectSID. This attribute is marked for global catalog replication.

This single-valued string attribute contains a pattern used for matching dial numbers into E.164 format. If the dial number matches this pattern, the translation is applied to the dialed number.

This multi-valued attribute contains a list of phone route distinguished names. This attribute specifies the back link to one or more phone routes. This attribute corresponds to the forward link msRTCSIP-RouteUsageLinks.

This single valued UNICODE string attribute specifies the friendly name of the phone route, so it can easily be referenced by the administrator.

This attribute is a single-valued Unicode string. This string attribute contains the policy definition in XML format. The XML schema definition is common across different policy types, only the settings are different for each policy type.

The XML schema definition (XSD) is defined below:

<?xml version="1.0" encoding="utf-8"?>
<xs:schema id="instance" xmlns="" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:msdata="urn:schemas-microsoft-com:xml-msdata">
  <xs:element name="instance" msdata:IsDataSet="true">
    <xs:complexType>
      <xs:choice maxOccurs="unbounded">
        <xs:element name="property" nillable="true">
          <xs:complexType>
            <xs:simpleContent msdata:ColumnName="property_Text" msdata:Ordinal="1">
              <xs:extension base="xs:string">
                <xs:attribute name="name" type="xs:string" />
              </xs:extension>
            </xs:simpleContent>
          </xs:complexType>
        </xs:element>
      </xs:choice>
    </xs:complexType>
  </xs:element>
</xs:schema>

This attribute is reserved for future use.

This single-valued Unicode string attribute contains the policy type. Valid policy types are as follows:

  • meeting
  • telephony

This attribute specifies a link back to the pool to which a computer belongs. This attribute is set regardless of whether the computer is running the Standard Edition or the Enterprise Edition of Office Communications Server. This attribute is marked for global catalog replication.

The valid value is the domain name of the pool.

This is a multi-valued attribute that contains a list of the distinguished names of pools with which the MCU factory is associated.

This attribute is a reserved attribute.

This attribute specifies an arbitrary name for a pool that is displayed by the management console. This name can be changed by the administrator.

The valid value is a string representing the name of a pool.

This attribute is a single-valued string value. The value of this attribute, when present, represents the pool’s domain FQDN if the administrator wants to create an Enterprise pool with an FQDN that does not conform to the Active Directory domain structure in which the Enterprise pool is created (for example, a SIP namespace disjoined from DNS namespace).

We recommend that you map the Enterprise pool domain FQDN to the domain name portion as the Active Directory domain in which the pool resides. Therefore, when no value is present in this attribute, the Enterprise pool FQDN will default to the Active Directory domain name structure, as denoted by the dnsHostName attribute.

A multi-valued list of the domain names of all Office Communications Server, Enterprise Edition servers associated with a pool.

This attribute of type integer defines whether the pool is capable of IM and presence, and meetings.

The possible valid value types are as follows:

  • Undefined: IM and Presence Service (Live Communications Server 2005 and 2003)
  • 1: IM and Presence Service (Office Communications Server)
  • 2: IM and Presence and Meeting Service (Office Communications Server)

This attribute specifies whether a server pool is running Office Communications Server, Standard Edition, or Office Communications Server, Enterprise Edition.

The possible valid value types are as follows:

  • Office Communications Server, Standard Edition
  • Office Communications Server, Enterprise Edition

This attribute defines the pool version. It is an integer type that is incremented with each major product release.

The possible valid value types are as follows:

  • 0: Live Communications Server 2003
  • 1: Live Communications Server 2005
  • 2: Live Communications Server 2005 SP1
  • 3: Office Communications Server

This attribute enables a user or contact for SIP messaging. It is added to the contact class because in the central forest topology, contact objects, not user objects, are SIP enabled.

The valid value is the domain name of the home server or pool where a user is homed.

This attribute contains the SIP address of a given user.

This attribute is a Boolean attribute used to determine whether Office Communications Server is authorized to route to this service using its GRUU address. If this value is set to TRUE, Office Communications Server is authorized to route to this service. If this value is set to FALSE, Office Communications Server is not authorized to route to this service.

This single-valued UNICODE string attribute defines an attribute that qualifies the usage for a phone route. Selection of a phone route is determined based on two elements: the usage attribute assigned to the phone route and the caller’s allowed policy usage attributes. The first phone route with a usage attribute that matches the caller’s allowed usage is selected.

This multi-valued distinguished name attribute contains a list of route usage distinguished names. This attribute is a back link corresponding to the forward link msRTCSIP-PhoneRouteBL.

This single-valued UNICODE string attribute specifies the friendly name of the normalization rule, so it can easily be referenced by an administrator.

This attribute represents the schema version currently deployed in the organization.

This attribute limits the number of search results to be returned from a directory search when a user searches for a contact using Office Communicator. This attribute will override the value provided by the client.

This multi-valued attribute is a back link that contains a list of distinguished names. These distinguished names point to a pool or TrustedService object. This attribute corresponds to the forward link msRTCSIP-TrustedServiceLinks.

This attribute is reserved for future use.

This multi-valued attribute contains a list of distinguished names. These distinguished names are back links that reference other server objects that can be assigned a default location profile. The corresponding forward link to this back link is msRTCSIP-DefaultLocationProfileLink.

This back link attribute references pools and Mediation Servers only.

This attribute defines the version information of the server. This version number applies to all server roles. It is a monotonously increasing integer that increments with each official product release.

The possible valid values are as follows:

  • Undefined: Live Communications Server 2003
  • Undefined: Live Communications Server 2005
  • Undefined: Live Communications Server 2005
  • 3: Office Communications Server 2007

This single-valued attribute of integer type specifies the type of object the msDS-SourceObjectDN points to, as follows:

  • null | 0x00000001: Represents a Windows NT principal user object from a different forest
  • The following attributes represent a group type from a different forest for distribution group expansion:
    • 0x00000002: ADS_GROUP_TYPE_GLOBAL_GROUP
    • 0x00000004: ADS_GROUP_TYPE_DOMAIN_LOCAL_GROUP
    • 0x00000004: ADS_GROUP_TYPE_LOCAL_GROUP
    • 0x00000008: ADS_GROUP_TYPE_UNIVERSAL_GROUP
    • 0x80000000: ADS_GROUP_TYPE_SECURITY_ENABLED
    • 0x90000000: Represents an Auto-Attendant or subscriber access object from the same forest or a different forest

This attribute enables moving a user or contact from one Office Communications Server or pool to another. This attribute is added to the contact class, because in the central forest topology, contact objects, not user objects, are SIP enabled.

The valid value is the distinguished name of the target Standard Edition server or Enterprise Edition pool to which a user is to be moved.

This single-valued string attribute contains a phone number pattern or range to route to the specified gateways defined in msRTCSIP-Gateways.

This attribute is used by the voice feature of Office Communications Server and contains the translation string to apply on the dialed number, if a match is found.

This attribute is reserved for future use.

This attribute is a string value that contains the FQDN of the MCU. This is a single-valued attribute. The valid value for each segment is 63 characters; the valid value for the entire FQDN is 255 characters.

This attribute is reserved for future use.

This attribute is a string value that contains the FQDN of the server running Proxy Server. This attribute is single-valued. The valid value for each segment is 63 characters; the valid value for the entire FQDN is 255 characters.

This attribute is reserved for future use.

This attribute is a single-valued attribute that represents the FQDN of a trusted server.

This attribute specifies the version number of a server in the trusted server list.

The possible valid values are as follows:

  • NULL: Live Communications Server 2003
  • 2: Live Communications Server 2005
  • 3: Office Communications Server 2007

This multi-valued attribute contains a list of distinguished names that reference a trusted service object, such as a Media Relay Authentication Service. A Media Relay Authentication Service (physically collocated on the A/V Conferencing Edge Server) must be associated with a pool to support audio scenarios for remote users. The corresponding back link to this forward link attribute is msRTCSIP-ServerBL.

This attribute is an integer that defines the port number used to connect to this GRUU service.

This attribute is a string value that defines the type of GRUU service it represents.

The valid GRUU service types are as follows:

  • MediationServer
  • Gateway
  • MRAS (Media Relay Authentication Service)
  • QoSM
  • msRTCSIP-UserExtension CWA

This attribute is a string value that contains the FQDN of the IIS running Office Communications Server Web Components. This is a single-valued attribute. The valid value for each segment is 63 characters; the valid value for the entire FQDN is 255 characters.

This attribute defines different Unified Communications options that are enabled globally to all user or contact objects. This attribute is a bit-mask value of integer type. Each option is represented by the presence of a bit.

The possible valid value types are as follows:

  • 4: UsePerUserUCPolicy

When this bit is set, the Unified Communications policy is defined per user.

This single-valued attribute contains the distinguished name of the Unified Communications policy that the administrator has assigned for this user.

This attribute provides a list of all the domains in a forest that host SIP-enabled users. The default is an empty list, indicating that all domains in the forest are SIP-enabled.

Valid values are multiple strings representing the domain names of individual domains.

This attribute determines whether the user is currently enabled for Office Communications Server.

This multi-valued attribute contains a list of name-value pairs in the format of "name=value." This attribute is marked for Global Catalog replication.

This is a multi-valued attribute containing a list of distinguished names with binary (DN_WITH_BINARY) pointing to global user policies of different types. The binary part indicates the type of policy to which the DN portion points.

The valid binary values are as follows:

  • 0x00000001: Meeting policy
  • 0x00000002: Unified Communications policy

This is a multi-valued attribute. This attribute is reserved.

This single-valued attribute points to the pool or Standard Edition Server to which the Web components belong.

This attribute is a multi-valued list of distinguished names. This attribute contains a list of all Web servers associated with this pool.

This existing attribute is used by the voice components in Office Communications Server, for contact objects only, for the purpose of routing calls to the unified messaging auto-attendant and subscriber access numbers. The unconditional call forwarding address is stored in this multi-valued attribute. This account is created for the specific purpose of auto-attendant and subscriber access. This account’s attributes should not be modified by administrators.

This existing multi-valued attribute is part of the base Active Directory schema introduced in Windows 2000. This attribute contains the various X400, X500, and SMTP addresses of the user’s e-mail. In Live Communications Server 2003 and later, the user’s SIP URI is added to this list, using the "sip:" tag.

The following applications search the user’s SIP URI from this attribute:

  • Microsoft Office Outlook® 2003 messaging and collaboration client
  • Microsoft Office SharePoint® Server 2007
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft