Management Center Menu

Configuration

Mindbreeze GmbH, A-4020 Linz, .

These documents are strictly confidential. The transmission and presentation of these documents alone does not establish any rights to our software, our services and service results or any other protected rights. The passing on, publication or duplication is not permitted.

For reasons of easier readability, gender-specific differentiation, e.g. user, is not used. Corresponding terms apply to both sexes in the sense of equal treatment.

Introduction

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)

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

Roles

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".
Here is the link to the documentation.

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

Roles with menu items:

roll	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
InSpire Config Administrator	Configuration
InSpire Services Administrator	Services
InSpire Webmin Administrator	System
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)

Available menu items

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

menu.admin.json

{

"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"]

}

]

}]

}

menu.config.json

{

"entries": [{

"priority": 500,

"id": "configuration",

"title": "Configuration",

"href": "config",

"icon": "wrench"

}]

}

menu.relevance.json

{

"entries": [{

"priority": 300,

"id": "searchexperience",

"title": "Search Experience",

"icon": "search",

"submenu": [{

"priority": 30,

"id": "searchexperience",

"title": "Query Boostings",

"icon": "list-alt",

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

"type": "csv"

},{

"priority": 70,

"id": "searchexperience",

"title": "Relevance",

"icon": "list-alt",

"type": "layout",

"grid": [{

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

"type": "url",

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

},{

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

"grid": [{

"file": "relevance/relevance.json",

"type": "json",

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

"height": "50%"

},{

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

"type": "csv",

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

"height": "50%"

}]

}

menu.reporting.json

{

"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.json

{

"entries": []

}

menu.resources.plugins.json

{

"entries": []

}

menu.searchapps.json

{

"entries": [{

"priority": 100,

"id": "searchapps",

"title": "Search Apps",

"icon": "th-large",

"submenu": [{

"priority": 10,

"title": "Client",

"href": "{{host_url}}/",

"icon": "search"

{

"priority": 20,

"title": "Search Apps",

"href": "{{host_url}}/apps/?saveMode=true&storeURL={{encoded_host_url}}",

"icon": "edit"

{

"priority": 30,

"title": "Designer",

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

"icon": "edit"

{

"priority": 40,

"title": "Users",

"href": "{{host_url}}/apps/admin/resources/#user",

"icon": "user",

"class": "userEl hidden"

{

"priority": 50,

"title": "Alerts",

"href": "{{host_url}}/apps/admin/resources/#alert",

"icon": "bell",

"class": "userEl hidden"

}

]

}]

}

menu.services.json

{

"entries": [{

"priority": 400,

"id": "services",

"title": "Services",

"href": "adminapps/services",

"icon": "cog"

}]

}

menu.vocabulary.json

{

"entries": [{

"priority": 300,

"id": "searchexperience",

"title": "Search Experience",

"icon": "search",

"submenu": [{

"priority": 10,

"id": "searchexperience",

"title": "Synonyms",

"icon": "list-alt",

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

"type": "text"

},{

"priority": 20,

"id": "searchexperience",

"title": "Replacements",

"icon": "list-alt",

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

"type": "csv"

},{

"priority": 40,

"id": "searchexperience",

"title": "Vocabulary",

"icon": "list-alt",

"file": "vocabulary/vocabulary.csv",

"type": "csv"

}]

}

menu.webmin.json

{

"entries": [{

"priority": 800,

"id": "system",

"title": "System",

"icon": "desktop",

"submenu": [{

"priority": 10,

"title": "File Manager",

"icon": "folder",

"href": "/webmin/filemin/",

"unsupportedBrowsers": ["Edge", "IE"]

}, {

"priority": 20,

"title": "System Time",

"icon": "clock-o",

"href": "/webmin/time/"

}]

}

Expand and customize the menu using JSON Files

Structure

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
  - file (only if “href” is not used)
  - type (only if “file” is used; supported types: “text”, “csv”)
  - submenu (optional)
- When "keepbuiltin"
  - id
  - submenu

Examples

Overwrite a plugin

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",

"file": "bestbets.csv",

"type": "csv"

}]

}

Overwrite Vocabulary (Search Experience)

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",

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

"type": "text"

}]

}

Overwrite Config

menu.config.json.overwrite

{

"header": {

"roles": [

"InSpire Administrator"

]

"entries": [{

"priority": 500,

"id": "configuration",

"title": "Configuration Neu",

"href": "config",

"icon": "wrench"

}]

}

Resource.json

Preparation

To customize the menu in the Mindbreeze Management Center, you need the "resources.json" file, 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 (Tip: Make a backup of the files resources.json and resource-TIMESTAMP.json first!).

Configuration

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

[{

"title": "Search Experience",

"icon": "search",

"entries": [

{

"title": "Synonyms",

"icon": "list-alt",

"file": "synonyms.csv",

"type": "csv"

{

"title": "Custom Site",

"icon": "list-alt",

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

"type": "url"

{

"title": "Query Boostings",

"icon": "list-alt",

"file": "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).

Extensions

Customize Hostname for “Search Apps“

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",

"file": "synonyms.csv",

"type": "csv"

{

"title": "Query Boostings",

"icon": "list-alt",

"file": "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.

Management Center Menu

Configuration

Introduction

Roles (from Spring Release 2018 HF3) or resource.json (before Spring Release 2018 HF3)

Roles

Roles with menu items:

Available menu items

menu.admin.json

menu.config.json

menu.relevance.json

menu.reporting.json

menu.resources.json

menu.resources.plugins.json

menu.searchapps.json

menu.services.json

menu.vocabulary.json

menu.webmin.json

Expand and customize the menu using JSON Files

Directory

Structure

Examples

Overwrite a plugin

Overwrite Vocabulary (Search Experience)

Overwrite Config

Resource.json

Preparation

Configuration

Extensions

Customize Hostname for “Search Apps“

Download PDF

Download PDF

{{{i18n.refineSearch}}}

Management Center Menu

Configuration

Introduction

Roles (from Spring Release 2018 HF3) or resource.json (before Spring Release 2018 HF3)

Roles

Roles with menu items:

Available menu items

menu.admin.json

menu.config.json

menu.relevance.json

menu.reporting.json

menu.resources.json

menu.resources.plugins.json

menu.searchapps.json

menu.services.json

menu.vocabulary.json

menu.webmin.json

Expand and customize the menu using JSON Files

Directory

Structure

Examples

Overwrite a plugin

Overwrite Vocabulary (Search Experience)

Overwrite Config

Resource.json

Preparation

Configuration

Extensions

Customize Hostname for “Search Apps“

Download PDF

Download PDF