Prefeitura da Cidade Digital
Sistema de Arrecadação de IPTU – SAI
Documento de Especificação de Casos de Uso
UC013 – Transferência de Arquivo Bancário
Sistema de Arrecadação de IPTU – SAI
Documento de Especificação de Casos de Uso
UC013 – Transferência de Arquivo Bancário
Versão 1.2
Prefeitura da Cidade Digital
Sistema de Arrecadação de IPTU – SAI
Documento de Especificação de Casos de Uso
UC013 – Transferência de Arquivo Bancário
Histórico de Revisão
Data
29/09/2008
13/10/2008
Versão
1.0
1.1
21/10/2008
1.2
Descrição
Documento inicial
Ajustes no diagrama, fluxo principal e alternativos,
regras de negócio e exceções. Inclusão de
premissas/dependências e sub-fluxos.
Desmembramento do caso de uso (UC012 e
UC013).
Assessoria de Tecnologia da Informação,
Autor (es)
Roberto Miyaba
Roberto Miyaba
Roberto Miyaba
Página 2 de 17
Prefeitura da Cidade Digital
Sistema de Arrecadação de IPTU – SAI
Documento de Especificação de Casos de Uso
UC013 – Transferência de Arquivo Bancário
Sumário
1. Descrição Geral ................................................................................................................................... 5
1.1 Perspectiva ................................................................................................................................ 5
1.2 Definições, Acrônimos, e Abreviações ...................................................................................... 5
1.3 Referências ................................................................................................................................ 5
1.4 Atores ......................................................................................................................................... 6
1.5 Premissas e dependências ........................................................................................................ 6
2. Fluxo de Eventos ................................................................................................................................. 6
2.1 RECEBER ARQUIVO DE RETORNO ....................................................................................... 6
2.1.1 Objetivo
6
2.1.2 Atores
6
2.1.3 Dados consumidos
6
2.1.4 Dados produzidos
6
2.1.5 Pré-condições
6
2.1.6 Pós-condições
6
2.1.7 Requisitos especiais
6
2.1.8 Demais interfaces
6
2.1.9 Observações
6
2.1.10 Fluxo principal
7
2.1.11 Fluxos alternativos
7
2.1.12 Regras de negócios
8
2.1.13 Regras de negócios específicas
12
2.2 SOLICITAR REPROCESSAMENTO DE RETORNO .............................................................. 13
2.2.1 Objetivo
13
2.2.2 Atores
13
2.2.3 Dados consumidos
13
2.2.4 Dados produzidos
13
2.2.5 Pré-condições
13
2.2.6 Pós-condições
13
2.2.7 Requisitos especiais
13
2.2.8 Demais interfaces
13
2.2.9 Observações
13
2.2.10 Fluxo principal
13
2.2.11 Fluxos alternativos
14
2.2.12 Regras de negócios específicas
14
2.3 CONSULTA RETORNOS ........................................................................................................ 14
2.3.1 Objetivo
14
2.3.2 Atores
14
2.3.3 Dados consumidos
14
2.3.4 Dados produzidos
14
2.3.5 Pré-condições
14
2.3.6 Pós-condições
14
2.3.7 Requisitos especiais
14
2.3.8 Demais interfaces
14
2.3.9 Observações
15
2.3.10 Fluxo principal
15
2.3.11 Fluxos alternativos
15
2.3.12 Regras de negócios
16
2.3.13 Regras de negócios específicas
16
2.4 CANCELAR SOLICITAÇÃO DE REPROCESSAMENTO DE RETORNO .............................. 16
2.4.1 Objetivo
16
2.4.2 Atores
16
Assessoria de Tecnologia da Informação,
Página 3 de 17
Prefeitura da Cidade Digital
Sistema de Arrecadação de IPTU – SAI
Documento de Especificação de Casos de Uso
UC013 – Transferência de Arquivo Bancário
2.4.3 Dados consumidos
2.4.4 Dados produzidos
2.4.5 Pré-condições
2.4.6 Pós-condições
2.4.7 Requisitos especiais
2.4.8 Demais interfaces
2.4.9 Observações
2.4.10 Fluxo principal
2.4.11 Fluxos alternativos
2.4.12 Regras de negócios específicas
Assessoria de Tecnologia da Informação,
16
16
16
16
17
17
17
17
17
17
Página 4 de 17
Prefeitura da Cidade Digital
Sistema de Arrecadação de IPTU – SAI
Documento de Especificação de Casos de Uso
UC013 – Transferência de Arquivo Bancário
Documento de Especificação de Casos de Uso
UC013 – Transferência de Arquivo Bancário
1.
Descrição Geral
1.1
Perspectiva
As funções a serem desenvolvidas a partir deste documento deverão permitir efetuar
a transferência de arquivos de remessa e/ou retorno, considerando o leiaute Padrão
FEBRABAN 240 Posições.
1.2
Definições, Acrônimos, e Abreviações
Ver Documento de Glossário, disponível no endereço
http://engsoft.williansilva.net/documents/glossario.pdf
1.3
Referências
Título
Memória de
reunião 1
Memória de
reunião 2
Memória de
reunião 3
Memória de
reunião 4
Memória de
reunião 5
Memória de
reunião 6
Memória de
reunião 7
Documento de
Glossário
Código Tributário
Municipal
Manual de
Avaliação de
Imóveis
Padrão
FEBRABAN 240
Posições
Padrão de
Arrecadação/
Recebimento
com Utilização
do Código de
Barras
Versão
1.0
Data
12/08/2008
Onde pode ser obtido
http://engsoft.williansilva.net/Ata01.pdf
1.0
19/08/2008
http://engsoft.williansilva.net/Ata02.pdf
1.0
26/08/2008
http://engsoft.williansilva.net/Ata03.pdf
1.0
02/09/2008
http://engsoft.williansilva.net/Ata04.pdf
1.0
09/09/2008
http://engsoft.williansilva.net/Ata05.pdf
1.0
16/09/2008
http://engsoft.williansilva.net/Ata06.pdf
1.0
07/10/2008
http://engsoft.williansilva.net/Ata07.pdf
1.0R02
25/10/2008
http://engsoft.williansilva.net/glossario.pdf
1.8
21/12/2001
http://engsoft.williansilva.net/ctmcd.pdf
1.0
29/07/1989
http://engsoft.williansilva.net/maicd.pdf
8.3
23/09/2008
http://engsoft.williansilva.net/Febraban240pV8.3.pdf
4.0
28/05/2004
http://engsoft.williansilva.net/Codbar4-v28052004.pdf
Assessoria de Tecnologia da Informação,
Página 5 de 17
Prefeitura da Cidade Digital
Sistema de Arrecadação de IPTU – SAI
Documento de Especificação de Casos de Uso
UC013 – Transferência de Arquivo Bancário
1.4
Atores
Nome Ator
Sistema IED
Usuário Autorizado
1.5
Descrição
Sistema de intermediação entre o cliente e o banco, para
transmissão/recebimento de arquivos.
Funcionário da Prefeitura habilitado para efetuar transações diversas
no sistema, como consultas e transferências de arquivos.
Premissas e dependências
Premissa/Dependência
Integração com outros
sistemas
Descrição
Se algum dos sistemas externos que interagem com o SAI estiver
indisponível (inclusive o link de comunicação com o banco), o
funcionamento das funções deste caso de uso ficará comprometido.
2.
Fluxo de Eventos
2.1
RECEBER ARQUIVO DE RETORNO
2.1.1 Objetivo
Permitir o recebimento de arquivo de retorno disponibilizado pelo banco.
2.1.2 Atores
• Sistema IED;
• Usuário autorizado.
2.1.3 Dados consumidos
• Identificador do usuário;
• Identificador de empresa cliente do banco;
• Arquivos de retorno disponíveis para o cliente.
2.1.4 Dados produzidos
• Confirmação da recepção do arquivo de retorno.
2.1.5 Pré-condições
• Não se aplica.
2.1.6 Pós-condições
• Não se aplica.
2.1.7 Requisitos especiais
• Não se aplica.
2.1.8 Demais interfaces
• Não se aplica.
2.1.9 Observações
Nihil.
Assessoria de Tecnologia da Informação,
Página 6 de 17
Prefeitura da Cidade Digital
Sistema de Arrecadação de IPTU – SAI
Documento de Especificação de Casos de Uso
UC013 – Transferência de Arquivo Bancário
2.1.10Fluxo principal
Este caso de uso se inicia quando o usuário autorizado necessita receber um
arquivo de retorno bancário.
Ação do Ator
[P01] Usuário autorizado seleciona o
procedimento “Receber arquivo de retorno”
da opção “Transferência de Arquivo
Bancário”.
Resposta do Sistema
[P02] Recupera identificador do usuário
autorizado e identificador da empresa cliente
do banco.
[P03] Solicita ao sistema IED lista com os
arquivos de retorno disponíveis.
[P04] Recebe do sistema IED lista com os
arquivos de retorno disponíveis.
[P05] Caso não receba lista do sistema IED.
[A01: Apresentar mensagem de erro]
[P06] Apresenta arquivos de retorno
disponíveis para seleção.
[P07] Usuário autorizado seleciona arquivo(s) [P08] Informa sistema IED sobre recebimento
de retorno que deseja receber.
do(s) arquivo(s) de retorno.
[P09] Recebe, descriptografa e descompacta
o(s) arquivo(s) de retorno.
[P10] Solicita ao sistema IED confirmar o
recebimento do(s) arquivo(s) de retorno.
[P11] Recebe do sistema IED confirmação do
recebimento do(s) arquivo(s) de retorno.
[P12] Usuário autorizado seleciona arquivo(s) [P13] Processa o(s) arquivo(s) de retorno
de retorno que deseja efetuar a conciliação
para atualização do(s) registro(s) de
bancária (gestão de caixa automatizada).
arrecadação. [RN01]
[P14] Caso haja erro na estrutura do(s)
arquivo(s) de retorno. [A02: Apresentar
mensagem de erro de leiaute do arquivo de
retorno]
[P15] Caso haja arquivo(s) de retorno em
duplicidade. [A03: Apresentar mensagem de
erro de tratamento de arquivo de retorno]
[P16] Inclui indicativo de arquivo(s) de retorno
processado.
[P17] Fim do Caso de Uso.
2.1.11 Fluxos alternativos
[A01: Apresentar mensagem de erro]
Ação do Ator
Assessoria de Tecnologia da Informação,
Resposta do Sistema
[P01] Apresenta mensagem de erro.
[P02] Retorna ao passo [P17] do fluxo
principal.
Página 7 de 17
Prefeitura da Cidade Digital
Sistema de Arrecadação de IPTU – SAI
Documento de Especificação de Casos de Uso
UC013 – Transferência de Arquivo Bancário
[A02: Apresentar mensagem de erro de leiaute do arquivo de retorno]
Ação do Ator
Resposta do Sistema
[P01] Apresenta mensagem de erro.
[P02] Inclui indicativo de arquivo(s) de retorno
com erro de leiaute.
[P03] Retorna ao passo [P17] do fluxo
principal.
[A03: Apresentar mensagem de erro de tratamento de arquivo de retorno]
Ação do Ator
Resposta do Sistema
[P01] Apresenta mensagem de erro.
[P02] Inclui indicativo de arquivo(s) de retorno
em duplicidade.
[P03] Retorna ao passo [P17] do fluxo
principal.
2.1.12 Regras de negócios
[RN01: Extrato para Gestão de Caixa - Retorno]
No passo [P13] o sistema verificará a estrutura do arquivo de retorno (lote, registros,
identificação e detalhamento da natureza do lançamento).
Estrutura do Lote
Assessoria de Tecnologia da Informação,
Página 8 de 17
Prefeitura da Cidade Digital
Sistema de Arrecadação de IPTU – SAI
Documento de Especificação de Casos de Uso
UC013 – Transferência de Arquivo Bancário
Um Lote de Extrato para Gestão de Caixa é composto por:
um registro Header de Lote;
um registro de Saldo Inicial para cada Natureza de Saldo;
vários registros Detalhe, onde um registro Segmento F com os dados de um
Lançamento pode vir seguido de um registro Segmento I que decompõe o
valor do Lançamento nos montantes que afetam os diferentes tipos de saldo;
um registro de Saldo Final para cada Natureza de Saldo;
um registro Trailer de Lote.
Observações:
Tamanho do Registro
O Tamanho do Registro é de 240 bytes.
Alinhamento de Campos
Campos Numéricos (Num) = Sempre à direita e preenchidos com zeros à
esquerda.
Campos Alfanuméricos (Alfa) = Sempre à esquerda e preenchidos com
brancos à direita.
Registro Header de Lote
Assessoria de Tecnologia da Informação,
Página 9 de 17
Prefeitura da Cidade Digital
Sistema de Arrecadação de IPTU – SAI
Documento de Especificação de Casos de Uso
UC013 – Transferência de Arquivo Bancário
Registro Saldo Inicial
Registro Detalhe Segmento F (Obrigatório - Retorno)
Assessoria de Tecnologia da Informação,
Página 10 de 17
Prefeitura da Cidade Digital
Sistema de Arrecadação de IPTU – SAI
Documento de Especificação de Casos de Uso
UC013 – Transferência de Arquivo Bancário
Registro Detalhe - Segmento I (Opcional - Retorno)
Registro Saldo Final
Assessoria de Tecnologia da Informação,
Página 11 de 17
Prefeitura da Cidade Digital
Sistema de Arrecadação de IPTU – SAI
Documento de Especificação de Casos de Uso
UC013 – Transferência de Arquivo Bancário
Registro Trailer de Lote
2.1.13 Regras de negócios específicas
• Conforme documento padrão FEBRABAN 240 Posições;
• A comunicação entre o cliente e o banco está baseada na troca de
mensagens (Strings). O protocolo estabelecido está definido por um
Header e uma Input (na solicitação) ou Output (na resposta);
• Quando ocorre erro na resposta de uma transação (campo código de erro
diferente de zero no Header), o cliente é informado da origem do erro,
através de campo especifico do Header.
Assessoria de Tecnologia da Informação,
Página 12 de 17
Prefeitura da Cidade Digital
Sistema de Arrecadação de IPTU – SAI
Documento de Especificação de Casos de Uso
UC013 – Transferência de Arquivo Bancário
2.2
SOLICITAR REPROCESSAMENTO DE RETORNO
2.2.1 Objetivo
Permitir solicitação de reprocessamento de um retorno disponibilizado
anteriormente.
2.2.2 Atores
• Sistema IED;
• Usuário autorizado.
2.2.3 Dados consumidos
• Reprocessamento do retorno.
2.2.4 Dados produzidos
• Confirmação da solicitação de reprocessamento do retorno.
2.2.5 Pré-condições
• Não se aplica.
2.2.6 Pós-condições
• Não se aplica.
2.2.7 Requisitos especiais
• Não se aplica.
2.2.8 Demais interfaces
• Não se aplica.
2.2.9 Observações
Nihil.
2.2.10 Fluxo principal
Este caso de uso se inicia quando o usuário autorizado deseja, após ter
consultado os retornos, solicitar o reprocessamento de um dos retornos
apresentados.
Ação do Ator
[P01] Usuário autorizado seleciona o
procedimento “Solicitar reprocessamento de
retorno”.
Resposta do Sistema
[P02] [Include: Consultar retornos].
[P03] Verifica a possibilidade de solicitação
de reprocessamento de um retorno.
[P04] Solicita ao sistema IED o
reprocessamento do retorno.
[P05] Recebe do sistema IED confirmação do
reprocessamento do retorno.
[P06] Caso não receba confirmação do
sistema IED. [A01: Apresentar mensagem de
erro]
[P07] Apresenta confirmação da solicitação
de reprocessamento do retorno.
[P08] Fim do Caso de Uso.
Assessoria de Tecnologia da Informação,
Página 13 de 17
Prefeitura da Cidade Digital
Sistema de Arrecadação de IPTU – SAI
Documento de Especificação de Casos de Uso
UC013 – Transferência de Arquivo Bancário
2.2.11 Fluxos alternativos
[A01: Apresentar mensagem de erro]
Ação do Ator
Resposta do Sistema
[P01] Apresenta mensagem de erro.
[P02] Retorna ao passo [P08] do fluxo
principal.
2.2.12 Regras de negócios específicas
• Conforme documento padrão FEBRABAN 240 Posições;
• A comunicação entre o cliente e o banco está baseada na troca de
mensagens (Strings). O protocolo estabelecido está definido por um
Header e uma Input (na solicitação) ou Output (na resposta);
• Quando ocorre erro na resposta de uma transação (campo código de erro
diferente de zero no Header), o cliente é informado da origem do erro,
através de campo especifico do Header.
2.3
CONSULTA RETORNOS
2.3.1 Objetivo
Permitir a visualização dos arquivos de retorno.
2.3.2 Atores
• Sistema IED;
• Usuário autorizado.
2.3.3 Dados consumidos
• Identificador da empresa cliente do banco;
• Período para pesquisa;
• Retornos no período;
• Dados do histórico do retorno.
2.3.4 Dados produzidos
• Lista de retornos.
2.3.5 Pré-condições
• Não se aplica.
2.3.6 Pós-condições
• Não se aplica.
2.3.7 Requisitos especiais
• Não se aplica.
2.3.8 Demais interfaces
• Não se aplica.
Assessoria de Tecnologia da Informação,
Página 14 de 17
Prefeitura da Cidade Digital
Sistema de Arrecadação de IPTU – SAI
Documento de Especificação de Casos de Uso
UC013 – Transferência de Arquivo Bancário
2.3.9 Observações
Nihil.
2.3.10 Fluxo principal
Este caso de uso se inicia quando um usuário autorizado deseja consultar os
arquivos de retorno bancário disponíveis para transferência.
Ação do Ator
[P01] Usuário autorizado seleciona o
procedimento “Consulta retornos” da opção
“Transferência de Arquivo Bancário”.
[P03] Usuário autorizado informa período da
pesquisa [RN02].
Resposta do Sistema
[P02] Recupera identificador do usuário
autorizado e identificador da empresa cliente
do banco.
[P04] Solicita ao sistema IED lista com os
arquivos de retorno disponíveis.
[P05] Recebe lista do sistema IED, com os
arquivos de retorno disponíveis.
[P06] Caso não receba lista do sistema IED.
[A01: Apresentar mensagem de erro]
[P07] Disponibiliza opção para consultar
histórico de um retorno. [A02: Consultar
histórico de um retorno]
[P08] Fim do Caso de Uso.
2.3.11 Fluxos alternativos
[A01: Apresentar mensagem de erro]
Ação do Ator
Resposta do Sistema
[P01] Apresenta mensagem de erro.
[P02] Retorna ao passo [P08] do fluxo
principal.
[A02: Consultar histórico de um retorno]
Ação do Ator
Assessoria de Tecnologia da Informação,
Resposta do Sistema
[P01] Solicita ao sistema IED os dados do
histórico do retorno.
[P02] Recebe do sistema IED os dados do
histórico do retorno.
[P03] Apresenta os dados do histórico do
retorno [RN03].
[P04] Retorna ao passo [P05] do fluxo
principal.
Página 15 de 17
Prefeitura da Cidade Digital
Sistema de Arrecadação de IPTU – SAI
Documento de Especificação de Casos de Uso
UC013 – Transferência de Arquivo Bancário
2.3.12 Regras de negócios
[RN02: Período para Pesquisa de Arquivos Retorno]
No passo [P03] o sistema verificará os dados informados.
Campos
Campo
Data Inicial
Data Final
Verificações
O dado informado deverá estar no formata DD/MM/AAAA e o valor
numérico de AAAA deverá ser menor ou igual à data corrente.
O dado informado deverá estar no formata DD/MM/AAAA e o valor
numérico de AAAA deverá ser menor ou igual à data corrente.
[RN03: Dados do Histórico de Arquivos Retorno]
No passo [P03] do fluxo alternativo [A02] o sistema verificará o detalhamento da
resposta da transação, para apresentação dos dados relativos à data do arquivo,
data de movimento, data e horário da transação, chave do operador.
2.3.13 Regras de negócios específicas
• Conforme documento padrão FEBRABAN 240 Posições;
• A comunicação entre o cliente e o banco está baseada na troca de
mensagens (Strings). O protocolo estabelecido está definido por um
Header e uma Input (na solicitação) ou Output (na resposta);
• Quando ocorre erro na resposta de uma transação (campo código de erro
diferente de zero no Header), o cliente é informado da origem do erro,
através de campo especifico do Header.
2.4
CANCELAR SOLICITAÇÃO DE REPROCESSAMENTO DE RETORNO
2.4.1 Objetivo
Permitir o cancelamento de uma solicitação de reprocessamento de retorno
previamente solicitado.
2.4.2 Atores
• Sistema IED;
• Usuário autorizado.
2.4.3 Dados consumidos
• Cancelamento da solicitação de reprocessamento de retorno.
2.4.4 Dados produzidos
• Confirmação do cancelamento.
2.4.5 Pré-condições
• Não se aplica.
2.4.6 Pós-condições
• Não se aplica.
Assessoria de Tecnologia da Informação,
Página 16 de 17
Prefeitura da Cidade Digital
Sistema de Arrecadação de IPTU – SAI
Documento de Especificação de Casos de Uso
UC013 – Transferência de Arquivo Bancário
2.4.7 Requisitos especiais
• Não se aplica.
2.4.8 Demais interfaces
• Não se aplica.
2.4.9 Observações
Nihil.
2.4.10 Fluxo principal
Este caso de uso se inicia quando o usuário autorizado deseja, após ter
consultado os retornos, cancelar uma solicitação de reprocessamento de
retorno.
Ação do Ator
[P01] Usuário autorizado seleciona o
procedimento “Cancelar solicitação de
reprocessamento de retorno”.
[P03] Usuário autorizado informa período da
pesquisa.
Resposta do Sistema
[P02] [Include: Consultar retornos].
[P04] Verifica a possibilidade de
cancelamento da solicitação de
reprocessamento de um retorno.
[P05] Solicita ao sistema IED cancelamento
da solicitação de reprocessamento do
retorno.
[P06] Recebe do sistema IED confirmação da
solicitação de cancelamento.
[P07] Caso não receba confirmação do
sistema IED. [A01: Apresentar mensagem de
erro]
[P08] Apresenta confirmação da solicitação
de cancelamento.
[P09] Fim do Caso de Uso.
2.4.11 Fluxos alternativos
[A01: Apresentar mensagem de erro]
Ação do Ator
Resposta do Sistema
[P01] Apresenta mensagem de erro.
[P02] Retorna ao passo [P09] do fluxo
principal.
2.4.12 Regras de negócios específicas
• Conforme documento padrão FEBRABAN 240 Posições;
• A comunicação entre o cliente e o banco está baseada na troca de
mensagens (Strings). O protocolo estabelecido está definido por um
Header e uma Input (na solicitação) ou Output (na resposta);
• Quando ocorre erro na resposta de uma transação (campo código de erro
diferente de zero no Header), o cliente é informado da origem do erro,
através de campo especifico do Header.
Assessoria de Tecnologia da Informação,
Página 17 de 17