Alfresco

Sobre a integração entre ONLYOFFICE e Alfresco

O ONLYOFFICE oferece um conector oficial para integrar o ONLYOFFICE Docs com o Alfresco para criar, editar e converter documentos de escritório dentro da biblioteca de documentos. Você pode baixar o conector ONLYOFFICE do diretório oficial de complementos do Alfresco ou da página do GitHub do ONLYOFFICE.

Para saber mais sobre o módulo ONLYOFFICE e Alfresco e como funciona em detalhes, visite nossa documentação da API.
Principais recursos
  • Criação, edição e visualização de documentos de texto, planilhas e apresentações.
  • Conversão de arquivos.
  • Co-edição de documentos em tempo real: dois modos de co-edição (Rápido e Estrito), o modo Controlar Alterações, comentários e o chat integrado.
  • Suporte JWT para proteger seu tráfego de modo que ninguém possa ter acesso aos seus documentos com a exceção dos usuários com os devidos direitos.
Formatos suportados
  • Para criação, edição e visualização: DOCX, PPTX, XLSX
  • Para trabalhar com formulários: PDF
  • Para conversão: ODT, ODP, ODS, DOC, XLS, PPT, RTF
  • Para edição através de conversão para OOXML: ODP, ODS, ODT, RTF, CSV, TXT
  • Para visualização apenas: PDF
Novidades na versão 8.1.0

Adicionado

  • Adicionado suporte a eventos no editor: onRequestReferenceData, onRequestReferenceSource, onRequestOpen

Alterado

  • Corrigido bug da configuração Ignorar Certificado SSL

O log de alterações completo está disponível aqui.

Conectando ONLYOFFICE Docs ao Alfresco Share

Requisitos
  • ONLYOFFICE Document Server v7.1 (servidor ou versão cloud) ou posterior

    Você precisa de uma instância do ONLYOFFICE Docs que seja resolvível e conectável tanto do Alfresco quanto de qualquer cliente final. Deve ser capaz de fazer POST para o Alfresco diretamente.

    Consulte a página de documentação oficial para saber mais sobre a instalação do ONLYOFFICE Docs.
  • Alfresco v.6.2 - 7.2
  • Conector ONLYOFFICE 7.0.0 para Alfresco
Instalando o pacote do módulo ONLYOFFICE e Alfresco

Os arquivos de pacote compilados mais recentes estão disponíveis no GitHub. Você precisa dos arquivos onlyoffice-integration-repo.jar e onlyoffice-integration-share.jar.

Instalando através de pacotes compilados
  1. Baixe os pacotes compilados nos diretórios repo e share: 
    cd onlyoffice-alfresco/
mvn clean install
  2. Carregue os pacotes *.jar compilados para os diretórios correspondentes à sua instalação do Alfresco:
    • de onlyoffice-alfresco/repo/target/ para /webapps/alfresco/WEB-INF/lib/ para o repositório Alfresco.
    • de onlyoffice-alfresco/share/target/ para /webapps/share/WEB-INF/lib/ para o Share .

  3. (Opcional) Edite o arquivo alfresco-global.properties para especificar os nomes de host corretos, abrir portas e protocolos pois o Alfresco e o Share são implantados como dois serviços separados. 

    
     alfresco.host=<hostname>
     alfresco.port=443
     alfresco.protocol=https
                
     share.host=<hostname>
     share.port=443
     share.protocol=https
  4. Reinicie o Alfresco. 
    sudo ./alfresco.sh stop
sudo ./alfresco.sh start
  5. Verifique se o módulo está presente na lista em /share/page/console/admin-console/module-package.
Instalando no Ubuntu

Para começar a usar o ONLYOFFICE Docs com o Alfresco, os seguintes passos devem ser executados para Ubuntu 24.04:

  1. Carregue os pacotes *.amp compilados para os diretórios correspondentes à sua instalação do Alfresco:
    • de onlyoffice-alfresco/repo/target/ para /usr/local/tomcat/amps/ para o repositório Alfresco,
    • de onlyoffice-alfresco/share/target/ para /usr/local/tomcat/amps_share/ para o Share.
  2. Você pode baixar os arquivos de pacote já compilados aqui e colocá-los nos respectivos diretórios.

    Use a Ferramenta de Gerenciamento de Módulos (MMT) para instalar módulos, execute estes comandos:

    • Alfresco
      java -jar /usr/local/tomcat/alfresco-mmt/alfresco-mmt.jar install /usr/local/tomcat/amps/onlyoffice-integration-repo.amp /usr/local/tomcat/webapps/alfresco
    • Share
      java -jar /usr/local/tomcat/alfresco-mmt/alfresco-mmt.jar install /usr/local/tomcat/amps_share/onlyoffice-integration-share.amp /usr/local/tomcat/webapps/share

    Mais detalhes sobre o uso do MMT podem ser encontrados no guia de instalação do Alfresco.

  3. Certifique-se de que o Document Server conseguirá fazer POST para o Alfresco.

    Você pode precisar alterar estas linhas no alfresco-global.properties ou pode configurá-lo usando a página de configuração: 

    
    alfresco.host=<hostname>
    alfresco.port=443
    alfresco.protocol=https
    
    share.host=<hostname>
    share.port=443
    share.protocol=https
  4. Reinicie o Alfresco: 
    sudo ./alfresco.sh stop sudo ./alfresco.sh start

O módulo pode ser verificado nas ferramentas do administrador em /share/page/console/admin-console/module-package no Alfresco.

Compilando o pacote do módulo ONLYOFFICE Alfresco

Se você planeja compilar o pacote do módulo ONLYOFFICE Alfresco por conta própria (por exemplo, editar o código-fonte e compilá-lo depois), siga estes passos:

  1. A versão estável mais recente do Oracle Java é necessária para uma compilação bem-sucedida. Se você não tiver instalada, use os seguintes comandos para instalar o Oracle Java 8: 
    sudo apt-get update sudo apt-get install openjdk-8-jdk
  2. Instale o Maven mais recente. O processo de instalação está descrito no guia oficial do Maven.
  3. Baixe o código-fonte do pacote do módulo ONLYOFFICE Alfresco: 
    git clone https://github.com/ONLYOFFICE/onlyoffice-alfresco.git
  4. Obtenha um submódulo: 
    git submodule update --init --recursive
  5. Compile os pacotes nos diretórios repo e share: 
    cd onlyoffice-alfresco && mvn clean install

Outra maneira de compilar o pacote do módulo ONLYOFFICE Alfresco é usando o arquivo docker-compose.

Use este comando do diretório do projeto:

docker-compose up
Configurando o pacote do módulo ONLYOFFICE e Alfresco

Vá para o Console de Administração do Alfresco. Abra http://<alfrescohost>/alfresco/s/onlyoffice/onlyoffice-config e especifique os seguintes parâmetros.

configurações:

  • Endereço do Serviço de Edição de Documentos - especifique o endereço URL onde o Serviço de Edição de Documentos está instalado.
    Importante O endereço do ONLYOFFICE Docs deve estar acessível do Alfresco, assim como o endereço do Alfresco deve estar acessível do ONLYOFFICE Docs.
  • Chave Secreta - especifique o segredo usado para assinar os dados.
    A partir do ONLYOFFICE Docs v7.2, o JWT está habilitado por padrão e a chave secreta é gerada automaticamente. Você precisa habilitá-lo no lado do Alfresco também: encontre sua chave secreta no arquivo de configuração do ONLYOFFICE Docs, depois especifique a mesma chave secreta nas configurações do conector. Para mais detalhes, veja a seção Habilitando JWT para a integração ONLYOFFICE e Alfresco deste artigo.

Configurações avançadas do servidor:

  • Endereço do Serviço de Edição de Documentos para solicitações internas do servidor Alfresco - especifique o endereço usado para acessar o Serviço de Edição de Documentos do servidor Alfresco.
  • Endereço do servidor Alfresco para solicitações internas do Serviço de Edição de Documentos - especifique o endereço usado para acessar o servidor Alfresco do Serviço de Edição de Documentos.
  • Cabeçalho de autorização (deixe em branco para usar o cabeçalho padrão) - O cabeçalho JWT de autorização usado no ONLYOFFICE é Authorization. Caso este cabeçalho esteja em conflito com sua configuração, você pode alterar o cabeçalho para um personalizado.

Configurações comuns:

  • Ignorar Certificado SSL - desativa o SSL.
  • Habilitar Force Save - habilita salvar alterações do documento diretamente no armazenamento do Alfresco após clicar no botão Salvar (se desabilitado, o documento é salvo no cache do editor de documentos até o documento ser fechado).
  • Salvar docx, xlsx, pptx como uma nova versão do arquivo original após conversão - se desabilitado, um arquivo separado será criado e colocado na mesma pasta.
  • Abrir o arquivo para edição - permite aos administradores escolher os formatos de documento para editar através de conversão para formatos OOXML.
  • Após fechar o editor, salvar o documento como uma versão menor - determina se as versões do documento são salvas como versões principais (2.0, 3.0) após fechar ou como versões menores (1.1, 1.2) durante a edição, com 1.0 como o documento vazio inicial.
Você também pode adicionar onlyoffice.url ao alfresco-global.properties. A configuração feita através da página de configurações substituirá o alfresco-global.properties.
Menu_configuracoesMenu_configuracoes
Como funciona

A integração ONLYOFFICE segue a API documentada aqui.

  1. O usuário navega para um documento no Alfresco Share e seleciona a opção de menu Editar no ONLYOFFICE.
  2. O Alfresco Share faz uma solicitação para o extremo do repo (URL da forma: /parashift/onlyoffice/prepare?nodeRef={nodeRef}).
  3. O extremo do Repo Alfresco prepara um objeto JSON para o Share com as seguintes propriedades:
    • url - a URL que o ONLYOFFICE Docs usa para baixar o documento (inclui o alf_ticket do usuário atual);
    • callbackUrl - a URL que o ONLYOFFICE Docs informa sobre o status da edição do documento;
    • onlyofficeUrl - a URL que o cliente precisa para responder ao ONLYOFFICE Docs (fornecida pela propriedade onlyoffice.url);
    • key - o UUID+Timestamp Modificado para instruir o ONLYOFFICE Docs se deve baixar o documento novamente ou não;
    • title - o título (nome) do documento.
  4. O Alfresco Share pega esse objeto e constrói uma página a partir de um template freemarker, preenchendo todos esses valores para que o navegador cliente possa carregar o editor.
  5. O navegador cliente faz uma solicitação para a biblioteca JavaScript do ONLYOFFICE Docs e envia para o ONLYOFFICE Docs a configuração DocEditor com as propriedades acima.
  6. Então o ONLYOFFICE Docs baixa o documento do Alfresco e o usuário começa a editar.
  7. O ONLYOFFICE Docs envia uma solicitação POST para callbackUrl para informar ao Alfresco que um usuário está editando o documento.
  8. O Alfresco bloqueia o documento, mas ainda permite que outros usuários com acesso de escrita colaborem em tempo real com o ONLYOFFICE Docs mantendo a Ação presente.
  9. Quando todos os usuários e navegadores clientes terminam de editar, eles fecham a janela de edição.
  10. Após 10 segundos de inatividade, o ONLYOFFICE Docs envia um POST para callbackUrl informando ao Alfresco que os clientes terminaram de editar o documento e o fecharam.
  11. O Alfresco baixa uma nova versão do documento, substituindo a antiga.
Habilitando JWT para a integração ONLYOFFICE e Alfresco

Para proteger documentos de acesso não autorizado, os editores ONLYOFFICE usam o JSON Web Token (JWT). O token é adicionado na configuração quando o Editor de Documentos é inicializado e durante a troca de comandos entre os serviços internos do ONLYOFFICE Docs. A chave secreta é usada para assinar o token web JSON e validar o token mediante solicitação ao ONLYOFFICE Docs.

A partir do ONLYOFFICE Docs v7.2, o JWT está habilitado por padrão e a chave secreta é gerada automaticamente. Você precisa encontrar sua chave secreta no arquivo de configuração do ONLYOFFICE Docs, depois especificar a mesma chave secreta nas configurações do conector.

Passo 1: Encontre sua chave secreta no arquivo de configuração do ONLYOFFICE Docs

  1. Abra o arquivo local.json com qualquer editor de texto disponível.
    • Para Linux - /etc/onlyoffice/documentserver/local.json
    • Para Windows - %ProgramFiles%\ONLYOFFICE\DocumentServer\config\local.json
    • Para Docker - acesse o container ONLYOFFICE Docs usando o comando docker exec -it <containerID> bash e abra /etc/onlyoffice/documentserver/local.json

      Alternativamente, você pode usar o seguinte comando para encontrar a chave secreta padrão sem abrir o local.json: 

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

    O arquivo local.json deve ficar assim:

    {"services": {"CoAuthoring": {"token": {"enable": {"request": {"inbox": true,"outbox": true},"browser": true}},"secret": {"inbox": {"string": "yoursecret"},"outbox": {"string": "yoursecret"},"session": {"string": "yoursecret"}}}}}
  2. O valor true é especificado em três seções. Isso significa que a validação de token está habilitada.
    • services.CoAuthoring.token.enable.browser
    • services.CoAuthoring.token.enable.request.inbox
    • services.CoAuthoring.token.enable.request.outbox
  3. A chave secreta gerada automaticamente é especificada em três seções. Você pode substituir o valor secreto padrão pela sua própria chave secreta. A chave secreta deve ser a mesma nas três seções.
    • services.CoAuthoring.secret.inbox.string
    • services.CoAuthoring.secret.outbox.string
    • services.CoAuthoring.secret.session.string
  4. Se você fizer alterações, salve-as e reinicie os serviços para que as mudanças de configuração tenham efeito. 
    supervisorctl restart all

Passo 2: Especifique a mesma chave secreta nas configurações do conector

Nas configurações do conector, especifique o mesmo segredo no campo Chave secreta e salve as configurações.

Conectando ao ONLYOFFICE Docs de demonstração

A partir da versão 5.0.0 do conector ONLYOFFICE, você pode testar os editores online do ONLYOFFICE no Alfresco sem instalar o ONLYOFFICE Docs.

Para ativar a conexão, marque a caixa Conectar ao servidor de demonstração ONLYOFFICE Document Server e clique no botão Salvar.

ImportanteEste é um servidor de teste público que estará disponível durante um período de 30 dias. Não compartilhe seus dados confidenciais lá.

Começar a usar ONLYOFFICE Docs no Alfresco

Para criar um documento:

  1. Abra a pasta onde você deseja criar um documento.
  2. Clique no botão Criar....
  3. Escolha o tipo de arquivo que você deseja criar: Documento, Planilha ou Apresentação.
menu_novomenu_novo

Para editar ou visualizar um documento:

  1. Encontre o documento necessário.
  2. Clique no botão Editar no ONLYOFFICE.
menu_editarmenu_editar

Para converter um documento não-XML para formato XML (DOCX, XLSX ou PPTX):

  1. Encontre o documento necessário.
  2. Clique no botão Converter usando ONLYOFFICE.

O documento será automaticamente convertido para seu análogo XML. Os arquivos resultantes são colocados na mesma pasta. Você também pode configurar regras de conversão automática para uma pasta. Para mais informações sobre a configuração de regras, leia a documentação oficial do Alfresco.

menu_convertermenu_converter

Para baixar o arquivo em um formato preferido:

  1. Encontre o arquivo necessário.
  2. Clique no botão Baixar como... e escolha o formato que você precisa.
menu_baixarmenu_baixar

Para ver o histórico de alterações do arquivo:

  1. Clique no nome do arquivo ou em seu ícone para abrir a aba de detalhes do arquivo.
  2. Encontre a aba Histórico de Versões no painel direito.
  3. As seções disponíveis são: Versão Mais Recente e Versões Antigas. As alterações feitas no arquivo serão destacadas.
  4. Para carregar uma nova versão, clique no ícone correspondente no canto superior direito.
  5. Para ver rapidamente a versão atual do arquivo, passe o ponteiro do mouse sobre o arquivo. O número da versão será exibido à direita do nome do arquivo, por exemplo .

propriedades

ou

  1. Vá para a aba Arquivo no editor.
  2. Escolha a opção Histórico de Versões no menu.

Para criar um novo arquivo diretamente no Editor de Documentos:

  1. Abra a aba Arquivo.
  2. Clique na opção Criar Novo.

Um novo arquivo .docx será aberto em uma nova aba.

Para criar modelos personalizados:

  1. Faça login no seu portal Alfresco como administrador que o criou.
  2. Vá para Meus arquivos → Dicionário de Dados → Modelos de Nó.
  3. Adicione modelos personalizados nos formatos disponíveis: .docx, .xlsx, .pptx.
criar_modelocriar_modelo

Para criar documentos a partir de modelos:

  1. Abra a pasta onde você deseja criar um documento.
  2. Clique no botão Criar....
  3. Selecione a opção Criar documento a partir de modelo e escolha um dos modelos disponíveis.
    criar_do_modelocriar_do_modelo

    ou

  1. No editor, vá para a aba Arquivo.
  2. Clique na opção Criar Novo....
  3. Escolha o modelo necessário.
    criar_do_modelo_editorcriar_do_modelo_editor

Para aprender como comparar arquivos do armazenamento, siga as instruções deste artigo.

comparar_arquivoscomparar_arquivos

Para aprender como usar mala direta do armazenamento, siga as instruções deste artigo.

mala_diretamala_direta

Para aprender como inserir imagens do armazenamento, siga as instruções deste artigo.

inserir_imagensinserir_imagens

Para aprender como marcar o documento como favorito diretamente no Editor de Documentos, siga as instruções deste artigo.

marcar_favmarcar_fav

Host ONLYOFFICE Docs on your own server or use it in the cloud

Get it nowUse in the cloud
Article with the tag:
Browse all tags