Atividade Salesforce Bulk Query no Jitterbit Studio

Introdução

Uma atividade Bulk Query do Salesforce, usando sua conexão Salesforce, consulta um grande número de registros do Salesforce e é destinada a ser usada como uma fonte para fornecer dados em uma operação.

A atividade Bulk Query deve ser usada apenas se você não precisar usar uma transformação para alterar dados antes de chegar ao seu destino, pois as atividades em massa do Salesforce não podem ser usadas com transformações. Se você precisar usar uma transformação, use a atividade Query do Salesforce.

As atividades em massa do Salesforce usam a Salesforce Bulk API baseada em SOAP. Para mais informações, consulte Pré-requisitos e versões de API suportadas.

Criar uma atividade Salesforce Bulk Query

Uma instância de uma atividade Bulk Query do Salesforce é criada a partir de uma conexão Salesforce usando seu tipo de atividade Bulk 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 Bulk 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 Bulk Query

Siga estas etapas para configurar uma atividade Bulk 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 serem consultados em massa.

• 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 1: Insira um nome e selecione objetos

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

• 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 Bulk Query do Salesforce. O nome deve ser único para cada atividade Bulk Query do Salesforce e não deve conter barras (/) ou dois-pontos (:).

• Selecionar Objeto(s): Esta seção exibe objetos disponíveis na conexão Salesforce:

• Copiar: Clique no ícone Copiar configuração da 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 da atividade para colar uma configuração existente que foi copiada desta etapa ou da etapa 2. 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 Bulk Query do Salesforce.

• Exibir: Use o menu suspenso para filtrar a lista de objetos que suportam Bulk Query para todos os objetos, objetos padrão ou objetos personalizados. Por padrão, todos os objetos são exibidos.

• Pesquisar: 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): Clique em um objeto da lista de objetos para selecioná-lo. Apenas um objeto pode ser selecionado.

  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.

• Salvar e Sair: Se habilitado, 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 inserindo uma instrução de consulta diretamente. 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.

  • Pesquisar: 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 superior direita é preenchida automaticamente com o objeto e os campos selecionados. Para usar uma instrução SOQL personalizada, faça edições na caixa de texto conforme necessário. Para referência sobre como estruturar uma instrução SOQL personalizada, consulte a documentação do Salesforce sobre Sintaxe SOQL SELECT.

• Copiar: Clique no ícone Copiar configuração da atividade para copiar a configuração existente desta etapa e da etapa 1 para a área de transferência. A cópia fica disponível apenas após validar uma consulta 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.

• Testar Consulta: Clique neste botão para validar se a consulta é válida. Se a consulta for válida, uma amostra de 10 registros recuperados da consulta é exibida em uma tabela semelhante à mostrada abaixo. A consulta deve ser válida para ativar o botão Próximo. Se a consulta não for válida, mensagens de erro relevantes são exibidas.

• 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, primeiro teste a consulta usando o botão Testar Consulta para ativar 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 múltipla
    EXCLUDES	Aplica-se apenas a listas de seleção múltipla

    Lógico
    AND	VERDADEIRO se ambas as expressões esquerda e direita forem VERDADEIRAS
    OR	VERDADEIRO se a expressão 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, especifique 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.

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

Próximas etapas

Após configurar uma atividade Bulk Query 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 Bulk Query do Salesforce, conclua a configuração da operação adicionando e configurando outras atividades ou ferramentas 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 estão no mesmo fluxo de trabalho ou em fluxos de trabalho diferentes.

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

As atividades Bulk Query do Salesforce podem ser usadas como uma origem com o padrão de origem em massa do Salesforce. Outros padrões não são válidos ao usar atividades Bulk Query do Salesforce. Consulte os padrões de validação na página Validade da operação.

As operações que contêm uma atividade do Salesforce podem ter apenas uma atividade do Salesforce e não podem conter nenhuma outra atividade, exceto aquelas associadas aos conectores 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 uma etapa de operação em apenas uma única operação. Ou seja, você não pode fazer referência à mesma atividade várias vezes em outras operações. Em vez disso, você pode fazer uma cópia de uma atividade do Salesforce para usar em outro lugar (consulte Reutilização de componentes).

Além disso, o destino baseado em arquivo usado na operação deve estar usando um formato de arquivo simples com um cabeçalho e apenas os seguintes tipos de dados:

• Base64
• Booleano
• Formatos de data
• Double
• Integer
• ID do Salesforce
• String

As 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 estiver pronto, implante e execute a operação e valide o comportamento verificando os logs da 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:

• Baixar Arquivo de Sucesso: 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.

• Baixar Arquivo de Falha: 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.