Ir para o conteúdo

Atividade de Consulta Square v2 no Jitterbit Studio

Introdução

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

Nota

A atividade de Consulta retornará dados de objeto que estão especificados dentro de seu esquema de solicitação. Para recuperar todos os dados do objeto selecionado, use a atividade de Leitura.

Criar uma atividade de Consulta Square v2

Uma instância de uma atividade de Consulta Square v2 é criada a partir de uma conexão Square v2 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 Square v2 existente pode ser editada a partir destes locais:

Configurar uma atividade de Consulta Square v2

Siga estas etapas para configurar uma atividade de Consulta Square v2:

Passo 1: Insira um nome e selecione um objeto

Neste passo, forneça um nome para a atividade e selecione um objeto. Cada elemento da interface do usuário deste passo é 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 Telasc 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 único para cada atividade de Consulta do Square v2 e não deve conter barras / ou dois-pontos :.

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

    • Objeto 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 Square v2. Isso pode ser útil se objetos foram adicionados ao Square v2. 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 de 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 Square v2:

      • Nome: O nome do objeto.

      • Descrição: A descrição do objeto.

    Dica

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

  • Limite: Especifique o número máximo de resultados por página. O valor mínimo é 1 e o máximo é 1000. Quando este campo é deixado em branco, o número máximo de resultados por página é 100.

  • Continuar em Caso de Erro: Selecione para continuar a execução da atividade se um erro for encontrado para um conjunto de dados em uma solicitação em lote. Se algum erro for encontrado, ele será registrado no log de operações.

  • Salvar e Sair: Se habilitado, clique para salvar a configuração para esta etapa e fechar a configuração da atividade.

  • 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: Selecionar um sub-objeto

Nesta etapa, selecione um sub-objeto. Cada elemento da interface do usuário desta etapa é descrito abaixo.

  • Selecionar um Sub-objeto: Esta seção exibe sub-objetos disponíveis no endpoint Square v2.

    • Objeto Selecionado: O objeto selecionado na etapa anterior é listado aqui.

    • Selecionar um Sub-objeto: Após um sub-objeto ser selecionado, ele é listado aqui.

    • Pesquisar: Insira o valor de qualquer coluna na caixa de pesquisa para filtrar a lista de sub-objetos. A pesquisa não diferencia maiúsculas de minúsculas. Se sub-objetos já estiverem exibidos na tabela, os resultados da tabela são filtrados em tempo real a cada tecla pressionada. Para recarregar sub-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 sub-objetos do endpoint Square v2. Isso pode ser útil se sub-objetos foram adicionados ao Square v2. Esta ação atualiza todos os metadados usados para construir a tabela de sub-objetos exibida na configuração.

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

    • Nome: O nome do sub-objeto.

    • Descrição: A descrição do sub-objeto.

    Dica

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

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

  • 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 3: Revisar os esquemas de dados

Qualquer esquema de solicitação ou resposta é exibido. Cada elemento da interface do usuário desta etapa é descrito abaixo.

  • Esquemas de Dados: Esses esquemas de dados são herdados por transformações adjacentes e são exibidos novamente durante o mapeamento de transformação.

    O conector Square v2 utiliza a API Square. Consulte a documentação da API do objeto para obter informações sobre os nós e campos do esquema:

    Nota

    O campo records, presente no esquema de resposta, atua como um contador quando você faz mais de uma solicitação usando a atividade Query.

  • Atualizar: Clique no ícone de atualizar ou na palavra Atualizar para regenerar esquemas do endpoint Square v2. Esta ação também regenera um esquema em outros locais 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 de 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 você confirmar que deseja descartar as alterações.

Próximas etapas

Após configurar uma atividade Query do Square v2, 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 Conceitos básicos do conector.

As atividades Query do Square v2 podem ser usadas como uma fonte com esses padrões de operação:

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.