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

De Documentação
Sem resumo de edição
Linha 19: Linha 19:
*<code>local_id</code>: número de ID do doador;
*<code>local_id</code>: número de ID do doador;
*<code>scope_label</code>: código da área de atuação do doador;
*<code>scope_label</code>: código da área de atuação do doador;
*<code>shortName</code>: código ou nome curto do doador (PAUSADO - não precisa preencher por hora);
*<code>vat_id</code>: número de cadastro de pessoa física ou jurídica do doador;
*<code>vat_id</code>: número de cadastro de pessoa física ou jurídica do doador;
*<code>legalName</code>: nome do doador;
*<code>legalName</code>: nome do doador;
Linha 45: Linha 44:
É 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).
É 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 de atuação é o país, será usado a sigla de 2 letras do país. Caso precisar, ver [[wikipedia:ISO_3166-1#Current_codes|esta 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 é uma subdivisão do país, será usado a sigla composta da sigla do país e da subdivisão. Caso precisar, ver [[wikipedia:ISO_3166-2#Current_codes|esta tabela]], escolha o país na coluna "Entry" para obter uma lista completa de códigos para as subdivisões do país.


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.
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.
Linha 57: Linha 56:
''Exemplos'':
''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>.
* Uma prefeitura que atua no 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>.
* Uma prefeitura que atua no 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>.
* Uma companhia de água que atua no estado do Pará, Brasil, seu código será <code>BR-PA</code>.
 
* Um instituto que atua na província de Entre Ríos, Argentina seu código será <code>AR-E</code>.
==== <code>shortName</code>: nome curto ====
* Uma entidade que atua no Peru seu código será <code>PE</code>.
(PAUSADO - não precisa preencher por hora)
 
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 ====
Linha 72: Linha 68:


==== <code>legalName</code>: nome do doador ====  
==== <code>legalName</code>: nome do doador ====  
Nome do ente doador como se identifica.
Nome do ente doador como ele 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.
No caso de não haver um código, deixar em branco e pedir para um membro da equipe técnica criar um ID na Wikidata.


O código é necessário para obter dados estruturados relevantes do ente.
O código é necessário para obter dados estruturados relevantes do ente doador.


==== <code>url</code>: endereço do site da entidade ====
==== <code>url</code>: endereço do site da entidade ====
Linha 85: Linha 81:


==== <code>donor_date</code>: data de inclusão do doador ====
==== <code>donor_date</code>: data de inclusão do doador ====
Data de inclusão do doador na planilha no formato ano-mês-dia, exemplo 2023-08-29.
Data de inclusão do doador na planilha.


==== <code>donor_status</code>: a situação do relacionamento entre doador e o Instituto ====
==== <code>donor_status</code>: a situação do relacionamento entre doador e o Instituto ====
Valores possíveis <sup>[[https://github.com/digital-guard/preserv-BR/issues/83#issuecomment-1157820299 1]]</sup>:
Valores possíveis:


0 = Doador em potencial sem contato realizado, ou com tentativas de contato sem resposta;
0 = Doador em potencial sem contato realizado, ou com tentativas de contato sem resposta - indica que ainda precisa ser feito contato;


1 = Doador potencial que respondeu ao chamado do representante do Instituto;
1 = Doador potencial que respondeu ao chamado do representante do Instituto;

Edição das 13h59min 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.

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;
  • 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. Caso precisar, ver esta 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. Caso precisar, ver esta tabela, escolha o país na coluna "Entry" para obter uma lista completa de códigos para as subdivisões do país.

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:

  • Uma prefeitura que atua no município de São José dos Pinhais, estado do Paraná, Brasil, seu código será BR-PR-SaoJosePinhais.
  • Uma prefeitura que atua no município de Tunja, departamento de Boyacá, Colômbia, seu código será CO-BOY-Tunja.
  • Uma companhia de água que atua no estado do Pará, Brasil, seu código será BR-PA.
  • Um instituto que atua na província de Entre Ríos, Argentina seu código será AR-E.
  • Uma entidade que atua no Peru seu código será PE.

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 ele 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, deixar em branco e pedir para um membro da equipe técnica criar um ID na Wikidata.

O código é necessário para obter dados estruturados relevantes do ente doador.

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.

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

Valores possíveis:

0 = Doador em potencial sem contato realizado, ou com tentativas de contato sem resposta - indica que ainda precisa ser feito contato;

1 = Doador potencial que respondeu ao chamado do representante do Instituto;

2 = Doador efetivo, uma vez feita alguma entrega, independentemente da qualidade;

3 = Doador efetivo com pacotes de dados aprovados e publicados (packs).