Atividade ServiceMax Upsert no Jitterbit Studio

Introdução

Uma atividade Upsert do ServiceMax tanto atualiza dados existentes quanto insere novos dados no ServiceMax e é destinada a ser usada como um destino para consumir dados em uma operação.

A atividade Upsert requer o uso de um campo de ID externo. Para informações sobre como criar um campo de ID externo no Salesforce, consulte Criar um ID externo do Salesforce para Jitterbit.

A atividade Upsert é usada para atualizar dados se um registro já existe e criar um se não existir. Se preferir apenas inserir novos registros, use uma atividade Insert do ServiceMax, ou se quiser atualizar registros existentes com base no ID do objeto no Salesforce, use uma atividade Update do ServiceMax.

Criar uma atividade ServiceMax Upsert

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

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 Upsert do ServiceMax existente pode ser editada a partir destes locais:

• A tela de design (consulte Menu de ações de componentes em Tela de design).

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

Configurar uma atividade ServiceMax Upsert

Siga estas etapas para configurar uma atividade Upsert do ServiceMax:

• Etapa 1: Inserir um nome, selecionar um objeto e especificar configurações
  Forneça um nome para a atividade e selecione o objeto a ser usado ao fazer upsert de dados.

• Etapa 2: Selecionar o ID externo
  Selecione um campo ServiceMax existente que você deseja que o Harmony use como o ID externo para associar registros.

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

Etapa 1: Inserir um nome, selecionar um objeto e especificar configurações

Nesta etapa, você fornece um nome para a atividade e seleciona o objeto a ser usado ao fazer upsert de dados.

• Menu Endpoint: Se você tiver vários endpoints do mesmo tipo de conector configurados, um menu na parte superior da tela exibe o nome do endpoint atual. Clique no menu para alternar para um endpoint diferente. Para mais informações, consulte Alterar o endpoint atribuído em Telas de configuração.

  • Editar endpoint: Aparece quando você passa o mouse sobre o nome do endpoint atual. Clique para editar a configuração de conexão do endpoint selecionado.

• Nome: Insira um nome para identificar a atividade Upsert do ServiceMax. O nome deve ser único para cada atividade Upsert do ServiceMax e não deve conter barras (/) ou dois-pontos (:).

• Selecionar a Referência do Objeto: Use o menu suspenso para selecionar um objeto padrão ou personalizado do ServiceMax para fazer upsert de dados. 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 atualização para recarregar objetos e campos do endpoint ServiceMax. Isso pode ser útil se você adicionou recentemente objetos ou campos ao Salesforce.

• Configurações Opcionais: Clique para expandir configurações opcionais adicionais.

  • Opções de Operação: Essas opções se aplicam a uma operação na qual uma atividade Upsert do ServiceMax é usada.

    Dica

    Opções adicionais podem ser definidas nas opções de operação de uma operação.

    • Inserir Valores Nulos: Marque a caixa de seleção para permitir que valores nulos sejam inseridos ou atualizados. Se essa opção não estiver selecionada, se um valor sendo mapeado tiver um valor nulo ou estiver em branco (tiver uma string vazia), ele não será processado.

• Salvar e Sair: Se ativado, clique para salvar a configuração desta etapa e fechar 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 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: Selecionar o ID externo

Nesta etapa, você seleciona um campo ServiceMax existente que deseja que o Harmony use como o ID externo para associar registros.

• ID Externo: Use o menu suspenso para selecionar o campo ServiceMax existente que deseja que o Harmony use como o ID externo para associar registros. Para informações sobre como criar um campo de ID externo no Salesforce, consulte Criar um ID externo do Salesforce para Jitterbit.

  Aviso

  O campo usado como ID externo deve ter um valor único para cada registro. Se você tiver vários registros com o mesmo valor de ID externo, uma resposta de erro do ServiceMax será retornada e o upsert falhará para os registros com IDs duplicados.

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

• Descartar alterações: Após fazer 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: Revisar os esquemas de dados

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

• Esquema de Dados: Os esquemas de dados de solicitação e resposta são exibidos. Se a operação usar uma transformação, os esquemas de dados serão exibidos novamente mais tarde durante o processo de mapeamento de dados, onde você pode mapear para campos de destino usando objetos de origem, scripts, variáveis, valores personalizados e muito mais.

  A versão da API do Salesforce que é usada depende da versão do agente Jitterbit que você está usando. Consulte Pré-requisitos e versões de API suportadas para links para 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 no 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 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óximas etapas

Após configurar uma atividade Upsert do ServiceMax, você pode usá-la em 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.

Concluir a operação

Após configurar uma atividade Upsert do ServiceMax, conclua 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 fluxo de trabalho ou em fluxos de trabalho diferentes.

As ações de menu de uma atividade são acessíveis no painel do projeto e na tela de design. Para obter detalhes, consulte Menu de ações da atividade em Noções básicas do conector.

As atividades Upsert do ServiceMax podem ser usadas com estes padrões de operação:

• Padrão de transformação (como o destino)
• Padrão de arquivo de dois destinos (apenas como o primeiro destino)
• Padrão de duas transformações (como o primeiro ou segundo destino)

Uma operação pode conter apenas uma atividade do ServiceMax. A atividade que fornece dados a uma atividade Upsert do ServiceMax pode estar associada a qualquer tipo de endpoint. Se a operação passar a resposta do ServiceMax diretamente para outra atividade de destino, como no padrão de arquivo de dois destinos, essa atividade de destino deve estar associada ao conector API, Banco de dados, Compartilhamento de arquivos, FTP, HTTP, Armazenamento local, Armazenamento temporário ou Variável. No padrão de duas transformações, a resposta do ServiceMax passa por uma segunda transformação antes de chegar à segunda atividade de destino, portanto essa atividade de destino pode estar associada a qualquer tipo de endpoint.

Uma atividade do ServiceMax pode ser usada como uma etapa de operação em apenas uma única operação. Ou seja, você não pode referenciar a mesma atividade várias vezes em outras operações. Em vez disso, você pode fazer uma cópia de uma atividade do ServiceMax para usar em outro lugar (consulte Reutilização de componentes).

Outros padrões não são válidos usando atividades Upsert do ServiceMax. Consulte os padrões de validação na página Validade da operação.

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

As operações que usam atividades do ServiceMax também podem ter ações de 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 uma falha SOAP. Para obter instruções sobre como acionar uma ação em caso de falha 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 depois 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 ServiceMax em um agente privado, os arquivos de sucesso e falha estarão disponíveis para download na página Runtime do Management Console. Selecione a operação relevante na tabela Runtime e clique na guia Activity Logs na seção inferior da tela para exibir os links de download dos arquivos, se disponíveis:

• Download Success File: 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.

• Download Failure File: 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.