ServiceNow

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

准备工作

在使用 Servicenow 连接器之前，请完成以下任务：

• 在您的 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)

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

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

• 提供对 ServiceNow 实例中以下表的访问权限：

  • sys_db_object
  • sys_dictionary
  • sys_glide_object

  必须具备此权限，连接器才能连接到您的数据。如需提供访问权限，请执行以下步骤：

  1. 在 ServiceNow 应用中，转到系统安全性 > 访问控制 (ACL)。
  2. 选择 New 以创建访问权限控制对象。
  3. 在类型部分，选择 record。
  4. 对于操作，选择读取。
  5. 对于名称，在第一个下拉列表中选择表 [sys_db_object]，在第二个下拉列表中选择 --None--。
  6. 在需要角色部分中，双击插入新行...文本框，然后搜索并选择所需的角色。
  7. 点击提交以创建 ACL 对象。
  8. 将拥有已创建 ACL 的角色分配给执行身份验证的用户。为此，请转到用户管理 > 用户 > 选择身份验证用户 > 角色 > 修改... > 。 然后从集合中添加角色

配置连接器

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

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

   转到“连接”页面

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

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

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

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

      • 连接名称可以使用字母、数字或连字符。
      • 字母必须小写。
      • 连接名称必须以字母开头，以字母或数字结尾。
      • 连接名称不能超过 63 个字符。
   4. （可选）输入连接实例的说明。
   5. 服务账号：选择具有所需角色的服务账号。
   6. 如需将连接用于事件订阅，请选择启用事件订阅。选择此选项，系统会显示以下选项：
      • 为事件订阅启用实体和操作：选择此选项可将连接同时用于事件订阅和连接器操作（实体和操作）。
      • Enable only event subscription（仅启用事件订阅）：选择此选项可将连接仅用于事件订阅。

      对于这两个选择，系统都会提示您在后续步骤中配置事件详情。

   7. （可选）配置连接节点设置：
      • 节点数下限：输入连接节点数下限。
      • 节点数上限：输入连接节点数上限。

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

   注意：只有随用随付的客户才能自定义连接节点值。
   8. 使用代理：选中此复选框可为连接配置代理服务器并配置以下值：
   • 代理身份验证方案：选择要通过代理服务器进行身份验证的身份验证类型。支持以下身份验证类型：
     • 基本：基本 HTTP 身份验证。
     • 摘要：摘要 HTTP 身份验证。
   • 代理用户：用于向代理服务器进行身份验证的用户名。
   • 代理密码：用户密码的 Secret Manager 密文。
   • 代理 SSL 类型：连接到代理服务器时使用的 SSL 类型。支持以下身份验证类型：
     • 自动：默认设置。如果网址是 HTTPS 网址，则使用“隧道”选项。如果网址是 HTTP 网址，则使用“永不”选项。
     • 始终：连接始终启用 SSL。
     • 永不：连接未启用 SSL。
     • 隧道：连接通过隧道代理建立。代理服务器会打开与远程主机的连接，并且流量会流经该代理。
   • 在代理服务器部分中，输入代理服务器的详细信息。
     1. 点击+ 添加目标。
     2. 选择目标类型。
        • 主机地址：指定目标的主机名或 IP 地址。

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

          • 创建 PSC 服务连接。
          • 创建端点连接然后在主机地址字段中输入端点连接的详细信息。
   9. （可选）点击 + 添加标签，以键值对的形式向连接添加标签。
   10. 点击下一步。
5. 在目标部分中，输入要连接到的远程主机（后端系统）的详细信息。
   1. 目的地类型：选择目的地类型。
      • 从列表中选择主机地址，以指定目的地的主机名或 IP 地址。
      • 如果要与后端系统建立专用连接，请从列表中选择端点连接，然后从端点连接列表中选择所需的端点连接。
        注意 ：如需了解如何创建端点连接，请参阅 PSC 服务连接和端点连接。创建端点连接后，它将出现在端点连接列表中。

      如果要与后端系统建立公共连接，以增强安全性，可以考虑为连接配置静态出站 IP 地址，然后将防火墙规则配置为仅将特定的静态 IP 地址列入许可名单。

      要输入其他目标，请点击 + 添加目标。

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

      Servicenow 连接支持以下身份验证类型：

      • 用户名和密码

   如需了解如何配置这些身份验证类型，请参阅配置身份验证。

   2. 点击下一步。
7. 如果您已启用事件订阅，则连接创建页面上会显示事件订阅详情部分。如需了解如何配置事件订阅详细信息，请参阅配置事件订阅。
8. 查看：查看您的连接和身份验证详细信息。
9. 点击创建。

配置身份验证

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

• 用户名和密码
  • 用户名：用于连接的 ServiceNow 用户名。
  • Password：包含与 ServiceNow 用户名关联的密码的 Secret Manager 密钥。

配置事件订阅 [预览版]

如果您启用了事件订阅，请在 Event Subscription Details 部分中输入以下值：

• 身份验证令牌：（可选）选择身份验证令牌的 Secret Manager 密钥，并从密钥版本下拉列表中选择相应的密钥版本。
• HMAC 算法：（可选）选择用于加密响应载荷的 HMAC 算法。
• HMAC 密钥：如果您选择了 HMAC 算法，请从 Secret 版本下拉列表中选择 HMAC 密钥的 Secret Manager 密钥，以及相应的 Secret 版本。

连接创建后的步骤

如需完成事件订阅配置，您必须向 ServiceNow 应用注册网络钩子网址。因此，成功创建连接后，请执行以下额外步骤：

1. 转到新创建的连接的“连接详情”页面，然后复制事件订阅的网络钩子网址。
2. 登录您的 ServiceNow 应用并执行以下操作：
   1. 在全部 > 业务规则 > 运行时间页面中，选择要监听的操作。
   2. 点击高级标签页。系统随即会打开一个脚本编辑器。
   3. 输入可向回调网址发送请求的 JavaScript。该请求包含在发生任何已启用的操作时触发的载荷。示例 JavaScript 如下所示：

      模板

      (function executeRule(current, previous /*null when async*/ ) {
      var request = new sn_ws.RESTMessageV2();
      request.setEndpoint('WEBHOOK_URL'); // here you must the listener url where you want send the event payload
      
      request.setHttpMethod('POST');
      
      var authToken = "AUTHENTICATION_TOKEN"
      request.setRequestHeader("authorization", authToken);
      request.setRequestHeader("Accept", "application/json");
      request.setRequestHeader('Content-Type', 'application/json');
      
      request.setRequestBody("{\"eventType\":\"" +
      "EVENT_TYPE" + CUSTOM_FIELDS "\"}");
      
      var data = request.getRequestBody();
      var secretKey = "SECRET_KEY";
      
      var signature = SncAuthentication.encode(data, secretKey, "ENCRYPTION_ALGORITHM");
      request.setRequestHeader("hmacauthorization",signature);
      var response = request.execute();
      
      })(current, previous);
      

      请替换以下内容：

      • WEBHOOK_URL：您从 Integration Connectors 的连接详情页面中获取的事件订阅的网络钩子网址。
      • AUTHENTICATION_TOKEN：您为连接配置的身份验证令牌的实际文本。
      • EVENT_TYPE：您在 ServiceNow 触发器中配置的事件类型的实际文本。
      • CUSTOM_FIELDS：请求正文必须始终包含 eventType 字段。除了此字段之外，您还可以根据需要添加其他字段。
      • SECRET_KEY：您为连接配置的密钥的实际文本。
      • ENCRYPTION_ALGORITHM：应为以下任何值：
        • HmacSHA224
        • HmacSHA256
        • HmacSHA384
        • HmacSHA512

        此算法应与您为连接配置的算法相同。

      示例

      (function executeRule(current, previous /*null when async*/ ) {
      var request = new sn_ws.RESTMessageV2();
      request.setEndpoint('https://webhook.site/bb37937e-24ea-19b3-9dcd-84eca77f60eg'); // here you must the listener url where you want send the event payload
      
      request.setHttpMethod('POST');
      
      var authToken = "YWRtaW46ZkVpNypxVzhCL3VY"
      request.setRequestHeader("authorization", authToken);
      request.setRequestHeader("Accept", "application/json");
      request.setRequestHeader('Content-Type', 'application/json');
      
      request.setRequestBody("{\"caller_id\":\"" +
      current.caller_id + "\",\"eventType\":\"" +
      "service_now_event_type_1" + "\",\"company\":\"" +
      current.company + "\",\"number\":\"" +
      current.number + "\",\"description\":\"" +
      current.description + "\",\"FirstName\":\"" +
      current.u_firstname + "\",\"LastName\":\"" +
      current.u_lastname + "\",\"status\":\"" +
      current.u_status + "\",\"Element\":\"" +
      current.getElement() + "\",\"category\":\"" +
      current.category + "\",\"opened_at\":\"" +
      current.opened_at + "\",\"opened_by\":\"" +
      current.opened_by + "\",\"location\":\"" +
      current.location + "\",\"salesforceId\":\"" +
      current.u_salesforceid + "\"}"); //fields you want
      
      var data = request.getRequestBody();
      var secretKey = "YWRtaW46ZkVpNypxVzhCL3VY";
      
      // var MAC_ALG_4 = "HmacSHA384";
      var MAC_ALG_3 = "HmacSHA256";
      // var MAC_ALG_5 = "HmacSHA512";
      // var MAC_ALG_2 = "HmacSHA224";
      
      var signature = SncAuthentication.encode(data, secretKey, MAC_ALG_3);
      request.setRequestHeader("hmacauthorization",signature);
      var response = request.execute();
      
      })(current, previous);

提示：如需了解如何在集成中使用事件订阅，请参阅 ServiceNow 触发器。

实体、操作和动作

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

注意：您可以在连接器任务中查看连接器的实体、操作和动作。

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

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

• 操作：操作是指您可以对实体执行的操作。您可以对实体执行以下任一操作：
  • List（列出）
  • 获取
  • 创作
  • 更新
  • 删除

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

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

注意 ：所有实体和操作都具有与之关联的架构。例如，操作架构将包含参数详细信息（如参数名称）及其对应的数据类型。实体和操作的架构（元数据）由连接在运行时从后端提取。如果架构有任何更新，此类更新不会自动反映在现有连接中；您必须手动刷新架构。如需刷新连接的架构，请打开该连接的连接详情页面，然后点击刷新连接架构。

操作

本部分列出了 Servicenow 连接支持的所有操作。

UploadAttachment 操作

此操作以附件形式将文件上传到指定记录。

UploadAttachment 操作的输入参数

参数名称	数据类型	需要	说明
内容	字符串	否	要作为文件上传的字符串内容。
ContentBytes	字符串	否	要作为文件上传的字节内容。
HasBytes	布尔值	否	是否以字节形式上传内容。
TableName	字符串	否	要附加文件的表的名称。
TableSysId	字符串	否	TableName 指定表中您希望附加文件的记录的 Sys_id。

UploadAttachment 操作的输出参数

此操作会从上传的实体返回一组参数

如需查看有关如何配置 UploadAttachment 操作的示例，请参阅示例。

DownloadAttachment 操作

此操作会从特定记录下载附件。

DownloadAttachment 操作的输入参数

参数名称	数据类型	需要	说明
SysId	字符串	是	附件文件的 Sys_id。
HasBytes	布尔值	否	是否以字节形式下载内容。

DownloadAttachment 操作的输出参数

此操作通过 Success 参数返回下载为 True 或 false，如果为 True，则输出 DownloadAttachment 的内容

如需查看有关如何配置 DownloadAttachment 操作的示例，请参阅示例。

示例

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

示例 - 上传突发事件的附件

1. 在 Configure connector task 对话框中，点击 Actions。
2. 选择 UploadAttachment 操作，然后点击完成。
3. 在连接器任务的任务输入部分中，点击 connectorInputPayload，然后在 Default Value 字段中输入类似于以下内容的值：

   {
     "Content": "File is uploaded",
     "TableName": "Incident",
     "TableSysId": "018f4057473ae5104593a6b5316d4357"
   }

此示例将来自载荷的内容值作为附件上传，并返回上传的实体的一组参数。如果操作成功，UploadAttachment 任务的 connectorOutputPayload 响应参数的值将如下所示：

{
                      "SysId": "a667f5d1939be110ff87352d6cba10fc",
                      "FileName": "7043426257788756581.connector.txt",
                      "TableSysId": "018f4057473ae5104593a6b5316d4357",
                      "TableName": "Incident",
                      "DownloadLink": "https://gcp.service-now.com/api/now/v1/attachment/a667f5d1939be110ff87352d6cba10fc/file",
                      "ContentType": "text/plain",
                      "SizeBytes": "16",
                      "ChunkSizeBytes": "700000",
                      "Compressed": "true",
                      "SizeCompressed": "36",
                      "SysTags": "",
                      "ImageHeight": "",
                      "ImageWidth": "",
                      "AverageImageColor": "",
                      "SysModCount": "0",
                      "Hash": "807e96c2942c41ad699d004a9d6a74595c84fab09111d479b6bbe013d5debff6",
                      "State": "pending",
                      "SysUpdatedBy": "gcp2",
                      "SysUpdatedOn": "2023-06-07 07:23:34",
                      "SysCreatedBy": "gcp2",
                      "SysCreatedOn": "2023-06-07 07:23:34",
                      "encryption_context": ""
                    }

示例 - 下载突发事件的附件

1. 在 Configure connector task 对话框中，点击 Actions。
2. 选择 DownloadAttachment 操作，然后点击完成。
3. 在连接器任务的任务输入部分中，点击 connectorInputPayload，然后在 Default Value 字段中输入类似于以下内容的值：

   {
     "SysId": "440c3995471fe1104593a6b5316d4384"
   }

此示例通过 Success 参数返回下载为 True 或 false，如果为 True，则输出 DownloadAttachment 的内容。如果操作成功，DownloadAttachment 任务的 connectorOutputPayload 响应参数的值将如下所示：

[
                    {
                      "Success": "True"
                    },
                    {
                      "Content": " A Simple Text File \r\n\r\n\r\n This is a small demonstration .txt file - \r\n just for use in the Virtual Mechanics tutorials. More text. And more \r\n text. And more text. And more text. And more text. \r\n And more text. And more text. And more text. And more text. And more \r\n text. And more text. Boring, zzzzz. And more text. And more text. And \r\n more text. And more text. And more text. And more text. And more text. \r\n And more text. And more text. \r\n And more text. And more text. And more text. And more text. And more \r\n text. And more text. And more text. Even more. Continued on page 2 ...\r\n Simple PDF File 2 \r\n ...continued from page 1. Yet more text. And more text. And more text. \r\n And more text. And more text. And more text. And more text. And more \r\n text. Oh, how boring typing this stuff. But not as boring as watching \r\n paint dry. And more text. And more text. And more text. And more text. \r\n Boring. More, a little more text. The end, and just as well. "
                    }]

系统限制

ServiceNow 连接器为每个节点每秒最多可以处理 10 个事务，并且可以限制超出此限制的任何事务。默认情况下，Integration Connectors 会为连接分配 2 个节点（以提高可用性）。

如需了解适用于 Integration Connectors 的限制，请参阅限制。

注意：Integration Connectors 节点的数量将根据您的使用情况动态自动扩缩。但是，如果您想为大量卷预留容量，而不等待自动扩缩，则可以调整连接的最小节点值。需要更多节点才能为连接处理更多事务。相反，如果连接处理的事务较少，则所需的节点数量也会减少。如需配置节点值，请执行以下操作：

• 如果您是随用随付的客户，请在“修改连接”页面中配置最小和最大节点值。
• 如果您是订阅客户，请与支持团队联系。

节点可以处理的最大事务量取决于各种因素。因此，在调整节点数下限以获得更高的吞吐量之前，建议您检查后端系统的设置是否以处理所需流量为优化目标。

使用 Terraform 创建连接

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

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

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

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

参数名称	数据类型	需要	说明
proxy_enabled	BOOLEAN	False	选中此复选框可为连接配置代理服务器。
proxy_auth_scheme	ENUM	False	用于向 ProxyServer 代理进行身份验证的身份验证类型。支持的值包括：BASIC、DIGEST、NONE
proxy_user	STRING	False	用于向 ProxyServer 代理进行身份验证的用户名。
proxy_password	SECRET	False	用于向 ProxyServer 代理进行身份验证的密码。
proxy_ssltype	ENUM	False	连接到 ProxyServer 代理时使用的 SSL 类型。支持的值包括：AUTO、ALWAYS、NEVER、TUNNEL
include_system_tables	BOOLEAN	False	控制是否公开系统表。
filter_tables	STRING	False	以英文逗号分隔的列表形式指定所需的表。

在集成中使用 Servicenow 连接

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

• 如需了解如何在 Apigee Integration 中创建和使用连接器任务，请参阅连接器任务。
• 如需了解如何在 Application Integration 中创建和使用连接器任务，请参阅连接器任务。

向 Google Cloud 社区寻求帮助

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

后续步骤

• 了解如何暂停和恢复连接。
• 了解如何监控连接器使用情况。
• 了解如何查看连接器日志。