Set-FASTSearchMetadataCategory

Article
07/25/2014

Applies to: SharePoint Server 2010

Updates the settings of a crawled property category.

Syntax

Set-FASTSearchMetadataCategory -Category <Category> [-DiscoverNewProperties <Nullable>] [-MapToContents <Nullable>] [-NewName <String>]

Set-FASTSearchMetadataCategory -Name <String> [-DiscoverNewProperties <Nullable>] [-MapToContents <Nullable>] [-NewName <String>]

Detailed Description

This cmdlet changes the settings of a crawled property category. A category is a group of crawled properties, and the properties of the category control the default behavior of the member crawled properties.

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 Category versus the Name parameter. The only difference is when using the Name parameter you look up the category each time, while when using the Category 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.

If MapToContents is set to “true” on a crawled property category, new crawled properties added to a category are mapped to the “content” full text index. The names of the crawled properties mapped to the “content” full text index are added to the crawledpropertynames managed property. You can override this action by setting the crawled property's IsMappedToContents parameter to “false”.

You can call the cmdlet with either the name of the category (Name parameter), or with a category object (Category parameter).

You can also use the cmdlet to rename a category.

Note

You can only map a crawled property to one category at a time.

Parameters

Parameter	Required	Type	Description
Category	Required	Microsoft.SharePoint.Search.Extended.Administration.Schema.Category	Specifies the category to be changed.
Name	Required	System.String	The name of the category to update.
MapToContents	Optional		If this parameter is set to true, all newly created or discovered properties (if automatic discovery is enabled) are added to the “content” full text index. The name of each crawled property is added to the “crawledpropertynames” managed property.
DiscoverNewProperties	Optional		If this parameter is set to true, previously unknown crawled properties mapped to this category (having the same property set identifier) are created and added to the category.
NewName	Optional	System.String	The new name for the category.

Input Types

Return Types

Example

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

Set-FASTSearchMetadataCategory -Name Titles -DiscoverNewProperties 1 -MapToContents 1

With this example, all new crawled properties for the category “Titles” are automatically discovered and added to the category. A crawled property is considered a member of the category if it has the same property set as the category.

This example also sets MapToContents so that new crawled properties are mapped to the “content” full text index. If you do not want a newly discovered crawled property made available through the full text index, override this action by setting the specific crawled property's IsMappedToContents parameter to false.

---------------EXAMPLE 2-----------------

Set-FASTSearchMetadataCategory -Name ExtendedTitle -Newname Titles

This example changes the name of the category “ExtendedTitle” to “Titles”.