dg:Guia de preenchimento da Planilha de Doadores: mudanças entre as edições

De Documentação
Linha 37: Linha 37:
Estas são as instruções de preenchimento:
Estas são as instruções de preenchimento:


==== <code>local_id</code>: Número de ID ====
==== <code>local_id</code>: Número de ID do doador ====
Quando é incluído, seu ID será temporariamente -1, até o momento que realizar a 1ª entrega de dados.
É dado por quem preenche no momento da inclusão do doador na planilha. O ID é o próximo número disponível para o país. Exemplo: se o último ID para a Colômbia foi 36, então o próximo será 37.
 
Após a 1ª entrega, o seu ID será alterado para o próximo número disponível para o país. Se o último foi 159, o próximo será 160, 161, etc... ''[quem altera isso?]''


==== <code>scope_label</code>: Área de atuação do doador ====
==== <code>scope_label</code>: Área de atuação do doador ====

Edição das 23h55min de 29 de agosto de 2023

Este guia aborda o que é, qual é o conteúdo e explica o preenchimento da planilha de doadores.

Definição

A Planilha de Doadores donor.csv lista os dados principais das entidades que são potenciais doadores de pacotes de dados ao Instituto AddressForAll, em especial aos projetos AddressForAll e Digital Guard.

Há uma planilha desta por país, as quais são armazenadas nos repositórios do GitHub.

Uso

Os dados desta planilha são usados para identificar e informar sobre os doadores e dar-lhes atribuição (crédito ou autoria) em qualquer meio de armazenamento, publicação e distribuição do material que o Instituto venha a fazer.

Por exemplo, um software do Instituto usa os dados da planilha para adicionar os dados do doador no box de metadados dos pacotes armazenados no Digital Guard (exemplo).

Conteúdo

A planilha consiste do seguinte (da coluna esquerda para direita):

  • local_id: número de ID do doador;
  • scope_label: código da área de atuação do doador;
  • shortName: código ou nome curto do doador;
  • vat_id: número de cadastro de pessoa física ou jurídica do doador;
  • legalName: nome do doador;
  • wikidata_id: código identificador Wikidata;
  • url: endereço do site da entidade;
  • donor_date: data de inclusão do doador;
  • donor_status: a situação do relacionamento entre doador e o Instituto.

Preenchimento

Quando e quem preenche

Obrigatório: após a realização de contato entre um representante do Instituto (CRM) e o doador. O representante inclui o doador na planilha.

Opcional: quando é feita por decisão unilateral de um integrante do Instituto para um futuro contato ou por outro motivo.

Instruções de preenchimento

Estas são as instruções de preenchimento:

local_id: Número de ID do doador

É dado por quem preenche no momento da inclusão do doador na planilha. O ID é o próximo número disponível para o país. Exemplo: se o último ID para a Colômbia foi 36, então o próximo será 37.

scope_label: Área de atuação do doador

É um código que identifica área de atuação do doador, que pode ser um município, estado ou província ou o país todo.

O código é composto pelos identificadores de duas letras de país e estado, e o nome do município sem acentos e preposições, separados por hifens, tudo sem espaço. Por exemplo, se a área de atuação do doador é o município de São José dos Pinhais, estado do Paraná, Brasil, seu código será BR-PR-SaoJosePinhais.

O código de país e estado (ou província) é dado pela norma ISO 3166-2. Há um link para esta norma no README do repositório de cada país no projeto Digital Guard no GitHub. Exemplos: Brasil, Colômbia, Peru, etc.

shortName: nome curto

No caso de prefeituras, será o código de 2 letras do estado e o código de 3 letras do município. O código dos municípios do Brasil é dado por esta planilha: https://github.com/datasets-br/city-codes/blob/master/data/br-city-codes.csv, na coluna ´abbrev3´.

vat_id: número de cadastro da pessoa física ou jurídica

Pesquisar o CNPJ pela Internet.

legalName: nome do doador

Nome do doador como se identifica.

wikidata_id: código de identificador Wikidata

O código é encontrado no site Wikidata, pela barra de pesquisa: https://www.wikidata.org/wiki/Wikidata:Main_Page

url: endereço do site da entidade

Pesquisar o endereço principal do website da entidade pela Internet.

donor_date: data de inclusão do doador

Data de inclusão do doador na planilha no formato ano-mês-dia, exemplo 2023-08-29.

donor_status: a situação do relacionamento entre doador e o Instituto

Valores possíveis [1]:

0 = Tentativas de contato realizadas;

1 = Contatos com doadores potenciais que respondem ao nosso chamado;

2 = Doadores efetivos: entregam alguma coisa mesmo que inútil;

3 = Doadores com pacotes aprovados e publicados (packs).