Ir para o conteúdo

Atividade de Consulta do Harmony Square

Introdução

Uma atividade Square Query recupera clientes de uma conexão Square e destina-se a ser usada como uma fonte para fornecer dados para uma operação. Depois de configurar uma conexão Square, você pode configurar quantas atividades Square você gosta para cada conexão Square.

Crie uma Atividade 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 quadro de design ou copie o tipo de atividade e cole-o na quadro de design. Para obter detalhes, consulte Criando uma instância de atividade em Reutilização de componente.

Uma atividade existente pode ser editada a partir destes locais:

Configurar uma Atividade de Consulta Square

Siga estas etapas para configurar uma atividade de consulta Square:

Etapa 1: Insira um Nome e Especifique as Configurações

aba Conexões

Dica

Campos com ícone de variável Ícone de variável suporte usando variáveis globais, variáveis de projeto e variáveis Jitterbit. Comece a digitar um colchete aberto [ no campo ou clique no ícone de variável para exibir as variáveis existentes para escolha.

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

  • Field Sort: Especifique a classificação do campo a ser usada, uma de DEFAULT ou CREATED_AT.

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

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

  • Save & Exit: Se ativado, clique para salvar a configuração desta etapa e fechar a configuração da atividade.

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

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

Etapa 2: Revisar os Esquemas de Dados

aba Conexões

  • 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 muito mais.

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

    • Resposta:

      Campo/nó do esquema de resposta Notas
      mensagem de erro A mensagem de erro
      clientes Nó dos clientes
      id Identificação do cliente
      criadoEm Data de criação
      atualizadoEm Data de atualização
      dadoNome O nome (primeiro) do cliente
      nomedafamília Nome da família (sobrenome) do cliente
      NomeEmpresa A empresa do cliente
      apelido Apelido do cliente
      endereço de e-mail O endereço e-mail do cliente
      número de telefone O número de telefone do cliente

  • Atualizar: Clique no ícone de atualização Ícone de atualização ou a palavra Atualizar para regenerar esquemas do endpoint. Essa ação também regenera o esquema em outros locais ao longo o 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.

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

Próximos Passos

Após configurar uma atividade de Consulta Square, conclua a configuração da operação adicionando e configurando outras atividades, transformações ou scripts como etapas da operação. Você também pode configurar a operação de uma operação configurações, que incluem a capacidade de encadear operações que estão no mesmo workflows ou em diferentes.

Após a criação de uma atividade do Square, as ações do menu para essa atividade ficam acessíveis no painel do projeto nas guias Workflows ou Componentes e na quadro de design. Ver Menu de Ações de Atividade para detalhes.

As atividades do Square Query podem ser usadas como fonte com este padrão de operação: - Padrão de transformação - Padrão de duas transformações (como primeiro ou segundo alvo)

Outros padrões não são válidos usando atividades Square Query. Veja os padrões de validação no Validade da Operação página.

Um caso de uso típico é usar uma atividade Square Query no Two-transformation Pattern. Neste exemplo, o primeira transformação (Square Query Request) cria uma estrutura de requisição que é passada para o Square Query atividade. A segunda transformação, (Square Query Response) recebe a estrutura de resposta que é então escrita para uma variável por uma atividade Variable Write (Write Square Query Response) e uma mensagem é então registrada pelo script Gravar no Log de Operações:

operação de consulta Square

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

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