Este documento é material de especificação dos requisitos de inovação, trata-se de conteúdo extremamente técnico. |
---|
Especificação | ||||
Produto | TSS | Módulo | TSS TOTVS Service SOA |
|
Segmento Executor | SERVIÇOS | |||
Projeto1 | M_SER_TSS002 | IRM1 | PCREQ-8280 | |
Requisito1 | PCREQ-8281 | Subtarefa1 |
| |
Chamado2 |
| |||
Release de Entrega Planejada | 12.1.13 | Réplica |
| |
País | ( X X ) Brasil ( X ) Argentina ( X ) Mexico ( X ) Chile ( X ) Paraguai ( X ) Equador ( X ) USA ( X ) Colombia ( ) Outro _____________. | |||
Outros | <Caso necessário informe outras referências que sejam pertinentes a esta especificação. Exemplo: links de outros documentos ou subtarefas relacionadas>. |
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 Serviceservice.
Os serviços oferecidos pelo TSS são disponibilizados apenas através de Web Services baseado services baseados no protocolo SOAP, onde cada serviço é consumido através requisições feitas para métodos específicos dentro do TSS. Com o No modelo proposto pelo TSS 3.0, os serviços do TSS deverão estar estarão acessíveis tanto por web services Web service quanto por qualquer outra interface de integração com o TSS , assim como requisições HTTP que será utilizada 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 servicesAs funções de processamento serão formadas por toda a parte de processamento segregada dos Web Services. Será estruturada da seguinte forma:
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 Abaixo a descrição da nomenclatura das funções deverá ser da seguinte forma:
TSSVal + código Código do processo Processo + nome do métodoNome do Método
oJSON
Exemplo:
TSSVal0002AdmEmpresas(oJSON)
A função de processamento envolverá todo o código compreendido após a validação validação da requisição. A função O processamento 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á validações e o processamento receberão como parâmetro, um objeto deserializado desserializado com os parâmetros da requisição. Dessa forma a função estará pronta para , possibilitando receber tanto os parâmetros recebidos passados pelos método métodos via Web Service service como as mensagens JSON envidas no formato JSON (formato texto e completamente independente de linguagem) enviadas pela DLL. A nomenclatura será definida da seguinte forma:
TSSProc + código Código do processo Processo + nome do método Nome do Método
oJSON
Exemplo:
TSSProc0002AdmEmpresas(oJSON)
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" .
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çõesSeguindo 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 lista com a especificação das funções a serem implementadas. A lista será , disponibilizada através da função TSSGetProcQueue()
<Caso necessário inclua protótipos de telas com o objetivo de facilitar o entendimento do requisito, apresentar conceitos e funcionalidades do software>.
Opcional
<Informações utilizadas na linha Protheus>.
<Informações utilizadas na linha Protheus>
<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>.
[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
Este documento é material de especificação dos requisitos de inovação, trata-se de conteúdo extremamente técnico. |
---|