dg:Guia de preenchimento da Planilha de Doadores: mudanças entre as edições
Linha 38: | Linha 38: | ||
==== <code>local_id</code>: número de ID do doador ==== | ==== <code>local_id</code>: 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. | É dado por quem preenche no momento da inclusão do doador na planilha. O novo ID é o próximo número disponível para o país. | ||
: ''Exemplo'': | : ''Exemplo'': Se o último ID para a Colômbia foi 36, então o próximo ID será 37. | ||
==== <code>scope_label</code>: área de atuação do doador ==== | ==== <code>scope_label</code>: área de atuação do doador ==== | ||
É um código que identifica área de atuação do doador, que pode ser | É um código que identifica área de atuação do doador, que pode ser o país, a subdivisão do país (estado ou província), ou o município (ou equivalente local). | ||
Se a área de atuação é o país, será usado a sigla de 2 letras do país. [[wikipedia:ISO_3166-1#Current_codes|Ver tabela]], na coluna "Alpha-2 code". | |||
Se a área é uma subdivisão do país, será usado a sigla composta da sigla do país e da subdivisão. [[wikipedia:ISO_3166-2#Current_codes|Ver tabela]], escolha o país na coluna "Entry". | |||
Se a área é um município, o código é composto pelas sigla da subdivisão do país onde o município está, um hífen, e pelo nome do município sem espaços, acentos e preposições. | |||
: '' | Caso o doador atua em mais de um município, sua área será a subdivisão do país pertinente. Se mais de uma subdivisão, sua área será o seu país. | ||
Os códigos de país e suas subdivisões são dados pela norma ISO 3166-2 relacionada ao país. Caso precisar, há um link para esta norma no README do repositório de cada país no projeto [https://github.com/digital-guard Digital Guard no GitHub]. | |||
''Exemplos'': | |||
* O doador X, cuja área de atuação é o município de São José dos Pinhais, estado do Paraná, Brasil, seu código será <code>BR-PR-SaoJosePinhais</code>. | |||
* O doador Y, cuja área de atuação é o município de Tunja, departamento de Boyacá, Colômbia, seu código será <code>CO-BOY-Tunja</code>. | |||
* O doador Y, cuja área de atuação é a província de Entre Ríos, Argentina, seu código será <code>AR-E</code>. | |||
==== <code>shortName</code>: nome curto ==== | ==== <code>shortName</code>: nome curto ==== | ||
{{Por fazer|Verificar se ainda é necessário.}} | {{Por fazer|Verificar se ainda é necessário.}} | ||
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 | 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". | ||
==== <code>vat_id</code>: número de cadastro da pessoa física ou jurídica ==== | ==== <code>vat_id</code>: número de cadastro da pessoa física ou jurídica ==== | ||
Pesquisar o | Argentina: CUIT; Brasil: CNPJ; Colômbia: NIT; Peru: RUC. | ||
Pesquisar o número de cadastro pela Internet. | |||
==== <code>legalName</code>: nome do doador ==== | ==== <code>legalName</code>: nome do doador ==== | ||
Nome do doador como se identifica. | Nome do ente doador como se identifica. | ||
==== <code>wikidata_id</code>: código de identificador Wikidata ==== | ==== <code>wikidata_id</code>: código de identificador Wikidata ==== | ||
O código é encontrado no site Wikidata, pela barra de pesquisa: https://www.wikidata.org/wiki/Wikidata:Main_Page | O código é encontrado no site Wikidata, pela barra de pesquisa: https://www.wikidata.org/wiki/Wikidata:Main_Page | ||
No caso de não haver um código, colocar , e pedir para um membro da equipe técnica criar. | |||
O código é necessário para obter dados estruturados relevantes do ente. | |||
==== <code>url</code>: endereço do site da entidade ==== | ==== <code>url</code>: endereço do site da entidade ==== | ||
Linha 82: | Linha 97: | ||
3 = Doadores com pacotes aprovados e publicados (''packs''). | 3 = Doadores com pacotes aprovados e publicados (''packs''). | ||
[[Categoria:Digital-guard]] | [[Categoria:Digital-guard]] |
Edição das 00h56min de 30 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.
- Exemplo de Planilha de Doadores: https://git.digital-guard.org/digital-guard/preserv-BR/blob/main/data/donor.csv
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 novo 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 ID será 37.
scope_label
: área de atuação do doador
É um código que identifica área de atuação do doador, que pode ser o país, a subdivisão do país (estado ou província), ou o município (ou equivalente local).
Se a área de atuação é o país, será usado a sigla de 2 letras do país. Ver tabela, na coluna "Alpha-2 code".
Se a área é uma subdivisão do país, será usado a sigla composta da sigla do país e da subdivisão. Ver tabela, escolha o país na coluna "Entry".
Se a área é um município, o código é composto pelas sigla da subdivisão do país onde o município está, um hífen, e pelo nome do município sem espaços, acentos e preposições.
Caso o doador atua em mais de um município, sua área será a subdivisão do país pertinente. Se mais de uma subdivisão, sua área será o seu país.
Os códigos de país e suas subdivisões são dados pela norma ISO 3166-2 relacionada ao país. Caso precisar, há um link para esta norma no README do repositório de cada país no projeto Digital Guard no GitHub.
Exemplos:
- O doador X, cuja área de atuação é o município de São José dos Pinhais, estado do Paraná, Brasil, seu código será
BR-PR-SaoJosePinhais
.
- O doador Y, cuja área de atuação é o município de Tunja, departamento de Boyacá, Colômbia, seu código será
CO-BOY-Tunja
. - O doador Y, cuja área de atuação é a província de Entre Ríos, Argentina, seu código será
AR-E
.
shortName
: nome curto
Tarefas: Verificar se ainda é necessário. |
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
Argentina: CUIT; Brasil: CNPJ; Colômbia: NIT; Peru: RUC.
Pesquisar o número de cadastro pela Internet.
legalName
: nome do doador
Nome do ente 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
No caso de não haver um código, colocar , e pedir para um membro da equipe técnica criar.
O código é necessário para obter dados estruturados relevantes do ente.
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).