List indexes
The List Indexes feature helps the administrator inspect how objects (documents, folders, emails, and records) are indexed by the Lucene search engine.
On the main screen, a table shows the Lucene-indexed fields of each object.
Common indexed fields:
| Field | Description |
|---|---|
|
# |
Row number |
|
_hibernate_class |
The Hibernate class name:
|
|
uuid |
Object's unique identifier. |
|
parent |
Parent node. |
|
context |
Context values:
|
|
tenant |
Tenant identifier. |
|
author |
ID of the author. |
|
created |
Date the object was created. |
|
name |
Object name. |
|
userPermission |
User permissions. |
|
rolePermission |
Role permissions. |
|
Depending on the type of object (_hibernate_class), there can be more indexed fields. |
|
Search indexes
- On the top right, click on
Search indexes button.
- In the input box, paste an object's UUID (available in the Properties tab when an object is selected in the desktop view).
- Click the Search button.
- From the table list, click on
List icon.
The filtering input box uses the syntax FIELD : value. Here are some examples:
- uuid:ce3338a5-b1ec-481b-9d59-f5aeb3fcf42b
- name:invoice.*
- text:telephone
The following examples illustrate how the filter syntax works. Given two documents called "Parana.doc" and "Parana.pdf", they can be located with:
name:paran*
Using quotation marks will return no results, because wildcards inside quotes are not supported:
name:"paran*"
To locate all PDF documents whose names start with "Paran", use:
name:paran*pdf
This equivalent query also works (note the dot before the extension):
name:paran*.pdf
The following query is invalid because wildcards cannot be used as the first character of a search. This is a Lucene limitation:
name:*pdf
To search by file extension, using the MIME type property is recommended:
mimeType:application/pdf
The following query finds all documents whose names start with "parana" and that have a keyword called "song":
name:parana* AND keyword:song
You can learn more about query syntax at Lucene Query Syntax.
Enable show terms
When show terms is enabled, extra fields named terms are shown on document objects with the terms used by the Lucene search engine to index that document.
- On the top right, click on
Show terms button.
Disable show terms
- On the top right, click on
Show terms button.
