Informações Gerais

   Legenda: 1 – Inovação 2 – Manutenção (Os demais campos devem ser preenchidos para ambos os processos). 

Objetivo

Elaborar a especificação que orientará a implementação e manutenção do Configurador na linha de produto TOP com EAI.

Definições Gerais

A primeira versão da API de configuração foi desenvolvida considerando o escopo e restrições listados abaixo.

Escopo e Restrições

• A API de configuração será criada no projeto RM.Prj.TotvsMessage.Server, juntamente com suas dependências (scripts)
• Os parâmetros que são manipulados atualmente a partir de procedures e triggers serão mantidos desta forma.
  • Os scripts com as procedures e triggers serão copiados para o projeto e terão somente os valores atualizados para o esperado na integração via EAI 2.0
    • A API de configuração será responsável por executar os scripts de atualização destes artefatos
    • Os parâmetros definidos nestes scripts não serão apresentados na tela do configurador uma vez que estes não podem ser alterados.
• Os parâmetros de integração do TOP, listados na devida seção neste documento, serão manipulados diretamente pela API.
  • Estes parâmetros que dependem de definição por parte do usuário serão manipulados na API para serem parametrizados via interface do configurador.
• Os parâmetros que não permitem alteração por parte do usuário serão adicionados na API para atualização com valor fixo, não apresentando ao usuário na interface do configurador.
• Esta versão da API efetuará a configuração sem considerar a concorrência de múltiplas integrações pelo mesmo parâmetro ou mensagem, de forma similar ao configurador existente para o EAI 1.0.

Definições da Regra de Negócio

Configurações

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

Projeto RM.Con.ConfiguraIntegracao.TotvsMessage

00_PARAMETROS_GERAL

O script "00_PARAMETROS_GERAL.sql" foi atualizado e levado para o projeto "RM.Prj.TotvsMessage.Server".

Projeto RM.Con.ConfiguraIntegracao.TotvsMessage.Procedures

00_A_PROCEDURES

O script "00_A_PROCEDURES.sql" foi atualizado e levado para o projeto "RM.Prj.TotvsMessage.Server" com o nome "01_A_PROCEDURES.sql".

00_PARAMETROS_GERAL

O script "00_PARAMETROS_GERAL.sql" foi atualizado e levado para o projeto "RM.Prj.TotvsMessage.Server" com o nome "99_PARAMETROS_GERAL.sql".

Projeto RM.Prj.TotvsMessage.Configurador.Protheus

03_PARAMETROS

O script "03_PARAMETROS.sql" foi atualizado e levado para o projeto "RM.Prj.TotvsMessage.Server" com o nome "02_PARAMETROS.sql"

Projeto RM.Prj.TotvsMessage.Server

Estrutura final dos scripts do configurador TOP

00_PARAMETROS_GERAL

Inclusão da procedure de configuração dos parâmetros por coligada.

01_A_PROCEDURE

Inclusão de procedures e triggers de configuração.

02_PARAMETROS

Atualiza os parâmetros do TOP fixados para integração com Protheus

99_PARAMETROS_GERAL

Executa os procedures de configuração para as coligadas.

Parâmetros

Os parâmetros disponibilizados na interface serão discriminados abaixo

Estrutura

API

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

Metadata

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.

Values

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.

Protótipos de Tela

Tela 01 - Seleção da Integração

Tela 02 - Configuração da Integração

Tela 03 - Configuração dos Parâmetros da Integração