Este documento é material de especificação dos requisitos de inovação, trata-se de conteúdo extremamente técnico. |
---|
Especificação | |||
Produto | TOTVS | Módulo | EAI |
Segmento Executor | Framework | ||
Projeto1 | DEAI1 | IRM/EPIC1 | |
Requisito/Story/Issue1 | DEAI1-1860 | Subtarefa1 | DEAI1-1897 |
Chamado/Ticket2 | |||
País | ( ) Brasil ( ) Argentina ( ) Mexico ( ) Chile ( ) Paraguai ( ) Equador ( ) USA ( ) Colombia ( X ) TODOS. | ||
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).
Elaborar a especificação que orientará a implementação e manutenção do Configurador na linha de produto TOP com EAI.
A primeira versão da API de configuração foi desenvolvida considerando o escopo e restrições listados abaixo.
Os scripts abaixo foram revisados, alterando para os valores da integração com EAI 2.0, e disponibilizados para execução na API de configuração da integração (verbo POST).
O script "00_PARAMETROS_GERAL.sql" foi atualizado e levado para o projeto "RM.Prj.TotvsMessage.Server".
O script "00_A_PROCEDURES.sql" foi atualizado e levado para o projeto "RM.Prj.TotvsMessage.Server" com o nome "01_A_PROCEDURES.sql".
O script "00_PARAMETROS_GERAL.sql" foi atualizado e levado para o projeto "RM.Prj.TotvsMessage.Server" com o nome "99_PARAMETROS_GERAL.sql".
O script "03_PARAMETROS.sql" foi atualizado e levado para o projeto "RM.Prj.TotvsMessage.Server" com o nome "02_PARAMETROS.sql"
Estrutura final dos scripts do configurador TOP
Inclusão da procedure de configuração dos parâmetros por coligada.
Inclusão de procedures e triggers de configuração.
Atualiza os parâmetros do TOP fixados para integração com Protheus
Executa os procedures de configuração para as coligadas.
Os parâmetros disponibilizados na interface serão discriminados abaixo
Aplicação | Tabela | Parâmetro | Tipo | Valor Padrão |
---|---|---|---|---|
Integração de Projetos | HCPARAMETROS | STATUSPRJ_EMANDAMENTO | Boolean | True |
HCPARAMETROS | STATUSPRJ_PARALISADO | Boolean | True | |
HCPARAMETROS | STATUSPRJ_CONCLUIDO | Boolean | True | |
HCPARAMETROS | STATUSPRJ_AEXECUTAR | Boolean | True | |
HCPARAMETROS | STATUSPRJ_EMNEGOCIACAO | Boolean | True | |
HCPARAMETROS | STATUSPRJ_REVISADO | Boolean | True | |
HCPARAMETROS | STATUSPRJ_CANCELADO | Boolean | True | |
Integração de Cotação de Moedas | HCPARAMETROS | MOEDAPADRAO | String | <VAZIO> |
Integração de Pedidos | HCPARAMETROS | PRODUTOPADRAO | String | <VAZIO> |
Integração de Tarefas | HCPARAMETROS | PRJ_EXPORTAVALORTRF | Boolean | False |
Integração de Solicitações | HCPARAMETROS | PRJ_AGLUTINAITENSSC | Boolean | True |
HCPARAMETROS | PRJ_AGLUTINAITENSPEDIDO | Boolean | True | |
HCPARAMETROS | PRJ_AGLUTINAITENSSA | Boolean | True | |
Consulta de Apropriação de Custos | HCPARAMETROS | CONSWSAPROPRIACAOPROTHEUS | Boolean | False |
HCPARAMETROS | PRJ_URLAPIRESTPROTHEUS | String | "HTTP://[Server]:[Port]" | |
HCPARAMETROS | PRJ_USRAPIRESTPROTHEUS | String | <VAZIO> | |
HCPARAMETROS | PRJ_PASSAPIRESTPROTHEUS | String | <VAZIO> |
As APIs serão disponibilizadas com base na especificação abaixo
openapi: '3.0.1' info: title: Configurador / Integração EAI description: API de Pacotes de Integrações para a Configuração das Integrações no EAI 2.0 version: '0.1' externalDocs: url: 'http://tdn.totvs.com/display/framework/ER_DEAI1_Configurador_TOP_Protheus_EAI_2' servers: - url: 'https://{server}:{port}/rm/configurator/v1/PrjConfiguraIntegracaoAPI' - url: '{protocol}://{server}:{port}/rm/configurator/{version}/PrjConfiguraIntegracaoAPI' variables: protocol: default: https enum: - http - https server: default: server port: default: port version: default: v1 paths: /Metadata: get: tags: - Metadata summary: Retorna as informações dos parâmetros para construção da tela. responses: '200': description: Lista de metadados content: application/json: schema: type: array items: $ref: '#/components/schemas/Metadata' /Values: get: tags: - Values summary: Retorna os valores atuais ou padrão dos parâmetros. responses: '200': description: Lista de valores content: application/json: schema: type: array items: $ref: '#/components/schemas/Value' put: tags: - Values summary: Atualiza os parâmetros. description: Além da atualização dos parâmetros recebidos no Json a API executará sempre os scripts de configuração descritos na devida seção deste documento. responses: '200': description: Valores atualizados content: application/json: schema: type: array items: $ref: '#/components/schemas/Value' components: schemas: Metadata: type: object required: - name - label - datatype properties: name: type: string label: type: string datatype: type: string default: text enum: - text - number - combo - date options: type: array items: $ref: '#/components/schemas/Option' Option: type: object required: - value - label properties: value: type: string label: type: string Value: type: object required: - name - value properties: name: type: string value: type: string
Request Method: GET
URI: HTTP://[Server]:[Porta]/rm/configurator/v1/PrjConfiguraIntegracaoAPI/Metadata
Método responsável por retornar as informações dos parâmetros para construção da tela.
Request Method: GET
URI: HTTP://[Server]:[Porta]/rm/configurator/v1/PrjConfiguraIntegracaoAPI/Values
Método responsável por retornar os valores atuais ou default dos parâmetros.
Request Method: PUT
URI: HTTP://[Server]:[Porta]/rm/configurator/v1/PrjConfiguraIntegracaoAPI/Values
Método responsável por atualizar os parâmetros com base no Json enviado no Body pelo Configurador.
Além da atualização dos parâmetros recebidos no Json a API executará sempre os scripts de configuração descritos na devida seção deste documento.
Este documento é material de especificação dos requisitos de inovação, trata-se de conteúdo extremamente técnico. |
---|