NetSuite

借助 NetSuite 连接器,您可以对 NetSuite 数据执行插入、删除、更新和读取操作。

准备工作

在使用 NetSuite 连接器之前,请完成以下任务:

  • 在您的 Google Cloud 项目中:
    • 将 IAM 角色 roles/connectors.admin 授予该用户 配置连接器。
    • 将以下 IAM 角色授予您要用其来使用连接器的服务账号:
      • roles/secretmanager.viewer
      • roles/secretmanager.secretAccessor

      服务账号是一种特殊类型的 Google 账号,用于表示需要验证身份并获得授权以访问 Google API 数据的非人类用户。如果您没有服务账号,则必须创建一个服务账号。如需了解详情,请参阅创建服务账号

    • 启用以下服务:
      • secretmanager.googleapis.com (Secret Manager API)
      • connectors.googleapis.com (Connectors API)

      如需了解如何启用服务,请参阅启用服务

    如果之前没有为您的项目启用这些服务或权限,则在您配置连接器时,系统会提示您启用。

配置连接器

配置连接器时,您需要创建与数据源(即后端系统)的连接。一个连接需专用于一个数据源。这意味着,如果您有许多数据源,则必须为每个数据源创建单独的连接。如需创建连接,请执行以下步骤:

  1. Cloud 控制台 中,进入 Integration Connectors > 连接页面,然后选择或创建一个 Google Cloud 项目。

    转到“连接”页面

  2. 点击 + 新建以打开创建连接页面。
  3. 位置部分中,选择连接的位置。
    1. 区域:从下拉列表中选择一个位置。

      连接器支持的区域包括:

      如需查看所有受支持区域的列表,请参阅位置

    2. 点击下一步
  4. 连接详情部分中,完成以下操作:
    1. 连接器:从可用连接器下拉列表中选择 Netsuite
    2. 连接器版本:从可用版本的下拉列表中选择一个连接器版本。
    3. 连接名称字段中,输入连接实例的名称。

      连接名称必须符合以下条件:

      • 连接名称可以使用字母、数字或连字符。
      • 字母必须小写。
      • 连接名称必须以字母开头,以字母或数字结尾。
      • 连接名称不能超过 49 个字符。
    4. (可选)输入连接实例的说明
    5. (可选)启用 Cloud Logging。 然后选择一个日志级别默认情况下,日志级别设置为 Error
    6. 服务账号:选择具有所需角色的服务账号。
    7. (可选)配置连接节点设置

      • 节点数下限:输入连接节点数下限。
      • 节点数上限:输入连接节点数上限。

      节点是处理事务的连接单元(或副本)。 连接处理越多事务就需要越多节点,相反,处理越少事务需要越少节点。 如需了解节点如何影响连接器价格,请参阅连接节点的价格。如果未输入任何值,则默认情况下,节点数下限设置为 2(以便提高可用性),节点数上限设置为 50。

    8. 账号 ID:您的用户名在 NetSuite 上关联的公司账号。
    9. 汇总列模式:指示应如何处理汇总列。
    10. 应用 ID:从版本 2020.1 开始,向 NetSuite 发出的请求需要应用 ID。
    11. 自定义字段权限:以英文逗号分隔的自定义字段权限列表。比 IncludeCustomFieldColumns 提供更大的控制力。
    12. 包括子表:一个指示是否应显示子表的布尔值。
    13. 包括自定义字段列:一个布尔值,用于指示是否要包含自定义字段列。
    14. Include Custom List Tables:一个布尔值,用于指示是否要使用基于自定义列表的表格。
    15. 包括自定义记录表:这是一个布尔值,表示是否要使用基于自定义记录类型的表。
    16. 包含引用列:以英文逗号分隔的列表,表示从表示记录引用的字段中检索数据时要包含的列。
    17. 并发会话数量上限:可在连接中使用的并发会话数量上限。
    18. Net Suite 日期格式:在 NetSuite 界面中设置的首选日期格式。
    19. Net Suite 长日期格式:在 NetSuite 界面中设置的首选长日期格式。
    20. Netsuite 元数据文件夹:用于从 NetSuite 下载元数据文件的目录的路径。为了获得最佳效果,请设置此选项。
    21. 报告双精度浮点数:指示双精度数是否应以小数形式报告。
    22. 请求记忆的交易:一个布尔值,用于指示您是否要在从 NetSuite 检索交易时请求记忆的交易。
    23. 角色 ID:RoleId 是将用于登录 NetSuite 的角色的内部 ID。留空可使用用户的默认角色。
    24. 架构:要使用的架构类型。您可以选择以下任意一个值:
      • SuiteTalk - 适用于基于 SOAP 的连接。
      • SuiteSQL - 适用于基于 REST 的连接。
    25. 使用异步服务:一个布尔值,指示您在插入、更新和删除时是否要使用异步服务。
    26. 使用内部名称进行自定义:一个布尔值,用于指示您是否要使用内部名称进行自定义。
    27. Use Upserts:这是一个布尔值,表示您是否要在使用插入操作时执行更新/插入操作。
    28. 用户时区偏移量:您的用户时区偏移量,如在 NetSuite 偏好设置的“首页”->“偏好设置”->“时区”下所定义。例如:EST。
    29. 行扫描深度:在动态确定表的列时扫描的行数。
    30. 使用代理:选中此复选框可为连接配置代理服务器并配置以下值:
      • 代理身份验证方案:选择要通过代理服务器进行身份验证的身份验证类型。支持以下身份验证类型:
        • 基本:基本 HTTP 身份验证。
        • 摘要:摘要 HTTP 身份验证。
      • 代理用户:用于向代理服务器进行身份验证的用户名。
      • 代理密码:用户密码的 Secret Manager 密文。
      • 代理 SSL 类型:连接到代理服务器时使用的 SSL 类型。支持以下身份验证类型:
        • 自动:默认设置。如果网址是 HTTPS 网址,则使用“隧道”选项。如果网址是 HTTP 网址,则使用“永不”选项。
        • 始终:连接始终启用 SSL。
        • 永不:连接未启用 SSL。
        • 隧道:连接通过隧道代理建立。代理服务器会打开与远程主机的连接,并且流量会流经该代理。
      • 代理服务器部分中,输入代理服务器的详细信息。
        1. 点击+ 添加目标
        2. 选择目标类型
          • 主机地址:指定目标的主机名或 IP 地址。

            如果要与后端系统建立专用连接,请执行以下操作:

    31. (可选)点击 + 添加标签,以键值对的形式向连接添加标签。
    32. 点击下一步
  5. 目标部分中,输入要连接到的远程主机(后端系统)的详细信息。
    1. 目标类型:您可以将目标详细信息指定为主机地址或服务连接。选择以下任意目标类型:
      • 主机地址:如果要指定目标的主机名或 IP 地址。
      • 服务连接:如果要为内部 IP 地址指定专用端点。使用服务连接,您可以对外部网络隐藏内部 IP 地址。您可以使用 Private Service Connect 功能在 Google Cloud 中创建服务连接。如需了解如何配置 Private Service Connect,请参阅发布托管式服务

      根据您选择的目标类型,输入主机地址或服务连接名称。

      要输入其他目的地,请点击 +添加目的地

    2. 点击下一步
  6. Authentication(身份验证)部分中,输入身份验证详细信息。
    1. 选择身份验证类型,然后输入相关详细信息。

      Netsuite 连接支持以下身份验证类型:

      • 用户名和密码
      • 基于令牌的身份验证
      • OAuth 2.0 授权代码授权
    2. 如需了解如何配置这些身份验证类型,请参阅配置身份验证

    3. 点击下一步
  7. 查看:查看您的连接和身份验证详细信息。
  8. 点击创建

配置身份验证

根据您要使用的身份验证输入详细信息。

  • 用户名和密码

    用户名和密码身份验证。此方法仅适用于 Netsuite 2020.2 或更低版本。

    • 用户名:连接器的用户名
    • 密码:包含与连接器关联的密码的 Secret Manager Secret。
  • 基于令牌的身份验证

    适用于 Netsuite 的基于令牌的身份验证。这可用于 SuiteTalkSuiteQL 方案。

    • OAuth 客户端 ID:应用创建时显示的使用方密钥。
    • OAuth 客户端密钥:包含应用创建时显示的使用方密钥的 Secret Manager 密文。
    • OAuth 访问令牌:创建访问令牌时的令牌 ID。
    • OAuth 访问令牌密钥:Secret Manager Secret,其中包含创建访问令牌时的令牌密钥。
  • OAuth 2.0 - 授权代码
  • 连接授权是通过基于 Web 的用户登录流程完成的。这仅适用于 SuiteQL 方案。

    • 客户端 ID:请求访问令牌时所用的客户端 ID。
    • 范围:所需范围的英文逗号分隔列表。
    • 客户端密钥:请求访问令牌时所用的客户端密钥。

    对于 Authorization code 身份验证类型,在创建连接后,您应执行一些额外的步骤来配置身份验证。如需更多信息 请参阅创建连接后的其他步骤

创建连接后的其他步骤

如果您选择OAuth 2.0 - Authorization code 身份验证,您必须在创建连接后执行以下额外步骤:

  1. “连接”页面中,找到新创建的连接。

    请注意,新连接器的状态将为需要授权

  2. 点击需要授权

    此时将显示修改授权窗格。

  3. 重定向 URI 值复制到您的外部应用。
  4. 验证授权详细信息。
  5. 点击 Authorize(授权)。

    如果授权成功,“连接”页面中的连接状态将设为活跃

重新授权授权代码

如果您使用的是 Authorization code 身份验证类型,并且在后端 NetSuite 应用中进行了任何配置更改,则必须重新授权 NetSuite 连接。如需重新授权关联,请执行以下步骤:

  1. “连接”页面中,点击所需的连接。

    系统随即会打开连接详情页面。

  2. 点击修改以修改关联详情。
  3. 身份验证部分中,验证 OAuth 2.0 - 授权代码详细信息。

    根据需要进行必要的更改。

  4. 点击保存。系统随即会转到连接详情页面。
  5. 点击身份验证部分中的修改授权。系统随即会显示 Authorize(授权)窗格。
  6. 点击 Authorize(授权)。

    如果授权成功,“连接”页面中的连接状态将设置为有效

实体、操作和动作

所有集成连接器都会为所连接应用的对象提供抽象层。您只能通过此抽象访问应用的对象。抽象作为实体、操作和动作向您展示。

  • 实体:实体可以被视为连接的应用或服务中的对象或属性集合。不同连接器的实体定义也会有所不同。例如,在数据库连接器中,表是实体;在文件服务器连接器中,文件夹是实体;在消息传递系统连接器中,队列是实体。

    但是,连接器可能不支持或不支持任何实体,在这种情况下, “Entities”列表将为空。

  • 操作:操作是指您可以对实体执行的操作。您可以对实体执行以下任一操作:

    从可用列表中选择一个实体,系统会生成该实体可用的操作列表。如需了解操作的详细说明,请参阅连接器任务的实体操作。不过,如果连接器不支持任何实体操作,则 Operations 列表中不会列出此类不受支持的操作。

  • 动作:动作是可通过连接器接口提供给集成的头等函数。动作可让您对一个或多个实体进行更改,并且动作因连接器而异。通常,操作有一些输入参数和一个输出 参数。但可能的情况是,连接器不支持任何动作,在这种情况下,Actions 列表将为空。

系统限制

Netsuite 连接器每个节点每秒可处理 1 笔交易,并会对超出此限制的所有交易进行节流。默认情况下,集成连接器会为连接分配 2 个节点(以提高可用性)。

如需了解适用于集成连接器的限制,请参阅限制

实体操作示例

本部分介绍如何在此连接器中执行一些实体操作。

在 NetSuite 中执行插入操作时,如果未指定所有必要字段和数据,与实体对应的 API 会拒绝请求。这会导致异常。异常可能会因插入操作中使用的实体而异。您必须在查询中提供 NetSuite 专列项,才能成功插入数据。您可以通过所有父表中都提供的 ItemListAggregate 字段指定订单项。以下是 ItemListAggregate 字段的格式:

    "`<ItemList>`\n" +
              "  <Row>\n" +
                      "    <ItemList_Item_InternalId>656</ItemList_Item_InternalId>\n" +
                      "    <ItemList_Item_Name>Iphone 15Pro</ItemList_Item_Name>\n" +
                      "    <ItemList_Line>1</ItemList_Line>\n" +
                      "    <ItemList_Description>Canon PowerShot Camera Test</ItemList_Description>\n" +
                      "    <ItemList_Amount>8500.0</ItemList_Amount>\n" +
                      "    <ItemList_Quantity>17.0</ItemList_Quantity>\n" +
                      "    <ItemList_Price_InternalId>1</ItemList_Price_InternalId>\n" +
                      "    <ItemList_Price_Name>List Price</ItemList_Price_Name>\n" +
                      "    <ItemList_Rate>500.00</ItemList_Rate>\n" +
                      "    <ItemList_Location_InternalId>1</ItemList_Location_InternalId>\n" +
                      "    <ItemList_Location_Name>02: NewYork</ItemList_Location_Name>\n" +
                      "    <ItemList_TaxCode_InternalId>-7</ItemList_TaxCode_InternalId>\n" +
                      "    <ItemList_TaxCode_Name>-Not Taxable-</ItemList_TaxCode_Name>\n" +
                      "    <ItemList_ShipGroup>1</ItemList_ShipGroup>\n" +
                      "    <ItemList_ItemIsFulfilled>false</ItemList_ItemIsFulfilled>\n" +
                      "    <CustomFieldListAggregate>\n" +
                      "      <CustomField InternalId=\"4779\" Type=\"platformCore:StringCustomFieldRef\" ScriptId=\"custcol121\">\n" +
                      "        <Value>1</Value>\n" +
                      "      </CustomField>\n" +
                      "    </CustomFieldListAggregate>\n" +
                      "  </Row>\n" +
                      "  <Row>\n" +
                      "    <ItemList_Item_InternalId>656</ItemList_Item_InternalId>\n" +
                      "    <ItemList_Item_Name>Iphone 15Pro</ItemList_Item_Name>\n" +
                      "    <ItemList_Line>4</ItemList_Line>\n" +
                      "    <ItemList_Description>Canon PowerShot Camera Test</ItemList_Description>\n" +
                      "    <ItemList_Amount>8500.0</ItemList_Amount>\n" +
                      "    <ItemList_Quantity>17.0</ItemList_Quantity>\n" +
                      "    <ItemList_Price_InternalId>1</ItemList_Price_InternalId>\n" +
                      "    <ItemList_Price_Name>List Price</ItemList_Price_Name>\n" +
                      "    <ItemList_Rate>500.00</ItemList_Rate>\n" +
                      "    <ItemList_Location_InternalId>2</ItemList_Location_InternalId>\n" +
                      "    <ItemList_Location_Name>01: California</ItemList_Location_Name>\n" +
                      "    <ItemList_TaxCode_InternalId>-7</ItemList_TaxCode_InternalId>\n" +
                      "    <ItemList_TaxCode_Name>-Not Taxable-</ItemList_TaxCode_Name>\n" +
                      "    <ItemList_ShipGroup>1</ItemList_ShipGroup>\n" +
                      "    <ItemList_ItemIsFulfilled>false</ItemList_ItemIsFulfilled>\n" +
                      "    <CustomFieldListAggregate>\n" +
                      "      <CustomField InternalId=\"4776\" Type=\"platformCore:StringCustomFieldRef\" ScriptId=\"custcol121\">\n" +
                      "        <Value>4</Value>\n" +
                      "      </CustomField>\n" +
                      "    </CustomFieldListAggregate>\n" +
                      "  </Row>\n" +
     "`</ItemList>`;"
  

示例 - 列出所有贷记通知单

此示例列出了 CreditMemo 实体中的所有贷记通知单。

  1. Configure connector task 对话框中,点击 Entities
  2. Entity 列表中选择 CreditMemo
  3. 选择 List 操作,然后点击完成
  4. 您还可以在连接器任务的任务输入部分中,通过指定过滤条件子句来过滤结果集。 请务必使用英文单引号 (') 指定过滤条件子句值。

示例 - 创建贷记通知单

此示例会在 CreditMemo 实体中创建贷记通知单记录。

  1. Configure connector task 对话框中,点击 Entities
  2. Entity 列表中选择 CreditMemo。
  3. 选择 Create 操作,然后点击完成
  4. 数据映射任务的数据映射器部分中,点击 Open Data Mapping Editor,然后在 Input Value 字段,然后选择 EntityId/ConnectorInputPayload 作为局部变量。
    {
              "ItemListAggregate": " + "<ItemList>\n" +
                     "  <Row>\n" +
                     "    <ItemList_Item_InternalId>6</ItemList_Item_InternalId>\n" +
                     "    <ItemList_Line>2</ItemList_Line>\n" +
                     "    <ItemList_Amount>8800.0</ItemList_Amount>\n" +
                     "  </Row>\n" +
                     "  <Row>\n" +
                     "    <ItemList_Item_InternalId>6</ItemList_Item_InternalId>\n" +
                     "    <ItemList_Line>3</ItemList_Line>\n" +
                     "    <ItemList_Amount>9900.0</ItemList_Amount>\n" +
                     "  </Row>\n" +
                     "</ItemList>" + ",
              "Entity_InternalId": "11",
              "Email": "cloudysanfrancisco@gmail.com"
          }

    如果集成成功, CreditMemo 任务的 connectorOutputPayload 响应 参数的值类似于以下内容:

    {
        "InternalId": "106"
      }
      

示例 - 创建客户记录

此示例在 Customer 实体中创建一条记录。

  1. Configure connector task 对话框中,点击 Entities
  2. Entity 列表中选择 Customer
  3. 选择 Create 操作,然后点击完成
  4. 连接器任务的任务输入部分中,点击 connectorInputPayload,然后在 Default Value 字段中输入类似于以下内容的值:
    {
    "CompanyName": "Test1",
    "Email": "test3@gmail.com"
    }

    如果集成成功,连接器任务的 connectorOutputPayload 字段将显示 值类似于以下内容:

    [{
    "InternalId": "4767"
    }]

示例 - 更新销售订单

此示例会更新 SalesOrder 实体中的记录。

  1. Configure connector task 对话框中,点击 Entities
  2. Entity 列表中选择 SalesOrder
  3. 选择 Update 操作,然后点击完成
  4. 连接器任务的任务输入部分,点击 connectorInputPayload,然后在 Default Value 字段:
    {
    "Email": "test2@gmail.com",
    "Entity_InternalId": "1709",
    "Item_InternalId": "945"
     }
  5. 点击 entityId,然后在 Default Value 字段中输入 1086949

    如果集成成功,连接器任务的 connectorOutputPayload 字段将显示 值类似于以下内容:

    [{
    "InternalId": "1086949"
    }]

使用 Terraform 创建连接

您可以使用 Terraform 资源创建新的连接。

如需了解如何应用或移除 Terraform 配置,请参阅基本 Terraform 命令

如需查看用于创建连接的 Terraform 模板示例,请参阅模板示例

使用 Terraform 创建此连接时,您必须在 Terraform 配置文件中设置以下变量:

参数名称 数据类型 必需 说明
account_id STRING True 您的用户名在 NetSuite 上关联的公司账号。
aggregate_column_mode STRING 错误 指明应如何处理汇总列。
application_id STRING 错误 从 2020.1 版开始,向 NetSuite 发出的请求需要应用 ID。
custom_field_permissions STRING 错误 以逗号分隔的自定义字段权限列表。比 IncludeCustomFieldColumns 提供更大的控制力。
include_child_tables BOOLEAN 错误 指示是否应显示子表的布尔值。
include_custom_field_columns BOOLEAN 错误 指示是否要包含自定义字段列的布尔值。
include_custom_list_tables BOOLEAN 错误 一个布尔值,用于指示您是否希望使用基于自定义列表的表格。
include_custom_record_tables BOOLEAN 错误 一个布尔值,用于指示您是否希望使用基于自定义记录类型的表格。
include_reference_columns STRING 错误 一个英文逗号分隔列表,表示从表示记录引用的字段检索数据时要包含的列。
maximum_concurrent_sessions INTEGER 错误 连接中可用的并发会话数量上限。
net_suite_date_format STRING 错误 NetSuite 界面中设置的首选日期格式。
net_suite_long_date_format STRING 错误 NetSuite 界面中设置的首选长日期格式。
netsuite_metadata_folder STRING 错误 用于从 NetSuite 下载元数据文件的目录的路径。请进行此设置,以获得最佳性能。
report_doubles_as_decimal BOOLEAN 错误 指示双精度数是否应以十进制数形式报告。
request_memorized_transactions BOOLEAN 错误 指示您是否要在从 NetSuite 检索事务时请求已存储的事务的布尔值。
role_id STRING 错误 RoleId 是将用于登录 NetSuite 的角色的 InternalId。留空可使用用户的默认角色。
架构 STRING True 要使用的架构类型。
use_async_services BOOLEAN 错误 一个布尔值,指示您是否要在插入、更新和删除时使用异步服务。
use_internal_names_for_customizations BOOLEAN 错误 一个布尔值,表示您是否想使用内部名称进行自定义。
use_upserts BOOLEAN 错误 指示是否要在使用插入操作时执行更新/插入操作的布尔值。
user_timezone_offset STRING 错误 您的 NetSuite 偏好设置中的“首页”下定义的用户时区偏移量 -->偏好设置 -->时区。例如:EST.
row_scan_depth STRING 错误 动态确定表的列时要扫描的行数。
详细程度 STRING 错误 连接的详细程度级别从 1 到 5 不等。详细级别越高,系统会记录的通信详细信息(请求、响应和 SSL 证书)就越多。
proxy_enabled BOOLEAN 错误 选中此复选框可为连接配置代理服务器。
proxy_auth_scheme ENUM 错误 用于向 ProxyServer 代理进行身份验证的身份验证类型。支持的值包括:BASIC、DIGEST、NONE
proxy_user STRING 错误 用于向 ProxyServer 代理进行身份验证的用户名。
proxy_password SECRET 错误 用于向 ProxyServer 代理进行身份验证的密码。
proxy_ssltype ENUM 错误 连接到 ProxyServer 代理时使用的 SSL 类型。支持的值包括:AUTO、ALWAYS、NEVER、TUNNEL

在集成中使用 NetSuite 连接

创建连接后,该连接将在 Apigee Integration 和 Application Integration 中可用。您可以通过连接器任务在集成中使用该连接。

  • 如需了解如何在 Apigee Integration 中创建和使用连接器任务,请参阅连接器任务
  • 如需了解如何在应用集成中创建和使用连接器任务,请参阅连接器任务

向 Google Cloud 社区寻求帮助

您可以在 Google Cloud 中发布问题和讨论此连接器 Cloud 论坛

后续步骤