ER_PCREQ-8588 Consumidor de Mensagens

(Obrigatório)

Informações Gerais

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

(Obrigatório)

Objetivo

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

(Opcional)

Grupo de Perguntas

(Opcional)

Consulta Padrão

(Opcional)

Estrutura de Menu

Cadastro de Papéis