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 |
Segmento Executor | SERVIÇOS | ||
Projeto1 | M_SER_TSS002 | IRM1 | PCREQ-8285 |
Requisito1 | PCREQ-8286 | Subtarefa1 |
|
Release de Entrega planejada | 12.1.13 | ||
País | ( X ) Brasil ( ) Argentina ( ) Mexico ( ) Chile ( ) Paraguai ( ) Equador ( ) USA ( ) 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).
Criar API com a finalidade de retornar o arquivo XML do documento.
Através da API de busca XML por documento, os clientes do TSS poderão obter o arquivo XML do documento. A consulta será para um documento. O critério para consulta será com base nos dados de entrada. A API terá como retorno o arquivo XML codificado em base64.
O consumo da API deverá ser realizado através de mensagens JSON definidas na função RetXmlTss()codificado em base64 definidas na WebService RestXMLTSS.
O processo de Deserialização de mensagens deverá ser realizado através da função FwJsonDeserialize().
Os códigos de status serão baseados no formato padrão de mensagens HTTP, conforme o link:
WebService: RestXMLTSS
WebService responsável pela definição da Interface da API de busca informações do documento.
O WebService deverá receber mensagens na estrutura JSON codificado em base64, onde serão decodificadas e passadas como parâmetro para a função RETXMLTSS().
O retorno do WebService será uma mensagem JSON.
Todos os parâmetros da mensagem serão obrigatórios.
Função: RETXMLTSS()
Função responsável pela definição da Interface da API retorna xml por documento.
A função RetXmlTss definirá a estrutura da API. A função deverá ser definida em um fonte.prw definido com o mesmo nome da função.
A função RetXmlTss deverá ser implementada apenas como função de interface para a API. Deverá ser totalmente desacoplada de qualquer definição de instrução de processamento, devendo apenas realizar as devidas validações das mensagens. Todo o processamento deverá estar definido em funções auxiliares.
A função RetXmlTss () deverá receber mensagens na estrutura JSON, onde serão convertidas em objeto pela função fwJsonDeserialize().
Caso não haja erro na deserialização de JSON para objeto, será chamada a rotina GetXml(), passando como parâmetro o objeto.
A função GetXml () retornará uma string, contendo o XML codificado em base64. Essa string será passada como parâmetro na chamada da função getJSONResp() junto com o código de status e mensagem de erro (caso exista). O retorno da função getJSONResp() é a mensagem já na estrutura JSON.
Todos os parâmetros da mensagem serão obrigatórios.
A rotina RetXmlTss() será finalizada e como retorno será passado a mensagem na estrutura JSON.
Função: GetXml()
A função GetXml() receberá como parâmetro o objeto da requisição, validará todos os campos quanto a obrigatoriedade, tamanho e tipo de dados. Se algum dado estiver inconsistente, deverá retorna a mensagem de validação correspondente informando.
Os dados contidos no objeto recebido como parâmetro, serão validados afim de identificar quais foram preenchidos, todos os campos são necessários para o retorno.
A função validará o tipo de documento, afim de identificar se é válida, esta informação estará contida dentro do objeto recebido como parâmetro.
Com as informações tipo de documento e número da entidade, será chamada a função RetXml(), para essa função serão passados como parâmetros: o número da entidade do cliente, o tipo de documento, número do documento e série do documento. O retorno desta função será uma mensagem string contendo o XML do documento codificado em base 64.
Após obter o retorno da rotina RetXml(), a função GetXml() será encerrada, retornando a string contendo o código xml em base64.
GetXml(oDados,cError,cHttpStatus)
oDados – Objeto contendo as informações da requisição: entidade, número do documento, série do documento, tipo de documento.
cError – Mensagem de erro, caso exista.
cXml – String contendo o XML codificado em base 64
Função: RetXml()
A função RetXml() receberá como parâmetro, a entidade do cliente, o tipo de documento, Nfe_Id, mensagem de erro(caso exista) e código do status, processará os dados afim de obter a mensagem XML.
A função verificará qual o tipo de documento, afim de identificar qual tabela irá buscar o XML.
A função por meio de Query, localizará o documento na tabela correspondente, obtendo informação do campo XML_ERP, essa informação string, será convertida em base64, que será o retorno da função.
(cEnt,cTipo,cDoc,cError)
cEnt – Código da entidade do cliente.
cTipo – Tipo de documento: ‘NFE’;’NFSE’, etc.
cDoc – Nfe_Id // Série + número do documento
cError – Mensagem de erro, caso exista.
cRet – String contendo o XML codificado em base64
Função: GetJSONResp()
A rotina consiste em obter os dados de entrada e gerar a mensagem em estrutura JSON.
A rotina retornará uma string na estrutura JSON
cHttpStatus – Código do Status.
aArray– Array multidimensional.
cError – Mensagem de erro.
cJSONResponse – String na estrutura JSON.
<Caso necessário inclua protótipos de telas com o objetivo de facilitar o entendimento do requisito, apresentar conceitos e funcionalidades do software>.
Protótipo 01
<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>.
Arquivo ou Código do Script: AAA – Negociação Financeira / *Versao=CP.2014.12_03*/
Índice | Chave |
01 | <FI9_FILIAL+FI9_IDDARF+FI9_STATUS> |
02 | <FI9_FILIAL+FI9_FORNEC+ FI9_LOJA+FI9_EMISS+FI9_IDDARF> |
03 | <FI9_FILIAL+FI9_FORNEC+ FI9_LOJA+FI9_PREFIX+FI9_NUM+FI9_PARCEL+FI9_TIPO> |
Campo | <AAA_PERESP> |
Tipo | <N> |
Tamanho | <6> |
Valor Inicial | <Varia de acordo com o tipo informado. Por exemplo, quando o campo “tipo” for date, neste campo pode ser informado uma data>. |
Mandatório | Sim ( ) Não ( ) |
Descrição | <Referência Mínima para Cálculo> |
Título | <Ref.Calc.> |
Picture | <@E999.99> |
Help de Campo | <Informar o % que o aluno pagará em dinheiro. Esse % poderá ser alterado durante a negociação> |
<Informações utilizadas na linha Protheus>.
Nome: FINSRF2
X1_ORDEM | 01 |
X1_PERGUNT | Emissão De |
X1_TIPO | D |
X1_TAMANHO | 8 |
X1_GSC | G |
X1_VAR01 | MV_PAR01 |
X1_DEF01 | Comum |
X1_CNT01 | '01/01/08' |
X1_HELP | Data inicial do intervalo de emissões das guias de DARF a serem consideradas na seleção dos dados para o relatório |
<Informações utilizadas na linha Protheus>
Consulta: AMB
Descrição | Configurações de Planejamento |
Tipo | Consulta Padrão |
Tabela | “AMB” |
Índice | “Código” |
Campo | “Código”; ”Descrição” |
Retorno | AMB->AMB_CODIGO |
<Informações utilizadas na linha Datasul>.
Procedimentos
Procedimento |
|
|
|
Descrição | (Max 40 posições) | (Max 40 posições) | (Max 40 posições) |
Módulo |
|
|
|
Programa base |
|
|
|
Nome Menu | (Max 32 posições) | (Max 32 posições) | (Max 32 posições) |
Interface | GUI/WEB/ChUI/Flex | GUI/WEB/ChUI/Flex | GUI/WEB/ChUI/Flex |
Registro padrão | Sim | Sim | Sim |
Visualiza Menu | Sim/Não | Sim/Não | Sim/Não |
Release de Liberação |
|
|
|
Programas
Programa
Descrição
(Max 40 posições)
(Max 40 posições)
(Max 40 posições)
Nome Externo
Nome Menu/Programa
(Max 32 posições)
(Max 32 posições)
(Max 32 posições)
Nome Verbalizado[1]
(Max 254 posições)
(Max 254 posições)
(Max 254 posições)
Procedimento
Template
(Verificar lista de opções no man01211)
(Verificar lista de opções no man01211)
(Verificar lista de opções no man01211)
Tipo[2]
Consulta/Manutenção/ Relatório/Tarefas
Consulta/Manutenção/ Relatório/Tarefas
Consulta/Manutenção/ Relatório/Tarefas
Interface
GUI/WEB/ChUI/Flex
GUI/WEB/ChUI/Flex
GUI/WEB/ChUI/Flex
Categoria[3]
Executa via RPC
Sim/Não
Sim/Não
Sim/Não
Registro padrão
Sim
Sim
Sim
Outro Produto
Não
Não
Não
Visualiza Menu
Sim/Não
Sim/Não
Sim/Não
Query on-line
Sim/Não
Sim/Não
Sim/Não
.
Sim/Não
Sim/Não
Sim/Não
Rotina (EMS)
Sub-Rotina (EMS)
Localização dentro da Sub Rotina (EMS)
Compact[4]
Sim/Não
Sim/Não
Sim/Não
Home[5]
Sim/Não
Sim/Não
Sim/Não
Posição do Portlet[6]
0 – Top Left
1 – Top Right
2 – Bottom Left
3 – Bottom Right
0 – Top Left
1 – Top Right
2 – Bottom Left
3 – Bottom Right
0 – Top Left
1 – Top Right
2 – Bottom Left
3 – Bottom Right
Informar os papeis com os quais o programa deve ser vinculado
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>.
Código Papel | (máx 3 posições) |
Descrição em Português* |
|
Descrição em Inglês* |
|
[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. |
---|