ÍNDICE

  1. Visão Geral
  2. Exemplo de utilização
  3. Tela Integração para Aplicações Externas
  4. Tela Aplicações
  5. Tela Entidades para Integração


01. VISÃO GERAL

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.


02. EXEMPLO DE UTILIZAÇÃO

03. TELA INTEGRAÇÃO PARA APLICAÇÕES EXTERNAS

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çãoDescrição
AdicionarInclusão de integrações.
EditarEdição de integrações.
ExcluirExclusão de integração e seus registros relacionados (Aplicações, Entidades e  Campos Extras).
AplicaçõesAbre a interface que lista as Aplicações cadastradas para a integração.
PesquisaPesquisa por nome e descrição de integrações.

Lista de Integrações

CampoDescrição
Nome IntegraçãoNome da integração.
DescriçãoDescriçã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çõesCombo que permite ao usuário escolher cadastrar uma nova aplicação ou utilizar uma disponibilizada pela Totvs.
Nome IntegraçãoPermite 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çãoTipo da integração que sera utilizada. Campo habilitado apenas para o cadastro de uma nova integração.


04. TELA APLICAÇÕES


Ações Disponíveis

AçãoDescrição
Nova AplicaçãoInclusão de aplicação.
PesquisaPesquisa por nome de aplicações.
Executar IntegraçãoPermite executar todas as entidades de integração para uma aplicação.
EntidadesAbre a interface de lista de entidades.
Outras açõesExibe ações: Editar, Copiar e Excluir aplicação.
Exibir detalhesExibe os detalhes de uma aplicação e os campos extras adicionados.
EditarPermite edição de uma aplicação.
CopiarPermite cópia de uma aplicação.
ExcluirPermite exclusão de uma aplicação.


Lista de Aplicações

CampoDescrição
NomeNome da aplicação
ExecutadoData 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. NÃO deve conter o prefixo como http\\ ou https\\. 
PortaPorta do servidor da aplicação externa - Informação utilizada conforme necessidade da aplicação externa.
Tempo Limite para RequisiçãoTempo limite para completar uma requisição de integração - Informação utilizada conforme necessidade da aplicação externa.
Registros por RequisiçãoQuantidade de registros por requisição - Informação utilizada conforme necessidade da aplicação externa.
Usuário IntegraçãoUsuário para autenticar em webservices de aplicações externas - quando utilizado autenticação básica 
Senha Usuário IntegraçãoSenha de usuário para autenticar em webservices de aplicações externas - quando utilizado autenticação básica 
Token (Chave de Acesso Fixa)Token para autenticar em webservices de aplicações externas - quando utilizado autenticação básica 
Campos extrasSerão apresentados campos extras e seus dados se forem adicionados no cadastro da aplicação.



05. TABELAS UTILIZADAS

<!-- 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>