Set-FASTSearchMetadataCrawledProperty

Article
07/25/2014

Applies to: SharePoint Server 2010

Updates the properties of a crawled property.

Syntax

Set-FASTSearchMetadataCrawledProperty -CrawledProperty <CrawledProperty> [-IsMappedToContents <Nullable>] [-Propset <Guid>] [-VariantType <Nullable>]

Set-FASTSearchMetadataCrawledProperty -Name <String> [-IsMappedToContents <Nullable>] [-Propset <Guid>] [-VariantType <Nullable>]

Detailed Description

This cmdlet specifies if a crawled property should be automatically indexed as part of the default full text index, “content”.

When the IsMappedToContents parameter is set to “true”, the crawled property is added to the default searchable index.

To find the crawled property to update, specify a crawled property object, or the combination of name, property set, and variant type.

This cmdlet contains more than one parameter set. You may only use parameters from one parameter set, and you may not combine parameters from different parameter sets. When doing simple operations, there is no difference between using the CrawledProperty versus the Name parameter. The only difference is when using the Name parameter you look up the crawled property each time, while when using the CrawledProperty parameter you use the object you already have a reference to. However, when dealing with operations involving a large set of objects (for example iterating over all categories), avoiding extra lookups by name can be slightly more efficient. For more information about how to use parameter sets, see Cmdlet Parameter Sets.

Parameters

Parameter	Required	Type	Description
CrawledProperty	Required	Microsoft.SharePoint.Search.Extended.Administration.Schema.CrawledProperty	An object representing the crawled property to update.
Name	Required	System.String	The name of the crawled property to update.
Propset	Optional	System.Guid	The property set GUID of the crawled property which is being updated. The GUID controls which category the crawled property is part of. A GUID (Global Unique Identifier) is a 128-bit integer that has a very low probability of being duplicated. The accepted GUID format is “xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx” or a System.Guid object.
VariantType	Optional		An integer value specifying the variant type of the updated crawled property. See https://go.microsoft.com/fwlink/p/?LinkId=163232 for a list of common variant types.
IsMappedToContents	Optional		This Boolean parameter specifies whether or not the content of the crawled property should be automatically mapped into the default full text index.

Input Types

Return Types

Crawled property.

Example

---------------EXAMPLE 1-----------------

$description = Get-FASTSearchMetadataCrawledProperty -Name Description
$description # Before
Set-FASTSearchMetadataCrawledProperty -CrawledProperty $description -IsMappedToContents 1
$description # After

This example automatically maps a crawled property to the full text index “content”, making the content of the crawled property searchable.

Share via