entry Element

Updated: September 26, 2009

Applies To: Windows 7, Windows Server 2008, Windows Server 2008 R2, Windows Vista

The entry element contains child elements that define information about a product displayed in the Web PI interface. The child elements include information about the product, such as version, release date, and supported operating systems.

The entry element can contain user-defined elements that let you customize product groupings and interact with the XML via the Web PI API. There is no predefined set of supported child elements.

The entry element is also used as a child element of the dependency element. The dependency element is used to define a product on which there is a dependency for the product defined by using the parent entry element.

<entry>
    <productId>ComponentName</productId>
    <title resourceName="Entry_ComponentName_Title>Component Name title</title>
    <version>1.0.0.0</version>
    <summary>Short description displayed in the Web PI interface.</summary>
    <id>http://www.microsoft.com/web/webpi/component_name</id>
    <updated>2009-1-13T18:30:02Z</updated>
    <images> ... </mages>
    <keywords> ... </keywords>
    <longSummary resourceName="Entry_ComponentName_LongSummary">Long description of the product.</longSummary>
    <author> ... </author>
    <published>03/16/2009</published>
    <link href="http://www.iis.net/componenet_name_page" />
    <discoveryHint> ... </discoveryHint>
    <architectures> ... </architectures>
    <supportedOSes>... </supportedOSes>
    <dependency> ... </dependency>
    <installers> ... </installers>
  </entry>

The following sections describe attributes, child elements, and parent elements.

Attributes

 

Attribute Description

Type

Specifies the classification for the entry. The attribute is used for entries for the Web Application gallery. Supported types include the following:

  • Application

Child Elements

 

Element Description

productId

Required. Contains a URL or a numeric value that represents the ID associated with the product. The productId element is also used as a child element of the dependency element to reference a product on which a dependency exists for the parent entry element.

title

Required. The product title that is displayed in the Web PI interface.

version

Optional. A numeric value, in the format x.x.x.x, that is the version number of the product.

summary

Optional. Text that is displayed as the product summary in the Web PI interface.

id

Required. Contains a URL for the product that is used for the Atom feed.

updated

Required. Specifies the date on which the product was published, in the format YYYY-MM-DDTHH:MM:SSZ.

images Element

Optional. Contains child elements that specify image files associated with the product, such as icons or screenshots.

keywords

Optional. Contains one or more child item elements that define a keyword associated with the product. The keywords are used to determine which products are displayed on Keyword tabs in the Web PI interface, and for programmatic queries.

longSummary

Optional. The text displayed as the product description in the Web PI interface.

published

Optional. The date on which the product was released, in the format YYYY-MM-DDTHH:MM:SSZ.

link

Optional. Specifies a URL to a page that contains additional information about the product.

discoveryHint

Optional. Contains child elements that define the values, such as registry key name or executable version number, used to determine whether a product is already installed on the client computer.

author

Optional. Contains child name and uri elements that define the author of the product and a URL to the author's Web site.

architectures

Required. Defines the CPU architectures on which the product is supported.

supportedOSes

Optional. Defines the operating systems on which the product is supported. If not used, all operating systems are displayed. To see a list of the values supported, see os Element

dependency

Optional. Contains one or more child productId elements that define products on which the product has a dependency.

installers

Required. Contains child elements that include information about the installer files for the product.

updates

Contains one more child productId elements that reference a product that is installed as an update to this product.

related

Contains one or more child relatedProduct elements. The value of a relatedProduct element corresponds to a product that will be installed with this product, but on which there is no dependency.

relatedDiscovery

Contains one or more item elements that can be specified when a product is included as a related product in the related element.

incompatibilities

Contains one or more child productId elements that reference products with which this product is incompatible.

external

If present, the external element indicates that this product contains no child installers element and therefore cannot be installed by using the Web PI. If the external element is included the longDescription and link elements are required.

An entry element may still contain a discoveryHint element.

When products have dependencies on products that are not installed by using the Web PI, a message is displayed that informs the user that the product is needed as a dependency.

terms

Contains one child termsText, termsLink, and termsLinkText elements that define additional terms displayed for the user to agree to when the product is installed.

Parent Elements

 

Element Description

feed

The root element.

Community Additions

ADD
Show: