Partager via

HomepageConfiguration

  • Article

Stores configuration information for a webpage that accesses FIM web services.

Schema

<?xml version="1.0"?><xs:schema xmlns:rm="https://schemas.microsoft.com/2006/11/ResourceManagement" targetNamespace="https://schemas.microsoft.com/2006/11/ResourceManagement" version="1.0" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:complexType name="HomepageConfiguration">
    <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="0" name="UsageKeyword" type="rm:StringCollectionType" />
      <xs:element minOccurs="0" name="CountXPath">
        <xs:simpleType>
          <xs:restriction base="xs:string">
            <xs:pattern value=".{0,448}" />
          </xs:restriction>
        </xs:simpleType>
      </xs:element>
      <xs:element minOccurs="0" name="ImageUrl">
        <xs:simpleType>
          <xs:restriction base="xs:string">
            <xs:pattern value=".{0,448}" />
          </xs:restriction>
        </xs:simpleType>
      </xs:element>
      <xs:element minOccurs="0" name="IsConfigurationType" type="xs:boolean" />
      <xs:element minOccurs="1" name="NavigationUrl">
        <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="ParentOrder">
        <xs:simpleType>
          <xs:restriction base="xs:integer" />
        </xs:simpleType>
      </xs:element>
      <xs:element minOccurs="1" name="Region">
        <xs:simpleType>
          <xs:restriction base="xs:integer" />
        </xs:simpleType>
      </xs:element>
    </xs:sequence>
  </xs:complexType>
</xs:schema>

Properties

The following table lists the properties of the HomepageConfiguration resource:

Property Description

CountXPath

Optional String property. This XPath filter (see FIM XPath Filter Dialect) is used to define the query that generates a resource count beside the homepage item.

The more configuration resources that define a CountXPath value, the longer the FIM Portal will take to load. See also NavigationBarConfiguration.

ImageUrl

Optional String property. The URL for the icon used on the homepage. Must be a relative URL. The String length must be no more than 448 characters.

IsConfigurationType

Required 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.

NavigationUrl

Required String property. The redirecting URL for the homepage item. The String length must be no more than 448 characters.

Order

Required Integer property. Order of the item within a given Region and ParentOrder. Lower numbered items appear higher in the Webpage. The combination of ParentOrder and Order has to be unique within the same Region.

ParentOrder

Required Integer property. Order of the header item on the homepage within a given Region. Lower numbered items appear higher in the Webpage. The combination of ParentOrder and Order has to be unique within the same Region.

Region

Required Integer property. This property indicates where the given homepage item shows on the homepage. Value must be between 1 and 4. See Region Property table.

UsageKeyword

Optional multi-valued String property. Can be used to categorize items on the homepage to enable a user to assign permissions to certain groups of homepage items. For more information, see Introduction to Modifying and Configuring the FIM Portal.

Region Property

Value Description

1

Center region of homepage.

2

Right-hand side region of homepage and also on Administration page.

3

Right-hand side region of homepage.

4

Administrage page of homepage.

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.

Example

Description

The following is an example of a HomepageConfiguration that redirects to an “All Distribution Lists” page. It appears on the center of the homepage as the last item in the first header item. The homepage item has a count that indicates total number of distribution lists in FIM.

Code

<HomepageConfiguration>
  // Attributes inherited from “Resource”
  // <…>
  //HomepageConfiguration attributes
  <NavigationUrl>~/IdentityManagement/aspx/groups/AllDLs.aspx</NavigationUrl>
  <ImageUrl>~/_layouts/images/MSILM2/homeadmin.png</ImageUrl>
  <IsConfigurationType>true<IsConfigurationType/> 
  <ParentOrder>0<ParentOrder> 
  <Order>100</Order>
  <Region>1<Region> 
  <CountXPath>/Group[Type=”Distribution”]<CountXPath>
</HomepageConfiguration>

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