# Suporte e-Ciga

# ⚠️ Erro de “Autorização Expirada” ao Assinar com Gov.br

## <span role="text">❗ **Situação**</span>

Ao tentar assinar um documento utilizando o **Gov.br**, o sistema exibe a mensagem de:

> **“Autorização expirada”**

Mesmo que o tempo disponível para assinatura ainda apareça como válido na tela.

---

## <span role="text">🔍 **Causa do Problema**</span>

Esse erro ocorre, na maioria dos casos, quando a **data e/ou hora do computador do usuário estão incorretas**.

📌 Isso acontece principalmente quando:

- O usuário altera manualmente a data/hora do sistema;
- O relógio do computador está desatualizado;
- O sistema não está sincronizado automaticamente com a internet.

Como a autenticação do Gov.br depende de **validação de tempo (timestamp)**, qualquer diferença entre o horário do computador e o horário real pode invalidar a autorização.

---

## <span role="text">🛠️ **Como Resolver**</span>

### 1️⃣ Ajustar Data e Hora do Computador

1. Acesse as configurações de **data e hora** do seu sistema operacional.
2. Habilite a opção: 
    - ✔️ **Definir hora automaticamente**
3. Habilite também: 
    - ✔️ **Definir fuso horário automaticamente**
4. Clique em **Sincronizar agora** (se disponível).

---

### 2️⃣ Reiniciar o Navegador

1. Feche completamente o navegador.
2. Abra novamente.
3. Acesse o e-Ciga e refaça o processo de assinatura.

---

### 3️⃣ Tentar Novamente a Assinatura

1. Retorne ao documento.
2. Inicie novamente o fluxo de assinatura via Gov.br.

---

## <span role="text">✅ **Resultado Esperado**</span>

- A mensagem de erro deixará de aparecer;
- A assinatura poderá ser realizada normalmente.

---

## <span role="text">📌 **Observações Importantes**</span>

- Esse erro **não está relacionado ao e-Ciga**, mas sim à validação de segurança do Gov.br.
- A sincronização correta da data e hora é essencial para: 
    - Assinaturas digitais
    - Acessos seguros
    - Validação de certificados

---

## <span role="text">🧾 **Mensagem Padrão para Atendimento**</span>

> “Identificamos que a mensagem de ‘autorização expirada’ ocorre quando a data ou hora do computador está incorreta. Ajuste para modo automático e sincronize o horário, depois tente novamente a assinatura.”

# ❗ Erro: "Chave inválida para uso no estado especificado"

### 📄 Ao tentar assinar documentos no e-Ciga

---

### 💡 O que significa esse erro?

Esse erro ocorre quando o **certificado digital instalado no computador ou dispositivo USB (token)** não consegue ser utilizado corretamente pelo navegador ou pelo sistema de assinatura. Ele indica que **a chave privada** associada ao certificado **não está acessível ou funcional no momento da operação**.

---

### 🔍 Causas mais comuns

1. **Token mal encaixado na porta USB**
    
    
    - O dispositivo pode não estar firmemente conectado ou pode estar intermitente.
    - **Solução:** Retire e conecte novamente o token em outra porta USB.
2. **Porta USB com mau funcionamento**
    
    
    - Algumas portas USB podem não fornecer energia ou conexão adequada.
    - **Solução:** Troque de porta USB, preferencialmente uma porta traseira (em desktops).
3. **Drivers do token ou certificados corrompidos ou desatualizados**
    
    
    - Pode haver problemas no software do fabricante do token ou na cadeia de certificação digital (ex: ICP-Brasil).
    - **Solução:**
        
        
        - Reinstale os drivers e o gerenciador do seu token (ex: SafeNet, GD Burti, e-Token).
        - Reinstale a cadeia de certificados raiz e intermediários da ICP-Brasil, se aplicável.

---

### ✅ Passos recomendados para correção

1. **Remova e reconecte o token**
2. **Troque de porta USB**
3. **Reinicie o navegador**
4. **Teste a assinatura em outro navegador (preferencialmente Chrome)**
5. **Reinstale os drivers do token e as cadeias de certificados**
    
    
    - Acesse o site do fabricante do token para baixar os instaladores mais recentes.
    - Baixe e instale os certificados da ICP-Brasil: <a class="cursor-pointer" data-end="1988" data-start="1892" rel="noopener" target="_new">https://www.iti.gov.br/icp-brasil/certificados</a>

---

### 🆘 Se o problema persistir:

- Teste o token em outro computador para isolar a causa.
- Verifique se o certificado ainda está válido.
- Caso continue com dificuldades, entre em contato com o **suporte técnico do e-Ciga** com os detalhes do erro.

# ❗ Erro: "O documento não pode ser assinado"

### 📄 Durante o processo de assinatura de documentos no e-Ciga

---

### 🔍 O que esse erro significa?

Essa mensagem aparece quando o sistema não consegue concluir a operação de assinatura do documento. O motivo pode estar relacionado a problemas no cadastro do documento ou em inconsistências no status da assinatura.

---

### 📌 Causas mais comuns

1. **PDF ausente no cadastro do documento**
    
    
    - O arquivo PDF que deveria estar associado ao documento não foi corretamente salvo no momento do cadastro ou foi corrompido.
    - **Solução:**
        
        
        - Vá até o **menu do documento**
        - Clique na opção **“Reenviar arquivo”**
        - Selecione novamente o arquivo PDF original e confirme o envio.
2. **Assinatura já realizada, mas ainda aparece como pendente**
    
    
    - O sistema pode ter registrado a assinatura, mas por algum erro de atualização, ainda aparece na lista de pendentes.
    - **Solução:**
        
        
        - Atualize a tela (pressionando `F5`)
        - Verifique no histórico do documento se a assinatura já está registrada.
3. **Arquivo em formato inválido ou corrompido**
    
    
    - O documento pode ter sido corrompido no upload ou estar com estrutura PDF inválida.
    - **Solução:**
        
        
        - Tente reprocessar o arquivo, por exemplo, utilizando a função “Imprimir em PDF” e substitua o arquivo no sistema.
        - Utilize a opção **“Substituir arquivo”** no menu do documento (se permitido).
4. **Outros motivos técnicos**
    
    
    - Problemas com o navegador, sessão expirada, falha de comunicação com a extensão de assinatura, etc.
    - **Solução:**
        
        
        - Certifique-se de estar com a extensão WebPKI ativa.
        - Tente em outro navegador ou reinicie a sessão.

---

### 🧩 Quando investigar?

Se as soluções acima não resolverem, o erro pode estar ligado a:

- Falhas internas de sincronização.
- Inconsistências de assinatura em lote.
- Erros não visíveis ao usuário final.

Neste caso, **entre em contato com o suporte do e-Ciga** pelo chat, informando:

- Número do documento.
- Ente e entidade.
- CPF do assinante.
- Captura de tela ou descrição completa do erro.

---

### ✅ Resumo das ações rápidas

<div class="_tableContainer_16hzy_1" id="bkmrk-problema-comum-a%C3%A7%C3%A3o-"><div class="_tableWrapper_16hzy_14 group flex w-fit flex-col-reverse" tabindex="-1"><table class="w-fit min-w-(--thread-content-width)" data-end="2621" data-start="2301" style="width: 54.1975%; height: 148.984px;"><thead data-end="2338" data-start="2301"><tr data-end="2338" data-start="2301" style="height: 29.7969px;"><th data-col-size="sm" data-end="2318" data-start="2301" style="width: 36.2364%; height: 29.7969px;">Problema comum</th><th data-col-size="md" data-end="2338" data-start="2318" style="width: 63.4966%; height: 29.7969px;">Ação recomendada</th></tr></thead><tbody data-end="2621" data-start="2377"><tr data-end="2438" data-start="2377" style="height: 29.7969px;"><td data-col-size="sm" data-end="2394" data-start="2377" style="width: 36.2364%; height: 29.7969px;">PDF ausente</td><td data-col-size="md" data-end="2438" data-start="2394" style="width: 63.4966%; height: 29.7969px;">Menu do documento → **Reenviar arquivo**</td></tr><tr data-end="2511" data-start="2439" style="height: 29.7969px;"><td data-col-size="sm" data-end="2465" data-start="2439" style="width: 36.2364%; height: 29.7969px;">Assinatura não atualiza</td><td data-col-size="md" data-end="2511" data-start="2465" style="width: 63.4966%; height: 29.7969px;">Atualizar tela (F5) ou verificar histórico</td></tr><tr data-end="2566" data-start="2512" style="height: 29.7969px;"><td data-col-size="sm" data-end="2531" data-start="2512" style="width: 36.2364%; height: 29.7969px;">Arquivo inválido</td><td data-col-size="md" data-end="2566" data-start="2531" style="width: 63.4966%; height: 29.7969px;">Substituir por versão corrigida</td></tr><tr data-end="2621" data-start="2567" style="height: 29.7969px;"><td data-col-size="sm" data-end="2590" data-start="2567" style="width: 36.2364%; height: 29.7969px;">Persistência do erro</td><td data-col-size="md" data-end="2621" data-start="2590" style="width: 63.4966%; height: 29.7969px;">Investigar com maiores detalhes</td></tr></tbody></table>

</div></div>

# ❗ Erro: “Documento ou Processo Já Cadastrado” no e-Ciga

# 📄 **Correção do Erro “Documento ou Processo Já Cadastrado” no e-Ciga**

Quando, ao tentar **cadastrar um documento ou processo**, o sistema exibe a mensagem informando que **o documento ou processo já foi cadastrado**, mesmo não existindo visualmente no sistema, normalmente trata-se de uma **inconsistência na numeração**.  
Esse cenário ocorre com mais frequência em situações de **lentidão do sistema**, quando a reserva de numeração é criada, mas o cadastro não é finalizado corretamente.

---

## 🔍 **Causa Mais Comum**

- Lentidão ou instabilidade no sistema durante o cadastro;
- A numeração foi **reservada**, mas o cadastro não foi concluído;
- O sistema entende que aquele número já está em uso, impedindo novo cadastro.

---

## 🛠️ **Procedimento de Correção**

### 1️⃣ Acessar o Cadastro de Documentos (ou Processos)

1. Entre no **e-Ciga** com perfil administrativo ou de suporte.
2. Acesse a opção de **Cadastro de Documento** (ou Processo, conforme o caso).

---

### 2️⃣ Selecionar a Classificação Correta

1. No formulário de cadastro:
    
    
    - Selecione **exatamente a mesma classificação documental ou processual**  
        que o usuário tentou utilizar originalmente.
2. Atenção especial a:
    
    
    - Espécie
    - Tipo (se houver)
    - Configurações de numeração (ano, setor, sufixo, etc.)

⚠️ Isso é fundamental para que o sistema atue sobre a **mesma sequência de numeração** afetada.

---

### 3️⃣ Gerar a Reserva de Numeração

1. Clique no botão **Gerar Reserva**.
2. Aguarde o sistema apresentar o **número reservado**.

---

### 4️⃣ Cancelar a Reserva

1. Assim que o número for exibido:
    
    
    - **Cancele a reserva** imediatamente.
2. Essa ação:
    
    
    - Libera a numeração presa/inconsistente
    - Reorganiza a sequência de numeração da classificação

---

## ✅ **5️⃣ Orientar o Usuário**

1. Informe ao usuário que:
    
    
    - O problema de numeração foi corrigido.
2. Solicite que ele:
    
    
    - Tente **cadastrar novamente o documento ou processo**
    - Utilizando a mesma classificação

Após esse procedimento, o cadastro deverá ocorrer normalmente, sem exibição da mensagem de erro.

---

## 📌 **Observações Importantes**

- Este procedimento **não cria documentos ou processos extras**.
- Serve apenas para **destravar a sequência de numeração**.
- Não deve ser feito repetidamente sem necessidade.
- Caso o erro persista mesmo após a correção:
    
    
    - Deve-se investigar possível inconsistência maior na classificação ou no banco de dados.

---

## 🧾 **Mensagem Sugerida ao Usuário**

> “Identificamos uma inconsistência temporária na numeração do sistema, causada por lentidão no momento do cadastro. A numeração já foi corrigida e você pode realizar o cadastro novamente normalmente.”

# 📌 Informativo: Atendimentos Realizados pelo Suporte do Ente Niterói no e-Ciga

O suporte do ente **Niterói** é realizado pela **SEPLAG (Secretaria de Planejamento)**, mediante solicitações efetuadas pelo portal oficial: [https://e.niteroi.rj.gov.br/](https://e.niteroi.rj.gov.br/).

### 🛠️ Tipos de Atendimentos Realizados

1. **Gestão de Usuários**
    
    
    - Ativações e desativações de contas.
    - Alterações de cargos e setores vinculados a usuários.
    - Ajustes de permissões relacionadas ao acesso no sistema.
2. **Movimentação de Processos e Documentos**
    
    
    - Solicitações de movimentação quando os usuários não possuem mais acesso direto.
    - Apoio em casos de processos/documentos bloqueados ou sem responsáveis ativos.
3. **Classificações Documentais e Processuais**
    
    
    - Cadastro de novas classificações.
    - Alterações e manutenção das classificações existentes.
4. **Desarquivamento de Documentos e Processos**
    
    
    - Atendimentos para desarquivar documentos e processos cujos responsáveis originais não estão mais ativos no e-Ciga.

---

### 📌 Observação

As demandas devem ser formalizadas **exclusivamente via portal e-Niterói**, garantindo controle, rastreabilidade e atendimento oficial pela SEPLAG.

# Alterar administrador de um grupo

A partir da ferramenta administrativa do e-Ciga, é possível redefinir o administrador de um grupo diretamente pela interface. Isso deve ser feito por usuários com permissão de acesso ao painel de administração.

<div id="bkmrk-">---

</div>### 🌐 1. Acessar o Painel de Administração de Grupos

1. Acesse a URL: [https://admin.eciga.consorciociga.gov.br/](https://admin.eciga.consorciociga.gov.br/)
2. Clique no botão **"Gerenciar Grupos"**.
3. Selecione o **ente** desejado na lista apresentada.

<div id="bkmrk--1">---

</div>### 👥 2. Localizar o Grupo

1. Na tela de gerenciamento de grupos, utilize a busca para localizar o grupo que deseja alterar.
2. Clique sobre o grupo para visualizar seus integrantes.

<div id="bkmrk--2">---

</div>### 🔄 3. Redefinir o Administrador do Grupo

1. Visualize a lista de membros atuais do grupo.
2. Selecione o novo integrante que assumirá como administrador.
3. Clique no botão **"Redefinir Administrador"**.

> ✅ O novo administrador passará a ter permissão para editar o nome do grupo e os membros.

<div id="bkmrk--3">---

</div>### 📌 Observações Importantes

- Apenas usuários com acesso ao painel administrativo do e-Ciga podem realizar esta ação.
- Um grupo **sempre deve ter ao menos um administrador**.
- Caso o administrador anterior esteja inativo, essa é a forma oficial de substituir sua responsabilidade pelo grupo.

# Alterar dados do interessado externo (contribuinte, servidor, requerente)

Caso seja necessário alterar o nome ou e-mail de um interessado externo já cadastrado no sistema e-Ciga:

1. Acesse o [Mongo Express](https://mongo.eciga.consorciociga.gov.br/).
2. Localize a base de dados da **entidade solicitante**.
3. Acesse a coleção **interessados\_externos**.
4. Utilize a busca:
    
    
    - Campo **key**: `cpfCnpj`
    - Campo **value**: insira o CPF ou CNPJ do interessado (somente números).
    - Clique em **Find**.
5. Clique no registro encontrado para editar.
6. Altere os campos desejados, como **nome** ou **e-mail**.
7. Após realizar as modificações, clique em **Save** para salvar.

> ⚠️ Se a alteração for no nome e o interessado já estiver vinculado a um processo, oriente o usuário a:
> 
> - Remover o interessado do processo;
> - Adicioná-lo novamente, para que o novo nome apareça corretamente na capa do processo.

# Alterar setor principal

O setor principal de um usuário define qual setor aparece por padrão em ações como **assinatura de documentos**, **filtros** e **exibição em listas**. A prioridade é determinada pela ordem do campo `setores` no cadastro do usuário.

### 🛠️ Etapas para Alterar

1. **Acesse o Mongo Express**
    
    
    - URL: [https://mongo.eciga.consorciociga.gov.br/](https://mongo.eciga.consorciociga.gov.br/)
    - Faça login com as credenciais administrativas.
2. **Selecione a base de dados da entidade solicitante**
    
    
    - Exemplo: `niteroi`, `itajai`, etc.
3. **Abra a coleção `usuarios`**
4. **Busque o usuário pelo CPF**
    
    
    - Campo `key`: `login`
    - Campo `value`: digite o CPF **somente com números** (sem pontos ou traços)
    - Clique em **Find**
5. **Clique no registro retornado**
6. **Altere o campo `setores`**
    
    
    - O campo `setores` é uma lista de `ObjectId` dos setores vinculados ao usuário.
    - Para tornar um setor o **principal**, mova o `ObjectId` correspondente ao setor desejado para a **primeira posição da lista**.
7. **Verifique o `ObjectId` correto do setor**
    
    
    - Vá até a coleção `setores`
    - Utilize o filtro de busca com o nome do setor desejado para descobrir seu `ObjectId`
8. **Salve a alteração**
    
    
    - Clique em **Save** no canto superior direito da tela do registro do usuário

---

### ✅ Resultado

O novo setor principal será exibido como padrão:

- Em assinaturas
- Em seletores de setor
- Em relatórios e filtros

# Assinante externo assinou mas não mostra como assinado

Se o assinante externo realizou a assinatura, mas o status não é refletido no sistema e-Ciga:

1. Acesse o [Mongo Express](https://mongo.eciga.consorciociga.gov.br/).
2. Localize a base de dados da entidade correspondente.
3. Acesse a coleção **convidados**.
4. Utilize a busca:
    
    
    - Campo **key**: `email`
    - Campo **value**: digite o endereço de e-mail do assinante externo.
    - Clique em **Find**.
5. Clique no resultado exibido para editar o documento.
6. Localize e **exclua a linha onde consta o campo** `<strong>CPF</strong>`.
7. Clique em **Save** para salvar as alterações.
8. Peça para o usuário atualizar a tela do sistema (pressionar **F5**) e verificar se a assinatura aparece corretamente.

# Cadastrar um setor no mongo e keycloak

Cadastrar um setor novo para um usuário existente no e-Ciga exige ações tanto no **Keycloak (SSO)** quanto no **Mongo Express (banco de dados)**. Abaixo está o passo a passo completo.

<div id="bkmrk-">---

</div>### 🔐 1. Acessar o Keycloak (SSO)

1. Vá até [https://sso.ciga.sc.gov.br/](https://sso.ciga.sc.gov.br/).
2. Acesse a **realm** correspondente ao ente do usuário.
3. No menu lateral, clique em **Groups**.
4. Expanda a opção **Setores**.
5. Clique no botão **New**.
6. No campo exibido, digite o **nome do novo setor** exatamente como deseja que apareça no sistema.
7. Clique em **Save**.

<div id="bkmrk--1">---

</div>### 🧬 2. Inserir o Setor no MongoDB (Mongo Express)

1. Acesse [https://mongo.eciga.consorciociga.gov.br/](https://mongo.eciga.consorciociga.gov.br/).
2. No menu lateral, selecione a base de dados com o nome da **realm** do usuário.
3. Localize a coleção chamada **setores**.
4. Clique em **New Document**.
5. Insira o seguinte código no campo de texto:

```
{
    "_id": ObjectId(),
    ente: 'niteroi',
    nome: 'nome do setor'
}
```

> 🔸 **Importante:**
> 
> - Substitua `niteroi` pelo ente correto.
> - Substitua `nome do setor` pelo nome digitado exatamente como foi criado no Keycloak.
> - Use **vírgulas corretamente** entre os campos.

6. Clique em **Save** para gravar o setor na base de dados.

<div id="bkmrk--2">---

</div>### 👤 3. Vincular o Setor ao Usuário no Keycloak

1. Volte ao Keycloak e vá até o menu **Users**.
2. Localize e clique no nome do usuário desejado.
3. Vá até a guia **Groups**.
4. Localize o setor recém-criado.
5. Selecione o setor e clique em **Join** para adicionar o usuário ao grupo.

<div id="bkmrk--3">---

</div>### ✅ 4. Finalizar com Impersonação

1. Ainda na tela do usuário no Keycloak, vá até a guia **Impersonate**.
2. Clique no botão do aplicativo **e-Ciga 2.0**.
3. Isso forçará a atualização do cache de permissões e garantirá que o novo setor seja persistido corretamente no MongoDB.

<div id="bkmrk--4">---

</div>### 📌 Observações Finais

- O nome do setor deve ser **idêntico** no Keycloak e Mongo Express.
- O procedimento deve ser feito por administradores com permissão de acesso ao SSO e ao banco Mongo.
- Após o processo, o usuário terá acesso aos documentos e fluxos vinculados ao novo setor.

# Desativar setor (Niterói)

Desativar um setor impede que ele receba novos **documentos** ou **processos** no sistema e-Ciga. Isso deve ser feito diretamente na base de dados do ente por meio do Mongo Express.

---

### 🛠️ Etapas para Desativar o Setor

1. **Acesse o Mongo Express**
    
    
    - URL direta da coleção: [https://mongo.eciga.consorciociga.gov.br/db/eciga-niteroi/setores](https://mongo.eciga.consorciociga.gov.br/db/eciga-niteroi/setores)
    - Faça login com credenciais administrativas.
2. **Acesse a base de dados do ente Niterói**
    
    
    - Certifique-se de estar na base `eciga-niteroi`.
3. **Entre na coleção `setores`**
4. **Busque o setor pelo nome**
    
    
    - Campo `key`: `nome`
    - Campo `value`: digite o nome completo do setor (exatamente como cadastrado).
    - Clique em **Find**.
5. **Clique sobre o registro retornado para editar**
6. **Adicione o campo de desativação**
    
    
    - Inclua o seguinte campo ao JSON do setor:
        
        <div class="contain-inline-size rounded-2xl relative bg-token-sidebar-surface-primary"><div class="flex items-center text-token-text-secondary px-4 py-2 text-xs font-sans justify-between h-9 bg-token-sidebar-surface-primary select-none rounded-t-2xl">json</div><div class="sticky top-9"><div class="absolute end-0 bottom-0 flex h-9 items-center pe-2"><div class="bg-token-bg-elevated-secondary text-token-text-secondary flex items-center gap-4 rounded-sm px-2 font-sans text-xs"><button aria-label="Copiar" class="flex gap-1 items-center select-none py-1"><svg class="icon-xs" fill="currentColor" height="20" viewbox="0 0 20 20" width="20" xmlns="http://www.w3.org/2000/svg"></svg>Copiar</button></div></div></div><div class="overflow-y-auto p-4" dir="ltr">`<span class="hljs-attr">"desativado"</span><span class="hljs-punctuation">:</span> <span class="hljs-literal"><span class="hljs-keyword">true</span></span>`</div></div>
    - **Importante:** certifique-se de que a linha anterior tenha uma vírgula (`,`) antes de adicionar este novo campo, para não causar erro de sintaxe.
7. **Clique em `Save`** no canto superior direito da tela para salvar a alteração

---

### ✅ Resultado

Após salvar:

- O setor ficará **inativo** no sistema e-Ciga.
- **Não poderá mais receber documentos ou processos.**
- Usuários ainda vinculados a ele continuarão com o setor listado, mas ele deixará de aparecer nas caixas de entrada e destinos de trâmite.

# Desativar usuário (Niterói)

Desativar um usuário impede que ele acesse o sistema e-Ciga e o retira de visualizações e funcionalidades ativas. O procedimento deve ser feito diretamente pelo Mongo Express.

---

### 🛠️ Etapas para Desativar o Usuário

1. **Acesse o Mongo Express**
    
    
    - URL: [https://mongo.eciga.consorciociga.gov.br/db/eciga-niteroi/usuarios](https://mongo.eciga.consorciociga.gov.br/db/eciga-niteroi/usuarios)
    - Faça login com as credenciais administrativas.
2. **Acesse a base de dados do ente Niterói**
    
    
    - Certifique-se de estar na base `eciga-niteroi`.
3. **Entre na coleção `usuarios`**
4. **Busque o usuário pelo CPF**
    
    
    - Campo `key`: `login`
    - Campo `value`: digite o CPF **somente com números** (sem pontos ou traços).
    - Clique em **Find**.
5. **Clique no registro retornado para editar**
6. **Inclua o campo de desativação**
    
    
    - Adicione no final do JSON do registro a seguinte linha:
        
        <div class="contain-inline-size rounded-2xl relative bg-token-sidebar-surface-primary"><div class="flex items-center text-token-text-secondary px-4 py-2 text-xs font-sans justify-between h-9 bg-token-sidebar-surface-primary select-none rounded-t-2xl">json</div><div class="sticky top-9"><div class="absolute end-0 bottom-0 flex h-9 items-center pe-2"><div class="bg-token-bg-elevated-secondary text-token-text-secondary flex items-center gap-4 rounded-sm px-2 font-sans text-xs"><button aria-label="Copiar" class="flex gap-1 items-center select-none py-1"><svg class="icon-xs" fill="currentColor" height="20" viewbox="0 0 20 20" width="20" xmlns="http://www.w3.org/2000/svg"></svg>Copiar</button></div></div></div><div class="overflow-y-auto p-4" dir="ltr">`<span class="hljs-attr">"desativado"</span><span class="hljs-punctuation">:</span> <span class="hljs-literal"><span class="hljs-keyword">true</span></span>`</div></div>
    - Certifique-se de que a linha anterior termine com vírgula (`,`) para evitar erro de sintaxe.
7. **Clique em `Save`** no canto superior direito para salvar a alteração

---

### ✅ Resultado

Após salvar:

- O usuário será considerado **desativado** pelo sistema.
- Isto **não impedirá de acessar acessar** o e-Ciga, pois, para isto, precisar ser removido acesso no keycloak (não temos acesso, somente a seplag em Niteroi).
- Seu nome e login não aparecerão mais como disponíveis em caixas de entrada, assinaturas e filtros.

# Gerar link de assinante externo

Quando um assinante externo não recebe o e-mail automático de solicitação de assinatura, o sistema e-Ciga permite que seja gerado manualmente um link para envio ao assinante. Veja abaixo como proceder:

---

### 🌐 1. Acessar o Painel de Geração de Link

1. Acesse a URL: [https://admin.eciga.consorciociga.gov.br/Gerar\_link\_de\_assinante\_externo](https://admin.eciga.consorciociga.gov.br/Gerar_link_de_assinante_externo)
2. Faça login com uma conta com permissões administrativas.

---

### 📄 2. Informar o email

1. Digite o e-mail do assinante externo no campo indicado para localizar rapidamente o destinatário
2. Defina a validade do link escolhendo um período entre 1 hora e 30 dias, de acordo com a urgência e o tempo necessário para o assinante externo realizar a assinatura.

---

### 🔗 4. Gerar o Link Manualmente

1. Copie o link gerado e envie ao solicitante pelo canal de comunicação mais adequado (como e-mail ou chat), garantindo que o destinatário tenha acesso rápido e seguro ao documento

---

---

### 📌 Observações Importantes

- O link gerado é **pessoal e intransferível**.
- O assinante precisa ter conta no gov.br com nível de confiabilidade suficiente para assinar ou ter certificado ICP Brasil.
- O sistema registra a hora e a origem da assinatura feita pelo link externo.

Caso o link não funcione ou o documento não apareça para o assinante, entre em contato com o **suporte técnico do e-Ciga**.

# Relatório de documentos e processos arquivado por um usuário

É possivel que sejam solicitados que listemos documentos e processos arquivados por um determinado usuário.

Utilize o aggregate para gerar relatório destas informações:

1. Acessar o link https://aggregate.eciga.consorciociga.gov.br/?ente=niteroi&amp;collection=processos&amp;pipeline=WwoKCiAgICB7CiAgICAgICAgJG1hdGNoOiB7CiAgICAgICAgICAgICdjYXJnYS5yZWFsaXphZG9Qb3InOiBPYmplY3RJZCgnNjUyZThkM2EzYzc5ZjliNjYxODU1ZGVmJyksCiAgICAgICAgICAgICdjYXJnYS5kZXN0aW5vJzogIE9iamVjdElkKCcwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAnKQogICAgICAgIH0KICAgIH0sCgl7ICRwcm9qZWN0OiB7IF9pZDogMCwgJ1TtdHVsbyc6ICckdGl0dWxvJywgJ0lkZW50aWZpY2Fkb3InOiAnJHV1aWQnIH0gfQpd
2. Atualizar o pipeline com o Objectid do usuário solicitado (buscar esta informação na coleção usuários utilizando o CPF através do campo login [![image.png](https://conhecimento.ciga.sc.gov.br/uploads/images/gallery/2025-07/scaled-1680-/image.png)](https://conhecimento.ciga.sc.gov.br/uploads/images/gallery/2025-07/image.png)
    
    [![image.png](https://conhecimento.ciga.sc.gov.br/uploads/images/gallery/2025-07/scaled-1680-/Etaimage.png)](https://conhecimento.ciga.sc.gov.br/uploads/images/gallery/2025-07/Etaimage.png)
3. Autencicar usuário com o certificado digital  
    [![image.png](https://conhecimento.ciga.sc.gov.br/uploads/images/gallery/2025-07/scaled-1680-/GYfimage.png)](https://conhecimento.ciga.sc.gov.br/uploads/images/gallery/2025-07/GYfimage.png)
4. Escolher a entidade no qual fará a consulta  
    [![image.png](https://conhecimento.ciga.sc.gov.br/uploads/images/gallery/2025-07/scaled-1680-/w1uimage.png)](https://conhecimento.ciga.sc.gov.br/uploads/images/gallery/2025-07/w1uimage.png)
5. Pesquisar usando a coleção processos e depois consultar utilizando a coleção documentos[![image.png](https://conhecimento.ciga.sc.gov.br/uploads/images/gallery/2025-07/scaled-1680-/UvOimage.png)](https://conhecimento.ciga.sc.gov.br/uploads/images/gallery/2025-07/UvOimage.png)
6. Exportar para json ou copiar o dados ao excel

# Renomear um setor

A renomeação de setores no sistema e-Ciga deve ser feita exclusivamente através do painel administrativo. A seguir, veja como realizar esse procedimento de forma segura:

<div id="bkmrk-">---

</div>### 🌐 1. Acessar o Painel de Renomeação de Setores

1. Acesse a URL: [https://admin.eciga.consorciociga.gov.br/Renomear\_setor](https://admin.eciga.consorciociga.gov.br/Renomear_setor)
2. Faça login com suas credenciais administrativas (perfil com permissão de gestão de entidades/setores).

<div id="bkmrk--1">---

</div>### 🏢 2. Selecionar o Ente

1. No topo da tela, selecione o **ente (órgão público)** ao qual o setor pertence.
2. A lista de setores vinculados ao ente será carregada.

<div id="bkmrk--2">---

</div>### ✏️ 3. Localizar e Selecionar o Setor a Ser Renomeado

1. Na lista de setores, localize o nome atual do setor que deseja renomear.
2. Clique sobre ele para selecioná-lo.

<div id="bkmrk--3">---

</div>### 🆕 4. Informar o Novo Nome do Setor

1. No campo correspondente, digite o **novo nome** do setor.
2. Verifique se a grafia está correta e consistente com o padrão da entidade.
3. **Atenção:** O nome do setor será alterado em todas as áreas do sistema onde ele for utilizado.

<div id="bkmrk--4">---

</div>### 💾 5. Confirmar a Renomeação

1. Após preencher o novo nome, clique no botão **"Renomear"**.
2. Aguarde a confirmação de que a alteração foi realizada com sucesso.

<div id="bkmrk--5">---

</div>### 📌 Observações Importantes

- A renomeação de setores não altera o histórico de trâmites, apenas atualiza o nome visível em caixas de entrada e registros.
- Certifique-se de que o novo nome do setor está correto, pois a alteração é imediata e afeta todos os usuários vinculados.
- Caso encontre inconsistências após a alteração, entre em contato com o **suporte do e-Ciga** via chat.

# Criar um Novo Ente no e-Ciga

Este procedimento deve ser seguido sempre que um novo ente for incorporado ao sistema de processo eletrônico do e-Ciga. Ele envolve duas partes principais:

1. **Configuração da realm no Keycloak (autenticação)**
2. **Criação do registro do ente no MongoDB (backend)**

---

# 🔐 **1️⃣ Criar e Configurar a Realm no Keycloak**

### ✔️ **1. Verificar se a Realm já Existe**

1. Acesse: **[https://sso.ciga.sc.gov.br/<svg class="block h-[0.75em] w-[0.75em] stroke-current stroke-[0.75]" data-rtl-flip="" fill="currentColor" height="20" viewbox="0 0 20 20" width="20" xmlns="http://www.w3.org/2000/svg"></svg>](https://sso.ciga.sc.gov.br/)**
2. Faça login com um usuário com permissão administrativa.
3. No menu lateral, clique na lista de *Realms*.
4. **Verifique se a realm já existe**.
    
    
    - Se não existir, prossiga com *Add realm*.

---

### ✔️ **2. Criar a Realm**

1. Clique em **Add Realm**.
2. No campo **Name**, informe o nome da realm:
    
    
    - **Apenas letras minúsculas**
    - **Sem espaços**
    - **Sem caracteres especiais**
3. Clique em **Create**.

A realm está criada — agora vamos configurá-la.

---

# ⚙️ **2️⃣ Configurações da Realm**

---

### ✔️ **General**

1. Vá em **General**.
2. No campo **Display Name**, informe o nome do ente como ele é apresentado oficialmente.
3. Em **HTML Display Name**, copie o mesmo conteúdo.
4. Clique em **Save**.

---

### ✔️ **Login**

1. Vá para a guia **Login**.
2. Habilite:
    
    
    - ✔️ *Forgot Password*
    - ✔️ *Login with email*
3. Clique em **Save**.

---

### ✔️ **Email**

1. Vá para a guia **Email**.
2. Configure:
    
    
    - **Host:** `lb2.consorciociga.gov.br`
    - **From:** `sso-no-reply@postal.consorciociga.gov.br`
    - **Enable Authentication:** habilitar
    - **Username:** `ciga`
    - **Password:** pegar no **Passbolt**
        
        
        - Se não tiver acesso → solicitar ao **Francis**, **Ricardo Taska** ou **Leandro**
3. Clique em **Save**.

---

### ✔️ **Themes**

1. Vá para a guia **Themes**.
2. Habilite:
    
    
    - ✔️ *Internationalization Enabled*
3. Em **Supported Locales**, deixe **apenas pt-BR**.
4. Em **Default Locale**, selecione **pt-BR**.
5. Clique em **Save**.

As configurações gerais estão concluídas. Agora vamos criar e configurar os *clients*.

---

# 🧩 **3️⃣ Configurar os Clients do Keycloak**

---

## **Client: eciga2**

### ✔️ **Criar o Client**

1. Vá em **Clients**.
2. Clique em **Create**.
3. Preencha:
    
    
    - **Client ID:** `eciga2`
    - **Client Protocol:** `openid-connect`
4. Clique em **Save**.

---

### ✔️ **Configurar o Client eciga2**

#### **Guia: Settings**

1. **Name:** `e-CIGA 2.0`
2. **Desabilitar:** *Direct Access Grants Enabled*
3. Em **Valid Redirect URIs**, adicionar (substituindo `nomedarealm`):

<div class="contain-inline-size rounded-2xl corner-superellipse/1.1 relative bg-token-sidebar-surface-primary" id="bkmrk-https%3A%2F%2Fnomedarealm."><div class="sticky top-9"><div class="absolute end-0 bottom-0 flex h-9 items-center pe-2"><div class="bg-token-bg-elevated-secondary text-token-text-secondary flex items-center gap-4 rounded-sm px-2 font-sans text-xs">  
</div></div></div><div class="overflow-y-auto p-4" dir="ltr">`https:<span class="hljs-comment">//nomedarealm.eciga.consorciociga.gov.br/*</span>https:<span class="hljs-comment">//ntfy.eciga.consorciociga.gov.br/oauth/callback</span>https:<span class="hljs-comment">//nomedarealm-treinamento-e2-186-250-92-134.beta.ciga.sc.gov.br/*</span>`</div></div>4. **Base URL:**

<div class="contain-inline-size rounded-2xl corner-superellipse/1.1 relative bg-token-sidebar-surface-primary" id="bkmrk-https%3A%2F%2Fnomedarealm.-1"><div class="sticky top-9"><div class="absolute end-0 bottom-0 flex h-9 items-center pe-2"><div class="bg-token-bg-elevated-secondary text-token-text-secondary flex items-center gap-4 rounded-sm px-2 font-sans text-xs">  
</div></div></div><div class="overflow-y-auto p-4" dir="ltr">`https:<span class="hljs-comment">//nomedarealm.eciga.consorciociga.gov.br/</span>`</div></div>5. **Web Origens:**

<div class="contain-inline-size rounded-2xl corner-superellipse/1.1 relative bg-token-sidebar-surface-primary" id="bkmrk-%2B"><div class="sticky top-9"><div class="absolute end-0 bottom-0 flex h-9 items-center pe-2"><div class="bg-token-bg-elevated-secondary text-token-text-secondary flex items-center gap-4 rounded-sm px-2 font-sans text-xs">  
</div></div></div><div class="overflow-y-auto p-4" dir="ltr">`<span class="hljs-addition">+</span>`</div></div>6. Clique em **Save**.

---

### ✔️ **Guia: Roles**

Criar 3 Roles:

- `access`
- `adminAcesso`
- `classificacaoDocumental`

Procedimento:

1. Clique em **Add Role**
2. Informe o nome da role
3. Clique em **Save**
4. Repita para as 3 roles

---

### ✔️ **Guia: Client Scopes**

1. Em **Assigned Default Client Scopes**
2. Selecione **web-origens**
3. Clique em **Remove selected**

---

### ✔️ **Guia: Mappers**

1. Clique em **Create**
2. **Name:** `groups`
3. **Mapper Type:** *Group Membership*
4. **Token Claim Name:** `groups`
5. Clique em **Save**

---

### ✔️ **Guia: Scope**

1. **Desmarque** a opção *Full Scope Allowed*
2. Clique em **Save**

Client `eciga2` finalizado.

---

## **Client: certificados**

### ✔️ **Criar / Importar**

O client **certificados** é criado via importação:

1. Baixe o arquivo [certificados.json](https://conhecimento.ciga.sc.gov.br/attachments/116)
2. Vá em **Clients** → **Create**
3. Clique em **Select file** no campo **Import**
4. Selecione o arquivo
5. Clique em **Save**

Client certificado criado.

---

# 🗂️ **4️⃣ Criar Grupos Padrão (Setores e Cargos)**

1. Vá em **Groups**.
2. Clique em **New**.
3. Crie o grupo:
    
    
    - `Setores`
4. Clique em **Save**
5. Repita o processo para criar:
    
    
    - `Cargo`

Configurações do Keycloak concluídas.

---

# 🗄️ **5️⃣ Criar o Ente no MongoDB**

1. Acesse o Mongo Express:  
    **[https://mongo.eciga.consorciociga.gov.br/db/eciga/entes<svg class="block h-[0.75em] w-[0.75em] stroke-current stroke-[0.75]" data-rtl-flip="" fill="currentColor" height="20" viewbox="0 0 20 20" width="20" xmlns="http://www.w3.org/2000/svg"></svg>](https://mongo.eciga.consorciociga.gov.br/db/eciga/entes)**
2. Clique em **New Document**
3. Preencha seguindo este modelo:

<div class="contain-inline-size rounded-2xl corner-superellipse/1.1 relative bg-token-sidebar-surface-primary" id="bkmrk-%7B-%22_id%22%3A-%22nomedareal"><div class="sticky top-9"><div class="absolute end-0 bottom-0 flex h-9 items-center pe-2"><div class="bg-token-bg-elevated-secondary text-token-text-secondary flex items-center gap-4 rounded-sm px-2 font-sans text-xs">  
</div></div></div><div class="overflow-y-auto p-4" dir="ltr">`<span class="hljs-punctuation">{</span>    <span class="hljs-attr">"_id"</span><span class="hljs-punctuation">:</span> <span class="hljs-string">"nomedarealm"</span><span class="hljs-punctuation">,</span>    <span class="hljs-attr">"mongoUri"</span><span class="hljs-punctuation">:</span> <span class="hljs-string">"/eciga-nomedarealm"</span><span class="hljs-punctuation">,</span>    <span class="hljs-attr">"nome"</span><span class="hljs-punctuation">:</span> <span class="hljs-string">"Prefeitura Municipal de *****"</span><span class="hljs-punctuation">,</span>    <span class="hljs-attr">"issuer"</span><span class="hljs-punctuation">:</span> <span class="hljs-string">"https://sso.ciga.sc.gov.br/auth/realms/nomedarealm"</span><span class="hljs-punctuation">,</span>    <span class="hljs-attr">"origin"</span><span class="hljs-punctuation">:</span> <span class="hljs-string">"https://nomedarealm.eciga.consorciociga.gov.br"</span><span class="hljs-punctuation">,</span>    <span class="hljs-attr">"diarioCodigoEntidade"</span><span class="hljs-punctuation">:</span> **<span class="hljs-punctuation">}</span>`</div></div>4. Clique em **Save**

---

# 🔎 **⚠️ Informações Importantes**

- **O código do diário** deve ser solicitado ao **Francis** ou **Bruno**.
- O campo **\_id** deve ser **exatamente** o nome da realm criada no Keycloak.
- A URL deve seguir rigorosamente o padrão do e-Ciga.
- Após isso, ainda será necessário:
    
    
    - Ativar buckets do ente (solicitar ao Francis)
    - Reiniciar o backend (solicitar ao Francis)

# Restaurar um Documento Excluído no e-Ciga

# ♻️ **Como Restaurar um Documento Excluído no e-Ciga**

Este procedimento deve ser utilizado quando um documento foi excluído indevidamente e precisa ser restaurado manualmente no sistema.

---

## 🔍 **1️⃣ Localizar o Documento Excluído**

1. Acesse o **Mongo Express**.
2. Entre no banco de dados correspondente à **entidade solicitante**.
3. Acesse a coleção:
    
    <div class="contain-inline-size rounded-2xl corner-superellipse/1.1 relative bg-token-sidebar-surface-primary"><div class="sticky top-[calc(--spacing(9)+var(--header-height))] @w-xl/main:top-9"><div class="absolute end-0 bottom-0 flex h-9 items-center pe-2"><div class="bg-token-bg-elevated-secondary text-token-text-secondary flex items-center gap-4 rounded-sm px-2 font-sans text-xs">  
    </div></div></div><div class="overflow-y-auto p-4" dir="ltr">`<span class="hljs-attribute">documentos_excluidos</span>`</div></div>
4. Utilize os filtros disponíveis (ex.: `_id`, número do documento, processo relacionado, etc.) para **localizar o documento excluído**.
5. Ao localizar o registro, **abra o documento** para visualização completa.

---

## 📋 **2️⃣ Copiar o Conteúdo do Registro**

1. Com o documento aberto na coleção `documentos_excluidos`, **copie todo o conteúdo do registro**.
2. Garanta que o conteúdo seja copiado integralmente, mantendo a estrutura original (JSON).

---

## 📁 **3️⃣ Recriar o Documento na Coleção Ativa**

1. Ainda no Mongo Express, acesse a coleção:
    
    <div class="contain-inline-size rounded-2xl corner-superellipse/1.1 relative bg-token-sidebar-surface-primary"><div class="sticky top-[calc(--spacing(9)+var(--header-height))] @w-xl/main:top-9"><div class="absolute end-0 bottom-0 flex h-9 items-center pe-2"><div class="bg-token-bg-elevated-secondary text-token-text-secondary flex items-center gap-4 rounded-sm px-2 font-sans text-xs">  
    </div></div></div><div class="overflow-y-auto p-4" dir="ltr">`<span class="hljs-attribute">documentos</span>`</div></div>
2. Clique em **New Document** (ou *Adicionar novo documento*).
3. **Cole exatamente o conteúdo copiado** do registro do documento excluído.
4. Verifique se o conteúdo foi colado corretamente.
5. Clique em **Save**.

➡️ Neste momento, o documento é restaurado para a base ativa do e-Ciga.

---

## 🗑️ **4️⃣ Remover o Registro da Coleção documentos\_excluidos**

1. Retorne à coleção:
    
    <div class="contain-inline-size rounded-2xl corner-superellipse/1.1 relative bg-token-sidebar-surface-primary"><div class="sticky top-[calc(--spacing(9)+var(--header-height))] @w-xl/main:top-9"><div class="absolute end-0 bottom-0 flex h-9 items-center pe-2"><div class="bg-token-bg-elevated-secondary text-token-text-secondary flex items-center gap-4 rounded-sm px-2 font-sans text-xs">  
    </div></div></div><div class="overflow-y-auto p-4" dir="ltr">`<span class="hljs-attribute">documentos_excluidos</span>`</div></div>
2. Localize novamente o registro do documento restaurado.
3. **Exclua o registro de exclusão** (Delete).
4. Confirme a exclusão.

---

## ✅ **5️⃣ Finalização**

- Após esses passos, o documento:
    
    
    - Volta a constar normalmente no sistema
    - Deixa de aparecer como excluído
- Caso o documento não apareça de imediato na interface do e-Ciga, oriente o usuário a **atualizar a página (F5)** ou realizar novo acesso.

---

## ⚠️ **Observações Importantes**

- Este procedimento deve ser executado **apenas por administradores com acesso ao MongoDB**.
- Não altere campos do documento durante a cópia, exceto se houver orientação técnica específica.
- Recomenda-se realizar este procedimento fora do horário de pico sempre que possível.

# Restaurar um Processo Excluído no e-Ciga

# ♻️ **Como Restaurar um Processo Excluído no e-Ciga**

Este procedimento deve ser utilizado quando um **processo foi excluído indevidamente** e precisa ser restaurado manualmente no sistema por meio do MongoDB.

---

## 🔍 **1️⃣ Localizar o Processo Excluído**

1. Acesse o **Mongo Express**.
2. Entre no banco de dados correspondente à **entidade solicitante**.
3. Acesse a coleção:
    
    <div class="contain-inline-size rounded-2xl corner-superellipse/1.1 relative bg-token-sidebar-surface-primary"><div class="sticky top-[calc(--spacing(9)+var(--header-height))] @w-xl/main:top-9"><div class="absolute end-0 bottom-0 flex h-9 items-center pe-2"><div class="bg-token-bg-elevated-secondary text-token-text-secondary flex items-center gap-4 rounded-sm px-2 font-sans text-xs">  
    </div></div></div><div class="overflow-y-auto p-4" dir="ltr">`<span class="hljs-attribute">processos_excluidos</span>`</div></div>
4. Utilize os filtros disponíveis (ex.: `_id`, número do processo, interessado, setor autuante, etc.) para **localizar o processo excluído**.
5. Ao encontrar o registro, **abra o documento** para visualização completa.

---

## 📋 **2️⃣ Copiar o Conteúdo do Registro**

1. Com o processo aberto na coleção `processos_excluidos`, **copie todo o conteúdo do registro**.
2. Certifique-se de copiar o JSON completo, mantendo a estrutura original do processo.

---

## 📁 **3️⃣ Recriar o Processo na Coleção Ativa**

1. No Mongo Express, acesse a coleção:
    
    <div class="contain-inline-size rounded-2xl corner-superellipse/1.1 relative bg-token-sidebar-surface-primary"><div class="sticky top-[calc(--spacing(9)+var(--header-height))] @w-xl/main:top-9"><div class="absolute end-0 bottom-0 flex h-9 items-center pe-2"><div class="bg-token-bg-elevated-secondary text-token-text-secondary flex items-center gap-4 rounded-sm px-2 font-sans text-xs">  
    </div></div></div><div class="overflow-y-auto p-4" dir="ltr">`<span class="hljs-attribute">processos</span>`</div></div>
2. Clique em **New Document** (Adicionar novo documento).
3. **Cole integralmente o conteúdo copiado** do registro do processo excluído.
4. Verifique se todos os campos foram colados corretamente.
5. Clique em **Save**.

➡️ Neste momento, o processo é restaurado para a base ativa do e-Ciga.

---

## 🗑️ **4️⃣ Remover o Registro da Coleção processos\_excluidos**

1. Retorne à coleção:
    
    <div class="contain-inline-size rounded-2xl corner-superellipse/1.1 relative bg-token-sidebar-surface-primary"><div class="sticky top-[calc(--spacing(9)+var(--header-height))] @w-xl/main:top-9"><div class="absolute end-0 bottom-0 flex h-9 items-center pe-2"><div class="bg-token-bg-elevated-secondary text-token-text-secondary flex items-center gap-4 rounded-sm px-2 font-sans text-xs">  
    </div></div></div><div class="overflow-y-auto p-4" dir="ltr">`<span class="hljs-attribute">processos_excluidos</span>`</div></div>
2. Localize novamente o registro do processo que foi restaurado.
3. **Exclua o registro de exclusão** (Delete).
4. Confirme a exclusão.

---

## ✅ **5️⃣ Finalização e Validação**

- Após a execução dos passos:
    
    
    - O processo volta a constar normalmente no e-Ciga
    - O histórico e os vínculos (documentos, interessados, trâmites) são preservados
- Caso o processo não apareça imediatamente:
    
    
    - Oriente o usuário a **atualizar a página (F5)** ou
    - Realizar novo login no sistema

---

## ⚠️ **Observações Importantes**

- Procedimento **restrito a administradores** com acesso ao MongoDB.
- Não altere dados do processo durante a cópia, salvo orientação técnica.
- Em processos com grande volume de documentos, recomenda-se validar se **todos os documentos vinculados** estão ativos.
- Caso existam documentos também excluídos, eles devem ser restaurados **antes ou após** a restauração do processo, conforme o cenário.

# Movimentar Documento ou Processo Personificando um Usuário no e-Ciga

# 🔁 **Como Movimentar Documento ou Processo Personificando um Usuário no e-Ciga**

Este procedimento deve ser utilizado **exclusivamente pelo suporte do Ciga**, quando é necessário movimentar um **documento ou processo em nome de um usuário**, geralmente por falta de acesso, afastamento ou indisponibilidade do responsável original.

---

## 🔐 **1️⃣ Acessar o Keycloak**

1. Acesse o **Keycloak** pelo endereço:
    
    <div class="contain-inline-size rounded-2xl corner-superellipse/1.1 relative bg-token-sidebar-surface-primary"><div class="sticky top-[calc(--spacing(9)+var(--header-height))] @w-xl/main:top-9"><div class="absolute end-0 bottom-0 flex h-9 items-center pe-2"><div class="bg-token-bg-elevated-secondary text-token-text-secondary flex items-center gap-4 rounded-sm px-2 font-sans text-xs">  
    </div></div></div><div class="overflow-y-auto p-4" dir="ltr">`https:<span class="hljs-comment">//sso.ciga.sc.gov.br/</span>`</div></div>
2. Localize a **realm (ente)** à qual pertence o documento ou processo.
3. Acesse a guia **Users**.
4. Localize o **usuário que possui a carga/posse** do documento ou processo.
5. Clique sobre o nome do usuário para abrir os detalhes.

---

## 🧑‍💻 **2️⃣ Personificar o Usuário**

1. Na tela do usuário, acesse a guia **Impersonate**.
2. Clique em **Impersonate** para acessar o sistema como se fosse o usuário selecionado.
3. Uma nova sessão será aberta já autenticada com as permissões do usuário.

⚠️ **Atenção:** Todas as ações realizadas nesta sessão ficam registradas como se fossem executadas pelo próprio usuário.

---

## 📂 **3️⃣ Acessar o e-Ciga**

1. Com a sessão de personificação ativa, acesse o **e-Ciga** normalmente.
2. Localize o **documento ou processo** que precisa ser movimentado:
    
    
    - Caixa de entrada
    - Documentos não enviados
    - Processos em posse
    - Busca pelo número ou assunto

---

## 📤 **4️⃣ Realizar a Movimentação**

1. No menu do **documento ou processo**, clique na opção **Enviar**.
2. Informe o **destinatário** (setor, grupo ou usuário), conforme solicitado.
3. No campo de observações/mensagem, **registre obrigatoriamente** o seguinte texto:

<div class="contain-inline-size rounded-2xl corner-superellipse/1.1 relative bg-token-sidebar-surface-primary" id="bkmrk-documento%2Fprocesso-m"><div class="sticky top-[calc(--spacing(9)+var(--header-height))] @w-xl/main:top-9"><div class="absolute end-0 bottom-0 flex h-9 items-center pe-2"><div class="bg-token-bg-elevated-secondary text-token-text-secondary flex items-center gap-4 rounded-sm px-2 font-sans text-xs">  
</div></div></div><div class="overflow-y-auto p-4" dir="ltr">`Documento/Processo movimentado pela equipe <span class="hljs-keyword">do</span> Ciga, a pedido de [nome <span class="hljs-keyword">do</span> solicitante], através <span class="hljs-keyword">do</span> chat nº [número <span class="hljs-keyword">do</span> chat].`</div></div>4. Finalize a movimentação clicando em **Enviar**.

---

## 🔚 **5️⃣ Encerrar a Personificação**

1. Após concluir a movimentação:
    
    
    - Encerre a sessão do e-Ciga
    - Finalize a personificação no Keycloak
2. Retorne à sua sessão administrativa normal.

---

## 📝 **Observações Importantes**

- Este procedimento deve ser realizado **somente mediante solicitação formal** (ex.: chamado, chat, e-mail institucional).
- A mensagem de movimentação é **obrigatória** para fins de:
    
    
    - Auditoria
    - Transparência
    - Rastreabilidade
- Não realizar outras ações na conta personificada além daquelas solicitadas.
- Sempre registrar no atendimento o **usuário personificado**, o **documento/processo** e o **destinatário final**.

# Correção de Miniatura de Documento ou Processo Indisponível no e-Ciga

# **Correção de Miniatura de Documento ou Processo Indisponível no e-Ciga**

Quando a miniatura (pré-visualização) de um **documento ou processo** não é exibida corretamente no e-Ciga, normalmente trata-se de uma inconsistência no campo responsável pela miniatura armazenada no banco de dados. O sistema é capaz de **regerar automaticamente** essa miniatura após a correção.

---

## 🔎 **1️⃣ Identificar o Documento ou Processo**

1. No e-Ciga, identifique:
    
    
    - Número do documento ou processo
    - Tipo (documento ou processo)
    - Entidade (ente) ao qual pertence

Essas informações serão necessárias para localizar o registro no banco de dados.

---

## 🗄️ **2️⃣ Acessar o Mongo Express**

1. Acesse o **Mongo Express**:
    
    <div class="contain-inline-size rounded-2xl corner-superellipse/1.1 relative bg-token-sidebar-surface-primary"><div class="sticky top-[calc(--spacing(9)+var(--header-height))] @w-xl/main:top-9"><div class="absolute end-0 bottom-0 flex h-9 items-center pe-2"><div class="bg-token-bg-elevated-secondary text-token-text-secondary flex items-center gap-4 rounded-sm px-2 font-sans text-xs">  
    </div></div></div><div class="overflow-y-auto p-4" dir="ltr">`https:<span class="hljs-comment">//mongo.eciga.consorciociga.gov.br/</span>`</div></div>
2. Selecione a base de dados correspondente à **entidade solicitante**.

---

## 📄 **3️⃣ Localizar o Registro**

### Para Documento:

1. Acesse a coleção **documentos**.
2. Localize o registro do documento:
    
    
    - Pelo número
    - Pelo `_id`
    - Ou por outros campos identificadores disponíveis

### Para Processo:

1. Acesse a coleção **processos**.
2. Localize o registro do processo correspondente.

---

## ✏️ **4️⃣ Remover o Campo de Miniatura**

1. Clique no registro para edição.
2. Localize o campo:
    
    <div class="contain-inline-size rounded-2xl corner-superellipse/1.1 relative bg-token-sidebar-surface-primary"><div class="sticky top-[calc(--spacing(9)+var(--header-height))] @w-xl/main:top-9"><div class="absolute end-0 bottom-0 flex h-9 items-center pe-2"><div class="bg-token-bg-elevated-secondary text-token-text-secondary flex items-center gap-4 rounded-sm px-2 font-sans text-xs">  
    </div></div></div><div class="overflow-y-auto p-4" dir="ltr">`<span class="hljs-attribute">miniatura</span>`</div></div>
3. **Apague completamente o campo `miniatura`**, incluindo:
    
    
    - O nome do campo
    - Seu conteúdo
    - A vírgula correspondente, respeitando a estrutura do documento JSON
4. Clique em **Save** para salvar a alteração.

⚠️ **Importante:**  
Não substitua o valor do campo por `null` ou vazio. O campo deve ser **removido** do registro.

---

## 🔄 **5️⃣ Regerar a Miniatura no e-Ciga**

1. Retorne ao **e-Ciga**.
2. Acesse novamente o **documento ou processo** corrigido.
3. O sistema irá:
    
    
    - Detectar a ausência do campo `miniatura`
    - Gerar automaticamente uma nova miniatura
    - Exibir corretamente a pré-visualização

---

## ✅ **6️⃣ Validação Final**

1. Atualize a tela (F5), se necessário.
2. Verifique se a miniatura:
    
    
    - Está visível
    - Corresponde ao conteúdo correto
3. Caso não seja gerada imediatamente, aguarde alguns instantes e acesse novamente o registro.

---

## 📝 **Observações Importantes**

- O procedimento não altera o conteúdo do documento ou processo.
- A regeneração da miniatura é automática e segura.
- Este procedimento deve ser realizado apenas por usuários com **acesso administrativo ao MongoDB**.
- Caso a miniatura continue indisponível após o procedimento, o problema deve ser escalado para a equipe técnica de backend do Ciga.

# Reinscrever um e-mail Desinscrito no e-Ciga

# 📧 **Como Reinscrever um E-mail Desinscrito no e-Ciga**

Quando um usuário deixa de receber e-mails automáticos do e-Ciga, pode ser que o endereço tenha sido **desinscrito manualmente ou automaticamente** do envio de notificações.  
Nesses casos, é possível **reinscrever o e-mail diretamente no Redis**.

---

## 🛠️ **Procedimento para Reinscrição do E-mail**

### 1️⃣ Acessar o Redis

1. Acesse a URL:  
    👉 [https://redis.eciga.consorciociga.gov.br/<svg aria-hidden="true" class="block h-[0.75em] w-[0.75em] stroke-current stroke-[0.75]" data-rtl-flip="" height="20" width="20" xmlns="http://www.w3.org/2000/svg"></svg>](https://redis.eciga.consorciociga.gov.br/)
2. Faça login com um usuário que possua permissão administrativa.

---

### 2️⃣ Navegar até o Caminho Correto

No painel do Redis, navegue seguindo a estrutura:

<div class="contain-inline-size rounded-2xl corner-superellipse/1.1 relative bg-token-sidebar-surface-primary" id="bkmrk-e2-%E2%94%94%E2%94%80%E2%94%80-worker-%E2%94%94%E2%94%80%E2%94%80-st"><div class="sticky top-[calc(--spacing(9)+var(--header-height))] @w-xl/main:top-9"><div class="absolute end-0 bottom-0 flex h-9 items-center pe-2"><div class="bg-token-bg-elevated-secondary text-token-text-secondary flex items-center gap-4 rounded-sm px-2 font-sans text-xs">  
</div></div></div><div class="overflow-y-auto p-4" dir="ltr">`e2 └── worker<span class="hljs-code">     └── store         └── unsubscribed</span>`</div></div>Esse local armazena todos os e-mails que foram desinscritos do envio automático de mensagens.

---

### 3️⃣ Localizar o E-mail Desinscrito

1. Utilize a busca do navegador:
    
    
    - Pressione **F3** (ou **Ctrl + F**, conforme o navegador).
2. Digite o **endereço de e-mail** que deve ser reinscrito.
3. Aguarde até localizar o e-mail na lista.

---

### 4️⃣ Remover o E-mail da Lista de Desinscritos

1. Dê **duplo clique** sobre o e-mail encontrado.
2. Clique na opção **Remove Member**.
3. Confirme a ação, se solicitado.

Essa ação remove o e-mail da lista de bloqueio e permite que ele volte a receber comunicações do sistema.

---

## ✅ **Resultado Esperado**

- O e-mail será **reinscrito** para recebimento de mensagens do e-Ciga.
- Novas notificações automáticas (assinaturas, movimentações, convites, etc.) voltarão a ser enviadas normalmente.

---

## 📌 **Observações Importantes**

- A reinscrição **não reenvia e-mails antigos**.
- Apenas **novas notificações** serão entregues após o procedimento.
- Caso o usuário ainda não receba mensagens:
    
    
    - Verifique spam/lixo eletrônico;
    - Confirme se o domínio do e-mail não está bloqueando o remetente;
    - Avalie se há outro problema de entrega (SMTP).

---

## 🧾 **Mensagem Sugerida ao Usuário**

> “Seu e-mail foi reinscrito para receber notificações do e-Ciga. A partir de agora, novas mensagens do sistema voltarão a ser entregues normalmente.”

# Desativar Notificações por E-mail de um Ente no e-Ciga

# 📭 **Como Desativar Notificações por E-mail de um Ente no e-Ciga**

Quando é necessário interromper **todo o envio de e-mails do e-Ciga para um ente específico** (ex.: manutenção, testes, problemas de entrega), a configuração deve ser feita diretamente no **MongoDB**.

---

## 🛠️ **Procedimento para Desativação**

### 1️⃣ Acessar o Mongo Express

1. Acesse a URL:  
    👉 [https://mongo.eciga.consorciociga.gov.br/db/eciga/entes<svg aria-hidden="true" class="block h-[0.75em] w-[0.75em] stroke-current stroke-[0.75]" data-rtl-flip="" height="20" width="20" xmlns="http://www.w3.org/2000/svg"></svg>](https://mongo.eciga.consorciociga.gov.br/db/eciga/entes)
2. Faça login com um usuário que possua permissão administrativa.

---

### 2️⃣ Localizar o Ente

1. Na lista de documentos da coleção **entes**, localize o ente desejado.
    
    
    - Normalmente o ente é identificado pelo campo `_id` (nome da realm).
2. Clique sobre o registro correspondente para abrir o conteúdo.

---

### 3️⃣ Inserir o Campo de Desativação de Notificações

1. Dentro do documento do ente, adicione o seguinte campo:

<div class="contain-inline-size rounded-2xl corner-superellipse/1.1 relative bg-token-sidebar-surface-primary" id="bkmrk-notificacoesdesativa"><div class="sticky top-[calc(--spacing(9)+var(--header-height))] @w-xl/main:top-9"><div class="absolute end-0 bottom-0 flex h-9 items-center pe-2"><div class="bg-token-bg-elevated-secondary text-token-text-secondary flex items-center gap-4 rounded-sm px-2 font-sans text-xs">  
</div></div></div><div class="overflow-y-auto p-4" dir="ltr">`notificacoesDesativadas<span class="hljs-punctuation">:</span> <span class="hljs-literal"><span class="hljs-keyword">true</span></span>`</div></div>> 🔎 Caso o campo já exista, apenas altere o valor para `true`.

2. Certifique-se de manter a **sintaxe correta**, incluindo vírgula quando necessário entre os campos.

---

### 4️⃣ Salvar as Alterações

1. Clique no botão **Save** para gravar a alteração.

---

## ✅ **Resultado Esperado**

- **Todos os usuários do ente** deixarão de receber **qualquer notificação por e-mail** do e-Ciga.
- Isso inclui:
    
    
    - Solicitações de assinatura;
    - Movimentações de documentos e processos;
    - Convites para assinantes externos;
    - Demais comunicações automáticas do sistema.

---

## ⚠️ **Observações Importantes**

- A desativação é **global para o ente** — não é possível manter e-mails ativos para usuários específicos enquanto essa opção estiver habilitada.
- Para reativar o envio de e-mails, basta:
    
    
    - Remover o campo `notificacoesDesativadas`, ou
    - Alterar o valor para `false`.

<div class="contain-inline-size rounded-2xl corner-superellipse/1.1 relative bg-token-sidebar-surface-primary" id="bkmrk-notificacoesdesativa-1"><div class="sticky top-[calc(--spacing(9)+var(--header-height))] @w-xl/main:top-9"><div class="absolute end-0 bottom-0 flex h-9 items-center pe-2"><div class="bg-token-bg-elevated-secondary text-token-text-secondary flex items-center gap-4 rounded-sm px-2 font-sans text-xs">  
</div></div></div><div class="overflow-y-auto p-4" dir="ltr">`notificacoesDesativadas<span class="hljs-punctuation">:</span> <span class="hljs-literal"><span class="hljs-keyword">false</span></span>`</div></div>- A alteração **não afeta**:
    
    
    - Assinaturas realizadas via link;
    - Funcionamento interno do sistema;
    - Registro de eventos e auditoria.

---

## 🧾 **Mensagem Sugerida ao Usuário / Ente**

> “As notificações por e-mail do e-Ciga foram temporariamente desativadas para este ente. O sistema continua funcionando normalmente, porém sem envio de mensagens automáticas.”

# Reconsiderar Documento Desconsiderado no e-Ciga

# ♻️ **Passo a Passo: Reconsiderar Documento Desconsiderado no e-Ciga**

A reconsideração de uma peça **desconsiderada por engano** é uma ação **excepcional**, realizada diretamente no banco de dados, e **somente pode ser solicitada pelo próprio usuário que realizou a desconsideração**.

---

## ⚠️ **Premissas Importantes**

- A reconsideração **não possui interface no sistema**.
- A ação deve ser executada **exclusivamente pelo suporte técnico autorizado**.
- O procedimento consiste na **remoção do trâmite de desconsideração** registrado no histórico do documento.
- O documento volta a ser considerado **válido no processo** após a correção.

---

## 🛠️ **Procedimento Técnico**

### 1️⃣ Acessar o Mongo Express

1. Acesse o Mongo Express da entidade solicitante.
2. Entre na base de dados correspondente ao ente.
3. Acesse a coleção **documentos**.

---

### 2️⃣ Localizar o Documento

1. Localize o documento que foi desconsiderado:
    
    
    - Preferencialmente pelo `_id` do documento;
    - Ou por outros campos disponíveis no cadastro.
2. Clique sobre o registro para abrir o conteúdo completo.

---

### 3️⃣ Identificar o Trâmite de Desconsideração

1. Dentro do documento, localize o array chamado **`tramites`**.
2. Percorra os registros do array até encontrar o trâmite com a seguinte informação:

<div class="contain-inline-size rounded-2xl corner-superellipse/1.1 relative bg-token-sidebar-surface-primary" id="bkmrk-%22__t%22%3A-%22tramitedesco"><div class="sticky top-[calc(--spacing(9)+var(--header-height))] @w-xl/main:top-9"><div class="absolute end-0 bottom-0 flex h-9 items-center pe-2"><div class="bg-token-bg-elevated-secondary text-token-text-secondary flex items-center gap-4 rounded-sm px-2 font-sans text-xs">  
</div></div></div><div class="overflow-y-auto p-4" dir="ltr">`<span class="hljs-attr">"__t"</span><span class="hljs-punctuation">:</span> <span class="hljs-string">"TramiteDesconsideracao"</span>`</div></div>> 🔎 Este registro representa exatamente o momento em que o documento foi desconsiderado no processo.

---

### 4️⃣ Remover o Trâmite de Desconsideração

1. **Apague completamente o objeto** referente ao trâmite de desconsideração:
    
    
    - Desde a **chave de abertura `{`** até a **chave de fechamento `}`**.
2. Tenha cuidado para:
    
    
    - Manter a estrutura correta do array;
    - Ajustar vírgulas entre os objetos restantes, evitando erro de sintaxe.

---

### 5️⃣ Salvar a Alteração

1. Após remover o trâmite, clique em **Save** para gravar as alterações.

---

## ✅ **Resultado Esperado**

- O documento será **automaticamente reconsiderado** pelo sistema.
- A peça volta a:
    
    
    - Ser considerada válida no processo;
    - Aparecer corretamente na linha do tempo;
    - Participar novamente das ações processuais.

---

## 📌 **Observações Importantes**

- O histórico do documento **não exibirá mais o evento de desconsideração**.
- Não é necessário reiniciar serviços ou backend.
- **Somente pode ser solicitada pelo próprio usuário que realizou a desconsideração**

---

## 🧾 **Mensagem Sugerida para Registro do Atendimento**

> “Documento reconsiderado mediante solicitação do próprio usuário que realizou a desconsideração, com ajuste direto no histórico de trâmites do sistema e-Ciga.”

# Dificuldade para Cadastrar um Marcador no e-Ciga

# 🏷️ **Dificuldade para Cadastrar um Marcador no e-Ciga**

Alguns usuários entram em contato informando que **não conseguem cadastrar um novo marcador**, pois, mesmo digitando o nome, o botão de cadastro **não é habilitado**.  
Esse comportamento é esperado pelo sistema e ocorre, na maioria dos casos, por um detalhe no preenchimento do campo.

---

## 🔍 **Motivo do Problema**

O e-Ciga **só reconhece o marcador como válido após a confirmação do texto**, que é feita **pressionando a tecla ENTER** no campo de digitação.

Apenas digitar o nome **não é suficiente** para que o sistema entenda que o marcador foi criado.

---

## ✅ **Forma Correta de Criar um Marcador**

### 1️⃣ Acessar o Cadastro do Marcador

1. Acesse o documento ou processo no e-Ciga.
2. Localize o campo de **Marcadores**.

---

### 2️⃣ Digitar o Nome do Marcador

1. No campo de marcadores, **digite o nome desejado** para o novo marcador.

📌 Exemplo:

<div class="contain-inline-size rounded-2xl corner-superellipse/1.1 relative bg-token-sidebar-surface-primary" id="bkmrk-urgente"><div class="sticky top-[calc(--spacing(9)+var(--header-height))] @w-xl/main:top-9"><div class="absolute end-0 bottom-0 flex h-9 items-center pe-2"><div class="bg-token-bg-elevated-secondary text-token-text-secondary flex items-center gap-4 rounded-sm px-2 font-sans text-xs">  
</div></div></div><div class="overflow-y-auto p-4" dir="ltr">`<span class="hljs-attribute">Urgente</span>`</div></div>---

### 3️⃣ Confirmar o Marcador (Passo Essencial)

1. **Pressione a tecla ENTER** no teclado após digitar o nome.
2. O marcador será convertido automaticamente em um item visível no campo.

⚠️ **Atenção:**  
Se a tecla **ENTER não for pressionada**, o sistema **não habilita o botão de cadastro**, pois entende que o marcador ainda não foi confirmado.

---

### 4️⃣ Finalizar o Cadastro

1. Após confirmar o marcador com ENTER, o botão de cadastro/atualização será habilitado.
2. Conclua a ação normalmente.

---

## 🧠 **Dica Importante ao Usuário**

> “Sempre que criar um novo marcador no e-Ciga, digite o nome e **pressione ENTER** para confirmar. Somente após isso o sistema permitirá salvar.”

---

## 📌 **Resumo Rápido**

- ❌ Apenas digitar o nome → **não funciona**
- ✅ Digitar o nome + **pressionar ENTER** → **funciona**
- ✔️ Botão de cadastro habilitado automaticamente após a confirmação

---

## 🧾 **Mensagem Padrão para Atendimento do Suporte**

> “O cadastro do marcador exige a confirmação com a tecla ENTER após digitar o nome. Após essa ação, o sistema reconhece o marcador e habilita o botão de cadastro.”