NetSuite

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

Antes de começar

Antes de usar o conector do NetSuite, faça 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:

No console do Cloud, acesse a página Integration Connectors > Conexões e selecione ou crie um projeto do Google Cloud.
Acesse a página "Conexões"
Clique em + Criar novo para abrir a página Criar conexão.
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.
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.
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 devem 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 campo personalizado: uma lista de permissões de campo personalizado separada por vírgulas. Oferece mais controle do queIncludeCustomFieldColumns .
11. Incluir tabelas filhas: um booleano que indica se as tabelas filhas devem ser exibidas.
12. Incluir colunas de campos personalizados: um booleano que indica se você quer incluir colunas de campos personalizados.
13. Incluir tabelas de listas 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 registro 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 do Net Suite: o formato de data preferido definido na interface do NetSuite.
18. Formato de data longa do Net Suite: o formato de data longa preferido definido na interface do NetSuite.
19. Pasta de metadados do Netsuite: um caminho para um diretório para fazer o download de arquivos de metadados do NetSuite. Defina essa opção para melhorar o desempenho.
20. Relatório duplos como decimais: indica se os valores duplos devem ser informados 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 InternalId do papel que será usado para fazer login no NetSuite. Deixe em branco para usar a função padrão do usuário.
23. Esquema: o tipo de esquema a ser usado. É possível selecionar qualquer um destes valores:
  - SuiteTalk: para conectividade baseada em SOAP.
  - SuiteSQL: para conectividade baseada em REST.
24. Usar serviços assíncronos: um booleano que indica se você quer usar serviços assíncronos ao inserir, atualizar e excluir.
25. Use nomes internos para personalizações: um booleano que indica se você quer usar nomes internos para personalizações.
26. Usar upsert: um booleano que indica se você quer fazer uma inserção quando uma operação de inserção for usada.
27. Diferença de fuso horário do usuário: o deslocamento do fuso horário do usuário, conforme definido nas preferências do NetSuite em Página inicial --> Preferências --> Fuso horário. Por exemplo: EST.
28. Profundidade da verificação da linha: 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:
30. Também é possível clicar em + Adicionar rótulo para incluir um rótulo na conexão na forma de um par de chave-valor.
31. Clique em Próxima.
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 mais destinos, clique em +Adicionar destino.
2. Clique em Próxima.
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 do Netsuite:
  - Nome de usuário e senha
  - Autenticação baseada em token
  - Concessão de código de autenticação do OAuth 2.0
2. Clique em Próxima.
Revisão: revise os detalhes de conexão e autenticação.
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 do Secret Manager que contém a chave secreta do cliente exibida quando o aplicativo foi criado.
- Token de acesso OAuth: o ID do token quando o token de acesso foi criado.
- Chave secreta do token de acesso do OAuth: o secret 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 de 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 do cliente usado para solicitar tokens de acesso.
Scopes: uma lista separada por vírgulas dos escopos obrigató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, execute mais algumas etapas para configurar a autenticação. Para mais informações, consulte Etapas adicionais após a criação da conexão.

Observação:se você estiver usando o tipo de autenticação Authorization code e tiver feito alterações na configuração no seu aplicativo externo, será preciso autorizar novamente a conexão HTTP. 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 etapas extras depois de criar a conexão:

Na página Conexões, localize a conexão recém-criada.
O Status do novo conector será Autorização necessária.
Clique em Autorização necessária.
O painel Editar autorização vai aparecer.
Copie o valor do URI de redirecionamento no seu aplicativo externo.
Verifique os detalhes da autorização.
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 na configuração no seu aplicativo de back-end NetSuite, autorize sua conexão NetSuite novamente. Para autorizar novamente uma conexão, siga estas etapas:

Clique na conexão necessária na página Conexões.
A página de detalhes da conexão será aberta.
Clique em Edit para editar os detalhes da conexão.
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.
Clique em Salvar. Isso leva você à página de detalhes da conexão.
Clique em Editar autorização na seção Autenticação. O painel Autorizar será exibido.
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.

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
- Criar
- 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 oferecer suporte a nenhuma das operações da entidade, essas operações não serão listadas na lista 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. No entanto, é possível que o conector não ofereça suporte a nenhuma ação. Nesse caso, a lista Actions estará vazia.

Limitações do sistema

O conector do Netsuite pode processar uma transação por segundo, por nó, e limita todas as transações além desse limite. Por padrão, os Integration Connectors alocam 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 dos conectores de integração será escalonado automaticamente 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. São necessários mais nós para processar mais transações para uma conexão. Por outro lado, menos nós serão necessários se uma conexão processar menos transações. Para configurar os valores do nó, faça o seguinte:

Se você for um cliente de 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ê é um cliente de 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 de processamento, verifique se os sistemas de back-end estão configurados de maneira ideal para lidar com o tráfego necessário.

Exemplos de operação de entidade

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

Exemplo: listar todas as notas de crédito

Neste exemplo, listamos todas as notas de crédito na entidade CreditMemo.

Na caixa de diálogo Configure connector task, clique em Entities.
Selecione CreditMemo na lista de Entity.
Selecione a operação List e clique em Concluído.
Como opção, na seção Task Input da tarefa Connectors, é 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.

Na caixa de diálogo Configure connector task, clique em Entities.
Selecione CreditMemo na lista de Entity.
Selecione a operação Get e clique em Concluído.
Na seção Task Input da tarefa Connectors, clique em EntityId e insira 1083723 no campo Valor padrão.
Aqui, 1083723 é um ID de registro exclusivo na entidade CreditMemo.

Exemplo: criar um registro do cliente

Este exemplo cria um registro na entidade Customer.

Na caixa de diálogo Configure connector task, clique em Entities.
Selecione Customer na lista de Entity.
Selecione a operação Create e clique em Concluído.
Na seção Task Input da tarefa Connectors, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Default Value:
```
{
"CompanyName": "Test1",
"Email": "test3@gmail.com"
}
```
Se a integração for bem-sucedida, o campo connectorOutputPayload da tarefa do conector terá um valor semelhante a este:
```
[{
"InternalId": "4767"
}]
```

Exemplo: atualizar um pedido de venda

Este exemplo atualiza um registro na entidade SalesOrder.

Na caixa de diálogo Configure connector task, clique em Entities.
Selecione SalesOrder na lista de Entity.
Selecione a operação Update e clique em Concluído.
Na seção Task Input da tarefa Connectors, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Default Value:
```
{
"Email": "test2@gmail.com",
"Entity_InternalId": "1709",
"Item_InternalId": "945"
 }
```
Clique em entityId e, em seguida, 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 a este:
```
[{
"InternalId": "1086949"
}]
```

Usar o Terraform para criar conexões

Use o recurso do Terraform (em inglês) para criar uma nova conexão.

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

Confira um exemplo de modelo do Terraform para criar uma conexão em exemplo.

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 devem 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 campo personalizado. Oferece mais controle do queIncludeCustomFieldColumns .
include_child_tables	BOOLEAN	Falso	Um booleano indicando se as tabelas filhas devem 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	INTEIRO	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 preferido 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 duplos devem ser reportados como decimais.
request_memorized_transactions	BOOLEAN	Falso	Um booleano que indica se você gostaria de solicitar transações memorizadas ao recuperar transações do NetSuite.
role_id	STRING	Falso	O RoleId é o InternalId do papel que será usado para fazer login no NetSuite. Deixe 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 indicando se você gostaria de usar nomes internos para personalizações.
use_upserts	BOOLEAN	Falso	Um booleano que indica se você quer executar uma inserção quando uma operação de inserção for usada.
user_timezone_offset	STRING	Falso	O deslocamento do fuso horário do usuário conforme definido nas preferências do NetSuite em Página inicial --> 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 detalhamento da conexão varia de 1 a 5. Um nível de detalhamento mais alto registra todos os detalhes da comunicação (solicitações,respostas e certificados SSL).
proxy_enabled	BOOLEAN	Falso	Marque essa 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 ProxyServer. Valores aceitos: BASIC, DIGEST, NONE
proxy_user	STRING	Falso	Um nome de usuário a ser usado para autenticação no proxy 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 do ProxyServer. Os valores aceitos são: AUTO, ALWAYS, NEVER, SELECTED

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

Depois de criar a conexão, ela ficará disponível tanto na Apigee Integration quanto na Application Integration. Use 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 Tarefa Conectores.
Para entender como criar e usar a tarefa de conectores na 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.
Entenda como visualizar os registros do conector.