Ir para o conteúdo

Assistente de consultar do Salesforce

Criar uma operação de consultar do Salesforce

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

Nota

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

A versão da API REST do Salesforce que está 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.

Inicie o assistente

  • Clique em anexo ícone na parte superior da tela para exibir a janela de diálogo Jitterbit Connect:

    anexo

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

Login do Salesforce

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

    anexo

  • Se você ainda não criou um login no Salesforce ou precisa usar credenciais diferentes, selecione Criar novo… no menu suspenso abaixo Selecionar ou criar uma organização do Salesforce.

  • Observe que quaisquer alterações feitas nesta página do assistente serão salvas automaticamente na Salesforce Org mostrada na página. Veja a Salesforce org para mais detalhes.

  • Na tela de login do Salesforce, clique em Avançar para ir 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 Salesforce

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

  • 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 para mostrar e selecione entre Objetos comuns padrão, Todos os objetos personalizados ou Todos os objetos.

  • Selecione o Salesforce Object desejado. Neste exemplo, acc foi inserido na caixa Filter e Account foi selecionado.

    anexo

  • Clique em Avançar para ir para a tela Fonte.

Crie sua consultar do Salesforce

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

    anexo

  • Para uma consultar simples (todas as referências em uma única tabela), use o painel Consulta Simples à esquerda e marque os Itens a serem incluídos na sua consultar. Ao fazer isso, eles serão adicionados à Sequência de caracteres de consulta no painel direito. Usar a caixa de entrada de texto Filtro, os botões Selecionar tudo e Remover tudo podem ajudar você a especificar rapidamente cada campo.

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

    anexo

  • Selecione um objeto da lista Relacionamentos de 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.):

    anexo

  • Marque um campo na tabela filho para adicioná-los à sua sequência de consultar. Novamente, você pode usar a caixa de entrada de texto Filter para encontrar rapidamente os itens desejados.

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

  • Você pode adicionar condições à consultar usando os controles Field, Operator e Value em Conditions; por exemplo, AccountSource = 'SF'. Quando tiver concluído as entradas nesses controles, clique em Add Condition e a condição será adicionada à sequência de consultar:

    anexo

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

  • Após concluir a consultar, clique em Avançar para ir para a tela Destino.

Defina o alvo

Selecione onde você deseja colocar seus dados

O target é o destino dos dados recuperados do Salesforce Query. Selecione um dos seguintes:

  • Um tipo de destino existente no menu suspenso, como Arquivo local, Site FTP, Compartilhamento de arquivos, Armazenamento temporário, Banco de dados, HTTP ou LDAP
  • Clique no botão Selecionar ou Criar novo para selecionar um alvo existente ou para criar um novo alvo do tipo selecionado no momento.

Para obter detalhes sobre os diferentes alvos, consulte a documentação em Alvos.

Destinos de arquivo local

Nota

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

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

  • Especificando um arquivo local como um destino e fornecendo sua localização:

    anexo

  • Clicar em Avançar levará você para a tela Selecionar um formato de arquivo, onde você pode especificar se deseja criar um formato de arquivo com base nos campos da consultar (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:

    anexo

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

    anexo

  • Quando você tiver concluído suas entradas para o alvo, clique em Próximo para passar para a próxima tela.

Selecione um formato de arquivo

  • Depois de especificar o alvo, você precisará especificar o Formato de Arquivo de Alvo. Se você selecionou um alvo de banco de dados em vez de um alvo de arquivo, veja Usando um banco de dados como alvo.

    anexo

  • Selecione um botão de opção para criar um formato de arquivo a partir dos campos da sua consultar, 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 a Selecionar ou Criar Novo no menu suspenso.

  • Clique em Avançar.

Horário e opções

  • Criar ou definir uma programação é opcional e pode ser feito posteriormente. Para mais detalhes sobre programação, veja Criar uma programação.
  • Você pode editar uma programação existente abrindo-a na pasta Programações 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 Duração, esteja ciente de que as datas Início em e Término em em um cronograma são inclusivas.
  • Para exibir essas opções, abra os triângulos de divulgação ao lado de Ocorrência, Frequência diária e Duração.

anexo

  • Quando terminar, clique em Avançar para ir para a tela Resumo.

Tela de resumo

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

anexo

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

Mapeamento de Transformação

Se você escolher Selecionar um formato de arquivo existente (ou criar um novo) na tela Destino do assistente, o mapeamento de transformação aparecerá na sua área de trabalho:

anexo

  • Se você especificou a caixa de seleção Usar Automapper, a maioria ou todos os mapeamentos de campos podem ser concluídos. Conclua qualquer mapeamento manual conforme apropriado.
  • Um mapeamento é mostrado como uma linha entre itens nas colunas Origem (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 tem validade questionável; no entanto, a operação tentará a transformação com esse mapeamento.
  • Você pode completar o mapeamento na aba Transformação arrastando e soltando da Source à esquerda para a Target à direita. Quando você faz isso, e um mapeamento válido é o resultado, um quadrado azul aparecerá à esquerda dos itens Source e Target.
  • Para salvar sua transformação, clique na seta para baixo na faixa de status e selecione Salvar.

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

Consultar Salesforce concluída

  • Após concluir, você será levado para a tela de resumo da nova consulta do Salesforce.
  • Você pode retornar a esta página de resumo encontrando o nome da operação em 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 Implementar o projeto e executar a operação.
  • Opções avançadas incluem opções de operação como fragmentação de dados e truncamento de campo. Elas são abordadas abaixo em Opções avançadas.

anexo

Opções avançadas

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

anexo

Opções de arquivo

  • Gravar como UTF-8: Selecione para gravar o arquivo de destino como codificação de caracteres UTF-8.
  • cabeçalho de destino: Selecione entre Sem cabeçalho, Nomes de campos do Salesforce ou Nomes de campos de formato de arquivo.

Opções de operação

  • Incluir linhas excluídas: Selecione para incluir linhas excluídas na saída da consultar.
  • Tamanho do lote: Por padrão, este é definido como 2000 registros.
  • Política de repetição: Exibe uma caixa de diálogo para definir as políticas de repetição. Veja o Salesforce avançado página.
  • Chunking: Por padrão, o fragmentação de dados não é habilitado para consultas do Salesforce. Ele pode ser habilitado nas opções de operações, conforme descrito em Salesforce advanced página.

Opções de operação adicionais para fragmentação de dados e gravação de registros de sucesso e falha são descritas em Salesforce avançado página.

Implante o projeto e execute a operação

Implantar o projeto

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

Para implantar o projeto:

  • Clique no ícone Implementar na barra de ferramentas; ou

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

  • Clique com o botão direito em Operações** na parte superior do painel Itens do projeto e, em seguida, clique com o botão esquerdo em Implementar no menu suspenso resultante.

O processo de implantar do projeto começa a enviar o projeto para o Harmony e uma mensagem de progresso é exibida.

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

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

A operação agora está concluída e implantada.

Executar a operação

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

anexo

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

    • Se o projeto ainda não tiver sido implantado, ou tiver sido alterado desde a última implantar, ele será implantado automaticamente. Veja Criar uma operação para obter informações adicionais sobre como criar, implantar e executar operações.
    • O Monitor de Operação exibe na parte inferior da tela o rastreamento do status, hora recebida, hora iniciada e hora em que a operação concluiu o processamento.

    • Quando a operação conclui o processamento, o pop-up Result exibe o tempo de conclusão, o status, o número de registros que foram processados com sucesso e o número de registros que falharam no processamento. Os botões Exibir arquivo de sucesso e Exibir arquivo de falha são descritos abaixo.

    • Pressione o botão Test… para testar a operação. Esta opção tem como objetivo testar a operação somente em um ambiente conectado a um Salesforce Sandbox e não deve ser usada em um ambiente de produção. Selecionar Test Insert na página de resumo Salesforce Inserts, por exemplo, processa e insere os primeiros 200 registros no Salesforce Sandbox. Observação: O botão Test… não está disponível na página de resumo Salesforce Bulk Processes.
    • Pressione o botão Result History para exibir uma lista pop-up de atividades recentes, incluindo o tempo concluído, status, o número de registros processados com sucesso e o número de registros que falharam no processamento. Selecione um resultado na lista para habilitar os botões View success file e View failure file, que são descritos abaixo. Observação: O botão Histórico de resultados não está disponível na página de resumo Consultas do Salesforce.
    • Pressione o botão Excluir para excluir a operação do projeto.
    • A janela pop-up Confirm delete é exibida. Clique em Delete para confirmar e excluir a operação.
    • O pop-up 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 no projeto. NOTA: Somente a operação de inserção será 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 obter informações adicionais sobre como criar, implementar e executar operações.

Exibir 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 Exibir arquivo de sucesso e Exibir arquivo de falha ficam disponíveis depois que você pressiona o botão Executar... ou o botão Histórico de resultados conforme descrito acima e, em seguida, seleciona um dos resultados. Este é um exemplo da janela pop-up Histórico de resultados, mostrando os botões e um resultado selecionado:

anexo

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

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

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

    anexo

    • 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 não está disponível no momento.

Nota

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