Profile Server API
Manual do usuário

Documentos

Envio, acompanhamento e revisão dos documentos das organizações.

Menu: Documentos (/documents)

Aqui ficam os documentos enviados pelas organizações, com seu status de revisão.

Ação varia por perfil

O perfil visualizador só consulta documentos. O técnico cadastra e edita, mas não revisa (ver abaixo). Veja Permissões.

A tela

A listagem tem quatro filtros no topo — Organização, Tipo de documento, Status e Auditoria — e as colunas Organização, Tipo, Status, Emissão e Validade. O filtro Auditoria mostra só os documentos de tipos que sofrem (ou que não sofrem) auditoria, conforme a marcação atual do tipo em Tipos de Documento.

Os status possíveis:

StatusSignificado
PendenteEnviado e aguardando revisão. É assim que nasce todo documento de um tipo que exige aprovação.
AprovadoRevisado e aceito — ou enviado para um tipo que não exige aprovação, caso em que já entra aprovado, sem revisão.
ReprovadoRevisado e recusado — veja o comentário da revisão nos detalhes.

Enviar um documento

Clique em Novo documento:

CampoObrigatórioObservações
OrganizaçãoSimBusque pelo nome.
Tipo de documentoSimSó aparecem tipos ativos. A escolha define os campos exigidos abaixo.
ArquivoSim (no envio)Arraste o arquivo para a área tracejada ou clique nela para procurar no computador. Aceita PDF, imagens (PNG, JPG, WEBP), documentos (DOC, DOCX, ODT) e planilhas (XLS, XLSX, ODS, CSV); outros formatos são recusados na hora. O arquivo escolhido aparece com nome e tamanho, e o X no canto o remove. Na edição, enviar um novo arquivo substitui o atual.
Data de emissãoSimData em que o documento foi emitido.
Data de validadeDepende do tipoAparece e é exigida quando o tipo tem expiração. Se o tipo tiver dias de validade padrão, ela é calculada sozinha a partir da data de emissão — e pode ser ajustada à mão.
Código de autenticidadeDepende do tipoAparece e é exigido quando o tipo pede código de autenticidade.

Cada organização tem, por tipo de documento, no máximo um documento pendente e um aprovado em vigor. Por isso:

  • Com um documento pendente do mesmo tipo, o envio é recusado até que ele seja revisado.
  • Com um documento aprovado e ainda válido, o envio é uma renovação — veja abaixo.
  • Com um documento aprovado e vencido, o envio é aceito normalmente.

Renovar um documento antes de vencer

Não é preciso esperar o documento vencer para enviar o próximo. Envie o novo documento do mesmo tipo com uma data de validade posterior à do documento em vigor — se a data for igual ou anterior, o envio é recusado.

O documento em vigor continua valendo até o novo passar a valer:

  • Se o tipo exige aprovação, o novo entra como Pendente e o anterior segue valendo até a aprovação. Se o novo for reprovado, nada muda: o anterior continua em vigor.
  • Se o tipo não exige aprovação, o novo já entra Aprovado e substitui o anterior na hora.

Ao ser substituído, o documento anterior sai da listagem, mas não é apagado: ele fica no histórico da organização (veja Documentos inativos).

Documento sem validade

Documento de um tipo sem expiração nunca vence, então não dá para renová-lo. Para trocá-lo, exclua o anterior e envie o novo.

Ações de cada documento

Na linha do documento:

  • Detalhes — todos os dados, incluindo quem revisou, quando ("Revisado em") e o comentário da revisão.
  • Baixar arquivo — baixa o arquivo enviado.
  • Editar — ajusta datas, código ou substitui o arquivo. Não aparece em documentos inativos.
  • Revisar — aprova ou reprova (ver abaixo). Só aparece em documentos pendentes e ativos: uma decisão já tomada não é refeita.
  • Reativar — só em documentos inativos (veja abaixo).
  • Excluir — remove o documento, com confirmação.

Documentos inativos (histórico)

Um documento fica inativo quando deixa de valer sem ter sido excluído:

SeloQuando acontece
SubstituídoUma renovação passou a valer no lugar dele.
Alerta desligadoAlguém desligou o alerta de um documento vencido na tela de Pendências. Passe o mouse sobre o selo para ver o motivo.

Inativos ficam fora da listagem. Ligue Mostrar inativos — no topo da tela de Documentos ou no quadro de documentos da organização — para vê-los. Eles aparecem esmaecidos, e os Detalhes dizem por que e quando deixaram de valer; num substituído, também até quando vale o documento que entrou no lugar.

Inativo não pode ser editado nem revisado. Para trazê-lo de volta, use Reativar. A reativação é recusada se a organização já tiver outro documento ativo do mesmo tipo e situação — por exemplo, reativar um substituído enquanto a renovação que o substituiu continua valendo.

Revisar um documento

A ação Revisar abre a janela de decisão:

  1. Escolha Aprovar ou Reprovar.
  2. Escreva um comentário — opcional na aprovação, obrigatório na reprovação (explique o motivo para a organização corrigir).
  3. Confirme. O status muda na hora e fica registrado nos detalhes.

Aprovar uma renovação substitui o documento que estava em vigor. Se a data de validade da renovação foi editada e não é mais posterior à do documento em vigor, a aprovação é recusada — corrija a data antes de aprovar.

Quem pode revisar

Revisar é uma permissão à parte de editar: nem todo perfil que envia ou edita documentos pode aprová-los. Se o botão não funcionar para você, seu perfil não tem essa permissão.