A+ A-

Kit para dados abertos Implementando uma política de dados abertos

Processo de abertura de bases de dados

Este é o processo que será executado em cada projeto de abertura de dados (por exemplo, o projeto da abertura de uma base de dados de um sistema de informação de uma área de negócio específica). A depender da capacidade da instituição, poderá ser executada uma ou mais instâncias desse processo simultaneamente em um dado momento.

Obs.: “Aberto por padrão”. Este processo se refere às atividades para abertura dos dados de um sistema/solução pré-existente. São, na verdade, “correções” de sistemas que ainda não possuem dados abertos. É importante que, no futuro, os sistemas sejam projetados para que já forneçam dados desde sua concepção. Todo sistema informacional público que não lide com informações que se encontrem dentro das exceçõs da LAI deve ter seus dados abertos por padrão.

Diagrama do processo de abertura de um conjunto de dados

Documento Plano de Dados Abertos - PDA

O PDA da instituição norteará o processo de abertura de dados quanto ao escopo, prazo estimado, partes interessadas, entre outros. Deve-se trazer do Plano de Dados Abertos para o Projeto de Abertura de Dados as suas partes que tratem dos seguintes aspectos:

Caso o Plano de Dados Abertos tenha sido omisso em relação a algum desses aspectos, eles deverão ser definidos durante a reunião de início de projeto.

Insumo para:

Reunião de início de projeto

Nessa primeira reunião entre as partes interessadas no projeto serão revisados o escopo e o prazo estimado do projeto, já definidos no Plano de Dados Abertos da instituição. Eventualmente algumas pessoas participarão transversalmente de vários projetos de abertura de dados na instituição. Por exemplo, pessoas do departamento de TI executando as atividades de fornecimento de infraestrutura e/ou desenvolvendo software.

Um aspecto que tem grande impacto no escopo e prazo estimados para o projeto é a escolha da forma de publicação dos dados. Por exemplo, desenvolver uma API de dados abertos requer um maior esforço do que simplesmente publicar arquivos estáticos. Mas, se o volume de dados é grande, pode ser vantajoso para o cidadão poder se utilizar dos métodos de consulta e filtros que uma API pode oferecer para receber apenas os dados que lhe interessam. Algumas das considerações para se decidir sobre a necessidade ou não do desenvolvimento da API são mostradas no artigo chamado “Você realmente precisa de uma API ?”.

Próximo passo: Solicitar documentação

Solicitar documentação

Solicitar esquema e documentação da base de dados. Ex.: modelos UML ou entidade-relacionamento, dicionário de dados, etc. Todo tipo de documentação ajuda às equipes de implementação a entender, em conjunto com especialistas de negócio, a melhor forma de estruturar os dados para sua publicação.

Documentações relacionadas ao conjunto de dados são muito úteis, principalmente para os consumidores dos dados abertos e também devem ser juntamente catalogados com os dados no dados.gov.br.

Próximo passo: Definir estrutura dos dados

Definir estrutura dos dados

Nessa etapa também são definidos os formatos de saída dos dados. XML, CSV e JSON são úteis para situações específicas.

As planilhas CSV têm a vantagem de poderem ser facilmente abertas e manipuladas em qualquer editor de planilhas, tais como Calc e Excel, inclusive por uma pessoa que não tenha conhecimentos de programação. Além disso, são igualmente fáceis de serem consumidas por aplicações.

Os arquivos XML e JSON têm a vantagem de possibilitarem a validação de vários tipos de dados, tais como números inteiros ou decimais. Além disso, permitem aninhar as estruturas de dados em hierarquias, o que facilita trabalhar com os dados em comparação com a estrutura plana de colunas do CSV. Permitem também a inclusão de marcações de links para outros recursos de dados através da web.

Em caso de publicação de planilhas CSV, definir e escrever a documentação de quais são e o que significam as colunas, bem como quais são os tipos de dados aceitáveis em cada coluna de cada planilha.

Em caso de publicação de arquivos XML ou JSON, definir a estrutura básica do documento. É possível, mas não necessário, estabelecer documentos XML Schema ou JSON Schema para validação.

Mais informações para subsidiar essa decisão estão disponíveis no Mapa de decisões tecnológicas.

Próximo passo: Realizar extração

Realizar extração

Realizar extração inicial dos dados, a partir do ambiente de produção da base de dados, para o local onde a base será disponibilizada como dados abertos.

Por exemplo, se tiver sido decidido publicar os dados em arquivos csv, essa etapa contempla hospedar a extração em csv em um servidor de arquivos para a web. Se tiver sido decidido publicar uma API de dados abertos, essa etapa contempla a carga da base de dados que é acessada diretamente pela camada de aplicação da API.

Próximo passo: Decidir qualidade mínima

Decidir qualidade mínima

A partir do momento em que os dados estejam à disposição para verificação da equipe técnica de implementação e dos especialistas de negócio, será avaliada a necessidade de higienização dos dados antes da publicação.

Definir por acordo entre as partes interessadas a qualidade mínima dos dados abertos publicados, de forma a viabilizar a sua publicação tempestiva dentro da capacidade da instituição.

Mais considerações sobre os requisitos dos dados podem ser encontradas na Cartilha Técnica para Publicação de Dados Abertos no Brasil , capítulo 6.

Próximo passo: Desenvolver API

Desenvolver solução

O trabalho a ser feito nessa etapa varia bastante, a depender do tipo de solução de dados abertos escolhida no início do projeto: disponibilização de arquivos CSV, de algum tipo de dumps dos dados, ou ainda, a criação de uma API de dados abertos.

Nos casos da diponibilização de arquivos ou dumps, esta etapa contempla a criação dos scripts de ETL que fazem a higienização dos dados decidida na etapa anterior.

No caso de desenvolvimento de uma API, esta etapa contempla o desenvolvimento do software que operará o serviço. Recomenda-se o uso de um método ágil de desenvolvimento de software.

Nesta etapa de desenvolvimento, pode-se ganhar muita produtividade ao utilizar ferramentas apropriadas ao tipo de solução que está sendo desenvolvida.

Em todos os casos, recomenda-se que os arquivos disponibilizados ou a API em desenvolvimento fiquem visíveis para toda a internet, de forma a reduzir as barreiras para que eventuais interessados em testar a solução (por exemplo, outro setor ou organização que tenham interesse em consumir os dados abertos) possam oferecer feedback durante o desenvolvimento e, assim, aprimorar a solução e garantir que quando ela esteja pronta atenda ao seu propósito de ser útil para os consumidores de dados.

Próximo passo: Atualização automática

Atualização automática

Definir e implementar processo periódico automático de atualização dos dados. Esta etapa contempla a negociação da periodicidade e fluxo dos dados entre os ambientes que compõem a arquitetura da solução de abertura de dados, bem como a criação de scripts de transformação e carga (ETL).

Esse momento é importante para garantir a atualidade dos dados publicados, que quanto mais atuais, mais valor possuem.

Próximo passo: Divulgar dados abertos

Divulgar dados abertos

Uma vez que a solução de dados abertos esteja em condições de qualidade suficientes para o encerramento do presente projeto de abertura de dados, pode-se dar início à ampla divulgação dos seus resultados.

Isso pode ser feito pelos canais de comunicação que o órgão possui e também naqueles que alcancem o público que já se antecipe estar interessado nos dados, tais como listas de discussão da Infraestrurua Nacional de Dados Abertos - INDA e de hackers cívicos, bem como de organizações da sociedade civil que acompanham o tema finalístico dos dados.

Nesse momento pode-se decidir pelo planejamento ou não de um futuro hackaton ou concurso de dados abertos, caso isso já não tenha sido previsto durante o processo de elaboração do PDA.

É importante destacar ainda que os dados logicamente compreendem ativos digitais da instituição e por isso devem estar disponíveis e visíveis em local apropriado em seu próprio sítio.

Próximo passo: Catalogar no dados.gov.br

Catalogar no dados.gov.br

A catalogação no Portal Brasileiro de Dados Abertos (dados.gov.br) deve ser feita com o objetivo de tornar os dados “descobríveis” na web para seus interessados. Isso aumenta as chances das pessoas encontrarem os dados prontamente, evitando assim solicitações por dados já disponibilizados, algo que poderiam onerar desnecessariamente o SIC da sua organização.

Para catalogar o novo conjunto de dados no dados.gov.br é necessário levantar um conjunto mínimo de metadados que são utilizados no portal. Esses metadados estão descritos na Cartilha Técnica para Publicação de Dados Abertos no Brasil , capítulo 7.

É necessário observar a forma de catalogação prevista no PDA ou, ainda, defini-la caso essa informação tenha sido omitida no plano.

Uma das maneiras é solicitar a criação de uma organização no Portal Brasileiro de Dados Abertos. Essa solicitação deve ter a anuência da autoridade de monitoramento, como definida no art. 40 da Lei de Acesso à Informação, e incluir o nome e o contato da pessoa que por ela ficará responsável no portal. Essa pessoa terá as responsabilidades de curadoria do conteúdo da organização e por cadastrar as pessoas que farão a catalogação dos metadados.

A outra maneira é criar um catálogo de dados abertos próprio da instituição, preferencialmente utilizando a ferramenta CKAN, que é software livre. O manual original (em inglês) do CKAN encontra-se no endereço docs.ckan.org, mas há uma versão traduzida e adaptada pelo IBICT para o idioma português.

Outras informações sobre catalogação de dados no Portal Brasileiro de Dados Abertos, incluindo o Manual de Catalogação, podem ser encontrados na wiki da INDA.

No caso de instuição que ainda não faz parte da INDA (por exemplo, empresas públicas ou organizações públicas de outros poderes e esferas), antes de realizar a catalogação no portal, seria importante avaliar a oportunidade de realizar a adesão voluntária à INDA (ver “Como participar da INDA” na wiki da INDA). A adesão formal é uma maneira de assegurar a continuidade da publicação e atualização dos dados, mesmo após eventuais trocas de gestão na organização.