Library.Search

Searches the specified document library.

Parameters

Library.queryField

Specifies which fields to search:

  • ALL - Search all fields (Default)
  • AUTHOR - Search author fields
  • SUBJECT - Search subject fields
Library.queryId

Specifies the name of the library to search. This parameter can be repeated 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:

  • Document.queryFirst Return results starting with the first document found (Default)
  • Document.queryNext Return results starting where the last set of results ended
Library.queryText

Specifies the text to use for the query. If not present or blank, defaults to find all documents.

User.context (Required)

Specifies the context identifier for this user’s session.

Return Values

Value

Description

Library.queryCount

Number of documents requested.

Library.queryField

Search field used.

Library.queryText

Search criteria.

Library.queryId

Libraries searched.

Library.hasMore

1 specifies that 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].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.

User.Access.HTMLDoc

1 enables viewing documents in HTML format (global)

User.Access.HTMLDocNative

1 enables viewing documents in native format (global)

Document[n].allowViewNative

1 enables native viewing for this attachment

Document[n].allowView

1 enables HTML viewing for this attachment

Example

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