Passa al contenuto principale

Liferay

Informazioni sull'integrazione di ONLYOFFICE e Liferay​

ONLYOFFICE offre un connettore ufficiale per integrare ONLYOFFICE Docs con Liferay e modificare i documenti d'ufficio all'interno della libreria Documenti e Media di Liferay. Puoi scaricare il connettore ONLYOFFICE dal Liferay Marketplace o dalla pagina GitHub. Il connettore è distribuito con licenza Apache.

note

Per saperne di più su come funziona il connettore ONLYOFFICE per Liferay, visita la nostra pagina della documentazione API.

Funzionalità principali​

  • Creazione di file con l'opzione di menu Create with ONLYOFFICE (Crea con ONLYOFFICE).
  • Creazione e compilazione di moduli online.
  • Visualizzazione e modifica di documenti di testo, fogli di calcolo o presentazioni esistenti con l'opzione di menu ONLYOFFICE Edit/View (ONLYOFFICE Modifica/Visualizza) nella sezione Documents and Media (Documenti e Media).
  • Co-editing dei documenti in tempo reale: due modalità di co-editing (Veloce e Rigorosa), revisione delle modifiche, commenti e chat integrata.
  • Supporto JWT per proteggere il traffico, in modo che solo gli utenti con i diritti appropriati abbiano accesso ai tuoi documenti.

Formati supportati​

  • Per la visualizzazione:
    • 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
  • Per la modifica:
    • WORD: DOCM, DOCX, DOTM, DOTX
    • CELL: XLSB, XLSM, XLSX, XLTM, XLTX
    • SLIDE: POTM, POTX, PPSM, PPSX, PPTM, PPTX
    • PDF: PDF
  • Per la conversione nei formati Office Open XML:
    • 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

Novità della versione 3.1.0​

Aggiunto

  • Supporto per ONLYOFFICE Docs v9.1.0

Modificato

  • Aggiornata la versione di com.onlyoffice:docs-integration-sdk
    • nuovi formati supportati: .vsdx, .md, .odg, .xlsb, Apple iWork, .hwp, .hwpx, .mht
    • aggiunto un nuovo tipo di documenti: DIAGRAM
    • modelli di file vuoti ampliati

Il registro completo delle modifiche è disponibile qui.

Collegamento di ONLYOFFICE Docs a Liferay​

Requisiti​

  • ONLYOFFICE Document Server v6.1.0 (versione server o cloud) o successiva.

    Hai bisogno di un'istanza di ONLYOFFICE Docs risolvibile e raggiungibile sia da Liferay sia da qualsiasi client finale. Deve poter inviare richieste POST direttamente a Liferay.

    note

    Consulta la pagina della documentazione ufficiale per saperne di più sull'installazione di ONLYOFFICE Docs.

  • 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.

  • Connettore ONLYOFFICE v2.2.0 per Liferay.

Installazione del connettore ONLYOFFICE per Liferay​

Puoi installare il connettore ONLYOFFICE tramite l'App Manager.

Per installarlo tramite l'App Manager:

  1. Vai a Control Panel > System > App Manager.
  2. Fai clic sul pulsante Options Options (Opzioni).
  3. Fai clic sul pulsante Upload (Carica).
  4. Nella finestra aperta, scegli il file dell'applicazione ONLYOFFICE.

Al termine dell'installazione, l'applicazione è pronta per l'uso.

Se stai compilando il connettore da solo, metti semplicemente il file .jar compilato dalla cartella build\libs in /opt/liferay/deploy. Liferay lo installerà automaticamente.

note

I file scaricati dal Marketplace sono forniti nel formato .lpkg. Puoi decomprimere un pacchetto .lpkg per ottenere il file .jar corrispondente. Il file .jar estratto può quindi essere distribuito tramite l'App Manager.

Compilazione del connettore ONLYOFFICE per Liferay​

Esegui semplicemente gradle build. Il file .jar risultante verrà collocato nella directory build/libs.

Configurazione del connettore ONLYOFFICE per Liferay​

Vai a Control Panel > Configuration > System Settings. Nella sezione Platform, scegli la categoria Connectors e seleziona ONLYOFFICE.

Qui puoi configurare le seguenti impostazioni:

  • ONLYOFFICE Docs address (Indirizzo di ONLYOFFICE Docs) - specifica l'indirizzo URL in cui è installato il Document Editing Service.

    note

    L'indirizzo di ONLYOFFICE Docs deve essere accessibile da Liferay, così come l'indirizzo di Liferay deve essere accessibile da ONLYOFFICE Docs.

  • ONLYOFFICE Docs address for internal requests from the server (Indirizzo di ONLYOFFICE Docs per le richieste interne dal server) - specifica l'indirizzo utilizzato per accedere al Document Editing Service da Liferay.

  • Server address for internal requests from ONLYOFFICE Docs (Indirizzo del server per le richieste interne da ONLYOFFICE Docs) - specifica l'indirizzo utilizzato per accedere a Liferay dal Document Editing Service.

  • Secret key (Chiave segreta) - specifica il segreto utilizzato per firmare i dati.

    note

    A partire da ONLYOFFICE Docs v7.2, JWT è abilitato per impostazione predefinita e la chiave segreta viene generata automaticamente. Devi abilitarlo anche lato Liferay: trova la tua chiave segreta nel file di configurazione di ONLYOFFICE Docs, quindi specifica la stessa chiave segreta nelle impostazioni del connettore. Per ulteriori dettagli, consulta la sezione Abilitazione di JWT per l'integrazione di ONLYOFFICE e Liferay di questo articolo.

  • Authorization header (Intestazione di autorizzazione) (lascia vuoto per usare l'intestazione predefinita) - l'intestazione JWT di autorizzazione usata in ONLYOFFICE è Authorization. Se questa intestazione è in conflitto con la tua configurazione, puoi sostituirla con una personalizzata.

  • Enable Force Save (Abilita il salvataggio forzato) - seleziona la casella per conservare le versioni intermedie del documento durante la modifica.

  • Enable ONLYOFFICE Web Preview (Abilita l'anteprima web di ONLYOFFICE) - seleziona la casella per abilitare l'anteprima dei file.

Configuration

Dopo aver configurato l'applicazione di integrazione, fai clic sul pulsante Save (Salva) per applicare le modifiche.

Come funziona​

L'integrazione di ONLYOFFICE segue l'API documentata qui.

  1. L'utente passa alla sezione Documents and Media in Liferay e seleziona l'azione Edit in ONLYOFFICE.
  2. Liferay prepara un oggetto JSON per Document Server con le seguenti proprietà:
    • url: l'URL che ONLYOFFICE Docs usa per scaricare il documento;
    • callbackUrl: l'URL che ONLYOFFICE Docs usa per informare sullo stato della modifica del documento;
    • key: il fileVersionId che indica a ONLYOFFICE Docs se scaricare di nuovo il documento o no;
    • title: il titolo (nome) del documento.
  3. Il browser del client invia una richiesta alla libreria JavaScript di ONLYOFFICE Docs e le invia la configurazione di DocEditor con le proprietà sopra indicate.
  4. Quindi ONLYOFFICE Docs scarica il documento da Liferay e l'utente inizia la modifica.
  5. ONLYOFFICE Docs invia una richiesta POST a callbackUrl per informare Liferay che un utente sta modificando il documento.
  6. Liferay blocca il documento, ma consente comunque agli altri utenti con accesso in scrittura di collaborare in tempo reale con ONLYOFFICE Docs lasciando disponibile l'Action (Azione).
  7. Quando tutti gli utenti e i browser client hanno terminato la modifica, chiudono la finestra di modifica.
  8. Dopo 10 secondi di inattività, ONLYOFFICE Docs invia un POST a callbackUrl per informare Liferay che i client hanno terminato la modifica del documento e lo hanno chiuso.
  9. Liferay scarica una nuova versione del documento, sostituendo la precedente.

Abilitazione di JWT per l'integrazione di ONLYOFFICE e Liferay​

Per proteggere i documenti dall'accesso non autorizzato, gli editor ONLYOFFICE utilizzano il JSON Web Token (JWT). Il token viene aggiunto alla configurazione quando l'editor di documenti viene inizializzato e durante lo scambio di comandi tra i servizi interni di ONLYOFFICE Docs. La chiave segreta viene utilizzata per firmare il JSON Web Token e convalidare il token nella richiesta a ONLYOFFICE Docs.

A partire da ONLYOFFICE Docs v7.2, JWT è abilitato per impostazione predefinita e la chiave segreta viene generata automaticamente. Devi trovare la tua chiave segreta nel file di configurazione di ONLYOFFICE Docs, quindi specificare la stessa chiave segreta nelle impostazioni del connettore.

Passaggio 1: trova la tua chiave segreta nel file di configurazione di ONLYOFFICE Docs

  1. Apri il file local.json con qualsiasi editor di testo disponibile.

    • Per Linux - /etc/onlyoffice/documentserver/local.json

    • Per Windows - %ProgramFiles%\ONLYOFFICE\DocumentServer\config\local.json

    • Per Docker – entra nel container di ONLYOFFICE Docs con il comando docker exec -it <containerID> bash e apri /etc/onlyoffice/documentserver/local.json

      In alternativa, puoi usare il seguente comando per trovare la chiave segreta predefinita senza aprire local.json:

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

    Il file local.json dovrebbe avere questo aspetto:

    {
    "services": {
    "CoAuthoring": {
    "token": {
    "enable": {
    "request": {
    "inbox": true,
    "outbox": true
    },
    "browser": true
    }
    },
    "secret": {
    "inbox": {
    "string": "yoursecret"
    },
    "outbox": {
    "string": "yoursecret"
    },
    "session": {
    "string": "yoursecret"
    }
    }
    }
    }
    }
  2. Il valore true è specificato in tre sezioni. Significa che la convalida del token è abilitata.

    • services.CoAuthoring.token.enable.browser
    • services.CoAuthoring.token.enable.request.inbox
    • services.CoAuthoring.token.enable.request.outbox
  3. La chiave segreta generata automaticamente è specificata in tre sezioni. Puoi sostituire il valore segreto predefinito con la tua chiave segreta. La chiave segreta deve essere la stessa nelle tre sezioni.

    • services.CoAuthoring.secret.inbox.string
    • services.CoAuthoring.secret.outbox.string
    • services.CoAuthoring.secret.session.string
  4. Se apporti modifiche, salvale e riavvia i servizi affinché le modifiche alla configurazione abbiano effetto.

    • Per Linux:

      sudo supervisorctl restart all
    • Per Docker:

      docker exec <containerID> supervisorctl restart all

      oppure riavvia l'intero container:

      docker restart <containerID>

Passaggio 2: specifica la stessa chiave segreta nelle impostazioni del connettore

Nelle impostazioni del connettore, specifica la stessa chiave segreta nel campo Secret key (Chiave segreta) e salva le impostazioni.

Come iniziare a usare ONLYOFFICE Docs in Liferay​

Per creare un file:

  1. Vai alla sezione Documents and Media.

  2. Fai clic sul pulsante Add File Add File (Aggiungi file).

  3. Nel menu aperto, fai clic sul pulsante Create with ONLYOFFICE.

    Create

  4. Nella pagina aperta, scegli il tipo di file e specifica il titolo e la descrizione (facoltativa).

  5. Fai clic sul pulsante Save (Salva).

    Create file

Per modificare un file:

  1. Trova il file necessario nella sezione Documents and Media.

  2. Fai clic sul documento.

  3. Nel menu aperto, fai clic sul pulsante Edit in ONLYOFFICE.

    Edit

Per creare un modulo PDF:

  1. Vai alla sezione Documents and Media.

  2. Fai clic sul pulsante Add File Add File (Aggiungi file).

  3. Nel menu aperto, fai clic sul pulsante Create with ONLYOFFICE.

    Create

  4. Nella pagina aperta, scegli il tipo di file PDF form (Modulo PDF).

  5. Fai clic sul pulsante Save (Salva).

note

Per saperne di più sui moduli, leggi gli articoli corrispondenti sulla creazione dei moduli.

note

Per saperne di più sui problemi più comuni e sui modi per risolverli, visita la nostra guida alla risoluzione dei problemi.