Atividade de Consulta Square V2¶

Introdução¶

Uma atividade Square v2 Query, usando sua conexão Square v2, recupera dados de objetos especificados do Square e destina-se a ser usado como uma fonte para fornecer dados em uma operação.

Crie uma Atividade de Consulta Square V2¶

Uma instância de uma atividade Square v2 Query é criada a partir de uma conexão Square v2 usando seu tipo de atividade Query.

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

Uma atividade existente do Square v2 Query pode ser editada nestes locais:

• A quadro de design (consulte Menu Ações do componente em Quadro de Design).
• A aba Componentes do painel do projeto (consulte Menu Ações do componente em Guia Componentes do painel do projeto).

Configurar uma Atividade de Consulta Square V2¶

Siga estas etapas para configurar uma atividade Square v2 Query:

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

• Etapa 2: Selecione um subobjeto
  Selecione um subobjeto.

• Etapa 3: 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.

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

• Selecione um objeto: Esta seção exibe objetos disponíveis no endpoint Square v2.

  • Objeto Selecionado: Depois que um objeto é selecionado, ele é listado aqui.

  • Pesquisar: Insira qualquer parte do nome do objeto na caixa de pesquisa para filtrar a lista de objetos. A busca não diferencia maiúsculas de minúsculas. Se os objetos já estiverem exibidos na tabela, os resultados da tabela serão filtrados em tempo real a cada pressionamento de tecla. Para recarregar objetos do endpoint durante a pesquisa, insira os critérios de pesquisa e atualize, conforme descrito abaixo.

  • Atualizar: Clique no ícone de atualização ou a palavra Refresh para recarregar objetos do endpoint Square v2. Isso pode ser útil se objetos tiverem sido adicionados ao Square v2. Esta ação atualiza todos os metadados usados para construir a tabela de objetos exibidos na configuração.

  • Selecionando um objeto: Na 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 no endpoint 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 sucesso. Certifique-se de estar 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 for encontrado um erro para um conjunto de dados em uma solicitação em lote. Se algum erro for encontrado, ele será gravado no log de operação.

• Salvar e Sair: Se ativado, clique para salvar a configuração desta etapa e feche a configuração da atividade.

• Próximo: Clique para armazenar temporariamente a configuração desta 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 as alterações, clique para fechar a configuração sem salvar as alterações feitas em nenhuma etapa. Uma mensagem solicita que você confirme que deseja descartar as alterações.

Etapa 2: Selecione um Subobjeto¶

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

• Selecione um subobjeto: Esta seção exibe subobjetos disponíveis no endpoint Square v2.

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

  • Selecione um subobjeto: Depois que um subobjeto é selecionado, ele é listado aqui.

  • Pesquisar: Insira qualquer parte do nome do subobjeto na caixa de pesquisa para filtrar a lista de subobjetos. A busca não diferencia maiúsculas de minúsculas. Se os subobjetos já estiverem exibidos na tabela, os resultados da tabela serão filtrados em tempo real a cada pressionamento de tecla. Para recarregar subobjetos do endpoint durante a pesquisa, insira os critérios de pesquisa e atualize, conforme descrito abaixo.

  • Atualizar: Clique no ícone de atualização ou a palavra Refresh para recarregar subobjetos do endpoint Square v2. Isso pode ser útil se subobjetos tiverem sido adicionados ao Square v2. Esta ação atualiza todos os metadados utilizados para construir a tabela de subobjetos exibidos na configuração.

  • Selecionando um subobjeto: Na tabela, clique em qualquer lugar de uma linha para selecionar um subobjeto. Somente um subobjeto pode ser selecionado. As informações disponíveis para cada subobjeto são obtidas do endpoint Square v2:

    • Nome: O nome do subobjeto.

    • Descrição: A descrição do subobjeto

  Dica

  Se a tabela não for preenchida com subobjetos disponíveis, a Conexão Square v2 pode não ter sucesso. Certifique-se de estar conectado reabrindo a conexão e testando novamente as credenciais.

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

• Próximo: Clique para armazenar temporariamente a configuração desta 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 as alterações, clique para fechar a configuração sem salvar as alterações feitas em nenhuma etapa. Uma mensagem solicita que você confirme que deseja descartar as alterações.

Etapa 3: Revise 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: 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 usa a API Square. Consulte a documentação da API do objeto para obter informações sobre os nós e campos do esquema:

  • Catálogo
  • Clientes
  • Inventário
  • Faturas
  • Pedidos
  • Pagamentos
  • Assinaturas
  • Terminal

  Nota

  O records campo, 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 atualização ou a palavra Refresh 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 desta 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 as alterações, clique para fechar a configuração sem salvar as alterações feitas em nenhuma etapa. Uma mensagem solicita que você confirme que deseja descartar as alterações.

Próximos Passos¶

Depois de configurar uma atividade Square v2 Query, conclua a configuração da operação adicionando e configurando outras atividades, transformações ou scripts como etapas de operação. Você também pode definir as configurações de operação, que incluem a capacidade de encadear operações que estejam no mesmo fluxo de trabalho ou em workflows diferentes.

As ações de menu de uma atividade podem ser acessadas no painel do projeto e na quadro de design. Para obter detalhes, consulte Menu Ações da atividade em Noções básicas do conector.

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

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

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

Quando estiver pronto, implantar e execute a operação e validar o comportamento verificando os logs de operação.