GUIA DE ELABORAO DA ESPECIFICAO

DE CASO DE USO BATCH DA SECRETARIA DE

FAZENDA/DF
Verso 2.1

Guia de elaborao de Especificao

de Caso de Uso

Histrico de Reviso
Data

Verso

Descrio

Autor

05/09/2013

1.0

Elaborao do guia com

orientaes e exemplos

Kelly

28/11/2013

Atualizao
da
descrio do histrico
de reviso

Excluso da descrio
do fluxo de eventos
para incluso no fluxo
bsico

2.0

22/04/2014

2.1

Atualizao do ndice

Incluso de legenda
nas regras de negcio

Atualizao
exemplo do PE1

Alterao do texto do
item 12 Aprovao

Revisor

Daniela

do

Daniela

<No Histrico de Revises dever constar a alterao que foi feita no documento, conforme
exemplo abaixo. Deve ser indicada a demanda Oasis que solicitou a alterao. A verso do
histrico de reviso s dever ser atualizada no momento da entrega do artefato >

Data

Verso

Descrio

Autor

Revisor

xxxx

xxxx

Atendimento ao OASIS 9999/2013

15/06/201
2

1.6

Confidencial

Alterao da RN11, RN35

Incluso das RNs: 49 a 60;

Alterao dos fluxos FA2 e FA4

Correo ortogrfica;

Secretaria de Estado de Fazenda

Pgina 2 de 13

Guia de elaborao de Especificao

de Caso de Uso
Especificao de Caso de Uso
ndice
<Nome do Caso de Uso>
4
1. Descrio 4
2. Atores
4
3. Pr-Condies
4
3.1 <nome da pr-condio> 4
4. Fluxo de Eventos 4
4.1 Fluxo Bsico <nome do fluxo bsico> 5
Fluxo Bsico Envio do acompanhamento dos arquivos
4.2 Fluxos Alternativos
6
4.3 Fluxos de Exceo 6
FE1. Arquivo gerado vazio 7
5. Regras de Negcio8
[RN1] <layout de arquivo (processamento batch)> 8
[RN2]. Recuperao das notas de empenho 10
6. Ps-Condies
11
7. Pontos de Extenso
11
8. Requisitos Especiais
11
9. Referncias
12
10.
Observaes 12
11.
Aprovao
13

Confidencial

Secretaria de Estado de Fazenda

Pgina 3 de 13

Guia de elaborao de Especificao

de Caso de Uso

Especificao de Caso de Uso

<Nome do Caso de Uso>
<O nome do caso dever ser no infinitivo>

1.

Descrio
<Neste item, dever ser descrito resumidamente o objetivo geral do caso de uso.>
Exemplo:
Este caso de uso permite ao ator realizar a incluso, alterao, excluso e
consulta de subitens de despesas e grupos de elementos de despesas.

2.

Atores
<Deve ser indicado os atores que tenham interao com o caso de uso. Normalmente, para
processamento batch, deve ser colocado No se aplica.>
Exemplos:
No se aplica.

3.

Pr-Condies

3.1

<nome da pr-condio>
<A pr-condio um estado observvel pelo usurio, mas no o evento que inicia o caso de uso,
podendo ser considerada uma premissa. Este tipo de informao somente deve ser includo na
especificao quando for aplicvel.>
Exemplo:
3.1 Recebimento de arquivo

Dever ser verificado se o arquivo esperado do Banco do Brasil

foi recepcionado.

4.

Fluxo de Eventos

Confidencial

Secretaria de Estado de Fazenda

Pgina 4 de 13

Guia de elaborao de Especificao

de Caso de Uso
4.1

Fluxo Bsico <nome do fluxo bsico>

Este caso de uso se inicia <descrio do incio do caso de uso>

<Descrever quem e para qu o caso de uso iniciado para realizar a especificao dos
Fluxos>
Exemplos:
1. Este caso de uso se inicia quando o o sistema BFI alimentado com um novo
benefcio concedido.
2. Este caso de uso inicia-se quando o rob dentro do seu ciclo temporizador
identifca que o horrio previsto para nicio do ciclo foi alcanado

FB1. <Descrio do passo 1 do fluxo bsico>. [RN999] [FA1] [FA2] [FA3]

FB2. <Descrio do passo 2>. [RNG999] [FE1] [M99]
FB3. Finaliza caso de uso.
< No Fluxo Bsico dever estar descrito todo o processamento que a funcionalidade dever executar.
Dever ser mencionado no seu contedo onde o sistema recupera as informaes e quais so elas, o que
sistema grava, lista, envia, etc. Sempre deve ser mencionado o destino e a origem das informaes.>

Exemplo:

Fluxo Bsico Envio do acompanhamento dos arquivos

FB.1 O sistema recupera as seguintes informaes no arquivo de configurao do rob:
Pasta onde devem ser gravados os arquivos de LOG;
Horrio do prximo ciclo;
Lista de destinatrios de e-mail do LOG de processamento;
FB.2 O sistema verifica a existncia de arquivos gerados e/ou recebidos desde o ltimo
processamento;
FB.3 O sistema recupera as seguintes informaes do Cadastro de LOG da integrao;
Nome do arquivo;
Indicador do tipo da ao E Enviado ou R Recebido;
Data do envio/recebimento do arquivo;
Indicador da situao do processamento do arquivo P Processado com sucesso
ou X Processado com erro.

Confidencial

Secretaria de Estado de Fazenda

Pgina 5 de 13

Guia de elaborao de Especificao

de Caso de Uso
FB.4 O sistema envia e-mail para a lista de destinatrios com as seguintes informaes:
Data do processamento;
Quantidade de arquivos recebidos com sucesso;
[Relao de arquivos recebidos com sucesso contendo a seguinte informao]
Nome do arquivo recebido com sucesso;
Quantidade de arquivos recebidos com erro;
[Relao de arquivos recebidos com erro contendo a seguinte informao]
Nome do arquivo recebido com erro;
Quantidade de arquivos enviados com sucesso;
[Relao de arquivos enviados com sucesso contendo a seguinte informao]

Nome do arquivo enviado com sucesso;

Quantidade de arquivos enviados com erro;

[Relao de arquivos enviados com erro contendo a seguinte informao]

Nome do arquivo enviado com erro;

FB.5 O caso de uso encerrado;

4.2

Fluxos Alternativos
FA1. <Nome do fluxo alternativo>

No(s) passo(s) <nmero do(s) passo(s) do fluxo bsico ou do fluxo alternativo onde
existe a possibilidade de ocorrncia de um fluxo alternativo > do <fluxo bsico ou fluxo alternativo>, caso
<descrio da condio de ocorrncia do fluxo alternativo>, devem ser executados os seguintes passos:
FA.1.1. <Descrio do passo do fluxo alternativo>.
FA.1.2. <Descrio do passo do fluxo alternativo>.
FA.1.3. <Descrio do passo do fluxo alternativo>.
FA.1.4. Finaliza caso de uso ou Retorna ao passo FB?? do Fluxo Bsico ou do Fluxo
Alternativo FA?? ou Fluxo de Exceo FE??.
<No fluxo alternativo dever estar descrito o nmero dos passos do fluxo bsico ou do fluxo alternativo
onde existe a possibilidade de ocorrncia de um fluxo alternativo>

4.3

Fluxos de Exceo
FE1. <Nome do fluxo de exceo>

Confidencial

Secretaria de Estado de Fazenda

Pgina 6 de 13

Guia de elaborao de Especificao

de Caso de Uso
FE.1.1. <Descrio do passo do fluxo de exceo>.
FE.1.2. <Descrio do passo do fluxo de exceo>.
FE.1.3. <Descrio do passo do fluxo de exceo>.
FE.1.4. Finaliza caso de uso ou Retorna ao passo FB?? do Fluxo Bsico ou do Fluxo
Alternativo FA?? ou Fluxo de Exceo FE??.
< O nome do fluxo deve ser objetivo e representar claramente a exceo;
- As excees devem tratar todos os problemas possveis e situaes que interrompam a execuo do caso
de uso;
- As excees no necessariamente encerram o caso de uso, mas elas devem impedir a continuidade do
fluxo.
- Cada exceo ou erro exclusivo podem ser capturados como um Fluxo de Exceo. A principal
informao a ser captada : qual deve ser a experincia dos atores quando ocorrerem excees?.>
Exemplo:
FE1. Arquivo gerado vazio
Este fluxo alternativo se inicia quando: No passo Error: Reference source not found o
sistema verifica que no existe nenhuma nota de empenho emitida para a data de
execuo do processo batch;
FA1.1.
O sistema verifica que no existe nenhuma informao a ser
apresentada nos arquivos;
FA1.2.
O sistema gera os arquivos PTBSIGMA, PTBSIGMADE e PTBSIGMAST
sem nenhuma informao;
FA1.3.

Confidencial

O caso de uso finalizado;

Secretaria de Estado de Fazenda

Pgina 7 de 13

Guia de elaborao de Especificao

de Caso de Uso
5.

Regras de Negcio
< Neste item, devero ser colocadas as regras de negcio envolvidas no processamento. O layout de arquivos de entrada e sada devero colocados
antes da especificao das regras de negcios envolvidas na funcionalidade>
<Dever ser seguido o template da tabela de especificao abaixo>
<O contedo dos campos da tabela esto exemplificados na tabela a seguir>
<Dever ser marcado com X a regra de cada campo. Dever ser indicado se o campo :
O - Preenchimento obrigatrio
< Quando o caso de uso for documentado aps a implementao da funcionalidade/sistema, o contedo das regras de negcio dever descrever a origem e destino das
informaes trabalhadas.>

Exemplo:
- Informao recuperada do SIGEP - Cadastro do rgo Sigla rgo
- Informao includa no SIGEP - Cadastro de Funcionrios Nome Pessoa
- Informao consultada no SIGEP - Cadastro de Histrico de Frias Data de Fruio Inicial

[RN1] <layout de arquivo (processamento batch)>

Exemplo: Gerar Arquivo Nota de Empenho - SIGGO
Legenda
N. - Nmero seqencial do Atributo. O - Preenchimento obrigatrio

N.

Nome do Atributo

Descrio do
Contedo

Tipo

Domnio

Tamanho

Mscara

N/A

DDMMAAAA

Regra

Parmetros de entrada
[RN1.1]

Data de execuo do
processamento

Confidencial

Data que o
processamento batch
est sendo
executado

Secretaria de Estado de Fazenda

Pgina 8 de 13

A data de
processamento deve
ser a data corrente.

Guia de elaborao de Especificao

de Caso de Uso
Header
A data de emisso
deve ser igual a data
de execuo do
processamento

Data de emisso

Data de gerao do
arquivo

[RN1.3]

Cdigo do credor

Cdigo do credor da
nota de empenho

[RN1.4]

Cdigo do evento

N/A

N/A

N/A

[RN1.5]

Cdigo da funo

N/A

N/A

N/A

[RN1.6]

Cdigo da subfuno

N/A

N/A

N/A

[RN1.7]

Cdigo do programa

N/A

N/A

N/A

[RN1.8]

Cdigo do projeto

N/A

N/A

N/A

[RN1.9]

Cdigo do subttulo

N/A

N/A

N/A

[RN1.10]

Cdigo da natureza

N/A

N/A

N/A

[RN1.11]

Modalidade
Nmero da nota de
empenho original
Valor do documento

N/A

N/A

N/A

N/A

N/A

N/A

N/A

15,2

N/A

N/A

N/A

10

N/A

N/A

N/A

N/A

N/A

[RN1.16]

Nmero do processo
Cdigo da unidade
gestora
Cdigo da gesto

N/A

N/A

N/A

[RN1.17]

...

[RN1.2]

Date

N/A

DDMMAAAA

N/A

N/A

N/A

Detalhe

[RN1.12]
[RN1.13]
[RN1.14]
[RN1.15]

N/A

Trailler
[RN1.18]
[RN1.19]

Qtde de Registros
lidos
Hora da execuo

N/A

N/A

10

N/A
99:99:99

N/A No se Aplica.
Tipo: A Alfanumrico, N Numrico, I Inteiro, D Decimal, TS TimeStamp, DT Data, LK Link, BT Boto, SU - .Seleo nica, SM Seleo Mltipla, LO
Lista de Opes.

Confidencial

Secretaria de Estado de Fazenda

Pgina 9 de 13

Guia de elaborao de Especificao

de Caso de Uso

[RN2]. Recuperao das notas de empenho

O sistema recupera informaes de notas de empenho emitidas onde a data de emisso seja igual a data de execuo do processo
batch e o cdigo da natureza da despesa seja igual a 339030 ou 339092 ou 449052 ou 449092.

Confidencial

Secretaria de Estado de Fazenda

Pgina 10 de 13

Guia de elaborao de Especificao

de Caso de Uso
6.

Ps-Condies

6.1. <nome da ps-condio>

<Descrio da ps-condio>.
<Ps-condio a descrio do estado do sistema aps a execuo do caso de uso. A ps-condio de um caso de
uso deve ser verdadeira independentemente dos fluxos alternativos que foram executados; no deve ser verdadeira
apenas para o fluxo principal. Ao fazer uso deste recurso em casos de uso que possuem pontos de extenso,
preciso garantir que os passos definidos no caso de uso de extenso no violem a ps-condio definida. Este
tipo de informao somente deve ser includo na especificao quando for aplicvel. A ps-condio deve ser
relevante e no o objetivo do caso de uso.>
Exemplo:
Todos os procedimentos executados pelo rob, alm de serem enviados por e-mail, ficaro
registrados numa cpia idntica do arquivo de LOG na pasta indicada no arquivo de
configurao do rob.

7.

Pontos de Extenso

PE1. <nome do ponto de extenso>

<Descrio do ponto de extenso>.
<Nos relacionamentos entre casos de uso com esteretipo <<extenso>>, caso este caso de uso seja a
base, indicar a existncia de pontos de extenso nesta seo.>
Exemplo:
PE1. Ativao do Registro de Ponto
No passo 5 do FA6, caso o Configurador do Ponto Eletrnico solicita a ativao dos
registros de ponto vinculados a Norma do Ponto Eletrnico, deve-se extender o Caso de
Uso Manter Verso do Registro de Ponto e retorna ao passo 6 do FA6.

8.

Requisitos Especiais
8.1. <nome do requisito especial>
<Descrio do requisito especial>.

<Normalmente, um requisito especial um requisito no funcional que especfico de um caso de uso, mas que no
especificado, de maneira fcil ou natural, no texto do fluxo de eventos do caso de uso. Entre os exemplos de
requisitos especiais esto includos requisitos legais e reguladores, padres de aplicativo e atributos de qualidade
do sistema a ser criado incluindo requisitos de usabilidade, confiabilidade, desempenho ou suportabilidade. Alm

Confidencial

Secretaria de Estado de Fazenda

Pgina 11 de 13

Guia de elaborao de Especificao

de Caso de Uso
disso, outros requisitos como sistemas operacionais e ambientes, requisitos de compatibilidade e restries de
design tambm podem ser informados.>
Exemplos:
8.1. Nvel de Segurana
As informaes deste caso de uso possuem nvel se segurana #20 Confidencial.
8.2. Disponibilidade em ambiente
O caso de uso deve estar disponvel no ambiente Intranet.
8.3. Registro da operao
O sistema deve registrar a operao e gravar informao para auditoria (log).
8.4. Desempenho
O tempo de resposta mxima para emisso do relatrio de 8 segundos.

9.

Referncias

<As referncias so todos os documentos mencionados em qualquer outra parte desta Especificao de Caso de
Uso>
- Documento de viso (SEFDF_SISGEPAT_GRS_DVS)
- Lista de Mensagens (SEFDF_SISGEPAT_GRS_MSI)
- Regra de Negcio Geral (SEFDF_SISGEPAT_GRS_RNG)
- ...
10.
Observaes
<Este item do documento poder ser usado para explicitar outras informaes teis ao desenvolvimento, teste ou
implementao do caso de uso, mas que no devem estar inclusos nos fluxos de eventos

Confidencial

Secretaria de Estado de Fazenda

Pgina 12 de 13

Guia de elaborao de Especificao

de Caso de Uso
11.

Aprovao
Este documento foi elaborado pela Cast Informtica e apresentado ao gestor tcnico para
conferncia e possveis alteraes. Considero que o mesmo est finalizado e pode ser
homologado.
Rio Pomba, <dia> de <ms> de <ano>.

<nome do gestor operacional>

Subsecretaria <nome da subsecretaria>
Gestor Operacional do <nome do sistema>

<nome do gestor tcnico>

Subsecretaria <nome da subsecretaria>
Gestor Tcnico do <nome do sistema>

Confidencial

Secretaria de Estado de Fazenda

Pgina 13 de 13