SharePoint Searching Listing FilteringSearching

Once we had SharePoint and the Vault database actually on speaking terms, the next step in the process was to configure the Vault Search feature. SharePoint already has the ability to search within its own database for keywords or filenames, etc. What we want now, is a separate search inside SharePoint that looks at Vault results only. This is where we ran into another snag that had me confused for a while.

Following the instructions in the Vault-SharePoint Integration documentation, I got stuck at step #12. Perhaps this would be a good spot to share this procedure, as it is written, so I can better describe the workaround. This one gets a bit confusing.

Configure Vault Search

1.   At the home page for the site, click the Settings > Site Settings.

2.   Select Search Result Sources under Site Collection Administration

3.   Click Result Sources in the Search group.

4.   Click New Result Source.

5.   Fill in the following data

  • Name: VaultSearch
  • Protocol: OpenSearch 1.0/1.1
  • Query Transform: {searchTerms}
  • Source Url: http://<server>/_layouts/Autodesk.Vault.BCSConnect/VaultSearch.aspx?s={searchTerms}&i={startIndex} Replace [server] with the value of your SP site.
  • Credentials: Anonymous

6.   Click Save

7.   Return to the home page for the site and click the Settings > Site Contents.

8.   Click new subsite

  • Title: Vault Search
  • Web Site Address: http://<server>/vaultsearch
  • Select Basic Search Center in the Enterprise Template tab
  • Select Yes for Navigation Inheritance
  • Click the Create button

9.   Go to the newly created site

10.   Click the Settings > Site Settings

11.   Select Result Sources

12.   Select the Vault Search resource created in step 8 and select Set as Default from the drop-down menu.

13.   Return to the site page and perform a search.

I followed this procedure step by step and everything was working just fine until I got to step #12. When I got to the Site Settings for this newly created sub site, the Vault Search resource was not there to select. This had me baffled, as I knew I was following the steps as they were written, and I had been assured by Autodesk people online that the procedure was correct. No matter how many times I did it though, there was no Vault Search there to Set as Default. Returning to the home page and looking at Result Sources there, I was able to select Vault Search and set it as the default. However, doing this overrode the default SharePoint search and replaced it with my Vault search. Now, no one was able to search for anything in SharePoint.

Finally, after scratching my head for a bit and panicking again, it occurred to me that it didn’t really make sense that the search Result Source had been created at the top level, before the Vault Search sub site was created. To me, it made more sense that the sub site should be created first, and then the search Result Source be created under that. Since I was still in the sandbox I decided to do a little creative playing with the order of this procedure.

Configure Vault Search

  1. At the home page for the site, click Settings > Site Contents.
  2. Click new subsite
  • Title: Vault Search
  • Web Site Address: http://<server>/vaultsearch
  • Select Basic Search Center in the Enterprise Template tab
  • Select Yes for Navigation Inheritance
  • Click the Create button
  1. Go to the newly created site
  2. Click Settings > Site Settings
  3. Select Result Sources
  4. Click New Result Source.

Fill in the following data

  • Name: VaultSearch
  • Protocol: OpenSearch 1.0/1.1
  • Query Transform: {searchTerms}
  • Source Url: http://<server>/_layouts/Autodesk.Vault.BCSConnect/VaultSearch.aspx?s={searchTerms}&i={startIndex} Replace [server] with the value of your SP site.
  • Credentials: Anonymous
  1. Click Save
  2. Return to the home page for the Vault Search sub site (http://<server>/vaultsearch), click Settings > Site Settings.
  3. Select Search Result Sources under Site Collection Administration
  4. Click Result Sources in the Search group.
  5. Select the Vault Search resource created in step 7 and select Set as Default from the drop-down menu.
  6. Return to the sub site page and perform a search.

This revised procedure creates a sub site for the Vault Search, and then creates a SharePoint Search Result Source on that sub site. This keeps the main SharePoint search feature separated from the Vault search, ensuring correct results from each. You can then easily create a link to this Vault Search on the SharePoint site home page, if you want. Here are some images of the search Screen and a typical search result.

Powell SharePoint Search FieldPowell SharePoint Search ResultsListing

To create a list of Vault data to be displayed on a page within SharePoint, go to http://<server>/_layouts/15/Autodesk.Vault.BCSConnect/addVaultlist.aspx

Type in a name for the list, and select a list type from the drop down menu. You can create a list for Vault Files, Items or Change Orders. When finished, click Create List. Make a note of the URL that will be created when you add the list. The format will be: http://<server>/Lists/<listname>/AdskVaultFileFinder.aspx (note: for Items this will be AdskVaultItemFinder.aspx, and for change orders AdskVaultChangeOrderFinder.aspx)
Once you have created a list, you still need to add a link to it on whichever page within your SharePoint site you want to view the results. To do this, navigate to the page within SharePoint and select Settings, Site Contents. At the top of the contents page you should see “add an app”.

SharePoint Add Vault ListsSelecting this will open a page with available apps that can be added to your page. Select “Links“, and give the app a name. This is what will appear on your SharePoint page and is what users will see. The app will appear at the bottom of the page, and under the name you will see “new link or edit this list”. This example is from the CAD page on my home site.

Add SharePoint AppEach of the items you see under the links, is a Vault List created using the steps above. When you select “new link” you are prompted for the web address. This will be the web address from the list you created earlier. There is a link to test your web address to make sure it is correct. Click Save once satisfied, and your Vault List will be added as a link on that page.

SharePoint Vault ListsFiltering

Once you have added a list to a page within SharePoint, it will return all results for the List Type you selected during List creation. So, an Item List will return the entire Item Master as the list results. Depending on how large your Vault database is, this will be more results than you probably want or need. Now you need to add some filters, to narrow the results to a specific set of Items or Files. In this way, for example, you can have a List that shows only those drawings associated with a particular project, on the project’s page in SharePoint.

Select a List from the link you just created in the steps above. Depending on the speed of your network and the size of your database, this could take a while. Once it is loaded, look for the toolbar in the upper right of the screen with Browse, Items & List. Select List and then Modify View.

SharePoint Modify ViewA View in SharePoint is simply a filtered version of the list. You can create many different Views from one List, and then specify one to be the default. Selecting Modify View brings up a screen full of options to narrow the results of this list. The first requirement is to give the view a name. In the future users will be able to select from your list of views by selecting Current View, as seen in the above image.

The section for Columns allows you to choose from a list of properties, preloaded from the Business Connectivity Model, for the Vault object type. Adding or removing columns from this list is covered quite well in the integration documentation, and worked very well in my testing, so I will not go over that in this article. The list of properties will be shown in the list results as a chart from left to right, in the order of their position. By selecting or deselecting the Display check-boxes, and manipulating the Position values, you can customize which properties you want to show and in what order.

SharePoint Configure ColumnsThe next section on the page is Sort. This sort allows you to do just that, sort the results by any of the properties in the list of columns. Data Source Filters is a good one for narrowing down the results of a list. You can filter by Category, State, Vault Folder and Limit. For Change Orders, the filter for Category would not be present. Category allows filtering by a Vault Category, State filters by Vault life cycle state, Vault Folder allows for filtering by specifying a folder path in the Vault project explorer. The correct format is $/1st level folder/next level folder. Limit specifies how many objects will be returned for this list from Vault. The default is 100.

SharePoint Data Source FiltersIn the example above I have filtered a list of Files, based only on a specific folder residing inside Vault. For an even deeper level of restriction on list results, you can use the Filter section to narrow the scope based on specific properties.

SharePoint Filter ConfigurationYou can stack up as many of these property filters as needed to narrow the scope of your results, but be careful that you don’t get too carried away. I recommend adding filters a few at a time, and checking the results. With some trial and error, you will eventually get to the results you want for this custom view. Make notes along the way so you can repeat the process on other pages. In my examples above I was able to narrow a list of the entire project explorer down to a much shorter list of only Autocad drawings from one specific folder. This speeds up display time and cuts down on frustration when a user is looking at a list.

There are other settings on this page that will affect the overall appearance of your lists, play around with them as you have time, but these are the main areas for filtering a list to a smaller group of results. Here is an example of a list which has been filtered down.

SharePoint Vault List ResultsSelecting one of these files will bring up a detail page that gives the user information about the file or item as well as any links to the CAD file itself or to the visualization file.

SharePoint Vault File List Result Detail PageConclusion

So… There you have it. Easy as pie, right? Using the installation document that came with the integration package; Autodesk Vault Professional 2014 – Integrating with Microsoft SharePoint 2013, and these helpful (I hope) tips, in no time at all you will have installed the Autodesk Vault Professional 2015 – Microsoft SharePoint 2013 Integration, set up login credentials, created a search function, and then created and filtered lists which can be placed on any page in your SharePoint site. Now anyone in your company, or even from outside if you grant them access, can use SharePoint to take a look into your Vault and download or print your CAD data. Now, if you feel brave enough, it’s time to move this into a production environment. Remember…. backup everything first! Good luck and….. Enjoy!

“Autodesk® screen shots reprinted with the permission of Autodesk, Inc. Autodesk® , AutoCAD® , DWG, the DWG logo, Vault®, Autocad Electrical® and Inventor® are registered trademarks or trademarks of Autodesk, Inc., and/or its subsidiaries and/or affiliates in the USA and other countries.” Programs and programmers’ information used with permission. Thanks guys!