Home
Home
German Version
Support
Impressum
20.5 Release ►

    Main Navigation

    • Preparation
      • Connectors
      • Initial Startup for G6 appliances (before January 2018)
      • Initial Startup for G7 appliances
      • Setup InSpire G7 primary and Standby Appliances
    • Datasources
      • Configuration - Atlassian Confluence Connector
      • Configuration - Best Bets Connector
      • Configuration - Data Integration Connector
      • Configuration - Documentum Connector
      • Configuration - Dropbox Connector
      • Configuration - Egnyte Connector
      • Configuration - GitHub Connector
      • Configuration - Google Drive Connector
      • Configuration - GSA Adapter Service
      • Configuration - HL7 Connector
      • Configuration - IBM Connections Connector
      • Configuration - IBM Lotus Connector
      • Configuration - Jira Connector
      • Configuration - JiveSoftware Jive Connector
      • Configuration - JVM Launcher Service
      • Configuration - LDAP Connector
      • Configuration - Microsoft Dynamics CRM Connector
      • Configuration - Microsoft Exchange Connector
      • Configuration - Microsoft File Connector (Legacy)
      • Configuration - Microsoft File Connector
      • Configuration - Microsoft SharePoint Connector
      • Configuration - Salesforce Connector
      • Configuration - SAP KMC Connector
      • Configuration - SemanticWeb Connector
      • Configuration - ServiceNow Connector
      • Configuration - SharePoint Online Connector
      • Configuration - Web Connector
      • Data Integration Guide with SQL Database by Example
      • Indexing user-specific properties (Documentum)
      • Installation & Configuration - Atlassian Confluence Sitemap Generator Add-On
      • Installation & Configuration - Caching Principal Resolution Service
      • Installation & Configuration - Jive Sitemap Generator
      • Mindbreeze InSpire Search Apps in Microsoft SharePoint 2010
      • Mindbreeze InSpire Search Apps in Microsoft SharePoint 2013
      • Mindbreeze InSpire Search Apps in Microsoft SharePoint Online
      • Mindbreeze Web Parts for Microsoft SharePoint
      • User Defined Properties (SharePoint 2013 Connector)
    • Configuration
      • CAS_Authentication
      • Cognito JWT Authentification
      • Configuration - Alternative Search Suggestions and Automatic Search Expansion
      • Configuration - Back-End Credentials
      • Configuration - Chinese Tokenization Plugin (Jieba)
      • Configuration - CJK Tokenizer Plugin
      • Configuration - Collected Results
      • Configuration - CSV Metadata Mapping Item Transformation Service
      • Configuration - Entity Recognition
      • Configuration - Exporting Results
      • Configuration - GSA Late Binding Authentication
      • Configuration - Index-Servlets
      • Configuration - Item Property Generator
      • Configuration - Japanese Language Tokenizer
      • Configuration - Kerberos Authentication
      • Configuration - Management Center Menu
      • Configuration - Metadata Enrichment
      • Configuration - Metadata Reference Builder Plugin
      • Configuration - Notifications
      • Configuration - Personalized Relevance
      • Configuration - Plugin Installation
      • Configuration - Principal Validation Plugin
      • Configuration - Profile
      • Configuration - Reporting Query Logs
      • Configuration - Reporting Query Performance Tests
      • Configuration - Request Header Session Authentication
      • Configuration - Vocabularies for Synonyms and Suggest
      • Configuration of Thumbnail Images
      • Cookie-Authentication
      • Documentation - Mindbreeze InSpire
      • Google Search Appliance Migration to Mindbreeze InSpire
      • I18n Item Transformation
      • Installation & Configuration - Outlook Add-In
      • Installation - GSA Base Configuration Package
      • Language detection - LanguageDetector Plugin
      • Mindbreeze Personalization
      • Mindbreeze Prediction Service Text Classification
      • Mindbreeze Property Expression Language
      • Mindbreeze Query Expression Transformation
      • Non-Inverted Metadata Item Transformer
      • SAML-based Authentication
      • Trusted Peer Authentication for Mindbreeze InSpire
      • Using the InSpire Snapshot for Development in a CI_CD Scenario
    • Operations
      • app.telemetry Statistics Regarding Search Queries
      • Configuration Usage Analysis
      • Deletion of Hard Disks
      • Handbook - Backup & Restore
      • Handbook - Command Line Tools
      • Handbook - Distributed Operation (G7)
      • Handbook - Filemanager
      • Handbook - Synchronized Operation (G6)
      • Index Operating Concepts
      • Indexing and Search Logs
      • Inspire Diagnostics and Resource Monitoring
      • InSpire Support Documentation
      • Mindbreeze InSpire SFX Update
      • Provision of app.telemetry Information on G7 Appliances via SNMPv3
      • Restoring to As-Delivered Condition
    • User Manual
      • Cheat Sheet
      • iOS App
      • Keyboard Operation
    • SDK
      • api.v2.alertstrigger Interface Description
      • api.v2.export Interface Description
      • api.v2.personalization Interface Description
      • api.v2.search Interface Description
      • api.v2.suggest Interface Description
      • api.v3.admin.SnapshotService Interface Description
      • Debugging (Eclipse)
      • Developing an API V2 search request response transformer
      • Developing Item Transformation and Post Filter Plugins with the Mindbreeze SDK
      • Development of Insight Apps
      • Java API Interface Description
    • Release Notes
      • Release Notes 20.1 Release - Mindbreeze InSpire
      • Release Notes 20.2 Release - Mindbreeze InSpire
      • Release Notes 20.3 Release - Mindbreeze InSpire
      • Release Notes 20.4 Release - Mindbreeze InSpire
      • Release Notes 20.5 Release - Mindbreeze InSpire
      • Release Notes 2018 Spring - Mindbreeze InSpire
      • Release Notes 2018 Winter - Mindbreeze InSpire
      • Release Notes 2019 Fall - Mindbreeze InSpire
      • Release Notes 2019 Winter - Mindbreeze InSpire
    • Security
      • Known Vulnerablities
    • Product Information
      • Product Information - Mindbreeze InSpire - Standby
      • Product Information - Mindbreeze InSpire
    Home

    Path

    Index Servlets

    Configuration

    Copyright ©

    Mindbreeze GmbH, A-4020 Linz, 2020.

    All rights reserved. All hardware and software names used are brand names and/or trademarks of their respective manufacturers.

    These documents are strictly confidential. The submission and presentation of these documents does not confer any rights to our software, our services and service outcomes, or any other protected rights. The dissemination, publication, or reproduction hereof is prohibited.

    For ease of readability, gender differentiation has been waived. Corresponding terms and definitions apply within the meaning and intent of the equal treatment principle for both sexes.

    IntroductionPermanent link for this heading

    In order to call index servlets, an index has to be started first; in addition, the checkbox “Disable Unrestricted Privileged Servlets” for this index needs to be unticked. To do this, go to the desired index in the Indices tab of your Mindbreeze InSpire configuration. You’ll need to make sure the “Advanced Settings” are activated first.

    Now you can access the index servlets at:

    https://<Appliance>:8443/index/<IndexPortNr>

    Index ServletsPermanent link for this heading

    AggregatePermanent link for this heading

    You can use this index servlet to obtain aggregated values for documents, such as the number of different document titles. The following options can be configured for this:

    • Column name: Column names of the index can be specified here. They are used for the aggregation.
    • Query constraint: Here you can specify various constraints for the query. For example, filtering by document date. The serach is restricted within system metadata (category, categoryinstance, fqcategory, mes:key, datasource/mes:key, url, extension, mes:uniformdocid, mes:date, mes:size, mes:lang, store:modificationdate, store:creationdate).
    • Aggregation operator: You can choose from four operators here.
    • Concatenation max value count: The maximum number of values to be concatenated can be specified here.
    • Concatenation value order: Specifies how the values for the “CONCAT” function are sorted.
    • Output format: Here you can choose between “csv” and “protobuf_textual” for the output format.

    DocumentsPermanent link for this heading

    You can use this index servlet to search individual documents by their docID, key, or UniformItemID.

    • By docID: Here you can enter the docID of the desired document.
    • By key: Here you can enter the key of the desired document.
    • By UnifomItemID: Here you can enter the UniformItemID of the document.
    • Output format: You can select the format in which the document is to be output and what content is to be displayed.
    • Deleted documents: Here you can specify whether deleted documents should also be included in the search.

    FindPermanent link for this heading

    You can use this index servlet to send search queries to search for documents.

    • Query: Here you can specify a search query like in the standard Mindbreeze search window. The search is restricted within system metadata (category, categoryinstance, fqcategory, mes:key, datasource/mes:key, url, extension, mes:uniformdocid, mes:date, mes:size, mes:lang, store:modificationdate, store:creationdate).
    • Order by: You can specify the criteria by which the documents are to be sorted.
    • Order direction: This lets you choose whether the documents should be sorted in ascending or descending order.
    • Group by: Here you can specify whether the documents should be grouped and according to which criteria.
    • Group by parent reference: Use this to group by references.
    • Group by parent reference mode: Here you can define how far you want to reference.
    • Summarize by property: Here you can combine documents with the same properties, such as a name or file extension.
    • Order summarized by: You can still change the sort order of the summary here.
    • Output format: You can specify the output format in which the results are displayed again here.
    • Diacritic similar terms: Here you can specify whether diacritical entries should also be included in a search. For example, a search for “possibel” will also include “possible.”
    • Requested properties (CSV): Here you can search for specific document properties. Multiple properties are separated by semicolons just like for CSV.

    StatisticsPermanent link for this heading

    Here you can call up statistics for the current index.

    • Detail level: You can specify the level of detail in which the statistics will be output.
    • Output format: Here you can specify the format in which you want the statistics to be output.

    ProcessItemsPermanent link for this heading

    A detailed instruction manual for the index servlet “processitems” can be found here:

    https://help.mindbreeze.com/de/index.php?topic=doc/Konfiguration---Metadaten-Anreicherung/index.htm#privileged-servlets

    Download PDF

    • Configuration - Index-Servlets

    Content

    • Introduction
    • Index Servlets

    Download PDF

    • Configuration - Index-Servlets