Ir para o conteúdo

Atividade de Consulta do Square

Introdução

Uma atividade de Consulta do Square recupera clientes de uma conexão do Square e é destinada a ser usada como uma fonte para fornecer dados a uma operação. Após configurar uma conexão do Square, você pode configurar quantas atividades do Square desejar para cada conexão do Square.

Criar uma atividade do Square

Uma instância de uma atividade é criada a partir de uma conexão usando um tipo de atividade.

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 existente pode ser editada a partir destes locais:

Configurar uma atividade de Consulta do Square

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

Etapa 1: Insira um nome e especifique as configurações

Dica

Campos com um ícone de variável suportam o uso de variáveis globais, variáveis de projeto e variáveis do Jitterbit. Comece digitando um colchete esquerdo [ no campo ou clicando no ícone de variável para exibir um menu com as variáveis existentes para escolher.

  • Nome: Insira um nome para identificar a atividade de Consulta Square. O nome deve ser único para cada atividade de Consulta e não deve conter barras (/) ou dois pontos (:).

  • Ordenação de Campo: Especifique a ordenação de campo a ser utilizada, uma de DEFAULT ou CREATED_AT.

  • Ordem de Classificação: Especifique a ordem de classificação a ser utilizada, uma de DESC (decrescente) ou ASC (crescente).

  • Número de Registros a Retornar: O número máximo de resultados a ser retornado em uma única página. Uma entrada válida é ou vazia ou um valor de 0 a 1000. Deixe o campo vazio (o padrão) para retornar todos os registros.

  • Salvar e Sair: Se ativado, clique para salvar a configuração desta etapa e fechar 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 alterações, clique em Descartar Alterações para fechar a configuração sem salvar as alterações feitas em qualquer etapa. Uma mensagem pedirá que você confirme que deseja descartar as alterações.

Etapa 2: Revisar os esquemas de dados

  • Esquema de Dados: O esquema de dados de resposta para o Square será exibido. 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.

    O conector Square utiliza a API REST do Square. Consulte a documentação da API para obter informações sobre os campos do esquema.

    • Resposta:

      Campo/Nó do Esquema de Resposta Notas
      errorMessage A mensagem de erro
      customers Nó dos clientes
      id ID do cliente
      createdAt Data de criação
      updatedAt Data de atualização
      givenName O nome (primeiro) do cliente
      familyName O sobrenome (último) do cliente
      companyName A empresa do cliente
      nickname O apelido do cliente
      emailAddress O endereço de email do cliente
      phoneNumber O número de telefone do cliente

  • Atualizar: Clique no ícone de atualizar ou na palavra Atualizar para regenerar esquemas a partir do endpoint. Esta ação também regenera o 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 de todas as etapas e fechar a configuração da atividade.

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

Próximas etapas

Após configurar uma atividade de Consulta Square, 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.

Após uma atividade Square ter sido criada, as ações do menu para essa atividade estão acessíveis no painel do projeto nas abas Fluxos de Trabalho ou Componentes, e no canvas de design. Veja o menu de ações da atividade para mais detalhes.

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

Outros padrões não são válidos usando atividades de Consulta Square. Veja os padrões de validação na página de validade da 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.