Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

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



    A página Criar operação é exibida, como mostrado abaixo.
  2. Na guia Detalhes da operação , informe o Nome da operação.
  3. O sistema exibe automaticamente o Domínio da habilidade padrão do tenant. 
  4. O URI (Uniform Resource Identifier - Identificador de Recurso Uniforme) é usado para se referir ao recurso de informações. Insira o URI.
  5. Selecione o método da operação. Ele usa uma estrutura de encadeamento de solicitação de API para que os bots enviem ou solicitem dados dos sites, sistemas e aplicativos web usando serviços web.
    Os seguintes métodos de operação estão disponíveis:
    • Get: para recuperar dados
    • Post: para criar dados
    • Put: para editar os dados
    • Delete: para excluir os dados
    • Patch:  para fazer atualizações parciais no recurso
  6. O sistema exibe automaticamente a operação suportada conforme invoca a API REST.
  7. Especifique o Tempo limite (em milissegundos), isto é, por quanto tempo esperar por uma resposta do serviço web ao invocar uma solicitação de saída.  O valor padrão é 10000 milissegundos, 10 segundos, e o valor máximo permitido é de 3 minutos, 180000 milissegundos.
  8. Clique em Avançar para especificar os detalhes da Configuração da solicitação .
    A página Configuração da solicitação é solicitação é exibida, como mostrado abaixo.
  9. Parâmetros de caminho: o parâmetro de caminho faz parte de um segmento de caminho que ocorre após seu nome. Os parâmetros de caminho oferecem uma oportunidade única de substituir dinamicamente os valores e passá-los no URL. Por exemplo, http://myserver.com/some-path/{parameter1}/path-continued/{parameter2}. É possível substituir a configuração definida no nível de instância ou continuar usando a mesma e talvez seja necessário adicionar valores e variáveis específicos da operação. 
    1. Insira o Campo externo e o Valor.
  10. Parâmetros de consulta: os parâmetros de consulta, às vezes, são chamados de parâmetros opcionais. Os parâmetros de consulta são separados dos parâmetros hierárquicos pelo ponto de interrogação. Os parâmetros de consulta são exibidos no URL após o ponto de interrogação (?) depois do nome do recurso. Por exemplo, https://myserver.com/resource-name?param1=value1&param2=value2. É possível substituir a configuração definida no nível de instância ou continuar usando a mesma e talvez seja necessário adicionar valores e variáveis específicos da operação. 
    1. Insira o Campo externo e o Valor.
  11. 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. É possível substituir a configuração definida no nível de instância ou continuar usando a mesma e talvez seja necessário adicionar valores e variáveis específicos da operação. 
    1. 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, 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 Content-Type para enviar um arquivo de anexo ao servidor do cliente.
        • Se você deseja substituir as configurações do cabeçalho global definidas no nível da instância, selecione Ignorar cabeçalhos globais. Assim, o sistema vai considerar as configurações definidas no nível de operação. Da mesma forma, você também pode substituir o parâmetro de caminho e o parâmetro de consulta.


  12. Carga de saída: a carga de solicitação precisa ser transmitida para conclusão da solicitação. 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. 

  13. Para enviar um anexo como carga de saída, use Mapeamento de anexo. Insira um campo externo e selecione um atributo com o tipo de dado Arquivo como Valor.



  14. Clique em Avançar para criar a Configuração de resposta.

...

  1. Clique em Adicionar Atributo 
  2. Para definir um atributo, adicione os detalhes abaixo.
    1. 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, isto é,  quando Expressão apontar para um caminho JSON, por exemplo, $.data.TicketIdentifier, $.data.items[*].Priority.
      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/Description
    2. 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.
    3. Atributo: nome do atributo
    4. Tipo de dado: representa o tipo de dado do valor
  3. Para usar a função Transformação, use Transformar. Para obter mais informações sobre como usar as funções de transformação, consulte Usando funções de transformaçãoTransformation functions
Info
  • Quando uma operação é adicionada ao fluxo de conversa de uma habilidade, os atributos locais criados nas operações podem ser usados para criar a habilidade. Um atributo local pode ser referido como  @{local.}
  • Ao Use atributos do tipo JSON para armazenar dados JSON recebidos da integração. Para se referir a uma lista/matriz de valores em um caminho JSON, use tipo de dado como LISTo atributo do tipo LISTA.

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.

...