Kategorien: FAU-Studium-Fachanteile Schlagwörter: API, API-Key
Index
Ich betreibe meine Website auf einer selbst betreuten WordPress-Installation und brauche den API Key für FAU-Studium-Fachanteile. Wie erhalte ich den API Key?
Der API Key kann online über die Dokumentation von api.fau.de beantragt werden:
Dokumentation: https://api.fau.de/doc
Für FAU-Studium-Fachanteile wird die Berechtigung auf den Endpoint edu in der Version 1 benötigt.
Ich betreibe meine Website auf einer selbst betreuten WordPress-Installation und brauche den API Key für RRZE-FAUdir. Wie erhalte ich den API Key?
Der API Key kann online über die Dokumentation von api.fau.de beantragt werden:
Dokumentation: https://api.fau.de/doc
Für RRZE -FAUdir wird die Berechtigung auf den Endpoint opendir in der Version 1 benötigt.
Ich betreibe meine Website auf einer selbst betreuten WordPress-Installation und brauche den API Key für RRZE-Lectures. Wie erhalte ich den API Key?
Der API Key kann online über die Dokumentation von api.fau.de beantragt werden:
Dokumentation: https://api.fau.de/doc
Für RRZE Lectures wird die Berechtigung auf den Endpoint vz in der Version 2 benötigt.
Wie erhalte ich die Identifier einer Person aus FAUdir?
Die Identifier einer Person kann man auf zwei Wegen erhalten:
- Man besucht die Website faudir.fau.de und sucht dort die gewünschte Person. Aus der Trefferliste ruft man dann den Personenintrag auf. Hat man dies getan, kann man sich in der Adresszeile des Browsers den Identifier kopieren.
Die Adresse (URL) hat dabei die Form:https://faudir.fau.de/public/person/abcd1234efgh56
. Die Zeichen am Ende, hinterperson/
, sind der Identifier. Im Beispiel dannabcd1234efgh56
. - Administratoren der Website finden unter den EInstellungen von FAUdir eine Lasche zur Suche nach Personen. Mittels dieser können ebenfalls Personeneinträge gefunden und dann gleich als Eintrag übernommen werden.
(Die Suche im FAUdir-Portal ist jedoch qualitativ besser und bietet mehr Möglichkeiten).
Mit dem alten Personen-Plugin gab es eine Metabox, mit der man sich eine Copy&Paste-Vorlage für einen Shortcode anzeigen lassen konnte. Wird es diese auch mit dem FAUdir Plugin geben?
Diese Option wird es nicht mehr geben.
Da in Zukunft der Umstieg auf den Blockeditor erfolgt, ist es nicht mehr sinnvoll, Shortcodes zu verwenden. Statdessen soll der FAUdir Block verwendet werden.
Zudem wurde die Metabox mit der Copy&Paste-Vorlage nur im FAU Einrichtungen-Theme gezeigt, wenn dieser noch im Modus des Classic Editors verwendet wurde. Somit ist diese Option ohnehin mit dem Blockeditor nicht mehr sofort sichtbar, sondern muss erst gesucht werden.
Da auch das Theme mit dem geplanten Relaunch wegfallen wird, wird unabhängig vom FAUdir Plugin auch diese Metabox dann komplett wegfallen.
Wie lange werden Kontakteinträge zwischengespeichert?
Die Erstellung von Kontaktseiten kostet stets etwas Zeit, da die Daten der einzelnen Personen zunächst vom FAUdir Portal geladen werden müssen. Damit, gerade bei Listen vieler Personen, die Ladezeit reduziert wird, werden sowohl die erzeugten Seiten als auch die darauf beruhenden Daten von Personen, Einrichtungen und Arbeitsplätzen in soegannte „Caches“ zwischengespeichert.
Der Administrator einer Webseite kann in den Einstellungen zum Plugin einstellen, dass die Generierung der Ausgabeseite für angemeldete Redakteure nicht gecacht wird. Dies ist sinnvoll, wenn die Ausgabe noch mehrmals angepasst werden muss. Die Daten der Personen und Einrichtungen hingegen werden nach dem ersten Laden von der zentralen Datenquelle in einem Cache abgelegt. Personendaten werden üblicherweise über 2 Stunden zwischengespeichert, die von Einrichtungen über 4 Stunden.
Wenn eine Person in FAUdir Einträge ändert, kann es dementsprechend so lange dauern, bis diese auch auf der Website geändert werden. Sollte es jedoch dringliche Änderungen geben, hat der Administrator der Website die Möglichkeit, im Backend unter den Einstellungen des Plugins den gesamten Cache zu löschen und somit die Daten neu anzufordern.
Können Einrichtungen oder Einheiten wie Servicetheken, Sekretariate oder Servicestellen angezeigt werden?
Ja, dies ist möglich, nachdem diese Einrichtungen im FAUdir-Portal eingerichtet wurde. Alle offiziellen Einrichtungen der FAU sind bereits in FAUdir enthalten. IdM-Beauftragte der EInrichtungen können überdies eigene untergeordnete Einheiten in „Ordnern“ anlegen. Diese Order haben, wie auch Einrichtungen, eigene Titel, Beschreibungen und Kontaktdaten.
Alle diese Einrichtungen ein Ordner können ebenfalls mit dem FAUdir Plugin angezeigt werden. Dies eignet sich insbesondere dann, wenn man nicht einzelne Personen als Kontakt angeben möchte, sondern Arbeits- und Projektgruppen oder Servicestellen.
Ein Beispiel zeigt der Ordner „Webteam“: https://faudir.fau.de/public/org/6f44f3fb31
Diese kann mit dem Shortcode eingebunden werden: [faudir display="org" orgid="6f44f3fb31"]
Werden meine Kategorien aus dem alten Personen-Plugin auch mit importiert?
Kategorien aus dem Person-Plugin (Kontakte) werden nur in das FAUdir-Plugin übernommen, wenn Sie mindestens einen importierten UnivIS Kontakt enthalten.
Kategorien, die ausschließlich nicht importierte oder externe Mitarbeiter beinhalten, werden nicht übernommen. Diese müssen dann im FAUdir-Plugin neu angelegt werden.
Der Import von Personen aus dem alten FAU Person zum FAUdir Plugin ist unvollständig?
Es können nur folgende Personen aus dem alten FAU Person Plugin übernommen werden:
- Zu den Personeneinträgen des alten Plugins gibt es eine UnivIS-Id. Diese UnivIS-Id muss im UnivIS-System gültig sein und zu einem Personeneintrag führen.
- Der Personeneintrag aus UnivIS wird im FAUdir gesucht. Und zwar mit entweder der im UnivIS hinterlegten IdM-Kennung oder wenn es diese nicht gibt, mit der im UnivIS hinterlegten Mailadresse oder wenn es auch diese nicht gibt mit der Kombination aus Vornamen und Nachname.
- Bei der Suche im FAUdir kann es nur dann z u Treffern kommen, wenn die aus UnivIS ermittelten Daten zu nur einer Person im FAUdir führen, deren Eintrag öffentlich sein muss.
Dementsprechend schlägt der Import dann fehl, wenn obiges Verfahren keine Treffer hat. Häufige Ursachen sind also:
- Die E-Mailadresse der Person im UnivIS ist nicht dieselbe, die im öffentlichen Eintrag in FAUdir zu finden ist.
- Die Person ist im FAUdir nicht öffentlich.
- Der Personeneintrag in FAU Person enthielt keine gültige UnivIS Id.
Der Import wird automatisch gestartet, wenn das FAUdir Plugin aktiviert wird und das FAU Person Plugin noch aktiv ist. Der Import kann später (z.B. nach einer Korrektur der Alteinträge um die Perosnen zu finden) neu angefordert werden. Hierzu findet sich in den Einstellungen des Plugins (Einstellung – RRZE FAUdir in der Lasche „Erweiterte EInstellungen“) eine entsprechende Option.
Welches Format haben die Personenbilder und kann dieses geändert werden?
In der aktuellen version des FAUdir Plugins sind nur Bildern im Format 1:1 (viereckig) vorgesehen. Ein Foto sollte dabei mindestens 500×500 Pixel groß sein und im JPG-Format hochgeladen werden.
Andere Formate des Bildes (z.B. Hochkant oder Quer) sind derzeit nicht möglich und nicht vorgesehen.
Hintergrund: Im Rahmen des anstehenden Relaunches des Corporate Designs der FAU werden Personenprofile nur noch im viereckigen Format auf der Website veröffentlicht. Auch wenn die jeweiligen Website noch nicht auf das neue Design umgestellt wurde, sollten bereits jetzt die Bilder entsprechend angepasst werden.