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

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 baseado no protocolo SOAP onde cada serviço é consumido através requisições feitas para métodos específicos dentro do TSS. Com o modelo proposto pelo TSS 3.0, os serviços do TSS deverão estar acessíveis tanto por web services quanto qualquer outra interface de integração com o TSS como requisições HTTP que será utilizada pela DLL de integração do TSS.  

(Obrigatório)

Definição da Regra de Negócio

As funções de processamento serão formadas por toda a parte de processamento segregada 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. A nomenvlatura das funções deverá ser da seguinte forma:

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. A função deverá retornar o resultado estruturado de acordo com o esperado pelo Web service. Da mesma forma que as funções de validações, a função de processamento receberá como parâmetro, um objeto deserializado com os parâmetros da requisição. Dessa forma a função estará pronta para receber tanto os parâmetros recebidos pelos método Web Service como as mensagens JSON envidas pela DLL. A nomenclatura será definida da seguinte forma:

Função:

TSSProc + código do processo + nome do método 

Exemplo:

TSSProc0002AdmEmpresas()

As funções receberão como parâmetro a mensagem JSON padrão definida para o TSS.(getJsonRequest() ).

A mensagem JSON recebida pela função já estará Deserializada e terá os mesmo parâmetros na mesma estrutura do recebida pelos Web Services, sendo necessario apenas subistituir as inicias " :: ou sef: " por:  "oJSON:receive" . 

Exemplo:

Acesso ao atributo  "TOKEN" através  do Web Service: "sef:TOKEN"

Acesso ao atributo TOKEN através do objeto JSON:  "oJSON:receive:token" .

Parâmetro:

oJSON

Exemplo:

TSSProc0002AdmEmpresas(oJSON)

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

Opcional

Fluxo do Processo

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

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