使用 Web 连接器

为 Web 服务配置连接器

通过 Web 服务连接器功能，您可以访问远程 Web 服务中的数据，以便显示在移动应用程序显示板中。支持身份验证类型为“基本”、“摘要”、“OAuth 1.0a”、“NLTM”或“无”而响应采用 XML、JSON 或 ATOM 格式的任何 RESTful Web 服务，如 CA APM Cloud Monitor、Yahoo Services、General Sentiment、Markit On Demand 和 Klout。

Web 连接器功能支持：

身份验证类型：基本、摘要、OAuth 1.0a、NLTM 或无
响应格式： XML、JSON、ATOM
度量标准和元数据请求类型
用于筛选来自 Web 服务的数据的参数
GET、POST HTTP 执行方法
将数据从一个请求传递到另一个请求的变量

注意：https://support.ca.com/irj/portal/anonymous/redirArticles?reqPage=search&searchID=TEC604364 链接的知识库文章提供了如何使用实际 Web 服务示例创建 Web 服务的更多相关信息。

关于度量标准和元数据请求

请求类型	须知
度量标准	显示可用的指标并且显示在“度量标准”选项卡中。使用参数指定从 Web 服务收集的数据。例如，您可以使用参数来定义时间间隔（开始和结束）。当配置其他请求时，执行此请求的输出变量可用作输入。
元数据	默认情况下，当连接器启动时执行且每 12 小时执行一次。可以通过更新来修改默认的刷新时间间隔： install_dir/config/execConfig.properties 文件中的 http.connector.incrementalSync.reschedule FullSync.minutes 属性值在“度量标准”选项卡中不可见。当配置其他请求时，执行此请求的输出变量可用作输入。

关于变量

使用变量的常见示例为，某个 Web 服务调用是一个返回了“sessionId”的身份验证请求，而第二个 Web 服务调用使用此“sessionId”作为输入之一来获取度量标准数据。在这种情况下，您必须将第一个请求配置为类型“元数据”（其生成变量 sessionId），而第二个请求为“度量标准”请求，将此变量用作 ${sessionId} 来获取度量标准数据。

其他说明：

通过在 ${} 内指定变量名称来在请求中使用变量，例如 ${sessionId}。
如果您的请求需要时间间隔，请使用指定的变量 $startTime{time format} 和 $endTime{time format}，其中 time format 指定为 Java 简单日期格式字符串，例如，$startTime{yyyMMdd}。
使用大括号 {} 来指定变量值作为常量。例如，创建具有可用于请求（如 ${stockName}）的值 {CA} 的变量 stockName。

下图说明管理员如何为 Web 服务配置连接器。

将 CA Executive Insight 与 Web 服务连接器集成

按照下面的步骤为 Web 服务配置连接器。

为连接器配置 Web 服务请求

CA Executive Insight 让用户可以通过 RESTful Web 服务获取度量标准。要执行此操作，必须先指定 Web 服务的相关信息，包括所有身份验证信息。

注意：连接器可以包含多个请求，但是，仅当多个请求有相互依存关系时，才应该将其添加到同一个连接器中。如果单个请求无法执行，连接器进入“失败”状态而无法执行其他请求，直到所有请求都能成功执行为止。

登录到管理用户界面。
在“管理”选项卡下单击“度量标准连接器”。
“度量标准连接器”页面打开。
单击“新添”，并从下拉列表中选择“Web 连接器”。
此时打开“新建通用 Web 服务连接器”页面。
在信息部分中，输入必要的连接器信息。

名称

定义连接器的名称。

限制：最多 225 个字符。

注意：连接器名称在内部使用，不需要与 Web 服务的任何值匹配。

说明

（可选）定义连接器的说明。

限制：最多 512 个字符。
在“属性”选项卡中，输入要收集度量标准的 Web 服务请求的必要信息。

请求名称

定义请求的名称。一旦保存了请求，该名称就会显示在“活动请求”下拉列表中。

方法

指定要用于该请求的 HTTP 方法。可以使用 GET 或 POST 方法。

URL

指定您向其提出请求的 Web 服务要使用的 URL。

参数

（可选）定义该请求所需并将会添加到 URL 的 HTTP 参数。参数被添加为键值对。

如果选择了 POST 方法：

原始正文

（可选）定义 POST 请求和应用程序所需的请求消息正文参数/x-www-form-urlencoded 媒介类型 (content。

负载

（可选）定义可添加为键值对的 POST 请求的正文参数。原始正文参数优先于负载。

身份验证

定义要用于请求的身份验证方法的类型。

默认：设为“无”。

内容

（可选）该请求可接受的内容类型。

标头

（可选）定义将用于该请求的 HTTP 标头。标头被添加为键值对。

HTTP 代理

指定是否将 HTTP 代理用于该请求。

默认：设为不适用 HTTP 代理
单击“测试”按钮。
对 Web 服务连接进行测试，并连同请求状态一起显示响应。
在“响应”文本部分查看该请求的结果。您可以使用以下方法之一查看响应。
- 状态 - 显示 HTTP 响应状态行和代码以确定输入的请求信息是否有效。
- 标头 - 显示该请求的 HTTP 响应标头。
- 正文 - 显示 HTTP 响应的正文。您可以使用此部分来确定配置响应处理时应输入的内容。
- 结果 - 显示该请求的处理结果。您可以在配置响应处理后使用此信息。
- 请求 - 显示提出的 HTTP 请求。

配置 Web 服务输出的响应处理

完成请求配置并测试成功之后，您要创建响应处理配置。这是由 Web 服务连接器使用，以便从 Web 服务响应正文获取度量标准及其值。您可以将“响应”的“正文”选项按钮和“测试”按钮结合使用以帮助确定需要处理的内容。

响应处理字段应包含 Web 服务连接器用来创建响应模型的 XPath 或 JSON 路径解析说明。

遵循这些步骤:

在“处理”选项卡中，输入用于将 Web 服务输出处理成度量标准的必要信息。

类型

定义响应的类型。

选项：“度量标准”或“元数据”。

解析器

定义要用于响应正文的解析器。

默认：自动

度量标准名称

指定将一个调用的度量标准与另一个调用的度量标准区别开来的唯一名称。

示例：XPath 表达式：//field[@[name='name']

示例：常量值：{CAStock}

示例：多个表达式和常量值，其导致三个度量标准名称被选择：//resource{2}/field{@name='name'];{CAStock};//resource[25}/field[@name='name']

度量标准值

指定度量标准的值。

示例：//field[@name='price'] //LastPrice

度量标准时间戳

指定度量标准值的时间戳。

示例：//field[@name='ts'] //Timestamp

日期/时间格式

指定用于解析度量标准时间戳的格式字符串。

选项：毫秒、秒、分钟、小时、天或 Java 简单日期格式的字符串

示例：//field[@name='ts'] //Timestamp

示例：yyyy-MM-dd'T'HH:mm:ss'Z'
单击“保存”。
新的 Web 服务度量标准连接器即被创建，连接器度量标准表单显示。
为业务指标选择度量标准。

响应模型 1

此响应模型包含可用作度量标准名称、度量标准值和度量标准时间戳的字段。度量标准名称应唯一，并简单用于数据库中的主密钥，以便针对向给定连接器提出的所有请求唯一识别此度量标准。

响应：

<StockQuote>
  <Symbol>CA</Symbol>
  <LastPrice>31.98</LastPrice>
  <Timestamp>Wed Dec 18 12:47:46 GMT-05:00 2013</Timestamp>
</StockQuote>

此类请求的 XPath 处理说明将为以下内容：

度量标准名称：//Symbol

度量标准值：//LastPrice

度量标准时间戳：//Timestamp

日期/时间格式字符串将为：

EEE MMM d HH:mm:s z yyy

该配置将产生一个度量标准。

相应模型变型

子例显示 Web 服务响应的不同模型的变型，具体取决于可用的信息。

响应模型变型 A 型 - 没有时间戳: 响应不包含度量标准时间戳，或使用简单格式表达式无法解析度量标准时间戳或匹配预定义常量之一，它应保留为空。如果您不指定时间戳表达式或格式，那么轮询时间将会用作相应业务指标数据的时间戳。

响应：

 <StockQuote>
   <Symbol>CA</Symbol>
   <LastPrice>31.98</LastPrice>
</StockQuote>

根据以上响应示例，此模型的 XPath 处理说明的将为以下内容：

度量标准名称：//Symbol

度量标准值：//LastPrice

响应模型变型 B 型 - 没有度量标准名称: 响应不包含可用作度量标准名称的字段。在这种情况下，输入作为由 {} 括号括起来的文本值的度量标准名称，而不是解析表达式。

响应：

<StockQuote>
   <LastPrice>31.98</LastPrice>
   <Timestamp>Wed Dec 18 12:47:46 GMT-05:00 2013</Timestamp>
</StockQuote>

根据以上响应示例，此模型的 XPath 处理说明的将为以下内容：

度量标准名称：{My Metric Name}

度量标准值：//LastPrice

度量标准时间戳：//Timestamp

日期/时间格式字符串将为：

EEE MMM d HH:mm:ss z yyy

响应模型变型 C 型 - 没有度量标准名称和时间戳: 响应不包含可用作度量标准名称和度量标准时间戳的字段。

响应：

<StockQuote>
   <LastPrice>31.98</LastPrice>
</StockQuote>

根据以上响应示例，此模型的 XPath 处理说明的将为以下内容：

度量标准名称：{My Metric Name}

度量标准值：//LastPrice

响应模型 2

此响应模型在一个根元素中包含多个子元素，可以用作度量标准名称、度量标准值和度量标准时间戳。度量标准名称应唯一，并简单用于数据库中的主密钥，以便唯一识别此度量标准。

响应：

<weather>
  <humidity>50</humidity>
  <temperature>98</temperature>
  <date>Wed, 18 Dec 2013 1:52 PM EST</date>
</weather>

根据以上响应示例，此模型的 XPath 处理说明的将为以下内容：

度量标准名称：//{Temperature}; {Humidity}

度量标准值：//temperature; //humidity

度量标准时间戳：//date; //date

日期/时间格式字符串将为：

EEE, d MMM yyy HH:mm a z

该配置产生两个度量标准：一个用于湿度，一个用于温度。该单个日期值还同时用于上述两个度量标准。

响应模型 3

此响应模型包括记录列表，其中每个记录的字段可用作度量标准名称、度量标准值和度量标准时间戳。度量标准名称应唯一，并简单用于数据库中的主密钥，以便唯一识别此度量标准。

响应：

<resource classname="Quote">
        <field name="name">USD/ARS</field>
        <field name="price">6.375500</field>
        <field name="ts">1387395903</field>
</resource>
<resource classname="Quote">
        <field name="name">USD/KRW</field>
        <field name="price">1052.199951</field>
        <field name="ts">1387395903</field>
</resource>

根据以上响应示例，此模型的 XPath 处理说明的将为以下内容：

度量标准名称：//field[@name='name']

度量标准值：//field[@name='price']

度量标准时间戳：//field[@name=’ts’]

日期/时间格式字符串将为

秒

此配置将为每个报价产生度量标准列表。

响应模型 4

此响应模型包含一个度量标准名称和带有时间戳的度量标准值列表。在这种情况下，CA Executive Insight 将获得单个轮询请求中特定度量标准的度量标准值的列表。

响应：

<collection>
   <name>Brand Name</name>
   <record>
        <sentiment>0.4567</sentiment>
        <timestamp>20131218</timestamp>
   </record>
   <record>
        <sentiment>0.4893</sentiment> 
       <timestamp>20131219</timstamp>
   </record>
</collection>

根据以上响应示例，此模型的 XPath 处理说明的将为以下内容：

度量标准名称：//name

度量标准值：//sentiment

度量标准时间戳：//timestamp

日期/时间格式字符串将为

yyyMMdd

该配置产生具有值列表的单个度量标准。如果度量标准名称不可用，请考虑使用 {} 括号中的度量标准名称。