BISAWiki - Contribuições do usuário [pt-br]

Critérios de Aceitação

2013-04-29T18:52:10Z

AnaPaula:

• Critérios de Aceitação do PO

o O tamanho do escopo deve manter a capacidade do time, analisada de acordo com dados históricos;
o Liberação de todos os artefatos identificados como produtos liberados para o cliente;
o Conclusão com êxito das avaliações de artefato identificadas no Plano de Projeto;
o Conclusão com êxito do treinamento do suporte;
o Conclusão com êxito da aprovação do teste;
o Medidas que identificarão até que ponto as especificações originais do projeto foram atendidas;

• Critérios de Aceitação do Time

o Requisição registrada no Mantis;
o Clareza dos requisitos;
o Requisitos devem ser possíveis de implementação;
o Ambiente de teste necessário está configurado;
o Requisitos devem ser testáveis;

Arquivo:BizAgi-BPMN-Lane.png

2013-04-23T19:45:00Z

AnaPaula: BizAgi-BPMN-Lane.png

BizAgi-BPMN-Lane.png

Arquivo:BizAgi-BPMN-ExclusiveGateway.png

2013-04-23T19:44:58Z

AnaPaula: BizAgi-BPMN-ExclusiveGateway.png

BizAgi-BPMN-ExclusiveGateway.png

Arquivo:BizAgi-BPMN-NoneStart.png

2013-04-23T19:44:55Z

AnaPaula: foi enviada uma nova versão de "Arquivo:BizAgi-BPMN-NoneStart.png": BizAgi-BPMN-NoneStart.png

BizAgi-BPMN-NoneStart.png

Arquivo:BizAgi-BPMN-NoneEnd.png

2013-04-23T19:44:53Z

AnaPaula: foi enviada uma nova versão de "Arquivo:BizAgi-BPMN-NoneEnd.png": BizAgi-BPMN-NoneEnd.png

BizAgi-BPMN-NoneEnd.png

Arquivo:BizAgi-BPMN-AbstractTask.png

2013-04-23T19:44:51Z

AnaPaula: foi enviada uma nova versão de "Arquivo:BizAgi-BPMN-AbstractTask.png": BizAgi-BPMN-AbstractTask.png

BizAgi-BPMN-AbstractTask.png

Arquivo:BizAgi-BPMN-Participant.png

2013-04-23T19:44:49Z

AnaPaula: foi enviada uma nova versão de "Arquivo:BizAgi-BPMN-Participant.png": BizAgi-BPMN-Participant.png

BizAgi-BPMN-Participant.png

Arquivo:EstagiosDeTeste-DiagramaEstagiosDeTeste.png

2013-04-23T19:44:47Z

AnaPaula: EstagiosDeTeste-DiagramaEstagiosDeTeste.png

EstagiosDeTeste-DiagramaEstagiosDeTeste.png

Estagios de teste

2013-04-23T19:44:44Z

AnaPaula: Automatic page editing

==Estagios de teste - Bizagi Process Modeler==

===Process Diagrams===
<gallery>
File:EstagiosDeTeste-DiagramaEstagiosDeTeste.png|[[Estagios de teste-Diagrama Estágios de teste|Diagrama Estágios de teste ]]

</gallery>

Estagios de teste-Diagrama Estágios de teste

2013-04-23T19:44:39Z

AnaPaula: Automatic page editing

==Diagrama Estágios de teste - Bizagi Process Modeler==

'''Version: ''' 1.0

'''Author: ''' Ana Paula

[[Image:EstagiosDeTeste-DiagramaEstagiosDeTeste.png|715px]]

===Estágios de Teste===

[[File:BizAgi-BPMN-Participant.png]]

====Process Elements====

=====Teste de Unidade=====

[[File:BizAgi-BPMN-AbstractTask.png]]

'''Description'''

Também conhecida como teste unitário ou teste de módulo, é a fase em que se testam as menores unidades de software desenvolvidas (pequenas partes ou unidades do sistema). O universo alvo desse tipo de teste são as subrotinas ou mesmo pequenos trechos de código. Assim, o objetivo é o de encontrar falhas de funcionamento dentro de uma pequena parte do sistema funcionando independentemente do todo. Essa fase pode ser feita de forma manual ou através de ferramentas automatizadas visando principalmente a diminuição da possibilidade de erros de codificação. Na Bisa é utilizado somente de forma manual. O desenvolvedor testa o comportamento do componente de software isoladamente. Esse compontente analisado, pode ser um ou mais métodos de objetos, pequenos trechos de código, uma classe, um módulo ou mesmo um procedimento. 

=====Teste de Integração=====

[[File:BizAgi-BPMN-AbstractTask.png]]

'''Description'''

O objetivo é encontrar falhas provenientes da integração interna dos componentes de um sistema. Geralmente os tipos de falhas encontradas são de transmissão de dados. Por exemplo, um componente A pode estar aguardando o retorno de um valor X ao executar um método do componente B; porém, B pode retornar um valor Y, gerando uma falha. Não faz parte do escopo dessa fase de teste o tratamento de interfaces com outros sistemas (integração entre sistemas). Essas interfaces são testadas na fase de teste de sistema, apesar de, a critério do gerente de projeto, estas interfaces podem ser testadas mesmo antes de o sistema estar plenamente construído.

=====Teste de Aceitação=====

[[File:BizAgi-BPMN-AbstractTask.png]]

'''Description'''

Geralmente, os testes de aceitação são realizados por um grupo restrito de usuários finais do sistema, que simulam operações de rotina do sistema de modo a verificar se seu comportamento está de acordo com o solicitado. Teste formal conduzido para determinar se um sistema satisfaz ou não seus critérios de aceitação e para permitir ao cliente determinar se aceita ou não o sistema. Validação de um software pelo comprador, pelo usuário ou por terceira parte, com o uso de dados ou cenários especificados ou reais. Pode incluir testes funcionais, de configuração, de recuperação de falhas, de segurança e de desempenho.

=====Fim=====

[[File:BizAgi-BPMN-NoneEnd.png]]

=====Início=====

[[File:BizAgi-BPMN-NoneStart.png]]

=====Cliente deseja testar a aplicação?=====

[[File:BizAgi-BPMN-ExclusiveGateway.png]]

'''Description'''

Verifica se o cliente deseja testar o software antes de ser implantado

'''Gates'''

'''Sim'''

'''Não'''

=====Desenvolvedor=====

[[File:BizAgi-BPMN-Lane.png]]

===== Testador=====

[[File:BizAgi-BPMN-Lane.png]]

=====Teste de sistema=====

[[File:BizAgi-BPMN-AbstractTask.png]]

'''Description'''

Na fase de teste de sistema, o objetivo é executar o sistema sob ponto de vista de seu usuário final, varrendo as funcionalidades em busca de falhas em relação aos objetivos originais. Os testes são executados em condições similares – de ambiente, interfaces sistêmicas e massas de dados – àquelas que um usuário utilizará no seu dia-a-dia de manipulação do sistema.

Papéis relacionados ao desenvolvimento de software da Bisa

2013-04-15T20:19:11Z

AnaPaula: Página substituída por 'Definição dos papéis existentes no processo de desenvolvimento da Bisa: Arquivo:Papeis.png'

Definição dos papéis existentes no processo de desenvolvimento da Bisa:

[[Arquivo:Papeis.png]]

Arquivo:Papeis.png

2013-04-15T20:18:50Z

AnaPaula:

Planning Poker

2013-03-06T02:56:15Z

AnaPaula:

==Definição==
Conforme definido no Wikipédia[1] (a enciclopédia livre), o planning poker também chamado de poker Scrum, é uma técnica baseada no consenso para estimar, usado principalmente para estimar o esforço ou o tamanho relativo de histórias de usuários em desenvolvimento de software . É uma variação do Delphi Wideband método. É mais comumente usado em desenvolvimento ágil de software , em particular o Extreme Programming metodologia. 

==Procedimento BisaWeb==

Na reunião de estimação, cada estimador é dado um baralho de cartas. Todas as plataformas têm conjuntos idênticos de placas neles.
A reunião prossegue como se segue: 
*Um moderador, que não vai jogar, preside a reunião. 
*O gerente de produto fornece uma visão curta. A equipe é a oportunidade de fazer perguntas e discutir a esclarecer pressupostos e riscos. Um resumo da discussão é registrado pelo Gerente de Projeto.
*Cada indivíduo coloca uma carta virada para baixo representando sua estimativa. Unidades usadas variam - podem ser dias de duração, os dias ideais ou pontos da história . Durante a discussão, os números não devem ser mencionados em tudo em relação a característica tamanho para evitar ancoragem .
*Todos o chamam os seus cartões em simultâneo por entregá-los.
*Pessoas com estimativas elevadas e estimativas baixas são dadas uma caixa de sabão para oferecer a sua justificação para a sua estimativa e, em seguida, a discussão continua.
*Repita o processo de estimação até que um consenso seja alcançado. O desenvolvedor que foi probabilidade de possuir a entrega tem uma parcela grande do "voto de consenso", embora o moderador pode negociar o consenso.
 
Os cartões são numerados como eles são para levar em conta o facto de que quanto mais tempo uma estimativa, mais incerteza que ele contém. Assim, se um desenvolvedor quer jogar um 6, ele é forçado a reconsiderar e quer trabalhar com que parte da incerteza percebida não existem e desempenham um 5, ou aceitar uma contabilidade estimativa conservadora para a incerteza e jogar um 8.

[1] http://en.wikipedia.org/wiki/Planning_poker

--[[Usuário:AnaPaula|AnaPaula]] 11h57min de 13 de dezembro de 2012 (BRST)

Abrindo requisições no Mantis

2013-02-26T14:34:50Z

AnaPaula: Limpou toda a página

Plano de Teste

2013-02-14T19:57:24Z

AnaPaula:

[[Arquivo:mpt1.PNG]] 

=1. OBJETIVO=

O objetivo desse Guia é especificar como serão desenvolvidas as atividades de teste na Bisa, abordando técnicas a serem utilizadas durante a sua execução, reunindo todas as informações necessárias para planejamento e controle de teste referente a uma iteração específica.

=2. CONCEITOS BÁSICOS=
===2.1 Tipos de testes===
Existem vários tipos de teste. Este Guia abordará apenas o tipos utilizados pela Bisa. Seguimos duas técnicas de teste, Caixa Branca e Caixa Preta, distribuídos em quatro níveis (Teste de Unidade, de Integração, de Sistema e de Aceitação). Veremos na figura abaixo e melhor detalhado no link: <http://www.portalbisa.com.br/wiki/index.php/Fluxograma_representando_o_processo_de_desenvolvimento_de_Testes_na_Bisa>

[[Arquivo:Diagrama_Estágios_de_teste.png]]

===2.2 Itens a serem testados===
O acompanhamento de testes de todas as CRs será feito através da planilha: http://boletoswebbisa.com.br/processo/Sprint%20Delphi

===2.3 Critérios de Entrada===
Podemos iniciar os testes quando o ambiente de teste estiver pronto e configurado e as versões beta liberadas para o teste.

===2.3 Critérios de Saída===
Podemos encerrar os testes quando todos os testes planejados forem executados e todos os problemas encontrados e reportados segundo o padrão.

===2.4 Critérios de Suspensão===
Os testes devem ser suspensos quando o ambiente se mostrar instável ou os problemas encontrados em uma requisição afetem outras requisições impedindo que os testes sejam executados. O teste também será suspenso caso haja qualquer tipo de falha inesperada no ambiente de teste.

=3. O PROCESSO DE TESTE NA BISA=
===3.1 Processo===
1. Análise do escopo 
2. Execução do teste 
3. Aceitação 
4. Implantação do Sistema 

===3.2 Fluxo de teste===
Abaixo é apresentada uma figura representando o processo de execução de teste da BisaWeb.

[[Arquivo:Testar_Build.png]]

=4. PADRÕES DE DOCUMENTAÇÃO=

===4.1 Criação da suite campos necessários:===
Campo <Nome da suite de Teste>
* Na suite de teste principal deve-se colocar o nome da rotina do sistema, ao qual deseja-se fazer relação a requisição que vai ser criado o caso de teste.
* Na suite secundaria deve-se ser colocado o nome do módulo ao qual a requisição pertence.
Detalhes: Uma breve descrição sobre a suite que está se criando, por exemplo se a suite for referente a rotina deve-se explicar a rotina, se for referente ao modulo deve-se explicar o modulo
===4.2 Palavras chaves disponíveis:===

* Quando for criada a suite principal deve-se criar pelo menos uma palavra chave associada a cada caso de teste.
* Quando for criado o módulo deve-se criar uma palavra chave referente ao modulo.

===4.3 Na criação dos casos de teste é necessário preencher os seguintes campos:===

Campo <Título do Caso de Teste>
* Neste campo deve conter o número do mantis e a descrição
Campo <Objetivo do Teste>
* Descrever o objetivo do teste de forma clara para que o testador saiba o que esta testando e verifique se o resultado está de acordo com o esperado.
Campo <Pré-Condição>
* Preencher com os dados necessários para a execução do CT
Campo < Pós-Condição>
* Campo opcional.
Campo <Tipo de Execução>
* Deve-se escolher entre as opções Manual ou automatizado:
Opção Manual - teste executado através dos casos de teste. 
Opção Automatizado - irá utilizar uma ferramenta para teste automatizados onde são criados scripts de teste. 
Campo <Prioridade do Teste>
* Deve-se escolher uma das opções: alto, médio ou baixo.
Campo <Palavras chaves>
* Outras palavras chaves devem ser identificadas para apoio no reuso.

=5. DEFINIÇÕES PARA O RESULTADO DA EXECUÇÃO DO CASO DE TESTE=

* Bloqueado: O caso de teste será bloqueado quando o mesmo estiver desatualizado ou quando um passo não estiver bem descrito impossibilitando seguir para o passo seguinte.
* Passou: Um caso de teste estará aprovado quando todos os passos forem executados sem falhas e sem bloqueios
* Falhou: É dado como falha quando o resultado esperado de um passo está diferente do resultado da aplicação.

=6. REPORTANDO BUGS=
O erro deverá ser reportado ao desenvolvedor através do Mantis. O status do mantis é alterado para atribuído, devolvendo o mantis para o programador responsável pela requisição.
===6.1 Campos obrigatórios do mantis -===
Campo <Adicionar Anotação> nesse campo é descrito passo a passo como reproduzir o erro e qual o real resultado esperado da aplicação. 
Campo <Carregar Arquivo> Nesse campo são adicionadas imagens com o passo a passo reproduzindo o erro.

--[[Usuário:AnaPaula|AnaPaula]] 12h13min de 15 de janeiro de 2013 (BRST)

Para uso do CTW

2013-02-07T14:17:19Z

AnaPaula: /* Introdução */

= Sistema de Contabilidade =
* '''''Autor: Ronaldo Barros'''''
* '''''Data: 2008 (primeira versão)'''''
* '''''Versão atual: 6.1.72'''''

----

=Introdução=

Em virtude da demanda por um software de contabilidade para a plataforma Windows que possa se integrar aos demais sistemas da BISA naquela plataforma, a empresa decidiu requerer do seu corpo técnico a elaboração deste projeto. 

Visando minimizar a necessidade de retreinamento de seus clientes, a empresa pede que sistema mantenha a interface com o usuário no mesmo padrão dos seus demais sistemas. 

O sistema a ser desenvolvido deverá prover recursos para um controle contábil formal/legal e para um controle contábil gerencial. 

A análise e notação do sistema será feita em UML de modo a fornecer para toda equipe envolvida uma compreensão única do projeto.

Veja a documentação no Word, [[Media:clickando aqui]]

=Requisitos Funcionais=

• '''Sistema Multi-Empresa''' 
O sistema deverá permitir o gerenciamento contábil de várias empresas independentemente. 

'''• Cadastrar Plano Orçamentário''' 
O sistema deverá prover ao usuário condições para que ele monte seu plano Orçamentário 

'''• Cadastrar Contas''' 
O sistema deverá prover ao usuário condições para que ele monte os seus planos de contas em sintonia com plano orçamentário (Se houver) 

• '''Importação de Plano de contas''' 
sistema deverá possibilitar a importação do plano de contas de uma empresa à outra. 

• '''Importação de Lançamentos''' 
O sistema deverá possibilitar importação de Lançamentos verificando consistência das informações. 

'''• Registrar Lançamentos''' 
O sistema deverá registrar os lançamentos de acordo com as normas contábeis, podendo ser de partida dobrada ou múltipla. 

'''• Cadastrar Históricos''' 
Histórico padrão de acordo com a necessidade do usuário. 

'''• Cadastrar Centro de Custos''' 
O sistema deverá prover ao usuário condições para que ele monte os seus Centro de custos. 

'''• Emitir o Razão '''
O sistema deverá prover ao usuário o relatório Razão 

'''• Emitir o Diário '''
O sistema deverá prover ao usuário o relatório Diário 

'''• Emitir Balancete '''
O sistema deverá prover ao usuário o relatório Balancete 

'''• Emitir Balanço '''
O sistema deverá prover ao usuário o relatório Balanço 

'''• Efetuar os lançamentos de encerramento de exercício''' 
sistema deverá, quando solicitado, efetuar os lançamentos de encerramento de exercício contábil 

=Requisitos não Funcionais=

'''• Plataforma''' 
O sistema deverá ser desenvolvido para a platoforma Windows 

'''• Segurança''' 
O sistema deverá manter controle dos seus usuários 

'''• Persistência '''
Os dados deverão ser armazenados em bancos de dados Access 

'''• Integridade '''
Efetuar alteraçoes no banco de dados por meio de Transações 

'''• Tempo de resposta''' 
Efetivação de lançamento online 

'''• Interface com o Usuário''' 
Manter o padrão da BISA 

'''• Interface com outros sistemas''' 
Deve ser definida uma interface que permita que outros sistemas gerem ou provoquem a geração de lançamentos contábeis. 

=Diagrama de casos de uso=

[[Arquivo:DIAGRAMA DE CASOS DE USO DO SISTEMA CTW.png]]
[[Arquivo:Caso_de_uso.PNG]]

=Descrição dos Casos de uso=

'''Login no sistema:'''

O login do sistema segue o padrão da BISA com o form FRM_Login , informando o usuário e senha, com acesso independente de senha desde que o usuário se logue no sistema como “visitante”. 
Ao logar-se no sistema, o usuário deverá informar seu username e senha padrões dos sistemas BISA. seus dados de entrada são comparados com o registro de usuários específico do sistema de Contabilidade. Identificado o usuário dentro do sistema. 
Confirmada a identificação, o usuário selecionará uma empresa existente ou a criaçao de uma nova, APÓS é feito uma checagem se o MDB corresponde àquele selecionado. 

'''Manter Empresas:'''

FRM_Empresa não permite a inclusão de novas empresas, apenas a manutenção dos dados referentes a empresa previamente criada junto com o MDB.
Quatro rotinas presentes neste Form são de tamanha importância:

• Definição da Máscara do plano de contas (caso alterada após definição do PC apagar registros, solicitando antes a confimação da operaçao); 
• Definição da Máscara do centro de Custos 
• Definição se a empresa adota um Plano Orçamentario ou não 
• Definição da Máscara do Plano Orçamentário (caso empresa adote) 

'''Manter Plano Orçamentário (Caso necessário):'''

Possui hierarquia, sendo semelhante e mais simples que a do plano de contas 

'''Manter Plano de Contas:'''

Este Formulário é de grande importância para o sistema, pois a partir das contas aqui armazenadas é que serão implementadas a maioria das rotinas do sistema. Devemos implementar rotinas para verificação dos seguintes casos: 

• Caso não haja nenhum registro ou lançamentos, permitir importação de PC 
• Verificar se existe conta pai (Hierarquia) 
• Verificar se a Conta é Analíca ou Sintética (Flag) 
• Verificar Grau da Conta 
• Codigo Reduzido só é aplicado para contas analiticas 
• Relacão com plano orçamentário se existir (Só em contas patrimoniais) 

'''Manter Centro de Custos:'''

Possui hierarquia, sendo semelhante e mais simples que a do plano de contas 

'''Manter Históricos:'''

Serve para descrição dos lançamentos, seguindo o esquema da BISA 

'''Efetuar Lançamentos:'''

Formulário de grande importância para determinar o desempenho Tempo X Espaço do sistema assim como a integridade e coerência das informações, pois possui a maioria das definições contábeis formais e procedimentos usados pelo CTW. 

Para otimizar o desempenho do sistema foram adotadas as seguintes convenções: 

• Os lançamentos ocorrerão utilizando-se código reduzido 
• cálculo do saldo das contas será On-line 
• lançamento poderá ser de partida dobrada ou múltipla, o sistema deverá ter controle do valor de créditos e débitos 
• Rotina para importação e exportação de lançamentos 
• Rotina para efetuar lançamentos de encerramento contábil 

'''Relatórios:'''

• Razão – Possui a conta, saldo anterior, creditos, debitos, saldo, lançamento e data, totalização da conta 
• Livro Diário – Possui a conta, contra partida, lançamento, histórico, debitos, créditos, Total do movimento do dia, Total de movimentação mensal 
• Balancete – Possui a conta, saldo anterior, débitos, créditos, saldo atual 
• Balanço – Possui a conta e o saldo atual. 

=Divisão do Sistema em Subsistemas (Pacotes)=

[[Arquivo:Divisão do Sistema em Subsistemas (Pacotes).PNG]]

=Diagrama de Casos de uso do subsistema lançamento=
[[Arquivo:Diagrama_de_Casos_de_uso_do_subsistema_lançamento.PNG]]

--[[Usuário:AnaPaula|AnaPaula]] 11h45min de 17 de dezembro de 2012 (BRST)

=Diagrama de classes do subsistema lançamento=
[[Arquivo:Diagrama_de_classes_do_subsistema_lançamento.PNG]]
[[Arquivo:Diagragrama_de_classes_subsistema.PNG]]

=Diagrama de atividades do subsistema lançamento=
[[Arquivo:Diagrama_de_atividades_do_subsistema_lançamento.PNG]]

=Diagrama de sequência do fluxo principal do subsistema lançamento=
[[Arquivo:Diagrama_de_sequência_do_fluxo_principal_do_subsistema_lançamento.png]]

=Diagrama de Casos de uso do subsistema Relatórios=
[[Arquivo:Diagrama_de_Casos_de_uso_do_subsistema_Relatórios.PNG]]

=Diagrama de Classes do subsistema Relatórios=
[[Arquivo:Diagrama_de_Classes_do_subsistema_Relatórios.PNG]]

=Diagrama de atividades do subsistema Relatórios=
[[Arquivo:Diagrama_de_atividades_do_subsistema_Relatórios.PNG]]

=Diagrama de sequência do fluxo principal do subsistema de relatórios=
[[Arquivo:Diagrama_de_sequência_do_fluxo_principal_do_subsistema_de_relatórios.PNG]]
[[Arquivo:Diagrama_de_sequência_do_fluxo_principal_do_subsistema_de_rel.PNG]]

=Diagrama de Casos de uso do subsistema Segurança=
[[Arquivo:Diagrama_de_Casos_de_uso_do_subsistema_Segurança.PNG]]

=Diagrama de classes do subsistema segurança=
[[Arquivo:Diagrama_de_classes_do_subsistema_segurança.PNG‎]]

=Diagrama de atividades do subsistema segurança=
[[Arquivo:Diagrama_de_atividades_do_subsistema_segurança.PNG]]

=Diagrama de casos de uso do subsistema cadastros=
[[Arquivo:Diagrama_de_casos_de_uso_do_subsistema_cadastros.PNG]]

=Diagrama de classes do subsistema cadastros=
[[Arquivo:Diagrama_de_classes_do_subsistema_cadastros.PNG]]

=Relacionamento da Base de Dados do Sistema e Descrição das Tabelas=
[[Arquivo:Relacionamento_da_Base_de_Dados_do_Sistema_e_Descrição_das_Tabelas.PNG]] 

[[Arquivo:Cadastroo_de_empresa.PNG]]

=Glossário=

O glossário consiste basicamente em um conjunto de conceitos, termos e expressões a serem usados nas tarefas de análise, codificação, documentação e homologação do sistema., devendo pois ser de conhecimento e domínio de todos os interlocutores que participam do desenvolvimento do produto de modo a evitar ambigüidades e promover o bom entendimento entre desenvolvedores e clientes e entre os desenvolvedores entre si.

''Conta Contábil ou simplesmente Conta: Totalização.''

''Natureza da Conta Contábil: Indica se a conta é normalmente credora ou devedora. Através dessa distinção, pode-se fazer uma crítica para apontar se a conta que deveria ficar credora ficou devedora e vice-versa.

Classificação da Conta Contábil: Patrimonial, Receitas, Despesas, Outras.

Conta Sintética: Conta que possui contas a ela subordinadas. Uma conta sintética não pode receber lançamentos. O saldo de uma conta sintética é igual à soma dos saldos das contas que lhe são imediatamente subordinadas.

Conta Analítica: Conta que não possui contas a ela subordinadas. Uma conta analítica pode receber lançamentos. O saldo de uma conta sintética é igual à soma do seu saldo anterior mais os créditos menos os débitos lançados no período.

Plano de Contas: conjunto de contas (analíticas e sintéticas) em organização hierárquica.
Movimento: registro dos débitos e créditos de um ato contábil.

Lançamento: valor que se adiciona aos débitos ou aos créditos de uma conta em um movimento.

Partida: conjunto de lançamentos com mesmo tipo de operação contábil (débito,crédito).

Contrapartida: conjunto de lançamentos com o tipo de operação inverso ao da partida.

Histórico: descrição/documentação do lançamento.

Histórico Padrão: históricos que rotineiramente são atribuídos aos lançamentos, podendo requerer que o usuário complemente informação.

Débito: subtração do valor lançado do saldo da conta.

Crédito: adição do valor lançado ao saldo da conta.

Centro de Custo: classificação usada para apurar custos segundo critérios diversos aos do plano de contas. Por exemplo: por departamento da empresa, por localização dentro da empresa, por projeto, por empreitada, por contrato).

Plano de Centros de Custo: conjunto de Centros de custo (analíticos e sintéticos) em organização hierárquica.

Saldo Anterior: Valor do Saldo Atual da conta no mês anterior.

Saldo Atual: O saldo de uma conta é sempre igual à soma do seu saldo anterior mais os créditos menos os débitos lançados no mês.

Efetivação de lançamento: operação que consiste em fazer com que o valor lançado componha o saldo das contas envolvidas. Pode ser dividido nas seguintes tarefas:
*Somar o valor do lançamento ao total de débitos ou ao total de créditos da conta analítica e das contas sintéticas a ela superiores;
*Em seguida efetuar o cálculo do saldo atual de cada conta envolvida (somar ou subtrair o valor do lançamento ao campo de saldo atual);
*Para cada conta envolvida no lançamento e para cada mês subseqüente, atualizar o valor do saldo anterior e recalcular o saldo atual (somar ou subtrair o valor do lançamento aos campos de saldo anterior / saldo atual);
*Exercício Contábil: período de tempo usado para apurar a contabilidade. Tipicamente anual. Ao final do exercício, deve-se proceder ao encerramento.
*Encerramento de exercício: operação que consiste em, após incluídos todos os lançamentos do período, apurar a diferença entre as contas de receitas e despesas, “zerá-las” e lançar a diferença como lucro ou prejuízo.''

--[[Usuário:AnaPaula|AnaPaula]] 17h55min de 16 de janeiro de 2013 (BRST)

Para uso do Bw

2013-01-31T18:56:01Z

AnaPaula: Criou página com 'Arquivo:BoletosWeb.PNG Arquivo:Historico_de_revisoes.PNG =1. Caso de Negócio= ==1.1 Objetivos== Do...'

[[Arquivo:BoletosWeb.PNG]] 

[[Arquivo:Historico_de_revisoes.PNG]] 

=1. Caso de Negócio=
==1.1 Objetivos==

Documentar o novo módulo de geração e impressão de boletos online. As informações aqui descritas especificam e refinam a regras de negócio.

==1.2 Referências==

Se baseará no conhecimento adquirido na implementação de rotinas de boletos da BISA (desktop) e no antigo sistema TRAB_RUR da BISA, em DOS. A entrevista com Mário e Márcio da FETAPE (realizada por Ronaldo e Alexandre) também é referência para a definição dos requisitos.

==1.3 Sistemas com rotinas de gerenciamento de boletos da BISA==

O Filiados 2000 é um sistema desktop de gestão de filiados que controla o cadastro de filiados dos sindicatos de trabalhadores, fazendo acompanhamento de participação na organização.

O OAB 2000 é um software de gestão de cadastro de advogados para OAB's. Faz desde o cadastro de alunos, pré-inscritos, coordena sociedades de advogados, estagiários, até a administração dos dados financeiros dos advogados.

O Receb 2000 é um software voltado para o acompanhamento do contas a receber de uma empresa, fazendo a gestão financeira da carteira de forma simples e eficiente.

Todos esses sistemas possuem uma função de gerenciamento de boletos bancários ou guias sindicais, sendo salvos de forma centralizada no MySQL, de forma que podem ser acessados de forma uniforme no BoletoWEB.

Cada sistema contém suas próprias regras de negócio para gerenciar os boletos; no entanto, as funções de acesso ao banco remoto serão padronizadas para todos os sistemas no BoletoWEB.

==1.4 Descrição do Produto==

A maior parte da implementação é voltada para a FETAPE, enquanto o restante imprime boletos gerados pelos nossos sistema desktop.

Módulo Geral: este módulo tem a função meramente de fornecer uma interface web que permita ao usuário imprimir boletos gerados pelos sistemas desktop da BISA. 

'''Módulo FETAPE:''' no antigo sistema TRAB_RUR da BISA, este sistema é o foco principal desta documentação. Nela o usuário poderá gerenciar todo o fluxo de boletos de contribuições: geração, impressão interna, cadastro de filiados, acesso on-line dos filiados, etc.

==1.5 Contexto de Negócio==

O módulo geral de boletos na web será utilizado a princípio pelos sistemas Receb2000, OAB2000 e Filiados2000, porém poderá ser extendido a qualquer sistema que queira fazer o controle de boletos/guias.

Este módulo concentrará as informações dos boletos em um único local independente de entidade ou sistema. Este local, a priori, ficou definido como sendo um dos servidores internos da BISA que possua acesso externo. Cada sistema rodará normalmente no ambiente do cliente. No momento que for necessário o acesso às informações, este será feito não mais na base local da área do cliente, mas na base remota situada na BISA.

O módulo FETAPE segue as mesmas diretrizes, tendo a diferença de ser implementado exclusivamente para esta entidade, devendo ser adaptável para outras entidades. Para tanto, aconselha-se o uso de uma arquitetura em camadas e padrões de projetos, facilitadores do processos de manutenção.

==1.6 Tecnologias utilizadas==

Os módulos geral e FETAPE deverão implementados utilizando uma tecnologia para web: PHP, Java ou .NET.

O banco de dados necessariamente deverá ser o MySQL, pois já é utilizado na bisa para o registro de boletos.

=2. Sobre os Requisitos=
==2.1 Introdução==

Este documento especifica todos os requisitos funcionais e não funcionais do módulo de gerenciamento de boletos, descrevendo os fluxos de eventos, prioridades, atores, entradas e saídas de cada caso de uso a ser implementado.

A correta interpretação deste documento exige o conhecimento de algumas convenções e termos específicos, que são descritos a seguir.

==2.2 Identificação dos Requisitos==

Por convenção, a referência a requisitos é feita através do nome da subseção onde eles estão descritos, seguidos do identificador do requisito, de acordo com o esquema abaixo:

[nome da subseção, identificador do requisito]

Por exemplo, o requisito funcional [Imprimir Boleto RF002] está descrito em um caso de uso chamado “Imprimir Boleto”, em um bloco identificado pelo identificador [RF002].

==2.3 Prioridades dos Requisitos==

Para estabelecer a prioridade dos requisitos foram adotadas as denominações “essencial”, “importante” e “desejável”. 
• Essencial é o requisito sem o qual o sistema não entra em funcionamento. São requisitos imprescindíveis, que têm que ser implementados. 
• Importante é o requisito sem o qual o sistema entra em funcionamento, mas de forma não satisfatória. Requisitos importantes devem ser implementados, mas, se não forem, o sistema poderá ser implantado e usado mesmo assim. 
• Desejável é o requisito que não compromete as funcionalidades básicas do sistema, isto é, o sistema pode funcionar de forma satisfatória sem ele. Requisitos desejáveis são requisitos que podem ser deixados para versões posteriores do sistema, caso não haja tempo hábil para implementá-los na versão que está sendo especificada. 

==2.4 Descrição dos Atores==

'''Usuário externo'''
É a pessoa que acessa a funcionalidade de impressão de boletos do módulo geral pelo browser.

Filiado FETAPE
Semelhante ao usuário comum, com a diferença de que terá a opção de se cadastrar pelo site.

Funcionário FETAPE
É responsável pelo gerenciamento dos boletos. É o ator principal deste sistema.

=3 Requisitos Funcionais (Casos de Uso)=
==3.1 Ações do Usuário==

==[RF001] Efetuar login==
Atores relacionados
Usuário externo, Filiado FETAPE e Funcionário FETAPE.

===Objetivo===
Fazer login no módulo Web de impressão de boletos.

===Prioridade===
Essencial.

===Entradas e pré condições===
'''Entradas:''' login do usuário e senha;
'''Pré-condições:''' computador deve ter acesso à internet; servidor web disponível.

===Saídas e pós-condições===
'''Saídas:''' não há
'''Pós-condições:''' usuário logado no sistema.

===Fluxo principal de eventos===
1. Usuário executa seu web browser e acessa a página de login (E1, E2); 
2. Usuário informa login e senha e clica em Entrar (E3); 
3. Sistema recupera na base de dados a senha do usuário com o login informado; 
4. Sistema verifica se o login está cadastrado (E4); 
5. Sistema verifica se a senha informada corresponde ao login informado (E5); 
6. Sistema libera o acesso após o sucesso da verificação; 
7. Includes [RF002]. 

===Fluxos de exceção===
• E1: se não houver conexão com a internet, uma mensagem será exibida informando que não é possível estabelecer uma conexão com a internet e solicitando ao usuário que verifique sua conexão; 
• E2: se o sistema não estiver disponível, uma mensagem será exibida informando que o serviço não está disponível e que o usuário deve tentar acessá-lo mais tarde; 
• E3: se o usuário não informar o login ou a senha, o sistema solicita que informe o login e a senha; 
• E4: se o login não estiver cadastrado, o sistema emite uma mensagem de erro informando que este usuário não está cadastrado e solicitando que o mesmo verifique se o login foi digitado corretamente; 
• E5: se a senha não conferir com a que está armazenada na base de dados, o sistema emite uma mensagem de erro avisando que a senha informada está incorreta e solicitando que o mesmo verifique se ela foi digitada corretamente. 

==[RF002] Listar boletos==
===Atores relacionados===
Usuário externo, Filiado FETAPE e Funcionário FETAPE.

===Objetivo===
Listar os boletos correspondentes ao usuário logado.

===Prioridade===
Essencial.

===Entradas e pré condições===
'''Entradas:''' nenhuma.
'''Pré-condições:''' usuário logado no sistema; boletos armazenados no banco de dados.

===Saídas e pós-condições===
'''Saídas:''' lista de boletos.
'''Pós-condições:''' nenhuma.

===Fluxo principal de eventos===
1. Sistema carrega da base de dados os boletos referentes ao usuário (E1, E2, E3); 
2. É exibida a lista de boletos (com check boxes para seleção), cada um com seu número, descrição, valor, vencimento e status (pendente/atrasado/impresso/pago). Os boletos serão ordenados de forma decrescente (maior para o menor) por data de vencimento na lista. Também haverá uma check box que permite a seleção de todos os boletos listados na tela e um limite de boletos a serem exibidos, sendo os demais boletos acessados por uma barra de próximo/anterior (semelhante a um esquema de web mail); 
3. Através de uma caixa de seleção (combo box), o usuário pode filtrar os boletos que serão exibidos na tela de acordo com a opção: “pendentes/impressos/pagos/todos”. Os boletos com status “atrasado” ficarão na lista de “pendentes” e “todos”, mas com uma cor de linha de grid que os diferencie dos demais (ex. vermelho). O status inicial do filtro é “pendentes”. 

===Fluxos de exceção===
• E1: se não houver conexão com a internet, uma mensagem será exibida informando que não é possível estabelecer uma conexão com a internet e solicitando ao usuário que verifique sua conexão; 
• E2: se o sistema não estiver disponível, uma mensagem será exibida informando que o serviço não está disponível e que o usuário deve tentar acessá-lo mais tarde; 
• E3: se o resultado da busca retornar vazio, uma mensagem será exibida informando ao usuário que não existe dados referentes à consulta realizada. 

=[RF003] Geração de boletos=
===Atores relacionados===
Usuário externo, Filiado FETAPE e Funcionário FETAPE.

===Objetivo===
Gerar registros de boletos no banco de dados para impressão. Não constitui a impressão do boleto em si.

===Prioridade===
Essencial.

===Entradas e pré condições===
'''Entradas:''' filiado(s)/usuário(s), banco, data de vencimento, modelo da guia, nosso número inicial, valor e instruções.
'''Pré-condições:''' usuário logado no sistema; sindicatos e filiados armazenados no banco de dados.

===Saídas e pós-condições===
'''Saídas:''' mensagem de aviso de sucesso da operação. 
'''Pós-condições:''' registro dos boletos inseridos no banco de dados.

===Fluxo principal de eventos===
1. Usuário Externo e Filiado FETAPE: usuário clica no botão Gerar Boletos. Se o usuário estiver com o status óbito, não será gerado boleto. Funcionário FETAPE: funcionário seleciona uma quantidade de filiados na tela de Listagem de Filiados e clica no botão Gerar Boletos. Os filiados com o status “óbito” nunca serão carregados; 
2. Sistema carrega o(s) usuários(s)/filiado(s) selecionados com seus respectivos dados (E1, E2, E3, E4); 
3. Uma janela é aberta perguntando se o usuário deseja imprimir boletos referentes a Contribuição Sindical e Contribuição Confederativa (2 check boxes); 
4. Uma tela é aberta onde o usuário informa os dados (banco, data de vencimento, modelo da guia, nosso número inicial, valor e instruções) para os boletos. Usuário confirma a operação; 
5. Sistema valida os dados inseridos pelo usuário e os dados obrigatórios para emissão de boleto (E5, E6); 
6. Sistema gera os boletos e os armazena no banco de dados com o status “gerado” (E7). O sistema deverá verificar se o número de boleto que ele irá gerar existe em algum intervalo na tabela de boletos avulso. Se existir, ele deverá gerar um próximo número que não esteja em um intervalo desta tabela; 
7. Sistema insere os registros de log da situação dos boletos no banco remoto com a justificava “gerado a partir da função de geração de boleto pelo usuário X:Y”, onde X corresponde ao login do funcionário e Y corresponde ao seu nome; 
8. Sistema exibe mensagem confirmando o sucesso na geração dos boletos e perguntando se o usuário deseja fazer a impressão dos mesmos; 
9. Se o usuário responder que sim, a janela de impressão padrão da funcionalidade imprimir é aberta. Includes [RF004]. 

===Filiado FETAPE===
Este usuário também terá acesso à rotina de CANCELAMENTO do boleto, que consiste meramente na exclusão do mesmo da base de dados. Vale salientar que devem ser efetuados os devidos registros no log do sistema seguindo o padrão supracitado, assim como devem ser atendidos os seguintes fluxos de exceção: 
1. Se o boleto possuir o status “pago”, “impresso” ou “enviado” (para o banco), o cancelamento não será permitido. O sistema exibirá uma mensagem de erro avisando que o boleto não pode ser impresso, indicando o seu status atual; 
2. Se o boleto requisitado não puder ser excluído, o sistema exibe uma mensagem de erro solicitando que o boleto não poder ser removido no momento. 

===Fluxos de exceção===
• E1: se não houver conexão com a internet, uma mensagem será exibida informando que não é possível estabelecer uma conexão com a internet e solicitando ao usuário que verifique sua conexão; 
• E2: se o sistema não estiver disponível, uma mensagem será exibida informando que o serviço não está disponível e que o usuário deve tentar acessá-lo mais tarde; 
• E3: se o resultado da busca retornar vazio, uma mensagem será exibida informando ao usuário que não existem dados referentes à consulta realizada; 
• E4: se o sistema não conseguir acessar a base de dados, uma mensagem será exibida informando ao usuário que a base de dados está inacessível; 
• E5: se o usuário não preencher os dados obrigatórios do boleto (banco, data de vencimento, modelo da guia, nosso número inicial e valor), uma mensagem será exibida informando ao usuário que os campos obrigatórios devem ser preenchidos; 
• E6: se os dados obrigatórios do(s) usuário(s)/filiado(s) para emissão de boleto não foram preenchidos (nome, logradouro, bairro, cidade, estado e CEP), o sistema lista na tela os usuário(s)/filiado(s) cujos dados obrigatórios não estão preenchidos e, para cada um, informa quais campos devem ser preenchidos. O usuário poderá prosseguir para a tela de marcação dos boletos que serão impressos (botão “prosseguir”), no entanto os boletos cujos dados não estão completos não aparecerão para seleção; 
• E7: se houver um estouro na numeração de boletos*, o sistema exibe uma mensagem solicitando ao usuário que entre em contato com a BISA pois houve um problema na geração da numeração do boleto. A operação não é finalizada. O sistema deve ainda efetuar todas as rotinas de rollback de modo a não deixar ‘lixo’ no banco de dados. 

<nowiki>*</nowiki> O estouro na numeração de boletos ocorre quando o limite do número de boletos cadastrado no banco de dados é atingido. Por exemplo, supondo um limite de 10 bytes, se o último registro cadastrado for 9999999999, o próximo registro de boleto irá acionar este erro. 

=[RF004] Imprimir boletos=
===Atores relacionados===
Usuário externo, Filiado FETAPE e Funcionário FETAPE.

===Objetivo===
Constitui a impressão de um boleto já gerado no sistema.

===Prioridade===
Essencial.

===Entradas e pré condições===
'''Entradas:''' lista de boletos para impressão. 
'''Pré-condições:''' o usuário deve estar logado no sistema na tela da listagem de boletos (RF002); os registros dos boletos devem estar armazenados no banco de dados e marcados como “não impresso”.

===Saídas e pós-condições===
'''Saídas:''' impressão dos boletos selecionados. 
'''Pós-Condições:''' registros dos boletos marcados no banco como “impresso”.

===Fluxo principal de eventos===
1. Usuário seleciona na Lista de boletos aqueles que deseja imprimir (check box) e clica no botão Imprimir (E1, E2, E3, E4, E5); 
2. Se o usuário houver selecionado apenas um boleto, o sistema imprime o boleto no navegador, permitindo ao usuário conferir seus dados. Depois disso, ele clica em um novo botão Imprimir e passa para o passo 3; 
3. Janela de impressão padrão é aberta (onde o usuário poderá selecionar impressora, quantidade de páginas, etc). Usuário confirma a impressão e o sistema envia os arquivos para a impressora (E6); 
4. Sistema marca no banco os boletos que foram impressos com o status “impresso” (E7); 
5. Sistema insere no log de boletos os registros com o status impresso com a justificativa “impresso pela função de impressão de boletos pelo usuário X:Y”, onde X corresponde ao código do usuário e Y ao seu nome. 
6. Sistema exibe uma mensagem de “Boletos impressos com sucesso”. 

===Fluxos de exceção===
• E1: se não houver conexão com a internet, uma mensagem será exibida informando que não é possível estabelecer uma conexão com a internet e solicitando ao usuário que verifique sua conexão; 
• E2: se o sistema não estiver disponível, uma mensagem será exibida informando que o serviço não está disponível e que o usuário deve tentar acessá-lo mais tarde; 
• E3: se o usuário não selecionar boletos, o sistema exibe uma mensagem solicitando ao usuário que selecione boletos para impressão; 
• E4: se na lista houver boletos que já foram pagos, o sistema exibe uma mensagem de erro informando que boletos pagos não podem ser reimpressos e cancela a operação; 
• E5: se houver boletos que já foram impressos, o sistema exibe um alerta informando que os boletos já foram impressos pelo sistema e serão reimpressos nesta operação; continua a executar normalmente; 
• E6: se houver um erro ao enviar os dados para a impressora, o sistema exibe uma mensagem avisando ao usuário que o sistema não conseguiu imprimir e solicitando que o mesmo verifique se a impressora está pronta para impressão; 
• E7: se houver um erro na alteração dos registros no banco de dados, uma mensagem será exibida informando que não foi possível marcar os boletos como impressos e solicitando ao usuário que tente novamente e que, caso o erro persista, entre em contato com a BISA. O sistema deve ainda efetuar todas as rotinas de rollback de modo a não deixar ‘lixo’ no banco de dados. 

=[RF005] Cadastro de filiado=
===Atores relacionados===
Filiado FETAPE e Funcionário FETAPE.

===Objetivo===
Cadastrar um filiado. As rotinas de ALTERAÇÃO e de EXCLUSÃO também estão contidas neste requisito para o Funcionário FETAPE.

===Prioridade===
Essencial.

===Entradas e pré condições===
'''Entradas:''' dados cadastrais do usuário. 
'''Pré-condições:''' computador deve ter acesso à internet; servidor web disponível. Funcionário: usuário cadastrado no sistema. 

===Saídas e pós-condições===
'''Saídas:''' mensagem avisando que o usuário foi cadastrado com sucesso. 
'''Pós-Condições:''' usuário cadastrado no banco de dados. 

===Fluxo principal de eventos===
1. Ator Filiado: a função “Cadastrar Filiado” é acionada pelo usuário no navegador web (E1, E2). Ator Funcionário: a função “Cadastrar Filiado” é acionada pelo usuário na tela de Listagem de Filiados (E1, E2). 
2. Um formulário é aberto solicitando dados cadastrais: login, senha, nome, CPF, CNAE, bairro, cidade, UF, logradouro, CEP, categoria (seleção entre as opções arrendatário, assentado, meeiro, parceiro, posseiro, pequeno proprietário e outros) e apelido do filiado; 
3. Usuário preenche os campos e confirma a operação (E3, E4, E5, E6); 
4. Sistema insere os registros de log da situação no banco remoto com a justificava “cadastrado pelo usuário X:Y”, onde X corresponde ao login do usuário e Y corresponde ao seu nome; 
5. Sistema retorna uma mensagem avisando que o usuário foi cadastrado com sucesso. 

O sistema também apresenta as rotinas de ALTERAÇÃO, que por ser trivial e seguir um fluxo semelhante à rotina de inclusão não terá sua execução descrita aqui. Vale salientar que devem ser efetuados os devidos registros no log do sistema. 

===Filiado FETAPE===
Ele possui também a funcionalidade EXCLUSÃO. Sua tela de ALTERAR é diferente. Nela, o usuário pode marcar um check box “óbito” para filiados que foram a óbito.

===Fluxos de exceção===
• E1: se não houver conexão com a internet, uma mensagem será exibida informando que não é possível estabelecer uma conexão com a internet e solicitando ao usuário que verifique sua conexão; 
• E2: se o sistema não estiver disponível, uma mensagem será exibida informando que o serviço não está disponível e que o usuário deve tentar acessá-lo mais tarde; 
• E3: se o login fornecido já estiver cadastrado no sistema, uma mensagem será exibida informando ao usuário que o login cadastrado já existe no sistema; 
• E4: se o CPF do filiado for inválido, uma mensagem será exibida informando ao usuário que o CPF cadastrado é inválido. Vale salientar que o preenchimento deste campo é opcional; 
• E5: se houver um erro na inserção dos registros no banco de dados, uma mensagem será exibida informando que não foi possível inserir os dados e solicitando ao usuário que tente novamente e que, caso o erro persista, entre em contato com a BISA. O sistema deve ainda efetuar todas as rotinas de rollback de modo a não deixar ‘lixo’ no banco de dados; 
• E6: se os dados obrigatórios dos filiados não forem preenchidos (nome, logradouro, bairro, cidade, estado e CEP), o sistema emite uma mensagem de erro informando quais os campos obrigatórios não foram preenchidos. 

=[RF006] Listar filiados=
===Atores relacionados===
Funcionário FETAPE.

===Objetivo===
Listar todos os filiados cadastrados no sistema.

===Prioridade===
Essencial.

===Entradas e pré condições===
'''Entradas:''' nenhuma.
'''Pré-condições:''' usuário logado no sistema; filiados armazenados no banco de dados.

===Saídas e pós-condições===
'''Saídas:''' lista de filiados. 
'''Pós-condições:''' nenhuma. 

===Fluxo principal de eventos===
1. Usuário clica no botão Filiados da barra de funções do sistema para acessar a Listagem de Filiados; 
2. Sistema carrega da base de dados os filiados com seus respectivos dados (E1, E2, E3, E4); 
3. É exibida a lista de filiados (com check boxes para seleção), cada um com seu número, nome, apelido, CPF, município, sindicato e categoria. Os filiados serão ordenados por ordem alfabética e agrupados por município. Também haverá uma check box que permite a seleção de todos os filiados listados na tela e um limite de filiados a serem exibidos, sendo os demais acessados por uma barra de próximo/anterior (semelhante a um esquema de web mail); 
4. Através de uma caixa de seleção (combo box), o usuário pode filtrar os filiados que serão exibidos na tela de acordo com a opção: “nome/apelido/município/sindicato”. A opção “nome” é a padrão. Os filiados que foram a óbito serão exibidos com uma cor de linha de grid acinzentada e só serão exibidos se um check box “todos” for ativado. 

===Fluxos de exceção===
• E1: se não houver conexão com a internet, uma mensagem será exibida informando que não é possível estabelecer uma conexão com a internet e solicitando ao usuário que verifique sua conexão; 
• E2: se o sistema não estiver disponível, uma mensagem será exibida informando que o serviço não está disponível e que o usuário deve tentar acessá-lo mais tarde; 
• E3: se o resultado da busca retornar vazio, uma mensagem será exibida informando ao usuário que não existem dados referentes à consulta realizada; 
• E4: se o sistema não conseguir acessar a base de dados, uma mensagem será exibida informando ao usuário que a base de dados está inacessível. 

=[RF007] Cadastro de sindicato=
===Atores relacionados===
Funcionário FETAPE.

===Objetivo===
Cadastrar um sindicato. As rotinas de ALTERAÇÃO e de EXCLUSÃO também estão contidas neste requisito.

===Prioridade===
Essencial.

===Entradas e pré condições===
'''Entradas:''' dados do sindicato; dados do Município (já presentes na base de dados, herdada do antigo sistema DOS TRAB_RUR). 
'''Pré-condições:''' usuário logado no sistema. 

===Saídas e pós-condições===
'''Saídas:''' mensagem avisando que o sindicato foi cadastrado com sucesso. 
'''Pós-Condições:''' sindicato cadastrado no banco de dados. 

Fluxo principal de eventos
1. Usuário clica no botão cadastrar na tela de Listagem de Sindicatos (E1, E2); 
2. Um formulário é aberto solicitando dados cadastrais: nome, município, UF, endereço; 
3. Usuário preenche os campos e confirma a operação (E3); 
4. Sistema insere os registros de log da situação no banco remoto com a justificava “cadastrado pelo usuário X:Y”, onde X corresponde ao login do funcionário e Y corresponde ao seu nome; 
5. Sistema retorna uma mensagem avisando que o sindicato foi cadastrado com sucesso. 

Também haverá rotinas de alteração e de exclusão. O processo é trivial para ser descrito aqui. Vale salientar que devem ser efetuados os devidos registros no log do sistema. 

===Fluxos de exceção===
• E1: se não houver conexão com a internet, uma mensagem será exibida informando que não é possível estabelecer uma conexão com a internet e solicitando ao usuário que verifique sua conexão; 
• E2: se o sistema não estiver disponível, uma mensagem será exibida informando que o serviço não está disponível e que o usuário deve tentar acessá-lo mais tarde; 
• E3: se houver um erro na inserção dos registros no banco de dados, uma mensagem será exibida informando que não foi possível inserir os dados e solicitando ao usuário que tente novamente e que, caso o erro persista, entre em contato com a BISA. O sistema deve ainda efetuar todas as rotinas de rollback de modo a não deixar ‘lixo’ no banco de dados; 

=[RF008] Listar sindicatos=
===Atores relacionados===
Funcionário FETAPE.

===Objetivo===
Listar todos os sindicatos cadastrados no sistema.

===Prioridade===
Essencial.

===Entradas e pré condições===
'''Entradas:''' nenhuma. 
'''Pré-condições:''' usuário logado no sistema; sindicatos armazenados no banco de dados. 

===Saídas e pós-condições===
'''Saídas:''' lista de sindicatos. 
'''Pós-condições:''' nenhuma. 

===Fluxo principal de eventos===
1. Usuário clica no botão Sindicatos da barra de funções do sistema para acessar a Listagem de Sindicatos; 
2. Sistema carrega da base de dados os sindicatos com seus respectivos dados (E1, E2, E3, E4); 
3. É exibida a lista de sindicatos (com check boxes para seleção), cada um com seu número, nome e município. Os sindicatos serão ordenados por ordem alfabética e agrupados por município. Também haverá uma check box que permite a seleção de todos os sindicatos listados na tela e um limite de sindicatos a serem exibidos, sendo os demais acessados por uma barra de próximo/anterior (semelhante a um esquema de web mail); 
4. Através de uma caixa de seleção (combo box), o usuário pode filtrar os sindicatos que serão exibidos na tela de acordo com a opção: “nome/município”. A opção “nome” é a padrão. 

===Fluxos de exceção===
• E1: se não houver conexão com a internet, uma mensagem será exibida informando que não é possível estabelecer uma conexão com a internet e solicitando ao usuário que verifique sua conexão; 
• E2: se o sistema não estiver disponível, uma mensagem será exibida informando que o serviço não está disponível e que o usuário deve tentar acessá-lo mais tarde; 
• E3: se o resultado da busca retornar vazio, uma mensagem será exibida informando ao usuário que não existem dados referentes à consulta realizada; 
• E4: se o sistema não conseguir acessar a base de dados, uma mensagem será exibida informando ao usuário que a base de dados está inacessível. 

===[RF009] Baixar Boleto===
===Atores relacionados===
Funcionário FETAPE.

===Objetivo===
Baixa nos boletos que foram impressos. Eles passarão a ter o status de pago.

===Prioridade===
Essencial.

===Entradas e pré condições===
'''Entradas:''' lista de boletos para baixa.
'''Pré-condições:''' usuário logado no sistema; os registros dos boletos devem estar armazenados no banco de dados.

===Saídas e pós-condições===
'''Saídas:''' mensagem de aviso de sucesso da operação. 
'''Pós-condições:''' registro dos boletos marcados no banco como “pagos”. 

===Fluxo principal de eventos===
1. Usuário seleciona na Lista de boletos aqueles que deseja baixar (check box) e clica no botão Baixar (E1, E2, E3, E4, E5); 
2. Sistema marca no banco os boletos como pagos (E6). Se o boleto não for encontrado na tabela de boletos, deverá ser procurado na tabela de boletos avulsos (E7); 
3. Sistema insere no log de boletos os registros com o status impresso com a justificativa “baixado pela função de baixar de boletos pelo usuário X:Y”, onde X corresponde ao código do usuário e Y ao seu nome; 
4. Sistema exibe uma mensagem de “Boletos baixados com sucesso”. 

===Fluxos de exceção===
• E1: se não houver conexão com a internet, uma mensagem será exibida informando que não é possível estabelecer uma conexão com a internet e solicitando ao usuário que verifique sua conexão; 
• E2: se o sistema não estiver disponível, uma mensagem será exibida informando que o serviço não está disponível e que o usuário deve tentar acessá-lo mais tarde; 
• E3: se o usuário não selecionar boletos, o sistema exibe uma mensagem solicitando ao usuário que selecione boletos para impressão; 
• E4: se na lista houver boletos com o status “pago”, o sistema exibe uma mensagem informando que boletos selecionados já foram baixados. Se o usuário clicar em continuar, o sistema continua a execução e ignora esses boletos; 
• E5: se na lista houver boletos com o status diferente de “impresso” ou “enviado” (enviado para o banco), o sistema exibe uma mensagem informando que há boletos selecionados que ainda não foram impressos ou enviados para o banco e quais são estes boletos. Se o usuário clicar em continuar, o sistema continua a execução e ignora esses boletos; 
• E6: se houver um erro na alteração dos registros no banco de dados, uma mensagem será exibida informando que não foi possível marcar os boletos como pagos e solicitando ao usuário que tente novamente e que, caso o erro persista, entre em contato com a BISA. O sistema deve ainda efetuar todas as rotinas de rollback de modo a não deixar ‘lixo’ no banco de dados; 
• E7: se o registro do boleto não for encontrado no banco, o sistema exibirá uma mensagem de erro indicando que o boleto não foi encontrado na base de dados do sistema. 

=[RF010] Baixar Boleto Automaticamente (via Arquivo de Retorno do Banco)=
===Atores relacionados===
Funcionário FETAPE.

===Objetivo===
Baixar de boletos a partir de um arquivo de retorno que o banco envia.

===Prioridade===
Essencial.

===Entradas e pré condições===
'''Entradas:''' arquivo de retorno do banco. 
'''Pré-condições:''' usuário logado no sistema; os registros dos boletos devem estar armazenados no banco de dados. 

===Saídas e pós-condições===
'''Saídas:''' mensagem de sucesso da operação. 
'''Pós-condições:''' registro dos boletos marcados no banco como “pagos”. 

===Fluxo principal de eventos===
1. Na tela da Lista de boletos, usuário clica na opção Baixa com Arquivo do Banco (E1, E2); 
2. Uma tela é aberta perguntando qual o arquivo de retorno do banco. O usuário então seleciona o caminho no seu computador correspondente à localização do arquivo e clica em OK. O sistema irá, então, fazer o upload do arquivo (E3, E4, E5); 
3. Sistema guarda a identificação do arquivo de retorno com situação de ‘não processado’ na base de dados e guarda uma cópia do arquivo em diretório especifico para histórico; 
4. Para cada linha do arquivo de retorno, o sistema procura o boleto referente na base de dados de boletos de contribuição. Se o boleto não for encontrado, o sistema procura na base de dados de boletos avulsos. Nesta base, há registros de boletos com intervalos (ex. de 001 a 100). O sistema irá buscar o número do boleto nessa faixa (E6); 
5. O sistema verifica se o boleto encontrado está marcado como “impresso” ou “enviado” (para o banco). Se estiver, o sistema marca no banco de dados o boleto como “pago” (E7); 
6. O sistema insere no log de boletos o registro com situação de “pago” com a justificativa ‘baixado pela função de baixa automática de boleto pelo usuário X:Y’, onde X corresponde ao login de usuário e Y corresponde ao seu nome; 
7. O Sistema marca o arquivo de retorno como ‘processado sem erros’ e uma exibe mensagem confirmando o sucesso na baixa dos boletos. 

===Fluxos de exceção===
• E1: se não houver conexão com a internet, uma mensagem será exibida informando que não é possível estabelecer uma conexão com a internet e solicitando ao usuário que verifique sua conexão; 
• E2: se o sistema não estiver disponível, uma mensagem será exibida informando que o serviço não está disponível e que o usuário deve tentar acessá-lo mais tarde; 
• E3: se o usuário não apontar nenhum arquivo de retorno, uma mensagem será exibida exigindo que o usuário aponte o arquivo; 
• E4: se o caminho para o arquivo estiver incorreto, o sistema exibe uma mensagem para o usuário informando que o caminho selecionado é inválido; 
• E5: se o formato do arquivo não corresponder ao formato do arquivo de retorno do banco esperado, o sistema exibirá uma mensagem informando que o formato do arquivo selecionado é inválido; 
• E6: se um registro do arquivo não for encontrado no sistema (base principal e base de boletos avulsos), será exibido numa tela todos os registros que não foram encontrados. A situação do arquivo de retorno no banco deve então mudar para “processado com erro” e o sistema deve inserir o registro de log de boleto com a justificativa “boleto não pode ser baixado, pois o mesmo não foi encontrado no sistema. Ação executada pelo usuário X:Y”, onde X é o login e Y é o nome. O valor do boleto pago e não encontrado deverá ser armazenado na tabela de boletos no registro cujo identificador é “BoletoXXXX”. Todo boleto que não for encontrado deverá ser somado ao valor desse registro; 
• E7: se houver um erro na alteração dos registros no banco de dados, uma mensagem será exibida informando que não foi possível marcar os boletos como “pago” e solicitando ao usuário que tente novamente e que, caso o erro persista, entre em contato com a BISA. O sistema deve ainda efetuar todas as rotinas de rollback de modo a não deixar ‘lixo’ no banco de dados. 

=[RF011] Gerar arquivo de remessa para banco=
===Atores relacionados===
===Funcionário FETAPE.===

===Objetivo===
Gerar arquivo de remessa de boletos para o banco.

===Prioridade===
Essencial.

===Entradas e pré condições===
'''Entradas:''' lista de boletos que serão enviados para o arquivo. 
'''Pré-condições:''' usuário logado no sistema; os registros dos boletos devem estar armazenados no banco de dados com o status “gerado” ou “impresso”. 

===Saídas e pós-condições===
'''Saídas:''' mensagem de sucesso da operação; arquivo de remessa para o banco. 
'''Pós-condições:''' boletos marcados com o status “enviado” no banco na base de dados. 

===Fluxo principal de eventos===
1. Na tela de Listagem de Boletos, o usuário seleciona os boletos e clica no botão Gerar de arquivo de remessa (E1, E2); 
2. Sistema verifica se todos os boletos selecionados estão marcados como “gerado” ou “impresso” (E3); 
3. Sistema abre tela para que o usuário informe o nome do arquivo e o local onde ele será gerado (E4, E5); 
4. Usuário confirma a geração do arquivo; 
5. Sistema gera o arquivo de remessa; 
6. Sistema marca no banco os boletos que foram inseridos no arquivo de remessa com o status de “enviado” para o banco (E6); 
7. Sistema insere no log de boletos os registros com situação de enviado com a justificativa “boleto gerado no arquivo de remessa para o banco pelo usuário X:Y”, onde X corresponde ao login do usuário e Y corresponde ao seu nome; 
8. Sistema salva em diretório especifico no banco uma cópia do arquivo gerado para remessa para fins de histórico; 
9. Sistema retorna o arquivo de remessa para que o usuário salve-o em seu computador. 

===Fluxos de exceção===
• E1: se não houver conexão com a internet, uma mensagem será exibida informando que não é possível estabelecer uma conexão com a internet e solicitando ao usuário que verifique sua conexão; 
• E2: se o sistema não estiver disponível, uma mensagem será exibida informando que o serviço não está disponível e que o usuário deve tentar acessá-lo mais tarde; 
• E3: se o sistema não encontrar nenhum arquivo com o status “gerado” ou “impresso”, uma mensagem será exibida informando que não existem boletos a serem gerados para o arquivo de remessa. Se encontrar, deverá informar quais os boletos não serão gerados no arquivo; 
• E4: se o usuário informa um local não existente, o sistema pergunta ao usuário se o mesmo deseja que o sistema crie o diretório de pastas informado. Se a resposta for sim, sistema cria diretório de pasta; se a resposta for não, sistema retorna a tela de informação do local para que o usuário selecione um novo diretório; 
• E5: se houver um erro na geração do arquivo de remessa, uma mensagem será exibida informando ao usuário que o arquivo de remessa não pode ser gerado e que o mesmo tente novamente e que, caso o erro persista, entre em contato com a BISA.; 
• E6: se houver um erro na alteração dos registros no banco de dados, uma mensagem será exibida informando que não foi possível marcar os boletos como “enviado” e solicitando ao usuário que tente novamente e que, caso o erro persista, entre em contato com a BISA. O sistema deve ainda efetuar todas as rotinas de rollback de modo a não deixar ‘lixo’ no banco de dados. 

=[RF012] Gerar arquivo de remessa para Gráfica=
===Atores relacionados===
Funcionário FETAPE.

===Objetivo===
Gerar arquivo de remessa de boletos para Gráfica.

===Prioridade===
Essencial.

===Entradas e pré condições===
'''Entradas:''' lista de boletos que serão enviados para o arquivo. 
'''Pré-condições:''' usuário logado no sistema; os registros dos boletos devem estar armazenados no banco de dados com o status “gerado”.

===Saídas e pós-condições===
'''Saídas:''' mensagem de sucesso da operação; arquivo de remessa para a gráfica (em formato txt e xls). 
'''Pós-condições:''' boletos marcados com o status “enviadoGrafica” no banco na base de dados. 

===Fluxo principal de eventos===
1. Na tela de Listagem de Boletos, o usuário seleciona os boletos e clica no botão Gerar arquivo de boleto para Gráfica (E1, E2); 
2. Sistema verifica se todos os boletos selecionados estão marcados como “gerado” (E3); 
3. Sistema abre tela para que o usuário informe o nome do arquivo e o local onde ele será gerado (E4, E5); 
4. Usuário confirma a geração do arquivo; 
5. Sistema pergunta se o usuário quer gerar o arquivo no formato txt ou xls; 
6. Sistema gera o arquivo de remessa para Gráfica; 
7. Sistema marca no banco os boletos que foram inseridos no arquivo de remessa com o status de “enviadoGrafica” para o banco (E6); 
8. Sistema insere no log de boletos os registros com situação de enviado com a justificativa “boleto gerado no arquivo de remessa para Gráfica pelo usuário X:Y”, onde X corresponde ao login do usuário e Y corresponde ao seu nome; 
9. Sistema salva em diretório especifico no banco uma cópia do arquivo gerado para remessa para Gráfica para fins de histórico; 
10. Sistema retorna o arquivo para que o usuário salve-o em seu computador. 

===Fluxos de exceção===
• E1: se não houver conexão com a internet, uma mensagem será exibida informando que não é possível estabelecer uma conexão com a internet e solicitando ao usuário que verifique sua conexão; 
• E2: se o sistema não estiver disponível, uma mensagem será exibida informando que o serviço não está disponível e que o usuário deve tentar acessá-lo mais tarde; 
• E3: se o sistema não encontrar nenhum arquivo com o status “gerado”, uma mensagem será exibida informando que não existem boletos a serem gerados para o arquivo de remessa. Se encontrar, deverá informar quais os boletos não serão gerados no arquivo; 
• E4: se o usuário informa um local não existente, o sistema pergunta ao usuário se o mesmo deseja que o sistema crie o diretório de pastas informado. Se a resposta for sim, sistema cria diretório de pasta; se a resposta for não, sistema retorna a tela de informação do local para que o usuário selecione um novo diretório; 
• E5: se houver um erro na geração do arquivo de remessa, uma mensagem será exibida informando ao usuário que o arquivo de remessa não pode ser gerado e que o mesmo tente novamente e que, caso o erro persista, entre em contato com a BISA; 
• E6: se houver um erro na alteração dos registros no banco de dados, uma mensagem será exibida informando que não foi possível marcar os boletos como “enviado” e solicitando ao usuário que tente novamente e que, caso o erro persista, entre em contato com a BISA. O sistema deve ainda efetuar todas as rotinas de rollback de modo a não deixar ‘lixo’ no banco de dados. 

=4 Especificações Suplementares=
===4.1 Objetivos===
Este documento tem como finalidade especificar todos os requisitos não funcionais do módulo de boletos web divididos em requisitos de usabilidade, confiabilidade, desempenho, segurança, distribuição, adequação a padrões e requisitos de hardware e software.
===4.2 Usabilidade===
Esta seção descreve os requisitos não funcionais associados à facilidade de uso da interface com o usuário, material de treinamento e documentação do sistema.
=[NF001] Interface com o Usuário=
===Prioridade:===
Desejável 
O sistema deve possuir uma interface amigável, simples e intuitiva.
===4.3 Confiabilidade===
Esta seção descreve os requisitos não funcionais associados à freqüência, severidade de falhas do sistema e habilidade de recuperação das mesmas, bem como a corretude do sistema.

=[NF001] Tempo de Retorno após Falha=
===Prioridade:===
Desejável 
Retorno de até 5 segundos após alguma falha.
=[NF002] Disponibilidade=
===Prioridade:===
Importante 
O sistema estará disponível 24 horas por dia durante todos os dias do ano.
===4.4 Desempenho===
Esta seção descreve os requisitos não funcionais associados à eficiência, uso de recursos e tempo de resposta do sistema.
=[NF001] Número de Acessos=
O sistema deve ser capaz de atender em média 10 usuários por segundo nos momentos de pico de acesso.
=[NF002] Tempo de Resposta para os Usuários=
O tempo máximo de resposta de uma requisição deve ser de no máximo 10 segundos.

===4.5 Segurança===
Esta seção descreve os requisitos não funcionais associados à integridade, privacidade e autenticidade dos dados do sistema.
=[NF001] Privacidade de Acesso=
Apenas os usuários credenciados e com permissão para acesso a este módulo deverão fazer uso das funcionalidades do módulo de boletos/guias na Web.
===4.6 Hardware e software===
Esta seção descreve os requisitos não funcionais associados ao hardware e software usados para desenvolver ou para executar o sistema.
=[NF001] Linguagem de Implementação=
===Prioridade:===
Essencial 
A linguagem de implementação do módulo de boleto Web será Delphi, mesma linguagem utilizada no desenvolvimento dos sistemas Partidos2000, Receb2000, OAB2000 e Filiados2000.
=[NF002] Banco de Dados=
===Prioridade:===
Essencial 
O banco de dados utilizado será o MySQL.
=[NF003] Ferramentas=
===Prioridade:===
Essencial 
Ferramenta de modelagem: Borland Delphi 2006
Ferramenta de Desenvolvimento: Borland Delphi 2006
=[NF004] Plataforma de Funcionamento=
===Prioridade:===
Essencial 
A plataforma tanto de desenvolvimento e de funcionamento será Windows.

=5 Modelagem do Banco de Dados=

===5.1 Modelo Entidade Relacionamento===
 
[[Arquivo:Caso_de_uso.png]]
===5.2 Dicionário de Dados (tabelas)===
 
[[Arquivo:Tabelas.png]] 
As demais tabelas serão as mesmas já definidas e utilizadas nos sistemas Partidos2000, Receb2000, OAB2000 e Filiados2000.

===5.3 Tabelas da FETAPE (cadastro web)===

=6 Modelagem de Classes=

===6.1 Diagrama de Classes===

[[Arquivo:Diagrama_de_classes.png]]
 
===6.2 Diagrama de Seqüência===
===6.2.1 [RF001] e [RF011]===
 

[[Arquivo:Diagrama_de_sequenciaa.png]]

 

===6.2.2 [RF002] e [RF012]===
 

[[Arquivo:Diagrama_de_sequencia2.PNG]]

Página principal

2013-01-25T12:32:38Z

AnaPaula: /* Requisitos Funcionais (RF) */

= Processos e Normas Administrativas=
* [[Normas Administrativas]]
# [http://www.portalbisa.com.br/wiki/index.php/Normas_Administrativas#OBJETIVO Objetivo]
# [http://www.portalbisa.com.br/wiki/index.php/Normas_Administrativas#CONSIDERA.C3.87.C3.95ES_INICIAIS Considerações Iniciais]
# [http://www.portalbisa.com.br/wiki/index.php/Normas_Administrativas#APLICABILIDADE Aplicabilidade]
# [http://www.portalbisa.com.br/wiki/index.php/Normas_Administrativas#REFER.C3.8ANCIAS Referências]
# [http://www.portalbisa.com.br/wiki/index.php/Normas_Administrativas#RESPONSABILIDADES Responsabilidades]
# [http://www.portalbisa.com.br/wiki/index.php/Normas_Administrativas#FUN.C3.87.C3.95ES_DO_EMPREGADO Funções do Empregado]
## [http://www.portalbisa.com.br/wiki/index.php/Normas_Administrativas#FUN.C3.87.C3.95ES_DA_CHEFIA Funções da Chefia]
# [http://www.portalbisa.com.br/wiki/index.php/Normas_Administrativas#C.C3.93DIGO_DE_CONDUTA_DA_BISA Código de Conduta da BISA]
## [http://www.portalbisa.com.br/wiki/index.php/Normas_Administrativas#PROIBI.C3.87.C3.95ES Proibições]
## [http://www.portalbisa.com.br/wiki/index.php/Normas_Administrativas#ELOGIOS_E_RECOMPENSAS Elogios e Recompenças]
### [http://www.portalbisa.com.br/wiki/index.php/Normas_Administrativas#Elogios Elogios]
#### [http://www.portalbisa.com.br/wiki/index.php/Normas_Administrativas#Compet.C3.AAncia_para_autorizar_elogios Competência para Autorizar Elogios]
## [http://www.portalbisa.com.br/wiki/index.php/Normas_Administrativas#PROCEDIMENTOS_REFERENTES_A_FALTAS Procedimentos Referentes a Faltas]
### [http://www.portalbisa.com.br/wiki/index.php/Normas_Administrativas#Faltas_n.C3.A3o_justificadas Faltas Não Justificadas]
### [http://www.portalbisa.com.br/wiki/index.php/Normas_Administrativas#Faltas_justificadas Faltas Justificadas]
## [http://www.portalbisa.com.br/wiki/index.php/Normas_Administrativas#A.C3.87.C3.83O_DISCIPLINAR:_ASPECTOS_FUNDAMENTAIS Ação Disciplinar: Aspectos Fundamentais]
## [http://www.portalbisa.com.br/wiki/index.php/Normas_Administrativas#APLICA.C3.87.C3.83O_DE_PENALIDADES Aplicação de Penalidades]
### [http://www.portalbisa.com.br/wiki/index.php/Normas_Administrativas#Advert.C3.AAncia_verbal Advertência Verbal]
#### [http://www.portalbisa.com.br/wiki/index.php/Normas_Administrativas#Procedimentos_para_aplica.C3.A7.C3.A3o_de_advert.C3.AAncia_verbal Procedimentos para Aplicação de Advertência Verbal]
### [http://www.portalbisa.com.br/wiki/index.php/Normas_Administrativas#Advert.C3.AAncia_escrita Advertência Escrita]
#### [http://www.portalbisa.com.br/wiki/index.php/Normas_Administrativas#Procedimentos_para_aplica.C3.A7.C3.A3o_de_advert.C3.AAncia_por_escrito Procedimentos para Aplicação de Advertencia por Escrita]
### [http://www.portalbisa.com.br/wiki/index.php/Normas_Administrativas#REGISTRO_DE_SUSPENS.C3.83O_DISCIPLINAR Registro de Suspenção Disciplinar]
### [http://www.portalbisa.com.br/wiki/index.php/Normas_Administrativas#Procedimentos_referentes_.C3.A0_suspens.C3.A3o_disciplinar Procedimentos Referentes à Suspenção Disciplinar]
## [http://www.portalbisa.com.br/wiki/index.php/Normas_Administrativas#Procedimentos_referentes_.C3.A0_suspens.C3.A3o_disciplinar Demição por Justa Causa]
# [http://www.portalbisa.com.br/wiki/index.php/Normas_Administrativas#POLITICA_DE_CAPACITA.C3.87.C3.83O Política de Capacitação]
## [http://www.portalbisa.com.br/wiki/index.php/Normas_Administrativas#EXIG.C3.8ANCIAS Exigências]
## [http://www.portalbisa.com.br/wiki/index.php/Normas_Administrativas#EXCESS.C3.95ES Excessões]

= Processos e Normas Financeiras=
* [[BISA]]
= Processos e Normas do Comercial=
* [[BISA]]

Tabela de Comissões

Tipos de Comissionamento.

TIPO A - Serviços Sem Taxa de Instalação mas com Mensalidade

Contratos de Consultoria como Filiados2000, Finanças2000, contas2000, Secretária2000, Receb2000, Jurídico2000, Protocolo2000 entre outros.

1 nível – se só indicar um novo cliente (10%)
2 nível – Se indicar e acompanhar a negociação (20%)
3 nível – Se indicar, acompanhar e Fechar um novo Cliente (30%)

TIPO B - Serviços com Taxa de Instalação

Contratos de Serviços tais como NoticiadorWeb, JurídicoWeb e Robô Jurídico.

1 nível – se só indicar um novo cliente (5%)
2 nível – Se indicar e acompanhar a negociação (10%)
3 nível – Se indicar, acompanhar e Fechar um novo Cliente (15%)

TIPO C - Serviços Outros (Sem Mensalidade)

Serviços eventuais como Eleições, Congressos, Cálculos de Processos Trabalhistas, Desenvolvimento de Sistemas Específicos.

1 nível – se só indicar um novo cliente (2%)
2 nível – Se indicar e acompanhar a negociação (3%)
3 nível – Se indicar, acompanhar e Fechar um novo Cliente (4%)

= Processos e Normas do Suporte Técnico=
* [[Procedimentos do Suporte]]
# [http://www.portalbisa.com.br/wiki/index.php/Procedimentos_do_Suporte#CAPACITA.C3.87.C3.83O Capacitação]
# [http://www.portalbisa.com.br/wiki/index.php/Procedimentos_do_Suporte#ATIVIDADES_DO_SUPORTE Atividades do Suporte]
# [http://www.portalbisa.com.br/wiki/index.php/Procedimentos_do_Suporte#PREMIA.C3.87.C3.83O Premiação]
## [http://www.portalbisa.com.br/wiki/index.php/Procedimentos_do_Suporte#GANHAR.C3.81_O_PR.C3.8AMIO_QUEM: Ganhará o prêmio quem:]
## [http://www.portalbisa.com.br/wiki/index.php/Procedimentos_do_Suporte#VERIFICA.C3.87.C3.83O_DO_GANHADOR Verificação do ganhador]
# [http://www.portalbisa.com.br/wiki/index.php/Procedimentos_do_Suporte#PR.C3.8AMIO Prêmio]
# [http://www.portalbisa.com.br/wiki/index.php/Procedimentos_do_Suporte#ROTINAS Rotinas]
# [http://www.portalbisa.com.br/wiki/index.php/Procedimentos_do_Suporte#AVALIA.C3.87.C3.83O Avaliação]
## [http://www.portalbisa.com.br/wiki/index.php/Procedimentos_do_Suporte#COMPORTAMENTO Comportamento]
## [http://www.portalbisa.com.br/wiki/index.php/Procedimentos_do_Suporte#PRODUTIVIDADE Produtividade]
# [http://www.portalbisa.com.br/wiki/index.php/Procedimentos_do_Suporte#EXEMPLO_DA_AVALIA.C3.87.C3.83O Exemplo da Avaliação]
# [http://www.portalbisa.com.br/wiki/index.php/Procedimentos_do_Suporte#LIBERAR_AS_PASTAS_VERS.C3.95ES-BETA_E_VERS.C3.95ES_LIBERADAS Habilitar as pastas versoes-beta e versoes-liberadas]

= Processos e Normas do Desenvolvimento=
* [[Processo de Desenvolvimento de Software da Bisa]];
* [[Processo de Desenvolvimento de Testes da Bisa]];
* [[Planning Poker]];
* [[Política de Desenvolvimento de Software da Bisa]];
* [[Papéis relacionados ao desenvolvimento de software da Bisa]];
* [[Critérios de Aceitação]];
* [[Normatizações da Bisa]];
* [[Lógica da Rotina de Login para Sistemas Multi-Empresa ou Multi-Planos]];
* [[Como Criar Um Executável Menor]];
* [[Controle de acesso de usuários aos sistemas da BISA]];
* [[Teclas de Atalho (Hotkeys) Padronizadas para todos os Sistemas BISA WEB]];
* [[Padronização de telas BISA]];
* [[Nova Nomenclatura das Tabelas do Antigo Banco BISA_TAB.MDB]];
* [[Aspectos Importantes da Implementação]];

== Requisitos Funcionais (RF)==
* [[Para uso de Todos os Sistemas]];
* [[Para uso do GFM]];
* [[Para uso do CAW]];
* [[Para uso do AJW]];
* [[Para uso do FWeb]];
* [[Para uso do AJM]];
* [[para uso do CTW]];
* [[para uso do Bw]];

= Auxílio aos desenvolvedores =
* O executável que você criou gerou falso positivo? não sabe?
** Clique [http://www.virustotal.com/index.html aqui] e verifique.

* Banco de Dados - alguns materiais
** Material de Banco da Dados - [http://portalbisa.com.br/docs/Workshop_SGBD_Linguagem_SQL.pdf Worshop Básico] (Nivelamento e Boas práticas)
** Material de Banco da Dados - [http://portalbisa.com.br/docs/Workshop_SGBD_Boas_Praticas.pdf Workshop Avançado] (Boas práticas, desempenho e performance)
**[http://www.mindomo.com/pt/mindmap/sql-ansi-562f6fc941a3f2865b194cc4ff09217c Mapa mental] para construção de comando SQL (ANSI)
**[http://www.w3schools.com/sql/sql_quickref.asp API de referência em SQL] - com todos os comandos e construções

* Aprendendo a usar o mantis
** [http://www.testexpert.com.br/files/alteracao_workflow_mantis.pdf Material] que explica as características de cada status no mantis
* [[Rotinas de alguns sistemas]];

= Auxílio ao Suporte =
* [[Abrindo requisições no Mantis]];
* [[Rotinas]];

= Processos e Normas da Gestão da Qualidade=
* [[Testes Necessários Para Todos os Sistemas]];

=Regras de Negócios=
* [[Documento de Utilização do Registrador]];

=Documentos da Bisa=
* [[Arquivos Produzidos pela BISA]];

Para uso do Bw- Construindo

2013-01-24T14:42:02Z

AnaPaula: /* 6.2.1 [RF001] e [RF011] */

Arquivo:Diagrama de sequencia2.PNG

2013-01-24T14:38:47Z

AnaPaula:

Para uso do Bw- Construindo

2013-01-24T14:30:18Z

AnaPaula: /* 6 Modelagem de Classes */

Arquivo:Diagrama de sequenciaa.png

2013-01-24T14:28:59Z

AnaPaula:

Para uso do Bw- Construindo

2013-01-24T14:10:15Z

AnaPaula: /* 6 Modelagem de Classes */

[[Arquivo:BoletosWeb.PNG]] 

[[Arquivo:Historico_de_revisoes.PNG]] 

=1. Caso de Negócio=
==1.1 Objetivos==

Documentar o novo módulo de geração e impressão de boletos online. As informações aqui descritas especificam e refinam a regras de negócio.

==1.2 Referências==

Se baseará no conhecimento adquirido na implementação de rotinas de boletos da BISA (desktop) e no antigo sistema TRAB_RUR da BISA, em DOS. A entrevista com Mário e Márcio da FETAPE (realizada por Ronaldo e Alexandre) também é referência para a definição dos requisitos.

==1.3 Sistemas com rotinas de gerenciamento de boletos da BISA==

O Filiados 2000 é um sistema desktop de gestão de filiados que controla o cadastro de filiados dos sindicatos de trabalhadores, fazendo acompanhamento de participação na organização.

O OAB 2000 é um software de gestão de cadastro de advogados para OAB's. Faz desde o cadastro de alunos, pré-inscritos, coordena sociedades de advogados, estagiários, até a administração dos dados financeiros dos advogados.

O Receb 2000 é um software voltado para o acompanhamento do contas a receber de uma empresa, fazendo a gestão financeira da carteira de forma simples e eficiente.

Todos esses sistemas possuem uma função de gerenciamento de boletos bancários ou guias sindicais, sendo salvos de forma centralizada no MySQL, de forma que podem ser acessados de forma uniforme no BoletoWEB.

Cada sistema contém suas próprias regras de negócio para gerenciar os boletos; no entanto, as funções de acesso ao banco remoto serão padronizadas para todos os sistemas no BoletoWEB.

==1.4 Descrição do Produto==

A maior parte da implementação é voltada para a FETAPE, enquanto o restante imprime boletos gerados pelos nossos sistema desktop.

Módulo Geral: este módulo tem a função meramente de fornecer uma interface web que permita ao usuário imprimir boletos gerados pelos sistemas desktop da BISA. 

'''Módulo FETAPE:''' no antigo sistema TRAB_RUR da BISA, este sistema é o foco principal desta documentação. Nela o usuário poderá gerenciar todo o fluxo de boletos de contribuições: geração, impressão interna, cadastro de filiados, acesso on-line dos filiados, etc.

==1.5 Contexto de Negócio==

O módulo geral de boletos na web será utilizado a princípio pelos sistemas Receb2000, OAB2000 e Filiados2000, porém poderá ser extendido a qualquer sistema que queira fazer o controle de boletos/guias.

Este módulo concentrará as informações dos boletos em um único local independente de entidade ou sistema. Este local, a priori, ficou definido como sendo um dos servidores internos da BISA que possua acesso externo. Cada sistema rodará normalmente no ambiente do cliente. No momento que for necessário o acesso às informações, este será feito não mais na base local da área do cliente, mas na base remota situada na BISA.

O módulo FETAPE segue as mesmas diretrizes, tendo a diferença de ser implementado exclusivamente para esta entidade, devendo ser adaptável para outras entidades. Para tanto, aconselha-se o uso de uma arquitetura em camadas e padrões de projetos, facilitadores do processos de manutenção.

==1.6 Tecnologias utilizadas==

Os módulos geral e FETAPE deverão implementados utilizando uma tecnologia para web: PHP, Java ou .NET.

O banco de dados necessariamente deverá ser o MySQL, pois já é utilizado na bisa para o registro de boletos.

=2. Sobre os Requisitos=
==2.1 Introdução==

Este documento especifica todos os requisitos funcionais e não funcionais do módulo de gerenciamento de boletos, descrevendo os fluxos de eventos, prioridades, atores, entradas e saídas de cada caso de uso a ser implementado.

A correta interpretação deste documento exige o conhecimento de algumas convenções e termos específicos, que são descritos a seguir.

==2.2 Identificação dos Requisitos==

Por convenção, a referência a requisitos é feita através do nome da subseção onde eles estão descritos, seguidos do identificador do requisito, de acordo com o esquema abaixo:

[nome da subseção, identificador do requisito]

Por exemplo, o requisito funcional [Imprimir Boleto RF002] está descrito em um caso de uso chamado “Imprimir Boleto”, em um bloco identificado pelo identificador [RF002].

==2.3 Prioridades dos Requisitos==

Para estabelecer a prioridade dos requisitos foram adotadas as denominações “essencial”, “importante” e “desejável”. 
• Essencial é o requisito sem o qual o sistema não entra em funcionamento. São requisitos imprescindíveis, que têm que ser implementados. 
• Importante é o requisito sem o qual o sistema entra em funcionamento, mas de forma não satisfatória. Requisitos importantes devem ser implementados, mas, se não forem, o sistema poderá ser implantado e usado mesmo assim. 
• Desejável é o requisito que não compromete as funcionalidades básicas do sistema, isto é, o sistema pode funcionar de forma satisfatória sem ele. Requisitos desejáveis são requisitos que podem ser deixados para versões posteriores do sistema, caso não haja tempo hábil para implementá-los na versão que está sendo especificada. 

==2.4 Descrição dos Atores==

'''Usuário externo'''
É a pessoa que acessa a funcionalidade de impressão de boletos do módulo geral pelo browser.

Filiado FETAPE
Semelhante ao usuário comum, com a diferença de que terá a opção de se cadastrar pelo site.

Funcionário FETAPE
É responsável pelo gerenciamento dos boletos. É o ator principal deste sistema.

=3 Requisitos Funcionais (Casos de Uso)=
==3.1 Ações do Usuário==

==[RF001] Efetuar login==
Atores relacionados
Usuário externo, Filiado FETAPE e Funcionário FETAPE.

===Objetivo===
Fazer login no módulo Web de impressão de boletos.

===Prioridade===
Essencial.

===Entradas e pré condições===
'''Entradas:''' login do usuário e senha;
'''Pré-condições:''' computador deve ter acesso à internet; servidor web disponível.

===Saídas e pós-condições===
'''Saídas:''' não há
'''Pós-condições:''' usuário logado no sistema.

===Fluxo principal de eventos===
1. Usuário executa seu web browser e acessa a página de login (E1, E2); 
2. Usuário informa login e senha e clica em Entrar (E3); 
3. Sistema recupera na base de dados a senha do usuário com o login informado; 
4. Sistema verifica se o login está cadastrado (E4); 
5. Sistema verifica se a senha informada corresponde ao login informado (E5); 
6. Sistema libera o acesso após o sucesso da verificação; 
7. Includes [RF002]. 

===Fluxos de exceção===
• E1: se não houver conexão com a internet, uma mensagem será exibida informando que não é possível estabelecer uma conexão com a internet e solicitando ao usuário que verifique sua conexão; 
• E2: se o sistema não estiver disponível, uma mensagem será exibida informando que o serviço não está disponível e que o usuário deve tentar acessá-lo mais tarde; 
• E3: se o usuário não informar o login ou a senha, o sistema solicita que informe o login e a senha; 
• E4: se o login não estiver cadastrado, o sistema emite uma mensagem de erro informando que este usuário não está cadastrado e solicitando que o mesmo verifique se o login foi digitado corretamente; 
• E5: se a senha não conferir com a que está armazenada na base de dados, o sistema emite uma mensagem de erro avisando que a senha informada está incorreta e solicitando que o mesmo verifique se ela foi digitada corretamente. 

==[RF002] Listar boletos==
===Atores relacionados===
Usuário externo, Filiado FETAPE e Funcionário FETAPE.

===Objetivo===
Listar os boletos correspondentes ao usuário logado.

===Prioridade===
Essencial.

===Entradas e pré condições===
'''Entradas:''' nenhuma.
'''Pré-condições:''' usuário logado no sistema; boletos armazenados no banco de dados.

===Saídas e pós-condições===
'''Saídas:''' lista de boletos.
'''Pós-condições:''' nenhuma.

===Fluxo principal de eventos===
1. Sistema carrega da base de dados os boletos referentes ao usuário (E1, E2, E3); 
2. É exibida a lista de boletos (com check boxes para seleção), cada um com seu número, descrição, valor, vencimento e status (pendente/atrasado/impresso/pago). Os boletos serão ordenados de forma decrescente (maior para o menor) por data de vencimento na lista. Também haverá uma check box que permite a seleção de todos os boletos listados na tela e um limite de boletos a serem exibidos, sendo os demais boletos acessados por uma barra de próximo/anterior (semelhante a um esquema de web mail); 
3. Através de uma caixa de seleção (combo box), o usuário pode filtrar os boletos que serão exibidos na tela de acordo com a opção: “pendentes/impressos/pagos/todos”. Os boletos com status “atrasado” ficarão na lista de “pendentes” e “todos”, mas com uma cor de linha de grid que os diferencie dos demais (ex. vermelho). O status inicial do filtro é “pendentes”. 

===Fluxos de exceção===
• E1: se não houver conexão com a internet, uma mensagem será exibida informando que não é possível estabelecer uma conexão com a internet e solicitando ao usuário que verifique sua conexão; 
• E2: se o sistema não estiver disponível, uma mensagem será exibida informando que o serviço não está disponível e que o usuário deve tentar acessá-lo mais tarde; 
• E3: se o resultado da busca retornar vazio, uma mensagem será exibida informando ao usuário que não existe dados referentes à consulta realizada. 

=[RF003] Geração de boletos=
===Atores relacionados===
Usuário externo, Filiado FETAPE e Funcionário FETAPE.

===Objetivo===
Gerar registros de boletos no banco de dados para impressão. Não constitui a impressão do boleto em si.

===Prioridade===
Essencial.

===Entradas e pré condições===
'''Entradas:''' filiado(s)/usuário(s), banco, data de vencimento, modelo da guia, nosso número inicial, valor e instruções.
'''Pré-condições:''' usuário logado no sistema; sindicatos e filiados armazenados no banco de dados.

===Saídas e pós-condições===
'''Saídas:''' mensagem de aviso de sucesso da operação. 
'''Pós-condições:''' registro dos boletos inseridos no banco de dados.

===Fluxo principal de eventos===
1. Usuário Externo e Filiado FETAPE: usuário clica no botão Gerar Boletos. Se o usuário estiver com o status óbito, não será gerado boleto. Funcionário FETAPE: funcionário seleciona uma quantidade de filiados na tela de Listagem de Filiados e clica no botão Gerar Boletos. Os filiados com o status “óbito” nunca serão carregados; 
2. Sistema carrega o(s) usuários(s)/filiado(s) selecionados com seus respectivos dados (E1, E2, E3, E4); 
3. Uma janela é aberta perguntando se o usuário deseja imprimir boletos referentes a Contribuição Sindical e Contribuição Confederativa (2 check boxes); 
4. Uma tela é aberta onde o usuário informa os dados (banco, data de vencimento, modelo da guia, nosso número inicial, valor e instruções) para os boletos. Usuário confirma a operação; 
5. Sistema valida os dados inseridos pelo usuário e os dados obrigatórios para emissão de boleto (E5, E6); 
6. Sistema gera os boletos e os armazena no banco de dados com o status “gerado” (E7). O sistema deverá verificar se o número de boleto que ele irá gerar existe em algum intervalo na tabela de boletos avulso. Se existir, ele deverá gerar um próximo número que não esteja em um intervalo desta tabela; 
7. Sistema insere os registros de log da situação dos boletos no banco remoto com a justificava “gerado a partir da função de geração de boleto pelo usuário X:Y”, onde X corresponde ao login do funcionário e Y corresponde ao seu nome; 
8. Sistema exibe mensagem confirmando o sucesso na geração dos boletos e perguntando se o usuário deseja fazer a impressão dos mesmos; 
9. Se o usuário responder que sim, a janela de impressão padrão da funcionalidade imprimir é aberta. Includes [RF004]. 

===Filiado FETAPE===
Este usuário também terá acesso à rotina de CANCELAMENTO do boleto, que consiste meramente na exclusão do mesmo da base de dados. Vale salientar que devem ser efetuados os devidos registros no log do sistema seguindo o padrão supracitado, assim como devem ser atendidos os seguintes fluxos de exceção: 
1. Se o boleto possuir o status “pago”, “impresso” ou “enviado” (para o banco), o cancelamento não será permitido. O sistema exibirá uma mensagem de erro avisando que o boleto não pode ser impresso, indicando o seu status atual; 
2. Se o boleto requisitado não puder ser excluído, o sistema exibe uma mensagem de erro solicitando que o boleto não poder ser removido no momento. 

===Fluxos de exceção===
• E1: se não houver conexão com a internet, uma mensagem será exibida informando que não é possível estabelecer uma conexão com a internet e solicitando ao usuário que verifique sua conexão; 
• E2: se o sistema não estiver disponível, uma mensagem será exibida informando que o serviço não está disponível e que o usuário deve tentar acessá-lo mais tarde; 
• E3: se o resultado da busca retornar vazio, uma mensagem será exibida informando ao usuário que não existem dados referentes à consulta realizada; 
• E4: se o sistema não conseguir acessar a base de dados, uma mensagem será exibida informando ao usuário que a base de dados está inacessível; 
• E5: se o usuário não preencher os dados obrigatórios do boleto (banco, data de vencimento, modelo da guia, nosso número inicial e valor), uma mensagem será exibida informando ao usuário que os campos obrigatórios devem ser preenchidos; 
• E6: se os dados obrigatórios do(s) usuário(s)/filiado(s) para emissão de boleto não foram preenchidos (nome, logradouro, bairro, cidade, estado e CEP), o sistema lista na tela os usuário(s)/filiado(s) cujos dados obrigatórios não estão preenchidos e, para cada um, informa quais campos devem ser preenchidos. O usuário poderá prosseguir para a tela de marcação dos boletos que serão impressos (botão “prosseguir”), no entanto os boletos cujos dados não estão completos não aparecerão para seleção; 
• E7: se houver um estouro na numeração de boletos*, o sistema exibe uma mensagem solicitando ao usuário que entre em contato com a BISA pois houve um problema na geração da numeração do boleto. A operação não é finalizada. O sistema deve ainda efetuar todas as rotinas de rollback de modo a não deixar ‘lixo’ no banco de dados. 

<nowiki>*</nowiki> O estouro na numeração de boletos ocorre quando o limite do número de boletos cadastrado no banco de dados é atingido. Por exemplo, supondo um limite de 10 bytes, se o último registro cadastrado for 9999999999, o próximo registro de boleto irá acionar este erro. 

=[RF004] Imprimir boletos=
===Atores relacionados===
Usuário externo, Filiado FETAPE e Funcionário FETAPE.

===Objetivo===
Constitui a impressão de um boleto já gerado no sistema.

===Prioridade===
Essencial.

===Entradas e pré condições===
'''Entradas:''' lista de boletos para impressão. 
'''Pré-condições:''' o usuário deve estar logado no sistema na tela da listagem de boletos (RF002); os registros dos boletos devem estar armazenados no banco de dados e marcados como “não impresso”.

===Saídas e pós-condições===
'''Saídas:''' impressão dos boletos selecionados. 
'''Pós-Condições:''' registros dos boletos marcados no banco como “impresso”.

===Fluxo principal de eventos===
1. Usuário seleciona na Lista de boletos aqueles que deseja imprimir (check box) e clica no botão Imprimir (E1, E2, E3, E4, E5); 
2. Se o usuário houver selecionado apenas um boleto, o sistema imprime o boleto no navegador, permitindo ao usuário conferir seus dados. Depois disso, ele clica em um novo botão Imprimir e passa para o passo 3; 
3. Janela de impressão padrão é aberta (onde o usuário poderá selecionar impressora, quantidade de páginas, etc). Usuário confirma a impressão e o sistema envia os arquivos para a impressora (E6); 
4. Sistema marca no banco os boletos que foram impressos com o status “impresso” (E7); 
5. Sistema insere no log de boletos os registros com o status impresso com a justificativa “impresso pela função de impressão de boletos pelo usuário X:Y”, onde X corresponde ao código do usuário e Y ao seu nome. 
6. Sistema exibe uma mensagem de “Boletos impressos com sucesso”. 

===Fluxos de exceção===
• E1: se não houver conexão com a internet, uma mensagem será exibida informando que não é possível estabelecer uma conexão com a internet e solicitando ao usuário que verifique sua conexão; 
• E2: se o sistema não estiver disponível, uma mensagem será exibida informando que o serviço não está disponível e que o usuário deve tentar acessá-lo mais tarde; 
• E3: se o usuário não selecionar boletos, o sistema exibe uma mensagem solicitando ao usuário que selecione boletos para impressão; 
• E4: se na lista houver boletos que já foram pagos, o sistema exibe uma mensagem de erro informando que boletos pagos não podem ser reimpressos e cancela a operação; 
• E5: se houver boletos que já foram impressos, o sistema exibe um alerta informando que os boletos já foram impressos pelo sistema e serão reimpressos nesta operação; continua a executar normalmente; 
• E6: se houver um erro ao enviar os dados para a impressora, o sistema exibe uma mensagem avisando ao usuário que o sistema não conseguiu imprimir e solicitando que o mesmo verifique se a impressora está pronta para impressão; 
• E7: se houver um erro na alteração dos registros no banco de dados, uma mensagem será exibida informando que não foi possível marcar os boletos como impressos e solicitando ao usuário que tente novamente e que, caso o erro persista, entre em contato com a BISA. O sistema deve ainda efetuar todas as rotinas de rollback de modo a não deixar ‘lixo’ no banco de dados. 

=[RF005] Cadastro de filiado=
===Atores relacionados===
Filiado FETAPE e Funcionário FETAPE.

===Objetivo===
Cadastrar um filiado. As rotinas de ALTERAÇÃO e de EXCLUSÃO também estão contidas neste requisito para o Funcionário FETAPE.

===Prioridade===
Essencial.

===Entradas e pré condições===
'''Entradas:''' dados cadastrais do usuário. 
'''Pré-condições:''' computador deve ter acesso à internet; servidor web disponível. Funcionário: usuário cadastrado no sistema. 

===Saídas e pós-condições===
'''Saídas:''' mensagem avisando que o usuário foi cadastrado com sucesso. 
'''Pós-Condições:''' usuário cadastrado no banco de dados. 

===Fluxo principal de eventos===
1. Ator Filiado: a função “Cadastrar Filiado” é acionada pelo usuário no navegador web (E1, E2). Ator Funcionário: a função “Cadastrar Filiado” é acionada pelo usuário na tela de Listagem de Filiados (E1, E2). 
2. Um formulário é aberto solicitando dados cadastrais: login, senha, nome, CPF, CNAE, bairro, cidade, UF, logradouro, CEP, categoria (seleção entre as opções arrendatário, assentado, meeiro, parceiro, posseiro, pequeno proprietário e outros) e apelido do filiado; 
3. Usuário preenche os campos e confirma a operação (E3, E4, E5, E6); 
4. Sistema insere os registros de log da situação no banco remoto com a justificava “cadastrado pelo usuário X:Y”, onde X corresponde ao login do usuário e Y corresponde ao seu nome; 
5. Sistema retorna uma mensagem avisando que o usuário foi cadastrado com sucesso. 

O sistema também apresenta as rotinas de ALTERAÇÃO, que por ser trivial e seguir um fluxo semelhante à rotina de inclusão não terá sua execução descrita aqui. Vale salientar que devem ser efetuados os devidos registros no log do sistema. 

===Filiado FETAPE===
Ele possui também a funcionalidade EXCLUSÃO. Sua tela de ALTERAR é diferente. Nela, o usuário pode marcar um check box “óbito” para filiados que foram a óbito.

===Fluxos de exceção===
• E1: se não houver conexão com a internet, uma mensagem será exibida informando que não é possível estabelecer uma conexão com a internet e solicitando ao usuário que verifique sua conexão; 
• E2: se o sistema não estiver disponível, uma mensagem será exibida informando que o serviço não está disponível e que o usuário deve tentar acessá-lo mais tarde; 
• E3: se o login fornecido já estiver cadastrado no sistema, uma mensagem será exibida informando ao usuário que o login cadastrado já existe no sistema; 
• E4: se o CPF do filiado for inválido, uma mensagem será exibida informando ao usuário que o CPF cadastrado é inválido. Vale salientar que o preenchimento deste campo é opcional; 
• E5: se houver um erro na inserção dos registros no banco de dados, uma mensagem será exibida informando que não foi possível inserir os dados e solicitando ao usuário que tente novamente e que, caso o erro persista, entre em contato com a BISA. O sistema deve ainda efetuar todas as rotinas de rollback de modo a não deixar ‘lixo’ no banco de dados; 
• E6: se os dados obrigatórios dos filiados não forem preenchidos (nome, logradouro, bairro, cidade, estado e CEP), o sistema emite uma mensagem de erro informando quais os campos obrigatórios não foram preenchidos. 

=[RF006] Listar filiados=
===Atores relacionados===
Funcionário FETAPE.

===Objetivo===
Listar todos os filiados cadastrados no sistema.

===Prioridade===
Essencial.

===Entradas e pré condições===
'''Entradas:''' nenhuma.
'''Pré-condições:''' usuário logado no sistema; filiados armazenados no banco de dados.

===Saídas e pós-condições===
'''Saídas:''' lista de filiados. 
'''Pós-condições:''' nenhuma. 

===Fluxo principal de eventos===
1. Usuário clica no botão Filiados da barra de funções do sistema para acessar a Listagem de Filiados; 
2. Sistema carrega da base de dados os filiados com seus respectivos dados (E1, E2, E3, E4); 
3. É exibida a lista de filiados (com check boxes para seleção), cada um com seu número, nome, apelido, CPF, município, sindicato e categoria. Os filiados serão ordenados por ordem alfabética e agrupados por município. Também haverá uma check box que permite a seleção de todos os filiados listados na tela e um limite de filiados a serem exibidos, sendo os demais acessados por uma barra de próximo/anterior (semelhante a um esquema de web mail); 
4. Através de uma caixa de seleção (combo box), o usuário pode filtrar os filiados que serão exibidos na tela de acordo com a opção: “nome/apelido/município/sindicato”. A opção “nome” é a padrão. Os filiados que foram a óbito serão exibidos com uma cor de linha de grid acinzentada e só serão exibidos se um check box “todos” for ativado. 

===Fluxos de exceção===
• E1: se não houver conexão com a internet, uma mensagem será exibida informando que não é possível estabelecer uma conexão com a internet e solicitando ao usuário que verifique sua conexão; 
• E2: se o sistema não estiver disponível, uma mensagem será exibida informando que o serviço não está disponível e que o usuário deve tentar acessá-lo mais tarde; 
• E3: se o resultado da busca retornar vazio, uma mensagem será exibida informando ao usuário que não existem dados referentes à consulta realizada; 
• E4: se o sistema não conseguir acessar a base de dados, uma mensagem será exibida informando ao usuário que a base de dados está inacessível. 

=[RF007] Cadastro de sindicato=
===Atores relacionados===
Funcionário FETAPE.

===Objetivo===
Cadastrar um sindicato. As rotinas de ALTERAÇÃO e de EXCLUSÃO também estão contidas neste requisito.

===Prioridade===
Essencial.

===Entradas e pré condições===
'''Entradas:''' dados do sindicato; dados do Município (já presentes na base de dados, herdada do antigo sistema DOS TRAB_RUR). 
'''Pré-condições:''' usuário logado no sistema. 

===Saídas e pós-condições===
'''Saídas:''' mensagem avisando que o sindicato foi cadastrado com sucesso. 
'''Pós-Condições:''' sindicato cadastrado no banco de dados. 

Fluxo principal de eventos
1. Usuário clica no botão cadastrar na tela de Listagem de Sindicatos (E1, E2); 
2. Um formulário é aberto solicitando dados cadastrais: nome, município, UF, endereço; 
3. Usuário preenche os campos e confirma a operação (E3); 
4. Sistema insere os registros de log da situação no banco remoto com a justificava “cadastrado pelo usuário X:Y”, onde X corresponde ao login do funcionário e Y corresponde ao seu nome; 
5. Sistema retorna uma mensagem avisando que o sindicato foi cadastrado com sucesso. 

Também haverá rotinas de alteração e de exclusão. O processo é trivial para ser descrito aqui. Vale salientar que devem ser efetuados os devidos registros no log do sistema. 

===Fluxos de exceção===
• E1: se não houver conexão com a internet, uma mensagem será exibida informando que não é possível estabelecer uma conexão com a internet e solicitando ao usuário que verifique sua conexão; 
• E2: se o sistema não estiver disponível, uma mensagem será exibida informando que o serviço não está disponível e que o usuário deve tentar acessá-lo mais tarde; 
• E3: se houver um erro na inserção dos registros no banco de dados, uma mensagem será exibida informando que não foi possível inserir os dados e solicitando ao usuário que tente novamente e que, caso o erro persista, entre em contato com a BISA. O sistema deve ainda efetuar todas as rotinas de rollback de modo a não deixar ‘lixo’ no banco de dados; 

=[RF008] Listar sindicatos=
===Atores relacionados===
Funcionário FETAPE.

===Objetivo===
Listar todos os sindicatos cadastrados no sistema.

===Prioridade===
Essencial.

===Entradas e pré condições===
'''Entradas:''' nenhuma. 
'''Pré-condições:''' usuário logado no sistema; sindicatos armazenados no banco de dados. 

===Saídas e pós-condições===
'''Saídas:''' lista de sindicatos. 
'''Pós-condições:''' nenhuma. 

===Fluxo principal de eventos===
1. Usuário clica no botão Sindicatos da barra de funções do sistema para acessar a Listagem de Sindicatos; 
2. Sistema carrega da base de dados os sindicatos com seus respectivos dados (E1, E2, E3, E4); 
3. É exibida a lista de sindicatos (com check boxes para seleção), cada um com seu número, nome e município. Os sindicatos serão ordenados por ordem alfabética e agrupados por município. Também haverá uma check box que permite a seleção de todos os sindicatos listados na tela e um limite de sindicatos a serem exibidos, sendo os demais acessados por uma barra de próximo/anterior (semelhante a um esquema de web mail); 
4. Através de uma caixa de seleção (combo box), o usuário pode filtrar os sindicatos que serão exibidos na tela de acordo com a opção: “nome/município”. A opção “nome” é a padrão. 

===Fluxos de exceção===
• E1: se não houver conexão com a internet, uma mensagem será exibida informando que não é possível estabelecer uma conexão com a internet e solicitando ao usuário que verifique sua conexão; 
• E2: se o sistema não estiver disponível, uma mensagem será exibida informando que o serviço não está disponível e que o usuário deve tentar acessá-lo mais tarde; 
• E3: se o resultado da busca retornar vazio, uma mensagem será exibida informando ao usuário que não existem dados referentes à consulta realizada; 
• E4: se o sistema não conseguir acessar a base de dados, uma mensagem será exibida informando ao usuário que a base de dados está inacessível. 

===[RF009] Baixar Boleto===
===Atores relacionados===
Funcionário FETAPE.

===Objetivo===
Baixa nos boletos que foram impressos. Eles passarão a ter o status de pago.

===Prioridade===
Essencial.

===Entradas e pré condições===
'''Entradas:''' lista de boletos para baixa.
'''Pré-condições:''' usuário logado no sistema; os registros dos boletos devem estar armazenados no banco de dados.

===Saídas e pós-condições===
'''Saídas:''' mensagem de aviso de sucesso da operação. 
'''Pós-condições:''' registro dos boletos marcados no banco como “pagos”. 

===Fluxo principal de eventos===
1. Usuário seleciona na Lista de boletos aqueles que deseja baixar (check box) e clica no botão Baixar (E1, E2, E3, E4, E5); 
2. Sistema marca no banco os boletos como pagos (E6). Se o boleto não for encontrado na tabela de boletos, deverá ser procurado na tabela de boletos avulsos (E7); 
3. Sistema insere no log de boletos os registros com o status impresso com a justificativa “baixado pela função de baixar de boletos pelo usuário X:Y”, onde X corresponde ao código do usuário e Y ao seu nome; 
4. Sistema exibe uma mensagem de “Boletos baixados com sucesso”. 

===Fluxos de exceção===
• E1: se não houver conexão com a internet, uma mensagem será exibida informando que não é possível estabelecer uma conexão com a internet e solicitando ao usuário que verifique sua conexão; 
• E2: se o sistema não estiver disponível, uma mensagem será exibida informando que o serviço não está disponível e que o usuário deve tentar acessá-lo mais tarde; 
• E3: se o usuário não selecionar boletos, o sistema exibe uma mensagem solicitando ao usuário que selecione boletos para impressão; 
• E4: se na lista houver boletos com o status “pago”, o sistema exibe uma mensagem informando que boletos selecionados já foram baixados. Se o usuário clicar em continuar, o sistema continua a execução e ignora esses boletos; 
• E5: se na lista houver boletos com o status diferente de “impresso” ou “enviado” (enviado para o banco), o sistema exibe uma mensagem informando que há boletos selecionados que ainda não foram impressos ou enviados para o banco e quais são estes boletos. Se o usuário clicar em continuar, o sistema continua a execução e ignora esses boletos; 
• E6: se houver um erro na alteração dos registros no banco de dados, uma mensagem será exibida informando que não foi possível marcar os boletos como pagos e solicitando ao usuário que tente novamente e que, caso o erro persista, entre em contato com a BISA. O sistema deve ainda efetuar todas as rotinas de rollback de modo a não deixar ‘lixo’ no banco de dados; 
• E7: se o registro do boleto não for encontrado no banco, o sistema exibirá uma mensagem de erro indicando que o boleto não foi encontrado na base de dados do sistema. 

=[RF010] Baixar Boleto Automaticamente (via Arquivo de Retorno do Banco)=
===Atores relacionados===
Funcionário FETAPE.

===Objetivo===
Baixar de boletos a partir de um arquivo de retorno que o banco envia.

===Prioridade===
Essencial.

===Entradas e pré condições===
'''Entradas:''' arquivo de retorno do banco. 
'''Pré-condições:''' usuário logado no sistema; os registros dos boletos devem estar armazenados no banco de dados. 

===Saídas e pós-condições===
'''Saídas:''' mensagem de sucesso da operação. 
'''Pós-condições:''' registro dos boletos marcados no banco como “pagos”. 

===Fluxo principal de eventos===
1. Na tela da Lista de boletos, usuário clica na opção Baixa com Arquivo do Banco (E1, E2); 
2. Uma tela é aberta perguntando qual o arquivo de retorno do banco. O usuário então seleciona o caminho no seu computador correspondente à localização do arquivo e clica em OK. O sistema irá, então, fazer o upload do arquivo (E3, E4, E5); 
3. Sistema guarda a identificação do arquivo de retorno com situação de ‘não processado’ na base de dados e guarda uma cópia do arquivo em diretório especifico para histórico; 
4. Para cada linha do arquivo de retorno, o sistema procura o boleto referente na base de dados de boletos de contribuição. Se o boleto não for encontrado, o sistema procura na base de dados de boletos avulsos. Nesta base, há registros de boletos com intervalos (ex. de 001 a 100). O sistema irá buscar o número do boleto nessa faixa (E6); 
5. O sistema verifica se o boleto encontrado está marcado como “impresso” ou “enviado” (para o banco). Se estiver, o sistema marca no banco de dados o boleto como “pago” (E7); 
6. O sistema insere no log de boletos o registro com situação de “pago” com a justificativa ‘baixado pela função de baixa automática de boleto pelo usuário X:Y’, onde X corresponde ao login de usuário e Y corresponde ao seu nome; 
7. O Sistema marca o arquivo de retorno como ‘processado sem erros’ e uma exibe mensagem confirmando o sucesso na baixa dos boletos. 

===Fluxos de exceção===
• E1: se não houver conexão com a internet, uma mensagem será exibida informando que não é possível estabelecer uma conexão com a internet e solicitando ao usuário que verifique sua conexão; 
• E2: se o sistema não estiver disponível, uma mensagem será exibida informando que o serviço não está disponível e que o usuário deve tentar acessá-lo mais tarde; 
• E3: se o usuário não apontar nenhum arquivo de retorno, uma mensagem será exibida exigindo que o usuário aponte o arquivo; 
• E4: se o caminho para o arquivo estiver incorreto, o sistema exibe uma mensagem para o usuário informando que o caminho selecionado é inválido; 
• E5: se o formato do arquivo não corresponder ao formato do arquivo de retorno do banco esperado, o sistema exibirá uma mensagem informando que o formato do arquivo selecionado é inválido; 
• E6: se um registro do arquivo não for encontrado no sistema (base principal e base de boletos avulsos), será exibido numa tela todos os registros que não foram encontrados. A situação do arquivo de retorno no banco deve então mudar para “processado com erro” e o sistema deve inserir o registro de log de boleto com a justificativa “boleto não pode ser baixado, pois o mesmo não foi encontrado no sistema. Ação executada pelo usuário X:Y”, onde X é o login e Y é o nome. O valor do boleto pago e não encontrado deverá ser armazenado na tabela de boletos no registro cujo identificador é “BoletoXXXX”. Todo boleto que não for encontrado deverá ser somado ao valor desse registro; 
• E7: se houver um erro na alteração dos registros no banco de dados, uma mensagem será exibida informando que não foi possível marcar os boletos como “pago” e solicitando ao usuário que tente novamente e que, caso o erro persista, entre em contato com a BISA. O sistema deve ainda efetuar todas as rotinas de rollback de modo a não deixar ‘lixo’ no banco de dados. 

=[RF011] Gerar arquivo de remessa para banco=
===Atores relacionados===
===Funcionário FETAPE.===

===Objetivo===
Gerar arquivo de remessa de boletos para o banco.

===Prioridade===
Essencial.

===Entradas e pré condições===
'''Entradas:''' lista de boletos que serão enviados para o arquivo. 
'''Pré-condições:''' usuário logado no sistema; os registros dos boletos devem estar armazenados no banco de dados com o status “gerado” ou “impresso”. 

===Saídas e pós-condições===
'''Saídas:''' mensagem de sucesso da operação; arquivo de remessa para o banco. 
'''Pós-condições:''' boletos marcados com o status “enviado” no banco na base de dados. 

===Fluxo principal de eventos===
1. Na tela de Listagem de Boletos, o usuário seleciona os boletos e clica no botão Gerar de arquivo de remessa (E1, E2); 
2. Sistema verifica se todos os boletos selecionados estão marcados como “gerado” ou “impresso” (E3); 
3. Sistema abre tela para que o usuário informe o nome do arquivo e o local onde ele será gerado (E4, E5); 
4. Usuário confirma a geração do arquivo; 
5. Sistema gera o arquivo de remessa; 
6. Sistema marca no banco os boletos que foram inseridos no arquivo de remessa com o status de “enviado” para o banco (E6); 
7. Sistema insere no log de boletos os registros com situação de enviado com a justificativa “boleto gerado no arquivo de remessa para o banco pelo usuário X:Y”, onde X corresponde ao login do usuário e Y corresponde ao seu nome; 
8. Sistema salva em diretório especifico no banco uma cópia do arquivo gerado para remessa para fins de histórico; 
9. Sistema retorna o arquivo de remessa para que o usuário salve-o em seu computador. 

===Fluxos de exceção===
• E1: se não houver conexão com a internet, uma mensagem será exibida informando que não é possível estabelecer uma conexão com a internet e solicitando ao usuário que verifique sua conexão; 
• E2: se o sistema não estiver disponível, uma mensagem será exibida informando que o serviço não está disponível e que o usuário deve tentar acessá-lo mais tarde; 
• E3: se o sistema não encontrar nenhum arquivo com o status “gerado” ou “impresso”, uma mensagem será exibida informando que não existem boletos a serem gerados para o arquivo de remessa. Se encontrar, deverá informar quais os boletos não serão gerados no arquivo; 
• E4: se o usuário informa um local não existente, o sistema pergunta ao usuário se o mesmo deseja que o sistema crie o diretório de pastas informado. Se a resposta for sim, sistema cria diretório de pasta; se a resposta for não, sistema retorna a tela de informação do local para que o usuário selecione um novo diretório; 
• E5: se houver um erro na geração do arquivo de remessa, uma mensagem será exibida informando ao usuário que o arquivo de remessa não pode ser gerado e que o mesmo tente novamente e que, caso o erro persista, entre em contato com a BISA.; 
• E6: se houver um erro na alteração dos registros no banco de dados, uma mensagem será exibida informando que não foi possível marcar os boletos como “enviado” e solicitando ao usuário que tente novamente e que, caso o erro persista, entre em contato com a BISA. O sistema deve ainda efetuar todas as rotinas de rollback de modo a não deixar ‘lixo’ no banco de dados. 

=[RF012] Gerar arquivo de remessa para Gráfica=
===Atores relacionados===
Funcionário FETAPE.

===Objetivo===
Gerar arquivo de remessa de boletos para Gráfica.

===Prioridade===
Essencial.

===Entradas e pré condições===
'''Entradas:''' lista de boletos que serão enviados para o arquivo. 
'''Pré-condições:''' usuário logado no sistema; os registros dos boletos devem estar armazenados no banco de dados com o status “gerado”.

===Saídas e pós-condições===
'''Saídas:''' mensagem de sucesso da operação; arquivo de remessa para a gráfica (em formato txt e xls). 
'''Pós-condições:''' boletos marcados com o status “enviadoGrafica” no banco na base de dados. 

===Fluxo principal de eventos===
1. Na tela de Listagem de Boletos, o usuário seleciona os boletos e clica no botão Gerar arquivo de boleto para Gráfica (E1, E2); 
2. Sistema verifica se todos os boletos selecionados estão marcados como “gerado” (E3); 
3. Sistema abre tela para que o usuário informe o nome do arquivo e o local onde ele será gerado (E4, E5); 
4. Usuário confirma a geração do arquivo; 
5. Sistema pergunta se o usuário quer gerar o arquivo no formato txt ou xls; 
6. Sistema gera o arquivo de remessa para Gráfica; 
7. Sistema marca no banco os boletos que foram inseridos no arquivo de remessa com o status de “enviadoGrafica” para o banco (E6); 
8. Sistema insere no log de boletos os registros com situação de enviado com a justificativa “boleto gerado no arquivo de remessa para Gráfica pelo usuário X:Y”, onde X corresponde ao login do usuário e Y corresponde ao seu nome; 
9. Sistema salva em diretório especifico no banco uma cópia do arquivo gerado para remessa para Gráfica para fins de histórico; 
10. Sistema retorna o arquivo para que o usuário salve-o em seu computador. 

===Fluxos de exceção===
• E1: se não houver conexão com a internet, uma mensagem será exibida informando que não é possível estabelecer uma conexão com a internet e solicitando ao usuário que verifique sua conexão; 
• E2: se o sistema não estiver disponível, uma mensagem será exibida informando que o serviço não está disponível e que o usuário deve tentar acessá-lo mais tarde; 
• E3: se o sistema não encontrar nenhum arquivo com o status “gerado”, uma mensagem será exibida informando que não existem boletos a serem gerados para o arquivo de remessa. Se encontrar, deverá informar quais os boletos não serão gerados no arquivo; 
• E4: se o usuário informa um local não existente, o sistema pergunta ao usuário se o mesmo deseja que o sistema crie o diretório de pastas informado. Se a resposta for sim, sistema cria diretório de pasta; se a resposta for não, sistema retorna a tela de informação do local para que o usuário selecione um novo diretório; 
• E5: se houver um erro na geração do arquivo de remessa, uma mensagem será exibida informando ao usuário que o arquivo de remessa não pode ser gerado e que o mesmo tente novamente e que, caso o erro persista, entre em contato com a BISA; 
• E6: se houver um erro na alteração dos registros no banco de dados, uma mensagem será exibida informando que não foi possível marcar os boletos como “enviado” e solicitando ao usuário que tente novamente e que, caso o erro persista, entre em contato com a BISA. O sistema deve ainda efetuar todas as rotinas de rollback de modo a não deixar ‘lixo’ no banco de dados. 

=4 Especificações Suplementares=
===4.1 Objetivos===
Este documento tem como finalidade especificar todos os requisitos não funcionais do módulo de boletos web divididos em requisitos de usabilidade, confiabilidade, desempenho, segurança, distribuição, adequação a padrões e requisitos de hardware e software.
===4.2 Usabilidade===
Esta seção descreve os requisitos não funcionais associados à facilidade de uso da interface com o usuário, material de treinamento e documentação do sistema.
=[NF001] Interface com o Usuário=
===Prioridade:===
Desejável 
O sistema deve possuir uma interface amigável, simples e intuitiva.
===4.3 Confiabilidade===
Esta seção descreve os requisitos não funcionais associados à freqüência, severidade de falhas do sistema e habilidade de recuperação das mesmas, bem como a corretude do sistema.

=[NF001] Tempo de Retorno após Falha=
===Prioridade:===
Desejável 
Retorno de até 5 segundos após alguma falha.
=[NF002] Disponibilidade=
===Prioridade:===
Importante 
O sistema estará disponível 24 horas por dia durante todos os dias do ano.
===4.4 Desempenho===
Esta seção descreve os requisitos não funcionais associados à eficiência, uso de recursos e tempo de resposta do sistema.
=[NF001] Número de Acessos=
O sistema deve ser capaz de atender em média 10 usuários por segundo nos momentos de pico de acesso.
=[NF002] Tempo de Resposta para os Usuários=
O tempo máximo de resposta de uma requisição deve ser de no máximo 10 segundos.

===4.5 Segurança===
Esta seção descreve os requisitos não funcionais associados à integridade, privacidade e autenticidade dos dados do sistema.
=[NF001] Privacidade de Acesso=
Apenas os usuários credenciados e com permissão para acesso a este módulo deverão fazer uso das funcionalidades do módulo de boletos/guias na Web.
===4.6 Hardware e software===
Esta seção descreve os requisitos não funcionais associados ao hardware e software usados para desenvolver ou para executar o sistema.
=[NF001] Linguagem de Implementação=
===Prioridade:===
Essencial 
A linguagem de implementação do módulo de boleto Web será Delphi, mesma linguagem utilizada no desenvolvimento dos sistemas Partidos2000, Receb2000, OAB2000 e Filiados2000.
=[NF002] Banco de Dados=
===Prioridade:===
Essencial 
O banco de dados utilizado será o MySQL.
=[NF003] Ferramentas=
===Prioridade:===
Essencial 
Ferramenta de modelagem: Borland Delphi 2006
Ferramenta de Desenvolvimento: Borland Delphi 2006
=[NF004] Plataforma de Funcionamento=
===Prioridade:===
Essencial 
A plataforma tanto de desenvolvimento e de funcionamento será Windows.

=5 Modelagem do Banco de Dados=

===5.1 Modelo Entidade Relacionamento===
 
[[Arquivo:Caso_de_uso.png]]
===5.2 Dicionário de Dados (tabelas)===
 
[[Arquivo:Tabelas.png]] 
As demais tabelas serão as mesmas já definidas e utilizadas nos sistemas Partidos2000, Receb2000, OAB2000 e Filiados2000.

===5.3 Tabelas da FETAPE (cadastro web)===

=6 Modelagem de Classes=

===6.1 Diagrama de Classes===

[[Arquivo:Diagrama_de_classes.png]]

6.2 Diagrama de Seqüência
6.2.1 [RF001] e [RF011]

[[Arquivo:Diagrama_de_sequencia.png]]

Arquivo:Diagrama de sequencia.png

2013-01-24T14:09:54Z

AnaPaula:

Para uso do Bw- Construindo

2013-01-24T13:56:03Z

AnaPaula: /* 5 Modelagem do Banco de Dados */

Para uso do Bw- Construindo

2013-01-24T13:51:33Z

AnaPaula: /* 5.1 Modelo Entidade Relacionamento */

[[Arquivo:BoletosWeb.PNG]] 

[[Arquivo:Historico_de_revisoes.PNG]] 

=1. Caso de Negócio=
==1.1 Objetivos==

Documentar o novo módulo de geração e impressão de boletos online. As informações aqui descritas especificam e refinam a regras de negócio.

==1.2 Referências==

Se baseará no conhecimento adquirido na implementação de rotinas de boletos da BISA (desktop) e no antigo sistema TRAB_RUR da BISA, em DOS. A entrevista com Mário e Márcio da FETAPE (realizada por Ronaldo e Alexandre) também é referência para a definição dos requisitos.

==1.3 Sistemas com rotinas de gerenciamento de boletos da BISA==

O Filiados 2000 é um sistema desktop de gestão de filiados que controla o cadastro de filiados dos sindicatos de trabalhadores, fazendo acompanhamento de participação na organização.

O OAB 2000 é um software de gestão de cadastro de advogados para OAB's. Faz desde o cadastro de alunos, pré-inscritos, coordena sociedades de advogados, estagiários, até a administração dos dados financeiros dos advogados.

O Receb 2000 é um software voltado para o acompanhamento do contas a receber de uma empresa, fazendo a gestão financeira da carteira de forma simples e eficiente.

Todos esses sistemas possuem uma função de gerenciamento de boletos bancários ou guias sindicais, sendo salvos de forma centralizada no MySQL, de forma que podem ser acessados de forma uniforme no BoletoWEB.

Cada sistema contém suas próprias regras de negócio para gerenciar os boletos; no entanto, as funções de acesso ao banco remoto serão padronizadas para todos os sistemas no BoletoWEB.

==1.4 Descrição do Produto==

A maior parte da implementação é voltada para a FETAPE, enquanto o restante imprime boletos gerados pelos nossos sistema desktop.

Módulo Geral: este módulo tem a função meramente de fornecer uma interface web que permita ao usuário imprimir boletos gerados pelos sistemas desktop da BISA. 

'''Módulo FETAPE:''' no antigo sistema TRAB_RUR da BISA, este sistema é o foco principal desta documentação. Nela o usuário poderá gerenciar todo o fluxo de boletos de contribuições: geração, impressão interna, cadastro de filiados, acesso on-line dos filiados, etc.

==1.5 Contexto de Negócio==

O módulo geral de boletos na web será utilizado a princípio pelos sistemas Receb2000, OAB2000 e Filiados2000, porém poderá ser extendido a qualquer sistema que queira fazer o controle de boletos/guias.

Este módulo concentrará as informações dos boletos em um único local independente de entidade ou sistema. Este local, a priori, ficou definido como sendo um dos servidores internos da BISA que possua acesso externo. Cada sistema rodará normalmente no ambiente do cliente. No momento que for necessário o acesso às informações, este será feito não mais na base local da área do cliente, mas na base remota situada na BISA.

O módulo FETAPE segue as mesmas diretrizes, tendo a diferença de ser implementado exclusivamente para esta entidade, devendo ser adaptável para outras entidades. Para tanto, aconselha-se o uso de uma arquitetura em camadas e padrões de projetos, facilitadores do processos de manutenção.

==1.6 Tecnologias utilizadas==

Os módulos geral e FETAPE deverão implementados utilizando uma tecnologia para web: PHP, Java ou .NET.

O banco de dados necessariamente deverá ser o MySQL, pois já é utilizado na bisa para o registro de boletos.

=2. Sobre os Requisitos=
==2.1 Introdução==

Este documento especifica todos os requisitos funcionais e não funcionais do módulo de gerenciamento de boletos, descrevendo os fluxos de eventos, prioridades, atores, entradas e saídas de cada caso de uso a ser implementado.

A correta interpretação deste documento exige o conhecimento de algumas convenções e termos específicos, que são descritos a seguir.

==2.2 Identificação dos Requisitos==

Por convenção, a referência a requisitos é feita através do nome da subseção onde eles estão descritos, seguidos do identificador do requisito, de acordo com o esquema abaixo:

[nome da subseção, identificador do requisito]

Por exemplo, o requisito funcional [Imprimir Boleto RF002] está descrito em um caso de uso chamado “Imprimir Boleto”, em um bloco identificado pelo identificador [RF002].

==2.3 Prioridades dos Requisitos==

Para estabelecer a prioridade dos requisitos foram adotadas as denominações “essencial”, “importante” e “desejável”. 
• Essencial é o requisito sem o qual o sistema não entra em funcionamento. São requisitos imprescindíveis, que têm que ser implementados. 
• Importante é o requisito sem o qual o sistema entra em funcionamento, mas de forma não satisfatória. Requisitos importantes devem ser implementados, mas, se não forem, o sistema poderá ser implantado e usado mesmo assim. 
• Desejável é o requisito que não compromete as funcionalidades básicas do sistema, isto é, o sistema pode funcionar de forma satisfatória sem ele. Requisitos desejáveis são requisitos que podem ser deixados para versões posteriores do sistema, caso não haja tempo hábil para implementá-los na versão que está sendo especificada. 

==2.4 Descrição dos Atores==

'''Usuário externo'''
É a pessoa que acessa a funcionalidade de impressão de boletos do módulo geral pelo browser.

Filiado FETAPE
Semelhante ao usuário comum, com a diferença de que terá a opção de se cadastrar pelo site.

Funcionário FETAPE
É responsável pelo gerenciamento dos boletos. É o ator principal deste sistema.

=3 Requisitos Funcionais (Casos de Uso)=
==3.1 Ações do Usuário==

==[RF001] Efetuar login==
Atores relacionados
Usuário externo, Filiado FETAPE e Funcionário FETAPE.

===Objetivo===
Fazer login no módulo Web de impressão de boletos.

===Prioridade===
Essencial.

===Entradas e pré condições===
'''Entradas:''' login do usuário e senha;
'''Pré-condições:''' computador deve ter acesso à internet; servidor web disponível.

===Saídas e pós-condições===
'''Saídas:''' não há
'''Pós-condições:''' usuário logado no sistema.

===Fluxo principal de eventos===
1. Usuário executa seu web browser e acessa a página de login (E1, E2); 
2. Usuário informa login e senha e clica em Entrar (E3); 
3. Sistema recupera na base de dados a senha do usuário com o login informado; 
4. Sistema verifica se o login está cadastrado (E4); 
5. Sistema verifica se a senha informada corresponde ao login informado (E5); 
6. Sistema libera o acesso após o sucesso da verificação; 
7. Includes [RF002]. 

===Fluxos de exceção===
• E1: se não houver conexão com a internet, uma mensagem será exibida informando que não é possível estabelecer uma conexão com a internet e solicitando ao usuário que verifique sua conexão; 
• E2: se o sistema não estiver disponível, uma mensagem será exibida informando que o serviço não está disponível e que o usuário deve tentar acessá-lo mais tarde; 
• E3: se o usuário não informar o login ou a senha, o sistema solicita que informe o login e a senha; 
• E4: se o login não estiver cadastrado, o sistema emite uma mensagem de erro informando que este usuário não está cadastrado e solicitando que o mesmo verifique se o login foi digitado corretamente; 
• E5: se a senha não conferir com a que está armazenada na base de dados, o sistema emite uma mensagem de erro avisando que a senha informada está incorreta e solicitando que o mesmo verifique se ela foi digitada corretamente. 

==[RF002] Listar boletos==
===Atores relacionados===
Usuário externo, Filiado FETAPE e Funcionário FETAPE.

===Objetivo===
Listar os boletos correspondentes ao usuário logado.

===Prioridade===
Essencial.

===Entradas e pré condições===
'''Entradas:''' nenhuma.
'''Pré-condições:''' usuário logado no sistema; boletos armazenados no banco de dados.

===Saídas e pós-condições===
'''Saídas:''' lista de boletos.
'''Pós-condições:''' nenhuma.

===Fluxo principal de eventos===
1. Sistema carrega da base de dados os boletos referentes ao usuário (E1, E2, E3); 
2. É exibida a lista de boletos (com check boxes para seleção), cada um com seu número, descrição, valor, vencimento e status (pendente/atrasado/impresso/pago). Os boletos serão ordenados de forma decrescente (maior para o menor) por data de vencimento na lista. Também haverá uma check box que permite a seleção de todos os boletos listados na tela e um limite de boletos a serem exibidos, sendo os demais boletos acessados por uma barra de próximo/anterior (semelhante a um esquema de web mail); 
3. Através de uma caixa de seleção (combo box), o usuário pode filtrar os boletos que serão exibidos na tela de acordo com a opção: “pendentes/impressos/pagos/todos”. Os boletos com status “atrasado” ficarão na lista de “pendentes” e “todos”, mas com uma cor de linha de grid que os diferencie dos demais (ex. vermelho). O status inicial do filtro é “pendentes”. 

===Fluxos de exceção===
• E1: se não houver conexão com a internet, uma mensagem será exibida informando que não é possível estabelecer uma conexão com a internet e solicitando ao usuário que verifique sua conexão; 
• E2: se o sistema não estiver disponível, uma mensagem será exibida informando que o serviço não está disponível e que o usuário deve tentar acessá-lo mais tarde; 
• E3: se o resultado da busca retornar vazio, uma mensagem será exibida informando ao usuário que não existe dados referentes à consulta realizada. 

=[RF003] Geração de boletos=
===Atores relacionados===
Usuário externo, Filiado FETAPE e Funcionário FETAPE.

===Objetivo===
Gerar registros de boletos no banco de dados para impressão. Não constitui a impressão do boleto em si.

===Prioridade===
Essencial.

===Entradas e pré condições===
'''Entradas:''' filiado(s)/usuário(s), banco, data de vencimento, modelo da guia, nosso número inicial, valor e instruções.
'''Pré-condições:''' usuário logado no sistema; sindicatos e filiados armazenados no banco de dados.

===Saídas e pós-condições===
'''Saídas:''' mensagem de aviso de sucesso da operação. 
'''Pós-condições:''' registro dos boletos inseridos no banco de dados.

===Fluxo principal de eventos===
1. Usuário Externo e Filiado FETAPE: usuário clica no botão Gerar Boletos. Se o usuário estiver com o status óbito, não será gerado boleto. Funcionário FETAPE: funcionário seleciona uma quantidade de filiados na tela de Listagem de Filiados e clica no botão Gerar Boletos. Os filiados com o status “óbito” nunca serão carregados; 
2. Sistema carrega o(s) usuários(s)/filiado(s) selecionados com seus respectivos dados (E1, E2, E3, E4); 
3. Uma janela é aberta perguntando se o usuário deseja imprimir boletos referentes a Contribuição Sindical e Contribuição Confederativa (2 check boxes); 
4. Uma tela é aberta onde o usuário informa os dados (banco, data de vencimento, modelo da guia, nosso número inicial, valor e instruções) para os boletos. Usuário confirma a operação; 
5. Sistema valida os dados inseridos pelo usuário e os dados obrigatórios para emissão de boleto (E5, E6); 
6. Sistema gera os boletos e os armazena no banco de dados com o status “gerado” (E7). O sistema deverá verificar se o número de boleto que ele irá gerar existe em algum intervalo na tabela de boletos avulso. Se existir, ele deverá gerar um próximo número que não esteja em um intervalo desta tabela; 
7. Sistema insere os registros de log da situação dos boletos no banco remoto com a justificava “gerado a partir da função de geração de boleto pelo usuário X:Y”, onde X corresponde ao login do funcionário e Y corresponde ao seu nome; 
8. Sistema exibe mensagem confirmando o sucesso na geração dos boletos e perguntando se o usuário deseja fazer a impressão dos mesmos; 
9. Se o usuário responder que sim, a janela de impressão padrão da funcionalidade imprimir é aberta. Includes [RF004]. 

===Filiado FETAPE===
Este usuário também terá acesso à rotina de CANCELAMENTO do boleto, que consiste meramente na exclusão do mesmo da base de dados. Vale salientar que devem ser efetuados os devidos registros no log do sistema seguindo o padrão supracitado, assim como devem ser atendidos os seguintes fluxos de exceção: 
1. Se o boleto possuir o status “pago”, “impresso” ou “enviado” (para o banco), o cancelamento não será permitido. O sistema exibirá uma mensagem de erro avisando que o boleto não pode ser impresso, indicando o seu status atual; 
2. Se o boleto requisitado não puder ser excluído, o sistema exibe uma mensagem de erro solicitando que o boleto não poder ser removido no momento. 

===Fluxos de exceção===
• E1: se não houver conexão com a internet, uma mensagem será exibida informando que não é possível estabelecer uma conexão com a internet e solicitando ao usuário que verifique sua conexão; 
• E2: se o sistema não estiver disponível, uma mensagem será exibida informando que o serviço não está disponível e que o usuário deve tentar acessá-lo mais tarde; 
• E3: se o resultado da busca retornar vazio, uma mensagem será exibida informando ao usuário que não existem dados referentes à consulta realizada; 
• E4: se o sistema não conseguir acessar a base de dados, uma mensagem será exibida informando ao usuário que a base de dados está inacessível; 
• E5: se o usuário não preencher os dados obrigatórios do boleto (banco, data de vencimento, modelo da guia, nosso número inicial e valor), uma mensagem será exibida informando ao usuário que os campos obrigatórios devem ser preenchidos; 
• E6: se os dados obrigatórios do(s) usuário(s)/filiado(s) para emissão de boleto não foram preenchidos (nome, logradouro, bairro, cidade, estado e CEP), o sistema lista na tela os usuário(s)/filiado(s) cujos dados obrigatórios não estão preenchidos e, para cada um, informa quais campos devem ser preenchidos. O usuário poderá prosseguir para a tela de marcação dos boletos que serão impressos (botão “prosseguir”), no entanto os boletos cujos dados não estão completos não aparecerão para seleção; 
• E7: se houver um estouro na numeração de boletos*, o sistema exibe uma mensagem solicitando ao usuário que entre em contato com a BISA pois houve um problema na geração da numeração do boleto. A operação não é finalizada. O sistema deve ainda efetuar todas as rotinas de rollback de modo a não deixar ‘lixo’ no banco de dados. 

<nowiki>*</nowiki> O estouro na numeração de boletos ocorre quando o limite do número de boletos cadastrado no banco de dados é atingido. Por exemplo, supondo um limite de 10 bytes, se o último registro cadastrado for 9999999999, o próximo registro de boleto irá acionar este erro. 

=[RF004] Imprimir boletos=
===Atores relacionados===
Usuário externo, Filiado FETAPE e Funcionário FETAPE.

===Objetivo===
Constitui a impressão de um boleto já gerado no sistema.

===Prioridade===
Essencial.

===Entradas e pré condições===
'''Entradas:''' lista de boletos para impressão. 
'''Pré-condições:''' o usuário deve estar logado no sistema na tela da listagem de boletos (RF002); os registros dos boletos devem estar armazenados no banco de dados e marcados como “não impresso”.

===Saídas e pós-condições===
'''Saídas:''' impressão dos boletos selecionados. 
'''Pós-Condições:''' registros dos boletos marcados no banco como “impresso”.

===Fluxo principal de eventos===
1. Usuário seleciona na Lista de boletos aqueles que deseja imprimir (check box) e clica no botão Imprimir (E1, E2, E3, E4, E5); 
2. Se o usuário houver selecionado apenas um boleto, o sistema imprime o boleto no navegador, permitindo ao usuário conferir seus dados. Depois disso, ele clica em um novo botão Imprimir e passa para o passo 3; 
3. Janela de impressão padrão é aberta (onde o usuário poderá selecionar impressora, quantidade de páginas, etc). Usuário confirma a impressão e o sistema envia os arquivos para a impressora (E6); 
4. Sistema marca no banco os boletos que foram impressos com o status “impresso” (E7); 
5. Sistema insere no log de boletos os registros com o status impresso com a justificativa “impresso pela função de impressão de boletos pelo usuário X:Y”, onde X corresponde ao código do usuário e Y ao seu nome. 
6. Sistema exibe uma mensagem de “Boletos impressos com sucesso”. 

===Fluxos de exceção===
• E1: se não houver conexão com a internet, uma mensagem será exibida informando que não é possível estabelecer uma conexão com a internet e solicitando ao usuário que verifique sua conexão; 
• E2: se o sistema não estiver disponível, uma mensagem será exibida informando que o serviço não está disponível e que o usuário deve tentar acessá-lo mais tarde; 
• E3: se o usuário não selecionar boletos, o sistema exibe uma mensagem solicitando ao usuário que selecione boletos para impressão; 
• E4: se na lista houver boletos que já foram pagos, o sistema exibe uma mensagem de erro informando que boletos pagos não podem ser reimpressos e cancela a operação; 
• E5: se houver boletos que já foram impressos, o sistema exibe um alerta informando que os boletos já foram impressos pelo sistema e serão reimpressos nesta operação; continua a executar normalmente; 
• E6: se houver um erro ao enviar os dados para a impressora, o sistema exibe uma mensagem avisando ao usuário que o sistema não conseguiu imprimir e solicitando que o mesmo verifique se a impressora está pronta para impressão; 
• E7: se houver um erro na alteração dos registros no banco de dados, uma mensagem será exibida informando que não foi possível marcar os boletos como impressos e solicitando ao usuário que tente novamente e que, caso o erro persista, entre em contato com a BISA. O sistema deve ainda efetuar todas as rotinas de rollback de modo a não deixar ‘lixo’ no banco de dados. 

=[RF005] Cadastro de filiado=
===Atores relacionados===
Filiado FETAPE e Funcionário FETAPE.

===Objetivo===
Cadastrar um filiado. As rotinas de ALTERAÇÃO e de EXCLUSÃO também estão contidas neste requisito para o Funcionário FETAPE.

===Prioridade===
Essencial.

===Entradas e pré condições===
'''Entradas:''' dados cadastrais do usuário. 
'''Pré-condições:''' computador deve ter acesso à internet; servidor web disponível. Funcionário: usuário cadastrado no sistema. 

===Saídas e pós-condições===
'''Saídas:''' mensagem avisando que o usuário foi cadastrado com sucesso. 
'''Pós-Condições:''' usuário cadastrado no banco de dados. 

===Fluxo principal de eventos===
1. Ator Filiado: a função “Cadastrar Filiado” é acionada pelo usuário no navegador web (E1, E2). Ator Funcionário: a função “Cadastrar Filiado” é acionada pelo usuário na tela de Listagem de Filiados (E1, E2). 
2. Um formulário é aberto solicitando dados cadastrais: login, senha, nome, CPF, CNAE, bairro, cidade, UF, logradouro, CEP, categoria (seleção entre as opções arrendatário, assentado, meeiro, parceiro, posseiro, pequeno proprietário e outros) e apelido do filiado; 
3. Usuário preenche os campos e confirma a operação (E3, E4, E5, E6); 
4. Sistema insere os registros de log da situação no banco remoto com a justificava “cadastrado pelo usuário X:Y”, onde X corresponde ao login do usuário e Y corresponde ao seu nome; 
5. Sistema retorna uma mensagem avisando que o usuário foi cadastrado com sucesso. 

O sistema também apresenta as rotinas de ALTERAÇÃO, que por ser trivial e seguir um fluxo semelhante à rotina de inclusão não terá sua execução descrita aqui. Vale salientar que devem ser efetuados os devidos registros no log do sistema. 

===Filiado FETAPE===
Ele possui também a funcionalidade EXCLUSÃO. Sua tela de ALTERAR é diferente. Nela, o usuário pode marcar um check box “óbito” para filiados que foram a óbito.

===Fluxos de exceção===
• E1: se não houver conexão com a internet, uma mensagem será exibida informando que não é possível estabelecer uma conexão com a internet e solicitando ao usuário que verifique sua conexão; 
• E2: se o sistema não estiver disponível, uma mensagem será exibida informando que o serviço não está disponível e que o usuário deve tentar acessá-lo mais tarde; 
• E3: se o login fornecido já estiver cadastrado no sistema, uma mensagem será exibida informando ao usuário que o login cadastrado já existe no sistema; 
• E4: se o CPF do filiado for inválido, uma mensagem será exibida informando ao usuário que o CPF cadastrado é inválido. Vale salientar que o preenchimento deste campo é opcional; 
• E5: se houver um erro na inserção dos registros no banco de dados, uma mensagem será exibida informando que não foi possível inserir os dados e solicitando ao usuário que tente novamente e que, caso o erro persista, entre em contato com a BISA. O sistema deve ainda efetuar todas as rotinas de rollback de modo a não deixar ‘lixo’ no banco de dados; 
• E6: se os dados obrigatórios dos filiados não forem preenchidos (nome, logradouro, bairro, cidade, estado e CEP), o sistema emite uma mensagem de erro informando quais os campos obrigatórios não foram preenchidos. 

=[RF006] Listar filiados=
===Atores relacionados===
Funcionário FETAPE.

===Objetivo===
Listar todos os filiados cadastrados no sistema.

===Prioridade===
Essencial.

===Entradas e pré condições===
'''Entradas:''' nenhuma.
'''Pré-condições:''' usuário logado no sistema; filiados armazenados no banco de dados.

===Saídas e pós-condições===
'''Saídas:''' lista de filiados. 
'''Pós-condições:''' nenhuma. 

===Fluxo principal de eventos===
1. Usuário clica no botão Filiados da barra de funções do sistema para acessar a Listagem de Filiados; 
2. Sistema carrega da base de dados os filiados com seus respectivos dados (E1, E2, E3, E4); 
3. É exibida a lista de filiados (com check boxes para seleção), cada um com seu número, nome, apelido, CPF, município, sindicato e categoria. Os filiados serão ordenados por ordem alfabética e agrupados por município. Também haverá uma check box que permite a seleção de todos os filiados listados na tela e um limite de filiados a serem exibidos, sendo os demais acessados por uma barra de próximo/anterior (semelhante a um esquema de web mail); 
4. Através de uma caixa de seleção (combo box), o usuário pode filtrar os filiados que serão exibidos na tela de acordo com a opção: “nome/apelido/município/sindicato”. A opção “nome” é a padrão. Os filiados que foram a óbito serão exibidos com uma cor de linha de grid acinzentada e só serão exibidos se um check box “todos” for ativado. 

===Fluxos de exceção===
• E1: se não houver conexão com a internet, uma mensagem será exibida informando que não é possível estabelecer uma conexão com a internet e solicitando ao usuário que verifique sua conexão; 
• E2: se o sistema não estiver disponível, uma mensagem será exibida informando que o serviço não está disponível e que o usuário deve tentar acessá-lo mais tarde; 
• E3: se o resultado da busca retornar vazio, uma mensagem será exibida informando ao usuário que não existem dados referentes à consulta realizada; 
• E4: se o sistema não conseguir acessar a base de dados, uma mensagem será exibida informando ao usuário que a base de dados está inacessível. 

=[RF007] Cadastro de sindicato=
===Atores relacionados===
Funcionário FETAPE.

===Objetivo===
Cadastrar um sindicato. As rotinas de ALTERAÇÃO e de EXCLUSÃO também estão contidas neste requisito.

===Prioridade===
Essencial.

===Entradas e pré condições===
'''Entradas:''' dados do sindicato; dados do Município (já presentes na base de dados, herdada do antigo sistema DOS TRAB_RUR). 
'''Pré-condições:''' usuário logado no sistema. 

===Saídas e pós-condições===
'''Saídas:''' mensagem avisando que o sindicato foi cadastrado com sucesso. 
'''Pós-Condições:''' sindicato cadastrado no banco de dados. 

Fluxo principal de eventos
1. Usuário clica no botão cadastrar na tela de Listagem de Sindicatos (E1, E2); 
2. Um formulário é aberto solicitando dados cadastrais: nome, município, UF, endereço; 
3. Usuário preenche os campos e confirma a operação (E3); 
4. Sistema insere os registros de log da situação no banco remoto com a justificava “cadastrado pelo usuário X:Y”, onde X corresponde ao login do funcionário e Y corresponde ao seu nome; 
5. Sistema retorna uma mensagem avisando que o sindicato foi cadastrado com sucesso. 

Também haverá rotinas de alteração e de exclusão. O processo é trivial para ser descrito aqui. Vale salientar que devem ser efetuados os devidos registros no log do sistema. 

===Fluxos de exceção===
• E1: se não houver conexão com a internet, uma mensagem será exibida informando que não é possível estabelecer uma conexão com a internet e solicitando ao usuário que verifique sua conexão; 
• E2: se o sistema não estiver disponível, uma mensagem será exibida informando que o serviço não está disponível e que o usuário deve tentar acessá-lo mais tarde; 
• E3: se houver um erro na inserção dos registros no banco de dados, uma mensagem será exibida informando que não foi possível inserir os dados e solicitando ao usuário que tente novamente e que, caso o erro persista, entre em contato com a BISA. O sistema deve ainda efetuar todas as rotinas de rollback de modo a não deixar ‘lixo’ no banco de dados; 

=[RF008] Listar sindicatos=
===Atores relacionados===
Funcionário FETAPE.

===Objetivo===
Listar todos os sindicatos cadastrados no sistema.

===Prioridade===
Essencial.

===Entradas e pré condições===
'''Entradas:''' nenhuma. 
'''Pré-condições:''' usuário logado no sistema; sindicatos armazenados no banco de dados. 

===Saídas e pós-condições===
'''Saídas:''' lista de sindicatos. 
'''Pós-condições:''' nenhuma. 

===Fluxo principal de eventos===
1. Usuário clica no botão Sindicatos da barra de funções do sistema para acessar a Listagem de Sindicatos; 
2. Sistema carrega da base de dados os sindicatos com seus respectivos dados (E1, E2, E3, E4); 
3. É exibida a lista de sindicatos (com check boxes para seleção), cada um com seu número, nome e município. Os sindicatos serão ordenados por ordem alfabética e agrupados por município. Também haverá uma check box que permite a seleção de todos os sindicatos listados na tela e um limite de sindicatos a serem exibidos, sendo os demais acessados por uma barra de próximo/anterior (semelhante a um esquema de web mail); 
4. Através de uma caixa de seleção (combo box), o usuário pode filtrar os sindicatos que serão exibidos na tela de acordo com a opção: “nome/município”. A opção “nome” é a padrão. 

===Fluxos de exceção===
• E1: se não houver conexão com a internet, uma mensagem será exibida informando que não é possível estabelecer uma conexão com a internet e solicitando ao usuário que verifique sua conexão; 
• E2: se o sistema não estiver disponível, uma mensagem será exibida informando que o serviço não está disponível e que o usuário deve tentar acessá-lo mais tarde; 
• E3: se o resultado da busca retornar vazio, uma mensagem será exibida informando ao usuário que não existem dados referentes à consulta realizada; 
• E4: se o sistema não conseguir acessar a base de dados, uma mensagem será exibida informando ao usuário que a base de dados está inacessível. 

===[RF009] Baixar Boleto===
===Atores relacionados===
Funcionário FETAPE.

===Objetivo===
Baixa nos boletos que foram impressos. Eles passarão a ter o status de pago.

===Prioridade===
Essencial.

===Entradas e pré condições===
'''Entradas:''' lista de boletos para baixa.
'''Pré-condições:''' usuário logado no sistema; os registros dos boletos devem estar armazenados no banco de dados.

===Saídas e pós-condições===
'''Saídas:''' mensagem de aviso de sucesso da operação. 
'''Pós-condições:''' registro dos boletos marcados no banco como “pagos”. 

===Fluxo principal de eventos===
1. Usuário seleciona na Lista de boletos aqueles que deseja baixar (check box) e clica no botão Baixar (E1, E2, E3, E4, E5); 
2. Sistema marca no banco os boletos como pagos (E6). Se o boleto não for encontrado na tabela de boletos, deverá ser procurado na tabela de boletos avulsos (E7); 
3. Sistema insere no log de boletos os registros com o status impresso com a justificativa “baixado pela função de baixar de boletos pelo usuário X:Y”, onde X corresponde ao código do usuário e Y ao seu nome; 
4. Sistema exibe uma mensagem de “Boletos baixados com sucesso”. 

===Fluxos de exceção===
• E1: se não houver conexão com a internet, uma mensagem será exibida informando que não é possível estabelecer uma conexão com a internet e solicitando ao usuário que verifique sua conexão; 
• E2: se o sistema não estiver disponível, uma mensagem será exibida informando que o serviço não está disponível e que o usuário deve tentar acessá-lo mais tarde; 
• E3: se o usuário não selecionar boletos, o sistema exibe uma mensagem solicitando ao usuário que selecione boletos para impressão; 
• E4: se na lista houver boletos com o status “pago”, o sistema exibe uma mensagem informando que boletos selecionados já foram baixados. Se o usuário clicar em continuar, o sistema continua a execução e ignora esses boletos; 
• E5: se na lista houver boletos com o status diferente de “impresso” ou “enviado” (enviado para o banco), o sistema exibe uma mensagem informando que há boletos selecionados que ainda não foram impressos ou enviados para o banco e quais são estes boletos. Se o usuário clicar em continuar, o sistema continua a execução e ignora esses boletos; 
• E6: se houver um erro na alteração dos registros no banco de dados, uma mensagem será exibida informando que não foi possível marcar os boletos como pagos e solicitando ao usuário que tente novamente e que, caso o erro persista, entre em contato com a BISA. O sistema deve ainda efetuar todas as rotinas de rollback de modo a não deixar ‘lixo’ no banco de dados; 
• E7: se o registro do boleto não for encontrado no banco, o sistema exibirá uma mensagem de erro indicando que o boleto não foi encontrado na base de dados do sistema. 

=[RF010] Baixar Boleto Automaticamente (via Arquivo de Retorno do Banco)=
===Atores relacionados===
Funcionário FETAPE.

===Objetivo===
Baixar de boletos a partir de um arquivo de retorno que o banco envia.

===Prioridade===
Essencial.

===Entradas e pré condições===
'''Entradas:''' arquivo de retorno do banco. 
'''Pré-condições:''' usuário logado no sistema; os registros dos boletos devem estar armazenados no banco de dados. 

===Saídas e pós-condições===
'''Saídas:''' mensagem de sucesso da operação. 
'''Pós-condições:''' registro dos boletos marcados no banco como “pagos”. 

===Fluxo principal de eventos===
1. Na tela da Lista de boletos, usuário clica na opção Baixa com Arquivo do Banco (E1, E2); 
2. Uma tela é aberta perguntando qual o arquivo de retorno do banco. O usuário então seleciona o caminho no seu computador correspondente à localização do arquivo e clica em OK. O sistema irá, então, fazer o upload do arquivo (E3, E4, E5); 
3. Sistema guarda a identificação do arquivo de retorno com situação de ‘não processado’ na base de dados e guarda uma cópia do arquivo em diretório especifico para histórico; 
4. Para cada linha do arquivo de retorno, o sistema procura o boleto referente na base de dados de boletos de contribuição. Se o boleto não for encontrado, o sistema procura na base de dados de boletos avulsos. Nesta base, há registros de boletos com intervalos (ex. de 001 a 100). O sistema irá buscar o número do boleto nessa faixa (E6); 
5. O sistema verifica se o boleto encontrado está marcado como “impresso” ou “enviado” (para o banco). Se estiver, o sistema marca no banco de dados o boleto como “pago” (E7); 
6. O sistema insere no log de boletos o registro com situação de “pago” com a justificativa ‘baixado pela função de baixa automática de boleto pelo usuário X:Y’, onde X corresponde ao login de usuário e Y corresponde ao seu nome; 
7. O Sistema marca o arquivo de retorno como ‘processado sem erros’ e uma exibe mensagem confirmando o sucesso na baixa dos boletos. 

===Fluxos de exceção===
• E1: se não houver conexão com a internet, uma mensagem será exibida informando que não é possível estabelecer uma conexão com a internet e solicitando ao usuário que verifique sua conexão; 
• E2: se o sistema não estiver disponível, uma mensagem será exibida informando que o serviço não está disponível e que o usuário deve tentar acessá-lo mais tarde; 
• E3: se o usuário não apontar nenhum arquivo de retorno, uma mensagem será exibida exigindo que o usuário aponte o arquivo; 
• E4: se o caminho para o arquivo estiver incorreto, o sistema exibe uma mensagem para o usuário informando que o caminho selecionado é inválido; 
• E5: se o formato do arquivo não corresponder ao formato do arquivo de retorno do banco esperado, o sistema exibirá uma mensagem informando que o formato do arquivo selecionado é inválido; 
• E6: se um registro do arquivo não for encontrado no sistema (base principal e base de boletos avulsos), será exibido numa tela todos os registros que não foram encontrados. A situação do arquivo de retorno no banco deve então mudar para “processado com erro” e o sistema deve inserir o registro de log de boleto com a justificativa “boleto não pode ser baixado, pois o mesmo não foi encontrado no sistema. Ação executada pelo usuário X:Y”, onde X é o login e Y é o nome. O valor do boleto pago e não encontrado deverá ser armazenado na tabela de boletos no registro cujo identificador é “BoletoXXXX”. Todo boleto que não for encontrado deverá ser somado ao valor desse registro; 
• E7: se houver um erro na alteração dos registros no banco de dados, uma mensagem será exibida informando que não foi possível marcar os boletos como “pago” e solicitando ao usuário que tente novamente e que, caso o erro persista, entre em contato com a BISA. O sistema deve ainda efetuar todas as rotinas de rollback de modo a não deixar ‘lixo’ no banco de dados. 

=[RF011] Gerar arquivo de remessa para banco=
===Atores relacionados===
===Funcionário FETAPE.===

===Objetivo===
Gerar arquivo de remessa de boletos para o banco.

===Prioridade===
Essencial.

===Entradas e pré condições===
'''Entradas:''' lista de boletos que serão enviados para o arquivo. 
'''Pré-condições:''' usuário logado no sistema; os registros dos boletos devem estar armazenados no banco de dados com o status “gerado” ou “impresso”. 

===Saídas e pós-condições===
'''Saídas:''' mensagem de sucesso da operação; arquivo de remessa para o banco. 
'''Pós-condições:''' boletos marcados com o status “enviado” no banco na base de dados. 

===Fluxo principal de eventos===
1. Na tela de Listagem de Boletos, o usuário seleciona os boletos e clica no botão Gerar de arquivo de remessa (E1, E2); 
2. Sistema verifica se todos os boletos selecionados estão marcados como “gerado” ou “impresso” (E3); 
3. Sistema abre tela para que o usuário informe o nome do arquivo e o local onde ele será gerado (E4, E5); 
4. Usuário confirma a geração do arquivo; 
5. Sistema gera o arquivo de remessa; 
6. Sistema marca no banco os boletos que foram inseridos no arquivo de remessa com o status de “enviado” para o banco (E6); 
7. Sistema insere no log de boletos os registros com situação de enviado com a justificativa “boleto gerado no arquivo de remessa para o banco pelo usuário X:Y”, onde X corresponde ao login do usuário e Y corresponde ao seu nome; 
8. Sistema salva em diretório especifico no banco uma cópia do arquivo gerado para remessa para fins de histórico; 
9. Sistema retorna o arquivo de remessa para que o usuário salve-o em seu computador. 

===Fluxos de exceção===
• E1: se não houver conexão com a internet, uma mensagem será exibida informando que não é possível estabelecer uma conexão com a internet e solicitando ao usuário que verifique sua conexão; 
• E2: se o sistema não estiver disponível, uma mensagem será exibida informando que o serviço não está disponível e que o usuário deve tentar acessá-lo mais tarde; 
• E3: se o sistema não encontrar nenhum arquivo com o status “gerado” ou “impresso”, uma mensagem será exibida informando que não existem boletos a serem gerados para o arquivo de remessa. Se encontrar, deverá informar quais os boletos não serão gerados no arquivo; 
• E4: se o usuário informa um local não existente, o sistema pergunta ao usuário se o mesmo deseja que o sistema crie o diretório de pastas informado. Se a resposta for sim, sistema cria diretório de pasta; se a resposta for não, sistema retorna a tela de informação do local para que o usuário selecione um novo diretório; 
• E5: se houver um erro na geração do arquivo de remessa, uma mensagem será exibida informando ao usuário que o arquivo de remessa não pode ser gerado e que o mesmo tente novamente e que, caso o erro persista, entre em contato com a BISA.; 
• E6: se houver um erro na alteração dos registros no banco de dados, uma mensagem será exibida informando que não foi possível marcar os boletos como “enviado” e solicitando ao usuário que tente novamente e que, caso o erro persista, entre em contato com a BISA. O sistema deve ainda efetuar todas as rotinas de rollback de modo a não deixar ‘lixo’ no banco de dados. 

=[RF012] Gerar arquivo de remessa para Gráfica=
===Atores relacionados===
Funcionário FETAPE.

===Objetivo===
Gerar arquivo de remessa de boletos para Gráfica.

===Prioridade===
Essencial.

===Entradas e pré condições===
'''Entradas:''' lista de boletos que serão enviados para o arquivo. 
'''Pré-condições:''' usuário logado no sistema; os registros dos boletos devem estar armazenados no banco de dados com o status “gerado”.

===Saídas e pós-condições===
'''Saídas:''' mensagem de sucesso da operação; arquivo de remessa para a gráfica (em formato txt e xls). 
'''Pós-condições:''' boletos marcados com o status “enviadoGrafica” no banco na base de dados. 

===Fluxo principal de eventos===
1. Na tela de Listagem de Boletos, o usuário seleciona os boletos e clica no botão Gerar arquivo de boleto para Gráfica (E1, E2); 
2. Sistema verifica se todos os boletos selecionados estão marcados como “gerado” (E3); 
3. Sistema abre tela para que o usuário informe o nome do arquivo e o local onde ele será gerado (E4, E5); 
4. Usuário confirma a geração do arquivo; 
5. Sistema pergunta se o usuário quer gerar o arquivo no formato txt ou xls; 
6. Sistema gera o arquivo de remessa para Gráfica; 
7. Sistema marca no banco os boletos que foram inseridos no arquivo de remessa com o status de “enviadoGrafica” para o banco (E6); 
8. Sistema insere no log de boletos os registros com situação de enviado com a justificativa “boleto gerado no arquivo de remessa para Gráfica pelo usuário X:Y”, onde X corresponde ao login do usuário e Y corresponde ao seu nome; 
9. Sistema salva em diretório especifico no banco uma cópia do arquivo gerado para remessa para Gráfica para fins de histórico; 
10. Sistema retorna o arquivo para que o usuário salve-o em seu computador. 

===Fluxos de exceção===
• E1: se não houver conexão com a internet, uma mensagem será exibida informando que não é possível estabelecer uma conexão com a internet e solicitando ao usuário que verifique sua conexão; 
• E2: se o sistema não estiver disponível, uma mensagem será exibida informando que o serviço não está disponível e que o usuário deve tentar acessá-lo mais tarde; 
• E3: se o sistema não encontrar nenhum arquivo com o status “gerado”, uma mensagem será exibida informando que não existem boletos a serem gerados para o arquivo de remessa. Se encontrar, deverá informar quais os boletos não serão gerados no arquivo; 
• E4: se o usuário informa um local não existente, o sistema pergunta ao usuário se o mesmo deseja que o sistema crie o diretório de pastas informado. Se a resposta for sim, sistema cria diretório de pasta; se a resposta for não, sistema retorna a tela de informação do local para que o usuário selecione um novo diretório; 
• E5: se houver um erro na geração do arquivo de remessa, uma mensagem será exibida informando ao usuário que o arquivo de remessa não pode ser gerado e que o mesmo tente novamente e que, caso o erro persista, entre em contato com a BISA; 
• E6: se houver um erro na alteração dos registros no banco de dados, uma mensagem será exibida informando que não foi possível marcar os boletos como “enviado” e solicitando ao usuário que tente novamente e que, caso o erro persista, entre em contato com a BISA. O sistema deve ainda efetuar todas as rotinas de rollback de modo a não deixar ‘lixo’ no banco de dados. 

=4 Especificações Suplementares=
===4.1 Objetivos===
Este documento tem como finalidade especificar todos os requisitos não funcionais do módulo de boletos web divididos em requisitos de usabilidade, confiabilidade, desempenho, segurança, distribuição, adequação a padrões e requisitos de hardware e software.
===4.2 Usabilidade===
Esta seção descreve os requisitos não funcionais associados à facilidade de uso da interface com o usuário, material de treinamento e documentação do sistema.
=[NF001] Interface com o Usuário=
===Prioridade:===
Desejável 
O sistema deve possuir uma interface amigável, simples e intuitiva.
===4.3 Confiabilidade===
Esta seção descreve os requisitos não funcionais associados à freqüência, severidade de falhas do sistema e habilidade de recuperação das mesmas, bem como a corretude do sistema.

=[NF001] Tempo de Retorno após Falha=
===Prioridade:===
Desejável 
Retorno de até 5 segundos após alguma falha.
=[NF002] Disponibilidade=
===Prioridade:===
Importante 
O sistema estará disponível 24 horas por dia durante todos os dias do ano.
===4.4 Desempenho===
Esta seção descreve os requisitos não funcionais associados à eficiência, uso de recursos e tempo de resposta do sistema.
=[NF001] Número de Acessos=
O sistema deve ser capaz de atender em média 10 usuários por segundo nos momentos de pico de acesso.
=[NF002] Tempo de Resposta para os Usuários=
O tempo máximo de resposta de uma requisição deve ser de no máximo 10 segundos.

===4.5 Segurança===
Esta seção descreve os requisitos não funcionais associados à integridade, privacidade e autenticidade dos dados do sistema.
=[NF001] Privacidade de Acesso=
Apenas os usuários credenciados e com permissão para acesso a este módulo deverão fazer uso das funcionalidades do módulo de boletos/guias na Web.
===4.6 Hardware e software===
Esta seção descreve os requisitos não funcionais associados ao hardware e software usados para desenvolver ou para executar o sistema.
=[NF001] Linguagem de Implementação=
===Prioridade:===
Essencial 
A linguagem de implementação do módulo de boleto Web será Delphi, mesma linguagem utilizada no desenvolvimento dos sistemas Partidos2000, Receb2000, OAB2000 e Filiados2000.
=[NF002] Banco de Dados=
===Prioridade:===
Essencial 
O banco de dados utilizado será o MySQL.
=[NF003] Ferramentas=
===Prioridade:===
Essencial 
Ferramenta de modelagem: Borland Delphi 2006
Ferramenta de Desenvolvimento: Borland Delphi 2006
=[NF004] Plataforma de Funcionamento=
===Prioridade:===
Essencial 
A plataforma tanto de desenvolvimento e de funcionamento será Windows.

=5 Modelagem do Banco de Dados=

===5.1 Modelo Entidade Relacionamento===

[[Arquivo:Caso_de_uso.png]]
===5.2 Dicionário de Dados (tabelas)===

[[Arquivo:Tabelas.png]]

As demais tabelas serão as mesmas já definidas e utilizadas nos sistemas Partidos2000, Receb2000, OAB2000 e Filiados2000.

===5.3 Tabelas da FETAPE (cadastro web)===

=6 Modelagem de Classes=

===6.1 Diagrama de Classes===

[[Arquivo:Diagrama_de_classes.png]]

Arquivo:Diagrama de classes.png

2013-01-24T13:51:15Z

AnaPaula:

Arquivo:Tabelas.png

2013-01-24T13:50:05Z

AnaPaula:

Para uso do Bw- Construindo

2013-01-24T13:30:01Z

AnaPaula:

Arquivo:Caso de uso.png

2013-01-24T13:29:35Z

AnaPaula:

Para uso do Bw- Construindo

2013-01-24T13:22:08Z

AnaPaula:

Para uso do Bw- Construindo

2013-01-24T13:19:39Z

AnaPaula: /* [NF001] Interface com o Usuário */

[[Arquivo:BoletosWeb.PNG]] 

[[Arquivo:Historico_de_revisoes.PNG]] 

=1. Caso de Negócio=
==1.1 Objetivos==

Documentar o novo módulo de geração e impressão de boletos online. As informações aqui descritas especificam e refinam a regras de negócio.

==1.2 Referências==

Se baseará no conhecimento adquirido na implementação de rotinas de boletos da BISA (desktop) e no antigo sistema TRAB_RUR da BISA, em DOS. A entrevista com Mário e Márcio da FETAPE (realizada por Ronaldo e Alexandre) também é referência para a definição dos requisitos.

==1.3 Sistemas com rotinas de gerenciamento de boletos da BISA==

O Filiados 2000 é um sistema desktop de gestão de filiados que controla o cadastro de filiados dos sindicatos de trabalhadores, fazendo acompanhamento de participação na organização.

O OAB 2000 é um software de gestão de cadastro de advogados para OAB's. Faz desde o cadastro de alunos, pré-inscritos, coordena sociedades de advogados, estagiários, até a administração dos dados financeiros dos advogados.

O Receb 2000 é um software voltado para o acompanhamento do contas a receber de uma empresa, fazendo a gestão financeira da carteira de forma simples e eficiente.

Todos esses sistemas possuem uma função de gerenciamento de boletos bancários ou guias sindicais, sendo salvos de forma centralizada no MySQL, de forma que podem ser acessados de forma uniforme no BoletoWEB.

Cada sistema contém suas próprias regras de negócio para gerenciar os boletos; no entanto, as funções de acesso ao banco remoto serão padronizadas para todos os sistemas no BoletoWEB.

==1.4 Descrição do Produto==

A maior parte da implementação é voltada para a FETAPE, enquanto o restante imprime boletos gerados pelos nossos sistema desktop.

Módulo Geral: este módulo tem a função meramente de fornecer uma interface web que permita ao usuário imprimir boletos gerados pelos sistemas desktop da BISA. 

'''Módulo FETAPE:''' no antigo sistema TRAB_RUR da BISA, este sistema é o foco principal desta documentação. Nela o usuário poderá gerenciar todo o fluxo de boletos de contribuições: geração, impressão interna, cadastro de filiados, acesso on-line dos filiados, etc.

==1.5 Contexto de Negócio==

O módulo geral de boletos na web será utilizado a princípio pelos sistemas Receb2000, OAB2000 e Filiados2000, porém poderá ser extendido a qualquer sistema que queira fazer o controle de boletos/guias.

Este módulo concentrará as informações dos boletos em um único local independente de entidade ou sistema. Este local, a priori, ficou definido como sendo um dos servidores internos da BISA que possua acesso externo. Cada sistema rodará normalmente no ambiente do cliente. No momento que for necessário o acesso às informações, este será feito não mais na base local da área do cliente, mas na base remota situada na BISA.

O módulo FETAPE segue as mesmas diretrizes, tendo a diferença de ser implementado exclusivamente para esta entidade, devendo ser adaptável para outras entidades. Para tanto, aconselha-se o uso de uma arquitetura em camadas e padrões de projetos, facilitadores do processos de manutenção.

==1.6 Tecnologias utilizadas==

Os módulos geral e FETAPE deverão implementados utilizando uma tecnologia para web: PHP, Java ou .NET.

O banco de dados necessariamente deverá ser o MySQL, pois já é utilizado na bisa para o registro de boletos.

=2. Sobre os Requisitos=
==2.1 Introdução==

Este documento especifica todos os requisitos funcionais e não funcionais do módulo de gerenciamento de boletos, descrevendo os fluxos de eventos, prioridades, atores, entradas e saídas de cada caso de uso a ser implementado.

A correta interpretação deste documento exige o conhecimento de algumas convenções e termos específicos, que são descritos a seguir.

==2.2 Identificação dos Requisitos==

Por convenção, a referência a requisitos é feita através do nome da subseção onde eles estão descritos, seguidos do identificador do requisito, de acordo com o esquema abaixo:

[nome da subseção, identificador do requisito]

Por exemplo, o requisito funcional [Imprimir Boleto RF002] está descrito em um caso de uso chamado “Imprimir Boleto”, em um bloco identificado pelo identificador [RF002].

==2.3 Prioridades dos Requisitos==

Para estabelecer a prioridade dos requisitos foram adotadas as denominações “essencial”, “importante” e “desejável”. 
• Essencial é o requisito sem o qual o sistema não entra em funcionamento. São requisitos imprescindíveis, que têm que ser implementados. 
• Importante é o requisito sem o qual o sistema entra em funcionamento, mas de forma não satisfatória. Requisitos importantes devem ser implementados, mas, se não forem, o sistema poderá ser implantado e usado mesmo assim. 
• Desejável é o requisito que não compromete as funcionalidades básicas do sistema, isto é, o sistema pode funcionar de forma satisfatória sem ele. Requisitos desejáveis são requisitos que podem ser deixados para versões posteriores do sistema, caso não haja tempo hábil para implementá-los na versão que está sendo especificada. 

==2.4 Descrição dos Atores==

'''Usuário externo'''
É a pessoa que acessa a funcionalidade de impressão de boletos do módulo geral pelo browser.

Filiado FETAPE
Semelhante ao usuário comum, com a diferença de que terá a opção de se cadastrar pelo site.

Funcionário FETAPE
É responsável pelo gerenciamento dos boletos. É o ator principal deste sistema.

=3 Requisitos Funcionais (Casos de Uso)=
==3.1 Ações do Usuário==

==[RF001] Efetuar login==
Atores relacionados
Usuário externo, Filiado FETAPE e Funcionário FETAPE.

===Objetivo===
Fazer login no módulo Web de impressão de boletos.

===Prioridade===
Essencial.

===Entradas e pré condições===
'''Entradas:''' login do usuário e senha;
'''Pré-condições:''' computador deve ter acesso à internet; servidor web disponível.

===Saídas e pós-condições===
'''Saídas:''' não há
'''Pós-condições:''' usuário logado no sistema.

===Fluxo principal de eventos===
1. Usuário executa seu web browser e acessa a página de login (E1, E2); 
2. Usuário informa login e senha e clica em Entrar (E3); 
3. Sistema recupera na base de dados a senha do usuário com o login informado; 
4. Sistema verifica se o login está cadastrado (E4); 
5. Sistema verifica se a senha informada corresponde ao login informado (E5); 
6. Sistema libera o acesso após o sucesso da verificação; 
7. Includes [RF002]. 

===Fluxos de exceção===
• E1: se não houver conexão com a internet, uma mensagem será exibida informando que não é possível estabelecer uma conexão com a internet e solicitando ao usuário que verifique sua conexão; 
• E2: se o sistema não estiver disponível, uma mensagem será exibida informando que o serviço não está disponível e que o usuário deve tentar acessá-lo mais tarde; 
• E3: se o usuário não informar o login ou a senha, o sistema solicita que informe o login e a senha; 
• E4: se o login não estiver cadastrado, o sistema emite uma mensagem de erro informando que este usuário não está cadastrado e solicitando que o mesmo verifique se o login foi digitado corretamente; 
• E5: se a senha não conferir com a que está armazenada na base de dados, o sistema emite uma mensagem de erro avisando que a senha informada está incorreta e solicitando que o mesmo verifique se ela foi digitada corretamente. 

==[RF002] Listar boletos==
===Atores relacionados===
Usuário externo, Filiado FETAPE e Funcionário FETAPE.

===Objetivo===
Listar os boletos correspondentes ao usuário logado.

===Prioridade===
Essencial.

===Entradas e pré condições===
'''Entradas:''' nenhuma.
'''Pré-condições:''' usuário logado no sistema; boletos armazenados no banco de dados.

===Saídas e pós-condições===
'''Saídas:''' lista de boletos.
'''Pós-condições:''' nenhuma.

===Fluxo principal de eventos===
1. Sistema carrega da base de dados os boletos referentes ao usuário (E1, E2, E3); 
2. É exibida a lista de boletos (com check boxes para seleção), cada um com seu número, descrição, valor, vencimento e status (pendente/atrasado/impresso/pago). Os boletos serão ordenados de forma decrescente (maior para o menor) por data de vencimento na lista. Também haverá uma check box que permite a seleção de todos os boletos listados na tela e um limite de boletos a serem exibidos, sendo os demais boletos acessados por uma barra de próximo/anterior (semelhante a um esquema de web mail); 
3. Através de uma caixa de seleção (combo box), o usuário pode filtrar os boletos que serão exibidos na tela de acordo com a opção: “pendentes/impressos/pagos/todos”. Os boletos com status “atrasado” ficarão na lista de “pendentes” e “todos”, mas com uma cor de linha de grid que os diferencie dos demais (ex. vermelho). O status inicial do filtro é “pendentes”. 

===Fluxos de exceção===
• E1: se não houver conexão com a internet, uma mensagem será exibida informando que não é possível estabelecer uma conexão com a internet e solicitando ao usuário que verifique sua conexão; 
• E2: se o sistema não estiver disponível, uma mensagem será exibida informando que o serviço não está disponível e que o usuário deve tentar acessá-lo mais tarde; 
• E3: se o resultado da busca retornar vazio, uma mensagem será exibida informando ao usuário que não existe dados referentes à consulta realizada. 

=[RF003] Geração de boletos=
===Atores relacionados===
Usuário externo, Filiado FETAPE e Funcionário FETAPE.

===Objetivo===
Gerar registros de boletos no banco de dados para impressão. Não constitui a impressão do boleto em si.

===Prioridade===
Essencial.

===Entradas e pré condições===
'''Entradas:''' filiado(s)/usuário(s), banco, data de vencimento, modelo da guia, nosso número inicial, valor e instruções.
'''Pré-condições:''' usuário logado no sistema; sindicatos e filiados armazenados no banco de dados.

===Saídas e pós-condições===
'''Saídas:''' mensagem de aviso de sucesso da operação. 
'''Pós-condições:''' registro dos boletos inseridos no banco de dados.

===Fluxo principal de eventos===
1. Usuário Externo e Filiado FETAPE: usuário clica no botão Gerar Boletos. Se o usuário estiver com o status óbito, não será gerado boleto. Funcionário FETAPE: funcionário seleciona uma quantidade de filiados na tela de Listagem de Filiados e clica no botão Gerar Boletos. Os filiados com o status “óbito” nunca serão carregados; 
2. Sistema carrega o(s) usuários(s)/filiado(s) selecionados com seus respectivos dados (E1, E2, E3, E4); 
3. Uma janela é aberta perguntando se o usuário deseja imprimir boletos referentes a Contribuição Sindical e Contribuição Confederativa (2 check boxes); 
4. Uma tela é aberta onde o usuário informa os dados (banco, data de vencimento, modelo da guia, nosso número inicial, valor e instruções) para os boletos. Usuário confirma a operação; 
5. Sistema valida os dados inseridos pelo usuário e os dados obrigatórios para emissão de boleto (E5, E6); 
6. Sistema gera os boletos e os armazena no banco de dados com o status “gerado” (E7). O sistema deverá verificar se o número de boleto que ele irá gerar existe em algum intervalo na tabela de boletos avulso. Se existir, ele deverá gerar um próximo número que não esteja em um intervalo desta tabela; 
7. Sistema insere os registros de log da situação dos boletos no banco remoto com a justificava “gerado a partir da função de geração de boleto pelo usuário X:Y”, onde X corresponde ao login do funcionário e Y corresponde ao seu nome; 
8. Sistema exibe mensagem confirmando o sucesso na geração dos boletos e perguntando se o usuário deseja fazer a impressão dos mesmos; 
9. Se o usuário responder que sim, a janela de impressão padrão da funcionalidade imprimir é aberta. Includes [RF004]. 

===Filiado FETAPE===
Este usuário também terá acesso à rotina de CANCELAMENTO do boleto, que consiste meramente na exclusão do mesmo da base de dados. Vale salientar que devem ser efetuados os devidos registros no log do sistema seguindo o padrão supracitado, assim como devem ser atendidos os seguintes fluxos de exceção: 
1. Se o boleto possuir o status “pago”, “impresso” ou “enviado” (para o banco), o cancelamento não será permitido. O sistema exibirá uma mensagem de erro avisando que o boleto não pode ser impresso, indicando o seu status atual; 
2. Se o boleto requisitado não puder ser excluído, o sistema exibe uma mensagem de erro solicitando que o boleto não poder ser removido no momento. 

===Fluxos de exceção===
• E1: se não houver conexão com a internet, uma mensagem será exibida informando que não é possível estabelecer uma conexão com a internet e solicitando ao usuário que verifique sua conexão; 
• E2: se o sistema não estiver disponível, uma mensagem será exibida informando que o serviço não está disponível e que o usuário deve tentar acessá-lo mais tarde; 
• E3: se o resultado da busca retornar vazio, uma mensagem será exibida informando ao usuário que não existem dados referentes à consulta realizada; 
• E4: se o sistema não conseguir acessar a base de dados, uma mensagem será exibida informando ao usuário que a base de dados está inacessível; 
• E5: se o usuário não preencher os dados obrigatórios do boleto (banco, data de vencimento, modelo da guia, nosso número inicial e valor), uma mensagem será exibida informando ao usuário que os campos obrigatórios devem ser preenchidos; 
• E6: se os dados obrigatórios do(s) usuário(s)/filiado(s) para emissão de boleto não foram preenchidos (nome, logradouro, bairro, cidade, estado e CEP), o sistema lista na tela os usuário(s)/filiado(s) cujos dados obrigatórios não estão preenchidos e, para cada um, informa quais campos devem ser preenchidos. O usuário poderá prosseguir para a tela de marcação dos boletos que serão impressos (botão “prosseguir”), no entanto os boletos cujos dados não estão completos não aparecerão para seleção; 
• E7: se houver um estouro na numeração de boletos*, o sistema exibe uma mensagem solicitando ao usuário que entre em contato com a BISA pois houve um problema na geração da numeração do boleto. A operação não é finalizada. O sistema deve ainda efetuar todas as rotinas de rollback de modo a não deixar ‘lixo’ no banco de dados. 

<nowiki>*</nowiki> O estouro na numeração de boletos ocorre quando o limite do número de boletos cadastrado no banco de dados é atingido. Por exemplo, supondo um limite de 10 bytes, se o último registro cadastrado for 9999999999, o próximo registro de boleto irá acionar este erro. 

=[RF004] Imprimir boletos=
===Atores relacionados===
Usuário externo, Filiado FETAPE e Funcionário FETAPE.

===Objetivo===
Constitui a impressão de um boleto já gerado no sistema.

===Prioridade===
Essencial.

===Entradas e pré condições===
'''Entradas:''' lista de boletos para impressão. 
'''Pré-condições:''' o usuário deve estar logado no sistema na tela da listagem de boletos (RF002); os registros dos boletos devem estar armazenados no banco de dados e marcados como “não impresso”.

===Saídas e pós-condições===
'''Saídas:''' impressão dos boletos selecionados. 
'''Pós-Condições:''' registros dos boletos marcados no banco como “impresso”.

===Fluxo principal de eventos===
1. Usuário seleciona na Lista de boletos aqueles que deseja imprimir (check box) e clica no botão Imprimir (E1, E2, E3, E4, E5); 
2. Se o usuário houver selecionado apenas um boleto, o sistema imprime o boleto no navegador, permitindo ao usuário conferir seus dados. Depois disso, ele clica em um novo botão Imprimir e passa para o passo 3; 
3. Janela de impressão padrão é aberta (onde o usuário poderá selecionar impressora, quantidade de páginas, etc). Usuário confirma a impressão e o sistema envia os arquivos para a impressora (E6); 
4. Sistema marca no banco os boletos que foram impressos com o status “impresso” (E7); 
5. Sistema insere no log de boletos os registros com o status impresso com a justificativa “impresso pela função de impressão de boletos pelo usuário X:Y”, onde X corresponde ao código do usuário e Y ao seu nome. 
6. Sistema exibe uma mensagem de “Boletos impressos com sucesso”. 

===Fluxos de exceção===
• E1: se não houver conexão com a internet, uma mensagem será exibida informando que não é possível estabelecer uma conexão com a internet e solicitando ao usuário que verifique sua conexão; 
• E2: se o sistema não estiver disponível, uma mensagem será exibida informando que o serviço não está disponível e que o usuário deve tentar acessá-lo mais tarde; 
• E3: se o usuário não selecionar boletos, o sistema exibe uma mensagem solicitando ao usuário que selecione boletos para impressão; 
• E4: se na lista houver boletos que já foram pagos, o sistema exibe uma mensagem de erro informando que boletos pagos não podem ser reimpressos e cancela a operação; 
• E5: se houver boletos que já foram impressos, o sistema exibe um alerta informando que os boletos já foram impressos pelo sistema e serão reimpressos nesta operação; continua a executar normalmente; 
• E6: se houver um erro ao enviar os dados para a impressora, o sistema exibe uma mensagem avisando ao usuário que o sistema não conseguiu imprimir e solicitando que o mesmo verifique se a impressora está pronta para impressão; 
• E7: se houver um erro na alteração dos registros no banco de dados, uma mensagem será exibida informando que não foi possível marcar os boletos como impressos e solicitando ao usuário que tente novamente e que, caso o erro persista, entre em contato com a BISA. O sistema deve ainda efetuar todas as rotinas de rollback de modo a não deixar ‘lixo’ no banco de dados. 

=[RF005] Cadastro de filiado=
===Atores relacionados===
Filiado FETAPE e Funcionário FETAPE.

===Objetivo===
Cadastrar um filiado. As rotinas de ALTERAÇÃO e de EXCLUSÃO também estão contidas neste requisito para o Funcionário FETAPE.

===Prioridade===
Essencial.

===Entradas e pré condições===
'''Entradas:''' dados cadastrais do usuário. 
'''Pré-condições:''' computador deve ter acesso à internet; servidor web disponível. Funcionário: usuário cadastrado no sistema. 

===Saídas e pós-condições===
'''Saídas:''' mensagem avisando que o usuário foi cadastrado com sucesso. 
'''Pós-Condições:''' usuário cadastrado no banco de dados. 

===Fluxo principal de eventos===
1. Ator Filiado: a função “Cadastrar Filiado” é acionada pelo usuário no navegador web (E1, E2). Ator Funcionário: a função “Cadastrar Filiado” é acionada pelo usuário na tela de Listagem de Filiados (E1, E2). 
2. Um formulário é aberto solicitando dados cadastrais: login, senha, nome, CPF, CNAE, bairro, cidade, UF, logradouro, CEP, categoria (seleção entre as opções arrendatário, assentado, meeiro, parceiro, posseiro, pequeno proprietário e outros) e apelido do filiado; 
3. Usuário preenche os campos e confirma a operação (E3, E4, E5, E6); 
4. Sistema insere os registros de log da situação no banco remoto com a justificava “cadastrado pelo usuário X:Y”, onde X corresponde ao login do usuário e Y corresponde ao seu nome; 
5. Sistema retorna uma mensagem avisando que o usuário foi cadastrado com sucesso. 

O sistema também apresenta as rotinas de ALTERAÇÃO, que por ser trivial e seguir um fluxo semelhante à rotina de inclusão não terá sua execução descrita aqui. Vale salientar que devem ser efetuados os devidos registros no log do sistema. 

===Filiado FETAPE===
Ele possui também a funcionalidade EXCLUSÃO. Sua tela de ALTERAR é diferente. Nela, o usuário pode marcar um check box “óbito” para filiados que foram a óbito.

===Fluxos de exceção===
• E1: se não houver conexão com a internet, uma mensagem será exibida informando que não é possível estabelecer uma conexão com a internet e solicitando ao usuário que verifique sua conexão; 
• E2: se o sistema não estiver disponível, uma mensagem será exibida informando que o serviço não está disponível e que o usuário deve tentar acessá-lo mais tarde; 
• E3: se o login fornecido já estiver cadastrado no sistema, uma mensagem será exibida informando ao usuário que o login cadastrado já existe no sistema; 
• E4: se o CPF do filiado for inválido, uma mensagem será exibida informando ao usuário que o CPF cadastrado é inválido. Vale salientar que o preenchimento deste campo é opcional; 
• E5: se houver um erro na inserção dos registros no banco de dados, uma mensagem será exibida informando que não foi possível inserir os dados e solicitando ao usuário que tente novamente e que, caso o erro persista, entre em contato com a BISA. O sistema deve ainda efetuar todas as rotinas de rollback de modo a não deixar ‘lixo’ no banco de dados; 
• E6: se os dados obrigatórios dos filiados não forem preenchidos (nome, logradouro, bairro, cidade, estado e CEP), o sistema emite uma mensagem de erro informando quais os campos obrigatórios não foram preenchidos. 

=[RF006] Listar filiados=
===Atores relacionados===
Funcionário FETAPE.

===Objetivo===
Listar todos os filiados cadastrados no sistema.

===Prioridade===
Essencial.

===Entradas e pré condições===
'''Entradas:''' nenhuma.
'''Pré-condições:''' usuário logado no sistema; filiados armazenados no banco de dados.

===Saídas e pós-condições===
'''Saídas:''' lista de filiados. 
'''Pós-condições:''' nenhuma. 

===Fluxo principal de eventos===
1. Usuário clica no botão Filiados da barra de funções do sistema para acessar a Listagem de Filiados; 
2. Sistema carrega da base de dados os filiados com seus respectivos dados (E1, E2, E3, E4); 
3. É exibida a lista de filiados (com check boxes para seleção), cada um com seu número, nome, apelido, CPF, município, sindicato e categoria. Os filiados serão ordenados por ordem alfabética e agrupados por município. Também haverá uma check box que permite a seleção de todos os filiados listados na tela e um limite de filiados a serem exibidos, sendo os demais acessados por uma barra de próximo/anterior (semelhante a um esquema de web mail); 
4. Através de uma caixa de seleção (combo box), o usuário pode filtrar os filiados que serão exibidos na tela de acordo com a opção: “nome/apelido/município/sindicato”. A opção “nome” é a padrão. Os filiados que foram a óbito serão exibidos com uma cor de linha de grid acinzentada e só serão exibidos se um check box “todos” for ativado. 

===Fluxos de exceção===
• E1: se não houver conexão com a internet, uma mensagem será exibida informando que não é possível estabelecer uma conexão com a internet e solicitando ao usuário que verifique sua conexão; 
• E2: se o sistema não estiver disponível, uma mensagem será exibida informando que o serviço não está disponível e que o usuário deve tentar acessá-lo mais tarde; 
• E3: se o resultado da busca retornar vazio, uma mensagem será exibida informando ao usuário que não existem dados referentes à consulta realizada; 
• E4: se o sistema não conseguir acessar a base de dados, uma mensagem será exibida informando ao usuário que a base de dados está inacessível. 

=[RF007] Cadastro de sindicato=
===Atores relacionados===
Funcionário FETAPE.

===Objetivo===
Cadastrar um sindicato. As rotinas de ALTERAÇÃO e de EXCLUSÃO também estão contidas neste requisito.

===Prioridade===
Essencial.

===Entradas e pré condições===
'''Entradas:''' dados do sindicato; dados do Município (já presentes na base de dados, herdada do antigo sistema DOS TRAB_RUR). 
'''Pré-condições:''' usuário logado no sistema. 

===Saídas e pós-condições===
'''Saídas:''' mensagem avisando que o sindicato foi cadastrado com sucesso. 
'''Pós-Condições:''' sindicato cadastrado no banco de dados. 

Fluxo principal de eventos
1. Usuário clica no botão cadastrar na tela de Listagem de Sindicatos (E1, E2); 
2. Um formulário é aberto solicitando dados cadastrais: nome, município, UF, endereço; 
3. Usuário preenche os campos e confirma a operação (E3); 
4. Sistema insere os registros de log da situação no banco remoto com a justificava “cadastrado pelo usuário X:Y”, onde X corresponde ao login do funcionário e Y corresponde ao seu nome; 
5. Sistema retorna uma mensagem avisando que o sindicato foi cadastrado com sucesso. 

Também haverá rotinas de alteração e de exclusão. O processo é trivial para ser descrito aqui. Vale salientar que devem ser efetuados os devidos registros no log do sistema. 

===Fluxos de exceção===
• E1: se não houver conexão com a internet, uma mensagem será exibida informando que não é possível estabelecer uma conexão com a internet e solicitando ao usuário que verifique sua conexão; 
• E2: se o sistema não estiver disponível, uma mensagem será exibida informando que o serviço não está disponível e que o usuário deve tentar acessá-lo mais tarde; 
• E3: se houver um erro na inserção dos registros no banco de dados, uma mensagem será exibida informando que não foi possível inserir os dados e solicitando ao usuário que tente novamente e que, caso o erro persista, entre em contato com a BISA. O sistema deve ainda efetuar todas as rotinas de rollback de modo a não deixar ‘lixo’ no banco de dados; 

=[RF008] Listar sindicatos=
===Atores relacionados===
Funcionário FETAPE.

===Objetivo===
Listar todos os sindicatos cadastrados no sistema.

===Prioridade===
Essencial.

===Entradas e pré condições===
'''Entradas:''' nenhuma. 
'''Pré-condições:''' usuário logado no sistema; sindicatos armazenados no banco de dados. 

===Saídas e pós-condições===
'''Saídas:''' lista de sindicatos. 
'''Pós-condições:''' nenhuma. 

===Fluxo principal de eventos===
1. Usuário clica no botão Sindicatos da barra de funções do sistema para acessar a Listagem de Sindicatos; 
2. Sistema carrega da base de dados os sindicatos com seus respectivos dados (E1, E2, E3, E4); 
3. É exibida a lista de sindicatos (com check boxes para seleção), cada um com seu número, nome e município. Os sindicatos serão ordenados por ordem alfabética e agrupados por município. Também haverá uma check box que permite a seleção de todos os sindicatos listados na tela e um limite de sindicatos a serem exibidos, sendo os demais acessados por uma barra de próximo/anterior (semelhante a um esquema de web mail); 
4. Através de uma caixa de seleção (combo box), o usuário pode filtrar os sindicatos que serão exibidos na tela de acordo com a opção: “nome/município”. A opção “nome” é a padrão. 

===Fluxos de exceção===
• E1: se não houver conexão com a internet, uma mensagem será exibida informando que não é possível estabelecer uma conexão com a internet e solicitando ao usuário que verifique sua conexão; 
• E2: se o sistema não estiver disponível, uma mensagem será exibida informando que o serviço não está disponível e que o usuário deve tentar acessá-lo mais tarde; 
• E3: se o resultado da busca retornar vazio, uma mensagem será exibida informando ao usuário que não existem dados referentes à consulta realizada; 
• E4: se o sistema não conseguir acessar a base de dados, uma mensagem será exibida informando ao usuário que a base de dados está inacessível. 

===[RF009] Baixar Boleto===
===Atores relacionados===
Funcionário FETAPE.

===Objetivo===
Baixa nos boletos que foram impressos. Eles passarão a ter o status de pago.

===Prioridade===
Essencial.

===Entradas e pré condições===
'''Entradas:''' lista de boletos para baixa.
'''Pré-condições:''' usuário logado no sistema; os registros dos boletos devem estar armazenados no banco de dados.

===Saídas e pós-condições===
'''Saídas:''' mensagem de aviso de sucesso da operação. 
'''Pós-condições:''' registro dos boletos marcados no banco como “pagos”. 

===Fluxo principal de eventos===
1. Usuário seleciona na Lista de boletos aqueles que deseja baixar (check box) e clica no botão Baixar (E1, E2, E3, E4, E5); 
2. Sistema marca no banco os boletos como pagos (E6). Se o boleto não for encontrado na tabela de boletos, deverá ser procurado na tabela de boletos avulsos (E7); 
3. Sistema insere no log de boletos os registros com o status impresso com a justificativa “baixado pela função de baixar de boletos pelo usuário X:Y”, onde X corresponde ao código do usuário e Y ao seu nome; 
4. Sistema exibe uma mensagem de “Boletos baixados com sucesso”. 

===Fluxos de exceção===
• E1: se não houver conexão com a internet, uma mensagem será exibida informando que não é possível estabelecer uma conexão com a internet e solicitando ao usuário que verifique sua conexão; 
• E2: se o sistema não estiver disponível, uma mensagem será exibida informando que o serviço não está disponível e que o usuário deve tentar acessá-lo mais tarde; 
• E3: se o usuário não selecionar boletos, o sistema exibe uma mensagem solicitando ao usuário que selecione boletos para impressão; 
• E4: se na lista houver boletos com o status “pago”, o sistema exibe uma mensagem informando que boletos selecionados já foram baixados. Se o usuário clicar em continuar, o sistema continua a execução e ignora esses boletos; 
• E5: se na lista houver boletos com o status diferente de “impresso” ou “enviado” (enviado para o banco), o sistema exibe uma mensagem informando que há boletos selecionados que ainda não foram impressos ou enviados para o banco e quais são estes boletos. Se o usuário clicar em continuar, o sistema continua a execução e ignora esses boletos; 
• E6: se houver um erro na alteração dos registros no banco de dados, uma mensagem será exibida informando que não foi possível marcar os boletos como pagos e solicitando ao usuário que tente novamente e que, caso o erro persista, entre em contato com a BISA. O sistema deve ainda efetuar todas as rotinas de rollback de modo a não deixar ‘lixo’ no banco de dados; 
• E7: se o registro do boleto não for encontrado no banco, o sistema exibirá uma mensagem de erro indicando que o boleto não foi encontrado na base de dados do sistema. 

=[RF010] Baixar Boleto Automaticamente (via Arquivo de Retorno do Banco)=
===Atores relacionados===
Funcionário FETAPE.

===Objetivo===
Baixar de boletos a partir de um arquivo de retorno que o banco envia.

===Prioridade===
Essencial.

===Entradas e pré condições===
'''Entradas:''' arquivo de retorno do banco. 
'''Pré-condições:''' usuário logado no sistema; os registros dos boletos devem estar armazenados no banco de dados. 

===Saídas e pós-condições===
'''Saídas:''' mensagem de sucesso da operação. 
'''Pós-condições:''' registro dos boletos marcados no banco como “pagos”. 

===Fluxo principal de eventos===
1. Na tela da Lista de boletos, usuário clica na opção Baixa com Arquivo do Banco (E1, E2); 
2. Uma tela é aberta perguntando qual o arquivo de retorno do banco. O usuário então seleciona o caminho no seu computador correspondente à localização do arquivo e clica em OK. O sistema irá, então, fazer o upload do arquivo (E3, E4, E5); 
3. Sistema guarda a identificação do arquivo de retorno com situação de ‘não processado’ na base de dados e guarda uma cópia do arquivo em diretório especifico para histórico; 
4. Para cada linha do arquivo de retorno, o sistema procura o boleto referente na base de dados de boletos de contribuição. Se o boleto não for encontrado, o sistema procura na base de dados de boletos avulsos. Nesta base, há registros de boletos com intervalos (ex. de 001 a 100). O sistema irá buscar o número do boleto nessa faixa (E6); 
5. O sistema verifica se o boleto encontrado está marcado como “impresso” ou “enviado” (para o banco). Se estiver, o sistema marca no banco de dados o boleto como “pago” (E7); 
6. O sistema insere no log de boletos o registro com situação de “pago” com a justificativa ‘baixado pela função de baixa automática de boleto pelo usuário X:Y’, onde X corresponde ao login de usuário e Y corresponde ao seu nome; 
7. O Sistema marca o arquivo de retorno como ‘processado sem erros’ e uma exibe mensagem confirmando o sucesso na baixa dos boletos. 

===Fluxos de exceção===
• E1: se não houver conexão com a internet, uma mensagem será exibida informando que não é possível estabelecer uma conexão com a internet e solicitando ao usuário que verifique sua conexão; 
• E2: se o sistema não estiver disponível, uma mensagem será exibida informando que o serviço não está disponível e que o usuário deve tentar acessá-lo mais tarde; 
• E3: se o usuário não apontar nenhum arquivo de retorno, uma mensagem será exibida exigindo que o usuário aponte o arquivo; 
• E4: se o caminho para o arquivo estiver incorreto, o sistema exibe uma mensagem para o usuário informando que o caminho selecionado é inválido; 
• E5: se o formato do arquivo não corresponder ao formato do arquivo de retorno do banco esperado, o sistema exibirá uma mensagem informando que o formato do arquivo selecionado é inválido; 
• E6: se um registro do arquivo não for encontrado no sistema (base principal e base de boletos avulsos), será exibido numa tela todos os registros que não foram encontrados. A situação do arquivo de retorno no banco deve então mudar para “processado com erro” e o sistema deve inserir o registro de log de boleto com a justificativa “boleto não pode ser baixado, pois o mesmo não foi encontrado no sistema. Ação executada pelo usuário X:Y”, onde X é o login e Y é o nome. O valor do boleto pago e não encontrado deverá ser armazenado na tabela de boletos no registro cujo identificador é “BoletoXXXX”. Todo boleto que não for encontrado deverá ser somado ao valor desse registro; 
• E7: se houver um erro na alteração dos registros no banco de dados, uma mensagem será exibida informando que não foi possível marcar os boletos como “pago” e solicitando ao usuário que tente novamente e que, caso o erro persista, entre em contato com a BISA. O sistema deve ainda efetuar todas as rotinas de rollback de modo a não deixar ‘lixo’ no banco de dados. 

=[RF011] Gerar arquivo de remessa para banco=
===Atores relacionados===
===Funcionário FETAPE.===

===Objetivo===
Gerar arquivo de remessa de boletos para o banco.

===Prioridade===
Essencial.

===Entradas e pré condições===
'''Entradas:''' lista de boletos que serão enviados para o arquivo. 
'''Pré-condições:''' usuário logado no sistema; os registros dos boletos devem estar armazenados no banco de dados com o status “gerado” ou “impresso”. 

===Saídas e pós-condições===
'''Saídas:''' mensagem de sucesso da operação; arquivo de remessa para o banco. 
'''Pós-condições:''' boletos marcados com o status “enviado” no banco na base de dados. 

===Fluxo principal de eventos===
1. Na tela de Listagem de Boletos, o usuário seleciona os boletos e clica no botão Gerar de arquivo de remessa (E1, E2); 
2. Sistema verifica se todos os boletos selecionados estão marcados como “gerado” ou “impresso” (E3); 
3. Sistema abre tela para que o usuário informe o nome do arquivo e o local onde ele será gerado (E4, E5); 
4. Usuário confirma a geração do arquivo; 
5. Sistema gera o arquivo de remessa; 
6. Sistema marca no banco os boletos que foram inseridos no arquivo de remessa com o status de “enviado” para o banco (E6); 
7. Sistema insere no log de boletos os registros com situação de enviado com a justificativa “boleto gerado no arquivo de remessa para o banco pelo usuário X:Y”, onde X corresponde ao login do usuário e Y corresponde ao seu nome; 
8. Sistema salva em diretório especifico no banco uma cópia do arquivo gerado para remessa para fins de histórico; 
9. Sistema retorna o arquivo de remessa para que o usuário salve-o em seu computador. 

===Fluxos de exceção===
• E1: se não houver conexão com a internet, uma mensagem será exibida informando que não é possível estabelecer uma conexão com a internet e solicitando ao usuário que verifique sua conexão; 
• E2: se o sistema não estiver disponível, uma mensagem será exibida informando que o serviço não está disponível e que o usuário deve tentar acessá-lo mais tarde; 
• E3: se o sistema não encontrar nenhum arquivo com o status “gerado” ou “impresso”, uma mensagem será exibida informando que não existem boletos a serem gerados para o arquivo de remessa. Se encontrar, deverá informar quais os boletos não serão gerados no arquivo; 
• E4: se o usuário informa um local não existente, o sistema pergunta ao usuário se o mesmo deseja que o sistema crie o diretório de pastas informado. Se a resposta for sim, sistema cria diretório de pasta; se a resposta for não, sistema retorna a tela de informação do local para que o usuário selecione um novo diretório; 
• E5: se houver um erro na geração do arquivo de remessa, uma mensagem será exibida informando ao usuário que o arquivo de remessa não pode ser gerado e que o mesmo tente novamente e que, caso o erro persista, entre em contato com a BISA.; 
• E6: se houver um erro na alteração dos registros no banco de dados, uma mensagem será exibida informando que não foi possível marcar os boletos como “enviado” e solicitando ao usuário que tente novamente e que, caso o erro persista, entre em contato com a BISA. O sistema deve ainda efetuar todas as rotinas de rollback de modo a não deixar ‘lixo’ no banco de dados. 

=[RF012] Gerar arquivo de remessa para Gráfica=
===Atores relacionados===
Funcionário FETAPE.

===Objetivo===
Gerar arquivo de remessa de boletos para Gráfica.

===Prioridade===
Essencial.

===Entradas e pré condições===
'''Entradas:''' lista de boletos que serão enviados para o arquivo. 
'''Pré-condições:''' usuário logado no sistema; os registros dos boletos devem estar armazenados no banco de dados com o status “gerado”.

===Saídas e pós-condições===
'''Saídas:''' mensagem de sucesso da operação; arquivo de remessa para a gráfica (em formato txt e xls). 
'''Pós-condições:''' boletos marcados com o status “enviadoGrafica” no banco na base de dados. 

===Fluxo principal de eventos===
1. Na tela de Listagem de Boletos, o usuário seleciona os boletos e clica no botão Gerar arquivo de boleto para Gráfica (E1, E2); 
2. Sistema verifica se todos os boletos selecionados estão marcados como “gerado” (E3); 
3. Sistema abre tela para que o usuário informe o nome do arquivo e o local onde ele será gerado (E4, E5); 
4. Usuário confirma a geração do arquivo; 
5. Sistema pergunta se o usuário quer gerar o arquivo no formato txt ou xls; 
6. Sistema gera o arquivo de remessa para Gráfica; 
7. Sistema marca no banco os boletos que foram inseridos no arquivo de remessa com o status de “enviadoGrafica” para o banco (E6); 
8. Sistema insere no log de boletos os registros com situação de enviado com a justificativa “boleto gerado no arquivo de remessa para Gráfica pelo usuário X:Y”, onde X corresponde ao login do usuário e Y corresponde ao seu nome; 
9. Sistema salva em diretório especifico no banco uma cópia do arquivo gerado para remessa para Gráfica para fins de histórico; 
10. Sistema retorna o arquivo para que o usuário salve-o em seu computador. 

===Fluxos de exceção===
• E1: se não houver conexão com a internet, uma mensagem será exibida informando que não é possível estabelecer uma conexão com a internet e solicitando ao usuário que verifique sua conexão; 
• E2: se o sistema não estiver disponível, uma mensagem será exibida informando que o serviço não está disponível e que o usuário deve tentar acessá-lo mais tarde; 
• E3: se o sistema não encontrar nenhum arquivo com o status “gerado”, uma mensagem será exibida informando que não existem boletos a serem gerados para o arquivo de remessa. Se encontrar, deverá informar quais os boletos não serão gerados no arquivo; 
• E4: se o usuário informa um local não existente, o sistema pergunta ao usuário se o mesmo deseja que o sistema crie o diretório de pastas informado. Se a resposta for sim, sistema cria diretório de pasta; se a resposta for não, sistema retorna a tela de informação do local para que o usuário selecione um novo diretório; 
• E5: se houver um erro na geração do arquivo de remessa, uma mensagem será exibida informando ao usuário que o arquivo de remessa não pode ser gerado e que o mesmo tente novamente e que, caso o erro persista, entre em contato com a BISA; 
• E6: se houver um erro na alteração dos registros no banco de dados, uma mensagem será exibida informando que não foi possível marcar os boletos como “enviado” e solicitando ao usuário que tente novamente e que, caso o erro persista, entre em contato com a BISA. O sistema deve ainda efetuar todas as rotinas de rollback de modo a não deixar ‘lixo’ no banco de dados. 

=4 Especificações Suplementares=
===4.1 Objetivos===
Este documento tem como finalidade especificar todos os requisitos não funcionais do módulo de boletos web divididos em requisitos de usabilidade, confiabilidade, desempenho, segurança, distribuição, adequação a padrões e requisitos de hardware e software.
===4.2 Usabilidade===
Esta seção descreve os requisitos não funcionais associados à facilidade de uso da interface com o usuário, material de treinamento e documentação do sistema.
=[NF001] Interface com o Usuário=
===Prioridade:===
Desejável 
O sistema deve possuir uma interface amigável, simples e intuitiva.
===4.3 Confiabilidade===
Esta seção descreve os requisitos não funcionais associados à freqüência, severidade de falhas do sistema e habilidade de recuperação das mesmas, bem como a corretude do sistema.

=[NF001] Tempo de Retorno após Falha=
===Prioridade:=== Desejável
Retorno de até 5 segundos após alguma falha.
=[NF002] Disponibilidade=
===Prioridade:=== Importante
O sistema estará disponível 24 horas por dia durante todos os dias do ano.
===4.4 Desempenho===
Esta seção descreve os requisitos não funcionais associados à eficiência, uso de recursos e tempo de resposta do sistema.
=[NF001] Número de Acessos=
O sistema deve ser capaz de atender em média 10 usuários por segundo nos momentos de pico de acesso.
=[NF002] Tempo de Resposta para os Usuários=
O tempo máximo de resposta de uma requisição deve ser de no máximo 10 segundos.

===4.5 Segurança===
Esta seção descreve os requisitos não funcionais associados à integridade, privacidade e autenticidade dos dados do sistema.
=[NF001] Privacidade de Acesso=
Apenas os usuários credenciados e com permissão para acesso a este módulo deverão fazer uso das funcionalidades do módulo de boletos/guias na Web.
===4.6 Hardware e software===
Esta seção descreve os requisitos não funcionais associados ao hardware e software usados para desenvolver ou para executar o sistema.
=[NF001] Linguagem de Implementação=
===Prioridade:=== Essencial
A linguagem de implementação do módulo de boleto Web será Delphi, mesma linguagem utilizada no desenvolvimento dos sistemas Partidos2000, Receb2000, OAB2000 e Filiados2000.
=[NF002] Banco de Dados=
===Prioridade:=== Essencial
O banco de dados utilizado será o MySQL.
=[NF003] Ferramentas=
===Prioridade:=== Essencial
Ferramenta de modelagem: Borland Delphi 2006
Ferramenta de Desenvolvimento: Borland Delphi 2006
=[NF004] Plataforma de Funcionamento=
===Prioridade:=== Essencial
A plataforma tanto de desenvolvimento e de funcionamento será Windows.

Para uso do Bw- Construindo

2013-01-24T13:18:30Z

AnaPaula: /* [NF001] Interface com o Usuário */

[[Arquivo:BoletosWeb.PNG]] 

[[Arquivo:Historico_de_revisoes.PNG]] 

=1. Caso de Negócio=
==1.1 Objetivos==

Documentar o novo módulo de geração e impressão de boletos online. As informações aqui descritas especificam e refinam a regras de negócio.

==1.2 Referências==

Se baseará no conhecimento adquirido na implementação de rotinas de boletos da BISA (desktop) e no antigo sistema TRAB_RUR da BISA, em DOS. A entrevista com Mário e Márcio da FETAPE (realizada por Ronaldo e Alexandre) também é referência para a definição dos requisitos.

==1.3 Sistemas com rotinas de gerenciamento de boletos da BISA==

O Filiados 2000 é um sistema desktop de gestão de filiados que controla o cadastro de filiados dos sindicatos de trabalhadores, fazendo acompanhamento de participação na organização.

O OAB 2000 é um software de gestão de cadastro de advogados para OAB's. Faz desde o cadastro de alunos, pré-inscritos, coordena sociedades de advogados, estagiários, até a administração dos dados financeiros dos advogados.

O Receb 2000 é um software voltado para o acompanhamento do contas a receber de uma empresa, fazendo a gestão financeira da carteira de forma simples e eficiente.

Todos esses sistemas possuem uma função de gerenciamento de boletos bancários ou guias sindicais, sendo salvos de forma centralizada no MySQL, de forma que podem ser acessados de forma uniforme no BoletoWEB.

Cada sistema contém suas próprias regras de negócio para gerenciar os boletos; no entanto, as funções de acesso ao banco remoto serão padronizadas para todos os sistemas no BoletoWEB.

==1.4 Descrição do Produto==

A maior parte da implementação é voltada para a FETAPE, enquanto o restante imprime boletos gerados pelos nossos sistema desktop.

Módulo Geral: este módulo tem a função meramente de fornecer uma interface web que permita ao usuário imprimir boletos gerados pelos sistemas desktop da BISA. 

'''Módulo FETAPE:''' no antigo sistema TRAB_RUR da BISA, este sistema é o foco principal desta documentação. Nela o usuário poderá gerenciar todo o fluxo de boletos de contribuições: geração, impressão interna, cadastro de filiados, acesso on-line dos filiados, etc.

==1.5 Contexto de Negócio==

O módulo geral de boletos na web será utilizado a princípio pelos sistemas Receb2000, OAB2000 e Filiados2000, porém poderá ser extendido a qualquer sistema que queira fazer o controle de boletos/guias.

Este módulo concentrará as informações dos boletos em um único local independente de entidade ou sistema. Este local, a priori, ficou definido como sendo um dos servidores internos da BISA que possua acesso externo. Cada sistema rodará normalmente no ambiente do cliente. No momento que for necessário o acesso às informações, este será feito não mais na base local da área do cliente, mas na base remota situada na BISA.

O módulo FETAPE segue as mesmas diretrizes, tendo a diferença de ser implementado exclusivamente para esta entidade, devendo ser adaptável para outras entidades. Para tanto, aconselha-se o uso de uma arquitetura em camadas e padrões de projetos, facilitadores do processos de manutenção.

==1.6 Tecnologias utilizadas==

Os módulos geral e FETAPE deverão implementados utilizando uma tecnologia para web: PHP, Java ou .NET.

O banco de dados necessariamente deverá ser o MySQL, pois já é utilizado na bisa para o registro de boletos.

=2. Sobre os Requisitos=
==2.1 Introdução==

Este documento especifica todos os requisitos funcionais e não funcionais do módulo de gerenciamento de boletos, descrevendo os fluxos de eventos, prioridades, atores, entradas e saídas de cada caso de uso a ser implementado.

A correta interpretação deste documento exige o conhecimento de algumas convenções e termos específicos, que são descritos a seguir.

==2.2 Identificação dos Requisitos==

Por convenção, a referência a requisitos é feita através do nome da subseção onde eles estão descritos, seguidos do identificador do requisito, de acordo com o esquema abaixo:

[nome da subseção, identificador do requisito]

Por exemplo, o requisito funcional [Imprimir Boleto RF002] está descrito em um caso de uso chamado “Imprimir Boleto”, em um bloco identificado pelo identificador [RF002].

==2.3 Prioridades dos Requisitos==

Para estabelecer a prioridade dos requisitos foram adotadas as denominações “essencial”, “importante” e “desejável”. 
• Essencial é o requisito sem o qual o sistema não entra em funcionamento. São requisitos imprescindíveis, que têm que ser implementados. 
• Importante é o requisito sem o qual o sistema entra em funcionamento, mas de forma não satisfatória. Requisitos importantes devem ser implementados, mas, se não forem, o sistema poderá ser implantado e usado mesmo assim. 
• Desejável é o requisito que não compromete as funcionalidades básicas do sistema, isto é, o sistema pode funcionar de forma satisfatória sem ele. Requisitos desejáveis são requisitos que podem ser deixados para versões posteriores do sistema, caso não haja tempo hábil para implementá-los na versão que está sendo especificada. 

==2.4 Descrição dos Atores==

'''Usuário externo'''
É a pessoa que acessa a funcionalidade de impressão de boletos do módulo geral pelo browser.

Filiado FETAPE
Semelhante ao usuário comum, com a diferença de que terá a opção de se cadastrar pelo site.

Funcionário FETAPE
É responsável pelo gerenciamento dos boletos. É o ator principal deste sistema.

=3 Requisitos Funcionais (Casos de Uso)=
==3.1 Ações do Usuário==

==[RF001] Efetuar login==
Atores relacionados
Usuário externo, Filiado FETAPE e Funcionário FETAPE.

===Objetivo===
Fazer login no módulo Web de impressão de boletos.

===Prioridade===
Essencial.

===Entradas e pré condições===
'''Entradas:''' login do usuário e senha;
'''Pré-condições:''' computador deve ter acesso à internet; servidor web disponível.

===Saídas e pós-condições===
'''Saídas:''' não há
'''Pós-condições:''' usuário logado no sistema.

===Fluxo principal de eventos===
1. Usuário executa seu web browser e acessa a página de login (E1, E2); 
2. Usuário informa login e senha e clica em Entrar (E3); 
3. Sistema recupera na base de dados a senha do usuário com o login informado; 
4. Sistema verifica se o login está cadastrado (E4); 
5. Sistema verifica se a senha informada corresponde ao login informado (E5); 
6. Sistema libera o acesso após o sucesso da verificação; 
7. Includes [RF002]. 

===Fluxos de exceção===
• E1: se não houver conexão com a internet, uma mensagem será exibida informando que não é possível estabelecer uma conexão com a internet e solicitando ao usuário que verifique sua conexão; 
• E2: se o sistema não estiver disponível, uma mensagem será exibida informando que o serviço não está disponível e que o usuário deve tentar acessá-lo mais tarde; 
• E3: se o usuário não informar o login ou a senha, o sistema solicita que informe o login e a senha; 
• E4: se o login não estiver cadastrado, o sistema emite uma mensagem de erro informando que este usuário não está cadastrado e solicitando que o mesmo verifique se o login foi digitado corretamente; 
• E5: se a senha não conferir com a que está armazenada na base de dados, o sistema emite uma mensagem de erro avisando que a senha informada está incorreta e solicitando que o mesmo verifique se ela foi digitada corretamente. 

==[RF002] Listar boletos==
===Atores relacionados===
Usuário externo, Filiado FETAPE e Funcionário FETAPE.

===Objetivo===
Listar os boletos correspondentes ao usuário logado.

===Prioridade===
Essencial.

===Entradas e pré condições===
'''Entradas:''' nenhuma.
'''Pré-condições:''' usuário logado no sistema; boletos armazenados no banco de dados.

===Saídas e pós-condições===
'''Saídas:''' lista de boletos.
'''Pós-condições:''' nenhuma.

===Fluxo principal de eventos===
1. Sistema carrega da base de dados os boletos referentes ao usuário (E1, E2, E3); 
2. É exibida a lista de boletos (com check boxes para seleção), cada um com seu número, descrição, valor, vencimento e status (pendente/atrasado/impresso/pago). Os boletos serão ordenados de forma decrescente (maior para o menor) por data de vencimento na lista. Também haverá uma check box que permite a seleção de todos os boletos listados na tela e um limite de boletos a serem exibidos, sendo os demais boletos acessados por uma barra de próximo/anterior (semelhante a um esquema de web mail); 
3. Através de uma caixa de seleção (combo box), o usuário pode filtrar os boletos que serão exibidos na tela de acordo com a opção: “pendentes/impressos/pagos/todos”. Os boletos com status “atrasado” ficarão na lista de “pendentes” e “todos”, mas com uma cor de linha de grid que os diferencie dos demais (ex. vermelho). O status inicial do filtro é “pendentes”. 

===Fluxos de exceção===
• E1: se não houver conexão com a internet, uma mensagem será exibida informando que não é possível estabelecer uma conexão com a internet e solicitando ao usuário que verifique sua conexão; 
• E2: se o sistema não estiver disponível, uma mensagem será exibida informando que o serviço não está disponível e que o usuário deve tentar acessá-lo mais tarde; 
• E3: se o resultado da busca retornar vazio, uma mensagem será exibida informando ao usuário que não existe dados referentes à consulta realizada. 

=[RF003] Geração de boletos=
===Atores relacionados===
Usuário externo, Filiado FETAPE e Funcionário FETAPE.

===Objetivo===
Gerar registros de boletos no banco de dados para impressão. Não constitui a impressão do boleto em si.

===Prioridade===
Essencial.

===Entradas e pré condições===
'''Entradas:''' filiado(s)/usuário(s), banco, data de vencimento, modelo da guia, nosso número inicial, valor e instruções.
'''Pré-condições:''' usuário logado no sistema; sindicatos e filiados armazenados no banco de dados.

===Saídas e pós-condições===
'''Saídas:''' mensagem de aviso de sucesso da operação. 
'''Pós-condições:''' registro dos boletos inseridos no banco de dados.

===Fluxo principal de eventos===
1. Usuário Externo e Filiado FETAPE: usuário clica no botão Gerar Boletos. Se o usuário estiver com o status óbito, não será gerado boleto. Funcionário FETAPE: funcionário seleciona uma quantidade de filiados na tela de Listagem de Filiados e clica no botão Gerar Boletos. Os filiados com o status “óbito” nunca serão carregados; 
2. Sistema carrega o(s) usuários(s)/filiado(s) selecionados com seus respectivos dados (E1, E2, E3, E4); 
3. Uma janela é aberta perguntando se o usuário deseja imprimir boletos referentes a Contribuição Sindical e Contribuição Confederativa (2 check boxes); 
4. Uma tela é aberta onde o usuário informa os dados (banco, data de vencimento, modelo da guia, nosso número inicial, valor e instruções) para os boletos. Usuário confirma a operação; 
5. Sistema valida os dados inseridos pelo usuário e os dados obrigatórios para emissão de boleto (E5, E6); 
6. Sistema gera os boletos e os armazena no banco de dados com o status “gerado” (E7). O sistema deverá verificar se o número de boleto que ele irá gerar existe em algum intervalo na tabela de boletos avulso. Se existir, ele deverá gerar um próximo número que não esteja em um intervalo desta tabela; 
7. Sistema insere os registros de log da situação dos boletos no banco remoto com a justificava “gerado a partir da função de geração de boleto pelo usuário X:Y”, onde X corresponde ao login do funcionário e Y corresponde ao seu nome; 
8. Sistema exibe mensagem confirmando o sucesso na geração dos boletos e perguntando se o usuário deseja fazer a impressão dos mesmos; 
9. Se o usuário responder que sim, a janela de impressão padrão da funcionalidade imprimir é aberta. Includes [RF004]. 

===Filiado FETAPE===
Este usuário também terá acesso à rotina de CANCELAMENTO do boleto, que consiste meramente na exclusão do mesmo da base de dados. Vale salientar que devem ser efetuados os devidos registros no log do sistema seguindo o padrão supracitado, assim como devem ser atendidos os seguintes fluxos de exceção: 
1. Se o boleto possuir o status “pago”, “impresso” ou “enviado” (para o banco), o cancelamento não será permitido. O sistema exibirá uma mensagem de erro avisando que o boleto não pode ser impresso, indicando o seu status atual; 
2. Se o boleto requisitado não puder ser excluído, o sistema exibe uma mensagem de erro solicitando que o boleto não poder ser removido no momento. 

===Fluxos de exceção===
• E1: se não houver conexão com a internet, uma mensagem será exibida informando que não é possível estabelecer uma conexão com a internet e solicitando ao usuário que verifique sua conexão; 
• E2: se o sistema não estiver disponível, uma mensagem será exibida informando que o serviço não está disponível e que o usuário deve tentar acessá-lo mais tarde; 
• E3: se o resultado da busca retornar vazio, uma mensagem será exibida informando ao usuário que não existem dados referentes à consulta realizada; 
• E4: se o sistema não conseguir acessar a base de dados, uma mensagem será exibida informando ao usuário que a base de dados está inacessível; 
• E5: se o usuário não preencher os dados obrigatórios do boleto (banco, data de vencimento, modelo da guia, nosso número inicial e valor), uma mensagem será exibida informando ao usuário que os campos obrigatórios devem ser preenchidos; 
• E6: se os dados obrigatórios do(s) usuário(s)/filiado(s) para emissão de boleto não foram preenchidos (nome, logradouro, bairro, cidade, estado e CEP), o sistema lista na tela os usuário(s)/filiado(s) cujos dados obrigatórios não estão preenchidos e, para cada um, informa quais campos devem ser preenchidos. O usuário poderá prosseguir para a tela de marcação dos boletos que serão impressos (botão “prosseguir”), no entanto os boletos cujos dados não estão completos não aparecerão para seleção; 
• E7: se houver um estouro na numeração de boletos*, o sistema exibe uma mensagem solicitando ao usuário que entre em contato com a BISA pois houve um problema na geração da numeração do boleto. A operação não é finalizada. O sistema deve ainda efetuar todas as rotinas de rollback de modo a não deixar ‘lixo’ no banco de dados. 

<nowiki>*</nowiki> O estouro na numeração de boletos ocorre quando o limite do número de boletos cadastrado no banco de dados é atingido. Por exemplo, supondo um limite de 10 bytes, se o último registro cadastrado for 9999999999, o próximo registro de boleto irá acionar este erro. 

=[RF004] Imprimir boletos=
===Atores relacionados===
Usuário externo, Filiado FETAPE e Funcionário FETAPE.

===Objetivo===
Constitui a impressão de um boleto já gerado no sistema.

===Prioridade===
Essencial.

===Entradas e pré condições===
'''Entradas:''' lista de boletos para impressão. 
'''Pré-condições:''' o usuário deve estar logado no sistema na tela da listagem de boletos (RF002); os registros dos boletos devem estar armazenados no banco de dados e marcados como “não impresso”.

===Saídas e pós-condições===
'''Saídas:''' impressão dos boletos selecionados. 
'''Pós-Condições:''' registros dos boletos marcados no banco como “impresso”.

===Fluxo principal de eventos===
1. Usuário seleciona na Lista de boletos aqueles que deseja imprimir (check box) e clica no botão Imprimir (E1, E2, E3, E4, E5); 
2. Se o usuário houver selecionado apenas um boleto, o sistema imprime o boleto no navegador, permitindo ao usuário conferir seus dados. Depois disso, ele clica em um novo botão Imprimir e passa para o passo 3; 
3. Janela de impressão padrão é aberta (onde o usuário poderá selecionar impressora, quantidade de páginas, etc). Usuário confirma a impressão e o sistema envia os arquivos para a impressora (E6); 
4. Sistema marca no banco os boletos que foram impressos com o status “impresso” (E7); 
5. Sistema insere no log de boletos os registros com o status impresso com a justificativa “impresso pela função de impressão de boletos pelo usuário X:Y”, onde X corresponde ao código do usuário e Y ao seu nome. 
6. Sistema exibe uma mensagem de “Boletos impressos com sucesso”. 

===Fluxos de exceção===
• E1: se não houver conexão com a internet, uma mensagem será exibida informando que não é possível estabelecer uma conexão com a internet e solicitando ao usuário que verifique sua conexão; 
• E2: se o sistema não estiver disponível, uma mensagem será exibida informando que o serviço não está disponível e que o usuário deve tentar acessá-lo mais tarde; 
• E3: se o usuário não selecionar boletos, o sistema exibe uma mensagem solicitando ao usuário que selecione boletos para impressão; 
• E4: se na lista houver boletos que já foram pagos, o sistema exibe uma mensagem de erro informando que boletos pagos não podem ser reimpressos e cancela a operação; 
• E5: se houver boletos que já foram impressos, o sistema exibe um alerta informando que os boletos já foram impressos pelo sistema e serão reimpressos nesta operação; continua a executar normalmente; 
• E6: se houver um erro ao enviar os dados para a impressora, o sistema exibe uma mensagem avisando ao usuário que o sistema não conseguiu imprimir e solicitando que o mesmo verifique se a impressora está pronta para impressão; 
• E7: se houver um erro na alteração dos registros no banco de dados, uma mensagem será exibida informando que não foi possível marcar os boletos como impressos e solicitando ao usuário que tente novamente e que, caso o erro persista, entre em contato com a BISA. O sistema deve ainda efetuar todas as rotinas de rollback de modo a não deixar ‘lixo’ no banco de dados. 

=[RF005] Cadastro de filiado=
===Atores relacionados===
Filiado FETAPE e Funcionário FETAPE.

===Objetivo===
Cadastrar um filiado. As rotinas de ALTERAÇÃO e de EXCLUSÃO também estão contidas neste requisito para o Funcionário FETAPE.

===Prioridade===
Essencial.

===Entradas e pré condições===
'''Entradas:''' dados cadastrais do usuário. 
'''Pré-condições:''' computador deve ter acesso à internet; servidor web disponível. Funcionário: usuário cadastrado no sistema. 

===Saídas e pós-condições===
'''Saídas:''' mensagem avisando que o usuário foi cadastrado com sucesso. 
'''Pós-Condições:''' usuário cadastrado no banco de dados. 

===Fluxo principal de eventos===
1. Ator Filiado: a função “Cadastrar Filiado” é acionada pelo usuário no navegador web (E1, E2). Ator Funcionário: a função “Cadastrar Filiado” é acionada pelo usuário na tela de Listagem de Filiados (E1, E2). 
2. Um formulário é aberto solicitando dados cadastrais: login, senha, nome, CPF, CNAE, bairro, cidade, UF, logradouro, CEP, categoria (seleção entre as opções arrendatário, assentado, meeiro, parceiro, posseiro, pequeno proprietário e outros) e apelido do filiado; 
3. Usuário preenche os campos e confirma a operação (E3, E4, E5, E6); 
4. Sistema insere os registros de log da situação no banco remoto com a justificava “cadastrado pelo usuário X:Y”, onde X corresponde ao login do usuário e Y corresponde ao seu nome; 
5. Sistema retorna uma mensagem avisando que o usuário foi cadastrado com sucesso. 

O sistema também apresenta as rotinas de ALTERAÇÃO, que por ser trivial e seguir um fluxo semelhante à rotina de inclusão não terá sua execução descrita aqui. Vale salientar que devem ser efetuados os devidos registros no log do sistema. 

===Filiado FETAPE===
Ele possui também a funcionalidade EXCLUSÃO. Sua tela de ALTERAR é diferente. Nela, o usuário pode marcar um check box “óbito” para filiados que foram a óbito.

===Fluxos de exceção===
• E1: se não houver conexão com a internet, uma mensagem será exibida informando que não é possível estabelecer uma conexão com a internet e solicitando ao usuário que verifique sua conexão; 
• E2: se o sistema não estiver disponível, uma mensagem será exibida informando que o serviço não está disponível e que o usuário deve tentar acessá-lo mais tarde; 
• E3: se o login fornecido já estiver cadastrado no sistema, uma mensagem será exibida informando ao usuário que o login cadastrado já existe no sistema; 
• E4: se o CPF do filiado for inválido, uma mensagem será exibida informando ao usuário que o CPF cadastrado é inválido. Vale salientar que o preenchimento deste campo é opcional; 
• E5: se houver um erro na inserção dos registros no banco de dados, uma mensagem será exibida informando que não foi possível inserir os dados e solicitando ao usuário que tente novamente e que, caso o erro persista, entre em contato com a BISA. O sistema deve ainda efetuar todas as rotinas de rollback de modo a não deixar ‘lixo’ no banco de dados; 
• E6: se os dados obrigatórios dos filiados não forem preenchidos (nome, logradouro, bairro, cidade, estado e CEP), o sistema emite uma mensagem de erro informando quais os campos obrigatórios não foram preenchidos. 

=[RF006] Listar filiados=
===Atores relacionados===
Funcionário FETAPE.

===Objetivo===
Listar todos os filiados cadastrados no sistema.

===Prioridade===
Essencial.

===Entradas e pré condições===
'''Entradas:''' nenhuma.
'''Pré-condições:''' usuário logado no sistema; filiados armazenados no banco de dados.

===Saídas e pós-condições===
'''Saídas:''' lista de filiados. 
'''Pós-condições:''' nenhuma. 

===Fluxo principal de eventos===
1. Usuário clica no botão Filiados da barra de funções do sistema para acessar a Listagem de Filiados; 
2. Sistema carrega da base de dados os filiados com seus respectivos dados (E1, E2, E3, E4); 
3. É exibida a lista de filiados (com check boxes para seleção), cada um com seu número, nome, apelido, CPF, município, sindicato e categoria. Os filiados serão ordenados por ordem alfabética e agrupados por município. Também haverá uma check box que permite a seleção de todos os filiados listados na tela e um limite de filiados a serem exibidos, sendo os demais acessados por uma barra de próximo/anterior (semelhante a um esquema de web mail); 
4. Através de uma caixa de seleção (combo box), o usuário pode filtrar os filiados que serão exibidos na tela de acordo com a opção: “nome/apelido/município/sindicato”. A opção “nome” é a padrão. Os filiados que foram a óbito serão exibidos com uma cor de linha de grid acinzentada e só serão exibidos se um check box “todos” for ativado. 

===Fluxos de exceção===
• E1: se não houver conexão com a internet, uma mensagem será exibida informando que não é possível estabelecer uma conexão com a internet e solicitando ao usuário que verifique sua conexão; 
• E2: se o sistema não estiver disponível, uma mensagem será exibida informando que o serviço não está disponível e que o usuário deve tentar acessá-lo mais tarde; 
• E3: se o resultado da busca retornar vazio, uma mensagem será exibida informando ao usuário que não existem dados referentes à consulta realizada; 
• E4: se o sistema não conseguir acessar a base de dados, uma mensagem será exibida informando ao usuário que a base de dados está inacessível. 

=[RF007] Cadastro de sindicato=
===Atores relacionados===
Funcionário FETAPE.

===Objetivo===
Cadastrar um sindicato. As rotinas de ALTERAÇÃO e de EXCLUSÃO também estão contidas neste requisito.

===Prioridade===
Essencial.

===Entradas e pré condições===
'''Entradas:''' dados do sindicato; dados do Município (já presentes na base de dados, herdada do antigo sistema DOS TRAB_RUR). 
'''Pré-condições:''' usuário logado no sistema. 

===Saídas e pós-condições===
'''Saídas:''' mensagem avisando que o sindicato foi cadastrado com sucesso. 
'''Pós-Condições:''' sindicato cadastrado no banco de dados. 

Fluxo principal de eventos
1. Usuário clica no botão cadastrar na tela de Listagem de Sindicatos (E1, E2); 
2. Um formulário é aberto solicitando dados cadastrais: nome, município, UF, endereço; 
3. Usuário preenche os campos e confirma a operação (E3); 
4. Sistema insere os registros de log da situação no banco remoto com a justificava “cadastrado pelo usuário X:Y”, onde X corresponde ao login do funcionário e Y corresponde ao seu nome; 
5. Sistema retorna uma mensagem avisando que o sindicato foi cadastrado com sucesso. 

Também haverá rotinas de alteração e de exclusão. O processo é trivial para ser descrito aqui. Vale salientar que devem ser efetuados os devidos registros no log do sistema. 

===Fluxos de exceção===
• E1: se não houver conexão com a internet, uma mensagem será exibida informando que não é possível estabelecer uma conexão com a internet e solicitando ao usuário que verifique sua conexão; 
• E2: se o sistema não estiver disponível, uma mensagem será exibida informando que o serviço não está disponível e que o usuário deve tentar acessá-lo mais tarde; 
• E3: se houver um erro na inserção dos registros no banco de dados, uma mensagem será exibida informando que não foi possível inserir os dados e solicitando ao usuário que tente novamente e que, caso o erro persista, entre em contato com a BISA. O sistema deve ainda efetuar todas as rotinas de rollback de modo a não deixar ‘lixo’ no banco de dados; 

=[RF008] Listar sindicatos=
===Atores relacionados===
Funcionário FETAPE.

===Objetivo===
Listar todos os sindicatos cadastrados no sistema.

===Prioridade===
Essencial.

===Entradas e pré condições===
'''Entradas:''' nenhuma. 
'''Pré-condições:''' usuário logado no sistema; sindicatos armazenados no banco de dados. 

===Saídas e pós-condições===
'''Saídas:''' lista de sindicatos. 
'''Pós-condições:''' nenhuma. 

===Fluxo principal de eventos===
1. Usuário clica no botão Sindicatos da barra de funções do sistema para acessar a Listagem de Sindicatos; 
2. Sistema carrega da base de dados os sindicatos com seus respectivos dados (E1, E2, E3, E4); 
3. É exibida a lista de sindicatos (com check boxes para seleção), cada um com seu número, nome e município. Os sindicatos serão ordenados por ordem alfabética e agrupados por município. Também haverá uma check box que permite a seleção de todos os sindicatos listados na tela e um limite de sindicatos a serem exibidos, sendo os demais acessados por uma barra de próximo/anterior (semelhante a um esquema de web mail); 
4. Através de uma caixa de seleção (combo box), o usuário pode filtrar os sindicatos que serão exibidos na tela de acordo com a opção: “nome/município”. A opção “nome” é a padrão. 

===Fluxos de exceção===
• E1: se não houver conexão com a internet, uma mensagem será exibida informando que não é possível estabelecer uma conexão com a internet e solicitando ao usuário que verifique sua conexão; 
• E2: se o sistema não estiver disponível, uma mensagem será exibida informando que o serviço não está disponível e que o usuário deve tentar acessá-lo mais tarde; 
• E3: se o resultado da busca retornar vazio, uma mensagem será exibida informando ao usuário que não existem dados referentes à consulta realizada; 
• E4: se o sistema não conseguir acessar a base de dados, uma mensagem será exibida informando ao usuário que a base de dados está inacessível. 

===[RF009] Baixar Boleto===
===Atores relacionados===
Funcionário FETAPE.

===Objetivo===
Baixa nos boletos que foram impressos. Eles passarão a ter o status de pago.

===Prioridade===
Essencial.

===Entradas e pré condições===
'''Entradas:''' lista de boletos para baixa.
'''Pré-condições:''' usuário logado no sistema; os registros dos boletos devem estar armazenados no banco de dados.

===Saídas e pós-condições===
'''Saídas:''' mensagem de aviso de sucesso da operação. 
'''Pós-condições:''' registro dos boletos marcados no banco como “pagos”. 

===Fluxo principal de eventos===
1. Usuário seleciona na Lista de boletos aqueles que deseja baixar (check box) e clica no botão Baixar (E1, E2, E3, E4, E5); 
2. Sistema marca no banco os boletos como pagos (E6). Se o boleto não for encontrado na tabela de boletos, deverá ser procurado na tabela de boletos avulsos (E7); 
3. Sistema insere no log de boletos os registros com o status impresso com a justificativa “baixado pela função de baixar de boletos pelo usuário X:Y”, onde X corresponde ao código do usuário e Y ao seu nome; 
4. Sistema exibe uma mensagem de “Boletos baixados com sucesso”. 

===Fluxos de exceção===
• E1: se não houver conexão com a internet, uma mensagem será exibida informando que não é possível estabelecer uma conexão com a internet e solicitando ao usuário que verifique sua conexão; 
• E2: se o sistema não estiver disponível, uma mensagem será exibida informando que o serviço não está disponível e que o usuário deve tentar acessá-lo mais tarde; 
• E3: se o usuário não selecionar boletos, o sistema exibe uma mensagem solicitando ao usuário que selecione boletos para impressão; 
• E4: se na lista houver boletos com o status “pago”, o sistema exibe uma mensagem informando que boletos selecionados já foram baixados. Se o usuário clicar em continuar, o sistema continua a execução e ignora esses boletos; 
• E5: se na lista houver boletos com o status diferente de “impresso” ou “enviado” (enviado para o banco), o sistema exibe uma mensagem informando que há boletos selecionados que ainda não foram impressos ou enviados para o banco e quais são estes boletos. Se o usuário clicar em continuar, o sistema continua a execução e ignora esses boletos; 
• E6: se houver um erro na alteração dos registros no banco de dados, uma mensagem será exibida informando que não foi possível marcar os boletos como pagos e solicitando ao usuário que tente novamente e que, caso o erro persista, entre em contato com a BISA. O sistema deve ainda efetuar todas as rotinas de rollback de modo a não deixar ‘lixo’ no banco de dados; 
• E7: se o registro do boleto não for encontrado no banco, o sistema exibirá uma mensagem de erro indicando que o boleto não foi encontrado na base de dados do sistema. 

=[RF010] Baixar Boleto Automaticamente (via Arquivo de Retorno do Banco)=
===Atores relacionados===
Funcionário FETAPE.

===Objetivo===
Baixar de boletos a partir de um arquivo de retorno que o banco envia.

===Prioridade===
Essencial.

===Entradas e pré condições===
'''Entradas:''' arquivo de retorno do banco. 
'''Pré-condições:''' usuário logado no sistema; os registros dos boletos devem estar armazenados no banco de dados. 

===Saídas e pós-condições===
'''Saídas:''' mensagem de sucesso da operação. 
'''Pós-condições:''' registro dos boletos marcados no banco como “pagos”. 

===Fluxo principal de eventos===
1. Na tela da Lista de boletos, usuário clica na opção Baixa com Arquivo do Banco (E1, E2); 
2. Uma tela é aberta perguntando qual o arquivo de retorno do banco. O usuário então seleciona o caminho no seu computador correspondente à localização do arquivo e clica em OK. O sistema irá, então, fazer o upload do arquivo (E3, E4, E5); 
3. Sistema guarda a identificação do arquivo de retorno com situação de ‘não processado’ na base de dados e guarda uma cópia do arquivo em diretório especifico para histórico; 
4. Para cada linha do arquivo de retorno, o sistema procura o boleto referente na base de dados de boletos de contribuição. Se o boleto não for encontrado, o sistema procura na base de dados de boletos avulsos. Nesta base, há registros de boletos com intervalos (ex. de 001 a 100). O sistema irá buscar o número do boleto nessa faixa (E6); 
5. O sistema verifica se o boleto encontrado está marcado como “impresso” ou “enviado” (para o banco). Se estiver, o sistema marca no banco de dados o boleto como “pago” (E7); 
6. O sistema insere no log de boletos o registro com situação de “pago” com a justificativa ‘baixado pela função de baixa automática de boleto pelo usuário X:Y’, onde X corresponde ao login de usuário e Y corresponde ao seu nome; 
7. O Sistema marca o arquivo de retorno como ‘processado sem erros’ e uma exibe mensagem confirmando o sucesso na baixa dos boletos. 

===Fluxos de exceção===
• E1: se não houver conexão com a internet, uma mensagem será exibida informando que não é possível estabelecer uma conexão com a internet e solicitando ao usuário que verifique sua conexão; 
• E2: se o sistema não estiver disponível, uma mensagem será exibida informando que o serviço não está disponível e que o usuário deve tentar acessá-lo mais tarde; 
• E3: se o usuário não apontar nenhum arquivo de retorno, uma mensagem será exibida exigindo que o usuário aponte o arquivo; 
• E4: se o caminho para o arquivo estiver incorreto, o sistema exibe uma mensagem para o usuário informando que o caminho selecionado é inválido; 
• E5: se o formato do arquivo não corresponder ao formato do arquivo de retorno do banco esperado, o sistema exibirá uma mensagem informando que o formato do arquivo selecionado é inválido; 
• E6: se um registro do arquivo não for encontrado no sistema (base principal e base de boletos avulsos), será exibido numa tela todos os registros que não foram encontrados. A situação do arquivo de retorno no banco deve então mudar para “processado com erro” e o sistema deve inserir o registro de log de boleto com a justificativa “boleto não pode ser baixado, pois o mesmo não foi encontrado no sistema. Ação executada pelo usuário X:Y”, onde X é o login e Y é o nome. O valor do boleto pago e não encontrado deverá ser armazenado na tabela de boletos no registro cujo identificador é “BoletoXXXX”. Todo boleto que não for encontrado deverá ser somado ao valor desse registro; 
• E7: se houver um erro na alteração dos registros no banco de dados, uma mensagem será exibida informando que não foi possível marcar os boletos como “pago” e solicitando ao usuário que tente novamente e que, caso o erro persista, entre em contato com a BISA. O sistema deve ainda efetuar todas as rotinas de rollback de modo a não deixar ‘lixo’ no banco de dados. 

=[RF011] Gerar arquivo de remessa para banco=
===Atores relacionados===
===Funcionário FETAPE.===

===Objetivo===
Gerar arquivo de remessa de boletos para o banco.

===Prioridade===
Essencial.

===Entradas e pré condições===
'''Entradas:''' lista de boletos que serão enviados para o arquivo. 
'''Pré-condições:''' usuário logado no sistema; os registros dos boletos devem estar armazenados no banco de dados com o status “gerado” ou “impresso”. 

===Saídas e pós-condições===
'''Saídas:''' mensagem de sucesso da operação; arquivo de remessa para o banco. 
'''Pós-condições:''' boletos marcados com o status “enviado” no banco na base de dados. 

===Fluxo principal de eventos===
1. Na tela de Listagem de Boletos, o usuário seleciona os boletos e clica no botão Gerar de arquivo de remessa (E1, E2); 
2. Sistema verifica se todos os boletos selecionados estão marcados como “gerado” ou “impresso” (E3); 
3. Sistema abre tela para que o usuário informe o nome do arquivo e o local onde ele será gerado (E4, E5); 
4. Usuário confirma a geração do arquivo; 
5. Sistema gera o arquivo de remessa; 
6. Sistema marca no banco os boletos que foram inseridos no arquivo de remessa com o status de “enviado” para o banco (E6); 
7. Sistema insere no log de boletos os registros com situação de enviado com a justificativa “boleto gerado no arquivo de remessa para o banco pelo usuário X:Y”, onde X corresponde ao login do usuário e Y corresponde ao seu nome; 
8. Sistema salva em diretório especifico no banco uma cópia do arquivo gerado para remessa para fins de histórico; 
9. Sistema retorna o arquivo de remessa para que o usuário salve-o em seu computador. 

===Fluxos de exceção===
• E1: se não houver conexão com a internet, uma mensagem será exibida informando que não é possível estabelecer uma conexão com a internet e solicitando ao usuário que verifique sua conexão; 
• E2: se o sistema não estiver disponível, uma mensagem será exibida informando que o serviço não está disponível e que o usuário deve tentar acessá-lo mais tarde; 
• E3: se o sistema não encontrar nenhum arquivo com o status “gerado” ou “impresso”, uma mensagem será exibida informando que não existem boletos a serem gerados para o arquivo de remessa. Se encontrar, deverá informar quais os boletos não serão gerados no arquivo; 
• E4: se o usuário informa um local não existente, o sistema pergunta ao usuário se o mesmo deseja que o sistema crie o diretório de pastas informado. Se a resposta for sim, sistema cria diretório de pasta; se a resposta for não, sistema retorna a tela de informação do local para que o usuário selecione um novo diretório; 
• E5: se houver um erro na geração do arquivo de remessa, uma mensagem será exibida informando ao usuário que o arquivo de remessa não pode ser gerado e que o mesmo tente novamente e que, caso o erro persista, entre em contato com a BISA.; 
• E6: se houver um erro na alteração dos registros no banco de dados, uma mensagem será exibida informando que não foi possível marcar os boletos como “enviado” e solicitando ao usuário que tente novamente e que, caso o erro persista, entre em contato com a BISA. O sistema deve ainda efetuar todas as rotinas de rollback de modo a não deixar ‘lixo’ no banco de dados. 

=[RF012] Gerar arquivo de remessa para Gráfica=
===Atores relacionados===
Funcionário FETAPE.

===Objetivo===
Gerar arquivo de remessa de boletos para Gráfica.

===Prioridade===
Essencial.

===Entradas e pré condições===
'''Entradas:''' lista de boletos que serão enviados para o arquivo. 
'''Pré-condições:''' usuário logado no sistema; os registros dos boletos devem estar armazenados no banco de dados com o status “gerado”.

===Saídas e pós-condições===
'''Saídas:''' mensagem de sucesso da operação; arquivo de remessa para a gráfica (em formato txt e xls). 
'''Pós-condições:''' boletos marcados com o status “enviadoGrafica” no banco na base de dados. 

===Fluxo principal de eventos===
1. Na tela de Listagem de Boletos, o usuário seleciona os boletos e clica no botão Gerar arquivo de boleto para Gráfica (E1, E2); 
2. Sistema verifica se todos os boletos selecionados estão marcados como “gerado” (E3); 
3. Sistema abre tela para que o usuário informe o nome do arquivo e o local onde ele será gerado (E4, E5); 
4. Usuário confirma a geração do arquivo; 
5. Sistema pergunta se o usuário quer gerar o arquivo no formato txt ou xls; 
6. Sistema gera o arquivo de remessa para Gráfica; 
7. Sistema marca no banco os boletos que foram inseridos no arquivo de remessa com o status de “enviadoGrafica” para o banco (E6); 
8. Sistema insere no log de boletos os registros com situação de enviado com a justificativa “boleto gerado no arquivo de remessa para Gráfica pelo usuário X:Y”, onde X corresponde ao login do usuário e Y corresponde ao seu nome; 
9. Sistema salva em diretório especifico no banco uma cópia do arquivo gerado para remessa para Gráfica para fins de histórico; 
10. Sistema retorna o arquivo para que o usuário salve-o em seu computador. 

===Fluxos de exceção===
• E1: se não houver conexão com a internet, uma mensagem será exibida informando que não é possível estabelecer uma conexão com a internet e solicitando ao usuário que verifique sua conexão; 
• E2: se o sistema não estiver disponível, uma mensagem será exibida informando que o serviço não está disponível e que o usuário deve tentar acessá-lo mais tarde; 
• E3: se o sistema não encontrar nenhum arquivo com o status “gerado”, uma mensagem será exibida informando que não existem boletos a serem gerados para o arquivo de remessa. Se encontrar, deverá informar quais os boletos não serão gerados no arquivo; 
• E4: se o usuário informa um local não existente, o sistema pergunta ao usuário se o mesmo deseja que o sistema crie o diretório de pastas informado. Se a resposta for sim, sistema cria diretório de pasta; se a resposta for não, sistema retorna a tela de informação do local para que o usuário selecione um novo diretório; 
• E5: se houver um erro na geração do arquivo de remessa, uma mensagem será exibida informando ao usuário que o arquivo de remessa não pode ser gerado e que o mesmo tente novamente e que, caso o erro persista, entre em contato com a BISA; 
• E6: se houver um erro na alteração dos registros no banco de dados, uma mensagem será exibida informando que não foi possível marcar os boletos como “enviado” e solicitando ao usuário que tente novamente e que, caso o erro persista, entre em contato com a BISA. O sistema deve ainda efetuar todas as rotinas de rollback de modo a não deixar ‘lixo’ no banco de dados. 

=4 Especificações Suplementares=
===4.1 Objetivos===
Este documento tem como finalidade especificar todos os requisitos não funcionais do módulo de boletos web divididos em requisitos de usabilidade, confiabilidade, desempenho, segurança, distribuição, adequação a padrões e requisitos de hardware e software.
===4.2 Usabilidade===
Esta seção descreve os requisitos não funcionais associados à facilidade de uso da interface com o usuário, material de treinamento e documentação do sistema.
=[NF001] Interface com o Usuário=
===Prioridade:===
Desejável
O sistema deve possuir uma interface amigável, simples e intuitiva.
===4.3 Confiabilidade===
Esta seção descreve os requisitos não funcionais associados à freqüência, severidade de falhas do sistema e habilidade de recuperação das mesmas, bem como a corretude do sistema.

=[NF001] Tempo de Retorno após Falha=
===Prioridade:=== Desejável
Retorno de até 5 segundos após alguma falha.
=[NF002] Disponibilidade=
===Prioridade:=== Importante
O sistema estará disponível 24 horas por dia durante todos os dias do ano.
===4.4 Desempenho===
Esta seção descreve os requisitos não funcionais associados à eficiência, uso de recursos e tempo de resposta do sistema.
=[NF001] Número de Acessos=
O sistema deve ser capaz de atender em média 10 usuários por segundo nos momentos de pico de acesso.
=[NF002] Tempo de Resposta para os Usuários=
O tempo máximo de resposta de uma requisição deve ser de no máximo 10 segundos.

===4.5 Segurança===
Esta seção descreve os requisitos não funcionais associados à integridade, privacidade e autenticidade dos dados do sistema.
=[NF001] Privacidade de Acesso=
Apenas os usuários credenciados e com permissão para acesso a este módulo deverão fazer uso das funcionalidades do módulo de boletos/guias na Web.
===4.6 Hardware e software===
Esta seção descreve os requisitos não funcionais associados ao hardware e software usados para desenvolver ou para executar o sistema.
=[NF001] Linguagem de Implementação=
===Prioridade:=== Essencial
A linguagem de implementação do módulo de boleto Web será Delphi, mesma linguagem utilizada no desenvolvimento dos sistemas Partidos2000, Receb2000, OAB2000 e Filiados2000.
=[NF002] Banco de Dados=
===Prioridade:=== Essencial
O banco de dados utilizado será o MySQL.
=[NF003] Ferramentas=
===Prioridade:=== Essencial
Ferramenta de modelagem: Borland Delphi 2006
Ferramenta de Desenvolvimento: Borland Delphi 2006
=[NF004] Plataforma de Funcionamento=
===Prioridade:=== Essencial
A plataforma tanto de desenvolvimento e de funcionamento será Windows.

Para uso do Bw- Construindo

2013-01-24T13:17:18Z

AnaPaula: /* [NF001] Interface com o Usuário */

[[Arquivo:BoletosWeb.PNG]] 

[[Arquivo:Historico_de_revisoes.PNG]] 

=1. Caso de Negócio=
==1.1 Objetivos==

Documentar o novo módulo de geração e impressão de boletos online. As informações aqui descritas especificam e refinam a regras de negócio.

==1.2 Referências==

Se baseará no conhecimento adquirido na implementação de rotinas de boletos da BISA (desktop) e no antigo sistema TRAB_RUR da BISA, em DOS. A entrevista com Mário e Márcio da FETAPE (realizada por Ronaldo e Alexandre) também é referência para a definição dos requisitos.

==1.3 Sistemas com rotinas de gerenciamento de boletos da BISA==

O Filiados 2000 é um sistema desktop de gestão de filiados que controla o cadastro de filiados dos sindicatos de trabalhadores, fazendo acompanhamento de participação na organização.

O OAB 2000 é um software de gestão de cadastro de advogados para OAB's. Faz desde o cadastro de alunos, pré-inscritos, coordena sociedades de advogados, estagiários, até a administração dos dados financeiros dos advogados.

O Receb 2000 é um software voltado para o acompanhamento do contas a receber de uma empresa, fazendo a gestão financeira da carteira de forma simples e eficiente.

Todos esses sistemas possuem uma função de gerenciamento de boletos bancários ou guias sindicais, sendo salvos de forma centralizada no MySQL, de forma que podem ser acessados de forma uniforme no BoletoWEB.

Cada sistema contém suas próprias regras de negócio para gerenciar os boletos; no entanto, as funções de acesso ao banco remoto serão padronizadas para todos os sistemas no BoletoWEB.

==1.4 Descrição do Produto==

A maior parte da implementação é voltada para a FETAPE, enquanto o restante imprime boletos gerados pelos nossos sistema desktop.

Módulo Geral: este módulo tem a função meramente de fornecer uma interface web que permita ao usuário imprimir boletos gerados pelos sistemas desktop da BISA. 

'''Módulo FETAPE:''' no antigo sistema TRAB_RUR da BISA, este sistema é o foco principal desta documentação. Nela o usuário poderá gerenciar todo o fluxo de boletos de contribuições: geração, impressão interna, cadastro de filiados, acesso on-line dos filiados, etc.

==1.5 Contexto de Negócio==

O módulo geral de boletos na web será utilizado a princípio pelos sistemas Receb2000, OAB2000 e Filiados2000, porém poderá ser extendido a qualquer sistema que queira fazer o controle de boletos/guias.

Este módulo concentrará as informações dos boletos em um único local independente de entidade ou sistema. Este local, a priori, ficou definido como sendo um dos servidores internos da BISA que possua acesso externo. Cada sistema rodará normalmente no ambiente do cliente. No momento que for necessário o acesso às informações, este será feito não mais na base local da área do cliente, mas na base remota situada na BISA.

O módulo FETAPE segue as mesmas diretrizes, tendo a diferença de ser implementado exclusivamente para esta entidade, devendo ser adaptável para outras entidades. Para tanto, aconselha-se o uso de uma arquitetura em camadas e padrões de projetos, facilitadores do processos de manutenção.

==1.6 Tecnologias utilizadas==

Os módulos geral e FETAPE deverão implementados utilizando uma tecnologia para web: PHP, Java ou .NET.

O banco de dados necessariamente deverá ser o MySQL, pois já é utilizado na bisa para o registro de boletos.

=2. Sobre os Requisitos=
==2.1 Introdução==

Este documento especifica todos os requisitos funcionais e não funcionais do módulo de gerenciamento de boletos, descrevendo os fluxos de eventos, prioridades, atores, entradas e saídas de cada caso de uso a ser implementado.

A correta interpretação deste documento exige o conhecimento de algumas convenções e termos específicos, que são descritos a seguir.

==2.2 Identificação dos Requisitos==

Por convenção, a referência a requisitos é feita através do nome da subseção onde eles estão descritos, seguidos do identificador do requisito, de acordo com o esquema abaixo:

[nome da subseção, identificador do requisito]

Por exemplo, o requisito funcional [Imprimir Boleto RF002] está descrito em um caso de uso chamado “Imprimir Boleto”, em um bloco identificado pelo identificador [RF002].

==2.3 Prioridades dos Requisitos==

Para estabelecer a prioridade dos requisitos foram adotadas as denominações “essencial”, “importante” e “desejável”. 
• Essencial é o requisito sem o qual o sistema não entra em funcionamento. São requisitos imprescindíveis, que têm que ser implementados. 
• Importante é o requisito sem o qual o sistema entra em funcionamento, mas de forma não satisfatória. Requisitos importantes devem ser implementados, mas, se não forem, o sistema poderá ser implantado e usado mesmo assim. 
• Desejável é o requisito que não compromete as funcionalidades básicas do sistema, isto é, o sistema pode funcionar de forma satisfatória sem ele. Requisitos desejáveis são requisitos que podem ser deixados para versões posteriores do sistema, caso não haja tempo hábil para implementá-los na versão que está sendo especificada. 

==2.4 Descrição dos Atores==

'''Usuário externo'''
É a pessoa que acessa a funcionalidade de impressão de boletos do módulo geral pelo browser.

Filiado FETAPE
Semelhante ao usuário comum, com a diferença de que terá a opção de se cadastrar pelo site.

Funcionário FETAPE
É responsável pelo gerenciamento dos boletos. É o ator principal deste sistema.

=3 Requisitos Funcionais (Casos de Uso)=
==3.1 Ações do Usuário==

==[RF001] Efetuar login==
Atores relacionados
Usuário externo, Filiado FETAPE e Funcionário FETAPE.

===Objetivo===
Fazer login no módulo Web de impressão de boletos.

===Prioridade===
Essencial.

===Entradas e pré condições===
'''Entradas:''' login do usuário e senha;
'''Pré-condições:''' computador deve ter acesso à internet; servidor web disponível.

===Saídas e pós-condições===
'''Saídas:''' não há
'''Pós-condições:''' usuário logado no sistema.

===Fluxo principal de eventos===
1. Usuário executa seu web browser e acessa a página de login (E1, E2); 
2. Usuário informa login e senha e clica em Entrar (E3); 
3. Sistema recupera na base de dados a senha do usuário com o login informado; 
4. Sistema verifica se o login está cadastrado (E4); 
5. Sistema verifica se a senha informada corresponde ao login informado (E5); 
6. Sistema libera o acesso após o sucesso da verificação; 
7. Includes [RF002]. 

===Fluxos de exceção===
• E1: se não houver conexão com a internet, uma mensagem será exibida informando que não é possível estabelecer uma conexão com a internet e solicitando ao usuário que verifique sua conexão; 
• E2: se o sistema não estiver disponível, uma mensagem será exibida informando que o serviço não está disponível e que o usuário deve tentar acessá-lo mais tarde; 
• E3: se o usuário não informar o login ou a senha, o sistema solicita que informe o login e a senha; 
• E4: se o login não estiver cadastrado, o sistema emite uma mensagem de erro informando que este usuário não está cadastrado e solicitando que o mesmo verifique se o login foi digitado corretamente; 
• E5: se a senha não conferir com a que está armazenada na base de dados, o sistema emite uma mensagem de erro avisando que a senha informada está incorreta e solicitando que o mesmo verifique se ela foi digitada corretamente. 

==[RF002] Listar boletos==
===Atores relacionados===
Usuário externo, Filiado FETAPE e Funcionário FETAPE.

===Objetivo===
Listar os boletos correspondentes ao usuário logado.

===Prioridade===
Essencial.

===Entradas e pré condições===
'''Entradas:''' nenhuma.
'''Pré-condições:''' usuário logado no sistema; boletos armazenados no banco de dados.

===Saídas e pós-condições===
'''Saídas:''' lista de boletos.
'''Pós-condições:''' nenhuma.

===Fluxo principal de eventos===
1. Sistema carrega da base de dados os boletos referentes ao usuário (E1, E2, E3); 
2. É exibida a lista de boletos (com check boxes para seleção), cada um com seu número, descrição, valor, vencimento e status (pendente/atrasado/impresso/pago). Os boletos serão ordenados de forma decrescente (maior para o menor) por data de vencimento na lista. Também haverá uma check box que permite a seleção de todos os boletos listados na tela e um limite de boletos a serem exibidos, sendo os demais boletos acessados por uma barra de próximo/anterior (semelhante a um esquema de web mail); 
3. Através de uma caixa de seleção (combo box), o usuário pode filtrar os boletos que serão exibidos na tela de acordo com a opção: “pendentes/impressos/pagos/todos”. Os boletos com status “atrasado” ficarão na lista de “pendentes” e “todos”, mas com uma cor de linha de grid que os diferencie dos demais (ex. vermelho). O status inicial do filtro é “pendentes”. 

===Fluxos de exceção===
• E1: se não houver conexão com a internet, uma mensagem será exibida informando que não é possível estabelecer uma conexão com a internet e solicitando ao usuário que verifique sua conexão; 
• E2: se o sistema não estiver disponível, uma mensagem será exibida informando que o serviço não está disponível e que o usuário deve tentar acessá-lo mais tarde; 
• E3: se o resultado da busca retornar vazio, uma mensagem será exibida informando ao usuário que não existe dados referentes à consulta realizada. 

=[RF003] Geração de boletos=
===Atores relacionados===
Usuário externo, Filiado FETAPE e Funcionário FETAPE.

===Objetivo===
Gerar registros de boletos no banco de dados para impressão. Não constitui a impressão do boleto em si.

===Prioridade===
Essencial.

===Entradas e pré condições===
'''Entradas:''' filiado(s)/usuário(s), banco, data de vencimento, modelo da guia, nosso número inicial, valor e instruções.
'''Pré-condições:''' usuário logado no sistema; sindicatos e filiados armazenados no banco de dados.

===Saídas e pós-condições===
'''Saídas:''' mensagem de aviso de sucesso da operação. 
'''Pós-condições:''' registro dos boletos inseridos no banco de dados.

===Fluxo principal de eventos===
1. Usuário Externo e Filiado FETAPE: usuário clica no botão Gerar Boletos. Se o usuário estiver com o status óbito, não será gerado boleto. Funcionário FETAPE: funcionário seleciona uma quantidade de filiados na tela de Listagem de Filiados e clica no botão Gerar Boletos. Os filiados com o status “óbito” nunca serão carregados; 
2. Sistema carrega o(s) usuários(s)/filiado(s) selecionados com seus respectivos dados (E1, E2, E3, E4); 
3. Uma janela é aberta perguntando se o usuário deseja imprimir boletos referentes a Contribuição Sindical e Contribuição Confederativa (2 check boxes); 
4. Uma tela é aberta onde o usuário informa os dados (banco, data de vencimento, modelo da guia, nosso número inicial, valor e instruções) para os boletos. Usuário confirma a operação; 
5. Sistema valida os dados inseridos pelo usuário e os dados obrigatórios para emissão de boleto (E5, E6); 
6. Sistema gera os boletos e os armazena no banco de dados com o status “gerado” (E7). O sistema deverá verificar se o número de boleto que ele irá gerar existe em algum intervalo na tabela de boletos avulso. Se existir, ele deverá gerar um próximo número que não esteja em um intervalo desta tabela; 
7. Sistema insere os registros de log da situação dos boletos no banco remoto com a justificava “gerado a partir da função de geração de boleto pelo usuário X:Y”, onde X corresponde ao login do funcionário e Y corresponde ao seu nome; 
8. Sistema exibe mensagem confirmando o sucesso na geração dos boletos e perguntando se o usuário deseja fazer a impressão dos mesmos; 
9. Se o usuário responder que sim, a janela de impressão padrão da funcionalidade imprimir é aberta. Includes [RF004]. 

===Filiado FETAPE===
Este usuário também terá acesso à rotina de CANCELAMENTO do boleto, que consiste meramente na exclusão do mesmo da base de dados. Vale salientar que devem ser efetuados os devidos registros no log do sistema seguindo o padrão supracitado, assim como devem ser atendidos os seguintes fluxos de exceção: 
1. Se o boleto possuir o status “pago”, “impresso” ou “enviado” (para o banco), o cancelamento não será permitido. O sistema exibirá uma mensagem de erro avisando que o boleto não pode ser impresso, indicando o seu status atual; 
2. Se o boleto requisitado não puder ser excluído, o sistema exibe uma mensagem de erro solicitando que o boleto não poder ser removido no momento. 

===Fluxos de exceção===
• E1: se não houver conexão com a internet, uma mensagem será exibida informando que não é possível estabelecer uma conexão com a internet e solicitando ao usuário que verifique sua conexão; 
• E2: se o sistema não estiver disponível, uma mensagem será exibida informando que o serviço não está disponível e que o usuário deve tentar acessá-lo mais tarde; 
• E3: se o resultado da busca retornar vazio, uma mensagem será exibida informando ao usuário que não existem dados referentes à consulta realizada; 
• E4: se o sistema não conseguir acessar a base de dados, uma mensagem será exibida informando ao usuário que a base de dados está inacessível; 
• E5: se o usuário não preencher os dados obrigatórios do boleto (banco, data de vencimento, modelo da guia, nosso número inicial e valor), uma mensagem será exibida informando ao usuário que os campos obrigatórios devem ser preenchidos; 
• E6: se os dados obrigatórios do(s) usuário(s)/filiado(s) para emissão de boleto não foram preenchidos (nome, logradouro, bairro, cidade, estado e CEP), o sistema lista na tela os usuário(s)/filiado(s) cujos dados obrigatórios não estão preenchidos e, para cada um, informa quais campos devem ser preenchidos. O usuário poderá prosseguir para a tela de marcação dos boletos que serão impressos (botão “prosseguir”), no entanto os boletos cujos dados não estão completos não aparecerão para seleção; 
• E7: se houver um estouro na numeração de boletos*, o sistema exibe uma mensagem solicitando ao usuário que entre em contato com a BISA pois houve um problema na geração da numeração do boleto. A operação não é finalizada. O sistema deve ainda efetuar todas as rotinas de rollback de modo a não deixar ‘lixo’ no banco de dados. 

<nowiki>*</nowiki> O estouro na numeração de boletos ocorre quando o limite do número de boletos cadastrado no banco de dados é atingido. Por exemplo, supondo um limite de 10 bytes, se o último registro cadastrado for 9999999999, o próximo registro de boleto irá acionar este erro. 

=[RF004] Imprimir boletos=
===Atores relacionados===
Usuário externo, Filiado FETAPE e Funcionário FETAPE.

===Objetivo===
Constitui a impressão de um boleto já gerado no sistema.

===Prioridade===
Essencial.

===Entradas e pré condições===
'''Entradas:''' lista de boletos para impressão. 
'''Pré-condições:''' o usuário deve estar logado no sistema na tela da listagem de boletos (RF002); os registros dos boletos devem estar armazenados no banco de dados e marcados como “não impresso”.

===Saídas e pós-condições===
'''Saídas:''' impressão dos boletos selecionados. 
'''Pós-Condições:''' registros dos boletos marcados no banco como “impresso”.

===Fluxo principal de eventos===
1. Usuário seleciona na Lista de boletos aqueles que deseja imprimir (check box) e clica no botão Imprimir (E1, E2, E3, E4, E5); 
2. Se o usuário houver selecionado apenas um boleto, o sistema imprime o boleto no navegador, permitindo ao usuário conferir seus dados. Depois disso, ele clica em um novo botão Imprimir e passa para o passo 3; 
3. Janela de impressão padrão é aberta (onde o usuário poderá selecionar impressora, quantidade de páginas, etc). Usuário confirma a impressão e o sistema envia os arquivos para a impressora (E6); 
4. Sistema marca no banco os boletos que foram impressos com o status “impresso” (E7); 
5. Sistema insere no log de boletos os registros com o status impresso com a justificativa “impresso pela função de impressão de boletos pelo usuário X:Y”, onde X corresponde ao código do usuário e Y ao seu nome. 
6. Sistema exibe uma mensagem de “Boletos impressos com sucesso”. 

===Fluxos de exceção===
• E1: se não houver conexão com a internet, uma mensagem será exibida informando que não é possível estabelecer uma conexão com a internet e solicitando ao usuário que verifique sua conexão; 
• E2: se o sistema não estiver disponível, uma mensagem será exibida informando que o serviço não está disponível e que o usuário deve tentar acessá-lo mais tarde; 
• E3: se o usuário não selecionar boletos, o sistema exibe uma mensagem solicitando ao usuário que selecione boletos para impressão; 
• E4: se na lista houver boletos que já foram pagos, o sistema exibe uma mensagem de erro informando que boletos pagos não podem ser reimpressos e cancela a operação; 
• E5: se houver boletos que já foram impressos, o sistema exibe um alerta informando que os boletos já foram impressos pelo sistema e serão reimpressos nesta operação; continua a executar normalmente; 
• E6: se houver um erro ao enviar os dados para a impressora, o sistema exibe uma mensagem avisando ao usuário que o sistema não conseguiu imprimir e solicitando que o mesmo verifique se a impressora está pronta para impressão; 
• E7: se houver um erro na alteração dos registros no banco de dados, uma mensagem será exibida informando que não foi possível marcar os boletos como impressos e solicitando ao usuário que tente novamente e que, caso o erro persista, entre em contato com a BISA. O sistema deve ainda efetuar todas as rotinas de rollback de modo a não deixar ‘lixo’ no banco de dados. 

=[RF005] Cadastro de filiado=
===Atores relacionados===
Filiado FETAPE e Funcionário FETAPE.

===Objetivo===
Cadastrar um filiado. As rotinas de ALTERAÇÃO e de EXCLUSÃO também estão contidas neste requisito para o Funcionário FETAPE.

===Prioridade===
Essencial.

===Entradas e pré condições===
'''Entradas:''' dados cadastrais do usuário. 
'''Pré-condições:''' computador deve ter acesso à internet; servidor web disponível. Funcionário: usuário cadastrado no sistema. 

===Saídas e pós-condições===
'''Saídas:''' mensagem avisando que o usuário foi cadastrado com sucesso. 
'''Pós-Condições:''' usuário cadastrado no banco de dados. 

===Fluxo principal de eventos===
1. Ator Filiado: a função “Cadastrar Filiado” é acionada pelo usuário no navegador web (E1, E2). Ator Funcionário: a função “Cadastrar Filiado” é acionada pelo usuário na tela de Listagem de Filiados (E1, E2). 
2. Um formulário é aberto solicitando dados cadastrais: login, senha, nome, CPF, CNAE, bairro, cidade, UF, logradouro, CEP, categoria (seleção entre as opções arrendatário, assentado, meeiro, parceiro, posseiro, pequeno proprietário e outros) e apelido do filiado; 
3. Usuário preenche os campos e confirma a operação (E3, E4, E5, E6); 
4. Sistema insere os registros de log da situação no banco remoto com a justificava “cadastrado pelo usuário X:Y”, onde X corresponde ao login do usuário e Y corresponde ao seu nome; 
5. Sistema retorna uma mensagem avisando que o usuário foi cadastrado com sucesso. 

O sistema também apresenta as rotinas de ALTERAÇÃO, que por ser trivial e seguir um fluxo semelhante à rotina de inclusão não terá sua execução descrita aqui. Vale salientar que devem ser efetuados os devidos registros no log do sistema. 

===Filiado FETAPE===
Ele possui também a funcionalidade EXCLUSÃO. Sua tela de ALTERAR é diferente. Nela, o usuário pode marcar um check box “óbito” para filiados que foram a óbito.

===Fluxos de exceção===
• E1: se não houver conexão com a internet, uma mensagem será exibida informando que não é possível estabelecer uma conexão com a internet e solicitando ao usuário que verifique sua conexão; 
• E2: se o sistema não estiver disponível, uma mensagem será exibida informando que o serviço não está disponível e que o usuário deve tentar acessá-lo mais tarde; 
• E3: se o login fornecido já estiver cadastrado no sistema, uma mensagem será exibida informando ao usuário que o login cadastrado já existe no sistema; 
• E4: se o CPF do filiado for inválido, uma mensagem será exibida informando ao usuário que o CPF cadastrado é inválido. Vale salientar que o preenchimento deste campo é opcional; 
• E5: se houver um erro na inserção dos registros no banco de dados, uma mensagem será exibida informando que não foi possível inserir os dados e solicitando ao usuário que tente novamente e que, caso o erro persista, entre em contato com a BISA. O sistema deve ainda efetuar todas as rotinas de rollback de modo a não deixar ‘lixo’ no banco de dados; 
• E6: se os dados obrigatórios dos filiados não forem preenchidos (nome, logradouro, bairro, cidade, estado e CEP), o sistema emite uma mensagem de erro informando quais os campos obrigatórios não foram preenchidos. 

=[RF006] Listar filiados=
===Atores relacionados===
Funcionário FETAPE.

===Objetivo===
Listar todos os filiados cadastrados no sistema.

===Prioridade===
Essencial.

===Entradas e pré condições===
'''Entradas:''' nenhuma.
'''Pré-condições:''' usuário logado no sistema; filiados armazenados no banco de dados.

===Saídas e pós-condições===
'''Saídas:''' lista de filiados. 
'''Pós-condições:''' nenhuma. 

===Fluxo principal de eventos===
1. Usuário clica no botão Filiados da barra de funções do sistema para acessar a Listagem de Filiados; 
2. Sistema carrega da base de dados os filiados com seus respectivos dados (E1, E2, E3, E4); 
3. É exibida a lista de filiados (com check boxes para seleção), cada um com seu número, nome, apelido, CPF, município, sindicato e categoria. Os filiados serão ordenados por ordem alfabética e agrupados por município. Também haverá uma check box que permite a seleção de todos os filiados listados na tela e um limite de filiados a serem exibidos, sendo os demais acessados por uma barra de próximo/anterior (semelhante a um esquema de web mail); 
4. Através de uma caixa de seleção (combo box), o usuário pode filtrar os filiados que serão exibidos na tela de acordo com a opção: “nome/apelido/município/sindicato”. A opção “nome” é a padrão. Os filiados que foram a óbito serão exibidos com uma cor de linha de grid acinzentada e só serão exibidos se um check box “todos” for ativado. 

===Fluxos de exceção===
• E1: se não houver conexão com a internet, uma mensagem será exibida informando que não é possível estabelecer uma conexão com a internet e solicitando ao usuário que verifique sua conexão; 
• E2: se o sistema não estiver disponível, uma mensagem será exibida informando que o serviço não está disponível e que o usuário deve tentar acessá-lo mais tarde; 
• E3: se o resultado da busca retornar vazio, uma mensagem será exibida informando ao usuário que não existem dados referentes à consulta realizada; 
• E4: se o sistema não conseguir acessar a base de dados, uma mensagem será exibida informando ao usuário que a base de dados está inacessível. 

=[RF007] Cadastro de sindicato=
===Atores relacionados===
Funcionário FETAPE.

===Objetivo===
Cadastrar um sindicato. As rotinas de ALTERAÇÃO e de EXCLUSÃO também estão contidas neste requisito.

===Prioridade===
Essencial.

===Entradas e pré condições===
'''Entradas:''' dados do sindicato; dados do Município (já presentes na base de dados, herdada do antigo sistema DOS TRAB_RUR). 
'''Pré-condições:''' usuário logado no sistema. 

===Saídas e pós-condições===
'''Saídas:''' mensagem avisando que o sindicato foi cadastrado com sucesso. 
'''Pós-Condições:''' sindicato cadastrado no banco de dados. 

Fluxo principal de eventos
1. Usuário clica no botão cadastrar na tela de Listagem de Sindicatos (E1, E2); 
2. Um formulário é aberto solicitando dados cadastrais: nome, município, UF, endereço; 
3. Usuário preenche os campos e confirma a operação (E3); 
4. Sistema insere os registros de log da situação no banco remoto com a justificava “cadastrado pelo usuário X:Y”, onde X corresponde ao login do funcionário e Y corresponde ao seu nome; 
5. Sistema retorna uma mensagem avisando que o sindicato foi cadastrado com sucesso. 

Também haverá rotinas de alteração e de exclusão. O processo é trivial para ser descrito aqui. Vale salientar que devem ser efetuados os devidos registros no log do sistema. 

===Fluxos de exceção===
• E1: se não houver conexão com a internet, uma mensagem será exibida informando que não é possível estabelecer uma conexão com a internet e solicitando ao usuário que verifique sua conexão; 
• E2: se o sistema não estiver disponível, uma mensagem será exibida informando que o serviço não está disponível e que o usuário deve tentar acessá-lo mais tarde; 
• E3: se houver um erro na inserção dos registros no banco de dados, uma mensagem será exibida informando que não foi possível inserir os dados e solicitando ao usuário que tente novamente e que, caso o erro persista, entre em contato com a BISA. O sistema deve ainda efetuar todas as rotinas de rollback de modo a não deixar ‘lixo’ no banco de dados; 

=[RF008] Listar sindicatos=
===Atores relacionados===
Funcionário FETAPE.

===Objetivo===
Listar todos os sindicatos cadastrados no sistema.

===Prioridade===
Essencial.

===Entradas e pré condições===
'''Entradas:''' nenhuma. 
'''Pré-condições:''' usuário logado no sistema; sindicatos armazenados no banco de dados. 

===Saídas e pós-condições===
'''Saídas:''' lista de sindicatos. 
'''Pós-condições:''' nenhuma. 

===Fluxo principal de eventos===
1. Usuário clica no botão Sindicatos da barra de funções do sistema para acessar a Listagem de Sindicatos; 
2. Sistema carrega da base de dados os sindicatos com seus respectivos dados (E1, E2, E3, E4); 
3. É exibida a lista de sindicatos (com check boxes para seleção), cada um com seu número, nome e município. Os sindicatos serão ordenados por ordem alfabética e agrupados por município. Também haverá uma check box que permite a seleção de todos os sindicatos listados na tela e um limite de sindicatos a serem exibidos, sendo os demais acessados por uma barra de próximo/anterior (semelhante a um esquema de web mail); 
4. Através de uma caixa de seleção (combo box), o usuário pode filtrar os sindicatos que serão exibidos na tela de acordo com a opção: “nome/município”. A opção “nome” é a padrão. 

===Fluxos de exceção===
• E1: se não houver conexão com a internet, uma mensagem será exibida informando que não é possível estabelecer uma conexão com a internet e solicitando ao usuário que verifique sua conexão; 
• E2: se o sistema não estiver disponível, uma mensagem será exibida informando que o serviço não está disponível e que o usuário deve tentar acessá-lo mais tarde; 
• E3: se o resultado da busca retornar vazio, uma mensagem será exibida informando ao usuário que não existem dados referentes à consulta realizada; 
• E4: se o sistema não conseguir acessar a base de dados, uma mensagem será exibida informando ao usuário que a base de dados está inacessível. 

===[RF009] Baixar Boleto===
===Atores relacionados===
Funcionário FETAPE.

===Objetivo===
Baixa nos boletos que foram impressos. Eles passarão a ter o status de pago.

===Prioridade===
Essencial.

===Entradas e pré condições===
'''Entradas:''' lista de boletos para baixa.
'''Pré-condições:''' usuário logado no sistema; os registros dos boletos devem estar armazenados no banco de dados.

===Saídas e pós-condições===
'''Saídas:''' mensagem de aviso de sucesso da operação. 
'''Pós-condições:''' registro dos boletos marcados no banco como “pagos”. 

===Fluxo principal de eventos===
1. Usuário seleciona na Lista de boletos aqueles que deseja baixar (check box) e clica no botão Baixar (E1, E2, E3, E4, E5); 
2. Sistema marca no banco os boletos como pagos (E6). Se o boleto não for encontrado na tabela de boletos, deverá ser procurado na tabela de boletos avulsos (E7); 
3. Sistema insere no log de boletos os registros com o status impresso com a justificativa “baixado pela função de baixar de boletos pelo usuário X:Y”, onde X corresponde ao código do usuário e Y ao seu nome; 
4. Sistema exibe uma mensagem de “Boletos baixados com sucesso”. 

===Fluxos de exceção===
• E1: se não houver conexão com a internet, uma mensagem será exibida informando que não é possível estabelecer uma conexão com a internet e solicitando ao usuário que verifique sua conexão; 
• E2: se o sistema não estiver disponível, uma mensagem será exibida informando que o serviço não está disponível e que o usuário deve tentar acessá-lo mais tarde; 
• E3: se o usuário não selecionar boletos, o sistema exibe uma mensagem solicitando ao usuário que selecione boletos para impressão; 
• E4: se na lista houver boletos com o status “pago”, o sistema exibe uma mensagem informando que boletos selecionados já foram baixados. Se o usuário clicar em continuar, o sistema continua a execução e ignora esses boletos; 
• E5: se na lista houver boletos com o status diferente de “impresso” ou “enviado” (enviado para o banco), o sistema exibe uma mensagem informando que há boletos selecionados que ainda não foram impressos ou enviados para o banco e quais são estes boletos. Se o usuário clicar em continuar, o sistema continua a execução e ignora esses boletos; 
• E6: se houver um erro na alteração dos registros no banco de dados, uma mensagem será exibida informando que não foi possível marcar os boletos como pagos e solicitando ao usuário que tente novamente e que, caso o erro persista, entre em contato com a BISA. O sistema deve ainda efetuar todas as rotinas de rollback de modo a não deixar ‘lixo’ no banco de dados; 
• E7: se o registro do boleto não for encontrado no banco, o sistema exibirá uma mensagem de erro indicando que o boleto não foi encontrado na base de dados do sistema. 

=[RF010] Baixar Boleto Automaticamente (via Arquivo de Retorno do Banco)=
===Atores relacionados===
Funcionário FETAPE.

===Objetivo===
Baixar de boletos a partir de um arquivo de retorno que o banco envia.

===Prioridade===
Essencial.

===Entradas e pré condições===
'''Entradas:''' arquivo de retorno do banco. 
'''Pré-condições:''' usuário logado no sistema; os registros dos boletos devem estar armazenados no banco de dados. 

===Saídas e pós-condições===
'''Saídas:''' mensagem de sucesso da operação. 
'''Pós-condições:''' registro dos boletos marcados no banco como “pagos”. 

===Fluxo principal de eventos===
1. Na tela da Lista de boletos, usuário clica na opção Baixa com Arquivo do Banco (E1, E2); 
2. Uma tela é aberta perguntando qual o arquivo de retorno do banco. O usuário então seleciona o caminho no seu computador correspondente à localização do arquivo e clica em OK. O sistema irá, então, fazer o upload do arquivo (E3, E4, E5); 
3. Sistema guarda a identificação do arquivo de retorno com situação de ‘não processado’ na base de dados e guarda uma cópia do arquivo em diretório especifico para histórico; 
4. Para cada linha do arquivo de retorno, o sistema procura o boleto referente na base de dados de boletos de contribuição. Se o boleto não for encontrado, o sistema procura na base de dados de boletos avulsos. Nesta base, há registros de boletos com intervalos (ex. de 001 a 100). O sistema irá buscar o número do boleto nessa faixa (E6); 
5. O sistema verifica se o boleto encontrado está marcado como “impresso” ou “enviado” (para o banco). Se estiver, o sistema marca no banco de dados o boleto como “pago” (E7); 
6. O sistema insere no log de boletos o registro com situação de “pago” com a justificativa ‘baixado pela função de baixa automática de boleto pelo usuário X:Y’, onde X corresponde ao login de usuário e Y corresponde ao seu nome; 
7. O Sistema marca o arquivo de retorno como ‘processado sem erros’ e uma exibe mensagem confirmando o sucesso na baixa dos boletos. 

===Fluxos de exceção===
• E1: se não houver conexão com a internet, uma mensagem será exibida informando que não é possível estabelecer uma conexão com a internet e solicitando ao usuário que verifique sua conexão; 
• E2: se o sistema não estiver disponível, uma mensagem será exibida informando que o serviço não está disponível e que o usuário deve tentar acessá-lo mais tarde; 
• E3: se o usuário não apontar nenhum arquivo de retorno, uma mensagem será exibida exigindo que o usuário aponte o arquivo; 
• E4: se o caminho para o arquivo estiver incorreto, o sistema exibe uma mensagem para o usuário informando que o caminho selecionado é inválido; 
• E5: se o formato do arquivo não corresponder ao formato do arquivo de retorno do banco esperado, o sistema exibirá uma mensagem informando que o formato do arquivo selecionado é inválido; 
• E6: se um registro do arquivo não for encontrado no sistema (base principal e base de boletos avulsos), será exibido numa tela todos os registros que não foram encontrados. A situação do arquivo de retorno no banco deve então mudar para “processado com erro” e o sistema deve inserir o registro de log de boleto com a justificativa “boleto não pode ser baixado, pois o mesmo não foi encontrado no sistema. Ação executada pelo usuário X:Y”, onde X é o login e Y é o nome. O valor do boleto pago e não encontrado deverá ser armazenado na tabela de boletos no registro cujo identificador é “BoletoXXXX”. Todo boleto que não for encontrado deverá ser somado ao valor desse registro; 
• E7: se houver um erro na alteração dos registros no banco de dados, uma mensagem será exibida informando que não foi possível marcar os boletos como “pago” e solicitando ao usuário que tente novamente e que, caso o erro persista, entre em contato com a BISA. O sistema deve ainda efetuar todas as rotinas de rollback de modo a não deixar ‘lixo’ no banco de dados. 

=[RF011] Gerar arquivo de remessa para banco=
===Atores relacionados===
===Funcionário FETAPE.===

===Objetivo===
Gerar arquivo de remessa de boletos para o banco.

===Prioridade===
Essencial.

===Entradas e pré condições===
'''Entradas:''' lista de boletos que serão enviados para o arquivo. 
'''Pré-condições:''' usuário logado no sistema; os registros dos boletos devem estar armazenados no banco de dados com o status “gerado” ou “impresso”. 

===Saídas e pós-condições===
'''Saídas:''' mensagem de sucesso da operação; arquivo de remessa para o banco. 
'''Pós-condições:''' boletos marcados com o status “enviado” no banco na base de dados. 

===Fluxo principal de eventos===
1. Na tela de Listagem de Boletos, o usuário seleciona os boletos e clica no botão Gerar de arquivo de remessa (E1, E2); 
2. Sistema verifica se todos os boletos selecionados estão marcados como “gerado” ou “impresso” (E3); 
3. Sistema abre tela para que o usuário informe o nome do arquivo e o local onde ele será gerado (E4, E5); 
4. Usuário confirma a geração do arquivo; 
5. Sistema gera o arquivo de remessa; 
6. Sistema marca no banco os boletos que foram inseridos no arquivo de remessa com o status de “enviado” para o banco (E6); 
7. Sistema insere no log de boletos os registros com situação de enviado com a justificativa “boleto gerado no arquivo de remessa para o banco pelo usuário X:Y”, onde X corresponde ao login do usuário e Y corresponde ao seu nome; 
8. Sistema salva em diretório especifico no banco uma cópia do arquivo gerado para remessa para fins de histórico; 
9. Sistema retorna o arquivo de remessa para que o usuário salve-o em seu computador. 

===Fluxos de exceção===
• E1: se não houver conexão com a internet, uma mensagem será exibida informando que não é possível estabelecer uma conexão com a internet e solicitando ao usuário que verifique sua conexão; 
• E2: se o sistema não estiver disponível, uma mensagem será exibida informando que o serviço não está disponível e que o usuário deve tentar acessá-lo mais tarde; 
• E3: se o sistema não encontrar nenhum arquivo com o status “gerado” ou “impresso”, uma mensagem será exibida informando que não existem boletos a serem gerados para o arquivo de remessa. Se encontrar, deverá informar quais os boletos não serão gerados no arquivo; 
• E4: se o usuário informa um local não existente, o sistema pergunta ao usuário se o mesmo deseja que o sistema crie o diretório de pastas informado. Se a resposta for sim, sistema cria diretório de pasta; se a resposta for não, sistema retorna a tela de informação do local para que o usuário selecione um novo diretório; 
• E5: se houver um erro na geração do arquivo de remessa, uma mensagem será exibida informando ao usuário que o arquivo de remessa não pode ser gerado e que o mesmo tente novamente e que, caso o erro persista, entre em contato com a BISA.; 
• E6: se houver um erro na alteração dos registros no banco de dados, uma mensagem será exibida informando que não foi possível marcar os boletos como “enviado” e solicitando ao usuário que tente novamente e que, caso o erro persista, entre em contato com a BISA. O sistema deve ainda efetuar todas as rotinas de rollback de modo a não deixar ‘lixo’ no banco de dados. 

=[RF012] Gerar arquivo de remessa para Gráfica=
===Atores relacionados===
Funcionário FETAPE.

===Objetivo===
Gerar arquivo de remessa de boletos para Gráfica.

===Prioridade===
Essencial.

===Entradas e pré condições===
'''Entradas:''' lista de boletos que serão enviados para o arquivo. 
'''Pré-condições:''' usuário logado no sistema; os registros dos boletos devem estar armazenados no banco de dados com o status “gerado”.

===Saídas e pós-condições===
'''Saídas:''' mensagem de sucesso da operação; arquivo de remessa para a gráfica (em formato txt e xls). 
'''Pós-condições:''' boletos marcados com o status “enviadoGrafica” no banco na base de dados. 

===Fluxo principal de eventos===
1. Na tela de Listagem de Boletos, o usuário seleciona os boletos e clica no botão Gerar arquivo de boleto para Gráfica (E1, E2); 
2. Sistema verifica se todos os boletos selecionados estão marcados como “gerado” (E3); 
3. Sistema abre tela para que o usuário informe o nome do arquivo e o local onde ele será gerado (E4, E5); 
4. Usuário confirma a geração do arquivo; 
5. Sistema pergunta se o usuário quer gerar o arquivo no formato txt ou xls; 
6. Sistema gera o arquivo de remessa para Gráfica; 
7. Sistema marca no banco os boletos que foram inseridos no arquivo de remessa com o status de “enviadoGrafica” para o banco (E6); 
8. Sistema insere no log de boletos os registros com situação de enviado com a justificativa “boleto gerado no arquivo de remessa para Gráfica pelo usuário X:Y”, onde X corresponde ao login do usuário e Y corresponde ao seu nome; 
9. Sistema salva em diretório especifico no banco uma cópia do arquivo gerado para remessa para Gráfica para fins de histórico; 
10. Sistema retorna o arquivo para que o usuário salve-o em seu computador. 

===Fluxos de exceção===
• E1: se não houver conexão com a internet, uma mensagem será exibida informando que não é possível estabelecer uma conexão com a internet e solicitando ao usuário que verifique sua conexão; 
• E2: se o sistema não estiver disponível, uma mensagem será exibida informando que o serviço não está disponível e que o usuário deve tentar acessá-lo mais tarde; 
• E3: se o sistema não encontrar nenhum arquivo com o status “gerado”, uma mensagem será exibida informando que não existem boletos a serem gerados para o arquivo de remessa. Se encontrar, deverá informar quais os boletos não serão gerados no arquivo; 
• E4: se o usuário informa um local não existente, o sistema pergunta ao usuário se o mesmo deseja que o sistema crie o diretório de pastas informado. Se a resposta for sim, sistema cria diretório de pasta; se a resposta for não, sistema retorna a tela de informação do local para que o usuário selecione um novo diretório; 
• E5: se houver um erro na geração do arquivo de remessa, uma mensagem será exibida informando ao usuário que o arquivo de remessa não pode ser gerado e que o mesmo tente novamente e que, caso o erro persista, entre em contato com a BISA; 
• E6: se houver um erro na alteração dos registros no banco de dados, uma mensagem será exibida informando que não foi possível marcar os boletos como “enviado” e solicitando ao usuário que tente novamente e que, caso o erro persista, entre em contato com a BISA. O sistema deve ainda efetuar todas as rotinas de rollback de modo a não deixar ‘lixo’ no banco de dados. 

=4 Especificações Suplementares=
===4.1 Objetivos===
Este documento tem como finalidade especificar todos os requisitos não funcionais do módulo de boletos web divididos em requisitos de usabilidade, confiabilidade, desempenho, segurança, distribuição, adequação a padrões e requisitos de hardware e software.
===4.2 Usabilidade===
Esta seção descreve os requisitos não funcionais associados à facilidade de uso da interface com o usuário, material de treinamento e documentação do sistema.
=[NF001] Interface com o Usuário=
===Prioridade:=== Desejável
O sistema deve possuir uma interface amigável, simples e intuitiva.
===4.3 Confiabilidade===
Esta seção descreve os requisitos não funcionais associados à freqüência, severidade de falhas do sistema e habilidade de recuperação das mesmas, bem como a corretude do sistema.
=[NF001] Tempo de Retorno após Falha=
===Prioridade:=== Desejável
Retorno de até 5 segundos após alguma falha.
=[NF002] Disponibilidade=
===Prioridade:=== Importante
O sistema estará disponível 24 horas por dia durante todos os dias do ano.
===4.4 Desempenho===
Esta seção descreve os requisitos não funcionais associados à eficiência, uso de recursos e tempo de resposta do sistema.
=[NF001] Número de Acessos=
O sistema deve ser capaz de atender em média 10 usuários por segundo nos momentos de pico de acesso.
=[NF002] Tempo de Resposta para os Usuários=
O tempo máximo de resposta de uma requisição deve ser de no máximo 10 segundos.

===4.5 Segurança===
Esta seção descreve os requisitos não funcionais associados à integridade, privacidade e autenticidade dos dados do sistema.
=[NF001] Privacidade de Acesso=
Apenas os usuários credenciados e com permissão para acesso a este módulo deverão fazer uso das funcionalidades do módulo de boletos/guias na Web.
===4.6 Hardware e software===
Esta seção descreve os requisitos não funcionais associados ao hardware e software usados para desenvolver ou para executar o sistema.
=[NF001] Linguagem de Implementação=
===Prioridade:=== Essencial
A linguagem de implementação do módulo de boleto Web será Delphi, mesma linguagem utilizada no desenvolvimento dos sistemas Partidos2000, Receb2000, OAB2000 e Filiados2000.
=[NF002] Banco de Dados=
===Prioridade:=== Essencial
O banco de dados utilizado será o MySQL.
=[NF003] Ferramentas=
===Prioridade:=== Essencial
Ferramenta de modelagem: Borland Delphi 2006
Ferramenta de Desenvolvimento: Borland Delphi 2006
=[NF004] Plataforma de Funcionamento=
===Prioridade:=== Essencial
A plataforma tanto de desenvolvimento e de funcionamento será Windows.

Para uso do Bw- Construindo

2013-01-24T13:14:04Z

AnaPaula: /* 4 Especificações Suplementares */

[[Arquivo:BoletosWeb.PNG]] 

[[Arquivo:Historico_de_revisoes.PNG]] 

=1. Caso de Negócio=
==1.1 Objetivos==

Documentar o novo módulo de geração e impressão de boletos online. As informações aqui descritas especificam e refinam a regras de negócio.

==1.2 Referências==

Se baseará no conhecimento adquirido na implementação de rotinas de boletos da BISA (desktop) e no antigo sistema TRAB_RUR da BISA, em DOS. A entrevista com Mário e Márcio da FETAPE (realizada por Ronaldo e Alexandre) também é referência para a definição dos requisitos.

==1.3 Sistemas com rotinas de gerenciamento de boletos da BISA==

O Filiados 2000 é um sistema desktop de gestão de filiados que controla o cadastro de filiados dos sindicatos de trabalhadores, fazendo acompanhamento de participação na organização.

O OAB 2000 é um software de gestão de cadastro de advogados para OAB's. Faz desde o cadastro de alunos, pré-inscritos, coordena sociedades de advogados, estagiários, até a administração dos dados financeiros dos advogados.

O Receb 2000 é um software voltado para o acompanhamento do contas a receber de uma empresa, fazendo a gestão financeira da carteira de forma simples e eficiente.

Todos esses sistemas possuem uma função de gerenciamento de boletos bancários ou guias sindicais, sendo salvos de forma centralizada no MySQL, de forma que podem ser acessados de forma uniforme no BoletoWEB.

Cada sistema contém suas próprias regras de negócio para gerenciar os boletos; no entanto, as funções de acesso ao banco remoto serão padronizadas para todos os sistemas no BoletoWEB.

==1.4 Descrição do Produto==

A maior parte da implementação é voltada para a FETAPE, enquanto o restante imprime boletos gerados pelos nossos sistema desktop.

Módulo Geral: este módulo tem a função meramente de fornecer uma interface web que permita ao usuário imprimir boletos gerados pelos sistemas desktop da BISA. 

'''Módulo FETAPE:''' no antigo sistema TRAB_RUR da BISA, este sistema é o foco principal desta documentação. Nela o usuário poderá gerenciar todo o fluxo de boletos de contribuições: geração, impressão interna, cadastro de filiados, acesso on-line dos filiados, etc.

==1.5 Contexto de Negócio==

O módulo geral de boletos na web será utilizado a princípio pelos sistemas Receb2000, OAB2000 e Filiados2000, porém poderá ser extendido a qualquer sistema que queira fazer o controle de boletos/guias.

Este módulo concentrará as informações dos boletos em um único local independente de entidade ou sistema. Este local, a priori, ficou definido como sendo um dos servidores internos da BISA que possua acesso externo. Cada sistema rodará normalmente no ambiente do cliente. No momento que for necessário o acesso às informações, este será feito não mais na base local da área do cliente, mas na base remota situada na BISA.

O módulo FETAPE segue as mesmas diretrizes, tendo a diferença de ser implementado exclusivamente para esta entidade, devendo ser adaptável para outras entidades. Para tanto, aconselha-se o uso de uma arquitetura em camadas e padrões de projetos, facilitadores do processos de manutenção.

==1.6 Tecnologias utilizadas==

Os módulos geral e FETAPE deverão implementados utilizando uma tecnologia para web: PHP, Java ou .NET.

O banco de dados necessariamente deverá ser o MySQL, pois já é utilizado na bisa para o registro de boletos.

=2. Sobre os Requisitos=
==2.1 Introdução==

Este documento especifica todos os requisitos funcionais e não funcionais do módulo de gerenciamento de boletos, descrevendo os fluxos de eventos, prioridades, atores, entradas e saídas de cada caso de uso a ser implementado.

A correta interpretação deste documento exige o conhecimento de algumas convenções e termos específicos, que são descritos a seguir.

==2.2 Identificação dos Requisitos==

Por convenção, a referência a requisitos é feita através do nome da subseção onde eles estão descritos, seguidos do identificador do requisito, de acordo com o esquema abaixo:

[nome da subseção, identificador do requisito]

Por exemplo, o requisito funcional [Imprimir Boleto RF002] está descrito em um caso de uso chamado “Imprimir Boleto”, em um bloco identificado pelo identificador [RF002].

==2.3 Prioridades dos Requisitos==

Para estabelecer a prioridade dos requisitos foram adotadas as denominações “essencial”, “importante” e “desejável”. 
• Essencial é o requisito sem o qual o sistema não entra em funcionamento. São requisitos imprescindíveis, que têm que ser implementados. 
• Importante é o requisito sem o qual o sistema entra em funcionamento, mas de forma não satisfatória. Requisitos importantes devem ser implementados, mas, se não forem, o sistema poderá ser implantado e usado mesmo assim. 
• Desejável é o requisito que não compromete as funcionalidades básicas do sistema, isto é, o sistema pode funcionar de forma satisfatória sem ele. Requisitos desejáveis são requisitos que podem ser deixados para versões posteriores do sistema, caso não haja tempo hábil para implementá-los na versão que está sendo especificada. 

==2.4 Descrição dos Atores==

'''Usuário externo'''
É a pessoa que acessa a funcionalidade de impressão de boletos do módulo geral pelo browser.

Filiado FETAPE
Semelhante ao usuário comum, com a diferença de que terá a opção de se cadastrar pelo site.

Funcionário FETAPE
É responsável pelo gerenciamento dos boletos. É o ator principal deste sistema.

=3 Requisitos Funcionais (Casos de Uso)=
==3.1 Ações do Usuário==

==[RF001] Efetuar login==
Atores relacionados
Usuário externo, Filiado FETAPE e Funcionário FETAPE.

===Objetivo===
Fazer login no módulo Web de impressão de boletos.

===Prioridade===
Essencial.

===Entradas e pré condições===
'''Entradas:''' login do usuário e senha;
'''Pré-condições:''' computador deve ter acesso à internet; servidor web disponível.

===Saídas e pós-condições===
'''Saídas:''' não há
'''Pós-condições:''' usuário logado no sistema.

===Fluxo principal de eventos===
1. Usuário executa seu web browser e acessa a página de login (E1, E2); 
2. Usuário informa login e senha e clica em Entrar (E3); 
3. Sistema recupera na base de dados a senha do usuário com o login informado; 
4. Sistema verifica se o login está cadastrado (E4); 
5. Sistema verifica se a senha informada corresponde ao login informado (E5); 
6. Sistema libera o acesso após o sucesso da verificação; 
7. Includes [RF002]. 

===Fluxos de exceção===
• E1: se não houver conexão com a internet, uma mensagem será exibida informando que não é possível estabelecer uma conexão com a internet e solicitando ao usuário que verifique sua conexão; 
• E2: se o sistema não estiver disponível, uma mensagem será exibida informando que o serviço não está disponível e que o usuário deve tentar acessá-lo mais tarde; 
• E3: se o usuário não informar o login ou a senha, o sistema solicita que informe o login e a senha; 
• E4: se o login não estiver cadastrado, o sistema emite uma mensagem de erro informando que este usuário não está cadastrado e solicitando que o mesmo verifique se o login foi digitado corretamente; 
• E5: se a senha não conferir com a que está armazenada na base de dados, o sistema emite uma mensagem de erro avisando que a senha informada está incorreta e solicitando que o mesmo verifique se ela foi digitada corretamente. 

==[RF002] Listar boletos==
===Atores relacionados===
Usuário externo, Filiado FETAPE e Funcionário FETAPE.

===Objetivo===
Listar os boletos correspondentes ao usuário logado.

===Prioridade===
Essencial.

===Entradas e pré condições===
'''Entradas:''' nenhuma.
'''Pré-condições:''' usuário logado no sistema; boletos armazenados no banco de dados.

===Saídas e pós-condições===
'''Saídas:''' lista de boletos.
'''Pós-condições:''' nenhuma.

===Fluxo principal de eventos===
1. Sistema carrega da base de dados os boletos referentes ao usuário (E1, E2, E3); 
2. É exibida a lista de boletos (com check boxes para seleção), cada um com seu número, descrição, valor, vencimento e status (pendente/atrasado/impresso/pago). Os boletos serão ordenados de forma decrescente (maior para o menor) por data de vencimento na lista. Também haverá uma check box que permite a seleção de todos os boletos listados na tela e um limite de boletos a serem exibidos, sendo os demais boletos acessados por uma barra de próximo/anterior (semelhante a um esquema de web mail); 
3. Através de uma caixa de seleção (combo box), o usuário pode filtrar os boletos que serão exibidos na tela de acordo com a opção: “pendentes/impressos/pagos/todos”. Os boletos com status “atrasado” ficarão na lista de “pendentes” e “todos”, mas com uma cor de linha de grid que os diferencie dos demais (ex. vermelho). O status inicial do filtro é “pendentes”. 

===Fluxos de exceção===
• E1: se não houver conexão com a internet, uma mensagem será exibida informando que não é possível estabelecer uma conexão com a internet e solicitando ao usuário que verifique sua conexão; 
• E2: se o sistema não estiver disponível, uma mensagem será exibida informando que o serviço não está disponível e que o usuário deve tentar acessá-lo mais tarde; 
• E3: se o resultado da busca retornar vazio, uma mensagem será exibida informando ao usuário que não existe dados referentes à consulta realizada. 

=[RF003] Geração de boletos=
===Atores relacionados===
Usuário externo, Filiado FETAPE e Funcionário FETAPE.

===Objetivo===
Gerar registros de boletos no banco de dados para impressão. Não constitui a impressão do boleto em si.

===Prioridade===
Essencial.

===Entradas e pré condições===
'''Entradas:''' filiado(s)/usuário(s), banco, data de vencimento, modelo da guia, nosso número inicial, valor e instruções.
'''Pré-condições:''' usuário logado no sistema; sindicatos e filiados armazenados no banco de dados.

===Saídas e pós-condições===
'''Saídas:''' mensagem de aviso de sucesso da operação. 
'''Pós-condições:''' registro dos boletos inseridos no banco de dados.

===Fluxo principal de eventos===
1. Usuário Externo e Filiado FETAPE: usuário clica no botão Gerar Boletos. Se o usuário estiver com o status óbito, não será gerado boleto. Funcionário FETAPE: funcionário seleciona uma quantidade de filiados na tela de Listagem de Filiados e clica no botão Gerar Boletos. Os filiados com o status “óbito” nunca serão carregados; 
2. Sistema carrega o(s) usuários(s)/filiado(s) selecionados com seus respectivos dados (E1, E2, E3, E4); 
3. Uma janela é aberta perguntando se o usuário deseja imprimir boletos referentes a Contribuição Sindical e Contribuição Confederativa (2 check boxes); 
4. Uma tela é aberta onde o usuário informa os dados (banco, data de vencimento, modelo da guia, nosso número inicial, valor e instruções) para os boletos. Usuário confirma a operação; 
5. Sistema valida os dados inseridos pelo usuário e os dados obrigatórios para emissão de boleto (E5, E6); 
6. Sistema gera os boletos e os armazena no banco de dados com o status “gerado” (E7). O sistema deverá verificar se o número de boleto que ele irá gerar existe em algum intervalo na tabela de boletos avulso. Se existir, ele deverá gerar um próximo número que não esteja em um intervalo desta tabela; 
7. Sistema insere os registros de log da situação dos boletos no banco remoto com a justificava “gerado a partir da função de geração de boleto pelo usuário X:Y”, onde X corresponde ao login do funcionário e Y corresponde ao seu nome; 
8. Sistema exibe mensagem confirmando o sucesso na geração dos boletos e perguntando se o usuário deseja fazer a impressão dos mesmos; 
9. Se o usuário responder que sim, a janela de impressão padrão da funcionalidade imprimir é aberta. Includes [RF004]. 

===Filiado FETAPE===
Este usuário também terá acesso à rotina de CANCELAMENTO do boleto, que consiste meramente na exclusão do mesmo da base de dados. Vale salientar que devem ser efetuados os devidos registros no log do sistema seguindo o padrão supracitado, assim como devem ser atendidos os seguintes fluxos de exceção: 
1. Se o boleto possuir o status “pago”, “impresso” ou “enviado” (para o banco), o cancelamento não será permitido. O sistema exibirá uma mensagem de erro avisando que o boleto não pode ser impresso, indicando o seu status atual; 
2. Se o boleto requisitado não puder ser excluído, o sistema exibe uma mensagem de erro solicitando que o boleto não poder ser removido no momento. 

===Fluxos de exceção===
• E1: se não houver conexão com a internet, uma mensagem será exibida informando que não é possível estabelecer uma conexão com a internet e solicitando ao usuário que verifique sua conexão; 
• E2: se o sistema não estiver disponível, uma mensagem será exibida informando que o serviço não está disponível e que o usuário deve tentar acessá-lo mais tarde; 
• E3: se o resultado da busca retornar vazio, uma mensagem será exibida informando ao usuário que não existem dados referentes à consulta realizada; 
• E4: se o sistema não conseguir acessar a base de dados, uma mensagem será exibida informando ao usuário que a base de dados está inacessível; 
• E5: se o usuário não preencher os dados obrigatórios do boleto (banco, data de vencimento, modelo da guia, nosso número inicial e valor), uma mensagem será exibida informando ao usuário que os campos obrigatórios devem ser preenchidos; 
• E6: se os dados obrigatórios do(s) usuário(s)/filiado(s) para emissão de boleto não foram preenchidos (nome, logradouro, bairro, cidade, estado e CEP), o sistema lista na tela os usuário(s)/filiado(s) cujos dados obrigatórios não estão preenchidos e, para cada um, informa quais campos devem ser preenchidos. O usuário poderá prosseguir para a tela de marcação dos boletos que serão impressos (botão “prosseguir”), no entanto os boletos cujos dados não estão completos não aparecerão para seleção; 
• E7: se houver um estouro na numeração de boletos*, o sistema exibe uma mensagem solicitando ao usuário que entre em contato com a BISA pois houve um problema na geração da numeração do boleto. A operação não é finalizada. O sistema deve ainda efetuar todas as rotinas de rollback de modo a não deixar ‘lixo’ no banco de dados. 

<nowiki>*</nowiki> O estouro na numeração de boletos ocorre quando o limite do número de boletos cadastrado no banco de dados é atingido. Por exemplo, supondo um limite de 10 bytes, se o último registro cadastrado for 9999999999, o próximo registro de boleto irá acionar este erro. 

=[RF004] Imprimir boletos=
===Atores relacionados===
Usuário externo, Filiado FETAPE e Funcionário FETAPE.

===Objetivo===
Constitui a impressão de um boleto já gerado no sistema.

===Prioridade===
Essencial.

===Entradas e pré condições===
'''Entradas:''' lista de boletos para impressão. 
'''Pré-condições:''' o usuário deve estar logado no sistema na tela da listagem de boletos (RF002); os registros dos boletos devem estar armazenados no banco de dados e marcados como “não impresso”.

===Saídas e pós-condições===
'''Saídas:''' impressão dos boletos selecionados. 
'''Pós-Condições:''' registros dos boletos marcados no banco como “impresso”.

===Fluxo principal de eventos===
1. Usuário seleciona na Lista de boletos aqueles que deseja imprimir (check box) e clica no botão Imprimir (E1, E2, E3, E4, E5); 
2. Se o usuário houver selecionado apenas um boleto, o sistema imprime o boleto no navegador, permitindo ao usuário conferir seus dados. Depois disso, ele clica em um novo botão Imprimir e passa para o passo 3; 
3. Janela de impressão padrão é aberta (onde o usuário poderá selecionar impressora, quantidade de páginas, etc). Usuário confirma a impressão e o sistema envia os arquivos para a impressora (E6); 
4. Sistema marca no banco os boletos que foram impressos com o status “impresso” (E7); 
5. Sistema insere no log de boletos os registros com o status impresso com a justificativa “impresso pela função de impressão de boletos pelo usuário X:Y”, onde X corresponde ao código do usuário e Y ao seu nome. 
6. Sistema exibe uma mensagem de “Boletos impressos com sucesso”. 

===Fluxos de exceção===
• E1: se não houver conexão com a internet, uma mensagem será exibida informando que não é possível estabelecer uma conexão com a internet e solicitando ao usuário que verifique sua conexão; 
• E2: se o sistema não estiver disponível, uma mensagem será exibida informando que o serviço não está disponível e que o usuário deve tentar acessá-lo mais tarde; 
• E3: se o usuário não selecionar boletos, o sistema exibe uma mensagem solicitando ao usuário que selecione boletos para impressão; 
• E4: se na lista houver boletos que já foram pagos, o sistema exibe uma mensagem de erro informando que boletos pagos não podem ser reimpressos e cancela a operação; 
• E5: se houver boletos que já foram impressos, o sistema exibe um alerta informando que os boletos já foram impressos pelo sistema e serão reimpressos nesta operação; continua a executar normalmente; 
• E6: se houver um erro ao enviar os dados para a impressora, o sistema exibe uma mensagem avisando ao usuário que o sistema não conseguiu imprimir e solicitando que o mesmo verifique se a impressora está pronta para impressão; 
• E7: se houver um erro na alteração dos registros no banco de dados, uma mensagem será exibida informando que não foi possível marcar os boletos como impressos e solicitando ao usuário que tente novamente e que, caso o erro persista, entre em contato com a BISA. O sistema deve ainda efetuar todas as rotinas de rollback de modo a não deixar ‘lixo’ no banco de dados. 

=[RF005] Cadastro de filiado=
===Atores relacionados===
Filiado FETAPE e Funcionário FETAPE.

===Objetivo===
Cadastrar um filiado. As rotinas de ALTERAÇÃO e de EXCLUSÃO também estão contidas neste requisito para o Funcionário FETAPE.

===Prioridade===
Essencial.

===Entradas e pré condições===
'''Entradas:''' dados cadastrais do usuário. 
'''Pré-condições:''' computador deve ter acesso à internet; servidor web disponível. Funcionário: usuário cadastrado no sistema. 

===Saídas e pós-condições===
'''Saídas:''' mensagem avisando que o usuário foi cadastrado com sucesso. 
'''Pós-Condições:''' usuário cadastrado no banco de dados. 

===Fluxo principal de eventos===
1. Ator Filiado: a função “Cadastrar Filiado” é acionada pelo usuário no navegador web (E1, E2). Ator Funcionário: a função “Cadastrar Filiado” é acionada pelo usuário na tela de Listagem de Filiados (E1, E2). 
2. Um formulário é aberto solicitando dados cadastrais: login, senha, nome, CPF, CNAE, bairro, cidade, UF, logradouro, CEP, categoria (seleção entre as opções arrendatário, assentado, meeiro, parceiro, posseiro, pequeno proprietário e outros) e apelido do filiado; 
3. Usuário preenche os campos e confirma a operação (E3, E4, E5, E6); 
4. Sistema insere os registros de log da situação no banco remoto com a justificava “cadastrado pelo usuário X:Y”, onde X corresponde ao login do usuário e Y corresponde ao seu nome; 
5. Sistema retorna uma mensagem avisando que o usuário foi cadastrado com sucesso. 

O sistema também apresenta as rotinas de ALTERAÇÃO, que por ser trivial e seguir um fluxo semelhante à rotina de inclusão não terá sua execução descrita aqui. Vale salientar que devem ser efetuados os devidos registros no log do sistema. 

===Filiado FETAPE===
Ele possui também a funcionalidade EXCLUSÃO. Sua tela de ALTERAR é diferente. Nela, o usuário pode marcar um check box “óbito” para filiados que foram a óbito.

===Fluxos de exceção===
• E1: se não houver conexão com a internet, uma mensagem será exibida informando que não é possível estabelecer uma conexão com a internet e solicitando ao usuário que verifique sua conexão; 
• E2: se o sistema não estiver disponível, uma mensagem será exibida informando que o serviço não está disponível e que o usuário deve tentar acessá-lo mais tarde; 
• E3: se o login fornecido já estiver cadastrado no sistema, uma mensagem será exibida informando ao usuário que o login cadastrado já existe no sistema; 
• E4: se o CPF do filiado for inválido, uma mensagem será exibida informando ao usuário que o CPF cadastrado é inválido. Vale salientar que o preenchimento deste campo é opcional; 
• E5: se houver um erro na inserção dos registros no banco de dados, uma mensagem será exibida informando que não foi possível inserir os dados e solicitando ao usuário que tente novamente e que, caso o erro persista, entre em contato com a BISA. O sistema deve ainda efetuar todas as rotinas de rollback de modo a não deixar ‘lixo’ no banco de dados; 
• E6: se os dados obrigatórios dos filiados não forem preenchidos (nome, logradouro, bairro, cidade, estado e CEP), o sistema emite uma mensagem de erro informando quais os campos obrigatórios não foram preenchidos. 

=[RF006] Listar filiados=
===Atores relacionados===
Funcionário FETAPE.

===Objetivo===
Listar todos os filiados cadastrados no sistema.

===Prioridade===
Essencial.

===Entradas e pré condições===
'''Entradas:''' nenhuma.
'''Pré-condições:''' usuário logado no sistema; filiados armazenados no banco de dados.

===Saídas e pós-condições===
'''Saídas:''' lista de filiados. 
'''Pós-condições:''' nenhuma. 

===Fluxo principal de eventos===
1. Usuário clica no botão Filiados da barra de funções do sistema para acessar a Listagem de Filiados; 
2. Sistema carrega da base de dados os filiados com seus respectivos dados (E1, E2, E3, E4); 
3. É exibida a lista de filiados (com check boxes para seleção), cada um com seu número, nome, apelido, CPF, município, sindicato e categoria. Os filiados serão ordenados por ordem alfabética e agrupados por município. Também haverá uma check box que permite a seleção de todos os filiados listados na tela e um limite de filiados a serem exibidos, sendo os demais acessados por uma barra de próximo/anterior (semelhante a um esquema de web mail); 
4. Através de uma caixa de seleção (combo box), o usuário pode filtrar os filiados que serão exibidos na tela de acordo com a opção: “nome/apelido/município/sindicato”. A opção “nome” é a padrão. Os filiados que foram a óbito serão exibidos com uma cor de linha de grid acinzentada e só serão exibidos se um check box “todos” for ativado. 

===Fluxos de exceção===
• E1: se não houver conexão com a internet, uma mensagem será exibida informando que não é possível estabelecer uma conexão com a internet e solicitando ao usuário que verifique sua conexão; 
• E2: se o sistema não estiver disponível, uma mensagem será exibida informando que o serviço não está disponível e que o usuário deve tentar acessá-lo mais tarde; 
• E3: se o resultado da busca retornar vazio, uma mensagem será exibida informando ao usuário que não existem dados referentes à consulta realizada; 
• E4: se o sistema não conseguir acessar a base de dados, uma mensagem será exibida informando ao usuário que a base de dados está inacessível. 

=[RF007] Cadastro de sindicato=
===Atores relacionados===
Funcionário FETAPE.

===Objetivo===
Cadastrar um sindicato. As rotinas de ALTERAÇÃO e de EXCLUSÃO também estão contidas neste requisito.

===Prioridade===
Essencial.

===Entradas e pré condições===
'''Entradas:''' dados do sindicato; dados do Município (já presentes na base de dados, herdada do antigo sistema DOS TRAB_RUR). 
'''Pré-condições:''' usuário logado no sistema. 

===Saídas e pós-condições===
'''Saídas:''' mensagem avisando que o sindicato foi cadastrado com sucesso. 
'''Pós-Condições:''' sindicato cadastrado no banco de dados. 

Fluxo principal de eventos
1. Usuário clica no botão cadastrar na tela de Listagem de Sindicatos (E1, E2); 
2. Um formulário é aberto solicitando dados cadastrais: nome, município, UF, endereço; 
3. Usuário preenche os campos e confirma a operação (E3); 
4. Sistema insere os registros de log da situação no banco remoto com a justificava “cadastrado pelo usuário X:Y”, onde X corresponde ao login do funcionário e Y corresponde ao seu nome; 
5. Sistema retorna uma mensagem avisando que o sindicato foi cadastrado com sucesso. 

Também haverá rotinas de alteração e de exclusão. O processo é trivial para ser descrito aqui. Vale salientar que devem ser efetuados os devidos registros no log do sistema. 

===Fluxos de exceção===
• E1: se não houver conexão com a internet, uma mensagem será exibida informando que não é possível estabelecer uma conexão com a internet e solicitando ao usuário que verifique sua conexão; 
• E2: se o sistema não estiver disponível, uma mensagem será exibida informando que o serviço não está disponível e que o usuário deve tentar acessá-lo mais tarde; 
• E3: se houver um erro na inserção dos registros no banco de dados, uma mensagem será exibida informando que não foi possível inserir os dados e solicitando ao usuário que tente novamente e que, caso o erro persista, entre em contato com a BISA. O sistema deve ainda efetuar todas as rotinas de rollback de modo a não deixar ‘lixo’ no banco de dados; 

=[RF008] Listar sindicatos=
===Atores relacionados===
Funcionário FETAPE.

===Objetivo===
Listar todos os sindicatos cadastrados no sistema.

===Prioridade===
Essencial.

===Entradas e pré condições===
'''Entradas:''' nenhuma. 
'''Pré-condições:''' usuário logado no sistema; sindicatos armazenados no banco de dados. 

===Saídas e pós-condições===
'''Saídas:''' lista de sindicatos. 
'''Pós-condições:''' nenhuma. 

===Fluxo principal de eventos===
1. Usuário clica no botão Sindicatos da barra de funções do sistema para acessar a Listagem de Sindicatos; 
2. Sistema carrega da base de dados os sindicatos com seus respectivos dados (E1, E2, E3, E4); 
3. É exibida a lista de sindicatos (com check boxes para seleção), cada um com seu número, nome e município. Os sindicatos serão ordenados por ordem alfabética e agrupados por município. Também haverá uma check box que permite a seleção de todos os sindicatos listados na tela e um limite de sindicatos a serem exibidos, sendo os demais acessados por uma barra de próximo/anterior (semelhante a um esquema de web mail); 
4. Através de uma caixa de seleção (combo box), o usuário pode filtrar os sindicatos que serão exibidos na tela de acordo com a opção: “nome/município”. A opção “nome” é a padrão. 

===Fluxos de exceção===
• E1: se não houver conexão com a internet, uma mensagem será exibida informando que não é possível estabelecer uma conexão com a internet e solicitando ao usuário que verifique sua conexão; 
• E2: se o sistema não estiver disponível, uma mensagem será exibida informando que o serviço não está disponível e que o usuário deve tentar acessá-lo mais tarde; 
• E3: se o resultado da busca retornar vazio, uma mensagem será exibida informando ao usuário que não existem dados referentes à consulta realizada; 
• E4: se o sistema não conseguir acessar a base de dados, uma mensagem será exibida informando ao usuário que a base de dados está inacessível. 

===[RF009] Baixar Boleto===
===Atores relacionados===
Funcionário FETAPE.

===Objetivo===
Baixa nos boletos que foram impressos. Eles passarão a ter o status de pago.

===Prioridade===
Essencial.

===Entradas e pré condições===
'''Entradas:''' lista de boletos para baixa.
'''Pré-condições:''' usuário logado no sistema; os registros dos boletos devem estar armazenados no banco de dados.

===Saídas e pós-condições===
'''Saídas:''' mensagem de aviso de sucesso da operação. 
'''Pós-condições:''' registro dos boletos marcados no banco como “pagos”. 

===Fluxo principal de eventos===
1. Usuário seleciona na Lista de boletos aqueles que deseja baixar (check box) e clica no botão Baixar (E1, E2, E3, E4, E5); 
2. Sistema marca no banco os boletos como pagos (E6). Se o boleto não for encontrado na tabela de boletos, deverá ser procurado na tabela de boletos avulsos (E7); 
3. Sistema insere no log de boletos os registros com o status impresso com a justificativa “baixado pela função de baixar de boletos pelo usuário X:Y”, onde X corresponde ao código do usuário e Y ao seu nome; 
4. Sistema exibe uma mensagem de “Boletos baixados com sucesso”. 

===Fluxos de exceção===
• E1: se não houver conexão com a internet, uma mensagem será exibida informando que não é possível estabelecer uma conexão com a internet e solicitando ao usuário que verifique sua conexão; 
• E2: se o sistema não estiver disponível, uma mensagem será exibida informando que o serviço não está disponível e que o usuário deve tentar acessá-lo mais tarde; 
• E3: se o usuário não selecionar boletos, o sistema exibe uma mensagem solicitando ao usuário que selecione boletos para impressão; 
• E4: se na lista houver boletos com o status “pago”, o sistema exibe uma mensagem informando que boletos selecionados já foram baixados. Se o usuário clicar em continuar, o sistema continua a execução e ignora esses boletos; 
• E5: se na lista houver boletos com o status diferente de “impresso” ou “enviado” (enviado para o banco), o sistema exibe uma mensagem informando que há boletos selecionados que ainda não foram impressos ou enviados para o banco e quais são estes boletos. Se o usuário clicar em continuar, o sistema continua a execução e ignora esses boletos; 
• E6: se houver um erro na alteração dos registros no banco de dados, uma mensagem será exibida informando que não foi possível marcar os boletos como pagos e solicitando ao usuário que tente novamente e que, caso o erro persista, entre em contato com a BISA. O sistema deve ainda efetuar todas as rotinas de rollback de modo a não deixar ‘lixo’ no banco de dados; 
• E7: se o registro do boleto não for encontrado no banco, o sistema exibirá uma mensagem de erro indicando que o boleto não foi encontrado na base de dados do sistema. 

=[RF010] Baixar Boleto Automaticamente (via Arquivo de Retorno do Banco)=
===Atores relacionados===
Funcionário FETAPE.

===Objetivo===
Baixar de boletos a partir de um arquivo de retorno que o banco envia.

===Prioridade===
Essencial.

===Entradas e pré condições===
'''Entradas:''' arquivo de retorno do banco. 
'''Pré-condições:''' usuário logado no sistema; os registros dos boletos devem estar armazenados no banco de dados. 

===Saídas e pós-condições===
'''Saídas:''' mensagem de sucesso da operação. 
'''Pós-condições:''' registro dos boletos marcados no banco como “pagos”. 

===Fluxo principal de eventos===
1. Na tela da Lista de boletos, usuário clica na opção Baixa com Arquivo do Banco (E1, E2); 
2. Uma tela é aberta perguntando qual o arquivo de retorno do banco. O usuário então seleciona o caminho no seu computador correspondente à localização do arquivo e clica em OK. O sistema irá, então, fazer o upload do arquivo (E3, E4, E5); 
3. Sistema guarda a identificação do arquivo de retorno com situação de ‘não processado’ na base de dados e guarda uma cópia do arquivo em diretório especifico para histórico; 
4. Para cada linha do arquivo de retorno, o sistema procura o boleto referente na base de dados de boletos de contribuição. Se o boleto não for encontrado, o sistema procura na base de dados de boletos avulsos. Nesta base, há registros de boletos com intervalos (ex. de 001 a 100). O sistema irá buscar o número do boleto nessa faixa (E6); 
5. O sistema verifica se o boleto encontrado está marcado como “impresso” ou “enviado” (para o banco). Se estiver, o sistema marca no banco de dados o boleto como “pago” (E7); 
6. O sistema insere no log de boletos o registro com situação de “pago” com a justificativa ‘baixado pela função de baixa automática de boleto pelo usuário X:Y’, onde X corresponde ao login de usuário e Y corresponde ao seu nome; 
7. O Sistema marca o arquivo de retorno como ‘processado sem erros’ e uma exibe mensagem confirmando o sucesso na baixa dos boletos. 

===Fluxos de exceção===
• E1: se não houver conexão com a internet, uma mensagem será exibida informando que não é possível estabelecer uma conexão com a internet e solicitando ao usuário que verifique sua conexão; 
• E2: se o sistema não estiver disponível, uma mensagem será exibida informando que o serviço não está disponível e que o usuário deve tentar acessá-lo mais tarde; 
• E3: se o usuário não apontar nenhum arquivo de retorno, uma mensagem será exibida exigindo que o usuário aponte o arquivo; 
• E4: se o caminho para o arquivo estiver incorreto, o sistema exibe uma mensagem para o usuário informando que o caminho selecionado é inválido; 
• E5: se o formato do arquivo não corresponder ao formato do arquivo de retorno do banco esperado, o sistema exibirá uma mensagem informando que o formato do arquivo selecionado é inválido; 
• E6: se um registro do arquivo não for encontrado no sistema (base principal e base de boletos avulsos), será exibido numa tela todos os registros que não foram encontrados. A situação do arquivo de retorno no banco deve então mudar para “processado com erro” e o sistema deve inserir o registro de log de boleto com a justificativa “boleto não pode ser baixado, pois o mesmo não foi encontrado no sistema. Ação executada pelo usuário X:Y”, onde X é o login e Y é o nome. O valor do boleto pago e não encontrado deverá ser armazenado na tabela de boletos no registro cujo identificador é “BoletoXXXX”. Todo boleto que não for encontrado deverá ser somado ao valor desse registro; 
• E7: se houver um erro na alteração dos registros no banco de dados, uma mensagem será exibida informando que não foi possível marcar os boletos como “pago” e solicitando ao usuário que tente novamente e que, caso o erro persista, entre em contato com a BISA. O sistema deve ainda efetuar todas as rotinas de rollback de modo a não deixar ‘lixo’ no banco de dados. 

=[RF011] Gerar arquivo de remessa para banco=
===Atores relacionados===
===Funcionário FETAPE.===

===Objetivo===
Gerar arquivo de remessa de boletos para o banco.

===Prioridade===
Essencial.

===Entradas e pré condições===
'''Entradas:''' lista de boletos que serão enviados para o arquivo. 
'''Pré-condições:''' usuário logado no sistema; os registros dos boletos devem estar armazenados no banco de dados com o status “gerado” ou “impresso”. 

===Saídas e pós-condições===
'''Saídas:''' mensagem de sucesso da operação; arquivo de remessa para o banco. 
'''Pós-condições:''' boletos marcados com o status “enviado” no banco na base de dados. 

===Fluxo principal de eventos===
1. Na tela de Listagem de Boletos, o usuário seleciona os boletos e clica no botão Gerar de arquivo de remessa (E1, E2); 
2. Sistema verifica se todos os boletos selecionados estão marcados como “gerado” ou “impresso” (E3); 
3. Sistema abre tela para que o usuário informe o nome do arquivo e o local onde ele será gerado (E4, E5); 
4. Usuário confirma a geração do arquivo; 
5. Sistema gera o arquivo de remessa; 
6. Sistema marca no banco os boletos que foram inseridos no arquivo de remessa com o status de “enviado” para o banco (E6); 
7. Sistema insere no log de boletos os registros com situação de enviado com a justificativa “boleto gerado no arquivo de remessa para o banco pelo usuário X:Y”, onde X corresponde ao login do usuário e Y corresponde ao seu nome; 
8. Sistema salva em diretório especifico no banco uma cópia do arquivo gerado para remessa para fins de histórico; 
9. Sistema retorna o arquivo de remessa para que o usuário salve-o em seu computador. 

===Fluxos de exceção===
• E1: se não houver conexão com a internet, uma mensagem será exibida informando que não é possível estabelecer uma conexão com a internet e solicitando ao usuário que verifique sua conexão; 
• E2: se o sistema não estiver disponível, uma mensagem será exibida informando que o serviço não está disponível e que o usuário deve tentar acessá-lo mais tarde; 
• E3: se o sistema não encontrar nenhum arquivo com o status “gerado” ou “impresso”, uma mensagem será exibida informando que não existem boletos a serem gerados para o arquivo de remessa. Se encontrar, deverá informar quais os boletos não serão gerados no arquivo; 
• E4: se o usuário informa um local não existente, o sistema pergunta ao usuário se o mesmo deseja que o sistema crie o diretório de pastas informado. Se a resposta for sim, sistema cria diretório de pasta; se a resposta for não, sistema retorna a tela de informação do local para que o usuário selecione um novo diretório; 
• E5: se houver um erro na geração do arquivo de remessa, uma mensagem será exibida informando ao usuário que o arquivo de remessa não pode ser gerado e que o mesmo tente novamente e que, caso o erro persista, entre em contato com a BISA.; 
• E6: se houver um erro na alteração dos registros no banco de dados, uma mensagem será exibida informando que não foi possível marcar os boletos como “enviado” e solicitando ao usuário que tente novamente e que, caso o erro persista, entre em contato com a BISA. O sistema deve ainda efetuar todas as rotinas de rollback de modo a não deixar ‘lixo’ no banco de dados. 

=[RF012] Gerar arquivo de remessa para Gráfica=
===Atores relacionados===
Funcionário FETAPE.

===Objetivo===
Gerar arquivo de remessa de boletos para Gráfica.

===Prioridade===
Essencial.

===Entradas e pré condições===
'''Entradas:''' lista de boletos que serão enviados para o arquivo. 
'''Pré-condições:''' usuário logado no sistema; os registros dos boletos devem estar armazenados no banco de dados com o status “gerado”.

===Saídas e pós-condições===
'''Saídas:''' mensagem de sucesso da operação; arquivo de remessa para a gráfica (em formato txt e xls). 
'''Pós-condições:''' boletos marcados com o status “enviadoGrafica” no banco na base de dados. 

===Fluxo principal de eventos===
1. Na tela de Listagem de Boletos, o usuário seleciona os boletos e clica no botão Gerar arquivo de boleto para Gráfica (E1, E2); 
2. Sistema verifica se todos os boletos selecionados estão marcados como “gerado” (E3); 
3. Sistema abre tela para que o usuário informe o nome do arquivo e o local onde ele será gerado (E4, E5); 
4. Usuário confirma a geração do arquivo; 
5. Sistema pergunta se o usuário quer gerar o arquivo no formato txt ou xls; 
6. Sistema gera o arquivo de remessa para Gráfica; 
7. Sistema marca no banco os boletos que foram inseridos no arquivo de remessa com o status de “enviadoGrafica” para o banco (E6); 
8. Sistema insere no log de boletos os registros com situação de enviado com a justificativa “boleto gerado no arquivo de remessa para Gráfica pelo usuário X:Y”, onde X corresponde ao login do usuário e Y corresponde ao seu nome; 
9. Sistema salva em diretório especifico no banco uma cópia do arquivo gerado para remessa para Gráfica para fins de histórico; 
10. Sistema retorna o arquivo para que o usuário salve-o em seu computador. 

===Fluxos de exceção===
• E1: se não houver conexão com a internet, uma mensagem será exibida informando que não é possível estabelecer uma conexão com a internet e solicitando ao usuário que verifique sua conexão; 
• E2: se o sistema não estiver disponível, uma mensagem será exibida informando que o serviço não está disponível e que o usuário deve tentar acessá-lo mais tarde; 
• E3: se o sistema não encontrar nenhum arquivo com o status “gerado”, uma mensagem será exibida informando que não existem boletos a serem gerados para o arquivo de remessa. Se encontrar, deverá informar quais os boletos não serão gerados no arquivo; 
• E4: se o usuário informa um local não existente, o sistema pergunta ao usuário se o mesmo deseja que o sistema crie o diretório de pastas informado. Se a resposta for sim, sistema cria diretório de pasta; se a resposta for não, sistema retorna a tela de informação do local para que o usuário selecione um novo diretório; 
• E5: se houver um erro na geração do arquivo de remessa, uma mensagem será exibida informando ao usuário que o arquivo de remessa não pode ser gerado e que o mesmo tente novamente e que, caso o erro persista, entre em contato com a BISA; 
• E6: se houver um erro na alteração dos registros no banco de dados, uma mensagem será exibida informando que não foi possível marcar os boletos como “enviado” e solicitando ao usuário que tente novamente e que, caso o erro persista, entre em contato com a BISA. O sistema deve ainda efetuar todas as rotinas de rollback de modo a não deixar ‘lixo’ no banco de dados. 

=4 Especificações Suplementares=
===4.1 Objetivos===
Este documento tem como finalidade especificar todos os requisitos não funcionais do módulo de boletos web divididos em requisitos de usabilidade, confiabilidade, desempenho, segurança, distribuição, adequação a padrões e requisitos de hardware e software.
===4.2 Usabilidade===
Esta seção descreve os requisitos não funcionais associados à facilidade de uso da interface com o usuário, material de treinamento e documentação do sistema.
=[NF001] Interface com o Usuário=
Prioridade: Desejável
O sistema deve possuir uma interface amigável, simples e intuitiva.
4.3 Confiabilidade
Esta seção descreve os requisitos não funcionais associados à freqüência, severidade de falhas do sistema e habilidade de recuperação das mesmas, bem como a corretude do sistema.
[NF001] Tempo de Retorno após Falha
Prioridade: Desejável
Retorno de até 5 segundos após alguma falha.
[NF002] Disponibilidade
Prioridade: Importante
O sistema estará disponível 24 horas por dia durante todos os dias do ano.
4.4 Desempenho
Esta seção descreve os requisitos não funcionais associados à eficiência, uso de recursos e tempo de resposta do sistema.
[NF001] Número de Acessos
O sistema deve ser capaz de atender em média 10 usuários por segundo nos momentos de pico de acesso.
[NF002] Tempo de Resposta para os Usuários
O tempo máximo de resposta de uma requisição deve ser de no máximo 10 segundos.

4.5 Segurança
Esta seção descreve os requisitos não funcionais associados à integridade, privacidade e autenticidade dos dados do sistema.
[NF001] Privacidade de Acesso
Apenas os usuários credenciados e com permissão para acesso a este módulo deverão fazer uso das funcionalidades do módulo de boletos/guias na Web.
4.6 Hardware e software
Esta seção descreve os requisitos não funcionais associados ao hardware e software usados para desenvolver ou para executar o sistema.
[NF001] Linguagem de Implementação
Prioridade: Essencial
A linguagem de implementação do módulo de boleto Web será Delphi, mesma linguagem utilizada no desenvolvimento dos sistemas Partidos2000, Receb2000, OAB2000 e Filiados2000.
[NF002] Banco de Dados
Prioridade: Essencial
O banco de dados utilizado será o MySQL.
[NF003] Ferramentas
Prioridade: Essencial
Ferramenta de modelagem: Borland Delphi 2006
Ferramenta de Desenvolvimento: Borland Delphi 2006
[NF004] Plataforma de Funcionamento
Prioridade: Essencial
A plataforma tanto de desenvolvimento e de funcionamento será Windows.

Para uso do Bw- Construindo

2013-01-22T19:28:15Z

AnaPaula: /* [RF011] Gerar arquivo de remessa para banco */

[[Arquivo:BoletosWeb.PNG]] 

[[Arquivo:Historico_de_revisoes.PNG]] 

=1. Caso de Negócio=
==1.1 Objetivos==

Documentar o novo módulo de geração e impressão de boletos online. As informações aqui descritas especificam e refinam a regras de negócio.

==1.2 Referências==

Se baseará no conhecimento adquirido na implementação de rotinas de boletos da BISA (desktop) e no antigo sistema TRAB_RUR da BISA, em DOS. A entrevista com Mário e Márcio da FETAPE (realizada por Ronaldo e Alexandre) também é referência para a definição dos requisitos.

==1.3 Sistemas com rotinas de gerenciamento de boletos da BISA==

O Filiados 2000 é um sistema desktop de gestão de filiados que controla o cadastro de filiados dos sindicatos de trabalhadores, fazendo acompanhamento de participação na organização.

O OAB 2000 é um software de gestão de cadastro de advogados para OAB's. Faz desde o cadastro de alunos, pré-inscritos, coordena sociedades de advogados, estagiários, até a administração dos dados financeiros dos advogados.

O Receb 2000 é um software voltado para o acompanhamento do contas a receber de uma empresa, fazendo a gestão financeira da carteira de forma simples e eficiente.

Todos esses sistemas possuem uma função de gerenciamento de boletos bancários ou guias sindicais, sendo salvos de forma centralizada no MySQL, de forma que podem ser acessados de forma uniforme no BoletoWEB.

Cada sistema contém suas próprias regras de negócio para gerenciar os boletos; no entanto, as funções de acesso ao banco remoto serão padronizadas para todos os sistemas no BoletoWEB.

==1.4 Descrição do Produto==

A maior parte da implementação é voltada para a FETAPE, enquanto o restante imprime boletos gerados pelos nossos sistema desktop.

Módulo Geral: este módulo tem a função meramente de fornecer uma interface web que permita ao usuário imprimir boletos gerados pelos sistemas desktop da BISA. 

'''Módulo FETAPE:''' no antigo sistema TRAB_RUR da BISA, este sistema é o foco principal desta documentação. Nela o usuário poderá gerenciar todo o fluxo de boletos de contribuições: geração, impressão interna, cadastro de filiados, acesso on-line dos filiados, etc.

==1.5 Contexto de Negócio==

O módulo geral de boletos na web será utilizado a princípio pelos sistemas Receb2000, OAB2000 e Filiados2000, porém poderá ser extendido a qualquer sistema que queira fazer o controle de boletos/guias.

Este módulo concentrará as informações dos boletos em um único local independente de entidade ou sistema. Este local, a priori, ficou definido como sendo um dos servidores internos da BISA que possua acesso externo. Cada sistema rodará normalmente no ambiente do cliente. No momento que for necessário o acesso às informações, este será feito não mais na base local da área do cliente, mas na base remota situada na BISA.

O módulo FETAPE segue as mesmas diretrizes, tendo a diferença de ser implementado exclusivamente para esta entidade, devendo ser adaptável para outras entidades. Para tanto, aconselha-se o uso de uma arquitetura em camadas e padrões de projetos, facilitadores do processos de manutenção.

==1.6 Tecnologias utilizadas==

Os módulos geral e FETAPE deverão implementados utilizando uma tecnologia para web: PHP, Java ou .NET.

O banco de dados necessariamente deverá ser o MySQL, pois já é utilizado na bisa para o registro de boletos.

=2. Sobre os Requisitos=
==2.1 Introdução==

Este documento especifica todos os requisitos funcionais e não funcionais do módulo de gerenciamento de boletos, descrevendo os fluxos de eventos, prioridades, atores, entradas e saídas de cada caso de uso a ser implementado.

A correta interpretação deste documento exige o conhecimento de algumas convenções e termos específicos, que são descritos a seguir.

==2.2 Identificação dos Requisitos==

Por convenção, a referência a requisitos é feita através do nome da subseção onde eles estão descritos, seguidos do identificador do requisito, de acordo com o esquema abaixo:

[nome da subseção, identificador do requisito]

Por exemplo, o requisito funcional [Imprimir Boleto RF002] está descrito em um caso de uso chamado “Imprimir Boleto”, em um bloco identificado pelo identificador [RF002].

==2.3 Prioridades dos Requisitos==

Para estabelecer a prioridade dos requisitos foram adotadas as denominações “essencial”, “importante” e “desejável”. 
• Essencial é o requisito sem o qual o sistema não entra em funcionamento. São requisitos imprescindíveis, que têm que ser implementados. 
• Importante é o requisito sem o qual o sistema entra em funcionamento, mas de forma não satisfatória. Requisitos importantes devem ser implementados, mas, se não forem, o sistema poderá ser implantado e usado mesmo assim. 
• Desejável é o requisito que não compromete as funcionalidades básicas do sistema, isto é, o sistema pode funcionar de forma satisfatória sem ele. Requisitos desejáveis são requisitos que podem ser deixados para versões posteriores do sistema, caso não haja tempo hábil para implementá-los na versão que está sendo especificada. 

==2.4 Descrição dos Atores==

'''Usuário externo'''
É a pessoa que acessa a funcionalidade de impressão de boletos do módulo geral pelo browser.

Filiado FETAPE
Semelhante ao usuário comum, com a diferença de que terá a opção de se cadastrar pelo site.

Funcionário FETAPE
É responsável pelo gerenciamento dos boletos. É o ator principal deste sistema.

=3 Requisitos Funcionais (Casos de Uso)=
==3.1 Ações do Usuário==

==[RF001] Efetuar login==
Atores relacionados
Usuário externo, Filiado FETAPE e Funcionário FETAPE.

===Objetivo===
Fazer login no módulo Web de impressão de boletos.

===Prioridade===
Essencial.

===Entradas e pré condições===
'''Entradas:''' login do usuário e senha;
'''Pré-condições:''' computador deve ter acesso à internet; servidor web disponível.

===Saídas e pós-condições===
'''Saídas:''' não há
'''Pós-condições:''' usuário logado no sistema.

===Fluxo principal de eventos===
1. Usuário executa seu web browser e acessa a página de login (E1, E2); 
2. Usuário informa login e senha e clica em Entrar (E3); 
3. Sistema recupera na base de dados a senha do usuário com o login informado; 
4. Sistema verifica se o login está cadastrado (E4); 
5. Sistema verifica se a senha informada corresponde ao login informado (E5); 
6. Sistema libera o acesso após o sucesso da verificação; 
7. Includes [RF002]. 

===Fluxos de exceção===
• E1: se não houver conexão com a internet, uma mensagem será exibida informando que não é possível estabelecer uma conexão com a internet e solicitando ao usuário que verifique sua conexão; 
• E2: se o sistema não estiver disponível, uma mensagem será exibida informando que o serviço não está disponível e que o usuário deve tentar acessá-lo mais tarde; 
• E3: se o usuário não informar o login ou a senha, o sistema solicita que informe o login e a senha; 
• E4: se o login não estiver cadastrado, o sistema emite uma mensagem de erro informando que este usuário não está cadastrado e solicitando que o mesmo verifique se o login foi digitado corretamente; 
• E5: se a senha não conferir com a que está armazenada na base de dados, o sistema emite uma mensagem de erro avisando que a senha informada está incorreta e solicitando que o mesmo verifique se ela foi digitada corretamente. 

==[RF002] Listar boletos==
===Atores relacionados===
Usuário externo, Filiado FETAPE e Funcionário FETAPE.

===Objetivo===
Listar os boletos correspondentes ao usuário logado.

===Prioridade===
Essencial.

===Entradas e pré condições===
'''Entradas:''' nenhuma.
'''Pré-condições:''' usuário logado no sistema; boletos armazenados no banco de dados.

===Saídas e pós-condições===
'''Saídas:''' lista de boletos.
'''Pós-condições:''' nenhuma.

===Fluxo principal de eventos===
1. Sistema carrega da base de dados os boletos referentes ao usuário (E1, E2, E3); 
2. É exibida a lista de boletos (com check boxes para seleção), cada um com seu número, descrição, valor, vencimento e status (pendente/atrasado/impresso/pago). Os boletos serão ordenados de forma decrescente (maior para o menor) por data de vencimento na lista. Também haverá uma check box que permite a seleção de todos os boletos listados na tela e um limite de boletos a serem exibidos, sendo os demais boletos acessados por uma barra de próximo/anterior (semelhante a um esquema de web mail); 
3. Através de uma caixa de seleção (combo box), o usuário pode filtrar os boletos que serão exibidos na tela de acordo com a opção: “pendentes/impressos/pagos/todos”. Os boletos com status “atrasado” ficarão na lista de “pendentes” e “todos”, mas com uma cor de linha de grid que os diferencie dos demais (ex. vermelho). O status inicial do filtro é “pendentes”. 

===Fluxos de exceção===
• E1: se não houver conexão com a internet, uma mensagem será exibida informando que não é possível estabelecer uma conexão com a internet e solicitando ao usuário que verifique sua conexão; 
• E2: se o sistema não estiver disponível, uma mensagem será exibida informando que o serviço não está disponível e que o usuário deve tentar acessá-lo mais tarde; 
• E3: se o resultado da busca retornar vazio, uma mensagem será exibida informando ao usuário que não existe dados referentes à consulta realizada. 

=[RF003] Geração de boletos=
===Atores relacionados===
Usuário externo, Filiado FETAPE e Funcionário FETAPE.

===Objetivo===
Gerar registros de boletos no banco de dados para impressão. Não constitui a impressão do boleto em si.

===Prioridade===
Essencial.

===Entradas e pré condições===
'''Entradas:''' filiado(s)/usuário(s), banco, data de vencimento, modelo da guia, nosso número inicial, valor e instruções.
'''Pré-condições:''' usuário logado no sistema; sindicatos e filiados armazenados no banco de dados.

===Saídas e pós-condições===
'''Saídas:''' mensagem de aviso de sucesso da operação. 
'''Pós-condições:''' registro dos boletos inseridos no banco de dados.

===Fluxo principal de eventos===
1. Usuário Externo e Filiado FETAPE: usuário clica no botão Gerar Boletos. Se o usuário estiver com o status óbito, não será gerado boleto. Funcionário FETAPE: funcionário seleciona uma quantidade de filiados na tela de Listagem de Filiados e clica no botão Gerar Boletos. Os filiados com o status “óbito” nunca serão carregados; 
2. Sistema carrega o(s) usuários(s)/filiado(s) selecionados com seus respectivos dados (E1, E2, E3, E4); 
3. Uma janela é aberta perguntando se o usuário deseja imprimir boletos referentes a Contribuição Sindical e Contribuição Confederativa (2 check boxes); 
4. Uma tela é aberta onde o usuário informa os dados (banco, data de vencimento, modelo da guia, nosso número inicial, valor e instruções) para os boletos. Usuário confirma a operação; 
5. Sistema valida os dados inseridos pelo usuário e os dados obrigatórios para emissão de boleto (E5, E6); 
6. Sistema gera os boletos e os armazena no banco de dados com o status “gerado” (E7). O sistema deverá verificar se o número de boleto que ele irá gerar existe em algum intervalo na tabela de boletos avulso. Se existir, ele deverá gerar um próximo número que não esteja em um intervalo desta tabela; 
7. Sistema insere os registros de log da situação dos boletos no banco remoto com a justificava “gerado a partir da função de geração de boleto pelo usuário X:Y”, onde X corresponde ao login do funcionário e Y corresponde ao seu nome; 
8. Sistema exibe mensagem confirmando o sucesso na geração dos boletos e perguntando se o usuário deseja fazer a impressão dos mesmos; 
9. Se o usuário responder que sim, a janela de impressão padrão da funcionalidade imprimir é aberta. Includes [RF004]. 

===Filiado FETAPE===
Este usuário também terá acesso à rotina de CANCELAMENTO do boleto, que consiste meramente na exclusão do mesmo da base de dados. Vale salientar que devem ser efetuados os devidos registros no log do sistema seguindo o padrão supracitado, assim como devem ser atendidos os seguintes fluxos de exceção: 
1. Se o boleto possuir o status “pago”, “impresso” ou “enviado” (para o banco), o cancelamento não será permitido. O sistema exibirá uma mensagem de erro avisando que o boleto não pode ser impresso, indicando o seu status atual; 
2. Se o boleto requisitado não puder ser excluído, o sistema exibe uma mensagem de erro solicitando que o boleto não poder ser removido no momento. 

===Fluxos de exceção===
• E1: se não houver conexão com a internet, uma mensagem será exibida informando que não é possível estabelecer uma conexão com a internet e solicitando ao usuário que verifique sua conexão; 
• E2: se o sistema não estiver disponível, uma mensagem será exibida informando que o serviço não está disponível e que o usuário deve tentar acessá-lo mais tarde; 
• E3: se o resultado da busca retornar vazio, uma mensagem será exibida informando ao usuário que não existem dados referentes à consulta realizada; 
• E4: se o sistema não conseguir acessar a base de dados, uma mensagem será exibida informando ao usuário que a base de dados está inacessível; 
• E5: se o usuário não preencher os dados obrigatórios do boleto (banco, data de vencimento, modelo da guia, nosso número inicial e valor), uma mensagem será exibida informando ao usuário que os campos obrigatórios devem ser preenchidos; 
• E6: se os dados obrigatórios do(s) usuário(s)/filiado(s) para emissão de boleto não foram preenchidos (nome, logradouro, bairro, cidade, estado e CEP), o sistema lista na tela os usuário(s)/filiado(s) cujos dados obrigatórios não estão preenchidos e, para cada um, informa quais campos devem ser preenchidos. O usuário poderá prosseguir para a tela de marcação dos boletos que serão impressos (botão “prosseguir”), no entanto os boletos cujos dados não estão completos não aparecerão para seleção; 
• E7: se houver um estouro na numeração de boletos*, o sistema exibe uma mensagem solicitando ao usuário que entre em contato com a BISA pois houve um problema na geração da numeração do boleto. A operação não é finalizada. O sistema deve ainda efetuar todas as rotinas de rollback de modo a não deixar ‘lixo’ no banco de dados. 

<nowiki>*</nowiki> O estouro na numeração de boletos ocorre quando o limite do número de boletos cadastrado no banco de dados é atingido. Por exemplo, supondo um limite de 10 bytes, se o último registro cadastrado for 9999999999, o próximo registro de boleto irá acionar este erro. 

=[RF004] Imprimir boletos=
===Atores relacionados===
Usuário externo, Filiado FETAPE e Funcionário FETAPE.

===Objetivo===
Constitui a impressão de um boleto já gerado no sistema.

===Prioridade===
Essencial.

===Entradas e pré condições===
'''Entradas:''' lista de boletos para impressão. 
'''Pré-condições:''' o usuário deve estar logado no sistema na tela da listagem de boletos (RF002); os registros dos boletos devem estar armazenados no banco de dados e marcados como “não impresso”.

===Saídas e pós-condições===
'''Saídas:''' impressão dos boletos selecionados. 
'''Pós-Condições:''' registros dos boletos marcados no banco como “impresso”.

===Fluxo principal de eventos===
1. Usuário seleciona na Lista de boletos aqueles que deseja imprimir (check box) e clica no botão Imprimir (E1, E2, E3, E4, E5); 
2. Se o usuário houver selecionado apenas um boleto, o sistema imprime o boleto no navegador, permitindo ao usuário conferir seus dados. Depois disso, ele clica em um novo botão Imprimir e passa para o passo 3; 
3. Janela de impressão padrão é aberta (onde o usuário poderá selecionar impressora, quantidade de páginas, etc). Usuário confirma a impressão e o sistema envia os arquivos para a impressora (E6); 
4. Sistema marca no banco os boletos que foram impressos com o status “impresso” (E7); 
5. Sistema insere no log de boletos os registros com o status impresso com a justificativa “impresso pela função de impressão de boletos pelo usuário X:Y”, onde X corresponde ao código do usuário e Y ao seu nome. 
6. Sistema exibe uma mensagem de “Boletos impressos com sucesso”. 

===Fluxos de exceção===
• E1: se não houver conexão com a internet, uma mensagem será exibida informando que não é possível estabelecer uma conexão com a internet e solicitando ao usuário que verifique sua conexão; 
• E2: se o sistema não estiver disponível, uma mensagem será exibida informando que o serviço não está disponível e que o usuário deve tentar acessá-lo mais tarde; 
• E3: se o usuário não selecionar boletos, o sistema exibe uma mensagem solicitando ao usuário que selecione boletos para impressão; 
• E4: se na lista houver boletos que já foram pagos, o sistema exibe uma mensagem de erro informando que boletos pagos não podem ser reimpressos e cancela a operação; 
• E5: se houver boletos que já foram impressos, o sistema exibe um alerta informando que os boletos já foram impressos pelo sistema e serão reimpressos nesta operação; continua a executar normalmente; 
• E6: se houver um erro ao enviar os dados para a impressora, o sistema exibe uma mensagem avisando ao usuário que o sistema não conseguiu imprimir e solicitando que o mesmo verifique se a impressora está pronta para impressão; 
• E7: se houver um erro na alteração dos registros no banco de dados, uma mensagem será exibida informando que não foi possível marcar os boletos como impressos e solicitando ao usuário que tente novamente e que, caso o erro persista, entre em contato com a BISA. O sistema deve ainda efetuar todas as rotinas de rollback de modo a não deixar ‘lixo’ no banco de dados. 

=[RF005] Cadastro de filiado=
===Atores relacionados===
Filiado FETAPE e Funcionário FETAPE.

===Objetivo===
Cadastrar um filiado. As rotinas de ALTERAÇÃO e de EXCLUSÃO também estão contidas neste requisito para o Funcionário FETAPE.

===Prioridade===
Essencial.

===Entradas e pré condições===
'''Entradas:''' dados cadastrais do usuário. 
'''Pré-condições:''' computador deve ter acesso à internet; servidor web disponível. Funcionário: usuário cadastrado no sistema. 

===Saídas e pós-condições===
'''Saídas:''' mensagem avisando que o usuário foi cadastrado com sucesso. 
'''Pós-Condições:''' usuário cadastrado no banco de dados. 

===Fluxo principal de eventos===
1. Ator Filiado: a função “Cadastrar Filiado” é acionada pelo usuário no navegador web (E1, E2). Ator Funcionário: a função “Cadastrar Filiado” é acionada pelo usuário na tela de Listagem de Filiados (E1, E2). 
2. Um formulário é aberto solicitando dados cadastrais: login, senha, nome, CPF, CNAE, bairro, cidade, UF, logradouro, CEP, categoria (seleção entre as opções arrendatário, assentado, meeiro, parceiro, posseiro, pequeno proprietário e outros) e apelido do filiado; 
3. Usuário preenche os campos e confirma a operação (E3, E4, E5, E6); 
4. Sistema insere os registros de log da situação no banco remoto com a justificava “cadastrado pelo usuário X:Y”, onde X corresponde ao login do usuário e Y corresponde ao seu nome; 
5. Sistema retorna uma mensagem avisando que o usuário foi cadastrado com sucesso. 

O sistema também apresenta as rotinas de ALTERAÇÃO, que por ser trivial e seguir um fluxo semelhante à rotina de inclusão não terá sua execução descrita aqui. Vale salientar que devem ser efetuados os devidos registros no log do sistema. 

===Filiado FETAPE===
Ele possui também a funcionalidade EXCLUSÃO. Sua tela de ALTERAR é diferente. Nela, o usuário pode marcar um check box “óbito” para filiados que foram a óbito.

===Fluxos de exceção===
• E1: se não houver conexão com a internet, uma mensagem será exibida informando que não é possível estabelecer uma conexão com a internet e solicitando ao usuário que verifique sua conexão; 
• E2: se o sistema não estiver disponível, uma mensagem será exibida informando que o serviço não está disponível e que o usuário deve tentar acessá-lo mais tarde; 
• E3: se o login fornecido já estiver cadastrado no sistema, uma mensagem será exibida informando ao usuário que o login cadastrado já existe no sistema; 
• E4: se o CPF do filiado for inválido, uma mensagem será exibida informando ao usuário que o CPF cadastrado é inválido. Vale salientar que o preenchimento deste campo é opcional; 
• E5: se houver um erro na inserção dos registros no banco de dados, uma mensagem será exibida informando que não foi possível inserir os dados e solicitando ao usuário que tente novamente e que, caso o erro persista, entre em contato com a BISA. O sistema deve ainda efetuar todas as rotinas de rollback de modo a não deixar ‘lixo’ no banco de dados; 
• E6: se os dados obrigatórios dos filiados não forem preenchidos (nome, logradouro, bairro, cidade, estado e CEP), o sistema emite uma mensagem de erro informando quais os campos obrigatórios não foram preenchidos. 

=[RF006] Listar filiados=
===Atores relacionados===
Funcionário FETAPE.

===Objetivo===
Listar todos os filiados cadastrados no sistema.

===Prioridade===
Essencial.

===Entradas e pré condições===
'''Entradas:''' nenhuma.
'''Pré-condições:''' usuário logado no sistema; filiados armazenados no banco de dados.

===Saídas e pós-condições===
'''Saídas:''' lista de filiados. 
'''Pós-condições:''' nenhuma. 

===Fluxo principal de eventos===
1. Usuário clica no botão Filiados da barra de funções do sistema para acessar a Listagem de Filiados; 
2. Sistema carrega da base de dados os filiados com seus respectivos dados (E1, E2, E3, E4); 
3. É exibida a lista de filiados (com check boxes para seleção), cada um com seu número, nome, apelido, CPF, município, sindicato e categoria. Os filiados serão ordenados por ordem alfabética e agrupados por município. Também haverá uma check box que permite a seleção de todos os filiados listados na tela e um limite de filiados a serem exibidos, sendo os demais acessados por uma barra de próximo/anterior (semelhante a um esquema de web mail); 
4. Através de uma caixa de seleção (combo box), o usuário pode filtrar os filiados que serão exibidos na tela de acordo com a opção: “nome/apelido/município/sindicato”. A opção “nome” é a padrão. Os filiados que foram a óbito serão exibidos com uma cor de linha de grid acinzentada e só serão exibidos se um check box “todos” for ativado. 

===Fluxos de exceção===
• E1: se não houver conexão com a internet, uma mensagem será exibida informando que não é possível estabelecer uma conexão com a internet e solicitando ao usuário que verifique sua conexão; 
• E2: se o sistema não estiver disponível, uma mensagem será exibida informando que o serviço não está disponível e que o usuário deve tentar acessá-lo mais tarde; 
• E3: se o resultado da busca retornar vazio, uma mensagem será exibida informando ao usuário que não existem dados referentes à consulta realizada; 
• E4: se o sistema não conseguir acessar a base de dados, uma mensagem será exibida informando ao usuário que a base de dados está inacessível. 

=[RF007] Cadastro de sindicato=
===Atores relacionados===
Funcionário FETAPE.

===Objetivo===
Cadastrar um sindicato. As rotinas de ALTERAÇÃO e de EXCLUSÃO também estão contidas neste requisito.

===Prioridade===
Essencial.

===Entradas e pré condições===
'''Entradas:''' dados do sindicato; dados do Município (já presentes na base de dados, herdada do antigo sistema DOS TRAB_RUR). 
'''Pré-condições:''' usuário logado no sistema. 

===Saídas e pós-condições===
'''Saídas:''' mensagem avisando que o sindicato foi cadastrado com sucesso. 
'''Pós-Condições:''' sindicato cadastrado no banco de dados. 

Fluxo principal de eventos
1. Usuário clica no botão cadastrar na tela de Listagem de Sindicatos (E1, E2); 
2. Um formulário é aberto solicitando dados cadastrais: nome, município, UF, endereço; 
3. Usuário preenche os campos e confirma a operação (E3); 
4. Sistema insere os registros de log da situação no banco remoto com a justificava “cadastrado pelo usuário X:Y”, onde X corresponde ao login do funcionário e Y corresponde ao seu nome; 
5. Sistema retorna uma mensagem avisando que o sindicato foi cadastrado com sucesso. 

Também haverá rotinas de alteração e de exclusão. O processo é trivial para ser descrito aqui. Vale salientar que devem ser efetuados os devidos registros no log do sistema. 

===Fluxos de exceção===
• E1: se não houver conexão com a internet, uma mensagem será exibida informando que não é possível estabelecer uma conexão com a internet e solicitando ao usuário que verifique sua conexão; 
• E2: se o sistema não estiver disponível, uma mensagem será exibida informando que o serviço não está disponível e que o usuário deve tentar acessá-lo mais tarde; 
• E3: se houver um erro na inserção dos registros no banco de dados, uma mensagem será exibida informando que não foi possível inserir os dados e solicitando ao usuário que tente novamente e que, caso o erro persista, entre em contato com a BISA. O sistema deve ainda efetuar todas as rotinas de rollback de modo a não deixar ‘lixo’ no banco de dados; 

=[RF008] Listar sindicatos=
===Atores relacionados===
Funcionário FETAPE.

===Objetivo===
Listar todos os sindicatos cadastrados no sistema.

===Prioridade===
Essencial.

===Entradas e pré condições===
'''Entradas:''' nenhuma. 
'''Pré-condições:''' usuário logado no sistema; sindicatos armazenados no banco de dados. 

===Saídas e pós-condições===
'''Saídas:''' lista de sindicatos. 
'''Pós-condições:''' nenhuma. 

===Fluxo principal de eventos===
1. Usuário clica no botão Sindicatos da barra de funções do sistema para acessar a Listagem de Sindicatos; 
2. Sistema carrega da base de dados os sindicatos com seus respectivos dados (E1, E2, E3, E4); 
3. É exibida a lista de sindicatos (com check boxes para seleção), cada um com seu número, nome e município. Os sindicatos serão ordenados por ordem alfabética e agrupados por município. Também haverá uma check box que permite a seleção de todos os sindicatos listados na tela e um limite de sindicatos a serem exibidos, sendo os demais acessados por uma barra de próximo/anterior (semelhante a um esquema de web mail); 
4. Através de uma caixa de seleção (combo box), o usuário pode filtrar os sindicatos que serão exibidos na tela de acordo com a opção: “nome/município”. A opção “nome” é a padrão. 

===Fluxos de exceção===
• E1: se não houver conexão com a internet, uma mensagem será exibida informando que não é possível estabelecer uma conexão com a internet e solicitando ao usuário que verifique sua conexão; 
• E2: se o sistema não estiver disponível, uma mensagem será exibida informando que o serviço não está disponível e que o usuário deve tentar acessá-lo mais tarde; 
• E3: se o resultado da busca retornar vazio, uma mensagem será exibida informando ao usuário que não existem dados referentes à consulta realizada; 
• E4: se o sistema não conseguir acessar a base de dados, uma mensagem será exibida informando ao usuário que a base de dados está inacessível. 

===[RF009] Baixar Boleto===
===Atores relacionados===
Funcionário FETAPE.

===Objetivo===
Baixa nos boletos que foram impressos. Eles passarão a ter o status de pago.

===Prioridade===
Essencial.

===Entradas e pré condições===
'''Entradas:''' lista de boletos para baixa.
'''Pré-condições:''' usuário logado no sistema; os registros dos boletos devem estar armazenados no banco de dados.

===Saídas e pós-condições===
'''Saídas:''' mensagem de aviso de sucesso da operação. 
'''Pós-condições:''' registro dos boletos marcados no banco como “pagos”. 

===Fluxo principal de eventos===
1. Usuário seleciona na Lista de boletos aqueles que deseja baixar (check box) e clica no botão Baixar (E1, E2, E3, E4, E5); 
2. Sistema marca no banco os boletos como pagos (E6). Se o boleto não for encontrado na tabela de boletos, deverá ser procurado na tabela de boletos avulsos (E7); 
3. Sistema insere no log de boletos os registros com o status impresso com a justificativa “baixado pela função de baixar de boletos pelo usuário X:Y”, onde X corresponde ao código do usuário e Y ao seu nome; 
4. Sistema exibe uma mensagem de “Boletos baixados com sucesso”. 

===Fluxos de exceção===
• E1: se não houver conexão com a internet, uma mensagem será exibida informando que não é possível estabelecer uma conexão com a internet e solicitando ao usuário que verifique sua conexão; 
• E2: se o sistema não estiver disponível, uma mensagem será exibida informando que o serviço não está disponível e que o usuário deve tentar acessá-lo mais tarde; 
• E3: se o usuário não selecionar boletos, o sistema exibe uma mensagem solicitando ao usuário que selecione boletos para impressão; 
• E4: se na lista houver boletos com o status “pago”, o sistema exibe uma mensagem informando que boletos selecionados já foram baixados. Se o usuário clicar em continuar, o sistema continua a execução e ignora esses boletos; 
• E5: se na lista houver boletos com o status diferente de “impresso” ou “enviado” (enviado para o banco), o sistema exibe uma mensagem informando que há boletos selecionados que ainda não foram impressos ou enviados para o banco e quais são estes boletos. Se o usuário clicar em continuar, o sistema continua a execução e ignora esses boletos; 
• E6: se houver um erro na alteração dos registros no banco de dados, uma mensagem será exibida informando que não foi possível marcar os boletos como pagos e solicitando ao usuário que tente novamente e que, caso o erro persista, entre em contato com a BISA. O sistema deve ainda efetuar todas as rotinas de rollback de modo a não deixar ‘lixo’ no banco de dados; 
• E7: se o registro do boleto não for encontrado no banco, o sistema exibirá uma mensagem de erro indicando que o boleto não foi encontrado na base de dados do sistema. 

=[RF010] Baixar Boleto Automaticamente (via Arquivo de Retorno do Banco)=
===Atores relacionados===
Funcionário FETAPE.

===Objetivo===
Baixar de boletos a partir de um arquivo de retorno que o banco envia.

===Prioridade===
Essencial.

===Entradas e pré condições===
'''Entradas:''' arquivo de retorno do banco. 
'''Pré-condições:''' usuário logado no sistema; os registros dos boletos devem estar armazenados no banco de dados. 

===Saídas e pós-condições===
'''Saídas:''' mensagem de sucesso da operação. 
'''Pós-condições:''' registro dos boletos marcados no banco como “pagos”. 

===Fluxo principal de eventos===
1. Na tela da Lista de boletos, usuário clica na opção Baixa com Arquivo do Banco (E1, E2); 
2. Uma tela é aberta perguntando qual o arquivo de retorno do banco. O usuário então seleciona o caminho no seu computador correspondente à localização do arquivo e clica em OK. O sistema irá, então, fazer o upload do arquivo (E3, E4, E5); 
3. Sistema guarda a identificação do arquivo de retorno com situação de ‘não processado’ na base de dados e guarda uma cópia do arquivo em diretório especifico para histórico; 
4. Para cada linha do arquivo de retorno, o sistema procura o boleto referente na base de dados de boletos de contribuição. Se o boleto não for encontrado, o sistema procura na base de dados de boletos avulsos. Nesta base, há registros de boletos com intervalos (ex. de 001 a 100). O sistema irá buscar o número do boleto nessa faixa (E6); 
5. O sistema verifica se o boleto encontrado está marcado como “impresso” ou “enviado” (para o banco). Se estiver, o sistema marca no banco de dados o boleto como “pago” (E7); 
6. O sistema insere no log de boletos o registro com situação de “pago” com a justificativa ‘baixado pela função de baixa automática de boleto pelo usuário X:Y’, onde X corresponde ao login de usuário e Y corresponde ao seu nome; 
7. O Sistema marca o arquivo de retorno como ‘processado sem erros’ e uma exibe mensagem confirmando o sucesso na baixa dos boletos. 

===Fluxos de exceção===
• E1: se não houver conexão com a internet, uma mensagem será exibida informando que não é possível estabelecer uma conexão com a internet e solicitando ao usuário que verifique sua conexão; 
• E2: se o sistema não estiver disponível, uma mensagem será exibida informando que o serviço não está disponível e que o usuário deve tentar acessá-lo mais tarde; 
• E3: se o usuário não apontar nenhum arquivo de retorno, uma mensagem será exibida exigindo que o usuário aponte o arquivo; 
• E4: se o caminho para o arquivo estiver incorreto, o sistema exibe uma mensagem para o usuário informando que o caminho selecionado é inválido; 
• E5: se o formato do arquivo não corresponder ao formato do arquivo de retorno do banco esperado, o sistema exibirá uma mensagem informando que o formato do arquivo selecionado é inválido; 
• E6: se um registro do arquivo não for encontrado no sistema (base principal e base de boletos avulsos), será exibido numa tela todos os registros que não foram encontrados. A situação do arquivo de retorno no banco deve então mudar para “processado com erro” e o sistema deve inserir o registro de log de boleto com a justificativa “boleto não pode ser baixado, pois o mesmo não foi encontrado no sistema. Ação executada pelo usuário X:Y”, onde X é o login e Y é o nome. O valor do boleto pago e não encontrado deverá ser armazenado na tabela de boletos no registro cujo identificador é “BoletoXXXX”. Todo boleto que não for encontrado deverá ser somado ao valor desse registro; 
• E7: se houver um erro na alteração dos registros no banco de dados, uma mensagem será exibida informando que não foi possível marcar os boletos como “pago” e solicitando ao usuário que tente novamente e que, caso o erro persista, entre em contato com a BISA. O sistema deve ainda efetuar todas as rotinas de rollback de modo a não deixar ‘lixo’ no banco de dados. 

=[RF011] Gerar arquivo de remessa para banco=
===Atores relacionados===
===Funcionário FETAPE.===

===Objetivo===
Gerar arquivo de remessa de boletos para o banco.

===Prioridade===
Essencial.

===Entradas e pré condições===
'''Entradas:''' lista de boletos que serão enviados para o arquivo. 
'''Pré-condições:''' usuário logado no sistema; os registros dos boletos devem estar armazenados no banco de dados com o status “gerado” ou “impresso”. 

===Saídas e pós-condições===
'''Saídas:''' mensagem de sucesso da operação; arquivo de remessa para o banco. 
'''Pós-condições:''' boletos marcados com o status “enviado” no banco na base de dados. 

===Fluxo principal de eventos===
1. Na tela de Listagem de Boletos, o usuário seleciona os boletos e clica no botão Gerar de arquivo de remessa (E1, E2); 
2. Sistema verifica se todos os boletos selecionados estão marcados como “gerado” ou “impresso” (E3); 
3. Sistema abre tela para que o usuário informe o nome do arquivo e o local onde ele será gerado (E4, E5); 
4. Usuário confirma a geração do arquivo; 
5. Sistema gera o arquivo de remessa; 
6. Sistema marca no banco os boletos que foram inseridos no arquivo de remessa com o status de “enviado” para o banco (E6); 
7. Sistema insere no log de boletos os registros com situação de enviado com a justificativa “boleto gerado no arquivo de remessa para o banco pelo usuário X:Y”, onde X corresponde ao login do usuário e Y corresponde ao seu nome; 
8. Sistema salva em diretório especifico no banco uma cópia do arquivo gerado para remessa para fins de histórico; 
9. Sistema retorna o arquivo de remessa para que o usuário salve-o em seu computador. 

===Fluxos de exceção===
• E1: se não houver conexão com a internet, uma mensagem será exibida informando que não é possível estabelecer uma conexão com a internet e solicitando ao usuário que verifique sua conexão; 
• E2: se o sistema não estiver disponível, uma mensagem será exibida informando que o serviço não está disponível e que o usuário deve tentar acessá-lo mais tarde; 
• E3: se o sistema não encontrar nenhum arquivo com o status “gerado” ou “impresso”, uma mensagem será exibida informando que não existem boletos a serem gerados para o arquivo de remessa. Se encontrar, deverá informar quais os boletos não serão gerados no arquivo; 
• E4: se o usuário informa um local não existente, o sistema pergunta ao usuário se o mesmo deseja que o sistema crie o diretório de pastas informado. Se a resposta for sim, sistema cria diretório de pasta; se a resposta for não, sistema retorna a tela de informação do local para que o usuário selecione um novo diretório; 
• E5: se houver um erro na geração do arquivo de remessa, uma mensagem será exibida informando ao usuário que o arquivo de remessa não pode ser gerado e que o mesmo tente novamente e que, caso o erro persista, entre em contato com a BISA.; 
• E6: se houver um erro na alteração dos registros no banco de dados, uma mensagem será exibida informando que não foi possível marcar os boletos como “enviado” e solicitando ao usuário que tente novamente e que, caso o erro persista, entre em contato com a BISA. O sistema deve ainda efetuar todas as rotinas de rollback de modo a não deixar ‘lixo’ no banco de dados. 

=[RF012] Gerar arquivo de remessa para Gráfica=
===Atores relacionados===
Funcionário FETAPE.

===Objetivo===
Gerar arquivo de remessa de boletos para Gráfica.

===Prioridade===
Essencial.

===Entradas e pré condições===
'''Entradas:''' lista de boletos que serão enviados para o arquivo. 
'''Pré-condições:''' usuário logado no sistema; os registros dos boletos devem estar armazenados no banco de dados com o status “gerado”.

===Saídas e pós-condições===
'''Saídas:''' mensagem de sucesso da operação; arquivo de remessa para a gráfica (em formato txt e xls). 
'''Pós-condições:''' boletos marcados com o status “enviadoGrafica” no banco na base de dados. 

===Fluxo principal de eventos===
1. Na tela de Listagem de Boletos, o usuário seleciona os boletos e clica no botão Gerar arquivo de boleto para Gráfica (E1, E2); 
2. Sistema verifica se todos os boletos selecionados estão marcados como “gerado” (E3); 
3. Sistema abre tela para que o usuário informe o nome do arquivo e o local onde ele será gerado (E4, E5); 
4. Usuário confirma a geração do arquivo; 
5. Sistema pergunta se o usuário quer gerar o arquivo no formato txt ou xls; 
6. Sistema gera o arquivo de remessa para Gráfica; 
7. Sistema marca no banco os boletos que foram inseridos no arquivo de remessa com o status de “enviadoGrafica” para o banco (E6); 
8. Sistema insere no log de boletos os registros com situação de enviado com a justificativa “boleto gerado no arquivo de remessa para Gráfica pelo usuário X:Y”, onde X corresponde ao login do usuário e Y corresponde ao seu nome; 
9. Sistema salva em diretório especifico no banco uma cópia do arquivo gerado para remessa para Gráfica para fins de histórico; 
10. Sistema retorna o arquivo para que o usuário salve-o em seu computador. 

===Fluxos de exceção===
• E1: se não houver conexão com a internet, uma mensagem será exibida informando que não é possível estabelecer uma conexão com a internet e solicitando ao usuário que verifique sua conexão; 
• E2: se o sistema não estiver disponível, uma mensagem será exibida informando que o serviço não está disponível e que o usuário deve tentar acessá-lo mais tarde; 
• E3: se o sistema não encontrar nenhum arquivo com o status “gerado”, uma mensagem será exibida informando que não existem boletos a serem gerados para o arquivo de remessa. Se encontrar, deverá informar quais os boletos não serão gerados no arquivo; 
• E4: se o usuário informa um local não existente, o sistema pergunta ao usuário se o mesmo deseja que o sistema crie o diretório de pastas informado. Se a resposta for sim, sistema cria diretório de pasta; se a resposta for não, sistema retorna a tela de informação do local para que o usuário selecione um novo diretório; 
• E5: se houver um erro na geração do arquivo de remessa, uma mensagem será exibida informando ao usuário que o arquivo de remessa não pode ser gerado e que o mesmo tente novamente e que, caso o erro persista, entre em contato com a BISA; 
• E6: se houver um erro na alteração dos registros no banco de dados, uma mensagem será exibida informando que não foi possível marcar os boletos como “enviado” e solicitando ao usuário que tente novamente e que, caso o erro persista, entre em contato com a BISA. O sistema deve ainda efetuar todas as rotinas de rollback de modo a não deixar ‘lixo’ no banco de dados. 

=4 Especificações Suplementares=
4.1 Objetivos
Este documento tem como finalidade especificar todos os requisitos não funcionais do módulo de boletos web divididos em requisitos de usabilidade, confiabilidade, desempenho, segurança, distribuição, adequação a padrões e requisitos de hardware e software.
4.2 Usabilidade
Esta seção descreve os requisitos não funcionais associados à facilidade de uso da interface com o usuário, material de treinamento e documentação do sistema.
[NF001] Interface com o Usuário
Prioridade: Desejável
O sistema deve possuir uma interface amigável, simples e intuitiva.
4.3 Confiabilidade
Esta seção descreve os requisitos não funcionais associados à freqüência, severidade de falhas do sistema e habilidade de recuperação das mesmas, bem como a corretude do sistema.
[NF001] Tempo de Retorno após Falha
Prioridade: Desejável
Retorno de até 5 segundos após alguma falha.
[NF002] Disponibilidade
Prioridade: Importante
O sistema estará disponível 24 horas por dia durante todos os dias do ano.
4.4 Desempenho
Esta seção descreve os requisitos não funcionais associados à eficiência, uso de recursos e tempo de resposta do sistema.
[NF001] Número de Acessos
O sistema deve ser capaz de atender em média 10 usuários por segundo nos momentos de pico de acesso.
[NF002] Tempo de Resposta para os Usuários
O tempo máximo de resposta de uma requisição deve ser de no máximo 10 segundos.

4.5 Segurança
Esta seção descreve os requisitos não funcionais associados à integridade, privacidade e autenticidade dos dados do sistema.
[NF001] Privacidade de Acesso
Apenas os usuários credenciados e com permissão para acesso a este módulo deverão fazer uso das funcionalidades do módulo de boletos/guias na Web.
4.6 Hardware e software
Esta seção descreve os requisitos não funcionais associados ao hardware e software usados para desenvolver ou para executar o sistema.
[NF001] Linguagem de Implementação
Prioridade: Essencial
A linguagem de implementação do módulo de boleto Web será Delphi, mesma linguagem utilizada no desenvolvimento dos sistemas Partidos2000, Receb2000, OAB2000 e Filiados2000.
[NF002] Banco de Dados
Prioridade: Essencial
O banco de dados utilizado será o MySQL.
[NF003] Ferramentas
Prioridade: Essencial
Ferramenta de modelagem: Borland Delphi 2006
Ferramenta de Desenvolvimento: Borland Delphi 2006
[NF004] Plataforma de Funcionamento
Prioridade: Essencial
A plataforma tanto de desenvolvimento e de funcionamento será Windows.

Para uso do Bw- Construindo

2013-01-22T19:16:21Z

AnaPaula: /* Fluxo principal de eventos */

[[Arquivo:BoletosWeb.PNG]] 

[[Arquivo:Historico_de_revisoes.PNG]] 

=1. Caso de Negócio=
==1.1 Objetivos==

Documentar o novo módulo de geração e impressão de boletos online. As informações aqui descritas especificam e refinam a regras de negócio.

==1.2 Referências==

Se baseará no conhecimento adquirido na implementação de rotinas de boletos da BISA (desktop) e no antigo sistema TRAB_RUR da BISA, em DOS. A entrevista com Mário e Márcio da FETAPE (realizada por Ronaldo e Alexandre) também é referência para a definição dos requisitos.

==1.3 Sistemas com rotinas de gerenciamento de boletos da BISA==

O Filiados 2000 é um sistema desktop de gestão de filiados que controla o cadastro de filiados dos sindicatos de trabalhadores, fazendo acompanhamento de participação na organização.

O OAB 2000 é um software de gestão de cadastro de advogados para OAB's. Faz desde o cadastro de alunos, pré-inscritos, coordena sociedades de advogados, estagiários, até a administração dos dados financeiros dos advogados.

O Receb 2000 é um software voltado para o acompanhamento do contas a receber de uma empresa, fazendo a gestão financeira da carteira de forma simples e eficiente.

Todos esses sistemas possuem uma função de gerenciamento de boletos bancários ou guias sindicais, sendo salvos de forma centralizada no MySQL, de forma que podem ser acessados de forma uniforme no BoletoWEB.

Cada sistema contém suas próprias regras de negócio para gerenciar os boletos; no entanto, as funções de acesso ao banco remoto serão padronizadas para todos os sistemas no BoletoWEB.

==1.4 Descrição do Produto==

A maior parte da implementação é voltada para a FETAPE, enquanto o restante imprime boletos gerados pelos nossos sistema desktop.

Módulo Geral: este módulo tem a função meramente de fornecer uma interface web que permita ao usuário imprimir boletos gerados pelos sistemas desktop da BISA. 

'''Módulo FETAPE:''' no antigo sistema TRAB_RUR da BISA, este sistema é o foco principal desta documentação. Nela o usuário poderá gerenciar todo o fluxo de boletos de contribuições: geração, impressão interna, cadastro de filiados, acesso on-line dos filiados, etc.

==1.5 Contexto de Negócio==

O módulo geral de boletos na web será utilizado a princípio pelos sistemas Receb2000, OAB2000 e Filiados2000, porém poderá ser extendido a qualquer sistema que queira fazer o controle de boletos/guias.

Este módulo concentrará as informações dos boletos em um único local independente de entidade ou sistema. Este local, a priori, ficou definido como sendo um dos servidores internos da BISA que possua acesso externo. Cada sistema rodará normalmente no ambiente do cliente. No momento que for necessário o acesso às informações, este será feito não mais na base local da área do cliente, mas na base remota situada na BISA.

O módulo FETAPE segue as mesmas diretrizes, tendo a diferença de ser implementado exclusivamente para esta entidade, devendo ser adaptável para outras entidades. Para tanto, aconselha-se o uso de uma arquitetura em camadas e padrões de projetos, facilitadores do processos de manutenção.

==1.6 Tecnologias utilizadas==

Os módulos geral e FETAPE deverão implementados utilizando uma tecnologia para web: PHP, Java ou .NET.

O banco de dados necessariamente deverá ser o MySQL, pois já é utilizado na bisa para o registro de boletos.

=2. Sobre os Requisitos=
==2.1 Introdução==

Este documento especifica todos os requisitos funcionais e não funcionais do módulo de gerenciamento de boletos, descrevendo os fluxos de eventos, prioridades, atores, entradas e saídas de cada caso de uso a ser implementado.

A correta interpretação deste documento exige o conhecimento de algumas convenções e termos específicos, que são descritos a seguir.

==2.2 Identificação dos Requisitos==

Por convenção, a referência a requisitos é feita através do nome da subseção onde eles estão descritos, seguidos do identificador do requisito, de acordo com o esquema abaixo:

[nome da subseção, identificador do requisito]

Por exemplo, o requisito funcional [Imprimir Boleto RF002] está descrito em um caso de uso chamado “Imprimir Boleto”, em um bloco identificado pelo identificador [RF002].

==2.3 Prioridades dos Requisitos==

Para estabelecer a prioridade dos requisitos foram adotadas as denominações “essencial”, “importante” e “desejável”. 
• Essencial é o requisito sem o qual o sistema não entra em funcionamento. São requisitos imprescindíveis, que têm que ser implementados. 
• Importante é o requisito sem o qual o sistema entra em funcionamento, mas de forma não satisfatória. Requisitos importantes devem ser implementados, mas, se não forem, o sistema poderá ser implantado e usado mesmo assim. 
• Desejável é o requisito que não compromete as funcionalidades básicas do sistema, isto é, o sistema pode funcionar de forma satisfatória sem ele. Requisitos desejáveis são requisitos que podem ser deixados para versões posteriores do sistema, caso não haja tempo hábil para implementá-los na versão que está sendo especificada. 

==2.4 Descrição dos Atores==

'''Usuário externo'''
É a pessoa que acessa a funcionalidade de impressão de boletos do módulo geral pelo browser.

Filiado FETAPE
Semelhante ao usuário comum, com a diferença de que terá a opção de se cadastrar pelo site.

Funcionário FETAPE
É responsável pelo gerenciamento dos boletos. É o ator principal deste sistema.

=3 Requisitos Funcionais (Casos de Uso)=
==3.1 Ações do Usuário==

==[RF001] Efetuar login==
Atores relacionados
Usuário externo, Filiado FETAPE e Funcionário FETAPE.

===Objetivo===
Fazer login no módulo Web de impressão de boletos.

===Prioridade===
Essencial.

===Entradas e pré condições===
'''Entradas:''' login do usuário e senha;
'''Pré-condições:''' computador deve ter acesso à internet; servidor web disponível.

===Saídas e pós-condições===
'''Saídas:''' não há
'''Pós-condições:''' usuário logado no sistema.

===Fluxo principal de eventos===
1. Usuário executa seu web browser e acessa a página de login (E1, E2); 
2. Usuário informa login e senha e clica em Entrar (E3); 
3. Sistema recupera na base de dados a senha do usuário com o login informado; 
4. Sistema verifica se o login está cadastrado (E4); 
5. Sistema verifica se a senha informada corresponde ao login informado (E5); 
6. Sistema libera o acesso após o sucesso da verificação; 
7. Includes [RF002]. 

===Fluxos de exceção===
• E1: se não houver conexão com a internet, uma mensagem será exibida informando que não é possível estabelecer uma conexão com a internet e solicitando ao usuário que verifique sua conexão; 
• E2: se o sistema não estiver disponível, uma mensagem será exibida informando que o serviço não está disponível e que o usuário deve tentar acessá-lo mais tarde; 
• E3: se o usuário não informar o login ou a senha, o sistema solicita que informe o login e a senha; 
• E4: se o login não estiver cadastrado, o sistema emite uma mensagem de erro informando que este usuário não está cadastrado e solicitando que o mesmo verifique se o login foi digitado corretamente; 
• E5: se a senha não conferir com a que está armazenada na base de dados, o sistema emite uma mensagem de erro avisando que a senha informada está incorreta e solicitando que o mesmo verifique se ela foi digitada corretamente. 

==[RF002] Listar boletos==
===Atores relacionados===
Usuário externo, Filiado FETAPE e Funcionário FETAPE.

===Objetivo===
Listar os boletos correspondentes ao usuário logado.

===Prioridade===
Essencial.

===Entradas e pré condições===
'''Entradas:''' nenhuma.
'''Pré-condições:''' usuário logado no sistema; boletos armazenados no banco de dados.

===Saídas e pós-condições===
'''Saídas:''' lista de boletos.
'''Pós-condições:''' nenhuma.

===Fluxo principal de eventos===
1. Sistema carrega da base de dados os boletos referentes ao usuário (E1, E2, E3); 
2. É exibida a lista de boletos (com check boxes para seleção), cada um com seu número, descrição, valor, vencimento e status (pendente/atrasado/impresso/pago). Os boletos serão ordenados de forma decrescente (maior para o menor) por data de vencimento na lista. Também haverá uma check box que permite a seleção de todos os boletos listados na tela e um limite de boletos a serem exibidos, sendo os demais boletos acessados por uma barra de próximo/anterior (semelhante a um esquema de web mail); 
3. Através de uma caixa de seleção (combo box), o usuário pode filtrar os boletos que serão exibidos na tela de acordo com a opção: “pendentes/impressos/pagos/todos”. Os boletos com status “atrasado” ficarão na lista de “pendentes” e “todos”, mas com uma cor de linha de grid que os diferencie dos demais (ex. vermelho). O status inicial do filtro é “pendentes”. 

===Fluxos de exceção===
• E1: se não houver conexão com a internet, uma mensagem será exibida informando que não é possível estabelecer uma conexão com a internet e solicitando ao usuário que verifique sua conexão; 
• E2: se o sistema não estiver disponível, uma mensagem será exibida informando que o serviço não está disponível e que o usuário deve tentar acessá-lo mais tarde; 
• E3: se o resultado da busca retornar vazio, uma mensagem será exibida informando ao usuário que não existe dados referentes à consulta realizada. 

=[RF003] Geração de boletos=
===Atores relacionados===
Usuário externo, Filiado FETAPE e Funcionário FETAPE.

===Objetivo===
Gerar registros de boletos no banco de dados para impressão. Não constitui a impressão do boleto em si.

===Prioridade===
Essencial.

===Entradas e pré condições===
'''Entradas:''' filiado(s)/usuário(s), banco, data de vencimento, modelo da guia, nosso número inicial, valor e instruções.
'''Pré-condições:''' usuário logado no sistema; sindicatos e filiados armazenados no banco de dados.

===Saídas e pós-condições===
'''Saídas:''' mensagem de aviso de sucesso da operação. 
'''Pós-condições:''' registro dos boletos inseridos no banco de dados.

===Fluxo principal de eventos===
1. Usuário Externo e Filiado FETAPE: usuário clica no botão Gerar Boletos. Se o usuário estiver com o status óbito, não será gerado boleto. Funcionário FETAPE: funcionário seleciona uma quantidade de filiados na tela de Listagem de Filiados e clica no botão Gerar Boletos. Os filiados com o status “óbito” nunca serão carregados; 
2. Sistema carrega o(s) usuários(s)/filiado(s) selecionados com seus respectivos dados (E1, E2, E3, E4); 
3. Uma janela é aberta perguntando se o usuário deseja imprimir boletos referentes a Contribuição Sindical e Contribuição Confederativa (2 check boxes); 
4. Uma tela é aberta onde o usuário informa os dados (banco, data de vencimento, modelo da guia, nosso número inicial, valor e instruções) para os boletos. Usuário confirma a operação; 
5. Sistema valida os dados inseridos pelo usuário e os dados obrigatórios para emissão de boleto (E5, E6); 
6. Sistema gera os boletos e os armazena no banco de dados com o status “gerado” (E7). O sistema deverá verificar se o número de boleto que ele irá gerar existe em algum intervalo na tabela de boletos avulso. Se existir, ele deverá gerar um próximo número que não esteja em um intervalo desta tabela; 
7. Sistema insere os registros de log da situação dos boletos no banco remoto com a justificava “gerado a partir da função de geração de boleto pelo usuário X:Y”, onde X corresponde ao login do funcionário e Y corresponde ao seu nome; 
8. Sistema exibe mensagem confirmando o sucesso na geração dos boletos e perguntando se o usuário deseja fazer a impressão dos mesmos; 
9. Se o usuário responder que sim, a janela de impressão padrão da funcionalidade imprimir é aberta. Includes [RF004]. 

===Filiado FETAPE===
Este usuário também terá acesso à rotina de CANCELAMENTO do boleto, que consiste meramente na exclusão do mesmo da base de dados. Vale salientar que devem ser efetuados os devidos registros no log do sistema seguindo o padrão supracitado, assim como devem ser atendidos os seguintes fluxos de exceção: 
1. Se o boleto possuir o status “pago”, “impresso” ou “enviado” (para o banco), o cancelamento não será permitido. O sistema exibirá uma mensagem de erro avisando que o boleto não pode ser impresso, indicando o seu status atual; 
2. Se o boleto requisitado não puder ser excluído, o sistema exibe uma mensagem de erro solicitando que o boleto não poder ser removido no momento. 

===Fluxos de exceção===
• E1: se não houver conexão com a internet, uma mensagem será exibida informando que não é possível estabelecer uma conexão com a internet e solicitando ao usuário que verifique sua conexão; 
• E2: se o sistema não estiver disponível, uma mensagem será exibida informando que o serviço não está disponível e que o usuário deve tentar acessá-lo mais tarde; 
• E3: se o resultado da busca retornar vazio, uma mensagem será exibida informando ao usuário que não existem dados referentes à consulta realizada; 
• E4: se o sistema não conseguir acessar a base de dados, uma mensagem será exibida informando ao usuário que a base de dados está inacessível; 
• E5: se o usuário não preencher os dados obrigatórios do boleto (banco, data de vencimento, modelo da guia, nosso número inicial e valor), uma mensagem será exibida informando ao usuário que os campos obrigatórios devem ser preenchidos; 
• E6: se os dados obrigatórios do(s) usuário(s)/filiado(s) para emissão de boleto não foram preenchidos (nome, logradouro, bairro, cidade, estado e CEP), o sistema lista na tela os usuário(s)/filiado(s) cujos dados obrigatórios não estão preenchidos e, para cada um, informa quais campos devem ser preenchidos. O usuário poderá prosseguir para a tela de marcação dos boletos que serão impressos (botão “prosseguir”), no entanto os boletos cujos dados não estão completos não aparecerão para seleção; 
• E7: se houver um estouro na numeração de boletos*, o sistema exibe uma mensagem solicitando ao usuário que entre em contato com a BISA pois houve um problema na geração da numeração do boleto. A operação não é finalizada. O sistema deve ainda efetuar todas as rotinas de rollback de modo a não deixar ‘lixo’ no banco de dados. 

<nowiki>*</nowiki> O estouro na numeração de boletos ocorre quando o limite do número de boletos cadastrado no banco de dados é atingido. Por exemplo, supondo um limite de 10 bytes, se o último registro cadastrado for 9999999999, o próximo registro de boleto irá acionar este erro. 

=[RF004] Imprimir boletos=
===Atores relacionados===
Usuário externo, Filiado FETAPE e Funcionário FETAPE.

===Objetivo===
Constitui a impressão de um boleto já gerado no sistema.

===Prioridade===
Essencial.

===Entradas e pré condições===
'''Entradas:''' lista de boletos para impressão. 
'''Pré-condições:''' o usuário deve estar logado no sistema na tela da listagem de boletos (RF002); os registros dos boletos devem estar armazenados no banco de dados e marcados como “não impresso”.

===Saídas e pós-condições===
'''Saídas:''' impressão dos boletos selecionados. 
'''Pós-Condições:''' registros dos boletos marcados no banco como “impresso”.

===Fluxo principal de eventos===
1. Usuário seleciona na Lista de boletos aqueles que deseja imprimir (check box) e clica no botão Imprimir (E1, E2, E3, E4, E5); 
2. Se o usuário houver selecionado apenas um boleto, o sistema imprime o boleto no navegador, permitindo ao usuário conferir seus dados. Depois disso, ele clica em um novo botão Imprimir e passa para o passo 3; 
3. Janela de impressão padrão é aberta (onde o usuário poderá selecionar impressora, quantidade de páginas, etc). Usuário confirma a impressão e o sistema envia os arquivos para a impressora (E6); 
4. Sistema marca no banco os boletos que foram impressos com o status “impresso” (E7); 
5. Sistema insere no log de boletos os registros com o status impresso com a justificativa “impresso pela função de impressão de boletos pelo usuário X:Y”, onde X corresponde ao código do usuário e Y ao seu nome. 
6. Sistema exibe uma mensagem de “Boletos impressos com sucesso”. 

===Fluxos de exceção===
• E1: se não houver conexão com a internet, uma mensagem será exibida informando que não é possível estabelecer uma conexão com a internet e solicitando ao usuário que verifique sua conexão; 
• E2: se o sistema não estiver disponível, uma mensagem será exibida informando que o serviço não está disponível e que o usuário deve tentar acessá-lo mais tarde; 
• E3: se o usuário não selecionar boletos, o sistema exibe uma mensagem solicitando ao usuário que selecione boletos para impressão; 
• E4: se na lista houver boletos que já foram pagos, o sistema exibe uma mensagem de erro informando que boletos pagos não podem ser reimpressos e cancela a operação; 
• E5: se houver boletos que já foram impressos, o sistema exibe um alerta informando que os boletos já foram impressos pelo sistema e serão reimpressos nesta operação; continua a executar normalmente; 
• E6: se houver um erro ao enviar os dados para a impressora, o sistema exibe uma mensagem avisando ao usuário que o sistema não conseguiu imprimir e solicitando que o mesmo verifique se a impressora está pronta para impressão; 
• E7: se houver um erro na alteração dos registros no banco de dados, uma mensagem será exibida informando que não foi possível marcar os boletos como impressos e solicitando ao usuário que tente novamente e que, caso o erro persista, entre em contato com a BISA. O sistema deve ainda efetuar todas as rotinas de rollback de modo a não deixar ‘lixo’ no banco de dados. 

=[RF005] Cadastro de filiado=
===Atores relacionados===
Filiado FETAPE e Funcionário FETAPE.

===Objetivo===
Cadastrar um filiado. As rotinas de ALTERAÇÃO e de EXCLUSÃO também estão contidas neste requisito para o Funcionário FETAPE.

===Prioridade===
Essencial.

===Entradas e pré condições===
'''Entradas:''' dados cadastrais do usuário. 
'''Pré-condições:''' computador deve ter acesso à internet; servidor web disponível. Funcionário: usuário cadastrado no sistema. 

===Saídas e pós-condições===
'''Saídas:''' mensagem avisando que o usuário foi cadastrado com sucesso. 
'''Pós-Condições:''' usuário cadastrado no banco de dados. 

===Fluxo principal de eventos===
1. Ator Filiado: a função “Cadastrar Filiado” é acionada pelo usuário no navegador web (E1, E2). Ator Funcionário: a função “Cadastrar Filiado” é acionada pelo usuário na tela de Listagem de Filiados (E1, E2). 
2. Um formulário é aberto solicitando dados cadastrais: login, senha, nome, CPF, CNAE, bairro, cidade, UF, logradouro, CEP, categoria (seleção entre as opções arrendatário, assentado, meeiro, parceiro, posseiro, pequeno proprietário e outros) e apelido do filiado; 
3. Usuário preenche os campos e confirma a operação (E3, E4, E5, E6); 
4. Sistema insere os registros de log da situação no banco remoto com a justificava “cadastrado pelo usuário X:Y”, onde X corresponde ao login do usuário e Y corresponde ao seu nome; 
5. Sistema retorna uma mensagem avisando que o usuário foi cadastrado com sucesso. 

O sistema também apresenta as rotinas de ALTERAÇÃO, que por ser trivial e seguir um fluxo semelhante à rotina de inclusão não terá sua execução descrita aqui. Vale salientar que devem ser efetuados os devidos registros no log do sistema. 

===Filiado FETAPE===
Ele possui também a funcionalidade EXCLUSÃO. Sua tela de ALTERAR é diferente. Nela, o usuário pode marcar um check box “óbito” para filiados que foram a óbito.

===Fluxos de exceção===
• E1: se não houver conexão com a internet, uma mensagem será exibida informando que não é possível estabelecer uma conexão com a internet e solicitando ao usuário que verifique sua conexão; 
• E2: se o sistema não estiver disponível, uma mensagem será exibida informando que o serviço não está disponível e que o usuário deve tentar acessá-lo mais tarde; 
• E3: se o login fornecido já estiver cadastrado no sistema, uma mensagem será exibida informando ao usuário que o login cadastrado já existe no sistema; 
• E4: se o CPF do filiado for inválido, uma mensagem será exibida informando ao usuário que o CPF cadastrado é inválido. Vale salientar que o preenchimento deste campo é opcional; 
• E5: se houver um erro na inserção dos registros no banco de dados, uma mensagem será exibida informando que não foi possível inserir os dados e solicitando ao usuário que tente novamente e que, caso o erro persista, entre em contato com a BISA. O sistema deve ainda efetuar todas as rotinas de rollback de modo a não deixar ‘lixo’ no banco de dados; 
• E6: se os dados obrigatórios dos filiados não forem preenchidos (nome, logradouro, bairro, cidade, estado e CEP), o sistema emite uma mensagem de erro informando quais os campos obrigatórios não foram preenchidos. 

=[RF006] Listar filiados=
===Atores relacionados===
Funcionário FETAPE.

===Objetivo===
Listar todos os filiados cadastrados no sistema.

===Prioridade===
Essencial.

===Entradas e pré condições===
'''Entradas:''' nenhuma.
'''Pré-condições:''' usuário logado no sistema; filiados armazenados no banco de dados.

===Saídas e pós-condições===
'''Saídas:''' lista de filiados. 
'''Pós-condições:''' nenhuma. 

===Fluxo principal de eventos===
1. Usuário clica no botão Filiados da barra de funções do sistema para acessar a Listagem de Filiados; 
2. Sistema carrega da base de dados os filiados com seus respectivos dados (E1, E2, E3, E4); 
3. É exibida a lista de filiados (com check boxes para seleção), cada um com seu número, nome, apelido, CPF, município, sindicato e categoria. Os filiados serão ordenados por ordem alfabética e agrupados por município. Também haverá uma check box que permite a seleção de todos os filiados listados na tela e um limite de filiados a serem exibidos, sendo os demais acessados por uma barra de próximo/anterior (semelhante a um esquema de web mail); 
4. Através de uma caixa de seleção (combo box), o usuário pode filtrar os filiados que serão exibidos na tela de acordo com a opção: “nome/apelido/município/sindicato”. A opção “nome” é a padrão. Os filiados que foram a óbito serão exibidos com uma cor de linha de grid acinzentada e só serão exibidos se um check box “todos” for ativado. 

===Fluxos de exceção===
• E1: se não houver conexão com a internet, uma mensagem será exibida informando que não é possível estabelecer uma conexão com a internet e solicitando ao usuário que verifique sua conexão; 
• E2: se o sistema não estiver disponível, uma mensagem será exibida informando que o serviço não está disponível e que o usuário deve tentar acessá-lo mais tarde; 
• E3: se o resultado da busca retornar vazio, uma mensagem será exibida informando ao usuário que não existem dados referentes à consulta realizada; 
• E4: se o sistema não conseguir acessar a base de dados, uma mensagem será exibida informando ao usuário que a base de dados está inacessível. 

=[RF007] Cadastro de sindicato=
===Atores relacionados===
Funcionário FETAPE.

===Objetivo===
Cadastrar um sindicato. As rotinas de ALTERAÇÃO e de EXCLUSÃO também estão contidas neste requisito.

===Prioridade===
Essencial.

===Entradas e pré condições===
'''Entradas:''' dados do sindicato; dados do Município (já presentes na base de dados, herdada do antigo sistema DOS TRAB_RUR). 
'''Pré-condições:''' usuário logado no sistema. 

===Saídas e pós-condições===
'''Saídas:''' mensagem avisando que o sindicato foi cadastrado com sucesso. 
'''Pós-Condições:''' sindicato cadastrado no banco de dados. 

Fluxo principal de eventos
1. Usuário clica no botão cadastrar na tela de Listagem de Sindicatos (E1, E2); 
2. Um formulário é aberto solicitando dados cadastrais: nome, município, UF, endereço; 
3. Usuário preenche os campos e confirma a operação (E3); 
4. Sistema insere os registros de log da situação no banco remoto com a justificava “cadastrado pelo usuário X:Y”, onde X corresponde ao login do funcionário e Y corresponde ao seu nome; 
5. Sistema retorna uma mensagem avisando que o sindicato foi cadastrado com sucesso. 

Também haverá rotinas de alteração e de exclusão. O processo é trivial para ser descrito aqui. Vale salientar que devem ser efetuados os devidos registros no log do sistema. 

===Fluxos de exceção===
• E1: se não houver conexão com a internet, uma mensagem será exibida informando que não é possível estabelecer uma conexão com a internet e solicitando ao usuário que verifique sua conexão; 
• E2: se o sistema não estiver disponível, uma mensagem será exibida informando que o serviço não está disponível e que o usuário deve tentar acessá-lo mais tarde; 
• E3: se houver um erro na inserção dos registros no banco de dados, uma mensagem será exibida informando que não foi possível inserir os dados e solicitando ao usuário que tente novamente e que, caso o erro persista, entre em contato com a BISA. O sistema deve ainda efetuar todas as rotinas de rollback de modo a não deixar ‘lixo’ no banco de dados; 

=[RF008] Listar sindicatos=
===Atores relacionados===
Funcionário FETAPE.

===Objetivo===
Listar todos os sindicatos cadastrados no sistema.

===Prioridade===
Essencial.

===Entradas e pré condições===
'''Entradas:''' nenhuma. 
'''Pré-condições:''' usuário logado no sistema; sindicatos armazenados no banco de dados. 

===Saídas e pós-condições===
'''Saídas:''' lista de sindicatos. 
'''Pós-condições:''' nenhuma. 

===Fluxo principal de eventos===
1. Usuário clica no botão Sindicatos da barra de funções do sistema para acessar a Listagem de Sindicatos; 
2. Sistema carrega da base de dados os sindicatos com seus respectivos dados (E1, E2, E3, E4); 
3. É exibida a lista de sindicatos (com check boxes para seleção), cada um com seu número, nome e município. Os sindicatos serão ordenados por ordem alfabética e agrupados por município. Também haverá uma check box que permite a seleção de todos os sindicatos listados na tela e um limite de sindicatos a serem exibidos, sendo os demais acessados por uma barra de próximo/anterior (semelhante a um esquema de web mail); 
4. Através de uma caixa de seleção (combo box), o usuário pode filtrar os sindicatos que serão exibidos na tela de acordo com a opção: “nome/município”. A opção “nome” é a padrão. 

===Fluxos de exceção===
• E1: se não houver conexão com a internet, uma mensagem será exibida informando que não é possível estabelecer uma conexão com a internet e solicitando ao usuário que verifique sua conexão; 
• E2: se o sistema não estiver disponível, uma mensagem será exibida informando que o serviço não está disponível e que o usuário deve tentar acessá-lo mais tarde; 
• E3: se o resultado da busca retornar vazio, uma mensagem será exibida informando ao usuário que não existem dados referentes à consulta realizada; 
• E4: se o sistema não conseguir acessar a base de dados, uma mensagem será exibida informando ao usuário que a base de dados está inacessível. 

===[RF009] Baixar Boleto===
===Atores relacionados===
Funcionário FETAPE.

===Objetivo===
Baixa nos boletos que foram impressos. Eles passarão a ter o status de pago.

===Prioridade===
Essencial.

===Entradas e pré condições===
'''Entradas:''' lista de boletos para baixa.
'''Pré-condições:''' usuário logado no sistema; os registros dos boletos devem estar armazenados no banco de dados.

===Saídas e pós-condições===
'''Saídas:''' mensagem de aviso de sucesso da operação. 
'''Pós-condições:''' registro dos boletos marcados no banco como “pagos”. 

===Fluxo principal de eventos===
1. Usuário seleciona na Lista de boletos aqueles que deseja baixar (check box) e clica no botão Baixar (E1, E2, E3, E4, E5); 
2. Sistema marca no banco os boletos como pagos (E6). Se o boleto não for encontrado na tabela de boletos, deverá ser procurado na tabela de boletos avulsos (E7); 
3. Sistema insere no log de boletos os registros com o status impresso com a justificativa “baixado pela função de baixar de boletos pelo usuário X:Y”, onde X corresponde ao código do usuário e Y ao seu nome; 
4. Sistema exibe uma mensagem de “Boletos baixados com sucesso”. 

===Fluxos de exceção===
• E1: se não houver conexão com a internet, uma mensagem será exibida informando que não é possível estabelecer uma conexão com a internet e solicitando ao usuário que verifique sua conexão; 
• E2: se o sistema não estiver disponível, uma mensagem será exibida informando que o serviço não está disponível e que o usuário deve tentar acessá-lo mais tarde; 
• E3: se o usuário não selecionar boletos, o sistema exibe uma mensagem solicitando ao usuário que selecione boletos para impressão; 
• E4: se na lista houver boletos com o status “pago”, o sistema exibe uma mensagem informando que boletos selecionados já foram baixados. Se o usuário clicar em continuar, o sistema continua a execução e ignora esses boletos; 
• E5: se na lista houver boletos com o status diferente de “impresso” ou “enviado” (enviado para o banco), o sistema exibe uma mensagem informando que há boletos selecionados que ainda não foram impressos ou enviados para o banco e quais são estes boletos. Se o usuário clicar em continuar, o sistema continua a execução e ignora esses boletos; 
• E6: se houver um erro na alteração dos registros no banco de dados, uma mensagem será exibida informando que não foi possível marcar os boletos como pagos e solicitando ao usuário que tente novamente e que, caso o erro persista, entre em contato com a BISA. O sistema deve ainda efetuar todas as rotinas de rollback de modo a não deixar ‘lixo’ no banco de dados; 
• E7: se o registro do boleto não for encontrado no banco, o sistema exibirá uma mensagem de erro indicando que o boleto não foi encontrado na base de dados do sistema. 

=[RF010] Baixar Boleto Automaticamente (via Arquivo de Retorno do Banco)=
===Atores relacionados===
Funcionário FETAPE.

===Objetivo===
Baixar de boletos a partir de um arquivo de retorno que o banco envia.

===Prioridade===
Essencial.

===Entradas e pré condições===
'''Entradas:''' arquivo de retorno do banco. 
'''Pré-condições:''' usuário logado no sistema; os registros dos boletos devem estar armazenados no banco de dados. 

===Saídas e pós-condições===
'''Saídas:''' mensagem de sucesso da operação. 
'''Pós-condições:''' registro dos boletos marcados no banco como “pagos”. 

===Fluxo principal de eventos===
1. Na tela da Lista de boletos, usuário clica na opção Baixa com Arquivo do Banco (E1, E2); 
2. Uma tela é aberta perguntando qual o arquivo de retorno do banco. O usuário então seleciona o caminho no seu computador correspondente à localização do arquivo e clica em OK. O sistema irá, então, fazer o upload do arquivo (E3, E4, E5); 
3. Sistema guarda a identificação do arquivo de retorno com situação de ‘não processado’ na base de dados e guarda uma cópia do arquivo em diretório especifico para histórico; 
4. Para cada linha do arquivo de retorno, o sistema procura o boleto referente na base de dados de boletos de contribuição. Se o boleto não for encontrado, o sistema procura na base de dados de boletos avulsos. Nesta base, há registros de boletos com intervalos (ex. de 001 a 100). O sistema irá buscar o número do boleto nessa faixa (E6); 
5. O sistema verifica se o boleto encontrado está marcado como “impresso” ou “enviado” (para o banco). Se estiver, o sistema marca no banco de dados o boleto como “pago” (E7); 
6. O sistema insere no log de boletos o registro com situação de “pago” com a justificativa ‘baixado pela função de baixa automática de boleto pelo usuário X:Y’, onde X corresponde ao login de usuário e Y corresponde ao seu nome; 
7. O Sistema marca o arquivo de retorno como ‘processado sem erros’ e uma exibe mensagem confirmando o sucesso na baixa dos boletos. 

===Fluxos de exceção===
• E1: se não houver conexão com a internet, uma mensagem será exibida informando que não é possível estabelecer uma conexão com a internet e solicitando ao usuário que verifique sua conexão; 
• E2: se o sistema não estiver disponível, uma mensagem será exibida informando que o serviço não está disponível e que o usuário deve tentar acessá-lo mais tarde; 
• E3: se o usuário não apontar nenhum arquivo de retorno, uma mensagem será exibida exigindo que o usuário aponte o arquivo; 
• E4: se o caminho para o arquivo estiver incorreto, o sistema exibe uma mensagem para o usuário informando que o caminho selecionado é inválido; 
• E5: se o formato do arquivo não corresponder ao formato do arquivo de retorno do banco esperado, o sistema exibirá uma mensagem informando que o formato do arquivo selecionado é inválido; 
• E6: se um registro do arquivo não for encontrado no sistema (base principal e base de boletos avulsos), será exibido numa tela todos os registros que não foram encontrados. A situação do arquivo de retorno no banco deve então mudar para “processado com erro” e o sistema deve inserir o registro de log de boleto com a justificativa “boleto não pode ser baixado, pois o mesmo não foi encontrado no sistema. Ação executada pelo usuário X:Y”, onde X é o login e Y é o nome. O valor do boleto pago e não encontrado deverá ser armazenado na tabela de boletos no registro cujo identificador é “BoletoXXXX”. Todo boleto que não for encontrado deverá ser somado ao valor desse registro; 
• E7: se houver um erro na alteração dos registros no banco de dados, uma mensagem será exibida informando que não foi possível marcar os boletos como “pago” e solicitando ao usuário que tente novamente e que, caso o erro persista, entre em contato com a BISA. O sistema deve ainda efetuar todas as rotinas de rollback de modo a não deixar ‘lixo’ no banco de dados. 

=[RF011] Gerar arquivo de remessa para banco=
Atores relacionados
Funcionário FETAPE.

Objetivo
Gerar arquivo de remessa de boletos para o banco.

Prioridade
Essencial.

Entradas e pré condições
Entradas: lista de boletos que serão enviados para o arquivo.
Pré-condições: usuário logado no sistema; os registros dos boletos devem estar armazenados no banco de dados com o status “gerado” ou “impresso”.

Saídas e pós-condições
Saídas: mensagem de sucesso da operação; arquivo de remessa para o banco.
Pós-condições: boletos marcados com o status “enviado” no banco na base de dados.

Fluxo principal de eventos
1. Na tela de Listagem de Boletos, o usuário seleciona os boletos e clica no botão Gerar de arquivo de remessa (E1, E2);
2. Sistema verifica se todos os boletos selecionados estão marcados como “gerado” ou “impresso” (E3);
3. Sistema abre tela para que o usuário informe o nome do arquivo e o local onde ele será gerado (E4, E5);
4. Usuário confirma a geração do arquivo;
5. Sistema gera o arquivo de remessa;
6. Sistema marca no banco os boletos que foram inseridos no arquivo de remessa com o status de “enviado” para o banco (E6);
7. Sistema insere no log de boletos os registros com situação de enviado com a justificativa “boleto gerado no arquivo de remessa para o banco pelo usuário X:Y”, onde X corresponde ao login do usuário e Y corresponde ao seu nome;
8. Sistema salva em diretório especifico no banco uma cópia do arquivo gerado para remessa para fins de histórico;
9. Sistema retorna o arquivo de remessa para que o usuário salve-o em seu computador.

Fluxos de exceção
• E1: se não houver conexão com a internet, uma mensagem será exibida informando que não é possível estabelecer uma conexão com a internet e solicitando ao usuário que verifique sua conexão;
• E2: se o sistema não estiver disponível, uma mensagem será exibida informando que o serviço não está disponível e que o usuário deve tentar acessá-lo mais tarde;
• E3: se o sistema não encontrar nenhum arquivo com o status “gerado” ou “impresso”, uma mensagem será exibida informando que não existem boletos a serem gerados para o arquivo de remessa. Se encontrar, deverá informar quais os boletos não serão gerados no arquivo;
• E4: se o usuário informa um local não existente, o sistema pergunta ao usuário se o mesmo deseja que o sistema crie o diretório de pastas informado. Se a resposta for sim, sistema cria diretório de pasta; se a resposta for não, sistema retorna a tela de informação do local para que o usuário selecione um novo diretório;
• E5: se houver um erro na geração do arquivo de remessa, uma mensagem será exibida informando ao usuário que o arquivo de remessa não pode ser gerado e que o mesmo tente novamente e que, caso o erro persista, entre em contato com a BISA.;
• E6: se houver um erro na alteração dos registros no banco de dados, uma mensagem será exibida informando que não foi possível marcar os boletos como “enviado” e solicitando ao usuário que tente novamente e que, caso o erro persista, entre em contato com a BISA. O sistema deve ainda efetuar todas as rotinas de rollback de modo a não deixar ‘lixo’ no banco de dados.

[RF012] Gerar arquivo de remessa para Gráfica
Atores relacionados
Funcionário FETAPE.

Objetivo
Gerar arquivo de remessa de boletos para Gráfica.

Prioridade
Essencial.

Entradas e pré condições
Entradas: lista de boletos que serão enviados para o arquivo.
Pré-condições: usuário logado no sistema; os registros dos boletos devem estar armazenados no banco de dados com o status “gerado”.

Saídas e pós-condições
Saídas: mensagem de sucesso da operação; arquivo de remessa para a gráfica (em formato txt e xls).
Pós-condições: boletos marcados com o status “enviadoGrafica” no banco na base de dados.

Fluxo principal de eventos
1. Na tela de Listagem de Boletos, o usuário seleciona os boletos e clica no botão Gerar arquivo de boleto para Gráfica (E1, E2);
2. Sistema verifica se todos os boletos selecionados estão marcados como “gerado” (E3);
3. Sistema abre tela para que o usuário informe o nome do arquivo e o local onde ele será gerado (E4, E5);
4. Usuário confirma a geração do arquivo;
5. Sistema pergunta se o usuário quer gerar o arquivo no formato txt ou xls;
6. Sistema gera o arquivo de remessa para Gráfica;
7. Sistema marca no banco os boletos que foram inseridos no arquivo de remessa com o status de “enviadoGrafica” para o banco (E6);
8. Sistema insere no log de boletos os registros com situação de enviado com a justificativa “boleto gerado no arquivo de remessa para Gráfica pelo usuário X:Y”, onde X corresponde ao login do usuário e Y corresponde ao seu nome;
9. Sistema salva em diretório especifico no banco uma cópia do arquivo gerado para remessa para Gráfica para fins de histórico;
10. Sistema retorna o arquivo para que o usuário salve-o em seu computador.

Fluxos de exceção
• E1: se não houver conexão com a internet, uma mensagem será exibida informando que não é possível estabelecer uma conexão com a internet e solicitando ao usuário que verifique sua conexão;
• E2: se o sistema não estiver disponível, uma mensagem será exibida informando que o serviço não está disponível e que o usuário deve tentar acessá-lo mais tarde;
• E3: se o sistema não encontrar nenhum arquivo com o status “gerado”, uma mensagem será exibida informando que não existem boletos a serem gerados para o arquivo de remessa. Se encontrar, deverá informar quais os boletos não serão gerados no arquivo;
• E4: se o usuário informa um local não existente, o sistema pergunta ao usuário se o mesmo deseja que o sistema crie o diretório de pastas informado. Se a resposta for sim, sistema cria diretório de pasta; se a resposta for não, sistema retorna a tela de informação do local para que o usuário selecione um novo diretório;
• E5: se houver um erro na geração do arquivo de remessa, uma mensagem será exibida informando ao usuário que o arquivo de remessa não pode ser gerado e que o mesmo tente novamente e que, caso o erro persista, entre em contato com a BISA;
• E6: se houver um erro na alteração dos registros no banco de dados, uma mensagem será exibida informando que não foi possível marcar os boletos como “enviado” e solicitando ao usuário que tente novamente e que, caso o erro persista, entre em contato com a BISA. O sistema deve ainda efetuar todas as rotinas de rollback de modo a não deixar ‘lixo’ no banco de dados.

4 Especificações Suplementares
4.1 Objetivos
Este documento tem como finalidade especificar todos os requisitos não funcionais do módulo de boletos web divididos em requisitos de usabilidade, confiabilidade, desempenho, segurança, distribuição, adequação a padrões e requisitos de hardware e software.
4.2 Usabilidade
Esta seção descreve os requisitos não funcionais associados à facilidade de uso da interface com o usuário, material de treinamento e documentação do sistema.
[NF001] Interface com o Usuário
Prioridade: Desejável
O sistema deve possuir uma interface amigável, simples e intuitiva.
4.3 Confiabilidade
Esta seção descreve os requisitos não funcionais associados à freqüência, severidade de falhas do sistema e habilidade de recuperação das mesmas, bem como a corretude do sistema.
[NF001] Tempo de Retorno após Falha
Prioridade: Desejável
Retorno de até 5 segundos após alguma falha.
[NF002] Disponibilidade
Prioridade: Importante
O sistema estará disponível 24 horas por dia durante todos os dias do ano.
4.4 Desempenho
Esta seção descreve os requisitos não funcionais associados à eficiência, uso de recursos e tempo de resposta do sistema.
[NF001] Número de Acessos
O sistema deve ser capaz de atender em média 10 usuários por segundo nos momentos de pico de acesso.
[NF002] Tempo de Resposta para os Usuários
O tempo máximo de resposta de uma requisição deve ser de no máximo 10 segundos.

4.5 Segurança
Esta seção descreve os requisitos não funcionais associados à integridade, privacidade e autenticidade dos dados do sistema.
[NF001] Privacidade de Acesso
Apenas os usuários credenciados e com permissão para acesso a este módulo deverão fazer uso das funcionalidades do módulo de boletos/guias na Web.
4.6 Hardware e software
Esta seção descreve os requisitos não funcionais associados ao hardware e software usados para desenvolver ou para executar o sistema.
[NF001] Linguagem de Implementação
Prioridade: Essencial
A linguagem de implementação do módulo de boleto Web será Delphi, mesma linguagem utilizada no desenvolvimento dos sistemas Partidos2000, Receb2000, OAB2000 e Filiados2000.
[NF002] Banco de Dados
Prioridade: Essencial
O banco de dados utilizado será o MySQL.
[NF003] Ferramentas
Prioridade: Essencial
Ferramenta de modelagem: Borland Delphi 2006
Ferramenta de Desenvolvimento: Borland Delphi 2006
[NF004] Plataforma de Funcionamento
Prioridade: Essencial
A plataforma tanto de desenvolvimento e de funcionamento será Windows.

Para uso do Bw- Construindo

2013-01-22T18:43:06Z

AnaPaula:

[[Arquivo:BoletosWeb.PNG]] 

[[Arquivo:Historico_de_revisoes.PNG]] 

=1. Caso de Negócio=
==1.1 Objetivos==

Documentar o novo módulo de geração e impressão de boletos online. As informações aqui descritas especificam e refinam a regras de negócio.

==1.2 Referências==

Se baseará no conhecimento adquirido na implementação de rotinas de boletos da BISA (desktop) e no antigo sistema TRAB_RUR da BISA, em DOS. A entrevista com Mário e Márcio da FETAPE (realizada por Ronaldo e Alexandre) também é referência para a definição dos requisitos.

==1.3 Sistemas com rotinas de gerenciamento de boletos da BISA==

O Filiados 2000 é um sistema desktop de gestão de filiados que controla o cadastro de filiados dos sindicatos de trabalhadores, fazendo acompanhamento de participação na organização.

O OAB 2000 é um software de gestão de cadastro de advogados para OAB's. Faz desde o cadastro de alunos, pré-inscritos, coordena sociedades de advogados, estagiários, até a administração dos dados financeiros dos advogados.

O Receb 2000 é um software voltado para o acompanhamento do contas a receber de uma empresa, fazendo a gestão financeira da carteira de forma simples e eficiente.

Todos esses sistemas possuem uma função de gerenciamento de boletos bancários ou guias sindicais, sendo salvos de forma centralizada no MySQL, de forma que podem ser acessados de forma uniforme no BoletoWEB.

Cada sistema contém suas próprias regras de negócio para gerenciar os boletos; no entanto, as funções de acesso ao banco remoto serão padronizadas para todos os sistemas no BoletoWEB.

==1.4 Descrição do Produto==

A maior parte da implementação é voltada para a FETAPE, enquanto o restante imprime boletos gerados pelos nossos sistema desktop.

Módulo Geral: este módulo tem a função meramente de fornecer uma interface web que permita ao usuário imprimir boletos gerados pelos sistemas desktop da BISA. 

'''Módulo FETAPE:''' no antigo sistema TRAB_RUR da BISA, este sistema é o foco principal desta documentação. Nela o usuário poderá gerenciar todo o fluxo de boletos de contribuições: geração, impressão interna, cadastro de filiados, acesso on-line dos filiados, etc.

==1.5 Contexto de Negócio==

O módulo geral de boletos na web será utilizado a princípio pelos sistemas Receb2000, OAB2000 e Filiados2000, porém poderá ser extendido a qualquer sistema que queira fazer o controle de boletos/guias.

Este módulo concentrará as informações dos boletos em um único local independente de entidade ou sistema. Este local, a priori, ficou definido como sendo um dos servidores internos da BISA que possua acesso externo. Cada sistema rodará normalmente no ambiente do cliente. No momento que for necessário o acesso às informações, este será feito não mais na base local da área do cliente, mas na base remota situada na BISA.

O módulo FETAPE segue as mesmas diretrizes, tendo a diferença de ser implementado exclusivamente para esta entidade, devendo ser adaptável para outras entidades. Para tanto, aconselha-se o uso de uma arquitetura em camadas e padrões de projetos, facilitadores do processos de manutenção.

==1.6 Tecnologias utilizadas==

Os módulos geral e FETAPE deverão implementados utilizando uma tecnologia para web: PHP, Java ou .NET.

O banco de dados necessariamente deverá ser o MySQL, pois já é utilizado na bisa para o registro de boletos.

=2. Sobre os Requisitos=
==2.1 Introdução==

Este documento especifica todos os requisitos funcionais e não funcionais do módulo de gerenciamento de boletos, descrevendo os fluxos de eventos, prioridades, atores, entradas e saídas de cada caso de uso a ser implementado.

A correta interpretação deste documento exige o conhecimento de algumas convenções e termos específicos, que são descritos a seguir.

==2.2 Identificação dos Requisitos==

Por convenção, a referência a requisitos é feita através do nome da subseção onde eles estão descritos, seguidos do identificador do requisito, de acordo com o esquema abaixo:

[nome da subseção, identificador do requisito]

Por exemplo, o requisito funcional [Imprimir Boleto RF002] está descrito em um caso de uso chamado “Imprimir Boleto”, em um bloco identificado pelo identificador [RF002].

==2.3 Prioridades dos Requisitos==

Para estabelecer a prioridade dos requisitos foram adotadas as denominações “essencial”, “importante” e “desejável”. 
• Essencial é o requisito sem o qual o sistema não entra em funcionamento. São requisitos imprescindíveis, que têm que ser implementados. 
• Importante é o requisito sem o qual o sistema entra em funcionamento, mas de forma não satisfatória. Requisitos importantes devem ser implementados, mas, se não forem, o sistema poderá ser implantado e usado mesmo assim. 
• Desejável é o requisito que não compromete as funcionalidades básicas do sistema, isto é, o sistema pode funcionar de forma satisfatória sem ele. Requisitos desejáveis são requisitos que podem ser deixados para versões posteriores do sistema, caso não haja tempo hábil para implementá-los na versão que está sendo especificada. 

==2.4 Descrição dos Atores==

'''Usuário externo'''
É a pessoa que acessa a funcionalidade de impressão de boletos do módulo geral pelo browser.

Filiado FETAPE
Semelhante ao usuário comum, com a diferença de que terá a opção de se cadastrar pelo site.

Funcionário FETAPE
É responsável pelo gerenciamento dos boletos. É o ator principal deste sistema.

=3 Requisitos Funcionais (Casos de Uso)=
==3.1 Ações do Usuário==

==[RF001] Efetuar login==
Atores relacionados
Usuário externo, Filiado FETAPE e Funcionário FETAPE.

===Objetivo===
Fazer login no módulo Web de impressão de boletos.

===Prioridade===
Essencial.

===Entradas e pré condições===
'''Entradas:''' login do usuário e senha;
'''Pré-condições:''' computador deve ter acesso à internet; servidor web disponível.

===Saídas e pós-condições===
'''Saídas:''' não há
'''Pós-condições:''' usuário logado no sistema.

===Fluxo principal de eventos===
1. Usuário executa seu web browser e acessa a página de login (E1, E2); 
2. Usuário informa login e senha e clica em Entrar (E3); 
3. Sistema recupera na base de dados a senha do usuário com o login informado; 
4. Sistema verifica se o login está cadastrado (E4); 
5. Sistema verifica se a senha informada corresponde ao login informado (E5); 
6. Sistema libera o acesso após o sucesso da verificação; 
7. Includes [RF002]. 

===Fluxos de exceção===
• E1: se não houver conexão com a internet, uma mensagem será exibida informando que não é possível estabelecer uma conexão com a internet e solicitando ao usuário que verifique sua conexão; 
• E2: se o sistema não estiver disponível, uma mensagem será exibida informando que o serviço não está disponível e que o usuário deve tentar acessá-lo mais tarde; 
• E3: se o usuário não informar o login ou a senha, o sistema solicita que informe o login e a senha; 
• E4: se o login não estiver cadastrado, o sistema emite uma mensagem de erro informando que este usuário não está cadastrado e solicitando que o mesmo verifique se o login foi digitado corretamente; 
• E5: se a senha não conferir com a que está armazenada na base de dados, o sistema emite uma mensagem de erro avisando que a senha informada está incorreta e solicitando que o mesmo verifique se ela foi digitada corretamente. 

==[RF002] Listar boletos==
===Atores relacionados===
Usuário externo, Filiado FETAPE e Funcionário FETAPE.

===Objetivo===
Listar os boletos correspondentes ao usuário logado.

===Prioridade===
Essencial.

===Entradas e pré condições===
'''Entradas:''' nenhuma.
'''Pré-condições:''' usuário logado no sistema; boletos armazenados no banco de dados.

===Saídas e pós-condições===
'''Saídas:''' lista de boletos.
'''Pós-condições:''' nenhuma.

===Fluxo principal de eventos===
1. Sistema carrega da base de dados os boletos referentes ao usuário (E1, E2, E3); 
2. É exibida a lista de boletos (com check boxes para seleção), cada um com seu número, descrição, valor, vencimento e status (pendente/atrasado/impresso/pago). Os boletos serão ordenados de forma decrescente (maior para o menor) por data de vencimento na lista. Também haverá uma check box que permite a seleção de todos os boletos listados na tela e um limite de boletos a serem exibidos, sendo os demais boletos acessados por uma barra de próximo/anterior (semelhante a um esquema de web mail); 
3. Através de uma caixa de seleção (combo box), o usuário pode filtrar os boletos que serão exibidos na tela de acordo com a opção: “pendentes/impressos/pagos/todos”. Os boletos com status “atrasado” ficarão na lista de “pendentes” e “todos”, mas com uma cor de linha de grid que os diferencie dos demais (ex. vermelho). O status inicial do filtro é “pendentes”. 

===Fluxos de exceção===
• E1: se não houver conexão com a internet, uma mensagem será exibida informando que não é possível estabelecer uma conexão com a internet e solicitando ao usuário que verifique sua conexão; 
• E2: se o sistema não estiver disponível, uma mensagem será exibida informando que o serviço não está disponível e que o usuário deve tentar acessá-lo mais tarde; 
• E3: se o resultado da busca retornar vazio, uma mensagem será exibida informando ao usuário que não existe dados referentes à consulta realizada. 

=[RF003] Geração de boletos=
===Atores relacionados===
Usuário externo, Filiado FETAPE e Funcionário FETAPE.

===Objetivo===
Gerar registros de boletos no banco de dados para impressão. Não constitui a impressão do boleto em si.

===Prioridade===
Essencial.

===Entradas e pré condições===
'''Entradas:''' filiado(s)/usuário(s), banco, data de vencimento, modelo da guia, nosso número inicial, valor e instruções.
'''Pré-condições:''' usuário logado no sistema; sindicatos e filiados armazenados no banco de dados.

===Saídas e pós-condições===
'''Saídas:''' mensagem de aviso de sucesso da operação. 
'''Pós-condições:''' registro dos boletos inseridos no banco de dados.

===Fluxo principal de eventos===
1. Usuário Externo e Filiado FETAPE: usuário clica no botão Gerar Boletos. Se o usuário estiver com o status óbito, não será gerado boleto. Funcionário FETAPE: funcionário seleciona uma quantidade de filiados na tela de Listagem de Filiados e clica no botão Gerar Boletos. Os filiados com o status “óbito” nunca serão carregados; 
2. Sistema carrega o(s) usuários(s)/filiado(s) selecionados com seus respectivos dados (E1, E2, E3, E4); 
3. Uma janela é aberta perguntando se o usuário deseja imprimir boletos referentes a Contribuição Sindical e Contribuição Confederativa (2 check boxes); 
4. Uma tela é aberta onde o usuário informa os dados (banco, data de vencimento, modelo da guia, nosso número inicial, valor e instruções) para os boletos. Usuário confirma a operação; 
5. Sistema valida os dados inseridos pelo usuário e os dados obrigatórios para emissão de boleto (E5, E6); 
6. Sistema gera os boletos e os armazena no banco de dados com o status “gerado” (E7). O sistema deverá verificar se o número de boleto que ele irá gerar existe em algum intervalo na tabela de boletos avulso. Se existir, ele deverá gerar um próximo número que não esteja em um intervalo desta tabela; 
7. Sistema insere os registros de log da situação dos boletos no banco remoto com a justificava “gerado a partir da função de geração de boleto pelo usuário X:Y”, onde X corresponde ao login do funcionário e Y corresponde ao seu nome; 
8. Sistema exibe mensagem confirmando o sucesso na geração dos boletos e perguntando se o usuário deseja fazer a impressão dos mesmos; 
9. Se o usuário responder que sim, a janela de impressão padrão da funcionalidade imprimir é aberta. Includes [RF004]. 

===Filiado FETAPE===
Este usuário também terá acesso à rotina de CANCELAMENTO do boleto, que consiste meramente na exclusão do mesmo da base de dados. Vale salientar que devem ser efetuados os devidos registros no log do sistema seguindo o padrão supracitado, assim como devem ser atendidos os seguintes fluxos de exceção: 
1. Se o boleto possuir o status “pago”, “impresso” ou “enviado” (para o banco), o cancelamento não será permitido. O sistema exibirá uma mensagem de erro avisando que o boleto não pode ser impresso, indicando o seu status atual; 
2. Se o boleto requisitado não puder ser excluído, o sistema exibe uma mensagem de erro solicitando que o boleto não poder ser removido no momento. 

===Fluxos de exceção===
• E1: se não houver conexão com a internet, uma mensagem será exibida informando que não é possível estabelecer uma conexão com a internet e solicitando ao usuário que verifique sua conexão; 
• E2: se o sistema não estiver disponível, uma mensagem será exibida informando que o serviço não está disponível e que o usuário deve tentar acessá-lo mais tarde; 
• E3: se o resultado da busca retornar vazio, uma mensagem será exibida informando ao usuário que não existem dados referentes à consulta realizada; 
• E4: se o sistema não conseguir acessar a base de dados, uma mensagem será exibida informando ao usuário que a base de dados está inacessível; 
• E5: se o usuário não preencher os dados obrigatórios do boleto (banco, data de vencimento, modelo da guia, nosso número inicial e valor), uma mensagem será exibida informando ao usuário que os campos obrigatórios devem ser preenchidos; 
• E6: se os dados obrigatórios do(s) usuário(s)/filiado(s) para emissão de boleto não foram preenchidos (nome, logradouro, bairro, cidade, estado e CEP), o sistema lista na tela os usuário(s)/filiado(s) cujos dados obrigatórios não estão preenchidos e, para cada um, informa quais campos devem ser preenchidos. O usuário poderá prosseguir para a tela de marcação dos boletos que serão impressos (botão “prosseguir”), no entanto os boletos cujos dados não estão completos não aparecerão para seleção; 
• E7: se houver um estouro na numeração de boletos*, o sistema exibe uma mensagem solicitando ao usuário que entre em contato com a BISA pois houve um problema na geração da numeração do boleto. A operação não é finalizada. O sistema deve ainda efetuar todas as rotinas de rollback de modo a não deixar ‘lixo’ no banco de dados. 

<nowiki>*</nowiki> O estouro na numeração de boletos ocorre quando o limite do número de boletos cadastrado no banco de dados é atingido. Por exemplo, supondo um limite de 10 bytes, se o último registro cadastrado for 9999999999, o próximo registro de boleto irá acionar este erro. 

=[RF004] Imprimir boletos=
===Atores relacionados===
Usuário externo, Filiado FETAPE e Funcionário FETAPE.

===Objetivo===
Constitui a impressão de um boleto já gerado no sistema.

===Prioridade===
Essencial.

===Entradas e pré condições===
'''Entradas:''' lista de boletos para impressão. 
'''Pré-condições:''' o usuário deve estar logado no sistema na tela da listagem de boletos (RF002); os registros dos boletos devem estar armazenados no banco de dados e marcados como “não impresso”.

===Saídas e pós-condições===
'''Saídas:''' impressão dos boletos selecionados. 
'''Pós-Condições:''' registros dos boletos marcados no banco como “impresso”.

===Fluxo principal de eventos===
1. Usuário seleciona na Lista de boletos aqueles que deseja imprimir (check box) e clica no botão Imprimir (E1, E2, E3, E4, E5); 
2. Se o usuário houver selecionado apenas um boleto, o sistema imprime o boleto no navegador, permitindo ao usuário conferir seus dados. Depois disso, ele clica em um novo botão Imprimir e passa para o passo 3; 
3. Janela de impressão padrão é aberta (onde o usuário poderá selecionar impressora, quantidade de páginas, etc). Usuário confirma a impressão e o sistema envia os arquivos para a impressora (E6); 
4. Sistema marca no banco os boletos que foram impressos com o status “impresso” (E7); 
5. Sistema insere no log de boletos os registros com o status impresso com a justificativa “impresso pela função de impressão de boletos pelo usuário X:Y”, onde X corresponde ao código do usuário e Y ao seu nome. 
6. Sistema exibe uma mensagem de “Boletos impressos com sucesso”. 

===Fluxos de exceção===
• E1: se não houver conexão com a internet, uma mensagem será exibida informando que não é possível estabelecer uma conexão com a internet e solicitando ao usuário que verifique sua conexão; 
• E2: se o sistema não estiver disponível, uma mensagem será exibida informando que o serviço não está disponível e que o usuário deve tentar acessá-lo mais tarde; 
• E3: se o usuário não selecionar boletos, o sistema exibe uma mensagem solicitando ao usuário que selecione boletos para impressão; 
• E4: se na lista houver boletos que já foram pagos, o sistema exibe uma mensagem de erro informando que boletos pagos não podem ser reimpressos e cancela a operação; 
• E5: se houver boletos que já foram impressos, o sistema exibe um alerta informando que os boletos já foram impressos pelo sistema e serão reimpressos nesta operação; continua a executar normalmente; 
• E6: se houver um erro ao enviar os dados para a impressora, o sistema exibe uma mensagem avisando ao usuário que o sistema não conseguiu imprimir e solicitando que o mesmo verifique se a impressora está pronta para impressão; 
• E7: se houver um erro na alteração dos registros no banco de dados, uma mensagem será exibida informando que não foi possível marcar os boletos como impressos e solicitando ao usuário que tente novamente e que, caso o erro persista, entre em contato com a BISA. O sistema deve ainda efetuar todas as rotinas de rollback de modo a não deixar ‘lixo’ no banco de dados. 

=[RF005] Cadastro de filiado=
===Atores relacionados===
Filiado FETAPE e Funcionário FETAPE.

===Objetivo===
Cadastrar um filiado. As rotinas de ALTERAÇÃO e de EXCLUSÃO também estão contidas neste requisito para o Funcionário FETAPE.

===Prioridade===
Essencial.

===Entradas e pré condições===
'''Entradas:''' dados cadastrais do usuário. 
'''Pré-condições:''' computador deve ter acesso à internet; servidor web disponível. Funcionário: usuário cadastrado no sistema. 

===Saídas e pós-condições===
'''Saídas:''' mensagem avisando que o usuário foi cadastrado com sucesso. 
'''Pós-Condições:''' usuário cadastrado no banco de dados. 

===Fluxo principal de eventos===
1. Ator Filiado: a função “Cadastrar Filiado” é acionada pelo usuário no navegador web (E1, E2). Ator Funcionário: a função “Cadastrar Filiado” é acionada pelo usuário na tela de Listagem de Filiados (E1, E2). 
2. Um formulário é aberto solicitando dados cadastrais: login, senha, nome, CPF, CNAE, bairro, cidade, UF, logradouro, CEP, categoria (seleção entre as opções arrendatário, assentado, meeiro, parceiro, posseiro, pequeno proprietário e outros) e apelido do filiado; 
3. Usuário preenche os campos e confirma a operação (E3, E4, E5, E6); 
4. Sistema insere os registros de log da situação no banco remoto com a justificava “cadastrado pelo usuário X:Y”, onde X corresponde ao login do usuário e Y corresponde ao seu nome; 
5. Sistema retorna uma mensagem avisando que o usuário foi cadastrado com sucesso. 

O sistema também apresenta as rotinas de ALTERAÇÃO, que por ser trivial e seguir um fluxo semelhante à rotina de inclusão não terá sua execução descrita aqui. Vale salientar que devem ser efetuados os devidos registros no log do sistema. 

===Filiado FETAPE===
Ele possui também a funcionalidade EXCLUSÃO. Sua tela de ALTERAR é diferente. Nela, o usuário pode marcar um check box “óbito” para filiados que foram a óbito.

===Fluxos de exceção===
• E1: se não houver conexão com a internet, uma mensagem será exibida informando que não é possível estabelecer uma conexão com a internet e solicitando ao usuário que verifique sua conexão; 
• E2: se o sistema não estiver disponível, uma mensagem será exibida informando que o serviço não está disponível e que o usuário deve tentar acessá-lo mais tarde; 
• E3: se o login fornecido já estiver cadastrado no sistema, uma mensagem será exibida informando ao usuário que o login cadastrado já existe no sistema; 
• E4: se o CPF do filiado for inválido, uma mensagem será exibida informando ao usuário que o CPF cadastrado é inválido. Vale salientar que o preenchimento deste campo é opcional; 
• E5: se houver um erro na inserção dos registros no banco de dados, uma mensagem será exibida informando que não foi possível inserir os dados e solicitando ao usuário que tente novamente e que, caso o erro persista, entre em contato com a BISA. O sistema deve ainda efetuar todas as rotinas de rollback de modo a não deixar ‘lixo’ no banco de dados; 
• E6: se os dados obrigatórios dos filiados não forem preenchidos (nome, logradouro, bairro, cidade, estado e CEP), o sistema emite uma mensagem de erro informando quais os campos obrigatórios não foram preenchidos. 

=[RF006] Listar filiados=
===Atores relacionados===
Funcionário FETAPE.

===Objetivo===
Listar todos os filiados cadastrados no sistema.

===Prioridade===
Essencial.

===Entradas e pré condições===
'''Entradas:''' nenhuma.
'''Pré-condições:''' usuário logado no sistema; filiados armazenados no banco de dados.

===Saídas e pós-condições===
'''Saídas:''' lista de filiados. 
'''Pós-condições:''' nenhuma. 

===Fluxo principal de eventos===
1. Usuário clica no botão Filiados da barra de funções do sistema para acessar a Listagem de Filiados; 
2. Sistema carrega da base de dados os filiados com seus respectivos dados (E1, E2, E3, E4); 
3. É exibida a lista de filiados (com check boxes para seleção), cada um com seu número, nome, apelido, CPF, município, sindicato e categoria. Os filiados serão ordenados por ordem alfabética e agrupados por município. Também haverá uma check box que permite a seleção de todos os filiados listados na tela e um limite de filiados a serem exibidos, sendo os demais acessados por uma barra de próximo/anterior (semelhante a um esquema de web mail); 
4. Através de uma caixa de seleção (combo box), o usuário pode filtrar os filiados que serão exibidos na tela de acordo com a opção: “nome/apelido/município/sindicato”. A opção “nome” é a padrão. Os filiados que foram a óbito serão exibidos com uma cor de linha de grid acinzentada e só serão exibidos se um check box “todos” for ativado. 

===Fluxos de exceção===
• E1: se não houver conexão com a internet, uma mensagem será exibida informando que não é possível estabelecer uma conexão com a internet e solicitando ao usuário que verifique sua conexão; 
• E2: se o sistema não estiver disponível, uma mensagem será exibida informando que o serviço não está disponível e que o usuário deve tentar acessá-lo mais tarde; 
• E3: se o resultado da busca retornar vazio, uma mensagem será exibida informando ao usuário que não existem dados referentes à consulta realizada; 
• E4: se o sistema não conseguir acessar a base de dados, uma mensagem será exibida informando ao usuário que a base de dados está inacessível. 

=[RF007] Cadastro de sindicato=
===Atores relacionados===
Funcionário FETAPE.

===Objetivo===
Cadastrar um sindicato. As rotinas de ALTERAÇÃO e de EXCLUSÃO também estão contidas neste requisito.

===Prioridade===
Essencial.

===Entradas e pré condições===
'''Entradas:''' dados do sindicato; dados do Município (já presentes na base de dados, herdada do antigo sistema DOS TRAB_RUR). 
'''Pré-condições:''' usuário logado no sistema. 

===Saídas e pós-condições===
'''Saídas:''' mensagem avisando que o sindicato foi cadastrado com sucesso. 
'''Pós-Condições:''' sindicato cadastrado no banco de dados. 

Fluxo principal de eventos
1. Usuário clica no botão cadastrar na tela de Listagem de Sindicatos (E1, E2); 
2. Um formulário é aberto solicitando dados cadastrais: nome, município, UF, endereço; 
3. Usuário preenche os campos e confirma a operação (E3); 
4. Sistema insere os registros de log da situação no banco remoto com a justificava “cadastrado pelo usuário X:Y”, onde X corresponde ao login do funcionário e Y corresponde ao seu nome; 
5. Sistema retorna uma mensagem avisando que o sindicato foi cadastrado com sucesso. 

Também haverá rotinas de alteração e de exclusão. O processo é trivial para ser descrito aqui. Vale salientar que devem ser efetuados os devidos registros no log do sistema. 

===Fluxos de exceção===
• E1: se não houver conexão com a internet, uma mensagem será exibida informando que não é possível estabelecer uma conexão com a internet e solicitando ao usuário que verifique sua conexão; 
• E2: se o sistema não estiver disponível, uma mensagem será exibida informando que o serviço não está disponível e que o usuário deve tentar acessá-lo mais tarde; 
• E3: se houver um erro na inserção dos registros no banco de dados, uma mensagem será exibida informando que não foi possível inserir os dados e solicitando ao usuário que tente novamente e que, caso o erro persista, entre em contato com a BISA. O sistema deve ainda efetuar todas as rotinas de rollback de modo a não deixar ‘lixo’ no banco de dados; 

=[RF008] Listar sindicatos=
===Atores relacionados===
Funcionário FETAPE.

===Objetivo===
Listar todos os sindicatos cadastrados no sistema.

===Prioridade===
Essencial.

===Entradas e pré condições===
'''Entradas:''' nenhuma. 
'''Pré-condições:''' usuário logado no sistema; sindicatos armazenados no banco de dados. 

===Saídas e pós-condições===
'''Saídas:''' lista de sindicatos. 
'''Pós-condições:''' nenhuma. 

===Fluxo principal de eventos===
1. Usuário clica no botão Sindicatos da barra de funções do sistema para acessar a Listagem de Sindicatos;
2. Sistema carrega da base de dados os sindicatos com seus respectivos dados (E1, E2, E3, E4);
3. É exibida a lista de sindicatos (com check boxes para seleção), cada um com seu número, nome e município. Os sindicatos serão ordenados por ordem alfabética e agrupados por município. Também haverá uma check box que permite a seleção de todos os sindicatos listados na tela e um limite de sindicatos a serem exibidos, sendo os demais acessados por uma barra de próximo/anterior (semelhante a um esquema de web mail);
4. Através de uma caixa de seleção (combo box), o usuário pode filtrar os sindicatos que serão exibidos na tela de acordo com a opção: “nome/município”. A opção “nome” é a padrão.

Fluxos de exceção
• E1: se não houver conexão com a internet, uma mensagem será exibida informando que não é possível estabelecer uma conexão com a internet e solicitando ao usuário que verifique sua conexão;
• E2: se o sistema não estiver disponível, uma mensagem será exibida informando que o serviço não está disponível e que o usuário deve tentar acessá-lo mais tarde;
• E3: se o resultado da busca retornar vazio, uma mensagem será exibida informando ao usuário que não existem dados referentes à consulta realizada;
• E4: se o sistema não conseguir acessar a base de dados, uma mensagem será exibida informando ao usuário que a base de dados está inacessível.

[RF009] Baixar Boleto
Atores relacionados
Funcionário FETAPE.

Objetivo
Baixa nos boletos que foram impressos. Eles passarão a ter o status de pago.

Prioridade
Essencial.

Entradas e pré condições
Entradas: lista de boletos para baixa.
Pré-condições: usuário logado no sistema; os registros dos boletos devem estar armazenados no banco de dados.

Saídas e pós-condições
Saídas: mensagem de aviso de sucesso da operação.
Pós-condições: registro dos boletos marcados no banco como “pagos”.

Fluxo principal de eventos
1. Usuário seleciona na Lista de boletos aqueles que deseja baixar (check box) e clica no botão Baixar (E1, E2, E3, E4, E5);
2. Sistema marca no banco os boletos como pagos (E6). Se o boleto não for encontrado na tabela de boletos, deverá ser procurado na tabela de boletos avulsos (E7);
3. Sistema insere no log de boletos os registros com o status impresso com a justificativa “baixado pela função de baixar de boletos pelo usuário X:Y”, onde X corresponde ao código do usuário e Y ao seu nome;
4. Sistema exibe uma mensagem de “Boletos baixados com sucesso”.

Fluxos de exceção
• E1: se não houver conexão com a internet, uma mensagem será exibida informando que não é possível estabelecer uma conexão com a internet e solicitando ao usuário que verifique sua conexão;
• E2: se o sistema não estiver disponível, uma mensagem será exibida informando que o serviço não está disponível e que o usuário deve tentar acessá-lo mais tarde;
• E3: se o usuário não selecionar boletos, o sistema exibe uma mensagem solicitando ao usuário que selecione boletos para impressão;
• E4: se na lista houver boletos com o status “pago”, o sistema exibe uma mensagem informando que boletos selecionados já foram baixados. Se o usuário clicar em continuar, o sistema continua a execução e ignora esses boletos;
• E5: se na lista houver boletos com o status diferente de “impresso” ou “enviado” (enviado para o banco), o sistema exibe uma mensagem informando que há boletos selecionados que ainda não foram impressos ou enviados para o banco e quais são estes boletos. Se o usuário clicar em continuar, o sistema continua a execução e ignora esses boletos;
• E6: se houver um erro na alteração dos registros no banco de dados, uma mensagem será exibida informando que não foi possível marcar os boletos como pagos e solicitando ao usuário que tente novamente e que, caso o erro persista, entre em contato com a BISA. O sistema deve ainda efetuar todas as rotinas de rollback de modo a não deixar ‘lixo’ no banco de dados;
• E7: se o registro do boleto não for encontrado no banco, o sistema exibirá uma mensagem de erro indicando que o boleto não foi encontrado na base de dados do sistema.

[RF010] Baixar Boleto Automaticamente (via Arquivo de Retorno do Banco)
Atores relacionados
Funcionário FETAPE.

Objetivo
Baixar de boletos a partir de um arquivo de retorno que o banco envia.

Prioridade
Essencial.

Entradas e pré condições
Entradas: arquivo de retorno do banco.
Pré-condições: usuário logado no sistema; os registros dos boletos devem estar armazenados no banco de dados.

Saídas e pós-condições
Saídas: mensagem de sucesso da operação.
Pós-condições: registro dos boletos marcados no banco como “pagos”.

Fluxo principal de eventos
1. Na tela da Lista de boletos, usuário clica na opção Baixa com Arquivo do Banco (E1, E2);
2. Uma tela é aberta perguntando qual o arquivo de retorno do banco. O usuário então seleciona o caminho no seu computador correspondente à localização do arquivo e clica em OK. O sistema irá, então, fazer o upload do arquivo (E3, E4, E5);
3. Sistema guarda a identificação do arquivo de retorno com situação de ‘não processado’ na base de dados e guarda uma cópia do arquivo em diretório especifico para histórico;
4. Para cada linha do arquivo de retorno, o sistema procura o boleto referente na base de dados de boletos de contribuição. Se o boleto não for encontrado, o sistema procura na base de dados de boletos avulsos. Nesta base, há registros de boletos com intervalos (ex. de 001 a 100). O sistema irá buscar o número do boleto nessa faixa (E6);
5. O sistema verifica se o boleto encontrado está marcado como “impresso” ou “enviado” (para o banco). Se estiver, o sistema marca no banco de dados o boleto como “pago” (E7);
6. O sistema insere no log de boletos o registro com situação de “pago” com a justificativa ‘baixado pela função de baixa automática de boleto pelo usuário X:Y’, onde X corresponde ao login de usuário e Y corresponde ao seu nome;
7. O Sistema marca o arquivo de retorno como ‘processado sem erros’ e uma exibe mensagem confirmando o sucesso na baixa dos boletos.

Fluxos de exceção
• E1: se não houver conexão com a internet, uma mensagem será exibida informando que não é possível estabelecer uma conexão com a internet e solicitando ao usuário que verifique sua conexão;
• E2: se o sistema não estiver disponível, uma mensagem será exibida informando que o serviço não está disponível e que o usuário deve tentar acessá-lo mais tarde;
• E3: se o usuário não apontar nenhum arquivo de retorno, uma mensagem será exibida exigindo que o usuário aponte o arquivo;
• E4: se o caminho para o arquivo estiver incorreto, o sistema exibe uma mensagem para o usuário informando que o caminho selecionado é inválido;
• E5: se o formato do arquivo não corresponder ao formato do arquivo de retorno do banco esperado, o sistema exibirá uma mensagem informando que o formato do arquivo selecionado é inválido;
• E6: se um registro do arquivo não for encontrado no sistema (base principal e base de boletos avulsos), será exibido numa tela todos os registros que não foram encontrados. A situação do arquivo de retorno no banco deve então mudar para “processado com erro” e o sistema deve inserir o registro de log de boleto com a justificativa “boleto não pode ser baixado, pois o mesmo não foi encontrado no sistema. Ação executada pelo usuário X:Y”, onde X é o login e Y é o nome. O valor do boleto pago e não encontrado deverá ser armazenado na tabela de boletos no registro cujo identificador é “BoletoXXXX”. Todo boleto que não for encontrado deverá ser somado ao valor desse registro;
• E7: se houver um erro na alteração dos registros no banco de dados, uma mensagem será exibida informando que não foi possível marcar os boletos como “pago” e solicitando ao usuário que tente novamente e que, caso o erro persista, entre em contato com a BISA. O sistema deve ainda efetuar todas as rotinas de rollback de modo a não deixar ‘lixo’ no banco de dados.

[RF011] Gerar arquivo de remessa para banco
Atores relacionados
Funcionário FETAPE.

Objetivo
Gerar arquivo de remessa de boletos para o banco.

Prioridade
Essencial.

Entradas e pré condições
Entradas: lista de boletos que serão enviados para o arquivo.
Pré-condições: usuário logado no sistema; os registros dos boletos devem estar armazenados no banco de dados com o status “gerado” ou “impresso”.

Saídas e pós-condições
Saídas: mensagem de sucesso da operação; arquivo de remessa para o banco.
Pós-condições: boletos marcados com o status “enviado” no banco na base de dados.

Fluxo principal de eventos
1. Na tela de Listagem de Boletos, o usuário seleciona os boletos e clica no botão Gerar de arquivo de remessa (E1, E2);
2. Sistema verifica se todos os boletos selecionados estão marcados como “gerado” ou “impresso” (E3);
3. Sistema abre tela para que o usuário informe o nome do arquivo e o local onde ele será gerado (E4, E5);
4. Usuário confirma a geração do arquivo;
5. Sistema gera o arquivo de remessa;
6. Sistema marca no banco os boletos que foram inseridos no arquivo de remessa com o status de “enviado” para o banco (E6);
7. Sistema insere no log de boletos os registros com situação de enviado com a justificativa “boleto gerado no arquivo de remessa para o banco pelo usuário X:Y”, onde X corresponde ao login do usuário e Y corresponde ao seu nome;
8. Sistema salva em diretório especifico no banco uma cópia do arquivo gerado para remessa para fins de histórico;
9. Sistema retorna o arquivo de remessa para que o usuário salve-o em seu computador.

Fluxos de exceção
• E1: se não houver conexão com a internet, uma mensagem será exibida informando que não é possível estabelecer uma conexão com a internet e solicitando ao usuário que verifique sua conexão;
• E2: se o sistema não estiver disponível, uma mensagem será exibida informando que o serviço não está disponível e que o usuário deve tentar acessá-lo mais tarde;
• E3: se o sistema não encontrar nenhum arquivo com o status “gerado” ou “impresso”, uma mensagem será exibida informando que não existem boletos a serem gerados para o arquivo de remessa. Se encontrar, deverá informar quais os boletos não serão gerados no arquivo;
• E4: se o usuário informa um local não existente, o sistema pergunta ao usuário se o mesmo deseja que o sistema crie o diretório de pastas informado. Se a resposta for sim, sistema cria diretório de pasta; se a resposta for não, sistema retorna a tela de informação do local para que o usuário selecione um novo diretório;
• E5: se houver um erro na geração do arquivo de remessa, uma mensagem será exibida informando ao usuário que o arquivo de remessa não pode ser gerado e que o mesmo tente novamente e que, caso o erro persista, entre em contato com a BISA.;
• E6: se houver um erro na alteração dos registros no banco de dados, uma mensagem será exibida informando que não foi possível marcar os boletos como “enviado” e solicitando ao usuário que tente novamente e que, caso o erro persista, entre em contato com a BISA. O sistema deve ainda efetuar todas as rotinas de rollback de modo a não deixar ‘lixo’ no banco de dados.

[RF012] Gerar arquivo de remessa para Gráfica
Atores relacionados
Funcionário FETAPE.

Objetivo
Gerar arquivo de remessa de boletos para Gráfica.

Prioridade
Essencial.

Entradas e pré condições
Entradas: lista de boletos que serão enviados para o arquivo.
Pré-condições: usuário logado no sistema; os registros dos boletos devem estar armazenados no banco de dados com o status “gerado”.

Saídas e pós-condições
Saídas: mensagem de sucesso da operação; arquivo de remessa para a gráfica (em formato txt e xls).
Pós-condições: boletos marcados com o status “enviadoGrafica” no banco na base de dados.

Fluxo principal de eventos
1. Na tela de Listagem de Boletos, o usuário seleciona os boletos e clica no botão Gerar arquivo de boleto para Gráfica (E1, E2);
2. Sistema verifica se todos os boletos selecionados estão marcados como “gerado” (E3);
3. Sistema abre tela para que o usuário informe o nome do arquivo e o local onde ele será gerado (E4, E5);
4. Usuário confirma a geração do arquivo;
5. Sistema pergunta se o usuário quer gerar o arquivo no formato txt ou xls;
6. Sistema gera o arquivo de remessa para Gráfica;
7. Sistema marca no banco os boletos que foram inseridos no arquivo de remessa com o status de “enviadoGrafica” para o banco (E6);
8. Sistema insere no log de boletos os registros com situação de enviado com a justificativa “boleto gerado no arquivo de remessa para Gráfica pelo usuário X:Y”, onde X corresponde ao login do usuário e Y corresponde ao seu nome;
9. Sistema salva em diretório especifico no banco uma cópia do arquivo gerado para remessa para Gráfica para fins de histórico;
10. Sistema retorna o arquivo para que o usuário salve-o em seu computador.

Fluxos de exceção
• E1: se não houver conexão com a internet, uma mensagem será exibida informando que não é possível estabelecer uma conexão com a internet e solicitando ao usuário que verifique sua conexão;
• E2: se o sistema não estiver disponível, uma mensagem será exibida informando que o serviço não está disponível e que o usuário deve tentar acessá-lo mais tarde;
• E3: se o sistema não encontrar nenhum arquivo com o status “gerado”, uma mensagem será exibida informando que não existem boletos a serem gerados para o arquivo de remessa. Se encontrar, deverá informar quais os boletos não serão gerados no arquivo;
• E4: se o usuário informa um local não existente, o sistema pergunta ao usuário se o mesmo deseja que o sistema crie o diretório de pastas informado. Se a resposta for sim, sistema cria diretório de pasta; se a resposta for não, sistema retorna a tela de informação do local para que o usuário selecione um novo diretório;
• E5: se houver um erro na geração do arquivo de remessa, uma mensagem será exibida informando ao usuário que o arquivo de remessa não pode ser gerado e que o mesmo tente novamente e que, caso o erro persista, entre em contato com a BISA;
• E6: se houver um erro na alteração dos registros no banco de dados, uma mensagem será exibida informando que não foi possível marcar os boletos como “enviado” e solicitando ao usuário que tente novamente e que, caso o erro persista, entre em contato com a BISA. O sistema deve ainda efetuar todas as rotinas de rollback de modo a não deixar ‘lixo’ no banco de dados.

4 Especificações Suplementares
4.1 Objetivos
Este documento tem como finalidade especificar todos os requisitos não funcionais do módulo de boletos web divididos em requisitos de usabilidade, confiabilidade, desempenho, segurança, distribuição, adequação a padrões e requisitos de hardware e software.
4.2 Usabilidade
Esta seção descreve os requisitos não funcionais associados à facilidade de uso da interface com o usuário, material de treinamento e documentação do sistema.
[NF001] Interface com o Usuário
Prioridade: Desejável
O sistema deve possuir uma interface amigável, simples e intuitiva.
4.3 Confiabilidade
Esta seção descreve os requisitos não funcionais associados à freqüência, severidade de falhas do sistema e habilidade de recuperação das mesmas, bem como a corretude do sistema.
[NF001] Tempo de Retorno após Falha
Prioridade: Desejável
Retorno de até 5 segundos após alguma falha.
[NF002] Disponibilidade
Prioridade: Importante
O sistema estará disponível 24 horas por dia durante todos os dias do ano.
4.4 Desempenho
Esta seção descreve os requisitos não funcionais associados à eficiência, uso de recursos e tempo de resposta do sistema.
[NF001] Número de Acessos
O sistema deve ser capaz de atender em média 10 usuários por segundo nos momentos de pico de acesso.
[NF002] Tempo de Resposta para os Usuários
O tempo máximo de resposta de uma requisição deve ser de no máximo 10 segundos.

4.5 Segurança
Esta seção descreve os requisitos não funcionais associados à integridade, privacidade e autenticidade dos dados do sistema.
[NF001] Privacidade de Acesso
Apenas os usuários credenciados e com permissão para acesso a este módulo deverão fazer uso das funcionalidades do módulo de boletos/guias na Web.
4.6 Hardware e software
Esta seção descreve os requisitos não funcionais associados ao hardware e software usados para desenvolver ou para executar o sistema.
[NF001] Linguagem de Implementação
Prioridade: Essencial
A linguagem de implementação do módulo de boleto Web será Delphi, mesma linguagem utilizada no desenvolvimento dos sistemas Partidos2000, Receb2000, OAB2000 e Filiados2000.
[NF002] Banco de Dados
Prioridade: Essencial
O banco de dados utilizado será o MySQL.
[NF003] Ferramentas
Prioridade: Essencial
Ferramenta de modelagem: Borland Delphi 2006
Ferramenta de Desenvolvimento: Borland Delphi 2006
[NF004] Plataforma de Funcionamento
Prioridade: Essencial
A plataforma tanto de desenvolvimento e de funcionamento será Windows.

Para uso do Bw- Construindo

2013-01-22T13:42:55Z

AnaPaula: /* Entradas e pré condições */

[[Arquivo:BoletosWeb.PNG]] 

[[Arquivo:Historico_de_revisoes.PNG]] 

=1. Caso de Negócio=
==1.1 Objetivos==

Documentar o novo módulo de geração e impressão de boletos online. As informações aqui descritas especificam e refinam a regras de negócio.

==1.2 Referências==

Se baseará no conhecimento adquirido na implementação de rotinas de boletos da BISA (desktop) e no antigo sistema TRAB_RUR da BISA, em DOS. A entrevista com Mário e Márcio da FETAPE (realizada por Ronaldo e Alexandre) também é referência para a definição dos requisitos.

==1.3 Sistemas com rotinas de gerenciamento de boletos da BISA==

O Filiados 2000 é um sistema desktop de gestão de filiados que controla o cadastro de filiados dos sindicatos de trabalhadores, fazendo acompanhamento de participação na organização.

O OAB 2000 é um software de gestão de cadastro de advogados para OAB's. Faz desde o cadastro de alunos, pré-inscritos, coordena sociedades de advogados, estagiários, até a administração dos dados financeiros dos advogados.

O Receb 2000 é um software voltado para o acompanhamento do contas a receber de uma empresa, fazendo a gestão financeira da carteira de forma simples e eficiente.

Todos esses sistemas possuem uma função de gerenciamento de boletos bancários ou guias sindicais, sendo salvos de forma centralizada no MySQL, de forma que podem ser acessados de forma uniforme no BoletoWEB.

Cada sistema contém suas próprias regras de negócio para gerenciar os boletos; no entanto, as funções de acesso ao banco remoto serão padronizadas para todos os sistemas no BoletoWEB.

==1.4 Descrição do Produto==

A maior parte da implementação é voltada para a FETAPE, enquanto o restante imprime boletos gerados pelos nossos sistema desktop.

Módulo Geral: este módulo tem a função meramente de fornecer uma interface web que permita ao usuário imprimir boletos gerados pelos sistemas desktop da BISA. 

'''Módulo FETAPE:''' no antigo sistema TRAB_RUR da BISA, este sistema é o foco principal desta documentação. Nela o usuário poderá gerenciar todo o fluxo de boletos de contribuições: geração, impressão interna, cadastro de filiados, acesso on-line dos filiados, etc.

==1.5 Contexto de Negócio==

O módulo geral de boletos na web será utilizado a princípio pelos sistemas Receb2000, OAB2000 e Filiados2000, porém poderá ser extendido a qualquer sistema que queira fazer o controle de boletos/guias.

Este módulo concentrará as informações dos boletos em um único local independente de entidade ou sistema. Este local, a priori, ficou definido como sendo um dos servidores internos da BISA que possua acesso externo. Cada sistema rodará normalmente no ambiente do cliente. No momento que for necessário o acesso às informações, este será feito não mais na base local da área do cliente, mas na base remota situada na BISA.

O módulo FETAPE segue as mesmas diretrizes, tendo a diferença de ser implementado exclusivamente para esta entidade, devendo ser adaptável para outras entidades. Para tanto, aconselha-se o uso de uma arquitetura em camadas e padrões de projetos, facilitadores do processos de manutenção.

==1.6 Tecnologias utilizadas==

Os módulos geral e FETAPE deverão implementados utilizando uma tecnologia para web: PHP, Java ou .NET.

O banco de dados necessariamente deverá ser o MySQL, pois já é utilizado na bisa para o registro de boletos.

=2. Sobre os Requisitos=
==2.1 Introdução==

Este documento especifica todos os requisitos funcionais e não funcionais do módulo de gerenciamento de boletos, descrevendo os fluxos de eventos, prioridades, atores, entradas e saídas de cada caso de uso a ser implementado.

A correta interpretação deste documento exige o conhecimento de algumas convenções e termos específicos, que são descritos a seguir.

==2.2 Identificação dos Requisitos==

Por convenção, a referência a requisitos é feita através do nome da subseção onde eles estão descritos, seguidos do identificador do requisito, de acordo com o esquema abaixo:

[nome da subseção, identificador do requisito]

Por exemplo, o requisito funcional [Imprimir Boleto RF002] está descrito em um caso de uso chamado “Imprimir Boleto”, em um bloco identificado pelo identificador [RF002].

==2.3 Prioridades dos Requisitos==

Para estabelecer a prioridade dos requisitos foram adotadas as denominações “essencial”, “importante” e “desejável”. 
• Essencial é o requisito sem o qual o sistema não entra em funcionamento. São requisitos imprescindíveis, que têm que ser implementados. 
• Importante é o requisito sem o qual o sistema entra em funcionamento, mas de forma não satisfatória. Requisitos importantes devem ser implementados, mas, se não forem, o sistema poderá ser implantado e usado mesmo assim. 
• Desejável é o requisito que não compromete as funcionalidades básicas do sistema, isto é, o sistema pode funcionar de forma satisfatória sem ele. Requisitos desejáveis são requisitos que podem ser deixados para versões posteriores do sistema, caso não haja tempo hábil para implementá-los na versão que está sendo especificada. 

==2.4 Descrição dos Atores==

'''Usuário externo'''
É a pessoa que acessa a funcionalidade de impressão de boletos do módulo geral pelo browser.

Filiado FETAPE
Semelhante ao usuário comum, com a diferença de que terá a opção de se cadastrar pelo site.

Funcionário FETAPE
É responsável pelo gerenciamento dos boletos. É o ator principal deste sistema.

=3 Requisitos Funcionais (Casos de Uso)=
==3.1 Ações do Usuário==

==[RF001] Efetuar login==
Atores relacionados
Usuário externo, Filiado FETAPE e Funcionário FETAPE.

===Objetivo===
Fazer login no módulo Web de impressão de boletos.

===Prioridade===
Essencial.

===Entradas e pré condições===
'''Entradas:''' login do usuário e senha;
'''Pré-condições:''' computador deve ter acesso à internet; servidor web disponível.

===Saídas e pós-condições===
'''Saídas:''' não há
'''Pós-condições:''' usuário logado no sistema.

===Fluxo principal de eventos===
1. Usuário executa seu web browser e acessa a página de login (E1, E2); 
2. Usuário informa login e senha e clica em Entrar (E3); 
3. Sistema recupera na base de dados a senha do usuário com o login informado; 
4. Sistema verifica se o login está cadastrado (E4); 
5. Sistema verifica se a senha informada corresponde ao login informado (E5); 
6. Sistema libera o acesso após o sucesso da verificação; 
7. Includes [RF002]. 

===Fluxos de exceção===
• E1: se não houver conexão com a internet, uma mensagem será exibida informando que não é possível estabelecer uma conexão com a internet e solicitando ao usuário que verifique sua conexão; 
• E2: se o sistema não estiver disponível, uma mensagem será exibida informando que o serviço não está disponível e que o usuário deve tentar acessá-lo mais tarde; 
• E3: se o usuário não informar o login ou a senha, o sistema solicita que informe o login e a senha; 
• E4: se o login não estiver cadastrado, o sistema emite uma mensagem de erro informando que este usuário não está cadastrado e solicitando que o mesmo verifique se o login foi digitado corretamente; 
• E5: se a senha não conferir com a que está armazenada na base de dados, o sistema emite uma mensagem de erro avisando que a senha informada está incorreta e solicitando que o mesmo verifique se ela foi digitada corretamente. 

==[RF002] Listar boletos==
===Atores relacionados===
Usuário externo, Filiado FETAPE e Funcionário FETAPE.

===Objetivo===
Listar os boletos correspondentes ao usuário logado.

===Prioridade===
Essencial.

===Entradas e pré condições===
'''Entradas:''' nenhuma.
'''Pré-condições:''' usuário logado no sistema; boletos armazenados no banco de dados.

===Saídas e pós-condições===
'''Saídas:''' lista de boletos.
'''Pós-condições:''' nenhuma.

===Fluxo principal de eventos===
1. Sistema carrega da base de dados os boletos referentes ao usuário (E1, E2, E3); 
2. É exibida a lista de boletos (com check boxes para seleção), cada um com seu número, descrição, valor, vencimento e status (pendente/atrasado/impresso/pago). Os boletos serão ordenados de forma decrescente (maior para o menor) por data de vencimento na lista. Também haverá uma check box que permite a seleção de todos os boletos listados na tela e um limite de boletos a serem exibidos, sendo os demais boletos acessados por uma barra de próximo/anterior (semelhante a um esquema de web mail); 
3. Através de uma caixa de seleção (combo box), o usuário pode filtrar os boletos que serão exibidos na tela de acordo com a opção: “pendentes/impressos/pagos/todos”. Os boletos com status “atrasado” ficarão na lista de “pendentes” e “todos”, mas com uma cor de linha de grid que os diferencie dos demais (ex. vermelho). O status inicial do filtro é “pendentes”. 

===Fluxos de exceção===
• E1: se não houver conexão com a internet, uma mensagem será exibida informando que não é possível estabelecer uma conexão com a internet e solicitando ao usuário que verifique sua conexão; 
• E2: se o sistema não estiver disponível, uma mensagem será exibida informando que o serviço não está disponível e que o usuário deve tentar acessá-lo mais tarde; 
• E3: se o resultado da busca retornar vazio, uma mensagem será exibida informando ao usuário que não existe dados referentes à consulta realizada. 

=[RF003] Geração de boletos=
===Atores relacionados===
Usuário externo, Filiado FETAPE e Funcionário FETAPE.

===Objetivo===
Gerar registros de boletos no banco de dados para impressão. Não constitui a impressão do boleto em si.

===Prioridade===
Essencial.

===Entradas e pré condições===
'''Entradas:''' filiado(s)/usuário(s), banco, data de vencimento, modelo da guia, nosso número inicial, valor e instruções.
'''Pré-condições:''' usuário logado no sistema; sindicatos e filiados armazenados no banco de dados.

===Saídas e pós-condições===
'''Saídas:''' mensagem de aviso de sucesso da operação. 
'''Pós-condições:''' registro dos boletos inseridos no banco de dados.

===Fluxo principal de eventos===
1. Usuário Externo e Filiado FETAPE: usuário clica no botão Gerar Boletos. Se o usuário estiver com o status óbito, não será gerado boleto. Funcionário FETAPE: funcionário seleciona uma quantidade de filiados na tela de Listagem de Filiados e clica no botão Gerar Boletos. Os filiados com o status “óbito” nunca serão carregados; 
2. Sistema carrega o(s) usuários(s)/filiado(s) selecionados com seus respectivos dados (E1, E2, E3, E4); 
3. Uma janela é aberta perguntando se o usuário deseja imprimir boletos referentes a Contribuição Sindical e Contribuição Confederativa (2 check boxes); 
4. Uma tela é aberta onde o usuário informa os dados (banco, data de vencimento, modelo da guia, nosso número inicial, valor e instruções) para os boletos. Usuário confirma a operação; 
5. Sistema valida os dados inseridos pelo usuário e os dados obrigatórios para emissão de boleto (E5, E6); 
6. Sistema gera os boletos e os armazena no banco de dados com o status “gerado” (E7). O sistema deverá verificar se o número de boleto que ele irá gerar existe em algum intervalo na tabela de boletos avulso. Se existir, ele deverá gerar um próximo número que não esteja em um intervalo desta tabela; 
7. Sistema insere os registros de log da situação dos boletos no banco remoto com a justificava “gerado a partir da função de geração de boleto pelo usuário X:Y”, onde X corresponde ao login do funcionário e Y corresponde ao seu nome; 
8. Sistema exibe mensagem confirmando o sucesso na geração dos boletos e perguntando se o usuário deseja fazer a impressão dos mesmos; 
9. Se o usuário responder que sim, a janela de impressão padrão da funcionalidade imprimir é aberta. Includes [RF004]. 

===Filiado FETAPE===
Este usuário também terá acesso à rotina de CANCELAMENTO do boleto, que consiste meramente na exclusão do mesmo da base de dados. Vale salientar que devem ser efetuados os devidos registros no log do sistema seguindo o padrão supracitado, assim como devem ser atendidos os seguintes fluxos de exceção: 
1. Se o boleto possuir o status “pago”, “impresso” ou “enviado” (para o banco), o cancelamento não será permitido. O sistema exibirá uma mensagem de erro avisando que o boleto não pode ser impresso, indicando o seu status atual; 
2. Se o boleto requisitado não puder ser excluído, o sistema exibe uma mensagem de erro solicitando que o boleto não poder ser removido no momento. 

===Fluxos de exceção===
• E1: se não houver conexão com a internet, uma mensagem será exibida informando que não é possível estabelecer uma conexão com a internet e solicitando ao usuário que verifique sua conexão; 
• E2: se o sistema não estiver disponível, uma mensagem será exibida informando que o serviço não está disponível e que o usuário deve tentar acessá-lo mais tarde; 
• E3: se o resultado da busca retornar vazio, uma mensagem será exibida informando ao usuário que não existem dados referentes à consulta realizada; 
• E4: se o sistema não conseguir acessar a base de dados, uma mensagem será exibida informando ao usuário que a base de dados está inacessível; 
• E5: se o usuário não preencher os dados obrigatórios do boleto (banco, data de vencimento, modelo da guia, nosso número inicial e valor), uma mensagem será exibida informando ao usuário que os campos obrigatórios devem ser preenchidos; 
• E6: se os dados obrigatórios do(s) usuário(s)/filiado(s) para emissão de boleto não foram preenchidos (nome, logradouro, bairro, cidade, estado e CEP), o sistema lista na tela os usuário(s)/filiado(s) cujos dados obrigatórios não estão preenchidos e, para cada um, informa quais campos devem ser preenchidos. O usuário poderá prosseguir para a tela de marcação dos boletos que serão impressos (botão “prosseguir”), no entanto os boletos cujos dados não estão completos não aparecerão para seleção; 
• E7: se houver um estouro na numeração de boletos*, o sistema exibe uma mensagem solicitando ao usuário que entre em contato com a BISA pois houve um problema na geração da numeração do boleto. A operação não é finalizada. O sistema deve ainda efetuar todas as rotinas de rollback de modo a não deixar ‘lixo’ no banco de dados. 

<nowiki>*</nowiki> O estouro na numeração de boletos ocorre quando o limite do número de boletos cadastrado no banco de dados é atingido. Por exemplo, supondo um limite de 10 bytes, se o último registro cadastrado for 9999999999, o próximo registro de boleto irá acionar este erro. 

=[RF004] Imprimir boletos=
===Atores relacionados===
Usuário externo, Filiado FETAPE e Funcionário FETAPE.

===Objetivo===
Constitui a impressão de um boleto já gerado no sistema.

===Prioridade===
Essencial.

===Entradas e pré condições===
'''Entradas:''' lista de boletos para impressão. 
'''Pré-condições:''' o usuário deve estar logado no sistema na tela da listagem de boletos (RF002); os registros dos boletos devem estar armazenados no banco de dados e marcados como “não impresso”.

===Saídas e pós-condições===
'''Saídas:''' impressão dos boletos selecionados. 
'''Pós-Condições:''' registros dos boletos marcados no banco como “impresso”.

===Fluxo principal de eventos===
1. Usuário seleciona na Lista de boletos aqueles que deseja imprimir (check box) e clica no botão Imprimir (E1, E2, E3, E4, E5); 
2. Se o usuário houver selecionado apenas um boleto, o sistema imprime o boleto no navegador, permitindo ao usuário conferir seus dados. Depois disso, ele clica em um novo botão Imprimir e passa para o passo 3; 
3. Janela de impressão padrão é aberta (onde o usuário poderá selecionar impressora, quantidade de páginas, etc). Usuário confirma a impressão e o sistema envia os arquivos para a impressora (E6); 
4. Sistema marca no banco os boletos que foram impressos com o status “impresso” (E7); 
5. Sistema insere no log de boletos os registros com o status impresso com a justificativa “impresso pela função de impressão de boletos pelo usuário X:Y”, onde X corresponde ao código do usuário e Y ao seu nome. 
6. Sistema exibe uma mensagem de “Boletos impressos com sucesso”. 

===Fluxos de exceção===
• E1: se não houver conexão com a internet, uma mensagem será exibida informando que não é possível estabelecer uma conexão com a internet e solicitando ao usuário que verifique sua conexão; 
• E2: se o sistema não estiver disponível, uma mensagem será exibida informando que o serviço não está disponível e que o usuário deve tentar acessá-lo mais tarde; 
• E3: se o usuário não selecionar boletos, o sistema exibe uma mensagem solicitando ao usuário que selecione boletos para impressão; 
• E4: se na lista houver boletos que já foram pagos, o sistema exibe uma mensagem de erro informando que boletos pagos não podem ser reimpressos e cancela a operação; 
• E5: se houver boletos que já foram impressos, o sistema exibe um alerta informando que os boletos já foram impressos pelo sistema e serão reimpressos nesta operação; continua a executar normalmente; 
• E6: se houver um erro ao enviar os dados para a impressora, o sistema exibe uma mensagem avisando ao usuário que o sistema não conseguiu imprimir e solicitando que o mesmo verifique se a impressora está pronta para impressão; 
• E7: se houver um erro na alteração dos registros no banco de dados, uma mensagem será exibida informando que não foi possível marcar os boletos como impressos e solicitando ao usuário que tente novamente e que, caso o erro persista, entre em contato com a BISA. O sistema deve ainda efetuar todas as rotinas de rollback de modo a não deixar ‘lixo’ no banco de dados. 

=[RF005] Cadastro de filiado=
===Atores relacionados===
Filiado FETAPE e Funcionário FETAPE.

===Objetivo===
Cadastrar um filiado. As rotinas de ALTERAÇÃO e de EXCLUSÃO também estão contidas neste requisito para o Funcionário FETAPE.

===Prioridade===
Essencial.

===Entradas e pré condições===
'''Entradas:''' dados cadastrais do usuário. 
'''Pré-condições:''' computador deve ter acesso à internet; servidor web disponível. Funcionário: usuário cadastrado no sistema. 

===Saídas e pós-condições===
'''Saídas:''' mensagem avisando que o usuário foi cadastrado com sucesso.
'''Pós-Condições:''' usuário cadastrado no banco de dados.

===Fluxo principal de eventos===
1. Ator Filiado: a função “Cadastrar Filiado” é acionada pelo usuário no navegador web (E1, E2). Ator Funcionário: a função “Cadastrar Filiado” é acionada pelo usuário na tela de Listagem de Filiados (E1, E2). 
2. Um formulário é aberto solicitando dados cadastrais: login, senha, nome, CPF, CNAE, bairro, cidade, UF, logradouro, CEP, categoria (seleção entre as opções arrendatário, assentado, meeiro, parceiro, posseiro, pequeno proprietário e outros) e apelido do filiado; 
3. Usuário preenche os campos e confirma a operação (E3, E4, E5, E6); 
4. Sistema insere os registros de log da situação no banco remoto com a justificava “cadastrado pelo usuário X:Y”, onde X corresponde ao login do usuário e Y corresponde ao seu nome; 
5. Sistema retorna uma mensagem avisando que o usuário foi cadastrado com sucesso. 

O sistema também apresenta as rotinas de ALTERAÇÃO, que por ser trivial e seguir um fluxo semelhante à rotina de inclusão não terá sua execução descrita aqui. Vale salientar que devem ser efetuados os devidos registros no log do sistema. 

===Filiado FETAPE===
Ele possui também a funcionalidade EXCLUSÃO. Sua tela de ALTERAR é diferente. Nela, o usuário pode marcar um check box “óbito” para filiados que foram a óbito.

===Fluxos de exceção===
• E1: se não houver conexão com a internet, uma mensagem será exibida informando que não é possível estabelecer uma conexão com a internet e solicitando ao usuário que verifique sua conexão; 
• E2: se o sistema não estiver disponível, uma mensagem será exibida informando que o serviço não está disponível e que o usuário deve tentar acessá-lo mais tarde; 
• E3: se o login fornecido já estiver cadastrado no sistema, uma mensagem será exibida informando ao usuário que o login cadastrado já existe no sistema; 
• E4: se o CPF do filiado for inválido, uma mensagem será exibida informando ao usuário que o CPF cadastrado é inválido. Vale salientar que o preenchimento deste campo é opcional; 
• E5: se houver um erro na inserção dos registros no banco de dados, uma mensagem será exibida informando que não foi possível inserir os dados e solicitando ao usuário que tente novamente e que, caso o erro persista, entre em contato com a BISA. O sistema deve ainda efetuar todas as rotinas de rollback de modo a não deixar ‘lixo’ no banco de dados; 
• E6: se os dados obrigatórios dos filiados não forem preenchidos (nome, logradouro, bairro, cidade, estado e CEP), o sistema emite uma mensagem de erro informando quais os campos obrigatórios não foram preenchidos. 

=[RF006] Listar filiados=
Atores relacionados
Funcionário FETAPE.

Objetivo
Listar todos os filiados cadastrados no sistema.

Prioridade
Essencial.

Entradas e pré condições
Entradas: nenhuma.
Pré-condições: usuário logado no sistema; filiados armazenados no banco de dados.

Saídas e pós-condições
Saídas: lista de filiados.
Pós-condições: nenhuma.

Fluxo principal de eventos
1. Usuário clica no botão Filiados da barra de funções do sistema para acessar a Listagem de Filiados;
2. Sistema carrega da base de dados os filiados com seus respectivos dados (E1, E2, E3, E4);
3. É exibida a lista de filiados (com check boxes para seleção), cada um com seu número, nome, apelido, CPF, município, sindicato e categoria. Os filiados serão ordenados por ordem alfabética e agrupados por município. Também haverá uma check box que permite a seleção de todos os filiados listados na tela e um limite de filiados a serem exibidos, sendo os demais acessados por uma barra de próximo/anterior (semelhante a um esquema de web mail);
4. Através de uma caixa de seleção (combo box), o usuário pode filtrar os filiados que serão exibidos na tela de acordo com a opção: “nome/apelido/município/sindicato”. A opção “nome” é a padrão. Os filiados que foram a óbito serão exibidos com uma cor de linha de grid acinzentada e só serão exibidos se um check box “todos” for ativado.

Fluxos de exceção
• E1: se não houver conexão com a internet, uma mensagem será exibida informando que não é possível estabelecer uma conexão com a internet e solicitando ao usuário que verifique sua conexão;
• E2: se o sistema não estiver disponível, uma mensagem será exibida informando que o serviço não está disponível e que o usuário deve tentar acessá-lo mais tarde;
• E3: se o resultado da busca retornar vazio, uma mensagem será exibida informando ao usuário que não existem dados referentes à consulta realizada;
• E4: se o sistema não conseguir acessar a base de dados, uma mensagem será exibida informando ao usuário que a base de dados está inacessível.

[RF007] Cadastro de sindicato
Atores relacionados
Funcionário FETAPE.

Objetivo
Cadastrar um sindicato. As rotinas de ALTERAÇÃO e de EXCLUSÃO também estão contidas neste requisito.

Prioridade
Essencial.

Entradas e pré condições
Entradas: dados do sindicato; dados do Município (já presentes na base de dados, herdada do antigo sistema DOS TRAB_RUR).
Pré-condições: usuário logado no sistema.

Saídas e pós-condições
Saídas: mensagem avisando que o sindicato foi cadastrado com sucesso.
Pós-Condições: sindicato cadastrado no banco de dados.

Fluxo principal de eventos
1. Usuário clica no botão cadastrar na tela de Listagem de Sindicatos (E1, E2);
2. Um formulário é aberto solicitando dados cadastrais: nome, município, UF, endereço;
3. Usuário preenche os campos e confirma a operação (E3);
4. Sistema insere os registros de log da situação no banco remoto com a justificava “cadastrado pelo usuário X:Y”, onde X corresponde ao login do funcionário e Y corresponde ao seu nome;
5. Sistema retorna uma mensagem avisando que o sindicato foi cadastrado com sucesso.

Também haverá rotinas de alteração e de exclusão. O processo é trivial para ser descrito aqui. Vale salientar que devem ser efetuados os devidos registros no log do sistema.

Fluxos de exceção
• E1: se não houver conexão com a internet, uma mensagem será exibida informando que não é possível estabelecer uma conexão com a internet e solicitando ao usuário que verifique sua conexão;
• E2: se o sistema não estiver disponível, uma mensagem será exibida informando que o serviço não está disponível e que o usuário deve tentar acessá-lo mais tarde;
• E3: se houver um erro na inserção dos registros no banco de dados, uma mensagem será exibida informando que não foi possível inserir os dados e solicitando ao usuário que tente novamente e que, caso o erro persista, entre em contato com a BISA. O sistema deve ainda efetuar todas as rotinas de rollback de modo a não deixar ‘lixo’ no banco de dados;

[RF008] Listar sindicatos
Atores relacionados
Funcionário FETAPE.

Objetivo
Listar todos os sindicatos cadastrados no sistema.

Prioridade
Essencial.

Entradas e pré condições
Entradas: nenhuma.
Pré-condições: usuário logado no sistema; sindicatos armazenados no banco de dados.

Saídas e pós-condições
Saídas: lista de sindicatos.
Pós-condições: nenhuma.

Fluxo principal de eventos
1. Usuário clica no botão Sindicatos da barra de funções do sistema para acessar a Listagem de Sindicatos;
2. Sistema carrega da base de dados os sindicatos com seus respectivos dados (E1, E2, E3, E4);
3. É exibida a lista de sindicatos (com check boxes para seleção), cada um com seu número, nome e município. Os sindicatos serão ordenados por ordem alfabética e agrupados por município. Também haverá uma check box que permite a seleção de todos os sindicatos listados na tela e um limite de sindicatos a serem exibidos, sendo os demais acessados por uma barra de próximo/anterior (semelhante a um esquema de web mail);
4. Através de uma caixa de seleção (combo box), o usuário pode filtrar os sindicatos que serão exibidos na tela de acordo com a opção: “nome/município”. A opção “nome” é a padrão.

Fluxos de exceção
• E1: se não houver conexão com a internet, uma mensagem será exibida informando que não é possível estabelecer uma conexão com a internet e solicitando ao usuário que verifique sua conexão;
• E2: se o sistema não estiver disponível, uma mensagem será exibida informando que o serviço não está disponível e que o usuário deve tentar acessá-lo mais tarde;
• E3: se o resultado da busca retornar vazio, uma mensagem será exibida informando ao usuário que não existem dados referentes à consulta realizada;
• E4: se o sistema não conseguir acessar a base de dados, uma mensagem será exibida informando ao usuário que a base de dados está inacessível.

[RF009] Baixar Boleto
Atores relacionados
Funcionário FETAPE.

Objetivo
Baixa nos boletos que foram impressos. Eles passarão a ter o status de pago.

Prioridade
Essencial.

Entradas e pré condições
Entradas: lista de boletos para baixa.
Pré-condições: usuário logado no sistema; os registros dos boletos devem estar armazenados no banco de dados.

Saídas e pós-condições
Saídas: mensagem de aviso de sucesso da operação.
Pós-condições: registro dos boletos marcados no banco como “pagos”.

Fluxo principal de eventos
1. Usuário seleciona na Lista de boletos aqueles que deseja baixar (check box) e clica no botão Baixar (E1, E2, E3, E4, E5);
2. Sistema marca no banco os boletos como pagos (E6). Se o boleto não for encontrado na tabela de boletos, deverá ser procurado na tabela de boletos avulsos (E7);
3. Sistema insere no log de boletos os registros com o status impresso com a justificativa “baixado pela função de baixar de boletos pelo usuário X:Y”, onde X corresponde ao código do usuário e Y ao seu nome;
4. Sistema exibe uma mensagem de “Boletos baixados com sucesso”.

Fluxos de exceção
• E1: se não houver conexão com a internet, uma mensagem será exibida informando que não é possível estabelecer uma conexão com a internet e solicitando ao usuário que verifique sua conexão;
• E2: se o sistema não estiver disponível, uma mensagem será exibida informando que o serviço não está disponível e que o usuário deve tentar acessá-lo mais tarde;
• E3: se o usuário não selecionar boletos, o sistema exibe uma mensagem solicitando ao usuário que selecione boletos para impressão;
• E4: se na lista houver boletos com o status “pago”, o sistema exibe uma mensagem informando que boletos selecionados já foram baixados. Se o usuário clicar em continuar, o sistema continua a execução e ignora esses boletos;
• E5: se na lista houver boletos com o status diferente de “impresso” ou “enviado” (enviado para o banco), o sistema exibe uma mensagem informando que há boletos selecionados que ainda não foram impressos ou enviados para o banco e quais são estes boletos. Se o usuário clicar em continuar, o sistema continua a execução e ignora esses boletos;
• E6: se houver um erro na alteração dos registros no banco de dados, uma mensagem será exibida informando que não foi possível marcar os boletos como pagos e solicitando ao usuário que tente novamente e que, caso o erro persista, entre em contato com a BISA. O sistema deve ainda efetuar todas as rotinas de rollback de modo a não deixar ‘lixo’ no banco de dados;
• E7: se o registro do boleto não for encontrado no banco, o sistema exibirá uma mensagem de erro indicando que o boleto não foi encontrado na base de dados do sistema.

[RF010] Baixar Boleto Automaticamente (via Arquivo de Retorno do Banco)
Atores relacionados
Funcionário FETAPE.

Objetivo
Baixar de boletos a partir de um arquivo de retorno que o banco envia.

Prioridade
Essencial.

Entradas e pré condições
Entradas: arquivo de retorno do banco.
Pré-condições: usuário logado no sistema; os registros dos boletos devem estar armazenados no banco de dados.

Saídas e pós-condições
Saídas: mensagem de sucesso da operação.
Pós-condições: registro dos boletos marcados no banco como “pagos”.

Fluxo principal de eventos
1. Na tela da Lista de boletos, usuário clica na opção Baixa com Arquivo do Banco (E1, E2);
2. Uma tela é aberta perguntando qual o arquivo de retorno do banco. O usuário então seleciona o caminho no seu computador correspondente à localização do arquivo e clica em OK. O sistema irá, então, fazer o upload do arquivo (E3, E4, E5);
3. Sistema guarda a identificação do arquivo de retorno com situação de ‘não processado’ na base de dados e guarda uma cópia do arquivo em diretório especifico para histórico;
4. Para cada linha do arquivo de retorno, o sistema procura o boleto referente na base de dados de boletos de contribuição. Se o boleto não for encontrado, o sistema procura na base de dados de boletos avulsos. Nesta base, há registros de boletos com intervalos (ex. de 001 a 100). O sistema irá buscar o número do boleto nessa faixa (E6);
5. O sistema verifica se o boleto encontrado está marcado como “impresso” ou “enviado” (para o banco). Se estiver, o sistema marca no banco de dados o boleto como “pago” (E7);
6. O sistema insere no log de boletos o registro com situação de “pago” com a justificativa ‘baixado pela função de baixa automática de boleto pelo usuário X:Y’, onde X corresponde ao login de usuário e Y corresponde ao seu nome;
7. O Sistema marca o arquivo de retorno como ‘processado sem erros’ e uma exibe mensagem confirmando o sucesso na baixa dos boletos.

Fluxos de exceção
• E1: se não houver conexão com a internet, uma mensagem será exibida informando que não é possível estabelecer uma conexão com a internet e solicitando ao usuário que verifique sua conexão;
• E2: se o sistema não estiver disponível, uma mensagem será exibida informando que o serviço não está disponível e que o usuário deve tentar acessá-lo mais tarde;
• E3: se o usuário não apontar nenhum arquivo de retorno, uma mensagem será exibida exigindo que o usuário aponte o arquivo;
• E4: se o caminho para o arquivo estiver incorreto, o sistema exibe uma mensagem para o usuário informando que o caminho selecionado é inválido;
• E5: se o formato do arquivo não corresponder ao formato do arquivo de retorno do banco esperado, o sistema exibirá uma mensagem informando que o formato do arquivo selecionado é inválido;
• E6: se um registro do arquivo não for encontrado no sistema (base principal e base de boletos avulsos), será exibido numa tela todos os registros que não foram encontrados. A situação do arquivo de retorno no banco deve então mudar para “processado com erro” e o sistema deve inserir o registro de log de boleto com a justificativa “boleto não pode ser baixado, pois o mesmo não foi encontrado no sistema. Ação executada pelo usuário X:Y”, onde X é o login e Y é o nome. O valor do boleto pago e não encontrado deverá ser armazenado na tabela de boletos no registro cujo identificador é “BoletoXXXX”. Todo boleto que não for encontrado deverá ser somado ao valor desse registro;
• E7: se houver um erro na alteração dos registros no banco de dados, uma mensagem será exibida informando que não foi possível marcar os boletos como “pago” e solicitando ao usuário que tente novamente e que, caso o erro persista, entre em contato com a BISA. O sistema deve ainda efetuar todas as rotinas de rollback de modo a não deixar ‘lixo’ no banco de dados.

[RF011] Gerar arquivo de remessa para banco
Atores relacionados
Funcionário FETAPE.

Objetivo
Gerar arquivo de remessa de boletos para o banco.

Prioridade
Essencial.

Entradas e pré condições
Entradas: lista de boletos que serão enviados para o arquivo.
Pré-condições: usuário logado no sistema; os registros dos boletos devem estar armazenados no banco de dados com o status “gerado” ou “impresso”.

Saídas e pós-condições
Saídas: mensagem de sucesso da operação; arquivo de remessa para o banco.
Pós-condições: boletos marcados com o status “enviado” no banco na base de dados.

Fluxo principal de eventos
1. Na tela de Listagem de Boletos, o usuário seleciona os boletos e clica no botão Gerar de arquivo de remessa (E1, E2);
2. Sistema verifica se todos os boletos selecionados estão marcados como “gerado” ou “impresso” (E3);
3. Sistema abre tela para que o usuário informe o nome do arquivo e o local onde ele será gerado (E4, E5);
4. Usuário confirma a geração do arquivo;
5. Sistema gera o arquivo de remessa;
6. Sistema marca no banco os boletos que foram inseridos no arquivo de remessa com o status de “enviado” para o banco (E6);
7. Sistema insere no log de boletos os registros com situação de enviado com a justificativa “boleto gerado no arquivo de remessa para o banco pelo usuário X:Y”, onde X corresponde ao login do usuário e Y corresponde ao seu nome;
8. Sistema salva em diretório especifico no banco uma cópia do arquivo gerado para remessa para fins de histórico;
9. Sistema retorna o arquivo de remessa para que o usuário salve-o em seu computador.

Fluxos de exceção
• E1: se não houver conexão com a internet, uma mensagem será exibida informando que não é possível estabelecer uma conexão com a internet e solicitando ao usuário que verifique sua conexão;
• E2: se o sistema não estiver disponível, uma mensagem será exibida informando que o serviço não está disponível e que o usuário deve tentar acessá-lo mais tarde;
• E3: se o sistema não encontrar nenhum arquivo com o status “gerado” ou “impresso”, uma mensagem será exibida informando que não existem boletos a serem gerados para o arquivo de remessa. Se encontrar, deverá informar quais os boletos não serão gerados no arquivo;
• E4: se o usuário informa um local não existente, o sistema pergunta ao usuário se o mesmo deseja que o sistema crie o diretório de pastas informado. Se a resposta for sim, sistema cria diretório de pasta; se a resposta for não, sistema retorna a tela de informação do local para que o usuário selecione um novo diretório;
• E5: se houver um erro na geração do arquivo de remessa, uma mensagem será exibida informando ao usuário que o arquivo de remessa não pode ser gerado e que o mesmo tente novamente e que, caso o erro persista, entre em contato com a BISA.;
• E6: se houver um erro na alteração dos registros no banco de dados, uma mensagem será exibida informando que não foi possível marcar os boletos como “enviado” e solicitando ao usuário que tente novamente e que, caso o erro persista, entre em contato com a BISA. O sistema deve ainda efetuar todas as rotinas de rollback de modo a não deixar ‘lixo’ no banco de dados.

[RF012] Gerar arquivo de remessa para Gráfica
Atores relacionados
Funcionário FETAPE.

Objetivo
Gerar arquivo de remessa de boletos para Gráfica.

Prioridade
Essencial.

Entradas e pré condições
Entradas: lista de boletos que serão enviados para o arquivo.
Pré-condições: usuário logado no sistema; os registros dos boletos devem estar armazenados no banco de dados com o status “gerado”.

Saídas e pós-condições
Saídas: mensagem de sucesso da operação; arquivo de remessa para a gráfica (em formato txt e xls).
Pós-condições: boletos marcados com o status “enviadoGrafica” no banco na base de dados.

Fluxo principal de eventos
1. Na tela de Listagem de Boletos, o usuário seleciona os boletos e clica no botão Gerar arquivo de boleto para Gráfica (E1, E2);
2. Sistema verifica se todos os boletos selecionados estão marcados como “gerado” (E3);
3. Sistema abre tela para que o usuário informe o nome do arquivo e o local onde ele será gerado (E4, E5);
4. Usuário confirma a geração do arquivo;
5. Sistema pergunta se o usuário quer gerar o arquivo no formato txt ou xls;
6. Sistema gera o arquivo de remessa para Gráfica;
7. Sistema marca no banco os boletos que foram inseridos no arquivo de remessa com o status de “enviadoGrafica” para o banco (E6);
8. Sistema insere no log de boletos os registros com situação de enviado com a justificativa “boleto gerado no arquivo de remessa para Gráfica pelo usuário X:Y”, onde X corresponde ao login do usuário e Y corresponde ao seu nome;
9. Sistema salva em diretório especifico no banco uma cópia do arquivo gerado para remessa para Gráfica para fins de histórico;
10. Sistema retorna o arquivo para que o usuário salve-o em seu computador.

Fluxos de exceção
• E1: se não houver conexão com a internet, uma mensagem será exibida informando que não é possível estabelecer uma conexão com a internet e solicitando ao usuário que verifique sua conexão;
• E2: se o sistema não estiver disponível, uma mensagem será exibida informando que o serviço não está disponível e que o usuário deve tentar acessá-lo mais tarde;
• E3: se o sistema não encontrar nenhum arquivo com o status “gerado”, uma mensagem será exibida informando que não existem boletos a serem gerados para o arquivo de remessa. Se encontrar, deverá informar quais os boletos não serão gerados no arquivo;
• E4: se o usuário informa um local não existente, o sistema pergunta ao usuário se o mesmo deseja que o sistema crie o diretório de pastas informado. Se a resposta for sim, sistema cria diretório de pasta; se a resposta for não, sistema retorna a tela de informação do local para que o usuário selecione um novo diretório;
• E5: se houver um erro na geração do arquivo de remessa, uma mensagem será exibida informando ao usuário que o arquivo de remessa não pode ser gerado e que o mesmo tente novamente e que, caso o erro persista, entre em contato com a BISA;
• E6: se houver um erro na alteração dos registros no banco de dados, uma mensagem será exibida informando que não foi possível marcar os boletos como “enviado” e solicitando ao usuário que tente novamente e que, caso o erro persista, entre em contato com a BISA. O sistema deve ainda efetuar todas as rotinas de rollback de modo a não deixar ‘lixo’ no banco de dados.

4 Especificações Suplementares
4.1 Objetivos
Este documento tem como finalidade especificar todos os requisitos não funcionais do módulo de boletos web divididos em requisitos de usabilidade, confiabilidade, desempenho, segurança, distribuição, adequação a padrões e requisitos de hardware e software.
4.2 Usabilidade
Esta seção descreve os requisitos não funcionais associados à facilidade de uso da interface com o usuário, material de treinamento e documentação do sistema.
[NF001] Interface com o Usuário
Prioridade: Desejável
O sistema deve possuir uma interface amigável, simples e intuitiva.
4.3 Confiabilidade
Esta seção descreve os requisitos não funcionais associados à freqüência, severidade de falhas do sistema e habilidade de recuperação das mesmas, bem como a corretude do sistema.
[NF001] Tempo de Retorno após Falha
Prioridade: Desejável
Retorno de até 5 segundos após alguma falha.
[NF002] Disponibilidade
Prioridade: Importante
O sistema estará disponível 24 horas por dia durante todos os dias do ano.
4.4 Desempenho
Esta seção descreve os requisitos não funcionais associados à eficiência, uso de recursos e tempo de resposta do sistema.
[NF001] Número de Acessos
O sistema deve ser capaz de atender em média 10 usuários por segundo nos momentos de pico de acesso.
[NF002] Tempo de Resposta para os Usuários
O tempo máximo de resposta de uma requisição deve ser de no máximo 10 segundos.

4.5 Segurança
Esta seção descreve os requisitos não funcionais associados à integridade, privacidade e autenticidade dos dados do sistema.
[NF001] Privacidade de Acesso
Apenas os usuários credenciados e com permissão para acesso a este módulo deverão fazer uso das funcionalidades do módulo de boletos/guias na Web.
4.6 Hardware e software
Esta seção descreve os requisitos não funcionais associados ao hardware e software usados para desenvolver ou para executar o sistema.
[NF001] Linguagem de Implementação
Prioridade: Essencial
A linguagem de implementação do módulo de boleto Web será Delphi, mesma linguagem utilizada no desenvolvimento dos sistemas Partidos2000, Receb2000, OAB2000 e Filiados2000.
[NF002] Banco de Dados
Prioridade: Essencial
O banco de dados utilizado será o MySQL.
[NF003] Ferramentas
Prioridade: Essencial
Ferramenta de modelagem: Borland Delphi 2006
Ferramenta de Desenvolvimento: Borland Delphi 2006
[NF004] Plataforma de Funcionamento
Prioridade: Essencial
A plataforma tanto de desenvolvimento e de funcionamento será Windows.

Para uso do Bw- Construindo

2013-01-22T13:42:17Z

AnaPaula: /* [RF005] Cadastro de filiado */

[[Arquivo:BoletosWeb.PNG]] 

[[Arquivo:Historico_de_revisoes.PNG]] 

=1. Caso de Negócio=
==1.1 Objetivos==

Documentar o novo módulo de geração e impressão de boletos online. As informações aqui descritas especificam e refinam a regras de negócio.

==1.2 Referências==

Se baseará no conhecimento adquirido na implementação de rotinas de boletos da BISA (desktop) e no antigo sistema TRAB_RUR da BISA, em DOS. A entrevista com Mário e Márcio da FETAPE (realizada por Ronaldo e Alexandre) também é referência para a definição dos requisitos.

==1.3 Sistemas com rotinas de gerenciamento de boletos da BISA==

O Filiados 2000 é um sistema desktop de gestão de filiados que controla o cadastro de filiados dos sindicatos de trabalhadores, fazendo acompanhamento de participação na organização.

O OAB 2000 é um software de gestão de cadastro de advogados para OAB's. Faz desde o cadastro de alunos, pré-inscritos, coordena sociedades de advogados, estagiários, até a administração dos dados financeiros dos advogados.

O Receb 2000 é um software voltado para o acompanhamento do contas a receber de uma empresa, fazendo a gestão financeira da carteira de forma simples e eficiente.

Todos esses sistemas possuem uma função de gerenciamento de boletos bancários ou guias sindicais, sendo salvos de forma centralizada no MySQL, de forma que podem ser acessados de forma uniforme no BoletoWEB.

Cada sistema contém suas próprias regras de negócio para gerenciar os boletos; no entanto, as funções de acesso ao banco remoto serão padronizadas para todos os sistemas no BoletoWEB.

==1.4 Descrição do Produto==

A maior parte da implementação é voltada para a FETAPE, enquanto o restante imprime boletos gerados pelos nossos sistema desktop.

Módulo Geral: este módulo tem a função meramente de fornecer uma interface web que permita ao usuário imprimir boletos gerados pelos sistemas desktop da BISA. 

'''Módulo FETAPE:''' no antigo sistema TRAB_RUR da BISA, este sistema é o foco principal desta documentação. Nela o usuário poderá gerenciar todo o fluxo de boletos de contribuições: geração, impressão interna, cadastro de filiados, acesso on-line dos filiados, etc.

==1.5 Contexto de Negócio==

O módulo geral de boletos na web será utilizado a princípio pelos sistemas Receb2000, OAB2000 e Filiados2000, porém poderá ser extendido a qualquer sistema que queira fazer o controle de boletos/guias.

Este módulo concentrará as informações dos boletos em um único local independente de entidade ou sistema. Este local, a priori, ficou definido como sendo um dos servidores internos da BISA que possua acesso externo. Cada sistema rodará normalmente no ambiente do cliente. No momento que for necessário o acesso às informações, este será feito não mais na base local da área do cliente, mas na base remota situada na BISA.

O módulo FETAPE segue as mesmas diretrizes, tendo a diferença de ser implementado exclusivamente para esta entidade, devendo ser adaptável para outras entidades. Para tanto, aconselha-se o uso de uma arquitetura em camadas e padrões de projetos, facilitadores do processos de manutenção.

==1.6 Tecnologias utilizadas==

Os módulos geral e FETAPE deverão implementados utilizando uma tecnologia para web: PHP, Java ou .NET.

O banco de dados necessariamente deverá ser o MySQL, pois já é utilizado na bisa para o registro de boletos.

=2. Sobre os Requisitos=
==2.1 Introdução==

Este documento especifica todos os requisitos funcionais e não funcionais do módulo de gerenciamento de boletos, descrevendo os fluxos de eventos, prioridades, atores, entradas e saídas de cada caso de uso a ser implementado.

A correta interpretação deste documento exige o conhecimento de algumas convenções e termos específicos, que são descritos a seguir.

==2.2 Identificação dos Requisitos==

Por convenção, a referência a requisitos é feita através do nome da subseção onde eles estão descritos, seguidos do identificador do requisito, de acordo com o esquema abaixo:

[nome da subseção, identificador do requisito]

Por exemplo, o requisito funcional [Imprimir Boleto RF002] está descrito em um caso de uso chamado “Imprimir Boleto”, em um bloco identificado pelo identificador [RF002].

==2.3 Prioridades dos Requisitos==

Para estabelecer a prioridade dos requisitos foram adotadas as denominações “essencial”, “importante” e “desejável”. 
• Essencial é o requisito sem o qual o sistema não entra em funcionamento. São requisitos imprescindíveis, que têm que ser implementados. 
• Importante é o requisito sem o qual o sistema entra em funcionamento, mas de forma não satisfatória. Requisitos importantes devem ser implementados, mas, se não forem, o sistema poderá ser implantado e usado mesmo assim. 
• Desejável é o requisito que não compromete as funcionalidades básicas do sistema, isto é, o sistema pode funcionar de forma satisfatória sem ele. Requisitos desejáveis são requisitos que podem ser deixados para versões posteriores do sistema, caso não haja tempo hábil para implementá-los na versão que está sendo especificada. 

==2.4 Descrição dos Atores==

'''Usuário externo'''
É a pessoa que acessa a funcionalidade de impressão de boletos do módulo geral pelo browser.

Filiado FETAPE
Semelhante ao usuário comum, com a diferença de que terá a opção de se cadastrar pelo site.

Funcionário FETAPE
É responsável pelo gerenciamento dos boletos. É o ator principal deste sistema.

=3 Requisitos Funcionais (Casos de Uso)=
==3.1 Ações do Usuário==

==[RF001] Efetuar login==
Atores relacionados
Usuário externo, Filiado FETAPE e Funcionário FETAPE.

===Objetivo===
Fazer login no módulo Web de impressão de boletos.

===Prioridade===
Essencial.

===Entradas e pré condições===
'''Entradas:''' login do usuário e senha;
'''Pré-condições:''' computador deve ter acesso à internet; servidor web disponível.

===Saídas e pós-condições===
'''Saídas:''' não há
'''Pós-condições:''' usuário logado no sistema.

===Fluxo principal de eventos===
1. Usuário executa seu web browser e acessa a página de login (E1, E2); 
2. Usuário informa login e senha e clica em Entrar (E3); 
3. Sistema recupera na base de dados a senha do usuário com o login informado; 
4. Sistema verifica se o login está cadastrado (E4); 
5. Sistema verifica se a senha informada corresponde ao login informado (E5); 
6. Sistema libera o acesso após o sucesso da verificação; 
7. Includes [RF002]. 

===Fluxos de exceção===
• E1: se não houver conexão com a internet, uma mensagem será exibida informando que não é possível estabelecer uma conexão com a internet e solicitando ao usuário que verifique sua conexão; 
• E2: se o sistema não estiver disponível, uma mensagem será exibida informando que o serviço não está disponível e que o usuário deve tentar acessá-lo mais tarde; 
• E3: se o usuário não informar o login ou a senha, o sistema solicita que informe o login e a senha; 
• E4: se o login não estiver cadastrado, o sistema emite uma mensagem de erro informando que este usuário não está cadastrado e solicitando que o mesmo verifique se o login foi digitado corretamente; 
• E5: se a senha não conferir com a que está armazenada na base de dados, o sistema emite uma mensagem de erro avisando que a senha informada está incorreta e solicitando que o mesmo verifique se ela foi digitada corretamente. 

==[RF002] Listar boletos==
===Atores relacionados===
Usuário externo, Filiado FETAPE e Funcionário FETAPE.

===Objetivo===
Listar os boletos correspondentes ao usuário logado.

===Prioridade===
Essencial.

===Entradas e pré condições===
'''Entradas:''' nenhuma.
'''Pré-condições:''' usuário logado no sistema; boletos armazenados no banco de dados.

===Saídas e pós-condições===
'''Saídas:''' lista de boletos.
'''Pós-condições:''' nenhuma.

===Fluxo principal de eventos===
1. Sistema carrega da base de dados os boletos referentes ao usuário (E1, E2, E3); 
2. É exibida a lista de boletos (com check boxes para seleção), cada um com seu número, descrição, valor, vencimento e status (pendente/atrasado/impresso/pago). Os boletos serão ordenados de forma decrescente (maior para o menor) por data de vencimento na lista. Também haverá uma check box que permite a seleção de todos os boletos listados na tela e um limite de boletos a serem exibidos, sendo os demais boletos acessados por uma barra de próximo/anterior (semelhante a um esquema de web mail); 
3. Através de uma caixa de seleção (combo box), o usuário pode filtrar os boletos que serão exibidos na tela de acordo com a opção: “pendentes/impressos/pagos/todos”. Os boletos com status “atrasado” ficarão na lista de “pendentes” e “todos”, mas com uma cor de linha de grid que os diferencie dos demais (ex. vermelho). O status inicial do filtro é “pendentes”. 

===Fluxos de exceção===
• E1: se não houver conexão com a internet, uma mensagem será exibida informando que não é possível estabelecer uma conexão com a internet e solicitando ao usuário que verifique sua conexão; 
• E2: se o sistema não estiver disponível, uma mensagem será exibida informando que o serviço não está disponível e que o usuário deve tentar acessá-lo mais tarde; 
• E3: se o resultado da busca retornar vazio, uma mensagem será exibida informando ao usuário que não existe dados referentes à consulta realizada. 

=[RF003] Geração de boletos=
===Atores relacionados===
Usuário externo, Filiado FETAPE e Funcionário FETAPE.

===Objetivo===
Gerar registros de boletos no banco de dados para impressão. Não constitui a impressão do boleto em si.

===Prioridade===
Essencial.

===Entradas e pré condições===
'''Entradas:''' filiado(s)/usuário(s), banco, data de vencimento, modelo da guia, nosso número inicial, valor e instruções.
'''Pré-condições:''' usuário logado no sistema; sindicatos e filiados armazenados no banco de dados.

===Saídas e pós-condições===
'''Saídas:''' mensagem de aviso de sucesso da operação. 
'''Pós-condições:''' registro dos boletos inseridos no banco de dados.

===Fluxo principal de eventos===
1. Usuário Externo e Filiado FETAPE: usuário clica no botão Gerar Boletos. Se o usuário estiver com o status óbito, não será gerado boleto. Funcionário FETAPE: funcionário seleciona uma quantidade de filiados na tela de Listagem de Filiados e clica no botão Gerar Boletos. Os filiados com o status “óbito” nunca serão carregados; 
2. Sistema carrega o(s) usuários(s)/filiado(s) selecionados com seus respectivos dados (E1, E2, E3, E4); 
3. Uma janela é aberta perguntando se o usuário deseja imprimir boletos referentes a Contribuição Sindical e Contribuição Confederativa (2 check boxes); 
4. Uma tela é aberta onde o usuário informa os dados (banco, data de vencimento, modelo da guia, nosso número inicial, valor e instruções) para os boletos. Usuário confirma a operação; 
5. Sistema valida os dados inseridos pelo usuário e os dados obrigatórios para emissão de boleto (E5, E6); 
6. Sistema gera os boletos e os armazena no banco de dados com o status “gerado” (E7). O sistema deverá verificar se o número de boleto que ele irá gerar existe em algum intervalo na tabela de boletos avulso. Se existir, ele deverá gerar um próximo número que não esteja em um intervalo desta tabela; 
7. Sistema insere os registros de log da situação dos boletos no banco remoto com a justificava “gerado a partir da função de geração de boleto pelo usuário X:Y”, onde X corresponde ao login do funcionário e Y corresponde ao seu nome; 
8. Sistema exibe mensagem confirmando o sucesso na geração dos boletos e perguntando se o usuário deseja fazer a impressão dos mesmos; 
9. Se o usuário responder que sim, a janela de impressão padrão da funcionalidade imprimir é aberta. Includes [RF004]. 

===Filiado FETAPE===
Este usuário também terá acesso à rotina de CANCELAMENTO do boleto, que consiste meramente na exclusão do mesmo da base de dados. Vale salientar que devem ser efetuados os devidos registros no log do sistema seguindo o padrão supracitado, assim como devem ser atendidos os seguintes fluxos de exceção: 
1. Se o boleto possuir o status “pago”, “impresso” ou “enviado” (para o banco), o cancelamento não será permitido. O sistema exibirá uma mensagem de erro avisando que o boleto não pode ser impresso, indicando o seu status atual; 
2. Se o boleto requisitado não puder ser excluído, o sistema exibe uma mensagem de erro solicitando que o boleto não poder ser removido no momento. 

===Fluxos de exceção===
• E1: se não houver conexão com a internet, uma mensagem será exibida informando que não é possível estabelecer uma conexão com a internet e solicitando ao usuário que verifique sua conexão; 
• E2: se o sistema não estiver disponível, uma mensagem será exibida informando que o serviço não está disponível e que o usuário deve tentar acessá-lo mais tarde; 
• E3: se o resultado da busca retornar vazio, uma mensagem será exibida informando ao usuário que não existem dados referentes à consulta realizada; 
• E4: se o sistema não conseguir acessar a base de dados, uma mensagem será exibida informando ao usuário que a base de dados está inacessível; 
• E5: se o usuário não preencher os dados obrigatórios do boleto (banco, data de vencimento, modelo da guia, nosso número inicial e valor), uma mensagem será exibida informando ao usuário que os campos obrigatórios devem ser preenchidos; 
• E6: se os dados obrigatórios do(s) usuário(s)/filiado(s) para emissão de boleto não foram preenchidos (nome, logradouro, bairro, cidade, estado e CEP), o sistema lista na tela os usuário(s)/filiado(s) cujos dados obrigatórios não estão preenchidos e, para cada um, informa quais campos devem ser preenchidos. O usuário poderá prosseguir para a tela de marcação dos boletos que serão impressos (botão “prosseguir”), no entanto os boletos cujos dados não estão completos não aparecerão para seleção; 
• E7: se houver um estouro na numeração de boletos*, o sistema exibe uma mensagem solicitando ao usuário que entre em contato com a BISA pois houve um problema na geração da numeração do boleto. A operação não é finalizada. O sistema deve ainda efetuar todas as rotinas de rollback de modo a não deixar ‘lixo’ no banco de dados. 

<nowiki>*</nowiki> O estouro na numeração de boletos ocorre quando o limite do número de boletos cadastrado no banco de dados é atingido. Por exemplo, supondo um limite de 10 bytes, se o último registro cadastrado for 9999999999, o próximo registro de boleto irá acionar este erro. 

=[RF004] Imprimir boletos=
===Atores relacionados===
Usuário externo, Filiado FETAPE e Funcionário FETAPE.

===Objetivo===
Constitui a impressão de um boleto já gerado no sistema.

===Prioridade===
Essencial.

===Entradas e pré condições===
'''Entradas:''' lista de boletos para impressão. 
'''Pré-condições:''' o usuário deve estar logado no sistema na tela da listagem de boletos (RF002); os registros dos boletos devem estar armazenados no banco de dados e marcados como “não impresso”.

===Saídas e pós-condições===
'''Saídas:''' impressão dos boletos selecionados. 
'''Pós-Condições:''' registros dos boletos marcados no banco como “impresso”.

===Fluxo principal de eventos===
1. Usuário seleciona na Lista de boletos aqueles que deseja imprimir (check box) e clica no botão Imprimir (E1, E2, E3, E4, E5); 
2. Se o usuário houver selecionado apenas um boleto, o sistema imprime o boleto no navegador, permitindo ao usuário conferir seus dados. Depois disso, ele clica em um novo botão Imprimir e passa para o passo 3; 
3. Janela de impressão padrão é aberta (onde o usuário poderá selecionar impressora, quantidade de páginas, etc). Usuário confirma a impressão e o sistema envia os arquivos para a impressora (E6); 
4. Sistema marca no banco os boletos que foram impressos com o status “impresso” (E7); 
5. Sistema insere no log de boletos os registros com o status impresso com a justificativa “impresso pela função de impressão de boletos pelo usuário X:Y”, onde X corresponde ao código do usuário e Y ao seu nome. 
6. Sistema exibe uma mensagem de “Boletos impressos com sucesso”. 

===Fluxos de exceção===
• E1: se não houver conexão com a internet, uma mensagem será exibida informando que não é possível estabelecer uma conexão com a internet e solicitando ao usuário que verifique sua conexão; 
• E2: se o sistema não estiver disponível, uma mensagem será exibida informando que o serviço não está disponível e que o usuário deve tentar acessá-lo mais tarde; 
• E3: se o usuário não selecionar boletos, o sistema exibe uma mensagem solicitando ao usuário que selecione boletos para impressão; 
• E4: se na lista houver boletos que já foram pagos, o sistema exibe uma mensagem de erro informando que boletos pagos não podem ser reimpressos e cancela a operação; 
• E5: se houver boletos que já foram impressos, o sistema exibe um alerta informando que os boletos já foram impressos pelo sistema e serão reimpressos nesta operação; continua a executar normalmente; 
• E6: se houver um erro ao enviar os dados para a impressora, o sistema exibe uma mensagem avisando ao usuário que o sistema não conseguiu imprimir e solicitando que o mesmo verifique se a impressora está pronta para impressão; 
• E7: se houver um erro na alteração dos registros no banco de dados, uma mensagem será exibida informando que não foi possível marcar os boletos como impressos e solicitando ao usuário que tente novamente e que, caso o erro persista, entre em contato com a BISA. O sistema deve ainda efetuar todas as rotinas de rollback de modo a não deixar ‘lixo’ no banco de dados. 

=[RF005] Cadastro de filiado=
===Atores relacionados===
Filiado FETAPE e Funcionário FETAPE.

===Objetivo===
Cadastrar um filiado. As rotinas de ALTERAÇÃO e de EXCLUSÃO também estão contidas neste requisito para o Funcionário FETAPE.

===Prioridade===
Essencial.

===Entradas e pré condições===
'''Entradas:''' dados cadastrais do usuário.
'''Pré-condições:''' computador deve ter acesso à internet; servidor web disponível. Funcionário: usuário cadastrado no sistema.

===Saídas e pós-condições===
'''Saídas:''' mensagem avisando que o usuário foi cadastrado com sucesso.
'''Pós-Condições:''' usuário cadastrado no banco de dados.

===Fluxo principal de eventos===
1. Ator Filiado: a função “Cadastrar Filiado” é acionada pelo usuário no navegador web (E1, E2). Ator Funcionário: a função “Cadastrar Filiado” é acionada pelo usuário na tela de Listagem de Filiados (E1, E2). 
2. Um formulário é aberto solicitando dados cadastrais: login, senha, nome, CPF, CNAE, bairro, cidade, UF, logradouro, CEP, categoria (seleção entre as opções arrendatário, assentado, meeiro, parceiro, posseiro, pequeno proprietário e outros) e apelido do filiado; 
3. Usuário preenche os campos e confirma a operação (E3, E4, E5, E6); 
4. Sistema insere os registros de log da situação no banco remoto com a justificava “cadastrado pelo usuário X:Y”, onde X corresponde ao login do usuário e Y corresponde ao seu nome; 
5. Sistema retorna uma mensagem avisando que o usuário foi cadastrado com sucesso. 

O sistema também apresenta as rotinas de ALTERAÇÃO, que por ser trivial e seguir um fluxo semelhante à rotina de inclusão não terá sua execução descrita aqui. Vale salientar que devem ser efetuados os devidos registros no log do sistema. 

===Filiado FETAPE===
Ele possui também a funcionalidade EXCLUSÃO. Sua tela de ALTERAR é diferente. Nela, o usuário pode marcar um check box “óbito” para filiados que foram a óbito.

===Fluxos de exceção===
• E1: se não houver conexão com a internet, uma mensagem será exibida informando que não é possível estabelecer uma conexão com a internet e solicitando ao usuário que verifique sua conexão; 
• E2: se o sistema não estiver disponível, uma mensagem será exibida informando que o serviço não está disponível e que o usuário deve tentar acessá-lo mais tarde; 
• E3: se o login fornecido já estiver cadastrado no sistema, uma mensagem será exibida informando ao usuário que o login cadastrado já existe no sistema; 
• E4: se o CPF do filiado for inválido, uma mensagem será exibida informando ao usuário que o CPF cadastrado é inválido. Vale salientar que o preenchimento deste campo é opcional; 
• E5: se houver um erro na inserção dos registros no banco de dados, uma mensagem será exibida informando que não foi possível inserir os dados e solicitando ao usuário que tente novamente e que, caso o erro persista, entre em contato com a BISA. O sistema deve ainda efetuar todas as rotinas de rollback de modo a não deixar ‘lixo’ no banco de dados; 
• E6: se os dados obrigatórios dos filiados não forem preenchidos (nome, logradouro, bairro, cidade, estado e CEP), o sistema emite uma mensagem de erro informando quais os campos obrigatórios não foram preenchidos. 

=[RF006] Listar filiados=
Atores relacionados
Funcionário FETAPE.

Objetivo
Listar todos os filiados cadastrados no sistema.

Prioridade
Essencial.

Entradas e pré condições
Entradas: nenhuma.
Pré-condições: usuário logado no sistema; filiados armazenados no banco de dados.

Saídas e pós-condições
Saídas: lista de filiados.
Pós-condições: nenhuma.

Fluxo principal de eventos
1. Usuário clica no botão Filiados da barra de funções do sistema para acessar a Listagem de Filiados;
2. Sistema carrega da base de dados os filiados com seus respectivos dados (E1, E2, E3, E4);
3. É exibida a lista de filiados (com check boxes para seleção), cada um com seu número, nome, apelido, CPF, município, sindicato e categoria. Os filiados serão ordenados por ordem alfabética e agrupados por município. Também haverá uma check box que permite a seleção de todos os filiados listados na tela e um limite de filiados a serem exibidos, sendo os demais acessados por uma barra de próximo/anterior (semelhante a um esquema de web mail);
4. Através de uma caixa de seleção (combo box), o usuário pode filtrar os filiados que serão exibidos na tela de acordo com a opção: “nome/apelido/município/sindicato”. A opção “nome” é a padrão. Os filiados que foram a óbito serão exibidos com uma cor de linha de grid acinzentada e só serão exibidos se um check box “todos” for ativado.

Fluxos de exceção
• E1: se não houver conexão com a internet, uma mensagem será exibida informando que não é possível estabelecer uma conexão com a internet e solicitando ao usuário que verifique sua conexão;
• E2: se o sistema não estiver disponível, uma mensagem será exibida informando que o serviço não está disponível e que o usuário deve tentar acessá-lo mais tarde;
• E3: se o resultado da busca retornar vazio, uma mensagem será exibida informando ao usuário que não existem dados referentes à consulta realizada;
• E4: se o sistema não conseguir acessar a base de dados, uma mensagem será exibida informando ao usuário que a base de dados está inacessível.

[RF007] Cadastro de sindicato
Atores relacionados
Funcionário FETAPE.

Objetivo
Cadastrar um sindicato. As rotinas de ALTERAÇÃO e de EXCLUSÃO também estão contidas neste requisito.

Prioridade
Essencial.

Entradas e pré condições
Entradas: dados do sindicato; dados do Município (já presentes na base de dados, herdada do antigo sistema DOS TRAB_RUR).
Pré-condições: usuário logado no sistema.

Saídas e pós-condições
Saídas: mensagem avisando que o sindicato foi cadastrado com sucesso.
Pós-Condições: sindicato cadastrado no banco de dados.

Fluxo principal de eventos
1. Usuário clica no botão cadastrar na tela de Listagem de Sindicatos (E1, E2);
2. Um formulário é aberto solicitando dados cadastrais: nome, município, UF, endereço;
3. Usuário preenche os campos e confirma a operação (E3);
4. Sistema insere os registros de log da situação no banco remoto com a justificava “cadastrado pelo usuário X:Y”, onde X corresponde ao login do funcionário e Y corresponde ao seu nome;
5. Sistema retorna uma mensagem avisando que o sindicato foi cadastrado com sucesso.

Também haverá rotinas de alteração e de exclusão. O processo é trivial para ser descrito aqui. Vale salientar que devem ser efetuados os devidos registros no log do sistema.

Fluxos de exceção
• E1: se não houver conexão com a internet, uma mensagem será exibida informando que não é possível estabelecer uma conexão com a internet e solicitando ao usuário que verifique sua conexão;
• E2: se o sistema não estiver disponível, uma mensagem será exibida informando que o serviço não está disponível e que o usuário deve tentar acessá-lo mais tarde;
• E3: se houver um erro na inserção dos registros no banco de dados, uma mensagem será exibida informando que não foi possível inserir os dados e solicitando ao usuário que tente novamente e que, caso o erro persista, entre em contato com a BISA. O sistema deve ainda efetuar todas as rotinas de rollback de modo a não deixar ‘lixo’ no banco de dados;

[RF008] Listar sindicatos
Atores relacionados
Funcionário FETAPE.

Objetivo
Listar todos os sindicatos cadastrados no sistema.

Prioridade
Essencial.

Entradas e pré condições
Entradas: nenhuma.
Pré-condições: usuário logado no sistema; sindicatos armazenados no banco de dados.

Saídas e pós-condições
Saídas: lista de sindicatos.
Pós-condições: nenhuma.

Fluxo principal de eventos
1. Usuário clica no botão Sindicatos da barra de funções do sistema para acessar a Listagem de Sindicatos;
2. Sistema carrega da base de dados os sindicatos com seus respectivos dados (E1, E2, E3, E4);
3. É exibida a lista de sindicatos (com check boxes para seleção), cada um com seu número, nome e município. Os sindicatos serão ordenados por ordem alfabética e agrupados por município. Também haverá uma check box que permite a seleção de todos os sindicatos listados na tela e um limite de sindicatos a serem exibidos, sendo os demais acessados por uma barra de próximo/anterior (semelhante a um esquema de web mail);
4. Através de uma caixa de seleção (combo box), o usuário pode filtrar os sindicatos que serão exibidos na tela de acordo com a opção: “nome/município”. A opção “nome” é a padrão.

Fluxos de exceção
• E1: se não houver conexão com a internet, uma mensagem será exibida informando que não é possível estabelecer uma conexão com a internet e solicitando ao usuário que verifique sua conexão;
• E2: se o sistema não estiver disponível, uma mensagem será exibida informando que o serviço não está disponível e que o usuário deve tentar acessá-lo mais tarde;
• E3: se o resultado da busca retornar vazio, uma mensagem será exibida informando ao usuário que não existem dados referentes à consulta realizada;
• E4: se o sistema não conseguir acessar a base de dados, uma mensagem será exibida informando ao usuário que a base de dados está inacessível.

[RF009] Baixar Boleto
Atores relacionados
Funcionário FETAPE.

Objetivo
Baixa nos boletos que foram impressos. Eles passarão a ter o status de pago.

Prioridade
Essencial.

Entradas e pré condições
Entradas: lista de boletos para baixa.
Pré-condições: usuário logado no sistema; os registros dos boletos devem estar armazenados no banco de dados.

Saídas e pós-condições
Saídas: mensagem de aviso de sucesso da operação.
Pós-condições: registro dos boletos marcados no banco como “pagos”.

Fluxo principal de eventos
1. Usuário seleciona na Lista de boletos aqueles que deseja baixar (check box) e clica no botão Baixar (E1, E2, E3, E4, E5);
2. Sistema marca no banco os boletos como pagos (E6). Se o boleto não for encontrado na tabela de boletos, deverá ser procurado na tabela de boletos avulsos (E7);
3. Sistema insere no log de boletos os registros com o status impresso com a justificativa “baixado pela função de baixar de boletos pelo usuário X:Y”, onde X corresponde ao código do usuário e Y ao seu nome;
4. Sistema exibe uma mensagem de “Boletos baixados com sucesso”.

Fluxos de exceção
• E1: se não houver conexão com a internet, uma mensagem será exibida informando que não é possível estabelecer uma conexão com a internet e solicitando ao usuário que verifique sua conexão;
• E2: se o sistema não estiver disponível, uma mensagem será exibida informando que o serviço não está disponível e que o usuário deve tentar acessá-lo mais tarde;
• E3: se o usuário não selecionar boletos, o sistema exibe uma mensagem solicitando ao usuário que selecione boletos para impressão;
• E4: se na lista houver boletos com o status “pago”, o sistema exibe uma mensagem informando que boletos selecionados já foram baixados. Se o usuário clicar em continuar, o sistema continua a execução e ignora esses boletos;
• E5: se na lista houver boletos com o status diferente de “impresso” ou “enviado” (enviado para o banco), o sistema exibe uma mensagem informando que há boletos selecionados que ainda não foram impressos ou enviados para o banco e quais são estes boletos. Se o usuário clicar em continuar, o sistema continua a execução e ignora esses boletos;
• E6: se houver um erro na alteração dos registros no banco de dados, uma mensagem será exibida informando que não foi possível marcar os boletos como pagos e solicitando ao usuário que tente novamente e que, caso o erro persista, entre em contato com a BISA. O sistema deve ainda efetuar todas as rotinas de rollback de modo a não deixar ‘lixo’ no banco de dados;
• E7: se o registro do boleto não for encontrado no banco, o sistema exibirá uma mensagem de erro indicando que o boleto não foi encontrado na base de dados do sistema.

[RF010] Baixar Boleto Automaticamente (via Arquivo de Retorno do Banco)
Atores relacionados
Funcionário FETAPE.

Objetivo
Baixar de boletos a partir de um arquivo de retorno que o banco envia.

Prioridade
Essencial.

Entradas e pré condições
Entradas: arquivo de retorno do banco.
Pré-condições: usuário logado no sistema; os registros dos boletos devem estar armazenados no banco de dados.

Saídas e pós-condições
Saídas: mensagem de sucesso da operação.
Pós-condições: registro dos boletos marcados no banco como “pagos”.

Fluxo principal de eventos
1. Na tela da Lista de boletos, usuário clica na opção Baixa com Arquivo do Banco (E1, E2);
2. Uma tela é aberta perguntando qual o arquivo de retorno do banco. O usuário então seleciona o caminho no seu computador correspondente à localização do arquivo e clica em OK. O sistema irá, então, fazer o upload do arquivo (E3, E4, E5);
3. Sistema guarda a identificação do arquivo de retorno com situação de ‘não processado’ na base de dados e guarda uma cópia do arquivo em diretório especifico para histórico;
4. Para cada linha do arquivo de retorno, o sistema procura o boleto referente na base de dados de boletos de contribuição. Se o boleto não for encontrado, o sistema procura na base de dados de boletos avulsos. Nesta base, há registros de boletos com intervalos (ex. de 001 a 100). O sistema irá buscar o número do boleto nessa faixa (E6);
5. O sistema verifica se o boleto encontrado está marcado como “impresso” ou “enviado” (para o banco). Se estiver, o sistema marca no banco de dados o boleto como “pago” (E7);
6. O sistema insere no log de boletos o registro com situação de “pago” com a justificativa ‘baixado pela função de baixa automática de boleto pelo usuário X:Y’, onde X corresponde ao login de usuário e Y corresponde ao seu nome;
7. O Sistema marca o arquivo de retorno como ‘processado sem erros’ e uma exibe mensagem confirmando o sucesso na baixa dos boletos.

Fluxos de exceção
• E1: se não houver conexão com a internet, uma mensagem será exibida informando que não é possível estabelecer uma conexão com a internet e solicitando ao usuário que verifique sua conexão;
• E2: se o sistema não estiver disponível, uma mensagem será exibida informando que o serviço não está disponível e que o usuário deve tentar acessá-lo mais tarde;
• E3: se o usuário não apontar nenhum arquivo de retorno, uma mensagem será exibida exigindo que o usuário aponte o arquivo;
• E4: se o caminho para o arquivo estiver incorreto, o sistema exibe uma mensagem para o usuário informando que o caminho selecionado é inválido;
• E5: se o formato do arquivo não corresponder ao formato do arquivo de retorno do banco esperado, o sistema exibirá uma mensagem informando que o formato do arquivo selecionado é inválido;
• E6: se um registro do arquivo não for encontrado no sistema (base principal e base de boletos avulsos), será exibido numa tela todos os registros que não foram encontrados. A situação do arquivo de retorno no banco deve então mudar para “processado com erro” e o sistema deve inserir o registro de log de boleto com a justificativa “boleto não pode ser baixado, pois o mesmo não foi encontrado no sistema. Ação executada pelo usuário X:Y”, onde X é o login e Y é o nome. O valor do boleto pago e não encontrado deverá ser armazenado na tabela de boletos no registro cujo identificador é “BoletoXXXX”. Todo boleto que não for encontrado deverá ser somado ao valor desse registro;
• E7: se houver um erro na alteração dos registros no banco de dados, uma mensagem será exibida informando que não foi possível marcar os boletos como “pago” e solicitando ao usuário que tente novamente e que, caso o erro persista, entre em contato com a BISA. O sistema deve ainda efetuar todas as rotinas de rollback de modo a não deixar ‘lixo’ no banco de dados.

[RF011] Gerar arquivo de remessa para banco
Atores relacionados
Funcionário FETAPE.

Objetivo
Gerar arquivo de remessa de boletos para o banco.

Prioridade
Essencial.

Entradas e pré condições
Entradas: lista de boletos que serão enviados para o arquivo.
Pré-condições: usuário logado no sistema; os registros dos boletos devem estar armazenados no banco de dados com o status “gerado” ou “impresso”.

Saídas e pós-condições
Saídas: mensagem de sucesso da operação; arquivo de remessa para o banco.
Pós-condições: boletos marcados com o status “enviado” no banco na base de dados.

Fluxo principal de eventos
1. Na tela de Listagem de Boletos, o usuário seleciona os boletos e clica no botão Gerar de arquivo de remessa (E1, E2);
2. Sistema verifica se todos os boletos selecionados estão marcados como “gerado” ou “impresso” (E3);
3. Sistema abre tela para que o usuário informe o nome do arquivo e o local onde ele será gerado (E4, E5);
4. Usuário confirma a geração do arquivo;
5. Sistema gera o arquivo de remessa;
6. Sistema marca no banco os boletos que foram inseridos no arquivo de remessa com o status de “enviado” para o banco (E6);
7. Sistema insere no log de boletos os registros com situação de enviado com a justificativa “boleto gerado no arquivo de remessa para o banco pelo usuário X:Y”, onde X corresponde ao login do usuário e Y corresponde ao seu nome;
8. Sistema salva em diretório especifico no banco uma cópia do arquivo gerado para remessa para fins de histórico;
9. Sistema retorna o arquivo de remessa para que o usuário salve-o em seu computador.

Fluxos de exceção
• E1: se não houver conexão com a internet, uma mensagem será exibida informando que não é possível estabelecer uma conexão com a internet e solicitando ao usuário que verifique sua conexão;
• E2: se o sistema não estiver disponível, uma mensagem será exibida informando que o serviço não está disponível e que o usuário deve tentar acessá-lo mais tarde;
• E3: se o sistema não encontrar nenhum arquivo com o status “gerado” ou “impresso”, uma mensagem será exibida informando que não existem boletos a serem gerados para o arquivo de remessa. Se encontrar, deverá informar quais os boletos não serão gerados no arquivo;
• E4: se o usuário informa um local não existente, o sistema pergunta ao usuário se o mesmo deseja que o sistema crie o diretório de pastas informado. Se a resposta for sim, sistema cria diretório de pasta; se a resposta for não, sistema retorna a tela de informação do local para que o usuário selecione um novo diretório;
• E5: se houver um erro na geração do arquivo de remessa, uma mensagem será exibida informando ao usuário que o arquivo de remessa não pode ser gerado e que o mesmo tente novamente e que, caso o erro persista, entre em contato com a BISA.;
• E6: se houver um erro na alteração dos registros no banco de dados, uma mensagem será exibida informando que não foi possível marcar os boletos como “enviado” e solicitando ao usuário que tente novamente e que, caso o erro persista, entre em contato com a BISA. O sistema deve ainda efetuar todas as rotinas de rollback de modo a não deixar ‘lixo’ no banco de dados.

[RF012] Gerar arquivo de remessa para Gráfica
Atores relacionados
Funcionário FETAPE.

Objetivo
Gerar arquivo de remessa de boletos para Gráfica.

Prioridade
Essencial.

Entradas e pré condições
Entradas: lista de boletos que serão enviados para o arquivo.
Pré-condições: usuário logado no sistema; os registros dos boletos devem estar armazenados no banco de dados com o status “gerado”.

Saídas e pós-condições
Saídas: mensagem de sucesso da operação; arquivo de remessa para a gráfica (em formato txt e xls).
Pós-condições: boletos marcados com o status “enviadoGrafica” no banco na base de dados.

Fluxo principal de eventos
1. Na tela de Listagem de Boletos, o usuário seleciona os boletos e clica no botão Gerar arquivo de boleto para Gráfica (E1, E2);
2. Sistema verifica se todos os boletos selecionados estão marcados como “gerado” (E3);
3. Sistema abre tela para que o usuário informe o nome do arquivo e o local onde ele será gerado (E4, E5);
4. Usuário confirma a geração do arquivo;
5. Sistema pergunta se o usuário quer gerar o arquivo no formato txt ou xls;
6. Sistema gera o arquivo de remessa para Gráfica;
7. Sistema marca no banco os boletos que foram inseridos no arquivo de remessa com o status de “enviadoGrafica” para o banco (E6);
8. Sistema insere no log de boletos os registros com situação de enviado com a justificativa “boleto gerado no arquivo de remessa para Gráfica pelo usuário X:Y”, onde X corresponde ao login do usuário e Y corresponde ao seu nome;
9. Sistema salva em diretório especifico no banco uma cópia do arquivo gerado para remessa para Gráfica para fins de histórico;
10. Sistema retorna o arquivo para que o usuário salve-o em seu computador.

Fluxos de exceção
• E1: se não houver conexão com a internet, uma mensagem será exibida informando que não é possível estabelecer uma conexão com a internet e solicitando ao usuário que verifique sua conexão;
• E2: se o sistema não estiver disponível, uma mensagem será exibida informando que o serviço não está disponível e que o usuário deve tentar acessá-lo mais tarde;
• E3: se o sistema não encontrar nenhum arquivo com o status “gerado”, uma mensagem será exibida informando que não existem boletos a serem gerados para o arquivo de remessa. Se encontrar, deverá informar quais os boletos não serão gerados no arquivo;
• E4: se o usuário informa um local não existente, o sistema pergunta ao usuário se o mesmo deseja que o sistema crie o diretório de pastas informado. Se a resposta for sim, sistema cria diretório de pasta; se a resposta for não, sistema retorna a tela de informação do local para que o usuário selecione um novo diretório;
• E5: se houver um erro na geração do arquivo de remessa, uma mensagem será exibida informando ao usuário que o arquivo de remessa não pode ser gerado e que o mesmo tente novamente e que, caso o erro persista, entre em contato com a BISA;
• E6: se houver um erro na alteração dos registros no banco de dados, uma mensagem será exibida informando que não foi possível marcar os boletos como “enviado” e solicitando ao usuário que tente novamente e que, caso o erro persista, entre em contato com a BISA. O sistema deve ainda efetuar todas as rotinas de rollback de modo a não deixar ‘lixo’ no banco de dados.

4 Especificações Suplementares
4.1 Objetivos
Este documento tem como finalidade especificar todos os requisitos não funcionais do módulo de boletos web divididos em requisitos de usabilidade, confiabilidade, desempenho, segurança, distribuição, adequação a padrões e requisitos de hardware e software.
4.2 Usabilidade
Esta seção descreve os requisitos não funcionais associados à facilidade de uso da interface com o usuário, material de treinamento e documentação do sistema.
[NF001] Interface com o Usuário
Prioridade: Desejável
O sistema deve possuir uma interface amigável, simples e intuitiva.
4.3 Confiabilidade
Esta seção descreve os requisitos não funcionais associados à freqüência, severidade de falhas do sistema e habilidade de recuperação das mesmas, bem como a corretude do sistema.
[NF001] Tempo de Retorno após Falha
Prioridade: Desejável
Retorno de até 5 segundos após alguma falha.
[NF002] Disponibilidade
Prioridade: Importante
O sistema estará disponível 24 horas por dia durante todos os dias do ano.
4.4 Desempenho
Esta seção descreve os requisitos não funcionais associados à eficiência, uso de recursos e tempo de resposta do sistema.
[NF001] Número de Acessos
O sistema deve ser capaz de atender em média 10 usuários por segundo nos momentos de pico de acesso.
[NF002] Tempo de Resposta para os Usuários
O tempo máximo de resposta de uma requisição deve ser de no máximo 10 segundos.

4.5 Segurança
Esta seção descreve os requisitos não funcionais associados à integridade, privacidade e autenticidade dos dados do sistema.
[NF001] Privacidade de Acesso
Apenas os usuários credenciados e com permissão para acesso a este módulo deverão fazer uso das funcionalidades do módulo de boletos/guias na Web.
4.6 Hardware e software
Esta seção descreve os requisitos não funcionais associados ao hardware e software usados para desenvolver ou para executar o sistema.
[NF001] Linguagem de Implementação
Prioridade: Essencial
A linguagem de implementação do módulo de boleto Web será Delphi, mesma linguagem utilizada no desenvolvimento dos sistemas Partidos2000, Receb2000, OAB2000 e Filiados2000.
[NF002] Banco de Dados
Prioridade: Essencial
O banco de dados utilizado será o MySQL.
[NF003] Ferramentas
Prioridade: Essencial
Ferramenta de modelagem: Borland Delphi 2006
Ferramenta de Desenvolvimento: Borland Delphi 2006
[NF004] Plataforma de Funcionamento
Prioridade: Essencial
A plataforma tanto de desenvolvimento e de funcionamento será Windows.

Para uso do Bw- Construindo

2013-01-22T13:37:12Z

AnaPaula: /* 1.4 Descrição do Produto */

[[Arquivo:BoletosWeb.PNG]] 

[[Arquivo:Historico_de_revisoes.PNG]] 

=1. Caso de Negócio=
==1.1 Objetivos==

Documentar o novo módulo de geração e impressão de boletos online. As informações aqui descritas especificam e refinam a regras de negócio.

==1.2 Referências==

Se baseará no conhecimento adquirido na implementação de rotinas de boletos da BISA (desktop) e no antigo sistema TRAB_RUR da BISA, em DOS. A entrevista com Mário e Márcio da FETAPE (realizada por Ronaldo e Alexandre) também é referência para a definição dos requisitos.

==1.3 Sistemas com rotinas de gerenciamento de boletos da BISA==

O Filiados 2000 é um sistema desktop de gestão de filiados que controla o cadastro de filiados dos sindicatos de trabalhadores, fazendo acompanhamento de participação na organização.

O OAB 2000 é um software de gestão de cadastro de advogados para OAB's. Faz desde o cadastro de alunos, pré-inscritos, coordena sociedades de advogados, estagiários, até a administração dos dados financeiros dos advogados.

O Receb 2000 é um software voltado para o acompanhamento do contas a receber de uma empresa, fazendo a gestão financeira da carteira de forma simples e eficiente.

Todos esses sistemas possuem uma função de gerenciamento de boletos bancários ou guias sindicais, sendo salvos de forma centralizada no MySQL, de forma que podem ser acessados de forma uniforme no BoletoWEB.

Cada sistema contém suas próprias regras de negócio para gerenciar os boletos; no entanto, as funções de acesso ao banco remoto serão padronizadas para todos os sistemas no BoletoWEB.

==1.4 Descrição do Produto==

A maior parte da implementação é voltada para a FETAPE, enquanto o restante imprime boletos gerados pelos nossos sistema desktop.

Módulo Geral: este módulo tem a função meramente de fornecer uma interface web que permita ao usuário imprimir boletos gerados pelos sistemas desktop da BISA. 

'''Módulo FETAPE:''' no antigo sistema TRAB_RUR da BISA, este sistema é o foco principal desta documentação. Nela o usuário poderá gerenciar todo o fluxo de boletos de contribuições: geração, impressão interna, cadastro de filiados, acesso on-line dos filiados, etc.

==1.5 Contexto de Negócio==

O módulo geral de boletos na web será utilizado a princípio pelos sistemas Receb2000, OAB2000 e Filiados2000, porém poderá ser extendido a qualquer sistema que queira fazer o controle de boletos/guias.

Este módulo concentrará as informações dos boletos em um único local independente de entidade ou sistema. Este local, a priori, ficou definido como sendo um dos servidores internos da BISA que possua acesso externo. Cada sistema rodará normalmente no ambiente do cliente. No momento que for necessário o acesso às informações, este será feito não mais na base local da área do cliente, mas na base remota situada na BISA.

O módulo FETAPE segue as mesmas diretrizes, tendo a diferença de ser implementado exclusivamente para esta entidade, devendo ser adaptável para outras entidades. Para tanto, aconselha-se o uso de uma arquitetura em camadas e padrões de projetos, facilitadores do processos de manutenção.

==1.6 Tecnologias utilizadas==

Os módulos geral e FETAPE deverão implementados utilizando uma tecnologia para web: PHP, Java ou .NET.

O banco de dados necessariamente deverá ser o MySQL, pois já é utilizado na bisa para o registro de boletos.

=2. Sobre os Requisitos=
==2.1 Introdução==

Este documento especifica todos os requisitos funcionais e não funcionais do módulo de gerenciamento de boletos, descrevendo os fluxos de eventos, prioridades, atores, entradas e saídas de cada caso de uso a ser implementado.

A correta interpretação deste documento exige o conhecimento de algumas convenções e termos específicos, que são descritos a seguir.

==2.2 Identificação dos Requisitos==

Por convenção, a referência a requisitos é feita através do nome da subseção onde eles estão descritos, seguidos do identificador do requisito, de acordo com o esquema abaixo:

[nome da subseção, identificador do requisito]

Por exemplo, o requisito funcional [Imprimir Boleto RF002] está descrito em um caso de uso chamado “Imprimir Boleto”, em um bloco identificado pelo identificador [RF002].

==2.3 Prioridades dos Requisitos==

Para estabelecer a prioridade dos requisitos foram adotadas as denominações “essencial”, “importante” e “desejável”. 
• Essencial é o requisito sem o qual o sistema não entra em funcionamento. São requisitos imprescindíveis, que têm que ser implementados. 
• Importante é o requisito sem o qual o sistema entra em funcionamento, mas de forma não satisfatória. Requisitos importantes devem ser implementados, mas, se não forem, o sistema poderá ser implantado e usado mesmo assim. 
• Desejável é o requisito que não compromete as funcionalidades básicas do sistema, isto é, o sistema pode funcionar de forma satisfatória sem ele. Requisitos desejáveis são requisitos que podem ser deixados para versões posteriores do sistema, caso não haja tempo hábil para implementá-los na versão que está sendo especificada. 

==2.4 Descrição dos Atores==

'''Usuário externo'''
É a pessoa que acessa a funcionalidade de impressão de boletos do módulo geral pelo browser.

Filiado FETAPE
Semelhante ao usuário comum, com a diferença de que terá a opção de se cadastrar pelo site.

Funcionário FETAPE
É responsável pelo gerenciamento dos boletos. É o ator principal deste sistema.

=3 Requisitos Funcionais (Casos de Uso)=
==3.1 Ações do Usuário==

==[RF001] Efetuar login==
Atores relacionados
Usuário externo, Filiado FETAPE e Funcionário FETAPE.

===Objetivo===
Fazer login no módulo Web de impressão de boletos.

===Prioridade===
Essencial.

===Entradas e pré condições===
'''Entradas:''' login do usuário e senha;
'''Pré-condições:''' computador deve ter acesso à internet; servidor web disponível.

===Saídas e pós-condições===
'''Saídas:''' não há
'''Pós-condições:''' usuário logado no sistema.

===Fluxo principal de eventos===
1. Usuário executa seu web browser e acessa a página de login (E1, E2); 
2. Usuário informa login e senha e clica em Entrar (E3); 
3. Sistema recupera na base de dados a senha do usuário com o login informado; 
4. Sistema verifica se o login está cadastrado (E4); 
5. Sistema verifica se a senha informada corresponde ao login informado (E5); 
6. Sistema libera o acesso após o sucesso da verificação; 
7. Includes [RF002]. 

===Fluxos de exceção===
• E1: se não houver conexão com a internet, uma mensagem será exibida informando que não é possível estabelecer uma conexão com a internet e solicitando ao usuário que verifique sua conexão; 
• E2: se o sistema não estiver disponível, uma mensagem será exibida informando que o serviço não está disponível e que o usuário deve tentar acessá-lo mais tarde; 
• E3: se o usuário não informar o login ou a senha, o sistema solicita que informe o login e a senha; 
• E4: se o login não estiver cadastrado, o sistema emite uma mensagem de erro informando que este usuário não está cadastrado e solicitando que o mesmo verifique se o login foi digitado corretamente; 
• E5: se a senha não conferir com a que está armazenada na base de dados, o sistema emite uma mensagem de erro avisando que a senha informada está incorreta e solicitando que o mesmo verifique se ela foi digitada corretamente. 

==[RF002] Listar boletos==
===Atores relacionados===
Usuário externo, Filiado FETAPE e Funcionário FETAPE.

===Objetivo===
Listar os boletos correspondentes ao usuário logado.

===Prioridade===
Essencial.

===Entradas e pré condições===
'''Entradas:''' nenhuma.
'''Pré-condições:''' usuário logado no sistema; boletos armazenados no banco de dados.

===Saídas e pós-condições===
'''Saídas:''' lista de boletos.
'''Pós-condições:''' nenhuma.

===Fluxo principal de eventos===
1. Sistema carrega da base de dados os boletos referentes ao usuário (E1, E2, E3); 
2. É exibida a lista de boletos (com check boxes para seleção), cada um com seu número, descrição, valor, vencimento e status (pendente/atrasado/impresso/pago). Os boletos serão ordenados de forma decrescente (maior para o menor) por data de vencimento na lista. Também haverá uma check box que permite a seleção de todos os boletos listados na tela e um limite de boletos a serem exibidos, sendo os demais boletos acessados por uma barra de próximo/anterior (semelhante a um esquema de web mail); 
3. Através de uma caixa de seleção (combo box), o usuário pode filtrar os boletos que serão exibidos na tela de acordo com a opção: “pendentes/impressos/pagos/todos”. Os boletos com status “atrasado” ficarão na lista de “pendentes” e “todos”, mas com uma cor de linha de grid que os diferencie dos demais (ex. vermelho). O status inicial do filtro é “pendentes”. 

===Fluxos de exceção===
• E1: se não houver conexão com a internet, uma mensagem será exibida informando que não é possível estabelecer uma conexão com a internet e solicitando ao usuário que verifique sua conexão; 
• E2: se o sistema não estiver disponível, uma mensagem será exibida informando que o serviço não está disponível e que o usuário deve tentar acessá-lo mais tarde; 
• E3: se o resultado da busca retornar vazio, uma mensagem será exibida informando ao usuário que não existe dados referentes à consulta realizada. 

=[RF003] Geração de boletos=
===Atores relacionados===
Usuário externo, Filiado FETAPE e Funcionário FETAPE.

===Objetivo===
Gerar registros de boletos no banco de dados para impressão. Não constitui a impressão do boleto em si.

===Prioridade===
Essencial.

===Entradas e pré condições===
'''Entradas:''' filiado(s)/usuário(s), banco, data de vencimento, modelo da guia, nosso número inicial, valor e instruções.
'''Pré-condições:''' usuário logado no sistema; sindicatos e filiados armazenados no banco de dados.

===Saídas e pós-condições===
'''Saídas:''' mensagem de aviso de sucesso da operação. 
'''Pós-condições:''' registro dos boletos inseridos no banco de dados.

===Fluxo principal de eventos===
1. Usuário Externo e Filiado FETAPE: usuário clica no botão Gerar Boletos. Se o usuário estiver com o status óbito, não será gerado boleto. Funcionário FETAPE: funcionário seleciona uma quantidade de filiados na tela de Listagem de Filiados e clica no botão Gerar Boletos. Os filiados com o status “óbito” nunca serão carregados; 
2. Sistema carrega o(s) usuários(s)/filiado(s) selecionados com seus respectivos dados (E1, E2, E3, E4); 
3. Uma janela é aberta perguntando se o usuário deseja imprimir boletos referentes a Contribuição Sindical e Contribuição Confederativa (2 check boxes); 
4. Uma tela é aberta onde o usuário informa os dados (banco, data de vencimento, modelo da guia, nosso número inicial, valor e instruções) para os boletos. Usuário confirma a operação; 
5. Sistema valida os dados inseridos pelo usuário e os dados obrigatórios para emissão de boleto (E5, E6); 
6. Sistema gera os boletos e os armazena no banco de dados com o status “gerado” (E7). O sistema deverá verificar se o número de boleto que ele irá gerar existe em algum intervalo na tabela de boletos avulso. Se existir, ele deverá gerar um próximo número que não esteja em um intervalo desta tabela; 
7. Sistema insere os registros de log da situação dos boletos no banco remoto com a justificava “gerado a partir da função de geração de boleto pelo usuário X:Y”, onde X corresponde ao login do funcionário e Y corresponde ao seu nome; 
8. Sistema exibe mensagem confirmando o sucesso na geração dos boletos e perguntando se o usuário deseja fazer a impressão dos mesmos; 
9. Se o usuário responder que sim, a janela de impressão padrão da funcionalidade imprimir é aberta. Includes [RF004]. 

===Filiado FETAPE===
Este usuário também terá acesso à rotina de CANCELAMENTO do boleto, que consiste meramente na exclusão do mesmo da base de dados. Vale salientar que devem ser efetuados os devidos registros no log do sistema seguindo o padrão supracitado, assim como devem ser atendidos os seguintes fluxos de exceção: 
1. Se o boleto possuir o status “pago”, “impresso” ou “enviado” (para o banco), o cancelamento não será permitido. O sistema exibirá uma mensagem de erro avisando que o boleto não pode ser impresso, indicando o seu status atual; 
2. Se o boleto requisitado não puder ser excluído, o sistema exibe uma mensagem de erro solicitando que o boleto não poder ser removido no momento. 

===Fluxos de exceção===
• E1: se não houver conexão com a internet, uma mensagem será exibida informando que não é possível estabelecer uma conexão com a internet e solicitando ao usuário que verifique sua conexão; 
• E2: se o sistema não estiver disponível, uma mensagem será exibida informando que o serviço não está disponível e que o usuário deve tentar acessá-lo mais tarde; 
• E3: se o resultado da busca retornar vazio, uma mensagem será exibida informando ao usuário que não existem dados referentes à consulta realizada; 
• E4: se o sistema não conseguir acessar a base de dados, uma mensagem será exibida informando ao usuário que a base de dados está inacessível; 
• E5: se o usuário não preencher os dados obrigatórios do boleto (banco, data de vencimento, modelo da guia, nosso número inicial e valor), uma mensagem será exibida informando ao usuário que os campos obrigatórios devem ser preenchidos; 
• E6: se os dados obrigatórios do(s) usuário(s)/filiado(s) para emissão de boleto não foram preenchidos (nome, logradouro, bairro, cidade, estado e CEP), o sistema lista na tela os usuário(s)/filiado(s) cujos dados obrigatórios não estão preenchidos e, para cada um, informa quais campos devem ser preenchidos. O usuário poderá prosseguir para a tela de marcação dos boletos que serão impressos (botão “prosseguir”), no entanto os boletos cujos dados não estão completos não aparecerão para seleção; 
• E7: se houver um estouro na numeração de boletos*, o sistema exibe uma mensagem solicitando ao usuário que entre em contato com a BISA pois houve um problema na geração da numeração do boleto. A operação não é finalizada. O sistema deve ainda efetuar todas as rotinas de rollback de modo a não deixar ‘lixo’ no banco de dados. 

<nowiki>*</nowiki> O estouro na numeração de boletos ocorre quando o limite do número de boletos cadastrado no banco de dados é atingido. Por exemplo, supondo um limite de 10 bytes, se o último registro cadastrado for 9999999999, o próximo registro de boleto irá acionar este erro. 

=[RF004] Imprimir boletos=
===Atores relacionados===
Usuário externo, Filiado FETAPE e Funcionário FETAPE.

===Objetivo===
Constitui a impressão de um boleto já gerado no sistema.

===Prioridade===
Essencial.

===Entradas e pré condições===
'''Entradas:''' lista de boletos para impressão. 
'''Pré-condições:''' o usuário deve estar logado no sistema na tela da listagem de boletos (RF002); os registros dos boletos devem estar armazenados no banco de dados e marcados como “não impresso”.

===Saídas e pós-condições===
'''Saídas:''' impressão dos boletos selecionados. 
'''Pós-Condições:''' registros dos boletos marcados no banco como “impresso”.

===Fluxo principal de eventos===
1. Usuário seleciona na Lista de boletos aqueles que deseja imprimir (check box) e clica no botão Imprimir (E1, E2, E3, E4, E5); 
2. Se o usuário houver selecionado apenas um boleto, o sistema imprime o boleto no navegador, permitindo ao usuário conferir seus dados. Depois disso, ele clica em um novo botão Imprimir e passa para o passo 3; 
3. Janela de impressão padrão é aberta (onde o usuário poderá selecionar impressora, quantidade de páginas, etc). Usuário confirma a impressão e o sistema envia os arquivos para a impressora (E6); 
4. Sistema marca no banco os boletos que foram impressos com o status “impresso” (E7); 
5. Sistema insere no log de boletos os registros com o status impresso com a justificativa “impresso pela função de impressão de boletos pelo usuário X:Y”, onde X corresponde ao código do usuário e Y ao seu nome. 
6. Sistema exibe uma mensagem de “Boletos impressos com sucesso”. 

===Fluxos de exceção===
• E1: se não houver conexão com a internet, uma mensagem será exibida informando que não é possível estabelecer uma conexão com a internet e solicitando ao usuário que verifique sua conexão; 
• E2: se o sistema não estiver disponível, uma mensagem será exibida informando que o serviço não está disponível e que o usuário deve tentar acessá-lo mais tarde; 
• E3: se o usuário não selecionar boletos, o sistema exibe uma mensagem solicitando ao usuário que selecione boletos para impressão; 
• E4: se na lista houver boletos que já foram pagos, o sistema exibe uma mensagem de erro informando que boletos pagos não podem ser reimpressos e cancela a operação; 
• E5: se houver boletos que já foram impressos, o sistema exibe um alerta informando que os boletos já foram impressos pelo sistema e serão reimpressos nesta operação; continua a executar normalmente; 
• E6: se houver um erro ao enviar os dados para a impressora, o sistema exibe uma mensagem avisando ao usuário que o sistema não conseguiu imprimir e solicitando que o mesmo verifique se a impressora está pronta para impressão; 
• E7: se houver um erro na alteração dos registros no banco de dados, uma mensagem será exibida informando que não foi possível marcar os boletos como impressos e solicitando ao usuário que tente novamente e que, caso o erro persista, entre em contato com a BISA. O sistema deve ainda efetuar todas as rotinas de rollback de modo a não deixar ‘lixo’ no banco de dados. 

=[RF005] Cadastro de filiado=
Atores relacionados
Filiado FETAPE e Funcionário FETAPE.

Objetivo
Cadastrar um filiado. As rotinas de ALTERAÇÃO e de EXCLUSÃO também estão contidas neste requisito para o Funcionário FETAPE.

Prioridade
Essencial.

Entradas e pré condições
Entradas: dados cadastrais do usuário.
Pré-condições: computador deve ter acesso à internet; servidor web disponível. Funcionário: usuário cadastrado no sistema.

Saídas e pós-condições
Saídas: mensagem avisando que o usuário foi cadastrado com sucesso.
Pós-Condições: usuário cadastrado no banco de dados.

Fluxo principal de eventos
1. Ator Filiado: a função “Cadastrar Filiado” é acionada pelo usuário no navegador web (E1, E2). Ator Funcionário: a função “Cadastrar Filiado” é acionada pelo usuário na tela de Listagem de Filiados (E1, E2).
2. Um formulário é aberto solicitando dados cadastrais: login, senha, nome, CPF, CNAE, bairro, cidade, UF, logradouro, CEP, categoria (seleção entre as opções arrendatário, assentado, meeiro, parceiro, posseiro, pequeno proprietário e outros) e apelido do filiado;
3. Usuário preenche os campos e confirma a operação (E3, E4, E5, E6);
4. Sistema insere os registros de log da situação no banco remoto com a justificava “cadastrado pelo usuário X:Y”, onde X corresponde ao login do usuário e Y corresponde ao seu nome;
5. Sistema retorna uma mensagem avisando que o usuário foi cadastrado com sucesso.

O sistema também apresenta as rotinas de ALTERAÇÃO, que por ser trivial e seguir um fluxo semelhante à rotina de inclusão não terá sua execução descrita aqui. Vale salientar que devem ser efetuados os devidos registros no log do sistema.

Filiado FETAPE
Ele possui também a funcionalidade EXCLUSÃO. Sua tela de ALTERAR é diferente. Nela, o usuário pode marcar um check box “óbito” para filiados que foram a óbito.

Fluxos de exceção
• E1: se não houver conexão com a internet, uma mensagem será exibida informando que não é possível estabelecer uma conexão com a internet e solicitando ao usuário que verifique sua conexão;
• E2: se o sistema não estiver disponível, uma mensagem será exibida informando que o serviço não está disponível e que o usuário deve tentar acessá-lo mais tarde;
• E3: se o login fornecido já estiver cadastrado no sistema, uma mensagem será exibida informando ao usuário que o login cadastrado já existe no sistema;
• E4: se o CPF do filiado for inválido, uma mensagem será exibida informando ao usuário que o CPF cadastrado é inválido. Vale salientar que o preenchimento deste campo é opcional;
• E5: se houver um erro na inserção dos registros no banco de dados, uma mensagem será exibida informando que não foi possível inserir os dados e solicitando ao usuário que tente novamente e que, caso o erro persista, entre em contato com a BISA. O sistema deve ainda efetuar todas as rotinas de rollback de modo a não deixar ‘lixo’ no banco de dados;
• E6: se os dados obrigatórios dos filiados não forem preenchidos (nome, logradouro, bairro, cidade, estado e CEP), o sistema emite uma mensagem de erro informando quais os campos obrigatórios não foram preenchidos.

[RF006] Listar filiados
Atores relacionados
Funcionário FETAPE.

Objetivo
Listar todos os filiados cadastrados no sistema.

Prioridade
Essencial.

Entradas e pré condições
Entradas: nenhuma.
Pré-condições: usuário logado no sistema; filiados armazenados no banco de dados.

Saídas e pós-condições
Saídas: lista de filiados.
Pós-condições: nenhuma.

Fluxo principal de eventos
1. Usuário clica no botão Filiados da barra de funções do sistema para acessar a Listagem de Filiados;
2. Sistema carrega da base de dados os filiados com seus respectivos dados (E1, E2, E3, E4);
3. É exibida a lista de filiados (com check boxes para seleção), cada um com seu número, nome, apelido, CPF, município, sindicato e categoria. Os filiados serão ordenados por ordem alfabética e agrupados por município. Também haverá uma check box que permite a seleção de todos os filiados listados na tela e um limite de filiados a serem exibidos, sendo os demais acessados por uma barra de próximo/anterior (semelhante a um esquema de web mail);
4. Através de uma caixa de seleção (combo box), o usuário pode filtrar os filiados que serão exibidos na tela de acordo com a opção: “nome/apelido/município/sindicato”. A opção “nome” é a padrão. Os filiados que foram a óbito serão exibidos com uma cor de linha de grid acinzentada e só serão exibidos se um check box “todos” for ativado.

Fluxos de exceção
• E1: se não houver conexão com a internet, uma mensagem será exibida informando que não é possível estabelecer uma conexão com a internet e solicitando ao usuário que verifique sua conexão;
• E2: se o sistema não estiver disponível, uma mensagem será exibida informando que o serviço não está disponível e que o usuário deve tentar acessá-lo mais tarde;
• E3: se o resultado da busca retornar vazio, uma mensagem será exibida informando ao usuário que não existem dados referentes à consulta realizada;
• E4: se o sistema não conseguir acessar a base de dados, uma mensagem será exibida informando ao usuário que a base de dados está inacessível.

[RF007] Cadastro de sindicato
Atores relacionados
Funcionário FETAPE.

Objetivo
Cadastrar um sindicato. As rotinas de ALTERAÇÃO e de EXCLUSÃO também estão contidas neste requisito.

Prioridade
Essencial.

Entradas e pré condições
Entradas: dados do sindicato; dados do Município (já presentes na base de dados, herdada do antigo sistema DOS TRAB_RUR).
Pré-condições: usuário logado no sistema.

Saídas e pós-condições
Saídas: mensagem avisando que o sindicato foi cadastrado com sucesso.
Pós-Condições: sindicato cadastrado no banco de dados.

Fluxo principal de eventos
1. Usuário clica no botão cadastrar na tela de Listagem de Sindicatos (E1, E2);
2. Um formulário é aberto solicitando dados cadastrais: nome, município, UF, endereço;
3. Usuário preenche os campos e confirma a operação (E3);
4. Sistema insere os registros de log da situação no banco remoto com a justificava “cadastrado pelo usuário X:Y”, onde X corresponde ao login do funcionário e Y corresponde ao seu nome;
5. Sistema retorna uma mensagem avisando que o sindicato foi cadastrado com sucesso.

Também haverá rotinas de alteração e de exclusão. O processo é trivial para ser descrito aqui. Vale salientar que devem ser efetuados os devidos registros no log do sistema.

Fluxos de exceção
• E1: se não houver conexão com a internet, uma mensagem será exibida informando que não é possível estabelecer uma conexão com a internet e solicitando ao usuário que verifique sua conexão;
• E2: se o sistema não estiver disponível, uma mensagem será exibida informando que o serviço não está disponível e que o usuário deve tentar acessá-lo mais tarde;
• E3: se houver um erro na inserção dos registros no banco de dados, uma mensagem será exibida informando que não foi possível inserir os dados e solicitando ao usuário que tente novamente e que, caso o erro persista, entre em contato com a BISA. O sistema deve ainda efetuar todas as rotinas de rollback de modo a não deixar ‘lixo’ no banco de dados;

[RF008] Listar sindicatos
Atores relacionados
Funcionário FETAPE.

Objetivo
Listar todos os sindicatos cadastrados no sistema.

Prioridade
Essencial.

Entradas e pré condições
Entradas: nenhuma.
Pré-condições: usuário logado no sistema; sindicatos armazenados no banco de dados.

Saídas e pós-condições
Saídas: lista de sindicatos.
Pós-condições: nenhuma.

Fluxo principal de eventos
1. Usuário clica no botão Sindicatos da barra de funções do sistema para acessar a Listagem de Sindicatos;
2. Sistema carrega da base de dados os sindicatos com seus respectivos dados (E1, E2, E3, E4);
3. É exibida a lista de sindicatos (com check boxes para seleção), cada um com seu número, nome e município. Os sindicatos serão ordenados por ordem alfabética e agrupados por município. Também haverá uma check box que permite a seleção de todos os sindicatos listados na tela e um limite de sindicatos a serem exibidos, sendo os demais acessados por uma barra de próximo/anterior (semelhante a um esquema de web mail);
4. Através de uma caixa de seleção (combo box), o usuário pode filtrar os sindicatos que serão exibidos na tela de acordo com a opção: “nome/município”. A opção “nome” é a padrão.

Fluxos de exceção
• E1: se não houver conexão com a internet, uma mensagem será exibida informando que não é possível estabelecer uma conexão com a internet e solicitando ao usuário que verifique sua conexão;
• E2: se o sistema não estiver disponível, uma mensagem será exibida informando que o serviço não está disponível e que o usuário deve tentar acessá-lo mais tarde;
• E3: se o resultado da busca retornar vazio, uma mensagem será exibida informando ao usuário que não existem dados referentes à consulta realizada;
• E4: se o sistema não conseguir acessar a base de dados, uma mensagem será exibida informando ao usuário que a base de dados está inacessível.

[RF009] Baixar Boleto
Atores relacionados
Funcionário FETAPE.

Objetivo
Baixa nos boletos que foram impressos. Eles passarão a ter o status de pago.

Prioridade
Essencial.

Entradas e pré condições
Entradas: lista de boletos para baixa.
Pré-condições: usuário logado no sistema; os registros dos boletos devem estar armazenados no banco de dados.

Saídas e pós-condições
Saídas: mensagem de aviso de sucesso da operação.
Pós-condições: registro dos boletos marcados no banco como “pagos”.

Fluxo principal de eventos
1. Usuário seleciona na Lista de boletos aqueles que deseja baixar (check box) e clica no botão Baixar (E1, E2, E3, E4, E5);
2. Sistema marca no banco os boletos como pagos (E6). Se o boleto não for encontrado na tabela de boletos, deverá ser procurado na tabela de boletos avulsos (E7);
3. Sistema insere no log de boletos os registros com o status impresso com a justificativa “baixado pela função de baixar de boletos pelo usuário X:Y”, onde X corresponde ao código do usuário e Y ao seu nome;
4. Sistema exibe uma mensagem de “Boletos baixados com sucesso”.

Fluxos de exceção
• E1: se não houver conexão com a internet, uma mensagem será exibida informando que não é possível estabelecer uma conexão com a internet e solicitando ao usuário que verifique sua conexão;
• E2: se o sistema não estiver disponível, uma mensagem será exibida informando que o serviço não está disponível e que o usuário deve tentar acessá-lo mais tarde;
• E3: se o usuário não selecionar boletos, o sistema exibe uma mensagem solicitando ao usuário que selecione boletos para impressão;
• E4: se na lista houver boletos com o status “pago”, o sistema exibe uma mensagem informando que boletos selecionados já foram baixados. Se o usuário clicar em continuar, o sistema continua a execução e ignora esses boletos;
• E5: se na lista houver boletos com o status diferente de “impresso” ou “enviado” (enviado para o banco), o sistema exibe uma mensagem informando que há boletos selecionados que ainda não foram impressos ou enviados para o banco e quais são estes boletos. Se o usuário clicar em continuar, o sistema continua a execução e ignora esses boletos;
• E6: se houver um erro na alteração dos registros no banco de dados, uma mensagem será exibida informando que não foi possível marcar os boletos como pagos e solicitando ao usuário que tente novamente e que, caso o erro persista, entre em contato com a BISA. O sistema deve ainda efetuar todas as rotinas de rollback de modo a não deixar ‘lixo’ no banco de dados;
• E7: se o registro do boleto não for encontrado no banco, o sistema exibirá uma mensagem de erro indicando que o boleto não foi encontrado na base de dados do sistema.

[RF010] Baixar Boleto Automaticamente (via Arquivo de Retorno do Banco)
Atores relacionados
Funcionário FETAPE.

Objetivo
Baixar de boletos a partir de um arquivo de retorno que o banco envia.

Prioridade
Essencial.

Entradas e pré condições
Entradas: arquivo de retorno do banco.
Pré-condições: usuário logado no sistema; os registros dos boletos devem estar armazenados no banco de dados.

Saídas e pós-condições
Saídas: mensagem de sucesso da operação.
Pós-condições: registro dos boletos marcados no banco como “pagos”.

Fluxo principal de eventos
1. Na tela da Lista de boletos, usuário clica na opção Baixa com Arquivo do Banco (E1, E2);
2. Uma tela é aberta perguntando qual o arquivo de retorno do banco. O usuário então seleciona o caminho no seu computador correspondente à localização do arquivo e clica em OK. O sistema irá, então, fazer o upload do arquivo (E3, E4, E5);
3. Sistema guarda a identificação do arquivo de retorno com situação de ‘não processado’ na base de dados e guarda uma cópia do arquivo em diretório especifico para histórico;
4. Para cada linha do arquivo de retorno, o sistema procura o boleto referente na base de dados de boletos de contribuição. Se o boleto não for encontrado, o sistema procura na base de dados de boletos avulsos. Nesta base, há registros de boletos com intervalos (ex. de 001 a 100). O sistema irá buscar o número do boleto nessa faixa (E6);
5. O sistema verifica se o boleto encontrado está marcado como “impresso” ou “enviado” (para o banco). Se estiver, o sistema marca no banco de dados o boleto como “pago” (E7);
6. O sistema insere no log de boletos o registro com situação de “pago” com a justificativa ‘baixado pela função de baixa automática de boleto pelo usuário X:Y’, onde X corresponde ao login de usuário e Y corresponde ao seu nome;
7. O Sistema marca o arquivo de retorno como ‘processado sem erros’ e uma exibe mensagem confirmando o sucesso na baixa dos boletos.

Fluxos de exceção
• E1: se não houver conexão com a internet, uma mensagem será exibida informando que não é possível estabelecer uma conexão com a internet e solicitando ao usuário que verifique sua conexão;
• E2: se o sistema não estiver disponível, uma mensagem será exibida informando que o serviço não está disponível e que o usuário deve tentar acessá-lo mais tarde;
• E3: se o usuário não apontar nenhum arquivo de retorno, uma mensagem será exibida exigindo que o usuário aponte o arquivo;
• E4: se o caminho para o arquivo estiver incorreto, o sistema exibe uma mensagem para o usuário informando que o caminho selecionado é inválido;
• E5: se o formato do arquivo não corresponder ao formato do arquivo de retorno do banco esperado, o sistema exibirá uma mensagem informando que o formato do arquivo selecionado é inválido;
• E6: se um registro do arquivo não for encontrado no sistema (base principal e base de boletos avulsos), será exibido numa tela todos os registros que não foram encontrados. A situação do arquivo de retorno no banco deve então mudar para “processado com erro” e o sistema deve inserir o registro de log de boleto com a justificativa “boleto não pode ser baixado, pois o mesmo não foi encontrado no sistema. Ação executada pelo usuário X:Y”, onde X é o login e Y é o nome. O valor do boleto pago e não encontrado deverá ser armazenado na tabela de boletos no registro cujo identificador é “BoletoXXXX”. Todo boleto que não for encontrado deverá ser somado ao valor desse registro;
• E7: se houver um erro na alteração dos registros no banco de dados, uma mensagem será exibida informando que não foi possível marcar os boletos como “pago” e solicitando ao usuário que tente novamente e que, caso o erro persista, entre em contato com a BISA. O sistema deve ainda efetuar todas as rotinas de rollback de modo a não deixar ‘lixo’ no banco de dados.

[RF011] Gerar arquivo de remessa para banco
Atores relacionados
Funcionário FETAPE.

Objetivo
Gerar arquivo de remessa de boletos para o banco.

Prioridade
Essencial.

Entradas e pré condições
Entradas: lista de boletos que serão enviados para o arquivo.
Pré-condições: usuário logado no sistema; os registros dos boletos devem estar armazenados no banco de dados com o status “gerado” ou “impresso”.

Saídas e pós-condições
Saídas: mensagem de sucesso da operação; arquivo de remessa para o banco.
Pós-condições: boletos marcados com o status “enviado” no banco na base de dados.

Fluxo principal de eventos
1. Na tela de Listagem de Boletos, o usuário seleciona os boletos e clica no botão Gerar de arquivo de remessa (E1, E2);
2. Sistema verifica se todos os boletos selecionados estão marcados como “gerado” ou “impresso” (E3);
3. Sistema abre tela para que o usuário informe o nome do arquivo e o local onde ele será gerado (E4, E5);
4. Usuário confirma a geração do arquivo;
5. Sistema gera o arquivo de remessa;
6. Sistema marca no banco os boletos que foram inseridos no arquivo de remessa com o status de “enviado” para o banco (E6);
7. Sistema insere no log de boletos os registros com situação de enviado com a justificativa “boleto gerado no arquivo de remessa para o banco pelo usuário X:Y”, onde X corresponde ao login do usuário e Y corresponde ao seu nome;
8. Sistema salva em diretório especifico no banco uma cópia do arquivo gerado para remessa para fins de histórico;
9. Sistema retorna o arquivo de remessa para que o usuário salve-o em seu computador.

Fluxos de exceção
• E1: se não houver conexão com a internet, uma mensagem será exibida informando que não é possível estabelecer uma conexão com a internet e solicitando ao usuário que verifique sua conexão;
• E2: se o sistema não estiver disponível, uma mensagem será exibida informando que o serviço não está disponível e que o usuário deve tentar acessá-lo mais tarde;
• E3: se o sistema não encontrar nenhum arquivo com o status “gerado” ou “impresso”, uma mensagem será exibida informando que não existem boletos a serem gerados para o arquivo de remessa. Se encontrar, deverá informar quais os boletos não serão gerados no arquivo;
• E4: se o usuário informa um local não existente, o sistema pergunta ao usuário se o mesmo deseja que o sistema crie o diretório de pastas informado. Se a resposta for sim, sistema cria diretório de pasta; se a resposta for não, sistema retorna a tela de informação do local para que o usuário selecione um novo diretório;
• E5: se houver um erro na geração do arquivo de remessa, uma mensagem será exibida informando ao usuário que o arquivo de remessa não pode ser gerado e que o mesmo tente novamente e que, caso o erro persista, entre em contato com a BISA.;
• E6: se houver um erro na alteração dos registros no banco de dados, uma mensagem será exibida informando que não foi possível marcar os boletos como “enviado” e solicitando ao usuário que tente novamente e que, caso o erro persista, entre em contato com a BISA. O sistema deve ainda efetuar todas as rotinas de rollback de modo a não deixar ‘lixo’ no banco de dados.

[RF012] Gerar arquivo de remessa para Gráfica
Atores relacionados
Funcionário FETAPE.

Objetivo
Gerar arquivo de remessa de boletos para Gráfica.

Prioridade
Essencial.

Entradas e pré condições
Entradas: lista de boletos que serão enviados para o arquivo.
Pré-condições: usuário logado no sistema; os registros dos boletos devem estar armazenados no banco de dados com o status “gerado”.

Saídas e pós-condições
Saídas: mensagem de sucesso da operação; arquivo de remessa para a gráfica (em formato txt e xls).
Pós-condições: boletos marcados com o status “enviadoGrafica” no banco na base de dados.

Fluxo principal de eventos
1. Na tela de Listagem de Boletos, o usuário seleciona os boletos e clica no botão Gerar arquivo de boleto para Gráfica (E1, E2);
2. Sistema verifica se todos os boletos selecionados estão marcados como “gerado” (E3);
3. Sistema abre tela para que o usuário informe o nome do arquivo e o local onde ele será gerado (E4, E5);
4. Usuário confirma a geração do arquivo;
5. Sistema pergunta se o usuário quer gerar o arquivo no formato txt ou xls;
6. Sistema gera o arquivo de remessa para Gráfica;
7. Sistema marca no banco os boletos que foram inseridos no arquivo de remessa com o status de “enviadoGrafica” para o banco (E6);
8. Sistema insere no log de boletos os registros com situação de enviado com a justificativa “boleto gerado no arquivo de remessa para Gráfica pelo usuário X:Y”, onde X corresponde ao login do usuário e Y corresponde ao seu nome;
9. Sistema salva em diretório especifico no banco uma cópia do arquivo gerado para remessa para Gráfica para fins de histórico;
10. Sistema retorna o arquivo para que o usuário salve-o em seu computador.

Fluxos de exceção
• E1: se não houver conexão com a internet, uma mensagem será exibida informando que não é possível estabelecer uma conexão com a internet e solicitando ao usuário que verifique sua conexão;
• E2: se o sistema não estiver disponível, uma mensagem será exibida informando que o serviço não está disponível e que o usuário deve tentar acessá-lo mais tarde;
• E3: se o sistema não encontrar nenhum arquivo com o status “gerado”, uma mensagem será exibida informando que não existem boletos a serem gerados para o arquivo de remessa. Se encontrar, deverá informar quais os boletos não serão gerados no arquivo;
• E4: se o usuário informa um local não existente, o sistema pergunta ao usuário se o mesmo deseja que o sistema crie o diretório de pastas informado. Se a resposta for sim, sistema cria diretório de pasta; se a resposta for não, sistema retorna a tela de informação do local para que o usuário selecione um novo diretório;
• E5: se houver um erro na geração do arquivo de remessa, uma mensagem será exibida informando ao usuário que o arquivo de remessa não pode ser gerado e que o mesmo tente novamente e que, caso o erro persista, entre em contato com a BISA;
• E6: se houver um erro na alteração dos registros no banco de dados, uma mensagem será exibida informando que não foi possível marcar os boletos como “enviado” e solicitando ao usuário que tente novamente e que, caso o erro persista, entre em contato com a BISA. O sistema deve ainda efetuar todas as rotinas de rollback de modo a não deixar ‘lixo’ no banco de dados.

4 Especificações Suplementares
4.1 Objetivos
Este documento tem como finalidade especificar todos os requisitos não funcionais do módulo de boletos web divididos em requisitos de usabilidade, confiabilidade, desempenho, segurança, distribuição, adequação a padrões e requisitos de hardware e software.
4.2 Usabilidade
Esta seção descreve os requisitos não funcionais associados à facilidade de uso da interface com o usuário, material de treinamento e documentação do sistema.
[NF001] Interface com o Usuário
Prioridade: Desejável
O sistema deve possuir uma interface amigável, simples e intuitiva.
4.3 Confiabilidade
Esta seção descreve os requisitos não funcionais associados à freqüência, severidade de falhas do sistema e habilidade de recuperação das mesmas, bem como a corretude do sistema.
[NF001] Tempo de Retorno após Falha
Prioridade: Desejável
Retorno de até 5 segundos após alguma falha.
[NF002] Disponibilidade
Prioridade: Importante
O sistema estará disponível 24 horas por dia durante todos os dias do ano.
4.4 Desempenho
Esta seção descreve os requisitos não funcionais associados à eficiência, uso de recursos e tempo de resposta do sistema.
[NF001] Número de Acessos
O sistema deve ser capaz de atender em média 10 usuários por segundo nos momentos de pico de acesso.
[NF002] Tempo de Resposta para os Usuários
O tempo máximo de resposta de uma requisição deve ser de no máximo 10 segundos.

4.5 Segurança
Esta seção descreve os requisitos não funcionais associados à integridade, privacidade e autenticidade dos dados do sistema.
[NF001] Privacidade de Acesso
Apenas os usuários credenciados e com permissão para acesso a este módulo deverão fazer uso das funcionalidades do módulo de boletos/guias na Web.
4.6 Hardware e software
Esta seção descreve os requisitos não funcionais associados ao hardware e software usados para desenvolver ou para executar o sistema.
[NF001] Linguagem de Implementação
Prioridade: Essencial
A linguagem de implementação do módulo de boleto Web será Delphi, mesma linguagem utilizada no desenvolvimento dos sistemas Partidos2000, Receb2000, OAB2000 e Filiados2000.
[NF002] Banco de Dados
Prioridade: Essencial
O banco de dados utilizado será o MySQL.
[NF003] Ferramentas
Prioridade: Essencial
Ferramenta de modelagem: Borland Delphi 2006
Ferramenta de Desenvolvimento: Borland Delphi 2006
[NF004] Plataforma de Funcionamento
Prioridade: Essencial
A plataforma tanto de desenvolvimento e de funcionamento será Windows.

Para uso do Bw- Construindo

2013-01-22T13:34:26Z

AnaPaula:

[[Arquivo:BoletosWeb.PNG]] 

[[Arquivo:Historico_de_revisoes.PNG]] 

=1. Caso de Negócio=
==1.1 Objetivos==

Documentar o novo módulo de geração e impressão de boletos online. As informações aqui descritas especificam e refinam a regras de negócio.

==1.2 Referências==

Se baseará no conhecimento adquirido na implementação de rotinas de boletos da BISA (desktop) e no antigo sistema TRAB_RUR da BISA, em DOS. A entrevista com Mário e Márcio da FETAPE (realizada por Ronaldo e Alexandre) também é referência para a definição dos requisitos.

==1.3 Sistemas com rotinas de gerenciamento de boletos da BISA==

O Filiados 2000 é um sistema desktop de gestão de filiados que controla o cadastro de filiados dos sindicatos de trabalhadores, fazendo acompanhamento de participação na organização.

O OAB 2000 é um software de gestão de cadastro de advogados para OAB's. Faz desde o cadastro de alunos, pré-inscritos, coordena sociedades de advogados, estagiários, até a administração dos dados financeiros dos advogados.

O Receb 2000 é um software voltado para o acompanhamento do contas a receber de uma empresa, fazendo a gestão financeira da carteira de forma simples e eficiente.

Todos esses sistemas possuem uma função de gerenciamento de boletos bancários ou guias sindicais, sendo salvos de forma centralizada no MySQL, de forma que podem ser acessados de forma uniforme no BoletoWEB.

Cada sistema contém suas próprias regras de negócio para gerenciar os boletos; no entanto, as funções de acesso ao banco remoto serão padronizadas para todos os sistemas no BoletoWEB.

==1.4 Descrição do Produto==

A maior parte da implementação é voltada para a FETAPE, enquanto o restante imprime boletos gerados pelos nossos sistema desktop.

Módulo Geral: este módulo tem a função meramente de fornecer uma interface web que permita ao usuário imprimir boletos gerados pelos sistemas desktop da BISA.

Módulo FETAPE: no antigo sistema TRAB_RUR da BISA, este sistema é o foco principal desta documentação. Nela o usuário poderá gerenciar todo o fluxo de boletos de contribuições: geração, impressão interna, cadastro de filiados, acesso on-line dos filiados, etc.

==1.5 Contexto de Negócio==

O módulo geral de boletos na web será utilizado a princípio pelos sistemas Receb2000, OAB2000 e Filiados2000, porém poderá ser extendido a qualquer sistema que queira fazer o controle de boletos/guias.

Este módulo concentrará as informações dos boletos em um único local independente de entidade ou sistema. Este local, a priori, ficou definido como sendo um dos servidores internos da BISA que possua acesso externo. Cada sistema rodará normalmente no ambiente do cliente. No momento que for necessário o acesso às informações, este será feito não mais na base local da área do cliente, mas na base remota situada na BISA.

O módulo FETAPE segue as mesmas diretrizes, tendo a diferença de ser implementado exclusivamente para esta entidade, devendo ser adaptável para outras entidades. Para tanto, aconselha-se o uso de uma arquitetura em camadas e padrões de projetos, facilitadores do processos de manutenção.

==1.6 Tecnologias utilizadas==

Os módulos geral e FETAPE deverão implementados utilizando uma tecnologia para web: PHP, Java ou .NET.

O banco de dados necessariamente deverá ser o MySQL, pois já é utilizado na bisa para o registro de boletos.

=2. Sobre os Requisitos=
==2.1 Introdução==

Este documento especifica todos os requisitos funcionais e não funcionais do módulo de gerenciamento de boletos, descrevendo os fluxos de eventos, prioridades, atores, entradas e saídas de cada caso de uso a ser implementado.

A correta interpretação deste documento exige o conhecimento de algumas convenções e termos específicos, que são descritos a seguir.

==2.2 Identificação dos Requisitos==

Por convenção, a referência a requisitos é feita através do nome da subseção onde eles estão descritos, seguidos do identificador do requisito, de acordo com o esquema abaixo:

[nome da subseção, identificador do requisito]

Por exemplo, o requisito funcional [Imprimir Boleto RF002] está descrito em um caso de uso chamado “Imprimir Boleto”, em um bloco identificado pelo identificador [RF002].

==2.3 Prioridades dos Requisitos==

Para estabelecer a prioridade dos requisitos foram adotadas as denominações “essencial”, “importante” e “desejável”. 
• Essencial é o requisito sem o qual o sistema não entra em funcionamento. São requisitos imprescindíveis, que têm que ser implementados. 
• Importante é o requisito sem o qual o sistema entra em funcionamento, mas de forma não satisfatória. Requisitos importantes devem ser implementados, mas, se não forem, o sistema poderá ser implantado e usado mesmo assim. 
• Desejável é o requisito que não compromete as funcionalidades básicas do sistema, isto é, o sistema pode funcionar de forma satisfatória sem ele. Requisitos desejáveis são requisitos que podem ser deixados para versões posteriores do sistema, caso não haja tempo hábil para implementá-los na versão que está sendo especificada. 

==2.4 Descrição dos Atores==

'''Usuário externo'''
É a pessoa que acessa a funcionalidade de impressão de boletos do módulo geral pelo browser.

Filiado FETAPE
Semelhante ao usuário comum, com a diferença de que terá a opção de se cadastrar pelo site.

Funcionário FETAPE
É responsável pelo gerenciamento dos boletos. É o ator principal deste sistema.

=3 Requisitos Funcionais (Casos de Uso)=
==3.1 Ações do Usuário==

==[RF001] Efetuar login==
Atores relacionados
Usuário externo, Filiado FETAPE e Funcionário FETAPE.

===Objetivo===
Fazer login no módulo Web de impressão de boletos.

===Prioridade===
Essencial.

===Entradas e pré condições===
'''Entradas:''' login do usuário e senha;
'''Pré-condições:''' computador deve ter acesso à internet; servidor web disponível.

===Saídas e pós-condições===
'''Saídas:''' não há
'''Pós-condições:''' usuário logado no sistema.

===Fluxo principal de eventos===
1. Usuário executa seu web browser e acessa a página de login (E1, E2); 
2. Usuário informa login e senha e clica em Entrar (E3); 
3. Sistema recupera na base de dados a senha do usuário com o login informado; 
4. Sistema verifica se o login está cadastrado (E4); 
5. Sistema verifica se a senha informada corresponde ao login informado (E5); 
6. Sistema libera o acesso após o sucesso da verificação; 
7. Includes [RF002]. 

===Fluxos de exceção===
• E1: se não houver conexão com a internet, uma mensagem será exibida informando que não é possível estabelecer uma conexão com a internet e solicitando ao usuário que verifique sua conexão; 
• E2: se o sistema não estiver disponível, uma mensagem será exibida informando que o serviço não está disponível e que o usuário deve tentar acessá-lo mais tarde; 
• E3: se o usuário não informar o login ou a senha, o sistema solicita que informe o login e a senha; 
• E4: se o login não estiver cadastrado, o sistema emite uma mensagem de erro informando que este usuário não está cadastrado e solicitando que o mesmo verifique se o login foi digitado corretamente; 
• E5: se a senha não conferir com a que está armazenada na base de dados, o sistema emite uma mensagem de erro avisando que a senha informada está incorreta e solicitando que o mesmo verifique se ela foi digitada corretamente. 

==[RF002] Listar boletos==
===Atores relacionados===
Usuário externo, Filiado FETAPE e Funcionário FETAPE.

===Objetivo===
Listar os boletos correspondentes ao usuário logado.

===Prioridade===
Essencial.

===Entradas e pré condições===
'''Entradas:''' nenhuma.
'''Pré-condições:''' usuário logado no sistema; boletos armazenados no banco de dados.

===Saídas e pós-condições===
'''Saídas:''' lista de boletos.
'''Pós-condições:''' nenhuma.

===Fluxo principal de eventos===
1. Sistema carrega da base de dados os boletos referentes ao usuário (E1, E2, E3); 
2. É exibida a lista de boletos (com check boxes para seleção), cada um com seu número, descrição, valor, vencimento e status (pendente/atrasado/impresso/pago). Os boletos serão ordenados de forma decrescente (maior para o menor) por data de vencimento na lista. Também haverá uma check box que permite a seleção de todos os boletos listados na tela e um limite de boletos a serem exibidos, sendo os demais boletos acessados por uma barra de próximo/anterior (semelhante a um esquema de web mail); 
3. Através de uma caixa de seleção (combo box), o usuário pode filtrar os boletos que serão exibidos na tela de acordo com a opção: “pendentes/impressos/pagos/todos”. Os boletos com status “atrasado” ficarão na lista de “pendentes” e “todos”, mas com uma cor de linha de grid que os diferencie dos demais (ex. vermelho). O status inicial do filtro é “pendentes”. 

===Fluxos de exceção===
• E1: se não houver conexão com a internet, uma mensagem será exibida informando que não é possível estabelecer uma conexão com a internet e solicitando ao usuário que verifique sua conexão; 
• E2: se o sistema não estiver disponível, uma mensagem será exibida informando que o serviço não está disponível e que o usuário deve tentar acessá-lo mais tarde; 
• E3: se o resultado da busca retornar vazio, uma mensagem será exibida informando ao usuário que não existe dados referentes à consulta realizada. 

=[RF003] Geração de boletos=
===Atores relacionados===
Usuário externo, Filiado FETAPE e Funcionário FETAPE.

===Objetivo===
Gerar registros de boletos no banco de dados para impressão. Não constitui a impressão do boleto em si.

===Prioridade===
Essencial.

===Entradas e pré condições===
'''Entradas:''' filiado(s)/usuário(s), banco, data de vencimento, modelo da guia, nosso número inicial, valor e instruções.
'''Pré-condições:''' usuário logado no sistema; sindicatos e filiados armazenados no banco de dados.

===Saídas e pós-condições===
'''Saídas:''' mensagem de aviso de sucesso da operação. 
'''Pós-condições:''' registro dos boletos inseridos no banco de dados.

===Fluxo principal de eventos===
1. Usuário Externo e Filiado FETAPE: usuário clica no botão Gerar Boletos. Se o usuário estiver com o status óbito, não será gerado boleto. Funcionário FETAPE: funcionário seleciona uma quantidade de filiados na tela de Listagem de Filiados e clica no botão Gerar Boletos. Os filiados com o status “óbito” nunca serão carregados; 
2. Sistema carrega o(s) usuários(s)/filiado(s) selecionados com seus respectivos dados (E1, E2, E3, E4); 
3. Uma janela é aberta perguntando se o usuário deseja imprimir boletos referentes a Contribuição Sindical e Contribuição Confederativa (2 check boxes); 
4. Uma tela é aberta onde o usuário informa os dados (banco, data de vencimento, modelo da guia, nosso número inicial, valor e instruções) para os boletos. Usuário confirma a operação; 
5. Sistema valida os dados inseridos pelo usuário e os dados obrigatórios para emissão de boleto (E5, E6); 
6. Sistema gera os boletos e os armazena no banco de dados com o status “gerado” (E7). O sistema deverá verificar se o número de boleto que ele irá gerar existe em algum intervalo na tabela de boletos avulso. Se existir, ele deverá gerar um próximo número que não esteja em um intervalo desta tabela; 
7. Sistema insere os registros de log da situação dos boletos no banco remoto com a justificava “gerado a partir da função de geração de boleto pelo usuário X:Y”, onde X corresponde ao login do funcionário e Y corresponde ao seu nome; 
8. Sistema exibe mensagem confirmando o sucesso na geração dos boletos e perguntando se o usuário deseja fazer a impressão dos mesmos; 
9. Se o usuário responder que sim, a janela de impressão padrão da funcionalidade imprimir é aberta. Includes [RF004]. 

===Filiado FETAPE===
Este usuário também terá acesso à rotina de CANCELAMENTO do boleto, que consiste meramente na exclusão do mesmo da base de dados. Vale salientar que devem ser efetuados os devidos registros no log do sistema seguindo o padrão supracitado, assim como devem ser atendidos os seguintes fluxos de exceção: 
1. Se o boleto possuir o status “pago”, “impresso” ou “enviado” (para o banco), o cancelamento não será permitido. O sistema exibirá uma mensagem de erro avisando que o boleto não pode ser impresso, indicando o seu status atual; 
2. Se o boleto requisitado não puder ser excluído, o sistema exibe uma mensagem de erro solicitando que o boleto não poder ser removido no momento. 

===Fluxos de exceção===
• E1: se não houver conexão com a internet, uma mensagem será exibida informando que não é possível estabelecer uma conexão com a internet e solicitando ao usuário que verifique sua conexão; 
• E2: se o sistema não estiver disponível, uma mensagem será exibida informando que o serviço não está disponível e que o usuário deve tentar acessá-lo mais tarde; 
• E3: se o resultado da busca retornar vazio, uma mensagem será exibida informando ao usuário que não existem dados referentes à consulta realizada; 
• E4: se o sistema não conseguir acessar a base de dados, uma mensagem será exibida informando ao usuário que a base de dados está inacessível; 
• E5: se o usuário não preencher os dados obrigatórios do boleto (banco, data de vencimento, modelo da guia, nosso número inicial e valor), uma mensagem será exibida informando ao usuário que os campos obrigatórios devem ser preenchidos; 
• E6: se os dados obrigatórios do(s) usuário(s)/filiado(s) para emissão de boleto não foram preenchidos (nome, logradouro, bairro, cidade, estado e CEP), o sistema lista na tela os usuário(s)/filiado(s) cujos dados obrigatórios não estão preenchidos e, para cada um, informa quais campos devem ser preenchidos. O usuário poderá prosseguir para a tela de marcação dos boletos que serão impressos (botão “prosseguir”), no entanto os boletos cujos dados não estão completos não aparecerão para seleção; 
• E7: se houver um estouro na numeração de boletos*, o sistema exibe uma mensagem solicitando ao usuário que entre em contato com a BISA pois houve um problema na geração da numeração do boleto. A operação não é finalizada. O sistema deve ainda efetuar todas as rotinas de rollback de modo a não deixar ‘lixo’ no banco de dados. 

<nowiki>*</nowiki> O estouro na numeração de boletos ocorre quando o limite do número de boletos cadastrado no banco de dados é atingido. Por exemplo, supondo um limite de 10 bytes, se o último registro cadastrado for 9999999999, o próximo registro de boleto irá acionar este erro. 

=[RF004] Imprimir boletos=
===Atores relacionados===
Usuário externo, Filiado FETAPE e Funcionário FETAPE.

===Objetivo===
Constitui a impressão de um boleto já gerado no sistema.

===Prioridade===
Essencial.

===Entradas e pré condições===
'''Entradas:''' lista de boletos para impressão. 
'''Pré-condições:''' o usuário deve estar logado no sistema na tela da listagem de boletos (RF002); os registros dos boletos devem estar armazenados no banco de dados e marcados como “não impresso”.

===Saídas e pós-condições===
'''Saídas:''' impressão dos boletos selecionados. 
'''Pós-Condições:''' registros dos boletos marcados no banco como “impresso”.

===Fluxo principal de eventos===
1. Usuário seleciona na Lista de boletos aqueles que deseja imprimir (check box) e clica no botão Imprimir (E1, E2, E3, E4, E5); 
2. Se o usuário houver selecionado apenas um boleto, o sistema imprime o boleto no navegador, permitindo ao usuário conferir seus dados. Depois disso, ele clica em um novo botão Imprimir e passa para o passo 3; 
3. Janela de impressão padrão é aberta (onde o usuário poderá selecionar impressora, quantidade de páginas, etc). Usuário confirma a impressão e o sistema envia os arquivos para a impressora (E6); 
4. Sistema marca no banco os boletos que foram impressos com o status “impresso” (E7); 
5. Sistema insere no log de boletos os registros com o status impresso com a justificativa “impresso pela função de impressão de boletos pelo usuário X:Y”, onde X corresponde ao código do usuário e Y ao seu nome. 
6. Sistema exibe uma mensagem de “Boletos impressos com sucesso”. 

===Fluxos de exceção===
• E1: se não houver conexão com a internet, uma mensagem será exibida informando que não é possível estabelecer uma conexão com a internet e solicitando ao usuário que verifique sua conexão; 
• E2: se o sistema não estiver disponível, uma mensagem será exibida informando que o serviço não está disponível e que o usuário deve tentar acessá-lo mais tarde; 
• E3: se o usuário não selecionar boletos, o sistema exibe uma mensagem solicitando ao usuário que selecione boletos para impressão; 
• E4: se na lista houver boletos que já foram pagos, o sistema exibe uma mensagem de erro informando que boletos pagos não podem ser reimpressos e cancela a operação; 
• E5: se houver boletos que já foram impressos, o sistema exibe um alerta informando que os boletos já foram impressos pelo sistema e serão reimpressos nesta operação; continua a executar normalmente; 
• E6: se houver um erro ao enviar os dados para a impressora, o sistema exibe uma mensagem avisando ao usuário que o sistema não conseguiu imprimir e solicitando que o mesmo verifique se a impressora está pronta para impressão; 
• E7: se houver um erro na alteração dos registros no banco de dados, uma mensagem será exibida informando que não foi possível marcar os boletos como impressos e solicitando ao usuário que tente novamente e que, caso o erro persista, entre em contato com a BISA. O sistema deve ainda efetuar todas as rotinas de rollback de modo a não deixar ‘lixo’ no banco de dados. 

=[RF005] Cadastro de filiado=
Atores relacionados
Filiado FETAPE e Funcionário FETAPE.

Objetivo
Cadastrar um filiado. As rotinas de ALTERAÇÃO e de EXCLUSÃO também estão contidas neste requisito para o Funcionário FETAPE.

Prioridade
Essencial.

Entradas e pré condições
Entradas: dados cadastrais do usuário.
Pré-condições: computador deve ter acesso à internet; servidor web disponível. Funcionário: usuário cadastrado no sistema.

Saídas e pós-condições
Saídas: mensagem avisando que o usuário foi cadastrado com sucesso.
Pós-Condições: usuário cadastrado no banco de dados.

Fluxo principal de eventos
1. Ator Filiado: a função “Cadastrar Filiado” é acionada pelo usuário no navegador web (E1, E2). Ator Funcionário: a função “Cadastrar Filiado” é acionada pelo usuário na tela de Listagem de Filiados (E1, E2).
2. Um formulário é aberto solicitando dados cadastrais: login, senha, nome, CPF, CNAE, bairro, cidade, UF, logradouro, CEP, categoria (seleção entre as opções arrendatário, assentado, meeiro, parceiro, posseiro, pequeno proprietário e outros) e apelido do filiado;
3. Usuário preenche os campos e confirma a operação (E3, E4, E5, E6);
4. Sistema insere os registros de log da situação no banco remoto com a justificava “cadastrado pelo usuário X:Y”, onde X corresponde ao login do usuário e Y corresponde ao seu nome;
5. Sistema retorna uma mensagem avisando que o usuário foi cadastrado com sucesso.

O sistema também apresenta as rotinas de ALTERAÇÃO, que por ser trivial e seguir um fluxo semelhante à rotina de inclusão não terá sua execução descrita aqui. Vale salientar que devem ser efetuados os devidos registros no log do sistema.

Filiado FETAPE
Ele possui também a funcionalidade EXCLUSÃO. Sua tela de ALTERAR é diferente. Nela, o usuário pode marcar um check box “óbito” para filiados que foram a óbito.

Fluxos de exceção
• E1: se não houver conexão com a internet, uma mensagem será exibida informando que não é possível estabelecer uma conexão com a internet e solicitando ao usuário que verifique sua conexão;
• E2: se o sistema não estiver disponível, uma mensagem será exibida informando que o serviço não está disponível e que o usuário deve tentar acessá-lo mais tarde;
• E3: se o login fornecido já estiver cadastrado no sistema, uma mensagem será exibida informando ao usuário que o login cadastrado já existe no sistema;
• E4: se o CPF do filiado for inválido, uma mensagem será exibida informando ao usuário que o CPF cadastrado é inválido. Vale salientar que o preenchimento deste campo é opcional;
• E5: se houver um erro na inserção dos registros no banco de dados, uma mensagem será exibida informando que não foi possível inserir os dados e solicitando ao usuário que tente novamente e que, caso o erro persista, entre em contato com a BISA. O sistema deve ainda efetuar todas as rotinas de rollback de modo a não deixar ‘lixo’ no banco de dados;
• E6: se os dados obrigatórios dos filiados não forem preenchidos (nome, logradouro, bairro, cidade, estado e CEP), o sistema emite uma mensagem de erro informando quais os campos obrigatórios não foram preenchidos.

[RF006] Listar filiados
Atores relacionados
Funcionário FETAPE.

Objetivo
Listar todos os filiados cadastrados no sistema.

Prioridade
Essencial.

Entradas e pré condições
Entradas: nenhuma.
Pré-condições: usuário logado no sistema; filiados armazenados no banco de dados.

Saídas e pós-condições
Saídas: lista de filiados.
Pós-condições: nenhuma.

Fluxo principal de eventos
1. Usuário clica no botão Filiados da barra de funções do sistema para acessar a Listagem de Filiados;
2. Sistema carrega da base de dados os filiados com seus respectivos dados (E1, E2, E3, E4);
3. É exibida a lista de filiados (com check boxes para seleção), cada um com seu número, nome, apelido, CPF, município, sindicato e categoria. Os filiados serão ordenados por ordem alfabética e agrupados por município. Também haverá uma check box que permite a seleção de todos os filiados listados na tela e um limite de filiados a serem exibidos, sendo os demais acessados por uma barra de próximo/anterior (semelhante a um esquema de web mail);
4. Através de uma caixa de seleção (combo box), o usuário pode filtrar os filiados que serão exibidos na tela de acordo com a opção: “nome/apelido/município/sindicato”. A opção “nome” é a padrão. Os filiados que foram a óbito serão exibidos com uma cor de linha de grid acinzentada e só serão exibidos se um check box “todos” for ativado.

Fluxos de exceção
• E1: se não houver conexão com a internet, uma mensagem será exibida informando que não é possível estabelecer uma conexão com a internet e solicitando ao usuário que verifique sua conexão;
• E2: se o sistema não estiver disponível, uma mensagem será exibida informando que o serviço não está disponível e que o usuário deve tentar acessá-lo mais tarde;
• E3: se o resultado da busca retornar vazio, uma mensagem será exibida informando ao usuário que não existem dados referentes à consulta realizada;
• E4: se o sistema não conseguir acessar a base de dados, uma mensagem será exibida informando ao usuário que a base de dados está inacessível.

[RF007] Cadastro de sindicato
Atores relacionados
Funcionário FETAPE.

Objetivo
Cadastrar um sindicato. As rotinas de ALTERAÇÃO e de EXCLUSÃO também estão contidas neste requisito.

Prioridade
Essencial.

Entradas e pré condições
Entradas: dados do sindicato; dados do Município (já presentes na base de dados, herdada do antigo sistema DOS TRAB_RUR).
Pré-condições: usuário logado no sistema.

Saídas e pós-condições
Saídas: mensagem avisando que o sindicato foi cadastrado com sucesso.
Pós-Condições: sindicato cadastrado no banco de dados.

Fluxo principal de eventos
1. Usuário clica no botão cadastrar na tela de Listagem de Sindicatos (E1, E2);
2. Um formulário é aberto solicitando dados cadastrais: nome, município, UF, endereço;
3. Usuário preenche os campos e confirma a operação (E3);
4. Sistema insere os registros de log da situação no banco remoto com a justificava “cadastrado pelo usuário X:Y”, onde X corresponde ao login do funcionário e Y corresponde ao seu nome;
5. Sistema retorna uma mensagem avisando que o sindicato foi cadastrado com sucesso.

Também haverá rotinas de alteração e de exclusão. O processo é trivial para ser descrito aqui. Vale salientar que devem ser efetuados os devidos registros no log do sistema.

Fluxos de exceção
• E1: se não houver conexão com a internet, uma mensagem será exibida informando que não é possível estabelecer uma conexão com a internet e solicitando ao usuário que verifique sua conexão;
• E2: se o sistema não estiver disponível, uma mensagem será exibida informando que o serviço não está disponível e que o usuário deve tentar acessá-lo mais tarde;
• E3: se houver um erro na inserção dos registros no banco de dados, uma mensagem será exibida informando que não foi possível inserir os dados e solicitando ao usuário que tente novamente e que, caso o erro persista, entre em contato com a BISA. O sistema deve ainda efetuar todas as rotinas de rollback de modo a não deixar ‘lixo’ no banco de dados;

[RF008] Listar sindicatos
Atores relacionados
Funcionário FETAPE.

Objetivo
Listar todos os sindicatos cadastrados no sistema.

Prioridade
Essencial.

Entradas e pré condições
Entradas: nenhuma.
Pré-condições: usuário logado no sistema; sindicatos armazenados no banco de dados.

Saídas e pós-condições
Saídas: lista de sindicatos.
Pós-condições: nenhuma.

Fluxo principal de eventos
1. Usuário clica no botão Sindicatos da barra de funções do sistema para acessar a Listagem de Sindicatos;
2. Sistema carrega da base de dados os sindicatos com seus respectivos dados (E1, E2, E3, E4);
3. É exibida a lista de sindicatos (com check boxes para seleção), cada um com seu número, nome e município. Os sindicatos serão ordenados por ordem alfabética e agrupados por município. Também haverá uma check box que permite a seleção de todos os sindicatos listados na tela e um limite de sindicatos a serem exibidos, sendo os demais acessados por uma barra de próximo/anterior (semelhante a um esquema de web mail);
4. Através de uma caixa de seleção (combo box), o usuário pode filtrar os sindicatos que serão exibidos na tela de acordo com a opção: “nome/município”. A opção “nome” é a padrão.

Fluxos de exceção
• E1: se não houver conexão com a internet, uma mensagem será exibida informando que não é possível estabelecer uma conexão com a internet e solicitando ao usuário que verifique sua conexão;
• E2: se o sistema não estiver disponível, uma mensagem será exibida informando que o serviço não está disponível e que o usuário deve tentar acessá-lo mais tarde;
• E3: se o resultado da busca retornar vazio, uma mensagem será exibida informando ao usuário que não existem dados referentes à consulta realizada;
• E4: se o sistema não conseguir acessar a base de dados, uma mensagem será exibida informando ao usuário que a base de dados está inacessível.

[RF009] Baixar Boleto
Atores relacionados
Funcionário FETAPE.

Objetivo
Baixa nos boletos que foram impressos. Eles passarão a ter o status de pago.

Prioridade
Essencial.

Entradas e pré condições
Entradas: lista de boletos para baixa.
Pré-condições: usuário logado no sistema; os registros dos boletos devem estar armazenados no banco de dados.

Saídas e pós-condições
Saídas: mensagem de aviso de sucesso da operação.
Pós-condições: registro dos boletos marcados no banco como “pagos”.

Fluxo principal de eventos
1. Usuário seleciona na Lista de boletos aqueles que deseja baixar (check box) e clica no botão Baixar (E1, E2, E3, E4, E5);
2. Sistema marca no banco os boletos como pagos (E6). Se o boleto não for encontrado na tabela de boletos, deverá ser procurado na tabela de boletos avulsos (E7);
3. Sistema insere no log de boletos os registros com o status impresso com a justificativa “baixado pela função de baixar de boletos pelo usuário X:Y”, onde X corresponde ao código do usuário e Y ao seu nome;
4. Sistema exibe uma mensagem de “Boletos baixados com sucesso”.

Fluxos de exceção
• E1: se não houver conexão com a internet, uma mensagem será exibida informando que não é possível estabelecer uma conexão com a internet e solicitando ao usuário que verifique sua conexão;
• E2: se o sistema não estiver disponível, uma mensagem será exibida informando que o serviço não está disponível e que o usuário deve tentar acessá-lo mais tarde;
• E3: se o usuário não selecionar boletos, o sistema exibe uma mensagem solicitando ao usuário que selecione boletos para impressão;
• E4: se na lista houver boletos com o status “pago”, o sistema exibe uma mensagem informando que boletos selecionados já foram baixados. Se o usuário clicar em continuar, o sistema continua a execução e ignora esses boletos;
• E5: se na lista houver boletos com o status diferente de “impresso” ou “enviado” (enviado para o banco), o sistema exibe uma mensagem informando que há boletos selecionados que ainda não foram impressos ou enviados para o banco e quais são estes boletos. Se o usuário clicar em continuar, o sistema continua a execução e ignora esses boletos;
• E6: se houver um erro na alteração dos registros no banco de dados, uma mensagem será exibida informando que não foi possível marcar os boletos como pagos e solicitando ao usuário que tente novamente e que, caso o erro persista, entre em contato com a BISA. O sistema deve ainda efetuar todas as rotinas de rollback de modo a não deixar ‘lixo’ no banco de dados;
• E7: se o registro do boleto não for encontrado no banco, o sistema exibirá uma mensagem de erro indicando que o boleto não foi encontrado na base de dados do sistema.

[RF010] Baixar Boleto Automaticamente (via Arquivo de Retorno do Banco)
Atores relacionados
Funcionário FETAPE.

Objetivo
Baixar de boletos a partir de um arquivo de retorno que o banco envia.

Prioridade
Essencial.

Entradas e pré condições
Entradas: arquivo de retorno do banco.
Pré-condições: usuário logado no sistema; os registros dos boletos devem estar armazenados no banco de dados.

Saídas e pós-condições
Saídas: mensagem de sucesso da operação.
Pós-condições: registro dos boletos marcados no banco como “pagos”.

Fluxo principal de eventos
1. Na tela da Lista de boletos, usuário clica na opção Baixa com Arquivo do Banco (E1, E2);
2. Uma tela é aberta perguntando qual o arquivo de retorno do banco. O usuário então seleciona o caminho no seu computador correspondente à localização do arquivo e clica em OK. O sistema irá, então, fazer o upload do arquivo (E3, E4, E5);
3. Sistema guarda a identificação do arquivo de retorno com situação de ‘não processado’ na base de dados e guarda uma cópia do arquivo em diretório especifico para histórico;
4. Para cada linha do arquivo de retorno, o sistema procura o boleto referente na base de dados de boletos de contribuição. Se o boleto não for encontrado, o sistema procura na base de dados de boletos avulsos. Nesta base, há registros de boletos com intervalos (ex. de 001 a 100). O sistema irá buscar o número do boleto nessa faixa (E6);
5. O sistema verifica se o boleto encontrado está marcado como “impresso” ou “enviado” (para o banco). Se estiver, o sistema marca no banco de dados o boleto como “pago” (E7);
6. O sistema insere no log de boletos o registro com situação de “pago” com a justificativa ‘baixado pela função de baixa automática de boleto pelo usuário X:Y’, onde X corresponde ao login de usuário e Y corresponde ao seu nome;
7. O Sistema marca o arquivo de retorno como ‘processado sem erros’ e uma exibe mensagem confirmando o sucesso na baixa dos boletos.

Fluxos de exceção
• E1: se não houver conexão com a internet, uma mensagem será exibida informando que não é possível estabelecer uma conexão com a internet e solicitando ao usuário que verifique sua conexão;
• E2: se o sistema não estiver disponível, uma mensagem será exibida informando que o serviço não está disponível e que o usuário deve tentar acessá-lo mais tarde;
• E3: se o usuário não apontar nenhum arquivo de retorno, uma mensagem será exibida exigindo que o usuário aponte o arquivo;
• E4: se o caminho para o arquivo estiver incorreto, o sistema exibe uma mensagem para o usuário informando que o caminho selecionado é inválido;
• E5: se o formato do arquivo não corresponder ao formato do arquivo de retorno do banco esperado, o sistema exibirá uma mensagem informando que o formato do arquivo selecionado é inválido;
• E6: se um registro do arquivo não for encontrado no sistema (base principal e base de boletos avulsos), será exibido numa tela todos os registros que não foram encontrados. A situação do arquivo de retorno no banco deve então mudar para “processado com erro” e o sistema deve inserir o registro de log de boleto com a justificativa “boleto não pode ser baixado, pois o mesmo não foi encontrado no sistema. Ação executada pelo usuário X:Y”, onde X é o login e Y é o nome. O valor do boleto pago e não encontrado deverá ser armazenado na tabela de boletos no registro cujo identificador é “BoletoXXXX”. Todo boleto que não for encontrado deverá ser somado ao valor desse registro;
• E7: se houver um erro na alteração dos registros no banco de dados, uma mensagem será exibida informando que não foi possível marcar os boletos como “pago” e solicitando ao usuário que tente novamente e que, caso o erro persista, entre em contato com a BISA. O sistema deve ainda efetuar todas as rotinas de rollback de modo a não deixar ‘lixo’ no banco de dados.

[RF011] Gerar arquivo de remessa para banco
Atores relacionados
Funcionário FETAPE.

Objetivo
Gerar arquivo de remessa de boletos para o banco.

Prioridade
Essencial.

Entradas e pré condições
Entradas: lista de boletos que serão enviados para o arquivo.
Pré-condições: usuário logado no sistema; os registros dos boletos devem estar armazenados no banco de dados com o status “gerado” ou “impresso”.

Saídas e pós-condições
Saídas: mensagem de sucesso da operação; arquivo de remessa para o banco.
Pós-condições: boletos marcados com o status “enviado” no banco na base de dados.

Fluxo principal de eventos
1. Na tela de Listagem de Boletos, o usuário seleciona os boletos e clica no botão Gerar de arquivo de remessa (E1, E2);
2. Sistema verifica se todos os boletos selecionados estão marcados como “gerado” ou “impresso” (E3);
3. Sistema abre tela para que o usuário informe o nome do arquivo e o local onde ele será gerado (E4, E5);
4. Usuário confirma a geração do arquivo;
5. Sistema gera o arquivo de remessa;
6. Sistema marca no banco os boletos que foram inseridos no arquivo de remessa com o status de “enviado” para o banco (E6);
7. Sistema insere no log de boletos os registros com situação de enviado com a justificativa “boleto gerado no arquivo de remessa para o banco pelo usuário X:Y”, onde X corresponde ao login do usuário e Y corresponde ao seu nome;
8. Sistema salva em diretório especifico no banco uma cópia do arquivo gerado para remessa para fins de histórico;
9. Sistema retorna o arquivo de remessa para que o usuário salve-o em seu computador.

Fluxos de exceção
• E1: se não houver conexão com a internet, uma mensagem será exibida informando que não é possível estabelecer uma conexão com a internet e solicitando ao usuário que verifique sua conexão;
• E2: se o sistema não estiver disponível, uma mensagem será exibida informando que o serviço não está disponível e que o usuário deve tentar acessá-lo mais tarde;
• E3: se o sistema não encontrar nenhum arquivo com o status “gerado” ou “impresso”, uma mensagem será exibida informando que não existem boletos a serem gerados para o arquivo de remessa. Se encontrar, deverá informar quais os boletos não serão gerados no arquivo;
• E4: se o usuário informa um local não existente, o sistema pergunta ao usuário se o mesmo deseja que o sistema crie o diretório de pastas informado. Se a resposta for sim, sistema cria diretório de pasta; se a resposta for não, sistema retorna a tela de informação do local para que o usuário selecione um novo diretório;
• E5: se houver um erro na geração do arquivo de remessa, uma mensagem será exibida informando ao usuário que o arquivo de remessa não pode ser gerado e que o mesmo tente novamente e que, caso o erro persista, entre em contato com a BISA.;
• E6: se houver um erro na alteração dos registros no banco de dados, uma mensagem será exibida informando que não foi possível marcar os boletos como “enviado” e solicitando ao usuário que tente novamente e que, caso o erro persista, entre em contato com a BISA. O sistema deve ainda efetuar todas as rotinas de rollback de modo a não deixar ‘lixo’ no banco de dados.

[RF012] Gerar arquivo de remessa para Gráfica
Atores relacionados
Funcionário FETAPE.

Objetivo
Gerar arquivo de remessa de boletos para Gráfica.

Prioridade
Essencial.

Entradas e pré condições
Entradas: lista de boletos que serão enviados para o arquivo.
Pré-condições: usuário logado no sistema; os registros dos boletos devem estar armazenados no banco de dados com o status “gerado”.

Saídas e pós-condições
Saídas: mensagem de sucesso da operação; arquivo de remessa para a gráfica (em formato txt e xls).
Pós-condições: boletos marcados com o status “enviadoGrafica” no banco na base de dados.

Fluxo principal de eventos
1. Na tela de Listagem de Boletos, o usuário seleciona os boletos e clica no botão Gerar arquivo de boleto para Gráfica (E1, E2);
2. Sistema verifica se todos os boletos selecionados estão marcados como “gerado” (E3);
3. Sistema abre tela para que o usuário informe o nome do arquivo e o local onde ele será gerado (E4, E5);
4. Usuário confirma a geração do arquivo;
5. Sistema pergunta se o usuário quer gerar o arquivo no formato txt ou xls;
6. Sistema gera o arquivo de remessa para Gráfica;
7. Sistema marca no banco os boletos que foram inseridos no arquivo de remessa com o status de “enviadoGrafica” para o banco (E6);
8. Sistema insere no log de boletos os registros com situação de enviado com a justificativa “boleto gerado no arquivo de remessa para Gráfica pelo usuário X:Y”, onde X corresponde ao login do usuário e Y corresponde ao seu nome;
9. Sistema salva em diretório especifico no banco uma cópia do arquivo gerado para remessa para Gráfica para fins de histórico;
10. Sistema retorna o arquivo para que o usuário salve-o em seu computador.

Fluxos de exceção
• E1: se não houver conexão com a internet, uma mensagem será exibida informando que não é possível estabelecer uma conexão com a internet e solicitando ao usuário que verifique sua conexão;
• E2: se o sistema não estiver disponível, uma mensagem será exibida informando que o serviço não está disponível e que o usuário deve tentar acessá-lo mais tarde;
• E3: se o sistema não encontrar nenhum arquivo com o status “gerado”, uma mensagem será exibida informando que não existem boletos a serem gerados para o arquivo de remessa. Se encontrar, deverá informar quais os boletos não serão gerados no arquivo;
• E4: se o usuário informa um local não existente, o sistema pergunta ao usuário se o mesmo deseja que o sistema crie o diretório de pastas informado. Se a resposta for sim, sistema cria diretório de pasta; se a resposta for não, sistema retorna a tela de informação do local para que o usuário selecione um novo diretório;
• E5: se houver um erro na geração do arquivo de remessa, uma mensagem será exibida informando ao usuário que o arquivo de remessa não pode ser gerado e que o mesmo tente novamente e que, caso o erro persista, entre em contato com a BISA;
• E6: se houver um erro na alteração dos registros no banco de dados, uma mensagem será exibida informando que não foi possível marcar os boletos como “enviado” e solicitando ao usuário que tente novamente e que, caso o erro persista, entre em contato com a BISA. O sistema deve ainda efetuar todas as rotinas de rollback de modo a não deixar ‘lixo’ no banco de dados.

4 Especificações Suplementares
4.1 Objetivos
Este documento tem como finalidade especificar todos os requisitos não funcionais do módulo de boletos web divididos em requisitos de usabilidade, confiabilidade, desempenho, segurança, distribuição, adequação a padrões e requisitos de hardware e software.
4.2 Usabilidade
Esta seção descreve os requisitos não funcionais associados à facilidade de uso da interface com o usuário, material de treinamento e documentação do sistema.
[NF001] Interface com o Usuário
Prioridade: Desejável
O sistema deve possuir uma interface amigável, simples e intuitiva.
4.3 Confiabilidade
Esta seção descreve os requisitos não funcionais associados à freqüência, severidade de falhas do sistema e habilidade de recuperação das mesmas, bem como a corretude do sistema.
[NF001] Tempo de Retorno após Falha
Prioridade: Desejável
Retorno de até 5 segundos após alguma falha.
[NF002] Disponibilidade
Prioridade: Importante
O sistema estará disponível 24 horas por dia durante todos os dias do ano.
4.4 Desempenho
Esta seção descreve os requisitos não funcionais associados à eficiência, uso de recursos e tempo de resposta do sistema.
[NF001] Número de Acessos
O sistema deve ser capaz de atender em média 10 usuários por segundo nos momentos de pico de acesso.
[NF002] Tempo de Resposta para os Usuários
O tempo máximo de resposta de uma requisição deve ser de no máximo 10 segundos.

4.5 Segurança
Esta seção descreve os requisitos não funcionais associados à integridade, privacidade e autenticidade dos dados do sistema.
[NF001] Privacidade de Acesso
Apenas os usuários credenciados e com permissão para acesso a este módulo deverão fazer uso das funcionalidades do módulo de boletos/guias na Web.
4.6 Hardware e software
Esta seção descreve os requisitos não funcionais associados ao hardware e software usados para desenvolver ou para executar o sistema.
[NF001] Linguagem de Implementação
Prioridade: Essencial
A linguagem de implementação do módulo de boleto Web será Delphi, mesma linguagem utilizada no desenvolvimento dos sistemas Partidos2000, Receb2000, OAB2000 e Filiados2000.
[NF002] Banco de Dados
Prioridade: Essencial
O banco de dados utilizado será o MySQL.
[NF003] Ferramentas
Prioridade: Essencial
Ferramenta de modelagem: Borland Delphi 2006
Ferramenta de Desenvolvimento: Borland Delphi 2006
[NF004] Plataforma de Funcionamento
Prioridade: Essencial
A plataforma tanto de desenvolvimento e de funcionamento será Windows.

Arquivo:Historico de revisoes.PNG

2013-01-22T13:31:11Z

AnaPaula:

Para uso do Bw- Construindo

2013-01-22T13:27:30Z

AnaPaula: /* Fluxos de exceção */

[[Arquivo:BoletosWeb.PNG]]

=1. Caso de Negócio=
==1.1 Objetivos==

Documentar o novo módulo de geração e impressão de boletos online. As informações aqui descritas especificam e refinam a regras de negócio.

==1.2 Referências==

Se baseará no conhecimento adquirido na implementação de rotinas de boletos da BISA (desktop) e no antigo sistema TRAB_RUR da BISA, em DOS. A entrevista com Mário e Márcio da FETAPE (realizada por Ronaldo e Alexandre) também é referência para a definição dos requisitos.

==1.3 Sistemas com rotinas de gerenciamento de boletos da BISA==

O Filiados 2000 é um sistema desktop de gestão de filiados que controla o cadastro de filiados dos sindicatos de trabalhadores, fazendo acompanhamento de participação na organização.

O OAB 2000 é um software de gestão de cadastro de advogados para OAB's. Faz desde o cadastro de alunos, pré-inscritos, coordena sociedades de advogados, estagiários, até a administração dos dados financeiros dos advogados.

O Receb 2000 é um software voltado para o acompanhamento do contas a receber de uma empresa, fazendo a gestão financeira da carteira de forma simples e eficiente.

Todos esses sistemas possuem uma função de gerenciamento de boletos bancários ou guias sindicais, sendo salvos de forma centralizada no MySQL, de forma que podem ser acessados de forma uniforme no BoletoWEB.

Cada sistema contém suas próprias regras de negócio para gerenciar os boletos; no entanto, as funções de acesso ao banco remoto serão padronizadas para todos os sistemas no BoletoWEB.

==1.4 Descrição do Produto==

A maior parte da implementação é voltada para a FETAPE, enquanto o restante imprime boletos gerados pelos nossos sistema desktop.

Módulo Geral: este módulo tem a função meramente de fornecer uma interface web que permita ao usuário imprimir boletos gerados pelos sistemas desktop da BISA.

Módulo FETAPE: no antigo sistema TRAB_RUR da BISA, este sistema é o foco principal desta documentação. Nela o usuário poderá gerenciar todo o fluxo de boletos de contribuições: geração, impressão interna, cadastro de filiados, acesso on-line dos filiados, etc.

==1.5 Contexto de Negócio==

O módulo geral de boletos na web será utilizado a princípio pelos sistemas Receb2000, OAB2000 e Filiados2000, porém poderá ser extendido a qualquer sistema que queira fazer o controle de boletos/guias.

Este módulo concentrará as informações dos boletos em um único local independente de entidade ou sistema. Este local, a priori, ficou definido como sendo um dos servidores internos da BISA que possua acesso externo. Cada sistema rodará normalmente no ambiente do cliente. No momento que for necessário o acesso às informações, este será feito não mais na base local da área do cliente, mas na base remota situada na BISA.

O módulo FETAPE segue as mesmas diretrizes, tendo a diferença de ser implementado exclusivamente para esta entidade, devendo ser adaptável para outras entidades. Para tanto, aconselha-se o uso de uma arquitetura em camadas e padrões de projetos, facilitadores do processos de manutenção.

==1.6 Tecnologias utilizadas==

Os módulos geral e FETAPE deverão implementados utilizando uma tecnologia para web: PHP, Java ou .NET.

O banco de dados necessariamente deverá ser o MySQL, pois já é utilizado na bisa para o registro de boletos.

=2. Sobre os Requisitos=
==2.1 Introdução==

Este documento especifica todos os requisitos funcionais e não funcionais do módulo de gerenciamento de boletos, descrevendo os fluxos de eventos, prioridades, atores, entradas e saídas de cada caso de uso a ser implementado.

A correta interpretação deste documento exige o conhecimento de algumas convenções e termos específicos, que são descritos a seguir.

==2.2 Identificação dos Requisitos==

Por convenção, a referência a requisitos é feita através do nome da subseção onde eles estão descritos, seguidos do identificador do requisito, de acordo com o esquema abaixo:

[nome da subseção, identificador do requisito]

Por exemplo, o requisito funcional [Imprimir Boleto RF002] está descrito em um caso de uso chamado “Imprimir Boleto”, em um bloco identificado pelo identificador [RF002].

==2.3 Prioridades dos Requisitos==

Para estabelecer a prioridade dos requisitos foram adotadas as denominações “essencial”, “importante” e “desejável”. 
• Essencial é o requisito sem o qual o sistema não entra em funcionamento. São requisitos imprescindíveis, que têm que ser implementados. 
• Importante é o requisito sem o qual o sistema entra em funcionamento, mas de forma não satisfatória. Requisitos importantes devem ser implementados, mas, se não forem, o sistema poderá ser implantado e usado mesmo assim. 
• Desejável é o requisito que não compromete as funcionalidades básicas do sistema, isto é, o sistema pode funcionar de forma satisfatória sem ele. Requisitos desejáveis são requisitos que podem ser deixados para versões posteriores do sistema, caso não haja tempo hábil para implementá-los na versão que está sendo especificada. 

==2.4 Descrição dos Atores==

'''Usuário externo'''
É a pessoa que acessa a funcionalidade de impressão de boletos do módulo geral pelo browser.

Filiado FETAPE
Semelhante ao usuário comum, com a diferença de que terá a opção de se cadastrar pelo site.

Funcionário FETAPE
É responsável pelo gerenciamento dos boletos. É o ator principal deste sistema.

=3 Requisitos Funcionais (Casos de Uso)=
==3.1 Ações do Usuário==

==[RF001] Efetuar login==
Atores relacionados
Usuário externo, Filiado FETAPE e Funcionário FETAPE.

===Objetivo===
Fazer login no módulo Web de impressão de boletos.

===Prioridade===
Essencial.

===Entradas e pré condições===
'''Entradas:''' login do usuário e senha;
'''Pré-condições:''' computador deve ter acesso à internet; servidor web disponível.

===Saídas e pós-condições===
'''Saídas:''' não há
'''Pós-condições:''' usuário logado no sistema.

===Fluxo principal de eventos===
1. Usuário executa seu web browser e acessa a página de login (E1, E2); 
2. Usuário informa login e senha e clica em Entrar (E3); 
3. Sistema recupera na base de dados a senha do usuário com o login informado; 
4. Sistema verifica se o login está cadastrado (E4); 
5. Sistema verifica se a senha informada corresponde ao login informado (E5); 
6. Sistema libera o acesso após o sucesso da verificação; 
7. Includes [RF002]. 

===Fluxos de exceção===
• E1: se não houver conexão com a internet, uma mensagem será exibida informando que não é possível estabelecer uma conexão com a internet e solicitando ao usuário que verifique sua conexão; 
• E2: se o sistema não estiver disponível, uma mensagem será exibida informando que o serviço não está disponível e que o usuário deve tentar acessá-lo mais tarde; 
• E3: se o usuário não informar o login ou a senha, o sistema solicita que informe o login e a senha; 
• E4: se o login não estiver cadastrado, o sistema emite uma mensagem de erro informando que este usuário não está cadastrado e solicitando que o mesmo verifique se o login foi digitado corretamente; 
• E5: se a senha não conferir com a que está armazenada na base de dados, o sistema emite uma mensagem de erro avisando que a senha informada está incorreta e solicitando que o mesmo verifique se ela foi digitada corretamente. 

==[RF002] Listar boletos==
===Atores relacionados===
Usuário externo, Filiado FETAPE e Funcionário FETAPE.

===Objetivo===
Listar os boletos correspondentes ao usuário logado.

===Prioridade===
Essencial.

===Entradas e pré condições===
'''Entradas:''' nenhuma.
'''Pré-condições:''' usuário logado no sistema; boletos armazenados no banco de dados.

===Saídas e pós-condições===
'''Saídas:''' lista de boletos.
'''Pós-condições:''' nenhuma.

===Fluxo principal de eventos===
1. Sistema carrega da base de dados os boletos referentes ao usuário (E1, E2, E3); 
2. É exibida a lista de boletos (com check boxes para seleção), cada um com seu número, descrição, valor, vencimento e status (pendente/atrasado/impresso/pago). Os boletos serão ordenados de forma decrescente (maior para o menor) por data de vencimento na lista. Também haverá uma check box que permite a seleção de todos os boletos listados na tela e um limite de boletos a serem exibidos, sendo os demais boletos acessados por uma barra de próximo/anterior (semelhante a um esquema de web mail); 
3. Através de uma caixa de seleção (combo box), o usuário pode filtrar os boletos que serão exibidos na tela de acordo com a opção: “pendentes/impressos/pagos/todos”. Os boletos com status “atrasado” ficarão na lista de “pendentes” e “todos”, mas com uma cor de linha de grid que os diferencie dos demais (ex. vermelho). O status inicial do filtro é “pendentes”. 

===Fluxos de exceção===
• E1: se não houver conexão com a internet, uma mensagem será exibida informando que não é possível estabelecer uma conexão com a internet e solicitando ao usuário que verifique sua conexão; 
• E2: se o sistema não estiver disponível, uma mensagem será exibida informando que o serviço não está disponível e que o usuário deve tentar acessá-lo mais tarde; 
• E3: se o resultado da busca retornar vazio, uma mensagem será exibida informando ao usuário que não existe dados referentes à consulta realizada. 

=[RF003] Geração de boletos=
===Atores relacionados===
Usuário externo, Filiado FETAPE e Funcionário FETAPE.

===Objetivo===
Gerar registros de boletos no banco de dados para impressão. Não constitui a impressão do boleto em si.

===Prioridade===
Essencial.

===Entradas e pré condições===
'''Entradas:''' filiado(s)/usuário(s), banco, data de vencimento, modelo da guia, nosso número inicial, valor e instruções.
'''Pré-condições:''' usuário logado no sistema; sindicatos e filiados armazenados no banco de dados.

===Saídas e pós-condições===
'''Saídas:''' mensagem de aviso de sucesso da operação. 
'''Pós-condições:''' registro dos boletos inseridos no banco de dados.

===Fluxo principal de eventos===
1. Usuário Externo e Filiado FETAPE: usuário clica no botão Gerar Boletos. Se o usuário estiver com o status óbito, não será gerado boleto. Funcionário FETAPE: funcionário seleciona uma quantidade de filiados na tela de Listagem de Filiados e clica no botão Gerar Boletos. Os filiados com o status “óbito” nunca serão carregados; 
2. Sistema carrega o(s) usuários(s)/filiado(s) selecionados com seus respectivos dados (E1, E2, E3, E4); 
3. Uma janela é aberta perguntando se o usuário deseja imprimir boletos referentes a Contribuição Sindical e Contribuição Confederativa (2 check boxes); 
4. Uma tela é aberta onde o usuário informa os dados (banco, data de vencimento, modelo da guia, nosso número inicial, valor e instruções) para os boletos. Usuário confirma a operação; 
5. Sistema valida os dados inseridos pelo usuário e os dados obrigatórios para emissão de boleto (E5, E6); 
6. Sistema gera os boletos e os armazena no banco de dados com o status “gerado” (E7). O sistema deverá verificar se o número de boleto que ele irá gerar existe em algum intervalo na tabela de boletos avulso. Se existir, ele deverá gerar um próximo número que não esteja em um intervalo desta tabela; 
7. Sistema insere os registros de log da situação dos boletos no banco remoto com a justificava “gerado a partir da função de geração de boleto pelo usuário X:Y”, onde X corresponde ao login do funcionário e Y corresponde ao seu nome; 
8. Sistema exibe mensagem confirmando o sucesso na geração dos boletos e perguntando se o usuário deseja fazer a impressão dos mesmos; 
9. Se o usuário responder que sim, a janela de impressão padrão da funcionalidade imprimir é aberta. Includes [RF004]. 

===Filiado FETAPE===
Este usuário também terá acesso à rotina de CANCELAMENTO do boleto, que consiste meramente na exclusão do mesmo da base de dados. Vale salientar que devem ser efetuados os devidos registros no log do sistema seguindo o padrão supracitado, assim como devem ser atendidos os seguintes fluxos de exceção: 
1. Se o boleto possuir o status “pago”, “impresso” ou “enviado” (para o banco), o cancelamento não será permitido. O sistema exibirá uma mensagem de erro avisando que o boleto não pode ser impresso, indicando o seu status atual; 
2. Se o boleto requisitado não puder ser excluído, o sistema exibe uma mensagem de erro solicitando que o boleto não poder ser removido no momento. 

===Fluxos de exceção===
• E1: se não houver conexão com a internet, uma mensagem será exibida informando que não é possível estabelecer uma conexão com a internet e solicitando ao usuário que verifique sua conexão; 
• E2: se o sistema não estiver disponível, uma mensagem será exibida informando que o serviço não está disponível e que o usuário deve tentar acessá-lo mais tarde; 
• E3: se o resultado da busca retornar vazio, uma mensagem será exibida informando ao usuário que não existem dados referentes à consulta realizada; 
• E4: se o sistema não conseguir acessar a base de dados, uma mensagem será exibida informando ao usuário que a base de dados está inacessível; 
• E5: se o usuário não preencher os dados obrigatórios do boleto (banco, data de vencimento, modelo da guia, nosso número inicial e valor), uma mensagem será exibida informando ao usuário que os campos obrigatórios devem ser preenchidos; 
• E6: se os dados obrigatórios do(s) usuário(s)/filiado(s) para emissão de boleto não foram preenchidos (nome, logradouro, bairro, cidade, estado e CEP), o sistema lista na tela os usuário(s)/filiado(s) cujos dados obrigatórios não estão preenchidos e, para cada um, informa quais campos devem ser preenchidos. O usuário poderá prosseguir para a tela de marcação dos boletos que serão impressos (botão “prosseguir”), no entanto os boletos cujos dados não estão completos não aparecerão para seleção; 
• E7: se houver um estouro na numeração de boletos*, o sistema exibe uma mensagem solicitando ao usuário que entre em contato com a BISA pois houve um problema na geração da numeração do boleto. A operação não é finalizada. O sistema deve ainda efetuar todas as rotinas de rollback de modo a não deixar ‘lixo’ no banco de dados. 

<nowiki>*</nowiki> O estouro na numeração de boletos ocorre quando o limite do número de boletos cadastrado no banco de dados é atingido. Por exemplo, supondo um limite de 10 bytes, se o último registro cadastrado for 9999999999, o próximo registro de boleto irá acionar este erro. 

=[RF004] Imprimir boletos=
===Atores relacionados===
Usuário externo, Filiado FETAPE e Funcionário FETAPE.

===Objetivo===
Constitui a impressão de um boleto já gerado no sistema.

===Prioridade===
Essencial.

===Entradas e pré condições===
'''Entradas:''' lista de boletos para impressão. 
'''Pré-condições:''' o usuário deve estar logado no sistema na tela da listagem de boletos (RF002); os registros dos boletos devem estar armazenados no banco de dados e marcados como “não impresso”.

===Saídas e pós-condições===
'''Saídas:''' impressão dos boletos selecionados. 
'''Pós-Condições:''' registros dos boletos marcados no banco como “impresso”.

===Fluxo principal de eventos===
1. Usuário seleciona na Lista de boletos aqueles que deseja imprimir (check box) e clica no botão Imprimir (E1, E2, E3, E4, E5); 
2. Se o usuário houver selecionado apenas um boleto, o sistema imprime o boleto no navegador, permitindo ao usuário conferir seus dados. Depois disso, ele clica em um novo botão Imprimir e passa para o passo 3; 
3. Janela de impressão padrão é aberta (onde o usuário poderá selecionar impressora, quantidade de páginas, etc). Usuário confirma a impressão e o sistema envia os arquivos para a impressora (E6); 
4. Sistema marca no banco os boletos que foram impressos com o status “impresso” (E7); 
5. Sistema insere no log de boletos os registros com o status impresso com a justificativa “impresso pela função de impressão de boletos pelo usuário X:Y”, onde X corresponde ao código do usuário e Y ao seu nome. 
6. Sistema exibe uma mensagem de “Boletos impressos com sucesso”. 

===Fluxos de exceção===
• E1: se não houver conexão com a internet, uma mensagem será exibida informando que não é possível estabelecer uma conexão com a internet e solicitando ao usuário que verifique sua conexão; 
• E2: se o sistema não estiver disponível, uma mensagem será exibida informando que o serviço não está disponível e que o usuário deve tentar acessá-lo mais tarde; 
• E3: se o usuário não selecionar boletos, o sistema exibe uma mensagem solicitando ao usuário que selecione boletos para impressão; 
• E4: se na lista houver boletos que já foram pagos, o sistema exibe uma mensagem de erro informando que boletos pagos não podem ser reimpressos e cancela a operação; 
• E5: se houver boletos que já foram impressos, o sistema exibe um alerta informando que os boletos já foram impressos pelo sistema e serão reimpressos nesta operação; continua a executar normalmente; 
• E6: se houver um erro ao enviar os dados para a impressora, o sistema exibe uma mensagem avisando ao usuário que o sistema não conseguiu imprimir e solicitando que o mesmo verifique se a impressora está pronta para impressão; 
• E7: se houver um erro na alteração dos registros no banco de dados, uma mensagem será exibida informando que não foi possível marcar os boletos como impressos e solicitando ao usuário que tente novamente e que, caso o erro persista, entre em contato com a BISA. O sistema deve ainda efetuar todas as rotinas de rollback de modo a não deixar ‘lixo’ no banco de dados. 

=[RF005] Cadastro de filiado=
Atores relacionados
Filiado FETAPE e Funcionário FETAPE.

Objetivo
Cadastrar um filiado. As rotinas de ALTERAÇÃO e de EXCLUSÃO também estão contidas neste requisito para o Funcionário FETAPE.

Prioridade
Essencial.

Entradas e pré condições
Entradas: dados cadastrais do usuário.
Pré-condições: computador deve ter acesso à internet; servidor web disponível. Funcionário: usuário cadastrado no sistema.

Saídas e pós-condições
Saídas: mensagem avisando que o usuário foi cadastrado com sucesso.
Pós-Condições: usuário cadastrado no banco de dados.

Fluxo principal de eventos
1. Ator Filiado: a função “Cadastrar Filiado” é acionada pelo usuário no navegador web (E1, E2). Ator Funcionário: a função “Cadastrar Filiado” é acionada pelo usuário na tela de Listagem de Filiados (E1, E2).
2. Um formulário é aberto solicitando dados cadastrais: login, senha, nome, CPF, CNAE, bairro, cidade, UF, logradouro, CEP, categoria (seleção entre as opções arrendatário, assentado, meeiro, parceiro, posseiro, pequeno proprietário e outros) e apelido do filiado;
3. Usuário preenche os campos e confirma a operação (E3, E4, E5, E6);
4. Sistema insere os registros de log da situação no banco remoto com a justificava “cadastrado pelo usuário X:Y”, onde X corresponde ao login do usuário e Y corresponde ao seu nome;
5. Sistema retorna uma mensagem avisando que o usuário foi cadastrado com sucesso.

O sistema também apresenta as rotinas de ALTERAÇÃO, que por ser trivial e seguir um fluxo semelhante à rotina de inclusão não terá sua execução descrita aqui. Vale salientar que devem ser efetuados os devidos registros no log do sistema.

Filiado FETAPE
Ele possui também a funcionalidade EXCLUSÃO. Sua tela de ALTERAR é diferente. Nela, o usuário pode marcar um check box “óbito” para filiados que foram a óbito.

Fluxos de exceção
• E1: se não houver conexão com a internet, uma mensagem será exibida informando que não é possível estabelecer uma conexão com a internet e solicitando ao usuário que verifique sua conexão;
• E2: se o sistema não estiver disponível, uma mensagem será exibida informando que o serviço não está disponível e que o usuário deve tentar acessá-lo mais tarde;
• E3: se o login fornecido já estiver cadastrado no sistema, uma mensagem será exibida informando ao usuário que o login cadastrado já existe no sistema;
• E4: se o CPF do filiado for inválido, uma mensagem será exibida informando ao usuário que o CPF cadastrado é inválido. Vale salientar que o preenchimento deste campo é opcional;
• E5: se houver um erro na inserção dos registros no banco de dados, uma mensagem será exibida informando que não foi possível inserir os dados e solicitando ao usuário que tente novamente e que, caso o erro persista, entre em contato com a BISA. O sistema deve ainda efetuar todas as rotinas de rollback de modo a não deixar ‘lixo’ no banco de dados;
• E6: se os dados obrigatórios dos filiados não forem preenchidos (nome, logradouro, bairro, cidade, estado e CEP), o sistema emite uma mensagem de erro informando quais os campos obrigatórios não foram preenchidos.

[RF006] Listar filiados
Atores relacionados
Funcionário FETAPE.

Objetivo
Listar todos os filiados cadastrados no sistema.

Prioridade
Essencial.

Entradas e pré condições
Entradas: nenhuma.
Pré-condições: usuário logado no sistema; filiados armazenados no banco de dados.

Saídas e pós-condições
Saídas: lista de filiados.
Pós-condições: nenhuma.

Fluxo principal de eventos
1. Usuário clica no botão Filiados da barra de funções do sistema para acessar a Listagem de Filiados;
2. Sistema carrega da base de dados os filiados com seus respectivos dados (E1, E2, E3, E4);
3. É exibida a lista de filiados (com check boxes para seleção), cada um com seu número, nome, apelido, CPF, município, sindicato e categoria. Os filiados serão ordenados por ordem alfabética e agrupados por município. Também haverá uma check box que permite a seleção de todos os filiados listados na tela e um limite de filiados a serem exibidos, sendo os demais acessados por uma barra de próximo/anterior (semelhante a um esquema de web mail);
4. Através de uma caixa de seleção (combo box), o usuário pode filtrar os filiados que serão exibidos na tela de acordo com a opção: “nome/apelido/município/sindicato”. A opção “nome” é a padrão. Os filiados que foram a óbito serão exibidos com uma cor de linha de grid acinzentada e só serão exibidos se um check box “todos” for ativado.

Fluxos de exceção
• E1: se não houver conexão com a internet, uma mensagem será exibida informando que não é possível estabelecer uma conexão com a internet e solicitando ao usuário que verifique sua conexão;
• E2: se o sistema não estiver disponível, uma mensagem será exibida informando que o serviço não está disponível e que o usuário deve tentar acessá-lo mais tarde;
• E3: se o resultado da busca retornar vazio, uma mensagem será exibida informando ao usuário que não existem dados referentes à consulta realizada;
• E4: se o sistema não conseguir acessar a base de dados, uma mensagem será exibida informando ao usuário que a base de dados está inacessível.

[RF007] Cadastro de sindicato
Atores relacionados
Funcionário FETAPE.

Objetivo
Cadastrar um sindicato. As rotinas de ALTERAÇÃO e de EXCLUSÃO também estão contidas neste requisito.

Prioridade
Essencial.

Entradas e pré condições
Entradas: dados do sindicato; dados do Município (já presentes na base de dados, herdada do antigo sistema DOS TRAB_RUR).
Pré-condições: usuário logado no sistema.

Saídas e pós-condições
Saídas: mensagem avisando que o sindicato foi cadastrado com sucesso.
Pós-Condições: sindicato cadastrado no banco de dados.

Fluxo principal de eventos
1. Usuário clica no botão cadastrar na tela de Listagem de Sindicatos (E1, E2);
2. Um formulário é aberto solicitando dados cadastrais: nome, município, UF, endereço;
3. Usuário preenche os campos e confirma a operação (E3);
4. Sistema insere os registros de log da situação no banco remoto com a justificava “cadastrado pelo usuário X:Y”, onde X corresponde ao login do funcionário e Y corresponde ao seu nome;
5. Sistema retorna uma mensagem avisando que o sindicato foi cadastrado com sucesso.

Também haverá rotinas de alteração e de exclusão. O processo é trivial para ser descrito aqui. Vale salientar que devem ser efetuados os devidos registros no log do sistema.

Fluxos de exceção
• E1: se não houver conexão com a internet, uma mensagem será exibida informando que não é possível estabelecer uma conexão com a internet e solicitando ao usuário que verifique sua conexão;
• E2: se o sistema não estiver disponível, uma mensagem será exibida informando que o serviço não está disponível e que o usuário deve tentar acessá-lo mais tarde;
• E3: se houver um erro na inserção dos registros no banco de dados, uma mensagem será exibida informando que não foi possível inserir os dados e solicitando ao usuário que tente novamente e que, caso o erro persista, entre em contato com a BISA. O sistema deve ainda efetuar todas as rotinas de rollback de modo a não deixar ‘lixo’ no banco de dados;

[RF008] Listar sindicatos
Atores relacionados
Funcionário FETAPE.

Objetivo
Listar todos os sindicatos cadastrados no sistema.

Prioridade
Essencial.

Entradas e pré condições
Entradas: nenhuma.
Pré-condições: usuário logado no sistema; sindicatos armazenados no banco de dados.

Saídas e pós-condições
Saídas: lista de sindicatos.
Pós-condições: nenhuma.

Fluxo principal de eventos
1. Usuário clica no botão Sindicatos da barra de funções do sistema para acessar a Listagem de Sindicatos;
2. Sistema carrega da base de dados os sindicatos com seus respectivos dados (E1, E2, E3, E4);
3. É exibida a lista de sindicatos (com check boxes para seleção), cada um com seu número, nome e município. Os sindicatos serão ordenados por ordem alfabética e agrupados por município. Também haverá uma check box que permite a seleção de todos os sindicatos listados na tela e um limite de sindicatos a serem exibidos, sendo os demais acessados por uma barra de próximo/anterior (semelhante a um esquema de web mail);
4. Através de uma caixa de seleção (combo box), o usuário pode filtrar os sindicatos que serão exibidos na tela de acordo com a opção: “nome/município”. A opção “nome” é a padrão.

Fluxos de exceção
• E1: se não houver conexão com a internet, uma mensagem será exibida informando que não é possível estabelecer uma conexão com a internet e solicitando ao usuário que verifique sua conexão;
• E2: se o sistema não estiver disponível, uma mensagem será exibida informando que o serviço não está disponível e que o usuário deve tentar acessá-lo mais tarde;
• E3: se o resultado da busca retornar vazio, uma mensagem será exibida informando ao usuário que não existem dados referentes à consulta realizada;
• E4: se o sistema não conseguir acessar a base de dados, uma mensagem será exibida informando ao usuário que a base de dados está inacessível.

[RF009] Baixar Boleto
Atores relacionados
Funcionário FETAPE.

Objetivo
Baixa nos boletos que foram impressos. Eles passarão a ter o status de pago.

Prioridade
Essencial.

Entradas e pré condições
Entradas: lista de boletos para baixa.
Pré-condições: usuário logado no sistema; os registros dos boletos devem estar armazenados no banco de dados.

Saídas e pós-condições
Saídas: mensagem de aviso de sucesso da operação.
Pós-condições: registro dos boletos marcados no banco como “pagos”.

Fluxo principal de eventos
1. Usuário seleciona na Lista de boletos aqueles que deseja baixar (check box) e clica no botão Baixar (E1, E2, E3, E4, E5);
2. Sistema marca no banco os boletos como pagos (E6). Se o boleto não for encontrado na tabela de boletos, deverá ser procurado na tabela de boletos avulsos (E7);
3. Sistema insere no log de boletos os registros com o status impresso com a justificativa “baixado pela função de baixar de boletos pelo usuário X:Y”, onde X corresponde ao código do usuário e Y ao seu nome;
4. Sistema exibe uma mensagem de “Boletos baixados com sucesso”.

Fluxos de exceção
• E1: se não houver conexão com a internet, uma mensagem será exibida informando que não é possível estabelecer uma conexão com a internet e solicitando ao usuário que verifique sua conexão;
• E2: se o sistema não estiver disponível, uma mensagem será exibida informando que o serviço não está disponível e que o usuário deve tentar acessá-lo mais tarde;
• E3: se o usuário não selecionar boletos, o sistema exibe uma mensagem solicitando ao usuário que selecione boletos para impressão;
• E4: se na lista houver boletos com o status “pago”, o sistema exibe uma mensagem informando que boletos selecionados já foram baixados. Se o usuário clicar em continuar, o sistema continua a execução e ignora esses boletos;
• E5: se na lista houver boletos com o status diferente de “impresso” ou “enviado” (enviado para o banco), o sistema exibe uma mensagem informando que há boletos selecionados que ainda não foram impressos ou enviados para o banco e quais são estes boletos. Se o usuário clicar em continuar, o sistema continua a execução e ignora esses boletos;
• E6: se houver um erro na alteração dos registros no banco de dados, uma mensagem será exibida informando que não foi possível marcar os boletos como pagos e solicitando ao usuário que tente novamente e que, caso o erro persista, entre em contato com a BISA. O sistema deve ainda efetuar todas as rotinas de rollback de modo a não deixar ‘lixo’ no banco de dados;
• E7: se o registro do boleto não for encontrado no banco, o sistema exibirá uma mensagem de erro indicando que o boleto não foi encontrado na base de dados do sistema.

[RF010] Baixar Boleto Automaticamente (via Arquivo de Retorno do Banco)
Atores relacionados
Funcionário FETAPE.

Objetivo
Baixar de boletos a partir de um arquivo de retorno que o banco envia.

Prioridade
Essencial.

Entradas e pré condições
Entradas: arquivo de retorno do banco.
Pré-condições: usuário logado no sistema; os registros dos boletos devem estar armazenados no banco de dados.

Saídas e pós-condições
Saídas: mensagem de sucesso da operação.
Pós-condições: registro dos boletos marcados no banco como “pagos”.

Fluxo principal de eventos
1. Na tela da Lista de boletos, usuário clica na opção Baixa com Arquivo do Banco (E1, E2);
2. Uma tela é aberta perguntando qual o arquivo de retorno do banco. O usuário então seleciona o caminho no seu computador correspondente à localização do arquivo e clica em OK. O sistema irá, então, fazer o upload do arquivo (E3, E4, E5);
3. Sistema guarda a identificação do arquivo de retorno com situação de ‘não processado’ na base de dados e guarda uma cópia do arquivo em diretório especifico para histórico;
4. Para cada linha do arquivo de retorno, o sistema procura o boleto referente na base de dados de boletos de contribuição. Se o boleto não for encontrado, o sistema procura na base de dados de boletos avulsos. Nesta base, há registros de boletos com intervalos (ex. de 001 a 100). O sistema irá buscar o número do boleto nessa faixa (E6);
5. O sistema verifica se o boleto encontrado está marcado como “impresso” ou “enviado” (para o banco). Se estiver, o sistema marca no banco de dados o boleto como “pago” (E7);
6. O sistema insere no log de boletos o registro com situação de “pago” com a justificativa ‘baixado pela função de baixa automática de boleto pelo usuário X:Y’, onde X corresponde ao login de usuário e Y corresponde ao seu nome;
7. O Sistema marca o arquivo de retorno como ‘processado sem erros’ e uma exibe mensagem confirmando o sucesso na baixa dos boletos.

Fluxos de exceção
• E1: se não houver conexão com a internet, uma mensagem será exibida informando que não é possível estabelecer uma conexão com a internet e solicitando ao usuário que verifique sua conexão;
• E2: se o sistema não estiver disponível, uma mensagem será exibida informando que o serviço não está disponível e que o usuário deve tentar acessá-lo mais tarde;
• E3: se o usuário não apontar nenhum arquivo de retorno, uma mensagem será exibida exigindo que o usuário aponte o arquivo;
• E4: se o caminho para o arquivo estiver incorreto, o sistema exibe uma mensagem para o usuário informando que o caminho selecionado é inválido;
• E5: se o formato do arquivo não corresponder ao formato do arquivo de retorno do banco esperado, o sistema exibirá uma mensagem informando que o formato do arquivo selecionado é inválido;
• E6: se um registro do arquivo não for encontrado no sistema (base principal e base de boletos avulsos), será exibido numa tela todos os registros que não foram encontrados. A situação do arquivo de retorno no banco deve então mudar para “processado com erro” e o sistema deve inserir o registro de log de boleto com a justificativa “boleto não pode ser baixado, pois o mesmo não foi encontrado no sistema. Ação executada pelo usuário X:Y”, onde X é o login e Y é o nome. O valor do boleto pago e não encontrado deverá ser armazenado na tabela de boletos no registro cujo identificador é “BoletoXXXX”. Todo boleto que não for encontrado deverá ser somado ao valor desse registro;
• E7: se houver um erro na alteração dos registros no banco de dados, uma mensagem será exibida informando que não foi possível marcar os boletos como “pago” e solicitando ao usuário que tente novamente e que, caso o erro persista, entre em contato com a BISA. O sistema deve ainda efetuar todas as rotinas de rollback de modo a não deixar ‘lixo’ no banco de dados.

[RF011] Gerar arquivo de remessa para banco
Atores relacionados
Funcionário FETAPE.

Objetivo
Gerar arquivo de remessa de boletos para o banco.

Prioridade
Essencial.

Entradas e pré condições
Entradas: lista de boletos que serão enviados para o arquivo.
Pré-condições: usuário logado no sistema; os registros dos boletos devem estar armazenados no banco de dados com o status “gerado” ou “impresso”.

Saídas e pós-condições
Saídas: mensagem de sucesso da operação; arquivo de remessa para o banco.
Pós-condições: boletos marcados com o status “enviado” no banco na base de dados.

Fluxo principal de eventos
1. Na tela de Listagem de Boletos, o usuário seleciona os boletos e clica no botão Gerar de arquivo de remessa (E1, E2);
2. Sistema verifica se todos os boletos selecionados estão marcados como “gerado” ou “impresso” (E3);
3. Sistema abre tela para que o usuário informe o nome do arquivo e o local onde ele será gerado (E4, E5);
4. Usuário confirma a geração do arquivo;
5. Sistema gera o arquivo de remessa;
6. Sistema marca no banco os boletos que foram inseridos no arquivo de remessa com o status de “enviado” para o banco (E6);
7. Sistema insere no log de boletos os registros com situação de enviado com a justificativa “boleto gerado no arquivo de remessa para o banco pelo usuário X:Y”, onde X corresponde ao login do usuário e Y corresponde ao seu nome;
8. Sistema salva em diretório especifico no banco uma cópia do arquivo gerado para remessa para fins de histórico;
9. Sistema retorna o arquivo de remessa para que o usuário salve-o em seu computador.

Fluxos de exceção
• E1: se não houver conexão com a internet, uma mensagem será exibida informando que não é possível estabelecer uma conexão com a internet e solicitando ao usuário que verifique sua conexão;
• E2: se o sistema não estiver disponível, uma mensagem será exibida informando que o serviço não está disponível e que o usuário deve tentar acessá-lo mais tarde;
• E3: se o sistema não encontrar nenhum arquivo com o status “gerado” ou “impresso”, uma mensagem será exibida informando que não existem boletos a serem gerados para o arquivo de remessa. Se encontrar, deverá informar quais os boletos não serão gerados no arquivo;
• E4: se o usuário informa um local não existente, o sistema pergunta ao usuário se o mesmo deseja que o sistema crie o diretório de pastas informado. Se a resposta for sim, sistema cria diretório de pasta; se a resposta for não, sistema retorna a tela de informação do local para que o usuário selecione um novo diretório;
• E5: se houver um erro na geração do arquivo de remessa, uma mensagem será exibida informando ao usuário que o arquivo de remessa não pode ser gerado e que o mesmo tente novamente e que, caso o erro persista, entre em contato com a BISA.;
• E6: se houver um erro na alteração dos registros no banco de dados, uma mensagem será exibida informando que não foi possível marcar os boletos como “enviado” e solicitando ao usuário que tente novamente e que, caso o erro persista, entre em contato com a BISA. O sistema deve ainda efetuar todas as rotinas de rollback de modo a não deixar ‘lixo’ no banco de dados.

[RF012] Gerar arquivo de remessa para Gráfica
Atores relacionados
Funcionário FETAPE.

Objetivo
Gerar arquivo de remessa de boletos para Gráfica.

Prioridade
Essencial.

Entradas e pré condições
Entradas: lista de boletos que serão enviados para o arquivo.
Pré-condições: usuário logado no sistema; os registros dos boletos devem estar armazenados no banco de dados com o status “gerado”.

Saídas e pós-condições
Saídas: mensagem de sucesso da operação; arquivo de remessa para a gráfica (em formato txt e xls).
Pós-condições: boletos marcados com o status “enviadoGrafica” no banco na base de dados.

Fluxo principal de eventos
1. Na tela de Listagem de Boletos, o usuário seleciona os boletos e clica no botão Gerar arquivo de boleto para Gráfica (E1, E2);
2. Sistema verifica se todos os boletos selecionados estão marcados como “gerado” (E3);
3. Sistema abre tela para que o usuário informe o nome do arquivo e o local onde ele será gerado (E4, E5);
4. Usuário confirma a geração do arquivo;
5. Sistema pergunta se o usuário quer gerar o arquivo no formato txt ou xls;
6. Sistema gera o arquivo de remessa para Gráfica;
7. Sistema marca no banco os boletos que foram inseridos no arquivo de remessa com o status de “enviadoGrafica” para o banco (E6);
8. Sistema insere no log de boletos os registros com situação de enviado com a justificativa “boleto gerado no arquivo de remessa para Gráfica pelo usuário X:Y”, onde X corresponde ao login do usuário e Y corresponde ao seu nome;
9. Sistema salva em diretório especifico no banco uma cópia do arquivo gerado para remessa para Gráfica para fins de histórico;
10. Sistema retorna o arquivo para que o usuário salve-o em seu computador.

Fluxos de exceção
• E1: se não houver conexão com a internet, uma mensagem será exibida informando que não é possível estabelecer uma conexão com a internet e solicitando ao usuário que verifique sua conexão;
• E2: se o sistema não estiver disponível, uma mensagem será exibida informando que o serviço não está disponível e que o usuário deve tentar acessá-lo mais tarde;
• E3: se o sistema não encontrar nenhum arquivo com o status “gerado”, uma mensagem será exibida informando que não existem boletos a serem gerados para o arquivo de remessa. Se encontrar, deverá informar quais os boletos não serão gerados no arquivo;
• E4: se o usuário informa um local não existente, o sistema pergunta ao usuário se o mesmo deseja que o sistema crie o diretório de pastas informado. Se a resposta for sim, sistema cria diretório de pasta; se a resposta for não, sistema retorna a tela de informação do local para que o usuário selecione um novo diretório;
• E5: se houver um erro na geração do arquivo de remessa, uma mensagem será exibida informando ao usuário que o arquivo de remessa não pode ser gerado e que o mesmo tente novamente e que, caso o erro persista, entre em contato com a BISA;
• E6: se houver um erro na alteração dos registros no banco de dados, uma mensagem será exibida informando que não foi possível marcar os boletos como “enviado” e solicitando ao usuário que tente novamente e que, caso o erro persista, entre em contato com a BISA. O sistema deve ainda efetuar todas as rotinas de rollback de modo a não deixar ‘lixo’ no banco de dados.

4 Especificações Suplementares
4.1 Objetivos
Este documento tem como finalidade especificar todos os requisitos não funcionais do módulo de boletos web divididos em requisitos de usabilidade, confiabilidade, desempenho, segurança, distribuição, adequação a padrões e requisitos de hardware e software.
4.2 Usabilidade
Esta seção descreve os requisitos não funcionais associados à facilidade de uso da interface com o usuário, material de treinamento e documentação do sistema.
[NF001] Interface com o Usuário
Prioridade: Desejável
O sistema deve possuir uma interface amigável, simples e intuitiva.
4.3 Confiabilidade
Esta seção descreve os requisitos não funcionais associados à freqüência, severidade de falhas do sistema e habilidade de recuperação das mesmas, bem como a corretude do sistema.
[NF001] Tempo de Retorno após Falha
Prioridade: Desejável
Retorno de até 5 segundos após alguma falha.
[NF002] Disponibilidade
Prioridade: Importante
O sistema estará disponível 24 horas por dia durante todos os dias do ano.
4.4 Desempenho
Esta seção descreve os requisitos não funcionais associados à eficiência, uso de recursos e tempo de resposta do sistema.
[NF001] Número de Acessos
O sistema deve ser capaz de atender em média 10 usuários por segundo nos momentos de pico de acesso.
[NF002] Tempo de Resposta para os Usuários
O tempo máximo de resposta de uma requisição deve ser de no máximo 10 segundos.

4.5 Segurança
Esta seção descreve os requisitos não funcionais associados à integridade, privacidade e autenticidade dos dados do sistema.
[NF001] Privacidade de Acesso
Apenas os usuários credenciados e com permissão para acesso a este módulo deverão fazer uso das funcionalidades do módulo de boletos/guias na Web.
4.6 Hardware e software
Esta seção descreve os requisitos não funcionais associados ao hardware e software usados para desenvolver ou para executar o sistema.
[NF001] Linguagem de Implementação
Prioridade: Essencial
A linguagem de implementação do módulo de boleto Web será Delphi, mesma linguagem utilizada no desenvolvimento dos sistemas Partidos2000, Receb2000, OAB2000 e Filiados2000.
[NF002] Banco de Dados
Prioridade: Essencial
O banco de dados utilizado será o MySQL.
[NF003] Ferramentas
Prioridade: Essencial
Ferramenta de modelagem: Borland Delphi 2006
Ferramenta de Desenvolvimento: Borland Delphi 2006
[NF004] Plataforma de Funcionamento
Prioridade: Essencial
A plataforma tanto de desenvolvimento e de funcionamento será Windows.

Para uso do Bw- Construindo

2013-01-22T13:12:41Z

AnaPaula: /* Fluxos de exceção */

[[Arquivo:BoletosWeb.PNG]]

=1. Caso de Negócio=
==1.1 Objetivos==

Documentar o novo módulo de geração e impressão de boletos online. As informações aqui descritas especificam e refinam a regras de negócio.

==1.2 Referências==

Se baseará no conhecimento adquirido na implementação de rotinas de boletos da BISA (desktop) e no antigo sistema TRAB_RUR da BISA, em DOS. A entrevista com Mário e Márcio da FETAPE (realizada por Ronaldo e Alexandre) também é referência para a definição dos requisitos.

==1.3 Sistemas com rotinas de gerenciamento de boletos da BISA==

O Filiados 2000 é um sistema desktop de gestão de filiados que controla o cadastro de filiados dos sindicatos de trabalhadores, fazendo acompanhamento de participação na organização.

O OAB 2000 é um software de gestão de cadastro de advogados para OAB's. Faz desde o cadastro de alunos, pré-inscritos, coordena sociedades de advogados, estagiários, até a administração dos dados financeiros dos advogados.

O Receb 2000 é um software voltado para o acompanhamento do contas a receber de uma empresa, fazendo a gestão financeira da carteira de forma simples e eficiente.

Todos esses sistemas possuem uma função de gerenciamento de boletos bancários ou guias sindicais, sendo salvos de forma centralizada no MySQL, de forma que podem ser acessados de forma uniforme no BoletoWEB.

Cada sistema contém suas próprias regras de negócio para gerenciar os boletos; no entanto, as funções de acesso ao banco remoto serão padronizadas para todos os sistemas no BoletoWEB.

==1.4 Descrição do Produto==

A maior parte da implementação é voltada para a FETAPE, enquanto o restante imprime boletos gerados pelos nossos sistema desktop.

Módulo Geral: este módulo tem a função meramente de fornecer uma interface web que permita ao usuário imprimir boletos gerados pelos sistemas desktop da BISA.

Módulo FETAPE: no antigo sistema TRAB_RUR da BISA, este sistema é o foco principal desta documentação. Nela o usuário poderá gerenciar todo o fluxo de boletos de contribuições: geração, impressão interna, cadastro de filiados, acesso on-line dos filiados, etc.

==1.5 Contexto de Negócio==

O módulo geral de boletos na web será utilizado a princípio pelos sistemas Receb2000, OAB2000 e Filiados2000, porém poderá ser extendido a qualquer sistema que queira fazer o controle de boletos/guias.

Este módulo concentrará as informações dos boletos em um único local independente de entidade ou sistema. Este local, a priori, ficou definido como sendo um dos servidores internos da BISA que possua acesso externo. Cada sistema rodará normalmente no ambiente do cliente. No momento que for necessário o acesso às informações, este será feito não mais na base local da área do cliente, mas na base remota situada na BISA.

O módulo FETAPE segue as mesmas diretrizes, tendo a diferença de ser implementado exclusivamente para esta entidade, devendo ser adaptável para outras entidades. Para tanto, aconselha-se o uso de uma arquitetura em camadas e padrões de projetos, facilitadores do processos de manutenção.

==1.6 Tecnologias utilizadas==

Os módulos geral e FETAPE deverão implementados utilizando uma tecnologia para web: PHP, Java ou .NET.

O banco de dados necessariamente deverá ser o MySQL, pois já é utilizado na bisa para o registro de boletos.

=2. Sobre os Requisitos=
==2.1 Introdução==

Este documento especifica todos os requisitos funcionais e não funcionais do módulo de gerenciamento de boletos, descrevendo os fluxos de eventos, prioridades, atores, entradas e saídas de cada caso de uso a ser implementado.

A correta interpretação deste documento exige o conhecimento de algumas convenções e termos específicos, que são descritos a seguir.

==2.2 Identificação dos Requisitos==

Por convenção, a referência a requisitos é feita através do nome da subseção onde eles estão descritos, seguidos do identificador do requisito, de acordo com o esquema abaixo:

[nome da subseção, identificador do requisito]

Por exemplo, o requisito funcional [Imprimir Boleto RF002] está descrito em um caso de uso chamado “Imprimir Boleto”, em um bloco identificado pelo identificador [RF002].

==2.3 Prioridades dos Requisitos==

Para estabelecer a prioridade dos requisitos foram adotadas as denominações “essencial”, “importante” e “desejável”. 
• Essencial é o requisito sem o qual o sistema não entra em funcionamento. São requisitos imprescindíveis, que têm que ser implementados. 
• Importante é o requisito sem o qual o sistema entra em funcionamento, mas de forma não satisfatória. Requisitos importantes devem ser implementados, mas, se não forem, o sistema poderá ser implantado e usado mesmo assim. 
• Desejável é o requisito que não compromete as funcionalidades básicas do sistema, isto é, o sistema pode funcionar de forma satisfatória sem ele. Requisitos desejáveis são requisitos que podem ser deixados para versões posteriores do sistema, caso não haja tempo hábil para implementá-los na versão que está sendo especificada. 

==2.4 Descrição dos Atores==

'''Usuário externo'''
É a pessoa que acessa a funcionalidade de impressão de boletos do módulo geral pelo browser.

Filiado FETAPE
Semelhante ao usuário comum, com a diferença de que terá a opção de se cadastrar pelo site.

Funcionário FETAPE
É responsável pelo gerenciamento dos boletos. É o ator principal deste sistema.

=3 Requisitos Funcionais (Casos de Uso)=
==3.1 Ações do Usuário==

==[RF001] Efetuar login==
Atores relacionados
Usuário externo, Filiado FETAPE e Funcionário FETAPE.

===Objetivo===
Fazer login no módulo Web de impressão de boletos.

===Prioridade===
Essencial.

===Entradas e pré condições===
'''Entradas:''' login do usuário e senha;
'''Pré-condições:''' computador deve ter acesso à internet; servidor web disponível.

===Saídas e pós-condições===
'''Saídas:''' não há
'''Pós-condições:''' usuário logado no sistema.

===Fluxo principal de eventos===
1. Usuário executa seu web browser e acessa a página de login (E1, E2); 
2. Usuário informa login e senha e clica em Entrar (E3); 
3. Sistema recupera na base de dados a senha do usuário com o login informado; 
4. Sistema verifica se o login está cadastrado (E4); 
5. Sistema verifica se a senha informada corresponde ao login informado (E5); 
6. Sistema libera o acesso após o sucesso da verificação; 
7. Includes [RF002]. 

===Fluxos de exceção===
• E1: se não houver conexão com a internet, uma mensagem será exibida informando que não é possível estabelecer uma conexão com a internet e solicitando ao usuário que verifique sua conexão; 
• E2: se o sistema não estiver disponível, uma mensagem será exibida informando que o serviço não está disponível e que o usuário deve tentar acessá-lo mais tarde; 
• E3: se o usuário não informar o login ou a senha, o sistema solicita que informe o login e a senha; 
• E4: se o login não estiver cadastrado, o sistema emite uma mensagem de erro informando que este usuário não está cadastrado e solicitando que o mesmo verifique se o login foi digitado corretamente; 
• E5: se a senha não conferir com a que está armazenada na base de dados, o sistema emite uma mensagem de erro avisando que a senha informada está incorreta e solicitando que o mesmo verifique se ela foi digitada corretamente. 

==[RF002] Listar boletos==
===Atores relacionados===
Usuário externo, Filiado FETAPE e Funcionário FETAPE.

===Objetivo===
Listar os boletos correspondentes ao usuário logado.

===Prioridade===
Essencial.

===Entradas e pré condições===
'''Entradas:''' nenhuma.
'''Pré-condições:''' usuário logado no sistema; boletos armazenados no banco de dados.

===Saídas e pós-condições===
'''Saídas:''' lista de boletos.
'''Pós-condições:''' nenhuma.

===Fluxo principal de eventos===
1. Sistema carrega da base de dados os boletos referentes ao usuário (E1, E2, E3); 
2. É exibida a lista de boletos (com check boxes para seleção), cada um com seu número, descrição, valor, vencimento e status (pendente/atrasado/impresso/pago). Os boletos serão ordenados de forma decrescente (maior para o menor) por data de vencimento na lista. Também haverá uma check box que permite a seleção de todos os boletos listados na tela e um limite de boletos a serem exibidos, sendo os demais boletos acessados por uma barra de próximo/anterior (semelhante a um esquema de web mail); 
3. Através de uma caixa de seleção (combo box), o usuário pode filtrar os boletos que serão exibidos na tela de acordo com a opção: “pendentes/impressos/pagos/todos”. Os boletos com status “atrasado” ficarão na lista de “pendentes” e “todos”, mas com uma cor de linha de grid que os diferencie dos demais (ex. vermelho). O status inicial do filtro é “pendentes”. 

===Fluxos de exceção===
• E1: se não houver conexão com a internet, uma mensagem será exibida informando que não é possível estabelecer uma conexão com a internet e solicitando ao usuário que verifique sua conexão; 
• E2: se o sistema não estiver disponível, uma mensagem será exibida informando que o serviço não está disponível e que o usuário deve tentar acessá-lo mais tarde; 
• E3: se o resultado da busca retornar vazio, uma mensagem será exibida informando ao usuário que não existe dados referentes à consulta realizada. 

=[RF003] Geração de boletos=
===Atores relacionados===
Usuário externo, Filiado FETAPE e Funcionário FETAPE.

===Objetivo===
Gerar registros de boletos no banco de dados para impressão. Não constitui a impressão do boleto em si.

===Prioridade===
Essencial.

===Entradas e pré condições===
'''Entradas:''' filiado(s)/usuário(s), banco, data de vencimento, modelo da guia, nosso número inicial, valor e instruções.
'''Pré-condições:''' usuário logado no sistema; sindicatos e filiados armazenados no banco de dados.

===Saídas e pós-condições===
'''Saídas:''' mensagem de aviso de sucesso da operação. 
'''Pós-condições:''' registro dos boletos inseridos no banco de dados.

===Fluxo principal de eventos===
1. Usuário Externo e Filiado FETAPE: usuário clica no botão Gerar Boletos. Se o usuário estiver com o status óbito, não será gerado boleto. Funcionário FETAPE: funcionário seleciona uma quantidade de filiados na tela de Listagem de Filiados e clica no botão Gerar Boletos. Os filiados com o status “óbito” nunca serão carregados; 
2. Sistema carrega o(s) usuários(s)/filiado(s) selecionados com seus respectivos dados (E1, E2, E3, E4); 
3. Uma janela é aberta perguntando se o usuário deseja imprimir boletos referentes a Contribuição Sindical e Contribuição Confederativa (2 check boxes); 
4. Uma tela é aberta onde o usuário informa os dados (banco, data de vencimento, modelo da guia, nosso número inicial, valor e instruções) para os boletos. Usuário confirma a operação; 
5. Sistema valida os dados inseridos pelo usuário e os dados obrigatórios para emissão de boleto (E5, E6); 
6. Sistema gera os boletos e os armazena no banco de dados com o status “gerado” (E7). O sistema deverá verificar se o número de boleto que ele irá gerar existe em algum intervalo na tabela de boletos avulso. Se existir, ele deverá gerar um próximo número que não esteja em um intervalo desta tabela; 
7. Sistema insere os registros de log da situação dos boletos no banco remoto com a justificava “gerado a partir da função de geração de boleto pelo usuário X:Y”, onde X corresponde ao login do funcionário e Y corresponde ao seu nome; 
8. Sistema exibe mensagem confirmando o sucesso na geração dos boletos e perguntando se o usuário deseja fazer a impressão dos mesmos; 
9. Se o usuário responder que sim, a janela de impressão padrão da funcionalidade imprimir é aberta. Includes [RF004]. 

===Filiado FETAPE===
Este usuário também terá acesso à rotina de CANCELAMENTO do boleto, que consiste meramente na exclusão do mesmo da base de dados. Vale salientar que devem ser efetuados os devidos registros no log do sistema seguindo o padrão supracitado, assim como devem ser atendidos os seguintes fluxos de exceção: 
1. Se o boleto possuir o status “pago”, “impresso” ou “enviado” (para o banco), o cancelamento não será permitido. O sistema exibirá uma mensagem de erro avisando que o boleto não pode ser impresso, indicando o seu status atual; 
2. Se o boleto requisitado não puder ser excluído, o sistema exibe uma mensagem de erro solicitando que o boleto não poder ser removido no momento. 

===Fluxos de exceção===
• E1: se não houver conexão com a internet, uma mensagem será exibida informando que não é possível estabelecer uma conexão com a internet e solicitando ao usuário que verifique sua conexão; 
• E2: se o sistema não estiver disponível, uma mensagem será exibida informando que o serviço não está disponível e que o usuário deve tentar acessá-lo mais tarde; 
• E3: se o resultado da busca retornar vazio, uma mensagem será exibida informando ao usuário que não existem dados referentes à consulta realizada; 
• E4: se o sistema não conseguir acessar a base de dados, uma mensagem será exibida informando ao usuário que a base de dados está inacessível; 
• E5: se o usuário não preencher os dados obrigatórios do boleto (banco, data de vencimento, modelo da guia, nosso número inicial e valor), uma mensagem será exibida informando ao usuário que os campos obrigatórios devem ser preenchidos; 
• E6: se os dados obrigatórios do(s) usuário(s)/filiado(s) para emissão de boleto não foram preenchidos (nome, logradouro, bairro, cidade, estado e CEP), o sistema lista na tela os usuário(s)/filiado(s) cujos dados obrigatórios não estão preenchidos e, para cada um, informa quais campos devem ser preenchidos. O usuário poderá prosseguir para a tela de marcação dos boletos que serão impressos (botão “prosseguir”), no entanto os boletos cujos dados não estão completos não aparecerão para seleção; 
• E7: se houver um estouro na numeração de boletos*, o sistema exibe uma mensagem solicitando ao usuário que entre em contato com a BISA pois houve um problema na geração da numeração do boleto. A operação não é finalizada. O sistema deve ainda efetuar todas as rotinas de rollback de modo a não deixar ‘lixo’ no banco de dados. 

<nowiki>*</nowiki> O estouro na numeração de boletos ocorre quando o limite do número de boletos cadastrado no banco de dados é atingido. Por exemplo, supondo um limite de 10 bytes, se o último registro cadastrado for 9999999999, o próximo registro de boleto irá acionar este erro. 

[RF004] Imprimir boletos
Atores relacionados
Usuário externo, Filiado FETAPE e Funcionário FETAPE.

Objetivo
Constitui a impressão de um boleto já gerado no sistema.

Prioridade
Essencial.

Entradas e pré condições
Entradas: lista de boletos para impressão.
Pré-condições: o usuário deve estar logado no sistema na tela da listagem de boletos (RF002); os registros dos boletos devem estar armazenados no banco de dados e marcados como “não impresso”.

Saídas e pós-condições
Saídas: impressão dos boletos selecionados.
Pós-Condições: registros dos boletos marcados no banco como “impresso”.

Fluxo principal de eventos
1. Usuário seleciona na Lista de boletos aqueles que deseja imprimir (check box) e clica no botão Imprimir (E1, E2, E3, E4, E5);
2. Se o usuário houver selecionado apenas um boleto, o sistema imprime o boleto no navegador, permitindo ao usuário conferir seus dados. Depois disso, ele clica em um novo botão Imprimir e passa para o passo 3;
3. Janela de impressão padrão é aberta (onde o usuário poderá selecionar impressora, quantidade de páginas, etc). Usuário confirma a impressão e o sistema envia os arquivos para a impressora (E6);
4. Sistema marca no banco os boletos que foram impressos com o status “impresso” (E7);
5. Sistema insere no log de boletos os registros com o status impresso com a justificativa “impresso pela função de impressão de boletos pelo usuário X:Y”, onde X corresponde ao código do usuário e Y ao seu nome.
6. Sistema exibe uma mensagem de “Boletos impressos com sucesso”.

Fluxos de exceção
• E1: se não houver conexão com a internet, uma mensagem será exibida informando que não é possível estabelecer uma conexão com a internet e solicitando ao usuário que verifique sua conexão;
• E2: se o sistema não estiver disponível, uma mensagem será exibida informando que o serviço não está disponível e que o usuário deve tentar acessá-lo mais tarde;
• E3: se o usuário não selecionar boletos, o sistema exibe uma mensagem solicitando ao usuário que selecione boletos para impressão;
• E4: se na lista houver boletos que já foram pagos, o sistema exibe uma mensagem de erro informando que boletos pagos não podem ser reimpressos e cancela a operação;
• E5: se houver boletos que já foram impressos, o sistema exibe um alerta informando que os boletos já foram impressos pelo sistema e serão reimpressos nesta operação; continua a executar normalmente;
• E6: se houver um erro ao enviar os dados para a impressora, o sistema exibe uma mensagem avisando ao usuário que o sistema não conseguiu imprimir e solicitando que o mesmo verifique se a impressora está pronta para impressão;
• E7: se houver um erro na alteração dos registros no banco de dados, uma mensagem será exibida informando que não foi possível marcar os boletos como impressos e solicitando ao usuário que tente novamente e que, caso o erro persista, entre em contato com a BISA. O sistema deve ainda efetuar todas as rotinas de rollback de modo a não deixar ‘lixo’ no banco de dados.

[RF005] Cadastro de filiado
Atores relacionados
Filiado FETAPE e Funcionário FETAPE.

Objetivo
Cadastrar um filiado. As rotinas de ALTERAÇÃO e de EXCLUSÃO também estão contidas neste requisito para o Funcionário FETAPE.

Prioridade
Essencial.

Entradas e pré condições
Entradas: dados cadastrais do usuário.
Pré-condições: computador deve ter acesso à internet; servidor web disponível. Funcionário: usuário cadastrado no sistema.

Saídas e pós-condições
Saídas: mensagem avisando que o usuário foi cadastrado com sucesso.
Pós-Condições: usuário cadastrado no banco de dados.

Fluxo principal de eventos
1. Ator Filiado: a função “Cadastrar Filiado” é acionada pelo usuário no navegador web (E1, E2). Ator Funcionário: a função “Cadastrar Filiado” é acionada pelo usuário na tela de Listagem de Filiados (E1, E2).
2. Um formulário é aberto solicitando dados cadastrais: login, senha, nome, CPF, CNAE, bairro, cidade, UF, logradouro, CEP, categoria (seleção entre as opções arrendatário, assentado, meeiro, parceiro, posseiro, pequeno proprietário e outros) e apelido do filiado;
3. Usuário preenche os campos e confirma a operação (E3, E4, E5, E6);
4. Sistema insere os registros de log da situação no banco remoto com a justificava “cadastrado pelo usuário X:Y”, onde X corresponde ao login do usuário e Y corresponde ao seu nome;
5. Sistema retorna uma mensagem avisando que o usuário foi cadastrado com sucesso.

O sistema também apresenta as rotinas de ALTERAÇÃO, que por ser trivial e seguir um fluxo semelhante à rotina de inclusão não terá sua execução descrita aqui. Vale salientar que devem ser efetuados os devidos registros no log do sistema.

Filiado FETAPE
Ele possui também a funcionalidade EXCLUSÃO. Sua tela de ALTERAR é diferente. Nela, o usuário pode marcar um check box “óbito” para filiados que foram a óbito.

Fluxos de exceção
• E1: se não houver conexão com a internet, uma mensagem será exibida informando que não é possível estabelecer uma conexão com a internet e solicitando ao usuário que verifique sua conexão;
• E2: se o sistema não estiver disponível, uma mensagem será exibida informando que o serviço não está disponível e que o usuário deve tentar acessá-lo mais tarde;
• E3: se o login fornecido já estiver cadastrado no sistema, uma mensagem será exibida informando ao usuário que o login cadastrado já existe no sistema;
• E4: se o CPF do filiado for inválido, uma mensagem será exibida informando ao usuário que o CPF cadastrado é inválido. Vale salientar que o preenchimento deste campo é opcional;
• E5: se houver um erro na inserção dos registros no banco de dados, uma mensagem será exibida informando que não foi possível inserir os dados e solicitando ao usuário que tente novamente e que, caso o erro persista, entre em contato com a BISA. O sistema deve ainda efetuar todas as rotinas de rollback de modo a não deixar ‘lixo’ no banco de dados;
• E6: se os dados obrigatórios dos filiados não forem preenchidos (nome, logradouro, bairro, cidade, estado e CEP), o sistema emite uma mensagem de erro informando quais os campos obrigatórios não foram preenchidos.

[RF006] Listar filiados
Atores relacionados
Funcionário FETAPE.

Objetivo
Listar todos os filiados cadastrados no sistema.

Prioridade
Essencial.

Entradas e pré condições
Entradas: nenhuma.
Pré-condições: usuário logado no sistema; filiados armazenados no banco de dados.

Saídas e pós-condições
Saídas: lista de filiados.
Pós-condições: nenhuma.

Fluxo principal de eventos
1. Usuário clica no botão Filiados da barra de funções do sistema para acessar a Listagem de Filiados;
2. Sistema carrega da base de dados os filiados com seus respectivos dados (E1, E2, E3, E4);
3. É exibida a lista de filiados (com check boxes para seleção), cada um com seu número, nome, apelido, CPF, município, sindicato e categoria. Os filiados serão ordenados por ordem alfabética e agrupados por município. Também haverá uma check box que permite a seleção de todos os filiados listados na tela e um limite de filiados a serem exibidos, sendo os demais acessados por uma barra de próximo/anterior (semelhante a um esquema de web mail);
4. Através de uma caixa de seleção (combo box), o usuário pode filtrar os filiados que serão exibidos na tela de acordo com a opção: “nome/apelido/município/sindicato”. A opção “nome” é a padrão. Os filiados que foram a óbito serão exibidos com uma cor de linha de grid acinzentada e só serão exibidos se um check box “todos” for ativado.

Fluxos de exceção
• E1: se não houver conexão com a internet, uma mensagem será exibida informando que não é possível estabelecer uma conexão com a internet e solicitando ao usuário que verifique sua conexão;
• E2: se o sistema não estiver disponível, uma mensagem será exibida informando que o serviço não está disponível e que o usuário deve tentar acessá-lo mais tarde;
• E3: se o resultado da busca retornar vazio, uma mensagem será exibida informando ao usuário que não existem dados referentes à consulta realizada;
• E4: se o sistema não conseguir acessar a base de dados, uma mensagem será exibida informando ao usuário que a base de dados está inacessível.

[RF007] Cadastro de sindicato
Atores relacionados
Funcionário FETAPE.

Objetivo
Cadastrar um sindicato. As rotinas de ALTERAÇÃO e de EXCLUSÃO também estão contidas neste requisito.

Prioridade
Essencial.

Entradas e pré condições
Entradas: dados do sindicato; dados do Município (já presentes na base de dados, herdada do antigo sistema DOS TRAB_RUR).
Pré-condições: usuário logado no sistema.

Saídas e pós-condições
Saídas: mensagem avisando que o sindicato foi cadastrado com sucesso.
Pós-Condições: sindicato cadastrado no banco de dados.

Fluxo principal de eventos
1. Usuário clica no botão cadastrar na tela de Listagem de Sindicatos (E1, E2);
2. Um formulário é aberto solicitando dados cadastrais: nome, município, UF, endereço;
3. Usuário preenche os campos e confirma a operação (E3);
4. Sistema insere os registros de log da situação no banco remoto com a justificava “cadastrado pelo usuário X:Y”, onde X corresponde ao login do funcionário e Y corresponde ao seu nome;
5. Sistema retorna uma mensagem avisando que o sindicato foi cadastrado com sucesso.

Também haverá rotinas de alteração e de exclusão. O processo é trivial para ser descrito aqui. Vale salientar que devem ser efetuados os devidos registros no log do sistema.

Fluxos de exceção
• E1: se não houver conexão com a internet, uma mensagem será exibida informando que não é possível estabelecer uma conexão com a internet e solicitando ao usuário que verifique sua conexão;
• E2: se o sistema não estiver disponível, uma mensagem será exibida informando que o serviço não está disponível e que o usuário deve tentar acessá-lo mais tarde;
• E3: se houver um erro na inserção dos registros no banco de dados, uma mensagem será exibida informando que não foi possível inserir os dados e solicitando ao usuário que tente novamente e que, caso o erro persista, entre em contato com a BISA. O sistema deve ainda efetuar todas as rotinas de rollback de modo a não deixar ‘lixo’ no banco de dados;

[RF008] Listar sindicatos
Atores relacionados
Funcionário FETAPE.

Objetivo
Listar todos os sindicatos cadastrados no sistema.

Prioridade
Essencial.

Entradas e pré condições
Entradas: nenhuma.
Pré-condições: usuário logado no sistema; sindicatos armazenados no banco de dados.

Saídas e pós-condições
Saídas: lista de sindicatos.
Pós-condições: nenhuma.

Fluxo principal de eventos
1. Usuário clica no botão Sindicatos da barra de funções do sistema para acessar a Listagem de Sindicatos;
2. Sistema carrega da base de dados os sindicatos com seus respectivos dados (E1, E2, E3, E4);
3. É exibida a lista de sindicatos (com check boxes para seleção), cada um com seu número, nome e município. Os sindicatos serão ordenados por ordem alfabética e agrupados por município. Também haverá uma check box que permite a seleção de todos os sindicatos listados na tela e um limite de sindicatos a serem exibidos, sendo os demais acessados por uma barra de próximo/anterior (semelhante a um esquema de web mail);
4. Através de uma caixa de seleção (combo box), o usuário pode filtrar os sindicatos que serão exibidos na tela de acordo com a opção: “nome/município”. A opção “nome” é a padrão.

Fluxos de exceção
• E1: se não houver conexão com a internet, uma mensagem será exibida informando que não é possível estabelecer uma conexão com a internet e solicitando ao usuário que verifique sua conexão;
• E2: se o sistema não estiver disponível, uma mensagem será exibida informando que o serviço não está disponível e que o usuário deve tentar acessá-lo mais tarde;
• E3: se o resultado da busca retornar vazio, uma mensagem será exibida informando ao usuário que não existem dados referentes à consulta realizada;
• E4: se o sistema não conseguir acessar a base de dados, uma mensagem será exibida informando ao usuário que a base de dados está inacessível.

[RF009] Baixar Boleto
Atores relacionados
Funcionário FETAPE.

Objetivo
Baixa nos boletos que foram impressos. Eles passarão a ter o status de pago.

Prioridade
Essencial.

Entradas e pré condições
Entradas: lista de boletos para baixa.
Pré-condições: usuário logado no sistema; os registros dos boletos devem estar armazenados no banco de dados.

Saídas e pós-condições
Saídas: mensagem de aviso de sucesso da operação.
Pós-condições: registro dos boletos marcados no banco como “pagos”.

Fluxo principal de eventos
1. Usuário seleciona na Lista de boletos aqueles que deseja baixar (check box) e clica no botão Baixar (E1, E2, E3, E4, E5);
2. Sistema marca no banco os boletos como pagos (E6). Se o boleto não for encontrado na tabela de boletos, deverá ser procurado na tabela de boletos avulsos (E7);
3. Sistema insere no log de boletos os registros com o status impresso com a justificativa “baixado pela função de baixar de boletos pelo usuário X:Y”, onde X corresponde ao código do usuário e Y ao seu nome;
4. Sistema exibe uma mensagem de “Boletos baixados com sucesso”.

Fluxos de exceção
• E1: se não houver conexão com a internet, uma mensagem será exibida informando que não é possível estabelecer uma conexão com a internet e solicitando ao usuário que verifique sua conexão;
• E2: se o sistema não estiver disponível, uma mensagem será exibida informando que o serviço não está disponível e que o usuário deve tentar acessá-lo mais tarde;
• E3: se o usuário não selecionar boletos, o sistema exibe uma mensagem solicitando ao usuário que selecione boletos para impressão;
• E4: se na lista houver boletos com o status “pago”, o sistema exibe uma mensagem informando que boletos selecionados já foram baixados. Se o usuário clicar em continuar, o sistema continua a execução e ignora esses boletos;
• E5: se na lista houver boletos com o status diferente de “impresso” ou “enviado” (enviado para o banco), o sistema exibe uma mensagem informando que há boletos selecionados que ainda não foram impressos ou enviados para o banco e quais são estes boletos. Se o usuário clicar em continuar, o sistema continua a execução e ignora esses boletos;
• E6: se houver um erro na alteração dos registros no banco de dados, uma mensagem será exibida informando que não foi possível marcar os boletos como pagos e solicitando ao usuário que tente novamente e que, caso o erro persista, entre em contato com a BISA. O sistema deve ainda efetuar todas as rotinas de rollback de modo a não deixar ‘lixo’ no banco de dados;
• E7: se o registro do boleto não for encontrado no banco, o sistema exibirá uma mensagem de erro indicando que o boleto não foi encontrado na base de dados do sistema.

[RF010] Baixar Boleto Automaticamente (via Arquivo de Retorno do Banco)
Atores relacionados
Funcionário FETAPE.

Objetivo
Baixar de boletos a partir de um arquivo de retorno que o banco envia.

Prioridade
Essencial.

Entradas e pré condições
Entradas: arquivo de retorno do banco.
Pré-condições: usuário logado no sistema; os registros dos boletos devem estar armazenados no banco de dados.

Saídas e pós-condições
Saídas: mensagem de sucesso da operação.
Pós-condições: registro dos boletos marcados no banco como “pagos”.

Fluxo principal de eventos
1. Na tela da Lista de boletos, usuário clica na opção Baixa com Arquivo do Banco (E1, E2);
2. Uma tela é aberta perguntando qual o arquivo de retorno do banco. O usuário então seleciona o caminho no seu computador correspondente à localização do arquivo e clica em OK. O sistema irá, então, fazer o upload do arquivo (E3, E4, E5);
3. Sistema guarda a identificação do arquivo de retorno com situação de ‘não processado’ na base de dados e guarda uma cópia do arquivo em diretório especifico para histórico;
4. Para cada linha do arquivo de retorno, o sistema procura o boleto referente na base de dados de boletos de contribuição. Se o boleto não for encontrado, o sistema procura na base de dados de boletos avulsos. Nesta base, há registros de boletos com intervalos (ex. de 001 a 100). O sistema irá buscar o número do boleto nessa faixa (E6);
5. O sistema verifica se o boleto encontrado está marcado como “impresso” ou “enviado” (para o banco). Se estiver, o sistema marca no banco de dados o boleto como “pago” (E7);
6. O sistema insere no log de boletos o registro com situação de “pago” com a justificativa ‘baixado pela função de baixa automática de boleto pelo usuário X:Y’, onde X corresponde ao login de usuário e Y corresponde ao seu nome;
7. O Sistema marca o arquivo de retorno como ‘processado sem erros’ e uma exibe mensagem confirmando o sucesso na baixa dos boletos.

Fluxos de exceção
• E1: se não houver conexão com a internet, uma mensagem será exibida informando que não é possível estabelecer uma conexão com a internet e solicitando ao usuário que verifique sua conexão;
• E2: se o sistema não estiver disponível, uma mensagem será exibida informando que o serviço não está disponível e que o usuário deve tentar acessá-lo mais tarde;
• E3: se o usuário não apontar nenhum arquivo de retorno, uma mensagem será exibida exigindo que o usuário aponte o arquivo;
• E4: se o caminho para o arquivo estiver incorreto, o sistema exibe uma mensagem para o usuário informando que o caminho selecionado é inválido;
• E5: se o formato do arquivo não corresponder ao formato do arquivo de retorno do banco esperado, o sistema exibirá uma mensagem informando que o formato do arquivo selecionado é inválido;
• E6: se um registro do arquivo não for encontrado no sistema (base principal e base de boletos avulsos), será exibido numa tela todos os registros que não foram encontrados. A situação do arquivo de retorno no banco deve então mudar para “processado com erro” e o sistema deve inserir o registro de log de boleto com a justificativa “boleto não pode ser baixado, pois o mesmo não foi encontrado no sistema. Ação executada pelo usuário X:Y”, onde X é o login e Y é o nome. O valor do boleto pago e não encontrado deverá ser armazenado na tabela de boletos no registro cujo identificador é “BoletoXXXX”. Todo boleto que não for encontrado deverá ser somado ao valor desse registro;
• E7: se houver um erro na alteração dos registros no banco de dados, uma mensagem será exibida informando que não foi possível marcar os boletos como “pago” e solicitando ao usuário que tente novamente e que, caso o erro persista, entre em contato com a BISA. O sistema deve ainda efetuar todas as rotinas de rollback de modo a não deixar ‘lixo’ no banco de dados.

[RF011] Gerar arquivo de remessa para banco
Atores relacionados
Funcionário FETAPE.

Objetivo
Gerar arquivo de remessa de boletos para o banco.

Prioridade
Essencial.

Entradas e pré condições
Entradas: lista de boletos que serão enviados para o arquivo.
Pré-condições: usuário logado no sistema; os registros dos boletos devem estar armazenados no banco de dados com o status “gerado” ou “impresso”.

Saídas e pós-condições
Saídas: mensagem de sucesso da operação; arquivo de remessa para o banco.
Pós-condições: boletos marcados com o status “enviado” no banco na base de dados.

Fluxo principal de eventos
1. Na tela de Listagem de Boletos, o usuário seleciona os boletos e clica no botão Gerar de arquivo de remessa (E1, E2);
2. Sistema verifica se todos os boletos selecionados estão marcados como “gerado” ou “impresso” (E3);
3. Sistema abre tela para que o usuário informe o nome do arquivo e o local onde ele será gerado (E4, E5);
4. Usuário confirma a geração do arquivo;
5. Sistema gera o arquivo de remessa;
6. Sistema marca no banco os boletos que foram inseridos no arquivo de remessa com o status de “enviado” para o banco (E6);
7. Sistema insere no log de boletos os registros com situação de enviado com a justificativa “boleto gerado no arquivo de remessa para o banco pelo usuário X:Y”, onde X corresponde ao login do usuário e Y corresponde ao seu nome;
8. Sistema salva em diretório especifico no banco uma cópia do arquivo gerado para remessa para fins de histórico;
9. Sistema retorna o arquivo de remessa para que o usuário salve-o em seu computador.

Fluxos de exceção
• E1: se não houver conexão com a internet, uma mensagem será exibida informando que não é possível estabelecer uma conexão com a internet e solicitando ao usuário que verifique sua conexão;
• E2: se o sistema não estiver disponível, uma mensagem será exibida informando que o serviço não está disponível e que o usuário deve tentar acessá-lo mais tarde;
• E3: se o sistema não encontrar nenhum arquivo com o status “gerado” ou “impresso”, uma mensagem será exibida informando que não existem boletos a serem gerados para o arquivo de remessa. Se encontrar, deverá informar quais os boletos não serão gerados no arquivo;
• E4: se o usuário informa um local não existente, o sistema pergunta ao usuário se o mesmo deseja que o sistema crie o diretório de pastas informado. Se a resposta for sim, sistema cria diretório de pasta; se a resposta for não, sistema retorna a tela de informação do local para que o usuário selecione um novo diretório;
• E5: se houver um erro na geração do arquivo de remessa, uma mensagem será exibida informando ao usuário que o arquivo de remessa não pode ser gerado e que o mesmo tente novamente e que, caso o erro persista, entre em contato com a BISA.;
• E6: se houver um erro na alteração dos registros no banco de dados, uma mensagem será exibida informando que não foi possível marcar os boletos como “enviado” e solicitando ao usuário que tente novamente e que, caso o erro persista, entre em contato com a BISA. O sistema deve ainda efetuar todas as rotinas de rollback de modo a não deixar ‘lixo’ no banco de dados.

[RF012] Gerar arquivo de remessa para Gráfica
Atores relacionados
Funcionário FETAPE.

Objetivo
Gerar arquivo de remessa de boletos para Gráfica.

Prioridade
Essencial.

Entradas e pré condições
Entradas: lista de boletos que serão enviados para o arquivo.
Pré-condições: usuário logado no sistema; os registros dos boletos devem estar armazenados no banco de dados com o status “gerado”.

Saídas e pós-condições
Saídas: mensagem de sucesso da operação; arquivo de remessa para a gráfica (em formato txt e xls).
Pós-condições: boletos marcados com o status “enviadoGrafica” no banco na base de dados.

Fluxo principal de eventos
1. Na tela de Listagem de Boletos, o usuário seleciona os boletos e clica no botão Gerar arquivo de boleto para Gráfica (E1, E2);
2. Sistema verifica se todos os boletos selecionados estão marcados como “gerado” (E3);
3. Sistema abre tela para que o usuário informe o nome do arquivo e o local onde ele será gerado (E4, E5);
4. Usuário confirma a geração do arquivo;
5. Sistema pergunta se o usuário quer gerar o arquivo no formato txt ou xls;
6. Sistema gera o arquivo de remessa para Gráfica;
7. Sistema marca no banco os boletos que foram inseridos no arquivo de remessa com o status de “enviadoGrafica” para o banco (E6);
8. Sistema insere no log de boletos os registros com situação de enviado com a justificativa “boleto gerado no arquivo de remessa para Gráfica pelo usuário X:Y”, onde X corresponde ao login do usuário e Y corresponde ao seu nome;
9. Sistema salva em diretório especifico no banco uma cópia do arquivo gerado para remessa para Gráfica para fins de histórico;
10. Sistema retorna o arquivo para que o usuário salve-o em seu computador.

Fluxos de exceção
• E1: se não houver conexão com a internet, uma mensagem será exibida informando que não é possível estabelecer uma conexão com a internet e solicitando ao usuário que verifique sua conexão;
• E2: se o sistema não estiver disponível, uma mensagem será exibida informando que o serviço não está disponível e que o usuário deve tentar acessá-lo mais tarde;
• E3: se o sistema não encontrar nenhum arquivo com o status “gerado”, uma mensagem será exibida informando que não existem boletos a serem gerados para o arquivo de remessa. Se encontrar, deverá informar quais os boletos não serão gerados no arquivo;
• E4: se o usuário informa um local não existente, o sistema pergunta ao usuário se o mesmo deseja que o sistema crie o diretório de pastas informado. Se a resposta for sim, sistema cria diretório de pasta; se a resposta for não, sistema retorna a tela de informação do local para que o usuário selecione um novo diretório;
• E5: se houver um erro na geração do arquivo de remessa, uma mensagem será exibida informando ao usuário que o arquivo de remessa não pode ser gerado e que o mesmo tente novamente e que, caso o erro persista, entre em contato com a BISA;
• E6: se houver um erro na alteração dos registros no banco de dados, uma mensagem será exibida informando que não foi possível marcar os boletos como “enviado” e solicitando ao usuário que tente novamente e que, caso o erro persista, entre em contato com a BISA. O sistema deve ainda efetuar todas as rotinas de rollback de modo a não deixar ‘lixo’ no banco de dados.

4 Especificações Suplementares
4.1 Objetivos
Este documento tem como finalidade especificar todos os requisitos não funcionais do módulo de boletos web divididos em requisitos de usabilidade, confiabilidade, desempenho, segurança, distribuição, adequação a padrões e requisitos de hardware e software.
4.2 Usabilidade
Esta seção descreve os requisitos não funcionais associados à facilidade de uso da interface com o usuário, material de treinamento e documentação do sistema.
[NF001] Interface com o Usuário
Prioridade: Desejável
O sistema deve possuir uma interface amigável, simples e intuitiva.
4.3 Confiabilidade
Esta seção descreve os requisitos não funcionais associados à freqüência, severidade de falhas do sistema e habilidade de recuperação das mesmas, bem como a corretude do sistema.
[NF001] Tempo de Retorno após Falha
Prioridade: Desejável
Retorno de até 5 segundos após alguma falha.
[NF002] Disponibilidade
Prioridade: Importante
O sistema estará disponível 24 horas por dia durante todos os dias do ano.
4.4 Desempenho
Esta seção descreve os requisitos não funcionais associados à eficiência, uso de recursos e tempo de resposta do sistema.
[NF001] Número de Acessos
O sistema deve ser capaz de atender em média 10 usuários por segundo nos momentos de pico de acesso.
[NF002] Tempo de Resposta para os Usuários
O tempo máximo de resposta de uma requisição deve ser de no máximo 10 segundos.

4.5 Segurança
Esta seção descreve os requisitos não funcionais associados à integridade, privacidade e autenticidade dos dados do sistema.
[NF001] Privacidade de Acesso
Apenas os usuários credenciados e com permissão para acesso a este módulo deverão fazer uso das funcionalidades do módulo de boletos/guias na Web.
4.6 Hardware e software
Esta seção descreve os requisitos não funcionais associados ao hardware e software usados para desenvolver ou para executar o sistema.
[NF001] Linguagem de Implementação
Prioridade: Essencial
A linguagem de implementação do módulo de boleto Web será Delphi, mesma linguagem utilizada no desenvolvimento dos sistemas Partidos2000, Receb2000, OAB2000 e Filiados2000.
[NF002] Banco de Dados
Prioridade: Essencial
O banco de dados utilizado será o MySQL.
[NF003] Ferramentas
Prioridade: Essencial
Ferramenta de modelagem: Borland Delphi 2006
Ferramenta de Desenvolvimento: Borland Delphi 2006
[NF004] Plataforma de Funcionamento
Prioridade: Essencial
A plataforma tanto de desenvolvimento e de funcionamento será Windows.

Para uso do Bw- Construindo

2013-01-22T13:00:31Z

AnaPaula: /* Saídas e pós-condições */

Para uso do Bw- Construindo

2013-01-22T12:59:20Z

AnaPaula: /* Fluxo principal de eventos */

Para uso do Bw- Construindo

2013-01-22T12:06:06Z

AnaPaula: /* Fluxos de exceção */

Para uso do Bw- Construindo

2013-01-21T20:21:09Z

AnaPaula:

Arquivo:BoletosWeb.PNG

2013-01-21T19:55:36Z

AnaPaula: foi enviada uma nova versão de "Arquivo:BoletosWeb.PNG"

Para uso do Bw- Construindo

2013-01-21T19:53:51Z

AnaPaula: