Ir para o conteúdo

Assistente de consulta Salesforce no Jitterbit Design Studio

Criar uma operação de consulta Salesforce

Esta página descreve como criar uma operação de Consulta Salesforce usando o Assistente de Consulta Salesforce do Jitterbit Connect.

Nota

Ao abrir um projeto existente que utiliza uma versão anterior da API do Salesforce, você será solicitado a atualizar para a versão mais recente da API do Salesforce suportada. (Uma atualização para uma versão superior inclui implicitamente todos os recursos e objetos das versões anteriores.)

A versão da API do Salesforce disponível depende do agente Jitterbit e da versão do Design Studio que você está usando. Consulte Pré-requisitos e versões de API suportadas para mais informações.

Iniciar o assistente

  • Clique no ícone attachment no topo da tela para exibir a janela de diálogo do Jitterbit Connect:

    attachment

  • Para iniciar o assistente, clique no botão Consulta Salesforce no menu do Assistente de Consulta Jitterbit, que abre o assistente.

Login no Salesforce

  • Se você já criou um login de org Salesforce, os detalhes da conexão aparecerão no assistente de Consulta. Você pode querer clicar no botão Testar Login Salesforce para verificar a conexão.

    attachment

  • Se você ainda não criou um login no Salesforce, ou se precisa usar credenciais diferentes, selecione Criar Novo… no menu suspenso abaixo de Selecionar ou criar uma Org Salesforce.

  • Observe que quaisquer alterações que você fizer nesta página do assistente serão salvas automaticamente na Org Salesforce mostrada na página. Consulte a página de org Salesforce para detalhes.

  • Na tela de login do Salesforce, clique em Próximo para avançar para a próxima tela. (Se necessário, você pode clicar no botão Voltar para retornar à tela anterior em qualquer uma dessas telas.)

Selecione o objeto do Salesforce

  • Na tela Objeto, você especifica o Objeto do Salesforce que a operação usará.

  • Simplifique sua visualização digitando as primeiras letras do nome de um objeto na caixa de entrada de texto Filtro, ou clique no menu suspenso Objetos a mostrar e selecione entre Objetos Comuns Padrão, Todos os Objetos Personalizados ou Todos os Objetos.

  • Selecione o Objeto do Salesforce desejado. Neste exemplo, acc foi inserido na caixa Filtro e Conta foi selecionado.

    attachment

  • Clique em Próximo para avançar para a tela Fonte.

Construa sua consulta do Salesforce

  • Nesta tela, você começa a construir a consulta. Você pode criar uma Consulta Simples ou uma Consulta de Relacionamento:

    attachment

  • Para uma consulta simples (todas as referências em uma única tabela), use o painel Consulta Simples à esquerda e marque os Itens a serem incluídos em sua consulta. À medida que você faz isso, eles serão adicionados à String da Consulta no painel à direita. Usando a caixa de entrada de texto Filtro, os botões Selecionar Todos e Remover Todos podem ajudá-lo a especificar rapidamente cada campo.

  • Para uma consulta de relacionamento (que inclui referências a outras tabelas, seja pais ou filhos do objeto atual), clique na guia Consulta de Relacionamento à esquerda. Listas para Relacionamentos Pai e Filho aparecem na parte inferior do painel esquerdo:

    attachment

  • Selecione um objeto da lista de Relacionamentos Filhos e clique duas vezes nele para visualizar seus Campos no objeto. Você pode adicioná-los, como mostrado neste exemplo, onde campos de Contatos foram adicionados (Sobrenome, Departamento, Email, etc.):

    attachment

  • Verifique um campo na tabela filha para adicioná-lo à sua string de consulta. Novamente, você pode usar a caixa de entrada de texto Filtro para encontrar rapidamente os itens desejados.

  • Para voltar a uma tabela anterior (como Conta, conforme mostrado no exemplo acima), clique no nome da tabela na trilha de navegação do assistente.

  • Você pode adicionar condições à consulta usando os controles Campo, Operador e Valor em Condições; por exemplo, AccountSource = 'SF'. Quando você tiver concluído as entradas nesses controles, clique em Adicionar Condição e a condição será adicionada à string de consulta:

    attachment

  • Você pode clicar no botão Testar Consulta no canto inferior direito para validar a consulta.

  • Após concluir a consulta, clique em Próximo para ir para a tela Destino.

Defina o destino

Selecione onde deseja colocar seus dados

O destino é o local de armazenamento dos dados recuperados da Consulta Salesforce. Selecione um dos seguintes:

  • Um tipo de destino existente no menu suspenso, como Arquivo Local, Site FTP, Compartilhamento de Arquivo, Armazenamento Temporário, Banco de Dados, HTTP ou LDAP
  • Clique no botão Selecionar ou Criar Novo para selecionar um destino existente ou criar um novo Destino do tipo atualmente selecionado.

Para detalhes sobre os diferentes destinos, consulte a documentação sobre Destinos.

Destinos de arquivo local

Nota

Se você estiver criando um destino de arquivo local pela primeira vez, deve primeiro habilitar locais de arquivo local em cada configuração de agente privado do Jitterbit. (Um Arquivo Local pode ser usado apenas com agentes privados.)

No caso de um Destino de Arquivo de Localização, você pode fornecer diretamente um nome de arquivo onde deseja que os dados sejam armazenados.

  • Especificando um Arquivo Local como destino e fornecendo sua localização:

    attachment

  • Clicar em Próximo levará você à tela Selecionar um Formato de Arquivo, onde você especifica se deseja criar um formato de arquivo com base nos campos da consulta (opcionalmente com os nomes dos campos como a primeira linha do arquivo), selecionar um formato de arquivo existente ou criar um novo formato de arquivo:

    attachment

  • Especificando um Arquivo Local como destino e selecionando o uso de um destino de Arquivo Local existente:

    attachment

  • Quando você tiver concluído suas entradas para o destino, clique em Próximo para avançar para a próxima tela.

Selecione um formato de arquivo

  • Depois de especificar o destino, você precisará especificar o Formato do Arquivo de Destino. Se você selecionou um destino de banco de dados em vez de um destino de arquivo, consulte Usando um banco de dados como destino.

    attachment

  • Selecione um botão Radio para criar um formato de arquivo a partir dos campos em sua consulta, selecionar um Formato de Arquivo existente ou criar um novo formato de arquivo.

  • Se você usar um Formato de Arquivo existente ou criar um novo, será solicitado no final do assistente para Selecionar ou Criar Novo no menu suspenso.

  • Clique em Próximo.

Agendar e opções

  • Criar ou definir um agendamento é opcional e pode ser feito em um momento posterior. Para mais detalhes sobre agendamento, consulte Criar um agendamento.
  • Você pode editar um agendamento existente abrindo-o na pasta Agendamentos do painel Itens do Projeto e fazendo os ajustes desejados.
  • Você pode usar esta tela do assistente para adicionar agendamento a uma operação não agendada ou abrir a operação no Painel de Itens do Projeto e fazer os ajustes apropriados.
  • Defina a Ocorrência, Frequência Diária (horas ou minutos) e Duração da operação.
  • Ao definir a Duração, esteja ciente de que as datas de Início e Fim em um agendamento são inclusivas.
  • Para exibir essas opções, abra os caret ao lado de Ocorrência, Frequência Diária e Duração.

attachment

  • Quando terminar, clique em Próximo para ir para a tela de Resumo.

Tela de Resumo

Na tela de Resumo, você pode editar o Nome dado ao assistente e especificar se deseja usar o Automapper do assistente para mapear os dados:

attachment

  • Clique em Concluir para finalizar o assistente.
  • Se precisar criar ou aprovar um mapeamento de transformação, você será levado a essa tela.
  • Caso contrário, os itens de design para sua operação serão criados e se tornarão visíveis no painel de Itens do Projeto no lado esquerdo da tela, e você será levado à página de Consulta do Salesforce da operação.

Mapeamento de transformação

Se você escolheu Selecionar um Formato de Arquivo existente (ou criou um novo) na tela de Destino do assistente, o mapeamento de transformação aparecerá na sua área de trabalho:

attachment

  • Se você especificou a caixa de seleção Usar Automapper, a maior parte ou todo o mapeamento de campos pode estar completo. Complete qualquer mapeamento manual conforme apropriado.
  • Um mapeamento é mostrado como uma linha entre os itens nas colunas Fonte (esquerda) e Destino (direita).
  • Uma linha verde indica um mapeamento válido e é ainda indicada pela presença de um quadrado azul ao lado de cada nome de item mapeado validamente.
  • Uma linha vermelha indica um mapeamento inválido.
  • Uma linha amarela indica que um mapeamento é de validade questionável; no entanto, a operação tentará a transformação com esse mapeamento.
  • Você pode completar o mapeamento na aba de Transformação arrastando e soltando da Fonte à esquerda para o Destino à direita. Quando você faz isso, e um mapeamento válido é o resultado, um quadrado azul aparecerá à esquerda de ambos os itens Fonte e Destino.
  • Para salvar sua transformação, clique na seta para baixo na faixa de Status e selecione Salvar.

Complete o mapeamento conforme necessário e clique em Concluir para finalizar o assistente e a criação dos itens de design.

Consulta do Salesforce concluída

  • Uma vez concluído, você será levado à tela de resumo para a nova Consulta do Salesforce.
  • Você pode retornar a esta página de resumo encontrando o nome da operação sob Jitterbit Connect no painel Itens do Projeto.
  • Você pode modificar qualquer um dos itens de design em seu projeto, como Login do Salesforce, Consulta do Salesforce, Mapeamentos, Gravar dados em, Operação e Executar conforme programação, clicando no botão Editar adjacente.
  • As funções dos botões Executar Consulta, Testar Consulta e Excluir são descritas abaixo em Implantar o projeto e executar a operação.
  • Opções Avançadas incluem opções de operação, como divisão em partes e truncamento de campo. Elas são abordadas abaixo em Opções avançadas.

attachment

Opções avançadas

Essas opções avançadas estão disponíveis para uma Consulta do Salesforce:

attachment

Opções de arquivo

  • Gravar como UTF-8: Selecione para gravar o arquivo de destino com codificação de caracteres UTF-8.
  • Cabeçalho de destino: Selecione entre Sem Cabeçalho, Nomes de Campos do Salesforce ou Nomes de Campos do Formato do Arquivo.

Opções de operação

  • Incluir linhas excluídas: Selecione para incluir linhas excluídas na saída da consulta.
  • Tamanho do lote: Por padrão, isso é definido para 2000 registros.
  • Política de Retentativa: Exibe um diálogo para definir as políticas de retentativa. Veja a página Avançado do Salesforce.
  • Divisão em partes: Por padrão, a divisão em partes não está habilitada para Consultas do Salesforce. Ela pode ser habilitada nas opções de operação, conforme descrito na página Avançado do Salesforce.

Opções adicionais de operação para divisão em partes e gravação de registros de sucesso e falha são descritas na página Avançado do Salesforce.

Implantar o projeto e executar a operação

Implantar o projeto

Implantar um projeto antes de executá-lo não é necessário, pois ele será implantado automaticamente, se necessário.

Para implantar o projeto, você pode:

  • Clicar no ícone Implantar na barra de ferramentas; ou

  • No painel Itens do Projeto, clique com o botão direito no Nome do projeto recém-criado e, em seguida, clique com o botão esquerdo em Implantar no menu suspenso resultante; ou

  • Clique com o botão direito em Operações no topo do painel Itens do Projeto e, em seguida, clique com o botão esquerdo em Implantar no menu suspenso resultante.

O processo de implantação do projeto começa enviando o projeto para o Harmony, e uma mensagem de progresso aparece.

  • Para executar a mensagem de progresso em segundo plano, clique em Executar em Segundo Plano.

  • Para cancelar o processo de implantação, clique em Cancelar, que o retorna à tela anterior.

A operação agora está completa e implantada.

Executar a operação

Esta imagem mostra os botões disponíveis nas páginas de resumo do Assistente Salesforce. Os rótulos (como Executar Consulta ou Executar Inserção) variarão dependendo do assistente que você está usando. O botão Histórico de Resultados não está disponível na página de resumo de Consultas Salesforce e o botão Testar… não está disponível na página de resumo de Processos em Massa Salesforce.

attachment

  • Pressione o botão Executar… apropriado para colocar a operação na fila para execução.

    • Se o projeto ainda não foi implantado ou foi alterado desde a última implantação, ele será implantado automaticamente. Consulte Criar uma operação para informações adicionais sobre como criar, implantar e executar operações.
    • O Monitor de Operações é exibido na parte inferior da tela, rastreando o status, o horário de recebimento, o horário de início e o horário em que a operação concluiu o processamento.

    • Quando a operação conclui o processamento, o popup Resultado exibe o horário de conclusão, o status, o número de registros que foram processados com sucesso e o número de registros que falharam ao processar. Os botões Ver arquivo de sucesso e Ver arquivo de falha são descritos abaixo.

    • Pressione o botão Testar… para testar a operação. Esta opção destina-se a testar a operação apenas em um ambiente que esteja conectado a um Salesforce Sandbox e não deve ser usada em um ambiente de produção. Selecionar Testar Inserção na página de resumo de Inserções Salesforce, por exemplo, processa e insere os primeiros 200 registros no Salesforce Sandbox. Nota: O botão Testar… não está disponível na página de resumo de Processos em Massa Salesforce.
    • Pressione o botão Histórico de Resultados para exibir uma lista popup de atividades recentes, incluindo o horário de conclusão, status, o número de registros processados com sucesso e o número de registros que falharam ao processar. Selecione um resultado na lista para habilitar os botões Ver arquivo de sucesso e Ver arquivo de falha, que são descritos abaixo. Nota: O botão Histórico de Resultados não está disponível na página de resumo de Consultas Salesforce.
    • Pressione o botão Excluir para excluir a operação do projeto.
    • A janela popup Confirmar exclusão é exibida. Clique em Excluir para confirmar e excluir a operação.
    • A janela popup Excluir Itens do Assistente? exibe os componentes da operação associados.
      • Selecione Sim para excluir os objetos do assistente associados além da operação de inserção.
      • Se você selecionar Não, os objetos do assistente permanecerão disponíveis dentro do projeto. NOTA: Apenas a operação de inserção é excluída.
      • Selecionar Cancelar cancela a exclusão da operação de inserção e dos objetos do assistente associados.

Veja Criar uma operação para informações adicionais sobre como criar, implantar e executar operações.

Visualizar arquivos de sucesso e falha

A visualização de arquivos de sucesso e falha está disponível se você estiver executando operações em um agente privado. Os botões Visualizar arquivo de sucesso e Visualizar arquivo de falha estão disponíveis após pressionar o botão Executar... ou o botão Histórico de Resultados conforme descrito acima e, em seguida, selecionar um dos resultados. Este é um exemplo da janela pop-up do Histórico de Resultados, mostrando os botões e um resultado selecionado:

attachment

  • Visualizar arquivo de sucesso: Se você estiver executando a operação em um agente privado, selecionar o botão Visualizar arquivo de sucesso exibe os primeiros 100 registros que foram processados com sucesso em uma janela pop-up.

  • Visualizar arquivo de falha: Se você estiver executando a operação em um agente privado, selecionar o botão Visualizar arquivo de falha exibe os primeiros 100 registros que falharam ao processar em uma janela pop-up.

  • Neste exemplo, três registros são mostrados:

    attachment

    • Copiar arquivo para...: Este botão salva os registros de sucesso ou falha em um arquivo CSV. O nome do arquivo padrão é salesforce.csv.

    • Abrir programa externo: Esta opção atualmente não está disponível.

Nota

Os arquivos de sucesso e falha estão disponíveis para visualização a partir do agente privado por 14 dias por padrão. Os arquivos são automaticamente excluídos do agente privado após 14 dias pelo Serviço de Limpeza de Arquivos Jitterbit. O número de dias que os arquivos são salvos pode ser alterado editando o arquivo jitterbit.conf na seção [ResultFiles] (veja Editando o arquivo de configuração). Você também pode alterar as regras de arquivos de sucesso e falha ao Editar as regras do serviço de limpeza de arquivos Jitterbit para agentes privados.