Export (0) Print
Expand All
Expand Minimize

New-SPEnterpriseSearchMetadataCrawledProperty

Published: July 16, 2012

Applies to:  SharePoint Server 2013 Enterprise | SharePoint Server 2013 Standard | SharePoint Foundation 2013 

Adds a crawled property.

New-SPEnterpriseSearchMetadataCrawledProperty -Category <CategoryPipeBind> -IsNameEnum <$true | $false> -Name <String> -PropSet <Guid> -SearchApplication <SearchServiceApplicationPipeBind> -VariantType <Int32> [-AssignmentCollection <SPAssignmentCollection>] [-Confirm [<SwitchParameter>]] [-IsMappedToContents <Nullable>] [-SiteCollection <Guid>] [-Tenant <Guid>] [-WhatIf [<SwitchParameter>]]

Parameters

Parameter Required Type Description

Name

Required

Microsoft.Office.Server.Search.Cmdlet.CrawledPropertyPipeBind

Specifies the identity of the new crawled property.

The type must be a valid crawled property name, for example “urn:schemas-microsoft-com:sharepoint:portal:profile:UserName”

Category

Required

Microsoft.Office.Server.Search.Cmdlet.CategoryPipeBind

Specifies to which metadata category the crawled property should be added

The type must be a valid GUID in the form 12345678-90ab-cdef-1234-567890bcdefgh, a valid name of a metadata category, for example, MetadataCategory1, or an instance of a valid Category object.

IsNameEnum

Required

System.Boolean

Specifies whether the crawled property name is of type integer. Specified by true or false.

PropSet

Optional

System.Guid

Specifies the property set that belongs to an existing category.

A valid GUID that specifies the property set, in the form 12345678-90ab-cdef-1234-567890bcdefgh.

SearchApplication

Required

Microsoft.Office.Server.Search.Cmdlet.SearchServiceApplicationPipeBind

Specifies the search application that contains the crawled property.

The type must be a valid search application name, for example, SearchApp1, or an instance of a valid SearchServiceApplication object.

VariantType

Required

System.Int32

Adds the crawled property as the specified variant type. For more information about valid values for this property, see VARIANT Type Constants (http://go.microsoft.com/fwlink/p/?LinkId=143322&clcid=0x409).

The type must be an integer that specifies the variant data type of the property set.

AssignmentCollection

Optional

Microsoft.SharePoint.PowerShell.SPAssignmentCollection

Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.

note Note:

When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.

Confirm

Optional

System.Management.Automation.SwitchParameter

Prompts you for confirmation before executing the command. For more information, type the following command: get-help about_commonparameters

IsMappedToContents

Optional

System.Nullable

Specifies that the crawled property should be mapped to managed properties. Specify true to map a crawled property to a managed property.

SiteCollection

Optional

System.Guid

Specifies that the crawled properties returned are to be within the scope of a site collection (SPSite).

The type must be a valid GUID that specifies the property set in the form 12345678-90ab-cdef-1234-567890bcdefgh.

Tenant

Optional

System.Guid

Specifies that the crawled properties returned are to be within the scope of a tenant.

The type must be a valid GUID that specifies the property set in the form 12345678-90ab-cdef-1234-567890bcdefgh.

WhatIf

Optional

System.Management.Automation.SwitchParameter

Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: get-help about_commonparameters

Detailed Description

This cmdlet is used when the search functionality is configured for the first time, and to add new crawled properties after the first configuration. SPEnterpriseSearchMetadataCrawledProperty represents a crawled property in the enterprise search metadata property schema. Or, crawled properties are automatically created during regular crawls (see SPEnterpriseSearchMetadataCategory).

Input Types

Return Types

------------------EXAMPLE------------------

$searchapp = Get-SPEnterpriseSearchServiceApplication
$cat = Get-SPEnterpriseSearchMetadataCategory -SearchApplication $searchapp -Identity People
$crawlprop = Get-SPEnterpriseSearchMetadataCrawledProperty -SearchApplication $searchapp -Category $cat -Limit 1

New-SPEnterpriseSearchMetadataCrawledProperty -SearchApplication $searchapp -Name "MyCrawlProp" -PropSet $crawlprop.PropSet -Category $crawlprop.CategoryName -IsNameEnum $false -VariantType $crawlprop.VariantType -IsMappedToContents $false

This example maps the new crawled property MyCrawlProp to the People metadata category for the default search service application. The mapping uses the constraints from the existing People category.

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft