Alle Kollektionen
REST-API-Dokumentation
Anpassen der App
Benutzer-Taste
Benutzer-Taste

Wie kann ABRA Flexi mit Benutzertasten angepasst werden?

Petr Pech avatar
Verfasst von Petr Pech
Vor über einer Woche aktualisiert

Verwendungsmöglichkeiten

Eine Benutzer-Schaltfläche dient zur Anpassung von ABRA Flexi, indem sie Entwicklern und Benutzern die Möglichkeit gibt, ihre eigene Aktion in Form einer Schaltfläche zu definieren. Wenn die Schaltfläche aktiviert ist, zeigt sie ein Panel in ABRA Flexi an oder öffnet einen Webbrowser, in beiden Fällen mit einer beliebigen Webseite.

Mit Hilfe eines Benutzerbuttons kann der entsprechende Teil des Intranet-Informationssystems angezeigt, die Ware im Preisvergleicher gesucht, der entsprechende Teil der ABRA Flexi-Web-Oberfläche geöffnet oder eine Aktion über unsere REST-API ausgelöst werden. Es ist möglich, Parameter dynamisch in die Webseitenadresse einzufügen, wie z. B. die ID-Nummer der aktuell bearbeiteten Firma oder die EAN der angezeigten Waren.

Methode der Anwendung

Die Parameter der Benutzerschaltfläche, wie z. B. ihr Text, die Ziel-URL oder der Speicherort in ABRA Flexi, werden in die Schaltflächendefinition, eine XML-Datei, geschrieben. Die erstellte Benutzerschaltflächendefinition wird durch Importieren aus der XML-Datei in ABRA Flexi geladen, und wenn die Verbindung mit dem Unternehmen wiederhergestellt ist, wird die Schaltfläche Teil der Benutzeroberfläche (entweder Client-Anwendung oder Weboberfläche) sein.

Definition der Benutzertaste

Einige Elemente sind obligatorisch (optionales Element ist Browser), kann jedes Element höchstens einmal innerhalb einer Schaltflächendefinition aufgeführt werden (die Ausnahme ist das Element idEine Datei kann die Definition mehrerer Benutzerschaltflächen enthalten; wenn mehrere Definitionen einer Schaltfläche angegeben werden, wird jede Definition als Aktualisierung der Schaltfläche betrachtet und die letzte Aktualisierung ihrer Eigenschaft wird tatsächlich berücksichtigt. Eine nicht konforme Benutzertastendefinition wird bereits beim Import in ABRA Flexi abgelehnt.

id

  • DieDatensatzbezeichner werden verwendet, um den Code/Shortcode beim Erstellen zuzuordnen und um die Benutzertaste beim späteren Aktualisieren oder Löschen zu lokalisieren.

  • Folgendes kann zur Identifizierung einer Benutzertaste verwendet werden:

    • Code/Shortcode - Benutzerbezeichnung (Präfix Code:)

    • Externer Bezeichner - ein Bezeichner aus einer externen Anwendung (Präfix ext:)

    • ABRA-Flexi-Kennung - eine numerische unveränderliche Kennung, die von der Anwendung zugewiesen wird (kein Präfix)

  • Pflichtelement, beim Anlegen einer Benutzerschaltfläche muss das Element mit einem Code (Kürzel) angegeben werden.

  • Ausführlichere Informationen über die Verwendung des Elements finden Sie unter Datensatzbezeichner.

url

  • Gibt die URL der Webseite oder Netzwerkressource an, die bei Betätigung der Schaltfläche geöffnet wird.

  • Die URL muss in vollständiger, absoluter Form angegeben werden, d. h. sie muss das Schema und die Domain-Adresse des Servers enthalten (z. B. https://www.flexibee.eu/).

  • Es wird empfohlen, die URL in <![CDATA[ ]]> anzugeben , damit das Vorhandensein des '&'-Zeichens nicht zu nicht gültigem XML führt.

  • Das Datei-URI-Schema, das für den Zugriff auf lokal gespeicherte Dateien verwendet wird, wird im URL-Wert nicht unterstützt. Benutzertastendefinitionen, die URLs mit file:// enthalten, werden beim Import als nicht zulässig zurückgewiesen.

  • Bei der Konstruktion von URLs ist es möglich, Variablen anzugeben, die von FreeMarker bei der Ausführung der Anwendung ausgewertet werden, und sicherzustellen, dass die Werte von der Anwendung übergeben werden. Zum Beispiel wird der Eintrag ${object.ic} verwendet, um die ID des Partners im Verzeichnis abzurufen. Das String-Objekt ist im Variablennamen obligatorisch, es wird verwendet, um auf den aktuellen Datensatz des angezeigten Datensatzes zu verweisen. Die Liste der verfügbaren Attribute eines jeden Datensatzes kann in der Weboberfläche angezeigt werden (Adressen wiehttps://localhost:5434/c/mojefirma/adresar/properties).

  • Unterstützte Variablen:

    • Objekt - der aktuelle Datensatz (siehe vorherigen Punkt).

    • objectIds - kommagetrennte Liste der ausgewählten Datensatz-IDs.

    • user - aktuell angemeldeter Benutzer (siehe https://localhost:5434/c/mojefirma/uzivatel/properties).

    • url - die vollständige URL des Objekts, auf dem die Schaltfläche aufgerufen wurde (z. B. https://instance.flexibee.eu/c/demo/adresar/1).

    • companyUrl - die API-Adresse der Firma, auf der sich die Schaltfläche befindet (z. B. https://instance.flexibee.eu/c/demo).

    • Datensatz - der Name des Datensatzes, auf dem die Schaltfläche platziert wird.

    • authSessionId - das Authentifizierungs-Token für die aktuelle Benutzersitzung. Sie kann verwendet werden, um Abfragen zu authentifizieren, solange die Sitzung gültig ist. Siehe die Verwendung des Authentifizierungstokens in der Beschreibung der Authentifizierung.

    • customerNo - die Kundennummer, die der Lizenz entspricht.

    • licenseId - die Kennung der Lizenz.

  • Hinweis: Die Variablen object und objectIds schließen sich gegenseitig aus!

Nachweise

  • Gibt den Datensatz bzw. die spezifische Bindung (Sitzung) des ABRA-Flexi-Datensatzes an, für den die Schaltfläche angezeigt werden soll.

  • Z.B. Adressbuch zur Erfassung von Geschäftspartnern, Rechnung-ausgestellt zur Erfassung von ausgestellten Rechnungen, etc. In der Variante für die Anbindung eines bestimmten Datensatzes, z. B. rechnung-ausgestellt-Posten für rechnung-ausgestellt-Posten oder anlage-darlehen für Darlehen im Anlagensatz usw.

  • Verwenden Sie für Datensätze im Allgemeinen die Zeichenfolge, die in der URL der Weboberfläche im Abschnitt "Datensätze" angezeigt wird(https://localhost:5434/c/mojefirma/cenik).

  • Eine Liste aller Datensätze ist unter https://localhost:5434/c/mojefirma/evidence-list verfügbar.

  • Für Datensatzverknüpfungen im Allgemeinen verwenden Sie die Datensatzzeichenfolge (siehe oben), gefolgt von einem Bindestrich und der Verknüpfungszeichenfolge aus der Datensatzverknüpfungsübersicht(https://localhost:5434/c/mojefirma/cenik/relations).

Standort

  • Bestimmt die Anzeige der Schaltfläche in der Datensatzübersicht oder auf der Registerkarte eines bestimmten Datensatzes.

  • Erlaubte Werte:

    • Liste - für die Protokollübersicht

    • Detail - für einen bestimmten Datensatz

  • Wenn die Schaltfläche in der Symbolleiste auf der Datensatzübersicht und auf der Registerkarte eines bestimmten Datensatzes verfügbar sein soll, ist es notwendig, zwei Definitionen der Benutzerschaltfläche vorzubereiten, die sich durch den Wert des Ortselements unterscheiden.

Titel

  • Der Text, der auf der Schaltfläche angezeigt wird.

Beschreibung

  • Die detaillierte Beschreibung der Schaltfläche, die in der Sprechblase angezeigt wird.

Browser

  • Legt den Browser fest, in dem die URL geöffnet werden soll. Der interne Browser wird schneller angezeigt, enthält aber möglicherweise keine Benutzeranpassungen und Daten (Passwörter, Cookies, Formulardaten, besuchte Links). Der externe Browser ist die Umgebung, an die der Benutzer gewöhnt ist.

  • Optionales Element, Standardwert ist automatisch.

  • Aufgrund der Beschaffenheit der Weboberfläche werden die Einstellungen der Browser-Elemente ignoriert.

  • Erlaubte Werte:

    • Desktop - externer Browser

    • automatisch - interner Browser; wenn nicht vorhanden, wird der externe Browser geöffnet

Beispiel für das Erstellen

<?xml version="1.0"?>
<winstrom version="1.0">
  <Benutzerdefinierte-Schaltfläche>
    <id>Code:JUSTICECZ</id>
    <url><![CDATA[https://or.justice.cz/ias/ui/rejstrik-$firma?ico=${object.ic}&jenPlatne=VSECHNY]]></url>
    <title>Kreislauf-Register&#x159;&#xED;k</title>
    <description>Abbildung der Firma im Handelsregister von justice.cz</description>
    <evidence>Adressierer</evidence>
    <ort>Detail</ort>
    <browser>Desktop</browser>
  </custom-button>
</winstrom>

Beispiel für ein Tastenupdate

Wenn Sie in der Definition eine eindeutige Identifikation einer vorhandenen Schaltfläche angeben, können Sie diese aktualisieren. ABRA Flexi erlaubt partielle Aktualisierungen von Datensätzen. Wenn Sie also die Adresse des Unternehmensregisters im obigen Beispiel ändern, müssen Sie nur die Benutzerschaltfläche identifizieren und den neuen URL-Wert angeben:

<?xml version="1.0"?>
<winstrom version="1.0">
  <Benutzerdefinierte-Schaltfläche>
    <id>Code:JUSTICECZ</id>
    <url><![CDATA[https://or.justice.cz/ias/ui/rejstrik-$firma?ico=${object.ic}&jenPlatne=VSECHNY&polozek=500]]></url>
  </custom-button>
</winstrom>

Beispiel für das Löschen einer Schaltfläche

Um eine vorhandene Schaltfläche zu löschen, müssen Sie das Aktionsattribut verwenden (weitere Informationen zu seiner Verwendung finden Sie unter Ausführen von Aktionen). Die Benutzertaste aus dem obigen Beispiel kann mit gelöscht werden:

<?xml version="1.0"?>
<winstrom version="1.0">
  <custom-button action="delete">
    <id>Code:JUSTICECZ</id>
  </custom-button>
</winstrom>
Hat dies Ihre Frage beantwortet?