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). 

Objetivo

Definir o padrão das funções de processamento das requisições de Web service. 

Os serviços oferecidos pelo TSS são disponibilizados apenas através de Web services baseados no protocolo SOAP, onde cada serviço é consumido através requisições feitas para métodos específicos dentro do TSS.No modelo proposto pelo TSS 3.0, os serviços do TSS estarão acessíveis tanto por Web service quanto por qualquer outra interface de integração, assim como requisições HTTP que serão utilizadas pela DLL de integração do TSS.  

Definição da Regra de Negócio  

Definir a função que irá executar o processamento segregado dos Web services. Será estruturada da seguinte forma:

• Validação:

            A validação dos parâmetros das requisições serão definidas em uma função que será chamada pelo método ou poderá ser utilizada por qualquer outra interface que venha ser implementada para integração com o TSS. Abaixo a descrição da nomenclatura das funções:

• Função:

           TSSVal + Código do Processo + Nome do Método

• Parâmetro:

            oJSON 

            Exemplo:

            TSSVal0002AdmEmpresas(oJSON)

• Processamento:

            A função de processamento envolverá todo o código compreendido após a validação da requisição. O processamento deverá retornar o resultado estruturado de acordo com o esperado pelo Web service. Da mesma forma as validações e o processamento receberão como parâmetro, um objeto desserializado com os parâmetros da requisição, possibilitando receber tanto os parâmetros passados pelos métodos via Web service como as mensagens no formato JSON (formato texto e completamente independente de linguagem) enviadas pela DLL. A nomenclatura será definida da seguinte forma:

• Função:

            TSSProc + Código do Processo + Nome do Método

• Parâmetro:

            oJSON

            Exemplo:

            TSSProc0002AdmEmpresas(oJSON)

Seguindo esse padrão, tanto a funções de validação quanto as de processamento, terão exatamente o mesmo código contido hoje no processamento dos Web service, sendo necessário apenas trocar a referência dos parâmetros da requisição, da referência "self:" ou "::" para a referência "oJSON".

Para Implementação, verificar a

 Definir a função EntidadeClear para a exclusão da entidade.

(Obrigatório)

Definição da Regra de Negócio

Atualmente grande parte dos métodos do TSS realizam o processamento das requisições no próprio corpo do método. Dessa forma esses serviços ficam acoplados na interface de Web service e impedindo que o serviço possa ser consumido através de outros métodos de consumo. Para que os serviços oferecidos pelo TSS possam ser atendidos através de qualquer interface como as requisições HTTP que serão implementada na DLL,  os serviços deverão ser disponibilizados através de funções. A nomeclatura das funções sera formada por:  

"TSPROC" + "Sequencia do processo" + "nome do Método"

Ex: TSPROC0001Remessa - Função para processamento de remessas do Web service NESBRA

As funções receberão como parâmetro a mensagem JSON padrão definida para o TSS.(ver especificação da função: getJsonRequest() ). Para facilitar a implementação das funções, os parâmetros seguirão a mesma nomenclatura e estrutura recebida pelos métodos devendo apenas acrescentar os atributos de referencia para o objeto JSON. Dessa forma para criar as funções será necessário apenas copiar a estrutura dos métodos e realizar a dos parâmetros e do retorno:

• Parâmetros: 

oJSON:receive: + "parâmetro"

• retorno

 oJSONRet:send + "retorno do método"

Ex:  Metodo Remessa:

Parâmetros : 

oJSON:receive:UserToken,

oJSON:receive:Id_Ent, 

oJSON:receive:Nfe:NOTAS[nX]:XML

Retorno:

oJSON:send:NfeOk:ID

Após o processamento as funções deverão criar a mensagem JSON de resposta através da função  getJSONResponse() e disponibiliza-lá na lista de resposta de requisições.

Para Implementação, verificar lista com a especificação das funções a serem implementadas. A lista será , disponibilizada através da função TSSGetProcQueue()

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>.

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

<Informações utilizadas na linha Datasul>.

Procedimentos

Programas 

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>.