Firebase Push-Connector für TYPO3

Diese Erweiterung ermöglicht es Ihnen Benachrichtigungen von TYPO3-News zu Firebase zu pushen. Die Erweiterung unterstützt mehrsprachige News-Benachrichtigungen durch die Erstellung von Connection für jede Sprache.

Anforderungen

  • CURL muss aktiviert sein

Konfiguration

Nach der Installation der Erweiterung müssen Sie einen Datencontainer im Seitenbaum erstellen, in dem Sie Ihre Firebase-Connection Datensätze ablegen.

Ein Firebase-Connection Datensatz ist die Schnittstellen zwischen Ihren News-Datensätzen und Firebase.

Sie müssen je eine Firebase-Connection für jede Sprache anlegen, welche folgende Felder beinhaltet:

  • Hide: Mit dieser Checkbox können Sie steuern ob die Conncetion verarbeitet wird oder nie.
  • Title: Das Titel-Feld ist nur für die interne Indentifikation.
  • Url: Das URL-Feld enthält die Firebase API-URL, z.B.: https://fcm.googleapis.com/fcm/send
  • API access key: Dieses Feld muss Ihren Firebase API-Key enthalten.
  • Push to: Dieses Feld enthält den Firebase Push-Pfad. Dieser Pfad ist normalerweise je Sprache unterschiedlich. So ein Pfad könnte /topics/allDevices heißen, oder für deutsch sprechende /topics/allDevices_de. Diese Pfade hängen von Ihrer Firebase-Konfiguration ab.

Nachdem Sie die erforderlichen Firebase-Connections konfiguriert haben, müssen Sie den Scheduler-Task, welcher den Push-Prozess ausführt. Dafür wechseln Sie in das Scheduler-Modul von TYPO3 und erstellen einen neuen Task. In diesem Task müssen Sie die Klasse Extbase CommandController Task und den CommandController Firebase News: push auswählen. Abschließend definieren Sie die Ausführungszeit in Sekunden und speichern den Task. Jetzt sollte der Firebase-Push Scheduler-Task bereit zur Ausführung sein.

Verwendung

Die Firebase-Erweiterung erweitert die News-Datensätze mit den folgenden Feldern:

  • Activate Firebase push: Diese Checkbox aktiviert das Push-Feature. Wenn Sie einen neuen News-Datensatz erstellen und Ihre Benutzer mit einer Push-Benachrichtigung benachrichtigen wollen, aktivieren Sie einfach die Checkbox. Wenn der Firebase-Scheduler ausgeführt wird, findet dieser den markierten News-Datensatz und pusht die Benachrichtigung.
  • Were already push to Firebase at: Dieses Feld enthält das Datum/Uhrzeit an dem die Push-Benachrichtigung an Firebase geschickt wurde. Wenn dieses Feld leer ist, wurde die Benachrichtigung noch nicht geschickt.
  • Push to Firebase connection: In diesem Feld muss die Firebase-Connection ausgewählt werden, an die die Benachrichtigung geschickt werden soll. Wenn Sie also übersetzte News an entsprechende Benutzergruppen senden möchten, wählen Sie einfach die entsprechende Firebase-Connection aus.

Wenn Sie einen neuen News-Datensatz mit aktivierter Activate Firebase push Checkbox erstellt haben und Ihr Scheduler-Task korrekt konfiguriert ist, schickt der Scheduler bei der nächsten Ausführung die Push-Benachrichtiungen zu Ihren Benutzern.

Logging

Die Firebase-Erweiterung enthält eineLogging-Funktion, welche über den Erweiterungsmanager konfiguriert werden kann.

Die Logging-Funktion hat folgende Einstellungen:

  • log.dontDeleteLogFilesAfterImport: Die Firebase-Erweiterung schreibt bei jeder Scheduler-Ausführung Logging-Einträge. Die Log-Datei wird im Verzeichnis uploads/tx_firebase/log/ geschrieben. Mit dieser Checkbox können Sie entscheiden, ob die Log-Datei nach der Ausführung gelöscht wird oder nicht.
  • import.report.active: Bei Aktivierung dieser Checkbox wird der Log-Report an die folgenden E-Mailadresse gesendet.
  • import.report.subject: In diesem Feld können Sie einen selbst definierten E-Mailbetreff eintragen, falls Sie mehrere TYPO3-Instanzen mit Firebase-Funktion in Verwendung haben.
  • import.report.email: In diesem Feld können Sie die E-Mailadresse für den Log-Report angeben.

Links