配置出站 Web 服务

本文包含以下主题：

出站 Web 服务使 ServiceAide Cloud Service Management 能够通过 SOAP 或 RESTful Web 服务调用与外部系统交互。 出站 Web 服务操作链接到工作流操作。 当分析人员对故障单执行工作流操作时，则会启动出站 Web 服务操作。 如果外部应用程序返回对 Web 服务调用的响应，则该产品将接受响应，并相应地更新该故障单。

作为管理员，您可以配置 Web 服务适配器并可以定义字段映射以便启用与外部应用程序的数据交换。

配置出站 Web 服务时，外部应用程序无需构建轮询机制便可以与该产品交换数据。 您可以设置数据交换，以更新外部应用程序和该应用程序上的字段。 出于对该产品启动的调用的响应，便发生了数据交换。

完成下列任务来配置出站 Web 服务。

收集先决条件信息

要配置外部应用程序的出站 Web 服务，需要对支持的 Web 服务有基本的了解。 还要标识外部应用程序中的字段和该产品中的相应字段。

收集配置出站 Web 服务调用所需的凭据。 凭据可能有所不同，具体取决于外部应用程序是否使用 SOAP 或 RESTful Web 服务。

基于 SOAP 的 Web 服务调用

ServiceAide Cloud Service Management 使用 Web 服务描述语言 (WSDL) 与基于 SOAP 的应用程序进行通信。 外部应用程序的 WSDL 文件包含配置 Web 服务操作所需的信息。 WSDL 文档包含诸如方法、字段映射，以及其他方面的信息。

要访问 Web 服务，请查找其 WSDL 条目。 WSDL 条目通常是 Web 上的 URL。 公司控制对其不同程度的 WSDL 文件的访问权限。 有关访问权限，请与外部应用程序的管理员联系。

RESTful Web 服务调用

未在正式文档中定义 RESTful Web 服务调用。 但是，某些外部应用程序定义了支持的 Web 服务。 您可以在应用程序的 Web 应用程序描述语言 (WADL) 文件中找到支持的操作。

通常情况下，RESTful Web 服务调用不需要任何身份验证。 如果应用程序要求身份验证，则请与外部应用程序的管理员联系。

收集以下先决条件信息来规划出站 Web 服务：

1. 验证外部应用程序是否提供 Web 服务。 如果外部应用程序没有提供 web 服务，您则无法继续。
2. 验证外部应用程序是否支持基于 SOAP 或 RESTful 的 Web 服务调用。
   • 对于支持基于 SOAP 调用的应用程序，确定 WSDL 条目的路径以及身份验证级别。 收集可用于配置凭据的信息。
   • 对于支持 RESTful Web 服务调用的应用程序，确定是否定义了支持的 Web 服务。 定义了 Web 服务后，收集到 WADL 条目的路径信息。 不必指定未定义 Web 服务的 WADL 路径，便可以继续。
3. 验证您是否可以将该产品与外部应用程序连接。 从 ServiceAide Cloud Service Management 服务器 Ping 外部应用程序服务器。 请检查任何错误的结果。 如果 ServiceAide Cloud Service Management Web 服务器无法连接到外部应用程序，您将无法继续进行。
4. 标识调用访问外部应用程序的 WSDL/WADL 条目的 URL。 当您识别 URL 后，请确认以下要求：
   • 调用 Web 服务所需的访问权限和身份验证。
   • 确认外部应用程序是否需要基本身份验证。 获取外部应用程序的用户名和密码。
   • 请确认应用程序是否使用基于会话的控制。 您可以从 WSDL 中获取此信息。
5. 标识您要配置的字段映射。 确认要映射的字段是否在该产品上可用。 标识需要用于计划配置的任何其他字段。
6. 标识您要配置的操作类型。 根据该计划，您可以配置 Web 服务操作和相关的工作流操作。

为字段映射配置属性和自定义字段模板

在计划过程中，您可以标识字段映射要求。 当标准的故障单字段和现有的自定义字段无法满足需要时，您可以配置自定义属性。 因此，您可以将属性和自定义字段模板相关联。 您可以标识属性名称和数据类型，然后可以配置属性。 在您将自定义字段与自下定义字段模板相关联时，属性将变为可用的字段映射。

注意：不支持“日期”字段的自定义字段映射。

有关创建属性的更多信息，请参阅“创建和管理属性”。

有关创建自定义字段模板的更多信息，请参阅“创建和管理自定义字段模板”。

启用 Web 服务调用

请执行以下步骤：

1. 导航到“工作区”、“管理”、“工具”、“配置参数”。
2. 在“搜索”字段中，搜索“启用_外部_Web_服务_调用”参数。
3. 单击列表中的参数名称，查看参数的详细信息。
4. 将参数值设置为“是”。

该产品目前使用出站 Web 服务调用支持数据交换。

配置 Web 服务凭据

ServiceAide Cloud Service Management 使用 Web 服务凭据连接到外部应用程序进行数据交换。 您可以创建和管理调用用于数据交换的外部 Web 服务所需的凭据。 相同的外部 Web 服务凭据可用于外部应用程序支持的所有身份验证方法。

请执行以下步骤：

1. 导航到“工作区”、“管理”、“工具”、“Web 服务凭据”。
   将显示“Web 服务凭据”选项卡。 您可以筛选列表以查看活动或非活动的凭据。 您可以修改现有的凭据，或者可以从此处创建凭据。 此处可以提供外部应用程序的 Web 服务凭据。
2. 提供所需的信息，并单击“保存”。

当您单击“保存”时，“摘要”和“相关操作”部分显示。

配置基于 SOAP 调用 Web 服务操作

该 Web 服务操作使该产品和外部应用程序之间可以进行数据交换。 配置 Web 服务凭据后，您可以使用外部应用程序支持的方法配置多个操作。

请执行以下步骤：

1. 导航到“工作区”、“管理”、“工具”，然后选择“Web 服务操作”。
2. 提供外部应用程序的名称、说明和凭据。
3. 输入 Web 服务操作的字段映射详细信息。 指定信息，如下所示：
   • 用于操作的 Web 服务绑定的类型。
   • 用来操作的方法。
   • 操作超时持续时间。
   • 此操作可用于的故障单类型。

4. （可选）指定出站映射。 您在此处指定的故障单字段值会填充该外部应用程序中的相应字段。
   通过 XML 文件或下拉字段，您可以映射字段。

   1. 要使用 XML 文件，请选择“高级配置”复选框。 将显示 XML 内容。 您可以通过在相关节点指定值来提供出站字段映射。 使用“高级配置”时，您可以看到整个 SOAP 请求 XML 并可以在 SOAP 调用中使用同一 XML。 “高级配置”包括自动增长的文本区域。 您可以使用查找图标打开实体搜索和选择实体令牌。 您选择的实体另将替换为外部字段值。 在 SOAP 请求 XML 中，通过放置光标，或者通过选择需要令牌替换的文本，可以插入令牌。 请求发送到外部应用程序时，您选择的实体令牌便替换为外部字段值。

   2. 要使用下拉选项指定字段映射，请提供以下信息，然后单击“+”图标以添加映射：
      外部字段
      从下拉列表中选择一个外部字段。 根据在“选择方法”字段中选择的方法，下拉列表动态呈现。
      故障单字段
      指定 ServiceAide Cloud Service Management 故障单字段令牌以映射在故障单上执行的 web 服务操作时将更新故障单字段。 您可以使用标准故障单模板、自定义字段或您配置的用户令牌。
      示例：标准故障单字段 ${description_long}
      注意：在默认情况下，在 WADL 文档中显示为必需的字段显示在外部字段中。

5. （可选）指定入站映射。 来自外部应用程序的值在该应用程序的相应故障单字段中得到更新。 在外部应用程序提到故障单字段以及字段的 xpath。 您还可以映射最多 10 个显示实体字段。 显示实体字段提供供参考用的附加信息，但是不保存在故障单上。 您可以在“Web 服务查找”属性类型的故障单详细信息页面上查看显示实体字段。
   
6. 单击“保存”。

此时便配置了 Web 服务操作。

现在可以将 Web 服务操作与工作流操作相关联。

配置 RESTful 调用的 Web 服务的操作

该 Web 服务操作使该产品和外部应用程序之间可以进行数据交换。 配置 Web 服务凭据后，您可以使用外部应用程序支持的方法配置多个操作。

请执行以下步骤：

1. 导航到“管理”、“管理”、“工具”，然后选择“Web 服务操作”。
2. 提供外部应用程序的名称、说明和 Web 服务凭据。
3. 指定 Web 服务操作的字段映射详细信息。 指定信息，如下所示：
   • 操作的实体类型或适用的故障单类型。
   • Web 服务的端点地址。
   • 用来执行操作的方法。
   • 操作超时持续时间。
4. （可选）指定出站映射。 您在此处指定的故障单字段值会填充该外部应用程序中的相应字段。 当配置 Web 服务的 WADL 时，外部应用程序值呈现在一个下拉列表中。 呈现的值取决于您在“选择方法”字段中选择的方式。 您可以从下拉列表中选择值以便配置出站映射。 未配置 WADL 时，该字段显示为文本区域。 您可以手动输入有效值。 在默认情况下，在 WADL 文档中显示为所需字段的字段显示在外部字段中。
5. （可选）要使用 XML 或 JSON 文件，请选择“高级配置”复选框。 您可以通过在相关节点指定值来提供出站字段映射。 当您使用“高级配置”时，显示一个文本框以输入 XML 或 JSON 内容。 您可以使用查找图标打开实体搜索和选择实体令牌。 您选择的实体另将替换为外部字段值。 在 REST 请求 XML 或 JSON 中，通过放置光标或者通过选择需要令牌替换的文本，可以插入令牌。 请求发送到外部应用程序时，您选择的实体令牌便替换为外部字段值。
6. （可选）指定入站映射。 来自外部应用程序的值在该产品的相应故障单字段中得到更新。 推荐故障单字段以及到该外部应用程序中字段的路径。
   注意：
   • 请勿在“入站映射”的 XML 搜索路径中使用通配符或运算符字符。

   • 确认您仅映射了所需的响应文件节点以配置“入站映射”值。 例如，在以下代码片段中，如果想要填充属性 id，请将节点输入为 employees.employee.id。 将节点指定为 employees.employee 不会填充任何属性。

7. 单击“保存”。

此时便配置了 Web 服务操作。

现在可以将 Web 服务操作与工作流操作相关联。

将 Web 服务配置与工作流操作相关联

配置 Web 服务操作之后，您可以将操作与工作流操作相关联。 在分析人员对故障单执行相应的工作流操作时，应用程序调用 Web 服务操作。

您可以从“工作区”、“管理”、“工具”、“工作流操作”页面上将 Web 服务操作与工作流操作关联。 使用工作流操作的“Web 服务操作”字段将操作与 Web 服务配置相关联。

您可以同时使用 SOAP 和 RESTful Web 服务调用来配置工作流操作。

有关工作流操作的信息，请参阅“创建和管理工作流操作”。

验证配置

要验证配置，您需要对该产品和外部应用程序都有访问权限。

请考虑以下示例。 配置出站 Web 服务以便与 ServiceAide Service Desk Manager 进行通讯。 您希望在 ServiceAide Cloud Service Management 中服务请求的创建将导致在 ServiceAide Service Desk Manager 中创建突发事件。 要启用通讯，您要为 ServiceAide Service Desk Manager 配置 Web 服务凭据。 然后，您配置 Web 服务操作，以便在 ServiceAide Service Desk Manager 中创建突发事件。 您配置出站映射，以便使故障单详细信息字段更新 ServiceAide Service Desk Manager 中的相应故障单详细信息字段。

配置字段映射，以使用 ServiceAide Service Desk Manager 中的故障单详细信息来更新该产品中的自定义字段。 下一步，配置工作流操作“CASD_创建故障单”，并将其与 Web 服务操作相关联。 将 L1 支持组的权限分配工作流操作。

要验证配置，请提交一个故障单，并使用工作流操作从工作流移动该故障单。 所有的 Web 服务操作都记录在故障单显示板上。 您可以查看 Web 服务操作、开始时间和结束时间，以及操作的状态。 当 Web 服务操作失败时，跟踪日志消息提供了失败原因的详细信息。

请执行以下步骤：

1. 作为分析人员登录到应用程序。
2. 单击“工作区”、“服务台”、“故障单中心”。
3. 单击“操作”、“创建请求”。
4. 提供基本信息，如，故障单“关于”部分中的详细信息和说明。
5. 单击“操作”、“CASD_创建故障单”（此操作是您创建的工作流操作）。
6. 使用适当的凭据登录到 ServiceAide Service Desk Manager。
7. 导航到故障单列表并搜索新创建的故障单。

如果故障单列表显示了相应的突发事件故障单，出站 Web 服务调用则成功。 您可以导航回该产品中的故障单以验证故障单留言板，获取更多详细信息。