Atividade de Consulta do Zendesk no Jitterbit Studio

Introdução

Uma atividade de Consulta do Zendesk, utilizando sua conexão do Zendesk, recupera dados de objetos do Zendesk e é destinada a ser usada como uma fonte para fornecer dados em uma operação.

Limites de taxa

A API REST do Zendesk, que é utilizada pelo conector do Zendesk, impõe uma série de limites de taxa dependendo de vários fatores. Leia sobre os limites na documentação do Zendesk.

Criar uma atividade de Consulta do Zendesk

Uma instância de uma atividade de Consulta do Zendesk é criada a partir de uma conexão do Zendesk usando seu tipo de atividade Consulta.

Para criar uma instância de uma atividade, arraste o tipo de atividade para a tela de design ou copie o tipo de atividade e cole-o na tela de design. Para detalhes, veja Criar uma instância de atividade ou ferramenta em Reutilização de componentes.

Uma atividade de Consulta do Zendesk existente pode ser editada a partir destes locais:

• A tela de design (veja Menu de ações do componente em Tela de design).
• A aba Componentes do painel do projeto (veja Menu de ações do componente em Aba de Componentes do painel do projeto).

Configurar uma atividade de Consulta do Zendesk

Siga estas etapas para configurar uma atividade Query do Zendesk:

• Etapa 1: Insira um nome e selecione um objeto
  Forneça um nome para a atividade e selecione um objeto.

• Etapa 2: Revise os esquemas de dados
  Quaisquer esquemas de solicitação ou resposta são exibidos.

Etapa 1: Insira um nome e selecione um objeto

Nesta etapa, forneça um nome para a atividade e selecione um objeto. Cada elemento da interface do usuário desta etapa é descrito abaixo.

• Menu de Endpoint: Se você tiver vários endpoints do mesmo tipo de conector configurados, um menu na parte superior da tela exibe o nome do endpoint atual. Clique no menu para alternar para um endpoint diferente. Para mais informações, veja Alterar o endpoint atribuído em Telasa de configuração.

  • Editar endpoint: Aparece quando você passa o mouse sobre o nome do endpoint atual. Clique para editar a configuração de conexão do endpoint atualmente selecionado.

• Nome: Insira um nome para identificar a atividade. O nome deve ser exclusivo para cada atividade Query do Zendesk e não deve conter barras / ou dois pontos :.

• Selecionar um Objeto: Esta seção exibe os objetos disponíveis no endpoint do Zendesk.

  • Objeto Zendesk Selecionado: Após um objeto ser selecionado, ele é listado aqui.

  • Pesquisar: Insira o valor de qualquer coluna na caixa de pesquisa para filtrar a lista de objetos. A pesquisa não diferencia maiúsculas de minúsculas. Se os objetos já estiverem exibidos na tabela, os resultados da tabela são filtrados em tempo real a cada tecla pressionada. Para recarregar objetos do endpoint ao pesquisar, insira os critérios de pesquisa e, em seguida, atualize, conforme descrito abaixo.

  • Atualizar: Clique no ícone de atualizar ou na palavra Atualizar para recarregar objetos do endpoint do Zendesk. Isso pode ser útil se objetos foram adicionados ao Zendesk. Esta ação atualiza todos os metadados usados para construir a tabela de objetos exibida na configuração.

• Selecionando um Objeto: Dentro da tabela, clique em qualquer lugar em uma linha para selecionar um objeto. Apenas um objeto pode ser selecionado. As informações disponíveis para cada objeto são obtidas do endpoint do Zendesk:

  -   **Nome:** O nome do objeto do Zendesk.
  
  -   **Descrição:** A descrição do objeto do Zendesk.
  

  Dica

  Se a tabela não for preenchida com objetos disponíveis, a conexão com o Zendesk pode não ter sido bem-sucedida. Certifique-se de que está conectado reabrindo a conexão e retestando as credenciais.

• Número Máximo de Páginas: Insira o número máximo de páginas a serem retornadas. Cada página retorna 100 registros. Por padrão, se um valor não for fornecido, uma página é retornada.

• Próximo: Clique para armazenar temporariamente a configuração para esta etapa e continuar para a próxima etapa. A configuração não será salva até que você clique no botão Concluído na última etapa.

• Descartar Alterações: Após fazer alterações, clique para fechar a configuração sem salvar as alterações feitas em qualquer etapa. Uma mensagem pede para você confirmar que deseja descartar as alterações.

Etapa 2: Revisar os esquemas de dados

Quaisquer esquemas de solicitação ou resposta são exibidos. Cada elemento da interface do usuário desta etapa é descrito abaixo.

• Esquemas de Dados: Os esquemas de dados de solicitação e resposta para o Zendesk serão exibidos. Se a operação usar uma transformação, os esquemas de dados serão exibidos novamente mais tarde durante o processo de mapeamento de transformação, onde você pode mapear para campos de destino usando objetos de origem, scripts, variáveis, valores personalizados e mais.

  Nota

  Os dados fornecidos em uma transformação têm precedência sobre a configuração da atividade.

  O conector do Zendesk utiliza a API Rest do Zendesk; consulte a API para obter informações sobre os campos de esquema dos objetos suportados.

  Os esquemas de dados de solicitação e resposta consistem nestes nós e campos:

  • Solicitação:

    Campo/Nó do Esquema de Requisição	Notas
    queryRequest	Requisição de consulta
    item	Os itens do Grupo
    property	Uma [palavra-chave de propriedade do grupo], seja name ou created
    operator	Um [operador de busca], um dos :, <, >, <=, >=, " ", -, ou *
    searchTerm	Um [termo de busca] que consiste em uma palavra, frase ou valor definido pelo usuário

  • Resposta:

    Campo/Nó do Esquema de Resposta	Notas
    queryResponse	Resposta de consulta
    item	Os itens do Grupo em [Formato JSON]
    deleted	Um booleano indicando se o grupo está marcado como deletado
    updated_at	O horário da última atualização do grupo
    name	O nome do grupo
    created_at	O horário em que o grupo foi criado
    id	Um inteiro atribuído durante a criação do grupo
    url	A URL da API do grupo

• Atualizar: Clique no ícone de atualizar ou na palavra Atualizar para regenerar esquemas do endpoint do Zendesk. Esta ação também regenera um esquema em outros locais ao longo do projeto onde o mesmo esquema é referenciado, como em uma transformação adjacente.

• Voltar: Clique para armazenar temporariamente a configuração para esta etapa e retornar à etapa anterior.

• Concluído: Clique para salvar a configuração para todas as etapas e fechar a configuração da atividade.

• Descartar Alterações: Após fazer alterações, clique para fechar a configuração sem salvar as alterações feitas em qualquer etapa. Uma mensagem pede para confirmar que você deseja descartar as alterações.

Próximas etapas

Após configurar uma atividade Consulta do Zendesk, complete a configuração da operação adicionando e configurando outras atividades ou ferramentas como etapas da operação. Você também pode configurar as configurações da operação, que incluem a capacidade de encadear operações que estão no mesmo ou em diferentes fluxos de trabalho.

As ações do menu para uma atividade estão acessíveis a partir do painel do projeto e da tela de design. Para detalhes, veja o menu de ações da atividade em Noções básicas sobre conectores.

Atividades Consulta do Zendesk podem ser usadas como fonte com esses padrões de operação:

• Padrão de transformação
• Padrão de arquivo de dois alvos (como a primeira fonte apenas)
• Padrão de arquivo HTTP de dois alvos (como a primeira fonte apenas)
• Padrão de duas transformações (como a primeira ou segunda fonte)

Para usar a atividade com funções de script, escreva os dados em um local temporário e, em seguida, use esse local temporário na função de script.

Quando estiver pronto, implante e execute a operação e valide o comportamento verificando os logs da operação.