ECS: Retenção de CAS no ECS

Retenção de CAS no ECS

Um C-Clip do CAS pode ter um período de retenção que rege o período. O objeto associado é retido no armazenamento do ECS antes que um aplicativo possa excluí-lo.


Períodos de retenção

Os períodos de retenção são atribuídos no C-Clip para o objeto pelo aplicativo CAS.

Por exemplo, se um documento financeiro precisar ser retido por três anos a partir de sua data de criação,
um período de retenção de três anos será especificado no C-Clip associado ao documento financeiro. Também é
possível especificar se o documento será retido indefinidamente.

Políticas de retenção (classes de retenção)

Nota: O conceito de classes de retenção do Centera está associado às políticas de retenção no ECS, e essa
documentação usa as políticas de retenção.

As políticas de retenção permitem que os casos de uso de retenção sejam capturados e aplicados aos C-Clips. Por exemplo,
diferentes tipos de documentos podem ter diferentes períodos de retenção. Você pode exigir os
seguintes períodos de retenção:

• Financeiro: 3 anos
• Jurídico: 5 anos
• E-mail: 6 meses

Quando uma política de retenção é aplicada a vários C-Clips, alterando a política. O período
de retenção muda para todos os objetos aos quais a política se aplica.

As políticas de retenção são associadas a namespaces no ECS e são reconhecidas pelo aplicativo CAS
como classes de retenção.
 

Retenção em nível de bucket e CAS do ECS

A retenção em nível de bucket não é a retenção de pool padrão no Centera. No ECS, a retenção padrão do CAS é
constantemente zero.
 

Período de retenção padrão em objetos gravados sem retenção em nível de objeto em
namespaces de conformidade.

A partir do ECS 3.0, quando um aplicativo gravar C-Clips sem retenção de objeto em um bucket do CAS do ECS
em um namespace de conformidade, e o bucket tiver um valor de retenção (seis meses, por exemplo),
o período de retenção padrão infinito (-1) será atribuído aos C-Clips. Os C-Clips nunca poderão
ser excluídos porque seu período de retenção real é o maior entre o
período de retenção em nível de bucket e o período de retenção padrão em nível de objeto.
 

Precedência do CAS

Quando vários períodos de retenção são aplicados a um objeto do CAS no ECS, o período de retenção com o
valor mais alto tem precedência, independentemente de como a retenção foi aplicada.
 

Como aplicar a retenção ao CAS

Você pode definir políticas de retenção para namespaces no Portal do ECS ou com a API
de gerenciamento do ECS. Consulte Configurar políticas de retenção do namespace.

Seu aplicativo CAS externo pode atribuir um período de retenção fixo ou uma política de retenção ao C-Clip
durante sua criação.

Ao aplicar períodos de retenção por meio de APIs, especifique o período em segundos.

Nota: O CAS do ECS considera o tempo de criação do C-Clip para todos os cálculos relacionados à retenção, e não
o tempo de migração.

Como criar políticas de retenção com a API de gerenciamento do ECS.

Você pode criar períodos e políticas de retenção usando o ECS, cujo resumo é fornecido
abaixo.

Método	Descrição
PUT /object/bucket/{bucketName}/retention	O valor de retenção de um bucket define um período de retenção obrigatório que é aplicado a todos os objetos de um bucket. Se você definir um período de retenção de 1 ano, um objeto do bucket não poderá ser excluído por um ano.
GET /object/bucket/{bucketName}/retention	Retorna o período de retenção que está atualmente definido para um bucket especificado.
POST /object/namespaces/namespace/{namespace}/ retention	Para namespaces, a configuração de retenção atua como uma política, em que cada política é um par de <Nome>:<Período de retenção>. Você pode definir várias políticas de retenção para um namespace e atribuir uma política, por nome, a um objeto dentro do namespace. Isso permite alterar o período de retenção de um conjunto de objetos que têm a mesma política atribuída alterando a política correspondente.
PUT /object/namespaces/namespace/{namespace}/ retention/{class}	Atualiza o período de um período de retenção associado a um namespace.
GET /object/namespaces/namespace/{namespace}/ retention	Retorna a política de retenção definida para um namespace.

Você pode encontrar mais informações sobre a API de gerenciamento do ECS na introdução à API REST de gerenciamento do ECS
no Guia de acesso aos dados do ECS. A referência on-line está aqui: Referência da API do ECS.

Retenção avançada para aplicativos CAS: retenção baseada em evento, retenção legal e regulador mín./máx.

Descreve os recursos de retenção avançada disponíveis na API do CAS compatíveis com o ECS.

Os aplicativos do cliente usam a API do CAS para habilitar estratégias de retenção. Quando as cargas de trabalho do CAS
são migradas para o ECS, o conhecimento do ECS sobre os recursos da API do CAS permite que os aplicativos do cliente continuem trabalhando
com os dados migrados. No ECS, os seguintes recursos do gerenciamento avançado de retenção (ARM)
estão disponíveis sem uma licença separada:

• Retenção baseada em evento: a capacidade de configurar um objeto por meio de seu C-Clip para aplicar (acionar) um
  período de retenção ou política de retenção quando o aplicativo CAS recebe um evento especificado.
• Retenção legal: a capacidade de impedir a exclusão de um objeto se o aplicativo CAS tiver aplicado
  uma retenção legal ao objeto por meio de seu C-Clip. O aplicativo CAS pode aplicar até 100
  retenções legais a um objeto criando e aplicando IDs exclusivos de retenção legal.
• Regulador mín./máx.: A capacidade de um administrador definir limites em nível de bucket para período fixo de retenção
  ou período de retenção variável. Um período de retenção variável é aquele definido para dar suporte
  à retenção baseada em evento. No ECS, os administradores de sistema ou namespace podem definir os valores no Portal
  do ECS. Os programadores podem usar a API de gerenciamento do ECS para definir os valores.

Nota: O ARM é compatível com dados legados do CAS gravados com qualquer esquema de nomenclatura migrado
para o ECS.

Regulador mín./máx. para retenção em nível de bucket do CAS

No Portal do ECS, localize um bucket do CAS e selecione Edit. Todos os recursos mostrados na tela
abaixo são recursos somente CAS, exceto o recurso Bucket Retention Period. Bucket Retention
Period é o recurso padrão de retenção de bucket do ECS compatível com todos os tipos de bucket do ECS.

Os recursos de retenção de bucket do CAS são explicados na tabela a seguir.
 

Recurso	Descrição
Enforce Retention	Se esse recurso estiver ativado, nenhum objeto do CAS poderá ser criado sem as informações de retenção (período ou política). Uma tentativa de salvar esse objeto retornará um erro. Se ele estiver ativado, é possível não configurar o Bucket Retention Period mesmo em um ambiente habilitado para conformidade. Nota: Quando um Centera no modo CE+ é migrado para o ECS, a opção Enforce Retention é ativada por padrão no bucket.
Bucket Retention Period	Se um período de retenção de bucket for especificado, o período mais longo será imposto se houver um período de retenção em nível de bucket e um em nível de objeto. Em um ambiente habilitado para conformidade, o Bucket Retention Period é obrigatório, a menos que as informações de retenção no objeto sejam impostas. No entanto, depois de configurado, o Bucket Retention Period não pode ser redefinido mesmo quando as informações de retenção no objeto são impostas.
Minimum Fixed Retention Period	Esse recurso rege os períodos de retenção especificados nos objetos. Se o período de retenção de um objeto estiver fora dos limites especificados aqui, uma tentativa de gravar o objeto apresentará falha. Usando políticas de retenção, as configurações mín./máx. não são impostas. Selecionar Infinite para Minimum Fixed Retention Period significa que todos os valores de retenção devem ser infinitos. Se for para Maximum Fixed Retention Period significa que não há limite máximo. Restrições de retenção mín./máx. são aplicadas a qualquer C-Clip gravado em um bucket. Se um clipe for migrado por qualquer ferramenta de terceiros baseada em SDK, a retenção deverá estar dentro dos limites, caso contrário, será exibido um erro.
Maximum Fixed Retention Period
Minimum Variable Retention Period	Esse recurso rege períodos de retenção variáveis especificados em objetos usando retenção. baseada em eventos (EBR). Na EBR, um período de retenção base é definido e a função de acionamento programada tem a capacidade de aumentar o período de retenção quando o acionador é disparado. Se um novo período de novo retenção de um objeto estiver fora dos limites especificados aqui, uma tentativa de gravar o objeto apresentará falha em resposta ao acionador. Ao usar políticas de retenção, as configurações mín./máx. não são impostas. Selecionar Infinite para Minimum Variable Retention Period significa que todos os valores de retenção devem ser infinitos. Se for para Maximum Variable Retention Period significa que não há limite máximo. Restrições de retenção mín./máx. são aplicadas a qualquer C-Clip gravado em um bucket. Se um clipe for migrado por qualquer ferramenta de terceiros baseada em SDK, a retenção deverá estar dentro dos limites, caso contrário, será exibido um erro.
Maximum Variable Retention Period

Nota: Se o administrador do sistema ou programador não tiver definido nenhum valor para os períodos de retenção fixos e
variáveis, a função get da API de gerenciamento do ECS não retornará valores para
as configurações mín./máx. A opção Enforce Retention Information in C-Clip retornará um valor padrão
false.
 

Retenção baseada em evento

A retenção baseada em evento (EBR) é uma instrução que especifica que um registro não pode ser excluído antes de um
evento e durante um período especificado após o evento. No CAS, a EBR é um C-Clip com um período de retenção base
ou uma política de retenção especificada e um acionador definido pelo aplicativo que pode definir um período de retenção
mais longo quando o acionador é disparado. O período de retenção só começa quando o acionador é disparado.
Quando um C-Clip é marcado para EBR, ele não pode ser excluído antes do evento, a menos que uma exclusão privilegiada
seja usada.

Ao usar a EBR, o ciclo de vida do C-Clip é o seguinte:

• Create: o aplicativo cria um novo C-Clip e o marca como sendo da EBR. O aplicativo
  pode fornecer um período de retenção fixo que atua como uma retenção mínima e deve fornecer um
  período ou uma política de retenção baseada em evento.
• Evento de acionamento: O aplicativo aciona o evento, que é o ponto de partida do período de retenção baseada
  em evento ou da política de retenção. O aplicativo poderá atribuir um novo período de retenção baseada
  em evento, se for mais longo do que aquele atribuído no momento da criação
  do C-Clip.
• Delete: Quando o aplicativo tenta excluir o C-Clip, as seguintes condições devem ser atendidas:
  A retenção de política (namespace) expirou
  A retenção de bucket expirou
  A retenção fixa expirou
  O evento foi acionado
  Tanto a EBR definida no momento da criação quanto quaisquer alterações subsequentes (extensões) no momento do evento expiraram

A figura a seguir mostra os três cenários possíveis para um C-Clip em EBR:

• O C1 tem uma retenção fixa ou mínima que já expirou antes de o evento ter sido acionado.
• O C2 tem uma retenção fixa ou mínima que expirará antes do vencimento da EBR.
• O C3 tem uma retenção fixa ou mínima que expirará após o vencimento da EBR.

 

Para namespaces não compatíveis, os comandos de exclusão privilegiada podem substituir a retenção fixa e variável
da EBR.

Ao aplicar a retenção de EBR, ela deve estar em conformidade com as configurações do Regulador mín./máx. para o período de
retenção variável.

A tabela mostra as funções da API do CAS para retenção baseada em evento

Função	Descrição
FPClip_EnableEBRWithClass	Essa função define um C-Clip como elegível para receber um evento futuro e permite que uma classe de retenção baseada em evento (EBR) seja atribuída ao C-Clip durante o momento da criação do C-Clip.
FPClip_EnableEBRWithPeriod	Essa função define um C-Clip como elegível para receber um evento futuro e permite que um período de retenção baseada em evento (EBR) seja atribuído ao C-Clip durante o momento da criação do C-Clip.
FPClip_IsEBREnabled	Essa função retorna um valor booleano para indicar se um C-Clip está habilitado ou não para retenção baseada em evento (EBR).
FPClip_GetEBRClassName	Essa função recupera o nome da retenção baseada em evento (EBR). política atribuída ao C-Clip.
FPClip_GetEBREventTime	Essa função retorna o horário do evento definido em um C-Clip quando o evento de retenção baseada em evento (EBR) desse C-Clip foi acionado.
FPClip_GetEBRPeriod	Essa função retorna o valor (em segundos) do período de retenção baseada em evento (EBR) associado a um C-Clip.
FPClip_TriggerEBREvent	Essa função aciona o evento de um C-Clip para o qual a retenção baseada em evento (EBR) foi habilitada.
FPClip_TriggerEBREventWithClass	Essa função aciona o evento de um C-Clip para o qual a retenção baseada em evento (EBR) foi habilitada e atribui uma nova política de EBR ao C-Clip.
FPClip_TriggerEBREventWithPeriod	Essa função aciona o evento de um C-Clip para o qual a retenção baseada em evento (EBR) foi habilitada e atribui um novo período de EBR ao C-Clip.

 

 

Retenção legal

A retenção legal permite que os aplicativos do CAS impeçam temporariamente a exclusão de um C-Clip. A retenção legal é
útil para dados que estão sujeitos a uma investigação oficial, intimação ou consulta e que não podem ser
excluídos até que a investigação seja finalizada. Depois que não houver necessidade de armazenar os dados, a retenção legal
poderá ser liberada pelo aplicativo e o comportamento normal de retenção será retomado. O aplicativo CAS
coloca e remove uma retenção legal no nível do C-Clip.

Nota: Mesmo uma exclusão privilegiada não pode excluir um C-Clip sob retenção legal.

Um C-Clip pode estar sob várias retenções legais. O aplicativo deve gerar IDs exclusivos de retenção
legal e ser capaz de rastrear as retenções legais específicas associadas a um C-Clip. O aplicativo
não pode consultar um C-Clip para obter essas informações. Há apenas uma função que determina o estado de retenção
legal do C-Clip. Se houver uma ou várias retenções legais no C-Clip, essa função retornará
verdadeira; caso contrário, ela será falsa.

Ao usar a retenção legal, o ciclo de vida do C-Clip é o seguinte:

• Criar: O aplicativo cria um novo C-Clip e fornece um período de retenção fixo e/ou
  baseado em evento.
• Definir a retenção legal: Um aplicativo coloca o C-Clip em retenção. Esse aplicativo pode ser diferente
  do aplicativo que gravou o C-Clip.
• Liberar a retenção legal: Um aplicativo libera o C-Clip. Esse aplicativo pode ser diferente
  do aplicativo que define a retenção legal ou gravou o C-Clip.
• Delete: Quando o aplicativo tenta excluir o C-Clip, as seguintes condições devem ser atendidas:
  Não há outras retenções legais pendentes no C-Clip.
  A retenção de política expirou.
  A retenção de bucket padrão expirou. (A retenção de bucket padrão está disponível para todos os tipos de objeto do ECS, mas não é recomendada para CAS.)
  O período de retenção fixo expirou (recurso somente CAS).
  A retenção baseada em evento expirou (recurso somente CAS).

A figura a seguir mostra os três cenários possíveis para um C-Clip colocado em retenção legal:

• O C1 tem uma retenção fixa que já expirou quando colocada em retenção.
• O C2 tem uma retenção fixa que expira durante a retenção.
• O C3 tem uma retenção fixa que expirará após a liberação da retenção.

Um C-Clip pode ter várias retenções legais atribuídas a ele. Se esse for o caso, cada retenção legal
requer uma chamada API separada com um identificador exclusivo para a retenção legal.

Nota: O tamanho máximo do ID de retenção legal é de 64 caracteres. O número máximo de IDs de retenção legal
por C-Clip é 100. Essas limitações são impostas pela API do CAS.

A tabela mostra as funções da API do CAS para retenção legal
 

Função	Descrição
FPClip_GetRetentionHold	Esta função determina o estado de retenção do C-Clip e retorna verdadeiro ou falso.
FPClip_SetRetentionHold	Essa função define ou redefine uma retenção em um C-Clip. Para várias retenções legais, forneça um ID exclusivo de retenção legal para cada retenção. Para várias retenções, faça uma chamada por ID.

Os tópicos relacionados ao CAS abaixo estão detalhados no Guia de acesso aos dados do ECS e estão separados em diferentes KBs:

• ECS: Como configurar o suporte do CAS no ECS: KB 538783
  • Como configurar o suporte do CAS no ECS
  • Armazenamento estático
• ECS: Conformidade com CAS: KB 538784
  • Fortalecimento e conformidade da plataforma
  • Política de conformidade e retenção
  • Agente de conformidade
• ECS: Retenção do CAS no ECS: KB 538782
  • Retenção do CAS
  • Retenção avançada para aplicativos CAS: retenção baseada em evento, retenção legal e regulador mín./máx.
• ECS: Configurar políticas de retenção de namespace do CAS: KB 538786
• ECS: Práticas recomendadas de administração de usuários e buckets do CAS: KB 478327
  • Criar e configurar um bucket para um usuário do CAS
  • Configurar um usuário de objeto do CAS
• ECS: Configurar ACLs de bucket do CAS: KB 538789
• ECS: APIs de gerenciamento do ECS que dão suporte a usuários do CAS: KB 538790
• ECS: Suporte à API SDK do Armazenamento endereçável por conteúdo (CAS): KB 538791
• ECS: Códigos de erro de SDK do CAS (Centera): KB 427034