Histórico da Página

(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 pela inclusão das mensagens nas Filas e recuperação das respostas das mensagens.

(Obrigatório)

Definição da Regra de Negócio

O componente de mensagens, deverá ser um componente utilizado apenas para troca de mensagens entre as aplicações, não poderá ter qualquer dependência de uso do TOP CONNECT ou com regras de Negócio da aplicação. Será responsável apenas por implementar as interfaces de inclusão de mensagens na fila e das consultas das respostas das mensagens. As funcionalidades do componente serão definidas pelas funções: PutProcInQueue() e GetProcResponse()

Função: PutProcInQueue()

Rotina responsável por inserir uma mensagem em uma Fila.

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 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 a inclusão da mensagem na Fila através do método putMsg(). Caso contrário deverá retornar o erro ocorrido.

Parâmetros: 

cDocModel – Modelo do Documento. Utilizado para a definição da fila a ser Utilizada.

cJSONRequest – Mensagem a ser enviada para a Fila.

cMsgId – Referência para retorno do Id da Mensagem na Fila.

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

Retorno:

lRet – Indica se a mensagem foi enviada com Sucesso para a Fila.

Função: GetProcResponse()

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 Status 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 do objeto 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

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

Opcional

Fluxo do Processo

Inclusão de Mensagens na Fila:

Consulta Lista de Resposta:

<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

<Informações utilizadas na linha Protheus>.

(Opcional)

Consulta Padrão

<Informações utilizadas na linha Protheus>

(Opcional)

 Estrutura de Menu

Programas

Cadastro de Papéis