SearchScopeConfiguration

Stores information about a search scope configuration for the FIM Portal.

Schema

<?xml version="1.0"?><xs:schema xmlns:rm="http://schemas.microsoft.com/2006/11/ResourceManagement" targetNamespace="http://schemas.microsoft.com/2006/11/ResourceManagement" version="1.0" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:complexType name="SearchScopeConfiguration">
    <xs:sequence>
      <xs:element minOccurs="0" name="ObjectID" type="rm:ReferenceType" />
      <xs:element minOccurs="1" name="ObjectType">
        <xs:simpleType>
          <xs:restriction base="xs:string">
            <xs:pattern value=".{0,448}" />
          </xs:restriction>
        </xs:simpleType>
      </xs:element>
      <xs:element minOccurs="1" name="CreatedTime" type="xs:dateTime" />
      <xs:element minOccurs="0" name="Creator" type="rm:ReferenceType" />
      <xs:element minOccurs="0" name="MVObjectID">
        <xs:simpleType>
          <xs:restriction base="xs:string">
            <xs:pattern value=".{0,448}" />
          </xs:restriction>
        </xs:simpleType>
      </xs:element>
      <xs:element minOccurs="0" name="DeletedTime" type="xs:dateTime" />
      <xs:element minOccurs="0" name="Description">
        <xs:simpleType>
          <xs:restriction base="xs:string">
            <xs:pattern value=".{0,448}" />
          </xs:restriction>
        </xs:simpleType>
      </xs:element>
      <xs:element minOccurs="0" name="DetectedRulesList" type="rm:ReferenceCollectionType" />
      <xs:element minOccurs="0" name="DisplayName">
        <xs:simpleType>
          <xs:restriction base="xs:string">
            <xs:pattern value=".{0,448}" />
          </xs:restriction>
        </xs:simpleType>
      </xs:element>
      <xs:element minOccurs="0" name="ExpectedRulesList" type="rm:ReferenceCollectionType" />
      <xs:element minOccurs="0" name="ExpirationTime" type="xs:dateTime" />
      <xs:element minOccurs="0" name="Locale">
        <xs:simpleType>
          <xs:restriction base="xs:string">
            <xs:pattern value=".{0,448}" />
          </xs:restriction>
        </xs:simpleType>
      </xs:element>
      <xs:element minOccurs="0" name="ResourceTime" type="xs:dateTime" />
      <xs:element minOccurs="1" name="UsageKeyword" type="rm:StringCollectionType" />
      <xs:element minOccurs="0" name="IsConfigurationType" type="xs:boolean" />
      <xs:element minOccurs="0" name="NavigationPage">
        <xs:simpleType>
          <xs:restriction base="xs:string">
            <xs:pattern value=".{0,448}" />
          </xs:restriction>
        </xs:simpleType>
      </xs:element>
      <xs:element minOccurs="1" name="Order">
        <xs:simpleType>
          <xs:restriction base="xs:integer" />
        </xs:simpleType>
      </xs:element>
      <xs:element minOccurs="1" name="SearchScope" type="xs:string" />
      <xs:element minOccurs="0" name="SearchScopeColumn">
        <xs:simpleType>
          <xs:restriction base="xs:string">
            <xs:pattern value=".{0,448}" />
          </xs:restriction>
        </xs:simpleType>
      </xs:element>
      <xs:element minOccurs="1" name="SearchScopeContext" type="rm:StringCollectionType" />
      <xs:element minOccurs="0" name="SearchScopeResultObjectType">
        <xs:simpleType>
          <xs:restriction base="xs:string">
            <xs:pattern value=".{0,448}" />
          </xs:restriction>
        </xs:simpleType>
      </xs:element>
      <xs:element minOccurs="0" name="SearchScopeTargetURL">
        <xs:simpleType>
          <xs:restriction base="xs:string">
            <xs:pattern value=".{0,448}" />
          </xs:restriction>
        </xs:simpleType>
      </xs:element>
    </xs:sequence>
  </xs:complexType>
</xs:schema>

Properties

The following table lists the properties of the SearchScopeConfiguration resource.

Property Description

IsConfigurationType

Optional property. Boolean value that is always set to true. The presence of this property indicates that this resource is a configuration resource. This property is set by the system.

NavigationPage

(This property is not used)

Order

Required property. Integer value that indicates the position of the search scope in a UI drop down list. The value must be equal or greater than 0. The SearchScopeConfiguration objects with smaller Order values will be displayed higher on the drop-down list. This value must be unique within the same drop-down list.

SearchScope

Required String property. XPath expression that indicates which resources are to be returned by the search scope. See FIM XPath Filter Dialect.

SearchScopeContext

Required String property. Name that will be used to match against the search string supplied by the user. The attribute must be a valid attribute of the expected return resource type of the search result.

SearchScopeColumn

Optional String property. Name of the attribute to be shown in search results. The attribute must be a valid attribute of the expected return resource type of the search result. The String length must be no more than 448 characters.

SearchScopeResultObjectType

Optional String properties. The expected return resource type of the search result. If a search scope returns more than one resource type, the property’s value should be Resource. The String length must be no more than 448 characters.

SearchScopeTargetURL

Optional String property. The redirection URL of a search scope item after the search is performed. The String length must be no more than 448 characters.

UsageKeyword

Required String property used to categorize search scopes. One can use this to assign rights to different search scopes or display different search scope combinations in different controls. For more information, see Introduction to Modifying and Configuring the FIM Portal.

Parent Elements

None

Remarks

All of the resource types in FIM have the same attribute bindings as the Resource type by default. For more information, see Forefront Identity Manager Schema.

The DisplayName of the SearchScopeConfiguration resource is "Attribute." For more information about DisplayName, see Resource.

See Also

Concepts

Schema Data Types
How to: Retrieve the FIM Service Schema Using WS-MetadataExchange

Other Resources

Forefront Identity Manager Schema
Introduction to Updating and Configuring the FIM Portal