Especificação de Caso de Uso e Regras de Negócio -

GUIA DE ELABORAÇÃO DA ESPECIFICAÇÃO DE CASO DE USO ONLINE DA SECRETARIA DE

FAZENDA/DF Versão 2.1

Guia de elaboração de Especificação de Caso de Uso

(online)

Histórico de RevisãoData Versão Descrição Autor Revisor

05/09/2013 1.0 Elaboração do guia com orientações e exemplos Kelly

28/11/2013 2.0

Atualização da descrição do histórico de revisão

Exclusão da descrição do fluxo de eventos para inclusão no fluxo básico

Atualização do índice Exclusão do layout de

arquivo para tratamento batch

Inclusão de legenda nas regras de negócio

Atualização do exemplo do PE1

Daniela

22/04/2014 2.1 Alteração do texto do item 12 – Aprovação Daniela

<No Histórico de Revisões deverá constar a alteração que foi feita no documento, conforme exemplo abaixo. Deve ser indicada a demanda Oasis que solicitou a alteração. A versão do

histórico de revisão só dever ser atualizada no momento da entrega do artefato>

Data Versão Descrição Autor Revisor

15/06/2012 1.6

Atendimento ao OASIS 9999/2013 Alteração da RN11, RN35 Inclusão das RNs: 49 a 60; Alteração dos fluxos FA2 e FA4 Correção ortográfica;

xxxx xxxx

Secretaria de Estado de Fazenda Página 2 de 23


(online)Especificação de Caso de Uso

Índice

<Nome do Caso de Uso> 41. Descrição42. Atores 43. Pré-Condições 4

3.1 <nome da pré-condição>44. Fluxo de Eventos5

4.1 Fluxo Básico – <nome do fluxo básico> 54.2 Fluxos Alternativos 64.3 Fluxos de Exceção7FE1. Campos de preenchimento obrigatório não informado 7

5. Regras de Negócio8[RN1] Informações Utilizadas – <nome da funcionalidade> 8[RN2] Informações Utilizadas – Inclusão/Alteração de subitens de despesas 12[RN3] Informações Utilizadas – Impressão dos grupos de subitens 16[RN4] Informações Utilizadas – Detalhar Grupo de subitens 196. Pós-Condições 237. Pontos de Extensão 238. Requisitos Especiais 239. Referências 2410. Observações 2411. Aprovação 25



(online)

Especificação de Caso de Uso<Nome do Caso de Uso>

<O nome do caso deverá ser no infinitivo>

1. Descrição <Neste item, deverá ser descrito resumidamente o objetivo geral do caso de uso.>

Exemplo:

Este caso de uso permite ao ator realizar a inclusão, alteração, exclusão e consulta de subitens de despesas e grupos de elementos de despesas.

2. Atores<Deve ser indicado os atores que tenham interação com o caso de uso>

Exemplos:

Agente Setorial: Ator responsável pela administração e controle de bens patrimoniais incorporados e distribuídos para uso das unidades administrativas. Servidores com perfil GEPAT e NUCAT;

Servidor com perfil COPAT: Ator responsável por gerenciar todos os cadastros e configurações do sistema.

3. Pré-Condições3.1 <nome da pré-condição>

<A pré-condição é um estado observável pelo usuário, mas não é o evento que inicia o caso de uso, podendo ser considerada uma premissa. Este tipo de informação somente deve ser incluído na especificação quando for aplicável.>

Exemplo:

3.1 Acesso



(online) O usuário deve ser autenticado no SIGGO e ter escolhido o

SISGEPAT como acesso.

O usuário deve ter permissão de acesso à funcionalidade, conforme habilitação do usuário no cadastro.

É necessário existir elemento de despesa cadastrado.

4. Fluxo de Eventos

4.1 Fluxo Básico – <nome do fluxo básico>

Este caso de uso se inicia <descrição do início do caso de uso>

<Descrever “quem” e “para quê” o caso de uso é iniciado para realizar a especificação dos

Fluxos>

Exemplos:

1. Este caso de uso se inicia quando o ator aciona a opção Emitir Relatório de Férias por Unidade Administrativa no menu: Relatórios Férias Férias por Unidade Administrativa para emissão do relatório das férias dos servidores de determinada unidade administrativa.

FB1. <Descrição do passo 1 do fluxo básico>. [RN999] [FA1] [FA2] [FA3]FB2. <Descrição do passo 2>. [RNG999] [FE1] [M99]FB3. Finaliza caso de uso.

< Deverá ser utilizado o fluxo de “Consulta” como fluxo básico para todos os casos de uso do projeto quando o caso de uso se tratar de “Manter...” (Inclusão, Alteração, Exclusão, Consulta). Os demais deverão ser colocados como fluxos alternativos>

Exemplo:4.1 – Consultar subitens de despesas

FB1. O caso de uso tem início quando o ator solicita a funcionalidade subitem de despesa no menu; FB2. O sistema recupera os grupos de subitens de despesas cadastrados; FB3. O sistema apresenta os grupos de subitens de despesas cadastrados; FB4. O ator informa o filtro de pesquisa; [RN1.1] [RN1.2] [A1] [A3]



(online)FB5. O sistema realiza a validação do filtro informado; [RNG15], Error:Reference source not found Error: Reference source not foundFB6. O sistema apresenta o resultado de pesquisa; FB7. O ator seleciona um elemento da lista; Error: Reference source notfoundError: Reference source not foundError: Reference source not foundFB8. O fluxo básico é encerrado;

4.2 Fluxos Alternativos

FA1. <Nome do fluxo alternativo>No(s) passo(s) <número do(s) passo(s) do fluxo básico ou do fluxo alternativo onde

existe a possibilidade de ocorrência de um fluxo alternativo > do <fluxo básico ou fluxo alternativo>, caso <descrição da condição de ocorrência do fluxo alternativo>, devem ser executados os seguintes passos:

FA.1.1. <Descrição do passo do fluxo alternativo>.FA.1.2. <Descrição do passo do fluxo alternativo>.FA.1.3. <Descrição do passo do fluxo alternativo>.FA.1.4. Finaliza caso de uso ou Retorna ao passo FB?? do Fluxo Básico ou do Fluxo Alternativo FA?? ou Fluxo de Exceção FE??.

<No fluxo alternativo deverá estar descrito o número dos passos do fluxo básico ou do fluxo alternativo onde existe a possibilidade de ocorrência de um fluxo alternativo>

Exemplo:

FA1. Incluir Subitem de despesa

Nos passos (FB4) ou (FB7) do fluxo básico, caso o ator solicite a inclusão de subitem de despesa: devem ser executados os seguintes passos:

FA1.1. O ator solicita a inclusão subitem de despesa; FA1.2. O sistema solicita as informações para preenchimento; [RN2]FA1.3. O ator preenche as informações e aciona a opção que permite incluir; Error: Reference source not found(FA5)FA1.4. O sistema valida as informações; RNG5 Error: Reference source notfound Error: Reference source not found FA1.5. O sistema solicita a confirmação da operação; [M06]FA1.6. O ator confirma a operação; Error: Reference source not foundFA1.7. O sistema grava os dados;



(online)FA1.8. O sistema grava o log da operação; (RNG18)FA1.9. O sistema emite a mensagem de sucesso; [M07]FA1.10. O fluxo alternativo retorna para o passo do Fluxo Básico..

4.3 Fluxos de Exceção

FE1. <Nome do fluxo de exceção>

FE.1.1. <Descrição do passo do fluxo de exceção>.FE.1.2. <Descrição do passo do fluxo de exceção>.FE.1.3. <Descrição do passo do fluxo de exceção>.FE.1.4. Finaliza caso de uso ou Retorna ao passo FB?? do Fluxo Básico ou do Fluxo Alternativo FA?? ou Fluxo de Exceção FE??.

< O nome do fluxo deve ser objetivo e representar claramente a exceção;

- As exceções devem tratar todos os problemas possíveis e situações que interrompam a execução do caso de uso;

- As exceções não necessariamente encerram o caso de uso, mas elas devem impedir a continuidade do fluxo.

- Cada exceção ou erro exclusivo podem ser capturados como um Fluxo de Exceção. A principal informação a ser captada é: qual deve ser a experiência dos atores quando ocorrerem exceções?.>

Exemplo:

FE1. Campos de preenchimento obrigatório não informado

Nos passos (FA1.4) ou (FA2.4) do fluxo alternativo, o sistema identifica que existe campo obrigatório sem preenchimento;

FE1.1. O sistema apresenta mensagem indicando os campos obrigatórios e marca os campos de vermelho para serem preenchidos; [M04]FE1.2. O caso de uso retorna ao passo ou Error: Reference source notfound do fluxo que o chamou.



(online)

5. Regras de Negócio

< Neste item, deverão ser colocadas as tela ou protótipos das telas, ou ainda, layout de arquivos nos casos de uso de funcionalidades batch, antes da especificação das regras de apresentação ou de negócios envolvidas na funcionalidade>

<Deverá ser seguido o template da tabela de especificação abaixo>

<O conteúdo dos campos da tabela estão exemplificados na tabela a seguir>

<Deverá ser marcado com “X” a regra de cada campo. Deverá ser indicado se o campo é:

O - Preenchimento obrigatório | A - Preenchimento automático pelo sistema | E - Valor do atributo pode ser editado | T - Atributo Visível na Tela;

< Quando o caso de uso for documentado após a implementação da funcionalidade/sistema, o conteúdo das regras de negócio deverá descrever a origem e destino das informações trabalhadas.>

Exemplo: - Informação recuperada do SIGEP - Cadastro do Órgão – Sigla Órgão - Informação incluída no SIGEP - Cadastro de Funcionários – Nome Pessoa- Informação consultada no SIGEP - Cadastro de Histórico de Férias – Data de Fruição Inicial

[RN1] Informações Utilizadas – <nome da funcionalidade>

Exemplo:

[RN1] Informações Utilizadas – Consultar subitens de despesas



(online)



(online)

LegendaN. - Número seqüencial do Atributo.

O - Preenchimento obrigatório | A - Preenchimento automático pelo sistema | E - Valor do atributo pode ser editado | T - Atributo Visível na Tela

N.Nome do Atributo

O A E TDescrição do

ConteúdoTipo Domínio Tamanho Máscara Regra de Apresentação

Filtros de pesquisa

[RN1.1]Código do elemento de despesa

x x

Campo para o ator informar o código de elemento de despesa para consulta

N N/A 2 N/A N/A

[RN1.2]

Descrição do elemento de despesa

x x

Campo para o ator informar a descrição do elemento de despesa

A N/A 70 N/A O campo deverá permitir consulta parcial

Resultado da consulta

[RN1.3] Selecionar x xApresenta um check Box para seleção

SM N/A 1 N/A N/A

[RN1.4]Código do elemento de despesa

X x

Apresenta o código do elemento de despesa cadastrado

N N/A 2 N/A N/A

[RN1.5]


X x

apresenta a descrição do elemento de despesa cadastrado

A N/A 70 N/A N/A

[RN1.6] Tipo do X x Apresenta o tipo A N/A 7 N/A Recuperar o tipo do



(online)

elemento de despesa

do elemento de despesa

elemento de despesa cadastrado no caso de uso Manter elemento de despesa

Botões

[RN1.7] Alterar X

Botão de opção que permite acesso ao fluxo A2

BT N/A N/A N/A Ao acionar a opção o

sistema deverá executar o fluxo A2

[RN1.8] Incluir X


BT N/A N/A N/A Ao acionar a opção o

sistema deverá executar o fluxo A1;

[RN1.9] Imprimir X


BT N/A N/A N/A

Ao acionar a opção o sistema deverá executar o fluxo A4;

O sistema deverá apresentar a opção em cada página do resultado de pesquisa.

[RN1.10] Excluir X


BT N/A N/A N/A

Ao acionar a opção o sistema deverá executar o fluxo A3;

N/A – Não se Aplica.Tipo: A – Alfanumérico, N – Numérico, I – Inteiro, D – Decimal, TS – TimeStamp, DT – Data, LK – Link, BT – Botão, SU - .Seleção Única, SM – Seleção Múltipla, LO – Lista de Opções.



(online)[RN2] Informações Utilizadas – Inclusão/Alteração de subitens de despesas




(online)O - Preenchimento obrigatório | A - Preenchimento automático pelo sistema | E - Valor do atributo pode ser editado | T - Atributo Visível na Tela

N.Nome do Atributo



Filtros de pesquisa

[RN2.1]

Código do elemento de despesa

x x x x

Campo para o ator informar o código de elemento de despesa para consulta

LO

Recuperar os códigos dos elementos de despesas cadastrados no caso de uso Manter elemento de despesa

2 caractere

s

Não se aplica

Caso o ator informe o campo código o sistema deverá apresentar automaticamente o campo “Descrição do elemento de despesa” cadastrado no Manter elemento de despesa, conforme o código cadastrado

[RN2.2]


x x x x

Campo para o ator informar a descrição do elemento de despesa

LO

Recuperar as

descrições dos

elementos de despesa cadastradas no caso de uso Manter elemento de

despesa

70 caractere

s

Não se aplica

Caso o ator informe o campo elemento de despesa o sistema deverá apresentar automaticamente o campo “Código do elemento de despesa” cadastrado no Manter elemento de despesa, conforme a descrição cadastrada.

[RN2.3] Tipo do elemento de

x Apresenta o tipo do elemento de despesa

A Não se aplica

70 caractere

s

Não se aplica

Recuperar o tipo do elemento de despesa cadastrado



(online)

despesa

no caso de uso Manter elemento de despesa, de acordo com o elemento de despesa selecionado.

Informações editáveis (inclusão/alteração)

[RN2.4]Código do Subitem de despesa

x x xCampo para o ator informar o código do subitem de despesa

N Não se aplica

2 caractere

s

Não se aplica Não se aplica

[RN2.5]

Descrição do subitem de despesa

x x x

Campo para o ator informar a descrição do subitem de despesa

N Não se aplica

70 caractere

s

Não se aplica Não se aplica

Botões

[RN2.6] Salvar X

Botão de opção que permite salvar uma inclusão ou alteração de dados

BT Não se aplica

Não se aplica

Não se aplica

A opção será apresentada nos formulários dos fluxos (A2) e (A1)

[RN2.7] Cancelar X

Botão de opção que permite sair da tela de alteração e retornar para o resultado da pesquisa

BT Não se aplica

Não se aplica

Não se aplica

Ao acionar a opção o sistema deverá executar o fluxo A6




(online)

[RN3] Informações Utilizadas – Impressão dos grupos de subitens



(online)




(online)O - Preenchimento obrigatório | A - Preenchimento automático pelo sistema | E - Valor do atributo pode ser editado | T - Atributo Visível na Tela

N.Nome do Atributo



Cabeçalho

[RN3.1]

Cabeçalho padrão secretária de fazenda

x x

Apresenta o cabeçalho do relatório A N/A N/A N/A

Recuperar a informação do caso de uso Manter cabeçalho de relatório.

[RN3.2]Tabela Subitem de despesa

x x Texto fixo A N/A N/A N/A Apresenta o texto fixo

“Tabela do subitem de despesa” como título

Informações apresentadas

[RN3.3]Código do elemento d despesa

x xApresenta o código do elemento de despesa

N N/A 2 N/A N/A

[RN3.4]


x xApresenta a descrição do elemento de

A N/A 70 N/A N/A

[RN3.5]Código do subitem de despesa

x xApresenta o código do subitem de despesa

N N/A 2 N/A N/A

[RN3.6]


x xApresenta a descrição do elemento de despesa

A N/A 70 N/A N/A




(online)

[RN4] Informações Utilizadas – Detalhar Grupo de subitens



(online)


O - Preenchimento obrigatório | A - Preenchimento automático pelo sistema | E - Valor do atributo pode ser editado | T - Atributo Visível na Tela

N.Nome do Atributo



Filtros de pesquisa

[RN4.1]

Código do elemento de despesa

x xApresenta o código do elemento de despesa

N N/A 2 N/A N/A

[RN4.2]


x xApresenta a descrição do elemento de

A N/A 70 N/A N/A

[RN4.3]

Tipo do elemento de despesa

x x Apresenta o tipo do elemento de despesa A N/A 70 N/A N/A

Resultado da pesquisa

[RN4.4]Código do subitem de despesa

x xApresenta o código do subitem de despesa

N N/A 2 N/A N/A

[RN4.5]


x xApresenta a descrição do elemento de despesa

A N/A 70 N/A N/A

Botões [RN4.6] Cancelar x x Apresenta o botão de BT N/A N/A N/A O botão de opção



(online)

opção de cancelarpermitir retornar para o resultado da pesquisa do fluxo principal.


RN5. O sistema recupera informações de notas de empenho emitidas onde a data de emissão seja igual a data de execução do processo batch e o código da natureza da despesa seja igual a 339030 ou 339092 ou 449052 ou 449092.



(online)

6. Pós-Condições

6.1. <nome da pós-condição>

<Descrição da pós-condição>.

<Pós-condição é a descrição do estado do sistema após a execução do caso de uso. A pós-condição de um caso de uso deve ser verdadeira independentemente dos fluxos alternativos que foram executados; não deve ser verdadeira apenas para o fluxo principal. Ao fazer uso deste recurso em casos de uso que possuem pontos de extensão, é preciso garantir que os passos definidos no caso de uso de “extensão” não violem a pós-condição definida. Este tipo de informação somente deve ser incluído na especificação quando for aplicável. A pós-condição deve ser relevante e não o objetivo do caso de uso.>

7. Pontos de Extensão

PE1. <nome do ponto de extensão>

<Descrição do ponto de extensão>.

<Nos relacionamentos entre casos de uso com estereótipo <<extensão>>, caso este caso de uso seja a“base”, indicar a existência de pontos de extensão nesta seção.>

Exemplo:

PE1. Ativação do Registro de Ponto

No passo 5 do FA6, caso o Configurador do Ponto Eletrônico solicita a ativação dos registros de ponto vinculados a Norma do Ponto Eletrônico, devem ser extender o Caso de Uso “Manter Versão do Registro de Ponto” e retorna ao passo 6 do FA6.

8. Requisitos Especiais

8.1. <nome do requisito especial>

<Descrição do requisito especial>.

<Normalmente, um requisito especial é um requisito não funcional que é específico de um caso de uso, mas que não é especificado, de maneira fácil ou natural, no texto do fluxo de eventos do caso de uso. Entre os exemplos de requisitos especiais estão incluídos requisitos legais e reguladores, padrões de aplicativo e atributos de qualidade do sistema a ser criado incluindo requisitos de usabilidade, confiabilidade, desempenho ou suportabilidade. Além disso, outros requisitos — como sistemas operacionais e ambientes, requisitos de compatibilidade e restrições de design — também podem ser informados.>

Exemplos:

8.1. Nível de SegurançaAs informações deste caso de uso possuem nível se segurança #20 – Confidencial.



(online)8.2. Disponibilidade em ambienteO caso de uso deve estar disponível no ambiente Intranet.

8.3. Registro da operaçãoO sistema deve registrar a operação e gravar informação para auditoria (log).

8.4. DesempenhoO tempo de resposta máxima para emissão do relatório é de 8 segundos.

9. Referências

<As referências são todos os documentos mencionados em qualquer outra parte desta Especificação de Caso de Uso> - Documento de visão (SEFDF_SISGEPAT_GRS_DVS)- Lista de Mensagens (SEFDF_SISGEPAT_GRS_MSI)- Regra de Negócio Geral (SEFDF_SISGEPAT_GRS_RNG)- ...

10. Observações<Este item do documento poderá ser usado para explicitar outras informações úteis ao desenvolvimento, teste ou implementação do caso de uso, mas que não devem estar inclusos nos fluxos de eventos



(online)

11. AprovaçãoEste documento foi elaborado pela Cast Informática e apresentado ao gestor técnico para

conferência e possíveis alterações. Considero que o mesmo está finalizado e pode ser

homologado.

Brasília, <dia> de <mês> de <ano>.

<nome do gestor operacional>Subsecretaria <nome da subsecretaria>

Gestor Operacional do <nome do sistema>

<nome do gestor técnico>Subsecretaria <nome da subsecretaria>Gestor Técnico do <nome do sistema>


Documents

Especificação de Caso de Uso e Regras de Negócio -