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().
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:
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.
A rotina RetXmlTss() será finalizada e como retorno será passado a mensagem na estrutura JSON.
cJsonRequest =
{
"empresa":
{"Entidade": "000002"},
"tipdoc":"nfe",
"parametros":{"docid":"001000001"}
}
Retorno Negativo:
Retorno:
{
"status": 200, "result":"PE5GZSB4bWxucz0iaHR0cDovL3d3dy5wb3J0YWxmaXNjYWwuaW5mLmJyL25mZSI+PGluZk5GZSB2ZXJzYW89I
jMuMTAiIElkPSJORmUzNTE1MDY1MzExMzc5MTAwMDEyMjU1NzU0MDAwMDAwNTgyMTAwMjgxMTExOSI+PGlkZT48Y1VGPjM
1PC9jVUY+PGNORj4wMDI4MTExMTwvY05GPjxuYXRPcD5WRU5EQSBJQ01TPC9uYXRPcD48aW5kUGFnPjA8L2luZFBhZz48bW9kPj
U1PC9tb2Q+PHNlcmllPjc1NDwvc2VyaWU+PG5ORj41ODI8L25ORj48ZGhFbWk+MjAxNS0wNi0xMVQxOTozMjowMC0wMjowMDwvZG
hFbWk+PGRoU2FpRW50PjIwMTUtMDYtMTFUMTk6MzI6MDAtMDI6MDA8L2RoU2FpRW50Pjx0cE5GPjA8L3RwTkY+PGlkRGVzdD4y
PC9pZERlc3Q+PGNNdW5GRz4zNTUwMzA4PC9jTXVuRkc+PHRwSW1wPjE8L3RwSW1wPjx0cEVtaXM+MTwvdHBFbWlzPjxjRFY+OT
wvY0RWPjx0cEFtYj4yPC90cEFtYj48ZmluTkZlPjE8L2Zpbk5GZT48aW5kRmluYWw+MDwvaW5kRmluYWw+PGluZFByZXM+OTwvaW5
kUHJlcz48cHJvY0VtaT4wPC9wcm9jRW1pPjx2ZXJQcm9jPjIuNDc8L3ZlclByb2M+PC9pZGU+PGVtaXQ+PENOUEo+NTMxMTM3OTEwM
DAxMjI8L0NOUEo+PHhOb21lPlRPVFZTIFNBPC94Tm9tZT48eEZhbnQ+VEVTVEU8L3hGYW50PjxlbmRlckVtaXQ+PHhMZ3I+QVYuIEJ
SQVogTEVNRTwveExncj48bnJvPjE2MzE8L25ybz48eEJhaXJybz5KRC4gU0FPIEJFTlRPPC94QmFpcnJvPjxjTXVuPjM1NTAzMDg8L2NNd
W4+PHhNdW4+U0FPIFBBVUxPPC94TXVuPjxVRj5TUDwvVUY+PENFUD4wMjUxMTAwMDwvQ0VQPjxjUGFpcz4xMDU4PC9jUGFpc
z48eFBhaXM+QlJBU0lMPC94UGFpcz48Zm9uZT41NTExMzk4MTcyMDA8L2ZvbmU+PC9lbmRlckVtaXQ+PElFPjExMTAxMDk0NTExMT
wvSUU+PENSVD4zPC9DUlQ+PC9lbWl0PjxkZXN0PjxDTlBKPjY1NTc2MTQzMDAwMTkxPC9DTlBKPjx4Tm9tZT5ORi1FIEVNSVRJREE
gRU0gQU1CSUVOVEUgREUgSE9NT0xPR0FDQU8gLSBTRU0gVkFMT1IgRklTQ0FMPC94Tm9tZT48ZW5kZXJEZXN0Pjx4TGdyPlJVQS
BKT1NFIFRFSVhFSVJBIERFIEFSQVVKTzwveExncj48bnJvPjg1PC9ucm8+PHhCYWlycm8+RkxPUkFNQVI8L3hCYWlycm8+PGNNdW4+
MzEwNjIwMDwvY011bj48eE11bj5CRUxPIEhPUklaT05URTwveE11bj48VUY+TUc8L1VGPjxDRVA+MzE3NDIxMzg8L0NFUD48Y1BhaX
M+MTA1ODwvY1BhaXM+PHhQYWlzPkJSQVNJTDwveFBhaXM+PGZvbmU+MzE4NjgyNTY4NjwvZm9uZT48L2VuZGVyRGVzdD48aW
5kSUVEZXN0PjI8L2luZElFRGVzdD48L2Rlc3Q+PGRldCBuSXRlbT0iMSI+PHByb2Q+PGNQcm9kPlAwMDFfSVNJUzwvY1Byb2Q+PGNF
QU4+PC9jRUFOPjx4UHJvZD5QUk9EVVRPIEFDQUJBRE8gSVNJUyBQSVMgQ09GSU48L3hQcm9kPjxOQ00+MDEwMTEwOTA8L05DT
T48Q0ZPUD4yNDAzPC9DRk9QPjx1Q29tPlBDPC91Q29tPjxxQ29tPjEuMDAwMDwvcUNvbT48dlVuQ29tPjUwLjAwMDAwMDAwPC92VW
5Db20+PHZQcm9kPjUwLjAwPC92UHJvZD48Y0VBTlRyaWI+PC9jRUFOVHJpYj48dVRyaWI+UEM8L3VUcmliPjxxVHJpYj4xLjAwMDA8
L3FUcmliPjx2VW5UcmliPjUwLjAwMDAwMDAwPC92VW5UcmliPjx2T3V0cm8+MTAuNzA8L3ZPdXRybz48aW5kVG90PjE8L2luZFRvdD
48L3Byb2Q+PGltcG9zdG8+PElDTVM+PElDTVMwMD48b3JpZz4wPC9vcmlnPjxDU1Q+MDA8L0NTVD48bW9kQkM+MzwvbW9kQkM+P
HZCQz41MC4wMDwvdkJDPjxwSUNNUz4xMi4wMDAwPC9wSUNNUz48dklDTVM+Ni4wMDwvdklDTVM+PC9JQ01TMDA+PC9JQ01TP
jxJUEk+PGNFbnE+OTk5PC9jRW5xPjxJUElUcmliPjxDU1Q+NTA8L0NTVD48dkJDPjUwLjAwPC92QkM+PHBJUEk+Ny4wMDAwPC9wSV
BJPjx2SVBJPjMuNTA8L3ZJUEk+PC9JUElUcmliPjwvSVBJPjxQSVM+PFBJU05UPjxDU1Q+MDU8L0NTVD48L1BJU05UPjwvUElTPjxQS
VNTVD48dkJDPjUzLjUwPC92QkM+PHBQSVM+MTAuMDAwMDwvcFBJUz48dlBJUz41LjM1PC92UElTPjwvUElTU1Q+PENPRklOUz48
Q09GSU5TTlQ+PENTVD4wNTwvQ1NUPjwvQ09GSU5TTlQ+PC9DT0ZJTlM+PENPRklOU1NUPjx2QkM+NTMuNTA8L3ZCQz48cENPRk
lOUz4xMC4wMDAwPC9wQ09GSU5TPjx2Q09GSU5TPjUuMzU8L3ZDT0ZJTlM+PC9DT0ZJTlNTVD48L2ltcG9zdG8+PC9kZXQ+PHRvdGF
sPjxJQ01TVG90Pjx2QkM+NTAuMDA8L3ZCQz48dklDTVM+Ni4wMDwvdklDTVM+PHZJQ01TRGVzb24+MDwvdklDTVNEZXNvbj48dkJD
U1Q+MDwvdkJDU1Q+PHZTVD4wPC92U1Q+PHZQcm9kPjUwLjAwPC92UHJvZD48dkZyZXRlPjA8L3ZGcmV0ZT48dlNlZz4wPC92U2VnP
jx2RGVzYz4wPC92RGVzYz48dklJPjA8L3ZJST48dklQST4zLjUwPC92SVBJPjx2UElTPjA8L3ZQSVM+PHZDT0ZJTlM+MDwvdkNPRklOUz
48dk91dHJvPjEwLjcwPC92T3V0cm8+PHZORj42NC4yMDwvdk5GPjwvSUNNU1RvdD48L3RvdGFsPjx0cmFuc3A+PG1vZEZyZXRlPjE8L21
vZEZyZXRlPjwvdHJhbnNwPjxjb2JyPjxkdXA+PG5EdXA+NzU0MDAwNTgyPC9uRHVwPjxkVmVuYz4yMDE1LTA2LTExPC9kVmVuYz48
dkR1cD42NC4yMDwvdkR1cD48L2R1cD48L2NvYnI+PC9pbmZORmU+PC9ORmU+" ,
"error": null
}
Função: GetXml()
cXml – String contendo o XML codificado em base 64
Função: RetXml()
cRet – String contendo o XML codificado em base64
Função: GetJSONResp()
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 |
Log Exec. | 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
[6] 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. |
---|