Mudanças entre as edições de "Robo GIT"

De WikiBase
(→‎Construção de Relatórios)
 
(23 revisões intermediárias pelo mesmo usuário não estão sendo mostradas)
Linha 1: Linha 1:
−
[[Arquivo:Partiu_Logo.gif|200px|thumb|right|Clube Partiu Vantagens]]
+
<!--[[Arquivo:Partiu_Logo.gif|200px|thumb|right|Clube Partiu Vantagens]]
 +
-->
  
  
Linha 27: Linha 28:
  
 
Esse processo requer a instalação do '''GIT''' no equipamento, conforme será demonstrado a seguir.
 
Esse processo requer a instalação do '''GIT''' no equipamento, conforme será demonstrado a seguir.
 +
 +
Mais adiante, consulte o [https://pt.wikipedia.org/wiki/Git Wikipédia] para mais informações sobre o Sistema GIT.
  
 
|}
 
|}
  
 
==Procedimentos==
 
==Procedimentos==
−
====Instalando o GIT====
+
====Instalação do GIT====
  
 
Conforme mencionado anteriormente, o '''GIT''' é o sistema que gerencia o versionamento do Robô. Ele deverá ser instalado no computador antes de iniciar qualquer tarefa.
 
Conforme mencionado anteriormente, o '''GIT''' é o sistema que gerencia o versionamento do Robô. Ele deverá ser instalado no computador antes de iniciar qualquer tarefa.
Linha 44: Linha 47:
  
 
|}
 
|}
 +
 +
====Configuração do Robô====
 +
 +
Após o download e instalação do GIT pode ser feita a instalação e configuração do Robô.
 +
 +
A instalação deverá ser feita através do download do programa '''Instalador.bat''' disponível no link direto em [http://suporte.basesoft.com.br/Download/Updates/instalador.bat Instalador].
  
  
 
{| style="border-spacing:0;width:100%;"
 
{| style="border-spacing:0;width:100%;"
−
| style="background-color:#96CFF5;border:none;padding:0.097cm;width:100px;"| [[Imagem:Dica.png|center]]
+
| style="background-color:#96CFF5;border:none;padding:0.097cm;width:100px;"| [[Arquivo:Dica.png|center]]
−
| style="background-color:#96CFF5;border:none;padding:0.097cm;"|
+
| style="background-color:#96CFF5;border:none;padding:0.097cm;"| '''
  
−
Mais adiante, consulte o [https://pt.wikipedia.org/wiki/Git Wikipédia] para mais informações sobre o Sistema GIT.  
+
O instalador deverá ser baixado no diretório correspondente a instalação do Robô, crie o diretório robo no computador de destino e copie o instalador.bat para esse diretório.
  
 
|}
 
|}
  
−
====Configuração do Robô====
 
  
−
O '''Robô''' é o programa responsável pela solicitação dos Promocodes via Webservice junto ao servidor da Partiu e atualização dessas informações de acordo com cada entidade no banco de dados do sistema.
+
[[Arquivo:Robo_GIT_1.JPG|center]]
 +
 
 +
 
 +
Ao executar (duplo clique sobre o instalador), o instalador.bat se encarregará de baixar todos os arquivos necessários para a execução do robô.
 +
 
 +
 
 +
[[Arquivo:Robo_GIT_2.JPG|center]]
  
−
Além de solicitar novos Promocodes ele também consulta informações sobre Promocodes ativados pelos clientes, da mesma forma atualizando o banco de dados.
 
  
−
A instalação deverá ser feita através do download do programa '''Instalacao_Partiu.exe''' disponível no [http://www.basesoft.com.br/agil '''Base Ágil'''] ou link direto em [http://suporte.basesoft.com.br/Download/Updates/Instalacao_Partiu.exe Instalação Partiu].
+
Depois de instalado, poderá ser observado que o diretório Robô foi atualizando com todos os arquivos. Observe o arquivo '''config.inc.template.php''' dentro desse diretório, esse arquivo deverá ser editado e atualizado com as configurações de conexão como banco de dados é o módulo. Escolha a opção '''Salvar Como''' e salve esse arquivo com o nome de '''config.inc.php'''.
  
  
−
[[Arquivo:Partiu_Base_Agil.JPG|center]]
+
[[Arquivo:Robo_GIT_3.JPG|center]]
  
  
Linha 70: Linha 83:
 
| style="background-color:#F18F8F;border:none;padding:0.097cm;"|  
 
| style="background-color:#F18F8F;border:none;padding:0.097cm;"|  
  
−
'''A instalação do Robô Partiu deverá ser feita no mesmo equipamento que executa outras rotinas automáticas de atualização do sistema (Ex. Base Filtro, Robô CRM, etc.) e que deverá ter a capacidade de agendamento para execução automática.'''
+
'''O arquivo '''config.inc.php''' será o responsável pelas configurações de execução do robô e é muito importante no processo de atualização de versão, pois, possibilitará a execução de scripts de atualização do banco de dados.'''
−
 
+
−
'''O programa de instalação poderá ser utilizado também para atualização de versão, pois, conserva os arquivos de configuração dos clientes.'''
+
  
 
|}
 
|}
  
  
−
Antes de configurar o robô é necessário que se faça a atualização do banco de dados com as tabelas, procedures e triggers necessárias para o seu funcionamento. Dentro da pasta de instalação será criada a pasta '''FSQL''' onde poderá ser encontrado o comando '''Atualizar_DB.bat''', esse comando deverá ser executado via prompt e se encarregará de realizar as respectivas atualizações.
+
Também poderá ser observado que foi criado o programa '''atualização.bat''' dentro do diretório do robô, esse programa será o responsável pelas rotinas de atualização. Ele deverá ser programado no agendador do windows para rodar diariamente, de preferência em horários que não entrem em conflito com o operacional da empresa.
−
 
+
−
 
+
−
[[Arquivo:Partiu_Atualizar_DB.JPG|center]]
+
−
 
+
−
 
+
−
[[Arquivo:Partiu_Atualizar_DB1.JPG|center]]
+
  
  
Linha 90: Linha 95:
 
| style="background-color:#96CFF5;border:none;padding:0.097cm;"| '''
 
| style="background-color:#96CFF5;border:none;padding:0.097cm;"| '''
  
−
Esse procedimento será necessário somente no momento da instalação, pois, o processo de atualização de versão do banco de dados pelo Base Utilitários se encarregará de fazer as atualizações caso seja necessário.
+
Depois de feita a instalação e configuração do arquivo config.inc.php, o programa '''atualização.bat''' deverá ser executado (duplo clique) uma vez para que o banco de dados seja atualizado, finalizando o processo de instalação.
 +
 
 +
'''ANTES DE RODAR A ATUALIZAÇÃO, CONFIRA SE O ARQUIVO '''config.inc.php''' FOI CRIADO CORRETAMENTE NO DIRETÓRIO.'''
  
 
|}
 
|}
  
 +
====Versionamento====
  
−
O Robô tem a estrutura de configuração (através do arquivo '''config.inc.php''') e execução semelhante ao Robô do Base CRM, porém, antes desse processo devemos atentar para alguns detalhes importantes.
+
Conforme mencionado acima, o programa '''atualizacao.bat''' será o responsável pela atualização dos arquivos do robô, além da execução de scripts de atualização do banco de dados.
  
−
Dados de conexão com a API da Partiu:
+
Utilize o agendador de tarefas do windows para adicionar essa tarefa para execução diária, de preferência em horários que não entrem com conflito com o operacional da administradora.
  
−
:$config['api_token'] - '''Corresponde ao Token fornecido pela Partiu no momento do credenciamento'''.
+
Feito isso, o programa de atualização se encarregará de controlar os versionamentos.
−
:$config['api_enterprise_id'] - '''Correspondente ao Enterprise_id fornecido pela Partiu no momento do credenciamento'''.
+
  
−
Dados de configuração das entidades:
+
====Construção de Relatórios====
  
−
:$elegiveis - '''Corresponde à qual tipo de entidade (ex. Síndico, Condômino, Fornecedor, etc.) estará apta para receber os Promocodes'''.
+
Um grande recurso do Robô GIT é a possibilidade de gerar relatórios, pertinentes a cada módulo, à partir da elaboração de SQLs que serão executadas no banco de dados.
−
:$gratuidades - '''Corresponde à qual tipo de entidade terá direito a gratuidade'''.
+
  
 +
Tomando como exemplo o módulo partiu, observe o diretório '''jobs'''. Nele poderá ser observado a divisão por módulo.
  
−
{| style="border-spacing:0;width:100%;"
+
Acesse o diretório '''partiu\relatorios''' e observe os arquivos existentes nesse diretório.
−
| style="background-color:#F18F8F;border:none;padding:0.097cm;width:100px;"| [[Imagem:Atencao.png|center]]
+
−
| style="background-color:#F18F8F;border:none;padding:0.097cm;"|
+
  
−
'''As entidades que não estiverem no regime de gratuidade serão controladas pelo regime de assinatura, porém a única forma automática de cobrança do serviço por assinatura é pela emissão de cobrança bancária com a inclusão do item opcional no recibo. Portanto, somente para entidades contempladas pela cobrança.'''
 
  
−
'''A única distinção quanto a ativação é pelo tipo de entidade, a partir do momento que um tipo de entidade é eleita para receber o Promocode todas as entidades do mesmo tipo serão contempladas.'''
+
[[Arquivo:Robo_GIT_5.JPG|center]]
  
−
|}
 
  
 +
Para cada relatório deverá existir os respectivos arquivos '''.conf.php''' e '''.sql'''
  
−
Além das informações mencionadas acima, existem outras configurações:
 
  
−
:$duracaoPromocode['ASSINATURA'] = 60 - '''Corresponde à quantidade de dias que o Promocode de assinatura estará apto para uso '''depois de ativado'''.'''
+
:*'''Arquivo .conf.php''' -  Corresponde aos padrões para a geração do relatório (padrões csv, xls, xml e json), além de configurações específicas para cada tipo de arquivo.
  
  
−
{| style="border-spacing:0;width:100%;"
+
[[Arquivo:Robo_GIT_6.JPG|center]]
−
| style="background-color:#F18F8F;border:none;padding:0.097cm;width:100px;"| [[Imagem:Atencao.png|center]]
+
−
| style="background-color:#F18F8F;border:none;padding:0.097cm;"|
+
  
−
'''Para assinatura, quando configurado um período menor que 45 dias para a duração, o robô assumirá 45 dias por padrão.'''
 
  
−
|}
+
:*'''Arquivo .sql''' - Corresponde à consulta SQL que irá gerar os dados para o relatório.
  
  
−
:$duracaoPromocode['GRATUIDADE'] = 60 - '''Corresponde à quantidade de dias que o Promocode gratuito estará apto para uso '''depois de ativado'''.'''
+
A geração dos arquivos poderá ser feita sob demanda ou programada via agendador de tarefas.
−
:$diasParaRenovarAssinatura = 2 - '''Quantidade de dias antecedentes que o robô fará a verificação da validade para a renovação do Promocode de assinatura.'''
+
−
:$diasParaRenovarGratuidade = 2 - '''Quantidade de dias antecedentes que o robô fará a verificação da validade para a renovação do Promocode gratuito.'''
+
  
  
−
{| style="border-spacing:0;width:100%;"
+
O comando '''robo /relatorios''' é o responsável pela execução das SQLs e geração dos arquivos, contudo existem algumas variações:
−
| style="background-color:#F18F8F;border:none;padding:0.097cm;width:100px;"| [[Imagem:Atencao.png|center]]
+
−
| style="background-color:#F18F8F;border:none;padding:0.097cm;"|
+
  
−
'''Existe uma distinção quanto ao status do Promocode.'''
+
:*Ao comandar '''robo /relatorios''' serão gerados todos relatórios de todos os módulos do robô.
  
−
'''O '''Promocode ativado''' significa que ele foi utilizado pelo cliente no aplicativo e será regido pelos parâmetros '''$duracaoPromocode'''.'''
+
:*Ao comandar '''robo /relatorios partiu''' serão gerados todos os relatórios do módulo partiu.
  
−
'''Sendo do tipo '''Assinatura''' a renovação estará condicionada ao pagamento do item opcional no recibo. Porém, os 60 dias valem para a utilização do Promocode como forma de degustação, à partir daí o Promocode será desabilitado.'''
+
:*Ao comandar '''robo /relatorios partiu/Chave_Condomino''' será gerado somente o relatório selecionado.
  
−
'''Promocodes do tipo '''Gratuidade''' são renovados automaticamente enquanto a entidade estiver dentro do critério eletivo (Ex. Enquanto for síndico), '''mesmo que não tenham sido ativados'''. Os 60 dias também valem para utilização do Promocode como forma de degustação à partir do momento que for ativado, mesmo que a entidade não esteja mais dentro dos critérios eletivos.'''
+
O exemplo abaixo sugere a geração do relatório Verificar_Sindico do módulo partiu.
  
−
|}
 
  
−
====Versionamento====
+
[[Arquivo:Robo_GIT_7.JPG|center]]
  
−
====Construção de Relatórios====
+
 
 +
Ao executar o relatório, poderá ser observado que dentro do diretório do respectivo módulo (no exemplo '''jobs/partiu''') foi gerado um arquivo de acordo com os padrões configurados.
 +
 
 +
 
 +
[[Arquivo:Robo_GIT_8.JPG|center]]
 +
 
 +
 
 +
{| style="border-spacing:0;width:100%;"
 +
| style="background-color:#96CFF5;border:none;padding:0.097cm;width:100px;"| [[Arquivo:Dica.png|center]]
 +
| style="background-color:#96CFF5;border:none;padding:0.097cm;"| '''
 +
 
 +
Os arquivos correspondentes aos relatórios serão classificados conforme o nome do arquivo SQL, data e hora de geração.
 +
 
 +
'''ATENÇÃO!!! AO CRIAR UM RELATÓRIO, OS ARQUIVOS '''.CONF.PHP''' E '''SQL''', CORRESPONDENTES AO RELATÓRIO, DEVERÃO SER COPIADOS PARA QUE SE FAÇA A DEVIDA ATUALIZAÇÃO NO REPOSITÓRIO DO GIT E ATUALIZAÇÃO AUTOMÁTICA NOS DEMAIS CLIENTES.'''
 +
 
 +
|}
  
  
 
[[:Categoria:Tutoriais Base Condomínio|Funcionalidades Base Condomínio]]
 
[[:Categoria:Tutoriais Base Condomínio|Funcionalidades Base Condomínio]]

Edição atual tal como às 13h54min de 8 de dezembro de 2016


Visão Geral

Atencao.png

Essa documentação se refere à procedimentos internos da Base Software, está em construção e poderá sofrer ajustes até a liberação final.


O Robô GIT é o programa responsável pelos controles dos serviços incorporados aos Sistemas da Base.

Ele foi construído de forma a incorporar funcionalidades de acordo com cada módulo implementado, além do controle automático do seu próprio versionamento e atualização do banco de dados quanto as funcionalidades.

Além dessas vantagens ele também permite a criação de relatórios baseados em comandos SQL onde pode ser configurado o formato de saída (CSV, XML, XML e JSON), conforme a necessidade de cada módulo.


Dica.png

Para o controle de versionamento o Robô utiliza o Sistema GIT (sistema de controle de versão distribuído e um sistema de gerenciamento de código fonte).

Esse processo requer a instalação do GIT no equipamento, conforme será demonstrado a seguir.

Mais adiante, consulte o Wikipédia para mais informações sobre o Sistema GIT.

Procedimentos

Instalação do GIT

Conforme mencionado anteriormente, o GIT é o sistema que gerencia o versionamento do Robô. Ele deverá ser instalado no computador antes de iniciar qualquer tarefa.

O download do GIT para Windows poderá ser feito em Download GIT, depois de baixa-lo execute-o e siga o passo a passo para a instalação clicando e Next a cada passo sem alterar os parâmetros de instalação.

Atencao.png

A instalação do Robô não irá funcionar enquanto o GIT não for instalado no computador.

Configuração do Robô

Após o download e instalação do GIT pode ser feita a instalação e configuração do Robô.

A instalação deverá ser feita através do download do programa Instalador.bat disponível no link direto em Instalador.


Dica.png

O instalador deverá ser baixado no diretório correspondente a instalação do Robô, crie o diretório robo no computador de destino e copie o instalador.bat para esse diretório.


Robo GIT 1.JPG


Ao executar (duplo clique sobre o instalador), o instalador.bat se encarregará de baixar todos os arquivos necessários para a execução do robô.


Robo GIT 2.JPG


Depois de instalado, poderá ser observado que o diretório Robô foi atualizando com todos os arquivos. Observe o arquivo config.inc.template.php dentro desse diretório, esse arquivo deverá ser editado e atualizado com as configurações de conexão como banco de dados é o módulo. Escolha a opção Salvar Como e salve esse arquivo com o nome de config.inc.php.


Robo GIT 3.JPG


Atencao.png

O arquivo config.inc.php será o responsável pelas configurações de execução do robô e é muito importante no processo de atualização de versão, pois, possibilitará a execução de scripts de atualização do banco de dados.


Também poderá ser observado que foi criado o programa atualização.bat dentro do diretório do robô, esse programa será o responsável pelas rotinas de atualização. Ele deverá ser programado no agendador do windows para rodar diariamente, de preferência em horários que não entrem em conflito com o operacional da empresa.


Dica.png

Depois de feita a instalação e configuração do arquivo config.inc.php, o programa atualização.bat deverá ser executado (duplo clique) uma vez para que o banco de dados seja atualizado, finalizando o processo de instalação.

ANTES DE RODAR A ATUALIZAÇÃO, CONFIRA SE O ARQUIVO config.inc.php FOI CRIADO CORRETAMENTE NO DIRETÓRIO.

Versionamento

Conforme mencionado acima, o programa atualizacao.bat será o responsável pela atualização dos arquivos do robô, além da execução de scripts de atualização do banco de dados.

Utilize o agendador de tarefas do windows para adicionar essa tarefa para execução diária, de preferência em horários que não entrem com conflito com o operacional da administradora.

Feito isso, o programa de atualização se encarregará de controlar os versionamentos.

Construção de Relatórios

Um grande recurso do Robô GIT é a possibilidade de gerar relatórios, pertinentes a cada módulo, à partir da elaboração de SQLs que serão executadas no banco de dados.

Tomando como exemplo o módulo partiu, observe o diretório jobs. Nele poderá ser observado a divisão por módulo.

Acesse o diretório partiu\relatorios e observe os arquivos existentes nesse diretório.


Robo GIT 5.JPG


Para cada relatório deverá existir os respectivos arquivos .conf.php e .sql


  • Arquivo .conf.php - Corresponde aos padrões para a geração do relatório (padrões csv, xls, xml e json), além de configurações específicas para cada tipo de arquivo.


Robo GIT 6.JPG


  • Arquivo .sql - Corresponde à consulta SQL que irá gerar os dados para o relatório.


A geração dos arquivos poderá ser feita sob demanda ou programada via agendador de tarefas.


O comando robo /relatorios é o responsável pela execução das SQLs e geração dos arquivos, contudo existem algumas variações:

  • Ao comandar robo /relatorios serão gerados todos relatórios de todos os módulos do robô.
  • Ao comandar robo /relatorios partiu serão gerados todos os relatórios do módulo partiu.
  • Ao comandar robo /relatorios partiu/Chave_Condomino será gerado somente o relatório selecionado.

O exemplo abaixo sugere a geração do relatório Verificar_Sindico do módulo partiu.


Robo GIT 7.JPG


Ao executar o relatório, poderá ser observado que dentro do diretório do respectivo módulo (no exemplo jobs/partiu) foi gerado um arquivo de acordo com os padrões configurados.


Robo GIT 8.JPG


Dica.png

Os arquivos correspondentes aos relatórios serão classificados conforme o nome do arquivo SQL, data e hora de geração.

ATENÇÃO!!! AO CRIAR UM RELATÓRIO, OS ARQUIVOS .CONF.PHP E SQL, CORRESPONDENTES AO RELATÓRIO, DEVERÃO SER COPIADOS PARA QUE SE FAÇA A DEVIDA ATUALIZAÇÃO NO REPOSITÓRIO DO GIT E ATUALIZAÇÃO AUTOMÁTICA NOS DEMAIS CLIENTES.


Funcionalidades Base Condomínio

Disponível em "http://www.basesoft.com.br/w/index.php?title=Robo_GIT&oldid=20221"