Eexemplo ms ecu real manter periodicidade

Prévia do material em texto

Empresa XXX 
RESERVADO 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
DESCRIÇÃO DE CASOS DE USO 
Manter Periodicidade 
 
 
 
Versão 
Nº de Páginas do Documento: 9 
Empresa XXX Identificação do Caso de Uso Versão 1 / 9 
 
Descrição de Casos de Uso Projeto 
 XXX 
 
 
 
 
 
 
 
 
 
 
 
DESCRIÇÃO DE CASOS DE USO 
Manter Periodicidade 
 
 
AD.03 
 
 
 
 
 
 
Histórico de Revisões 
 
 - 
 
Referências 
Empresa XXX Identificação do Caso de Uso Versão 2 / 9 
 
Descrição de Casos de Uso Projeto 
 XXX 
ÍNDICE 
1 MANTER PERIODICIDADE ........................................................................................ 3 
1.1 Descrição ............................................................................................................................ 3 
2 FLUXO DE EVENTOS ................................................................................................ 3 
2.1 Fluxo Básico ........................................................................................................................ 3 
2.1.1 Incluir Periodicidade ....................................................................................................... 3 
2.1.2 Alterar Periodicidade ...................................................................................................... 4 
2.1.3 Excluir Periodicidade ...................................................................................................... 5 
2.1.4 Detalhar Periodicidade ................................................................................................... 5 
2.1.5 Buscar Periodicidade ...................................................................................................... 6 
2.2 Fluxos Alternativos .............................................................................................................. 7 
2.2.1 Dados da Periodicidade incompletos ............................................................................. 7 
2.2.2 Exclusão de Periodicidade Relacionada a Critério ........................................................ 7 
2.2.3 O Gestor de cobrança não confirma a exclusão ............................................................ 7 
2.2.4 Nenhuma periodicidade encontrada para os filtros especificados ................................. 7 
2.2.5 Já existe outra periodicidade com o mesmo nome ........................................................ 7 
2.2.6 Vigência da periodicidade expirada................................................................................ 8 
3 REQUISITOS ESPECIAIS .......................................................................................... 8 
3.1 Criar uma periodicidade a partir de uma existente ............................................................. 8 
3.2 Registro de log da operação realizada ............................................................................... 8 
4 PRÉ-CONDIÇÕES ...................................................................................................... 8 
4.1 Serviço de consulta às empresas às quais um usuário tem acesso .................................. 8 
5 PÓS-CONDIÇÕES ...................................................................................................... 8 
6 PONTOS DE EXTENSÃO ........................................................................................... 8 
 
Empresa XXX Identificação do Caso de Uso Versão 3 / 9 
 
Descrição de Casos de Uso Projeto 
 XXX 
1 MANTER PERIODICIDADE 
1.1 Descrição 
Este caso de uso permite ao gestor de cobrança manter (incluir, alterar, excluir, consultar e 
detalhar) as periodicidades utilizadas no sistema Cobrança. A periodicidade é utilizada pelo sistema 
para saber quais os dias em que uma entidade deve ser utilizada. 
Ex: Vamos considerar que um critério utilize a periodicidade abaixo para determinar os dias em que 
ele (critério) deve ser aplicado pelo sistema. Neste caso, este critério somente será aplicado às 
segundas-feiras. 
 
NOME DESCRIÇÃO INÍCIO DA 
VIGÊNCIA 
FIM DA 
VIGÊNCIA 
PERIODICIDADE 
DE EXECUÇÃO 
DIA DA 
SEMANA 
ORIGATÓRIO EMPRESA 
Periodicidade 
das segundas-
feiras 
Descrição da 
periodicidade 
01/01/2004 Semanal Segunda-
feira 
NÃO CELG 
2 FLUXO DE EVENTOS 
2.1 Fluxo Básico 
1. Este caso de uso se inicia quando o Gestor de cobrança necessita incluir, alterar, excluir, 
detalhar ou consultar informações sobre a periodicidade dos critérios para aplicar ações de 
cobrança ou para transferir para incobráveis. 
2. O sistema solicita que o Gestor de cobrança selecione a função que deseja realizar. 
3. Uma vez que o Gestor de cobrança forneça a informação solicitada, um dos seguintes sub-
fluxos é executado: 
 Se o Gestor de cobrança selecionar “Incluir”, o sub-fluxo 2.1.1 é executado. 
 Se o Gestor de cobrança selecionar “Buscar”, o sub-fluxo 2.1.5 é executado. 
4. O Caso de Uso termina. 
2.1.1 Incluir Periodicidade 
1. Este fluxo se inicia quando o Gestor de cobrança solicita incluir uma Periodicidade. 
2. O sistema solicita o preenchimento dos seguintes dados: 
 *Nome da periodicidade. 
 *Descrição da periodicidade. 
 *Data inicial: é a data inicial em que a periodicidade deverá ser observada. Se não 
for informada a data de início é a data atual. 
 Data Final: data final do período no qual a periodicidade deverá ser observada. A 
data deve ser maior ou igual à data inicial, e somente deve ser informada quando 
se desejar limitar o período de observação da periodicidade. Caso a data final não 
seja informada, a periodicidade é observada por tempo indeterminado. 
 *Periodicidade de execução: campo de escolha fechada (valores possíveis: diária, 
semanal ou mensal). 
Empresa XXX Identificação do Caso de Uso Versão 4 / 9 
 
Descrição de Casos de Uso Projeto 
 XXX 
 Dia da Semana: campo de escolha fechada (valores possíveis: todos os 
dias da semana). Esta informação somente pode estar disponível se o 
gestor de cobrança tiver escolhida a opção “Semanal” na “periodicidade de 
execução”. Ela indica o dia da semana no qual esta periodicidade é válida. 
 Dia do Mês: campo de escolha fechada (valores possíveis: qualquer 
número inteiro contido no intervalo de 1 a 31 e “ÚLTIMO DIA DO MÊS”). 
Esta informação somente pode estar disponível se o gestor de cobrança 
tiver escolhida a opção “Mensal” na “periodicidade de execução”. Ela indica 
o dia do mês no qual esta periodicidade é válida. A opção “ÚLTIMO DIA DO 
MÊS” deve ser utilizada pelo gestor de cobrança para informar que esta 
periodicidade é válida no último dia do mês, independente do mês. 
Por exemplo: um critério com uma periodicidade mensal e cujo dia de 
execução é o “ÚLTIMO DIA DO MÊS” deve ser aplicado no dia 29/02/2004, 
pois este é o último dia do mês fevereiro em 2004. 
 *Indicador de obrigatoriedade de execução: campo de escolha fechada (valores 
possíveis: SIM ou NÃO). O valor SIM indica que se por algum motivo o(s) critério(s) 
associado(s) à periodicidade não for executada, então o sistema deve executá-lo(s) 
no próximo ciclo do processamento. 
 *Empresa: campo de escolha fechada (valores possíveis: todas as empresas às 
quais o usuário tem acesso). 
3. O Gestor de cobrança preenche os dados e solicita a inclusão. 
4. O sistema valida se não existe para a empresa informada, outra periodicidade vigente com 
o nome informado no passo 3. 
5. O sistema valida se todos os campos obrigatórios foram preenchidos. 
6. O sistema valida se o início da vigência é maior ou igual à data corrente. 
7. Quando o fim da vigência for informado, o sistema valida sea data informada é maior ou 
igual ao início da vigência e à data corrente. 
8. O sistema verifica se o valor do Indicador de execução diária informado é “SIM”. 
9. O sistema verifica se o dia do mês não foi informado. 
10. O sistema verifica se o dia da semana não foi informado. 
11. O sistema realiza a inclusão da Periodicidade com os seguintes dados: 
 Nome da Periodicidade 
 Descrição da Periodicidade 
 Data Inicial 
 Data Final 
 Periodicidade de execução 
o Dia da Semana: caso a “periodicidade de execução” seja “Semanal”. 
o Dia do Mês: caso a “periodicidade de execução” seja “Mensal”. 
 Indicador de obrigatoriedade de execução 
 Empresa 
12. O caso de uso termina. 
2.1.2 Alterar Periodicidade 
1. Para este fluxo ser executado, o Gestor de cobrança deve ter selecionado uma única 
periodicidade. 
Empresa XXX Identificação do Caso de Uso Versão 5 / 9 
 
Descrição de Casos de Uso Projeto 
 XXX 
2. Este fluxo se inicia quando o Gestor de cobrança solicita alterar uma Periodicidade. 
3. O sistema valida se a vigência da periodicidade não está expirada. 
4. O sistema solicita o preenchimento dos seguintes dados: 
 *Descrição da Periodicidade 
 *Data Inicial 
 Data Final 
 *Periodicidade de execução 
o Dia da Semana: caso a “periodicidade de execução” seja “Semanal”. 
o Dia do Mês: caso a “periodicidade de execução” seja “Mensal”. 
 Indicador de obrigatoriedade de execução 
 *Empresa 
5. O Gestor de cobrança preenche os dados e solicita a alteração. 
6. O sistema valida os dados conforme os passos de 4 à 10 do sub-fluxo “Incluir 
Periodicidade”. 
7. O sistema realiza a alteração da Periodicidade com os seguintes dados: 
 Descrição da Periodicidade 
 Data Inicial 
 Data Final 
 Periodicidade de execução 
o Dia da Semana: caso a “periodicidade de execução” seja “Semanal”. 
o Dia do Mês: caso a “periodicidade de execução” seja “Mensal”. 
 Indicador de obrigatoriedade de execução 
 Empresa 
8. O caso de uso termina. 
2.1.3 Excluir Periodicidade 
1. Para este fluxo ser executado, o Gestor de cobrança deve ter selecionado uma ou mais 
Periodicidades. 
2. Este fluxo se inicia quando o Gestor de cobrança seleciona excluir uma ou mais 
periodicidades. 
3. Para cada periodicidade selecionada, o sistema verifica se a vigência da mesma não está 
expirada e não está associada a algum critério. 
4. O sistema exibe as periodicidades que não foram utilizadas e solicita confirmação da 
exclusão. 
5. O Gestor de cobrança confirma a exclusão. 
6. O sistema exclui a(s) periodicidade(s) exibidas no passo 4 deste sub-fluxo. 
7. O caso de uso termina. 
2.1.4 Detalhar Periodicidade 
1. Para este fluxo ser executado, o Gestor de cobrança deve ter selecionado uma única 
periodicidade. 
Empresa XXX Identificação do Caso de Uso Versão 6 / 9 
 
Descrição de Casos de Uso Projeto 
 XXX 
2. Este fluxo se inicia quando o Gestor de cobrança seleciona a opção “Detalhar”; 
3. O sistema fornece as seguintes informações: 
 Nome da Periodicidade 
 Descrição da Periodicidade 
 Data Inicial 
 Data Final 
 Periodicidade de execução (os valores possíveis estão mencionados abaixo) 
o “Diária”: quando a periodicidade for diária; 
o “Segunda”, “Terça”, “Quarta”, “Quinta”, “Sexta”, “Sábado” ou “Domingo”: 
quando a periodicidade for semanal; 
o 1-31 ou “Último dia do mês” : quando a periodicidade for mensal; 
 Indicador de obrigatoriedade de execução 
 Empresa 
4. O sistema solicita que o Gestor de cobrança selecione uma dentre as funções “Excluir”, 
“Voltar” e ”Alterar”. 
5. Após a escolha do Gestor de cobrança, um dos seguintes sub-fluxos é executado: 
 Se o Gestor de cobrança selecionar “Alterar”, o sub-fluxo 2.1.2 é executado. 
 Se o Gestor de cobrança selecionar “Excluir”, o sub-fluxo 2.1.3 é executado. 
 Se o Gestor de cobrança selecionar “Voltar”, o sistema exibe a tela anterior. 
6. O caso de uso termina. 
2.1.5 Buscar Periodicidade 
1. Este fluxo se inicia quando o Gestor de cobrança seleciona a opção “Buscar”; 
2. O sistema solicita o preenchimento de um dos seguintes filtros: 
 *Empresa: campo de escolha fechada (valores possíveis: todas as empresas cadastradas 
às quais o usuário tem acesso). 
 Nome da periodicidade: campo de escolha fechada (valores possíveis: todas as 
periodicidades cadastradas pertencentes à empresa selecionada). 
3. O sistema apresenta uma lista das periodicidades pertencentes ao domínio no qual o 
usuário se encontra. Estas são as informações exibidas: 
 Identificador único 
 Nome da Periodicidade 
 Descrição da Periodicidade 
 Empresa 
4. Uma vez que o Gestor de cobrança obtenha a informação requerida, as seguintes opções 
são habilitadas: Detalhar, Incluir, Alterar, Excluir. 
5. O sistema requisita que o Gestor de cobrança especifique a função desejada. 
6. Uma vez que o Gestor de cobrança forneça a informação requerida, um dos seguintes sub-
fluxos é executado: 
 Se o Gestor de cobrança selecionar “Incluir”, o sub-fluxo 2.1.1 é executado. 
 Se o Gestor de cobrança selecionar “Alterar”, o sub-fluxo 2.1.2 é executado. 
Empresa XXX Identificação do Caso de Uso Versão 7 / 9 
 
Descrição de Casos de Uso Projeto 
 XXX 
 Se o Gestor de cobrança selecionar “Excluir”, o sub-fluxo 2.1.3 é executado. 
 Se o Gestor de cobrança selecionar “Detalhar”, o sub-fluxo 2.1.4 é executado. 
 Se o Gestor de cobrança selecionar “Buscar”, o sub-fluxo 2.1.5 é executado. 
7. O caso de uso termina. 
2.2 Fluxos Alternativos 
2.2.1 Dados da Periodicidade incompletos 
1. Ocorre no passo 4 do sub-fluxo Incluir Periodicidade e no passo 6 do sub-fluxo Alterar 
Periodicidade quando o sistema verifica que um ou mais dados obrigatórios não foram 
informados. 
2. O sistema exibe aviso informando que não pode cadastrar ou atualizar a Periodicidade por 
falta de alguns parâmetros. 
3. O fluxo retorna ao passo 2 do sub-fluxo Incluir Periodicidade ou passo 4 do sub-fluxo 
Alterar Periodicidade. 
2.2.2 Exclusão de Periodicidade Relacionada a Critério 
1. Ocorre no passo 3 do sub-fluxo Excluir Periodicidade quando o sistema verifica que uma ou 
mais periodicidades das periodicidades selecionadas já foram relacionadas a algum critério. 
2. O sistema exibe uma mensagem informando às periodicidades que já foram relacionadas a 
algum critério. 
3. O fluxo retorna ao passo 4 do sub-fluxo “Excluir Periodicidade”. 
2.2.3 O Gestor de cobrança não confirma a exclusão 
1. Ocorre no passo 5 do sub-fluxo Excluir Periodicidade quando o Gestor de cobrança opta 
por não confirmar a Exclusão de Periodicidade. 
2. O fluxo retorna ao passo 7 do sub-fluxo Excluir Periodicidade. 
2.2.4 Nenhuma periodicidade encontrada para os filtros especificados 
1. Ocorre no passo 3 do sub-fluxo “Buscar Periodicidade” quando o sistema não encontra 
nenhuma periodicidade para os filtros especificados. 
2. O sistema exibe a mensagem “Nenhuma periodicidade encontrada para os filtros 
especificados”. 
3. O caso de uso retorna ao passo 2 do sub-fluxo “Buscar Periodicidade”. 
2.2.5 Já existe outra periodicidade com o mesmo nome 
1. Ocorre no passo 4 do sub-fluxo “Incluir Periodicidade” e no passo 6 do sub-fluxo “Alterar 
Periodicidade” quando o sistema verifica que já existe para a empresa outra periodicidade 
vigente com o mesmo nome. 
2. O sistema exibe a mensagem “Informe um nome diferente, pois já existe uma periodicidade 
vigente com este nome”. 
3. O caso de uso retorna ao passo 2 do sub-fluxo “Incluir Periodicidade” e no passo 4 do sub-
fluxo “Alterar Periodicidade”, dependendo do fluxo original. 
Empresa XXX Identificação do Caso de Uso Versão 8 / 9 
 
Descrição de Casos de Uso Projeto 
 XXX 
2.2.6 Vigência da periodicidade expirada1. Ocorre no passo 6 do sub-fluxo “Alterar Periodicidade” e no passo 3 do sub-fluxo “Excluir 
Periodicidade” quando a vigência da periodicidade está expirada. 
2. O sistema exibe a mensagem “Vigência da periodicidade está expirada”. 
3. O caso de uso termina. 
3 REQUISITOS ESPECIAIS 
3.1 Criar uma periodicidade a partir de uma existente 
No sub-fluxo de detalhamento deve existir uma opção para se criar uma nova periodicidade a 
partir do tipo que está sendo visualizado. O usuário deve informar o nome/empresa para a 
nova periodicidade e após seu cadastro ser salvo no banco de dados (os dados da nova 
periodicidade são os mesmos da original, com exceção do nome/empresa), o sistema exibe os 
dados da nova periodicidade para que o gestor de cobrança possa alterá-lo. 
3.2 Registro de log da operação realizada 
O sistema deve registrar um log para cada operação de inclusão, alteração e exclusão 
realizada com sucesso. No registro do log devem ser inseridas as seguintes informações: 
 Operação realizada; 
 Data e hora da operação; 
 Usuário; 
4 PRÉ-CONDIÇÕES 
4.1 Serviço de consulta às empresas às quais um usuário tem acesso 
Um serviço que disponibiliza as empresas às quais um determinado usuário tem acesso deve 
estar disponível. 
5 PÓS-CONDIÇÕES 
Não se aplica. 
6 PONTOS DE EXTENSÃO 
Não se aplica.