Atividade Salesforce Query no Jitterbit Studio

Introdução

Uma atividade Query do Salesforce, usando sua conexão Salesforce, consulta dados do Salesforce e é destinada a ser usada como uma fonte para fornecer dados em uma operação.

Criar uma atividade Salesforce Query

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

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, consulte Criar uma instância de atividade ou ferramenta em Reutilização de componentes.

Uma atividade Query do Salesforce existente pode ser editada a partir destes locais:

• A tela de design (consulte Menu de ações de componentes em Tela de design).

• A aba Componentes do painel de projeto (consulte Menu de ações de componentes em Aba Componentes do painel de projeto).

Configurar uma atividade Salesforce Query

Siga estas etapas para configurar uma atividade Query do Salesforce:

• Etapa 1: Insira um nome e selecione objetos
  Forneça um nome para a atividade e selecione o(s) objeto(s) a ser(em) consultado(s).

• Etapa 2: Selecione campos e crie condições
  Crie a instrução de consulta, automaticamente selecionando campos e especificando condições, ou manualmente inserindo uma instrução de consulta diretamente.

• Etapa 3: Revise os esquemas de dados
  Qualquer esquema de solicitação ou resposta gerado a partir do endpoint é exibido.

Etapa 1: Insira um nome e selecione objetos

Nesta etapa, você fornece um nome para a atividade e seleciona o(s) objeto(s) a ser(em) consultado(s).

• 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, consulte Alterar o endpoint atribuído em Telas 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 selecionado no momento.

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

• Selecionar Objeto(s): Esta seção exibe objetos disponíveis no endpoint do Salesforce:

  • Copiar: Clique no ícone Copiar configuração de atividade para copiar a configuração existente desta etapa e da etapa 2 para sua área de transferência. A cópia é habilitada apenas após uma consulta ser validada na etapa 2 usando o botão Testar Consulta.

  • Colar: Clique no ícone Colar configuração de atividade para colar uma configuração existente que foi copiada desta etapa ou da etapa 2. Quando você tenta colar uma consulta, um diálogo de confirmação é exibido indicando que qualquer configuração existente nas etapas 1 e 2 será sobrescrita.

    Dica

    Os botões Copiar e Colar também podem ser usados em diferentes instâncias da atividade Query do Salesforce.

• Visualização: Use o menu suspenso para filtrar a lista de objetos para todos os objetos, objetos padrão ou objetos personalizados. Por padrão, todos os objetos são exibidos.

• Pesquisa: Digite 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.

• Atualizar: Clique no ícone de atualização para recarregar objetos do endpoint do Salesforce. Isso é útil se você adicionou recentemente objetos ao Salesforce que ainda não estão visíveis na lista Selecionar Objeto(s).

• Selecionar Objeto(s): A lista de objetos é exibida em uma coluna à esquerda. Clique no objeto para adicioná-lo à lista à direita. Apenas um objeto primário pode ser selecionado na lista à esquerda.

  Nota

  Se a lista não for preenchida com objetos disponíveis, a conexão do Salesforce pode não ter sido bem-sucedida. Certifique-se de estar conectado reabrindo a conexão e testando novamente as credenciais.

• Selecionar Objeto(s) Relacionado(s): Opcionalmente, para incluir objetos filhos ou pais na consulta, marque a caixa de seleção ao lado de cada objeto relacionado a incluir. Isso é chamado de consulta de relacionamento.

  Nota

  A seleção de objetos relacionados é limitada a filhos imediatos e ancestrais até 5 níveis. Isso inclui pai(s) de um filho, mas não inclui um filho de um filho ou outro filho de um pai.

  • Atualizar: Clique no ícone de atualização para recarregar campos nos objetos relacionados para esta atividade do endpoint do Salesforce. As seleções existentes em Selecionar Objeto(s) Relacionado(s) permanecem apenas se esses objetos forem usados na etapa 2. Qualquer objeto que não seja usado na etapa 2 terá sua seleção limpa.

• Visualizar Campos: Para visualizar campos de um objeto específico, clique diretamente no nome do objeto em Selecionar Objeto(s) Relacionado(s). Observe que ativar a visualização de campos é independente de quais caixas de seleção de campo estão selecionadas. Ou seja, você pode visualizar campos de objetos independentemente de estarem selecionados.

• 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 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: Selecionar campos e criar condições

Nesta etapa, você cria a instrução de consulta, automaticamente selecionando campos e especificando condições, ou manualmente digitando diretamente uma instrução de consulta. Você deve testar a consulta para garantir que seja válida antes de prosseguir para a próxima etapa.

• Selecionar Campos e Criar Condições: Esta seção exibe campos para o(s) objeto(s) selecionado(s) que estão disponíveis no endpoint do Salesforce. Os objetos selecionados na etapa anterior são exibidos em negrito.

  • Pesquisa: Digite o valor de qualquer coluna na caixa de pesquisa para filtrar a lista de campos. A pesquisa não diferencia maiúsculas de minúsculas. Os resultados listados são filtrados em tempo real a cada digitação.

  • 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 vez (objetos e campos recolhidos não são selecionados).

  • Selecionar Campos: Marque as caixas de seleção dos campos que deseja incluir na consulta para adicioná-los automaticamente à instrução SOQL à direita. A menos que esteja usando a caixa de pesquisa, você também pode selecionar um objeto inteiro para selecionar todos os seus campos de uma vez.

• Instrução SOQL: Conforme você seleciona campos, a instrução de consulta na caixa de texto do canto superior direito é preenchida automaticamente com o objeto e os campos selecionados. Para usar uma instrução SOQL personalizada, faça edições nesta caixa de texto conforme necessário. Para referência sobre como estruturar uma instrução SOQL personalizada, consulte a documentação do Salesforce em Sintaxe SOQL SELECT.

• Incluir Linhas Excluídas: Marque esta caixa de seleção para incluir linhas marcadas como excluídas no Salesforce. (Isso se aplica tanto durante o teste da consulta quanto durante a execução.)

• Copiar: Clique no ícone Copiar configuração da atividade para copiar a configuração existente desta etapa e da etapa 1 para sua área de transferência. A cópia é habilitada apenas após uma consulta ser validada usando o botão Testar Consulta.

• Colar: Clique no ícone Colar configuração da atividade para colar uma configuração existente que foi copiada desta etapa ou da etapa 1. Ao tentar colar uma consulta, um diálogo de confirmação é exibido indicando que as configurações existentes nas etapas 1 e 2 serão sobrescritas.

  Dica

  Os botões Copiar e Colar também podem ser usados em diferentes instâncias da atividade Query do ServiceMax.

• Testar Consulta: Clique neste botão para validar se a consulta é válida. Se a consulta não for válida, mensagens de erro relevantes serão exibidas. A consulta deve ser válida para habilitar o botão Próximo.

• Cláusula WHERE (Opcional): Para adicionar uma cláusula WHERE, use os campos abaixo como entrada para ajudar a construir a cláusula ou insira manualmente a cláusula na caixa de texto inferior. Após adicionar uma cláusula WHERE, você deve primeiro testar a consulta usando o botão Testar Consulta para habilitar o botão Próximo.

• Objeto: Campo: Use o menu suspenso para selecionar um campo dos objetos selecionados.

  • Operador: Use o menu suspenso para selecionar o(s) operador(es) apropriado(s). A lista de operadores disponíveis depende do tipo de dados do campo selecionado.

    Comparação
    =	Igual a
    !=	Não igual a
    <	Menor que
    <=	Menor que ou igual a
    >	Maior que
    >=	Maior que ou igual a
    LIKE	Semelhante a
    IN	IN
    NOT IN	NOT IN
    INCLUDES	Aplica-se apenas a listas de seleção multisseleção
    EXCLUDES	Aplica-se apenas a listas de seleção multisseleção

    Lógico
    AND	VERDADEIRO se ambas as expressões esquerda e direita forem VERDADEIRAS
    OR	VERDADEIRO se uma das expressões esquerda ou direita for VERDADEIRA
    NOT	VERDADEIRO se a expressão direita for FALSA

  • Valor: Insira o valor desejado para usar com as seleções do menu suspenso. Quando o valor é uma string, coloque o valor entre aspas simples para corresponder ao formato usado pelo Salesforce.

    Cuidado

    Ao usar variáveis globais em uma cláusula WHERE, você deve especificar um valor padrão para que a consulta seja válida para teste (com o botão Testar Consulta), pois as variáveis globais obtêm seu valor em tempo de execução (consulte Definir um valor padrão em Variáveis globais).

• Adicionar: Clique no link para construir automaticamente a cláusula com base nas seleções do menu suspenso e no valor inserido. A cláusula construída automaticamente aparece na caixa de texto inferior.

  Dica

  Para adicionar várias condições à cláusula, repita o processo adicionando seleções adicionais. Observe que pode ser necessário adicionar um operador lógico como AND ou OR para considerar as condições adicionais.

• 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. Se você adicionou uma cláusula WHERE, deve testar a consulta usando o botão Testar Consulta para ativar o botão Próximo.

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

Nesta etapa, qualquer esquema de solicitação ou resposta gerado a partir do endpoint é exibido:

• Esquema de Dados: O esquema de dados de resposta é exibido. Se a operação usa uma transformação, os esquemas de dados sã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.

  A versão da API do Salesforce usada depende da versão do agente Jitterbit que você está usando. Consulte Pré-requisitos e versões de API suportadas para links para documentação sobre os campos do esquema.

  Nota

  Para atualizar um esquema de dados em uma atividade existente, você deve avançar por cada etapa de configuração de atividade novamente, fazendo pelo menos uma alteração (como adicionar e remover um caractere no final do nome da atividade) para forçar uma atualização do esquema.

• 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 de 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 solicita que você confirme que deseja descartar as alterações.

Próximas etapas

Após configurar uma atividade Consulta do Salesforce, você pode usá-la em uma operação conforme descrito abaixo. Após executar uma operação contendo uma atividade do Salesforce em um agente privado, você pode baixar os arquivos de sucesso e falha da operação.

Concluir a operação

Após configurar uma atividade Consulta do Salesforce, conclua a configuração da operação adicionando e configurando outras atividades ou ferramentas como etapas de operação. Você também pode configurar as definições de operação, que incluem a capacidade de encadear operações que estão no mesmo fluxo de trabalho ou em fluxos de trabalho diferentes.

As ações de menu para uma atividade são acessíveis no painel do projeto e na tela de design. Para obter detalhes, consulte Menu de ações de atividade em Noções básicas do conector.

As atividades Consulta do Salesforce podem ser usadas com estes padrões de operação:

• Padrão de arquivo (como a origem)
• Padrão de transformação (como a origem)
• Padrão de arquivo com dois destinos (como a primeira ou segunda origem)
• Padrão de duas transformações (como a primeira ou segunda origem)

Se uma Consulta do Salesforce for usada como atividade de origem, então uma atividade de destino é necessária.

Uma operação pode conter apenas uma atividade do Salesforce. A atividade que recebe dados de uma atividade de Consulta do Salesforce deve estar associada ao conector API, Banco de Dados, Compartilhamento de Arquivos, FTP, HTTP, Armazenamento Local, Armazenamento Temporário ou Variável.

Uma atividade do Salesforce pode ser usada como etapa de operação em apenas uma única operação. Ou seja, não é possível referenciar a mesma atividade várias vezes em outras operações. Em vez disso, é possível fazer uma cópia de uma atividade do Salesforce para usar em outro lugar (consulte Reutilização de componentes).

Outros padrões não são válidos ao usar atividades de Consulta do Salesforce. Consulte os padrões de validação na página Validade da operação.

Em uma transformação, ao usar a opção de espelhar um esquema fornecido por uma atividade do Salesforce não em massa, o esquema espelhado resultante será criado automaticamente com um nó raiz adicional chamado records com nó(s) filho espelhando o esquema. Quando campos dentro do(s) nó(s) filho são mapeados, o nó se torna um nó de loop para permitir que todos os registros sejam percorridos (consulte Nós de loop em Estruturas de dados).

Operações que usam atividades do Salesforce também podem ter ações de operação configuradas para serem acionadas em uma falha SOAP — um erro resultante de um formato de mensagem incorreto, processamento de cabeçalho ou incompatibilidade. As ações de operação podem ser configuradas para executar uma operação ou enviar um email após uma falha SOAP. Para obter instruções sobre como acionar uma ação em caso de falha SOAP, consulte Ações de operação.

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

Quando pronto, implante e execute a operação e valide o comportamento verificando os logs de operação.

Exibir arquivos de sucesso e falha

Se você estiver executando uma operação contendo uma atividade do Salesforce em um agente privado, os arquivos de sucesso e falha estarão disponíveis para download na página Runtime do Console de Gerenciamento. Selecione a operação relevante na tabela Runtime e clique na guia Activity Logs na seção inferior da tela para exibir os links de download dos arquivos, se disponíveis:

• Download Success File: Se você estiver executando a operação em um agente privado, clique no link Download para salvar os registros de sucesso como um arquivo CSV.

• Download Failure File: Se você estiver executando a operação em um agente privado, clique no link Download para salvar os registros de falha como um arquivo CSV.