Genexus CSV - Parte II

Nessa segunda parte sobre criação e leitura de arquivos CSV, iremos visualizar como podemos realizar a leitura  de um arquivo exemplo (figura abaixo), criado anteriormente a partir do post Genexus CSV - Parte I.

Vamos imaginar que o nosso cliente contratou um novo software de frente de caixa, esse novo software oferece um relatório diário de todas as vendas realizadas na loja, e este relatório pode ser extraído no formato CSV. Em determinados períodos, o cliente precisará importar estes dados para o seu sistema gerencial.

Pois bem, agora precisamos criar em nossa aplicação uma tela que permita ao usuário importar o relatório desejado e gravar em nossa base de dados estas informações. Como faremos isso.. veremos a seguir..

Criação da Web Panel Importadora

Primeiro, iremos adicionar a variável &Blob à nossa web panel..

..e um botão "Importar Arquivo" que realizará o seguinte evento:

Event 'ImportarArquivo'
   //=====Chama Procedure de leitura passando o caminho da variável blob como parâmetro===
   LeArquivoCSV.Call(&Blob.ToString())
EndEvent

Ao utilizar uma variável do tipo blob os arquivos selecionados através desta variável são abertos a partir da pasta "PrivateTempStorage", definida nas propriedades do nosso gerador. Portanto, quando utilizamos a função "ToString()" estamos na verdade trabalhando com o caminho (source) do arquivo selecionado.

Criação de Procedure de Leitura dos Arquivos Importados

Agora precisamos programar nossa Procedure "LeArquivoCSV" criada.

Esta procedure irá receber como parâmetro o caminho (source) do arquivo importado na web panel.

//=====Variável Arquivo = Varchar, caminho do arquivo recebido=====
parm(in:&Arquivo);

Na aba Source da nossa Procedure iremos adicionar o seguinte código.

Obs.: Quando uma determinada variável Blob não é usada junto a algum registro da base de dados, não é possível capturar a sua extensão através da função "FileType()". Logo, para capturarmos a extensão desta variável, teremos que pegá-la através do seu caminho completo...

//=====Captura extensão do arquivo recebido como parâmetro=====
&PosicaoInicial = StrSearchRev(&Arquivo,'.',&Arquivo.Trim().Length())
&PosicaoInicial += 1
&Extensao = SubStr(&Arquivo,&PosicaoInicial,5)

//=====Se a extesão nao for csv, envia mensagem=====
if &Extensao.ToLower() <> 'csv'
msg('Arquivo Incorreto!')
else

//=====Abre Arquivo recebido como parâmetro=====
&retorno = dfrOpen(&Arquivo,,',','"','utf-8')

//=====Realizar a seguinte rotina enquanto não chegar ao fim do arquivo=====
do while dfrNext() = 0

//=====Leitura dos registros contidos=====
&retorno = dfrGNum(&LivroCodigo)
&retorno = dfrGTxt(&LivroNome)
&retorno = dfrGTxt(&LivroEdicao)
&retorno = dfrGNum(&LivroValor)
&retorno = dfrGTxt(&EditoraNome)
&retorno = dfrGDate(&NotaFiscalData,'dmy','/')
&retorno = dfrGTxt(&Hora)
&NotaFiscalHora.FromString(&Hora)
&retorno = dfrGNum(&NotaFiscalNSU)
&retorno = dfrGTxt(&PagamentoTipo)
&retorno = dfrGNum(&PagamentoId)
enddo

//=====Fechar arquivo=====
&retorno = dfrClose()
endif

A função StrSearchRev() serve para procurarmos a posição de um determinado caractere de trás para frente. Esta função recebe como parâmetros:

1. String que desejamos realizar a procura - variável &Arquivo;
2. Caractere(s) que estamos procurando - caractere ponto ".";
3. Posição inicial da procura - fim do caminho do arquivo.

Note que não é possível capturarmos o registro hora de forma direta, o genexus não fornece uma função específica para este tipo de formato. Portanto, precisamos primeiro capturá-lo como uma String para após associá-lo a varíável hora (DateTime, propriedades: picture Date format = none).

Bom pessoal, pretendo postar mais alguns exemplos de desenvolvimento nos próximos posts. Bom ano novo pra todos, abraço!

Genexus CSV - Parte I

Dando continuidade aos nossos posts, a partir de hoje iremos aprender como criar e ler arquivos CSV. Quase todos os analistas genexus em algum momento já se depararam com a necessidade de trabalhar com este tipo de arquivos. Como sabem, assim como o XML, o CSV é muito utilizado para transmitir registros e informações, porém quando estes registros e informações são muito extensos, o CSV torna-se mais adequado.

Este tipo de arquivo é padrão de bancos, administradoras de cartões de crédito e sistemas ERP, entre outros. Como as transações ocorrem diariamente em uma grande quantidade, os bancos, por exemplo, disponibilizam estes arquivos diariamente, junto com um manual de leitura, e dessa forma, torna-se mais fácil às empresas realizar um programa de leituras destas informações e por fim, registrá-las em seu próprio sistema.

O que vem a ser este tipo de arquivo?

CSV significa Coma Separator Value, traduzindo: Valores Separados por Vírgula. De forma padrão um arquivo CSV, contém diversos valores, campos (ou colunas de tabelas), separados por vírgulas. Porém não necessariamente estes valores necessitam estar separados por este tipo de caractere (vírgula), através do genexus qualquer caractere que definirmos realizará esta separação, eu particularmente prefiro o ponto e vírgula. Principalmente quando um destes campos contém um valor (onde se utiliza a vírgula).

Exemplo de criação de arquivos CSV

Para começar este assunto, daremos continuidade ao nosso exemplo de uma aplicação para controle de uma livraria digital. Um novo ERP foi adquirido pela empresa, e precisamos criar um arquivo CSV diariamente com todas as vendas realizadas para que o ERP possa importá-las. Cada campo do CSV representará uma coluna da tabela de vendas, e cada linha representará uma venda, logo...

O nosso exemplo de arquivo contém:

1. código do livro vendido;
2. nome do livro vendido;
3. edição;
4. valor bruto;
5. editora;
6. data da venda;
7. hora da venda;
8. número único da transação;
9. forma de pagamento;
10. código de pagamento;

Vamos lá então, primeiro passo, em uma Web Panel inserimos uma variável Varchar(40) e um botão ao lado. Através desta variável, o usuário poderá determinar em qual pasta este arquivo será gerado. Veja figura abaixo:

Ao clicar sobre o botão o seguinte evento é executado:

Event 'GeraArquivo'
if not &Destino.IsEmpty()
GeraArquivoCSV.Call(&Destino)
else
msg('Informe o Destino do arquivo!')
endif
EndEvent

Agora, na procedure "GeraArquivoCSV" criada, iremos definir a propriedade "commit on exit: no".

Incluir em suas Regras o recebimento do parâmetro, variável Destino:

parm(in:&Destino);

E, em seu Source, o seguinte código:

//=====Captura Ano/Mes/Dia=====
&Ano = Year(ServerDate())
&Mes = Month(ServerDate())
&Dia = Day(ServerDate())

/*=====Monta Nome do Arquivo=====
O nome irá conter:
1º Caminho (pasta a ser gravado)
2º Nome do Arquivo (Data de Geração - Ano/Mes/Dia)
Exemplo: VendaDiaria_20121215
3º Extensão (.csv)
*/
&NomeArquivo = &Destino.Trim()+'VendaDiaria_'
&NomeArquivo += &Ano.ToString().Trim()+&Mes.ToString().Trim()+&Dia.ToString().Trim()
&NomeArquivo += '.csv'

/*=====Cria novo arquivo=====
Parâmetro:
1º Nome do Arquivo completo
2º Delimitador de registros (, - vírgula)
3º Delimitador de conteúdo (" - aspas duplas)
4º Anexar = false (caso exista outro arquivo com o mesmo nome, irá sobrescrever)
5º Encoding (utf-8)
*/
&retorno = dfwOpen(&NomeArquivo,',','"',0,'utf-8')

//=====Percorre tabela de notas fiscais====
for each NotaFiscalData NotaFiscalHora

/*Inserir registros (os delimitadores se inserem automaticamente)
quando utilizarmos "dfwPNum" precisamos informar um parâmetro: quantidade de decimais
quando utilizarmos "dfwPTxt" o ideal é utilizarmos a função .Trim()
quando utilizarmos "dfwPDate" precisamos informar dois parâmetros:
  1º formato da data, "d" para dia, "m" para mês e "y" para ano
  2º separador dos caracteres dia,mês e ano

os registros inseridos com "dfwPNum" e "dfwPDate", por não serem Strings não irão ficar entre aspas duplas "
*/
&retorno = dfwPNum(LivroCodigo,0)
&retorno = dfwPTxt(LivroNome.Trim())
&retorno = dfwPTxt(LivroEdicao.Trim())
&retorno = dfwPNum(LivroValor,2)
&retorno = dfwPTxt(EditoraNome.Trim())
&retorno = dfwPDate(NotaFiscalData,'dmy','/')
&retorno = dfwPTxt(NotaFiscalHora.ToString().Trim())
&retorno = dfwPNum(NotaFiscalNSU,0)
&retorno = dfwPTxt(PagamentoTipo.Trim())
&retorno = dfwPNum(PagamentoId,0)

//=====Ir para a próxima linha=====
&retorno = dfwNext()
endfor

//=====Fechar arquivo=====
&retorno = dfwClose()

Ao trabalhar com arquivos csv, utilizamos as funções

• dfw...(Delimited File Write) - para escrever arquivos;
• dfr...(Delimited File Read) - para ler arquivos;

Por hoje era isso, no próximo post entraremos na função de leitura de arquivos .csv, e para facilitar, continuaremos utilizando este mesmo exemplo. Grande abraço.

Genexus Business Component - Parte II

Nesta segunda parte do assunto Business Component (acesse aqui a parte 1), iremos verificar como realizar rotinas de inserção através de Data Provider, além de atualizações e exclusões de registros. Se a utilização de BC já reduz as linhas de programação e facilita o desenvolvimento, a combinação deste com Data Provider facilita ainda mais.

Mas lembre-se, através de Data Provider só podemos realizar inserções através do Business Component. Veremos abaixo como realizar isto.

Inserção de registros através de Data Provider

Continuando com o exemplo da Parte 1, considere uma aplicação Genexus para uma livraria. Nesta livraria os livros são catalogados por Assunto, Editora e edição correspondente. A partir do seu Assunto cada livro recebe um código único. Após definirmos o desenho da transação e declarar suas regras, definidos a propriedade "Business Component" como true. Neste código, os três primeiros dígitos é o código de seu assunto e os três últimos são sequenciais. Então, os livros do assunto "Negócios" (código 100), terão códigos de 100001 a 100999.

Para facilitarmos a inserção de novos livros, é criado uma Web Panel contendo um grid, com todos os livros registrados. Na última coluna da direita deste grid, inserimos uma imagem e criamos um evento associado a esta, com a opção de clonar este livro. Isto é, inserir um novo livro a partir dos dados do livro selecionado. Logo em nossa form teríamos:

Adicionamos a variável "Livro" que terá como Tipo de Dado o Business Component Livro. Agora, na aba de eventos desta Web Panel, iremos programar o evento associado ao clique da imagem "Clonar":

Event 'ClonarLivro'
//=====Chama o Data Provider passando o código do livro clicado como parâmetro=====
&Livro = DPLivro(LivroCodigo)

//=====Salva os Dados=====
&Livro.Save()

//=====Finaliza a UTL=====
commit

//=====Atualiza a página para aparecer o novo registro no grid=====
Refresh
EndEvent

Data Provider utilizado, a propriedade Output foi definida com o objeto Transação Livro. Os objetos Data Provider não possuem parâmetros de saída (out), este parâmetro é sempre definido a partir de suas propriedades, conforme abaixo:

Regra declarada:

parm(in:&LivroCodigo);

Podemos notar que o parâmetro recebido, id da tabela de Livros, serve como condição para capturar os dados referentes a este registro (where LivroCodigo = &LivroCodigo).

O atributo LivroCodigo e LivroDataCadastro não estão especificados no Data Provider em função de serem atribuídos a partir das regras da transação Livro. Isto é, o Business Component irá herdar estas regras (Regras especificadas na parte 1).

Atualização de registros através de Business Component

Imaginamos a seguinte situação, após determinados períodos, a nossa livraria necessita alterar o preço de todos os livros cadastrados, aumentando ou diminuindo 5% ou então 10%. Seria muito trabalhoso para o administrador da aplicação entrar em todos os livros e realizar esta alteração.

Logo, iremos inserir um campo de ajuste e um botão em nossa web panel para permitir ao administrador alterar todos os registros a partir de uma determinada porcentagem. Assim as mudanças da Form do objeto ficaram da seguinte forma:

Ao clicar sobre o botão o seguinte evento é realizado:

Event 'RealizarAjuste'
//=====Se valor informado não for vazio=====
if not &Ajuste.IsEmpty()

//=====Para cada linha do Grid=====
for each line in Grid

//=====Carrega BC com chave primária=====
&Livro.Load(LivroCodigo)

//=====Define novo valor do livro=====
&Livro.LivroValor = LivroValor * (1+(&Ajuste/100))

//=====Salva alteração e finaliza UTL=====
&Livro.Save()
commit
endfor

//=====Refresh após todos valores serem alterador=====
Refresh
else

//=====Se valor informado for vazio, exibir mensagem=====
msg('Informe a porcentagem de ajuste!')
endif
EndEvent

Note que ao realizar o Load, apenas passamos a chave primária, nos Business Components não precisamos passar todos os parâmetros recebidos pela transação, como o Modo (Update, Delete, Insert ou Display).

Exclusão de registros através de Business Component

Por fim, veremos como excluir registro através do BC.

Nossa seguinte demanda é, após algumas falhas de inclusões (um administrador novato tomou conta do sistema..hehe), precisamos facilitar a forma de exclusão dos livros. Caso se deseje excluir 100 livros, esta tarefa se torna muito trabalhosa, caso tenha que entrar de um em um. Logo, iremos inserir um check box na linha do grid, com a opção do usuário selecionar aquelas linhas que deseje excluir apenas clicando sobre um botão.

Nossa Form ficaria da seguinte forma:

Ao clicar sobre o botão "Excluir Registros Selecionados" o seguinte evento é realizado:

Event 'ExcluirRegistrosSelecionados'
//=====Para cada linha do Grid=====
for each line in Grid
if &Excluir = 'S'
//=====Carrega BC com chave primária=====
&Livro.Load(LivroCodigo)

//=====Exclui registro e finaliza UTL=====
&Livro.Delete()
commit
endif
endfor

//=====Refresh após todos valores serem alterador=====
Refresh
EndEvent

Bom gurizada, caso tenham alguma dúvida perguntem nos comentários, não há necessidade de se identificar. Forte Abraço.