6.1. Orientações para Criação de um Conjunto de Dados na Plataforma CKAN

Ao acessar a plataforma CKAN[1] (https://www.tesourotransparente.gov.br/ckan/user/login), o Editor deverá preencher dois formulários, primeiro o Formulário Criar um Conjunto de Dados, figura abaixo, e depois, o Formulário Recursos para inserção dos arquivos a serem disponibilizados ao usuário.

Campos do Formulário “Criar um Conjunto de Dados”

Título

O título do Conjunto de dados deve ser preenchido segundo o padrão gramatical de escrita. Iniciais em maiúscula, acentuações corretas e sentenças completas.

Exemplos negativos:

• Cadastrar uma tag sem preocupação com a correção de escrita: “Resultado Orçamentario do Regime Geral Previdencia Social”. O correto seria cadastrar “Resultado Orçamentário do Regime Geral Previdência Social”
• Fazer abreviações na escrita: “Resultado Orçamentário Regime Geral Previdência Social”. O correto seria cadastrar “Resultado Orçamentário do Regime Geral Previdência Social”

URL

A URL "Uniform Resource Locator" (localizador Padrão Recursos na rede) preenchida automaticamente conforme o preenchimento do título do conjunto de dados.

Descrição

A descrição deve ser objetiva e falar somente do Conjunto de Dados e seu conteúdo.

Adicionalmente a descrição pode ser complementada com parte do dicionário de conceitos que seja relevante para o seu melhor entendimento. Não é necessário adicionar a descrição de colunas que não estejam diretamente relacionadas à descrição do conjunto de dados.

Os itens do dicionário de conceitos que forem adicionados à descrição do conjunto de dados devem ter o título do item em negrito seguido do texto em fonte normal.

Exemplo:

• Este conjunto de dados contém a listagem de todos os Programas liquidados....,

Programa: É um conjunto de contratos......

Etiquetas

Etiquetas são palavras-chaves que, de forma transversal, auxiliam o usuário externo a localizar o conjunto de dados que deseja encontrar no Portal. Elas representam um dos principais mecanismos de categorização dos dados, desde que expressem de alguma forma a visão externa que os usuários têm a respeito dos dados. No entanto, devido aos conteúdos quase sempre muito técnicos dos dados e informações do Tesouro, é necessário que as áreas de negócio induzam à consulta por meio das suas próprias visões. Desse modo, é a área de negócios a mais competente para “etiquetar” seus dados, ou seja, interpretar como os cidadãos iriam procurar pelas informações no Portal Tesouro Transparente.

No momento, temos dois tipos de etiquetas no Portal, as etiquetas mestre, postadas na tela inicial, e as etiquetas postadas no topo da lista ao lado esquerdo da seção “Dados”, onde ficam os conjuntos de dados. Todo conjunto de dados tem uma e somente uma etiqueta mestre. A gestão de etiquetas mestres, sua criação, etiquetagem e postagem, é de competência exclusiva da GEIFO/CODIN. No entanto, muito em breve, teremos a possibilidade de categorização por assuntos, atendendo às visões exclusivas das áreas do Tesouro. Quando esse momento chegar, as etiquetas mestre serão desdobradas em temas afetos às áreas e não haverá mais essa pequena dificuldade de classificação.

As etiquetas devem ser, portanto, criadas pelas áreas responsáveis pelos conjuntos de dados, com atenção e cuidado, tendo em vista que serão as palavras ou expressões pelas quais os usuários buscarão uma informação específica. Uma dica: quando o usuário, potencial cliente de informações públicas produzidas pela sua área quiser pesquisar a existência de um conjunto de dados, em que termos de busca pensará? Essas palavras-chave e expressões devem ser as etiquetas do conjunto de dados.

As etiquetas devem ser criadas segundo o padrão gramatical de escrita. Iniciais em maiúscula (caixa alta e baixa), acentuações corretas e sentenças completas. O texto deve ser curto, com até três palavras de preferência.

É fundamental verificar se já há uma etiqueta similar cadastrada. Em caso positivo, deve-se sempre reutilizar as etiquetas existentes para evitar duplicidades desnecessárias.

Exemplos negativos:

• Se houver uma etiqueta “Estados e Municípios” o cadastrador insere uma outra etiqueta “Estadual e Municipal”. O correto seria reaproveitar a etiqueta existente;
• Cadastrar uma etiqueta sem preocupação com a correção de escrita: “Seguranca Publica”. O correto seria cadastrar “Segurança Pública”;
• Fazer abreviações na escrita: “Receitas União”. O correto seria cadastrar “Receitas da União”;
• Escrever etiquetas longas e que não seriam intuitivamente usadas pelos usuários: ‘programa refinanciamento estados municípios”. O correto seria cadastrar: “Programas de Refinanciamento”, “Estados e Municípios”.

Licença

Caso o Editor tenha conhecimento de alguma licença para divulgação dos dados deverá selecioná-la, caso contrário deverá manter a customizada no formulário: “Lincese not specified” (licença não especifica).

Observamos que caso o Conjunto de Dados seja de fontes externas os Responsáveis (Coordenações-Gerais da STN) devem obter a devida autorização das organizações proprietárias dos dados sobre se, e com quais restrições, seus dados podem ser publicados - como exemplo, os termos de uso do Portal permitem que nossos dados sejam reproduzidos e utilizados para qualquer fim lícito desde que citada a fonte.

Autoria

Os campos “Autor” e “E-mail do autor” devem ser deixados em branco, assim como os campos sobre referentes ao “Mantenedor”.

Campos Customizados

Os campos customizados devem seguir exatamente o mesmo padrão em todos os Conjunto de Dados.

Até o momento foi identificada a necessidade de cadastrar os seguintes campos:

• Categoria do VCGE
• Data de início dos dados
• Frequência de atualização

A categoria do VCGE deve ser preenchida segundo a versão 2.0.3 do vocabulário e deve conter a sequência completa de dois níveis separados por barra (/).

As datas devem ser preenchidas segundo este padrão:

• 12 de outubro de 2015 (quando for data completa)
• Outubro de 2015 (quando a data omitir o dia)
• 2015 (quando a data só contiver o ano)

A figura abaixo ilustra a visão do usuário, depois do cadastramento das informações.

Para salvar o trabalho realizado e passar para o Formulário Recursos, clicar no botão

Campos do Formulário “Recursos”

O Formulário “Recursos” é utilizado para fazer o upload dos arquivos a serem disponibilizados ao usuário do Portal, figura abaixo.

O primeiro recurso da lista de recursos de um conjunto de dados deve ser o arquivo de “Metadados”, cujo nome será “Metadados” e deve estar no formato PDF. As orientações para elaboração do “Metadados” está o no Anexo I.

O segundo arquivo, quando apropriado, será um exemplo de arquivo. Utilize o arquivo de exemplo quando os recursos principais tiverem mais que 1Mb. Este exemplo deve conter poucas linhas de modo a ser pequeno e facilmente baixado. Será o único dos recursos a fazer uso do plugin de pré-visualização. Terá o formato CSV (arquivos de texto com valores separados por vírgulas).

O nome do arquivo de exemplo será “Arquivo de exemplo” e sua descrição será “Um exemplo com XXXX registros para facilitar a degustação deste conjunto de dados.”. Um número razoável de linhas para o exemplo é 100. Somente haverá um único arquivo de exemplo por conjunto de dados.

No caso de vários arquivos em sequência, cada um referente a um período, colocar os arquivos na ordem crescente de período. Exemplo: janeiro, fevereiro, março, etc.

Alguns recursos já estão disponíveis em outros portais ou páginas do tesouro. Nestes casos, não utilizar links para os arquivos em outros lugares, mas fazer o upload do recurso para o CKAN.

Às vezes uma única saída de um conjunto de dados é composta de vários arquivos. Como o CKAN não possibilita agrupamentos, neste caso o cadastrador deve agrupar os arquivos em um único arquivo ZIP. Um exemplo seria caso o resultado do tesouro de 2015 fosse composto duas planilhas, neste caso as duas planilhas deveriam compor um único recurso.

Quando um recurso tiver tamanho superior a 10 Mb ou quando este recurso for composto de vários arquivos será necessário compactar em um arquivo do tipo ZIP. Este arquivo deve ser cadastrado no CKAN de modo que o campo “Formato” seja preenchido com o formato do conteúdo (PDF, CSV, etc), não do ZIP.

Deve-se evitar de publicar documentos no formato Word. Deve-se dar preferência para PDF.

O nome dos recursos deve seguir o seguinte formato: <nome do recurso> - <diferenciador de período>

Exemplo:

• Resultado do Tesouro - 2014
• Créditos da União - 12-05-2015
• Títulos Negociados - março-2015

Alterações em Conjunto de Dados

Para a realização de qualquer alteração de um conjunto de dados já existente, deve-se acessá-lo e clicar em Gerenciar.

[1] O CKAN, sigla para Comprehensive Knowledge Archive Network, é um sistema para gerenciamento de dados, uma aplicação web de catalogação de dados desenvolvido pela Open Knowledge Foundation.