| Table of Contents |
|---|
Visão geral
As integrações definem como
...
a Agente virtual Luma se conecta a sistemas externos.
...
Isso pode ser
...
usado para executar uma ação no sistema de terceiros ou recuperar dados de outros sistemas
...
. A Luma permite que os administradores criem e gerenciem integrações para o sistema de destino criando aplicativos, instâncias do aplicativo (credenciais para
...
se conectar aos sistemas de destino) e
...
operações. Os serviços web (APIs) são usados para criar essas integrações que podem ser usadas em habilidades para
...
ações de solicitações do usuário nos sistemas de destino necessários.
...
Criar aplicativo
Instâncias do aplicativo são os sistemas de destino nos quais as habilidades e os atributos são executados para processamento. A criação da instância do aplicativo define O administrador precisará definir as integrações no nível do tenant.
Existem 3 componentes em uma definição de integração:
Aplicativo
Instância
Operação
Aplicativo:
"Aplicativo" representa o aplicativo ou sistema de terceiros que pode ser integrado à Luma usando serviços web/APIs. As integrações são definidas no nível de tenant e definem os mecanismos de conectividade e autenticação para o usados pela Luma para se conectar ao sistema de destino. Você pode definir Aqui, definimos o nome do aplicativo (como ISM, SDM) e o tipo de integração (por exemplo, REST, ISM, SDM, Email, entre outros). O tipo de aplicativo selecionado na definição de operação deve informar o tipo de integração, que processará o modelo para a configuração da operação necessária. Para criar um aplicativo:
...
...
...
Criar instância
Depois de criar o aplicativo, é necessário criar a instância do aplicativo. Resumidamente, a instância do aplicativo define os mecanismos de conectividade e autenticação para o sistema de destino. A instância do aplicativo ajuda a definir os detalhes do SOAP).
Instância:
A instância do aplicativo representa o ambiente específico dos sistemas de destino em que a solicitação é acionada. A instância do aplicativo ajuda a definir o ambiente de destino para a execução das operações de serviço web. O desenvolvedor usa os detalhes da instância do aplicativo no processamento da habilidades/processamento do atributo para executar a operação no ambiente de destino necessário. No caso do tipo de integração REST do aplicativo conectado, você pode fornecer a configuração de solicitação (caminho, consulta e cabeçalhos) no nível de instância do aplicativo que são comuns a todas as operações de serviço web.
Para criar uma instância:
...
...
Insira o URL base ao qual a Luma deve se conectar.
...
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:
- Nenhuma autenticação: use essa opção se não precisar de autenticação para efetuar logon em sistemas de terceiros.
- 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:
- 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.
- Senha: especifique a senha. A Luma usa essa senha ao se autenticar para o sistema de terceiros.
- Nome do cabeçalho de autorização: por padrão, o Nome do cabeçalho de autorização é especificado como Autorização pela Luma.
- 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:- Nome do cabeçalho de autorização: por padrão, o Nome do cabeçalho de autorização é especificado como Autorização pela Luma.
- Token: informe o token de autenticação exclusivo necessário para aplicativos externos se comunicarem com a API da Luma.
...
- Insira o Campo externo e o Valor.
...
- Insira o Campo externo e o Valor.
...
- Insira o Campo externo e o Valor.
Os cabeçalhos de amostra a seguir são os mais encontrados.- Autorização: inclui credenciais contendo as informações de autenticação do cliente para o recurso que está sendo solicitado.
Accept-Charset: esse é um cabeçalho que é definido com a solicitação e informa o servidor sobre quais conjuntos de caracteres são aceitáveis pelo cliente.
Content-Type: indica o tipo de mídia (texto/HTML ou texto/JSON, XML/personalizado) da resposta enviada ao cliente pelo servidor. Isso ajudará o cliente a processar o corpo da resposta corretamente.
Click Create to create the app instance.
| Info |
|---|
A primeira instância que você adicionar será considerada como a instância padrão. |
Criar operações
As operações ajudam a criar integrações com sistemas externos. Como administrador, você pode criar e editar as operações no aplicativo selecionado para as habilidades no nível de domínio, que devem ser executadas no ambiente de destino como parte do processamento da habilidade.
Após a criação do aplicativo e da instância do aplicativo, crie as operações necessárias sob ela. Uma operação define a tarefa que você precisa executar como parte do processamento. Para criar uma operação:
...
...
- Get: para recuperar dados
- Post: para criar dados
- Put: para editar os dados
- Delete: para excluir os dados
...
- Insira o Campo externo e o Valor.
...
- Insira o Campo externo e o Valor.
...
Accept-Charset: esse é um cabeçalho que é definido com a solicitação e informa o servidor sobre quais conjuntos de caracteres são aceitáveis pelo cliente.
Tipo de conteúdo: indica o tipo de mídia (texto/HTML, texto/JSON, XML/personalizado ou multipart/form-data) da resposta enviada ao cliente pelo servidor. Isso ajudará o cliente a processar o corpo da resposta corretamente.
| Info |
|---|
Use multipart/form-data como Tipo de conteúdo para enviar um arquivo de anexo ao servidor do cliente. |
...
...
| Info |
|---|
Você pode consultar os atributos Global e Personalizado do usuário, em Configuração da solicitação, para enviar informações para autorização de acesso ou como carga de saída. Sintaxe válida:
|
Configuração de resposta
Essa seção é usada para processar os dados ou a resposta recebidos do serviço web externo.
Mapeamento de entrada
É possível criar os atributos Local e Personalizado do usuário para armazenar os dados que são usados em uma operação. O atributo Local armazena os dados temporários no fluxo de trabalho de ação para transmissão a várias operações. Ele é usado como um espaço reservado nos modelos e regras de mensagem do usuário dentro do fluxo de trabalho da ação. O atributo personalizado do usuário armazena os dados extraídos da entrada do usuário, da operação de integração de terceiros , das respostas, etc.
Veja a seguir os detalhes necessários no mapeamento de entrada:
- Escopo: representa o escopo do atributo a ser usado para manter os valores de entrada
- 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 até a execução da habilidade.
- Use Local para criar e definir o valor para os atributos locais. Esses atributos são válidos e estão disponíveis somente durante a execução da habilidade.
- 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.
- Atributo: nome do atributo
- Tipo de dado: representa o tipo de dado do valor
- 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.
- Use Tipo de expressão → Valor quando um valor tiver que ser atribuído ao atributo, isto é, quando Expressão apontar para um valor direto, por exemplo, @{response.body}, @{response.code}.
- Use Tipo de expressão → JSONPath quando um valor da resposta JSON recebida tiver que ser atribuído ao atributo, isto é, quando Expressão apontar para um caminho JSON, por exemplo, $.data.TicketIdentifier, $.data.items[*].Priority.
- 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
| Info |
|---|
|
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.
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:
- Fazer a correspondência de qualquer condição abaixo: uma das condições especificadas deve corresponder para análise da mensagem de erro.
- 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.
- 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, (,) (,)
Especifique @response.StatusCode no campo Chave seguido por um operador. Veja a seguir uma lista de operadores suportados.
- Igual a
- É diferente de
- É superior a
- É superior ou igual a
- É inferior a
- É inferior ou igual a
- Começa com
- Não começa com
- Termina com
- Não termina com
- Contém
- Não contém
- Está vazio
- Não está vazio
- corresponde ao padrão
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.
Tratamento bem-sucedido
...
Aqui, definimos o serviço web, o tipo de autorização e outros parâmetros globais necessários para se conectar ao sistema de destino. A instância do aplicativo é selecionada na habilidade para identificar o ambiente do aplicativo no qual a operação do serviço web será executada.
Operações:
As operações são as ações que devem ser executadas nos sistemas de destino. Elas representam as funções que são expostas pela API do sistema de destino. Como administrador, você pode criar e editar as operações no aplicativo selecionado. Aqui, definimos a função a ser usada, os parâmetros de solicitação a serem passados para o serviço web e os atributos que conterão a resposta recebida pela Luma. Os desenvolvedores de habilidades adicionam as operações no fluxo de conversa de habilidades para executar uma operação específica no ambiente de destino necessário. Nas operações, você também pode processar as condições de sucesso, sem dados e respostas de erro do serviço web.
A Agente virtual Luma oferece suporte a dois tipos de integração a sistemas de terceiros:
| Child pages (Children Display) |
|---|