Documentação de atributos
Documentação de atributos/colunas |
A documentação de atributos/colunas deve conter uma descrição clara do dado que será armazenado e, sempre que necessário, sua especificação de domínio e exemplos.
Exemplos:
| Coluna | Descrição |
| DAT_INICIO_VIGENCIA | Armazena a data de início de vigência do aditivo contratual. |
| DSC_IDENTIFICACAO | Descrição de identificação do arquivo anexado ao contrato. Trata-se de informação descritiva preenchida pelo usuário do sistema. |
| NOM_ARQUIVO_ANEXO | Armazena o nome do arquivo anexo. Diferente da descrição de identificação do anexo. |
| FLG_SERVICO_CONTINUADO | Indica se o serviço contratado é continuado. Contratos para o fornecimento de luz, telefone, limpeza, dentre outros, são contratos de serviço continuado. |
TIP_AQUISICAO_ACERVO | Define como foi adquirida a obra. Pode assumir os seguintes valores: 'C' - compra; 'D' - doação; 'P' - permuta. |
Deve-se tomar um cuidado especial na documentação de colunas que armazenam valores chaves, mesmo quando se tratar apenas de valores numéricos sequenciais não-significativos, conforme exemplos abaixo.
- Chave primária (pk) - A chave primária permite identificar o conjunto de dados que compõe um registro único, característica que deve ser ressaltada no contexto dos dados armazenados.
Exemplos:
| Coluna (pk) | Descrição |
| COD_ORIGEM | Código numérico identificador do órgão de origem do processo ou recurso. |
| SEQ_GUIA_RECOLHIMENTO | Número sequencial que identifica unicamente uma guia de recolhimento emitida pelo CNJ. Chave primária da tabela. |
- Chave estrangeira (fk) – As descrições de colunas que armazenam valores importados como chave estrangeira de outras tabelas devem ser corretamente contextualizados na nova tabela.
Exemplos:
| Coluna(fk) | Descrição |
| SEQ_ORIGEM_DECISAO | Campo identificador da origem da decisão. Chave estrangeira importada da tabela ORIGEM_DECISAO. |
| SEQ_FONTE_RECURSO | Identificador da fonte do recurso vinculado à nota de empenho. Chave estrangeira importada da tabela FONTE_RECURSO. |
Em determinados casos, os dados armazenados em uma coluna podem possuir algum tipo de tratamento diferente daquele especificado para o conjunto de dados da tabela. Na documentação da coluna devem ser registrados quaisquer requisitos ou características diferenciados, inclusive quanto à classificação da informação armazenada.
Em modelos multidimensionais, a documentação de colunas deve ser segmentada utilizando-se marcadores (tags) em estilo XML.