List indexes
The List index feature helps the administrator take control of how the objects (documents, folders, emails and records) are indexed in the Lucene search engine.
On the main screen, a table is shown with the Lucene-indexed fields of each object.
Common indexed fields:
| Field | Description |
|---|---|
|
# |
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 |
Indicates when the object was created. |
|
name |
Object name. |
|
userPermission |
User permissions. |
|
rolePermission |
Role permissions. |
|
Depending on the type of object (_hibernate_class), there may be additional indexed fields. |
|
Search indexes
- On the top right, click on
Search indexes button.
- In the input box, copy an object UUID (from the desktop view you can get any object's UUID at the Properties tab; select the UUID and press CTRL+C to copy).
- 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
Let's see an example. Imagine you have two documents called "Parana.doc" and "Parana.pdf". You can locate them by this search:
name:paran*
But be careful, because using quotation marks you won't get any results:
name:"paran*"
If you want to locate all PDF documents whose name starts with "Paran", the correct query is:
name:paran*pdf
This query would also work (note the dot before the extension):
name:paran*.pdf
But this query will fail because you cannot use a * or ? symbol as the first character of a search. This is a Lucene limitation.
name:*pdf
If you want to look up documents with a given extension, I recommend using the MIME Type property this way:
mimeType:application/pdf
In this query we are looking for all documents whose name starts with "parana" and have a keyword called "dog":
name:parana* AND keyword:song
You can learn more about query syntax at Lucene Query Syntax.
Enable show terms
When show terms is enabled, an extra field named terms is 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.
