Software: spLinker
Desenvolvido por: CRIA - Centro de Referncia em Informao Ambiental

Finalidade:
-----------

Permitir que dados de colees biolgicas sejam enviados e atualizados
em servidores regionais, a partir de onde passam a fazer parte da rede 
speciesLink.

Execuo:
---------

Sempre atravs do link "splinker" ou do arquivo "run.bat".

Descrio dos arquivos e diretrios:
------------------------------------

config.ini           : Arquivo de configurao usado para troca de idioma e nvel 
                       de detalhamento de log. Ateno: apenas o idioma portugus  
                       suportado neste momento.
config/              : Diretrio com os demais arquivos de configurao (no devem 
                       ser alterados sem que haja total conhecimento sobre as 
                       implicaes).
config/access.dat    : Armazena o tipo de conexo a ser utilizada para acesso aos
                       dados locais (arquivo texto ou conexao ODBC).
config/central.dat   : Configurao da conexo com o servio central da rede (deve 
                       sempre vir preenchido).
config/control.dat   : Armazena dados bsicos para o correto funcionamento deste 
                       software.
config/db.dat        : Configurao da conexo com a base de dados local quando
                       se trata de banco relacional.
config/info.dat      : Contm metadados sobre quem est usando o software (estes
                       dados so buscados no servidor quando se clica em "Buscar
                       "metadados").
config/map.dat       : Mapeamento dos campos a serem servidos  rede com base 
                       nos campos do banco de dados local.
config/mirror.dat    : Configurao da conexo com o servidor regional.
config/oldinstall.dat: Diretrios onde  feita a busca de possveis verses 
                       antigas instaladas na mquina.
config/proxy.dat     : Configurao de proxy.
config/text.dat      : Configurao da conexo com a base de dados local quando
                       se trata de arquivo texto.
data/                : Diretorio do repositrio de dados local (contm uma cpia 
                       dos registros que foram enviados para o servidor).
images/              : Imagens utilizadas pelo aplicativo.
lib/                 : Bibliotecas de terceiros.
log/                 : Diretorio de log.
samples/             : Contm exemplos de bases de dados.


Arquivos de configurao:
-------------------------

Os arquivos de configurao so usados para controlar as variveis do
aplicativo. Eles so automaticamente criados durante a instao do 
programa e configurados atravs de um assistente de configurao
(interface grfica). Apenas devem ser alterados manualmente em casos
especficos e quando houver total conhecimento sobre as implicaes.

Maiores detalhes sobre os arquivos de configurao:

* proxy.dat (Configura acesso via proxy)

  proxyhost = <Endereo do proxy>
  proxyport = <Porta de acesso ao proxy>

 Ex:
  proxyhost = http://meu_proxy.com.br
  proxyport = 330

* access.dat (Indica o tipo de acesso  base de dados local)

  type = <tipo de base de dados. Pode ser Text ou DB>

 Ex:
   type = Text

* text.dat (Configura a conexo com a base de dados da coleo.
            Necessrio apenas quando a base estiver em um arquivo texto)

  file<N> = <diretrio e nome do arquivo que contm a base de dados>
  encoding = <codificao do arquivo>
  filter_field  = <nome do campo que ser usado como filtro>
  filter_regexp = <expresso regular para selecionar os registros que 
                   no sero compartilhados>

  Ex:
    file  = c:/splink/samples/peixes.txt
    encoding = ISO-8859-1
    filter_field = CollectionCode
    filter_regexp = /^H/

    Este filtro indica que os registros cujos contedos do campo
    denominado CollectionCode que iniciarem com 'H' no sero
    enviados.

* db.dat (Configura a conexo com a base de dados da coleo.
          Necessrio apenas quando a base puder ser lida via SQL, 
          atravs de conexo ODBC)

  driver = <driver java para acesso  base>
  query  = <clusula "from ...where ..." da SQL para obteno dos dados.
  url    = <URL da base>
  user   = <usurio da base>
  passwd = <senha do usurio na base>

  Ex:
    driver = sun.jdbc.odbc.JdbcOdbcDriver
    query  = FROM preencher_com_nome_tabela
    url    = jdbc:odbc:preencher_com_DSN
    user   = admin
    passwd = admin

* central.dat (Configura a conexo com o servio central da rede)

  uri = <Identificao do servio central>
  url = <URL do servidor central>

  Ex:
    uri = http://algum_host/central
    url = http://algum_host/central/MirrorsManager

* mirror.dat (Configura a conexo com o servidor regional)

  uri = <Identificao do servio provido pelo servidor regional>
  url = <URL do servidor regional>
  accession_code = <Cdigo de acesso>
  batchsize = <Tamanho do lote de registros>

  Ex:
    uri = http://algum_host/interface
    url = http://algum_host/mirror/MirrorServer
    accession_code = X3SHF8EOW9
    batchsize = 300

* info.dat (Metadados sobre quem usa o software)

  institution_code = <Cdigo da instituio>
  institution_name = <Nome da instituio>
  collection_code  = <Cdigo da coleo>
  collection_name  = <Nome da coleo>
  contact_name     = <Pessoa para contato>
  contact_email    = <E-mail para contato> 
  url              = <URL da coleo> 
  status_on_server = <Cdigo da situao dos dados no servidor regional>

  Ex:
    institution_code   = IX
    institution_name   = Instituto X
    collection_code    = MHN
    collection_name    = Museu de Histria Natural
    contact_name       = Fulano de Tal
    contact_email      = fulano@exemplo.org
    url                = http://mhn.ix.org.br/
    status_on_server   = O

* map.dat  (Mapeamento dos campos)

  Kingdom                 = 
  Phylum                  = 
  Class                   = 
  Order                   = 
  Family                  = 
  Genus                   = 
  Species                 = 
  Subspecies              =             
  Scientific name author  = 
  Common name             = 
  Field number            = 
  Catalog number          = 
  Previous catalog number = 
  Basis of Record         = 
  Type status             = 
  Preparation type        = 
  Individual count        = 
  Specimen sex            = 
  Specimen life stage     = 
  Collection date         = 
  Collector name          = 
  Collector number        = 
  Continent or Ocean      = 
  Country                 = 
  State or Province       = 
  City, County or Shire   = 
  Locality                = 
  Latitude                = 
  Longitude               = 
  Elevation               = 
  Depth                   = 
  Identification date     = 
  Identifier name         = 
  Related catalog item    = 
  Relationship type       = 
  Notes                   = 

  Obs:
    1) Para indicar que um campo no existe na coleo,
       ele deve ser deixado em branco ou deve ser omitido.
    2) So permitidas as expresses aceitas na clusula "SELECT" de um comando
       SQL desde que aceito pelo driver utilizado (ver "db.dat"),
       como: "<campo1>|<campo2>".
    3) A ordem dos campos no altera o resultado.
    4) Se um nome de um campo for grafado erroneamente, ele
       ser ignorado e no ser emitida qualquer mensagem!
    5) O arquivo "map.dat"  lido apenas ao iniciar o aplicativo.

  Ex:
    Family                  = Famlia
    Genus                   = Gnero
    Species                 = Espcie
    City, County or Shire   = Municpio
    Locality                = Stio
    Subspecies              = 
    Catalog number          = Lmina
    Collector name          = Coletor
    Country                 = Pas
    State or Province       = Estado
    Individual count        = Espcimes
    Specimen sex            = Estdio_sexo
    Collection date         = Data_col
    Notes                   = 

