Atividade de Consulta do Salesforce

Introdução

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

Criar uma atividade de Consulta do Salesforce

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

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

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

• A tela de design (veja Menu de ações do componente em Tela de design).

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

Configurar uma atividade de Consulta do Salesforce

Siga estas etapas para configurar uma atividade de Consulta 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.

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

• Passo 3: Revisar os esquemas de dados
  Quaisquer esquemas de solicitação ou resposta gerados a partir do endpoint são exibidos.

Passo 1: Insira um nome e selecione objetos

Neste passo, você fornece um nome para a atividade e seleciona o(s) objeto(s) a serem consultados.

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

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

  • Copiar: Clique no ícone Copiar configuração da atividade para copiar a configuração existente tanto deste passo quanto do passo 2 para sua área de transferência. A cópia é habilitada apenas após uma consulta ter sido validada no passo 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 deste passo ou do passo 2. Quando você tenta colar uma consulta, um diálogo de confirmação é exibido indicando que quaisquer configurações existentes nos passos 1 e 2 serão sobrescritas.

    Dica

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

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

  • Pesquisar: Insira 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 atualizar para recarregar os objetos do endpoint do Salesforce. Isso é útil se você adicionou recentemente objetos ao Salesforce que não estão visíveis na lista de 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 principal pode ser selecionado na lista à esquerda.

    Nota

    Se a lista não for preenchida com objetos disponíveis, observe as seguintes dicas de solução de problemas:

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

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

      Nome de usuário, senha ou token de segurança inválidos; ou usuário bloqueado. [INVALID_LOGIN]
      

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

• Selecionar Objeto(s) Relacionado(s): Opcionalmente, para incluir objetos filhos ou pais na consulta, selecione a caixa de seleção ao lado de cada objeto relacionado a ser incluído. 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 atualizar para recarregar os campos nos objetos relacionados para esta atividade a partir do endpoint do Salesforce. As seleções existentes em Selecionar Objeto(s) Relacionado(s) permanecem apenas se esses objetos forem usados na etapa 2. Quaisquer objetos que não forem usados na etapa 2 têm 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 habilitar a visualização de campos é independente de quais caixas de seleção de campo estão selecionadas. Ou seja, você pode visualizar campos para objetos independentemente de estarem selecionados.

• 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 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 qualquer 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 declaração de consulta, seja automaticamente selecionando campos e especificando condições, ou manualmente inserindo diretamente uma declaração de consulta. Você deve testar a consulta para garantir que ela seja válida antes de prosseguir para a próxima etapa.

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

  • Pesquisar: Insira 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 tecla pressionada.

  • Selecionar Todos: 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 colapsados não são selecionados).

  • Selecionar Campos: Selecione as caixas de seleção dos campos que você deseja incluir na consulta para que eles sejam adicionados automaticamente à declaraçã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.

• Declaração SOQL: Ao selecionar campos, a declaração da consulta na caixa de texto no canto superior direito é preenchida automaticamente com o objeto e os campos selecionados. Para usar uma declaração SOQL personalizada, faça edições nesta caixa de texto conforme necessário. Para referência sobre como estruturar uma declaração SOQL personalizada, consulte a documentação da Salesforce sobre Sintaxe SOQL SELECT.

• Incluir Linhas Excluídas: Selecione esta caixa de seleção para incluir linhas que estão marcadas como excluídas dentro da 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 tanto deste passo quanto do passo 1 para sua área de transferência. A cópia é habilitada apenas após uma consulta ter sido 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 deste passo ou do passo 1. Quando você tenta colar uma consulta, um diálogo de confirmação é exibido indicando que quaisquer configurações existentes nos passos 1 e 2 serão sobrescritas.

  Dica

  Os botões Copiar e Colar também podem ser usados em diferentes instâncias da atividade Consulta 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 sã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 dropdown para selecionar um campo dos objetos selecionados.

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

    Comparação
    =	Igual
    !=	Diferente
    <	Menor que
    <=	Menor ou igual a
    >	Maior que
    >=	Maior ou igual a
    LIKE	Como
    IN	EM
    NOT IN	NÃO EM
    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 qualquer 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 dropdown. Quando o valor é uma string, coloque o valor entre aspas simples para corresponder ao formato usado pelo Salesforce.

    Atenção

    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 Test Query), pois as variáveis globais obtêm seu valor em tempo de execução (veja 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 dropdown e no valor inserido. A cláusula construída automaticamente aparece na caixa de texto inferior.

  Dica

  Para adicionar múltiplas 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 para esta 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 Finalizado na última etapa. Se você adicionou uma cláusula WHERE, deve testar a consulta usando o botão Testar Consulta para habilitar 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 qualquer etapa. Uma mensagem pede para você confirmar que deseja descartar as alterações.

Etapa 3: Revisar os esquemas de dados

Nesta etapa, quaisquer esquemas de solicitação ou resposta gerados a partir do endpoint são exibidos:

• Esquema de Dados: O esquema de dados da resposta é 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 mais.

  A versão da API do Salesforce que é utilizada depende da versão do agente Jitterbit que você está usando. Consulte Pré-requisitos e versões de API suportadas para links para a 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 da atividade novamente, fazendo pelo menos uma alteração (como adicionar e remover um caractere do final do nome da atividade) para forçar uma atualização do esquema.

• Voltar: Clique para armazenar temporariamente a configuração para esta etapa e retornar à etapa anterior.

• Concluído: Clique para salvar a configuração para 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 qualquer 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 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.

Completar a operação

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

As ações do menu para uma atividade estão acessíveis a partir do painel do projeto e da tela de design. Para detalhes, consulte o menu de ações da atividade em Conceitos básicos do conector.

Atividades Consulta do Salesforce podem ser usadas como fonte com esses padrões de operação:

• Padrão de Arquivamento
• Padrão de Transformação
• Padrão de Arquivamento de Dois Alvos (como a primeira ou a segunda fonte)
• Padrão de Duas Transformações (como a primeira ou a segunda fonte)

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

Operações que contêm uma atividade do Salesforce podem ter apenas uma atividade do Salesforce e não podem conter outras atividades, 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 um passo de operação em apenas uma única operação. Ou seja, não é possível 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 (veja Reutilização de Componentes).

Outros padrões não são válidos usando atividades de Consulta do Salesforce. Veja os padrões de validação na página Validade da Operação.

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

Operações que usam atividades do Salesforce também podem ter ações de operação configuradas para serem acionadas em um erro 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 um erro SOAP. Para instruções sobre como acionar uma ação em erro 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, em seguida, 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.

Visualizar arquivos de sucesso e falha

Se você estiver executando uma operação que contém 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 em Tempo de Execução do Console de Gerenciamento. Selecione a operação relevante na tabela Operações em Tempo de Execução e clique na guia Logs de Atividade 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 Baixar 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 Baixar para salvar os registros de falha como um arquivo CSV.