Histórico da Página

(Obrigatório)

Informações Gerais

   Legenda:    Legenda: 1 – Inovação 2 – Manutenção (Os demais campos devem ser preenchidos para ambos os processos). 

(Obrigatório)

Objetivo

<Nesta etapa informar o objetivo da especificação do requisito, ou seja, o que a funcionalidade deve fazer. Exemplo: Permitir que o usuário defina o percentual mínimo em espécie (dinheiro), a referência mínima para calculo dos débitos do aluno e o período de validade do parâmetro de negociação>.

(Obrigatório)

Definição da Regra de Negócio

<Regra de negócio é o que define a forma de fazer o negócio, o processo definido e/ou as regras que devem ser contempladas. Devem ser descritas restrições, validações, condições e exceções do processo. Caso necessário, incluir neste capítulo também regras de integridade que devem ser observadas no momento do desenvolvimento>.

<Na tabela abaixo informe quais são as rotinas envolvidas, o tipo de operação, a opção de menu e se necessário uma breve descrição das regras de negócio relacionadas a rotina>.

Exemplo de Aplicação:

• Criar o campo “% Mínimo Espécie” (AAA_PERESP) onde o usuário informará o % que o aluno pagará em dinheiro. Esse % poderá ser alterado durante a negociação.
• Criar o campo “Referência Mínima para Cálculo” (AAA_REFCAL) onde o usuário informará um dos 4 valores disponíveis para pagamento das mensalidades  como a referência mínima para calcular o débito total do aluno.
• Criar o parâmetro MV_ACPARNE que definirá se as informações de “% Mínimo Espécie” e “Referência Mínima para Cálculo” serão obrigatórias.
• O parâmetro MV_ACPARNE deve ter as seguintes opções: 1=Obrigatório e 2=Opcional. Deve ser inicializado como opcional>.

Tabelas Utilizadas

• SE2 – Cadastro de Contas a Pagar
• FI9 – Controle de Emissão de DARF>.

Opcional

Protótipo de Tela

<Caso necessário inclua protótipos de telas com o objetivo de facilitar o entendimento do requisito, apresentar conceitos e funcionalidades do software>.

Protótipo 01

 Image Removed

Disponibilizar componente para consumo das Fila de Mensagens e da disponibilização de sua respectivas respostas.

(Obrigatório)

Definição da Regra de Negócio

O componente de Consumo de Mensagens deverá ser um componente único para processamento de qualquer Fila. Cada instância do componente será responsável por consumir apenas uma única Fila. A definição de qual fila consumir, será definida no arquivo ,ini de configuração do appserver.  As funcionalidade do componente serão definidas pelas funções: jobQueue() e putProcResponse() 

Função: JobQueue(): 

Rotina responsável pelo monitoramento das Filas. A Rotina deverá ser estruturada de forma genérica para atender a qualquer tipo de Fila. A Identificação da fila a ser monitorada será realizada através da seção do parâmetro PROCQUEUE que definirá o modelo de documento.

A rotina deverá obter uma referência para a Fila a ser utilizada para a inclusão da mensagem. A referência deverá ser obtida através da função  QueueFactory(), que retornará um status indicando se a criação do Objeto de referência para a fila foi criado com sucesso. Em caso de Sucesso a rotina poderá realizar buscar por mensagens na fila  através do método WaitMsg() da classe TQueueSvc(). Caso contrário deverá retornar o erro ocorrido.  

A aplicação ficará em estado de espera até o surgimento de alguma mensagem na fila. Ao receber a mensagem, a rotina deverá através da função smartjob(), distribuir as mensagens para a função procMsgQueue() e retornar para o monitoramento da Fila. 

Parâmetros:

           nil

Retorno:

nil

Função: procMsgQueue()

A função ProcMsgQueue, Será a função responsável por validar e  solicitar o processamento das mensagens. Ao obter o retorno do processamento, a rotina deverá postar a resposta mensagem e em seguida excluir a mensagem da Fila, caso a resposta tenha sido incluída com sucesso na Lista. A rotina deverá realizar controle de sequência da mensagem.  O controle de sequência será utilizado para documentos que necessitam seguir uma sequencia de processamento, o controle deverá ser realizado através da comparação da sequência enviada na mensagem com a sequência armazenada no parâmetro na SPED000. O parâmetro deverá ser definido para cada tipo de processo. Caso a mensagem recebida não atenda a sequência do processo, ela será descartada pelo processo atual.

A execução da mensagem deverá ser realizada através da função TSSProcRequest(), que será responsável por executar as funções de regra de negócio de acordo com o processo informado no objeto da requisição.

A resposta do processamento deverá ser obtida através ad função getJSONResponse() e em seguida disponibilizada na lista de resposta através da função putProcResponse().

Caso ocorra sucesso na inclusão da mensagem na Lista, a mensagem deverá ser removida da Fila. Para remoção da mensagem a rotina deverá obter uma referência para a Fila atraves da função.  QueueFactory().

Parâmetros:

cMsgRet – Mensagem retrornada pela Fila

cDocModel – Modelo do Documento.

cMsgId – Id da mensagem 

Retorno:

nil

Função: putProcResponse()

Rotina responsável por recuperar uma resposta de uma Lista

A rotina deverá obter uma referência para a Lista referente ao Modelo de documento A referência deverá ser obtida através da função  ListFactory(), que retornará um valor Booleano indicando se a criação do Objeto de referência para a Lista foi criado com sucesso. Em caso de Sucesso a rotina poderá recuperar a resposta da mensagem através do método getMsg(). Ao obter o retorno do método, a rotina deverá realizar algumas verificações essas verificações serão baseadas em atributos da classe utilizados para atribuição de retorno do método. A rotina deverá seguir os seguintes Critérios:

nRet = oObj: eNO_MSG: Condição que define a Inexistência de mensagens na Lista.

nRet = oObj:eNO_MSGID : Condição que define que não existe resposta para a Mensagem solicitada.  Em ambos os casos a rotina deverá gerar o seguinte retorno:

Status = “202”

Mensagem = “Mensagem Não localizada na Lista. ” + oObj:cName + “ Erro: ” + nRet

Parâmetros:

cMsgId – Id de referência para busca da resposta.

cDocModel – Modelo do Documento.

cMsgRet – Referencia para a resposta da Mensagem.

cHttpStatus – Referencia para Status Http da requisição

cError – Referência para informação de erros no Processamento.

Retorno:

lRet – Indica se a resposta foi recuperada.

Opcional

Protótipo de Tela

Opcional

Fluxo do Processo

<Nesta etapa incluir representações gráficas que descrevam o problema a ser resolvido e o sistema a ser desenvolvido. Exemplo: Diagrama - Caso de Uso, Diagrama de Atividades, Diagrama de Classes, Diagrama de Entidade e Relacionamento e Diagrama de Sequência>. 

Opcional

Dicionário de Dados

Arquivo ou Código do Script: AAA – Negociação Financeira / *Versao=CP.2014.12_03*/

Campo

<AAA_PERESP>

Tipo

<N>

Tamanho

<6>

Valor Inicial

<Varia de acordo com o tipo informado. Por exemplo, quando o campo “tipo” for date, neste campo pode ser informado uma data>. 

Mandatório

Sim (  ) Não (  )

Descrição

<Referência Mínima para Cálculo>

Título

<Ref.Calc.>

Picture

<@E999.99>

Help de Campo

(Opcional)

Grupo de Perguntas

<Informações utilizadas na linha Protheus>.

Nome: FINSRF2

X1_ORDEM

01

X1_PERGUNT

Emissão De

X1_TIPO

D

X1_TAMANHO

8

X1_GSC

G

X1_VAR01

MV_PAR01

X1_DEF01

Comum

X1_CNT01

'01/01/08'

X1_HELP

Data inicial do intervalo de emissões das guias de DARF a serem consideradas na seleção dos dados para o relatório 

(Opcional)

Consulta Padrão

<Informações utilizadas na linha Protheus>

Consulta: AMB

Descrição

Configurações de Planejamento

Tipo

Consulta Padrão

Tabela

“AMB”

Índice

“Código”

Campo

“Código”; ”Descrição”

Retorno

(Opcional)

Estrutura de

<Informações utilizadas na linha Datasul>.

Procedimentos

Procedimento

Descrição

(Max 40 posições)

(Max 40 posições)

(Max 40 posições)

Módulo

Programa base

Nome Menu

(Max 32 posições)

(Max 32 posições)

(Max 32 posições)

Interface

GUI/WEB/ChUI/Flex

GUI/WEB/ChUI/Flex

GUI/WEB/ChUI/Flex

Registro padrão

Sim

Sim

Sim

Menu

Sim/Não

Sim/Não

Sim/Não

 

 

 

 

 

 

Programas

 

Programa
Descrição	(Max 40 posições)	(Max 40 posições)	(Max 40 posições)
Nome Externo
Nome Menu/Programa	(Max 32 posições)	(Max 32 posições)	(Max 32 posições)
Nome Verbalizado[1]	(Max 254 posições)	(Max 254 posições)	(Max 254 posições)
Procedimento
Template	(Verificar lista de opções no man01211)	(Verificar lista de opções no man01211)	(Verificar lista de opções no man01211)
Tipo[2]	Consulta/Manutenção/ Relatório/Tarefas	Consulta/Manutenção/ Relatório/Tarefas	Consulta/Manutenção/ Relatório/Tarefas
Interface	GUI/WEB/ChUI/Flex	GUI/WEB/ChUI/Flex	GUI/WEB/ChUI/Flex
Categoria[3]
Executa via RPC	Sim/Não	Sim/Não	Sim/Não
Registro padrão	Sim	Sim	Sim
Outro Produto	Não	Não	Não
Visualiza Menu	Sim/Não	Sim/Não	Sim/Não
Query on-line	Sim/Não	Sim/Não	Sim/Não
Log Exec.	Sim/Não	Sim/Não	Sim/Não
Rotina (EMS)
Sub-Rotina (EMS)
Localização dentro da Sub Rotina (EMS)
Compact[4]	Sim/Não	Sim/Não	Sim/Não
Home[5]	Sim/Não	Sim/Não	Sim/Não
Posição do Portlet[6]	0 – Top Left 1 – Top Right 2 – Bottom Left 3 – Bottom Right	0 – Top Left 1 – Top Right 2 – Bottom Left 3 – Bottom Right	0 – Top Left 1 – Top Right 2 – Bottom Left 3 – Bottom Right
Informar os papeis com os quais o programa deve ser vinculado

 

Cadastro de Papéis

<O cadastro de papéis é obrigatório para os projetos de desenvolvimento FLEX a partir do Datasul 10>.

<Lembrete: o nome dos papeis em inglês descrito neste ponto do documento, devem ser homologados pela equipe de tradução>.

 

Código Papel	(máx 3 posições)
Descrição em Português*
Descrição em Inglês*

[1] Nome Verbalizado é obrigatório para desenvolvimentos no Datasul 10 em diante.

[2] Tipo é obrigatório para desenvolvimento no Datasul 10 em diante

[3] Categorias são obrigatórias para os programas FLEX.

[4] Obrigatório quando o projeto for FLEX

[5] Obrigatório quando o projeto for FLEX

[6] Obrigatório quando o projeto for FLEX