Atividade de consulta em massa do Salesforce

Introdução

Uma atividade Bulk Query do Salesforce consulta um grande número de registros de um endpoint do Salesforce e tem a intenção de ser usada como uma fonte para fornecer dados a uma operação. Após configurar uma conexão do Salesforce, você pode configurar quantas atividades do Salesforce quiser para cada conexão do Salesforce.

A atividade Consulta em massa é mais rápida e dimensionável melhor do que uma atividade Consulta do Salesforce não em massa, mas deve ser usado somente se você não precisar usar uma transformação para alterar dados antes de atingir seu destino. (As atividades em massa do Salesforce não podem ser usadas com transformações.)

O conector Salesforce oferece suporte à API em massa do Salesforce. Para obter mais informações, consulte Pré-requisitos e versões de API com suporte.

Criar uma atividade do Salesforce

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 componentes.

Uma atividade existente pode ser editada a partir destes 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 em massa do Salesforce

Siga estas etapas para configurar uma atividade Consulta em massa do Salesforce:

• Etapa 1: Insira um nome e selecione os 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 declaração de consultar, seja automaticamente selecionando campos e especificando condições, ou manualmente inserindo diretamente uma declaração de consultar. Você deve testar a consultar para garantir que ela seja válida antes de prosseguir.

Etapa 1: insira um nome e selecione os objetos

Nesta etapa, você fornece um nome para a atividade e seleciona os objetos a serem consultados em massa.

• Nome: Insira um nome a ser usado para identificar a atividade Consulta em massa do Salesforce. O nome deve ser exclusivo para cada atividade Consulta em massa do Salesforce e não deve conter barras (/) ou dois pontos (:).

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

  • Exibir: Use o menu suspenso para filtrar a lista de objetos que suportam Consulta em massa para Padrão, Personalizado ou Todos os objetos. Por padrão, todos os objetos são mostrados.

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

  • Atualizar: Clique no ícone de atualização para recarregar objetos do endpoint do Salesforce. Isso pode ser útil se você adicionou objetos recentemente ao Salesforce.

  • 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, observe as seguintes dicas de solução de problemas:

    • A conexão Salesforce pode não ser bem-sucedido. Certifique-se de que você está conectado reabrindo a conexão e testando novamente as credenciais.

    • Uma senha do Salesforce que usa caracteres ASCII estendidos, como £, pode causar o seguinte erro ao buscar dados durante a configuração da atividade:

      Invalid username, password, security token; or user locked out. [INVALID_LOGIN]
      

      Nesse caso, o teste de conexão ainda pode ser bem-sucedido. Se você receber esse erro durante a configuração da atividade e estiver usando caracteres especiais na senha, tente alterá-la.

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

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

• Selecionar campos e criar condições: Esta seção exibe campos para os objetos selecionados que estão disponíveis no endpoint do Salesforce. Objetos que foram selecionados na etapa anterior são mostrados em negrito.
• Pesquisar: Insira qualquer valor de 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 pressionamento de tecla.
• 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 (objetos e campos recolhidos não são selecionados).
• Selecionar campos: Selecione as caixas de seleção dos campos que você deseja incluir na consultar para que eles sejam adicionados 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 consultar 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 dentro desta 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.

• Test Query: Clique neste botão para validar se a consultar é válida. Se a consultar for válida, uma amostra de 10 registros recuperados da consultar será exibida em uma tabela semelhante à mostrada abaixo. Se a consultar não for válida, mensagens de erro relevantes serão exibidas.

  

• Cláusula WHERE (Opcional): Para adicionar uma cláusula WHERE, você pode usar os campos abaixo como entrada para ajudar a construir a cláusula, ou pode inserir manualmente a cláusula na caixa de texto inferior.

  • 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 ou igual a
    >	Maior que
    >=	Maior que ou igual a
    CURTIR	Curtir
    EM	EM
    NÃO DENTRO	NÃO DENTRO
    INCLUI	Aplica-se somente a listas de seleção múltipla
    EXCLUI	Aplica-se somente a listas de seleção múltipla

    Lógico
    E	VERDADEIRO se ambas as expressões esquerda e direita forem VERDADEIRAS
    OU	VERDADEIRO se a expressão esquerda ou direita for VERDADEIRA
    NÃO	VERDADEIRO se a expressão correta for FALSA

  • Valor: Insira o valor desejado para usar com as seleções suspensas.

    Nota

    Ao usar variáveis globais em uma cláusula WHERE, você deve especificar um valor padrão para que a consultar 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 suspensas e no valor inserido. A cláusula construída automaticamente aparece na caixa de texto inferior.

  Nota

  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óximos passos

Após configurar uma atividade Bulk Query do Salesforce, você pode usá-la dentro de 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 scripts como etapas da operação. Você também pode configurar as configurações de operação de uma operação, que incluem a capacidade de encadear operações que estejam no mesmo fluxo de trabalho ou em workflows diferentes.

Depois que uma atividade do Salesforce Bulk Query é criada, as ações de menu para essa atividade ficam acessíveis no painel do projeto nas guias Workflows ou Components e na quadro de design. Consulte menu de ações da atividade para mais detalhes.

As atividades de Consulta em massa do Salesforce podem ser usadas como uma fonte com o padrão de fonte em massa do Salesforce

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 referenciar a mesma atividade várias vezes dentro de 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).

Outros padrões não são válidos usando atividades do Salesforce Bulk Query. Veja os padrões de validação em Validade da operação página.

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

• Base64
• Booleano
• Formatos de data
• Dobro
• Inteiro
• ID do Salesforce
• Corda

As operações que usam atividades do Salesforce também podem ter ações de operação configuradas para disparar em uma falha de 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 a ocorrência de uma falha de SOAP. Para obter instruções sobre como disparar uma ação em uma falha de SOAP, consulte Ações de operação.

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 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 estão disponíveis para download na página Operações de tempo de execução do Management Console. Selecione a operação relevante na tabela Operações de tempo de execução e clique na aba Registros de atividades na seção inferior da tela para exibir links de download para os 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.

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