Entwicklung von Insight Apps

Help

Mindbreeze GmbH, A-4020 Linz, .

Diese Unterlagen sind streng vertraulich. Durch die Übermittlung und Präsentation dieser Unterlagen alleine werden keine Rechte an unserer Software, an unseren Dienstleistungen und Dienstleistungsresultaten oder sonstigen geschützten Rechten begründet. Die Weitergabe, Veröffentlichung oder Vervielfältigung ist nicht gestattet.

Aus Gründen der einfacheren Lesbarkeit wird auf die geschlechtsspezifische Differenzierung, z.B. Benutzer/-innen, verzichtet. Entsprechende Begriffe gelten im Sinne der Gleichbehandlung grundsätzlich für beide Geschlechter.

Tutorial Video „Creating an Insight App“

Dieses Video zeigt Ihnen, wie Sie Ihre eigene Mindbreeze InSpire Insight App mit dem integrierten Insight App-Designer erstellen können. Alle Funktionen des Standard-Clients werden ausführlich erläutert, wie z.B. die Verbesserung der Ergebnisliste durch Filter und die Mindbreeze InSpire Query Language.

Link zum Video: https://www.youtube.com/watch?v=2X0Ot3oXZwQ

Einführung

Mindbreeze Suchanwendungen gestalten den Zugriff auf die Informationen Ihres Unternehmens und passen ihn maßgeschneidert auf Ihre Bedürfnisse an. Sie können Suchanwendungen verwenden, um wichtige Informationen anzuzeigen, ohne dass der Benutzer suchen muss, eine spezielle Suchmaske erstellen, die für eine Anwendung ideal ist oder einfach eine Suchabfrage nach Personen tätigen. Die Möglichkeiten sind beinahe grenzenlos. Der Mindbreeze Client selbst ist eine solche Suchanwendung.

Beispiele: Personensuche, Ticketsuche, Anzeige der zuletzt geänderten Dokumente, alle Informationen zu einer Person, alle Informationen zu einem Thema, Einbettung in Microsoft SharePoint, Einbettung ins Intranet, Einbettung eine Webseite, usw.

Aus technischer Sicht sind Suchanwendungen HTML-Abschnitte, die auf jeder Webseite verwendet werden können. Wichtig ist, dass die Webseite von einem Webserver geladen werden muss, HTML-Dokumente können nicht einfach mit Doppelklick geöffnet werden. Stellen Sie sicher, dass die Adresse im Browser mit http oder https beginnt.

Benötigte Ressourcen

Head

Meta-Tags

Es wird empfohlen, folgende Meta-Tags im <head> Bereich der Suchanwendung anzugeben und zu verwenden:

mes:user	Username des aktuell eingeloggten Users
display:mes:user	Gibt an, ob der Username am Client angezeigt werden soll
mes:emailaddress	Emailadresse des aktuell eingeloggten Users
mes:loginstatus	Gibt an, welche Aktion für den User aktuell verfügbar ist (login oder logout)
mes:logoutdisabled	Gibt an, ob sicher der User abmelden kann
mes:decrypted:user	Entschlüsselte Username des aktuell eingeloggten Users
app:telemetry:enabled	Gibt an, ob App.Telemetry aktiviert sein soll
app:telemetry:application:id	Gibt die App.Telemetry-Application-ID an
app:telemetry:application:tier:id	Gibt die App.Telemetry-Application-Tier-ID an
enablePersonalization	Gibt an, ob Personalization aktiv ist

Styles

Die Styles werden über das File adapted.css geliefert. Es befindet sich unter apps/css/.

Zusätzlich wird ein minimales Stylesheet (minimal-adapted) angeboten. Dieses File befindet sich ebenfalls unter apps/css/.

Empfohlen wird, diese Styles innerhalb des <head> im HTML zu laden.

Scripts

Das benötigte JavaScript wird vom client.js geliefert. Es befindet sich unter apps/scripts/.

data-mindbreeze-lib: Ist dieses Attribut gesetzt, bedeutet es, dass der Pfad dieser Ressource für die restlichen zu ladenden Files/Ressourcen verwendet wird.
data-global-export: Gibt an, ob Ressourcen global verwendet werden können oder nicht. Default „false“.

Standardbibliotheken

Das client.js wird mit folgenden Bibliotheken ausgeliefert:

Bibliothek	Key	Version	Webseite	Patches
jQuery	jquery	1.12.4	http://jquery.com/	CVE-2015-9251 CVE-2019-11358 CVE-2020-11022 CVE-2020-11023
Underscorejs	underscore	1.4.3	https://underscorejs.org/
Backbone	backbone	0.9.9	https://backbonejs.org/
MomentJS	moment	2.8.3	https://momentjs.com/	CVE-2022-24785
Highcharts	highcharts	8.1.2	https://www.highcharts.com/	CVE-2018-20801
Mustache	mustache	0.7.1	https://mustache.github.io/
RequireJS	require	2.1.8	https://requirejs.org/
Bootstrap	bootstrap	2.2.2	https://getbootstrap.com/

Die Bibliotheken können nun mit Hilfe von require() verwendet werden siehe Beispiel:

Mindbreeze.require(["jquery","moment"], function($,moment) {

var body = $("body");

var now = moment().toDate();

});

Minimal client version

Eine minimale client.js Version mit Basiskomponenten und Funktionalitäten ist als client-base.js vorhanden. Die Größe dieses Files ist um mehr als 50% reduziert, entfernt wurden jedoch folgende Komponenten:

highcharts
jsoneditor
charts
map
table
timeline
queryinfo
breadcrumb
savedsearches
alertedsearches
profilesettings
profilesettingsview
suggestlist
voting
annotationPopup
summarize
emailalert
emailalert_preset
alertcenter
feedback

Insight App Designer

Die einfachste Art, eine Insight App zu erstellen, ist der Insight App Designer. Hier fügen Sie Bausteine per Drag & Drop zu einer Suchanwendung zusammen. Als Bausteine stehen Layouts, Suchfelder, Ergebnisse, Navigationselemente und Filter zur Verfügung.

Durch die einfache Bedienbarkeit ist der Designer speziell für Fachbereichsmitarbeiter geeignet, damit die Personen, die die Informationen benötigen, das Maximum aus den Daten herausholen können.

Allgemein

Öffnen Sie den Designer: Der Designer ist unter der gleichen Adresse wie der Client, unter dem Pfad apps/designer verfügbar (z.B. https://example.com/apps/designer/).
Klicken Sie die "Widget hinzufügen"-Schaltfläche: Die Schaltfläche steht an allen Stellen zur Verfügung, wo Sie Widgets einfügen können (mehr dazu bei Layouts).
Wählen Sie ein Widget aus: Am rechten Fensterrand erscheint die Widgetauswahl. Die einzelnen Widgets sind in thematische Gruppen gegliedert. Hinzufügen können Sie das Widget mit einem einfachen Klick oder per Drag & Drop.
Passen Sie die Einstellungen an: Nach dem Hinzufügen eines Widgets können Sie dessen Einstellungen am linken Fensterrand anpassen. Hier stehen unter anderem Suchbegriff, Ergebnisanzahl und Darstellungsvorlage zur Auswahl.

Um die Einstellungen später erneut zu bearbeiten, klicken Sie auf die Bearbeiten-Schaltfläche
Verwenden der Insight Application: Klicken Sie auf den "HTML Code Generieren"-Button und kopieren Sie das erzeugte Snippet in eine beliebige Webseite.
Fertig!: Zeigen Sie die neue Insight Application Ihren Kolleginnen und Kollegen.

Änderungen und Anpassungen im generierten HTML

Loader

Mit dem Mindbreeze-Loader kann das erstellte Snippet geladen und in das HTML eingefügt werden.

Loader.loadAppFromResource(options, additionalOptions);

Application Einstellungen

options:

appid: Die App-ID kann aus dem Managementcenter – InSight Apps kopiert werden.
sourceURL: Wird eine spezielle Source-URL benötigt, kann diese hier angegeben werden.
sources: Wird eine spezielle Sources benötigt, kann diese hier angegeben werden.
target: Das Element im DOM, in dem das geladene Snippet eingefügt werden soll.

additionalOptions:

useMessageFrameForNonBuiltinSources: Wenn true, verwendet die Anwendung den MessageFrame-Channel für die Sources. Werte: true oder falsch. Default: true.

Bausteine

Layout

Verwenden Sie Layout-Bausteine, um die weiteren Abschnitte zu gliedern. So können Sie Spalten in unterschiedlichen Aufteilungen oder einen Kopfbereich hinzufügen. Sämtliche Layouts werden mittels „Responsive Webdesign“ sowohl auf Arbeitsplatzrechnern als auch auf Mobilgeräten optimal dargestellt.

Suchfeld

In das Suchfeld kann der Benutzer eigene Suchbegriffe eingeben.

Bildschirmfoto:

Ergebnisse

Für die Darstellung von Ergebnissen stehen Listen-, Bilder-, Karten- und Zeitleistenansicht zur Verfügung.

Ergebnis Einstellungen

Sucheinschränkung: Es werden nur die Ergebnisse angezeigt, die einer vorgegebenen Einschränkung entsprechen.
Hier wird zwischen zwei Abfragearten unterschieden:
- Textabfrage: (Typ: String) Wird verwendet, wenn die Eingabe ein ungeparster Wert ist z.B. ”Mindbreeze InSpire”.
- Strukturelle Abfrage: (Typ: JSON) Wird verwendet, wenn die Eingabe ein geparster Wert ist, so dass wir komplexe Einschränkungen umsetzen können z.B.
  {
  "id": "additional_constraint",
  "quoted_term": "Mindbreeze InSpire"
  }
  um nur Dokumente anzuzeigen, die all den Einschränkungen innerhalb der Phrase entsprechen.
  
  Hinweis: Ob es sich nun um eine Textabfrage oder um eine Strukturelle Abfrage handelt, wird automatisch erkannt.
Ergebnisse: die Anzahl der angezeigten Ergebnisse
Sortieren nach: Ergebnisse können nach den für die Ergebnisse zur Verfügung stehenden Kriterien sortiert werden
Sortierreihenfolge: die Ergebnisse werden aufsteigend oder absteigend sortiert

Bei Listen- und Bilderansicht stehen zusätzlich folgende Optionen zur Verfügung:

Ergebnisse beim Scrollen anzeigen: Es werden automatisch zusätzliche Ergebnisse geladen, wenn der Benutzer nach unten scrollt. Wichtig: Aktivieren Sie diese Einstellung nur, wenn die Ergebnisanzeige das letzte Element auf der Seite ist, andernfalls können die Benutzer die Elemente unter den Ergebnissen nicht erreichen.

Bei der Zeitleistenansicht stehen zusätzlich folgende Optionen zur Verfügung:

Höhe: Höhe der Zeitleiste, auto für automatische Anpassung an die angezeigten Treffer oder Höhenangabe laut CSS, z.B. 200px. Standardwert: auto
Startdatum & Enddatum: Begrenzung der Zeitleiste auf einen Zeitraum
Bei Listen-, Bilder- und Zeitleistenansicht steht zusätzlich folgende Option zur Verfügung:
Vorlage: Sie können die Darstellung der Ergebnisse mittels mustache-Templates anpassen. Somit können Sie z.B.:
- Metadaten ein- und ausblenden,
- die Darstellung von z.B. Personen anpassen,
- die HTML-Struktur der Zielseite verwenden.

mustache-Templates

In der Vorlage stehen alle Metadaten, das Vorschaubild und alle Aktionen der Dokumente zur Verfügung. Die folgende Vorlage zeigt das Vorschaubild und den Titel als Überschrift und darunter den Inhalt des Dokuments an:

<h3>{{{icon}}} {{{title}}}</h3>
<p>
{{{content}}}
</p>

Schreiben sie den Namen eines Metadatums in {{{ }}}, um das Metadatum anzuzeigen, z.B.:

{{{Author}}}

oder

Autor: {{{Author}}}

Wenn das Metadatum nicht vorhanden ist, soll auch "Autor:" nicht angezeigt werden? Mit einer Bedingung machen Sie die Ausgabe optional:

{{#Author?}}Autor: {{{Author}}}{{/Author?}}

Die komplette Vorlage:

<h3>{{{icon}}} {{{title}}}</h3>

{{#Author?}}Autor: {{{Author}}}{{/Author?}}

<p>

{{{content}}}

</p>

Die Ausgabe könnte dann wie folgt aussehen:

<div>

<h3><img src="..."> Dokument</h3>

Autor: Max Mustermann

<p>

Lorem impsum ...

</p>

</div>

<div>

<h3><img src="..."> Max Mustermann</h3>

</div>

Mit {{#actions.data}}{{{html}}}{{/actions.data}} geben Sie alle Aktionen aus. Um nur auf die erste Aktion zuzugreifen, können Sie {{actions.data[0].value.href}} verwenden.

Die komplette Vorlage mit der ersten Aktion als Link:

<h3>

{{{icon}}} {{{title}}}

</a>

</h3>

{{#Author?}}Autor: {{{Author}}}{{/Author?}}

<p>

{{{content}}}

</p>

Die Ausgabe könnte dann wie folgt aussehen:

<div>

<h3><a href="http://..."><img src="..."> Dokument</a></h3>

Autor: Max Mustermann

<p>

Lorem impsum ...

</p>

</div>

<div>

<h3><a href="http://..."><img src="..."> Max Mustermann</a></h3>

</div>

Link

Mit einem Link kann die Suche in einer externen Suchmaschine fortgesetzt werden.

Bildschirmfoto:

Einstellungen:

Adresse: die Adresse der externen Suche mit Platzhaltern, z.B. https://duckduckgo.com/?q={searchTerms}. {searchTerms} wird mit dem Suchbegriff ersetzt, {language} mit der Sprache der Suchanwendung.
Text: Der Text des Links

Blättern

Mit dem Blättern-Widget können die Benutzer weitere Suchergebnisse anzeigen. Verwenden Sie dieses Widget, falls Sie bei den Ergebnissen die Option Ergebnisse beim Scrollen anzeigen nicht aktiviert haben.

Bildschirmfoto:

Detailinformation für Anpassungen finden Sie beim pagination-Widget.

Seiten

Mit dem Seiten-Widget kann seitenweisen in den Suchresultaten navigiert werden. Bei den Ergebnissen sollte die Option „Ergebnisse beim Scrollen anzeigen“ deaktiviert sein, damit nur eine Variante zum Blättern zur Verfügung steht.

Bildschirmfoto:

Detailinformation für benutzerdefinierte Anpassungen finden Sie beim pages-Widget.

Filter

Filter dienen zum Einschränken der Suchergebnisse. Beim Hinzufügen des Widgets stehen alle Filter zur Auswahl, die für die aktuelle Suche möglich sind.

Bildschirmfoto:

Einstellungen:

Filter: das Metadatum, das für den Filter verwendet wird
Titel: falls Sie nicht die Standardübersetzung des Metadatennamens anzeigen möchten, geben Sie hier den gewünschten Titel an (Vorsicht wenn der Suchclient in unterschiedlichen Sprachen verwendet wird).
Benutzereingaben zulassen: mit „Widget automatisch auswählen“ wird die Benutzereingabe unter dem Filter an dessen Typ angepasst, z.B. Datumseingabe für Datumswerte, Autovervollständigung für Textwerte. „Deaktiviert“ blendet die Benutzereingabe aus. Mit „Widget verwenden“ wird die Option „Widget für Benutzereingaben“ angezeigt.
Widget für Benutzereingaben: Wählen sie das Widget aus, das für die Benutzereingabe verwendet werden soll.
Benutzereingabe immer anzeigen: Soll die Benutzereingabe auch angezeigt werden, wenn noch kein Suchbegriff eingegeben wurde?
Anzahl der angezeigten Filterwerte: Die angegebene Anzahl wird standardmäßig angezeigt, weitere Werte können mit "Mehr anzeigen“ und „Weniger anzeigen“ ein- oder ausgeblendet werden.
Aufklappbar: Der Benutzer kann den Filter zuklappen, somit wird nur noch die Titelzeile angezeigt.
standardmäßig aufgeklappt: Der Filter wird zu Beginn aufgeklappt dargestellt.
Verknüpfung von ausgewählten Filterwerten: Muss ein Treffer alle ausgewählten Werte besitzen (AND) oder genügt einer (OR). Standardwert: OR
Kombinationen von Filterwerten erlauben: Aktiviert eine Schaltfläche „+“ neben einem Filterwert, mit dem eine Und-Verknüpfung gemacht werden kann.
Sortieren nach: „Anzahl Filterwerte“ sortiert nach Häufigkeit des Auftretens, „Titel“ nach dem Filterwert, „Angepasst“ sortiert nach Titel in aufsteigender Reihenfolge und es können die ersten Werte angegeben werden.
Sortierreihenfolge: „Aufsteigend“ und „Absteigend“ legen die Richtung direkt fest. Standardwert: Aufsteigend
Angepasste Reihenfolge: Liste der zu Beginn anzuzeigenden Werte, Beistrich getrennt.
Vorlage: Sie können die Darstellung der Filter mittels mustache-Templates anpassen.

Mustache-Templates

Die Vorlage enthält den Wert des Filtereintrags, die Anzahl der Dokumente und ob der eingegebene Eintrag bei der aktuellen Suche berücksichtigt wird oder nicht.

Standardvorlage:

{{{html}}}

<span class="pull-right">{{^count?}}-{{/count?}}{{count}}</span>

<span class="pull-right">{{count}}</span>

Designer einbetten

Es ist möglich, den Mindbreeze Insight App Designer als eigenständige, eingebettete Anwendung zu verwenden. Wie bei der Insight App selbst funktioniert dies in wenigen Schritten.

Erforderliche Ressourcen

Styles

Das allgemeine Designer-Styling wird über das File designer.css bereitgestellt. Das File kann unter der Client-Service-Adresse im Ordner apps/css/v2/ abgerufen werden.

Mindbreeze liefert zusätzlich für eingebettete Designer auch das File designer-prefixed.css aus, in welchem die CSS Klassen einen Präfix erhalten und nur die notwendigsten Regeln enthält.

4.4.1.2 Scripts

Das benötigte JavaScript wird von editor.js bereitgestellt. Es kann unter der Client-Service-Adresse unter apps/scripts/ aufgerufen werden.

4.4.1.3 HTML

Der nächste Schritt besteht darin, das notwendige HTML in einem Container-Element (Root-Element) im HTML zu platzieren. Hierfür eignet sich ein entsprechendes Element mit der ID "designer-container".

Dieser Container ist notwendig, damit sich der Designer nur in diesem Element ausbreiten kann und hat den folgenden Inhalt (kann kopiert und eingefügt werden):

</div>

</div>

</div>

JavaScript

Der Application-Konstruktor erstellt eine Suchanwendung und ermöglicht die Bearbeitung mit dem Mindbreeze Insight App Designer.

Das notwendige JavaScript-Snippet befindet sich unter den HTML-Elementen. Hier wird eine neue Anwendung erstellt und im Callback wird der Bearbeitungsmodus der Anwendung aufgerufen.

Mindbreeze.require([

"client/application",

"utils/browser"

], function(

Application,

browser

) {

var options = {

startSearch: false,

rootEl: document.getElementById("insight-app-container"),

containerEl: document.getElementById("designer-container"),

callback: function (application) {

application.edit()

}

};

var sources = browser.getURLParameter("sources");

if (sources) options.sources = [ sources + "../../api/v2/" ];

new Application(options);

});

Verfügbare Widgets

Der folgende Teil enthält die Beschreibung aller zur Verfügung stehenden Widgets. Widgets sind HTML-Tags, die in beliebige HTML-Dateien eingefügt werden. HTML-Tags mit dem Attribut data-template="<Widget-ID>" werden zu Widgets. Einstellungen und Vorlagen können entweder als weitere Attribute oder als Inhalt des Tags definiert werden. Beispiele:

<h3>{{{icon}}} {{{title}}}</h3>

<p>

{{{content}}}

</p>

</script>

</div>

accordion

Das Accordion-Widget ist ein Element zur Einfassung von auf- und zuklappbaren Bereichen.

Enthaltene Elemente mit role=tab werden als auf- und zuklappbar dargestellt und können mit der Tastatur bedient werden. Das Widget verwendet die ARIA-role tablist (http://www.w3.org/TR/wai-aria/roles#tablist), die Unterelemente müssen der definierten Struktur entsprechen.

Beispiele:

</div>

Einstellungen:

data-enabled: bei true können die Bereiche geöffnet und geschlossen werden. Standardwert: false
data-default-open: gibt an, ob die enthaltenen Bereiche standardmäßig geöffnet oder geschlossen sind. Standardwert: false

alert

Ein „alert“ zeigt Fehler an, die bei der Suche aufgetreten sind.

Bildschirmfoto:

Modell: application.models.channels.alerts

Beispiele:

{{{message}}}

{{{error}}}

{{{warning}}}

{{{info}}}

({{{service_ids}}})

</div>

</script>

</div>

mustache-Templates

Werte:

level: info, warning, error
message: Fehlermeldung
error: Fehlermeldung
warning: Warnmeldung
info: Informationsmeldung
service_ids: Serivces, die die Meldung verursacht haben

alertcenter

Das alertcenter-Widget ist ein Element zum Anzeigen von beliebigen Alerts. Diese Alerts können entweder vom User angelegt oder auch als Template von Administratoren hinterlegt worden sein. Dazu wird pro User eine E-Mail-Adresse hinterlegt, an welche diese Alerts (bei Änderungen von Treffern) im gewünschten Abstand versendet werden. Somit ist diese Komponente eine Erweiterung der „alertedsearches“ Komponente, welche damit abgelöst wird.

Beispiel:
<div data-template="alertedsearches"></div>

Konfiguration
Um dieses Widget verwenden zu können, sind im Konfigurator Einstellungen nötig.

annotationPopup

Das annotationPopup-Widget ist ein Element zum Anzeigen von Eigenschaften in der Preview-Komponente via mousehover über einer Annotation. Dabei werden sämtliche Eigenschaften aus der URL verwendet, welche als URL-Parameter angegeben werden. Werden nicht alle Eigenschaften gewünscht, können die gewünschten Eigenschaften im Mustache-Template explizit angegeben werden (Achtung: Diese müssen als URL-Parameter verfügbar sein).

Beispiel:
https://entity.yourcompany.com/?type=Search&code=J01FA09&term=Mindbreeze%20InSpire

Zusätzlich kann zu jeder Annotation ein Feedback abgegeben werden, welches in App.Telemetry ersichtlich ist:

Final eingebettet sieht es in der PDF-Vorschau wie folgt aus:

Beispiel:

Um dieses Feature verwenden zu können, muss im Client folgender Container hinzugefügt werden:

</div>

Weiteres Beispiel:

{{#term?}} <div><b>{{term}}</b></div> {{/term?}}

{{#code?}} <div>Code: {{code}}</div> {{/code?}}

{{#type?}} <div>Type: {{type}}</div> {{/type?}}

</script>

</div>

Einstellungen:

data-enable-feedback: Aktiviert die Feedbackfunktionalität am Client. Default: false

applists

Bietet eine Auswahl an föderierbaren Quellen.

Bildschirmfoto:

Modell: application.models.applists

Beispiel:

breadcrumb

Wenn Aktionen die Ergebnisse einschränken, stehen diese Einschränkungen im breadcrumb-Widget zur Verfügung und können dort wieder deaktiviert werden.

Bildschirmfoto:

Modell: application.models.search.user.constraints

Beispiele:

<div>

<span title="{{{description}}}">{{{description}}}</span>

</label>

</div>

</script>

</ul>

Einstellungen:

data-display-filteredfacets: bei true werden ausgewählte Filterwerte auch angezeigt. Standardwert: false

charts

Zeigt Filter in Form von Charts an und besitzt somit eine Ähnliche Funktion wie die Komponente filteredfacet.

Verfügbare Chart-Typen

Pie

Wählt man den Chart-Type „pie“ aus, erhält man eine Grafik wie in folgender Grafik angezeigt. Die möglichen Einstellungen findet man hier.

Beispiel:

<div data-template="charts"

data-charttype="pie"

data-chartSourceName="extension"

data-chartTitle="Erweiterung"

data-showlegend="true"

></div>

Bar

Wählt man den Chart-Type „bar“ aus, erhält man eine Grafik wie in folgender Grafik angezeigt. Die möglichen Einstellungen findet man hier.

Beispiel:

<div data-template="charts"

data-charttype="bar"

data-chartSourceName="extension"

data-chartTitle="Erweiterung"

></div>

Line

Wählt man den Chart-Type „line“ aus, erhält man eine Grafik wie in folgender Grafik angezeigt. Die möglichen Einstellungen findet man hier.

Beispiel:

<div data-template="charts"

data-charttype="line"

data-chartSourceName="extension"

data-chartTitle="Erweiterung"

></div>

Einstellungen der Charts

data-template: Als Template wird “charts” angegeben.

data-charttype: Gibt den Type des Charts an. In diesem Fall wird „pie“ verwendet.

data-chartsourcename: Gibt den zu verwendenen Filter an (Bsp.: „extension“, „mes:size“, etc.).

data-enablecustomsourcename: Verwendung von benutzerdefiniertem Sourcename oder Sourcename (Default: “false”)

data-customsourcename: Gibt den zu verwendenen benutzerdefinierten Sourcename an, sollte dieser nicht in der Auswahlliste von „Sourcename“ vorhanden sein. (Freitext)

data-charttitle: Setzt eine Überschrift bzw. den Titel. Beispiel: „Erweiterung“.

data-showlegend: Zeigt die Werte in der Legende an („true“ or „false“ – Default: „false“).

data-chartheight: Setzt die Höhe des Charts (default “200”).

data-chartwidth: Setzt die Breite des Charts (default 100 Prozent).

data-titlealign: Ausrichtung der Überschrift (“left”,”center”,”right” – Default: „center“).

collect

Widget für Ergebnisse, die mit der "Sammeln"-Aktion gesammelt wurden.

Bildschirmfoto:

Modell: application.models.collected

Beispiel:

Einstellungen:

data-favorites-collection-path: Persisted Collection Pfad zum Speichern der gesammelten Ergebnisse. Muss mit favorites/ beginnen. Standardwert: leer
data-results-shortcut: Beschreibung der Tastenkombination, die verwendet wird, um zu den Resultaten zu navigieren. Beispiel: Alt+2, Standardwert: leer

constraints

Zeigt einen Filter für die Einschränkungen der Datenquellen an. Bei Microsoft Exchange stehen beispielsweise E-Mail, Anhang, Kalender, Kontakt, Aufgabe, Notiz und Post zur Auswahl.

Bildschirmfoto:

Modell: application.models.userSourceInfo

Beispiel:

mustache-Templates

Siehe mustache-Templates unter filteredfacet.

datasources

Zeigt einen Filter für die Datenquellen an. Hier können Datenquellen, wie Microsoft Exchange, Fabasoft Folio, Microsoft SharePoint ausgewählt werden.

Bildschirmfoto:

Modell: application.models.userSourceInfo

Beispiel:

mustache-Templates

Siehe mustache-Templates unter filteredfacet.

inputdate

Bietet eine Datumsauswahl für ein Eingabefeld an. Das Template muss auf einem input-Element verwendet werden. Das name-Attribut gibt an, welches Metadatum eingeschränkt wird.

Beispiele:

Einstellungen:

name: Name des Metadatums für die Einschränkung
data-isrange: bei true kann ein Zeitbereich angegeben werden. Standardwert: false
data-format: Datumsformat. Default Wert: “DD.MM.YYYY”
Andere Werte:
"DD.MM.YYYY", "DD-MM-YYYY", "MM.DD.YYYY", "MM-DD-YYYY",
"D. MMMM YYYY", "DD. MMMM YYYY", "DD MMMM YYYY"

Datumsfilter

Der Datumsfilter kann auch auf Monatsebene beginnen. Die Reihenfolge ist vom neuesten zum ältesten Datum.

Diese Einstellung findet man in den Client Services unter „Filter Settings. Dazu wird folgende Einstellung benötigt:

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

feedback

Die Feedback-Komponente zeigt die persistierten Daten von Ergebniselementen an und bietet die Möglichkeit, deren Wert in Persisted Resources zu ändern.

Diese Komponente zeigt in den Resultatsaktionen eine Dropdown-Liste mit Einträgen aus dem Backend-Service an. Für authentifizierte Benutzer ist dieser Wert änderbar, ansonsten ist er nur lesbar.

Beispiel:

<div

data-template="feedback"

data-enabled="$$DOCUMENT_LABELING_ENABLED$$"

data-label-path="$$DOCUMENT_LABELING_LABEL_PATH$$"

data-feedback-path="$$DOCUMENT_LABELING_FEEDBACK_PATH$$"

data-label-property="$$DOCUMENT_LABELING_LABEL_PROPERTY$$"

</div>

Sollten die Platzhalter-Attribute nicht verwendet werden, muss folgendes Format verwendet werden:

data-label-path=”labeldefinition/<label-pfad>”
data-collection-path=”itemdata/<feedback-collection>”

Einstellungen:

Enable	Aktiviert die Persistierten Ressourcen – Standardwert: false
User Administrator Users	Angabe der User Administratoren. User Administratoren können alle User verwalten (löschen, bearbeiten (z.B. E-Mail Adresse bearbeiten), hinzufügen). Jeder User wird in einer neuen Zeile eingetragen.
JDBC URL	Angabe der Datenbank URL.
Max Number Of Database Connections	Maximale Anzahl der Datenbankverbindungen. Standardwert: 10, Minimalwert: 2.
User	Bitte stattdessen ein Credential für die JDBC URL verwenden
Password	Bitte stattdessen ein Credential für die JDBC URL verwenden
Database Table Prefix	Angabe des Tabellen-Prefix in der Datenbank

Um die Komponente Feedback einzubinden, müssen die folgenden Einstellungen im Client Service aktiviert und richtig konfiguriert sein:

Text Classification Insight Service. Document Labeling und Persisted Resources: Die Konfiguration dazu finden Sie hier: „Text Classification Insight Service“.

feedbackbutton

Zeigt den app.telemetry-Feedback-Button an. Der Feedback-Button ist nur sichtbar, wenn app.telemetry für den Client aktiviert und der URL im Clientservice angegeben ist.

Bildschirmfoto:

Beispiel:

Einstellungen:

data-check-if-enabled-in-profile: der Feedback-Button kann im Profil aktiviert/deaktiviert werden. Mit dieser Option legen Sie fest, ob die Profileinstellung berücksichtigt wird. Werte: true, false

Der URL muss im Manager unter Clientservice beim Punkt: Fabasoft app.telemetry Web API URL eingetragen werden. (http://yourdomain.com/web.telemetry)

filteredfacet

Bildschirmfoto:

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

Beispiele:

data-tag-name="span"

data-attr-title="{{name}}{{^name?}}{{html}}{{/name?}}"

{{{html}}}

<span class="pull-right">{{^count?}}-{{/count?}}{{count}}</span>

<span class="pull-right">{{count}}</span>

</script>

</div>

<div data-template="filteredfacet"

data-name="Author"

data-container-tag-name="div"

data-container-class-name="filter"

data-entry-tag-name="div"

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

</div>

Ausgabe:

<div data-template="filteredfacet"

data-name="Author"

data-title-tag-name="h3"

data-title-class-name="title"

data-container-tag-name="div"

data-container-class-name="filter"

data-entry-tag-name="div"

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

<h3 class="title">Autor</h3>

...

</div>

...

</div>

Einstellungen:

data-name: das Metadatum, das für den Filter verwendet wird
data-user-input: mit disabled kann die Benutzereingabe unter dem Filter deaktiviert werden. Mit auto wird die Benutzereingabe an den Typ des Filters angepasst, z.B. Datumseingabe für Datumswerte, Autovervollständigung für Textwerte. Ohne Angabe wird auto verwendet.

Die Einstellung ersetzt data-suggest:
data-suggest="false" => data-user-input="disabled"
data-suggest="true" => data-user-input="auto"
data-user-input-template: Widget, das für die Benutzereingabe verwendet wird. Mit suggest wird die Autovervollständigung angezeigt, inputdate zeigt die Datumseingabe. Damit der Wert verwendet wird, darf data-user-input nicht gesetzt sein.
data-user-input-<Einstellung>: übergeben Sie Einstellungen an das Benutzereingabe-Widget. Z.B. data-user-input-isrange="true" beim inputdate-Widget.
data-always-visible: mit true wird der Filter auch angezeigt, wenn noch keine Suche abgesetzt wurde. Da der Typ eines Filters ohne Suche nicht bekannt ist, muss data-user-input-template definiert sein. Standardwert: false
data-incomplete-class: Diese Klasse wird dem HTML Element gesetzt, wenn der Filter „incomplete“ liefert. Default „mb-incomplete“.
data-title: falls Sie nicht die Standardübersetzung des Metadatennamens anzeigen möchten, geben Sie hier den gewünschten Titel an
data-title-tag-name: HTML-Tag, das für die Überschriften der Filter verwendet wird. Standardwert: h3
data-title-class-name: CSS-Klassenname, der für die Überschriften der Filter verwendet wird. Standardwert: leer
data-title-template: Mustache-Template zur Darstellung des Titels. Verfügbare Werte: title, isOpen. Standardwert: leer
data-container-tag-name: HTML-Tag für das Element, das die Filtereinträge enthält. Standardwert: ul
data-container-class-name: CSS-Klassenname für das Element, das die Filtereinträge enthält. Standardwert: leer
data-entry-tag-name: HTML-Tag für einen Filtereintrag. Standardwert: li
data-entry-class-name: CSS-Klassenname für einen Filtereintrag. Standardwert: leer
data-entry-role: ARIA-role-Attribut für einen Filtereintrag. Standardwert: leer
data-collapsible: bei true kann der Filter geöffnet und geschlossen werden. Standardwert: false
data-default-open: gibt an, ob der Filter standardmäßig geöffnet oder geschlossen ist. Standardwert: false
data-displayed: Anzahl der angezeigten Filterwerte. Schränkt die Anzeige der am Client Service konfigurierten Anzahl weiter ein. Sind mehr Einträge vorhanden, können diese mit einer Schaltfläche angezeigt werden.
data-and-available: Aktiviert eine Schaltfläche „+“ neben einem Filterwert, mit dem eine Und-Verknüpfung gemacht werden kann. Standardwert: false
data-intersect-values: Verwendet für die Verknüpfung der ausgewählten Werte AND, somit müssen Treffer alle ausgewählten Werte enthalten. Standardwert: false
data-order-criteria: COUNT sortiert nach Häufigkeit des Auftretens, VALUE nach dem Filterwert, PREDEFINED sortiert nach Titel in aufsteigender Reihenfolge und es können die ersten Werte in data-predefined-order angegeben werden.
data-order-direction: ASCENDING und DESCENDING legen die Richtung direkt fest. Standardwert: ASCENDING
data-predefined-order: Liste der zu Beginn anzuzeigenden Werte, beistrichgetrennt oder JSON. Z.B. pdf, gif oder ["pdf", "gif"]
data-restore-focus: Setzt den Fokus nach Auswahl eines Wertes wieder auf die Checkbox. Standardwert: true
data-show-checkbox: Soll eine Checkbox angezeigt werden? Standardwert: true
data-show-all: Soll die Option „Alle“ angezeigt werden? Standardwert: true
data-all-descendants: Soll die komplette Hierarchie ohne Einschränkung zurückgeliefert werden? Standardwert: false

mustache-Templates

In der Vorlage steht der Wert eines Filtereintrags, die Anzahl der Dokumente, sowie ob der Eintrag aktuell bei der Suche berücksichtigt wird oder nicht.

Standardvorlage:

{{{html}}}

<span class="pull-right">{{^count?}}-{{/count?}}{{count}}</span>

<span class="pull-right">{{count}}</span>

Werte:

html: der formatierte Wert des Filtereintrages, z.B. pdf, Max Mustermann, 2014
value: der Wert des Filtereintrages (z.B. bei Datumswerten)
count: die Anzahl der gefundenen Dokumente für diesen Eintrag
excluded: ist der Eintrag nicht ausgewählt, obwohl andere ausgewählt sind

filteredfacets

Zeigt eine Gruppe von Filtern an. Aktuell steht die Gruppe "mes:configuredfacets" zur Verfügung, die alle in der Client Service-Konfiguration ausgewählten Filter enthält.

Für die Darstellung der einzelnen Filter wird das filteredfacet-Widget verwendet. Eine Darstellungsvorlage dafür kann in filteredfacets hinterlegt werden. Die Möglichkeiten für diese Vorlage finden Sie unter mustache-Templates bei filteredfacet. Zusätzlich können die Filter per Option als Comboboxen angezeigt werden.

Bildschirmfoto:

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

Beispiele:

data-tag-name="span"

data-attr-title="{{name}}{{^name?}}{{html}}{{/name?}}"

{{{html}}}

<span class="pull-right">{{^count?}}-{{/count?}}{{count}}</span>

<span class="pull-right">{{count}}</span>

</script>

</div>

Einstellungen:

data-name: die Filtergruppe, die angezeigt wird
data-user-input: mit disabled kann die Benutzereingabe unter dem Filter deaktiviert werden. Mit auto wird die Benutzereingabe an den Typ des Filters angepasst, z.B. Datumseingabe für Datumswerte, Autovervollständigung für Textwerte. Ohne Angabe wird auto verwendet.

Die Einstellung ersetzt data-suggest:
data-suggest="false" => data-user-input="disabled"
data-suggest="true" => data-user-input="auto"
data-user-input-template: Widget, das für die Benutzereingabe verwendet wird. Mit suggest wird die Autovervollständigung angezeigt, inputdate zeigt die Datumseingabe. Damit der Wert verwendet wird, darf data-user-input nicht gesetzt sein.
data-user-input-<Einstellung>: übergeben Sie Einstellungen an das Benutzereingabe-Widget. Z.B. data-user-input-isrange="true" beim inputdate-Widget.
data-title-tag-name: HTML-Tag, das für die Überschriften der Filter verwendet wird. Standardwert: h5
data-title-class-name: CSS-Klassenname, der für die Überschriften der Filter verwendet wird. Standardwert: leer
data-facet-container-tag-name: HTML-Tag für das Element, das die Filtereinträge enthält. Standardwert: ul
data-facet-container-class-name: CSS-Klassenname für das Element, das die Filtereinträge enthält. Standardwert: leer
data-facet-entry-tag-name: HTML-Tag für einen Filtereintrag. Standardwert: li
data-facet-entry-class-name: CSS-Klassenname für einen Filtereintrag. Standardwert: leer
data-collapsible: bei true kann der Filter geöffnet und geschlossen werden. Standardwert: false
data-default-open: gibt an, ob der Filter standardmäßig geöffnet oder geschlossen ist. Standardwert: false
data-displayed: Anzahl der angezeigten Filterwerte. Schränkt die Anzeige der am Client Service konfigurierten Anzahl weiter ein. Sind mehr Einträge vorhanden, können diese mit einer Schaltfläche angezeigt werden.
data-dropdownfilter: Bei „true“ werden die Filter als Dropdown bzw. Combobox dargestellt. Standardwert: false

mustache-Templates

Die Vorlage für das filteredfacet-widget wird wie folgt definiert:

...

</div>

Siehe mustache-Templates unter filteredfacet.

map

Zeigt Ergebnisse, die Geodaten enthalten, in einer Karte. Gibt es kein Ergebnis mit Geodaten wird die Karte nicht angezeigt. Geodaten müssen in den Metadaten geo_latitude und geo_longitude enthalten sein (als Float, Integer oder String, wobei das Dezimaltrennzeichen in diesem Fall ein Punkt sein muss).

Bildschirmfoto:

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

Beispiel:

mustache-Templates

Der Inhalt des Markers kann mittels Mustache-Template angepasst werden. Die Vorlage für das Map-Widget wird wie folgt definiert (Hilfe siehe mustache):

<a target="_blank" href="{{actions[0].href}}">{{{title}}}</a>

</script>

</div>

Mehrere Markierungen zu einem Resultat anzeigen

Mit folgendem Beispiel können für nur ein einziges Resultat mit mehreren geo_latitude/geo_longitude Weten mehrere Marker in der Map angezeigt werden.

Folgender Aufbau ist notwendig:

"geo_latitude": { data: [ {"value": 15.3343 ], {"value": 14.11111}, … ] }

"geo_longitude": { data: [ {"value": 48.1234 ], {"value": 57.1234}, … ] }

"customProperty ": { data: [ {"value”: “Title 1”], {"value": “Title 2 }, … ] }

{{{customProperty[geo_index]}}}

</a>

</script>

</div>

Einstellungen:

data-allow-symbolic-path: Um dynamische Eigenschaften zu aktivieren. Beispiel „myProp[index]“. Default false.

mustache

Mit dem mustache-Widget können beliebige JavaScript-Objekte mit mustache-Templates angezeigt werden.

Spezialverhalten: {{#...?}}{{/...?}} {{..}} vs. {{{...}}}

Beispiele:

<h3>{{{icon}}} {{{title}}}</h3>

<p>

{{{content}}}

</p>

</script>

<h3>{{{icon}}} {{{title}}}</h3>

<p>

{{{content}}}

</p>

</script>

<h3>{{{icon}}} {{{title}}}</h3>

<p>

{{{content}}}

</p>

</script>

Einstellungen:

data-tag-name: HTML-Tag für die Vorlage. Standardwert: div
data-class-name: CSS-Klassenname für die Vorlage. Standardwert: leer
data-use-output-only: wenn aktiviert, wird der Input-Teil des Modells nicht für die Darstellung verwendet. Standardwert: false
data-attr-*: Attribute können mit mustache-Templates berechnet werden, z.B. data-attr-id="{{myId}}" → <... id="valueOfMyId">.

Werte:

Die Werte hängen vom verwendeten Model, also dem umgebenden Widget ab. Für Übersetzungen steht immer i18n zur Verfügung, z.B.

Events:

afterRender: modelType:
- Parameters: application, widget, model
- Eventziel: application.views

pages

Zur seitenweisen Navigation der Suchresultate. Verwenden Sie dieses Widget, falls Sie bei den Ergebnissen die Option „Ergebnisse beim Scrollen anzeigen“ nicht aktiviert haben und nicht nur nach vorne und zurück navigieren möchten.

Bildschirmfoto:

Beispiele:

</script>

</div>

Einstellungen:

data-max-page-count: Anzahl der maximal angezeigten Seiten. Gibt es mehr Seiten, wird im Standardtemplate „…“ ausgegeben (siehe Bildschirmfoto).

mustache-Templates

In der Vorlage stehen folgende Eigenschaften zur Verfügung:

pages: eine Liste der verfügbaren Seiten. Die aktuell ausgewählte Seite liefert current_page true. Mit page kann auf die Seitenzahl zugegriffen werden.

onFirstPage: enthält true, wenn die erste Seite ausgewählt ist

onLastPage: enthält true, wenn die letzte Seite ausgewählt ist

more_avail: enthält true, wenn mehr als die angeforderten Seiten verfügbar sind

Die Standardvorlage:

<ul>

</ul>

</script>

pagination

Mit dem pagination-Widget können die Benutzer weitere Suchergebnisse anzeigen. Verwenden Sie dieses Widget, falls Sie bei den Ergebnissen die Option „Ergebnisse beim Scrollen anzeigen“ nicht aktiviert haben.

Bildschirmfoto:

Beispiele:

Weitere Ergebnisse laden

</a>

</div>

Zurück

</a>

Weiter

</a>

</div>

Das pagination-Widget zeigt Elemente mit CSS-Klassenname mb-next an, wenn weitergeblättert werden kann. Falls zurückgeblättert werden kann, wird der CSS-Klassenname mb-previous verwendet.

Für das Auslösen der Aktionen verwenden Sie class="... action" data-action="<Aktion>". Mit der Aktion this.nextPage() können Sie weiterblättern, mit this.previousPage() zurück. Wenn die Ergebnisse am Ende der Liste hinzugefügt werden sollen, verwenden Sie this.nextPage({ append: true }).

preview

Zeigt die Vorschau eines Dokuments an, wenn die Preview-Aktion ausgeführt wurde.

Bildschirmfoto:

Modell: preview

Beispiele:

<h3>

{{{icon}}} {{{title}}}

</a>

</h3>

{{#Author?}}Autor: {{{Author}}}{{/Author?}}

<p>

{{{content}}}

</p>

</script>

</div>

Einstellungen:

data-loading-message: Kann verwendet werden um wärend des ladens von Dokumenten im Vorschaufenster eine Nachricht anzuzeigen.
data-loading-message-styles: Kann verwendet werden, um den Stil der Nachricht anzupassen.

mustache-Templates

Die Möglichkeiten für diese Vorlage finden Sie unter mustache-Templates bei results.

queryinfo

Zeigt grafisch Expressions an.

Beispiel:

<div

data-template="queryinfo"

data-input-path="user.constraints.parsed.and.constraints"

data-title="Query Constraints"

class="constraints-container searchinfo_constraints">

</div>

Die Liste der verschiedenen Options für das Dropdown wird über die Funktion ‘getQueryinfoSelectOptionProperties’ beretigestellt. Diese Funktion gibt ein object mit “key”, “label” und „type“ zurück.

Key: Die Eigenschaft – Zum Beispiel “extension”

Label: Der lesbare Wert im Dropdown – Zum Beispiel „Endung“

Type: suggest | inputdate – Freitext oder Datumsfeld

var customApp = Application.extend({

getQueryinfoSelectOptionProperties: function () {

return {

"extension": { label: "File Format", type: "suggest"}

}

});

Der input-path ist entscheidend dafür, von wo aus die Exressions zur Anzeige verwendet werden.

In folgendem Beispiel muss sichergestellt sein, dass die Such-Einschränkungen am Search Input unter „user.constraints.parsed.and.constraints“ zu finden sind und würde somit wie folgt aussehen:

search_request.user:

{

"query": {

"and": [{

"unparsed": "Searchterm",

"description": "Searchterm",

"id": "query"

}]

"constraints": [{

"and": [{

"or": [{

"label": "extension",

"unparsed": "PDF",

"id": "constraintsGroupFound[0].constraints[0]"

},{

"label": "extension",

"unparsed": "TXT",

"id": "constraintsGroupFound[0].constraints[1]"

}],

"id": "constraints"

}],

"id": "parsed"

}]

}

results

Zeigt Ergebnisse an.

Bildschirmfoto:

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

Beispiele:

</div>

Einstellungen:

data-appendonscroll: Es werden automatisch zusätzliche Ergebnisse geladen, wenn der Benutzer nach unten scrollt. Aktivieren Sie diese Einstellung nur, wenn die Ergebnisanzeige das letzte Element auf der Seite ist, andernfalls können die Benutzer die Elemente unter den Ergebnissen nicht erreichen.
data-enable-optional-terms: Es wird automatisch ein Element an die Resultate hinzugefügt, mit dem man die Suche expliziter einschränken kann „Enthält nicht: {Term}“ und „Enthält: {Term}“. (Werte: true/false. Default true).
data-optional-terms-ratio: Ist dieses Feature aktiviert, kann zusätzlich das Verhältnis der Terms angegeben werden. Werte: 0 – 1 (Default 0.33). Type Float.

Events:

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

mustache-Templates

<h3>{{{icon}}} {{{title}}}</h3>

<p>

{{{content}}}

</p>

Schreiben Sie den Namen eines Metadatums in {{{ }}}, um das Metadatum anzuzeigen, z.B.:

{{{Author}}}

oder

Autor: {{{Author}}}

Wenn das Metadatum nicht vorhanden ist, soll auch "Autor:" nicht angezeigt werden? Mit einer Bedingung machen Sie die Ausgabe optional:

{{#Author?}}Autor: {{{Author}}}{{/Author?}}

Die komplette Vorlage:

<h3>{{{icon}}} {{{title}}}</h3>

{{#Author?}}Autor: {{{Author}}}{{/Author?}}

<p>

{{{content}}}

</p>

Die Ausgabe könnte dann wie folgt aussehen:

<div>

<h3><img src="..."> Dokument</h3>

Autor: Max Mustermann

<p>

Lorem impsum ...

</p>

</div>

<div>

<h3><img src="..."> Max Mustermann</h3>

</div>

Mit {{#actions.data}}{{{html}}}{{/actions.data}} geben Sie alle Aktionen aus. Um nur auf die erste Aktion zuzugreifen, können Sie {{actions.data[0].value.href}} verwenden.

Die komplette Vorlage mit der ersten Aktion als Link:

<h3>

{{{icon}}} {{{title}}}

</a>

</h3>

{{#Author?}}Autor: {{{Author}}}{{/Author?}}

<p>

{{{content}}}

</p>

Die Ausgabe könnte dann wie folgt aussehen:

<div>

<h3><a href="http://..."><img src="..."> Dokument</a></h3>

Autor: Max Mustermann

<p>

Lorem impsum ...

</p>

</div>

<div>

<h3><a href="http://..."><img src="..."> Max Mustermann</a></h3>

</div>

resultsprogress

Das resultsprogress-Widget zeigt in einem Fortschrittsbalken wie viele der verfügbaren Resultate bereits geladen wurden.

Beispiel:

savedsearches

Zeigt die gespeicherten Suchen an.

Modell: application.models.savedSearches

Beispiele:

Einstellungen:

aria-controls: enthält das Attribut die Id eines anderen Elements, wird dieses Element fokussiert, nachdem eine Suche abgesetzt wurde. Standardwert: leer
data-title-tag-name: HTML-Tag, das für die Überschrift verwendet wird. Standardwert: h2
data-title-class-name: CSS-Klassenname, der für die Überschrift verwendet wird. Standardwert: leer
data-serversaved: Speichert die Suche am Server. Standardwert: false

search

Das search-Widget dient zum Darstellen mehrerer Suchen in einer Applikation bzw. auf einer Seite. Verwenden Sie die template-refid, um einen Platzhalter dafür anzulegen (siehe Beispiel unten). Bei allen Suchen kann die Anzahl der Treffer angepasst werden (data-count). Somit eignet sich dieses Widget sehr gut, um z.B. neben den gewöhnlichen Treffern auch noch Personen oder bestimmte Filetypen anzuzeigen.

Beispiele:

Das Beispiel zeigt 3 Resultate mit der Extension „txt“ sowie direkt darunter 5 Resultate an Personen.

{{{title}}}

</div>

</script>

</div>

{{{title}}}

</div>

{{{person.name}}}

</script>

</div>

Einstellungen:

data-template-refid: Der Verweis zum Container mit dem data-template=“results“. Der Container muss von einem <div data-mb-exclude="true"> umschlossen sein.
data-count: Anzahl der Resultate in den jeweiligen Search-Templates.
data-constraint: Einschränkung für die jeweilige Suche (z.B. Files, Personen, Bilder,…)
data-name: Um Suchen zu unterscheiden und den Request.Name in app.telemetry einsehen zu können.
data-channel-url: Die URL des Zielservers der für die Föderierung benutzt werden soll (Type: “string“)
data-channel-type: Legt den Type des Kommunikationskanals fest. (z.B.: CrossDomainAjaxChannel, EWSChannel, …etc.). Wenn die data-channel-url gesetzt ist der data-channel-type jedoch nicht, wird der Typ CrossDomainAjaxChannel verwendet (Type: “string“)

searchform

Das searchform-Widget dient zur Eingabe von Suchbegriffen. Es kann mehrere Eingabeelemente (input, select) enthalten. Verwenden Sie das name-Attribut, um den Suchbegriff nur in einem Metadatum zu suchen. Ohne name-Attribut oder bei name="query" wird die Eingabe als genereller Suchbegriff verwendet.

Bildschirmfoto:

Modell: application.models.search.input

Beispiele:

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

</form>

<input data-template="suggest"

data-disabled="$$DISABLE_MAIN_SUGGEST$$"

data-placeholder="search"

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

data-aria-label="search"

autofocus

</form>

Einstellungen:

data-requires-user-input: ist die Option aktiviert, muss ein Suchbegriff eingegeben werden, damit eine Suche gestartet wird (es genügt nicht, dass ein Karteireiter oder ein Filter ausgewählt ist). Standardwert: false
aria-controls: enthält das Attribut die Id eines anderen Elements, wird dieses Element fokussiert, nachdem eine Suche abgesetzt wurde. Standardwert: leer

Das Attribut data-query-template legt die Suche fest, die für ein Eingabefeld verwendet wird. Verwenden Sie {{value}} als Platzhalter für den eingegebenen Wert.

searchinfo

Zeigt Informationen zu den Suchergebnissen an. Die Standardvorlage zeigt Suchtimeouts, "Keine Ergebnisse gefunden" und Alternative Suchbegriffe an.

Bildschirmfoto:

Modell: application.models.search

Beispiele:

</div>

<h5>

</h5>

<p>

{{{i18n.client_did_you_mean}}}:

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

</a>

</p>

</script>

</div>

mustache-Templates

In der Vorlage steht das gesamte Search-Modell zur Verfügung.

Standardvorlage:

</div>

</h2>

<p>

{{{i18n.client_did_you_mean}}}:

{{{alternatives.query_spelling.entries[0].html}}} </a>

</p>

Werte:

alternatives: Vorschläge zum eingegebenen Suchbegriff, aktuell führt query_spelling.entries[0] zum ersten Korrekturvorschlag. Hinweis: falls wider Erwarten Vorschläge erscheinen und eigene logische Operatoren in der Query verwendet werden, siehe: Hinweise zu Query Spelling Alternativen
computing: true, wenn gerade eine Suche durchgeführt wird
status_messages: Statusnachrichten zur Suche (z.B. status_messages.timeout oder status_messages.no_results)
estimated_count: Anzahl der Treffer für die abgesetzte Suche
orderable: eine Liste von verfügbaren Sortierkriterien, enthält localized_name für die Anzeige und name für die Auswahl in der API. isSelected enthält true, falls das Sortierkriterium ausgewählt ist.

sortswitch

Zeigt die für die Suche zur Verfügung stehenden Sortierkriterien an.

Bildschirmfoto:

Modell: application.models.search

Beispiele:

</div>

<ul>

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

</li>

</ul>

</div>

mustache-Templates

In der Vorlage steht das gesamte Search-Modell zur Verfügung.

Standardvorlage:

<h2>{{{i18n.client_toolbar_sortingalgorithm_label}}}</h2>

<option {{#isSelected?}}selected{{/isSelected?}} value="{{name}}">{{localized_name}}</option>

</select>

<legend class="mb-acc">{{i18n.order_direction}}</legend>

<span>

<span class="mb-acc">{{i18n.sort_ascending}}</span>

</span>

</label>

<span>

<span class="mb-acc">{{i18n.sort_descending}}</span>

</span>

</label>

</fieldset>

</div>

Werte:

Siehe mustache-Templates searchinfo.

stack

Mit dem stack-Widget können Benutzer Aktionen ausführen, die eine neue Suchanwendung als neue Suche ausführen. Optisch liegt die ausgeführte Aktion dann über der zuletzt ausgeführten. Dadurch kann einfach im Navigationspfad zurückgesprungen werden.

Bildschirmfoto:

+--------------+ +--------------+ +--------------+

| | |+--------------+ | |

| | || Vorschau | | |

| | || | | |

| Aktion o--------> || | | |

| ------ | || | | |

| | || | | |

+--------------+ +| | +--------------+

| |

+--------------+

Beispiele:

Ergebnisse

</div>

<a href="#"

data-action-object="{

"pushStack": {

"title": "PDF-Dokumente",

"template-ref": "pdfAppTemplate",

"applicationOptions": {

"startSearch": true

}}}">

PDF-Dokumente

</a>

</div>

</div>

Beispiel: Anzeige aller Informationen zu einer Person

...

<a href="#"

data-action-object="{

"pushStack": {

"title": "{{name}}",

"template-ref": "personTemplate",

"action": "showPerson"

}}">

Alles zu {{{name}}}

</a>

...

</div>

...

</div>

...

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 +'"'});

}

});

</script>

Parameter der Aktion pushStack:

template-ref: die id des HTML-Elements, das die Vorlage für den Stack enthält.
title: der Titel des Stack-Elements. Standardwert: Titel des Links
applicationOptions: die Initialisierungsoptionen für die Suchanwendung
action: eine Aktion, die nach dem Initialisieren der neuen Suchanwendung ausgeführt wird

suggest

Erlaubt die Verwendung der Autovervollständigung in einem Eingabefeld. Ab sofort können neben Suchtreffern aus Metadaten beliebte Suchen, die zuletzt durchgeführten Suchen und Begriffe aus Taxonomien vorgeschlagen werden. Zusätzlich können alle verfügbaren Tabs mit dem jeweiligen Suchbegriff durchsucht werden.

Bildschirmfoto – Vorschläge bei leerem Suchstring der letzten Suchen.

Bildschirmfoto – Vorschläge mit dem Suchbegriff „Mindbreeze“ aus Metadaten und Tabs.

Suggest Default Beispiel (im jeweiligen HTML zu finden)

< input data - template = "suggest"

data - disabled = "$$DISABLE_MAIN_SUGGEST$$"

data - placeholder = "search"

data - shortcut = "alt+1"

id = "query"

data - aria - describedby = "search-description"

data - source - id - pattern = "$$SUGGEST_SOURCE_ID_PATTERN$$"

data - initial - source - id - pattern = "$$SUGGEST_INITIAL_SOURCE_ID_PATTERN$$"

data - grouped = "true"

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

autofocus

Dieses HTML-Snippet kann mit allen verfügbaren Einstellungen angepasst werden. Beispiel:

< input data - template = "suggest"

data - placeholder = "search"

class = "mb-query"

name = "query"

type = "search"

data - source - id - pattern = "document_property|tabs"

data - initial - source - id - pattern = "recent_query|document_property"

data - grouped = "true"

data - show - onfocus = "true"

Einstellungen:

property: das Metadatum, das für die Vervollständigung verwendet werden soll. Standardwert: title
property-constraint: ein Suchbegriff zur Einschränkung der möglichen Werte. Standardwert: leer
count: die Anzahl der Vorschläge. Standardwert: 4
source-id-pattern: Angabe der Suggest-Quellen (z.B.: document_property|recent_query|tabs)
Standardwert: $$SUGGEST_SOURCE_ID_PATTERN$$. Wird diese Einstellung geändert, werden die Einstellungen im Konfigurator (Checkboxen zum Aktivieren der Vorschläge) nicht mehr berücksichtigt und überschrieben.
- document_property – liefert Vorschläge aus Metadaten
- popularsearches – liefert Vorschläge aus der Datenbank (Einstellungen in der Konfiguration nötig)
- words_and_terms – liefert Vorschläge aus einem Konzeptindex (CSV-File)
  (Einstellungen in der Konfiguration nötig)
- recent_query – liefert Vorschläge der letzten Suchen
- tabs – listet die verfügbaren Tabs auf, um in allen Tabs suchen zu können
initial-source-id-pattern: Einstellungen sind identisch zu source-id-pattern mit dem Unterschied, dass die Treffer von diesen Quellen angezeigt werden, wenn der Suchbegriff leer ist.
Standardwert: $$SUGGEST_INITIAL_SOURCE_ID_PATTERN$$. Wird diese Einstellung geändert, werden die Einstellungen im Konfigurator (Checkboxen zum Aktivieren der Vorschläge) nicht mehr berücksichtigt und überschrieben.
service: URL zu einem Suggest-Service. Standardwert: leer - gleich wie Suche
disabled: Vorschläge sind deaktiviert. Standardwert: false
grouped: Gruppiert die Autocomplete-Treffer zusammen (true/false)
initial-grouped: Gruppierung der Treffer bei der Initialsuche (true/false) - Standardwert: true
show-onfocus: Zeigt das Autocomplete beim Fokussieren des Textfeldes an (true/false) – Standardwert: false*1
suggest-timeout: Setzt ein Timeout für den Request. Angabe in Sekunden.
source-id-document_property-title: Setzt den Titel der “document_property” Quelle.*1
source-id-popularsearches-title: Setzt den Titel der “popularsearches” Quelle.*1
source-id-words-and-terms-title: Setzt den Titel der “word_and_term” Quelle.*1
source-id-recent-query-title: Setzt den Titel der “recent_query” Quelle.*1
default-tab-title: Ist kein Tab vorhanden, wird als Titel dieser Wert herangezogen.*1
source-id-order: Legt die Reihenfolge im Suggest fest:*1
Beispiel: „document_property,words_and_terms,tabs,recent_query“ (Beistrichgetrennt)
initial-source-id-order: Legt die Reihenfolge im Suggest fest, welche beim Fokussieren des Suchfeldes angezeigt wird (Einstellung identisch wie bei source-id-order).*1
before-submit-action – Löst eine eine Funktion der Application aus um beispielsweise den Searchrequest transformieren zu können und wird vor der ‘submit’ Aktion aufgerufen: “application.transformQuery(view)” *1

*1 Diese Einstellungen müssen auf Wunsch direkt im HTML-File angepasst werden.

Einstellen lassen sich die vorgeschlagenen Suchbegriffe im Konfigurator wie folgt:

Suggest Settings (Similar Terms):

ID: Die ID „popularsearches“ muss vergeben werden (Kann zum Stylen verwendet werden).
Source Name: Der Source Name kann z.B. „Popular Searches“ also beliebte Suchen, sein
Database JDBC URL: URL zur App.Telemetry Datenbank (Anlegen einer Datenbank wird unten erklärt).
Max Number Of Database Connections: Maximale Anzahl der Datenbankverbindungen. Standardwert: 10, Minimalwert: 2.
Table Name: Tabellenname aus der App.Telementry-Konfiguration
Table Column for Query: Auswahl der Anzahl der Ergebnisse – App Telemetry-Konfiguration
Table Column for Score: Auswahl des Spaltennamen der Ergebnisse aus der App Telemetry-Konfiguration
Table Column for View ID: Auswahl des Spaltennamen der Abfragen aus der App Telemetry-Konfiguration
Additional WHERE Clause: Hier haben Sie die Möglichkeit, verschiedene „WHERE“-Klauseln zu erstellen und hinzuzufügen.
Suggest If User Query Is Empty: wenn „true“ aktiviert ist, werden Vorschläge ausgegeben, auch wenn der User noch nicht gesucht hat.

Suggest Settings (Concept CSV):

ID: Die ID „words_and_terms“ muss vergeben werden (Kann zum Stylen verwendet werden).
Source Name: Der Source Name kann z.B. „Words and Terms“ also Worte und Begriffe, sein
CSV File Path: Der Pfad zum CSV-File

Die CSV-Datei muss die Spalten Disabled, PrefLabel, AltLabel und Definition enthalten. Die Spalten werden wird folgt verwendet:

Name	Funktion	Suchbegriff wird geprüft	Muss gesetzt sein
Disabled	TRUE: Zeile wird ignoriert	Nein	Nein
PrefLabel	Hauptteil des Vorschlags	Ja	Ja
AltLabel	Wird in Klammern hinter Preflabel angezeigt	Ja	Nein
Definition	Wird unter dem Vorschlag angezeigt	Nein	Nein

Beispiel: Die Zeile

Disabled	PrefLabel	AltLabel	Definition
	Example	Sample	A Definition

wird in der Autovervollständigung so angezeigt:

Suggest Settings und Initial Suggest Settings:

Grundsätzlich gilt: Die Einstellungen unter „Suggest Settings“ werden verwendet, sobald ein Suchbegriff eingegeben wurde – „Initial Suggest Settings“ werden verwendet, wenn der Suchbegriff leer ist (Siehe Bildschirmfoto- Vorschläge bei leerem Suchstring der letzten Suchen).

Enable Suggesting from CSV File: Wenn angehakt, wird das Suggest über die ähnlichen Suchbegriffe aus einem CSV-File gelesen
Enable Suggesting of Similar Queries: Wenn angehakt, wird das Suggest über die ähnlichen Suchbegriffe aus der App.Telemetry Datenbank gelesen.
Enable Suggesting of Tabs: Wenn angehakt, wird das Suggest über die ähnlichen Suchbegriffe aus der App.Telemetry Datenbank gelesen.
Enable Suggesting of Document Property: Wenn angehakt, wird das Suggest über die ähnlichen Suchbegriffe aus der App.Telemetry Datenbank gelesen.
Enable Suggesting of Recent Queries: Wenn angehakt, wird das Suggest über die ähnlichen Suchbegriffe aus der App.Telemetry Datenbank gelesen.

Tipp: Einfache Anleitung für das Anlegen der Datenbank für „Similar Terms“:
- create database similarterms;
- CREATE USER mindbreeze WITH PASSWORD 'Mindbreeze123';
- grant all privileges on database " similarterms" to mindbreeze;

suggestlist

Erlaubt die Verwendung der Suggest-Sourcen (beliebte Suchen, Begriffe und Wörter) als eigene Komponente.

Settings:

count: die Anzahl der Vorschläge. Standardwert: 4
title: Titel der Überschrift (Default: Popular Searches)
property: das Metadatum, das für die Vervollständigung verwendet werden soll. Standardwert: title
source-id-pattern: Angabe der Suggest-Quellen (Äquivalent zur Suggest-Komponente)

Bildschirmfoto:

Beispiele:

summarize

Erlaubt das Zusammenfassen bzw. Gruppieren von ähnlichen Ergebnissen.

Konfiguration:

Aktiviert bzw. deaktiviert wird diese Komponente im Client-Service:

Ist diese Komponente aktiv, erhält man im Client einen neuen Abschnitt „Zusammenfassen nach“.

Beispiel:

Einstellungen:

data-enabled: Aktiviert bzw. deaktiviert das Feature (Standardwert: true).
data-summarize_by.property: Die Ergebnisse lassen sich nach Eigenschaften zusammenfassen.
Beispiele: “mes:relevance”, “mes:date”, “extension”, … (Standardwert: empty)
data-summarize_by.orderby: Zusammengefasste Ergebnisse können nach Eigenschaften geordnet werden.
Beispiele: “mes:relevance”, “mes:date”, “extension”, … (Standardwert: empty)
data-summarize_by.order_direction: Zusammengefasste Ergebnisse können in auf- oder absteigender Reihenfolge geordnet werden (Standardwert: “ASCENDING”).
data-summarize_by.aggregated_properties: Ergebnisse können nach aggregierten Eigenschaften (Properties) zusammengefasst werden.
Hinweis: Die Ergebnisse werden, damit nicht verändert, sondern es wird lediglich eine neues Property zur Verfügung gestellt, welches man an einem beliebigen Platz im HTML via mustache-Template einfügen kann (z.B.: neben dem Titel).
Beispiele: [
            {"name":"countProperty","expr":"count()"},
            {"name":"sumProperty","expr":"sum()"},
            {"name":"averageProperty","expr":"avg()"}
         ]
Beschreibungen und weitere Beispiele zu den aggregierten Properties finden Sie hier.
data-summarize_by.summarize_non_existent: Ergebnisse ohne der angegebenen Eigenschaft werden ebenfalls zusammengefasst.
Beispiel: Nach zusammenfassen der Eigenschaft „extension“ werden alle anderen Inhalte, die keine „extension“ besitzen (beispielsweise Ordner) zu einer gemeinsamen Gruppe zusammengefasst. (Standardwert: false)

Um diese Funktion in Ihrer benutzerdefinierten Insight-App zu aktivieren, müssen Sie das mustache snippet wie hier beschrieben bearbeiten.

Dieses Widget ist auch im Designer unter dem tab "More" verfügbar.

tabs

Karteireiter, die Sucheinschränkungen zur Auswahl bieten. Die Karteireiter sind im Benutzerprofil hinterlegt, kommen von den Quellen und können auch im Element festgelegt werden.

Bildschirmfoto:

Modell: application.models.tabs, application.models.userSourceInfo

Beispiele:

</ul>

</ul>

data-tag-name="a"

data-attr-role="tab"

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

aria-hidden="true">

{{{name}}}

</script>

</ul>

Einstellungen:

data-model: tabs
data-editable: bei true können Tabs vom Benutzer hinzugefügt und bearbeitet werden.
data-datasourcetabs: falls true werden Karteireiter für die aktivierten Quellen angezeigt
data-role: ARIA-role der tabs. Standardwert: tablist
data-entry-role: ARIA-role der Listeneinträge. Standardwert: presentation

Eigene Karteireiter anlegen

Sie können in der Vorlage eigene Karteireiter anlegen. Verwenden Sie dazu folgendes HTML:

Einstellungen:

data-tabconfig: true
data-name: Name des Karteireiters. Falls es eine Übersetzung für den Namen gibt, wird er in der aktuellen Sprache angezeigt
data-constraint: der Suchbegriff, der als Einschränkung verwendet wird. Gibt es keine Einschränkung, werden alle Einschränkungen entfernt; so können Sie einen "Alles"-Karteireiter machen

mustache-Templates

In der Vorlage steht der Wert eines Filtereintrags, die Anzahl der Dokumente, sowie ob der Eintrag aktuell bei der Suche berücksichtigt wird oder nicht.

Standardvorlage:

data-tag-name="a"

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

aria-hidden="true">

{{{name}}}

Werte:

selected: liefert true falls der Karteireiter ausgewählt ist
constraint: die Einschränkung
name: der übersetzte Name

treeview

Rendert eine aus Modellen bestehende Collection.

Diese Collection wird idealerweise im initializeModels der Application erstellt und im „computed“ Event der Suche angereichert.

Im folgenden Beispiel wird eine Collection erstellt und im „computed“ Event der Suche mit den Eigenschaften „title“ und „mes:key“ befüllt und gerendert.

HTML:

<span>{{title}}</span>

</script>

</ul>

JavaScript:

var application = new Application({

startSearch: false,

initializeModels: function (application) {

application.models.treeViewCollection = new Backbone.Collection();

application.listenTo(

application.models.search,

"computed",

function(options) {

_.each(application.models.search.get("resultset.results"),

function (result) {

application.models.treeViewCollection.add({

'title': result.properties.title.data[0].value,

'mes:key': result.properties['mes:key'].data[0].value,

});

}

});

Erweitert man das HTML mit einer Aktion (data-action-name, data-action-object, …), kann beispielsweise via Klick auf das Resultat ein Stack geöffnet und eine 360° Ansicht auf ein bestimmtes Resultat angezeigt werden. Die dafür notwendige neue Suche kann mit Eigenschaften des geklickten Resultates bzw. des geklickten Modelles (options.model) angepasst werden.

Anleitung, wie ein Stack initialisiert und verwendet wird.

Weiters ist es möglich, die Resultate weiter einzuschränken und eine Hierarchische Resultatsliste zu erstellen.

Dazu wird ein Suchmodell angelegt, welches die Detailsuche absetzt und die anschließenden Treffer in den „children“ des Modelles befüllt und anzeigt.

Tipp: In den Arguments der „exampleAction“ wird das geklickte Resultat/Model mitübergeben (options.model). Damit kann auf sämtliche Eigenschaften (title, mes:key, …) des Resultates zugegriffen werden.

HTML:

<span data-action-name="exampleAction">{{title}}</span>

</script>

</ul>

JavaScript:

/* require api via "api/v2/api" */

var searchModel = api.search.createModel(application.models.channels);

searchModel.once("computed", function () {

var children = new Backbone.Collection();

_.each(searchModel.get("resultset.results"), function (result) {

children.add({

title: result.properties.title.data[0].value,

'mes:key': result.properties['mes:key'].data[0].value,

});

options.model.set("children", children);

searchModel.destroy();

}

searchModel.set("count", 5, { silent: true });

searchModel.set("source_context.constraints.view_base", {

unparsed: "ALL",

});

timeline

Zeigt Ergebnisse auf einer Zeitleiste an. In der Zeitleiste kann mittels Mausrad und Drag&Drop navigert werden.

Bildschirmfoto:

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

Beispiele:

<div data-template="timeline"

data-height="50px"

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

data-range-end="2015-12-31"

data-date="mes:date">

</div>

Einstellungen:

data-height: Höhe der Zeitleiste, auto für automatische Anpassung an die angezeigten Treffer oder Höhenangabe laut CSS, z.B. 200px. Standardwert: auto
data-range-start & data-range-end: Begrenzung der Zeitleiste auf einen Zeitraum. Die Angaben werden mit new Date(<Attributwert>) in ein Datum umgewandelt.
data-date: Legt fest welches Metadatum zur Positionierung herangezogen werden soll (Standardwert: mes:date).
data-padding-right: Legt den freizuhaltenden Bereich rechts fest. (Sollte der Titel des Resultats nicht mehr sichtbar sein)
data-padding-left: Legt den freizuhaltenden Bereich links fest. (Sollte der Titel des Resultats nicht mehr sichtbar sein)

mustache-Templates

Für die Darstellung der Einträge in der Zeitleiste können mustache-Templates verwendet werden. Mehr Information finden Sie unter results.

view

Das view-Widget legt die Basiseinstellung für die Suche fest. Es ändert die Darstellung der Seite nicht.

Modell: application.models.search.input

Beispiele:

Werte:

constraint: Einschränkung für die Suche
count: Anzahl der Suchtreffer
orderby: Sortierkriterium - aktuell mes:relevance oder mes:date
count_filtered_facet_values: Zeigt die Anzahl bei nicht ausgewählten Filterwerten an. Dieses Setting kann im Editor bei der Komponente „filteredfacet“ gesetzt werden (Checkbox bei „Anzahl bei nicht ausgewählten Filterwerten anzeigen“) - Default: true
computed_properties: Liefert zur Laufzeit neu erstellte Properties mittles Expression. Beispiel: [{"name": "my_new_property", "expr": "extension"}] - Default: nicht gesetzt

Das Application-Objekt

Der Application-Konstruktor erzeugt eine Suchanwendung mit den im HTML enthaltenen Widgets. Als Argument werden Einstellungen als Namen-Wert-Paare erwartet.

Einstellungen:

apiRequestHeaders: Durch diese Einstellung können bei Suchanfragen Header übergeben werden. Typ: Objekt. Z.B: apiRequestHeaders: headers["x-mes-auth-token"]
applicationId: Zur Unterscheidung in der app.telemetry kann die Application mit einer ID versehen werden.
Beispiel: „Meine Application“
Standardwert: “Default Application”
Typ: String
callback: Funktion, die nach der Initialisierung der Application aufgerufen wird. Erhält als Argument das Application-Objekt.
datasourcesCategoryOrder: Liste der Datenquellen-Categories, die für die Sortierung der Datenquellen verwendet wird. Für nicht angegebene Categories wird die alphabetische Standardsortierung verwendet. Z.B.: ["Web", "Microsoft Exchange"]
datasourcesGroupByCategory: Datenquellen nach Datenquellen-Category gruppiert anzeigen. Werte: true, false, Standardwert: true
datasourcesNameOrder: Liste der Datenquellen-Name, die für die Sortierung der Datenquellen verwendet wird. Ist datasourcesGroupByCategory aktiviert, werden die Datenquellen in den Gruppen sortiert. Für nicht angegebene Datenquellen wird die alphabetische Standardsortierung verwendet. Z.B. ["Benutzerlaufwerk","Intranet"]
enableProfile: aktiviert das Benutzerprofil. Werte: true, false, Standartwert: false
enableRemoteSources: aktiviert in der Konfiguration eingetragene föderierte Datenquellen. Werte: true, false, Standardwert: true
enablePersonalization: de-/aktiviert die Personalization am Client. Werte: true, false, Standartwert: true.
loginAsError: Login-Aufforderungen werden als Fehler behandelt. Es wird kein Login angezeigt. Werte: true, false, Standardwert: false
queryURLParameter: Name des URL-Parameters für Suchbegriffe (z.B. wird beim Öffnen der Seite http://www.example.com/?query=test eine Suche nach test gestartet). Standardwert: query
rootEl: DOM-Element in dem die Suchanwendung enthalten ist. Standardwert: document.body
rootEls: Liste von DOM-Element in welchen die Suchanwendung enthalten ist. Überschreibt die Einstellung rootEl. Standardwert: document.body
sources: Liste der Such-Adressen, z.B. ["<Client Service URL>/api/v2/"]. Standardwert: Adresse des Client Services, von dem die JavaScript-Datei geladen wurde. Optional kann anstelle der Liste ein AjaxChannel/CrossDomainAjaxChannel angegeben werden, z.B. new AjaxChannel({ url: "<Client Service URL>/api/v2/"}), um crossDomain Request zuzulassen. AjaxChannel kann via "service/ajax_channel" required werden. Bei der Definition einer ‚Source‘ durch ein Objekt {url: "<Client Service URL>/api/v2/", channelType: "AjaxChannel"} gibt die channelType-Eigenschaft an, welcher Channel verwendet werden soll. Die Werte: MessageFrameChannel, AjaxChannel, CrossDomainAjaxChannel sind verfügbar. Default: CrossAjaxDomainChannel.
linkOpenTarget: Default Target Option um Links zu öffnen. Werte: „_blank“, „_parent“, „_self“, „_top“. Standardwert: „_blank“
enableImmediateDisplayOfFederatedResults: Sollen bei föderierten Datenquellen immer alle Resultate, die von den einzelnen Services angefordert wurden, angezeigt werden? Dadurch kann es sein, dass weniger relevante Resultate bereits auf der ersten Seite angezeigt werden. Werte: true, false, Standardwert: false
startSearch: Soll bei der Initialisierung eine Suche gestartet werden, falls Einschränkungen hinterlegt sind? Werte: true, false, Standardwert: true
updateTitle: Soll bei der Initialisierung eine Suche gestartet werden, falls Einschränkungen hinterlegt sind? Werte: true, false, Standardwert: true
titleTemplate: Für den Titel kann ein mustache-Template hinterlegt werden, um den Suchbegriff (unparsedUserQuery), den Titel des aktuellen Stack-Elements (stackTitle) und den Status, ob gerade gesucht wird (computing), anzuzeigen. Standardwert:
{{#stackTitle}}{{stackTitle}} - {{/stackTitle}}{{^stackTitle}}{{#unparsedUserQuery?}}{{unparsedUserQuery}} - {{/unparsedUserQuery?}}{{/stackTitle}}" + document.title + "{{#computing?}} ...{{/computing?}}
enableUserSourceInfo: Sollen benutzerabhängige Einschränkungen verfügbar sein, muss diese Option aktiviert werden, z.B. um das Constraint-Widget verwenden zu können:
<div data-template="constraints" data-model="userSourceInfo" data-path="sources.constraints"></div>
Anzumerken ist, dass das Aktivieren dieser Option unter gewissen Umständen Auswirkungen auf die Performance haben kann.
Werte: true, false, Standardwert: false
crossDomainAjax: Liste von Eigenschaften, die vom CrossDomainAjaxChannel verwendet werden. Typ: Object.
Properties:
- loggedInHandlerBasePath: Der relative URL-Pfad zur HTML-Seite des Login-Handlers. Typ: string. Default: “apps/client/loggedin.html”
- loginWindowName: Der Parameter windowName des Loginfensters wie in Window.open() documentation beschrieben. Standardwert: _blank.
- loginWindowFeatures: Eine kommagetrennte Liste von Features für das Loginfenster wie in Window.open() documentation beschrieben. Standardwert: "menubar=no,width=800,height=600,top=100,left=100".
- onLoginAsErrorTreat403as401: Wenn die Eigenschaft „loginAsError“ und diese Eigenschaft true ist, werden Responses mit HTTP-Status 403 als Status 401 behandelt. Werte: true, false, Standardwert: true.
- treatBasicAuth401as403ForBrowser: Legt fest, ob eine 401-Antwort auf eine Basic-Auth-Anfrage wie ein Fehlercode 403 behandelt werden soll. Typ: Function. Standardwert: Aktiv nur für Safari-Browser. Return: Boolean.
  function(browserName) { return Boolean; }
- onLoginFailedErrorComponent: Legt fest wir Fehler beim Login-Prozess behandelt werden sollen (aktuell nur bei Problemen mit Popup-Blockern). Ist die Eigenschaft nicht gesetzt, dann wird der Standard Bootstrap Modaldialog verwendet.
  Wenn „onLoginFaild“ gesetzt ist, hat die Eigenschaft onLoginFaild Priorität gegenüber der Build in Error Komponente.
  Eigenschaften:
  - “alertComponent“: Wenn gesetzt, muss ein Alert Template im HTML definiert werden.
  - Jeder andere Wert verwendet die Standard-Komponente (Bootstrap modal).
- onLoginFailed: Diese Rückruffunktion (Callback) wird aufgerufen, wenn eine Anfrage aufgrund einer fehlgeschlagenen Authentisierung nicht erfolgreich ist, weil der Login-Dialog von einem Popup-Blocker blockiert wurde. Wenn diese Funktion definiert ist, werden in diesem Fall keine modalen Fehlerdialoge angezeigt.
  onLoginFailed function (reason, loginURL, serviceUrl, failedRequest) {}
  Parameter:
  - reason: Der Grund für den fehlgeschlagenen Login (aktuell nur PopupBlocker)
  - loginUrl: Adresse and der ein manueller Login stattfinden kann
  - serviceUrl: Adresse des Service für das der Login fehlgeszchlagen ist
  - failedRequest: {url: string, retryCallback: function() }:
    url: Die Adresse der Fehlgeschlagenen Anfrage
    retryCallback: Eine Rückruffunktion (Callback) mit der die Anfrage erneut gesendet werden kann.
ajaxOptions: Eine Liste von Eingeschaften, welche beim Ajax Channel verwendet werden. Typ: Object.
Eigenschaften:
- requestHeaders: Zusätzliche Header die im Ajax Request enthalten sein sollen. Type: Object oder Function.
  - Object: { “https://appliance.com”: { key: value, … }
  - Function: function(channelURL) { return { key: value, …}
- requestHeadersAsync: Benutzerdefinierte Header, die in Ajax-Anfragen asynchron übergeben werden sollen. Typ: Function.
  function(url: string, callback: function):
  - url: Aktuelle Request-URL
  - callback(error: Objekt, data: Objekt): Eine Callback-Funktion, die in einer asynchronen Funktion mit folgenden Argumenten aufgerufen wird:
    error: Sollte auf {message: 'Some error message'} gesetzt werden, falls ein Fehler auftritt, ansonsten auf NULL.
    data: Ist die Liste der Header als Objekt mit key:value.
- requestTimeoutInSec: Timeouts für verschiedene API Methoden (in Sekunden). Typ: Object. Eigenschaften:
  - search, suggest, preview, export, asyncExport, sourceinfo, usersourceinfo, getprofile, persistedresources, persistedcollections, persistedcollectionschema, personalization, resource.
  - genericFallbackTimeout: Ein benutzerdefiniertes Fallback-Timeout, das auf Methoden angewendet wird, die nicht in der obigen Liste aufgeführt sind.
msalConfig: Eine Liste der Authentifizierungskonfiguration (AD FS/AAD), die von der MSAL-Bibliothek verwendet wird, um das Zugriffstoken von der Microsoft Identity Plattform zu erhalten (z.B. AD FS-Server oder Azure AD).
- Beispiel für AAD:
  Mindbreeze.require([..., "msal"], function (..., msal) {
      var msalConfig = {
          msal: msal,
          username:  < email_address_of_the_logged_in_user > ,
          msalConfig: {
              auth: {
                  clientId: "<OAuth2_Application_ID>",
                  authority: "https://login.microsoftonline.com/" + "<AAD_Tenant_ID>",
                  redirectUri: "<OAuth2_Application_Redirect_URI>",
              },
          };
          scopes: [ < configured_scopes > ]
      }
  
      var application = new Application({
          msalConfig: msalConfig,
          ...
      });
  });
- Beispiel für AD FS:
  Mindbreeze.require(…, "msal"], function (…, msal) {
      var msalConfig = {
          msal: msal,
          username:  < email_address_of_the_logged_in_user > ,
          msalConfig: {
              auth: {
                  clientId: "<OAuth2_Application_ID>",
                  authority: "<ADFS_Authority_URL>",
                  redirectUri: "<Configured_Redirect_URI>",
                  knownAuthorities: [
                      "<ADFS_Domain>"
                  ]
              }
          },
          scopes: [ < configured_scopes > ]
      };
  
      var application = new Application({
          msalConfig: msalConfig,
          ...
      });
  });
- Informationen bezüglich <OAuth2_Application_ID>, <AAD_Tenant_ID>, <OAuth2_Application_Redirect_URI>, <ADFS_Authority_URL>, <Configured_Redirect_URI> ,und <configured_scopes> können Sie aus der offiziellen Microsoft webseite entnehmen: https://docs.microsoft.com/en-us/azure/active-directory/develop/msal-client-application-configuration
- Um das AD FS oder Azure AD einzurichten, befolgen sie bitte folgende Dokumentation.
useAvailablePropertiesAsFilters: Standardmäßig werden im Designer alle verfügbaren ‚Facets‘ angezeigt. Mit dieser Einstellung ist es möglich, anstelle der verfügbaren ‚Facets‘ alle verfügbaren ‚Properties‘ anzuzeigen.
useLegacyMessageFrameChannel: Wenn true, wird für built-in sources der Legacy-MessageFrame-Channel verwenden. Diese Eigenschaft setzt die Backend-Option "Use Legacy Messageframe Channel" außer Kraft. Werte: true oder false. Standardwert: false.
useMessageFrameForNonBuiltinSources: Wenn true, verwendet die Anwendung den MessageFrame-Channel für non-built-in-Sources. Werte: true or falsch. Default: true.
onRequestFailed: Eine Funktion, welche aufgerufen wird, wenn Requests einen Fehler liefern. Typ: Funktion.
function(errorStatus, requestInfo, retryCallRequest, defaultHandler)
- errorStatus: Dieses Argument beinhaltet Fehlerinformationen wie folgt:
  - status: HTTP response status
  - reason: Der Grund wie Authentifizierung, RequestFail oder PopupBlocker. Typ: String
  - retryCount: Der Counter gibt die Anzahl der Wiederholungen an. Wichtig: errorStatus.retryCount muss verwendet werden, um das Auslösen von retryCallRequest oder defaultHandler zu stoppen. Ansonsten könnte Ihre Anwendung in eine Endlosschleife geraten.
- requestInfo: Objekt mit Requst-Informationen wie: requestUrl, loginUrl oder serviceUrl.
- retryCallRequest: Der Callback zur Wiederholung der letzten fehlgeschlagenen Anfrage. Typ: Funktion.
- function(headers)
- Der Parameter beinhaltet die neune/überarbeiteten Header, welche im neuen Request verwendet werden sollen.
- defaultHandler: Callback, um mit der standardmäßigen internen Fehlerbehandlung der Anwendung fortzufahren. Typ: Funktion.
  
  Verwendung von onRequestFailed:
  Wichtige Information: errorStatus.retryCount muss überprüft und die Wiederholungsversuche durch den Aufruf von defaultHandler gestoppt werden oder durch eine eigenen Handler implementiert werden. Andernfalls wird die Anfrage unendlich oft erneut versucht.
  onRequestFailed: function (errorStatus, requestInfo, retryCallRequest, defaultHandler) {
      if (errorStatus.retryCount > 5) {
          defaultHandler(); // Oder der eigene Handler
          return;
      }
      retryCallRequest({
          'Authorization': 'abc123'
      });
  },
enhancedPDFPreview : Bei der Vorschau von PDF-Dateien wird automatisch zum relevantesten Trefferergebnis gecrawlt. Werte: true, false. Default: false.
loginUrl : Kann der vollständige URL sein, in dem sich /mashup-login befindet, aber auch der Client-Service Basepath. Wenn die vollständige URL angegeben wird, wird der Pfad "mashup-login" während des Anmeldevorgangs angehängt. Standardwert: client.js location + “../../“.
matchingOptions: Überschreiben der optionalen Suchbegriffe (Default Client-Service Einstellungen) Type Objekt
- enableOptionalTerms: Um das Feature „Es Fehlt {Term} – Es muss folgendes enthalten {Term}“ anzuzeigen. Siehe Results-Widget. Type: Boolean
- optionalTermsRatio: Das Verhältnis, ab wann Optionale Terms angezeigt werden sollen. (Default 0.33) Type: Float
relevanceOptions: Type Objekt
- termBoostRelativeToPositionInQuery: Optionen, um den Boost für alle Terms ohne Boost zu setzen. Werte zwischen 1.0 und 0.0 werden zugewiesen. Type Objekt
  - maxTermBoost: Minimum Wert der gesetzt werden kann. Type: Float
  - reductionStep: Schrittgröße, um den jeder Wert erniedrigt wird. Type: Float
  - disablePositionBoostReduction: Auf True setzen um termBoostRelativeToPositionInQuery generell deaktivieren. Type: Boolean

Beispiele:

new Application({});

new Application({

callback: function (application) {

…

rootEl: document.getElementById("mySearchApp"),

crossDomainAjax: {

loggedInHandlerBasePath:”apps/client/handle-login.html”

}

});

Funktionen:

getUserConstraints(): liefert die aktuellen Einschränkungen (zur Verwendung mit setUserConstraints)
setUserConstraints(userConstraints, options): setzt die Einschränkungen (zur Verwendung mit getUserConstraints)
getUnparsedUserQuery(): liefert den aktuellen Suchbegriff, welcher vom User eingegeben wurde
setUnparsedUserQuery(unparsedUserQuery, options): setzt den Suchbegriff und fügt diesen im Suchefeld automatisch ein
getConstraint(): liefert zusätzlich hinzugefügte Einschränkungen (zur Verwendung mit setConstraint)
getACLConstraint(): liefert zusätzlich hinzugefügte ACL Einschränkungen (zur Verwendung mit setACLConstraint)

Der Unterschied zwischen „UnparsedUserQuery“ und „Constraints“ besteht darin, dass die „UnparsedUserQuery“ die Suche grundlegend (über das Suchefeld) einschränkt. Mit Hilfe der Constraints wird die Suche verfeinert, das Suchefeld wird dadurch aber nicht upgedatet.

Beispiele:

application.setConstraint({ unparsed: "extension:PDF" });

application.setACLConstraint({ unparsed: "%ID:123456" });

Events:

Sie können sich bei den einzelnen Modellen für Events registrieren. Hier finden Sie die unterstützen Events.

Beginn einer Suche:

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

});

Ende einer Suche:

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

});

Nach dem Rendern eines Resultats

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

});

Mit view.el können Sie auf das gerenderte DOM-Element zugreifen.

Hooks und Erweiterungen

Search Result Transformer

Such transformers in your search application will be executed right after the search response. A transformer should return a jQuery deferred object. The transformer function contains the response result in parameters list. Please remember that these transformers will be applied only to search responses.

Solche Transformatoren in Ihrer Insight Suchanwendung werden direkt nach dem Searchresponse ausgeführt. Ein Transformer muss ein jQuery-Deferred-Objekt zurückgeben. Die Transformator-Funktion enthält das Antwort-Ergebnis in der Parameterliste. Bitte beachten Sie, dass diese Transformatoren nur auf Suchantworten angewendet werden

e.g: var myTransformer = function(responseData) {

return $.Deferred(function() {

var self = this;

// modify your responseData here

self.resolve();

});

}

Die Liste der Transformatoren muss an application.models.search.output.loadTransformers angehängt werden. Eine Möglichkeit, dies zu tun, besteht darin, die Anwendung zu erweitern und das Ausgabemodell aus der Anwendungsfunktion prepareModels wie folgt zu modifizieren:

Beispiel:

var newApp = Application.extend({

prepareModels: function () {

var myTransformer = function(responseData) {

return $.Deferred(function() {

var self = this;

// modify your responseData here

self.resolve();

});

this.models.search.output.loadTransformers.push(myTransformer);

}

});

Aktionen

Links und Schaltflächen können mit dem Attribut data-action-object Aktionen in der Suchanwendung auslösen. Z.B.

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

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

Bei DuckDuckGo suchen

</a>

openSearch

Die openSearch-Aktion sucht den aktuellen Suchbegriff mit einer externen Suchmaschine, wie z.B. Bing, DuckDuckGo, Google oder Yahoo.

Attribute:

data-href: die Adresse der externen Suchmaschine mit Platzhaltern für Suchbegriff {searchTerms} und Sprache {language}.

Optionen:

searchTerms: damit können zuätzliche Einschränkungen zu den searchTerms hinzugefügt werden, z.B. „{searchTerms} Bild“ sucht nach dem aktuellen Suchbegriff und dem Wort Bild.

Beispiel:

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

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

Bei DuckDuckGo suchen

</a>

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

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

Bei Bing suchen

</a>

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

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

Bei DuckDuckGo suchen

</a>

exportResults

Die exportResults-Aktion öffnet einen neuen Stack, um die Suchtreffer zu exportieren.

Attribute:

data-properties: Gibt die Eigenschaften an, welche exportiert werden sollen
data-export-enabled: Gibt an, ob der Export aktiv sein soll oder nicht

Beispiele:

<button

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

name="export"

data-action-name="exportResults"

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

data-export-enabled="true">Exportieren

</button>

PDF Vorschau Interaktionen

Eine Erweiterung der Vorschau-Schnittstelle erlaubt es Entwicklern, auf Hyperlinks in der PDF Vorschau reagieren zu können (Mouseover, Mouseleave, Klick).

Beispielsweise kann somit ein Tooltip zu jedem Link mit erweiterten Informationen angezeigt werden.

Events:

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:text:selected", function (obj){});

Beispiel:

</script>

</div>

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

dataObject = {

}

var model = new Backbone.Model(dataObject);

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

var mustacheTemplate = new Mustache(innerHTML);

var str = mustacheTemplate.render(model);

});

Um die Möglichkeit einer Anpassung (z.B. Style der Annotations) bieten zu können, ist es über die Applikation möglich, das Annoation-Objekt zu manipulieren.

Event:

application.views._events["annotation:transform"] = function (annObj, _) {

annObj.style = …

};

Standard Aktion-Type bei eigenen Aktionen:

Als Argument kann, wenn die jeweilige Aktion in App.Telemetry sichtbar sein soll, der Wert „actionType“ angegeben werden. Folgende Werte sind dabei zulässig: “preview”, “openHref”, “vote”, “sendFeedback”:

Open custom preview

</a>

Ein Klick auf „Open custom preview“ führt die Funktion „myCustomAction“ aus und setzt dabei einen „personalization“ Request ab.

Tastenkombinationen

Mit dem Attribut data-shortcut können Tastenkombinationen für Bereiche und Aktionen hinterlegt werden. Wird das Attribut auf einen Button oder Link gesetzt, wird dieser beim Drücken der Tastenkombination ausgeführt. Bei allen anderen Elementen wird das Element fokussiert. Ist das Element selbst nicht fokussierbar, wird das erste fokussierbare enthaltene Element fokussiert.

Für die Tastenkombination stehen folgende Tasten, in angegebener Reihenfolge, zur Verfügung:

alt
ctrl
meta
shift
Zeichen

Beispiele:

…

</div>

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

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

CSS

Der Mindbreeze InSpire Client verwendet Bootstrap Version 2.2.2 (http://getbootstrap.com/2.2.2/) für die Gestaltung der Benutzeroberfläche.

Das Grundgerüst bildet ein zweispaltiges Layout mit folgende Struktur (http://getbootstrap.com/2.2.2/scaffolding.html#fluidGridSystem):

.container .row-fluid

.span9

.span3

Icons, wie die Lupe im Suchfeld, sind mit einem Icon Font umgesetzt. Dadurch können Farben einfach verändert werden. Die Icons werden mit Elementen, wie z.B. <i class="icon-search"></i> eingebunden, damit ist es auch möglich den Icon Font gegen eine eigene Implementierung zu tauschen. Die verwendete Bibliothek ist Font Awesome (https://fontawesome.com/v3.2/).

Für die Hauptbereiche werden h2-Elemente als Überschriften verwendet.

Die Beschreibung der Nummerierung ist wie folgt:

Suchfeld
Für die Gestaltung des Suchfeldes stehen folgende Elemente zur Verfügung:
form.search-field
input
button
Ergebnisse
Für die Ergebnisse wird die Struktur der Media object-Komponente (http://getbootstrap.com/2.2.2/components.html#media) verwendet:
.media
       .media-heading
       .media-object
       .media-body
Filter
Für Filter wird die Struktur der Stacked pills-Komponente (http://getbootstrap.com/2.2.2/components.html#navs) verwendet:
.nav.nav-stacked.nav-pills

Die Titel der einzelnen Filter, z.B. Datum sind h3-Elemente.

Für Elemente, die auf- und zugeklappt werden können, wird die Struktur für dir ARIA-Rolle tablist + multiselectable verwendet (http://www.w3.org/TR/wai-aria/roles#tablist).
1. Titel zugeklappt
  .mb-role[role=tablist][aria-multiselectable=true] [role=tab]
2. Titel aufgeklappt
  .mb-role[role=tablist][aria-multiselectable=true] [role=tab][aria-expanded=true]
Suchreiter
Für die Suchreiter wird die Struktur der Basic Navbar-Komponente (http://getbootstrap.com/2.2.2/components.html#navbar) mit Nav links verwendet:
.navbar .nav
Kopfleiste
Für die Kopfleiste wird die Struktur der Basic Navbar-Komponente (http://getbootstrap.com/2.2.2/components.html#navbar) mit Nav links verwendet:
.mb-header.navbar.navbar-inverse .mb-top-menu .nav

mb-computing

Während eine Suche durchgeführt wird, erhalten die Widgets die CSS-Klasse mb-computing. Verwenden Sie diese CSS-Klasse, um die Aktivität darzustellen.

Beispiele:

.mb-progress-indicator {

display: none;

}

.mb-computing .mb-progress-indicator {

display: block;

}

Entwicklung eigener Widgets

Eigene Widgets können als Plugin installiert werden und stehen für eigene Suchanwendungen und im Insight App Editor zur Verfügung.

Beispielplugin

Nachdem das Plugin heruntergeladen wurde, kann es angepasst (siehe ab Plugin-Aufbau) und unter „Plugins“ wieder hochgeladen werden. Nachdem das Plugin unter „Client-Service“ > „Client Resources“ aktiviert wurde, steht es im Editor zur Verfügung.

Plugin-Aufbau

Mindbreeze Plugins sind zip-Dateien, die im plugins.xml eine Beschreibung enthalten. Das Element id enthält eine eindeutige Zeichenkette für das Plugin und als Extension Point wird mindbreeze.webapp.Resources verwendet. resource_path gibt den Pfad innerhalb des Plugins an, an dem die Dateien abgelegt sind.

<?xml version="1.0" encoding="utf-8"?>

</version>

<id>mycompany.example</id>

<kind>RESOURCE</kind>

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

</Extension>

</extension>

<resource_path>resources</resource_path>

</Plugin>

</plugins>

</Plugins>

Resource Proxying

Mithilfe von Mindbreeze Resource Plugins kann der Mindbreeze Client Service auch als Proxy für entfernte Web Resources agieren.

Um entfernte Resources für Suchanwendungen erreichbar zu machen, muss ein <resource_destination> Element in die Plugin-Konfiguration eingefügt werden:

<?xml version="1.0" encoding="utf-8"?>

</version>

<id>remote.resource</id>

<kind>RESOURCE</kind>

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

</Extension>

</extension>

<resource_destination>

<base_url>https://www.myserver.com</base_url>

<request_headers>

<key>User-Agent</key>

<value>curl/7.19.7 (x86_64-redhat-linux-gnu) libcurl/7.50.0 OpenSSL/1.0.1e zlib/1.2.3 libidn/1.18</value>

</KeyValuePair>

<key>CustomHeader</key>

<value>CustomValue</value>

</KeyValuePair>

</request_headers>

<request_query_parameters>

<key>QueryParam1</key>

<value>Value1</value>

</KeyValuePair>

</request_query_parameters>

</resource_destination>

</Plugin>

</plugins>

</Plugins>

Ein „resource_destination“ Element enthält ein „base_url“ Element. Hier ist die Basis-URL für die entfernte Resources konfiguriert.

HTTP-Anfragen im Form von <InSpire_searchapp_base_url>/resource/<plugin_id>/path werden auf <base_url>/path weitergeleitet.

Mit dem „remote.resource“ Plugin (siehe Plugin Konfiguration oben) werden z.B. Anfragen an https://inspire.mindbreeze.com/searchapp/resource/remote.resource/api an https://myserver.com/api geschickt.

Mit dem <request_headers> Element kann auch bestimmt werden, welche HTTP-Header in den weitergeleiteten HTTP-Anfragen gesetzt werden sollen. HTTP-Header-Namen und -Werte können als „KeyValuePair“ Elemente hinterlegt werden, wie in unserem Beispiel die User-Agent- bzw. CustomHeader-Headers.

Analog zu Headers, können auch HTTP-Query-Parameters mit KeyValuePair Elementen konfiguriert werden. Diese müssen sich in einem „request_query_parameters“ Element befinden.

Anlegen eigener Widgets

Templates.View.extend erzeugt eine neue View. Es handelt sind dabei um Backbone.Views mit Erweiterungen. Zum Erzeugen einer eigenen View wird Templates.View.extend verwendet:

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

An extend werden die angepassten Funktionen übergeben. Die wichtigsten Funktionen im Überblick:

initialize	Wird beim Anlegen der View aufgerufen. Zu Beginn immer Templates.View.prototype.initialize.apply(this, arguments) aufrufen, damit die Basisarbeiten erledigt werden.
setModel	Wird beim Ändern des Modells aufgerufen. Kann im Designer auch während des Betriebs aufgerufen werden. Beim Löschen einer View wird setModel mit einem null-Modell aufgerufen. Der Ablauf besteht aus 1. Abhängigkeiten zu aktuellem Modell aufräumen 2.Templates.View.prototype.setModel.apply(this, arguments) 3. Event-Handler und andere Abhängigkeiten für das neue Modell anlegen
render	Wird zum Anpassen des HTML verwendet. Das DOM-Element steht unter this.el zur Verfügung als jQuery-Object unter this.$el.
remove	Wird beim Löschen der View aufgerufen. Am Ende immer Templates.View.prototype.remove.apply(this, arguments) aufrufen, damit die Basisarbeiten erledigt werden.

Registrieren eigener Widgets

Nach Anlegen eigener Widgets muss es noch registriert werden, damit es in Suchanwendungen und im Designer zur Verfügung steht. Dazu wird Templates.add verwendet:

Templates.add({

view: MyView,

attributes: {

size: {

title: "mycompany_results_size",

type: "string",

defaultValue: "test"

}

designer_menu: [{

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

description: "mycompany_results_description",

group: {

description: "mygroup_description"

}

}]

});

Optionen:

name	Name des Widgets. Dadurch kann in Suchanwendungen data-template="exampleresults" verwendet werden. Pflichtfeld
view	View-Objekt. Pflichtfeld
attributes	Beschreibung der zur Verfügung stehenden Optionen. Wird im Designer und für die Optionen der View verwendet.
designer_menu	Menüeinträge für den Designer

Attribute

Beim Registrieren eigener Widgets können mit attributes Optionen an das Widget übergeben werden, z.B.

attributes: {

size: {

title: "mycompany_results_size",

type: "string",

defaultValue: "test"

}

- Ist im HTML als data-size verwendbar:

- Steht im Widget automatisch in den Optionen zur Verfügung:

var MyView = Templates.View.extend({

…

initialize: function () {

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

…

});

Der Titel für den Designer wird mit title angegeben. Ist der Text in den Übersetzungen enthalten, wird er automatisch übersetzt.

Folgende Typen stehen bei types zur Verfügung:

string	Zeichenketten
boolean	true/false
int	Ganzzahlen
date	Datumswerte, die mit new Date(<value>) geparst werden können. Z.B. 25 Dec 1995 13:30:00 GMT
list	JSON-Array oder Beistrich getrennte Liste von String-Werten. ["a", "b", 1] oder a, b
i18nString	Werte, die mit i18n. beginnen, werden übersetzt.
QueryExpr	Zeichenkette wird als Unstrukturierte Suche übernommen.

Mit defaultValue kann ein Standardwert angegeben werden, der verwendet wird, wenn die Option nicht gesetzt wurde.

Im Designer anzeigen

Beim Registrieren eigener Widgets können mit designer_menu Menüeinträge für das Widget im Designer hinterlegt werden, z.B.

designer_menu: [{

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

description: "mycompany_results_description",

group: {

description: "mygroup_description"

}

}]

Mit folgenden Übersetzungen:

i18n.loadExtension({

mygroup: {

"de": "Meine Gruppe",

"en": "My Group"

mygroup_description: {

"de": "Meine Gruppe macht ...",

"en": "My Group takes care of...."

mycompany_results: {

"de": "Resultate",

"en": "Results"

mycompany_results_description: {

"de": "Anzeige von Resultaten",

"en": "Result Display"

mycompany_results_size: {

"de": "Größe",

"en": "Size"

}

});

wird dieses Menü angezeigt:

Optionen:

name	Automatisch übersetzter Name
icon	Adresse eines Bildes. Mindbreeze.require("<plugin-id>/<Pfad>") liefert den Pfad einer Datei im Plugin
description	Erweiterte Beschreibung des Widgets
group	Name (name) und Beschreibung (description) der Gruppe, in der das Widget einsortiert wird.

Hinzufügen von Übersetzungen

Mit i18n.loadExtension können eigene Übersetzungen hinzugefügt werden:

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

i18n.loadExtension({

mygroup: {

"de": "Meine Gruppe",

"en": "My Group"

}

});

Entwicklungsumgebung

Voraussetzungen:

Apache Ant	https://ant.apache.org/
Node JS	https://nodejs.org/

Ordnerstruktur:

build.xml	Wird mit ant aufgerufen. Kombiniert alle Abhängigkeiten in eine neue JavaScript-Datei und paketiert das Plugin.
build.js	Konfiguration zum Paktieren des Plugins. Verwendet require.js


src/css/plugin.css
lib
lib/r.js	Optimier-Skript
lib/text.js

Um das Plugin ohne Installation zu entwickeln kann es auf einem Webserver abgelegt und mit folgendem JavaScript geladen werden:

window.define = Mindbreeze.define;

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

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

</script>

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

new Application({

…

})

});

</script>

Wichtig hierbei ist, dass das Plugin sowie das Client.js vom gleichen Server stammen.

CMIS RSS Feed Interface

Mindbreeze bietet Ihnen die Möglichkeit die Suche in Form eines dynamischen RSS-Feeds durchzuführen. Dazu muss die nachstehende URL aufgerufen werden:

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

Im nachstehenden Abschnitt werden die URL-Parameter und deren Funktion beschrieben

Parameter	Optional	Beschreibung
q	Nein	Suchbegriff - es kann die gesamte Suchsprache verwendet werden.
maxItems	Ja	Anzahl der Suchergebnisse. Standardwert: 5
skipCount	Ja	Anzahl der zu überspringenden Ergebnisse. Dieser Parameter kann zum Blättern verwendet werden. Z.B. skipCount=5, um bei maxItems 5 auf die zweite Seite zu kommen. Standarwert: 0
language	Ja	Dieser Parameter steuert die Übersetzung der Metadaten. Beispiel: language=de Standardwert: Sprache des Browsers

Betreiben von Insight Apps über das Client Service und Ändern der Standard Insight App

Um eigene Insight Apps direkt über das Client Service zu betreiben und dort auch als Standard zu hinterlegen, kann dem Menüpunkt „Web Application Contexts Settings“ in der Client Service Konfiguration folgende Parameter hinterlegt werden. Die entsprechenden Dateien sollten dann via dem InSpire File-Uploader auf die entsprechende Stelle kopiert werden.

URL Path	URL Pfad der Insight App.
File Path	URL Pfad der Insight App.
Override Existing Path	Wenn aktiviert können Pfäde, die normalerwiese im Standard-Client existieren, überschrieben werden. Diese Einstellung kann zu Folge haben, dass Standard-Anwendungen nicht mehr wie gewohnt funktionieren.
Allow Symlinks	Wenn aktiviert können in den eingeblendeten Pfäden auch symbolische Links exisiteren.
Authenticated URL pattern	Das Pattern bestimmt die Anfrage-URLs, für die Filter (welche unter anderem Authentisierung durchführen) angewendet werden. Üblicherweise enthält das Patter die gesamte Insight App (Standard-Pattern: /* ). Aus Performanzgründen sollen jedoch URLs mit statischen Inhalten (z. B. Bilder, CSS oder Javascript-Bibliotheken) nicht im Pattern enthalten sein. Das Pattern muss relativ zum URL Path sein und dem Tomcat web.xml URL Pattern entsprechen. [Servlet 3.0 Spezifikation] Ist das Pattern leer, werden keine Filter angewendet und die Insight App kann nur ohne Benutzerauthentisierung verwendet werden.
Login URL pattern	Wenn im „Require Authentication“ Feld „Optional“ ausgewählt ist, werden für alle Anfrage URLs, die diesem Pattern entsprechen (das Pattern muss relativ zum URL Path sein.) eine Benutzer Authentisierung angefordert. Das Pattern muss den Tomcat web.xml URL Pattern entsprechen. [Servlet 3.0 Spezifikation]
Not Cached MIME-Types Pattern	Grundsätzlich werden alle Ressourcen im "Authenticated URL pattern“ vom Browser gecached. Mit dieser Option können gewisse Resourcen explizit ausgenommen werden. Diese Option definiert einen regulären Ausdruck, der auf die MIME-Type der Resource angewendet wird. Resourcen mit übereinstimmenden MIME-Types werden explizit nicht gecached. Standardmäßig wird z.B. das index.html nicht gecached, da das index.html personalisierte Werte enthalten kann. Standardwert: text/plain\|text/html\|application/json

[Servlet 3.0 Spezifikation] http://download.oracle.com/otn-pub/jcp/servlet-3.0-fr-oth-JSpec/servlet-3_0-final-spec.pdf

Als Vorlage ist die Standard Insight App unter /data/apps/client/index.html verfügbar.

Im Folgenden Beispiel sind zwei Insight Apps (marketing und sales) am Client Service der unter https://search.mycompany.com erreichbar ist konfiguriert. Die Insight App marketing ist dann unter https://search.mycompany.com und https://search.mycompany.com/apps/marketing erreichbar und die Insight App sales unter https://search.mycompany.com/apps/sales erreichbar.

Appendix

Source-Info Cache

Die Source-Info wird beim Laden der Insight App mittels POST-Request an /api/v2/sourceinfo abgeholt. Diese enthält Informationen zu Datenquellen und API-Endpunkten. Aus Performance-Gründen wird diese serverseitig gecached. Um den Cache zu erneuern, muss der HTTP-Header „x-mes-refresh-cache“ gesetzt werden, z.B.:

curl -k -H "x-mes-refresh-cache:refresh" -X POST --data "{}" https://<your_appliance>:<your_client_port>/api/v2/sourceinfo

Einbettung von Insight Apps mit Iframes und Content Security Policy

Falls auf einem Webserver Content Security Policy verwendet wird und Ressourcen von einer Mindbreeze InSpire mittels beispielsweise eines Iframes eingebunden werden, ist es notwendig, mögliche Content-Security-Policy Header anzupassen, damit die Ressource vom Webbrowser geladen werden dürfen.

Folgender Content Security Policy Header ist sehr restriktiv. Hier muss ein frame-src Parameter angegeben werden, um den Zugriff auf die Ressourcen der Mindbreeze InSpire, erreichbar unter https://search.mindbreeze.com zu erlauben. Z.B.

Content-Security-Policy: default-src 'none'; frame-src https://search.mycompany.com

oder

Content-Security-Policy: default-src 'none'; frame-src https://*.mycompany.com

{{{i18n.refineSearch}}}

Entwicklung von Insight Apps

Help

Tutorial Video „Creating an Insight App“

Einführung

Benötigte Ressourcen

Head

Meta-Tags

Styles

Scripts

Standardbibliotheken

Minimal client version

Insight App Designer

Allgemein

Änderungen und Anpassungen im generierten HTML

Loader

Application Einstellungen

Bausteine

Layout

Suchfeld

Ergebnisse

Ergebnis Einstellungen

mustache-Templates

Link

Blättern

Seiten

Filter

Mustache-Templates

Designer einbetten

Erforderliche Ressourcen

Styles

4.4.1.2 Scripts

4.4.1.3 HTML

JavaScript

Verfügbare Widgets

accordion

alert

mustache-Templates

alertcenter

annotationPopup

applists

breadcrumb

charts

Verfügbare Chart-Typen

Pie

Bar

Line

Einstellungen der Charts

collect

constraints

mustache-Templates

datasources

mustache-Templates

inputdate

Datumsfilter

feedback

feedbackbutton

filteredfacet

mustache-Templates

filteredfacets

mustache-Templates

map

mustache-Templates

Mehrere Markierungen zu einem Resultat anzeigen

mustache

pages

mustache-Templates

pagination

preview

mustache-Templates

queryinfo

results

mustache-Templates

resultsprogress

savedsearches

search

searchform

searchinfo

mustache-Templates

sortswitch