Technische Dokumentation des Documents-Link-Widget
- Florian Pieper
- Anna Janzen
Beschreibung
Diese Seite enthält die technische Dokumentation des Documents-Link-Widget. Mit der Integration kann ein Parameter z.B. die Werksartikelnummer in der Bibliothek gesucht werden, um die betreffende Einzelseite mit dem gefundenen Parameter abzubilden. So können zutreffende Seiten automatisiert am entsprechenden Artikel ausgegeben werden. Im Folgenden werden die Inhalte dieser Seite aufgeführt:
Inhalt
Integration per “xs-loader” Widget
Alle Widgets werden über den “xs-loader” eingebunden. Bitte machen Sie sich mit der Dokumentation https://itek-wissen.atlassian.net/wiki/spaces/SOF/pages/2841313293 vertraut.
Parameter “xs-documents-link“
Dieses Widget startet eine Suche mit den übergebenen Parametern und stellt die Treffer in Verkaufsdokumenten als Einzelseiten dar. Es werden nur PDF Dokumente berücksichtigt.
Eingang | ||||
|---|---|---|---|---|
Hauptparameter | Teilparameter | Pflicht | Beschreibung | Beispielwert |
filter |
| Ja | Die Grundlage des Widgets. Hier wird festgelegt welche Dokumente angezeigt werden sollen.
|
|
| searchterms | ja, wenn documents nicht gesetzt ist | Die Parameter bestehen aus Parametern, die einen Array von Strings annehmen um z.B. mehrere Lieferanten anzeigen zu können
und Parametern, die einen einzelnen Wert annehmen
Alle Parameter können beliebig kombiniert werden um das gewünschte Ergebnis angezeigt zu bekommen. |
"filter": {
"searchterms": {
"supplierids": ["adminlfr1"],
"infopackagenames": ["Suchtest"],
"documentcountries": ["de"],
"documentlanguages": ["de"],
"tags": ["Querformat"],
"archived": false,
"documentcount": 25,
"language": "de"
}
} |
| documents | ja, wenn parameters nicht gesetzt ist | Eine Kombination aus Dokumenten-ID und Seite des Dokumentes, das als Thumbnail verwendet werden soll. WICHTIG: Die Dokumenten-Links funktionieren nur wenn der externe Link angelegt und aktiv ist Der Parameter besteht aus:
|
"filter": {
"documents":[
{
"id": "99678681-c7fa-4184-83aa-d9694e9ef790",
"thumbnailpage": 4
},
{
"id": "76d38ef0-bdcb-4237-bb2c-ff85d073db46",
"thumbnailpage": 2
}
]
} |
pdfviewer |
| Nein | Objekt mit Konfigurationen für den PDF-Viewer |
|
| position | Nein | Gibt die Position des PDF-Viewers an. Der Viewer kann dadurch verschoben werden um z.B. einen Header aus dem Hintergrund nicht zu überdecken. Das Attribut besteht dabei aus:
Alle Zahlen werden dabei in Pixel-Werte umgewandelt und als solche interpretiert. | "pdfviewer":{
"position":{
"top": "150px",
"right": "20px",
"bottom": "50px",
"left": "20px"
}
} |
showdocumentdescription |
| Nein | Parameter, der angibt ob die Beschreibung des Dokumentes unter dem Bild angezeigt wird. Defaultwert: false | |
showinfopackagename |
| Nein | Parameter, der angibt ob das Infopaket, in dem sich das Dokument befindet, unter dem Bild angezeigt wird Defaultwert: false | |
style |
| Nein | JSON-Objekt zur Definition der Primär- und Sekundär-Farbe des Widgets. Das Objekt hat zwei Felder:
| |
downloadinnewtab |
| Nein | Wird der Parameter auf true gesetzt, so öffnet sich beim klick auf den Downloadbutton ein neuer Tab und die Datei wird heruntergeladen |
|
Ausgang | ||||
Eingangsevents | ||||
closeAlldialogs |
|
| Dieses Event kann an das Widget emittet werden. Das Widget fängt das Event und schließt daraufhin alle zu Zeit geöffneten Dialogfenster. | Beispielaufruf: |
Beispielabbildung
Ein einzelnes Dokument mit Default-Einstellungen
Mehrere Dokumente mit Default-Einstellungen
Wenn der Parameter “showdocumentdescription” auf “true” gesetzt ist
Wenn die Parameter “showdocumentdescription” und “showinfopackagename” auf “true” gesetzt sind
Beispielparameter
Beispielintegration
Folgendes Codesnippet in den HTML DOM einbetten.
Widget-Loader V1.x.x
Widget-Loader V2.x.x
Beispielevent “status”
Folgendes Codebeispiel wartet auf das Rückgabevent “status” von dem Documents Widget.
Beispielcode (PHP)