Tipos de integrações
No Zeev é possível realizar integrações de tipos diferentes
Tipos de integrações
Atualmente, os seguintes padrões de API´s são aceitos:
Fixas
São listas de dados fixos, cadastrados dentro da própria integração do sistema. Utilize esse tipo de integração se você não possui um sistema externo com os dados que você precisa.
Complemento em integrações fixas
O uso de complemento em integrações fixas possibilita o preenchimento automático de outros campos, conforme o valor principal selecionado.
Imagine uma integração que possui o cadastro de filiais, e ao selecionar uma filial específica no campo do formulário, seu endereço deve ser preenchido automaticamente em outros campos.
A configuração se resume em:
Identificador do campo => Valor que deve ser preenchido
Para adicionar uma lista de itens, no momento em que está sendo criada uma nova integração, insira uma lista de itens em um único campo “Nome” e clique em "Salvar". Com isso, já ocorrerá o comportamento de salvar cada item em uma linha.
ATENÇÃO: Esse comportamento só é possível em uma criação de Nova Integração. Em Edições de Integrações não é possível realizar, assim como o comportamento não é suportado no campo “Complemento”.
Dinâmicas
RESTful / JSON
JSON (JavaScript Object Notation) é um padrão para formato de dados, derivado da sintaxe de objetos em Javascript. E apesar de estar diretamente relacionado à JavaScript, ele é um padrão com vários parsers em diferentes linguagens, podendo servir para diferentes propósitos. Se o seu sistema externo permite conexões JSON, use esse padrão.
RESTful / XML
XML é a sigla para Extensible Markup Language, que significa em português "Linguagem Extensível de Marcação Genérica". É uma recomendação para gerar linguagens de marcação para necessidades especiais. XML é capaz de descrever diversos tipos de dados, e seu objetivo principal é a facilidade de compartilhamento de informações através da Internet.
A decisão sobre qual padrão de integração será usada é, geralmente, definida pela forma de integração suportada pelo seu sistema externo. A ferramenta suporta os principais padrões do mercado; é possível, entretanto, que seu sistema externo suporte somente um ou outro padrão.
Governança de integrações
As integrações são itens muito sensíveis do sistema e erros em sua manutenção podem prejudicar diversas solicitações de aplicativos de processo em execução.
As integrações, também, são compartilhadas por todo o sistema. Isso significa que se uma pessoa possui acesso ao módulo de integrações, terá acesso a todas as integrações do sistema. Além disso, uma vez que uma integração é criada, essa poderá ser usada em todos os aplicativos de sua empresa.
A maior parte das configurações de integrações, também, requerem um menor ou maior conhecimento técnico de linguagens de programação e de técnicas de integração de sistemas. É importante que a pessoa responsável por esse módulo conheça itens técnicos como XML, JSON, XPATH, JSONPATH .
Mapeamento
Quando você executar uma conexão a uma API utilizando um dos padrões suportados, você terá como retorno um documento JSON, XML ou uma tabela de banco de dados (dependendo do tipo de integração).
Para que o sistema consiga compreender o documento retornado e possa efetivamente usar esses dados, você terá que configurar um processo de transformação do documento capturado para um documento JSON padrão do sistema. Esse procedimento é realizado através da configuração do "mapeamento". Mesmo que sua API retorne um documento XML, internamente, no sistema, ele será transformado em JSON. Isso não tem impacto no seu uso.
É importante enfatizar que esse procedimento não é obrigatório; se você somente precisa se conectar a API para enviar dados a um sistema externo, pode ser que o retorno de informações seja irrelevante para você. Porém, se você pretende usar ou mostrar os dados retornados pela API, precisará configurar o mapeamento.
Como realizar o mapeamento
Observe na tabela abaixo que, mesmo com os diferentes tipos de integração, os tipos de documentos retornados resumem-se a XML e JSON. Por isso, a linguagem de transformação utilizada será XPath para documentos XML e JSONPath para documentos JSON.
Tipo de integração
Tipo de padrão usado
Linguagem para mapeamento
Fixa
XML
N/A
RESTful / JSON
JSON
JSONPath
RESTful / XML
XML
XPath 1.0
Tanto o XPath quanto o JSONPath são linguagens de navegação em documentos XML e JSON, respectivamente. O mapeamento é realizado no formulário de cadastro da in
Mapeamento de campos acessórios
O mapeamento de campos acessórios permite definir uma série de expressões XPATH ou JSONPath adicionais, acessórias e opcionais para a integração.
O mapeamento de campos acessórios é usado principalmente para dois fins.
Alterar o valor de campos do formulário em tela
Em campos do formulário com múltiplos valores, caso os identificadores da integração transformada sejam iguais aos identificadores de outros campos do formulário, esses campos terão seus valores automaticamente preenchidos uma vez selecionado o valor principal do campo origem.
Exemplo: digamos que você tenha uma integração de pessoas cujo atributo "id" é o identificador único da pessoa, e o atributo "txt" é o nome da pessoa. O vetor "fields" poderia ter uma série de atributos adicionais com outras informações da pessoa, como "email", "cpf" e "sobrenome". Se você vincular essa integração a um campo caixa de seleção, a pessoa poderá ver e escolher um dos nomes de pessoas disponíveis. Quando a pessoa escolher uma pessoa, caso existam campos nesse formulário com identificadores "email", "cpf" e "sobrenome", esses campos serão automaticamente preenchidos com as informações da integração transformada.
Alterar o valor de campos do formulário na execução do processo
Na execução de tarefas de serviço, configurada no desenho do processo, caso existam campos no formulário com identificadores iguais a atributos do vetor "fields", esses campos terão seus valores automaticamente atualizados conforme o valor do atributo na integração transformada.
Atualizado