Invocar uma Tarefa de API em um formulário

Crie um formulário para invocar o Tarefa de API e mapeie as variáveis do Tarefa de API para os campos obrigatórios no formulário.

Pré-requisitos

  • Você deve ter uma licença do Bot Creator.
  • Você precisa primeiro criar uma Tarefa de API para invocá-la no formulário.
Este tópico descreve como invocar uma Tarefa de API em um Formulário. Neste exemplo, você criará um formulário de CEP que invoca uma Tarefa de API para recuperar os detalhes do local e do estado com base na entrada de CEP fornecida. O formulário criado pode ser executado por meio de um processo. Você pode criar um formulário com os campos específicos do seu caso de uso.

Procedimento

  1. Navegue até um formulário existente ou crie um formulário no qual deseja invocar um Tarefa de API. Para mais detalhes, consulte Criar um formulário.
    Nomeie este formulário como Formulário de CEP.
  2. Crie um formulário: Use os elementos do formulário para criar um formulário interativo com base em seu caso de uso. Neste exemplo, o formulário foi projetado para mapear as variáveis de CEP a partir da Tarefa de API.
    1. Na coluna Elementos, arraste o elemento Caixa de texto e solte-o no designer de formulários.
      A guia Propriedades é exibida com os campos relevantes no lado direito da tela.
    2. Digite um Rótulo do elemento. Por exemplo: CEP
    3. Se desejar, insira um Limite de caracteres Mín e Máx. Você pode inserir 1 no campo Mín e 5 no campo Máx.
    4. Além disso, arraste mais dois elementos de Caixa de texto e nomeie-os como Local e Estado.
    5. Da coluna Elementos, arraste um elemento Botão e solte-o no designer de formulários. Digite um nome para esse botão no campo Texto do botão (obrigatório) (por exemplo: Redefinir). A imagem a seguir mostra um formulário preenchido:
      Exemplo de tarefa de API de Código Postal
  3. Adicione as Regras de formulário. As regras de formulário fornecem as condições necessárias para cada elemento do formulário. Você pode definir regras de formulário usandoifethene especificar as ações que serão executadas quando as condições forem atendidas. Neste exemplo, as regras do formulário são configuradas de modo que o valor do elemento CEP deve ser maior ou igual a cinco. Se essa condição for atendida, a caixa de elementos de local e estado recuperará os valores das variáveis da Tarefa de API. Durante a execução, a Tarefa de API não terá o desempenho esperado se as condições da regra de formulário não forem atendidas.
    1. Clique na guia Regras de formulário.
    2. Se desejar, digite um nome para a regra. (Por exemplo, chamada de Tarefa de API).
    3. Insira uma condição If para validar o CEP inserido. Por exemplo, você pode verificar se o CEP inserido tem no mínimo 5 caracteres.
      Exemplo de código postal da tarefa de API Verificar no mínimo 5 caracteres
    4. Para definir a cláusula Then, selecione Ações de formulário e, em seguida, no menu suspenso, selecione Obter valor da chamada de API.
      Em seguida, condicione o Formulário de tarefa de API de Código Postal
    5. Você pode mapear variáveis associadas ao Tarefa de API em um formulário usando a opção Adicionar mapeamento de variáveis.
      Nota: Se você editar um Tarefa de API publicado e adicionar outras variáveis depois de ter feito o checkin da tarefa, as variáveis não serão exibidas no formulário. Você precisa fazer o checkin do Tarefa de API depois de adicionar as variáveis
    6. Clique em Procurar, para selecionar uma Tarefa de API específica para executar uma determinada operação. Neste exemplo, uma Tarefa de API (Tarefa de CEP) é selecionada para recuperar o Local e o Estado de qualquer CEP.
  4. Adicione uma regra para o botão Redefinir. Neste exemplo, as regras de formulário para o botão de redefinição são definidas para limpar os valores em todos os campos quando você clica no botão Redefinir.
    1. Clique no botão Adicionar regra.
    2. Insira uma condição Se para capturar o estado É clicado do botão. Essa condição é verdadeira sempre que o botão for clicado.
      Exemplo de código postal da tarefa de API Verificar no mínimo 5 caracteres
    3. Para definir a cláusula Then, clique em Adicionar ação e clique no menu suspenso Selecionar elemento para selecionar todos os elementos de TextBox que precisam ser limpos ao clicar no botão Redefinir.
      Redefinição do formulário de tarefa de API Código Postal
    4. Clique no menu suspenso abaixo da lista suspensa Selecionar elementos e selecione Limpar valor.
      Nota: Quando você invoca um Tarefa de API em um formulário múltiplas vezes em uma única sessão, pode encontrar um erro. Para resolver esse erro, adicione um botão de redefinição ao formulário para limpar os valores existentes.