Atividade de Consulta em Lote do ServiceMax

Introdução

Uma atividade de Consulta em Lote do ServiceMax, utilizando sua conexão do ServiceMax, consulta um grande número de registros do ServiceMax e é destinada a ser usada como uma fonte para fornecer dados em uma operação.

A atividade de Consulta em Lote deve ser usada apenas se você não precisar usar uma transformação para alterar os dados antes de chegar ao seu destino, uma vez que as atividades em lote do ServiceMax não podem ser usadas com transformações. Se você precisar usar uma transformação, utilize a atividade de Consulta do ServiceMax.

As atividades em lote do ServiceMax utilizam a API em Lote do ServiceMax baseada em SOAP. Para mais informações, consulte Pré-requisitos e versões de API suportadas.

Criar uma Atividade de Consulta em Lote do ServiceMax

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

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

Uma atividade de Consulta em Lote do ServiceMax 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 na aba Componentes do painel do projeto).

Configurar uma atividade de Consulta em Massa do ServiceMax

Siga estas etapas para configurar uma atividade de Consulta em Massa do ServiceMax:

• Etapa 1: Insira um nome e selecione 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 consulta, seja automaticamente selecionando campos e especificando condições, ou manualmente inserindo diretamente uma declaração de consulta.

Etapa 1: Insira um nome e selecione objetos

Nesta etapa, você fornece um nome para a atividade e seleciona o(s) objeto(s) a serem consultados em massa.

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

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

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

  • Visualizar: Use o menu suspenso para filtrar a lista de objetos que suportam Consulta em Massa 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 ServiceMax. Isso é útil se você adicionou recentemente objetos ao ServiceMax que ainda não estão visíveis na lista de Selecionar Objeto(s).

  • 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 do ServiceMax 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, 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.

• Salvar e Sair: Se habilitado, clique para salvar a configuração para esta 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 pede que você confirme que deseja descartar as alterações.

Etapa 2: Selecionar campos e criar condições

Neste passo, você cria a declaração de consulta, seja automaticamente selecionando campos e especificando condições, ou manualmente inserindo diretamente uma declaração de consulta. É necessário testar a consulta para garantir que ela seja válida antes de prosseguir para o próximo passo.

• Selecionar Campos e Criar Condições: Esta seção exibe campos para o(s) objeto(s) selecionado(s) que estão disponíveis no endpoint ServiceMax. Objetos que foram selecionados na etapa anterior são mostrados 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 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: À medida que você seleciona campos, a declaração de 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.

• Copiar: Clique no ícone Copiar configuração da atividade para copiar a configuração existente tanto deste passo quanto do passo 1 para a 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. Ao tentar 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 em Massa do ServiceMax.

• Testar Consulta: Clique neste botão para validar se a consulta é válida. Se a consulta for válida, um exemplo de 10 registros recuperados da consulta é exibido em uma tabela semelhante à mostrada abaixo. A consulta deve ser válida para habilitar o botão Próximo. Se a consulta não for válida, mensagens de erro relevantes são exibidas.

• 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
    >	Maior que
    >=	Maior ou igual
    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
    E	VERDADEIRO se ambas as expressões esquerda e direita forem VERDADEIRAS
    OU	VERDADEIRO se qualquer uma das expressões esquerda ou direita for VERDADEIRA
    NÃO	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 Testar Consulta), 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 E ou OU para considerar as condições adicionais.

• Voltar: Clique para armazenar temporariamente a configuração para esta 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 qualquer etapa. Uma mensagem pede para você confirmar que deseja descartar as alterações.

Próximas etapas

Após configurar uma atividade de Consulta em Massa do ServiceMax, você pode usá-la dentro de uma operação conforme descrito abaixo. Após executar uma operação contendo uma atividade do ServiceMax em um agente privado, você pode baixar os arquivos de sucesso e falha da operação.

Complete a operação

Após configurar uma atividade Bulk Query do ServiceMax, 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 definiçõ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, veja o menu de ações da atividade em Conceitos básicos do conector.

As atividades Bulk Query do ServiceMax podem ser usadas como uma fonte com o padrão de fonte em massa do ServiceMax. Outros padrões não são válidos usando atividades Bulk Query do ServiceMax. Veja os padrões de validação na página de Validade da operação.

Operações que contêm uma atividade do ServiceMax podem ter apenas uma atividade do ServiceMax e não podem conter outras atividades, exceto aquelas associadas aos conectores de API, Banco de Dados, Compartilhamento de Arquivos, FTP, HTTP, Armazenamento Local, Armazenamento Temporário ou Variável.

Uma atividade do ServiceMax pode ser usada como uma etapa da 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 ServiceMax para usar em outro lugar (veja Reutilização de componentes).

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

• Base64
• Booleano
• Formatos de data
• Double
• Inteiro
• ID do Salesforce
• String

Operações que utilizam atividades do ServiceMax 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 um 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 contendo uma atividade do ServiceMax 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 para os 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.

Os downloads do registro de atividades estão desativados para agentes em nuvem. Se os links estiverem visíveis, você receberá uma mensagem de erro se tentar fazer um download.