Skinny moustache. Development of Search Apps

Mindbreeze GmbH, A-4020 Linz,. Mustache types chart.

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.

The term ‘user‘ is used in a gender-neutral sense throughout the document.

Mindbreeze search applications shape and design the access to your company's information and customize it tailored to your needs. You can use search applications to display and highlight important information without the user having to search for it, to create a special search mask that is ideal for an application, or simply to set up a query targeted toward people. The possibilities are almost limitless. Indeed the Mindbreeze Client itself is a search application.

Examples: Contact search, ticket search, display of recently modified documents, all information pertaining to a person, all information about a topic, embedding in Microsoft SharePoint, embedding in the intranet, embedding a web page, etc.

From a technical point of view, search applications are HTML snippets that can be used on any web page.

Styles

The styles are delivered via the file adapted.css. This is located in apps/css/.

In addition, a minimal stylesheet (minimal-adapted) is available. This file is also located in apps/css/.

We recommend that you load these styles within the <head> in the HTML.

Scripts

The required JavaScript is supplied by client.js. This is located in apps/scripts/.

data-mindbreeze-lib: If this attribute is set, this means that the path of this resource is used for the remaining files/resources to be loaded.

data-global-export: Specifies whether resources can be used globally or not. Default “false”

The easiest way to create a search application is the Search App editor. It allows you to assemble the building blocks of your search application using drag-and-drop. Such building blocks include layouts, search fields, results, navigation elements and filters.

Because it’s so easy to use, the Editor is particularly helpful for staff specialists, enabling those who need the information to get maximum value from the data.

Open the Editor: The Editor can be found at the same address as the Client, using the path apps/editor (e.g. https://example.com/apps/editor/ ).

Click on the " Add Widget" button: This button appears wherever it’s possible to add widgets (more on this in Layouts).

Choose a widget: The widget selection appears at the right edge of the window. The individual widgets are organized into thematic categories. You can add a widget simply by clicking on it or by using drag and drop.

Adjust the settings: After you add a widget, you can adjust its settings at the right edge of the window (1). Here you will see choices like search term, number of results and presentation template.

To edit the settings again later, click the Edit button (2).

Use the search application: Click the "Export" button and copy your newly produced snippet onto any web page.

All done! Show your colleagues the new search application.

Building Blocks

Layout

Use layout building blocks to organize the subsequent sections. You can add columns with different partitions or a header. All layouts are displayed optimally using " Responsive Web Design " both on workstations as well as on mobile devices.

Search Field

The user can type his or her own key words in the search field.

Results

Lists, pictures and maps can be used to display the results.

Settings

Search Restrictions: Only the results that correspond to a given constraint are displayed, e.g. extension:pdf, to display only PDF documents.

Results: The number of displayed results

Sort by: Results can be sorted by relevance or date.

Sort order: The results are sorted in ascending or descending order

In List View and Picture View, the following additional options are available:

Display results while scrolling: Additional results are automatically shown when the user scrolls down. Please Note: Enable this setting only if the results display is the last element on the page, otherwise the users cannot get to the elements under the results.

The following options are also available for the timeline view:

Height: height of the timeline, auto for automatic adjustment to the displayed hits, or height according to CSS, e.g. 200px. Default value: auto

Start date & end date: Limits the timeline to a specific period

In List View and Picture View, the following additional options are available:

Vorlage: You can customize the display of results using mustache-Templates. This way you can, for instance:

Customize the displayed presentation, e.g. of a person,

Use the HTML structure of the target page.

mustache-Templates

All metadata, the preview image (thumbnail) and all actions of the document are available in the template.

The following template shows the thumbnail and the title as a headline, underneath which you see the content of the document:

Enter the name of the metadata item in curly braces {{{ }}}, in order to view it. For instance:

If the metadata is not available, should " Author:" not be shown either? You can make the output optional using a condition:

The output might look like this:

With {{#actions.data}}{{{html}}}{{/actions.data}} you output all actions. In order to access the first action only, you can use {{actions.data[0].value.href}}.

The complete template with the first action as link:

The output could look as follows:

Your Search can be resumed in an external search engine.

Adress: the path to the external search engine including placeholder, for example: https://duckduckgo.com/?q={searchTerms}. {searchTerms} replaces the searched term, {language} gets replaced with the language of your search app.

Scrolling

The scrolling widget allows users to view more search results. Use this widget if you have not enabled the Show results when scrolling option for the results.

For detailed information about customizing, see the pagination widget.

The page widget can be used to navigate through the search results page by page. For the results, the option “ Show results when scrolling ” should be disabled so that only one variant is available for scrolling.

For detailed information about customizing, see the pages widget.

Filter

Filters are used to restrict the search results. When you add a widget you’ll be able to choose from all available filters which are possible for the current search.

Filter: The metadata that is used for the filter

Titl e: If you do not want to display the standard translation of the metadata name, enter your preferred title here (but be careful if your search client is used in different languages).

Allow user input: "Select widget automatically" adjusts the user input under the filter to its type, e.g. date input for date values, auto-completion for text values. "Disabled" hides the user input. “Use Widget” will display the widget option for user input.

User input widget: Select the widget that will be used for user input.

Always display user input: Should user input be displayed even if no search term has been entered yet?

Expandable: The user can shut the filter, so that only the title bar is displayed.

Open by default: The filter is displayed in expanded form from the beginning.

AND operation of filter values possible: Enables a "+" button next to a filter value, which can be used to make an AND operation.

Template: You can customize the appearance of the filter using the mustache-Templates.

mustache-Templates

The template contains the value of the filter entry, the number of documents and whether or not the entered item is being taken into account for the current search.

html: the formatted value of the filter entry

value: the value of the filter entry (e.g. calendar date and time values)

excluded: the entry is not selected although others are

For detailed information about customization, see the filteredfacet widget.

The following section contains a description of all available widgets. Widgets are HTML tags that are inserted into any HTML files. HTML tags with the attribute data-template="<Widget-ID>" become widgets. Settings and templates can be defined either as additional attributes or contents of the tag.

alertedsearches

The alert widget enables the user to subscribe to email notifications.

Configuration: Configuration using the management Interface is needed to use this widget.

accordion

The accordion widget is an element for surrounding areas which are expandable/collapsible.

Elements included with role=tab are displayed as expandable/collapsible and can be operated using the keyboard. The widget uses the ARIA-role tab list ( http://www.w3.org/TR/wai-aria/roles#tablist ); the sub-elements must conform to the defined structure.

data-enabled: Using true allows areas on the screen to be opened and closed. Default: false

data-default-open: indicates whether the included areas are by default open or closed. Default: false

An " alert " indicates errors that occurred during the search.

Model: application.models.channels.alerts

mustache-Templates

level: info, warning, error

warning: Warning message

info: Information message

service_ids: Services that prompted the message

annotationPopup

The annotationPopup widget is an element for displaying properties in the preview component by using mouse hover over an annotation. All properties from the URL that are specified as URL parameters are used. If you don't want all properties, you can explicitly specify the required properties in the mustache template (Note: These must be available as URL parameters). type =Search& code =J01FA09& term =Mindbreeze%20InSpire

In addition, feedback can be given for each annotation, which is shown in app.telemetry:

Once embedded, it looks like this in the PDF preview:

To use this feature, the following container must be added to the client:

data-enable-feedback: Enables the feedback functionality on the client. Default value: false

applists

Offers a choice of additional search sources and additional external data sources.

Model: application.models.applists

breadcrumb

When actions restrict the results, these constraints remain available in the breadcrumb widget and can be disabled there again.

Model: application.models.search.user.constraints

collect

Widget for results that were collected using the " Collect " action.

Model: application.models.collected

data-favorites-collection-path: Persisted Collection path for saving the collected results. Has to start with favorites/. Default: empty

data-results-shortcut: Describtion of the keyboard-shortcut used to navigate to the results Example: Alt+2, Default: empty

constraints

Displays a filter for the constraints of the data sources. In Microsoft Exchange, for example, the user can choose from E-mail, Attachment, Calendar, Contact, Task, Note and Mail.

Model: application.models.userSourceInfo

mustache-Templates

datasources

Displays a filter for the data sources. Here data sources such as Microsoft Exchange, Fabasoft Folio and Microsoft SharePoint can be selected.

Model: application.models.userSourceInfo

mustache-Templates

Input Date

Provides date selection for an input field. The template must be used on an input element. The name attribute specifies which metadata is restricted.

data-isrange: If true, a time range can be specified. Default value: false

Date filter

The date filter can also start on a monthly basis. The order is from the latest to the oldest date.

This setting can be found in Client Services under “Filter Settings”. The following setting is required:

Flat Date Filter Values (Month Year): “true“

feedbackbutton

Displays the app.telemetry feedback button. The feedback button is visible only when app.telemetry is enabled for the client and the URL is configured in the client service.

data-check-if-enabled-in-profile: the feedback button can be enabled or disabled in the profile. This option allows you to specify whether the profile setting is taken into account. Values: true, fa lse.

The URL has to be entered in the “Fabasoft app.telemetry Web API URL” input box in the client service.

filteredfacet

Model: application.models.search + FacetValueCollection + FacetValueCollection.Entry

<div data-template="filteredfacet"

data-container-tag-name="div"

data-container-class-name="filter"

data-entry-class-name="entry">

<div data-template="filteredfacet"

data-title-class-name="title"

data-container-tag-name="div"

data-container-class-name="filter"

data-entry-class-name="entry">

data-name: The metadata used for the filter

data-user-input: When disabled, the user input under the filter can be deactivated. With “auto,” the user input is adapted to the type of filter, e.g. date input for date values, auto-completion for text values. If not otherwise specified, “auto” is used.

This setting replaces data-suggest:

data-suggest="false" => data-user-input="disabled"

data-suggest="true" => data-user-input="auto"

data- user-input-template: The widget that is used for user input. With “suggest” the autocompletion is displayed; “inputdate” shows the date input. To use this value, data-user-input should not be set.

data-user-input-<setting>: transfers settings to the user input widget. For example: data-user-input-isrange="true" in the input-date widget.

data-always-visible: if “true” is set, the filter will be displayed even if no search has been set yet. Since the type of filter is not recognized without a search, data-user-input-template must be defined. Default value: false

data-title: If you do not want to display the standard translation of the metadata name, enter the desired title here

data-title-tag-name: The HTML tag used for the filter headings. Default value: h3

data-title-class-name: The CSS class name used for the filter headings. Default value: empty

How to grow a big mustache

data-title-template: Mustache template for displaying the title. Available values: title, isOpen. Default value: empty

data-container-tag-name: The HTML tag for the element containing the filter entries. Default value: ul

data-container-class-name: The CSS class name for the element containing the filter entries. Default value: empty

data-entry-tag-name: The HTML tag for a filter entry. Default value: li

data-entry-class-name: The CSS class name for a filter entry. Default value: empty

data-entry-role: The ARIA role attribute for a filter entry. Default value: empty

data-collapsible: “true” allows you to open and close the filter. Default value: false

data-default-open: specifies whether the filter is open or closed by default. Default value: false

data-displayed: Number of filter values displayed. Further restricts the display of the number configured on the client service. If there are more entries, they can be displayed using a button.

data-and-available: Activates a “+” button next to a filter value with which an AND operation can be performed. Default value: false

data-intersect-values: Used for linking the selected values AND, so that hits should contain all selected values. Default value: false

data-order-criteria: COUNT sorts by frequency of occurrence, VALUE by filter value, PREDEFINED sorts by title in ascending order, and the first values can be specified in data-predefined-order.

data-order-direction: ASCENDING and DESCENDING directly define the direction. Default value: ASCENDING

data-predefined-order: List of values to be displayed at the beginning, separated by a comma or JSON. For example: pdf, gif or ["pdf", "gif"]

data-restore-focus: Sets the focus back to the checkbox after selecting a value. Default value: true

data-show-checkbox: Should a checkbox be displayed? Default value: true

data-show-all: Should the option “All” be displayed? Default value: true

mustache templates

The template contains the value of a filter entry, the number of documents, and whether or not the entry is currently being included in the search.

html: The formatted value of the filter entry, e. g. pdf, John Doe, 2014

value: The value of the filter entry (for example, for date values)

excluded: the entry is not selected although others are selected

filteredfacets

Displays a set of filters. Currently, the group " mes:configuredfacets " is available, which contains all the filters selected in the client service configuration.

For the presentation of the individual filter, the filteredfacet widget is used. A presentation template for this can be deposited in filteredfacets. You can find the options for this template under mustache templates at filteredfacet. In addition, the filters can be displayed per option as combo boxes.

Model: application.models.search + application.models.search.facets + FacetValueCollection + FacetValueCollection.Entry

data-name: the filter group which is displayed

data-user-input: with disabled, user input can be disabled under the filter. With auto, the user input will be adapted to the type of filter, for example, date for date values, autocomplete for text values. Without specifying otherwise, auto is used.

This setting replaces data-suggest:

data-suggest="false" => data-user-input="disabled"

data-suggest="true" => data-user-input="auto"

data- user-input-template: Widget that is used for the user input. With suggest, autocompletion is displayed, input date displays the date entry. data-user-input should not be entered, so that the value is used.

data-user-input-<Einstellung>: transfers settings to the user input widget. For example data-user-input-isrange="true" with the input-date widget

data-title-tag-name: HTML tag, which is used for the titles of the filter. Default: h5

data-title-class-name: CSS class name that is used for the titles of the filter. Default: empty

data-facet-container-tag-name: HTML tag for the element that contains the filter entries. Default: ul

data-facet-container-class-name: CSS class name for the element that contains the filter entries. Default: empty

data-facet-entry-tag-name: HTML tag for a filter entry. Default: li

data-facet-entry-class-name: CSS class name for a filter entry. Default: empty

data-collapsible: If true, the filter can be opened and closed. Default: false

data-default-open: specifies whether the filter is opened or closed by default. Default: false

data-displayed: Number of displayed filter values. Further restricts the display of the number configured on client service. If more entries are available, they can be displayed with a button.

data-dropdownfilter: If “true”, the filters are displayed as a dropdown/combobox. Default: false.

mustache-Templates

The template for the filteredfacet widget is defined as follows:

Shows results that contain geodata on a map. If there is no result with geodata, the map is not displayed. Geodata must be present in the metadata geolatitude und geolongitude.

Model: application.models.search + ResultCollection + ResultCollection.Entry

mustache templates

The content of the marker can be customized using a mustache template.

mustache

Any JavaScript object with mustache -templates can be displayed using the mustache widget.

data-tag-name: HTML tag for the template. Default value: div

data-class-name: CSS class name for the template. Default: empty

data-use-output-only: If enabled, the input part of the model is not used for display. Default: false

data-attr- *: attributes can be calculated with mustache templates, e.g. data-attr-id="{{myId}}" → <... id="valueOfMyId">.

The values depend on the model used, i.e. the surrounding widget. For translations i18n is always available, e.g.

Parameters: application, widget, model

Event target: application.views

pagination

With the pagination widget, users can view additional search results. Use this widget if you didn’t activate the option “ Display Results while Scrolling” with the results.

The pagination widget displays elements with CSS class name mb-next, if it is possible to scroll forward. If it is possible to scroll back, the CSS class name mb-previous is used.

In order to initiate the actions, use class class="... action" data-action="<Aktion>". Using the action this.nextPage() you can scroll forward; this.previousPage() you can scroll backward. If the results are to be added to the end of the list, use this.nextPage({ append: true }).

To navigate the search results page by page. Use this widget if you have not enabled the Show results when scrolling option for the results and you don't just want to navigate forward and backward.

data-max-page-count: Maximum number of pages displayed. If there are more pages, the standard template outputs “...” (see screenshot).

mustache templates

The following properties are available in the template:

pages: a list of available pages. current_page true returns the currently selected page. Page can be used to access the page number.

onFirstPage: contains true when the first page is selected

onLastPage: contains true if the last page is selected

more_avail:: contains true if more than the requested pages are available

pagination

The pagination widget allows users to view additional search results. Use this widget if you have not enabled the “ Show results when scrolling ” option for the results.

Weitere Ergebnisse laden

The pagination widget displays elements with the CSS class name mb-next if you can scroll through them. If it is possible to scroll back, the CSS class name mb-previous is used.

To trigger the actions, use class="... action" data-action="<Aktion>". You can scroll forward using the action this.nextPage(), and using this.previousPage() you can scroll back. If you want the results to be added at the end of the list, use this.nextPage({ append: true }).

preview

Displays the document preview, if the preview action was executed.

mustache-Templates

results

Model: application.models.search + ResultCollection + ResultCollection.Entry

data-appendonscroll: Additional results will automatically be loaded when the user scrolls down. Enable this setting only if the results display is the last element on the page, otherwise the users cannot get to the elements under the results.

this.options.application.views.trigger("afterRender:Result", this.options.application, view, model);

mustache-Templates

All metadata, the preview image (thumbnail) and all actions of the document are available in the template. The following template shows the thumbnail and the title as a headline, underneath which you see the content of the document:

Enter the name of the metadata item in curly braces {{{ }}} in order to view it. For instance:

If the metadata is not available, should the label "Author:" not be shown either? You can make the output optional using a condition:{{#Author?}}Author: {{{Author}}}{{/Author?}}

The output might look like this:

With {{#actions.data}}{{{html}}}{{/actions.data}} you output all actions. In order to access the first action only, you can use {{actions.data[0].value.href}}.

The complete template with the first action as link:

The output could look as follows:

resultsprogress

The resultsprogress widget uses a progress bar to show how many of the available results have already been loaded.

savedsearches

Displays the saved searches.

Model: application.models.savedSearches

aria-controls: if the attribute contains the ID of another element, this element is focalized after a search has been discontinued. Default: empty

data-title-tag-name: HTML tag which is used for the header. Default: h2

data-title-class-name: CSS class name which is used for the header. Default: empty

data-serversaved: Saves the search at the server. Default: false

search

The search-widget is used for displaying multiple searches in one application for example your default results and above this results some persons or pictures.

Use the template-refi d to reference a placeholder with your search-results (e xample below). For all placeholders the number of display results can be customized (data-count).

Use this example if you would like to show three results of “txt”-files and five results of “persons”.

data-template-ref id: The reference to the container with the option data-template=“results“. This container must have a <div data-mb-exclude="true"> around.

data-count: The number of displayed results for every search-container.

data-constraint: Restriction for the search.

searchform

The searchform widget is used to enter search terms. It can contain multiple input elements (input, select). Use the name -Attribut to search for the query term in one metadata item only. Without name -Attribut or if name=”query”, the input will be used as a general search term.

Model: application.models.search.input

<button type="submit" tabindex="-1">Search</button>

<input data-template="suggest"

data-disabled="$$DISABLE_MAIN_SUGGEST$$"

data-placeholder="search"

class="mb-query" name="query" type="search"

data-requires-user-input: when this option is enabled, a search term must be entered in order to start a search (it is not enough to just select a tab or a filter). Default: false

aria-controls: if the attribute contains the ID of another element, this element is focalized after a search has been discontinued. Default: empty

The attribute data-query-template specifies the search that will be used for an input field. Use {{value}} as a placeholder for the value entered.

<!—The input value {{value}} will be replaced in the template, e.g. Input: doc.* Search: { "label": "extension", "regex": "doc.*" } -->

searchinfo

Displays information about the search results. The default template shows search timeouts, " No Results Found" and alternative search queries.

Model: application.models.search

Goatee styles without mustache

{{{alternatives.query_spelling.entries[0].html}}}

mustache-Templates

In the template, the entire search model is available.

{{{alternatives.query_spelling.entries[0].html}}}

alternatives: Suggestions for the entered search term, currently query_spelling.entries[0] leads to the first suggested correction.

computing: true, if a search is being executed

status_messages: Status messages about the search (e.g. status_messages.timeout or status_messages.no_results )

estimated_count: Number of hits for the triggered search

orderable: a list of available sort criteria includes localized_name for the display and name for the selection in the API. isSelected contains true, if the sort criterion is selected.

sortswitch

Displays the sort criteria available for the search

Model: application.models.search

<a class="action" tabindex="0" data-name="orderby" data-value="{{name}}">{{localized_name}}</a>

mustache-Templates

In the template, the entire search model is available.

{{{i18n.client_toolbar_sortingalgorithm_label}}}:

<li class="mb-selectable {{#isSelected?}}mb-selected{{/isSelected?}}"><a class="action" tabindex="0" data-name="orderby" data-value="{{name}}">{{localized_name}}</a></li>

Using the stack widget, users can perform actions that execute a new search application as a new search. Visually, the executed action is on top of the last executed action. This allows the user to easily jump back in the navigation path.

"template-ref": "pdfAppTemplate",

"applicationOptions": {

"startSearch": true

Example: Display all Information About a Person

"template-ref": "personTemplate",

var MyApplication = Application.extend({

showPerson: function (options) {

var personId = options.model.get("id");

this.models.search.set("constraint", {unparsed:'(categoryclass:person AND id:"' + personId + '") OR lastmodifiedby:"' + personId +'"'});

Parameters of the action pushStack:

template-ref: The id of the HTML element that contains the template for the stack.

title: The title of the stack element. Default: title of the link

applicationOptions: The initialization options for the search application

action: An action that is executed after initializing the new search application

suggest

Allows you to use the auto-completion in an input field. From now on, popular searches, recently performed searches, and terms from taxonomies alongside the search results from metadata can be also suggested. Additionally it is possible to search all available tabs using the search term.

Screenshot: Suggests if the search string is empty (latest searches):

Screenshot: Suggests for the search term “Mindbreeze” from metadata and tabs:

Examples (This Snipped can be found in the default-client /in your searchapp and can be a dapted):

<input data-template="suggest"

data-placeholder="search"

data-source-id-pattern="database"

<input data-template="suggest"

property: the metadata to be used for completion. Default value: title

property-constraint: a search term to restrict the possible values. Default value: empty

source-id-pattern: Specifies the suggest sources (e.g.: document_property | recent_query | tabs)

Default value: $$SUGGEST_SOURCE_ID_PATTERN$$. If this setting is changed, the settings in the configurator (checkboxes for activating the suggestions) are no t taken into account and overwritten.

document_property – provides suggestions from metadata

popularsearches – provides suggestions from the database (settings required in the configuration)

words_and_terms – provides suggestions from a concept index (CSV file) - (settings in the configuration required)

recent_query – delivers suggestions from the most recent queries

tabs – lists the available tabs to be able to search in all tabs

initial-source-id-pattern: Settings are the same as source-id-pattern except that the hits from these sources are displayed when the search term is empty.

Default value: $$SUGGEST_INITIAL_SOURCE_ID_PATTERN$$. If this setting is changed, the settings in the configurator (check - boxes for activating the suggestions) are not taken into account and overwritten.

service: URL to a suggest service. Default value: empty − same as search

disabled: Suggestions are disabled. Default value: false

grouped: groups the autocomplete hits (true/false)

initial-grouped: Grouping of the hits at the initial search (true/false). Default value: true

show-onfocus: Displays the Autocomplete when focusing the text field (true/false). Default value: false* 1

suggest-timeout: Sets a timeout for the request. Specified in seconds.

source-id-document_property-title: Sets the title of the “document_property” source.* 1

source-id-popularsearches-title: Sets the title of the “popularsearches” source.* 1

source-id-word_and_terms-title: Sets the title of the “word_and_term” source.* 1

source-id-recent_query-title: Sets the title of the “recent_query” source.* 1

default-tab-title: If no tab is available, this value is used as the title.* 1

source-id-order: Determines the order in Suggest:* 1

Example: “document_property,words_and_terms,tabs,recent_query“ (separated by commas)

initial-source-id-order: Determines the order in Suggest, which is displayed when the search field is focused (setting identical to source-id-order).* 1

* 1 Upon request, these settings have to be adapted directly in the HTML file.

The snipped above can be extended by the settings. You can even remove some settings from the snipped. To Add a setting to the snipped, add a line to it, which looks like: data- SETTING =”VALUE”. In the example below we add the settings for the source, that just the content from the tabs is shown in the suggests and nor the default settings. If you do not add some the source-line yourself it will take the default-value.

input data-template="suggest"

data-placeholder="search"

data-source-id-pattern="database"

input data-template="suggest"

data-placeholder="search"

The settings for the suggested search terms can be entered in the configurator as follows:

Enable Suggesting of Similar Queries: If checked, the Suggest will be read via the related search terms from the database app.telemetry.

ID: An ID can be assigned for each Suggest source (e.g. for styling)

Source Name: The source name can be “Popular Searches“, for instance

Database JDBC URL: URL for app.telemetry database

Table Name: Table name from the App.Telementry configuration

Table Column for Query: Selection of the number of results - App Telemetry Configuration

Table Column for Score: Selection of the column names of the results from the App Telemetry configuration

Table Column for View ID: Selection of the column name of the queries from the App Telemetry configuration

Additional WHERE Clause: Here you have the possibility to create and add different "WHERE" clauses.

Suggest If User Query Is Empty: if "true" is enabled, suggestions are given, even if the user has not yet searched.

Suggest Settings ( Concept CSV )

Enable Suggesting from CSV File: If checked, the Suggest will be read via the similar search terms from a CSV file

ID: An ID can be assigned for each Suggest source (e.g. for styling)

Source Name: The source name can be "Words and Terms", for instance

CSV File Path: The path to the CSV file

Suggest Settings a nd Initial Suggest Settings:

Basically, the settings under " Suggest Settings " are used as soon as a search term has been entered. " Initial Suggest Settings " are used when the search term is empty (see screenshot – suggestions for empty search string of the last searches ).

Enable Suggesting from CSV File: If checked, the Suggest about similar search terms is read from a CSV file.

Enable Suggesting of Similar Queries: When checked, the Suggest about similar search terms is read from the App.Telemetry database.

Enable Suggesting of Tabs: If checked, the Suggest about similar tabs is read from the App.Telemetry database.

Enable Suggesting of Document Property: If checked, the Suggest about similar document properties is read from the App.Telemetry database.

Enable Suggesting of Recent Queries: If checked, the Suggest about similar recent search terms is read from the App.Telemetry database.

Tip: Simple instructions for creating the database for "Similar Terms":

- create database similarterms;

- CREATE USER mindbreeze WITH PASSWORD 'Mindbreeze123';

- grant all privileges on database " similarterms" to mindbreeze;

suggestlist

Allows the usage of suggest-sources (pouplar searches, words and terms) as separate component.

title: default: Popular Searches

property: metadata to be used for autocomplete. Default value: title

source-id-pattern: suggest source

summarize

Allows you to group similar results.

This feature can be enabled or disabled in the client service:

If this feature is active, the client gets a new section "Summarize by".

data-enabled: Enables or disables the feature (Default true).

Tabs that offer search constraints to choose from. The tabs are stored in the user profile, come from the sources and can also be determined in the element.

Model:, application.models.userSourceInfo

data-attr-tabindex="{{#selected?}}-1{{/selected?}}{{^selected?}}0{{/selected?}}"

data-attr-class="action {{#selected?}}mb-selected{{/selected?}}"

data-attr-data-action-object="{"changeView":{"constraints.view": {{^constraint?}}null{{/constraint?}}{{{constraint}}} } }"

data-editable: if true, tabs can be added and edited by the user

data-datasourcetabs: if true, tabs are displayed for the activated sources

data-role: ARIA role of the tabs. Default value: tablist

data-entry-role: ARIA role of the list entries. Default value: presentation

Create your own Tabs

You can create your own tabs in the template. To do this, use the following HTML:

data-name: Name of the tab. If there is a translation for the name, it appears in the current language

data-constraint: The search term that is used as a constraint. If there is no constraint, all constraints are removed; this way you can create an "All" tab

mustache-Templates

The template contains the value of the filter entry, the number of documents and whether or not the entered item is being taken into account for the current search.

data-attr-tabindex="{{#selected?}}-1{{/selected?}}{{^selected?}}0{{/selected?}}"

data-attr-class="action {{#selected?}}mb-selected{{/selected?}}"

data-attr-data-action-object="{"changeView":{"constraints.view": {{^constraint?}}null{{/constraint?}}{{{constraint}}} } }"

selected: returns true if the tab is selected

Latest moustache and beard styles

constraint: the used constraint

timeline

Displays the results on a timeline. Navigation inside the timeline is possible by using the mouse-wheel and drag&drop.

Model: application.models.search + ResultCollection + ResultCollection.Entry

<div data-template="timeline"

data-range-start="2015-01-01"

data-height: Height of the timeline, auto for automatic adjustment to the displayed results or height indication according to CSS, for example, 200px. Default: auto

data-range-start & data-range-end: Limits the timeline to a specific time period. The information is converted into a date with new Date (<attributevalue>).

data-date: Specifies the metadata that is used to position the results on the timeline (default-value: mes:date).

data-padding-right: Specifies the amount of space to the right to be left empty. (In case the title is not fully visible)

data-padding- left: Specifies the amount of space to the left to be left empty. (In case the title is not fully visible)

mustache Templates

To display the items in the timeline, mustache templates can be used. More information can be found under results.

The view widget defines the basic settings for the search. It does not change the appearance of the page.

Model: application.models.search.input

constraint: Constraint for the search

orderby: Sorting parameters – currently: mes:relevance or mes:date

charts

Displays filters in the form of charts and thus has a similar function to the component.

Available chart types

If you select the "pie" chart type, you get a graphic as shown below. The possible settings can be found e.

<div data-template="charts"

data-chartSourceName="extension"

data-chartTitle="Erweiterung"

If you select the "bar" chart type, you get a graphic as shown below. The possible settings can be found.

<div data-template="charts"

data-chartSourceName="extension"

data-chartTitle="Erweiterung"

If you select the chart type “line”, you will receive a graphic similar to the one below. The possible settings can be found.

<div data-template="charts"

data-chartSourceName="extension"

data-chartTitle="Erweiterung"

Chart settings

data- template: “Charts” is specified as the template.

data- charttype: Specifies the type of chart. In this case, “pie” is used.

data- chartsourcename: Specifies the filter to be used (e.g. “extension“, “mes:size“, etc.).

data- charttitle: Sets a heading or title. Example: “Extension”.

data- chartheight: Sets the height of the chart (default “200”).

data- chartwidth: Sets the width of the chart (default 100 percent).

The application constructor creates a search application with the widgets contained in the HTML. Settings as name-value pairs are expected as arguments.

callback: Function that is called after the initialization of the application. Receives the application object as an argument.

datasourcesCategoryOrder: List of the data source categories used for sorting the data sources. For unspecified categories, the alphabetical default sorting is used. For example: ["Web", "Microsoft Exchange"]

datasourcesGroupByCategory: Displays data sources grouped by data source category. Values: true, false. Default value: true

datasourcesNameOrder: List of the data source name used for sorting the data sources. If datasourcesGroupByCategory is enabled, the data sources are sorted in the groups. For non-specified data sources, the alphabetical default sorting is used. E.g. ["User drive", "Intranet"]

enableProfile: Enables the user profile. Values: true, false. Default value: false

enableRemoteSources: Enables federated data sources entered in the configuration. Values: true, false. Default value: true

loginAsError: Login requests are treated as errors. No login is displayed. Values: true, false. Default value: false

queryURLParameter: Name of the URL parameter for search terms (e.g. a search for test is started when the page http://www.example.com/?query=test is opened). Default value: empty

rootEl: DOM element that contains the search application. Default value:

rootEls: List of DOM elements that contain the search application. Overwrites the rootEl setting. Default value:

sources: List of search addresses, e.g. [ "<Client Service URL>/api/v2/" ]. Default value: Address of the client service from which the JavaScript file was loaded. Alternatively, an AjaxChannel can be specified instead of the list, e.g. new AjaxChannel({ url: "<Client Service URL>/api/v2/”}), to allow crossDomain requests.

AjaxChannel can be required via "service/ajax_channel".

enableImmediateDisplayOfFederatedResults: Do you want to display all results requested by the individual services for federated data sources? This means that results that are less relevant may already be displayed on the first page. Values: true, false. Default value: false

startSearch: Should a search be started during initialization if constraints are defined? Values: true, false. Default value: true

updateTitle: Should a search be started during initialization if constraints are defined? Values: true, false. Default value: true

titleTemplate: A mustache template can be configured for the title to display the search term (unparsedUserQuery), the title of the current stack element (stackTitle), and the status of the current search (computing). Default value:

{{#stackTitle}}{{stackTitle}} - {{/stackTitle}}{{^stackTitle}}{{#unparsedUserQuery?}}{{unparsedUserQuery}} - {{/unparsedUserQuery?}}{{/stackTitle}}" + document.title + "{{#computing?}}...{{/computing?}}

callback: function (application) {

rootEl: document.getElementById("mySearchApp")

getUserConstraints(): Returns the current constraits (for use with setUserConstraints)

setUserConstraints(userConstraints, options): Sets the constraints (for use with getUserConstraints)

getUnparsedUserQuery(): Returns the current search term

setUnparsedUserQuery(unparsedUserQuery, options): Sets the search term

You can register for events on the individual models. Here you can find the supported events.

application.models.search.on("computing", function () {

application.models.search.on("computed", function () {

After rendering a result

application.views.on("afterRender:Result", function (application, view, resultModel) {

You can use to access the rendered DOM element.

Links and buttons can trigger actions in the search application with the attribute data-action-object. For example,

data-href="https://duckduckgo.com/?q={searchTerms}">

openSearch

The openSearch action searches the current term using an external search engine, such as Bing, DuckDuckGo, Google or Yahoo.

data-href: the address of the external search engine with placeholders for the search term {searchTerms} and language {language}.

searchTerms: additional restrictions on the search terms can be added, for example, "{searchTerms} image" searches for the current term and the word image

data-href="https://duckduckgo.com/?q={searchTerms}">

data-href="https://www.bing.com/search?cc={language}&q={searchTerms}">

<a data-action-object="{"openSearch":{"searchTerms": "{searchTerms} Bild"}}"

data-href="https://duckduckgo.com/?q={searchTerms}">

exportResults

The exportResults action opens a new stack, to export the current search.

data-properties: List of default export properties

data-export-enabled: Aktivate or deactivate the export feature

class="btn hidden-when-mb-stack-has-child btn-export mb-no-print

data-action-name="exportResults"

data-properties="title,mes:date,mes:size,action_0"

data-export-enabled="true">Export

PDF Preview Interactions

An API extension allows developers to react to hyperlinks in the PDF preview. For example, an interactive tooltip for a component in a technical drawing can be displayed.

application.views.on("preview:annotation:mouseover", function(obj){});

application.views.on("preview:annotation:mouseleave", function(obj){});

application.views.on("preview:annoation:click", function(obj){});

application.views.on("preview:annotation:mouseover", function(obj){

var model = new Backbone.Model(dataObject);

var innerHTML = document.querySelector('#linkoverlayinfo').innerHTML;

var mustacheTemplate = new Mustache(innerHTML);

var str = mustacheTemplate.render(model);

Using the attribute data-shortcut, key combinations for areas and actions can be set. If the attribute is set to a button or link, this is executed when you press the key combination. For all other elements, the element is focalized. If the element itself is not focusable, the first focusable element contained will be focalized.

For the key combination, the following keys are available in the order indicated:

<button data-shortcut="alt+shift+s">Aktion</button>

<button data-shortcut=" ctrl+meta+shift+x">Aktion</button>

The Mindbreeze InSpire Client uses Bootstrap Version 2.2.2 ( http://getbootstrap.com/2.2.2/ ) for the design of the user interface.

Icons, such as the magnifying glass in the search field, are transcribed with an icon font, which enables the colors to be changed easily. The icons are integrated with elements such as <i class="icon-search"></i>, making it possible to exchange the icon font for your own implementation. The utilized library is Font Awesome ( http://fortawesome.github.io/Font-Awesome/3.2.1/ ).

h2 -elements are used as headers for the main areas.

Search field

The following elements are available for the design of the search field:

Results

The titles of the results are h3-elements.

Filter

.nav.nav-stacked.nav-pills

The titles of the individual filters, e.g. date, are h3-elements.

Expandable Elements

For elements that can be expanded and collapsed, the structure for the ARIA roll tablist + multiselectable is used ( http://www.w3.org/TR/wai-aria/roles#tablist ):

Title collapsed

Title expanded

Search Tab

For the search tab, the structure of the Basic Navbar components

Header

For the header, the structure of the Basic Navbar components

.mb-header.navbar.navbar-inverse.mb-top-menu.nav

mb-computing

While a search is being performed, the widgets obtain the CSS class mb-computing. Use this CSS class to show the activity.

.mb-computing.mb-progress-indicator {

Your own widgets can be installed as plugins and be used by you as your own search applications and in the Search App editor.

Exampleplugin

Once the plugin has been downloaded, it can be adjusted (see from Plugin structure onwards) and uploaded again under " Plugins ". Once the plugin has been activated under " Client-Service “ > “ Client Resources ", it is in the editor and ready for use.

Plugin structure

Mindbreeze plugins are zip files that contain a description in the plugins.xml. The element id contains a clear string for the plugin, and mindbreeze.webapp.Resources is the extension point used. resource_path specifies the path inside the plugin, where the files are stored.

<point>mindbreeze.webapp.Resources</point>

<resource_path>resources</resource_path>

Creating your own widgets

Templates.View.extend creates a new view. These are s with extensions. To create a custom view, use Templates.View.extend:

At extend, the custom functions are transferred. The main features include:

var = MyView Templates.View.extend ({...});

Registering your own widgets

After creating your own widget using Creating your own widgets, it needs to be registered so that it is available in search applications and in the Designer. To do this, use Templates.add:

title: "mycompany_results_size",

icon: Mindbreeze.require.toUrl("mycompany.example/example.png"),

description: "mycompany_results_description",

description: "mygroup_description"

Attribute

When you register your own widgets under, you can use attributes to transfer options to the widget, for example:

title: "mycompany_results_size",

- If it’s usable in the HTML as data-size:

- then in the widget, the option is automatically available:

var MyView = Templates.View.extend({

console.log(this.options.size); // logs mysize

The title for the designer is specified with title. If the text is included in the translations, it is automatically translated.

The following types are available in types:

With defaultValue, a default value can be specified to be used if the Option was not set.

Display in Designer

When you register your own widgets at, menu options for the widget can be filed in Designer with designer_menu menu options; for example:

icon: Mindbreeze.require.toUrl("mycompany.example/example.png"),

description: "mycompany_results_description",

description: "mygroup_description"

With the following translations:

mycompany_results_description: {

"de": "Anzeige von Resultaten",

Adding Translations

With i18n.loadExtension your own translations can be added:

Mindbreeze.require(["i18n/i18n"], function(i18n) {

Development environment

In order to develop the plugin without installation, it can be stored on a web server and loaded using the following JavaScript:

window.define = Mindbreeze.define;

Mindbreeze.require.config({ paths: { "mycompany.example": "/plugins/mycompany.example/src" }});

Mindbreeze.require(["mycompany.example/init"]);

Mindbreeze.require(["client/application"], function (Application) {

It is important that the plugin and the both stem from the same server.

Mindbreeze offers you the possibility of performing the search in the form of a dynamic RSS feed. To do this, open the URL below:

https://YourAppliance/mindbreeze/cmis/content/query?q=ALL&qtype=mes:sanskrit&maxItems=5&skipCount=5&language=de_DE

The following section describes the URL parameters and their function

To operate your own search apps and provide your default search app, you have to configure the following parameters in the client service under point „ Web Application Contexts Settings “. The corresponding files should be copied via the InSpire file uploader to the appropriate location.

You can use the default Searchclient as a template which is available at /data/apps/client/index.html.

In the following example two search applications (marketing and sales) are configured on the client service (available at https://search.mycompany.com). The marketing search app can be reached at and https://search.mycompany.com/apps/marketing, and the sales search application can be reached at https://search.mycompany.com/apps/sales.

Military mustache styles. Development of Search Apps

Styles

Scripts

Building Blocks

Layout

Search Field

Results

Settings

mustache-Templates

Scrolling

Filter

mustache-Templates

alertedsearches

accordion

mustache-Templates

annotationPopup

applists

breadcrumb

collect

constraints

mustache-Templates

datasources

mustache-Templates

Input Date

Date filter

feedbackbutton

filteredfacet

How to grow a big mustache

mustache templates

filteredfacets

mustache-Templates

mustache templates

mustache

pagination

mustache templates

pagination

preview

mustache-Templates

results

mustache-Templates

resultsprogress

savedsearches

search

searchform

searchinfo

mustache-Templates

sortswitch

mustache-Templates

Example: Display all Information About a Person

suggest

suggestlist

summarize

Create your own Tabs

mustache-Templates

timeline

mustache Templates

charts

Available chart types

Chart settings

openSearch

exportResults

PDF Preview Interactions

Search field

Results

Filter

Expandable Elements

Title collapsed

Title expanded

Search Tab

Header

mb-computing

Exampleplugin

Plugin structure

Creating your own widgets

Registering your own widgets

Attribute

Display in Designer

Adding Translations

Development environment

Comments