Wiki-Quellcode von LDAP query
Zeige letzte Bearbeiter
| author | version | line-number | content |
|---|---|---|---|
| 1 | {{figure image="ldap_statements_de.png" clear="h1"}} | ||
| 2 | Konfigurationsoberfläche der Aktion //LDAP-Abfrage// | ||
| 3 | {{/figure}} | ||
| 4 | |||
| 5 | Aktionen des Typs //LDAP-Abfrage// ermöglicht es, eine LDAP-Abfrage gegen einen LDAP-Server auszuführen, um Daten von diesem Server abzuholen. Hierzu muss vorher eine LDAP-Verbindung im System konfiguriert worden sein. Weiterhin ist es möglich, die Rückgabewerte zu filtern, sodass nur die benötigten Attribut zurückgegeben werden. | ||
| 6 | |||
| 7 | == Parameter == | ||
| 8 | |||
| 9 | === Details zur LDAP Abfrage === | ||
| 10 | |||
| 11 | ; Konfigurierte LDAP-Abfrage nutzen? | ||
| 12 | : Wenn diese Option ausgewählt wird, kann eine im Backend vorkonfigurierte LDAP-Abfrage ausgewählt werden. Zusätzlichen werden Details zur Abfrage angezeigt. | ||
| 13 | ; Mandant-LDAP Verbindung nutzen? | ||
| 14 | : Wenn die Option ausgewählt wird, dann werden die bereits definierten Einstellungen für LDAP unter Mandant verwenden. Dadurch muss keine eigene LDAP-Verbindung eingerichtet werden. | ||
| 15 | ; LDAP-Verbindung | ||
| 16 | : LDAP-Verbindung, welche in der Verwaltung vor konfiguriert wurde. | ||
| 17 | ; Base DN | ||
| 18 | : Angabe des für die Suche definierten Root-Verzeichnises des Active Directory. | ||
| 19 | ; LDAP Abfrage | ||
| 20 | : Textfeld für die eigentliche LDAP Abfrage. | ||
| 21 | ; Filter für Rückgabewerte | ||
| 22 | : Attribute können über das Plus-Icon hinzugefügt werden, die bei der LDAP-Abfrage ausgeliefert werden sollen. Ansonsten werden alle Daten ungefiltert zurückgeliefert. | ||
| 23 | |||
| 24 | == Aktionsplatzhalter == | ||
| 25 | |||
| 26 | Aktionen vom Typ //LDAP Abfrage// stellen [[Aktionsplatzhalter>>Formcycle.UserInterface.Variables||anchor="Aktionsplatzhalter"]] bereit, welche in darauf folgenden Aktionen verwendet werden können. | ||
| 27 | |||
| 28 | === Standardplatzhalter === | ||
| 29 | |||
| 30 | ; [%$<Aktionsname>.SUCCESS%] | ||
| 31 | : Rückgabe ob Aktion erfolgreich ausgeführt wurde. Liefert Boolean (true/false) zurück. | ||
| 32 | ; [%$<Aktionsname>.RESULT%] | ||
| 33 | : Rückgabe aller von der Aktion bereitgestellten Ergebnisse in strukturierter JSON-Form. | ||
| 34 | |||
| 35 | ; [%$<Aktionsname>.ERROR_CODE%] | ||
| 36 | : Der geworfene Fehler-Code im Fehlerfall der Aktion. Leer wenn kein Fehler aufgetreten ist. | ||
| 37 | ; [%$<Aktionsname>.ERROR_MESSAGE%] | ||
| 38 | : Die geworfene Fehler-Nachricht im Fehlerfall der Aktion. Leer wenn kein Fehler aufgetreten ist. | ||
| 39 | |||
| 40 | === Aktionsspezifische Platzhalter === | ||
| 41 | |||
| 42 | ; [%$<Aktionsname>.RESULT.rows[i]%] | ||
| 43 | : Enthält die durch die Abfrage ermittelten Ergebnisse in Form eines JSON-Arrays, welches JSON-Objekte enthalten kann. Die Eigenschaften / Attribute eines JSON-Objektes, bestimmt sich aus den zurückgelieferten Eigenschaften des jeweils ermittelten LDAP-Objektes. | ||
| 44 | : Der Parameter i gibt den Index der Zeile an, hierbei ist mit 0 für die erste Zeile zu beginnen. Mittels Punktnotation kann auf die weiteren Attribute zugegriffen werden. | ||
| 45 | : Beispiel RESULT: | ||
| 46 | |||
| 47 | {{code language="json"}} | ||
| 48 | {"rows":[{"mail":"beispiel@mail.de","name":"Beispiel"}],"rowsCount":1} | ||
| 49 | {{/code}} | ||
| 50 | |||
| 51 | : Zugriff auf Attribut Mail per Platzhalter: //[%$<Aktionsname>.RESULT.rows[0].mail%] // | ||
| 52 | |||
| 53 | ; [%$<Aktionsname>.RESULT.rowsCount%] | ||
| 54 | : Anzahl der durch die Abfrageausführung zurückgelieferten Zeilen. Hat den Wert 0, wenn die Abfrage keine Ergebnisse lieferte oder ein Fehler aufgetreten ist |