Partager via

PortalUIConfiguration

  • Article

Stores global UI configuration for the FIM Portal including cache information, branding information and global time zone information.

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="PortalUIConfiguration">
    <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="BrandingCenterText">
        <xs:simpleType>
          <xs:restriction base="xs:string">
            <xs:pattern value=".{0,448}" />
          </xs:restriction>
        </xs:simpleType>
      </xs:element>
      <xs:element minOccurs="1" name="BrandingLeftImage">
        <xs:simpleType>
          <xs:restriction base="xs:string">
            <xs:pattern value=".{0,448}" />
          </xs:restriction>
        </xs:simpleType>
      </xs:element>
      <xs:element minOccurs="1" name="BrandingRightImage">
        <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="ListViewCacheTimeOut">
        <xs:simpleType>
          <xs:restriction base="xs:integer" />
        </xs:simpleType>
      </xs:element>
      <xs:element minOccurs="1" name="ListViewPageSize">
        <xs:simpleType>
          <xs:restriction base="xs:integer" />
        </xs:simpleType>
      </xs:element>
      <xs:element minOccurs="1" name="ListViewPagesToCache">
        <xs:simpleType>
          <xs:restriction base="xs:integer" />
        </xs:simpleType>
      </xs:element>
      <xs:element minOccurs="0" name="TimeZone" type="rm:ReferenceType" />
      <xs:element minOccurs="1" name="UICacheTime">
        <xs:simpleType>
          <xs:restriction base="xs:integer" />
        </xs:simpleType>
      </xs:element>
      <xs:element minOccurs="1" name="UICountCacheTime">
        <xs:simpleType>
          <xs:restriction base="xs:integer" />
        </xs:simpleType>
      </xs:element>
      <xs:element minOccurs="1" name="UIUserCacheTime">
        <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 PortalUIConfiguration resource:

Property Description

BrandingCenterText

Optional String property. Text that is located in the center of the section of the portal that contains branding information. The String length must be no more than 448 characters.

BrandingLeftImage

Required String property. Relative path of the image used on the left of the section of the portal that contains branding information. The String length must be no more than 448 characters.

BrandingRightImage

Required String property. Relative path of the image used on the right of the section of the portal that contains branding information. The String length must be no more than 448 characters.

UICacheTime

Required Integer property. Time in seconds that the UI configuration resources will be kept on the cache. These configuration resources include: ObjectVisualizationConfiguration, PortalUIConfiguration, SearchScopeConfiguration, NavigationBarConfiguration and HomepageConfiguration.

UICountCacheTime

Required Integer property. Time in seconds that the UI dynamic counts will stay on the cache before it expired. This includes the CountXPath property value in the NavigationBarConfiguration and HomepageConfiguration resources.

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.

ListViewCacheTimeOut

Required Integer property. Specifies the amount of time in seconds for a ListView cache to time out and expire.

ListViewPageSize

Required Integer property. Specifies the number of items to show per page in all ListViews.

ListViewPagesToCache

Required Integer property. Specifies the number of pages to cache while retrieving ListView results.

TimeZone

Optional property. Reference to a TimeZoneConfiguration resource. This defines the fall back global time zone setting for the FIM Portal. Users can have their own time zone information set in their user profile to further customize their time zone information.

UIUserCacheTime

Required Integer property. Time in seconds that the FIM Portal user data will stay on the cache before it expires.

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.

See Also

Concepts

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

Other Resources

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