ServiceNow

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

准备工作

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

• 在您的 Google Cloud 项目中：
  • 确保已设置网络连接。如需了解网络模式，请参阅网络连接。
  • 向配置连接器的用户授予 roles/connectors.admin IAM 角色。
  • 将以下 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. 选择新建以创建访问权限控制对象。
  3. 在类型部分，选择记录。
  4. 对于操作，选择读取。
  5. 对于名称，请在第一个下拉菜单中选择表 [sys_db_object]，并在第二个下拉菜单中选择 --None--。
  6. 在需要角色部分，双击插入新行...文本框，然后搜索并选择所需的角色。
  7. 点击提交以创建 ACL 对象。
  8. 将具有所创建 ACL 的角色分配给进行身份验证的用户。为此，请依次前往用户管理 > 用户 > 选择进行身份验证的用户 > 角色 > 修改... > 。 然后，从您的集合中添加您的角色。

• 获取 ServiceNow 实例网址、用户名和密码。

配置连接器

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

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

   转到“连接”页面

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

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

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

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

      • 连接名称可以使用字母、数字或连字符。
      • 字母必须小写。
      • 连接名称必须以字母开头，以字母或数字结尾。
      • 连接名称不能超过 49 个字符。
      • 对于支持事件订阅的连接器，连接名称不得以“goog”前缀开头。
   4. （可选）输入连接实例的说明。
   5. 您可以选择启用 Cloud Logging，然后选择日志级别。默认情况下，日志级别设置为 Error。
   6. 服务账号：选择具有所需角色的服务账号。
   7. 如需将该关联用于事件订阅，请选择启用事件订阅。选择此选项后，系统会显示以下选项：
      • 启用事件订阅、实体和操作：选择此选项可将连接用于事件订阅和连接器操作（实体和操作）。
      • 仅启用事件订阅：选择此选项可将连接仅用于事件订阅。如果您选择此选项，请点击下一步，然后配置事件订阅。
   8. 包含系统表：选择此选项可检索存储安全数据和元数据的系统表。只有具有管理员角色的用户才能访问这些表。
   9. 过滤表：以英文逗号分隔列表的形式指定表。使用此字段可过滤要让连接检索的表，而不是检索所有表。
   10. 显示值：指定连接是否必须从数据库检索显示值、实际值或这两个值。

   注意：如果您决定将此连接属性设置为“true”，则由于 Servicenow API 限制，所有返回的字段都将是“String”类型。

   • TRUE：返回所有字段的显示值。
   • FALSE：返回数据库中的实际值。
   • 全部：同时返回实际值和显示值。
   11. （可选）配置连接节点设置：
       • 节点数下限：输入连接节点数下限。
       • 节点数上限：输入连接节点数上限。

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

   注意：仅当您是随用随付客户时，才能自定义连接节点值。
   12. （可选）点击 + 添加标签，以键值对的形式向连接添加标签。
   13. 点击下一步。
5. 在目标部分中，输入要连接到的远程主机（后端系统）的详细信息。
   1. 目标类型：选择目标类型。
      • 从列表中选择主机地址，以指定目标的主机名或 IP 地址。
      • 如果要与后端系统建立专用连接，请从列表中选择端点连接，然后从端点连接列表中选择所需的端点连接。
        注意： 如需了解如何创建端点连接，请参阅 PSC 服务连接和端点连接。创建端点连接后，它将显示在端点连接列表中。

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

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

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

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

      • 用户名和密码

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

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

配置身份验证

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

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

配置事件订阅

如果您已启用事件订阅，请在事件订阅详情部分中输入以下值：

• 身份验证令牌：（可选）从 Secret 版本下拉列表中选择身份验证令牌的 Secret Manager Secret 和相应的 Secret 版本。
• HMAC 算法：选择用于加密响应载荷的 HMAC 算法。
• HMAC 密钥：如果您已选择 HMAC 算法，请选择 HMAC 密钥的 Secret Manager 密钥，然后从 Secret 版本下拉菜单中选择相应的 Secret 版本。
• 启用专用连接：选择此选项可通过专用连接安全地监听事件。
• 输入以下死信箱配置：
  • 死信项目 ID：您配置了死信 Pub/Sub 主题的 Google Cloud 项目 ID。
  • 死信主题：您要将未处理事件的详细信息写入的 Pub/Sub 主题。

创建连接后的步骤

如需完成事件订阅配置，您必须在 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：事件订阅的 Webhook 网址，您可以从“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 触发器。

连接配置示例

本部分列出了您在创建关联时配置的各种字段的示例值。

基本身份验证连接类型

字段名称	详细信息
位置	us-central1
连接器	Servicenow
连接器版本	1
连接名称	google-cloud-servicenow-conn
服务账号	Your_Project_Number@serviceaccount
显示值	True
节点数下限	2
节点数上限	50
目标类型	主机地址
主机 1	https://Your-domainname.com
用户名	User_name
密码	密码
Secret 版本	1

连接配置示例

本部分列出了您为创建 ServiceNow 关联而配置的各种字段的示例值。

ServiceNow Web 连接类型

字段名称	详细信息
位置	us-central1
连接器	ServiceNow
连接器版本	1
连接名称	gcp-servicenow-conn
服务账号	SERVICE_ACCOUNT_NAME@serviceaccount
节点数下限	2
节点数上限	50
目标类型	主机地址
主机 1	https://host_name.com
用户名	用户名
密码	密码
Secret 版本	1

实体、操作和动作

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

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

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

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

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

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

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

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

操作

本部分列出了 ServiceNow 关联支持的所有操作。

UploadAttachment 操作

此操作会将文件作为附件上传到指定记录。

UploadAttachment 操作的输入参数

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

UploadAttachment 操作的输出参数

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

如需了解如何配置 UploadAttachment 操作，请参阅示例。

DownloadAttachment 操作

此操作用于下载特定记录中的文件附件。

DownloadAttachment 操作的输入参数

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

DownloadAttachment 操作的输出参数

此操作会通过成功参数返回下载是否为 True 或 False，如果为 True，则输出 DownloadAttachment 的内容

如需了解如何配置 DownloadAttachment 操作，请参阅示例。

示例

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

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

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

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

此示例将载荷中的 Content 值作为附件上传，并返回上传的实体的参数集。如果操作成功，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"
   }

此示例通过成功参数返回下载操作是成功还是失败，如果成功，则输出 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. "
}]

实体操作示例

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

示例 - 获取实体“Incident”的单个记录

1. 在 Configure connector task 对话框中，点击 Entities。
2. 从 Entity 列表中选择“Incident”。
3. 选择 GET 操作，然后点击完成。
4. 将实体 ID 设置为“0c5f3cece1b12010f877971dea0b1449”，这是要传递的键。如需设置实体 ID，请在数据映射的数据映射器部分，点击打开数据映射编辑器，然后在输入值字段中输入 "0c5f3cece1b12010f877971dea0b1449"，并选择 EntityId 作为本地变量。

注意：

必须直接传递实体 ID 的值，例如“0c5f3cece1b12010f877971dea0b1449”。其中，“0c5f3cece1b12010f877971dea0b1449”是唯一的主键值。

在某些情况下，由于存在两个复合键，传递单个实体 ID 可能会抛出错误。

如需提取“Incident”实体下的“Comment”字段详细信息，请在关联级别将显示值标记为 true。

系统限制

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

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

注意：集成连接器节点的数量将根据您的使用情况动态扩缩。不过，如果您想为大量数据预留容量，而不必等待自动扩缩，则可以调整连接的最小节点值。连接处理越多事务就需要越多节点。相反，如果连接处理的事务较少，则需要的节点就越少。如需配置节点值，请执行以下操作：

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

节点可处理的最大事务数取决于多种因素。因此，在调整最小节点数以提高吞吐量之前，建议您检查后端系统是否已以最佳方式设置，以处理所需的流量。

使用 Terraform 创建连接

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

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

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

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

参数名称	数据类型	必需	说明
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
include_system_tables	BOOLEAN	错误	控制是否公开系统表。
filter_tables	STRING	错误	以英文逗号分隔的列表形式指定所需的表。

在集成中使用 ServiceNow 连接

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

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

向 Google Cloud 社区寻求帮助

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

后续步骤

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