Library.Search

Searches the specified document library.

Parameters

Library.queryField

Specifies which fields to search:

  • ALLSearch all fields (Default)
  • AUTHORSearch author fields
  • SUBJECTSearch subject fields
Library.queryId

Specifies the name of the library to search (can repeat to search as many libraries as desired).

Library.queryCount

Specifies how many documents to retrieve.

Library.queryType:

Specifies whether to query from the beginning of the list or the current position (defaults to the beginning of the list):

  • Document.queryFirst Start from beginning
  • Document.queryNext Start from the current position
Library.queryText:

Specifies the text to use for the query. If not present (or blank), all documents will be found.

Returns

Library.queryCount

Number of document requested.

Library.queryField

Search field used.

Library.queryText

Search criteria.

Library.queryId

Libraries searched.

Library.hasMore

1 = More documents were found than what was returned.

Document.count

Number of documents found.

Document[n].Library.id

Library identifier of the nth document.

Document[n].id

Document number of the nth document.

Document[n].version

Document version of the nth document.

Document[n].author

Author of the nth document.

Document[n].size

Size of the nth document.

Document[n].subject

Subject of the nth document.

Document[n].extension

Document file extension of the nth document.

Document[n].allowViewNative

1 enables native viewing for the document.

Document[n].allowView

1 enables HTML viewing for the document.

Document[n].Profile.createDate

Creation date of the nth document.

Document[n].Profile.modifyDate

Modification date of the nth document.

Document[n].Profile.officialVersion

Official version of the nth document.

Document[n].Profile.currentVersion

Current version of the nth document.

Document[n].Profile.versionCount

Number of versions for the nth document.

Example

<A href=/servlet/webpub?User.context=xyz&action=
Library.Search&Library.queryField=ALL&Library.queryId=
Lib1&Library.queryId=Lib2&Library.queryText=
WebAccess+Documents"> WebAccess Documents </A>