Integrating the BCS with Search in SharePoint 2013
Download as PPTX, PDF1 like3,116 views
This document provides an overview of Business Connectivity Services (BCS) in SharePoint 2013 and how to integrate BCS with Search. It describes what BCS is, its main components and features, how to create external content types using SharePoint Designer or Visual Studio, and the key aspects of configuring a BCS model to enable searching of external data, including required properties, methods, and fields.
![Configure Search
Configure Search Service App
$searchapp = Get-
SPEnterpriseSearchServiceApplication
New-SPEnterpriseSearchCrawlCustomConnector -
SearchApplication $searchapp -protocol myfile -
ModelFilePath
"ServerNameFolderNameMyFileModel.xml" -Name
myfile
Registry Key
[HKEY_LOCAL_MACHINE] SOFTWAREMicrosoftOffice
Server15.0SearchSetupProtocolHandlersmyfile
44](https://image.slidesharecdn.com/htf2014integratingthebcswithsearchinsharepoint2013-andy-140923084302-phpapp02/85/Integrating-the-BCS-with-Search-in-SharePoint-2013-45-320.jpg)
Integrating the BCS with Search in SharePoint 2013
- 1. Integrating the BCS with Search in SharePoint 2013 Andy Boyet, CISSP SharePoint Architect @ Sparkhound andy.boyet@Sparkhound.com Twitter: @andrewboyet LinkedIn: https://www.linkedin.com/in/andyboyet 0
- 2. Introduction Goal: Understand concepts for the BCS and how to integrate it with Search • What is the BCS • BCS Feature Set • Enhancing the BCS for Search 1
- 3. What is the BCS? Feature of SharePoint that facilitates integration with other systems How? • Introduced in 2007 as Business Data Catalog (BDC) • Data model description • Tooling has improved 2
- 4. BCS Feature Set 3
- 5. Components 4
- 6. Tools SharePoint Designer: adds to the BCS Store Visual Studio: Deploy wsp and activate farm feature 5
- 7. Content Type Hierarchical reusable collection of columns, workflow, and other settings. Item Event Link Task 6
- 8. External Content Types Like normal Content Types, only external Tools for Creating: • SharePoint Designer (.Net, SQL, WCF) • Visual Studio 7 XML behind the scenes Defined as Entities
- 9. ECTs in SharePoint Designer 8
- 10. ECTs in SharePoint Designer 9
- 11. Visual Studio BDC Explorer 10
- 12. App-Scoped ECTs • Introduced in 2013 • Isolated from the rest of the farm • Requires Visual Studio • One model/app • Only ODATA sources 11
- 13. Presentation Features 12 • External List • External Data Column
- 14. Extensibility Features 13 • REST APIs – http://<sitecollection>/<site>/_api/ • CSOM APIs • Server OM – .Net • Remote Event Receivers – New in 2013
- 15. Connector Framework 14 • ODATA • WCF • SQL • .NET
- 16. Profile Pages • Similar to List Forms • Can be overridden - DisplayUriField 15
- 17. Secure Store Service • Used for Storing Credentials • Accessible through CA and Powershell 16
- 18. External Data Search 17 Two Parts • BCS Model – Additional properties required for search support • Connector
- 19. ShowInSearchUI Set on a LobSystemInstance element 18
- 20. Search UI 19
- 21. BCS Requirements for Search • Finder and Specific Finder Methods • DisplayUri • Permissions for Search Account • BinarySecurityDescriptorAccessor • StreamAccessor 20
- 22. Incremental Crawl • ChangedIdEnumerator Method • DeletedIdEnumerator Method • LastModifiedTimeStamp 21
- 23. Caution • Version numbers must be incremented to pick up changes 22
- 24. InputUriProcessor • Specifies the name of the class that processes the input URL before passing it to the connector. Applies to .NET and custom BCS indexing connectors. 23
- 25. OutputUriProcessor • Specifies the name of the class that processes the output URL before passing it to the search system from the connector. Applies to .NET and custom BCS indexing connectors. 24
- 26. SystemUtilityTypeName Specifies the name of the class that implements the StructuredRepositorySystemUtility class. Applies to custom BCS indexing connectors. 25 <LobSystems> <LobSystem Name="MyFileSystem" Type="Custom"> <Properties> <Property Name="SystemUtilityTypeName" Type="System.String">MyFileConnector.MyFileConnec tor, MyFileConnector, Version=1.0.0.0, Culture=neutral, PublicKeyToken=15865f58b9878bf8</Property> </Properties> <Entities>
- 27. Title Found in Entity Elements • Specifies the title of the external content type to display in search results. 26
- 28. DefaultLocale Found in Entity Elements • Specifies the locale string. You can override this value by using the LCIDField property or the CultureField property. 27
- 29. RootFinder Found in Method Elements • Specifies the Finder method to use to enumerate the items to crawl. 28
- 30. DirectoryLink Found in Association Elements • Specifies that BCS should navigate associations. Required for hierarchical crawling. 29
- 31. DeletedCountField Found in Method Elements • Specifies the deleted count value. 30
- 32. WindowsSecurityDescriptorField Found in Method Elements • Specifies the Windows Security descriptor for the item • GetSecurityDescriptor method 31
- 33. AuthorField Found in Method Elements • Specifies the author name to display in search results. 32
- 34. DisplayUriField Found in Method Elements • Specifies the URL to display in search results • Overrides the Profile Page • May require a restart of search service 33
- 35. LastModifiedTimeStampField Found in Method Elements • Specifies the external item's timestamp to display in search results. • Used for incremental crawling. 34
- 36. DescriptionField Found in Method Elements • Specifies the description to display in search results. 35
- 37. LCIDField Found in Method Elements • Specifies the locale ID (LCID) for the DescriptionField. If this is not specified, the default word breaker is used. 36
- 38. CultureField Found in Method Elements • Specifies the culture for the DescriptionField. 37
- 39. Extension Found in Method Elements • Specifies the file name extension for the crawlable stream. • Default extension is .txt. 38
- 40. MimeType Found in Method Elements • Specifies the MIME type for the crawlable stream. If not specified, the default extension is .txt. • Takes precedence over the Extension Property 39
- 41. MimeType Example <MethodInstance Name="LargeResumeAccessor" Type="StreamAccessor" ReturnParameterName="StreamData" ReturnTypeDescriptorName="ResumeLarge"> 40 <Properties> <Property Name="MimeType" Type="System.String">application/vnd.openxmlformats-officedocument. wordprocessingml.document</Property> <Property Name="FileName" Type="System.String">Resume Large.docx</Property> <Property Name="MimeTypeField" Type="System.String">ResumeLargeMIME</Property> <Property Name="FileNameField" Type="System.String">ResumeLargeName</Property> <Property Name="MaxFileSizeInKB" Type="System.Int32">120</Property> </Properties> </MethodInstance>
- 42. UseClientCachingForSearch Found in Method Elements • Specifies whether the crawler caches the content during enumeration. 41
- 43. EnumerateIdsOnly Found in FilterDescriptor Elements • Specifies whether to return IDs only in the IDEnumerator. 42
- 44. CrawlStartTime Found in FilterDescriptor Elements • Contains the start time of the last crawl. 43
- 45. Configure Search Configure Search Service App $searchapp = Get- SPEnterpriseSearchServiceApplication New-SPEnterpriseSearchCrawlCustomConnector - SearchApplication $searchapp -protocol myfile - ModelFilePath "ServerNameFolderNameMyFileModel.xml" -Name myfile Registry Key [HKEY_LOCAL_MACHINE] SOFTWAREMicrosoftOffice Server15.0SearchSetupProtocolHandlersmyfile 44
- 46. Thanks to all our Sponsors! 45
Editor's Notes
- #8: A content type is a reusable collection of metadata (columns), workflow, behavior, and other settings for a category of items or documents in a Microsoft SharePoint Foundation 2010 list or document library. Content types enable you to manage the settings for a category of information in a centralized, reusable way. Mention properties in the Item type: author, created, modified, URL Event has those plus Start, End
- #11: Mention Filter Types
- #14: Function similar to regular lists and columns
- #16: App scoped ECTS only use ODATA, given a choice look at ODATA WCF, SQL, and .Net are available in SPD and in Visual Studio
- #25: Its primary responsibility is to receive an access URL from SharePoint Search, and translate it into the appropriate BCS metadata object.
- #27: defines the logic of how the types from the external system are reflected back for SharePoint Server search.
- #32: This property is ignored unless it contains an integer greater than zero.
- #33: If the GetSecurityDescriptor is not defined, all external items are assigned the Everyone access control list (ACL).
- #35: If specified, this property overrides the profile page URL provided by BCS. If not specified, the URL displayed in search results starts with bdc3://, and is not understood by the browser.
- #41: If the Extension field and MimeType field are both specified, the value specified in the MimeType field is used.
- #43: If items are larger than 30 kilobytes on average, do not set this property, as it will lead to a significant number of cache misses and negate performance gains.