Mudanças entre as edições de "Robo GIT"
(→Gerando Arquivo Bureaux de Síndicos) |
(→Gerando Arquivo Bureaux de Condôminos) |
||
| Linha 154: | Linha 154: | ||
====Versionamento==== | ====Versionamento==== | ||
| − | ==== | + | ====Construção de Relatórios==== |
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
====Gerando Arquivo Bureaux de Locatários==== | ====Gerando Arquivo Bureaux de Locatários==== | ||
Edição das 09h12min de 7 de dezembro de 2016
Índice
Visão Geral
 |
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.
 |
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. |
Procedimentos
Instalando o 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.
| |
A instalação do Robô não irá funcionar enquanto o GIT não for instalado no computador. |
| |
Mais adiante, consulte o Wikipédia para mais informações sobre o Sistema GIT. |
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.
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 Base Ágil ou link direto em Instalação Partiu.
| |
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 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.
| |
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. |
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.
Dados de conexão com a API da Partiu:
- $config['api_token'] - Corresponde ao Token fornecido pela Partiu no momento do credenciamento.
- $config['api_enterprise_id'] - Correspondente ao Enterprise_id fornecido pela Partiu no momento do credenciamento.
Dados de configuração das entidades:
- $elegiveis - Corresponde à qual tipo de entidade (ex. Síndico, Condômino, Fornecedor, etc.) estará apta para receber os Promocodes.
- $gratuidades - Corresponde à qual tipo de entidade terá direito a gratuidade.
| |
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. |
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.
| |
Para assinatura, quando configurado um período menor que 45 dias para a duração, o robô assumirá 45 dias por padrão. |
- $duracaoPromocode['GRATUIDADE'] = 60 - Corresponde à quantidade de dias que o Promocode gratuito estará apto para uso depois de ativado.
- $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.
| |
Existe uma distinção quanto ao status do Promocode. O Promocode ativado significa que ele foi utilizado pelo cliente no aplicativo e será regido pelos parâmetros $duracaoPromocode. 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. 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. |
Versionamento
Construção de Relatórios
Gerando Arquivo Bureaux de Locatários
O padrão de lançamento não será feito com a cobrança do item opcional no primeiro mês. No primeiro momento o locatário receberá o layout diferenciado como degustação (60 dias), pois, somente a partir do mês seguinte a cobrança será efetuada. Esse lançamento depende da geração do arquivo padrão para que o respectivo bureaux faça as impressões do Layout correspondente mesclando o arquivo do chaves com o arquivo correspondente à impressão dos recibos.
O procedimento de geração do arquivo padrão deverá ser feito executando, via prompt, o comando Exportar_Chave_Locatario.bat que também estará dento da pasta FSQL.
| |
A execução do comando deverá ser feita passando o caminho do banco de dados como parâmetro. |
Esse comando irá gerar o arquivo CHAVE_LOCATARIO.CSV dentro da mesma pasta, esse arquivo deverá ser enviado à respectiva empresa de impressão bureaux.
| |
A empresa bureaux de impressão deverá estar preparada para processar o arquivo, mesclando as informações com o arquivo de recibos através do campo CODIGO_DO_IMOVEL de acordo com o layout de impressão para o lançamento. |
| |
Um exemplo do arquivo de locatários poderá ser consultado em Arquivo Locatário. |
Gerando Arquivo Bureaux de Locadores
O envio de Promocodes aos locadores deverá ser feito por meio de mala direta.
O procedimento de geração do arquivo padrão deverá ser feito executando, via prompt, o comando Exportar_Chave_Locador.bat que também estará dento da pasta FSQL.
| |
A execução do comando deverá ser feita passando o caminho do banco de dados como parâmetro. |
Esse comando irá gerar o arquivo CHAVE_LOCADOR.CSV dentro da mesma pasta, esse arquivo deverá ser enviado à respectiva empresa de impressão bureaux.
| |
Um exemplo do arquivo de locadores poderá ser consultado em Arquivo Locador. |
Verificar Promocodes Ativados
Também via prompt, o comando Verificar_Promocode_Ativo.bat poderá ser utilizado para gerar um arquivo de controle contendo os Promocodes que foram ativados.
| |
A execução do comando deverá ser feita passando o caminho do banco de dados como parâmetro. |
Esse comando irá gerar o arquivo CHAVES_ATIVAS.CSV dentro da mesma pasta, esse arquivo conterá o resumo dos Promocodes que foram ativados.
| |
Um exemplo do arquivo poderá ser consultado em Chaves Ativas. |
Lançamento de Opcionais
| |
Antes do lançamentos dos itens nos recibos o Parâmetro 325 que correspondente a conta (para o Base Condomínio) e/ou histórico (para o Base Locação) padrão correspondente ao item opcional do recibo. |
O Controle de Lançamento de Opcionais poderá ser utilizado para fazer o lançamento automático da cobrança em todos os rateios dos condomínios, sem a necessidade de editar rateio por rateio.
| |
Para o Sistema Base Locação o serviço deverá ser lançado na Aba Serviços do Contrato de Locação. Para mais detalhes sobre o lançamento de opcionais para condomínio consulte a documentação em Lançamentos de Opcionais. |
Controles Adicionais
Além dos controles necessários para a execução do robô, existem outros controles incorporados ao sistema para complementar o funcionamento.
Viewer GR_ENTIDADE_CLUBE_VANTAGENS - Monta consulta das entidades com os seus respectivos escopos (síndico, condômino, locador, etc), além do metadata referente aos campos de controle do clube de vantagens.
Trigger TG_CLUBE_VANTAGENS_COMPLEMENTO - Monitora a tabela de itens do recibo adicionando os Promocodes da entidade ao campo complemento do respectivo item.
Trigger TG_CLUBE_VANTAGENS_BAIXA - Também monitora a tabela de itens do recibo atualizando o metadata referente a data de pagamento do item na viewer GR_ENTIDADE_CLUBE_VANTAGENS.
Trigger TG_CLUBE_VANTAGENS_AVULSO - Monitora a tabela de unidades no lançamento avulso de contas a receber para zerar os valores de unidades vinculadas à entidades não elegíveis.
