Código fonte Wiki de Documentação de atributos

Última modificação por GEOFLAVIA GUILARDUCCI DE ALVARENGA em 16/01/2019, 17:31
 1: (% style="height:41px; width:1075px" %)
 2: |(((
 3: (% class="firstHeading" lang="pt-BR" style="color: black; background: none; font-weight: normal; margin: 0px 0px 0.25em; overflow: visible; padding: 0px; border-bottom: 1px solid rgb(170, 170, 170); font-size: 1.8em; line-height: 1.3; font-family: ~"Linux Libertine~", Georgia, Times, serif; font-style: normal; font-variant-ligatures: normal; font-variant-caps: normal; letter-spacing: normal; orphans: 2; text-align: start; text-indent: 0px; text-transform: none; white-space: normal; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; text-decoration-style: initial; text-decoration-color: initial;" %)
 4: = Documentação de atributos/colunas =
 5: )))
 6: 
 7: 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.
 8: 
 9: {{html}}
10: 
11: <p class=MsoNormal style='margin-top:12.0pt;margin-right:0cm;margin-bottom: 6.0pt;margin-left:72.0pt;text-align:justify'><b><span style='font-size:11.0pt; color:#003366'>Exemplos: </span></b></p> 
12: <table class=MsoTableGrid border=1 cellspacing=0 cellpadding=0 width=519 style='width:389.55pt;margin-left:89.4pt;border-collapse:collapse;border:none'> <tr style='height:15.9pt'> <td width=246 style='width:184.6pt;border:solid windowtext 1.0pt;padding:0cm 5.4pt 0cm 5.4pt;height:15.9pt'> <p class=MsoNormal style='text-autospace:none'><b><span style='font-size:9.0pt;color:#003366'>Coluna</span></b></p> </td> <td width=273 style='width:204.95pt;border:solid windowtext 1.0pt;border-left:none;padding:0cm 5.4pt 0cm 5.4pt;height:15.9pt'> <p class=MsoNormal style='text-autospace:none'><b><span style='font-size:9.0pt;color:#003366'>Descrição</span></b></p> </td> </tr> <tr>  <td width=246 valign=top style='width:184.6pt;border:solid windowtext 1.0pt;  border-top:none;padding:0cm 5.4pt 0cm 5.4pt'> <p class=MsoNormal style='margin-right:29.75pt'><span style='font-size:10.0pt; color:#003366'>DAT_INICIO_VIGENCIA</span></p> </td> <td width=273 valign=top style='width:204.95pt;border-top:none;border-left: none;border-bottom:solid windowtext 1.0pt;border-right:solid windowtext 1.0pt; padding:0cm 5.4pt 0cm 5.4pt'> <p class=MsoNormal style='margin-right:29.75pt'><span style='font-size:10.0pt'>Armazena a data de início de vigência do aditivo contratual.</span></p></td></tr><tr> <td width=246 valign=top style='width:184.6pt;border:solid windowtext 1.0pt;border-top:none;padding:0cm 5.4pt 0cm 5.4pt;border:solid windowtext 1.0pt !msorm;border-top:none !msorm;padding:0cm 5.4pt 0cm 5.4pt !msorm'> <p class=MsoNormal style='margin-right:29.75pt'><span style='font-size:10.0pt;color:#003366'>DSC_IDENTIFICACAO</span></p> </td> <td width=273 valign=top style='width:204.95pt;border-top:none;border-left: none;border-bottom:solid windowtext 1.0pt;border-right:solid windowtext 1.0pt; padding:0cm 5.4pt 0cm 5.4pt;border-top:none !msorm;border-left:none !msorm;border-bottom:solid windowtext 1.0pt !msorm;border-right:solid windowtext 1.0pt !msorm; padding:0cm 5.4pt 0cm 5.4pt !msorm'> <p class=MsoNormal style='margin-right:29.75pt'><span style='font-size:10.0pt'>Descrição de identificação do arquivo anexado ao contrato. Trata-se de informação descritiva preenchida pelo usuário do sistema.</span></p> </td> </tr> <tr> <td width=246 valign=top style='width:184.6pt;border:solid windowtext 1.0pt;  border-top:none;padding:0cm 5.4pt 0cm 5.4pt'>  <p class=MsoNormal style='margin-right:29.75pt'><span style='font-size:10.0pt;  color:#003366'>NOM_ARQUIVO_ANEXO</span></p>  </td>  <td width=273 valign=top style='width:204.95pt;border-top:none;border-left:  none;border-bottom:solid windowtext 1.0pt;border-right:solid windowtext 1.0pt; padding:0cm 5.4pt 0cm 5.4pt'>  <p class=MsoNormal style='margin-right:29.75pt'><span style='font-size:10.0pt'>Armazena o nome do arquivo anexo. Diferente da descrição de identificação do anexo. <br>Ex.: documento_2009.doc</span></p> </td> </tr> <tr>  <td width=246 valign=top style='width:184.6pt;border:solid windowtext 1.0pt;  border-top:none;padding:0cm 5.4pt 0cm 5.4pt'>  <p class=MsoNormal style='margin-right:29.75pt'><span style='font-size:10.0pt;  color:#003366'>FLG_SERVICO_CONTINUADO</span></p>  </td>  <td width=273 valign=top style='width:204.95pt;border-top:none;border-left:  none;border-bottom:solid windowtext 1.0pt;border-right:solid windowtext 1.0pt;  padding:0cm 5.4pt 0cm 5.4pt'>  <p class=MsoNormal style='margin-right:29.75pt'><span style='font-size:10.0pt'>Indica se o serviço contratado é continuado. Contratos para o fornecimento de luz, telefone, limpeza, dentre outros, são contratos de serviço continuado. <br>Domínio: SIM ('S') ou NÃO ('N').</span></p>  </td> </tr> <tr><td width=246 valign=top style='width:184.6pt;border:solid windowtext 1.0pt;border-top:none;padding:0cm 5.4pt 0cm 5.4pt'><p class=MsoNormal style='margin-right:29.75pt'><span style='font-size:10.0pt;color:#003366'>TIP_AQUISICAO_ACERVO</span></p>
13: </td><td width=273 valign=top style='width:204.95pt;border-top:none;border-left:none;border-bottom:solid windowtext 1.0pt;border-right:solid windowtext 1.0pt;padding:0cm 5.4pt 0cm 5.4pt'><p class=MsoNormal style='margin-right:29.75pt'><span style='font-size:10.0pt'>Define como foi adquirida a obra. Pode assumir os seguintes valores:</span></p><p class=MsoNormal style='margin-right:29.75pt'><span style='font-size:10.0pt'>'C' - compra;</span></p><p class=MsoNormal style='margin-right:29.75pt'><span style='font-size:10.0pt'>'D' - doação;</span></p> <p class=MsoNormal style='margin-right:29.75pt'><span style='font-size:10.0pt'>'P' - permuta.</span></p></td></tr></table>
14: 
15: {{/html}}
16: 
17: 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.
18: 
19: * 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.
20: 
21: {{html}}
22: <p class=MsoNormal style='margin-top:12.0pt;margin-right:0cm;margin-bottom: 6.0pt;margin-left:72.0pt;text-align:justify'><b><span style='font-size:11.0pt; color:#003366'>Exemplos: </span></b></p> <table class=MsoTableGrid border=1 cellspacing=0 cellpadding=0 width=536 style='width:402.0pt;margin-left:77.4pt;border-collapse:collapse;border:none'> <tr>  <td width=248 valign=top style='width:186.0pt;border:solid windowtext 1.0pt;  padding:0cm 5.4pt 0cm 5.4pt'>  <p class=MsoNormal style='text-autospace:none'><b><span style='font-size:  9.0pt;color:#003366'>Coluna (pk)</span></b></p>  </td>  <td width=288 valign=top style='width:216.0pt;border:solid windowtext 1.0pt;  border-left:none;padding:0cm 5.4pt 0cm 5.4pt'>  <p class=MsoNormal style='text-autospace:none'><b><span style='font-size:  9.0pt;color:#003366'>Descrição</span></b></p>  </td> </tr> <tr>  <td width=248 valign=top style='width:186.0pt;border:solid windowtext 1.0pt;  border-top:none;padding:0cm 5.4pt 0cm 5.4pt'>  <p class=MsoNormal style='margin-right:29.75pt'><span style='font-size:10.0pt;  color:#003366'>COD_ORIGEM</span></p>  </td>  <td width=288 valign=top style='width:216.0pt;border-top:none;border-left:none;border-bottom:solid windowtext 1.0pt;border-right:solid windowtext 1.0pt;  padding:0cm 5.4pt 0cm 5.4pt'> <p class=MsoNormal style='margin-right:29.75pt'><span style='font-size:10.0pt'>Código numérico identificador do órgão de origem do processo ou recurso. </span></p> </td> </tr> <tr>  <td width=248 valign=top style='width:186.0pt;border:solid windowtext 1.0pt;  border-top:none;padding:0cm 5.4pt 0cm 5.4pt'>  <p class=MsoNormal style='margin-right:29.75pt'><span style='font-size:10.0pt;  color:#003366'>SEQ_GUIA_RECOLHIMENTO</span></p>  </td>  <td width=288 valign=top style='width:216.0pt;border-top:none;border-left:  none;border-bottom:solid windowtext 1.0pt;border-right:solid windowtext 1.0pt; padding:0cm 5.4pt 0cm 5.4pt'>  <p class=MsoNormal style='margin-right:29.75pt'><span style='font-size:10.0pt'>Número sequencial que identifica unicamente uma guia de recolhimento emitida pelo CNJ. Chave primária da tabela.</span></p> </td> </tr> </table>
23: {{/html}}
24: 
25: *  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.
26: 
27: {{html}}
28: <p class=MsoNormal style='margin-top:12.0pt;margin-right:0cm;margin-bottom: 6.0pt;margin-left:72.0pt;text-align:justify'><b><span style='font-size:11.0pt; color:#003366'>Exemplos: </span></b></p> <table class=MsoTableGrid border=1 cellspacing=0 cellpadding=0 width=535 style='width:401.55pt;margin-left:77.4pt;border-collapse:collapse;border:none'> <tr>  <td width=262 valign=top style='width:196.6pt;border:solid windowtext 1.0pt;  padding:0cm 5.4pt 0cm 5.4pt'>  <p class=MsoNormal style='text-autospace:none'><b><span style='font-size:  9.0pt;color:#003366'>Coluna(fk)</span></b></p>  </td>  <td width=273 valign=top style='width:204.95pt;border:solid windowtext 1.0pt;  border-left:none;padding:0cm 5.4pt 0cm 5.4pt'>  <p class=MsoNormal style='text-autospace:none'><b><span style='font-size:  9.0pt;color:#003366'>Descrição</span></b></p> </td> </tr> <tr>  <td width=262 valign=top style='width:196.6pt;border:solid windowtext 1.0pt;  border-top:none;padding:0cm 5.4pt 0cm 5.4pt'>  <p class=MsoNormal style='margin-right:29.75pt'><span style='font-size:10.0pt;  color:#003366'>SEQ_ORIGEM_DECISAO</span></p>  </td>  <td width=273 valign=top style='width:204.95pt;border-top:none;border-left:  none;border-bottom:solid windowtext 1.0pt;border-right:solid windowtext 1.0pt;  padding:0cm 5.4pt 0cm 5.4pt'>  <p class=MsoNormal style='margin-right:29.75pt'><span style='font-size:10.0pt'>Campo identificador da origem da decisão. Chave estrangeira importada da tabela ORIGEM_DECISAO.</span></p>  </td> </tr> <tr>  <td width=262 valign=top style='width:196.6pt;border:solid windowtext 1.0pt;  border-top:none;padding:0cm 5.4pt 0cm 5.4pt'>  <p class=MsoNormal style='margin-right:29.75pt'><span style='font-size:10.0pt;  color:#003366'>SEQ_FONTE_RECURSO</span></p> </td>  <td width=273 valign=top style='width:204.95pt;border-top:none;border-left:  none;border-bottom:solid windowtext 1.0pt;border-right:solid windowtext 1.0pt;  padding:0cm 5.4pt 0cm 5.4pt'>  <p class=MsoNormal style='margin-right:29.75pt'><span style='font-size:10.0pt'>Identificador da fonte do recurso vinculado à nota de empenho. Chave estrangeira importada da tabela FONTE_RECURSO.</span></p>  </td> </tr> </table>
29: {{/html}}
30: 
31: 
32: 
33: 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.
34: 
35: 
36: Em modelos multidimensionais, a documentação de colunas deve ser segmentada utilizando-se marcadores (//tags//) em estilo XML.
37: 
38: (% class="box infomessage" %)
39: (((
40: (% style="font-family: monospace, Courier; color: black; background-color: rgb(249, 249, 249); border: 1px solid rgb(221, 221, 221); padding: 1em; white-space: pre-wrap; line-height: 1.0em;" %)
41: {{{<COMENTARIO>
42: </COMENTARIO>
43:  
44: <ORIGEM>
45: </ORIGEM>}}}
46: )))