Atividade de consulta do QuickBooks
Introdução
Uma atividade Consulta do QuickBooks, usando sua conexão, recupera um objeto do QuickBooks e se destina a ser usado como uma fonte para fornecer dados em uma operação.
Criar uma atividade de consulta do QuickBooks
Uma instância de uma atividade Consulta do QuickBooks é criada a partir de uma conexão do QuickBooks usando seu tipo de atividade Consulta.
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 Consulta existente do QuickBooks pode ser editada nestes locais:
- A quadro de design (veja menu de ações do componente em Tela de design).
- A aba Componentes do painel do projeto (consulte menu de ações do componente na aba Componentes do painel Projeto).
Configurar uma atividade de consulta do QuickBooks
Siga estas etapas para configurar uma atividade Consulta do QuickBooks:
-
Etapa 1: Insira um nome e selecione um objeto
Forneça um nome para a atividade e selecione um objeto. -
Etapa 2: Crie sua consultar
Defina condições em uma consultar usando os campos de objeto e aplique paginação a uma consultar. -
Etapa 3: Revise os esquemas de dados
Quaisquer esquemas de solicitação ou resposta gerados 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 de Consulta do QuickBooks e não deve conter barras
/
ou dois pontos:
. -
Selecione um objeto: Esta seção exibe os objetos disponíveis no endpoint.
-
Objeto QuickBooks selecionado: Depois que um objeto é selecionado, ele é listado aqui.
-
Pesquisar: Insira qualquer valor de 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 serão filtrados em tempo real a cada pressionamento de tecla. Para recarregar objetos do endpoint ao pesquisar, 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. Isso pode ser útil se objetos foram adicionados ao QuickBooks. 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 QuickBooks:
-
Nome: O nome do objeto do endpoint.
-
Tipo: O tipo de objeto do endpoint.
-
Descrição: A descrição do objeto do endpoint.
-
Dica
Se a tabela não for preenchida com objetos disponíveis, a conexão pode não ser bem-sucedido. Certifique-se de que você esteja conectado reabrindo a conexão e testando novamente as credenciais.
-
-
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 nenhuma etapa. Uma mensagem solicita que você confirme que deseja descartar as alterações.
Etapa 2: crie sua consultar
Nesta etapa, defina condições em uma consultar usando os campos de objeto e aplique paginação a uma consultar. Cada elemento de interface do usuário desta etapa é descrito abaixo.
Dica
Campos com um ícone de variável suporte usando variáveis globais, variáveis do projeto e variáveis Jitterbit. Comece digitando um colchete aberto [
no campo ou clicando no ícone de variável para exibir uma lista de variáveis existentes para escolher.
-
Pesquisar: Insira qualquer parte do nome de um campo na caixa de pesquisa para filtrar a lista de campos para o objeto selecionado. A pesquisa não diferencia maiúsculas de minúsculas. Os resultados listados são filtrados em tempo real a cada pressionamento de tecla.
-
Atualizar: Clique no ícone de atualização ou a palavra Atualizar para recarregar campos do objeto do endpoint do QuickBooks.
-
Selecionar tudo: Ao usar a caixa de pesquisa para filtrar, você pode usar esta caixa de seleção para selecionar todos os campos visíveis de uma só vez.
-
Selecionar campos: Selecione as caixas de seleção dos campos que você deseja incluir na consultar para que eles sejam adicionados automaticamente à instrução SELECT na Query String. Você também pode Selecionar todos os campos de uma vez usando a caixa de seleção.
-
Paging: Para adicionar uma cláusula de paginação (um limite no número de registros com um deslocamento de registro opcional), você pode usar o menu suspenso para definir o limite de paginação e o campo para inserir um deslocamento. Se um deslocamento não for especificado, o padrão será 0. Uma única cláusula de paginação é suportada. Se a cláusula de paginação não for incluída, todos os registros serão retornados.
-
Aplicar: Clique para construir automaticamente a cláusula com base nas seleções suspensas e no valor inserido. A cláusula de paginação construída automaticamente aparece na caixa de texto Query String.
-
Remover: Clique para remover uma cláusula de paginação que foi aplicada.
-
-
Condições: Para adicionar cláusulas condicionais, use os campos abaixo como entrada para ajudar a construir as cláusulas, que então aparecem na caixa de texto String de consulta.
-
Objeto: Campo: Use o menu suspenso para selecionar um campo do objeto selecionado.
-
Operador: Use o menu suspenso para selecionar um operador apropriado para o tipo de dados do campo:
Operador Rótulo Descrição = É igual a != Não é igual a CURTIR 'string' Curtir Curtir string LIKE 'string%' Começa com Começa com string LIKE '%string' Termina com Termina com string LIKE '%string%' Contém Contém string < Menos que <= Menor ou igual > Maior que >= Maior ou igual -
Valor: Insira o valor desejado para usar com as seleções suspensas.
-
Adicionar: Clique para construir automaticamente a cláusula com base nas seleções suspensas e no valor inserido. A cláusula condicional é adicionada à caixa de texto Query String.
-
Remover tudo: Clique para remover todas as cláusulas condicionais inseridas.
-
-
Sequência de caracteres de consulta: Conforme você seleciona campos, especifica condições e define a paginação, a instrução de consultar nesta caixa de texto é preenchida automaticamente com os campos, condições e limites de paginação selecionados.
Nota
Os valores de quaisquer variáveis globais usados na Query String não são preenchidos ao usar o botão Test Query, mesmo se um valor padrão for especificado. Os valores de variáveis globais serão obtidos no tempo de execução quando a consultar for executada. Para testar a consultar com um valor de variável padrão, use uma variável de projeto em vez de.
-
Test Query: Clique para validar a consultar. Se a consultar for válida, uma amostra de até 10 registros recuperados da consultar será exibida em uma tabela. Se a consultar não for válida, mensagens de erro relevantes serão exibidas.
-
Voltar: Clique para armazenar temporariamente a configuração desta 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 nenhuma etapa. Uma mensagem pede para você confirmar que deseja descartar as alterações.
Etapa 3: Revise os esquemas de dados
O esquema de 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.
Consulte a documentação para obter informações sobre os nós e campos do esquema.
-
Atualizar: Clique no ícone de atualização ou a palavra Refresh para regenerar esquemas do endpoint do QuickBooks. Esta ação também regenera um esquema em outros locais em todo 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.
-
Descartar alterações: Após fazer alterações, clique para fechar a configuração sem salvar as alterações feitas em nenhuma etapa. Uma mensagem pede para você confirmar que deseja descartar as alterações.
Próximos passos
Após configurar uma atividade Query do QuickBooks, 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 as definições da 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 para uma atividade são acessíveis a partir do painel do projeto e da quadro de design. Para obter detalhes, consulte menu de ações de atividade em Noções básicas do conector.
As atividades de Consulta podem ser usadas como uma fonte com esses padrões de operação:
- Padrão de Transformação
- Padrão de arquivo de dois alvos (apenas como primeira fonte)
- Padrão de arquivo HTTP de dois alvos (apenas como primeira fonte)
- Padrão de duas transformações (apenas como primeira 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 executar a operação e validar o comportamento verificando os logs de operação.