|By Corey Roth||
|January 8, 2013 11:00 AM EST||
Every organization wants better search results. However, few have actually spent the time to create file plans, content types, and managed properties to make it happen. SharePoint 2013 has a feature called entity extraction though that can actually infer values by comparing what it finds in the body of the document to a dictionary. This feature is Entity Extraction. If you are familiar with FAST Search for SharePoint or FAST ESP, you know that entity extraction is nothing new. What it does is gives you the power to infer the values of managed properties in search without having metadata in your site columns. FS4SP and SharePoint 2013 come with an extraction dictionaries for company names out-of-the-box. This means when it crawls it will search the contents of the body of your documents and if it recognizes any companies it knows, you can then search and refine on it. However, the true value comes when you create your own. SharePoint 2013 makes it really easy to create these custom dictionaries.
Let me give you a few more examples to help you really understand the significance. Most companies have a concept of a department or business unit. We can create a dictionary with all of the company’s departments such as Accounting, Human Resources, IT, Operations, etc. With entity extraction, if it finds a document and somewhere the text “Human Resources Organization Chart” is found, it then sets the value of the managed property to Human Resources. Now, when the user does an advanced search and says “show me all Human Resources documents”, that result comes back with more confidence. By using the extraction dictionary, we get better results that just using a regular keyword search. Now you may be wondering that’s nothing special, but we can also add other terms, for example, I could add “HR”, and “Benefits” to that dictionary as well and map them to the Human Resources department. Once I have a property defined like this, I can combine it with others as well. This will let us issue queries like “show me all documents from Human Resources with a document type of Policy”.
As another example, you could pre-load SharePoint with a dictionary of product names. For those of you in the energy industry, you could pre-populate it with a list of wells or names of leases. Are you starting to see the significance? In previous versions of SharePoint, we had to set site columns in our document libraries to capture these values either from the user or programmatically. Now with the right dictionary, we can assume the values with a reasonable degree of confidence.
Alright, enough explanation, let’s see this in action and hopefully it will make sense. MSDN has a great post on this but I found and error in it so that is why I am writing this post (plus I know you all like screenshots). For my example, I have a bunch of PowerPoint documents about SharePoint 2013 on my site. I’ve created a custom entity extraction dictionary that will help me refine these documents by feature in SharePoint (i.e.: Apps, Business Intelligence, Search, Social, etc).
Before you build your dictionary file though, you need to decide on what type of extraction to use. You can choose whether you want it to match a word or just part of it. You can also specify whether it needs to match exactly. The MSDN article summarizes this well, but here’s a quick recap of your choices.
- Word Extraction – case-insentive, word has to match, limited to 5 dictionaries
- Word Part Extraction – case-insensitive, only part of a word has to match, limited to 5 dictionaries
- Word Exact Extraction – case-sensitive, word has to match, limited to 1 dictionary
- Word Part Exact Extraction – case-sensitive, only part of a word has to match, limited to 1 dictionary
For today’s example, I am going to use Word Part Extraction as it gives you some of the most flexibility. You might want to use Word Exact Extraction for extracting IDs from a document. For example, you could use it to extract part numbers or invoice numbers. Those aren’t something you would typically want to refine on but you may want to query on them. FAST Search for SharePoint only provided case-sensitive extraction. This made the feature less useful as you had to accommodate all possible varieties of case combinations in your dictionary file.
To get started, we need to create a dictionary file. I started with notepad and I also edited with Excel some. The format is simple “Key,Display form”. The key is what it matches and the Display form is what gets displayed in the refiner. Although the Display form is optional, you want to include it as it allows you to control the exact way the text looks in the refiner (including case sensitivity). Here’s the dictionary file I created.
bcs,Business Connectivity Services
Business Connectivity Services,Business Connectivity Services
wcm,Web Content Management
Web Content Management,Web Content Management
Business Intelligence,Business Intelligence
ecm,Electronic Content Management
Electronic Content Management,Electronic Content Management
Service Application,Service Application
Excel Services,Excel Services
Office Web Apps,Office Web Apps
owa,Office Web Apps
wac,Office Web Apps
My Sites,My Sites
Visio Services,Visio Services
The next step is to use the PowerShell command, Import-SPEnterpriseSearchCustomExtractionDictionary. The documentation on this page is correct which is how I found the solution to my problem. The first step is to get a reference to the Search Service Application using Get-SPEnterpriseSearchServiceApplication. Then for our import command, we pass the service application, the Filename, and the DictionaryName. Here’s where the complexity comes in. The Filename requires a UNC path. That means something like \\servername\path\file.csv. It won’t take a relative path. The next tricky part is where I found an issue in the documentation. I wanted to use the Word Part extraction, it has the case of the word “WordPart” incorrect in the dictionary name. If you do specify the DictionaryName wrong, it will not work. Here are the list of valid values which correspond to the extraction types we talked about above.
- Microsoft.UserDictionaries.EntityExtraction.Custom.Word.n [where n = 1,2,3,4 or 5]
- Microsoft.UserDictionaries.EntityExtraction.Custom.WordPart.n [where n = 1,2,3,4 or 5]
For the non-exact entries, you need to specify a value at the end (1 – 5) which specifies which extraction dictionary it uses. In the case below, I did number 2 since I already messed up number 1 by specifying the dictionary name incorrectly. :)
$searchApp = Get-SPEnterpriseSearchServiceApplication
Import-SPEnterpriseSearchCustomExtractionDictionary –SearchApplication $searchApp –Filename \\server\c$\folder\WordPartExtraction.csv –DictionaryName Microsoft.UserDictionaries.EntityExtraction.Custom.WordPart.2
When you run the commands, it will look like this. I put the above in a script file for convenience.
The next part I believe is a little different than the way you did it with FAST Search for SharePoint. What you need to do is tell search which managed properties to perform entity extraction. Effectively, what we are doing here is telling search to look at the body of the document and see if anything in there matches items in the dictionary. To do this, go to your Search Service Application –> Search Schema and edit the property named body.
Scroll to the bottom and you will see the Custom entity extraction section. Now, we just need to check the box next to the dictionary we want to use. In my case, it is Word Part Extraction – Custom2. If you have multiple dictionaries you may select them here. Save the managed property after you make your selection.
After you save, you need to start a full crawl on your content source, typically Local SharePoint sites.
When this finishes, we can now begin to use our new extracted entities in our search center. The first thing we want to do is add this new extraction to the Refinement web part so that users can refine results by SharePoint feature. Go to your Search Center and issue a query that is going to get you some results that you know you can refine on. In my case, I typed the word SharePoint since I knew all of my documents were related to that. Once you get search results, edit the page. Then on the left side, edit the Refinement web part. Now, click the Choose Refiners button.
This page will list all managed properties marked for refinement. What’s really nice is that when you click on a managed property, it gives you a preview of the available refiners.
In the list of available refiners, I select WordPartCustomRefiner2. Below, you see a list of Sample values and the number of times it found a match. To configure the property, select it and click the Add button. I also added this new refiner up to the top since I want users to see it first.
Now, I gave it a Display name and you have the option to choose a different Display template as well as how it is sorted. You can actually customize how the refiner is rendered on the page with the display template too but that’s outside of the scope of today’s post. At the bottom of the page there is also a Preview button. Click on it and you will see what your search results look like before you even save the page.
If you’re happy with the way the refiners look, save the page, check it in, and publish it. Now issue a query. I am going to use the same one from before.
As you can see, we now see a list of the SharePoint features that we specified in our dictionary. Let’s try a few refiners. Let’s start by selecting Electronic Content Management. I do know that should it read Enterprise, but it was after midnight when I started working on this. :)
Notice, that in the results, that Word Document 3 comes back and you see “ECM” in it. That’s the only text in the document and it matched it to that feature since we defined it in the dictionary. Now let’s try Business Connectivity Services.
It returns several slide decks this time because it mentions it in the Intro deck, the BCS deck, UPS, etc. I’m not sue how Visio Services made a hit to it, but maybe there is something new I need to learn. :)
You can also select multiple refiners. In this case, I selected Apps and Web Content Management.
By now, I am hoping you are seeing the power of entity extraction. It gives you a new level of classification on documents and the users never had to tag anything manually at all.
You can issue queries with these dictionaries as well too. For example, if I want to search for anything tagged with Apps, I would issue the following query.
I hope after reading this post, it has got you started thinking. Most organizations have next to no metadata on their documents. This isn’t a replacement for taking the time to classify your documents properly with site columns and content types. Inferring metadata will never be as good as the users taking the time to classify the documents themselves. However, it is a great stop-gap in dealing with all of that untagged content you have.
I think this is one of the most significant feature in SharePoint 2013 that most people will probably never use. :( Take the time to set up a few dictionaries and you are going to get immediate value out of search and your users are going to notice.
Internet of Things (IoT) will be a hybrid ecosystem of diverse devices and sensors collaborating with operational and enterprise systems to create the next big application. In their session at @ThingsExpo, Bramh Gupta, founder and CEO of robomq.io, and Fred Yatzeck, principal architect leading product development at robomq.io, discussed how choosing the right middleware and integration strategy from the get-go will enable IoT solution developers to adapt and grow with the industry, while at the same time reduce Time to Market (TTM) by using plug and play capabilities offered by a robust IoT ...
Jun. 29, 2015 06:00 PM EDT Reads: 1,705
The Internet of Things is not only adding billions of sensors and billions of terabytes to the Internet. It is also forcing a fundamental change in the way we envision Information Technology. For the first time, more data is being created by devices at the edge of the Internet rather than from centralized systems. What does this mean for today's IT professional? In this Power Panel at @ThingsExpo, moderated by Conference Chair Roger Strukhoff, panelists addressed this very serious issue of profound change in the industry.
Jun. 29, 2015 12:19 PM EDT Reads: 594
SYS-CON Events announced today that BMC will exhibit at SYS-CON's 16th International Cloud Expo®, which will take place on June 9-11, 2015, at the Javits Center in New York City, NY. BMC delivers software solutions that help IT transform digital enterprises for the ultimate competitive business advantage. BMC has worked with thousands of leading companies to create and deliver powerful IT management services. From mainframe to cloud to mobile, BMC pairs high-speed digital innovation with robust IT industrialization – allowing customers to provide amazing user experiences with optimized IT per...
Jun. 29, 2015 12:15 PM EDT Reads: 2,518
There will be 150 billion connected devices by 2020. New digital businesses have already disrupted value chains across every industry. APIs are at the center of the digital business. You need to understand what assets you have that can be exposed digitally, what their digital value chain is, and how to create an effective business model around that value chain to compete in this economy. No enterprise can be complacent and not engage in the digital economy. Learn how to be the disruptor and not the disruptee.
Jun. 29, 2015 11:00 AM EDT Reads: 2,086
Internet of Things is moving from being a hype to a reality. Experts estimate that internet connected cars will grow to 152 million, while over 100 million internet connected wireless light bulbs and lamps will be operational by 2020. These and many other intriguing statistics highlight the importance of Internet powered devices and how market penetration is going to multiply many times over in the next few years.
Jun. 29, 2015 11:00 AM EDT Reads: 1,842
It is one thing to build single industrial IoT applications, but what will it take to build the Smart Cities and truly society-changing applications of the future? The technology won’t be the problem, it will be the number of parties that need to work together and be aligned in their motivation to succeed. In his session at @ThingsExpo, Jason Mondanaro, Director, Product Management at Metanga, discussed how you can plan to cooperate, partner, and form lasting all-star teams to change the world and it starts with business models and monetization strategies.
Jun. 29, 2015 10:00 AM EDT Reads: 1,996
The Internet of Things is not only adding billions of sensors and billions of terabytes to the Internet. It is also forcing a fundamental change in the way we envision Information Technology. For the first time, more data is being created by devices at the edge of the Internet rather than from centralized systems. What does this mean for today's IT professional? In this Power Panel at @ThingsExpo, moderated by Conference Chair Roger Strukhoff, panelists will addresses this very serious issue of profound change in the industry.
Jun. 29, 2015 09:45 AM EDT Reads: 2,383
Business as usual for IT is evolving into a "Make or Buy" decision on a service-by-service conversation with input from the LOBs. How does your organization move forward with cloud? In his general session at 16th Cloud Expo, Paul Maravei, Regional Sales Manager, Hybrid Cloud and Managed Services at Cisco, discusses how Cisco and its partners offer a market-leading portfolio and ecosystem of cloud infrastructure and application services that allow you to uniquely and securely combine cloud business applications and services across multiple cloud delivery models.
Jun. 28, 2015 11:00 AM EDT Reads: 2,142
In his General Session at 16th Cloud Expo, David Shacochis, host of The Hybrid IT Files podcast and Vice President at CenturyLink, investigated three key trends of the “gigabit economy" though the story of a Fortune 500 communications company in transformation. Narrating how multi-modal hybrid IT, service automation, and agile delivery all intersect, he will cover the role of storytelling and empathy in achieving strategic alignment between the enterprise and its information technology.
Jun. 27, 2015 10:00 AM EDT Reads: 2,166
Buzzword alert: Microservices and IoT at a DevOps conference? What could possibly go wrong? In this Power Panel at DevOps Summit, moderated by Jason Bloomberg, the leading expert on architecting agility for the enterprise and president of Intellyx, panelists peeled away the buzz and discuss the important architectural principles behind implementing IoT solutions for the enterprise. As remote IoT devices and sensors become increasingly intelligent, they become part of our distributed cloud environment, and we must architect and code accordingly. At the very least, you'll have no problem fillin...
Jun. 26, 2015 12:00 PM EDT Reads: 2,154
Growth hacking is common for startups to make unheard-of progress in building their business. Career Hacks can help Geek Girls and those who support them (yes, that's you too, Dad!) to excel in this typically male-dominated world. Get ready to learn the facts: Is there a bias against women in the tech / developer communities? Why are women 50% of the workforce, but hold only 24% of the STEM or IT positions? Some beginnings of what to do about it! In her Opening Keynote at 16th Cloud Expo, Sandy Carter, IBM General Manager Cloud Ecosystem and Developers, and a Social Business Evangelist, d...
Jun. 26, 2015 10:00 AM EDT Reads: 2,016
Converging digital disruptions is creating a major sea change - Cisco calls this the Internet of Everything (IoE). IoE is the network connection of People, Process, Data and Things, fueled by Cloud, Mobile, Social, Analytics and Security, and it represents a $19Trillion value-at-stake over the next 10 years. In her keynote at @ThingsExpo, Manjula Talreja, VP of Cisco Consulting Services, discussed IoE and the enormous opportunities it provides to public and private firms alike. She will share what businesses must do to thrive in the IoE economy, citing examples from several industry sectors.
Jun. 25, 2015 02:00 PM EDT Reads: 1,959
In his keynote at 16th Cloud Expo, Rodney Rogers, CEO of Virtustream, discussed the evolution of the company from inception to its recent acquisition by EMC – including personal insights, lessons learned (and some WTF moments) along the way. Learn how Virtustream’s unique approach of combining the economics and elasticity of the consumer cloud model with proper performance, application automation and security into a platform became a breakout success with enterprise customers and a natural fit for the EMC Federation.
Jun. 25, 2015 01:30 PM EDT Reads: 2,110
SYS-CON Events announced today that the "Second Containers & Microservices Conference" will take place November 3-5, 2015, at the Santa Clara Convention Center, Santa Clara, CA, and the “Third Containers & Microservices Conference” will take place June 7-9, 2016, at Javits Center in New York City. Containers and microservices have become topics of intense interest throughout the cloud developer and enterprise IT communities.
Jun. 22, 2015 02:15 PM EDT Reads: 2,634
SYS-CON Events announced today that the "First Containers & Microservices Conference" will take place June 9-11, 2015, at the Javits Center in New York City. The “Second Containers & Microservices Conference” will take place November 3-5, 2015, at Santa Clara Convention Center, Santa Clara, CA. Containers and microservices have become topics of intense interest throughout the cloud developer and enterprise IT communities.
Jun. 20, 2015 12:00 PM EDT Reads: 3,815
With major technology companies and startups seriously embracing IoT strategies, now is the perfect time to attend @ThingsExpo in Silicon Valley. Learn what is going on, contribute to the discussions, and ensure that your enterprise is as "IoT-Ready" as it can be! Internet of @ThingsExpo, taking place Nov 3-5, 2015, at the Santa Clara Convention Center in Santa Clara, CA, is co-located with 17th Cloud Expo and will feature technical sessions from a rock star conference faculty and the leading industry players in the world. The Internet of Things (IoT) is the most profound change in personal an...
Jun. 15, 2015 08:45 PM EDT Reads: 4,044
17th Cloud Expo, taking place Nov 3-5, 2015, at the Santa Clara Convention Center in Santa Clara, CA, will feature technical sessions from a rock star conference faculty and the leading industry players in the world. Cloud computing is now being embraced by a majority of enterprises of all sizes. Yesterday's debate about public vs. private has transformed into the reality of hybrid cloud: a recent survey shows that 74% of enterprises have a hybrid cloud strategy. Meanwhile, 94% of enterprises are using some form of XaaS – software, platform, and infrastructure as a service.
Jun. 15, 2015 07:15 PM EDT Reads: 3,832
The 17th International Cloud Expo has announced that its Call for Papers is open. 17th International Cloud Expo, to be held November 3-5, 2015, at the Santa Clara Convention Center in Santa Clara, CA, brings together Cloud Computing, APM, APIs, Microservices, Security, Big Data, Internet of Things, DevOps and WebRTC to one location. With cloud computing driving a higher percentage of enterprise IT budgets every year, it becomes increasingly important to plant your flag in this fast-expanding business opportunity. Submit your speaking proposal today!
Jun. 15, 2015 10:15 AM EDT Reads: 5,887
In his keynote at 16th Cloud Expo, Rodney Rogers, CEO of Virtustream, discusses the evolution of the company from inception to its recent acquisition by EMC – including personal insights, lessons learned (and some WTF moments) along the way. Learn how Virtustream’s unique approach of combining the economics and elasticity of the consumer cloud model with proper performance, application automation and security into a platform became a breakout success with enterprise customers and a natural fit for the EMC Federation.
Jun. 11, 2015 08:00 AM EDT Reads: 2,285
The 4th International Internet of @ThingsExpo, co-located with the 17th International Cloud Expo - to be held November 3-5, 2015, at the Santa Clara Convention Center in Santa Clara, CA - announces that its Call for Papers is open. The Internet of Things (IoT) is the biggest idea since the creation of the Worldwide Web more than 20 years ago.
Jun. 10, 2015 06:00 PM EDT Reads: 3,275