Skip to main content

xSuite Archive Prism User Guide

The "IndexGroups" configuration node

Index groups combine multiple indexes, allowing the user to search multiple indexes at the same time. An index group may contain hit lists and search forms.

To enable use of an index group, specify the names of the indexes in the IndexNames property. Select existing indices with input help, and define rules to restrict access (i.e., to filter out documents).

Creating an index group

  1. Open Archive Administration.

  2. Open the Archive → IndexGroups configuration node.

  4. Enter a name for the index.

  5. Click Confirm.

    Notice

    To open the properties of the index group directly after creating it, activate the Open node afterwards checkbox.

    ➤ The index group has now been created.

    ➤ You can now edit the properties of the index group.

Editing the properties of an index group

  1. Open Archive Administration.

  2. Click on an index group under Archive → IndexGroups.

    ➣ The properties of the index group will open.

  3. Define the following properties:

    Property

    Description

    IndexNames

    Comma-separated list of indexes that are summarized in the index group

    SuggestionFields

    Controls whether default fields are used.

    • None: no suggestions

    • All: suggestions from all fields

    • Suggestion: suggestions from suggestion fields (indicated by the Suggestion property)

    Notice

    The suggestion function does not serve as a correction for incorrect user input or as a fuzzy search. Only the last five SuggestionFields entries that are very similar to the word entered will be displayed to the user.

    Filter

    Elasticsearch query that restricts the result set

    For information on the syntax, see Query syntax.

    Label

    Display name of the index group

    You can use Locale to define the name for different languages (e.g., de for German and en for English).

  4. Click prism_archive_speichern.png Save.

    ➤ The properties are now saved.

In this section:

Elasticsearch is a search engine based on Apache Lucene. Elasticsearch enables the search and filtering of attachments of various types using plug-ins and Google-like search options. Elasticsearch is only used in xSuite Archive Prism for indexing documents. MongoDB is used for all other storage (except for the file archive storage itself).