Histórico da Página
...
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. |
...
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. |
Banco | Nome do banco de dados que será utiizado pela API para integração com EAI. |
Modo Suportado | Modos de operação disponíveis para integração do tipo EAI (ENVIO, RECEBIMENTO, AMBOS). Para integração do tipo WEBSERVICE será sempre AMBOS. |
Modo Habilitado | Modo de operação da entidade |
Padrão | Define se a entidade pertence a uma integração padrão disponibilizada pela Totvs. |
Incluir\Alterar Entidades
Campo | Descrição |
---|---|
Nome | Nome da integração, esse nome pode ser utilizado na API da entidade para identifica-laTransação/Serviço |
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 | Modos de operação disponíveis para integração do tipo EAI (ENVIO, RECEBIMENTO, AMBOS). Para integração do tipo WEBSERVICE será sempre AMBOS. |
Modo Habilitado | Modo de operação para integração do tipo EAI poderão ser ENVIO, RECEBIMENTO ou AMBOS. Modo de operação para integração do tipo WEBSERVICE poderão ser GET, PUT, POST, PATCH ou DELETE |
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" |
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). |
Salvar | Grava os dados da entidade e dos campos extras. |
06. TELA - INCLUSÃO DE CAMPO EXTRA
...