BIS

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/.

Implementações em Andamento

Sessão dedicada ao registro das implementações em andamento, decisões e pendências.

Reorganização do Código

Organização das Classes Utilitárias

Leia sempre o comentário de cada classe utilitária antes de migrar um método para garantir o padrão da classe, além de buscar por outros métodos que possam já existir.

• Todos os métodos utilitários que possam ser genéricos devem ser migrados para o projeto RFW.

• Os métodos que não necessitam de bibliotecas externas devem ir para classes RU* adequadas do projeto RFW.Kernel, já os métodos com dependências de bibliotecas externas devem ser avaliados e talvez criados projetos específicos de acordo com suas finalidades.

• As classes utilitárias RUDV e RUDocValidation estão migrando seu conteúdo para o novo formato dentro da classe RUValueValidation.
• RUTypes - Essa classe passou a concentrar todos os métodos de tratamento de tipos e objetos de tipos do Java. Formatação, conversão, validação, etc.. Simplificando encontrar métodos de conversões que antes estavam espalhados em classes diferentes, por exemplo um conversor de String para BigDecimal estaria na classe de qual tipo?

RFW.Base

• Este projeto foi o primeiro do RFW antes da reestruturação das bibliotecas, e deve ser extinto, migrando seu conteúdo para os demais projetos do RFW.
• Todo o conteúdo do seu bundle foi jogado dentro do bundle do RFW.Kernel, que deve ser revisado depois de finalizar a migração.

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.
Instalação Ambiente Desenvolvimento e Produção Registro e Definições do BIS10 Eventos do BIS10	Serviços do Kernel BISLogger Módulos do Kernel Person - Módulo de Cadastro de Pessoas (Físicas ou Jurídicas centradlizado do Sistema)	Módulo de Item Itens Módulo Fiscal TaxRules

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.
Arquitetura do BIS Uso das Exceções Organização do Projeto Formatação e Escrita de Código Layers & Camadas Camada de Negócio (CRUD) Fachada do CRUD Versionamento e Release Definindo Número de Versão Procedimento de Merge Procedimento de Release Instalação Preparação do Servidor do Cliente Ambiente Desenvolvimento e Produção Pay&Go MGV Toledo Outras Informações Portas TCP/IP - Relação de portas usadas pelo BIS e sistemas integrados. Solução de Problemas	Estruturas, Patterns e Design Estrutura de Dados e Entidades BISVO - Entidade BISVO_ - MetaDados Object BISMeta Annotations - Sistema de Annotations para MetaDados dos VOs Tipo de Relacionamento das Entidades Persistência de Dados BISDAO Legacy - DAO JPA Mapeamentos JPA BISMO - MatchObject BISOrderBy Modulos do BISKernel BISLogger BISMail BISSecurity - Acesso e segurança de usuários 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 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. BundleManager - Modulo de Internacionalização Integrada (i18N). CertCenter - Central de Certificados CSVGenerator - Gerador de arquivos CSV a partir dos VOs. EventDispatcher-v2 Location - Informações de endereços e localidades MeasureRuler - Régua de conversão de medidas. ReportMaker - Sistema de geração de relatórios em PDF. Person - Cadastro Centralizado de Pessoas Físicas e Jurídicas PluginManager Scheduler - BISv2 - Modulo de Agendamento de Tarefas SystemProperties - Modulo de variáveis de sistema Criando um Plugin Interface do Usuário - Vaadin (UI) Camada de Apresentação - Vaadin Padrão Visual Plugin da Camada de Apresentação VaadinPluginManager VaadinPlugin Estrutura & Design BISUI Componentes da UI Janelas BISWindow BISListWindow BISListAndManagerWindow BISDialog BISConfirmCancelDialog Componentes Gráficos BISAssociativeDateRange BISPercentualBarComponent Componentes dos Modulos do Core PersonComponent Anexos Relação de Eventos do BISKernel	Apresentação do BISModules Módulos do BISModules CashFlow Terminal BISModulesSocket Anexos Relação de Eventos do BISModules

Módulo Item

O Módulo Item é o módulo responsável por manter o cadastro de produtos do sistema, organizando-os em categorias, tipos de itens, grupos, etc.. Também é o responsável por manter inventários (estoques) e outras informações relacionadas aos itens (produtos/serviços) do sistema.

Módulo PDV

O Módulo PDV é o módulo da Aplicação responsável por controlar e realizar as vendas para consumidores. O que inclui aplicações de Checkout e Terminais.

BISPDV

O BISPDV é a aplicação desktop utilizada no checkout para atender o consumidor, com controle de fichas, emissão de cupom fiscal, etc. Ele opera independentemente do servidor, mas sincroniza suas informações bidirecionalmente com ele.

Módulo Fiscal

O Módulo Fiscal é responsável por gerenciar a parte fiscal da empresa, como o gerenciamento de documentos fiscais (notas e cupons).

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
Documentação do Sistema BISHUB API Functions - Relação de funções disponibilizadas pela API Guias de Referência Certificado para BISHUB API Server

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.
Introdução ao BISFramework	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.

Design e Estrutura do FrameWork
Tópicos relacionados à estrutura e design patters do FrameWork.
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.

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.
Registro e Definições do BIS10 Portas do Servidor BIS10 Solução de Problemas	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	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

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
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.