NetSuite

O conector do NetSuite permite executar operações de inserção, exclusão, atualização e leitura dos dados do NetSuite.

Antes de começar

Antes de usar o conector do NetSuite, execute as seguintes tarefas:

• No seu projeto do Google Cloud, faça o seguinte:
  • Conceda o papel do IAM roles/connectors.admin ao usuário que estiver configurando o conector.
  • Conceda os seguintes papéis de IAM à conta de serviço que você quer usar para o conector:
    • roles/secretmanager.viewer
    • roles/secretmanager.secretAccessor

    Uma conta de serviço é um tipo especial de Conta do Google destinada a representar um usuário não humano que precisa ser autenticado e autorizado a acessar dados nas APIs do Google. Se você não tiver uma conta de serviço, será necessário criar uma. Para mais informações, consulte Como criar uma conta de serviço.

  • Ative os seguintes serviços:
    • secretmanager.googleapis.com (API Secret Manager)
    • connectors.googleapis.com (API Connectors)

    Para entender como ativar os serviços, consulte Como ativar serviços.

  Se esses serviços ou permissões não tiverem sido ativados no seu projeto, você precisará ativá-los ao configurar o conector.

Configurar o conector

Para configurar o conector, crie uma conexão com a fonte de dados (sistema de back-end). Uma conexão é específica a uma fonte de dados. Isso significa que, se você tiver muitas fontes de dados, precisará criar uma conexão separada para cada uma. Para criar uma conexão, siga estas etapas:

1. No console do Cloud, acesse a página Integration Connectors > Conexões e selecione ou crie um projeto do Google Cloud.

   Acessar a página "Conexões"

2. Clique em + Criar novo para abrir a página Criar conexão.
3. Na seção Local, escolha o local da conexão.
   1. Região: selecione um local na lista suspensa.

      Veja abaixo as regiões com suporte com o conector:

      Para acessar a lista de todas as regiões com suporte, consulte Locais.

   2. Clique em Próxima.
4. Na seção Detalhes da conexão, faça o seguinte:
   1. Conector: selecione Netsuite na lista suspensa de conectores disponíveis.
   2. Versão do conector: selecione a versão do conector na lista suspensa de versões disponíveis.
   3. No campo Nome da conexão, insira um nome para a instância de conexão

      Os nomes de conexão precisam atender aos seguintes critérios:

      • Os nomes de conexões podem usar letras, números ou hifens.
      • As letras precisam ser minúsculas.
      • Os nomes das conexões precisam começar com uma letra e terminar com uma letra ou um número.
      • Os nomes das conexões não podem exceder 63 caracteres.
   4. Como opção, insira uma Descrição para a instância de conexão.
   5. Conta de serviço: selecione uma conta de serviço que tenha os papéis necessários.
   6. Opcionalmente, defina as Configurações do nó de conexão:
      • Número mínimo de nós: digite o número mínimo de nós de conexão.
      • Número máximo de nós: digite o número máximo de nós de conexão.

      Um nó é uma unidade (ou réplica) de uma conexão que processa transações. Mais nós são necessários para processar mais transações para uma conexão e, por outro lado, menos nós são necessários para processar menos transações. Para entender como os nós afetam os preços do conector, consulte Preços dos nós de conexão. Se você não inserir qualquer valor, por padrão, os nós mínimos serão definidos como 2 (para melhor disponibilidade) e os nós máximos serão definidos como 50.

   Observação: você só poderá personalizar os valores do nó de conexão se for um cliente de pagamento por utilização.
   7. ID da conta: a conta corporativa à qual seu nome de usuário está associado no NetSuite.
   8. Modo de coluna agregada: indica como as colunas agregadas precisam ser tratadas.
   9. ID do aplicativo: a partir da versão 2020.1, as solicitações para o NetSuite exigem um ID do aplicativo.
   10. Permissões de campos personalizados: é uma lista separada por vírgulas de permissões de campos personalizados. Oferece mais controle do que includeCustomFieldColumns .
   11. Incluir tabelas filhas: um booleano que indica se as tabelas filhas devem ser exibidas.
   12. Incluir colunas de campo personalizado: um booleano que indica se você quer incluir colunas de campos personalizados.
   13. Incluir tabelas de lista personalizadas: um booleano que indica se você quer usar tabelas com base em listas personalizadas.
   14. Incluir tabelas de registros personalizados: um booleano que indica se você quer usar tabelas com base em tipos de registros personalizados.
   15. Incluir colunas de referência: uma lista separada por vírgulas que representa as colunas a serem incluídas ao recuperar dados de um campo que representa uma referência de registro.
   16. Máximo de sessões simultâneas: o número máximo de sessões simultâneas disponíveis para uso na conexão.
   17. Formato de data líquida do pacote: o formato de data preferencial definido na interface do NetSuite.
   18. Formato de data longa líquida do pacote: o formato de data longo preferido definido na interface do NetSuite.
   19. Pasta de metadados do Netsuite: um caminho para um diretório onde será feito o download dos arquivos de metadados do NetSuite. Defina essa opção para melhorar o desempenho.
   20. Relatório dobra como decimal: indica se duplicações devem ser informadas como decimais.
   21. Solicitar transações memorizadas: é um booleano que indica se você quer solicitar transações memorizadas ao recuperar transações do NetSuite.
   22. ID do papel: o RoleId é o InternalId do papel que será usado para fazer login no NetSuite. Deixe o campo em branco para usar a função padrão do usuário.
   23. Esquema: o tipo de esquema a ser usado. Você pode selecionar qualquer um destes valores:
       • SuiteTalk: para conectividade baseada em SOAP.
       • SuiteSQL: para conectividade baseada em REST.
   24. Use Async Services: um booleano que indica se você quer usar serviços assíncronos ao inserir, atualizar e excluir.
   25. Usar nomes internos para personalizações: um booleano que indica se você quer usar nomes internos para personalizações.
   26. Use Upserts: um booleano que indica se você quer fazer um upsert quando uma operação de inserção for usada.
   27. Compensação de fuso horário do usuário: a diferença de fuso horário do usuário, conforme definido nas preferências do NetSuite em Início -> Preferências -> Fuso horário. Por exemplo: EST.
   28. Profundidade da verificação de linhas: o número de linhas a serem verificadas ao determinar dinamicamente as colunas da tabela.
   29. Usar proxy: marque esta caixa de seleção para configurar um servidor proxy para a conexão e defina os seguintes valores:
   • Esquema de autenticação de proxy: selecione o tipo de autenticação para autenticar com o servidor proxy. Há compatibilidade com os seguintes tipos de autenticação:
     • Básico: autenticação HTTP básica.
     • Resumo: autenticação HTTP de resumo.
   • Usuário proxy: um nome de usuário a ser usado para autenticar com o servidor proxy.
   • Senha de proxy: a chave secreta do Secret Manager da senha do usuário.
   • Tipo de SSL de proxy: o tipo de SSL a ser usado para se conectar ao servidor proxy. Há compatibilidade com os seguintes tipos de autenticação:
     • Automático: configuração padrão. Se o URL for HTTPS, a opção Túnel será usada. Se o URL for HTTP, a opção NUNCA será usada.
     • Sempre: a conexão será sempre com SSL ativado.
     • Nunca: a conexão não está com SSL ativado.
     • Túnel: a conexão é feita por um proxy de encapsulamento. O servidor proxy abre uma conexão com o host remoto e o tráfego flui de ida e volta pelo proxy.
   • Na seção Servidor proxy, insira os detalhes do servidor proxy.
     1. Clique em + Adicionar destino.
     2. Selecione um Tipo de destino.
        • Endereço do host: especifique o nome do host ou o endereço IP do destino.

          Se quiser estabelecer uma conexão privada com seu sistema de back-end, faça o seguinte:

          • Crie um anexo do serviço PSC.
          • Crie um anexo de endpoint e insira os detalhes dele no campo Endereço do host.
   30. Também é possível clicar em + Adicionar rótulo para adicionar um rótulo à conexão na forma de um par de chave-valor.
   31. Clique em Próxima.
5. Na seção Destinos, insira os detalhes do host remoto (sistema de back-end) ao qual você quer se conectar.
   1. Tipo de destino: é possível especificar os detalhes de destino como endereço de host ou anexo de serviço. Selecione um dos tipos de destino a seguir:
      • Endereço do host: se você quiser especificar o nome do host ou o endereço IP do destino.
      • Anexo de serviço: se você quiser especificar o endpoint particular para seus endereços IP internos. O anexo de serviço permite ocultar seus endereços IP internos da rede externa. É possível criar um anexo de serviço no Google Cloud usando o recurso Private Service Connect. Para informações sobre como configurar um Private Service Connect, consulte Publicar serviços gerenciados.

      Com base no tipo de destino selecionado, insira o endereço do host ou o nome do anexo do serviço.

      Para inserir outros destinos, clique em +Adicionar destino.

   2. Clique em Próxima.
6. Na seção Autenticação, insira os detalhes da autenticação.
   1. Selecione um Tipo de autenticação e insira os detalhes relevantes.

      Os seguintes tipos de autenticação são compatíveis com a conexão Netsuite:

      • Nome de usuário e senha
      • Autenticação com base em token
      • Concessão de código de autenticação OAuth 2.0

   Para entender como configurar esses tipos de autenticação, consulte Configurar autenticação.

   2. Clique em Próxima.
7. Revisão: revise os detalhes de conexão e autenticação.
8. Clique em Criar.

Configurar a autenticação

Digite os detalhes com base na autenticação que você quer usar.

• Nome de usuário e senha

  Autenticação de nome de usuário e senha. Válido apenas para o Netsuite 2020.2 ou anterior.

  • Nome de usuário: nome de usuário para o conector
  • Senha: a senha do Secret Manager que contém a senha associada ao conector.

• Autenticação baseada em token

  Autenticação baseada em token para Netsuite. Isso pode ser usado para esquemas SuiteTalk e SuiteQL.

  • ID do cliente OAuth: a chave do cliente exibida quando o aplicativo foi criado.
  • Chave secreta do cliente OAuth: é a chave secreta do Secret Manager que contém a chave secreta do cliente exibida quando o aplicativo foi criado.
  • Token de acesso do OAuth: o ID do token quando o token de acesso foi criado.
  • Chave secreta do token de acesso OAuth: a chave secreta do Secret Manager que contém o secret do token quando o token de acesso foi criado.

• Código de autorização OAuth 2.0

A autorização da conexão é feita com um fluxo de login do usuário baseado na Web. Isso é válido apenas para o esquema SuiteQL.

• ID do cliente: o ID usado para solicitar tokens de acesso.
• Escopos: uma lista separada por vírgulas dos escopos necessários.
• Chave secreta do cliente: usada para solicitar tokens de acesso.

Para o tipo de autenticação Authorization code, depois de criar a conexão, realize mais algumas etapas para configurá-la. Para mais informações, consulte Outras etapas após a criação da conexão.

Observação:se você estiver usando o tipo de autenticação Authorization code e tiver feito mudanças de configuração no aplicativo externo, será necessário autorizar a conexão HTTP novamente. Para entender como fazer isso, consulte Reautorização para o código de autorização.

Etapas adicionais após a criação da conexão

Se você selecionou OAuth 2.0 - Authorization code para autenticação, siga estas outras etapas depois de criar a conexão:

1. Na página Conexões, localize a conexão recém-criada.

   O Status do novo conector será Autorização necessária.

2. Clique em Autorização necessária.

   O painel Editar autorização será exibido.

3. Copie o valor de Redirect URI no seu aplicativo externo.
4. Verifique os detalhes da autorização.
5. Clique em Autorizar.

   Se a autorização for bem-sucedida, o status da conexão será definido como Ativo na página Conexões.

Reautorização para o código de autorização

Se você estiver usando o tipo de autenticação Authorization code e tiver feito alterações de configuração no aplicativo NetSuite de back-end, será necessário autorizar novamente a conexão NetSuite. Para autorizar uma conexão novamente, siga estas etapas:

1. Clique na conexão necessária na página Conexões.

   A página de detalhes da conexão será aberta.

2. Clique em Editar para editar os detalhes da conexão.
3. Verifique os detalhes de OAuth 2.0 - Código de autorização na seção Autenticação.

   Se necessário, faça as alterações necessárias.

4. Clique em Salvar. Isso leva você à página de detalhes da conexão.
5. Clique em Editar autorização na seção Autenticação. Isso mostra o painel Autorizar.
6. Clique em Autorizar.

   Se a autorização for bem-sucedida, o status da conexão será definido como Ativo na página Conexões.

Entidades, operações e ações

Todos os Integration Connectors fornecem uma camada de abstração para os objetos do aplicativo conectado. Só é possível acessar os objetos de um aplicativo por esta abstração. A abstração é exposta a você como entidades, operações e ações.

Observação:você pode ver as entidades, as operações e as ações de um conector na tarefa de conectores.

• Entidade: uma entidade pode ser considerada um objeto ou um conjunto de propriedades no aplicativo ou serviço conectado. A definição de uma entidade difere de um conector para outro. Por exemplo, em um conector de banco de dados, as tabelas são as entidades, em um conector de servidor de arquivos, as pastas são as entidades e, em um conector de sistema de mensagens, as filas são as entidades.

  No entanto, é possível que um conector não aceite ou não tenha entidades. Nesse caso, a lista Entities estará vazia.

• Operação: uma operação é a atividade que pode ser realizada em uma entidade. É possível executar qualquer uma das seguintes operações em uma entidade:
  • List
  • Receber
  • Criação
  • Atualizar
  • Excluir

  Selecionar uma entidade na lista disponível gera uma lista de operações disponíveis para ela. Para uma descrição detalhada das operações, consulte as operações de entidades da tarefa "Conectores". No entanto, se um conector não for compatível com nenhuma das operações da entidade, essas operações sem suporte não serão incluídas na lista de Operations.

• Ação: uma ação é uma função de primeira classe disponibilizada para a integração por meio da interface do conector. Uma ação permite fazer alterações em uma ou mais entidades e varia de um conector para outro. Normalmente, uma ação tem alguns parâmetros de entrada e de saída. No entanto, é possível que o conector não ofereça suporte a nenhuma ação. Nesse caso, a lista Actions estará vazia.

Observação : todas as entidades e ações terão um esquema associado a elas. Por exemplo, um esquema de ação terá os detalhes do parâmetro, como os nomes dos parâmetros e o tipo de dados correspondente. O esquema (metadados) de entidades e ações é buscado pela conexão no tempo de execução do back-end. Se houver atualizações no esquema, elas não serão refletidas automaticamente nas conexões atuais. Será necessário atualizar o esquema manualmente. Para atualizar o esquema de uma conexão, abra a página Detalhes da conexão e clique em Atualizar esquema de conexão.

Limitações do sistema

O conector do Netsuite pode processar uma transação por segundo, por nó, e limitar as transações acima desse limite. Por padrão, o Integration Connectors aloca dois nós para melhor disponibilidade para uma conexão.

Para informações sobre os limites aplicáveis aos Integration Connectors, consulte Limites.

Observação:o número de nós do Integration Connectors será escalonado automaticamente de maneira dinâmica com base no seu uso. No entanto, se você quiser reservar capacidade para grandes volumes sem esperar pelo escalonamento automático, ajuste o valor mínimo do nó para uma conexão. Mais nós são necessários para processar mais transações para uma conexão. Por outro lado, menos nós são necessários se uma conexão processa menos transações. Para configurar os valores do nó, faça o seguinte:

• Se você for um cliente com pagamento por utilização, configure o valor mínimo e máximo do nó na página de edição de conexão.
• Se você for um cliente com base em assinatura, entre em contato com o suporte.

O número máximo de transações que um nó pode processar depende de vários fatores. Portanto, antes de ajustar os nós mínimos para melhorar a capacidade, verifique se os sistemas de back-end estão configurados de maneira ideal para lidar com o tráfego necessário.

Exemplos de operações de entidade

Esta seção mostra como executar algumas das operações de entidade neste conector.

Exemplo: listar todas as notas de crédito

Este exemplo lista todas as notas de crédito na entidade CreditMemo.

1. Na caixa de diálogo Configure connector task, clique em Entities.
2. Selecione CreditMemo na lista Entity.
3. Selecione a operação List e clique em Concluído.
4. Opcionalmente, na seção Entrada de tarefa da tarefa Conectores, é possível filtrar o conjunto de resultados especificando uma cláusula de filtro. Especifique o valor da cláusula de filtro sempre entre aspas simples (').

Exemplo: acessar um registro de nota de crédito

Este exemplo recebe um registro com o ID especificado da entidade CreditMemo.

1. Na caixa de diálogo Configure connector task, clique em Entities.
2. Selecione CreditMemo na lista Entity.
3. Selecione a operação Get e clique em Concluído.
4. Na seção Entrada da tarefa da tarefa Conectores, clique em IdEntidade e insira 1083723 no campo Valor padrão.

   Aqui, 1083723 é um ID de registro exclusivo na entidade CreditMemo.

Exemplo: criar um registro de cliente

Este exemplo cria um registro na entidade Customer.

1. Na caixa de diálogo Configure connector task, clique em Entities.
2. Selecione Customer na lista Entity.
3. Selecione a operação Create e clique em Concluído.
4. Na seção Entrada da tarefa da tarefa Conectores, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Default Value:

   {
   "CompanyName": "Test1",
   "Email": "[e-mail]"
   }

   Se a integração for bem-sucedida, o campo connectorOutputPayload da tarefa do conector terá um valor semelhante ao seguinte:

   [{
   "InternalId": "4767"
   }]

Exemplo: atualizar um pedido de vendas

Este exemplo atualiza um registro na entidade SalesOrder.

1. Na caixa de diálogo Configure connector task, clique em Entities.
2. Selecione SalesOrder na lista Entity.
3. Selecione a operação Update e clique em Concluído.
4. Na seção Entrada da tarefa da tarefa Conectores, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Default Value:

   {
   "Email": "[e-mail]",
   "Entity_InternalId": "1709",
   "Item_InternalId": "945"
    }

5. Clique em entityId e insira 1086949 no campo Valor padrão.

   Se a integração for bem-sucedida, o campo connectorOutputPayload da tarefa do conector terá um valor semelhante ao seguinte:

   [{
   "InternalId": "1086949"
   }]

Usar o Terraform para criar conexões

É possível usar o recurso do Terraform para criar uma nova conexão.

Para saber como aplicar ou remover uma configuração do Terraform, consulte Comandos básicos do Terraform.

Para conferir um exemplo de modelo do Terraform para a criação de conexões, consulte Exemplo de modelo.

Ao criar essa conexão usando o Terraform, você precisa definir as seguintes variáveis no arquivo de configuração do Terraform:

Nome do parâmetro	Tipo de dados	Obrigatório	Descrição
account_id	STRING	Verdadeiro	A conta corporativa à qual seu nome de usuário está associado no NetSuite.
aggregate_column_mode	STRING	Falso	Indicar como as colunas agregadas precisam ser tratadas.
application_id	STRING	Falso	A partir da versão 2020.1, as solicitações para o NetSuite exigem um ID do aplicativo.
custom_field_permissions	STRING	Falso	Uma lista separada por vírgulas de permissões de campos personalizados. Oferece mais controle do que includeCustomFieldColumns .
include_child_tables	BOOLEAN	Falso	Um booleano que indica se as tabelas filho precisam ser exibidas.
include_custom_field_columns	BOOLEAN	Falso	Um booleano que indica se você quer incluir colunas de campos personalizados.
include_custom_list_tables	BOOLEAN	Falso	Um booleano que indica se você quer usar tabelas com base em listas personalizadas.
include_custom_record_tables	BOOLEAN	Falso	Um booleano que indica se você quer usar tabelas com base em tipos de registro personalizados.
include_reference_columns	STRING	Falso	Uma lista separada por vírgulas que representa as colunas a serem incluídas ao recuperar dados de um campo que representa uma referência de registro.
maximum_concurrent_sessions	INTEGER	Falso	O número máximo de sessões simultâneas disponíveis para uso na conexão.
net_suite_date_format	STRING	Falso	O formato de data preferencial definido na interface do NetSuite.
net_suite_long_date_format	STRING	Falso	O formato de data longa preferido definido na interface do NetSuite.
netsuite_metadata_folder	STRING	Falso	Um caminho para um diretório para fazer o download de arquivos de metadados do NetSuite. Defina essa opção para melhorar o desempenho.
report_doubles_as_decimal	BOOLEAN	Falso	Indica se os valores duplos devem ser informados como decimais.
request_memorized_transactions	BOOLEAN	Falso	Um booleano que indica se você quer solicitar transações memorizadas ao recuperar transações do NetSuite.
role_id	STRING	Falso	RoleId é o InternalId do papel que será usado para fazer login no NetSuite. Deixe o campo em branco para usar a função padrão do usuário.
schema	STRING	Verdadeiro	O tipo de esquema a ser usado.
use_async_services	BOOLEAN	Falso	Um booleano que indica se você gostaria de usar serviços assíncronos ao inserir, atualizar e excluir.
use_internal_names_for_customizations	BOOLEAN	Falso	Um booleano que indica se você quer usar nomes internos para personalizações.
use_upserts	BOOLEAN	Falso	Um booleano que indica se você quer fazer uma inserção quando uma operação de inserção é usada.
user_timezone_offset	STRING	Falso	O deslocamento do fuso horário do usuário, conforme definido nas preferências do NetSuite em Início --> Preferências --> Fuso horário. Por exemplo: EST.
row_scan_depth	STRING	Falso	O número de linhas a serem verificadas ao determinar dinamicamente as colunas da tabela.
nível de detalhes	STRING	Falso	O nível de detalhes da conexão varia de 1 a 5. O nível de detalhes mais alto registrará todos os detalhes da comunicação (solicitação,resposta e certificados SSL).
proxy_enabled	BOOLEAN	Falso	Marque esta caixa de seleção para configurar um servidor proxy para a conexão.
proxy_auth_scheme	ENUM	Falso	O tipo de autenticação a ser usado para autenticar o proxy do ProxyServer. Os valores aceitos são: BASIC, DIGEST, NONE
proxy_user	STRING	Falso	Um nome de usuário a ser usado para autenticar o proxy do ProxyServer.
proxy_password	SECRET	Falso	Uma senha a ser usada para autenticação no proxy ProxyServer.
proxy_ssltype	ENUM	Falso	O tipo de SSL a ser usado na conexão com o proxy ProxyServer. Os valores aceitos são: AUTO, ALWAYS, NEVER, TUNNEL

Usar a conexão do NetSuite em uma integração

Depois que você cria a conexão, ela fica disponível na Apigee Integration e no Application Integration. É possível usar a conexão em uma integração por meio da tarefa "Conectores".

• Para entender como criar e usar a tarefa "Conectores" na integração da Apigee, consulte a Tarefa "Conectores".
• Para entender como criar e usar a tarefa Conectores no Application Integration, consulte Tarefa Conectores.

Receber ajuda da comunidade do Google Cloud

Poste suas dúvidas e converse sobre esse conector na comunidade do Google Cloud em Fóruns do Cloud.

A seguir

• Entenda como suspender e retomar uma conexão.
• Entenda como monitorar o uso do conector.
• Saiba como acessar os registros do conector.