Atividade de Consulta do Salesforce¶

Introdução¶

Uma atividade de consulta do Salesforce consulta dados de um endpoint do Salesforce e deve ser usada como fonte para fornecer dados a uma operação. Depois de configurar uma conexão do Salesforce, você pode configurar quantas atividades do Salesforce desejar para cada conexão do Salesforce.

Crie 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 nestes locais:

• A quadro de design (consulte Menu Ações do componente em Quadro de Design).
• A aba Componentes do painel do projeto (consulte Menu Ações do componente em Guia 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 ser(em) consultado(s).
• Etapa 2: Selecionar Campos e Criar Condições Crie a instrução de consultar 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.
• Etapa 3: Revise os esquemas de dados Quaisquer esquemas de solicitação ou resposta gerados a partir do endpoint são exibidos.

Etapa 1: Insira um Nome e Selecione Objetos¶

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

• Nome: Insira um nome a ser usado 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 objetos disponíveis no endpoint 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 mostrados.

  • Pesquisar: Insira qualquer parte do nome do objeto na caixa de pesquisa para filtrar a lista de objetos. A busca 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.

    Dica

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

• Selecionar objeto(s) relacionado(s): Opcionalmente, para incluir objetos filho ou pai na consultar, marque a caixa de seleção ao lado de cada objeto relacionado a ser incluído. Isso é chamado de consultar de relacionamento.

  Nota

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

  • 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) permanecerão somente se esses objetos forem usados na etapa 2. Quaisquer objetos que não forem usados na etapa 2 terão sua seleção desmarcada.

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

• Salvar e Sair: Se ativado, clique para salvar a configuração desta etapa e feche 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 as 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 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. Os objetos selecionados na etapa anterior são mostrados em negrito.

  • Pesquisar: Insira qualquer parte do nome do campo na caixa de pesquisa para filtrar a lista de campos. A busca 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 vez (objetos e campos recolhidos não são selecionados).
  • Selecionar campos: Marque as caixas de seleção dos campos que deseja incluir na consultar para que sejam adicionados automaticamente à instrução SOQL à direita. A menos que use a caixa de pesquisa, você também pode selecionar um objeto inteiro para selecionar todos os seus campos de uma vez.

• Instrução SOQL: À medida que 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 nesta caixa de texto conforme necessário. Para obter referência sobre como estruturar uma instrução SOQL personalizada, consulte a documentação do Salesforce sobre 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 consultar quanto durante o tempo de execução.)

• Consulta de Teste: 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, serão exibidas mensagens de erro relevantes. A consultar deve ser válida para ativar 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. Depois de adicionar uma cláusula WHERE, você deve primeiro testar a consultar 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
    \<	Menos que
    \<=	Menor ou igual
    >	Maior que
    >=	Maior ou igual
    GOSTO	Curtir
    DENTRO	DENTRO
    NÃO ESTÁ	NÃO ESTÁ
    INCLUI	Aplica-se somente a listas de opções de seleção múltipla
    EXCLUI	Aplica-se somente a listas de opções de seleção múltipla
    Lógico
    E	TRUE se ambas as expressões esquerda e direita forem TRUE
    OU	TRUE se a expressão da esquerda ou da direita for TRUE
    NÃO	TRUE se a expressão correta for FALSE

  • Valor: Insira o valor desejado para usar com as seleções suspensas. Quando o valor for uma string, coloque-o 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 consultar seja válida para teste (com o botão Testar Consulta), como 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.

  Dica

  Para adicionar diversas 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 dar conta das 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, deverá testar a consultar usando o botão Testar consulta para ativar o botão Próximo.

• Descartar alterações: Após fazer as 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: Revise 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 de resposta é exibido. Se a operação usar uma transformação, os esquemas de dados serão exibidos novamente posteriormente durante o mapeamento da transformação, onde você pode mapear campos de destino usando objetos de origem, scripts, variáveis, valores personalizados e muito mais.

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

  Nota

  Para atualizar um esquema de dados em uma atividade existente, você deve avançar novamente em cada etapa de configuração da atividade, 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 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 as 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¶

Depois de configurar uma atividade de consulta do Salesforce, você poderá usá-la em uma operação conforme descrito abaixo. Depois de 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.

Conclua a Operação¶

Depois de configurar uma atividade de consulta do Salesforce, 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 definir 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 de consulta do Salesforce for criada, as ações de menu para essa atividade estarão acessíveis no painel do projeto nas guias Workflows ou Componentes e na quadro de design. Consulte Menu Ações de Atividade para detalhes.

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

• Padrão de arquivo
• Padrão de transformação
• Padrão de arquivo 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 atividade de origem, será necessária uma atividade de destino.

As operações que contêm uma atividade do Salesforce podem ter apenas uma atividade do Salesforce e também não podem conter nenhuma outra atividade, exceto aquelas associadas à API, Base de dados, Compartilhamento de arquivo, FTP, HTTP, Armazenamento local, Armazenamento temporário ou Variável conectores.

Uma atividade do Salesforce pode ser usada como uma etapa de operação em apenas uma operação. Ou seja, não é possível fazer referência à mesma atividade diversas 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).

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 página.

Em uma transformação, se você 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 repetidos (consulte Nós de Loop em Estruturas de dados).

As operações que usam atividades do Salesforce também podem ter ações 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 ocorrer uma falha SOAP. Para obter instruções sobre como disparar uma ação em caso de falha 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.

Visualizar 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 Runtime Operations do Management Console. Selecione a operação relevante na tabela Operações em tempo de execução e clique na aba Logs de atividades na seção inferior da tela para exibir links de download para os arquivos, se disponíveis:

• Baixar arquivo com 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.

• Falha no download do arquivo: 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.