CrawledProperty Element

Article
07/24/2014

Applies to: SharePoint Server 2010

<CrawledProperty propertySet='GUID' propertyName='PropertyName' propertyId='PropertyId' varType='PropertyType' defaultValue='DefaultValue'>

Attributes and Elements

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

Attributes

Attribute	Description
propertySet	Required. Specifies the property set of the crawled property, as a hexadecimal GUID string in the following format: 00000000-0000-0000-0000-000000000000. The value is case-insensitive.
propertyName	Optional. Specifies the string that is the name of the crawled property.
propertyId	Optional. Specifies the integer representing the ID of the crawled property. Note You use this attribute instead of propertyName if the crawled property has IsNameEnum=True.
varType	Required. Specifies the integer value that represents the data type for the crawled property. The varType for an output crawled property must be 30 (string) or 31 (wide string).
defaultValue	Optional. Specifies a default output value to use when the command does not emit a value. Applicable only when it is used inside an Output element.

Child Elements

None.

Parent Elements

Element	Description
Input	Contains a list of CrawledProperty elements that specifies the input to the command.
Output	Contains a list of CrawledProperty elements that specifies the crawled properties output by the command.

Remarks

A crawled property in a property set is identified with a string or a number. You must specify either propertyName or propertyId, not both. You use propertyId if the crawled property has IsNameEnum=True.

Only crawled property types that can be mapped to a managed property are supported.

A special property set contains crawled properties that are created inside the item processing pipeline. These read-only properties may be passed to the command in the Input element.

The property set is specified by propertySet="11280615-f653-448f-8ed8-2915008789f2" and varType="31" (variant type VT_LPWSTR). From this property set, you can input the following internal properties to the pipeline extensibility command:

url: The URL that is displayed when the item occurs in the query results.
data: The binary content of the source document encoded in base64.
body: The text extracted from the item by parsing the data property. The body is extracted by using an IFilter or other document parser.

You cannot modify these internal properties by using the pipeline extensibility feature.

A data property can occur multiple times in one item, such as a SharePoint list entry with multiple attachments. This will correspond to multiple CrawledProperty elements in the input file.

Example

This example specifies an input section to a pipeline extensibility command that includes the body crawled property and another crawled property that has propertyId="4".

<Input>
    <CrawledProperty propertySet="11280615-f653-448f-8ed8-2915008789f2" 
                     varType="31" propertyName="body"/> 
    <CrawledProperty propertySet="f29f85e0-4ff9-1068-ab91-08002b27b3d9" 
                     varType="31" propertyId="4"/>
</Input>