Gerenciar retenções

As guardas de documentos preservam os dados por tempo indeterminado para cumprir obrigações legais ou de preservação. Normalmente, as guardas de documentos são aplicadas a um ou mais usuários para garantir que os dados potencialmente relevantes para um caso não sejam excluídos até que ele seja encerrado.

Se um usuário sujeito a uma guarda de documentos excluir dados retidos, eles serão removidos da visualização do usuário, mas serão preservados no Vault. Enquanto a guarda de documentos estiver em vigor, um administrador do Vault poderá pesquisar e exportar esses dados.

As retenções têm os seguintes componentes:

  • Um serviço: o aplicativo responsável pelos dados a serem mantidos. O serviço pode ser definido como e-mail, Drive ou Grupos.
  • Um escopo: as entidades cobertas pela guarda. O escopo pode ser definido como uma ou mais contas de usuário ou como uma unidade organizacional (UO).
  • Outras opções (opcional): os detalhes específicos (consultas de pesquisa ou opções de configuração) usados para restringir os dados a serem mantidos no escopo definido. As opções incluem:
    • e-mail, Grupos: consulta de pesquisa para restringir a retenção
    • Drive: incluir drives compartilhados na retenção

Para trabalhar com recursos do Vault, a conta precisa ter os privilégios necessários do Vault e acesso ao caso. Para acessar um caso, a conta precisa ter criado o caso, ter recebido o compartilhamento dele ou ter o privilégio Visualizar todos os casos.

Criar uma retenção de e-mail em contas de usuário específicas com uma consulta de pesquisa

O exemplo a seguir mostra como uma retenção chamada "Minha primeira retenção de contas de e-mail" é criada para:

  • Serviço: mail
  • Entidade: contas de usuário "user1" e "user2"
  • Outras opções: consulta de pesquisa "para:ceo@company.com"

Recupere os IDs das contas de usuário na API Directory. O HeldAccount pode receber o ID ou o e-mail da conta. Se os dois forem fornecidos, o e-mail será usado e o ID da conta será ignorado.

Java

HeldMailQuery mailQuery = new HeldMailQuery().setTerms("to:ceo@company.com");
List accounts = Lists.newArrayList();
accounts.add(new HeldAccount().setAccountId(user1accountId));
accounts.add(new HeldAccount().setEmail(user2Email));
Hold hold = new Hold()
    .setName("My First mail Accounts Hold")
    .setCorpus("MAIL");
    .setQuery(new CorpusQuery().setMailQuery(mailQuery))
    .setAccounts(accounts);
Hold createdHold = client.matters().holds().create(matterId, hold).execute();

Python

def create_hold_mail_accounts(service, matter_id, account_id):
    mail_query = {'terms': 'to:ceo@company.com'}
    accounts = [
        {'accountId': user1_account_id},
        {'email': user2_email}
    ]
    wanted_hold = {
        'name': 'My First mail Accounts Hold',
        'corpus': 'MAIL',
        'query': {
            'mailQuery': mail_query
        },
        'accounts': accounts
    }
    return service.matters().holds().create(
        matterId=matter_id, body=wanted_hold).execute()

Criar uma retenção para o Drive em uma UO e incluir conteúdo do drive compartilhado

O exemplo a seguir mostra como uma retenção chamada "My First Drive OU Hold" é criada para:

  • Serviço: Drive
  • Entidade: unidade organizacional "Finance" (o ID da UO é capturado em orgUnitId)
  • Outras opções: incluir drives compartilhados de que os usuários nesta unidade organizacional são participantes

Recupere os IDs das UOs na API Directory.

Java

HeldOrgUnit orgUnit = new HeldOrgUnit().setOrgUnitId(orgUnitId);
// Include shared drives content.
HeldDriveQuery driveQuery = new HeldDriveQuery().setIncludeSharedDriveFiles(true);
// Create the hold.
Hold hold = new Hold()
    .setName("My First Drive OU Hold")
    .setCorpus("DRIVE")
    .setQuery(new CorpusQuery().setDriveQuery(driveQuery))
    .setOrgUnit(orgUnit);
Hold createdHold = client.matters().holds().create(matterId, hold).execute();
return createdHold;

Python

def create_hold_drive_org(service, matter_id, org_unit_id):
    drive_query = {'includeSharedDriveFiles': True}
    org_unit = {'orgUnitId': org_unit_id}
    wanted_hold = {
        'name': 'My First Drive OU Hold',
        'corpus': 'DRIVE',
        'orgUnit': org_unit,
        'query': {
            'driveQuery': drive_query
        }
    }
    return service.matters().holds().create(
        matterId=matter_id, body=wanted_hold).execute()

Criar uma guarda para grupos em contas específicas com um período

O exemplo a seguir mostra como criar uma espera chamada "My First Group Hold" para:

  • Serviço: Grupos
  • Entidade: agrupar as contas "group1" e "group2"
  • Outras opções: manter apenas mensagens com datas de envio entre "startTime" e "endTime"

Recupere os IDs das contas de grupo na API Directory.

Java

String APRIL_2_2017_GMT = "2017-04-02T00:00:00Z"; // See below for format*.
 
List accounts = Lists.newArrayList();
accounts.add(new HeldAccount().setAccountId(accountId));
accounts.add(new HeldAccount().setAccountId(accountId2));
HeldGroupsQuery groupQuery = new HeldGroupsQuery();
// Restrict by sent date.
groupQuery.setStartTime(APRIL_2_2017_GMT);
groupQuery.setEndTime(APRIL_2_2017_GMT);
// create the hold
Hold hold = new Hold()
    .setName("My First Group Hold")
    .setCorpus("GROUPS")
    .setQuery(new CorpusQuery().setGroupsQuery(groupQuery));
    hold.setAccounts(accounts);
Hold createdHold = client.matters().holds().create(matterId, hold).execute();

Python

def create_hold_groups_date_range(service, matter_id, group_account_id):
    groups_query = {
        'startTime': '2017-04-02T00:00:00Z', # See below for format*
        'endTime': '2017-04-02T00:00:00Z'
    }
    accounts = [{'accountId': group_account_id}]
    wanted_hold = {
        'name': 'My First Group Hold',
        'corpus': 'GROUPS',
        'query': {
            'groupsQuery': groups_query
        },
        'accounts': accounts
    }
    return service.matters().holds().create(
        matterId=matter_id, body=wanted_hold).execute()

Consultar e modificar suspensões

O exemplo a seguir mostra como listar todas as contas incluídas em uma retenção:

Java

client.matters().holds().accounts().list(matterId, holdId).execute().getAccounts();

Python

# If no accounts are on hold, ['accounts'] will raise an error.
def list_held_accounts(service, matter_id, hold_id):
    return service.matters().holds().accounts().list(
        matterId=matter_id, holdId=hold_id).execute()['accounts']

O exemplo a seguir mostra como adicionar e remover uma conta de uma retenção:

Java

// Add an account by id.
client
        .matters()
        .holds()
        .accounts()
        .create(matterId, holdId, new HeldAccount().setAccountId(accountId))
        .execute();
// Remove an account by id.
client.matters().holds().accounts().delete(matterId, holdId, accountId).execute();

String email = "email@email.com";
// Add an account by email.
client
        .matters()
        .holds()
        .accounts()
        .create(matterId, holdId, new HeldAccount().setEmail(email))
        .execute();

Python

 
def add_held_account(service, matter_id, hold_id, account_id):
    held_account = {'accountId': account_id}
    return service.matters().holds().accounts().create(
        matterId=matter_id, holdId=hold_id, body=held_account).execute()

def remove_held_account(service, matter_id, hold_id, account_id):
    return service.matters().holds().accounts().delete(
        matterId=matter_id, holdId=hold_id, accountId=account_id).execute()

def add_held_account(service, matter_id, hold_id, email):
    held_account = {'email': email}
    return service.matters().holds().accounts().create(
        matterId=matter_id, holdId=hold_id, body=held_account).execute()

O exemplo a seguir mostra como modificar a UO em uma retenção de UO atual:

Java

Hold hold = client.matters().holds().get(matterId, holdId).execute();
hold.getOrgUnit().setOrgUnitId(newOrgUnitId);
Hold modifiedHold = client.matters().holds().update(matterId, holdId, hold).execute();
return modifiedHold;

Python

def update_hold_ou(service, matter_id, hold_id, org_unit_id):
    current_hold = get_hold(matter_id, hold_id)
    current_hold['orgUnit'] = {'orgUnitId': org_unit_id}
    return service.matters().holds().update(
        matterId=matter_id, holdId=hold_id, body=current_hold).execute()

O exemplo a seguir mostra como listar todas as retenções de um caso:

Java

 
String matterId = "Matter Id";



// List all holds.
List holdsList = 
    client.matters().holds().list(matterId).execute().getHolds();



// Paginate on holds.
ListHoldsResponse response = client
        .matters()
        .holds()
        .list(matterId)
        .setPageSize(10)
        .execute();



String nextPageToken = response.getNextPageToken();
if (nextPageToken != null) {
    client
        .matters()
        .holds()
        .list(matterId)
        .setPageSize(10)
        .setPageToken(nextPageToken)
        .execute();
}

Python

# This can paginate in the same manner as with matters.
def list_holds(service, matter_id):
    return service.matters().holds().list(matterId=matter_id).execute()