Home
Home
German Version
Support
Impressum
25.2 Release ►

Start Chat with Collection

    Main Navigation

    • Preparation
      • Connectors
      • Create an InSpire VM on Hyper-V
      • Initial Startup for G7 appliances
      • Setup InSpire G7 primary and Standby Appliances
    • Datasources
      • Configuration - Atlassian Confluence Connector
      • Configuration - Best Bets Connector
      • Configuration - Box Connector
      • Configuration - COYO 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 - JVM Launcher Service
      • Configuration - LDAP Connector
      • Configuration - Microsoft Azure Principal Resolution Service
      • Configuration - Microsoft Dynamics CRM Connector
      • Configuration - Microsoft Exchange Connector
      • Configuration - Microsoft File Connector (Legacy)
      • Configuration - Microsoft File Connector
      • Configuration - Microsoft Graph Connector
      • Configuration - Microsoft Loop Connector
      • Configuration - Microsoft Project Connector
      • Configuration - Microsoft SharePoint Connector
      • Configuration - Microsoft SharePoint Online Connector
      • Configuration - Microsoft Stream Connector
      • Configuration - Microsoft Teams Connector
      • Configuration - Salesforce Connector
      • Configuration - SCIM Principal Resolution Service
      • Configuration - SemanticWeb Connector
      • Configuration - ServiceNow Connector
      • Configuration - Web Connector
      • Configuration - Yammer 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 - Mindbreeze InSpire Insight Apps in Microsoft SharePoint On-Prem
      • Mindbreeze InSpire Insight Apps in Microsoft SharePoint Online
      • Mindbreeze Web Parts for Microsoft SharePoint
      • User Defined Properties (SharePoint 2013 Connector)
      • Whitepaper - Mindbreeze InSpire Insight Apps in Salesforce
      • Whitepaper - Web Connector - Setting Up Advanced Javascript Usecases
    • Configuration
      • CAS_Authentication
      • Configuration - Alerts
      • 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 - External Query Service
      • Configuration - Filter Plugins
      • Configuration - GSA Late Binding Authentication
      • Configuration - Identity Conversion Service - Replacement Conversion
      • Configuration - InceptionImageFilter
      • Configuration - Index-Servlets
      • Configuration - InSpire AI Chat and Insight Services for Retrieval Augmented Generation
      • Configuration - Item Property Generator
      • Configuration - Japanese Language Tokenizer
      • Configuration - Kerberos Authentication
      • Configuration - Management Center Menu
      • Configuration - Metadata Enrichment
      • Configuration - Metadata Reference Builder Plugin
      • Configuration - Mindbreeze Proxy Environment (Remote Connector)
      • 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 - Shared Configuration (Windows)
      • Configuration - Vocabularies for Synonyms and Suggest
      • Configuration of Thumbnail Images
      • Cookie-Authentication
      • Documentation - Mindbreeze InSpire
      • I18n Item Transformation
      • Installation & Configuration - Outlook Add-In
      • Installation - GSA Base Configuration Package
      • JWT Authentication
      • Language detection - LanguageDetector Plugin
      • Mindbreeze Personalization
      • Mindbreeze Property Expression Language
      • Mindbreeze Query Expression Transformation
      • SAML-based Authentication
      • Trusted Peer Authentication for Mindbreeze InSpire
      • Using the InSpire Snapshot for Development in a CI_CD Scenario
      • Whitepaper - AI Chat
      • Whitepaper - Create a Google Compute Cloud Virtual Machine InSpire Appliance
      • Whitepaper - Create a Microsoft Azure Virtual Machine InSpire Appliance
      • Whitepaper - Create AWS 10M InSpire Appliance
      • Whitepaper - Create AWS 1M InSpire Appliance
      • Whitepaper - Create AWS 2M InSpire Appliance
      • Whitepaper - Create Oracle Cloud 10M InSpire Application
      • Whitepaper - Create Oracle Cloud 1M InSpire Application
      • Whitepaper - MMC_ Services
      • Whitepaper - Natural Language Question Answering (NLQA)
      • Whitepaper - SSO with Microsoft AAD or AD FS
      • Whitepaper - Text Classification Insight Services
    • Operations
      • Adjusting the InSpire Host OpenSSH Settings - Set LoginGraceTime to 0 (Mitigation for CVE-2024-6387)
      • app.telemetry Statistics Regarding Search Queries
      • CIS Level 2 Hardening - Setting SELinux to Enforcing mode
      • Configuration - app.telemetry dashboards for usage analysis
      • Configuration - Usage Analysis
      • Deletion of Hard Disks
      • Handbook - Backup & Restore
      • Handbook - Command Line Tools
      • Handbook - Distributed Operation (G7)
      • Handbook - Filemanager
      • Handbook - Indexing and Search Logs
      • Handbook - Updates and Downgrades
      • Index Operating Concepts
      • Inspire Diagnostics and Resource Monitoring
      • Provision of app.telemetry Information on G7 Appliances via SNMPv3
      • Restoring to As-Delivered Condition
      • Whitepaper - Administration of Insight Services for Retrieval Augmented Generation
    • User Manual
      • Browser Extension
      • Cheat Sheet
      • iOS App
      • Keyboard Operation
    • SDK
      • api.chat.v1beta.generate Interface Description
      • 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 a Query Expression Transformer
      • Development of Insight Apps
      • Embedding the Insight App Designer
      • Java API Interface Description
      • OpenAPI 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 21.1 Release - Mindbreeze InSpire
      • Release Notes 21.2 Release - Mindbreeze InSpire
      • Release Notes 21.3 Release - Mindbreeze InSpire
      • Release Notes 22.1 Release - Mindbreeze InSpire
      • Release Notes 22.2 Release - Mindbreeze InSpire
      • Release Notes 22.3 Release - Mindbreeze InSpire
      • Release Notes 23.1 Release - Mindbreeze InSpire
      • Release Notes 23.2 Release - Mindbreeze InSpire
      • Release Notes 23.3 Release - Mindbreeze InSpire
      • Release Notes 23.4 Release - Mindbreeze InSpire
      • Release Notes 23.5 Release - Mindbreeze InSpire
      • Release Notes 23.6 Release - Mindbreeze InSpire
      • Release Notes 23.7 Release - Mindbreeze InSpire
      • Release Notes 24.1 Release - Mindbreeze InSpire
      • Release Notes 24.2 Release - Mindbreeze InSpire
      • Release Notes 24.3 Release - Mindbreeze InSpire
      • Release Notes 24.4 Release - Mindbreeze InSpire
      • Release Notes 24.5 Release - Mindbreeze InSpire
      • Release Notes 24.6 Release - Mindbreeze InSpire
      • Release Notes 24.7 Release - Mindbreeze InSpire
      • Release Notes 24.8 Release - Mindbreeze InSpire
      • Release Notes 25.1 Release - Mindbreeze InSpire
      • Release Notes 25.2 Release - Mindbreeze InSpire
    • Security
      • Known Vulnerablities
    • Product Information
      • Product Information - Mindbreeze InSpire - Standby
      • Product Information - Mindbreeze InSpire
    Home

    Path

    Sure, you can handle it. But should you?
    Let our experts manage the tech maintenance while you focus on your business.
    See Consulting Packages

    Management Center Menu
    Configuration

    IntroductionPermanent link for this heading

    In the InSpire Management Center it is possible to store your own menu items or to overwrite them. For example, CSV files or text files can be directly integrated into the Mindbreeze Management Center and edited. The authorizations are still checked according to the backend credentials.

    Roles (from Spring Release 2018 HF3) or resource.json (before Spring Release 2018 HF3)Permanent link for this heading

    Depending on which variant is used (roles or resource.json), the documentation is differentiated as follows

    RolesPermanent link for this heading

    All menu items are displayed via roles if no resource.json is available. Otherwise the menu will be loaded in the usual way (see resource.json).

    Attention: This feature is only available with CentOS 7.

    Users can be managed in the Management Center under "Credentials". For more information, see Configuration - Backend Credentials.

    Important: Every user using the Management Center must have the role "InSpire Overview User".

    Roles with menu itemsPermanent link for this heading

    Role

    Displayed menu items

    InSpire Administrator

    Search Apps, Reporting, Search Experience, Services, Configuration, Setup, Update, System

    InSpire app.telemetry Administrator

    Reporting

    InSpire Client User

    Search Apps (Not Insight Apps)

    InSpire Config Administrator

    Configuration

    InSpire Services Administrator

    Services

    InSpire Vocabulary Administrator

    Search Experience (Synonyms, Replacements, Vocabulary)

    InSpire Relevance Administrator

    Search Apps, Search Experience (Query Boosting, Relevanz)

    InSpire Resource Administrator

    Search Apps, Search Experience (Complete incl. Plugins)

    InSpire Insight Services Administrator

    Insight Services

    Available menu itemsPermanent link for this heading

    If roles are available (data/resources/resource.json does not exist) the menu items are as follows.

    menu.admin.jsonPermanent link for this heading

    {

      "entries": [{

        "priority": 700,

        "id": "update",

        "title": "Update",

        "icon": "upload",

        "submenu": [{

          "priority": 10,

          "title": "Upload",

          "href": "adminapps/services/update/upload/form",

          "icon": "upload",

          "unsupportedBrowsers": ["Edge"]

        }, {

          "priority": 20,

          "title": "Perform Update",

          "href": "adminapps/services/update/update/form",

          "icon": "refresh",

          "unsupportedBrowsers": ["Edge"]

        }]

      },

      {

        "priority": 600,

        "id": "setup",

        "title": "Setup",

        "icon": "cogs",

        "submenu": [{

            "priority": 10,

            "title": "Kerberos",

            "href": "adminapps/services/krb5config",

            "icon": "lock"

          },

          {

            "priority": 20,

            "title": "Credentials",

            "href": "auth/admin/master/console/#/realms/master/users",

            "icon": "users",

            "unsupportedBrowsers": ["IE"]

          },

          {

            "priority": 30,

            "title": "InSpire",

            "href": "update/settings/form",

            "icon": "tasks"

          },

          {

            "priority": 40,

            "title": "SSL Certificate",

            "href": "adminapps/services/update/upload/certificateform",

            "icon": "certificate",

            "unsupportedBrowsers": ["Edge"]

          }

        ]

      },

      {

        "priority": 900,

        "submenu": [],

        "icon": "folder",

        "id": "filesystem",

        "title": "File Manager"

      }]

    }]

    }

    menu.config.jsonPermanent link for this heading

    {

      "entries": [{

        "priority": 500,

        "id": "configuration",

        "title": "Configuration",

        "href": "config",

        "icon": "wrench"

      }]

    }

    menu.relevance.jsonPermanent link for this heading

    {

      "entries": [{

        "priority": 300,

        "id": "searchexperience",

        "title": "Search Experience",

        "icon": "search",

        "submenu": [{

          "priority": 30,

          "id": "searchexperience",

          "title": "Query Boostings",

          "icon": "list-alt",

          "filepath": "relevance/term2documentboost.csv",

          "type": "csv"

         },{

          "priority": 70,

          "id": "searchexperience",

          "title": "Relevance",

          "icon": "list-alt",

          "type": "layout",

          "grid": [{

            "href": "{{client_url}}/apps/client/index.html?relevance-info=true",

            "type": "url",

            "class": "col-md-8 search-client"

          },{

            "class": "col-md-4",

            "grid": [{

              "filepath": "relevance/relevance.json",

              "type": "json",

              "class": "col-md-12",

              "height": "50%"

            },{

              "filepath": "relevance/term2documentboost.csv",

              "type": "csv",

              "class": "col-md-12 mb-hidden-overflow",

              "height": "50%"

            }]

          }]

         }]

      }]

    }

    menu.reporting.jsonPermanent link for this heading

    {

      "entries": [{

        "priority": 200,

        "id": "reporting",

        "title": "Reporting",

        "icon": "bar-chart-o",

        "submenu": [{

          "priority": 10,

          "title": "Telemetry Details",

          "href": "apptelemetry/#application-view!noSplash:1",

          "icon": "tasks"

        }, {

          "priority": 20,

          "title": "Appliance Health",

          "href": "apptelemetry/#status-view!noSplash:1",

          "icon": "medkit"

        }, {

          "priority": 30,

          "title": "Performance",

          "href": "apptelemetry/#dashboard-view!dashboardId:10097!noSplash:1",

          "icon": "dashboard"

        }, {

          "priority": 40,

          "title": "Search Experience",

          "href": "apptelemetry/#dashboard-view!dashboardId:10103!noSplash:1",

          "icon": "th-list"

        }, {

         "priority": 50,

          "id": "queryLogs",

          "title": "Query Logs",

         "icon": "list-alt",

          "href": "mindbreeze-inspire-query-logs"

        }, {

         "priority": 60,

          "id": "queryperformanceTests",

         "title": "Query Performance Testing",

         "icon": "dashboard",

          "href": "mindbreeze-inspire-query-performance-testing"

       }]

      }]

    }

    menu.resources.jsonPermanent link for this heading

    {

      "entries": []

    }

    menu.resources.plugins.jsonPermanent link for this heading

    {

      "entries": []

    }

    menu.searchapps.jsonPermanent link for this heading

    {

      "entries": [{

        "priority": 100,

        "id": "searchapps",

        "title": "Search Apps",

        "icon": "th-large",

        "submenu": [{

            "priority": 10,

            "title": "Client",

            "href": "{{client_url}}/",

            "icon": "search"

          },

          {

            "priority": 30,

            "title": "Designer",

            "href": "{{client_url}}/apps/editor/",

            "icon": "edit"

          }

        ]

      }]

    }

    menu.insightapps.jsonPermanent link for this heading

    {

      "entries": [{

        "priority": 100,

        "id": "searchapps",

        "title": "Insight Apps",

        "titlesI18n": {

          "de": "Insight Apps",

          "en-US": "Insight Apps"

        },

        "icon": "th-large",

        "submenu": [{

            "priority": 20,

            "title": "Insight Apps",

            "titlesI18n": {

              "de": "Insight Apps",

              "en-US": "Insight Apps"

            },

            "href": "{{client_url}}/apps/?saveMode=true&storeURL={{encoded_host_url}}&storeProtocol=postMessage",

            "icon": "edit"

          }

        ]

      }]

    }

    menu.services.jsonPermanent link for this heading

    {

      "entries": [{

        "priority": 400,

        "id": "services",

        "title": "Services",

        "href": "adminapps/services",

        "icon": "cog"

      }]

    }

    menu.vocabulary.jsonPermanent link for this heading

    {

      "entries": [{

        "priority": 300,

        "id": "searchexperience",

        "title": "Search Experience",

        "icon": "search",

        "submenu": [{

          "priority": 10,

          "id": "searchexperience",

          "title": "Synonyms",

          "icon": "list-alt",

          "filepath": "vocabulary/synonyms.txt",

          "type": "text"

         },{

          "priority": 20,

          "id": "searchexperience",

          "title": "Replacements",

          "icon": "list-alt",

          "filepath": "vocabulary/replacements.csv",

          "type": "csv"

         },{

          "priority": 40,

          "id": "searchexperience",

          "title": "Vocabulary",

          "icon": "list-alt",

          "filepath": "vocabulary/vocabulary.csv",

          "type": "csv"

       }]

      }]

    }

    menu.insight.services.jsonPermanent link for this heading

    {

      "entries": [

        {

          "priority": 150,

          "id": "insights",

          "title": "Insight Services",

          "titlesI18n": {

            "de": "Insight Services",

            "en-US": "Insight Services"

          },

          "icon": "bar-chart-o",

          "submenu": [

            {

              "priority": 10,

              "id": "text-classification",

              "title": "Text Classification",

              "titlesI18n": {

                "de": "Textklassifizierung",

                "en-US": "Text Classification"

              },

              "icon": "list-alt",

              "href": "text-classification"

            },

            {

              "priority": 11,

              "id": "rag",

              "title": "RAG",

              "services": "mindbreeze.plugins.insight.services.rag",

              "titlesI18n": {

                "de": "RAG",

                "en-US": "RAG"

              },

              "icon": "list-alt",

              "href": "rag"

            }

          ]

        }

      ]

    }

    Expand and customize the menu using JSON FilesPermanent link for this heading

    DirectoryPermanent link for this heading

    The adapted JSON files must be stored in the directory: /data/resources/mmc/ and correspond to the following pattern:

    menu.{{menu item}}. json.overwrite

    StructurePermanent link for this heading

    A JSON file must consist of a header part and an entries part.

    • header
      • Mergestragety:
        • replace: The entire menu entry is replaced.
        • keepbuiltin: The menu entry is extended with the entries
        • Default value is "replace".
      • Roles:
        • Which users are allowed to see this menu item?
        • Default value is all users
    • entries
      • If "replace"
        • id (without spaces and written in lower case; in "submenu" the ID of the parent element must be used)
        • priority
        • title
        • icon
        • href
        • filepath (only if “href” is not used)
        • type (only if “filepath” is used; supported types: “text”, “csv”)
        • submenu (optional)
      • When "keepbuiltin"
        • id
        • submenu

    ExamplesPermanent link for this heading

    Overwrite a pluginPermanent link for this heading

    Plugins must be overwritten in the directory with the pattern "menu.resources.plugin.{{plugin-id}}.json.overwrite”.

    menu.resources.plugin.[bestbets].json.overwrite

    {

      "header": {

        "mergestrategy": "keepbuiltin",

        "roles": [

          "InSpire Resource Administrator"

        ]

      },

      "entries": [{

        "id": "searchexperience",

        "submenu": [{

          "priority": 35,

          "id": "searchexperience",

          "title": "Suggested Sites 2",

          "icon": "list-alt",

          "filepath": "bestbets.csv",

          "type": "csv"

         }]

      }]

    }

    Overwrite Vocabulary (Search Experience)Permanent link for this heading

    menu.vocabulary.json.overwrite

    {

      "header": {

        "mergestrategy": "replace",

        "roles": [

          "InSpire Administrator"

        ]

      },

      "entries": [{

        "priority": 300,

        "id": "searchexperience",

        "title": "New Search Experience",

        "icon": "search",

        "submenu": [{

          "priority": 10,

          "id": "searchexperience",

          "title": "Synonyms Neu",

          "icon": "list-alt",

          "filepath": "vocabulary/synonyms.txt",

          "type": "text"

         }]

      }]

    }

    Overwrite ConfigPermanent link for this heading

    menu.config.json.overwrite

    {

      "header": {

        "roles": [

          "InSpire Administrator"

        ]

      },

      "entries": [{

        "priority": 500,

        "id": "configuration",

        "title": "Configuration Neu",

        "href": "config",

        "icon": "wrench"

      }]

    }

    Resource.jsonPermanent link for this heading

    PreparationPermanent link for this heading

    To customize the menu in the Mindbreeze Management Center, you need the file "resources.json", which is located under /data/resources/.

    Important: During an update, this resources.json file will be overwritten to get possible updates. However, a backup of the file is created in the same directory (resources-[TIMESTAMP]).json). This file can be renamed to resources.json so that the old configuration is used.

    Hint: Make a backup of the files resources.json and resource-TIMESTAMP.json first.

    ConfigurationPermanent link for this heading

    The configuration is described by an excerpt of the current resources.json file:

    [{

      "title": "Search Experience",

      "icon": "search",

      "entries": [

       {

        "title": "Synonyms",

        "icon": "list-alt",

        "filepath": "synonyms.csv",

        "type": "csv"

       },

       {

        "title": "Custom Site",

        "icon": "list-alt",

        "url": ":8443/site/to/page",

        "type": "url"

       },

       {

        "title": "Query Boostings",

        "icon": "list-alt",

        "filepath": "term2documentboost.csv",

        "type": "csv"

       }

      ]

    }]

    To extend/create the menu as shown in the image above, a list of objects is specified in this resources.json file. An object consists of a title (here "Search Experience") and a Font-Awesome icon. Each entry is assigned "entries" with the respective subitems (see example).

    ExtensionsPermanent link for this heading

    Customize Hostname for “Search Apps“Permanent link for this heading

    This file can be extended to adapt the host name for the subitems in "Search Apps", to adapt a port or path if necessary.

    For this purpose another object is entered with the key "searchappsbaseurl".

    [{

        "searchappsbaseurl": "http://meine-domaine.com:12345/"

      },{

      "title": "Search Experience",

      "icon": "search",

      "entries": [

       {

        "title": "Synonyms",

        "icon": "list-alt",

        "filepath": "synonyms.csv",

        "type": "csv"

       },

       {

        "title": "Query Boostings",

        "icon": "list-alt",

        "filepath": "term2documentboost.csv",

        "type": "csv"

       },

      ]

    }]

    Tip: If the changes are not applied immediately, it can be helpful to empty the browser cache and reload the page.

    Select Client Service from a dropdown menuPermanent link for this heading

    The Client Service to be used can be selected directly in the Management Center via the dropdown menu on the top right.

    In the dropdown menu you see all your available Client Services.

    All Client Service related Apps, displayed in Management Center will use the Client Service that is selected in the dropdown. When the Management Center is loaded first time the first available Client Service will be used as Client Service in use. If there is only one available Client Service it will be automatically selected as active.

    There is an additional option (at the bottom of select dropdown list) to add a custom Client Service.

    When you click “Add Custom URL” a modal with input form will be displayed:

    Here you can input you custom ClientService-URL. Valid URLs are e.g. https://yourdomain.com/search/ (including a basepath) or https://yourdomain.com/.

    Do not include the path to your client (…/apps/client).

    Add the URL by clicking on “Add URL”. After that, all Insight Apps will be loaded from the new custom Client Service URL.

    Hint: It is possible to add and modify only one custom Client Service URL and to remove it on page reload.

    Download PDF

    • Configuration - Management Center Menu

    Content

    • Introduction
    • Roles (from Spring Release 2018 HF3) or resource.json (before Spring Release 2018 HF3)
    • Roles
    • Resource.json
    • Select Client Service from a dropdown menu

    Download PDF

    • Configuration - Management Center Menu