Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Version History

Version 1 Next »


SOAP (Simple Object Access Protocol) é um protocolo de mensagem que permite que os aplicativos em execução em diferentes sistemas operacionais e com diferentes tecnologias se comuniquem entre si. Trata-se de um protocolo com base em XML para troca de informações entre aplicativos usando serviços web. As mensagens SOAP são gravadas inteiramente em XML e, portanto, são independentes de plataforma e idioma.

A Agente virtual Luma oferece suporte ao protocolo SOAP para fazer interface com aplicativos de terceiros.

Criar aplicativo

Para criar um aplicativo:

  1. No menu Inquilino , clique em Integrações. A página Aplicativos conectados é exibida, como mostrado abaixo. 
    Aqui, podemos configurar uma integração entre a Luma e um sistema de terceiros. Depois que o aplicativo conectado for criado, a próxima etapa será criar a instância do aplicativo e as respectivas operações de serviço web.




  1. Clique em Criar aplicativo para criar um novo aplicativo.
    A página Criar aplicativo é exibida, como mostrado abaixo.

  Detalhes: 

  1. Digite o Nome do aplicativo.
  2. Selecione o Tipo de integração como SOAP

Configuração do aplicativo: veja a seguir a lista de detalhes a serem configurados.

  1. Digite oNome do aplicativo
  2. Selecione o URL WSDL ou o nome de arquivo WSDL
  3. Insira o nome do WSDL do URL WSDL OU o nome do arquivo WSDL
  4. Tipo de autorização : 
    1. Nenhuma autenticação: use essa opção se não precisar de autenticação para efetuar logon em sistemas de terceiros.
    2. Autenticação básica: use essa opção para autenticar aplicativos externos para interação com o inquilino da Luma. A autenticação básica consiste nos seguintes campos:
      1. Nome de usuário: especifique o nome de usuário. A Luma o usa como um nome de usuário de autenticação para efetuar logon em sistemas de terceiros.
      2. Senha: especifique a senha. A Luma usa essa senha ao se autenticar para o sistema de terceiros.
      3. Nome do cabeçalho de autorização: por padrão, o Nome do cabeçalho de autorização é especificado como Autorização pela Luma.
    3. Token do portador: esse é o token de autenticação exclusivo necessário para aplicativos externos se comunicarem com a API da Luma.

  1. Clique em Criar para concluir a criação do aplicativo. 

O aplicativo criado é disponibilizado na lista Aplicativos conectados . A próxima etapa é criar uma instância.  




Se o aplicativo de terceiros exigir URLs ou arquivos WSDL diferentes para se conectar a ambientes ou módulos diferentes, você poderá adicionar vários URLs ou arquivos WSDL com detalhes de autenticação.


Criar instância

Depois de criar o aplicativo, é necessário criar a instância do aplicativo. No caso do tipo de integração SOAP, você pode fornecer a configuração de solicitação (cabeçalhos globais) no nível de instância do aplicativo que é comum para todas as operações de serviço web criadas para o aplicativo.  

Para criar uma instância:

  1. Na página Aplicativos conectados , clique em Criar instância , como mostrado abaixo.



  1. A página Criar instância é exibida.
  2. Digite o Nome e a Descrição da instância. A próxima etapa é definir as credenciais e os detalhes de conexão dessa instância.alterar captura de tela
  3. Adicionar detalhes de configuração da instância:

    1. Insira o URL base ao qual a Luma deve se conectar.

    2. O Tipo de autorização é usado pela Luma para efetuar logon e executar as operações especificadas como parte da operação do serviço web. A Luma oferece suporte aos seguintes tipos de autorização:

      1. Nenhuma autenticação: use essa opção se não precisar de autenticação para efetuar logon em sistemas de terceiros.
      2. Autenticação básica: use essa opção para autenticar aplicativos externos para interação com o inquilino da Luma. A autenticação básica consiste nos seguintes campos:
        1. Nome de usuário: especifique o nome de usuário. A Luma o usa como um nome de usuário de autenticação para efetuar logon em sistemas de terceiros.
        2. Senha: especifique a senha. A Luma usa essa senha ao se autenticar para o sistema de terceiros.
        3. Nome do cabeçalho de autorização: por padrão, o Nome do cabeçalho de autorização é especificado como Autorização pela Luma.
      3. Token do portador: esse é o token de autenticação exclusivo necessário para aplicativos externos se comunicarem com a API da Luma. O token do portador consiste nos seguintes campos:
        1. Nome do cabeçalho de autorização: por padrão, o Nome do cabeçalho de autorização é especificado como Autorização pela Luma.
        2. Token: informe o token de autenticação exclusivo necessário para aplicativos externos se comunicarem com a API da Luma.

  4. Clique em Criar para criar a instância do aplicativo.

    A primeira instância que você adicionar será considerada como a instância padrão.

Criar operações

Depois que o aplicativo e a instância são criados, você pode criar as operações necessárias para serem executadas com o sistema de integração. Uma operação define a tarefa que você precisa executar como parte da habilidade. 

Para criar uma operação:

  1. Na página Aplicativos conectados , clique em Criar operação , como mostrado abaixo.

  2. A página Criar operação é exibida.
  3. Na guia Detalhes da operação , adicione detalhes da operação:
    1. Digite o nome da operação.
    2. Selecione um dos WSDL adicionados para o aplicativo. 
    3. Selecione o método de vinculação. Os métodos de vinculação são preenchidos automaticamente com base no WSDL selecionado
  4. Selecione a operação. O sistema exibe automaticamente as operações suportadas para o WSDL selecionado e o método de vinculação
  5. Especifique o tempo limite (em milissegundos) da operação. Essa é a quantidade de tempo de espera por uma resposta do serviço web ao invocar uma solicitação de saída.  O valor padrão é 10000 milissegundos, 10 segundos; o valor mínimo é 1000 milissegundos; e o valor máximo permitido é 3 minutos, 180000 milissegundos.
  6. Clique em Avançar para especificar os detalhes da Configuração da solicitação . A página Configuração da solicitação é exibida, como mostrado abaixo.
    1. Cabeçalhos: cabeçalhos são, em sua maioria, classificados como cabeçalhos de solicitação. Será necessário definir os cabeçalhos de solicitação quando você estiver enviando a solicitação. Os cabeçalhos especificados no nível da instância são preenchidos automaticamente. Você pode substituir a configuração definida no nível da instância ou continuar usando a mesma
    2. Ignorar cabeçalho global: se precisar substituir a configuração definida no nível da instância, selecione Ignorar cabeçalhos globais e você poderá adicionar a variável e os valores específicos da operação. 
      1. Insira o Campo externo e o Valor.

    3. Carga de saída: a carga de solicitação que deve ser passada ao aplicativo externo. FormData é a codificação padrão que um formulário da web usa para transferir dados. A área da caixa de texto aceita pares de chave-valor simples e JSON complexo/aninhado. 
  7. Clique em Avançar para criar a Configuração de resposta. A seção Configuração de resposta é usada para processar os dados ou a resposta recebidos do serviço web externo.
    • Mapeamento de entrada: nessa seção, você pode transformar os dados recebidos como uma resposta e atribuí-los aos atributos de usuário Local, Global e Personalizado. Esses dados, por sua vez, podem ser usados na criação de habilidades, como operações de terceiros, avaliação de regras,  definição de respostas de bot, atribuição de valores aos atributos personalizados do usuário.



 Existem duas maneiras de configurar os atributos. 

Definir atributo:  usado para armazenar informações em um atributo. Selecione Definir Atributo .

Transformar:  as funções de transformação são usadas quando as informações recebidas da integração devem ser convertidas antes de serem usadas em uma operação ou na habilidade.

Por exemplo, extrair o número do ticket do identificador de ticket recebido de um sistema ITSM e fornecê-lo a um cliente.  A Luma fornece uma variedade de funções de transformação para permitir que os desenvolvedores de habilidades manipulem os dados conforme necessário, como dividir, cortar, subsequência de caracteres, substituir, data e hora personalizadas, etc.



Para definir o mapeamento de entrada, siga as etapas abaixo: 

    1. Adicionar tipo de expressão e expressão: representam o tipo (valor ou JSON) e o caminho do local do valor a ser atribuído ao atributo
      1. Use Tipo de expressão → Valor quando um valor tiver que ser atribuído ao atributo; por ex.: @{response.body}, @{response.code}.
      2. Use Tipo de expressão → JSONPath quando um valor da resposta JSON recebida tiver que ser atribuído ao atributo; por exemplo, quando  Expressão apontar para um caminho JSON
      3. Use Tipo de expressão → JSONPath indireto quando um valor de um atributo do tipo JSON tiver que ser atribuído ao atributo, por exemplo, quando Expressão apontar para um atributo que mantém um caminho JSON, como @{local.items}→$.[*].TicketIdentifier
      4. Use Tipo de expressão → XPath quando um valor tiver que ser atribuído ao atributo, isto é, quando Expressão apontar para um caminho, por exemplo, //AddResponse/AddResult

    2. Definir saída para atributo: usado para armazenar os dados.

      1. Escopo: representa o escopo do atributo a ser usado para manter os valores de entrada
        1. Use Global para atribuir valor a um atributo global a ser usado na habilidade. Embora os atributos sejam disponibilizados para uso de outras habilidades, o valor fica retido durante a execução da habilidade.
        2. Use Local para criar e definir o valor para um atributo local. Esses atributos são válidos e estão disponíveis somente durante a execução da habilidade. O valor da variável local é retido entre os prompts e é usado para passar dados entre várias integrações, mensagens de usuário ou regras. Se usado após uma resposta do bot, o valor no atributo Local será perdido.
        3. Use  Personalizado do usuário  para atribuir valor a um atributo personalizado do usuário. Esses atributos retêm os valores atribuídos, a não ser que sejam substituídos.
      2. Atributo:  nome do atributo
      3. Tipo de dado: representa o tipo de dado do valor. Inteiro,  Longo, Booleano, etc.

  2. Para usar a função Transformação, use  Transformar em Definir atributo. Para obter mais informações sobre como usar as funções de transformação, consulte  Funções de transformação


  1. Tratamento de erros: essa seção é usada para definir o comportamento e a resposta do bot para o usuário quando a execução da operação resulta em um erro. Você pode criar várias regras de tratamento de erros a partir das operações de serviço web. 
    1. Selecione uma das opções a seguir de modo a definir uma regra para enviar a mensagem de erro. A mensagem de erro será enviada apenas se as condições especificadas forem validadas:
      1. Fazer a correspondência de qualquer condição abaixo: uma das condições especificadas deve corresponder para análise da mensagem de erro.
      2. Fazer a correspondência de todas as condições abaixo: todas as condições especificadas devem ser validadas para análise da mensagem de erro.
      3. Definir critérios personalizados: é possível definir critérios personalizados com base em condições determinadas para análise da mensagem de erro, se validada.
        Por exemplo, 1 e 2 ou 3. A primeira e a segunda condição devem corresponder ou apenas a terceira condição deve corresponder.         Você pode inserir apenas números, e, ou, (,) (,)
    2. Especifique @response.StatusCode no campo Chave seguido por um operador.  Veja a seguir uma lista de operadores suportados.
      1. Igual a
      2. É diferente de
      3. É superior a
      4. É superior ou igual a
      5. É inferior a
      6. É inferior ou igual a
      7. Começa com
      8. Não começa com
      9. Termina com
      10. Não termina com
      11. Contém
      12. Não contém
      13. Está vazio
      14. Não está vazio
      15. corresponde ao padrão

  2. Sem tratamento dos dados: essa seção é usada para definir o comportamento e a resposta do bot ao usuário quando a execução da operação não retorna dados. Você pode criar várias regras para tratamento de cenários sem dados a partir das operações do serviço web. Siga os valores de retorno da API dos sistemas externos dos quais você recebe os dados e, proporcionalmente, escreva/avalie os valores na seção Regras/condições.

  3. Tratamento bem-sucedido: essa seção é usada para definir o comportamento e a resposta do bot ao usuário quando a execução da operação é bem-sucedida. Crie várias regras de tratamento bem-sucedido a partir das operações de serviço web. 

Editar aplicativo

Para editar um aplicativo:

  1. No menu Inquilino , clique em Integrações.
  2. Todos os aplicativos conectados são listados como mostrado abaixo, onde a opção de edição está disponível.
  3. Clique no botão Editar . A página Aplicativo conectado é exibida. 
  4. Aqui, podemos editar os detalhes como tipo de integração, instância padrão, operação de logon e operação de logoff.
    As operações de logon  e logoff são úteis quando uma funcionalidade/operação exige uma condição de pré-logon e pós-logoff. 
    Por exemplo, as operações de logon e logoff podem ser usadas para controle de sessão. Ao executar uma operação por meio de uma habilidade, a operação de logon geraria um token e reservaria a sessão. Após a conclusão da tarefa, a operação de logoff vai liberar a sessão. Isso garante a utilização ideal das sessões alocadas ao usuário da API.

  5. Depois de selecionar as operações necessárias, clique em Atualizar para salvar as alterações.


  • No labels