Search from oscript

JaredAllmond

I am new to builder and oscript, and writing my first module.  We have an Uploads folder off the Enterprise level, but it may have subfolders.  A set or related docs in the Upload folder will share the same identifier as a category attribute.  For example RefNum 00005.  I want to execute a search from within oscript that returns a list of all nodes with a specified matching RefNum.  I have read posts on something about specifying regions so I could set the starting folder as the object id of the Upload folder.  I can't seem to find documentation on how to execute a search within oscript.  Can someone please point me in the right direction?

Kyle_Swidrovich

Hi Jared,

Before delving into search, can your requirement be met with an RDB query?
The LLAttrData table will contain the category/attribute information you mentioned in your post and could be used to locate these items through SQL.

If you still want to attempt to go down the route of search via Oscript, the implementation would really depend on which version of Content Server (Livelink) is being used.

 

As of 9.7.1, the URL-based search API, and the Web Services search interface both call into:

 

   $WEBSBROKER.SearchAPIUtil.Search( prgCtx, request )

 

A search through that interface will follow all directives outlined in the Search API documentation (9.7.1 version is here -- https://knowledge.opentext.com/knowledge/llisapi.dll/Properties/13621465), but it will not follow any output options (e.g., XML vs. HTML).

 

As of 9.7.1, the dspRegion directive is also supported.

However, dspRegions need to be marked as "Displayable" in the region map of the applicable search manager (e.g., Enterprise Search Manager -> Properties -> Regions) before they will be returned.

 

If you have the SDK with Builder, places in code that call the aforementioned function can be located within Oscript and used as reference code.

 

The function will return a raw data structure in the form of an Assoc that contains all search result data.  The results will have already been permission-checked, based on the user's program session passed in as the first parameter (prgCtx).

 

Please keep in mind that at this time, direct use of this internal API and its resultant raw data structure isn't something that Open Text will provide support  for, so there's no available documentation to accompany it.

 

Here's an example:

 

// Simply test search.

 

assoc searchAssoc = assoc.createAssoc()

searchAssoc.where1 = "the"

searchAssoc.prgCtx = prgCtx

searchAssoc.startAt = 1

searchAssoc.goFor = undefined

 

Record searchRequest = Assoc.toRecord( searchAssoc ) Assoc parm = $SEARCHSERVICES.SearchAPIUtil.Search(prgctx,searchRequest)

 

// ***** In 971, Direct calls to the SearchAPIUtil can lead to leaking

//       SearchStats Obects, so after each call, this must be done.

 

if isDefined( $SearchStats )

      // search statistics code

      Object      searchStatistics

      if isFeature( parm.response.data, \

            'searchStatistics') \

            && isNotError( \

            parm.response.data.searchStatistics )

           

            searchStatistics = parm.response.data.searchStatistics

 

      // Skip the store line if you don't need to record the stats.

            searchStatistics.StoreInfo( prgCtx, \

                  parm.request, \

                  parm.response.data.template, \

                  parm.response.data )

      // The delete of the search stats object is the important piece.

           

                  searchStatistics.Delete()

      end

end

 

 

Cheers,

Kyle