Conteúdo

1. Visão geral
2. Conexão com o Produto
3. Relacionamento com Schemas

01. Visão geral

Após a instalação do TOTVS Connector Client, deverá ser realizada a configuração para que a aplicação passe a integrar os dados. Basicamente o que deve ser feito é informar os dados do banco de dados do produto OnPremise e habilitar quais os Schemas devem ser integrados.

02. Conexão com o Produto

Para informar os dados de conexão com o Produto, deve-se acessar o swagger da aplicação (exemplo: http://192.168.0.10:8080/swagger-ui-html), encontrar o endpoint POST /api/v1/productConnections e inserir os dados de conexão com o banco do Produto conforme exemplo abaixo:

Os atributos informados no JSON são:

• databaseType: Tipo do banco, os valores possíveis são: POSTGRESQL, MSSQLSERVER, ORACLE11G, ORACLE12C ou MYSQL
• enabled: Passar sempre true
• password: Senha do banco de dados do Produto (Essa informação será armazenada criptografada)
• productName: Identificador do Produto (Deverá ser um valor pré-determinado de acordo com o Schema)
• productVersion: Versão do Produto (Possívelmente existirão versões compatíveis do Produto com os Schemas necessários)
• url: URL JDBC de conexão com o banco de dados do Produto (Essa informação será armazenada criptografada)
• username: Usuário do banco de dados do Produto (Essa informação será armazenada criptografada)

Observação:

A tabela TCC_PRODUT_METADATA deve existir no produto com as colunas NAME e VERSION. Caso não existam, criar com base no script abaixo (para Oracle): 

CREATE TABLE TCC_PRODUCT_METADATA (
    NAME VARCHAR2(255),
    VERSION VARCHAR2(50)
);

03. Relacionamento com Schemas

Após configurar o banco de dados do Produto será necessário habilitar os Schemas que devem ser integrados entre Produto OnPremise e SaaS. Para isso, seguir os passos abaixo:

Identificar os IDs dos Schemas (de acordo com a versão necessária) que precisem ser integrados através do endpoint GET /api/v1/schema (com possibilidade de filtrar por nome e versão):

Com os IDs em mãos, agora será necessário relacioná-los com a Conexão do Produto através do endpoint POST /api/v1/productConnections/schemas:

Os atributos informados nesta requisição são:

• enableStandalone: true ou false (caso seja necessário o TOTVS Connector Client realizar integrações entre aplicações OnPremise). Mais informações sobre o modo Standalone
• idProductConnection: ID da Conexão com o Produto cadastrada anteriormente (pode ser obtida pelo endpoint GET /api/v1/productConnections)
• idSchemaDefinition: ID do Schema obtido no passo anterior