Conector NetSuite GetList no Jitterbit Design Studio

A atividade GetList do NetSuite disponível no conector NetSuite permite consultar registros por ID interno ou externo em uma instância do NetSuite conectada usando o Jitterbit.

Esta página descreve como consultar registros existentes do NetSuite por ID usando um exemplo simples com IDs externos fornecidos em um arquivo CSV através do Jitterbit. Isso dá continuidade à demonstração usando registros de exemplo criados e atualizados durante os tutoriais para criação do conector NetSuite, atualização do conector NetSuite e upsert do conector NetSuite.

As seções a seguir estão divididas em iniciar a atividade GetList, definir os componentes da operação e implantar e executar a operação.

Criando uma operação GetList do NetSuite

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

   • Vá para Arquivo > Novo > Conectores > Novo NetSuite GetList.
   • Na árvore à esquerda sob Conectores, clique com o botão direito na categoria NetSuite, e selecione Novo NetSuite GetList.
   • Na árvore à esquerda sob Conectores, clique duas vezes na categoria NetSuite, depois clique com o botão direito em Novo NetSuite GetList e selecione Novo NetSuite GetList.
   • Na barra de ferramentas superior, clique no ícone do conector (peça de quebra-cabeça laranja) . No popup, selecione NetSuite, depois selecione NetSuite GetList.

2. A tela Endpoint do Assistente NetSuite GetList deve abrir na visualização principal do Studio. Esta tela solicita que você selecione o endpoint do qual deseja obter os dados. Você já deve ter configurado seu endpoint em endpoint do conector NetSuite. Use o dropdown para selecionar o endpoint apropriado. Clique em Próximo quando terminar.

3. A tela Objeto do Assistente NetSuite GetList solicita que você selecione o objeto do qual deseja consultar registros. Neste momento, apenas um tipo de objeto pode ser consultado por solicitação. Neste exemplo, queremos consultar registros de clientes existentes 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 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 dropdown 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.

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

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

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

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 GetList é criada e salva no seu projeto.

Definindo os componentes da operação

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

Para fins 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 da nossa documentação.

• Fonte: No exemplo, usamos um arquivo CSV como a solicitação de entrada para consultar registros de clientes existentes por ID. Esses mesmos IDs foram mapeados para o ID Externo do NetSuite durante as operações de criação, atualização e upsert do NetSuite.

  Nota

  O GetList do NetSuite suporta consulta de dados de objeto por ExternalID ou InternalID.

  • ExternalID: Se o ID que você deseja usar para o ExternalID do NetSuite ainda não existir nos registros existentes do NetSuite, você pode realizar uma atualização do conector do NetSuite ou uma operação de upsert do conector do NetSuite para adicioná-lo.
  • InternalID: O InternalID do NetSuite é gerado pelo NetSuite e pode ser obtido do registro dentro do NetSuite. Ele também pode ser consultado a partir de uma operação de busca do conector do NetSuite, bem como desta operação GetList.

  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, CustomerGetListRequest.csv). Em seguida, para este exemplo, estamos usando um agente privado com arquivos locais habilitados e, portanto, selecione um Tipo de "Arquivo Local" e depois Procurar para o local. Se você estiver usando os arquivos de exemplo, a Pasta é 'C:\NetSuiteSampleFiles' e o Obter Arquivos é 'CustomerGetListRequest.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.

  Nota

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

• Alvo: Clique duas vezes no ícone Alvo. No exemplo, gravaremos a resposta do NetSuite em um arquivo XML. Clique no botão Criar Novo Alvo, dê um Nome ao seu alvo (por exemplo, CustomerGetListResponse.xml) e selecione novamente um Tipo de "Arquivo Local" e Navegue até um local no agente privado onde queremos salvar os dados. No exemplo, a Pasta é 'C:\NetSuiteSampleFiles' e o Nome do Arquivo é 'CustomerGetListResponse.xml'.

  Nota

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

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

  Nota

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

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

  2. Na próxima tela, Fonte, use o dropdown Definições de Formato de Arquivo Disponíveis para selecionar Criar Novo. Isso abrirá opções adicionais para definir um novo formato de arquivo. Forneça um Nome para o novo formato de arquivo (no exemplo, chamamos o nosso de "Exemplo de Arquivo Plano de Cliente ID Apenas"). Para criar a definição de texto com base em nosso arquivo CSV existente, selecione Criar a Partir do Arquivo, em seguida, na janela pop-up, navegue até o arquivo local 'CustomerGetListRequest.csv'. Clique em Concluir para continuar.

  3. A aba Transformações deve abrir onde você pode completar seu mapeamento. Use o + para expandir os itens de origem e alvo em cada árvore. Em seguida, arraste e solte cada campo que você gostaria de mapear de uma árvore para a outra. Neste caso, o ID fornecido em nosso arquivo CSV mapeia para o campo 'externalId' no NetSuite.

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

• Resposta: Clique com o botão direito no ícone Resposta e selecione Pass-Through. Isso nos permitirá capturar todos os dados associados aos registros que consultamos.

  Nota

  Neste exemplo, queremos consultar dados do NetSuite e passá-los para um arquivo de saída, ou nosso arquivo XML. Se quiséssemos transformar algum dos dados antes que fosse gerado, poderíamos criar uma nova transformação aqui, semelhante aos outros exemplos fornecidos nas operações de criação, atualização, upsert e pesquisa do NetSuite.

• Scripts Opcionais: Você pode encontrar funções de script adicionais para usar durante seu mapeamento de Transformação ou separadamente como Scripts na seção Construtor de Fórmulas. Para mais informações, consulte conector NetSuite avançado.

Implantando e executando a operação

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

1. Na aba Operações, clique no ícone de implantar .
2. Em seguida, clique no ícone de executar 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 Status para visualizar quaisquer mensagens de log.
4. Você também deve ver agora a resposta de saída que foi passada para seu arquivo de destino. No exemplo, o arquivo agora é criado em 'C:\NetSuiteSampleFiles\CustomerGetListResponse.xml'. O arquivo deve conter todos os dados dos registros de clientes consultados por ID.