AbaReport konfigurieren
Individuelle Abacus-Reports im Caller-Cockpit anzeigen
Übersicht
Mit AbaReport zeigt echo individuelle Abacus-Report-Ergebnisse im Caller-Cockpit an. Sie konfigurieren den Report in Abacus im Programm Q948 AbaReport und fügen ihn anschliessend unter Einstellungen → Abacus in echo hinzu. Mehrere Reports sind möglich; jeder erscheint als eigener Tab im AbaReport-Widget.
Voraussetzungen
- Sie haben Administratorzugriff auf die organisationsweiten Abacus-Einstellungen in echo.
- Ein Abacus-Service-User hat Zugriff auf die benötigten Reports und Daten. Für den AbaReport-API-Zugriff liegen Client ID und Client Secret vor.
1. Report in Abacus konfigurieren
Öffnen Sie Q948 AbaReport in Abacus und erstellen oder konfigurieren Sie den Report, den Sie in echo anzeigen möchten.
- Definieren Sie die Daten und allfällige Filter des Reports.
- Soll das Ergebnis vom ausgewählten Kontakt oder der Suche abhängen, definieren Sie passende Eingabeparameter im Report.
- Richten Sie den Report für das gewünschte Ausgabeformat ein: JSON für strukturierte Daten oder Text für reinen Text.
- Notieren Sie den genauen Report-Namen und die Namen seiner Eingabeparameter.
- Testen Sie den Report in Abacus mit repräsentativen Parameterwerten und stellen Sie sicher, dass der Service-User ihn ausführen kann.
Die Eingabeparameter in echo müssen mit den im Report definierten Parametern übereinstimmen. Es gibt keinen allgemeingültigen Parameternamen: Verwenden Sie die Namen aus Ihrer eigenen Q948-Konfiguration.
2. Report in echo hinzufügen
Öffnen Sie Einstellungen → Abacus, klappen Sie den optionalen Abschnitt AbaReport in den Mandantenverbindungseinstellungen auf und tragen Sie die AbaReport Client ID und das Client Secret ein. Dies sind die Service-User-Zugangsdaten für die Report-Ausführung; sie sind nicht zwingend identisch mit den Zugangsdaten der bestehenden Mandantenverbindung.
Klicken Sie auf + Report hinzufügen und erfassen Sie die Felder:
| Feld | Beschreibung |
|---|---|
| Anzeigename | Beschriftung des Report-Tabs im Caller-Cockpit, z. B. Kundenübersicht. |
| Report Name | Genauer Name des in Q948 AbaReport konfigurierten Reports. |
| Darstellung | Anzeige des Ergebnisses in echo. Beginnen Sie mit Auto; siehe Darstellungsoptionen unten. |
| Ausgabeformat | json für strukturierte Ergebnisse oder txt für reinen Text. Muss zur Ausgabe des Reports passen. |
| Eingabeparameter | Name/Wert-Paare, die dem Report übergeben werden. Verwenden Sie feste Werte oder die unten beschriebenen Kontextwerte. |
Fügen Sie bei Bedarf weitere Reports hinzu und sichern Sie die Mandanteneinstellungen mit Speichern.
3. Eingabeparameter zuordnen
Klicken Sie für jeden Report-Parameter auf + Parameter hinzufügen. Erfassen Sie den Namen genau wie in Abacus und wählen Sie einen Wert:
| Wert in echo | An Abacus übergebener Wert |
|---|---|
company.id | Abacus-ID der Firma des ausgewählten Kontakts. |
person.id | Abacus-ID der Person des ausgewählten Kontakts. |
search.query | Aktueller Suchtext ohne führende und nachfolgende Leerzeichen. |
Fester Text, z. B. Open | Hinterlegter Text ohne führende und nachfolgende Leerzeichen. |
Verwenden Sie Kontextwerte als vollständigen Wert, ohne Klammern oder zusätzlichen Text. Definiert Ihr Report beispielsweise einen Parameter SubjectNumber, erfassen Sie SubjectNumber als Namen und company.id als Wert. SubjectNumber ist nur ein Beispiel; ersetzen Sie es durch den tatsächlichen Parameternamen Ihres Reports.
person.id liefern. Konfigurieren Sie in Q948 geeignete Standardwerte oder eine Behandlung fehlender Parameter und testen Sie Firmen- sowie Personenkontakte.Darstellungsoptionen
| Darstellung | Geeignete Report-Ausgabe |
|---|---|
| Auto | Wählt automatisch eine Tabelle für JSON-Zeilen, Schlüssel/Wert für ein JSON-Objekt oder andernfalls Rohdaten. |
| Tabelle | Ein JSON-Array aus Zeilenobjekten oder ein JSON-Objekt, dessen Eigenschaft data ein Array aus Zeilenobjekten enthält. Die Objektschlüssel werden zu Spaltenüberschriften. |
| Schlüssel/Wert | Ein JSON-Objekt mit einzelnen Feldern statt einer Tabelle aus Zeilen. |
| Rohdaten | Reiner Text oder die JSON-Ausgabe des Reports, als Text dargestellt. |
Wählen Sie für tabellarische Reports das Ausgabeformat json mit Auto oder Tabelle. Für Text-Reports wählen Sie txt mit Auto oder Rohdaten.
Ergebnis im Caller-Cockpit prüfen
Suchen Sie in echo nach einem Abacus-Kontakt und öffnen Sie das Caller-Cockpit. Das AbaReport-Widget erscheint für Kontakte aus Abacus, wenn Zugangsdaten und mindestens ein Report konfiguriert sind und die Funktion freigeschaltet ist. Die Reports werden automatisch für den aktuellen Kontakt-/Suchkontext geladen. Wählen Sie einen Tab, um einen anderen Report anzuzeigen.
Prüfen Sie, ob das Ergebnis zum ausgewählten Kontakt gehört. Wiederholen Sie dies mit einem anderen Kontakt, um die Parameterzuordnung zu überprüfen.
Fehlerbehebung
| Problem | Was Sie prüfen sollten |
|---|---|
| Das Widget fehlt | Wählen Sie einen Kontakt aus Abacus. Prüfen Sie die Freischaltung, die AbaReport Client ID und das Client Secret sowie mindestens einen Report mit ausgefülltem Report Name. Prüfen Sie auch, ob das AbaReport-Widget in Ihrem Cockpit-Layout aktiviert ist. |
| Der Report kann nicht geladen werden | Prüfen Sie Report-Namen, Service-User-Zugangsdaten und Berechtigungen sowie die erfolgreiche Ausführung in Q948. Lange laufende Reports können das Zeitlimit überschreiten; reduzieren Sie bei Bedarf den Umfang. |
| Das Ergebnis ist leer oder gehört zum falschen Kontakt | Prüfen Sie Parameternamen, die Auswahl von company.id beziehungsweise person.id und die Report-Filter. Der ausgewählte Kontakt muss die entsprechende Abacus-ID besitzen. |
| Strukturierte Daten werden nicht wie erwartet angezeigt | Prüfen Sie Ausgabeformat und JSON-Struktur. Wählen Sie Rohdaten, um die zurückgegebene Ausgabe anzusehen, oder Auto für die automatische Darstellung. |