GetList do Conector NetSuite¶

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

Esta página descreve como consultar registros NetSuite existentes por ID usando um exemplo simples com IDs externos fornecidos em um arquivo CSV por meio do Jitterbit. Isso continua a demonstração usando registros de exemplo criados e atualizados durante as orientações para NetSuite Connector Create, Atualização do conector NetSuite e Inserção do conector NetSuite.

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

Criando uma Operação NetSuite GetList¶

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 NetSuite GetList Wizard para guiá-lo durante o processo.

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

2. A tela Endpoint do NetSuite GetList Wizard deverá abrir na visualização principal do Studio. Esta tela pede para selecionar o endpoint do qual você gostaria de obter os dados. Você já deve ter configurado seu endpoint em NetSuite Connector Endpoint. Use o menu suspenso para selecionar o endpoint apropriado. Clique em Avançar quando terminar.

3. A tela Object do NetSuite GetList Wizard solicita que você selecione o objeto do qual deseja consultar os 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 aguardar um momento para que eles sejam carregados. Você também pode inserir um nome de objeto no campo Filtro ou usar o menu suspenso Objetos para mostrar para limitar os resultados a "Objetos padrão" ou "Objetos personalizados". Experimente o botão Atualizar se os resultados não forem os esperados.

   

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

5. 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 Jitterbit que consultar os dados existentes do cliente no NetSuite.

6. Uma nova aba deverá abrir no Studio chamada Operations, contendo uma representação gráfica da atividade GetList.

   Nota

   Os ícones de Origem, Solicitação, Resposta e Destino na imagem acima são espaços reservados 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 vários discos para salvar todas as alterações em seu projeto de integração. Você deverá ver o asterisco na aba Operações e o título da operação desaparecer à medida que sua nova atividade GetList for criada e salva em 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 Origem, Solicitação, Resposta e Destino.

Para fins deste passo a passo, 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 o Design Studio seção de nossa documentação.

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

  Nota

  NetSuite GetList suporta consultar de dados de objetos por ExternalID ou InternalID.

  • ExternalID: Se o ID que você deseja usar para o NetSuite ExternalID ainda não existe nos registros existentes do NetSuite, você pode realizar uma Atualização do NetSuite Connector ou Inserção do conector NetSuite operação para adicioná-lo.
  • InternalID: O NetSuite InternalID é gerado pelo NetSuite e pode ser obtido no registro dentro do NetSuite. Também pode ser consultado em uma Pesquisa do Conector NetSuite, bem como esta operação GetList.

  Para usar o arquivo CSV, primeiro clique duas vezes no ícone Fonte, depois clique no botão Criar Nova Fonte e dê um Nome à sua fonte (por exemplo, CustomerGetListRequest.csv). A seguir, para este exemplo, estamos usando um Agente Privado com arquivos locais habilitados e, portanto, selecione um Tipo de "Arquivo Local" e, em seguida, Procurar até o local. Se você estiver usando os arquivos de exemplo, Folder será 'C:\NetSuiteSampleFiles' e Get Files será 'CustomerGetListRequest.csv'. Também expandiremos Options e definiremos Ignore Lines como First: '1' já que nosso arquivo CSV usa uma linha de cabeçalho.

  Nota

  Uma variedade de tipos de fontes estão disponíveis no Jitterbit. Veja Fontes para mais.

• Alvo: Clique duas vezes no ícone Alvo. No exemplo, registraremos a resposta do NetSuite em um arquivo XML. Clique no botão Criar novo destino, dê um Nome ao seu destino (por exemplo, CustomerGetListResponse.xml) e selecione novamente um Tipo de "Arquivo local" e Procurar até um local no Agente Privado onde queremos salvar os dados. No exemplo, Folder é 'C:\NetSuiteSampleFiles' e Filename é 'CustomerGetListResponse.xml'.

  Nota

  Você também pode enviar para uma variedade de tipos de destino diferentes. O tipo não precisa ser igual ao tipo de origem. Consulte Metas 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 orientará você na criação da solicitação.

  Nota

  Informações adicionais sobre estruturas de solicitação são fornecidas 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, Fonte, use o menu suspenso 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 ID de arquivo simples do cliente"). Para criar a definição de texto com base em nosso arquivo CSV existente, selecione Criar do arquivo e, no 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 destino em cada árvore. Em seguida, arraste e solte cada campo que deseja mapear de uma árvore para outra. Nesse caso, o ID fornecido em nosso arquivo CSV é mapeado para o campo ‘externalId’ em NetSuite.

     Seu mapeamento de transformação deve ser semelhante ao mostrado abaixo:

• Resposta: Clique com o botão direito no ícone Resposta e selecione Passagem. 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 qualquer um dos dados antes de serem gerados, poderíamos criar uma nova transformação aqui, semelhante aos outros exemplos fornecidos no NetSuite create, atualizar, inserir e pesquisar operações.

• Scripts opcionais: Você pode encontrar funções de script adicionais para usar durante sua Transformação mapeamento ou separadamente como Scripts no Formula Builder seção. Para obter informações adicionais, consulte NetSuite Connector Avançado.

Implantando e Executando a Operação¶

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

1. Na aba Operações, clique em implantar ícone.
2. Em seguida, clique em executar ícone para colocar a operação na fila para execução.
3. Na parte inferior da tela, o Monitor de operação deverá indicar que sua operação foi executada com sucesso. Caso contrário, você pode clicar duas vezes no ícone Status para visualizar quaisquer mensagens de registro.
4. Agora você também deve ver a resposta de saída que foi transmitida ao seu arquivo de destino. No exemplo, o arquivo agora é criado em 'C:\NetSuiteSampleFiles\CustomerGetListResponse.xml'. O arquivo deve conter todos os dados dos registros do cliente consultados por ID.