BIS: mudanças entre as edições

De BIS Wiki
Ir para navegação Ir para pesquisar
← Edição anterior
 
(115 revisões intermediárias pelo mesmo usuário não estão sendo mostradas)
Linha 1: Linha 1:
== BIS 10 ==
Esta página contém a documentação do Sistema BIS em formato Wiki. O sistema é montado em cima do framework RFW, sua documentação pode ser encontrada em https://wiki.rodrigogml.eng.br/.
 
 
 
= BIS 10 =


Bem vindo ao wiki de documentação do BIS v10. Aqui devem registramos toda a documentação de desenvolvimento do sistema. Documentos comuns ao desenvolvimento são requisitos, planejamento de arquiteturas, manuais de boas práticas em equipe, manuais de componentes, regras de desenvolvimento e assim por diante.
Bem vindo ao wiki de documentação do BIS v10. Aqui devem registramos toda a documentação de desenvolvimento do sistema. Documentos comuns ao desenvolvimento são requisitos, planejamento de arquiteturas, manuais de boas práticas em equipe, manuais de componentes, regras de desenvolvimento e assim por diante.
Linha 11: Linha 15:
| <p align="justify" style="margin:10px;"><b>Tópicos relacionados ao conhecimento geral do projeto, sobre arquitetura, concepção, tecnologias usadas, etc. Leia e informe-se antes de proceder para o desenvolvimento.</b></p>
| <p align="justify" style="margin:10px;"><b>Tópicos relacionados ao conhecimento geral do projeto, sobre arquitetura, concepção, tecnologias usadas, etc. Leia e informe-se antes de proceder para o desenvolvimento.</b></p>
| <p align="justify" style="margin:10px;"><b>Aqui estão os registros da implementação do BISKernel. Os requisitos, as funcionalidades e manual de como usa-los, etc.</b></p>
| <p align="justify" style="margin:10px;"><b>Aqui estão os registros da implementação do BISKernel. Os requisitos, as funcionalidades e manual de como usa-los, etc.</b></p>
| <p align="justify" style="margin:10px;"><b>Aqui está a documentação da implementação dos módulos do sistema. Aqui estão as funcionalidade comerciais de um ERP para pequenos comércios com o foco principal em padarias.</b></p>
| <p align="justify" style="margin:10px;"><b>Aqui está a documentação da implementação dos módulos do sistema.</b></p>


|-
|-
| style="vertical-align:top; width:33%"|
| style="vertical-align:top; width:33%"|
* Instalação
* Instalação
** [[Preparação dos Ambientes]]
** [[Ambiente Desenvolvimento e Produção]]
 


* Registro e Definições do BIS10
** [[Eventos do BIS10]]


* [[Solução de Problemas]]


| style="vertical-align:top; width:33%"|
| style="vertical-align:top; width:33%"|
* '''Requisitos e Visão Geral do Sistema'''
* '''Serviços do Kernel'''
** [[Arquitetura do BIS]]
** [[BISLogger]]
 
 
* '''Estruturas, Patterns e Design'''
** Entidade de Dados
*** [[BISVO]] - Entidade
*** [[BISVO_]] - MetaDados Object
*** [[BISMeta Annotations]] - Sistema de Annotations para MetaDados dos VOs
** [[Exceções & Tratamento]]
** Persistência de Dados
*** [[BISDAO]]
*** [[BISMO]] - MatchObject
*** [[BISOrderBy]]




* '''Serviços do Kernel'''
* '''Módulos do Kernel'''
** [[BISBundle]] - Leitor de mensagens do BIS.
** [[Person]] - Módulo de Cadastro de Pessoas (Físicas ou Jurídicas centradlizado do Sistema)
** [[BISLogger]]
** [[BISSecurity]] - Acesso e segurança de usuários
** [[EventDispatcher]]
** [[Properties]] - Propriedades do Sistema




* '''UI - BISVaadin'''
** [[Teclas de Atalho]]
| style="vertical-align:top; width:33%"|
| style="vertical-align:top; width:33%"|


* '''Item'''
* '''Módulo de Item'''
** [[Cadastro de Itens]]
** [[Itens]]
** [[Balanças]]


* '''Fiscal'''
* '''Módulo Fiscal'''
** [[SPED]]
** [[TaxRules]]


* '''Fluxo de Caixa'''
** [[Contas Financeiras]] (Caixas)
** [[Contas à Pagar e Receber]]
|}
|}


== BIS Anterior a v10 ==
= BIS 2 =


Use os tópicos abaixo para navegar na documentação do BIS e conhecer sobre o desenvolvimento da aplicação.
Use os tópicos abaixo para navegar na documentação do BIS e conhecer sobre o desenvolvimento da aplicação.
Linha 89: Linha 73:
* Instalação
* Instalação
** [[Preparação do Servidor do Cliente]]
** [[Preparação do Servidor do Cliente]]
** [[Ambiente de Produção e Desenvolvimento]]
** [[Ambiente Desenvolvimento e Produção]]
** [[Pay&Go]]
** [[Pay&Go]]
** [[MGV Toledo]]
** [[MGV Toledo]]
Linha 116: Linha 100:
** [[BISMail]]
** [[BISMail]]
** [[BISSecurity]] - Acesso e segurança de usuários
** [[BISSecurity]] - Acesso e segurança de usuários
** [[BISSocket]] - Modulo de Conexão Server/Client
** BISSocket - Página alterada com o conteúdo do BIS10 - conteúdo anterior está em [[FWSocket]]
** [[BISTask]] - Definição de Tarefa usada por outros modulos
** [[BISTask]] - Definição de Tarefa usada por outros modulos
** [[BISValidator]] - Modulo de validação automatizada dos VOs.
** BISValidator - Modulo de validação automatizada dos VOs. (A página do BIS2 foi perdida sendo alterada para o BIS10 e depois para o RFW)
** [[BISRecursiveClone]] - Módulo de Clone Recursivo dos objetos.
** [[BISRecursiveClone]] - Módulo de Clone Recursivo dos objetos.
** [[BundleManager]] - Modulo de Internacionalização Integrada (i18N).
** [[BundleManager]] - Modulo de Internacionalização Integrada (i18N).
** [[CertCenter]] - Central de Certificados
** [[CertCenter]] - Central de Certificados
** [[CSVGenerator]] - Gerador de arquivos CSV a partir dos VOs.
** [[CSVGenerator]] - Gerador de arquivos CSV a partir dos VOs.
** [[EventDispatcher]]
** [[EventDispatcher-v2]]
** [[Location]] - Informações de endereços e localidades
** [[Location]] - Informações de endereços e localidades
** [[MeasureRuler]] - Régua de conversão de medidas.
** [[MeasureRuler]] - Régua de conversão de medidas.
Linha 129: Linha 113:
** [[Person]] - Cadastro Centralizado de Pessoas Físicas e Jurídicas
** [[Person]] - Cadastro Centralizado de Pessoas Físicas e Jurídicas
** [[PluginManager]]
** [[PluginManager]]
** [[Scheduler]] - Modulo de Agendamento de Tarefas
** [[Scheduler - BISv2]] - Modulo de Agendamento de Tarefas
** [[SystemProperties]] - Modulo de variáveis de sistema
** [[SystemProperties]] - Modulo de variáveis de sistema
*** [[Criando um Plugin]]
*** [[Criando um Plugin]]
Linha 167: Linha 151:
** [[CashFlow]]
** [[CashFlow]]
** [[BISModulesFiscal|Fiscal]]
** [[BISModulesFiscal|Fiscal]]
** [[Item]]
** [[Item-v2]]
** [[PDV]]
** [[PDV]]
** [[Terminal]]
** [[Terminal]]
** [[BISModulesSocket]]
** [[BISModulesSocket]]
* '''Aplicações Externas'''
** [[PDVApp]] - Aplicativo do Checkout




Linha 178: Linha 166:




|}
= BIS - Automation Eco System =
Utilizando a nomenclarura BIS, o sistema tem alguns módulos (aplicações) mais 'independentes', que embora se comuniquem com o sistema do BIS (tanto BIS2 quando BIS10), têm o potencial de se comunicar com outros sistemas e funcionar isoladamente.
Inicialmente esse projeto está sendo feito com a intenção de criar um ambiente para o sistema de vendas que não seja completamente dependente dos sistemas BIS2 e BIS10.
== BISHUB ==
O módulo '''BISHUB''' é o concentrador de funções. Ele será o responsável por comunicar com outros sistemas e fornecer o suporte e comunicação para os outros sistemas que completam o sistema de vendas.
{| class="wikitable" style="width:100%;"
!scope="col"| Overview e Documentação
!scope="col"| Funcionalidades e Clases Principais
|-
| style="vertical-align:top; width:50%"|
* Documentação do Sistema
** [[BISHUB API Functions]] - Relação de funções disponibilizadas pela API
* Guias de Referência
** [[Certificado para BISHUB API Server]]
| style="vertical-align:top; width:50%"|
|}
== BISPDV ==
BISPDV é uma nova versão do BISPDV já existente no BIS2, feita para substituir a versão antiga e comunicando diretamente com o BISHUB. Além de remover código antigo de emissão de cupons ECF e SAT, que deixarão de ter suporte.
{| class="wikitable" style="width:100%;"
!scope="col"| Overview e Documentação
!scope="col"| Funcionalidades e Clases Principais
|-
| style="vertical-align:top; width:50%"|
| style="vertical-align:top; width:50%"|
* Aplicação
** [[Inicialização e Estrutura do BISPDV]]
|}
= Documentação Possivelmente Desatualizada =
== BISFramework ==
=== BISFW.Main ===
O BISFW Main é o módulo principal do FrameWork do BIS. onde estão os itens mais básicos e que menos dependem de bibliotecas externas. Preferencialmente nenhuma, mas podem incluir algumas libs que sejam enxutas e não pesem na distribuição da aplicação final com excesso de pacotes que nunca serão utilizados.
{| class="wikitable" style="width:100%;"
!scope="col"| Design e Estrutura do FrameWork
!scope="col"| Funcionalidades
|-
| <p align="justify" style="margin:10px;"><b>Tópicos relacionados à estrutura e design patters do FrameWork.</b></p>
| <p align="justify" style="margin:10px;"><b>Classe de funcionalidades e Serviços que o FrameWork oferece.</b></p>
|-
| style="vertical-align:top; width:50%"|
* [[Introdução ao BISFramework]]
| style="vertical-align:top; width:50%"|
* [[FWMail]]
* [[FWReport]] - Herdado do BIS2 (antigo BISReport), permite a confecção de relatórios em PDF.
* [[FWSocket]] - Modulo de Conexão Server/Client por TCP
* [[JobMonitor]] - Processamento em Background
* [[Markdown]] - Linguagem de Marcação
* [[Scheduler]] - Agendador de Tarefas
* [[SessionManager]]
|}
=== BISFW.Vaadin ===
O BISFW Vaadin é o módulo do FrameWork responsável pela otimização da criação da UI com base no Framework Vaadin.
{| class="wikitable" style="width:100%;"
!scope="col"| Design e Estrutura do FrameWork
|-
| <p align="justify" style="margin:10px;"><b>Tópicos relacionados à estrutura e design patters do FrameWork.</b></p>
|-
| style="vertical-align:top; width:100%"|
* [[Introdução ao UIFactory]]
* Componentes da Interface
** [[Grid]]
|}
=== BISFW.AWS ===
Extensão do BISFW que agrega suporte para as funcionalidades de serviços oferecidos pelo AWS da Amazon.
{| class="wikitable" style="width:100%;"
!scope="col"| Funcionalidades
|-
| <p align="justify" style="margin:10px;"><b>Funcionalidades Oferecidas.</b></p>
|-
| style="vertical-align:top; width:100%"|
* [[FWS3]] - Manipulação do S3
|}
== BIS 10 ==
Bem vindo ao wiki de documentação do BIS v10. Aqui devem registramos toda a documentação de desenvolvimento do sistema. Documentos comuns ao desenvolvimento são requisitos, planejamento de arquiteturas, manuais de boas práticas em equipe, manuais de componentes, regras de desenvolvimento e assim por diante.
Use os tópicos abaixo para navegar na documentação do BIS e conhecer sobre o desenvolvimento da aplicação.
{| class="wikitable" style="width:100%;"
!scope="col"| Ambiente e outros Procedimentos
!scope="col"| BISKernel
!scope="col"| Modulos
|-
| <p align="justify" style="margin:10px;"><b>Tópicos relacionados ao conhecimento geral do projeto, sobre arquitetura, concepção, tecnologias usadas, etc. Leia e informe-se antes de proceder para o desenvolvimento.</b></p>
| <p align="justify" style="margin:10px;"><b>Aqui estão os registros da implementação do BISKernel. Os requisitos, as funcionalidades e manual de como usa-los, etc.</b></p>
| <p align="justify" style="margin:10px;"><b>Aqui está a documentação da implementação dos módulos do sistema.</b></p>
|-
| style="vertical-align:top; width:33%"|
* Registro e Definições do BIS10
** [[Portas do Servidor BIS10]]
* [[Solução de Problemas]]
| style="vertical-align:top; width:33%"|
* '''Requisitos e Visão Geral do Sistema'''
** [[Arquitetura do BIS]]
'''=== Itens Abaixo precisam de Revisão desde a criação do RFW.Kernel ==='''
* '''Serviços do Kernel'''
** [[BISMail]] - Sistema de Envio de E-mails
** [[BISNotification]] - Disparo de Notificações do Sistema
** [[BISSocket]] - Fachada por Socket
** [[CheckupDoctor]] - Chekup do sistema
** [[FileVO]] - Sistema de Arquivos
** [[Properties]] - Propriedades do Sistema
** [[BISSecurity]] - Acesso e segurança de usuários
** [[AutoReport]] - Relatórios Dinâmicos
* '''UI - BISVaadin'''
** [[Teclas de Atalho]]
* '''ThinSync'''
** [[Definições e Informações]]
| style="vertical-align:top; width:33%"|
* '''Item'''
** [[Itens]]
** [[Balanças]]
* '''Fiscal'''
** [[LockDate]]
** [[NF]]
** [[SPED]]
** '''PDV'''
*** [[Cupom Fiscal]]
** [[COP]] - Classificação da Operação
* '''Fluxo de Caixa'''
** [[Contas Financeiras]] (Caixas)
** [[Contas à Pagar e Receber]]
** [[Lançamentos Financeiros]] (StatementVO)
* '''Migration Tools'''
** [[MigrateBIS2To10]] - Ferramenta de migração dos dados do BIS2 para o BIS10
|}
|}


Linha 186: Linha 359:
!scope="col"| Projeto
!scope="col"| Projeto
!scope="col"| Descrição
!scope="col"| Descrição
|-
| style="vertical-align:top; width:20%"|
'''[[SEFAZClient]]'''
| <p align="justify" style="margin:10px;">Projeto usado para abstrair a conexão com o Web Service da SEFAZ.</p>


|-
|-
Linha 196: Linha 364:
'''[[BISPDV]]'''
'''[[BISPDV]]'''
| <p align="justify" style="margin:10px;">Projeto de sistema para checkouts de lojas, padarias, mercados, etc., que utiliza a emissão de cupons fiscais de acordo com o sistema de ECF e SAT. Este projeto faz parte do plugin [[BISModules]].</p>
| <p align="justify" style="margin:10px;">Projeto de sistema para checkouts de lojas, padarias, mercados, etc., que utiliza a emissão de cupons fiscais de acordo com o sistema de ECF e SAT. Este projeto faz parte do plugin [[BISModules]].</p>
|-
| style="vertical-align:top; width:20%"|
'''[[BISPDVNFCe]]'''
| <p align="justify" style="margin:10px;">Projeto de sistema para checkouts de lojas, padarias, mercados, etc., que utiliza a emissão de cupons fiscais de acordo com o sistema de NFCe. Este projeto faz parte do plugin [[BISModules]]. '''Este projeto tende a ser descontinuado como um projeto separado e deve ser migrado para dentro do projeto original BISPDV.'''</p>


|-
|-
Linha 252: Linha 415:


Para editar o wiki, consulte a [[https://www.mediawiki.org/wiki/Help:Formatting Ajuda de Formatação]] do wiki.
Para editar o wiki, consulte a [[https://www.mediawiki.org/wiki/Help:Formatting Ajuda de Formatação]] do wiki.
= HOG Invest =
Parte temporária para armazenar a documentação do Projeto [[HOG Invest]], até que ganhe sua própria página.

Edição atual tal como às 14h30min de 13 de março de 2025

Esta página contém a documentação do Sistema BIS em formato Wiki. O sistema é montado em cima do framework RFW, sua documentação pode ser encontrada em https://wiki.rodrigogml.eng.br/.


BIS 10

Bem vindo ao wiki de documentação do BIS v10. Aqui devem registramos toda a documentação de desenvolvimento do sistema. Documentos comuns ao desenvolvimento são requisitos, planejamento de arquiteturas, manuais de boas práticas em equipe, manuais de componentes, regras de desenvolvimento e assim por diante.

Use os tópicos abaixo para navegar na documentação do BIS e conhecer sobre o desenvolvimento da aplicação.

Ambiente e outros Procedimentos BISKernel Modulos

Tópicos relacionados ao conhecimento geral do projeto, sobre arquitetura, concepção, tecnologias usadas, etc. Leia e informe-se antes de proceder para o desenvolvimento.

Aqui estão os registros da implementação do BISKernel. Os requisitos, as funcionalidades e manual de como usa-los, etc.

Aqui está a documentação da implementação dos módulos do sistema.


  • Módulos do Kernel
    • Person - Módulo de Cadastro de Pessoas (Físicas ou Jurídicas centradlizado do Sistema)

BIS 2

Use os tópicos abaixo para navegar na documentação do BIS e conhecer sobre o desenvolvimento da aplicação.

Desenvolvendo o BISERP BISKernel BISModules

Tópicos relacionados ao conhecimento geral do projeto, sobre arquitetura, concepção, tecnologias usadas, etc. Leia e informe-se antes de proceder para o desenvolvimento.

Aqui estão os registros da implementação do BISKernel. Os requisitos, os modulos oferecidos e manual de como usa-los, etc.

Aqui está a documentação da implementação do Plugin BISModules. O BISModules tem a função de oferecer os módulos comerciais com as funcionalidades de um ERP para pequenos comércios com o foco principal em padarias.







  • Aplicações Externas
    • PDVApp - Aplicativo do Checkout




BIS - Automation Eco System

Utilizando a nomenclarura BIS, o sistema tem alguns módulos (aplicações) mais 'independentes', que embora se comuniquem com o sistema do BIS (tanto BIS2 quando BIS10), têm o potencial de se comunicar com outros sistemas e funcionar isoladamente.


Inicialmente esse projeto está sendo feito com a intenção de criar um ambiente para o sistema de vendas que não seja completamente dependente dos sistemas BIS2 e BIS10.


BISHUB

O módulo BISHUB é o concentrador de funções. Ele será o responsável por comunicar com outros sistemas e fornecer o suporte e comunicação para os outros sistemas que completam o sistema de vendas.


Overview e Documentação Funcionalidades e Clases Principais






BISPDV

BISPDV é uma nova versão do BISPDV já existente no BIS2, feita para substituir a versão antiga e comunicando diretamente com o BISHUB. Além de remover código antigo de emissão de cupons ECF e SAT, que deixarão de ter suporte.


Overview e Documentação Funcionalidades e Clases Principais


Documentação Possivelmente Desatualizada

BISFramework

BISFW.Main

O BISFW Main é o módulo principal do FrameWork do BIS. onde estão os itens mais básicos e que menos dependem de bibliotecas externas. Preferencialmente nenhuma, mas podem incluir algumas libs que sejam enxutas e não pesem na distribuição da aplicação final com excesso de pacotes que nunca serão utilizados.


Design e Estrutura do FrameWork Funcionalidades

Tópicos relacionados à estrutura e design patters do FrameWork.

Classe de funcionalidades e Serviços que o FrameWork oferece.

BISFW.Vaadin

O BISFW Vaadin é o módulo do FrameWork responsável pela otimização da criação da UI com base no Framework Vaadin.


Design e Estrutura do FrameWork

Tópicos relacionados à estrutura e design patters do FrameWork.

BISFW.AWS

Extensão do BISFW que agrega suporte para as funcionalidades de serviços oferecidos pelo AWS da Amazon.


Funcionalidades

Funcionalidades Oferecidas.

  • FWS3 - Manipulação do S3

BIS 10

Bem vindo ao wiki de documentação do BIS v10. Aqui devem registramos toda a documentação de desenvolvimento do sistema. Documentos comuns ao desenvolvimento são requisitos, planejamento de arquiteturas, manuais de boas práticas em equipe, manuais de componentes, regras de desenvolvimento e assim por diante.

Use os tópicos abaixo para navegar na documentação do BIS e conhecer sobre o desenvolvimento da aplicação.

Ambiente e outros Procedimentos BISKernel Modulos

Tópicos relacionados ao conhecimento geral do projeto, sobre arquitetura, concepção, tecnologias usadas, etc. Leia e informe-se antes de proceder para o desenvolvimento.

Aqui estão os registros da implementação do BISKernel. Os requisitos, as funcionalidades e manual de como usa-los, etc.

Aqui está a documentação da implementação dos módulos do sistema.

=== Itens Abaixo precisam de Revisão desde a criação do RFW.Kernel ===


  • Migration Tools

Bibliotecas e Projetos Auxiliares

Aqui está a definição de projetos auxiliares e bibliotecas que acrescentam funções ou serviços especiais ao BIS. Mas não costumam ser serviços muito comuns para fazerem parte permanente do BISKernel e pode ser utilizada por mais de um plugin, módulo ou aplicação externa por isso também não fica 'embutido' em um plugin ou outro.

Projeto Descrição

BISPDV

Projeto de sistema para checkouts de lojas, padarias, mercados, etc., que utiliza a emissão de cupons fiscais de acordo com o sistema de ECF e SAT. Este projeto faz parte do plugin BISModules.

BISTest

Projeto para armazenar os casos de testes do sistema. No mesmo projeto ficarão concentrados os casos de testes de todos os plugins.

Tutoriais, Ajudas e Relatos de Desenvolvimento

Aqui estão alguns tópicos de ajuda para os desenvolvedores. Tutoriais e registros de como foram feitas algumas tarefas de desenvolvimento do BIS. Os registros dessa seção em geral não estão associados à um único plugin, caso contrário devem ser registrados junto com a documentação do plugin. Esses tópicos tem sempre a intenção de ajudar a lembrar ou orientar o desenvolvedor à realizar a mesma tarefa ou dar manutenção no futuro.

Tópico Descrição

XSD To Java Objects

Orienta como utilizar o Eclipse para transformar o XSD de um WebService em objetos java para integração.

Criando KeyStore

Mostra passo a passo como criar uma KeyStore do java para armazenar certificados (com ou sem a chave privada). Os certificados de uma keystore podem ser usados em qualquer parte da aplicação para operações que utilizam criptografia. Mesmo certificados só com a chave pública podem ser colocadas em uma keystore para definir os certificados raiz confiáveis. Este tutorial explica como criar a keystore por comandos do KeyTool.

Axis2 WebService Client

Ensina como usar o Eclipse com Axis 2 para gerar um cliente para acesso à um webservice.

MySQL To DerbyDB

Auxilia a migrar comandos SQL e tipos de dados das colunas do MySQL para o DerbyDB.

Especificação de Guias e Boletos

Junta todas as informações relacionadas numeração de guias de impostos, boletos, contas de concessionárias, etc. encontradas durante o desenvolvimento. Um guia de referência e consulta para manutenções futuras.

Procedimentos do SAT

Documentação e procedimentos relacionados ao funcionamento do equipamento SAT.

Editando o Wiki

Para editar o wiki, consulte a [Ajuda de Formatação] do wiki.

HOG Invest

Parte temporária para armazenar a documentação do Projeto HOG Invest, até que ganhe sua própria página.

Disponível em “http://wiki.biserp.com.br/index.php?title=BIS&oldid=1608”