Ana içeriğe geç

Liferay

ONLYOFFICE ve Liferay entegrasyonu hakkında​

ONLYOFFICE, ONLYOFFICE Docs'u Liferay ile entegre etmek ve ofis belgelerini Liferay Document and Media Library içinde düzenlemek için resmi bir bağlayıcı sunar. ONLYOFFICE bağlayıcısını Liferay Marketplace veya GitHub sayfasından indirebilirsiniz. Bağlayıcı Apache lisansı altında dağıtılır.

not

Liferay için ONLYOFFICE bağlayıcısının nasıl çalıştığı hakkında daha fazla bilgi için API belgeleri sayfasını ziyaret edin.

Ana özellikler​

  • Create with ONLYOFFICE menü seçeneğini kullanarak dosya oluşturma.
  • Çevrimiçi formlar oluşturma ve doldurma.
  • Documents and Media bölümündeki ONLYOFFICE Edit/View menü seçeneğini kullanarak mevcut metin belgelerini, e-tabloları veya sunumları görüntüleme ve düzenleme.
  • Belgeleri gerçek zamanlı olarak birlikte düzenleme: iki ortak düzenleme modu (Hızlı ve Katı), Değişiklikleri İzle, yorumlar ve yerleşik sohbet.
  • Trafiğinizi korumak için JWT desteği: belgelerinize yalnızca uygun haklara sahip kullanıcılar erişebilir.

Desteklenen formatlar​

  • Görüntüleme için:
    • 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
  • Düzenleme için:
    • WORD: DOCM, DOCX, DOTM, DOTX
    • CELL: XLSB, XLSM, XLSX, XLTM, XLTX
    • SLIDE: POTM, POTX, PPSM, PPSX, PPTM, PPTX
    • PDF: PDF
  • Office Open XML formatlarına dönüştürme için:
    • 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

3.1.0 sürümündeki yenilikler​

Eklenenler

  • ONLYOFFICE Docs v9.1.0 desteği

Değişenler

  • com.onlyoffice:docs-integration-sdk sürümü güncellendi
    • yeni desteklenen formatlar: .vsdx, .md, .odg, .xlsb, Apple iWork, .hwp, .hwpx, .mht
    • yeni belge türü eklendi: DIAGRAM
    • boş dosya şablonları genişletildi

Değişikliklerin tam listesine buradan ulaşabilirsiniz.

ONLYOFFICE Docs'u Liferay'e bağlama​

Gereksinimler​

  • ONLYOFFICE Document Server v6.1.0 (sunucu veya bulut sürümü) veya üzeri.

    Hem Liferay'den hem de tüm son istemcilerden çözümlenebilen ve erişilebilen bir ONLYOFFICE Docs örneğine ihtiyacınız vardır. Örneğin doğrudan Liferay'e POST isteği gönderebilmesi gerekir.

    not

    ONLYOFFICE Docs'un kurulumu hakkında daha fazla bilgi için resmi belgeler sayfasına bakın.

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

  • Liferay için ONLYOFFICE Bağlayıcısı v2.2.0.

Liferay için ONLYOFFICE bağlayıcısını kurma​

ONLYOFFICE bağlayıcısını App Manager ile kurabilirsiniz.

App Manager ile kurmak için:

  1. Control Panel > System > App Manager yolunu izleyin.
  2. Options Options düğmesine tıklayın.
  3. Upload düğmesine tıklayın.
  4. Açılan pencerede ONLYOFFICE uygulama dosyasını seçin.

Kurulum tamamlandığında uygulama kullanıma hazırdır.

Bağlayıcıyı kendiniz derliyorsanız, build\libs klasöründeki derlenmiş .jar dosyasını /opt/liferay/deploy klasörüne koymanız yeterlidir. Liferay dosyayı otomatik olarak kuracaktır.

not

Marketplace'ten indirilen dosyalar .lpkg formatında sunulur. İlgili .jar dosyasını almak için bir .lpkg paketini açabilirsiniz. Çıkarılan .jar dosyası daha sonra App Manager üzerinden dağıtılabilir.

Liferay için ONLYOFFICE bağlayıcısını derleme​

gradle build komutunu çalıştırmanız yeterlidir. Çıktı olan .jar dosyası build/libs klasörüne yerleştirilir.

Liferay için ONLYOFFICE bağlayıcısını yapılandırma​

Control Panel > Configuration > System Settings yolunu izleyin. Platform bölümünde Connectors kategorisini seçin ve ONLYOFFICE'i seçin.

Burada aşağıdaki ayarları yapılandırabilirsiniz:

  • ONLYOFFICE Docs address - Belge Düzenleme Hizmeti'nin kurulu olduğu URL adresini belirtin.

    not

    ONLYOFFICE Docs adresi Liferay'den erişilebilir olmalıdır, aynı şekilde Liferay adresi de ONLYOFFICE Docs'tan erişilebilir olmalıdır.

  • ONLYOFFICE Docs address for internal requests from the server - Liferay'den Belge Düzenleme Hizmeti'ne erişmek için kullanılan adresi belirtin.

  • Server address for internal requests from ONLYOFFICE Docs - Belge Düzenleme Hizmeti'nden Liferay'e erişmek için kullanılan adresi belirtin.

  • Secret key - verileri imzalamak için kullanılan gizli anahtarı belirtin.

    not

    ONLYOFFICE Docs v7.2 sürümünden itibaren JWT varsayılan olarak etkindir ve gizli anahtar otomatik olarak oluşturulur. JWT'yi Liferay tarafında da etkinleştirmeniz gerekir: gizli anahtarınızı ONLYOFFICE Docs yapılandırma dosyasında bulun, ardından aynı gizli anahtarı bağlayıcı ayarlarında belirtin. Daha fazla bilgi için bu makalenin ONLYOFFICE ve Liferay entegrasyonu için JWT'yi etkinleştirme bölümüne bakın.

  • Authorization header (varsayılan başlığı kullanmak için boş bırakın) - ONLYOFFICE'te kullanılan yetkilendirme JWT başlığı Authorization'dır. Bu başlık kurulumunuzla çakışırsa, başlığı özel bir başlıkla değiştirebilirsiniz.

  • Enable Force Save - düzenleme sırasında ara belge sürümlerini saklamak için onay kutusunu etkinleştirin.

  • Enable ONLYOFFICE Web Preview - dosya önizlemesini etkinleştirmek için onay kutusunu etkinleştirin.

Configuration

Entegrasyon uygulamasını yapılandırdıktan sonra değişiklikleri uygulamak için Save düğmesine tıklayın.

Nasıl çalışır​

ONLYOFFICE entegrasyonu burada açıklanan API'yi izler.

  1. Kullanıcı Liferay içinde Documents and Media bölümüne gider ve Edit in ONLYOFFICE eylemini seçer.
  2. Liferay, Document Server için aşağıdaki özelliklere sahip bir JSON nesnesi hazırlar:
    • url: ONLYOFFICE Docs'un belgeyi indirmek için kullandığı URL;
    • callbackUrl: ONLYOFFICE Docs'un belge düzenleme durumunu bildirmek için kullandığı URL;
    • key: ONLYOFFICE Docs'a belgeyi yeniden indirip indirmeyeceğini bildiren fileVersionId;
    • title: belge başlığı (adı).
  3. İstemci tarayıcısı ONLYOFFICE Docs'un JavaScript kitaplığına istek gönderir ve yukarıdaki özellikleri içeren DocEditor yapılandırmasını ONLYOFFICE Docs'a iletir.
  4. Ardından ONLYOFFICE Docs belgeyi Liferay'den indirir ve kullanıcı düzenlemeye başlar.
  5. ONLYOFFICE Docs, bir kullanıcının belgeyi düzenlediğini Liferay'e bildirmek için callbackUrl adresine POST isteği gönderir.
  6. Liferay belgeyi kilitler, ancak Action öğesini görünür bırakarak yazma erişimi olan diğer kullanıcıların ONLYOFFICE Docs ile gerçek zamanlı olarak birlikte çalışmasına izin vermeye devam eder.
  7. Tüm kullanıcılar ve istemci tarayıcıları düzenlemeyi bitirdiğinde düzenleme penceresini kapatır.
  8. 10 saniyelik hareketsizlikten sonra ONLYOFFICE Docs, istemcilerin belgeyi düzenlemeyi bitirip kapattığını Liferay'e bildirmek için callbackUrl adresine POST isteği gönderir.
  9. Liferay belgenin yeni sürümünü indirir ve eskisinin yerine koyar.

ONLYOFFICE ve Liferay entegrasyonu için JWT'yi etkinleştirme​

Belgeleri yetkisiz erişime karşı korumak için ONLYOFFICE düzenleyicileri JSON Web Token (JWT) kullanır. Token, Belge Düzenleyici başlatılırken yapılandırmaya ve ONLYOFFICE Docs'un iç hizmetleri arasındaki komut alışverişi sırasında eklenir. Gizli anahtar, JSON web token'ı imzalamak ve ONLYOFFICE Docs'a gelen istekte token'ı doğrulamak için kullanılır.

ONLYOFFICE Docs v7.2 sürümünden itibaren JWT varsayılan olarak etkindir ve gizli anahtar otomatik olarak oluşturulur. Gizli anahtarınızı ONLYOFFICE Docs yapılandırma dosyasında bulmanız, ardından aynı gizli anahtarı bağlayıcı ayarlarında belirtmeniz gerekir.

Adım 1: Gizli anahtarınızı ONLYOFFICE Docs yapılandırma dosyasında bulun

  1. local.json dosyasını herhangi bir metin düzenleyiciyle açın.

    • Linux için - /etc/onlyoffice/documentserver/local.json

    • Windows için - %ProgramFiles%\ONLYOFFICE\DocumentServer\config\local.json

    • Docker için – docker exec -it <containerID> bash komutuyla ONLYOFFICE Docs kapsayıcısına girin ve /etc/onlyoffice/documentserver/local.json dosyasını açın

      Alternatif olarak, local.json dosyasını açmadan varsayılan gizli anahtarı bulmak için aşağıdaki komutu kullanabilirsiniz:

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

    local.json dosyası şöyle görünmelidir:

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

  2. true değeri üç bölümde belirtilmiştir. Bu, token doğrulamasının etkin olduğu anlamına gelir.

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

  3. Otomatik olarak oluşturulan gizli anahtar üç bölümde belirtilmiştir. Varsayılan gizli değeri kendi gizli anahtarınızla değiştirebilirsiniz. Gizli anahtar üç bölümde de aynı olmalıdır.

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

  4. Değişiklik yaparsanız, kaydedin ve yapılandırma değişikliklerinin geçerli olması için hizmetleri yeniden başlatın.

    • Linux için:

      sudo supervisorctl restart all

    • Docker için:

      docker exec <containerID> supervisorctl restart all

      veya kapsayıcının tamamını yeniden başlatın:

      docker restart <containerID>

Adım 2: Aynı gizli anahtarı bağlayıcı ayarlarında belirtin

Bağlayıcı ayarlarında Secret key alanına aynı gizli anahtarı girin ve ayarları kaydedin.

Liferay içinde ONLYOFFICE Docs'u kullanmaya başlama​

Dosya oluşturmak için:

  1. Documents and Media bölümüne gidin.

  2. Add File Add File düğmesine tıklayın.

  3. Açılan menüde Create with ONLYOFFICE düğmesine tıklayın.

    Create

  4. Açılan sayfada dosya türünü seçin, başlığını ve isteğe bağlı olarak açıklamasını girin.

  5. Save düğmesine tıklayın.

    Create file

Dosyayı düzenlemek için:

  1. Documents and Media bölümünde gerekli dosyayı bulun.

  2. Belgeye tıklayın.

  3. Açılan menüde Edit in ONLYOFFICE düğmesine tıklayın.

    Edit

PDF formu oluşturmak için:

  1. Documents and Media bölümüne gidin.

  2. Add File Add File düğmesine tıklayın.

  3. Açılan menüde Create with ONLYOFFICE düğmesine tıklayın.

    Create

  4. Açılan sayfada PDF form dosya türünü seçin.

  5. Save düğmesine tıklayın.

not

Formlar hakkında daha fazla bilgi için form oluşturma makalelerine bakın.

not

En sık karşılaşılan sorunlar ve çözüm yolları hakkında daha fazla bilgi için sorun giderme kılavuzumuzu ziyaret edin.