Use os rótulos de retenção para gerenciar o ciclo de vida dos documentos armazenados no SharePoint.

Descrição do serviço Microsoft Purview

Este artigo mostra como gerenciar o ciclo de vida de documentos do SharePoint usando rótulos de retenção aplicados automaticamente e retenção baseada em eventos.

O recurso de aplicação automática usa metadados do SharePoint para classificação de documentos. O exemplo neste artigo é para documentos relacionados a produtos, mas você pode aplicar os mesmos conceitos a outros cenários. Por exemplo, no setor de petróleo e gás, você pode usá-lo para gerenciar o ciclo de vida dos documentos sobre ativos físicos, como plataformas de petróleo, registros de poços ou licenças de produção. No setor de serviços financeiros, você poderia gerenciar conta bancária, hipoteca ou documentos de contratos de seguro. No setor público, você poderia gerenciar autorizações de construção ou formulários de imposto.

Este artigo examina a arquitetura de informações e a definição dos rótulos de retenção, classifica documentos aplicando automaticamente os rótulos e gera os eventos que iniciam o período de retenção.

Arquitetura de informações

Nosso cenário é uma empresa de manufatura que usa o SharePoint para armazenar todos os documentos sobre os produtos que a empresa desenvolve. Esses documentos incluem as especificações do produto, acordos com fornecedores e manuais de usuário. Ao armazenar esses documentos no SharePoint por meio de políticas de gerenciamento de conteúdo empresarial, você define metadados para classificá-los. Cada documento tem as seguintes propriedades de metadados:

  • Tipo de documento (especificação do produto, contrato ou manual do usuário)

  • Nome do produto (widget giratório, widget voador, widget de rastreamento)

  • Status (rascunho ou final)

Esses metadados formam uma base do tipo de conteúdo chamado de Documento de Produção para todos os documentos.

Tabela que mostra as propriedades de metadados da documentação do produto.

Observação

As propriedades Tipo de Documento e Status são usadas posteriormente neste cenário para classificar e aplicar automaticamente rótulos de retenção.

Podemos ter vários tipos de conteúdo que representam diferentes tipos de documentos. Este cenário se concentra na documentação do produto.

Aqui, usamos o serviço de Metadados Gerenciados e o Repositório de Termos para criar um conjunto de termos para Tipo de Documento e Nome do Produto. Para cada conjunto de termos, criamos um termo para cada valor. O resultado é semelhante a este no Repositório de Termos para nossa organização do SharePoint:

Captura de tela do exemplo de conjunto de termos para documentação do produto no Repositório de Termos.

Tipo de Conteúdo pode ser criado e publicado pelo uso do Hub de Tipo de Conteúdo. Você também pode criar e publicar um tipo de conteúdo pelo uso de ferramentas de provisionamento de site, como a estrutura de provisionamento PnP ou esquema JSON de design de site.

Cada produto tem um site dedicado do SharePoint que contém uma biblioteca de documentos que tem os corretos tipos de conteúdo habilitados. Todos os documentos são armazenados na biblioteca de documentos.

Captura de tela da biblioteca de documentos para documentação do produto.

Observação

Neste artigo, focamos em documentos e usamos um site, mas a empresa de fabricação nesse cenário poderia usar uma equipe do Microsoft Teams por produto para dar suporte a atividades de colaboração, como chat persistente e usar a guia Files no Teams para gerenciamento de documentos.

Uma visualização da biblioteca de documentos do produto Spinning Widget:

Captura de tela da biblioteca de documentos do Widget Giratório.

Com a arquitetura de informações básica em vigor para o gerenciamento de documentos, examine a estratégia de retenção e descarte dos documentos que usam os metadados e como eles são classificados.

Retenção e disposição

As políticas de conformidade e de governança de dados da empresa de manufatura ditam como os dados são preservados e descartados. Os documentos relacionados ao produto devem ser mantidos enquanto o produto for fabricado e retidos por um período de tempo depois. O período de retenção é diferente para especificações do produto, contratos e manuais de usuário. A tabela a seguir indica os requisitos de retenção e descarte:

Tipo de documento Retenção Requisitos de disposição
Especificações do produto 5 anos após o fim da produção Excluir
Contratos de produtos 10 anos após o fim da produção Analisar
Manuais do usuário 5 anos após o fim da produção Excluir
Todos os outros tipos de documentos Não reter ativamente Exclua quando o documento tiver mais de 3 anos.

Um documento é considerado mais velho do que 3 anos se não tiver sido modificado nos últimos 3 anos.

O portal do Microsoft Purview é usado para criar os seguintes rótulos de retenção:

  • Especificação do Produto

  • Contrato de produto

  • Manual de usuário

Neste artigo, mostramos como criar e aplicar automaticamente o rótulo de retenção de Especificação do produto. Para implementar o cenário completo, crie e aplique automaticamente rótulos de retenção para os outros dois tipos de documentos.

Configurações para a etiqueta de retenção da Especificação do Produto

O plano de arquivo para o rótulo de retenção de Especificação do produto:

  • Nome: Especificação do Produto

  • Descrição para usuários: Reter por 5 anos após o fim da produção.

  • Descrição para administradores: Reter por 5 anos após o fim da produção, exclusão automática, retenção baseada em evento, e o tipo de evento é Cessação do Produto.

  • Ação de retenção: Reter e excluir.

  • Duração da retenção: 5 anos (1,825 dias).

  • Rótulo do registro: Configure o rótulo de retenção para marcar itens como um registro, o que significa que os usuários não podem modificar ou excluir os documentos rotulados.

  • Descritores de plano de arquivo: Para simplificar o cenário, nenhum descritor de arquivo opcional é fornecido.

O exemplo a seguir mostra um resumo das configurações de rótulo quando você cria o rótulo de retenção de Especificação de Produto no portal do Microsoft Purview. Você pode criar o tipo de evento Cessação do produto antes de criar o rótulo de retenção ou durante o processo de criação do rótulo de retenção.

Captura de tela das configurações de retenção do rótulo de Especificação do produto.

Observação

Se você estiver recriando esse cenário em um ambiente de teste, defina a duração de retenção como um período de tempo mais curto para evitar uma espera de cinco anos pela exclusão do documento.

Criar um tipo de evento quando você criar um rótulo de retenção

Para criar um tipo de evento durante o processo de criação do rótulo de retenção, siga estas etapas:

  1. Na página Definir o período de retenção do fluxo de trabalho do rótulo de retenção, após Iniciar o período de retenção com base em, selecione Criar novo tipo de evento:

    Captura de tela da caixa de diálogo Criar um novo tipo de evento para o rótulo de Especificação do Produto.

  2. Na página Nomear o tipo de evento, digite Cessação do Produto e uma descrição opcional. Em seguida, selecione Próximo, Enviar, e Concluído.

  3. De volta à página Definir o período de retenção , para Iniciar o período de retenção com base em, use a caixa suspensa para selecionar o tipo de evento Cessação do produto que você criou.

A próxima seção mostra como aplicar automaticamente o rótulo de retenção ao conteúdo da especificação do produto.

Aplicação automática de rótulos de retenção

Use a linguagem QL por palavra-chave (KQL) para aplicar automaticamente os rótulos de retenção que você criou. KQL é a linguagem usada para criar consultas de pesquisa. Na KQL, você pode pesquisar usando as palavras-chave ou as propriedades gerenciadas. Para mais informações, confira Referência de sintaxe da Linguagem de Consulta de Palavra-chave (KQL).

Configure o esquema de pesquisa para que o Microsoft 365 aplique o rótulo de retenção de Especificação do Produto a todos os documentos que tenham um Status de Final e um Tipo de Doc de Especificação do Produto. Lembre-se de que Status e Tipo de Documento são as colunas de site que definimos para o tipo de conteúdo de Documentação do Produto na seção Arquitetura de Informação.

Quando o SharePoint indexa conteúdo, ele gera automaticamente propriedades rastreadas para cada coluna de site. Neste cenário, estamos interessados nas propriedades Tipo de documento e Status. Precisamos de documentos na biblioteca que são do tipo de conteúdo correto e tenham as colunas de site preenchidas na pesquisa para assim criar as propriedades rastreadas.

No centro de administração do SharePoint, abra a configuração de Pesquisa e selecione Gerenciar Esquema de Pesquisa para configurar as propriedades rastreadas.

Captura de tela das propriedades rastreadas na configuração do esquema de pesquisa.

Execute uma pesquisa de status usando o filtro Propriedades rastreadas. Isso mostra os resultados que incluem "status" no campo de nome da propriedade:

Captura de tela da propriedade ows_Status rastreada nos resultados da pesquisa.

O exemplo anterior mostra a propriedade ows__Status (observe o sublinhado duplo). Essa propriedade é mapeada para a propriedade Status do tipo de conteúdo Documento de Produção usado nesse cenário.

Execute uma pesquisa por ows_doc usando o filtro de propriedades rastreadas . Isso mostra os resultados que incluem "ows_doc" no campo de nome da propriedade:

Captura de tela da propriedade ows_Doc_Type rastreada nos resultados da pesquisa.

Os resultados da pesquisa mostram a propriedade ows_Doc_x0020_Type . Essa propriedade é mapeada para a propriedade Doc Type do tipo de conteúdo Documento de Produção usado neste cenário.

Dica

Para identificar o nome de uma propriedade rastreada para este cenário:

  1. Acesse a biblioteca de documentos que contém os documentos de produção.
  2. Vá para as configurações da biblioteca.
  3. Para Colunas, selecione o nome da coluna (por exemplo, Status ou Tipo de Documento) para abrir a página da coluna do site.
  4. O parâmetro Campo na URL dessa página contém o nome do campo. O nome do campo, com o prefixo "ows_", é o nome da propriedade rastreada. Por exemplo, a URL https://tenantname.sharepoint.com/sites/SpinningWidget/_layouts/15/FldEdit.aspx?List=%7BC38C2F45-3BD6-4C3B-AA3B-EF5DF6B3D172%7D&Field=_Status corresponde à propriedade ows__Status rastreada.

Se as propriedades rastreadas que você está procurando não aparecerem na seção Gerenciar Esquema de Pesquisa no centro de administração do SharePoint:

  • Os documentos podem ainda não estar indexados. Você pode forçar uma nova indexação da biblioteca acessando Configurações da biblioteca do documento>Configurações Avançadas.

  • Se a biblioteca de documentos estiver em um site moderno, certifique-se de que o administrador do SharePoint também é um administrador do conjunto de sites.

Para obter mais informações sobre propriedades rastreadas e gerenciadas, consulte Propriedades gerenciadas criadas automaticamente no Servidor do SharePoint.

Mapear propriedades rastreadas para propriedades gerenciadas predefinidas

KQL não pode usar propriedades rastreadas em consultas de pesquisa. É preciso usar uma propriedade gerenciada. Em um cenário de pesquisa típico, crie uma propriedade gerenciada e mapeie-a para a propriedade rastreada. Para aplicação automática de rótulos de retenção, você só pode especificar propriedades gerenciadas predefinidas em KQL (não propriedades gerenciadas personalizadas). O sistema tem um conjunto de propriedades gerenciadas predefinidas (padrão) para a cadeia de caracteres RefinableString00 a RefinableString199 que podem ser usadas. As propriedades gerenciadas padrão normalmente são usadas para definir refinadores de pesquisa. Para obter uma lista completa, confira Propriedades gerenciadas padrão não usadas .

Para que a consulta KQL aplique automaticamente o rótulo de retenção correto ao conteúdo do documento de produção, mapeie as propriedades rastreadas ows_Doc_x0020_Type e ows__Status para duas propriedades gerenciadas refináveis.

No cenário, RefinableString00 e RefinableString01 não estão sendo usados. Você pode determinar seu uso examinando as Propriedades Gerenciadas em Gerenciar Esquema de Pesquisa no Centro de Administração do SharePoint:

Captura de tela de propriedades gerenciadas no esquema de pesquisa.

A coluna Propriedades Rastreadas Mapeadas no exemplo anterior está vazia para a propriedade gerenciada que não está em uso.

Para mapear a propriedade ows_Doc_x0020_Type rastreada, siga estas etapas:

  1. Execute uma pesquisa por RefinableString00 usando o filtro de propriedades gerenciadas .

  2. Na lista de resultados, selecione o link RefinableString00 e navegue até a seção Mapeamentos para propriedades rastreadas .

  3. Selecione Adicionar um mapeamento e execute uma pesquisa por ows_Doc_x0020_Type na caixa Pesquisar um nome de propriedade rastreada na janela de seleção de propriedade rastreada .

  4. Na lista de resultados, selecione ows_Doc_x0020_Type e OK. O exemplo a seguir mostra o novo mapeamento na seção Propriedades Rastreadas Mapeadas :

    Captura de tela da opção Adicionar um mapeamento na seção Propriedades rastreadas mapeadas.

  5. Salve o mapeamento.

Repita essas etapas para mapear RefinableString01 e ows__Status.

O exemplo a seguir mostra os resultados de duas propriedades gerenciadas mapeadas para as duas propriedades rastreadas:

Captura de tela de propriedades gerenciadas mapeadas para propriedades rastreadas.

A instalação pode ser verificada executando uma pesquisa corporativa. Em um navegador, acesse https://< your_tenant.sharepoint.com/search>. Pesquise por RefinableString00:"Product Specification". Essa pesquisa retorna todos os documentos que têm uma Especificação de Produto do Tipo Doc.

Em seguida, pesquise RefinableString00:"Product Specification" AND RefinableString01:Final. Isso retorna todos os documentos que têm Especificação do Produto do Tipo Doc e um Status de Final.

Criar as políticas de aplicação automática de rótulos

Depois que a consulta KQL for verificada para retornar os documentos esperados, crie uma política de rótulo de aplicação automática que use uma consulta KQL para aplicar automaticamente o rótulo de retenção da Especificação do Produto aos documentos apropriados.

  1. Entre no portal> do Microsoft PurviewSoluções>Gerenciamento de> registrosPolíticas>Políticas> de rótuloRótulos de retenção

  2. Selecione Aplicar um rótulo automaticamente. Na configuração da política de rotulagem automática, na página Nomear sua política de rotulagem automática , insira um nome, como Aplicar automaticamente o rótulo Especificação do Produto e uma descrição opcional. Em seguida, selecione Avançar.

  3. Na página Escolha o tipo de conteúdo ao qual você deseja aplicar este rótulo , selecione Aplicar rótulo ao conteúdo que contém palavras, frases ou propriedades específicas e selecione Avançar.

    Captura de tela da opção Aplicar rótulo ao conteúdo que contém palavras, frases ou propriedades específicas.

    Essa opção permite fornecer a mesma consulta de pesquisa KQL que foi testada na seção anterior. Esta consulta retorna todos os documentos de Especificação do Produto que têm um status Final. Quando a mesma consulta é usada na política de rótulo de aplicação automática, o rótulo de retenção de Especificação do Produto é aplicado automaticamente aos documentos que correspondem a ele.

  4. Na página Aplicar rótulo ao conteúdo correspondente a esta consulta , digite RefinableString00:"Product Specification" AND RefinableString01:Final e selecione Avançar.

    Captura de tela da caixa editor de consultas de palavra-chave com a consulta especificada.

  5. Para esse cenário, escolha Estático na página Escolher o tipo de política de retenção a ser criada .

    Observação

    Para um ambiente de produção, recomendamos escopos adaptáveis porque eles atualizam automaticamente os locais incluídos na política usando atributos e propriedades.

  6. Na página Escolher onde aplicar automaticamente o rótulo , selecione os locais de conteúdo aos quais você deseja aplicar a política. Para esse cenário, aplique a política somente aos sites clássicos e de comunicação do SharePoint. Alterne todos os outros locais para Desativado:

    Captura de tela da Escolha onde aplicar automaticamente a página de rótulo com os sites do SharePoint selecionados.

    Dica

    Em vez de aplicar a política a todos os sites do SharePoint, você pode aplicar a política a sites individuais selecionando Editar na coluna Incluído e adicionando as URLs do site.

  7. Na página Escolher um rótulo para aplicar automaticamente , selecione o rótulo Especificação do produto .

  8. Para esse cenário, mantenha o padrão de Ativar política na página Decidir se deseja testar ou executar sua política .

  9. Examine suas configurações para confirmar a precisão antes de enviar:

    Captura de tela das configurações de resumo da política para aplicar automaticamente o rótulo.

  10. Selecione Enviar para criar a política do rótulo de aplicação automática.

Verificar que o rótulo de retenção foi aplicado automaticamente

Depois de reservar tempo suficiente para que os rótulos de retenção sejam aplicados automaticamente, use o gerenciador de atividades no portal do Microsoft Purview para verificar se a política de rótulo de aplicação automática aplicou rótulos de retenção aos documentos do produto.

No SharePoint, as propriedades dos documentos na Biblioteca de Documentos são exibidas quando um rótulo é aplicado no painel de detalhes do documento.

Captura de tela das propriedades do documento na Biblioteca de Documentos mostrando o rótulo de retenção aplicado.

Quando os rótulos de retenção marcam itens como um registro, eles impedem que os usuários excluam esses itens. Os usuários verão uma mensagem de erro se tentarem excluir o documento e a ação de exclusão for bloqueada:

Captura de tela de uma mensagem de erro mostrando que os documentos não podem ser excluídos porque o rótulo declara que os documentos são registros.

Gerar o evento que dispara o período de retenção

Nesse cenário, um evento define quando um produto chega ao fim da produção. Para documentos de especificação de produto, o período de retenção de cinco anos começa quando o evento de "fim da produção" é disparado. Esse evento aciona o início do período de retenção definido no rótulo de retenção.

Os eventos podem ser criados no portal do Microsoft Purview. Escolha o tipo de evento, defina as IDs de ativo corretas e insira uma data para o evento. Para mais informações, confira Iniciar a retenção quando um evento ocorrer.

Você também pode criar e gerenciar eventos usando as APIs de Gerenciamento de Registros do Microsoft Graph.

Entender a relação entre IDs de ativos e eventos

Conforme explicado no artigo Iniciar retenção quando ocorre um evento , é importante entender a relação entre tipos de eventos, rótulos de retenção, eventos e IDs de ativos. A ID do ativo é uma propriedade do documento no SharePoint e no OneDrive. Isso ajuda a identificar os documentos que têm um período de retenção disparado pelo evento. Por padrão, o SharePoint tem uma propriedade de ID do Ativo que pode ser usada para retenção controlada por eventos:

Captura de tela da propriedade ID do ativo exibida em uma página de detalhes de propriedades do documento.

O exemplo a seguir mostra que a propriedade gerenciada ID do ativo é ComplianceAssetId.

Captura de tela da propriedade gerenciada ComplianceAssetID.

Este cenário usou a propriedade padrão ID do Ativo . Outras propriedades também podem ser usadas. Se uma ID de ativo ou palavras-chave para um evento não forem especificadas, o período de retenção será acionado para todo o conteúdo que tiver um rótulo desse tipo de evento.

Usando a pesquisa avançada no SharePoint

No exemplo da ID do Ativo, há outra propriedade gerenciada relacionada a rótulos de retenção chamada ComplianceTag que é mapeada para uma propriedade rastreada. A propriedade gerenciada ComplianceAssetId também é mapeada para uma propriedade rastreada. Essas propriedades gerenciadas podem ser usadas na pesquisa avançada para recuperar todos os documentos que tenham um rótulo de retenção aplicado.