| Jira | ||||||
|---|---|---|---|---|---|---|
|
...
O TOTVS iPaaS é uma ferramenta de integração de produtos, permitindo conectar produtos que utilizam diferentes formas de comunicação, de maneira simples e intuitiva utilizando drag-and-drop (arrastar e soltar) para que qualquer pessoa consiga elaborar diagramas. Atuando como intermediário, o TOTVS iPaaS permite realizar transformações nos dados de A para enviar a B, e vice-versa, além de criar diversos fluxos personalizados baseados em condições específicas dos dados trafegados. A solução também é capaz de integrar com qualquer aplicação, seja da TOTVS ou de terceiros.
...
Monitoramento → Monitor: É responsável por monitorar a quantidade de mensagens transacionadas, separando-as em processadas, em processamento, reprocessadas e com falhas. É possível reprocessar as mensagens de um ou vários diagramas na subdivisão "Mensagens". As informações podem ser filtradas por intervalo de tempo.
Monitoramento → Dashboard: Resume as informações de integração, como o consumo do plano contratado, a saúde do ambiente (percentual de mensagens processadas com sucesso em relação ao total transacionado), a quantidade de transações por diferentes períodos de tempo e os diagramas que levam mais tempo para executar, entre outras métricas.
Monitoramento → Alertas: Esta tela tem como objetivo automatizar a vigilância de problemas e dados de consumo nas integrações, permitindo a criação de alertas personalizados para monitorar o "Limite de mensagens" e a "Taxa de erro". A primeira opção notifica um número específico de pessoas definidas sobre o consumo de transações em relação ao plano contratado. A segunda opção alerta os responsáveis sobre exceções e erros nas integrações. Ambas opções permitem definir limites quantitativos ou percentuais para o envio dos alertas. Os contatos que receberão os alertas podem ser configurados com e-mails, Discord, Telegram, entre outros.
Integrações → Projetos e Pacotes → Templates: Criar diagramas a partir de templates pré-configurados. Além dos templates padrão, também é possível definir outros templates personalizados, facilitando e agilizando a criação de diagramas frequentemente utilizados.
Integrações → Projetos e Pacotes → Diagramas: O builder é a ferramenta de construção de diagramas, projetada no formato "arrasta e solta", permitindo a criação rápida e intuitiva de diagramas com diversas opções de configuração. Os diagramas podem ser salvos como rascunho ou publicados imediatamente após a finalização. No menu à esquerda, você pode acessar uma lista de aplicativos nativos e personalizados e os componentes essenciais para a construção dos diagramas. Também é possível editar configurações importantes, como o título e a descrição do diagrama, adicionar ou modificar variáveis, e ajustar a pré-visualização. O builder oferece ainda a possibilidade de consultar o histórico de ações e validar o diagrama, verificando automaticamente possíveis erros de fluxo ou configurações inadequadas antes da publicação. Além disso, o builder oferece funções adicionais no painel à esquerda, como a opção de alternar entre fundo claro e escuro para maior conforto, ajustar o zoom para facilitar a visualização de diagramas grandes, e a função "voltar ao início", que reposiciona o diagrama na posição original dentro do builder.
Ferramentas → Aplicativos → Nativos: Na guia "Nativos", estão listados todos os Aplicativos nativos homologados pela TOTVS, que já vêm disponíveis para uso ao adquirir o TOTVS iPaaS.
Ferramentas → Aplicativos → Personalizados: A guia "Personalizados" exibe exclusivamente os aplicativos criados pelos usuários. Estes aplicativos podem ser editados clicando no ícone de engrenagem.
Para criar um novo aplicativo, basta localizar a opção "Cadastrar aplicativo" na aba "Aplicativos". Após criar um aplicativo, também é possível cadastrar os recursos que será utilizado, como Cadastrar ambiente, Cadastrar conta e Cadastrar serviço.
Ferramentas → Componentes: Lista os componentes de início, básicos e avançados por meio das guias de cada tipo de componentes. Além disso, é possível localizar componentes por meio da barra de busca.
Ferramentas → Componentes → Iniciais: Esta
O TOTVS IPaaS é uma ferramenta de integração de sistemas, permitindo conectar produtos que utilizam diferentes formas de comunicação. Atuando como intermediário, o TOTVS IPaaS permite realizar transformações nos dados de A para enviar a B, e vice-versa, além de criar diversos fluxos personalizados baseados em condições específicas dos dados trafegados. A solução também é capaz de integrar com qualquer aplicação, seja da TOTVS ou de terceiros.
Monitoramento → Monitor: Essa tela é responsável por monitorar a quantidade de mensagens transacionadas, separando-as em processadas, em processamento, reprocessadas e com falhas. É possível reprocessar as mensagens de um ou vários diagramas na subdivisão "Mensagens". As informações podem ser filtradas por intervalo de tempo.
Monitoramento → Dashboard: Essa tela resume as informações de integração, como o consumo do plano contratado, a saúde do ambiente (percentual de mensagens processadas com sucesso em relação ao total transacionado), a quantidade de transações por diferentes períodos de tempo e os diagramas que levam mais tempo para executar, entre outras métricas.
Monitoramento → Alertas: Essa tela tem como objetivo automatizar a vigilância de problemas e dados de consumo nas integrações, permitindo a criação de alertas personalizados para monitorar o "Limite de mensagens" e a "Taxa de erro". A primeira opção notifica um número específico de pessoas definidas sobre o consumo de transações em relação ao plano contratado. A segunda opção alerta os responsáveis sobre exceções e erros nas integrações. Ambas opções permitem definir limites quantitativos ou percentuais para o envio dos alertas. Os contatos que receberão os alertas podem ser configurados com e-mails, Discord, Telegram, entre outros.
Integrações → Projetos e Pacotes → Templates: No TOTVS iPaaS, você pode criar diagramas a partir de templates pré-configurados. Além dos templates padrão, também é possível definir outros templates personalizados, facilitando e agilizando a criação de diagramas frequentemente utilizados.
Integrações → Projetos e Pacotes → Diagramas: O builder é a ferramenta de construção de diagramas do TOTVS iPaaS, projetada no formato "arrasta e solta", permitindo a criação rápida e intuitiva de diagramas com diversas opções de configuração. Os diagramas podem ser salvos como rascunho ou publicados imediatamente após a finalização. No menu à esquerda, você pode acessar uma lista de aplicativos nativos e personalizados e os componentes essenciais para a construção dos diagramas. Também é possível editar configurações importantes, como o título e a descrição do diagrama, adicionar ou modificar variáveis, e ajustar a pré-visualização. O builder oferece ainda a possibilidade de consultar o histórico de ações e validar o diagrama, verificando automaticamente possíveis erros de fluxo ou configurações inadequadas antes da publicação. Além disso, o builder oferece funções adicionais no painel à esquerda, como a opção de alternar entre fundo claro e escuro para maior conforto, ajustar o zoom para facilitar a visualização de diagramas grandes, e a função "voltar ao início", que reposiciona o diagrama na posição original dentro do builder.
Ferramentas → Aplicativos → Nativos: Na guia "Nativos", estão listados todos os aplicativos homologados pela TOTVS, que já vêm disponíveis para uso ao adquirir o TOTVS iPaaS. Você pode conferir cada um deles neste link: Aplicativos nativos.
Ferramentas → Aplicativos → Personalizados: A guia "Personalizados" exibe exclusivamente os aplicativos criados pelos usuários. Esses aplicativos podem ser editados clicando no ícone de engrenagem.
Para criar um novo aplicativo, basta localizar a opção "Cadastrar aplicativo" na aba "Aplicativos". Após criar um aplicativo, também é possível cadastrar os recursos que ele utilizará, como Ambientes, Contas e Serviços. Para o passo a passo de cada tipo de cadastro de recurso, acesse os links a seguir: Cadastrar ambiente, Cadastrar conta e Cadastrar serviço.
Ferramentas → Componentes: A página de componentes do TOTVS iPaaS lista os componentes de início, básicos e avançados através das guias de cada tipo de componente. Além disso, é possível localizar componentes através da barra de busca. Para mais detalhes e especificações de cada componente, consulte este link: Componentes.
Ferramentas → Componentes → Iniciais: Essa guia traz apenas os componentes que estão disponíveis para iniciar uma integração/diagrama. Sendo eles: SmartLink Hook, Timer, Webhook e Webhook síncrono.
Ferramentas → Componentes → Básicos: Essa Esta guia traz os componentes de uso básico no TOTVS iPaaS. Sendo eles: Converter, Generator, Global error, JDBC, Jolt, Resposta síncrona, JavaScript (disponível para o plano Enterprise), SmartLink Sender, Splitter, Throw Exception e XSLT.
Ferramentas → Componentes → Básicos → Avançados: Essa guia traz os componentes de uso avançado no TOTVS iPaaS. Sendo eles: FTP e SFTP.
Ferramentas → Variáveis → Projetos: Funcionam de maneira similar às variáveis globais, mas com o escopo limitado a um único projeto. Assim, as variáveis de projeto só são visíveis para diagramas dentro desse projeto específico.
Ferramentas → Variáveis → Globais: Visam facilitar o desenvolvimento de diagramas, reduzindo a duplicação de dados. Dados comuns podem ser cadastrados como palavras-chave e usados em múltiplos diagramas de um ou mais projetos. Caso haja necessidade de alteração, essa mudança refletirá em todos os diagramas que utilizam a variável.
Os dados apresentados abaixo foram consultados no Webinar de Apresentação da Solução TOTVS iPaaS.
Obs: valores e planos sujeitos a atualização, consulte o responsável.
O projeto ta-api-hub é uma ferramenta desenvolvida para facilitar a exposição de APIs de forma facilitada e padronizada, com base na estrutura de dados das soluções TOTVS Agro (Bioenergia), possibilitando também customizar as APIs via cadastro de queries obtendo maior flexibilidade.
O Cadastro de Entidades e Queries definirá a configuração / exposição e comportamento das APIs, bem como os métodos HTTPs habilitados, tabelas e colunas utilizadas, atributos da estrutura JSON relacionada, validações básicas, como tamanho, tipo de dado, obrigatoriedade, aplicação de máscara, validação de existência de entidade relacionada.
| Multimedia | ||||||
|---|---|---|---|---|---|---|
|
A disponibilização das APIs no ta-api-hub é realizada via cadastro de entidades, definida e baseada na estrutura de dados da aplicação, conforme os cadastros a seguir:
Endpoint para entidades:
Estrutura de dados:
| Bloco de código | ||||
|---|---|---|---|---|
| ||||
{
"id": "UUID",
"name": "nomeEntidade",
"description": "Descrição da Entidade",
"product": "BIOENERGIA",
"entityTable": "NOME_DA_TABELA",
"lastUpdate": "2024-06-20T12:58:05.401",
"entityDeList": [
{
"id": "UUID",
"fieldName": "nomeDoCampo",
"description": "Descricao do Campo",
"tableColumn": "NOME_DA_COLUNA",
"columnType": "STRING",
"columnSize": 50,
"columnRequired": true,
"columnMask": null,
"columnPk": true,
"tableFk": null,
"columnFk": null,
"filter": true
},
...
],
"entityChildList": [
{
"id": "UUID",
"entityChild":{}
"entityChildType": ""
},
...
],
"entityApi": {
"id": "UUID",
"pathUrl": "entidades",
"apiVersion": "v1",
"businessClass": "",
"enableGet": true,
"enablePost": true,
"enablePut": true,
"enableDelete": true,
"enabled": true,
"lastUpdate": "2024-06-20T12:58:05.401"
}
} |
Diponibilizado endpoint para consulta do sumário de entidades cadastradas.
Método GET
| Bloco de código | ||||
|---|---|---|---|---|
| ||||
[
{
"id": "a3427359-dc2f-4245-915c-972cfa2b25af",
"name": "parametro",
"description": "Parametros",
"path": "api/entity/v1/parametros",
"enableGet": true,
"enablePost": false,
"enablePut": false,
"enableDelete": false,
"enabled": true,
"details": [
{
"id": "d4a0e418-9423-4516-940b-03d4de5b9800",
"fieldName": "secao",
"description": "Seção",
"columnRequired": false,
"columnPk": false,
"filter": true
},
{
"id": "6c076bf9-2456-4b46-b43a-1296047be0ab",
"fieldName": "entrada",
"description": "Entrada",
"columnRequired": false,
"columnPk": false,
"filter": true
},
{
"id": "87c60f83-7592-44d7-9005-43589a05dcda",
"fieldName": "tipo",
"description": "Tipo",
"columnRequired": false,
"columnPk": false,
"filter": false
},
{
"id": "2fe199e6-3209-463b-af31-1ef20794e2b5",
"fieldName": "valor",
"description": "Valor",
"columnRequired": false,
"columnPk": false,
"filter": false
},
{
"id": "0611d39b-42f8-4044-86db-bb9e6336c998",
"fieldName": "descricao",
"description": "Descrição",
"columnRequired": false,
"columnPk": false,
"filter": true
},
{
"id": "828fcde4-9d47-4270-b1a7-82f35f148517",
"fieldName": "validos",
"description": "Valores Válidos",
"columnRequired": false,
"columnPk": false,
"filter": false
},
{
"id": "a4802480-ed33-46b6-91c1-df0e442672ac",
"fieldName": "instancia",
"description": "Instancia",
"columnRequired": false,
"columnPk": false,
"filter": true
}
]
},
...
] |
A disponibilização das APIs no ta-api-hub também podes ser realizada via cadastro de queries, definida e baseada na estrutura de dados da aplicação, conforme os cadastros a seguir:
Endpoint para queries:
Estrutura de dados:
| Bloco de código | ||||
|---|---|---|---|---|
| ||||
[
{
"id": "UUID",
"name": "nomeEstruturaDados",
"description": "Descrição",
"product": "BIOENERGIA",
"pathUrl": "queries",
"lastUpdate": "2024-06-20T04:58:05.401",
"queryDeList": [
{
"id": "UUID",
"apiVersion": "v1",
"query": "SELECT CD_SAFRA, DE_SAFRA, DE_COMP_TBL FROM SAFRAS WHERE CD_SAFRA = ::codigo",
"databaseType": "ORACLE",
"httpMethod": "GET",
"enabled": true
},
...
],
"queryFieldsList": [
{
"fieldName": "codigo",
"tableColumn": "CD_SAFRA",
"columnType": "INTEGER",
"columnSize": 5,
"columnRequired": true,
"columnMask": null,
"columnPk": true,
"tableFk": null,
"columnFk": null,
"id": "697e73b0-9520-4819-a6dc-350172fd9792"
},
...
]
}
] |
Diponibilizado endpoint para consulta do sumário de queries cadastradas.
Método GET
| Bloco de código | ||||
|---|---|---|---|---|
| ||||
[
{
"id": "ce429b8e-e284-44c7-a37c-d7dfbb0b7aed",
"name": "safra",
"description": "Safras",
"details": [
{
"id": "56c53717-727b-4b33-bfcd-57b6f85d20df",
"query": "SELECT CD_SAFRA, DE_SAFRA, DE_COMP_TBL FROM SAFRAS WHERE CD_SAFRA = ::codigo",
"httpMethod": "GET",
"path": "/api/v1/safras",
"enabled": true
},
{
"id": "bf3bbf43-cb35-4cc7-8c50-4c441772d4ce",
"query": "INSERT INTO SAFRAS(CD_SAFRA, DE_SAFRA, DE_COMP_TBL) VALUES (::codigo,::descricao,::complemento)",
"httpMethod": "POST",
"path": "/api/v1/safras",
"enabled": true
},
{
"id": "23856856-2b8b-48a4-988d-38a20dba7209",
"query": "UPDATE SAFRAS SET DE_SAFRA = ::descricao, DE_COMP_TBL = ::complemento WHERE CD_SAFRA = ::codigo",
"httpMethod": "PUT",
"path": "/api/v1/safras",
"enabled": true
},
{
"id": "4ddbba69-91a3-4f6e-92c3-92cd24a8619a",
"query": "DELETE FROM SAFRAS WHERE CD_SAFRA = ::codigo",
"httpMethod": "DELETE",
"path": "/api/v1/safras",
"enabled": true
}
]
}
] |
A URL para as entidades e queries cadastradas é composta confome conforme configurado no cadastro da EntityAPI e QueryHe/QueryDe, para os campos apiVersion e pathUrl, conforme demonstrado a seguir:
Os métodos HTTPs que podem ser utilizados são GET, POST, PUT e DELETE, e estarão disponíveis conforme configurados em cada modelo de exposição de APIs.
A autenticação/autorização das APIs de integração utiliza o OAuth 2.0 Client Credentials Grant, sendo o método mais utilizado e também um fluxo de autorização projetado especificamente para integrações entre sistemas backend.
Principais vantagens:
Fluxo:
| Multimedia | ||||||
|---|---|---|---|---|---|---|
|
...
Converter: Este componente realiza a conversão de dados entre diferentes formatos, como XML para JSON e vice-versa, garantindo a compatibilidade de informações em fluxos complexos de integração. Ele aceita uma entrada em um formato específico e a transforma para outro conforme a necessidade do fluxo. O vídeo abaixo exemplifica o uso do componente Converter em um cenário prático:
Multimedia name render converter.mp4 width 40% height 40%
Ferramentas → Componentes → Básicos → Generator: Este componente é utilizado para gerar dados estruturados de forma automática, como objetos JSON ou elementos XML, criando estruturas padrão que podem ser utilizadas em fluxos de integração. A saída é um dado estruturado, como JSON ou XML, que pode ser usado em etapas subsequentes para processamento ou montagem de mensagens. O vídeo abaixo exemplifica o uso do componente Generator em um cenário prático:
Multimedia name render generator.mp4 width 40% height 40%
Ferramentas → Componentes → Básicos → Global Error: Este componente cria um sub-fluxo dedicado para gerenciar e tratar erros em um nível global dentro de cada diagrama de integração. Ele permite a captura e o manuseio centralizado de exceções em qualquer parte do processo, garantindo que falhas inesperadas sejam tratadas de forma robusta e consistente. O componente é versátil e pode lidar com diferentes tipos de dados que causaram a exceção, como XML, JSON, entre outros. O vídeo abaixo exemplifica o uso do componente Global Error em um cenário prático:
Multimedia name Render Global Error.mp4 width 40% height 40%
Ferramentas → Componentes → Básicos → Jolt: Este componente permite a transformação de dados exclusivamente em formato JSON, aplicando regras definidas pelo usuário para modificar, reordenar ou enriquecer a estrutura de entrada. A entrada e a saída são sempre em JSON, tornando-o ideal para fluxos que manipulam dados desse tipo. O vídeo abaixo exemplifica o uso do componente Jolt em um cenário prático:
Multimedia name Render Jolt.mp4 width 40% height 40%
Ferramentas → Componentes → Básicos → Splitter: Este componente divide uma entrada de dados, como um documento XML ou um array JSON, em partes menores para permitir o processamento individual. Por exemplo, ele pode separar um array JSON em elementos únicos ou fragmentar um XML em nós específicos. A saída são partes separadas do dado original, prontas para processamento sequencial. O vídeo abaixo exemplifica o uso do componente Splitter em um cenário prático:
Multimedia name render splitter.mp4 width 40% height 40%
Ferramentas → Componentes → Básicos → Throw Exception: Este componente é utilizado para lançar exceções personalizadas em fluxos de integração, permitindo o tratamento específico de erros. Ele pode receber qualquer tipo de dado de entrada, mas serve para interromper o fluxo com uma mensagem de erro clara, ajudando na depuração e controle de exceções. O vídeo abaixo exemplifica o uso do componente Throw Exception em um cenário prático:
Multimedia name render throw exception.mp4 width 40% height 40%
Ferramentas → Componentes → Avançados: Esta guia traz os componentes de uso avançado no TOTVS iPaaS. Sendo eles: FTP e SFTP.
Ferramentas → Variáveis → Projetos: Funcionam de maneira similar às variáveis globais, mas com o escopo limitado a um único projeto. Assim, as variáveis de projeto só são visíveis para diagramas dentro desse projeto específico.
Ferramentas → Variáveis → Globais: Visam facilitar o desenvolvimento de diagramas, reduzindo a duplicação de dados. Dados comuns podem ser cadastrados como palavras-chave e usados em múltiplos diagramas de um ou mais projetos. Caso haja necessidade de alteração, essa mudança refletirá em todos os diagramas que utilizam a variável.
...
Para ilustrar cenários práticos, foi desenvolvido um protótipo de produto chamado "Agro Digital", que simula um recurso externo a ser consumido. Essa ferramenta se comunicará com o TOTVS Agro API Hub, com o objetivo de integrá-las como exemplo de aplicação. A seguir, são apresentados três cenários iniciais:
Cenário 1 (clique para acessar)
Cenário 2 (clique para acessar)
Cenário 3 (clique para acessar)
Cenário 4 (clique para acessar)
| Aviso | ||
|---|---|---|
| ||
Será importante analisar todos os cenários, pois cada um contém informações complementares, novos exemplos a serem explorados e a resolução de algumas limitações. |
...
Para esclarecer um compilado de informações e considerações, no formato de semáforo acesse a página a seguir:
Considerações (clique para acessar)
...
Os dados apresentados abaixo foram consultados no Webinar de Apresentação da Solução TOTVS iPaaS
| Aviso | ||
|---|---|---|
| ||
Valores e planos sujeitos a atualização, consulte o responsável. |
...
🎯Estudo e Análise de Viabilidade TOTVS iPaaS e TOTVS Agro Bioenergia (APIs Padrões
Vídeos para exemplificar o fluxo completo da Integração entre Fila EAI x TOTVS Agro Middleware x TOTVS Agro API Hub
| Multimedia | ||||||
|---|---|---|---|---|---|---|
|
| Multimedia | ||||||
|---|---|---|---|---|---|---|
|
Release 12.1.2406 (Junho/2024)