SharePoint Server 2013

Transcription

1 SharePoint Server 2013 Content Extract Files Installing the Search Connector in SharePoint Prerequisites Open an elevated command prompt Deploy the solution to SharePoint Set content access account in BDC model file Register protocol handler, search connector and create content source Create a target application in the secure store Configure the start address of the content source Add crawl rules Add file type Configuration of AD Account/Group Mapping IISReset and Search Service Restart Crawl content Configure User Search Experience: Search Refiners Create Managed Properties Configure search refiners Add filter properties to advanced search Configure User Search Experience: Search Result Sources Prerequsites Creating a result source in search administration Configuring Search Vertical Test the new Result Source Extract Files The installation package consists of the following files: File Communardo.ConfluenceSearchConnector.wsp ConfluenceBDCModel.xml SearchConnectorLib.ps1 DeploySolution.ps1 RegisterProtocolHandler.ps1 Description Solution package containing the search connector Business Data Catalog describing the Confluence object model Library used by scripts Deploys the solution to SharePoint register confluence protocol handler register search connector create content source CreateTargetApplicationForConfluenceConnector.ps1 CreateManagedProperties.ps1 CreateManagedMetadataCategory.ps1 Create target application in secure store Create managed properties for crawled Confluence entity properties Creates category for crawled properties ConfluenceTechnicalUserConfigurationUtility.exe Not applicable to SharePoint Server 2013 Copy these files to a directory on your hard drive. This directory will be called SetupDir in the following instructions. In examples SetupDir will be C:\ConnectorForSharePointSearch\Files. The setup path must not contain spaces. Don't delete the setup directory after installation as the file ConfluenceBDCModel.xml needs to be present at all times.

2 Installing the Search Connector in SharePoint The following steps will cause application pool recycles and require IIS to be reset. Consider scheduling a maintenance window. Prerequisites Powershell.exe must be included in your system search path PowerShell Execution Policy must be configured to allow local scripts to be run Exactly one Search Service Application must be present (for the scripts to work ) Exactly one Secure Store Service must be present and configured Open SharePoint Central Administration and check the list of service applications for service applications of the following types: Search Service Application Secure Store Service Application Service applications of these type are needed for the installation to succeed. Note that the actual names might differ from the type (e.g. "Enterprise Search Application"). The following permissions are required for the installation: # Required Permission Account that might have these permissions Reason 1 Execution of PowerShell scripts 2 Running a program as administrator SharePoint installation account (sp_install, sp_setup or similar) SharePoint installation account (sp_install, sp_setup or similar) Needed to run the installation scripts. Note: The Add-SPShellAdmin command grants this permission. 3 Installation of farm solutions SharePoint installation account (sp_install, sp_setup or similar) SharePoint farm account (sp_farm or similar) Needed to install the SharePoint solution. 4 Administration of the Search Service Application SharePoint farm account (sp_farm or similar) Search Service Application administrator account Needed to configure content sources and managed properties. 5 Administration of the Secure Store Service Application SharePoint farm account (sp_farm or similar) Secure Store Service Application administrator account Needed to create a target application in the Secure Store. 6 Permission to design the SharePoint search center owners of the search center site collection Needed for testing the result and adding refiners, etc. Different steps require different permissions. Depending on how your environment is configured you might be able to install everything with one account, but it might be necessary to switch accounts in between. The following steps assume that the SharePoint installation account has all necessary permissions. Each step is marked with the permission number (from above table) that is needed. Log in with the SharePoint installation account. Open an elevated command prompt

3 NEEDED PERMISSIONS: # Click the windows start button to open the start menu Locate the command prompt menu item: All Programs -> Accessories -> Command Prompt Right click on Command Prompt In the pop-up right click menu click "Run as Administrator" Navigate to SetupDir: Use the command prompt to execute the commands in the following steps Deploy the solution to SharePoint NEEDED PERMISSIONS: #1 #3 Use DeploySolution.ps1 which takes the following parameters: Param number Parameter description Value 1 Installation mode Must be install 2 Solution name Must be 'Communardo. ConfluenceSearchConnector.wsp' 3 Absolute path to solution file Example value: 'C: \ConnectorForSharePointSearch\Files\Co mmunardo.confluencesearchconnector. wsp' Example powershell.\deploysolution.ps1 install 'Communardo.ConfluenceSearchConnector.wsp' 'C: \ConnectorForSharePointSearch\Files\Communardo.ConfluenceSearchConnector.wsp' As said above the elevated command prompt opened earlier has to be used to execute this command. If the installation was successful you will see the following status message: Successfully installed solution: Communardo.ConfluenceSearchConnector.wsp Set content access account in BDC model file Open ConfluenceBDCModel.xml in a text editor Replace all occurrences of contentaccessaccount_placeholder with the actual content access account (e.g. contoso\searchservice)

4 Tip You can look up (and configure) the account SharePoint uses as content access account in the Crawl Rule configuration under Specify Authentication: Register protocol handler, search connector and create content source NEEDED PERMISSIONS: #1 #2 #4 Use RegisterProtocolHandler.ps1 which takes the following parameters: Param number Parameter description Value 1 Installation mode Must be install 2 Path to the BDC model file ConfluenceBDCModel.xml Example value: 'C: \ConnectorForSharePointSearch\Files\Confl uencebdcmodel.xml' The ConfluenceBDCModel.xml file must be present at all times at the given path. Example powershell.\registerprotocolhandler.ps1 install 'C:\ConnectorForSharePointSearch\Files\ConfluenceBDCModel.xml' If successful you now have the following content source under Central Administration -> Application management -> Manage service applications -> Search Service Application -> Crawling -> Content Sources: Crawl Servers This step is necessary on all servers that host the Search role. The must be present on these Crawl ConfluenceBDCModel.xml all servers at the same path. Create a target application in the secure store NEEDED PERMISSIONS: #1 #5 Use CreateTargetApplicationForConfluenceConnector.ps1 which takes the following parameters (in this order):

5 Param number Parameter description Value 1 Installation mode Must be install 2 The contact should be a valid address of the primary contact for the Target Application. 3 Target application administrator: The user who has access to manage the Target Application settings. The farm administrator will have access by default. 4 Account of the search filter deamon. This is the content access account of the Search Service Application. Example value: admin@contoso.com Example value: contoso\targetappadmin Example value: consoso\searchsvcapppool You can find this account in the > SharePoint Central Administration > Search Administration > System Status > Default content access account 5 Web service user name User name for Confluence web service login Caution!: This User must be a Confluence user that must be member ofconfluence- administrators There is not required a domain in the username 6 Web service user password Password of above user Example powershell.\createtargetapplicationforconfluenceconnector.ps1 install ' admin@contoso.com' 'contoso\targetappadmin' 'contoso\ searchsvcapppool' 'webserviceadminname' 'webserviceadminpassword' The parameter value for " Web service user password" must not contain a ">". If this should not be avoidable you have to execute the relevant commands from CreateTargetApplicationForConfluenceConnector.ps1 in the Powershell ISE instead of executing the command line from the example above in the elevated command prompt. If you get the error New-SPSecurestoreApplication : Unable to obtain master key. you have to go to your Secure Store Service Application to create a master key. If successful you now have the following entry under Central Administration -> Application management -> Manage service applications -> Secure Store Service: Configure the start address of the content source

6 NEEDED PERMISSIONS: #4 Go to Central Administration -> Application management -> Manage service applications -> Search Service Application -> Crawling -> Content Sources. The content source Confluence Source should be listed there: Click Confluence Source to open the Edit Content Source page: Under Start Addresses there is already an address present which serves as a placeholder. Delete the entry confluence://localhost/. Then enter the start addresses, one per line. Replace <address> with the address of your Confluence installation: confluence://<address>/?entity=space confluence://<address>/?entity=page confluence://<address>/?entity=comment confluence://<address>/?entity=blogentry confluence://<address>/?entity=attachment Important: After the last line there has to be a line break (i.e. a new line)! If you have an ip adress then "confluence:" replaces the " (or " For example, if your Confluence installation is accessible under the start addresses would look like: confluence:// confluence:// confluence:// confluence:// confluence:// If you have multiple Confluence installations you can also add additional start addresses.

7 HTTPS If Confluence uses the https scheme you must configure the start addresses as described here in section "HTTPS Configuration". Add crawl rules Go to Central Administration -> Application management -> Manage service applications -> Search Service Application -> Crawling -> Crawl Rules. Create a new crawl rule by clicking New Crawl Rule. Enter the values in the Add Crawl Rule page like on this screenshot: Click OK to create the crawl rule. Create another new crawl rule by again clicking New Crawl Rule. Enter the values in the Add Crawl Rule page like on this screenshot: Be sure to check Crawl complex URLs. This ensures that all pages of Confluence can be successfully crawled. HTTPS The screenshot uses "http" as schema. Replace this by "https" if your Confluence is accessible via secure connection. Add file type Confluence uses URLs ending with.action which SharePoint detects as action file type. This type must be registered for SharePoint to crawl these pages.

8 Go to Central Administration -> Application management -> Manage service applications -> Search Service Application -> Crawling -> File Types which shows a list of file types already known by SharePoint. If action is already present you can skip to the next step. If not, click Ne w File Type: In the field File extension type action and click OK: The file extension action should now be listed: Configuration of AD Account/Group Mapping If usergroups with different names are used in SharePoint and Confluence, you have to configure the AD-Mapping in order to receive searchresults. Read how: AD Mapping IISReset and Search Service Restart An IISReset and search service restart is required. 1. In the command prompt type iisreset and press the Return key to reset IIS. If applicable you should run the cmd as administrator. 2. Then type net stop osearch15 and press Return to stop the search service. 3. Then type net start osearch15 and press Return to start the search service again. Crawl Servers This step is necessary on all servers that host the Search Crawl role. Crawl content To test the crawling process you have to start a crawl. Go to Central Administration -> Application Management -> Service Applications -> Manage Service Applications -> Search Service Application -> Crawling -> Content Sources. Open the drop down menu of Confluence Source and click Start Full Crawl:

9 Depending on how much content you have in Confluence this can take a while to finish. Refresh the page from time to time (for example by pressing F5) and wait for the Status of the content source to switch to Idle. Verify that crawling succeeded by clicking View Crawl Log in the drop down menu of the content source: The crawl log should show a number of Successes that corresponds with the number of crawlable URLs in your Confluence: If you see Warnings or Errors have a look at the Crawl Log and refer to the Troubleshooting section for help. Configure User Search Experience: Search Refiners NEEDED PERMISSIONS: #6

10 After successful installation of the Connector for SharePoint Search you can extend the user's search experience by providing Refiners and filter options for Confluence results. The following steps do not determine if Confluence results will be presented in search results but rather how. Create Managed Properties This step requires that you already did a successful Full Crawl. Otherwise crawled properties from Confluence will be missing and can't be mapped to managed properties. To have properties like Space Name and Confluence Labels available as refiners to filter search results Managed Properties need to be created in SharePoint. In the command prompt change to the SetupDir directory and run: powershell.\createmanagedproperties.ps1 The script maps crawled properties to managed properties and can only fully succeed if the last full crawl of Confluence found each of the following different types of content: Space Page Page Label Blog Post Blog Post Label Comment Attachment (any of the file types SharePoint actually crawls, like.doc) If any of these types of content is missing, the script will say so. In this case create the content in Confluence, perform a Full Crawl and run the script again. If the managed properties could be successfully created the console output shows something along these lines: Created managed property: ConfluenceLabel Mapped crawled properties Created managed property: ConfluenceSpace Mapped crawled properties Now check that the managed properties are complete: In the Search Service Application, in the left menu under Queries and Results click Search Schema. The list of Managed Properties opens. Make sure it contains the properties ConfluenceLabel and ConfluenceSpace: Now check that they are properly mapped to crawled properties: Click ConfluenceLabel to open the property settings page. Make sure that at Mappings to crawled properties the list contains both BlogEntry. Labels and Page.Labels. Click Cancel to navigate back to the list of properties. Click ConfluenceSpace to open the property settings page. Make sure that at Mappings to crawled properties the list contains BlogEntry. Space, Page.Space, Space.Key, Attachment.Space and Comment.Space. Click Cancel to navigate back to the list of properties. What if crawled properties are missing? Errors during the last Full Crawl can lead to missing crawled properies. For instance if the Full Crawl failed to crawl any attachments the crawled property Attachment.Space will be missing. It will also be missing in the list of crawled properties under Mappings to crawled properties. If this is the case, make sure to fix the crawl errors and perform another Full Crawl to successfully acquire the missing crawled properties. Then add the crawled property manually using the Add Mapping button:

11 Again, don't forget to do a Full Crawl before as new crawled properties are only acquired during the crawl. The script modifies the standard managed property Title of SharePoint. This is necessary for the search results to display Confluence Attachment titles correctly. Unfortunately this change only takes effect after resetting the search index. If you don't reset the search index attachment titles will be displayed with placeholders for spaces, umlauts and special characters (" AN%C3%9C.xlsx"). You can reset the search index in the > SharePoint Central Administration > Search Administration > Index Reset After running the script you (again) must do a Full Crawl for all Confluence content sources. Configure search refiners Prerequisite There is a Search Center set up which you have the rights to modify. Open the Search Center. Open the Search Results page. (The easiest way to open this page is to type something in the search box and search; the page displaying the results is the Search Results page.) On the Search Results page go to Site Actions, click Edit Page: Locate or insert the Refinement Panel web part, move your mouse to the right of its caption and click the arrow to open the drop down menu. In the drop down menu click Edit Web Part:

12 The Refinement Properties open:

13 Click on "Choose Refiners..." and following form opens:

14 Under Available refiners find the ConfluenceLabel and ConfluenceSpace refiners. Add these two refiners to the Selected Refiners and close the form by clicking OK. Close the Refinement web part properties by clicking OK. Then save or publish the page, whichever applies. Searching for content from Confluence will now show you the respective refiners:

15 Label and Space (in the above picture) are now configured as refiners and will show up whenever there is content from Confluence to be refined. Add filter properties to advanced search In the > Search Center > Search Results page click Advanced to open the Advanced Search page:

16 The Advanced Search page can be configured to offer Confluence properties to be used as search restriction. We will extend the drop down menu which appears when you click (Pick Property) : Click on the gear on the upper right corner of the page and then on Edit page:

17 Locate the Advanced Search Box web part, move your mouse to the arrow right of its caption and click the arrow to open the drop down menu. In the menu click Edit Web Part: The panel Advanced Search Box opens. Given you have enough access rights it should contain a Properties section. Expand the section by clicking on the plus left of the caption. Click into the edit field Properties. A button with three dots appears on the right of it. Click it:

18 A text editor opens, containing an XML description of all available properties which can be used for restricting search results:

19 Tip: Copy the text to an editor capable of formatting XML properly to make editing easier. The default XML text should contain the following parts: <PropertyDefs> <PropertyDef> </PropertyDef> <PropertyDef> </PropertyDef> </ PropertyDefs > <ResultTypes> <ResultType> <PropertyRef> </PropertyRef> </ResultType> <ResultType> <PropertyRef> </PropertyRef> </ResultType> </ ResultTypes > Each PropertyDef represents a property. You can now add your own properties. Property for Confluence Space Add this PropertyDef to the XML description. <PropertyDef DisplayName="Space" DataType="text" Name="ConfluenceSpace"/>

20 You can modify the following attributes in the above XML: Display Name name of the Property Now add a reference to this property to every ResultType tag you want it to be available for: <PropertyRef Name="ConfluenceSpace"/> Refiner for Confluence Label Add this category to the XML description. <PropertyDef DisplayName="Label" DataType="text" Name="ConfluenceLabel"/> You can modify the following attributes in the above XML: Display Name the Property name Now add a reference to this property to every ResultType tag you want it to be available for: <PropertyRef Name="ConfluenceLabel"/> When you are finished editing the XML description click OK to close the dialog. In the Page menu click Save to save the changes: Maybe you also have to check in the site. If necessary: To Publish the site click Publish to make the changes available to other users: Now you have additional properties available for filtering: Configure User Search Experience: Search Result Sources Once you installed and configured the search connector you probably want to give your users a better search experience by providing a result source and search link for confluence results.

21 Prerequsites Search connector is installed and working Several items in the index Content Source for confluence exists SharePoint Search Center Creating a result source in search administration In general you can look up this issue in Technet: Configure result sources for search in SharePoint Server 2013 The subsequent instruction is associated with Confluence search results Open Central Administration, Manage Service Applications, Search Service Application Choose Result Sources under Queries and Results 3. Create a new result source (i.e. "Confluence") 4. Fill in the required information on the Add Result Source that is opened 1. General information: set Name and Description according to your preferences (i.e. "Confluence") 2. Protocol: Local SharePoint 3. Type: SharePoint Search Results

22 4. Query Transform: Build a query in order to retrieve only results from the Confluence content source. 5. Credentials information: Default authentication 5. Once your result source is created and configured you will have to wait a couple of minutes until it's indexed Configuring Search Vertical We are assuming you are having a standard sharepoint search center with several search and search-result pages. 1. Go to your search center

23 2. Select Settings and click Add a page. Enter a name for the page and click Create. 3. The created page will be in edit mode (otherwise open the page and choose edit from the settings menu) 1. Edit Search Results Web Part 2. Click > Search Criteria > Change Query

24 3. Select the created Confluence Result Source under > Basics > Select a Query and click OK As an alternative you could use the following configuration: Select a query: Local SharePoint Sites Query text: {searchboxquery} ContentSource:"Confluence Source" Save Web Part and Page Check in and publish the page if neccessary Add the new page as a search vertical (known as search scope in SharePoint 2010) Select Settings and Site Settings to navigate to Site Settings page Select Search Settings from Search section Locate Configure Search Navigation section in Search Settings page. Click Add Link to add a new navigation link.

25 4. Enter a title and the URL of the the newly created page. Click OK. 5. Click OK to exit Search Settings page. Test the new Result Source Navigate to Search Center and perform a search. You will see the new result source being added to search result page.

26 Select the Everything result source and verify that results from various systems will be displayed

27 Select the new result source and verify that only results from Confluence will be displayed Tipp Probably it would be a good idea to add refiners for Confluence, too (see Configure search refiners).