topic Narrow Search Criteria to Specific Folder - Speed Up Vault Search API in Vault Customization Forum

Narrow Search Criteria to Specific Folder - Speed Up Vault Search API

Tiffany_Hayden_ — Thu, 26 Mar 2020 17:17:25 GMT

I found this bit of code in a search and modified some of it for my needs but I'm interested in how to modify it to only search for in a specific folder to speed up my search. For Example I would like to only search to find this file in $\PARTS LIBRARY\ And not search the entire vault for the part. Is this possible?

Private Shared Function FindVaultFileByFileName(connection As VDF.Vault.Currency.Connections.Connection, filename As String) As ACW.File Dim result As ACW.File = Nothing Dim filePropDefs As ACW.PropDef() = connection.WebServiceManager.PropertyService.GetPropertyDefinitionsByEntityClassId("FILE") Dim fileNamePropDef As ACW.PropDef = filePropDefs.[Single](Function(n) n.SysName = "ClientFileName") Dim fileNameMatch As New ACW.SrchCond() fileNameMatch.PropDefId = fileNamePropDef.Id fileNameMatch.PropTyp = ACW.PropertySearchType.SingleProperty fileNameMatch.SrchOper = 3 fileNameMatch.SrchRule = ACW.SearchRuleType.Must fileNameMatch.SrchTxt = filename Dim bookmark As String = String.Empty Dim searchStatus As ACW.SrchStatus = Nothing Dim searchResults As ACW.File() = connection.WebServiceManager.DocumentService.FindFilesBySearchConditions(New ACW.SrchCond() {fileNameMatch}, Nothing, Nothing, False, True, bookmark, searchStatus) If searchResults IsNot Nothing Then If searchResults.Length > 0 Then result = searchResults(0) End If End If Return result End Function

For example:

I'm wanting to edit the "Look In" but do it with the API.

Re: Narrow Search Criteria to Specific Folder - Speed Up Vault Search API

Markus.Koechl — Thu, 26 Mar 2020 17:36:46 GMT

You can add an array of folder IDs to your search. The sample code here expects the paths of folders being included, aggregates its IDs and uses the array of folder Ids in the search method:

/// <summary> /// Find 1 to many file(s) by 1 to many search criteria as property/value pairs. /// Downloads first file matching all or any search criterias. /// Preset Search Operator Options: [Property] is (exactly) [Value]; multiple conditions link up using AND condition. /// Preset Download Options: Download Children (recursively) = Enabled, Enforce Overwrite = True /// </summary> /// <param name="SearchCriteria">Dictionary of property/value pairs</param> /// <param name="MatchAllCriteria">Optional. Switches AND/OR conditions using multiple criterias. Default is true</param> /// <param name="CheckOut">Optional. File downloaded does NOT check-out as default</param> /// <param name="FoldersSearched">Optional. Limit search scope to given folder path(s).</param> /// <returns>Local path/filename</returns> public string GetFileBySearchCriteria(Dictionary<string, string> SearchCriteria, bool MatchAllCriteria = true, bool CheckOut = false, string[] FoldersSearched = null) { //FoldersSearched: Inventor files are expected in IPJ registered path's only. In case of null use these: AWS.Folder[] mFldr; List<long> mFolders = new List<long>(); if (FoldersSearched != null) { mFldr = conn.WebServiceManager.DocumentService.FindFoldersByPaths(FoldersSearched); foreach (AWS.Folder folder in mFldr) { if (folder.Id != -1) mFolders.Add(folder.Id); } } List<String> mFilesFound = new List<string>(); //combine all search criteria List<AWS.SrchCond> mSrchConds = CreateSrchConds(SearchCriteria, MatchAllCriteria); List<AWS.File> totalResults = new List<AWS.File>(); string bookmark = string.Empty; AWS.SrchStatus status = null; while (status == null || totalResults.Count < status.TotalHits) { AWS.File[] mSrchResults = conn.WebServiceManager.DocumentService.FindFilesBySearchConditions( mSrchConds.ToArray(), null, mFolders.ToArray(), true, true, ref bookmark, out status); if (mSrchResults != null) totalResults.AddRange(mSrchResults); else break; } //if results not empty if (totalResults.Count >= 1) { ...

Re: Narrow Search Criteria to Specific Folder - Speed Up Vault Search API

Tiffany_Hayden_ — Thu, 26 Mar 2020 17:43:59 GMT

thank you for your quick reply.

@Markus.Koechl