Ir para o conteúdo

Atualização do conector NetSuite no Jitterbit Design Studio

A atividade de atualização do NetSuite disponível dentro do conector NetSuite permite atualizar registros existentes em uma instância do NetSuite conectada usando o Jitterbit.

Nota

Antes de configurar uma operação de atualização do NetSuite, é necessário ter um endpoint do NetSuite definido. Para mais informações sobre como criar um endpoint, consulte endpoint do conector NetSuite.

Esta página descreve como atualizar registros existentes do NetSuite usando um exemplo de atualização do número de telefone de um registro de cliente existente no NetSuite a partir de dados de origem fornecidos em um arquivo CSV através do Jitterbit.

Exemplo

Para referência, veja o Jitterpak NetSuiteExample.jpk e os arquivos acompanhantes em NetSuiteSampleFiles.zip. Descompacte o NetSuiteSampleFiles.zip no seu drive "C:\", ou se descompactar em outro diretório, certifique-se de editar os diretórios de origem e destino nas operações. Se esta for sua primeira vez usando um Jitterpak, consulte Importando um Jitterpak.

Este exemplo demonstra uma atualização de um registro de cliente que foi criado como exemplo durante o walkthrough de criação do conector NetSuite. Este exemplo é usado apenas para fins de demonstração e não cobre todas as opções disponíveis no produto; consulte Design Studio para uma documentação mais abrangente.

As seções a seguir estão divididas em início da atividade de atualização, definição dos componentes da operação e implantação e execução da operação.

Criando uma operação de atualização do NetSuite

Nota

Se você ainda não está familiarizado com o Jitterbit, veja Começar ou Estúdio de Design para informações detalhadas sobre como usar o produto.

  1. Dentro do seu projeto no Jitterbit Studio, existem várias maneiras de iniciar uma nova atividade de atualização do NetSuite. Cada uma das opções a seguir iniciará o Assistente de Atualização do NetSuite para guiá-lo pelo processo.

    • Vá para Arquivo > Novo > Conectores > Nova Atualização do NetSuite.
    • Na árvore à esquerda, sob Conectores, clique com o botão direito na categoria NetSuite, e selecione Nova Atualização do NetSuite.
    • Na árvore à esquerda, sob Conectores, clique duas vezes na categoria NetSuite, depois clique com o botão direito em Nova Atualização do NetSuite e selecione Nova Atualização do NetSuite.
    • Na barra de ferramentas superior, clique no ícone do conector (peça de quebra-cabeça laranja) attachment. No pop-up, selecione NetSuite, depois selecione Atualização do NetSuite.
  2. A tela Endpoint do Assistente de Atualização do NetSuite deve abrir na visualização principal do Studio. Esta tela solicita que você selecione o endpoint que deseja atualizar os dados existentes. Você já deve ter configurado seu endpoint em endpoint do conector NetSuite. Use o menu suspenso para selecionar o endpoint apropriado. Clique em Próximo quando terminar.

    attachment

  3. A tela Objeto do Assistente de Atualização do NetSuite solicita que você selecione o objeto que deseja atualizar os dados existentes. Neste exemplo, queremos atualizar um registro de cliente existente no NetSuite, então selecionamos o objeto "Cliente" e clicamos em Concluir para continuar.

    Nota

    Se você tiver muitos objetos disponíveis em sua conta do NetSuite, pode ser necessário esperar um momento para que eles carreguem. Você também pode inserir um nome de objeto no campo Filtro ou usar o menu suspenso Objetos a mostrar para limitar os resultados a "Objetos Padrão" ou "Objetos Personalizados". Tente o botão Atualizar se os resultados não forem o que você espera.

    attachment

  4. O Jitterbit irá prosseguir com a criação de uma estrutura de solicitação e resposta da API do NetSuite que permitirá que os dados existentes sejam atualizados dentro da sua conta conectada do NetSuite. Uma nova aba deve aparecer no Studio chamada Atualizações do NetSuite. Você pode renomear sua atividade de atualização aqui, se desejar; no exemplo, a nossa é chamada "Exemplo de Atualização de Cliente do NetSuite." Você também pode usar os botões + - ou setas para expandir todos os elementos dentro de cada estrutura.

    attachment

  5. Em seguida, na mesma tela, clique no botão Criar Operação localizado sob Usar em uma Integração no canto superior direito. Isso criará a operação do Jitterbit que atualizará os dados de clientes existentes no NetSuite.

  6. Uma nova aba deve abrir no Studio chamada Operações, contendo uma representação gráfica da atividade de atualização.

    attachment

    Nota

    Os ícones para Fonte, Solicitação, Resposta e Alvo na imagem acima são marcadores para os componentes da operação, que definiremos na próxima seção.

    Salve sua operação clicando no ícone de disco único para salvar apenas esta operação ou no ícone de disco múltiplo para salvar todas as alterações no seu projeto de integração. Você deve ver o asterisco na aba Operações e o título da operação desaparecerem à medida que sua nova atividade de atualização é criada e salva no seu projeto.

Definindo os componentes da operação

Em seguida, precisamos definir os outros componentes da operação que aparecem na representação gráfica, incluindo Fonte, Solicitação, Resposta e Alvo.

Para cada um, as instruções abaixo orientam você a retornar à representação gráfica da operação que você criou e clicar duas vezes em cada ícone para configurar cada componente. Como alternativa, você também pode criar a Fonte, Solicitação, Resposta e Alvo separadamente e, em seguida, arrastá-los e soltá-los da árvore à esquerda diretamente sobre os ícones na representação visual da sua operação.

Para os propósitos deste guia, fornecemos os seguintes exemplos para referência acima: Jitterpak NetSuiteExample.jpk e arquivos acompanhantes em NetSuiteSampleFiles.zip. Muitos tipos diferentes de dados podem ser usados para cada componente da operação. Para saber mais sobre opções adicionais de personalização, consulte a seção Design Studio de nossa documentação.

  • Fonte: No exemplo, usamos um arquivo CSV como a solicitação de entrada para atualizar o cliente existente com os valores de campo fornecidos abaixo. A tabela a seguir exibe o conteúdo do arquivo de exemplo CustomerUpdateRequest.csv.

    ID Nome Email Telefone Endereço Cidade Estado CEP
    Test Cust 1 Test Customer 1 test1@example.com 1-999-999-9999 1234 Main St. Denver CO 80250

    Nota

    Uma atualização do NetSuite deve sempre incluir (1) um campo ID que mapeia para o ExternalID do cliente no NetSuite, ou (2) o InternalID do registro do cliente no NetSuite. Este exemplo usa o ExternalID criado durante NetSuite connector create. No entanto, se você quiser usar um InternalID, pode encontrá-lo dentro do NetSuite ou dentro do Jitterbit através de uma NetSuite connector search.

    Nota

    O cliente existente foi originalmente criado com um número de telefone de 1-111-111-1111 no exemplo usado para NetSuite connector create. No arquivo de origem para a operação de atualização, incluímos o número de telefone alterado junto com os outros campos originais porque estamos usando a mesma definição de formato de arquivo. No entanto, você poderia omitir os outros campos se quiser criar um novo formato de arquivo apenas com esses campos.

    Nota

    Uma variedade de tipos de fonte está disponível no Jitterbit. Veja Fontes para mais informações.

    Para usar o arquivo CSV, primeiro clique duas vezes no ícone Fonte, em seguida, clique no botão Criar Nova Fonte e dê um Nome à sua fonte (por exemplo, CustomerUpdateRequest.csv). Em seguida, para este exemplo, estamos usando um agente privado com arquivos locais habilitados, e assim selecione um Tipo de "Arquivo Local" e depois Navegar até a localização. Se você estiver usando os arquivos de exemplo, a Pasta é 'C:\NetSuiteSampleFiles' e o Obter Arquivos é 'CustomerUpdateRequest.csv'. Também expandiremos as Opções e definiremos Ignorar Linhas para Primeiro: '1', uma vez que nosso arquivo CSV usa uma linha de cabeçalho.

  • Destino: Clique duas vezes no ícone Destino. No exemplo, registraremos a resposta do NetSuite em um arquivo CSV para fornecer informações sobre sucesso/falha. Clique no botão Criar Novo Destino, dê um Nome ao seu destino (por exemplo, CustomerUpdateResponse.csv) e novamente selecione um Tipo de "Arquivo Local" e Navegar até um local no agente privado onde queremos salvar os dados. No exemplo, a Pasta é 'C:\NetSuiteSampleFiles' e o Nome do Arquivo é 'CustomerUpdateResponse.csv'.

    Nota

    Você também pode exportar para uma variedade de tipos de destino diferentes. O tipo não precisa ser o mesmo que o tipo de fonte. Veja Destinos para opções.

  • Solicitação: Clique duas vezes no ícone Solicitação e selecione Criar Nova Transformação. Isso abrirá o Assistente de Transformação, que o guiará na criação da solicitação.

    Nota

    Informações adicionais sobre estruturas de solicitação estão disponíveis em Transformações.

    1. Na primeira tela, Nome, forneça um Nome para sua transformação ou deixe como padrão. Em seguida, use o menu suspenso Fonte para selecionar o tipo de fonte. Para o exemplo, usamos um arquivo CSV, que é considerado "Texto." Clique em Próximo para continuar.

    2. Na próxima tela, Source, use o dropdown Available File Format Definitions para selecionar a mesma definição de formato de arquivo de origem criada durante a criação do conector NetSuite (ou seja, "Exemplo de Arquivo Plano de Cliente").

      Ou, se você estiver criando do zero, pode selecionar Create New. Isso abrirá opções adicionais para definir um novo formato de arquivo. Forneça um Name para o novo formato de arquivo (no exemplo, chamamos o nosso de "Exemplo de Arquivo Plano de Cliente"). Para criar a definição de texto com base em nosso arquivo CSV existente, selecione Create From File, em seguida, na janela pop-up, navegue até o arquivo local 'CustomerUpdateRequest.csv'.

      Clique em Finish para continuar.

    3. A aba Transformations deve abrir onde você pode completar seu mapeamento. Use o + para expandir os itens de origem e destino em cada árvore. Em seguida, arraste e solte cada campo que você gostaria de mapear de uma árvore para a outra.

      Nota

      Uma atualização do NetSuite deve sempre incluir (1) um campo ID que mapeia para o ExternalID do cliente no NetSuite, ou (2) o InternalID do registro do cliente no NetSuite. Este exemplo usa o ExternalID criado durante a criação do conector NetSuite. Se você estivesse usando o InternalID, você mapearia para o campo internalId do NetSuite.

      Seu mapeamento de transformação deve se parecer com o mostrado abaixo:

      attachment

  • Response: Clique duas vezes no ícone Response e selecione Create New Transformation. Isso abrirá o Transformation Wizard que o guiará na criação da resposta.

    Nota

    Informações adicionais sobre estruturas de resposta são fornecidas em Transformations.

    1. Na primeira tela, Name, forneça um Name para sua transformação ou deixe como o padrão. Em seguida, use o dropdown Target para selecionar o tipo de destino. Para o exemplo, usamos um arquivo CSV, que é considerado "Texto." Clique em Next para continuar.

    2. Na próxima tela, Target, use o dropdown Available File Format Definitions para selecionar a mesma definição de formato de arquivo de destino criada durante NetSuite connector create (ou seja, "Estrutura de Resposta do NetSuite").

      Ou, se você estiver criando do zero, pode selecionar Create New. No exemplo, configuramos uma estrutura de resposta típica que gravará o ID externo, status e mensagem na resposta para que recebamos um feedback caso a operação de atualização falhe. Na primeira tela, defina o Name do novo formato de arquivo (no exemplo, o nosso é chamado de "Estrutura de Resposta do NetSuite"), em seguida, clique no botão para Create Manually. Na próxima tela, clique em New e adicione três novos campos chamados "ExternalID", "Status" e "Message."

      Clique em Finish para continuar.

    3. A aba Transformations deve abrir onde você pode completar seu mapeamento. Use o + para expandir os lados de origem e destino. Neste exemplo, adicionaremos scripts para obter o ID externo no NetSuite para que, se a operação falhar, agora saibamos o ID do registro que falhou para solucionar problemas. Para fazer isso:

      • Arraste e solte o campo "isSuccess" do lado de origem para o novo campo "Status" do lado de destino.

      • Clique duas vezes no campo "ExternalID" do lado de destino para abrir o Formula Builder e adicione as seguintes funções ao script, em seguida, clique em OK.

        <trans>
        FindByPos(SourceInstanceCount(),jbroot$jbrequest$updateList$record#.Customer$externalId)
        </trans>
        

        A função FindByPos encontra a instância nos dados solicitados que corresponde à resposta.

      • Clique duas vezes no campo "Message" do lado de destino para abrir o Formula Builder e adicione as seguintes funções ao script, em seguida, clique em OK.

        <trans>
        SumString(jbroot$jbresponse$updateListResponse$writeResponseList$writeResponse.status$statusDetail#.message$,"|",true)
        </trans>
        

A função SumString irá concatenar um elemento que pode ter mais de uma instância em uma única string.

Nota

Encontre funções de script adicionais para usar durante o mapeamento da sua Transformação ou separadamente como Scripts na seção Construtor de Fórmulas. Além disso, existem várias funções específicas do NetSuite documentadas em Funções do Conector que podem ser usadas para mapeamentos ou scripts mais complexos.

Seu mapeamento de transformação deve se parecer com o mostrado abaixo:

attachment

Implantando e executando a operação

Com a atividade de atualização do NetSuite totalmente configurada, estamos prontos para implantar e executar a operação.

  1. Na aba Operações, clique no ícone de implantar attachment.

  2. Em seguida, clique no ícone de executar attachment para colocar a operação na fila para execução.

  3. Na parte inferior da tela, o Monitor de Operações deve indicar que sua operação foi executada com sucesso. Se não, você pode clicar duas vezes no ícone de Status para visualizar quaisquer mensagens de log.

    attachment

  4. Você também deve ver agora a resposta de saída que foi mapeada para o seu arquivo de destino. No exemplo, o arquivo agora é criado em 'C:\NetSuiteSampleFiles\CustomerUpdateResponse.csv'. Como a operação foi executada com sucesso, vemos o campo ID seguido por um status de '1', indicando sucesso. Se a operação falhasse, veríamos um '0' junto com uma terceira coluna mostrando a mensagem de erro do log.

    ExternalID Status Message
    Test Cust 1 1
  5. Além disso, ao verificar sua conta do NetSuite, você deve encontrar as informações do cliente atualizadas com o novo número de telefone.

    attachment

    Nota

    Você pode encontrar mais informações sobre a chamada da API para o NetSuite no Registro de Uso de Serviços Web disponível no NetSuite em Configuração > Integração > Registro de Uso de Serviços Web. Isso fornece informações detalhadas sobre sucesso/falha, bem como a solicitação e a resposta que foram enviadas para o Jitterbit.