Olá, como podemos ajudar?

Pesquisas recentes: Realizar recolhimento de arquivo físico - Aprovar solicitação de arquivo físico - Realizar solicitação de arquivo físico - Configurar motivo de solicitação

Editar e visualizar arquivos eletrônicos com OneDrive

A configuração descrita neste artigo é aplicável à versão 3.0 do sistema. Para consultar a configuração de versões anteriores, clique aqui.

 

 

Pré-requisitos

  • Acesso ao menu Configuração > Parâmetros gerais (DC035).
  • Acesso ao menu Cadastro > Documento (DC003/DC010).
  • Usuário do Microsoft Entra ID com privilégio de Administrador Global.
  • Usuário do SoftExpert Documento com controle “Visualizar”, “Alterar” e “Salvar localmente” permitido na lista de segurança do documento.
  • Parâmetro Permitir download do arquivo original na consulta marcado na seção Geral do menu Configuração > Parâmetros gerais (DC035).
  • Documento em etapa de “Revisão” ou “Indexação”.

 

Apresentação

O componente Documento permite a utilização do Microsoft OneDrive para a edição e visualização de arquivos eletrônicos durante as etapas de revisão ou indexação.

Ao utilizar este recurso, o arquivo é aberto diretamente nos aplicativos do Office 365 (Word, Excel, PowerPoint, entre outros) e, após a conclusão da revisão, é automaticamente armazenado novamente no componente Documento.

Para habilitar essa funcionalidade, é necessária a integração da API do Microsoft 365 ao componente Documento, garantindo a edição posterior dos arquivos eletrônicos com o pacote Office.

A seguir, são apresentados os procedimentos necessários para utilizar este recurso.

 

Criar site no SharePoint da empresa

  • Para realizar os passos a seguir, é necessário ter uma conta Microsoft 365 com acesso ao SharePoint e permissão para criar sites na organização.
  • Recomendamos fortemente a criação de um novo site exclusivo para a integração. Esse site será utilizado para armazenar temporariamente os arquivos durante os processos de visualização e edição realizados pelo sistema.
  • Para garantir a segurança das informações, recomendamos que o site seja privado. A aplicação realizará automaticamente o controle de acesso, de acordo com as permissões do usuário e com a operação executada no SoftExpert Documento.
 

1. Acesse o SharePoint.

2. Faça login com sua conta Microsoft corporativa.

3. Clique em SharePoint, ou acesse diretamente: https://yourdomain.sharepoint.com.

4. Clique no botão + Criar site do canto superior esquerdo da tela.

5. Escolha o tipo de site desejado para a equipe.

6. Configure o site, preenchendo os seguintes campos:

  • Nome do site: insira o nome do seu site. Sugestão: SoftExpert Documento.
  • Descrição (opcional): descreva a finalidade do site. Sugestão: “Site destinado à integração com SoftExpert Documento.”
  • Privacidade: privado.
  • Endereço do site (URL): o SharePoint gera automaticamente o endereço do site (URL), mas é possível ajustá-lo se desejar.

7. Adicione os proprietários e membros do site (ou pule e adicione depois).

8. Clique em Concluir.

 

Configurar API do Microsoft 365

Parte 1: Registro Inicial do Aplicativo

1. Acesse o portal Microsoft Entra.

2. No painel lateral, navegue até Identidade > Aplicativos > Registros de aplicativo.

3. Selecione a opção Novo registro

4. Preencha os campos apresentados:

  • Nome: SoftExpert Documento
  • Tipos de conta com suporte: selecione a opção Contas somente neste diretório organizacional.
  • URL de redirecionamento (opcional): Selecione a opção Web e preencha o campo ao lado com http://localhost.

5. Clique em Registrar.

 

Parte 2: Configuração Básica e Coleta de IDs

1. Na tela “Visão geral” que será apresentada, copie os seguintes valores e guarde-os em local seguro, pois serão usados posteriormente:

  • ID do aplicativo (cliente)
  • ID do diretório (locatário)

2. Na seção Gerenciar do painel lateral, clique em Identidade visual e propriedades.

3. Preencha o campo URL da home page com http://localhost e clique em Salvar

4. Ainda na seção Gerenciar, clique em Proprietários.

5. Caso o seu usuário (ou o usuário de serviço apropriado) não apareça na listagem, selecione a opção Adicionar proprietários, localize e selecione o usuário desejado e clique no botão Selecionar.

 

Parte 3: Configuração de Permissões da API

1. No painel lateral, na seção Gerenciar, clique em Permissões de APIs.

2. Clique na permissão User.Read do Microsoft Graph. Ela será apresentada por padrão como delegada.

3. No painel que será apresentado, clique na opção Remover permissão e confirme a exclusão.

Se ocorrer o erro “Unable to complete due to service connection error, please try again later”, espere algumas horas e tente novamente.

 

4. Novamente na tela principal "Permissões de APIs", clique em Adicionar uma permissão.

5. No painel lateral, clique em Microsoft Graph.

6. Escolha a opção Permissões de aplicativo (Application permissions).

7. Na caixa de pesquisa, digite Sites.Selected.

8. Marque a opção Sites.Selected e clique no botão Adicionar permissões.

9. Após adicionar a permissão, clique no botão Conceder consentimento de administrador para [Seu Diretório] e confirme a ação.

 

Parte 4: Criação do Segredo do Cliente (Client Secret)

1. No painel lateral, na seção Gerenciar, clique em Certificados e segredos.

2. Na aba Segredos do cliente, clique em Novo segredo do cliente.

3. No painel que será apresentado, preencha os campos:

  • Descrição: informe um valor como “Admin” ou “SoftExpertDocumento_Secret”.
  • Expira em: selecione a opção 24 meses (ou o período desejado).

4. Clique em Adicionar

5. O segredo será apresentado na listagem. Copie o conteúdo da coluna Valor e guarde-o em local seguro, pois ele será usado posteriormente.

O valor do segredo do cliente é exibido uma única vez. Ao sair da tela sem copiar o valor, será necessário criar um novo segredo. 

 

 

Obter ID do site

Parte 1: Preparação - Autenticando no Graph Explorer

Antes de executar qualquer consulta, é necessário se autenticar e garantir que a ferramenta Graph Explorer tenha as permissões corretas para agir em nome do usuário conectado.

 

1. Acesse o Graph Explorer.

2. No canto superior direito, clique no ícone de Sign in (Entrar) e autentique-se com sua conta de administrador (Global Admin ou SharePoint Admin).

3. Após logar, clique na aba Modify permissions (Modificar permissões).

4. Na caixa de pesquisa, procure as seguintes permissões e clique em Consent:

  • Sites.Read.All (permissão para encontrar o site na parte 2)
  • Sites.Selected (permissão para conceder acesso ao seu APP na parte 3)

5. Na janela pop-up da Microsoft que será gerada ao clicar em Consent, confirme a permissão para o "Graph Explorer".

6. O Graph Explorer está pronto para ser usado.

 

Parte 2: Obter o ID do Site (Requisição GET)

1. Verifique se o método HTTP está definido como GET (é normalmente o padrão).

2. Na barra de consulta principal, insira a URL, substituindo os placeholders: https://graph.microsoft.com/v1.0/sites/{hostname}:/sites/{site-path}

  • {hostname}: O host da sua empresa no SharePoint. Exemplo: suaempresa.sharepoint.com).
  • {site-path}: O nome do seu site. Exemplo: nomedosite.

3. Clique em Run query (Executar consulta).

4. Na janela Response preview (Prévia da resposta) abaixo, será apresentado um JSON. Copie o valor inteiro do campo ID e guarde-o. O valor deve seguir o padrão suaempresa.sharepoint.com,xxxx-xxxx-xxxx,yyyy-yyyy-yyyy.

 

Parte 3: Conceder Permissão ao seu Aplicativo (Requisição POST)

1. Altere o método HTTP de GET para POST.

2. Na barra de consulta, insira a nova URL, substituindo o valor {siteId} pelo ID recentemente copiado: https://graph.microsoft.com/v1.0/sites/{siteId}/permissions

3. Abaixo da barra de consulta, clique na aba Request Headers (Cabeçalhos da Requisição).

4. Preencha os campos apresentados:

  • No campo Key, digite: Content-Type
  • No campo Value, digite: application/json

5. Clique em Add.

6. Clique na aba Request Body (Corpo da Requisição) ao lado. 

7. Cole o seguinte JSON no editor de texto, substituindo os placeholders com os dados do aplicativo que você criou na guia anterior:

{
  "roles": ["write"],
  "grantedToIdentities": [
    {      "application": {
        "id": "<client-id-do-seu-app>",
        "displayName": "<nome-do-seu-app>"
      }
    }
  ]
}
  • <client-id-do-seu-app>: substitua pelo “ID do aplicativo (cliente)” salvo anteriormente.
  • <nome-do-seu-app>: substitua pelo nome do seu aplicativo. Exemplo: “SotfExpert Documento”.

8. Revise se tudo está correto (URL do POST, Request Header e Request Body) e clique em Run query.

9. Se tudo der certo, será apresentado o status 201 Created e o JSON da permissão que acabou de ser criada na janela de resposta.

 

Configurar integração no componente Documento

1. Acesse o menu Configuração > Parâmetros gerais (DC035) e vá até a seção Microsoft 365.

2. Marque a opção Habilitar edição com Microsoft 365.

3. Preencha os campos necessários:

ID do locatário Informe o ID do diretório (locatário) obtido nas propriedades do aplicativo no Microsoft Entra.
ID do site Informe o ID do site do Microsoft SharePoint configurado.
Client ID Informe o ID do aplicativo (cliente) obtido durante a configuração do aplicativo no Microsoft Entra.
Client Secret Informe o valor do segredo do cliente obtido durante a configuração do aplicativo no Microsoft Entra.

4. Marque a opção Converter arquivo para PDF utilizando o Microsoft 365, se desejar. Com esta opção marcada, o sistema usará a integração com o Microsoft 365 para converter arquivos eletrônicos dos documentos para PDF, desde que na categoria do documento esteja configurada a publicação em PDF.

  • A API do o Microsoft 365 é compatível com arquivos com as seguintes extensões: .doc, .docx, .odt, .xls, .xlsx, .xlsm, .ods, .ppt, .pptx, .pps, .ppsx, .potm, .odp e .pdf.
  • Quando houver a troca do site, os arquivos permanecerão vinculados ao site antigo. Para não haver perda de informações, certifique-se que os documentos estão homologados antes de trocar o site.
  • Ao utilizar esta API, recursos como as marcas d'água não serão aplicados.
  • Se eventualmente os dados da integração forem alterados, os documentos com revisão em andamento (que se encontram armazenados temporariamente no site) terão as alterações perdidas.
 

 

Utilizar Microsoft 365 para editar e visualizar arquivos eletrônicos

1. Acesse o menu Cadastro > Documento (DC003) ou Documento (DC010).

2. Localize e selecione o documento desejado.

3. Clique no botão para editar o arquivo eletrônico, salvando as alterações ao sair.

4. Clique no botão para visualizar o arquivo eletrônico.

  • Se a opção Visualizar arquivo eletrônico com duplo clique estiver marcada na aba Geral dos parâmetros gerais, os arquivos poderão ser visualizados também ao dar um duplo clique sobre o documento ao qual eles pertencem. Essa opção não estará disponível se a situação do documento for “Emissão”.
  • É possível visualizar o arquivo eletrônico de forma rápida ao clicar no ícone apresentado na coluna AE. Se houverem mais de um arquivo eletrônico associado ao documento, uma tela será aberta com uma lista com todos os arquivos eletrônicos associados. Clique no arquivo que deseja e visualize-o.
  • Além do menu Cadastro > Documento (DC003), também é possível visualizar ou editar os arquivos eletrônicos pelo Microsoft 365 nos menus abaixo. Em outros menus, o arquivo será aberto pelo visualizador configurado na aba Aplicativo dos parâmetros gerais.
    • Execução > Revisão (DC016).
    • Minhas tarefas (execução) > Revisão de documento.
    • Minhas tarefas (acompanhamento) > Acompanhamento de revisão.
 

 

Conclusão

Desta forma, o Microsoft 365 foi integrado com sucesso e será possível editar e visualizar os arquivos eletrônicos com o pacote Office.


Este artigo foi útil?