Ferramenta para configuração e execução de integrações de dados para aplicações externas, utiliza APIs desenvolvidas com tecnologia Progress que são executadas em um agendador de tarefas (RPW).
As integrações disponibilizadas pela TOTVS estão pré-cadastradas e suas APIs de integração de dados estão prontas para uso, um exemplo é a integração padrão com a MasterSales.
É possível cadastrar manualmente integrações com outras aplicações e definir seus parâmetros de execução, porém será necessário desenvolver APIs customizadas seguindo as especificações desse documento.
Essa interface pode ser acessada no menu do Datasul com o nome de "Integração para Aplicações Externas", ela permite listar, editar, remover e cadastrar integrações disponibilizadas pela Totvs e integrações customizadas.
Ações Disponíveis
| Ação | Descrição |
|---|---|
| Adicionar | Inclusão de integrações. |
| Editar | Edição de integrações. |
| Excluir | Exclusão de integração e seus registros relacionados (Aplicações, Entidades e Campos Extras). |
| Aplicações | Abre a interface que lista as Aplicações cadastradas para a integração. |
| Pesquisa | Pesquisa por nome e descrição de integrações. |
| Campo | Descrição |
|---|---|
| Nome Integração | Nome da integração. |
| Descrição | Descrição da integração. |
| Tipo Integração | Tipo da integração, possui dois tipos disponíveis: EAI - Integração que utiliza a ferramente EAI para comunicação de dados (Exige o uso de adapters para o EAI). WEBSERVICE - Integrações que utiliza webservices (Exige API de comunicação exemplificadas neste documento). |
| Campo | Descrição |
|---|---|
| Integrações | Combo que permite ao usuário escolher cadastrar uma nova aplicação ou utilizar uma disponibilizada pela Totvs. |
| Nome Integração | Permite definir o nome de uma integração. Campo habilitado apenas para o cadastro\edição de uma nova integração. |
| Descrição | Permite definir a descrição de uma integração. Campo habilitado apenas para o cadastro\edição de uma nova integração. |
| Tipo Integração | Tipo da integração que sera utilizada. Campo habilitado apenas para o cadastro de uma nova integração. |
Essa interface é acessada por meio do botão "Aplicações" da interface "Integração para Aplicações Externas", seu objetivo é permitir o cadastro e visualização de aplicações com o qual uma integração se comunica.
Ações Disponíveis
| Ação | Descrição |
|---|---|
| Nova Aplicação | Inclusão de aplicação. |
| Pesquisa | Pesquisa por nome de aplicações. |
| Executar Integração | Permite executar todas as entidades de integração para uma aplicação. |
| Entidades | Abre a interface de lista de entidades. |
| Outras ações | Exibe ações: Editar, Copiar e Excluir aplicação. |
| Exibir detalhes | Exibe os detalhes de uma aplicação e os campos extras adicionados. |
| Editar | Permite edição de uma aplicação. |
| Copiar | Permite cópia de uma aplicação. |
| Excluir | Permite exclusão de uma aplicação. |
Lista de Aplicações
| Campo | Descrição |
|---|---|
| Nome | Nome da aplicação. |
| Executado | Data e hora da ultima execução de integração da aplicação. |
| Ativo | Indica se a aplicação esta habilitada para execução. |
| Servidor de Agendamento (RPW) | Nome do servidor de agendamento (RPW) que executará a integração dos dados. Para execução é necessário que o servidor esteja ativo. |
| Endereço (Host) | Endereço (domínio ou ip) do servidor da aplicação externa que sera realizado a integração de dados. |
| Porta | Porta do servidor da aplicação externa - Informação utilizada conforme necessidade da aplicação externa. |
| Tempo Limite para Requisição | Tempo limite para completar uma requisição de integração - Informação utilizada conforme necessidade da aplicação externa. |
| Registros por Requisição | Quantidade de registros por requisição - Informação utilizada conforme necessidade da aplicação externa. |
| Usuário Integração | Usuário para autenticar em webservices de aplicações externas - quando utilizado autenticação básica . |
| Senha Usuário Integração | Senha de usuário para autenticar em webservices de aplicações externas - quando utilizado autenticação básica (A a senha fica escondida para visualizar o usuário deve clicar no ícone com formato de olho ). |
| Token (Chave de Acesso Fixa) | Token para autenticar em webservices de aplicações externas - quando utilizado autenticação básica. |
| Campos extras | Serão apresentados campos extras e seus dados se forem adicionados no cadastro da aplicação. |
Adicionar Aplicações (Web Service)
| Campo | Descrição |
|---|---|
| Nome (Descrição) | Informe o nome da aplicação |
| Servidor de Agendamento | Selecione o servidor de agendamento (RPW) que executará a integração dos dados. |
| Ativo | Indique se a aplicação esta habilitada ou desabilitada para execução. |
| Endereço | Endereço (domínio ou ip) do servidor da aplicação externa que sera realizado a integração de dados. NÃO deve conter o prefixo como http\\ ou https\\. |
| Porta | Porta do servidor da aplicação externa - Informação utilizada conforme necessidade da aplicação externa. |
| Tempo Limite para Requisição (Segundos) | Tempo limite para completar uma requisição de integração - Informação utilizada conforme necessidade da aplicação externa. |
| Registros por Requisição | Quantidade de registros por requisição - Informação utilizada conforme necessidade da aplicação externa. |
| Usuário Integração | Usuário para autenticar em webservices de aplicações externas - quando utilizado autenticação básica. |
| Senha Usuário Integração | Senha de usuário para autenticar em webservices de aplicações externas - quando utilizado autenticação básica (A a senha fica escondida para visualizar o usuário deve clicar no ícone com formato de olho ). |
| Token (Chave de Acesso Fixa) | Token para autenticar em webservices de aplicações externas - quando utilizado autenticação básica. |
| Inclusão de Campo Extra | Botão que abre a interface para inclusão de campos extras, esses campos são utilizados para armazenar informações customizadas e podem ser recuperadas na api de execução de integração (veja exemplo de API em anexo). |
Essa interface é acessada por meio do botão "Entidades" disponível em uma aplicação, cadastrada na interface "Aplicações", seu objetivo é permitir o cadastro e visualização de entidades (webservices), que serão utilizados para enviar ou receber dados de uma integração. Cada entidade pode executar uma API desenvolvida com linguagem Progress OpenEdge que pode ser parte do produto padrão Datasul ou customizada seguindo os exemplos em anexo nesta documentação. As APIs que são responsáveis por realizar a busca, inclusão, alteração ou exclusão de dados.
Ações Disponíveis
| Ação | Descrição |
|---|---|
| Executar Entidade | Realiza agendamento no servidor de execução (RPW) para execução da API da entidade, que executará a integração de dados. |
| Incluir Entidade | Abre o formulário para cadastro de uma entidade (Integrações disponibilizadas pela Totvs podem conter campos bloqueados) |
| Editar | Abre o formulário para edição de uma entidade (Integrações disponibilizadas pela Totvs podem conter campos bloqueados) |
| Excluir | Abre confirmação de exclusão de uma entidade (Integrações disponibilizadas pela Totvs podem conter campos bloqueados) |
| Copiar | Abre confirmação de exclusão de uma entidade (Integrações disponibilizadas pela Totvs podem conter campos bloqueados) |
| Executar Integração | Realiza agendamento no servidor de execução (RPW) para execução das APIs de todas as entidades da aplicação selecionada. |
Lista de Entidades
| Campo | Descrição |
|---|---|
| Ativo | Define se a integração esta ativada, integrações desativadas não serão executadas ao clicar no botão "Executar Entidade" ou "Executar Integração" |
| Nome | Nome da integração, esse nome pode ser utilizado na API da entidade para identifica-la |
| Transação/Serviço | Nome da transação quanto utilizado o tipo de integração EAI. Para as integrações do tipo WEBSERVICE sera a URL do serviço (sem o nome do host da aplicação ). |
| Versão Transação/Serviço | Versão da transação ou do webservice. |
| API Execução RPW | Nome do programa progress que define a API que fará a integração dos dados. Esse programa progress deve estar no propath do Datasul. Exemplo: apicusomizada/integracliente.p |
| Banco | Nome do banco de dados que será utiizado pela API para integração com EAI. Opcional para integrações com WEBSERVICES. |
| Modo Suportado | Modo de integração suportado pelo EAI (ENVIO, RECEBIMENTO, AMBOS). Para integração do tipo WEBSERVICE será sempre AMBOS. |
| Modo Habilitado | |
| Padrão |
| Campo | Descrição |
|---|---|
| Nome | |
| Transação/Serviço | |
| Versão Transação/Serviço | |
| API Execução RPW | |
| Banco | |
| Modo Suportado | |
| Modo Habilitado | |
| Ativo | |
| Inclusão de Campo Extra | |
| Salvar | Grava os dados da entidade e dos campos extras. |
Ações Disponíveis
| Campo | Descrição |
|---|---|
| Tipo do Campo | |
| Identificador | |
| Título do Campo | |
| Sequência no Formulário | |
| Salvar | Adiciona o campo extra no formulário da entidade ou da aplicação |
Incluir
<!-- esconder o menu -->
<style>
div.theme-default .ia-splitter #main {
margin-left: 0px;
}
.ia-fixed-sidebar, .ia-splitter-left {
display: none;
}
#main {
padding-left: 10px;
padding-right: 10px;
overflow-x: hidden;
}
.aui-header-primary .aui-nav, .aui-page-panel {
margin-left: 0px !important;
}
.aui-header-primary .aui-nav {
margin-left: 0px !important;
}
</style>
|