Zum Hauptinhalt springen

Liferay

Über die ONLYOFFICE- und Liferay-Integration​

ONLYOFFICE bietet einen offiziellen Konnektor zur Integration von ONLYOFFICE Docs mit Liferay und zur Bearbeitung von Office-Dokumenten in der Liferay-Dokumenten- und Medienbibliothek. Sie können den ONLYOFFICE-Konnektor vom Liferay Marketplace oder von der GitHub-Seite herunterladen. Der Konnektor wird unter der Apache-Lizenz vertrieben.

hinweis

Weitere Informationen darüber, wie der ONLYOFFICE-Konnektor für Liferay funktioniert, finden Sie auf unserer Seite zur API-Dokumentation.

Haupteigenschaften​

  • Erstellen von Dateien über die Menüoption Create with ONLYOFFICE (Mit ONLYOFFICE erstellen).
  • Erstellen und Ausfüllen von Online-Formularen.
  • Anzeigen und Bearbeiten vorhandener Textdokumente, Tabellenkalkulationen oder Präsentationen über die Menüoption ONLYOFFICE Edit/View (ONLYOFFICE Bearbeiten/Anzeigen) im Bereich Documents and Media (Dokumente und Medien).
  • Co-Bearbeitung von Dokumenten in Echtzeit: zwei Co-Editing-Modi (Schnell und Formal), Änderungen verfolgen, Kommentare und der integrierte Chat.
  • JWT-Unterstützung, um Ihren Datenverkehr zu sichern, damit niemand außer den Benutzern mit den entsprechenden Zugriffsrechten Zugriff auf Ihre Dokumente hat.

Unterstützte Formate​

  • Zum Anzeigen:
    • WORD: DOC, DOCM, DOCX, DOT, DOTM, DOTX, EPUB, FB2, FODT, HTM, HTML, HWP, HWPX, MD, MHT, MHTML, ODT, OTT, PAGES, RTF, STW, SXW, TXT, WPS, WPT, XML
    • CELL: CSV, ET, ETT, FODS, NUMBERS, ODS, OTS, SXC, XLS, XLSM, XLSX, XLT, XLTM, XLTX
    • SLIDE: DPS, DPT, FODP, KEY, ODG, ODP, OTP, POT, POTM, POTX, PPS, PPSM, PPSX, PPT, PPTM, PPTX, SXI
    • PDF: DJVU, DOCXF, OFORM, OXPS, PDF, XPS
    • DIAGRAM: VSDM, VSDX, VSSM, VSSX, VSTM, VSTX
  • Zum Bearbeiten:
    • WORD: DOCM, DOCX, DOTM, DOTX
    • CELL: XLSB, XLSM, XLSX, XLTM, XLTX
    • SLIDE: POTM, POTX, PPSM, PPSX, PPTM, PPTX
    • PDF: PDF
  • Zum Konvertieren in Office Open XML-Formate:
    • WORD: DOC, DOCM, DOCX, DOT, DOTM, DOTX, EPUB, FB2, FODT, HTM, HTML, HWP, HWPX, MD, MHT, MHT, MHTML, ODT, OTT, PAGES, RTF, STW, SXW, TXT, WPS, WPT, XML
    • CELL: CSV, ET, ETT, FODS, NUMBERS, ODS, OTS, SXC, XLS, XLSB, XLSM, XLSX, XLT, XLTM, XLTX
    • SLIDE: DPS, DPT, FODP, KEY, ODG, ODP, OTP, POT, POTM, POTX, PPS, PPSM, PPSX, PPT, PPTM, PPTX, SXI
    • PDF: DOCXF, OXPS, PDF, XPS

Was gibt es Neues in Version 3.1.0​

Hinzugefügt

  • Unterstützung für ONLYOFFICE Docs v9.1.0

Geändert

  • Aktualisierte Version von com.onlyoffice:docs-integration-sdk
    • neue unterstützte Formate: .vsdx, .md, .odg, .xlsb, Apple iWork, .hwp, .hwpx, .mht
    • neuer Dokumenttyp hinzugefügt: DIAGRAM
    • erweiterte Vorlagen für leere Dateien

Das vollständige Änderungsprotokoll ist hier verfügbar.

Verbinden von ONLYOFFICE Docs mit Liferay​

Systemanforderungen​

  • ONLYOFFICE Document Server V. 6.1.0 (die Server- oder Cloud-Lösung) oder höher.

    Sie benötigen eine Instanz von ONLYOFFICE Docs, die sowohl von Liferay als auch von beliebigen End-Clients auflösbar und verbindbar ist. Die Instanz muss direkt an Liferay POSTen können.

    hinweis

    Weitere Informationen über die Installation von ONLYOFFICE Docs finden Sie auf der offiziellen Dokumentationsseite.

  • Liferay CE Portal 7.2 GA1+, Liferay DXP 7.2 GA1+, Liferay CE Portal 7.3 GA1+, Liferay DXP 7.3 GA1+, Liferay CE Portal 7.4 GA1+, Liferay CE 7.4 GA44 - GA73, Liferay DXP 7.4 U44 - U73.

  • ONLYOFFICE Konnektor v2.2.0 für Liferay.

Installieren des ONLYOFFICE-Konnektors für Liferay​

Sie können den ONLYOFFICE-Konnektor über den App Manager installieren.

So installieren Sie ihn über den App Manager:

  1. Navigieren Sie zu Control Panel > System > App Manager.
  2. Klicken Sie auf die Schaltfläche Options Options (Optionen).
  3. Klicken Sie auf die Schaltfläche Upload (Hochladen).
  4. Wählen Sie im geöffneten Fenster die ONLYOFFICE-Anwendungsdatei aus.

Wenn die Installation abgeschlossen ist, ist die Anwendung einsatzbereit.

Wenn Sie den Konnektor selbst erstellen, legen Sie einfach die kompilierte .jar-Datei aus dem Ordner build\libs in /opt/liferay/deploy ab. Liferay installiert sie automatisch.

hinweis

Vom Marketplace heruntergeladene Dateien werden im Format .lpkg bereitgestellt. Sie können ein .lpkg-Paket entpacken, um die entsprechende .jar-Datei zu erhalten. Die extrahierte .jar-Datei kann dann über den App Manager bereitgestellt werden.

Kompilieren des ONLYOFFICE-Konnektors für Liferay​

Führen Sie einfach gradle build aus. Die resultierende .jar-Datei wird im Verzeichnis build/libs abgelegt.

Konfigurieren des ONLYOFFICE-Konnektors für Liferay​

Gehen Sie zu Control Panel > Configuration > System Settings. Wählen Sie im Abschnitt Platform die Kategorie Connectors und wählen Sie ONLYOFFICE.

Hier können Sie die folgenden Einstellungen konfigurieren:

  • ONLYOFFICE Docs address (ONLYOFFICE Docs-Adresse) - geben Sie die URL-Adresse an, unter der der Document Editing Service installiert ist.

    hinweis

    Die Adresse von ONLYOFFICE Docs muss von Liferay aus zugänglich sein, ebenso muss die Adresse von Liferay von ONLYOFFICE Docs aus zugänglich sein.

  • ONLYOFFICE Docs address for internal requests from the server (ONLYOFFICE Docs-Adresse für interne Anfragen vom Server) - geben Sie die Adresse an, die für den Zugriff auf den Document Editing Service von Liferay verwendet wird.

  • Server address for internal requests from ONLYOFFICE Docs (Serveradresse für interne Anfragen von ONLYOFFICE Docs) - geben Sie die Adresse an, die für den Zugriff auf Liferay vom Document Editing Service verwendet wird.

  • Secret key (Geheimer Schlüssel) - geben Sie das Geheimnis an, das zum Signieren der Daten verwendet wird.

    hinweis

    Ab ONLYOFFICE Docs v7.2 ist JWT standardmäßig aktiviert und der geheime Schlüssel wird automatisch generiert. Sie müssen es auch auf der Liferay-Seite aktivieren: Suchen Sie Ihren geheimen Schlüssel in der Konfigurationsdatei von ONLYOFFICE Docs und geben Sie dann denselben geheimen Schlüssel in den Konnektor-Einstellungen an. Weitere Informationen finden Sie im Abschnitt Aktivieren von JWT für die ONLYOFFICE- und Liferay-Integration dieses Artikels.

  • Authorization header (Autorisierungs-Header) (leer lassen, um den Standard-Header zu verwenden) - der in ONLYOFFICE verwendete JWT-Autorisierungs-Header ist Authorization. Falls dieser Header mit Ihrer Konfiguration in Konflikt steht, können Sie ihn durch einen benutzerdefinierten ersetzen.

  • Enable Force Save (Speichern erzwingen aktivieren) - aktivieren Sie das Kontrollkästchen, um beim Bearbeiten Zwischenversionen des Dokuments beizubehalten.

  • Enable ONLYOFFICE Web Preview (ONLYOFFICE-Webvorschau aktivieren) - aktivieren Sie das Kontrollkästchen, um die Dateivorschau zu aktivieren.

Configuration

Nachdem Sie die Integrationsanwendung konfiguriert haben, klicken Sie auf die Schaltfläche Save (Speichern), um die Änderungen zu übernehmen.

Wie es funktioniert​

Die ONLYOFFICE-Integration folgt der API, die hier dokumentiert ist.

  1. Der Benutzer navigiert in Liferay zum Bereich Documents and Media und wählt die Aktion Edit in ONLYOFFICE.
  2. Liferay bereitet ein JSON-Objekt für den Document Server mit den folgenden Eigenschaften vor:
    • url: die URL, die ONLYOFFICE Docs zum Herunterladen des Dokuments verwendet;
    • callbackUrl: die URL, die ONLYOFFICE Docs verwendet, um über den Status der Dokumentbearbeitung zu informieren;
    • key: die fileVersionId, die ONLYOFFICE Docs anweist, ob das Dokument erneut heruntergeladen werden soll oder nicht;
    • title: der Titel (Name) des Dokuments.
  3. Der Client-Browser sendet eine Anfrage an die JavaScript-Bibliothek von ONLYOFFICE Docs und übergibt ONLYOFFICE Docs die DocEditor-Konfiguration mit den oben genannten Eigenschaften.
  4. Anschließend lädt ONLYOFFICE Docs das Dokument von Liferay herunter und der Benutzer beginnt mit der Bearbeitung.
  5. ONLYOFFICE Docs sendet eine POST-Anfrage an die callbackUrl, um Liferay darüber zu informieren, dass ein Benutzer das Dokument bearbeitet.
  6. Liferay sperrt das Dokument, erlaubt aber weiterhin anderen Benutzern mit Schreibzugriff, in Echtzeit mit ONLYOFFICE Docs zusammenzuarbeiten, indem die Action (Aktion) verfügbar bleibt.
  7. Wenn alle Benutzer und Client-Browser die Bearbeitung beendet haben, schließen sie das Bearbeitungsfenster.
  8. Nach 10 Sekunden Inaktivität sendet ONLYOFFICE Docs ein POST an die callbackUrl, um Liferay mitzuteilen, dass die Clients die Bearbeitung des Dokuments abgeschlossen und es geschlossen haben.
  9. Liferay lädt eine neue Version des Dokuments herunter und ersetzt die alte.

Aktivieren von JWT für die ONLYOFFICE- und Liferay-Integration​

Um Dokumente vor unbefugtem Zugriff zu schützen, verwenden ONLYOFFICE-Editoren das JSON Web Token (JWT). Das Token wird in der Konfiguration hinzugefügt, wenn der Dokumenteneditor initialisiert wird und während des Austauschs von Befehlen zwischen internen ONLYOFFICE Docs-Diensten. Der geheime Schlüssel wird verwendet, um das JSON-Web-Token zu signieren und das Token auf Anfrage an ONLYOFFICE Docs zu validieren.

Ab ONLYOFFICE Docs v7.2 ist JWT standardmäßig aktiviert und der geheime Schlüssel wird automatisch generiert. Sie müssen Ihren geheimen Schlüssel in der ONLYOFFICE Docs-Konfigurationsdatei finden und dann denselben geheimen Schlüssel in den Konnektor-Einstellungen angeben.

Schritt 1: Ihren geheimen Schlüssel in der Konfigurationsdatei von ONLYOFFICE Docs finden

  1. Öffnen Sie die Datei local.json mit einem beliebigen verfügbaren Texteditor.

    • Für Linux - /etc/onlyoffice/documentserver/local.json

    • Für Windows - %ProgramFiles%\ONLYOFFICE\DocumentServer\config\local.json

    • Für Docker – betreten Sie den ONLYOFFICE Docs-Container mit dem Befehl docker exec -it <containerID> bash und öffnen Sie /etc/onlyoffice/documentserver/local.json

      Alternativ können Sie den folgenden Befehl verwenden, um den standardmäßigen geheimen Schlüssel zu finden, ohne local.json zu öffnen:

      sudo docker exec <containerID> /var/www/onlyoffice/documentserver/npm/json -f /etc/onlyoffice/documentserver/local.json 'services.CoAuthoring.secret.session.string'

    Die local.json-Datei sollte wie folgt aussehen:

    {
      "services": {
        "CoAuthoring": {
          "token": {
            "enable": {
              "request": {
                "inbox": true,
                "outbox": true
              },
              "browser": true
            }
          },
          "secret": {
            "inbox": {
              "string": "yoursecret"
            },
            "outbox": {
              "string": "yoursecret"
            },
            "session": {
              "string": "yoursecret"
            }
          }
        }
      }
    }

  2. Der Wert true ist in drei Abschnitten angegeben. Das bedeutet, dass die Token-Validierung aktiviert ist.

    • services.CoAuthoring.token.enable.browser
    • services.CoAuthoring.token.enable.request.inbox
    • services.CoAuthoring.token.enable.request.outbox

  3. Der automatisch generierte geheime Schlüssel ist in drei Abschnitten angegeben. Sie können den standardmäßigen geheimen Wert durch Ihren eigenen geheimen Schlüssel ersetzen. Der geheime Schlüssel muss in allen drei Abschnitten gleich sein.

    • services.CoAuthoring.secret.inbox.string
    • services.CoAuthoring.secret.outbox.string
    • services.CoAuthoring.secret.session.string

  4. Wenn Sie Änderungen vornehmen, speichern Sie diese und starten Sie die Dienste neu, damit die Konfigurationsänderungen wirksam werden.

    • Für Linux:

      sudo supervisorctl restart all

    • Für Docker:

      docker exec <containerID> supervisorctl restart all

      oder starten Sie den gesamten Container neu:

      docker restart <containerID>

Schritt 2: Denselben geheimen Schlüssel in den Konnektor-Einstellungen angeben

Geben Sie in den Konnektor-Einstellungen im Feld Secret key (Geheimer Schlüssel) denselben geheimen Schlüssel an und speichern Sie die Einstellungen.

Erste Schritte für ONLYOFFICE Docs in Liferay​

So erstellen Sie eine Datei:

  1. Gehen Sie zum Bereich Documents and Media.

  2. Klicken Sie auf die Schaltfläche Add File Add File (Datei hinzufügen).

  3. Klicken Sie im geöffneten Menü auf die Schaltfläche Create with ONLYOFFICE.

    Create

  4. Wählen Sie auf der geöffneten Seite den Dateityp aus und geben Sie (optional) Titel und Beschreibung an.

  5. Klicken Sie auf die Schaltfläche Save (Speichern).

    Create file

So bearbeiten Sie eine Datei:

  1. Suchen Sie die gewünschte Datei im Bereich Documents and Media.

  2. Klicken Sie auf das Dokument.

  3. Klicken Sie im geöffneten Menü auf die Schaltfläche Edit in ONLYOFFICE.

    Edit

So erstellen Sie ein PDF-Formular:

  1. Gehen Sie zum Bereich Documents and Media.

  2. Klicken Sie auf die Schaltfläche Add File Add File (Datei hinzufügen).

  3. Klicken Sie im geöffneten Menü auf die Schaltfläche Create with ONLYOFFICE.

    Create

  4. Wählen Sie auf der geöffneten Seite den Dateityp PDF form (PDF-Formular).

  5. Klicken Sie auf die Schaltfläche Save (Speichern).

hinweis

Weitere Informationen zu Formularen finden Sie in den entsprechenden Artikeln zum Erstellen von Formularen.

hinweis

Weitere Informationen zu den häufigsten Problemen und deren Lösung finden Sie in unserer Anleitung zur Fehlerbehebung.