Product Information

Mindbreeze InSpire

Copyright ©

Mindbreeze GmbH, A-4020 Linz, 2017.

All rights reserved. All hardware and software names used are registered trade names and/or registered trademarks of the respective manufacturers.

These documents are highly confidential. No rights to our software or our professional services, or results of our professional services, or other protected rights can be based on the handing over and presentation of these documents. Distribution, publication or duplication is not permitted.

.

.

Overview Permanent link for this heading

This product information (PI) defines the scope of usage and the features of Mindbreeze InSpire services. In addition, it provides an overview of the application interfaces and supported platforms.

Mindbreeze InSpire is a software system enabling the search for information objects in a corporate context ("Enterprise Search Software"). Information objects can be any kind of information contained in structured, partially structured or unstructured storage systems. For most use cases these information objects will be document files in a file system, e-mails in an e-mail box system or documents in a document management system or archive.

System OverviewPermanent link for this heading

Mindbreeze InSpire comprises a multi-stage service-oriented architecture for indexing and searching document files and e-mails on desktop and server computers in enterprises.

For accessing systems containing contents to be indexed (for search) – i.e. data sources – the following architecture components are utilized: index service, filter service, crawler service, query service and client service. The chart below shows the logical components of this architecture.

The above chart shows the system for indexing typical schematic data sources. The components correspond to the essential working steps of the indexing process and will be discussed in the following chapters.

All components communicate based on HTTP/S connections.

Mindbreeze InSpire – Crawler ServicePermanent link for this heading

The crawler searches the source system exhaustively for new and changed contents that need to be indexed.

This can be achieved in two ways:

  • either the crawler searches the source system actively (e.g. file systems) to identify changed data and to forward them to the indexing process or
  • the source system (e.g. DMS) is able to identify all changes itself and forwards this information to the crawler.

Mindbreeze InSpire - Filter ServicePermanent link for this heading

The Mindbreeze InSpire – Filter Service enables extraction and filtering of the textual information from various file types. For this purpose, document files are forwarded by Mindbreeze InSpire - Crawler Service to Mindbreeze InSpire - Filter Service.

Note: As of many proprietary formats the filter service cannot guarantee that the text/HTML output is 100% identical to the original file content.

Mindbreeze InSpire - Index ServicePermanent link for this heading

In this working step, the actual index for full text search is created or updated if the source system was changed. The index store can be considered as storage with index information which optimized to answer search queries.

Mindbreeze InSpire - Query ServicePermanent link for this heading

The clients connect with Mindbreeze InSpire – Query Service to query the index. Query loads can be distributed by utilizing several Mindbreeze InSpire – Query Service and Client Service services. Several types of clients can be used (e.g. Mindbreeze InApp client, to be integrated into third-party products), which can be realised based on Mindbreeze InSpire SDK.

Mindbreeze InSpire – Client ServicePermanent link for this heading

The Mindbreeze InSpire – Web Client connects with the Client Service to send queries to the Query Service.

Mindbreeze InSpire – Management ServicePermanent link for this heading

Mindbreeze InSpire – Management Service enables central configuration and deployment of services for Mindbreeze Enterprise Search.

Mindbreeze InSpire – Advanced ConfigurationPermanent link for this heading

Mindbreeze InSpire – Advanced Configuration helps you to configure a distributed Mindbreeze InSpire infrastructure.

Mindbreeze InSpire – Guided ConfigurationPermanent link for this heading

Mindbreeze InSpire – Guided Configuration helps you to configure a single instance of Mindbreeze InSpire - Index Service with several data sources.

NOTE: The Guided Configuration is supported on Microsoft Windows Platforms only.

Access CheckPermanent link for this heading

An essential component for securing access rights is the so-called access check. The access check ensures that the context of the user logged onto the system is evaluated for any potential search result and applied so that only those search results a user has the appropriate rights for will be displayed. This can be an external authorization of results or the authorization of results against an ACL (access control list) stored in the index. This depends on the data source connected via a specific connector.

Context Interface (CTX)Permanent link for this heading

The context of files and documents that are displayed as search results in a client (within the context of a query) is provided by this component. This enables, for example, the provision of application-specific context menu entries for data and documents in the search result list.

FeaturesPermanent link for this heading

This section shows all features of Mindbreeze InSpire.

Availability and Scalability Permanent link for this heading

  • The server-side Mindbreeze InSpire software architecture is based on redundant units. Mixing operating systems in one infrastructure is not supported.
  • The scaling via hardware units optimizes response times and makes the system highly available. In addition, a redundant structure of backend systems increases availability and in this way avoids a typical "Single Points of Failure".
  • The following redundancy options are possible:
  • The Mindbreeze InSpire – Client Service can be operated redundantly with the use of load balancing hardware.
  • The Mindbreeze InSpire – Query Service can be operated for each physical index redundantly with the use of load balancing hardware.

ExtensibilityPermanent link for this heading

Mindbreeze InSpire comprises the following SDK interfaces:

  • Extensibility of the system via file filters on Microsoft Windows platforms - via the Mindbreeze InSpire - Filter Interface.
  • Connection of additional external data sources via the Mindbreeze InSpire Connector Interface. Mindbreeze provides a Software Development Kit (SDK) for implementation of these interfaces by third-party manufacturers, which is available at http://www.mindbreeze.com/developer.

Mindbreeze InSpire SDK - Support MatrixPermanent link for this heading

The Mindbreeze InSpire SDK was updated for the 2016 Spring Release. Please make sure you use the updated SDK for future development.

Mindbreeze InSpire 2017 Summer Release supports the following SDK versions:

  • Mindbreeze InSpire SDK 2017 Winter|Summer Release
  • Mindbreeze InSpire SDK 2016 Winter|Spring|Summer|Fall Release
  • Mindbreeze InSpire SDK 2015 Winter|Spring|Summer Release
  • Mindbreeze InSpire SDK 2014 Winter|Spring|Summer|Fall Release
  • Mindbreeze InSpire SDK 2013 Spring|Summer|Fall Release

AdministrationPermanent link for this heading

Mindbreeze InSpire provides a central configuration tool for creation, regular maintenance and administration of index catalogues. In addition, this central tool distributes the system components to the servers of the entire system. Central administration comprises all components of Mindbreeze InSpire (Mindbreeze InSpire – Crawler Service, - Filter Service, - Index Service, - Query Service, - Client Service) from a single point.

IndexingPermanent link for this heading

Server-side contents are indexed by Mindbreeze InSpire Crawler Service component at regular intervals. The intervals can be defined for each data source (in seconds).

Software UpdatePermanent link for this heading

Re-indexing is in general not necessary for a software update from version 2016 Spring Release to the current Mindbreeze InSpire product version.

Supported Data Sources Permanent link for this heading

Mindbreeze InSpire 2017 Summer Release supports the data sources listed below for indexing, navigation and interaction during search. Additional data sources can be integrated via the Mindbreeze InSpire Connector Interface and Mindbreeze InSpire Software Development Kit (SDK) made available.

File Systems:

  • Microsoft Windows net shares with user accounts in Microsoft Active Directory are supported. Groups are resolved against Active Directory.
  • Linux/Samba shares are supported, but local groups must be resolvable to LDAP groups/users (Microsoft AD, Univention CS, Samba with OpenLDAP).

Mail Server:

  • Microsoft Exchange Server 2007, Microsoft Exchange Server 2013 (prerequisite: Kerberos authentication and integrated login respectively SAML 2.0 infrastructure according to note)
  • Microsoft Exchange Server 2010 via the Microsoft Exchange Connector Plugin (prerequisite: Kerberos authentication and integrated login respectively SAML 2.0 infrastructure according to note)
  • Microsoft Exchange Server 2013 via the Microsoft Exchange Connector Plugin (prerequisite: Kerberos authentication and integrated login respectively SAML 2.0 infrastructure according to note)

  • EMC Documentum 6.6

Data Integration

  • The Data Integration Connector is used to integrate complex ETL-Processes (Extract, Transform and Load) into Mindbreeze InSpire. Such ETL Processes/Jobs can be created using the Talend Open Studio which will also generate the required Java Code for integration into Mindbreeze InSpire.
    • Access Plugin: Since the permissions of such ETL Processes/Jobs depend mainly on the used data sources a customized Access plugin is required to fulfill the desired access restrictions of the source application. Such a customized Access plugin can be created using the Mindbreeze SDK.
    • Context Plugin: The Context plugin provides for every data object deliverd as search result specific context information (e.g. icon or context-menu with context actions). Such application specific context actions can be developed using the Mindbreeze SDK

SAP

LDAP / Microsoft Active Directory

Microsoft SharePoint 2007 und Microsoft SharePoint 2013

  • Microsoft SharePoint 2007 (Kerberos authentication and integrated login required respectively SAML 2.0 infrastructure according to note)
  • Mindbreeze InSpire – Microsoft SharePoint Crawler can be used to crawl „Document Libraries“ of Microsoft SharePoint datasources, these can be indexed.
  • The following metadata information gets default extracted:
    • listId: ID of a Microsoft SharePoint list
    • sharepointURL: URL of a Microsoft SharePoint server
    • listName: Name of a Microsoft SharePoint list
    • folder: Folder within a document list
    • site: Name of a Microsoft SharePoint site

Web

Mindbreeze InSpire – Web Connector allows to crawl intranet and extranet sources by following links extracted from HTML sources. The following policy can be restricted to different levels: all, site only, link-depth, sitemap. Access restrictions for the Web Connector are set to unrestricted public access, meaning, if you need to restrict access to certain web content you need to implement a plugin based on the Mindbreeze InSpire – Connector Framework (SDK) that fits your situation and need.

Third party components:

Authentication mechanisms with Mindbreeze InSpire Web Client other than Kerberos (e.g. certificate-based authentication, form-based authentication, basic authentication,...) can be established by providing a SAML 2.0 identity provider infrastructure.

Note: Using Mindbreeze InSpire 2015 Client Service together with SAML 2.0 Identity Provider (IdP) was tested exclusively with the SAML 2.0 compliant Shibboleth 2.4.0 IdP. Other SAML 2.0 IdPs may but are not guaranteed to work out of the box.

IMPORTANT NOTE: Operating nodes interleaved between Linux and Windows are only supported for Mindbreeze InSpire - Filter Service, exclusively. A mixed operating system deployment of Mindbreeze InSpire services is not supported.

Supported File TypesPermanent link for this heading

Filters delivered by MindbreezePermanent link for this heading

Microsoft Office:

  • Versions
    • Microsoft Word, Microsoft Power Point, Version 2003 to 2013
    • Microsoft Office: Microsoft Excel, Version ‘97 to 2013
    • Microsoft Outlook 2003 - 2013
  • Formats: PST, MSG, DOC, PPT, XLS, DOCX, PPTX, XLSX

Mail: MBOX, EML

Calendar: ICS

Contact: VCF

Open Document Format: ODT, ODS, ODP

Open Office:

  • Versions
    • OpenOffice.org Version 1.1 to 4.0
    • OpenDocument Version 1.0
  • Formats: SXC, SXD, SXI, SXW

Text files: TXT

Images: BMP, GIF, JPEG, JPG, PNG, TIF, TIFF, PNM, PGM, PPM, PBM, SVG

Web: HTML: CFM, HTM, HTML / XHTML: XHT, XHTM

Audio: MP3, AU, AIF, WAV, MID

Ebook: EPUB

ASCII- and ANSI-based text files (UTF-8)

Archive files: ZIP, JAR

Additional supported formats: PDF (Adobe PDF Format), RTF, URL, XML, COOML, RDF, FLV (Flash-Video), CLASS (Java Class Files)

The Mindbreeze InSpire - Filter Service supports Abbyy FineReader Engine 11 for OCR processing of contents by means of using appropriate Mindbreeze plugins. The 3rd party components (from vendor Abbyy) have to be licensed separately.

NOTE:  Mindbreeze InSpire – Filter Service analyzers and filters files according to their content. A 100% complete and correct filtering of all contents can’t be granted.

Restrictions for using the “Microsoft Outlook PST file” filter:

  • During a delta index run, documents are not removed from the index, even if they were deleted from the indexed PST file.
  • During a delta index run, documents (PST contents) are not removed from the index, even if the indexed PST file itself was deleted.

It is strongly recommended to create a separate index for Microsoft Outlook PST files.

Languages and character codes of the documents:Permanent link for this heading

Mindbreeze InSpire supports the Unicode standard (UTF-8 and UTF-16) – in this way, all language and character set systems defined by this standard are supported.

SearchPermanent link for this heading

OverviewPermanent link for this heading

The queries Mindbreeze InSpire Web Client sets off against server-side contents are taken over by Mindbreeze InSpire - Client Service of Mindbreeze InSpire architecture.

Users can search in one or more index catalogues at the same time using Mindbreeze InSpire Web Client. The catalogues can be located on one or more servers. The search results originating from specific indexes can be displayed or hidden as required by the user.

Search based on words and on phrasesPermanent link for this heading

Mindbreeze InSpire enables an exact search for words (word based search) and for groups of words (phrase search). Such search will only display those results which contain the entire search term (single word or phrase).

Query LanguagePermanent link for this heading

Mindbreeze InSpire has an intuitive query language as known from Internet search engines.

By default, all search terms separated by space characters are forwarded to the search engine via a logic AND operator. A search for phrases can be performed by using quotation marks. The results can be limited by specifying the file type (file extension) and by specifying a category (e-mail, file, etc.) (see user manual).

In addition to the automatic AND operation, the Boolean operators "AND" and "OR" and brackets can be used. This enables performing a more detailed search.

Proximity of words can be used by "NEAR" to display preferably those results where both search terms are closer together.

The search also supports wildcards at the ending of words. The search functionality automatically provides a wildcard search in a special situation. During a search in the "title" metadata, wildcards are implicitly supported at the beginning and at the end of the search term; e.g.; a search for "report" will return results for *report* in the "title" metadata.

Search ResultsPermanent link for this heading

The search results are displayed in the main window according to categories. Depending on the search result, the following categories may be displayed (if there are results in the respective category):

  • Files: The search term(s) is/are contained in the full text of the document or in a selection of the additionally stored metadata.
  • E-mails: The search term is contained in the full text or in common boxes (sender, subject, etc.).
  • Contacts: The search term was found in the data boxes of a Microsoft Exchange/Outlook contact.
  • Calendar: The search term was found in the Microsoft Exchange/Outlook calendar entries.
  • Tasks: The search term was found in the Microsoft Exchange/Outlook tasks.
  • Notes: The search term was found in the Microsoft Outlook/Exchange notes.
  • Application-specific category names defined by integrators: (e.g. Fabasoft Folio): list hits of the respective category with the possibility of assigning subcategories.
  • Images including preview: The search term is contained in the file name or in the directory of an image.

The number of hits selected by the user are displayed for each category. Besides the navigation buttons ("Next", "Back") the hits of each category are dynamically classified to find the result faster. The type and manner of classification depends on the sorting of the result. If the result is sorted by date, classification will be done in time segments. Depending on the dimension of time covered by all results, results of this category will be divided into years, quarters and months (so-called "drill down" over time).

Sorting and grouping of search resultsPermanent link for this heading

This section describes how to preview, highlight search terms and how to range and navigate in search results.

Preview and highlighting of search termsPermanent link for this heading

The main window displays the search results in two levels of detail. The overview only displays essential elements (e.g. name, place or date) to get a relatively quick overview of the results; such display varies according to the metadata which is available for the hits. In the more detailed view, a text preview of the content is provided, trying to display relevant passages of the summary text saved in the index. Each search term is highlighted in a different colour.

RankingPermanent link for this heading

During the search the results are sorted within a category according to semantic relevance or chronologically, displaying the more important or more recent elements first. In the case of a chronological sorting the date of the last modification is used.

Alternatively, a ranking algorithm may be chosen which considers several criteria, including the number of times a search term is contained in a document and in what position (content-based ranking) for calculating a ranking based on the quality of a search result. When searching several phrases, the proximity of the phrases is considered, like when searching with "NEAR".

NavigationPermanent link for this heading

Mindbreeze InSpire allows for a simple and very quick navigation through the search results by means of the contextual navigation elements. In addition to the buttons for browsing (forward and backward), the divisions calculated online and dynamically are available. This enables a behaviour for fast navigation called "drill-down" in database technology. Even without knowing much about a searched object (few search terms), the result can be found simply and quickly.

Contextual ActionsPermanent link for this heading

In addition to opening a result (starting the associated application), Mindbreeze InSpire provides many possibilities for processing the searched object. Depending on the type, the context menu offers options for opening an object with other programs, opening the containing folder, copying the object to the Microsoft Windows clip board or displaying it in the Microsoft Windows Explorer. For each data source (source system) this menu is adapted to the conditions of the data source via the context interface and/or extended.

Search TabsPermanent link for this heading

Mindbreeze InSpire offers so called „Search Tabs“. “Search Tabs” allow to constraint search requests for certain views. “Search Tabs“ are defined in user profile files and can be

  • one setting for all users and/or
  • dedicated settings on a per user basis.

SecurityPermanent link for this heading

Mindbreeze InSpire displays only those search results for which the current user has access rights (at least read-only access)..

For access checking Mindbreeze InSpire supports the following options according to the data source.

  • Online access check for the data source is performed via the correlative Mindbreeze InSpire interface. This secures within all systems to factor all changes in access rights and prevent security risks. If the access check fails the actual displayed content (e.g. a document) is removed from the result list and is not displayed.
  • Within the indexing process Authorization information (ACLs) can be added to the index. This grants a constant search rate without any external dependency. The user has to account a latency for the authorization information in the index.

Supported Platforms and minimum System RequirementsPermanent link for this heading

ServicesPermanent link for this heading

Mindbreeze InSpire comprises the following services:

  • Filter Service
  • Index Service
  • Query Service
  • Client Service
  • Crawler Service

ConnectorsPermanent link for this heading

Mindbreeze InSpire - File System Crawler Service

  • Mindbreeze InSpire (Microsoft Windows-based Appliance)
    • Microsoft Windows file shares and DFS
    • File Systems: FAT32 und NTFS

Mindbreeze InSpire – Microsoft Exchange Crawler Service

  • Microsoft Exchange Server 2007 (64-bit, x64)
  • Microsoft Exchange Server 2010 (64-bit x64)
  • Microsoft Exchange Server 2013 (64-bit x64)

Mindbreeze InSpire Web Connector

Mindbreeze InSpire – Microsoft SharePoint Connector

  • Microsoft SharePoint 2007 (64-bit, x64)
  • Microsoft SharePoint 2010 (64-bit, x64)
  • Microsoft SharePoint 2013 (64-bit, x64)
    • Mindbreeze InSpire – Data Integration Connector

Mindbreeze InSpire – SAP KMC Connector

Mindbreeze InSpire – LDAP/Active Directory Connector

Mindbreeze InSpire – EMC Documentum Connector

  • EMC Documentum 6.6

Supported Client Operating System for Webbrowser Client

  • Operating Systems
    • Microsoft Windows 7 SP1 (x86 and x64; incl. x64-Browser)
    • Microsoft Windows 8.1
    • Microsoft Windows 10 (1607)
    • Apple macOS Sierra (x64)

  • Supported Browsers
    • Internet Explorer 10 (Win 7)
    • Internet Explorer 11 (Win 8.1, Win 10)
    • Firefox 55 (Win 7, Win 8.1, Win 10, Apple macOS)
    • Chrome 61 (Win 7, Win 8.1, Win 10, Apple macOS)
    • iPhone iOS 10.1
    • iPad iOS 10.1

Newer versions are supported, after successful testing and approval as well.

Supported LanguagesPermanent link for this heading

User interface of the software product:

  • English: Mindbreeze InSpire Server Configuration
  • Supported Languages for Mindbreeze InSpire - Web Client User Interface (without help):
    • English
    • German
    • Italian
    • French
    • Bulgarian
    • Croation
    • Portuguese
    • Romanian
    • Serbian
    • Slovak
    • Slovenian
    • Spanish
    • Czech
    • Hungarian
    • Russian
    • Dutch
    • Turkish
    • Norwegian
    • Japanese
    • Chinese (Traditional)
    • Indonesian

Documentation:

  • English/German: Installation and Administration Manual

Important Notes for running Mindbreeze InSpirePermanent link for this heading

  • During the first index-run or during a delta-index-run queries against Mindbreeze InSpire – Query Service are not supported.

Hardware Product InformationPermanent link for this heading

The specification and hardware details are different for the different editions 500K, 1M, 2M, 5M und 10M.

We deliver the hardware with a hardware support: 3 years and next-business-day support.

Condition of UsePermanent link for this heading

  • All statements contained in this software product information concerning designated use and operating conditions of the product exclusively constitute principal information. To ensure and guarantee that the product is used in accordance with the designated use and operating conditions in everyday use, expert training by qualified expert staff is mandatory.
  • Third-party software products that are required or supported by Mindbreeze products, proper licensing and installation of the same, necessary tests prior to product release, as well as appropriate manufacturer support are not included in the scope of delivery and services and, therefore, they are not subject to warranty of Mindbreeze regarding functionality, mode of operation or features. Mindbreeze shall not be liable for errors or malfunctions, which are caused by third-party software products and/or software products that are not included in the scope of delivery and services. Thus, Mindbreeze may only be liable - apart from the other requirements - if it is shown that the third-party products work without errors. In connection with the interaction of hardware and software environments reference is made to the information given in the licence agreement.
  • Mindbreeze does not make any explicit or implicit statements concerning performance or response times of Mindbreeze software products because performance and response times significantly depend on the infrastructure used. For layout, configuration and sizing of the relevant infrastructure please see the information, recommendations and specifications of the relevant manufacturers.
  • In particular no functionalities for backup, restore or disaster recovery are included in the scope of delivery of Mindbreeze products.
  • This product is intended for customary commercial use. This does not include usage that demands special security requirements.
  • The licensor reserves the right to modify the conditions of designated use and the operating conditions of the program, which means that the product manufacturer exclusively holds title to proprietary rights.
  • The customer acknowledges that the customer is exclusively responsible for the protection of its business secrets, trade secrets and professional secrets as well as for safeguarding all protected legal positions and related legal consequences from publication of the customer's work results.