Search fields are used to search documents. Besides the search fields shown below, you can use all attributes.
| ID | Name | Description | Is searchable? | Search value must match exactly? | Type |
|---|
| fulltext |
fulltext |
The content of the document as text |
true |
false |
String |
| relevance |
hit relevance |
the LUCENE relevance in a search |
false |
false |
Float |
| score |
!score! |
!score.description! |
false |
false |
Long |
| source |
Document Source |
where the document is found. This is depedent on the user. Although you cannot search for this field, the search API has an extra paramter to specify the sources where to search. |
false |
true |
!com.bookpac.server.archive.search.SearchScope! |
| udid |
Document ID |
Global or Database Document ID |
true |
true |
!com.bookpac.server.uid.Uid! |
| currentVersionFormat |
Format |
The format of the current version of the document. For commercial documents, use one of the "Avilable As" attributes in the promotional attributes |
true |
true |
Enumeration (com.bookpac.server.archive.core.Format)
| Value | Description |
|---|
| UNKNOWN | !com.bookpac.server.archive.core.Format.UNKNOWN! |
| TEXT | !com.bookpac.server.archive.core.Format.TEXT! |
| HTML | !com.bookpac.server.archive.core.Format.HTML! |
| RSS | !com.bookpac.server.archive.core.Format.RSS! |
| ATOM | !com.bookpac.server.archive.core.Format.ATOM! |
| PDF | !com.bookpac.server.archive.core.Format.PDF! |
| DOC | !com.bookpac.server.archive.core.Format.DOC! |
| PPT | !com.bookpac.server.archive.core.Format.PPT! |
| XLS | !com.bookpac.server.archive.core.Format.XLS! |
| PNG | !com.bookpac.server.archive.core.Format.PNG! |
| JPG | !com.bookpac.server.archive.core.Format.JPG! |
| BBEB | !com.bookpac.server.archive.core.Format.BBEB! |
| RTF | !com.bookpac.server.archive.core.Format.RTF! |
| FLASH | !com.bookpac.server.archive.core.Format.FLASH! |
| EPUB | !com.bookpac.server.archive.core.Format.EPUB! |
| DOCX | !com.bookpac.server.archive.core.Format.DOCX! |
| PPTX | !com.bookpac.server.archive.core.Format.PPTX! |
| XLSX | !com.bookpac.server.archive.core.Format.XLSX! |
|
| currentVersionAccessType |
Access Type |
The access type of the current version of the document. For commercial documents, use one of the "Avilable As" attributes in the promotional attributes |
true |
true |
Enumeration (com.bookpac.server.archive.drm.ContentAccessControllerType)
| Value | Description |
|---|
| FREE | !com.bookpac.server.archive.drm.ContentAccessControllerType.FREE! |
| PASSWORD_PROTECTED | !com.bookpac.server.archive.drm.ContentAccessControllerType.PASSWORD_PROTECTED! |
| ADEPT_DRM | !com.bookpac.server.archive.drm.ContentAccessControllerType.ADEPT_DRM! |
| CORRUPTED | !com.bookpac.server.archive.drm.ContentAccessControllerType.CORRUPTED! |
|
| currentVersionNumber |
Version |
the number of the current version (starting with 1) |
true |
false |
Long |
| originalURL |
URL |
Original URL |
true |
false |
!com.bookpac.server.archive.searchfield.valuetype.ComparableURL! |
| fileName |
File Name |
File Name |
true |
false |
String |
| displayName |
Display Name |
Display Name |
true |
false |
String |
| owner |
Owner |
Name of the owner of the document |
true |
false |
String |
| previousOwner |
Previous Owner |
Name of the previous Owner of the document |
true |
false |
String |
| creationDate |
Created |
Creation timestamp of the document |
true |
false |
Date according to RFC 3339 |
| modificationDate |
Modified |
Modification timestamp of the document |
true |
false |
Date according to RFC 3339 |
| tag |
Tag |
A personal tag |
true |
false |
String |
| category |
Category Name |
Name of the content category iteself or a parent of the content category (recursive) |
true |
false |
String |
| categoryID |
Category ID |
ID of the content category iteself or a parent of the content category (recursive) |
true |
true |
!com.bookpac.server.uid.Uid! |
| categoryOnly |
Category Name (only) |
Name of the content category |
true |
false |
String |
| categoryOnlyID |
Category ID (only) |
ID of the content category |
true |
true |
!com.bookpac.server.uid.Uid! |
| collectionID |
Collection ID |
ID of the document collection |
true |
true |
!com.bookpac.server.uid.Uid! |
| collectionTitle |
Collection Title |
Name of the document collection |
true |
false |
String |
| collectionDescription |
Collection Description |
Description of the document collection |
true |
false |
String |
| collectionAuthor |
Collection Author |
Name of the owner of the document collection |
true |
false |
String |
