Skip navigation
All Places > All Things PI - Ask, Discuss, Connect > PI Square中文论坛 > Blog > 2016 > August
2016

PI Square中文论坛

August 2016 Previous month Next month

接上一个系列:Coresight 系列讨论 - Coresight 安装 ,原文链接为:Coresight Squared – What’s next? Kerberos and more..

 

该系列目前包括三部分:

Server核心版的安装和配置

PI Coresight的安装

Kerberos配置及更多 << 您在这

 

到这里,Coresight已经可以使用了,不过我们这个系列还没有结束,我们将会谈谈大家最喜欢的三头怪(Kerberos是希腊神话中的一个三头狗)Kerberos

声明:

这篇文章中不会涉及Kerberos端口如何工作的技术细节,也不会包含Kerberos的troubleshooting。(可能会在下一次会谈)。与之对应的是我们会将如何利用Kerberos认证和Kerberos委任来加强PI系统的安全性。

 

Coresight - IIS 设置

 

在配置 Kerberos之前,确保 Kerberos 验证在PI Coresight 上是可行的。

 

1. 启用 Windows Authentication(Windows 认证)

选择 Coresight Web Application > Authentication Settings:

2. 启用 Kernel-mode Authentication

右键点击 Windows Authentication > Advanced Settings... > 确保Kernel-mode authentication是被启用的:

 

 

 

 

按照上面的描述,Microsoft 推荐保持启用Kernel-mode 认证。一些关于Kernel-mode 认证对于性能的好处的数据可以在这里看到

 

如果Kernel-mode 认证被:

  • 启用, Kerberos 票据默认用Local System 账户解码.
  • 禁用, Kerberos 票据默认用app pool 账户解码.


这样的话,如果Coresight AppPools以如下用户运行:

  • 虚拟或者机器账户 (比如Network Service) - 不需要更多操作

 

  • 自定义域账户 - 启用 AppPool 账户来解码 Kerberos 票据:
    IIS Manager 中,选择Coresight Web Application > Configuration Editor > 导航到 system.webServer/security/authentication/windowsAuthentication > 设置 useAppPoolCredentialsTrue。这保证了 AppPool 用户是被用户解码传数过来的Kerberos票据的,允许Kerberos认证可以正常工作。

 

3. 使 Kerberos 认证 成为可能

右键点击 Windows Authentication > Providers... > 确保 Negotiate provider是列表中的第一个选项. 比如:

 

Kerberos 简化版: “三个头”

为了尽可能简化,让我们考虑三个主要的关注点:

1. 前端服务器主体名称(SPN,Service Principal Name) - Coresight 终端用户需要能够使用 Kerberos 认证来登录 Coresight (前端服务)

2. 端服务器主体名称(SPN,Service Principal Name)PI 或者 AF Server ( 后端服务) 需要可以接受Kerberos请求 (委任的凭据)

3. Kerberos 委任 - Coresight 服务用户 (前端服务身份) 需要被允许去委任终端用户的凭据给后端服务 (PI or AF Server)

 

第一头: 前端服务器主体名称


一个服务器主体名称是一个服务实例唯一标识符。 服务器主题名称(SPNs)被Kerberos 认证用于将一个服务实例和服务账户联结起来。

服务主体名称能够被分成两部分(这里省略了端口号和服务名,因为它们和我们的内容不大相关)

 

服务类/目标主机, 被安排到一个合适的服务账号.

 

服务类(ServiceClass) – 一个指明服务普通类的字符串。和PI系统有关的常用的服务类包括:

PI Data Archive – PIServer

PI AF Server – AFServer

PI Coresight – HTTP

无论Coresight是不是用了SSL,服务类都是HTTP!

 

目标主机(TargetHost) - 服务运行的机器的主机名和全域名。对Coresight服务器总是既创建两个服务主体名称(SPN)一个给主机名,另一个给全域名!

 

服务账号(ServiceAccount) – 运行服务的用户,如果是:

域账户 - 服务器主体名称(SPN)是被安排给实际存在的运行服务的域用户

虚拟或者机器账号 (Network Service, NT Service\Service 等.) – 服务器主体名称(SPN)被安排给计算机(服务在运行的那台)

 

服务器主体名称(SPNs)可以用 setSPN.exe 工具来创建 (在命令行中可用). 在大多数环境下,创建新的服务器主体名称需要域管理员的权限

 

为了OSI\CoresightSVC 运行的PI Coresight 创建服务器主体名称(SPN), 在 Core01.it.local 机器上运行:

setspn -S HTTP/Core01.it.local OSI\CoresightSVC  
setspn -S HTTP/Core01 OSI\CoresightSVC

为了用Network Service运行的PI Coresight 创建服务器主体名称(SPN),在Core01.it.local 机器上运行:

setspn -S HTTP/Core01.it.local Core01  
setspn -S HTTP/Core01 Core01  

 

用setSPN.exe来验证是否服务器主体名称(SPNs)已经被正确创建和安排。

 

列举安排给某一个域账户所有的服务器主体名称(SPNs):

setspn -L domain\account  
Example: setspn -L OSI\CoresightSVC 

 

检查特定的SPN是否存在

setspn -Q SPN  
Example: setspn -Q HTTP/Core01  

 

第二头: 后端服务器主体名称

 

相同的适用于前端的服务器主体名称的原则也适用于后端。保证合适的 (PIServer/TargetHost and AFServer/TargetHost, 分别) SPNs 被安排给正确的服务用户 (PI Network Manager 服务账号 对应PI Data Archive; PI AF Application Service 的服务账号 对应AF的).

 

第三头: Kerberos委任

 

一旦Kerberos委任被启用,前端服务 (PI Coresight) 可以委任终端用户的凭据给后端服务 (PI Data Archive 或者 PI AF Server) 从而保证终端用户用安全的方法读取后端的数据。

 

在我们的案例中, Coresight 服务用户需要被允许委任终端用户的凭据给 PI Data Archive. 从PI Coresight 2016开始,对AF Server的Keberos 委任对于给Event Frame添加注释是必须的。

 

有三种主要的Kerberos委任的方式:

  • 通常的 (不约束的) 委任
  • 约束委任


  • 按资源的委任

要了解更多信息,请参阅 KB01222 - Types of Kerberos Delegation. 我们将使用最新的方式 – 按照资源的委任。这种方法有多个好处,主要有:

  • 用于委任的权限与后端关联而不是前端
  • 不需要域管理员特权
  • 可以跨域或者跨森林工作

这对于非IT管理员用户是一个非常好的消息,因为它允许后端资源的管理员,如PI Data Archive和PI AF的管理员来控制是否这些资源接受被委任的凭据。 但是要使用基于资源的约束委任也有一些要求。

  • 前端和后端账户域都必须有Server 2012或更高等级的Kerberos分配中心
  • 前端服务器必须安装在Windows Server 2012或更高版本的操作系统上

 

要配置基于资源的约束委任,在Powershell中使用活动目录命令集

下面的例子是给 用域用户 picoresight 运行的PI Coresight和用默认虚拟账户NT Service\AFService 运行的AF Server PIAF01

 

分步指导:

 

1. 获得前端和后端服务标识。如果服务用一个域账户运行,用Get-ADUser。如果用机器账号如 Network Service 或者一个虚拟账号运行, 使用 Get-ADComputer.

$frontendidentity = Get-ADUser -Identity picoresight  
$backendidentity = Get-ADComputer -Identity PIAF01 

2. 安排 front-end identity(前端标识)back-end identity(后端标识)  PrincipalsAllowedToDelegateToAccount 属性

 

Set-ADComputer $backendidentity -PrincipalsAllowedToDelegateToAccount $frontendidentity 

 

3. 观察更新后的后端身份标识的 PrincipalsAllowedToDelegateToAccount 属性,验证它是被合理设置的:

 

Get-ADComputer $backendidentity -Properties PrincipalsAllowedToDelegateToAccount 

 

 

另外:

 

允许多个主体委任给相同的后端,设置 PrincipalsAllowedToDelegateToAccount 给所有需要的标识,以逗号隔开:

 

Set-ADComputer $backendidentity -PrincipalsAllowedToDelegateToAccount $frontendidentity1, $frontendidentity2 

 

 

如果有多个域参与其中,当指定Get-ADUser时指定更多标准,下面这个例子包含了-Server 参数来指定一个标识所在的域控制器:

$frontendidentity = Get-ADUser -Identity picoresight -Server piDC01.pidoge.local 

 

推荐 Kerberos 阅读

OSIsoft: Kerberos Authentication and web browsers

How Windows Server 2012 Eases the Pain of Kerberos Constrained Delegation, Part 1

How Windows Server 2012 Eases the Pain of Kerberos Constrained Delegation, Part 2

If there are multiple domains involved, specify more criteria when executing the Get-ADUser cmdlet. The example below includes the -Server parameter to specify a DC of the domain where the identity resides:

接上一个系列:Coresight 系列讨论 - 在Windows Server核心版安装和配置 ,原文连接为Coresight Squared - Coresight Installation

 

整个系列包括以下3部分:

Coresight 系列讨论 - 在Windows Server核心版安装和配置

PI Coresight安装 << 您现在这里

Kerberos以及更多

 

服务账号

 

在开始安装PI Coresight之前,先准备一个合适的服务账号。为了遵循最小权限的原则,建议准备三个分开的账号:

  1. 运行两个Coresight AppPools的域账号
  2. 运行PI WebAPI Service的域账号
  3. 运行PI Crawler Service的域账号

 

需要的权限:

 

PI Coresight服务账号

- 所有PI Coresight将会需要读取的AF和PI Data Archive内容的读取权限

- 任意PI ProcessBook画面导入文件夹的读取权限

 

PI Crawler 服务账号

- PI Data Archive中PIUSER, PIDBSEC, PIPOINT, PIMAPPINGS 表格的读取权限

- 所有PI Coresight用户将会需要搜索的AF和PI Data Archive内容的读取权限

 

PI Web API 服务账号

- 可以连接任意PI Coresight用到的PI或者AF服务器 (为了 PI Crawler可以成功生成索引)

- AF中事件框架的读取权限(事件框架不被crawler索引, PI Coresight 直接通过PI Web API搜索事件框架)

 

PI Coresight 安装

 

附件中的 setup.ini file (或从pastebin获取)是在Server核心版中安装PI Coresight的钥匙。这个setup 文件已经被修改过了,所以服务器角色和功能的检查已经被跳过了,PI Buffer Subsystem模块也被从安装过程中移除了,因为PI Coresight不需要它。

 

关于 .NET Framework 4.6的重要说明:

考虑到大量关于在安装.Net Framework 4.6过程中报告的缺少前置组件的报告,在安装PI Coresight之前先通过Windows 更新安装,NET Framework 4.6是一个比较好的方案

 

有两种方式完成这一点:

1) 慢:等待Windows更新自动安装

Windows更新是以自动模式运行的(我们在Coresight 系列讨论 - 在Windows Server核心版安装和配置 中已经提到),所以最终所有需要的更新都会被安装。

 

2) 快:在Server核心版上强制执行一个手动更新

要加快这个进程,将Windows Update切换到手动模式,并立刻安装所有可用的更新To speed up the process, switch Windows Update to Manual mode and installed all available Updates immediately:

a) 打开 sconfig > 选择 Option 5 – Windows Update Settings(Windows 升级设置) > 输入 m 切换 Windows Update 到手动模式。

 

b)sconfig 主菜单, 选择 Option 6 – Download and Install Updates(下载和安装更新) > 输入 a 来搜索所有的更新 > 再次输入 a 来安装所有的更新。

有些更新可能需要重启。上述步骤可能需要重复几次直到安装.NET Framework 4.6

 

c) 将Windows 更新切换回到自动模式 (sconfig > 选择 Option 5 – Windows Update Settings (Windows 升级设置)> 输入 a 切换Windows 更新到自动模式)

 

如果您想手动安装,当在Server核心版安装 .NET Framework 4.6 需要使用/q 开关 (静默安装) 。
这样安装将会通过运行 NDP46-KB3045557-x86-x64-AllOS-ENU.exe /q开始。因此,为了以防万一, /q 开关在修改过的 setup.ini 已经包含了

 

按照如下步骤进行操作:

 

1. 替换setup.ini

 

i. 在任意电脑上,运行PI Coresight的安装包,将其解压到一个文件夹(让我们把他叫做installsrc),并且在安装任何组件之前取消安装.

ii. 到 installsrc 路径中用修改过的setup.ini文件替换原有的setup.ini文件。

 

 

2.  将 installsrc 文件夹拷贝到Server核心版的机器上并安装Coresight。

 

使用Robocopy (在命令行中可用) 或者在Windows Explorer当中使用复制粘贴功能。

 

比如,从本地 C:\Temp拷贝Coresight 2016 安装文件夹到一台叫做CORE的远端的机器:

 

robocopy "C:\Temp\Coresight2016" "\\CORES\c$\Coresight2016" /e

 

 

 

使用命令行, 在Server 核心版机器上运行在 installsrc Setup.exe 并按照向导提示安装。PI System Explorer 可以选择不安装,因为它不是必须的,但是他会使得天机PI和AF Server更加容易。不管怎样,PI Coresight到这时已经被安装了。

 

 

3. 用 shutdown /r /t 0 命令重启电脑

 

4. 配置PI Coresight Application Pools让他用一个 service 账户运行

 

如果按照之前的post(Coresight 系列讨论 - 在Windows Server核心版安装和配置远程管理步骤已经完成,配置AppPool会变得容易很多,因为可以通过IIS manager远程操控

 

或者,使用 Powershell. 例如,配置 Coresight AppPools 用 OSI\CoresightSVC:

Import-Module WebAdministration;  
Set-ItemProperty iis:\apppools\coresightserviceapppool -name processModel -value @{userName="OSI\CoresightSVC";password="password";identitytype=3}  
Set-ItemProperty iis:\apppools\coresightadminapppool -name processModel -value @{userName="OSI\CoresightSVC";password="password";identitytype=3} 

 

5. 回收两个Coresight AppPools – 在命令行中运行 iisreset 或者在通过IIS Manager在远端回收AppPool

 

PI Coresight - 安装后工作

 

1. 给PI Coresight 和/或 PI Coresight 管理页面添加权限

 

PI Coresight 应用 - 本地 Windows 用户组 PI Coresight Users 在 PI Coresight 服务器上控制PI Coresight应用的权限。默认情况下经过验证用户组(Authenticated Users group)是其中一个成员。

PI Coresight 管理 - 本地 Windows 用户组 PI Coresight Admins 在 PI Coresight 服务器上控制 PI Coresight 管理的全向。另外一个 PI Coresight 管理员需要是另外一个本地用户组 PI Web API Admins 的成员,以便能允许或者禁用PI Coresight 的PI和AF的来源。默认只用安装Coresight的用户是被加入到这个组当中的.

 

本地用户和组可以从一个工作站上的服务器管理(Server manager)上访问。

 

或者,Poweshell可以被用来添加用户或组到本地用户组当中。比如在CORESIGHTSERVER机器上添加用户 IT.local\AverageJoePI Coresight Admins 本地用户组 ,运行:

$Computer = "CORESIGHTSERVER"  
$Group = "PI Coresight Admins"  
$Domain = "IT.local"  
$UserOrGroup = "AverageJoe"  
([ADSI]"WinNT://$computer/$Group,group").psbase.Invoke("Add",([ADSI]"WinNT://$domain/$userorgroup").path)  

 

Coresight可以配置用任何域或者本地组来运行,具体信息可以参考这篇文档

 

2. 手动创建PI Coresight SQL数据库

 

%pihome64%\Coresight\Admin\SQL 文件夹中所有文件拷贝到一台 SQL Server机器上。

 

使用 robocopy (或者 Windows Explorer复制粘贴功能):

robocopy "C:\Program Files\PIPC\Coresight\Admin\SQL" "\\SQLSERVER\c$\Coresight-SQL" /e  

 

到 SQL Server上,打开一个命令行,导航到含有Coresight SQL文件的文件夹并执行:

GO.BAT DBSERVER DBNAME CoresightAppPoolAccount output.log 

 

比如,在SQL Server MYSQLSERVER上创建一个SQL数据库PICoresight 假设 OSI\CoresightSVC 是运行Coresight AppPools的域账户:

GO.BAT MYSQLSERVER PICoresight OSI\CoresightSVC output.log 

 

对于额外的细节,请参考我们网上的文档

 

最后,连接Coresight应用到Coresight SQL数据库。在网页服务器上,导航到Coresight Admin page > Configuration > PI Coresight Database 并选择合适的SQL Server和SQL数据库

 

注意:因为这个已知的问题, 管理页面会显示Coresight SQL database的连接不健康。要证明这个状况是不是假阳性,到Coresight主页上,创建一个页面并保存,如果这些操作都成功,说明Coresight和SQL Database的连接是没有问题的。

 

3. 在PI Coresight管理页面配置允许的PI和AF数据源

 

额外的PI服务器和AF服务器需要被添加到已知服务器列表(KST)中才能被Coresight使用

 

选项 1) 使用 PI System Explorer (PSE)

 

如果 PSE 在安装AF Client时已经被安装了,可以用它来添加新的PI或者AF服务器。在Server核心版的机器上,使用命令行导航到 %pihome64%\AF (cd /d %pihome64%\AF) 路径下,接着运行AFExplorer.exe.

PSE将会正常打开,在 File > Connections 菜单中可以完成此项工作

 

Option 2) PSE 不可用 - 手动添加PI /AF服务器

 

AF 服务器的信息存储在 AFSDK.config 文件中 (位于 %programdata%\OSIsoft\AF). 在命令行中导航到相应路径,并打开它

cd /d  %programdata%\OSIsoft\AF  
notepad  AFSDK.config  

 

添加一个新的 AF 服务器到 PISystems 集合中:<PISystem name="AFSERVERNAME" host="AFSERVERHOST" protocol="Tcp" port="5457" accountName="" timeout="300" />. Server的唯一 ID 将会在第一次连接时自动生成

 

比如: <PISystem name="CSAFBUILD" host="CSAFBUILD" protocol="Tcp" port="5457" accountName="" timeout="300" /> 将会变成 <PISystem name="CSAFBUILD" id="638f25d4-21ed-44ea-92bb-84305d373578" host="CSAFBUILD" protocol="Tcp" port="5457" accountName="" timeout="300" /> 在第一次连接后

 

 

PI 服务器信息存储在注册表 HKLM\SOFTWARE\PISystem\PI-SDK\1.0\ServerHandles 位置

用Powershell添加新的PI Data Archive - 如果有需要,设置$PI 变量的值。

$PI = "PISERVERNAME"  
$Key = "HKLM:\SOFTWARE\PISystem\PI-SDK\1.0\ServerHandles\" + $PI  
If ( -Not ( Test-Path $Key)){New-Item -Path $Key -ItemType RegistryKey -Force}  
Set-ItemProperty -path $Key -Name "configString" -Type "String" -Value ""  
Set-ItemProperty -path $Key -Name "confirmed" -Type "String" -Value "0"  
Set-ItemProperty -path $Key -Name "defaultServer" -Type "String" -Value "0"  
Set-ItemProperty -path $Key -Name "defaultUser" -Type "String" -Value "pidemo"  
Set-ItemProperty -path $Key -Name "path" -Type "String" -Value $PI  
Set-ItemProperty -path $Key -Name "port" -Type "String" -Value "5450"  
Set-ItemProperty -path $Key -Name "serverID" -Type "String" -Value ""  

 

或者直接在注册表中创建相应的条目

在任何情况下,第一次连接PI Data Archive后ServerID属性会被自动添加。

 

到此为止,PI Coresight + Server 核心版的配置已经全部完成,下一章将介绍 Kerberos配置

stang

AF SDK 开发中级篇

Posted by stang Aug 19, 2016

: 为了更好的利用站内资源营造一个更好的中文开发资源空间,本文为转发修正帖,原作者为OSIsoft技术工程师王曦(Xi Wang),原帖地址:AF SDK 中级篇

 

本帖旨在介绍AF SDK的一些较为复杂函数的用法。

 

以下所有的函数,需要连接好AF服务器,AF数据库,以及一个Element。因此,以下函数将首先完成这个操作:

 

            PISystems AFSDK = new PISystems();                                                                            // 创建连接实例
            PISystem AFServer = AFSDK["XWANG-KQ8HT8KU8"];                                                 // 连接AF服务器
            AFDatabase Connected_Database = AFServer.Databases["training"];                     // 连接AF数据库
            AFElement Connected_Element = Connected_Database.Elements["osisoft"];     // 连接一个Element

 

1. 查询属性的某一时刻值:

 

            AFAttribute myAttribute = Connected_Element.Elements["Beijing"].Elements["test"].Attributes["Attribute2"];  // 指定一个属性
            AFValue Value = myAttribute.GetValue();   

 

2. 查询属性一段时间内的值:

 

            AFTime starttime = new AFTime("*-2h");                                                                                                                         // 定义开始时间
            AFTime endtime = new AFTime("*");                                                                                                                                // 定义结束时间
            AFTimeRange myTimeRange = new AFTimeRange();                                                                                               // 创建时间段实例
            myTimeRange.StartTime = starttime;                                                                                                                             // 确定时间段的开始时间
            myTimeRange.EndTime = endtime;                                                                                                                               // 确定时间段的结束时间

            AFAttribute myAttribute = Connected_Element.Elements["Beijing"].Elements["test"].Attributes["Attribute2"];   // 确定属性名
            AFValues ValueList = myAttribute.GetValues(myTimeRange, 100, null);                                                                 // 将时间段内的值取出

 

3. 按名称查找Element:

 

AFNamedCollectionList<AFElement> myTreeView = AFElement.FindElements(Connected_Database, Connected_Element, "*Beijing*",   AFSearchField.Name, true, AFSortField.Name, AFSortOrder.Ascending, 100);                            // 这个函数比较长,需要的参数比较多对于对应参数的解释请参看AF SDK帮助文件的说明 

 

4. 根据属性查找Element

 

            AFElementTemplate myTemplate = Connected_Database.ElementTemplates["osisoft"];                                                    // 指定需要按属性查找的Element模板
            AFAttributeTemplate myAttribute = myTemplate.AttributeTemplates["speed"];                                                                          // 指定上述模板中的Attribute模板
            AFAttributeValueQuery ValueQuery = new AFAttributeValueQuery(myAttribute, AFSearchOperator.GreaterThan, 0);         // 定义查询的条件
            AFAttributeValueQuery[] ValueArray = {ValueQuery};                                                                                                                        // 将查询条件加入查询条件数组

 

            AFNamedCollectionList<AFElement> myTreeView = AFElement.FindElementsByAttribute(Connected_Element, "*", ValueArray, true, AFSortField.Name, AFSortOrder.Ascending, 100); // 查询element

 

需要注意的是,如果要根据属性来查找Element,这个属性必须基于模板,也就是说,这些找到的Element, 是用模板制作的。

 

下面要讲的部分是AF SDK 2.5新加入的功能。从此版之后,AF SDK将在功能上全面代替PI SDK。在.NET环境中,AF SDK的性能表现也优于PI SDK。

 

1. 连接PI服务器:

 

            PIServers myServers = new PIServers();                                  // 创建实例
            PIServer myServer = myServers["XWANG-KQ8HT8KU8"];    // 连接服务器

 

这个用法与PI SDK极为类似

 

2. 创建点表:

 

             List<PIPoint> myList = new List<PIPoint>();                        // 创建点表实例
            myList.Add(PIPoint.FindPIPoint(myServer, "cdt158"));        // 将需要的点放入点表实例中
            myList.Add(PIPoint.FindPIPoint(myServer, "cdm158"));

 

3. 数据更新:以上两个功能都是为这个功能服务的,这个功能也是AF SDK新增功能中,极为重要的一个,因为它代替了PI SDK中的EVENT PIPE

 

            PIDataPipe myPipe = new PIDataPipe(AFDataPipeType.Snapshot);                                     // 创建一个PIDataPipe实例,用于获取快照值
            myPipe.AddSignups(myList);                                                                                                          // 将点表导入,即获取这些点的快照值
            AFListResults<PIPoint, AFDataPipeEvent> myResults = myPipe.GetUpdateEvents(4);   // 将获取的值导入到 AFListResults类中,用于其他程序调用

 

这里要说明的是:

 

1. myPipe.GetUpdateEvents(4)中的”4“的意思是每个服务器最大的事件采集量,这个DATAPIPE从一个PI服务器中,一次最多获取多少个事件

 

2. 这个功能只能用于从PI服务器中取数,AF属性中连接关系库的数据是不能用这个方法取的

 

3. 用这个功能取数,可以使用时间或事件触发。使用时间触发,推荐使用FOR循环的方式,比较简单;使用事件触发,将会较复杂,需要使用另一个程序进行事件比较,我们会在以后进行更为详细的讨论。

 

***原作到此为止***

 

以下内容是AF SDK 2.6新加入的常用功能简介。

1. AF数据更新

IList<AFAttribute> myList = new IList<AFAttribute>();    // 创建属性表实例
//***IList 中添加属性***

AFDataPipe myPipe = new AFDataPipe()        //创建AFDataPipe实例
myPipe.AddSignups(myList);                         //将属性表导入,即获取该属性的新值
AFListResults<AFAttribute, AFDataPipeEvent> myResults = myPipe.GetUpdateEvents();    //将获取的新值导入到AFListResults类中,用于其他程序调用

 

以下内容是AF SDK 2.7新加入的常用功能简介

1. AF新安全机制

 

2. 未来数据

 

3. 查询式搜索

元素搜索(AFElementSearch)

AFElementSearch eleSearch = new AFElementSearch(AF数据库对象,"对象名称(任选)",“查询字串”);    //创建元素查询式搜索对象
List<AFElement> = eleSearch.FindElements();                                                  //进行搜索,导入元素表实例,用于其他程序调用

Event Frame搜索 (AFEventFrameSearch)

AFEventFrameSearch eleSearch = new AFEventFrameSearch(AF数据库对象,"对象名称(任选)",“查询字串”);    //创建Event Frame查询式搜索对象
List<AFEventFrame> = eleSearch.FindEventFrames();                                                  //进行搜索,导入Event Frame表实例,用于其他程序调用

 

查询字串格式如 Search Query Syntax Overview

 

以下内容是AF SDK 2.8新加入的常用功能简介

1. 数值更改

PI测点数值(PIPoint.ReplaceValues Method )

            AFTime start = new AFTime("-1d");
            AFTime end = new AFTime("*");
            AFTimeRange timeRange = new AFTimeRange(start, end);
            IList<AFValue> myList = new IList<AFValue>();
            //***IList中添加AFValue对象***
            AFErrors<AFValue> afE = new AFErrors<AFValue>();
             afE = myPIPoint.ReplaceValues(timeRange,myList);    //归档里timeRange中的值换成myList中的值

AF属性数值(AFData.ReplaceValues Method )

            AFTime start = new AFTime("-1d");
            AFTime end = new AFTime("*");
            AFTimeRange timeRange = new AFTimeRange(start, end);
            IList<AFValue> myList = new IList<AFValue>();
            //***IList中添加AFValue对象***
            AFErrors<AFValue> afE = new AFErrors<AFValue>();
            afE = myAttribute.Data.ReplaceValues(timeRange,myList);    //属性数据源里timeRange中的值换成myList中的值

 

注:以上方法需要PI Data Archive 2016才能够使用

stang

AF SDK 开发基础篇

Posted by stang Aug 19, 2016

: 为了更好的利用站内资源营造一个更好的中文开发资源空间,本文为转发修正帖,原作者为OSIsoft技术工程师王曦(Xi Wang),原帖地址:AF SDK 基础篇

 

本帖旨在介绍AF SDK的基础功能,包括建立于AF服务器的连接,建立数据库,建立节点,创建节点属性及属性的底层数据连接。本帖所介绍功能不可直接粘贴使用。AF SDK只可使用在.net语言中,因此,以下均为C#程序。

 

连AF服务器

 

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using OSIsoft.AF;
using OSIsoft.AF.Asset;
using OSIsoft.AF.Time;

namespace AF_Element_creation
{
    class Program
    {
        static void Main(string[] args)
        {
            string servername = "XWANG-KQ8HT8KU8";                                                                 // 给一个AF服务器名
            PISystem ConnectedAFServer = AFServerConnect(servername);                                              // 将服务器名作为参数传递给连接函数
            Console.WriteLine("the Connected AF Server is: {0}", ConnectedAFServer.Name.ToString());
            Console.Read();
        }

        static PISystem AFServerConnect(string servername)
        {
            PISystems myAFSDK = new PISystems();                            // 创建一个新的AF SDK实例
            PISystem myAFServer = myAFSDK[servername];                      // 创建AF服务器的链接
            myAFServer.Connect();                                                                    // 连接AF服务器
            return myAFServer;
        }

 

以下的所有函数均需要连接上AF服务器才可使用,因此,连接服务器部分不做重复。

 

1. 创建数据库:

 

static AFDatabase AFDBCreation(string DBName, PISystem ConnectedServer)
        {
            AFDatabase myDB = ConnectedServer.Databases.Add(DBName);                    // 加入一个新的数据库
            return myDB;
        }

 

2. 创建根节点:

 

static AFElement AFRootElementCreation(PISystem ConnectedAFServer)
        {
            AFDatabase ConnectedAFDatabase = ConnectedAFServer.Databases["test"];         // 连接数据库
            AFElement root = ConnectedAFDatabase.Elements.Add("test");                                  // 创建根节点
            root.CheckIn();                                                                                                                          // 执行CheckIn功能
            return root;
        }

 

3. 创建子节点:

 

static AFElement AFElementCreation(PISystem ConnectedAFServer)
        {
            AFDatabase ConnectedAFDatabase = ConnectedAFServer.Databases["test"];                // 连接数据库
            AFElement ConnectedAFElement = ConnectedAFDatabase.Elements["test"];                 // 连接根节点
            lock (ConnectedAFElement)                                                                                                            
            { 
                ConnectedAFElement.CheckOut();                                                                                          // 锁定根节点
            }
            AFElement newElement = ConnectedAFElement.Elements.Add("the first");                      // 创建子节点
            newElement.Description = "this is the description";                                                                // 增加子节点“描述”属性
            ConnectedAFElement.CheckIn();                                                                                                // 解锁子节点
            return newElement;
        }

 

4. 创建属性,及其连接值

 

static AFAttributeCreation(AFElement ConnectedAFElement)
        {
            lock (ConnectedAFElement) {ConnectedAFElement.CheckOut();}                                                                                                                // 锁定子节点
            AFAttribute newAFAttribute_forPIPoint = ConnectedAFElement.Attributes.Add("test for PI Point");                                                          // 创建属性
            newAFAttribute_forPIPoint.Type = typeof(double);                                                                                                                                             // 定义属性数据类型
            AFPlugIn Plugin = ConnectedAFElement.Database.PISystem.DataReferencePlugIns["PI Point"];                                                       // 定义数据连接源为PI数据点
            newAFAttribute_forPIPoint.DataReferencePlugIn = Plugin;                                                                                                                            // 定义属性的数据源连接为PI数据点
            newAFAttribute_forPIPoint.ConfigString = @"\\XWANG-KQ8HT8KU8\cdt158";                                                                                           // 连接PI点的路径

            AFAttribute newAFAttribute_for_RelationalDatabase = ConnectedAFElement.Attributes.Add("test for RelationalDatabase");         // 创建属性
            newAFAttribute_for_RelationalDatabase.Type = typeof(Int32);                                                                                                                      // 定义属性数据类型
            AFPlugIn Plugin2 = ConnectedAFElement.Database.PISystem.DataReferencePlugIns["Table Lookup"];                                          // 定义数据连接源为关系库数据
            newAFAttribute_for_RelationalDatabase.DataReferencePlugIn = Plugin2;                                                                                                // 定义属性的数据源连接为关系库数据
            newAFAttribute_forPIPoint.ConfigString = @"SELECT Number FROM Table1 WHERE people = 'beijing'";                                         // 使用SQL语句连接数据源数据
            ConnectedAFElement.CheckIn();                                                                                                                                                                         // 执行CheckIn功能
        }

 

5. 锁定与释放:

对于AF Element中的各种更改,首先要做的是锁定这个Element为自己操作;当更改完毕后,需要释放这个Element,使之可以被其他人操作。

锁定

private static void LockElement(AFElement e)
        {
            int retries = 0;
            while (retries < 60)
            {
                try
                {
                    lock (e) { e.CheckOut(); }

                    if (e.CheckOutInfo.IsCheckedOutThisThread)
                    {
                        return;
                    }
                }
                catch
                {
                    System.Threading.Thread.Sleep(1000);
                    e.Refresh();
                }

                if (e.CheckOutInfo != null &&
                    e.CheckOutInfo.CheckOutTime.UtcTime < DateTime.UtcNow.AddSeconds(-60))
                    retries++;
            }

            throw new ApplicationException("Cannot obtain lock");
        }:

释放

private static void UnlockElement(AFElement e)
        {
            if (e != null &&
                e.CheckOutInfo != null &&
                e.CheckOutInfo.IsCheckedOutToMe)
            {
                e.CheckIn();
            }
        }:

stang

PI SDK 开发中级篇

Posted by stang Aug 19, 2016

: 为了更好的利用站内资源营造一个更好的中文开发资源空间,本文为转发修正帖,原作者为OSIsoft技术工程师王曦(Xi Wang),原帖地址:PI SDK 中级篇

 

本帖旨在介绍使用PI SDK做一些基本的数据分析,同时,也包括了数据更新的方法,和一些推荐的程序结构。

本帖针对已对PI SDK基础篇比较了解的开发人员。由于OSIsoft在.NET环境下的开发包,已基本由AF SDK取代,因此,本帖只使用C++语言作为PI SDK的开发平台。如果您需要在.NET环境中进行二次开发,请参考AF SDK中级篇。

说明:PI SDK 是过时的技术

 

1. 准备工作

 

在这里的第一段程序,是推荐使用的,进行PI服务器的连接工作,是用子程序的调用方式:

 

static ServerPtr PIServerConnect(_bstr_t servername) 
{
    ::CoInitializeEx(NULL,COINIT_APARTMENTTHREADED);                  // 初始化COM            
    IPISDKPtr spPISDK                                                 // 创建PI SDK连接
    spPISDK.CreateInstance(__uuidof(PISDK));                          // 实例化PI SDK连接
    ServerPtr spServer = spPISDK->GetServers()->GetItem(servername);  // 通过参数,获取连接
    return spServer;                                                  // 返回已连接的服务器指针
}

进行数据的基本分析,需要搜索PI服务器内的点的数据,以下两端子程序,来自PI基础篇的所有点名和搜索点表的子程序:

 

按点名搜索

 

static PIPointPtr GetPIPointsByName(ServerPtr server, _bstr_t tagname)
{
    return server->PIPoints->GetItem(tagname);  // 返回一个PIPoint类型的指针
}

 

按点表搜索:

 

static _PointListPtr SearchPIPoints(ServerPtr server, _bstr_t condition)
{
   return server->GetPoints(condition, NULL); //返回PointList指针类
}

 

2. Variant类型转换: 这是非常重要的部分,后面所有函数的讲解,都要依据此部分的功能

 

PI SDK的大部分函数所需要的参数,都要转换成variant类型,有的传递variant指针,有的传递引用,有的传递二级指针。下面的转换工作将为您展示如何将字符串类型的指针转换成variant类型:

在C++中,字符串指针一般会使用bstr指针类,我们使用这个类型作为例子,进行转换:

 

_bstr_t start = "*-2h";                       // 字符串类起始时间
_variant_t starttime = (_variant_t)start;     // variant类起始时间

 

上面是比较简单的方法,直接做的指针类型强制转换。

下面是做更加通用的方法:

 

_bstr_t start = "*-2h";                                   //起始时间字符串
_PITimeFormatPtr spStart;                                 // 定义PI时间格式指针
spStart.CreateInstance(__uuidof(PITimeFormat));           // 指针实例化
spStart->InputString = start;                             // 指针指向起始时间字符串


VariantInit                                              // 初始化variant指针
V_VT (&starttime) = VT_DISPATCH;                         // 在variant内部类中进行通用指针转换
V_DISPATCH(&starttime) = spStart;                        // 使用dispatch函数,将variant指针指向PI时间格式指针
除了PI的时间,PI的服务器名,PI点名等等,基本都是用这种方法进行格式转换。

 

有了这部分内容后,后面各个函数将省略参数类型转换的功能。

 

功能一:取某一时间段的值(对应PI Datalink中的compressed data功能)

 

static _PIValuesPtr CompressedData (PIPointPtr spPoint, _variant_t starttime, _variant_t endtime)
{    
    return spPoint->Data->RecordedValues(&starttime, &endtime, BoundaryTypeConstants::btAuto, "", FilteredViewConstants::fvRemoveFiltered, NULL);  
}

 

这个函数看似简单,但其中的参数需要说明:

a. 参数starttime和endtime,都是variant &(引用)

b. BoundaryTypeConstants和FilteredViewConstants分别对应的功能就是PI Datalink中的边界类型和标记过滤值的功能

c. 比较不明显的,在参数中,有""参数,它代表的就是PI Datalink中的过滤条件,因为现在为测试,所以过滤条件在这里没有体现

 

功能二:按标准时间间隔显示数据(对应PI Datalink中的采样数据)

 

 

static _PIValuesPtr SampledData (PIPointPtr spPoint, _variant_t starttime, _variant_t endtime)
{    
    return sampled->InterpolatedValues2(&starttime, &endtime, &vtinterval, "", FilteredViewConstants::fvRemoveFiltered, NULL);
}

 

 

此使用的参数与前面一个基本相同,只是多了一个&vtinterval,这个参数同样是variant的引用,意义是采样频率。

 

功能三:数据计算,这部分使用数据在一段时间内,以一个采样频率求和的功能,其他的,类似最大值,最小值等,基本都是使用类似的方法

 

void GetSummariesValues(PIPointPtr spPIPoint, _variant_t vtStart, _variant_t vtEnd, _bstr_t interval)
{
    IPIData2Ptr ipdata2 = (IPIData2Ptr)spPIPoint->Data;                         // 使用PIData2接口类指针
    _NamedValuesPtr summary = ipdata2->Summaries2(vtStart, vtEnd,interval, ArchiveSummariesTypeConstants::asTotal,CalculationBasisConstants::cbEventWeighted,NULL);  // 定义NamedValues指针类
    _variant_t reference = "Total";                                                            
    VARIANT vt_Item = reference;                                                                 // 转换指针为引用
    NamedValuePtr total = summary -> GetItem(&vt_Item);
    spPIValues = (_PIValuesPtr)total->Value;
}

 

这个函数略微有点复杂,原因在于,需要计算的,如和,最大值,最小值,方差等的信息,都存在NamedValues指针类。同时,我们看到了variant指针和variant引用之间的转换方式。

在NamedValue指针类中,使用summary函数,将给定PI点按照时间段和采样频率进行求和。

 

功能四:取值

 

刚才所有的功能,返回的值都是PIValues,也就是类似于一个数组,下面的功能是遍历这个数组中的每一个数:

 

for(long i = 1; i <= spPIValues->Count; i++)
{
    _PIValuePtr spPIValue = spPIValues->GetItem(i);
}

 

这个做法很通俗,就不多讲了

 

功能五:数据更新,在此,默认数据类型是浮点型32位

 

 

HRESULThr = spPIPoint->Data->UpdateValues(spPIValues, DataMergeConstants::dmInsertDuplicates, NULL);

 

数据更新的功能是向PI服务器更新或插入数据,这个函数的使用需要比较小心。

首先,在使用这个函数之前,接口与数据源的数据传递应符合数据源的数据传递协议。当数据到达快照之后,应先使用_PIValuePtr spPIValue = spPIPoint->Data->GetSnapshot()获取点的数据;之后使用

spPIValues->put_ReadOnly(false)将PIValues指针类的写权限打开;然后,spPIValues->Add("*",spPIValue->Value.fltVal + 1,spNVValAttr)将刚才的值写入PIValues指针类;最后,spPIValues->put_ReadOnly(true)将只读打开。

经过上述描述,相信大家已经明白数据更新的过程了。需要说明的是,PIValues指针类可以容纳很多的数据,也就是说,UpdateValues可以支持多点的同时更新。

除了数据的插入,这个函数还可以用作数据替换。您可能已经注意到了dmInsertDuplicates这个参数,同样,如果这个参数被替换成:dmReplaceDuplicates,那么,实现的功能就是替换给定时间的数据。这个时间的设定,就是在spPIValues->Add("*",spPIValue->Value.fltVal + 1,spNVValAttr)中,“*” 表示当前时间,同样,可以使用具体的时间戳进行替换,不过必不可少的就是variant类型的转换。

 

功能六:数据输出更新

 

PI系统的数据传输更新用于向外发送数据,主要使用EVENTPIPE这个工具。如果使用之传输数据,要分两步走

 

1. 创建EVENTPIPE

 

static IEventPipe2Ptr Get_EventPipe (_PointListPtr spPointList)
{
    IEventPipe2Ptr spEventPipe2 = (IEventPipe2Ptr)spPointList->Data->EventPipe;       // 需要使用 IEventPipe2Ptr类型的指针,并且需要已经定义好的点表作为参数,用来明确需要哪些点的数据更新
    spEventPipe2->PollInterval = 2000;                                                // 数据更新频率,单位毫秒
    return spEventPipe2;                                                              // 返回这个指针
}

 

2. 获取数据:

 

void GetValue_EventPipe (EventPipePtr spEventPipe)
{
    while (spEventPipe->Count > 0)
    {
        _PIEventObjectPtr spEventObject = spEventPipe->Take();             // 定义一个PIEventObject类型的指针,获取刚才定义好的EVENTPIPE中的数据
        PointValuesPtr spPointValue = spEventObject->EventData;            // 将这个数据传递给PointValues指针参数
    }
}

 

EVENTPIPE的作用就像一个队列,可以将不同点,不同时间的数据进行存储,当有客户端需要数据时,就把这些数据一次性直接给这个客户端。

 

注释一:PI服务器的值,在C++中的处理

 

PI中存储的值,在C++中是以variant类型存在的,因此,如果需要普通类型的值,可以使用如下的例子,这个例子是OSIsoft德国办公室资深工程师Andreas写的,您可以浏览他的博客,本贴只是加中文注释

 

MyPIValue::MyPIValue (_PIValuePtr pv) {                                                                                            // 将PI的值指针传递进该类,并且对值指针中所包含的内容进行归类分解
       codtTimeStamp = pv->TimeStamp->LocalDate;                                                                               
       bstrTimeStamp = (_bstr_t)codtTimeStamp.Format(_T("%d-%b-%Y %H:%M:%S"));
       DigitalStatePtr tmpDigitalState = NULL;
       IDispatchPtr    tmpDispatch = NULL;
       _PITimePtr      tmpPITime = NULL;
       COleDateTime    tmpTS;
       HRESULT         hr = E_FAIL;

 

       _variant_t vT = pv->Value;                                                                                                              // 过去值指针中的点的数据
       vt = vT.vt;

 

       switch (vT.vt) {
       case VT_I4:                                                                                                                                      // variant VT_I4类存储的是整形32位
              // Int32
              intValue = vT.lVal;
              dblValue = intValue;
              bstrValue = (_bstr_t)intValue;
              break;
       case VT_I2:                                                                                                                                      // variant VT_I2类存储的是整形16位
              // Int16
              intValue = vT.iVal;
              dblValue = intValue;
              bstrValue = (_bstr_t)intValue;
              break;
       case VT_R8:                                                                                                                                    // variant VT_R8类存储的是浮点形64位
              // Float64
              dblValue = vT.dblVal;
              intValue = (int)dblValue;
              bstrValue = (_bstr_t)dblValue;
              break;
       case VT_R4:                                                                                                                                    // variant VT_R4类存储的是浮点形32位
              // Float16/Float32
              dblValue = vT.fltVal;
              intValue = (int)dblValue;
              bstrValue = (_bstr_t)dblValue;
              break;
       case VT_BSTR:                                                                                                                              // variant VT_BSTR类存储的是字符串类
              // String
              bstrValue = vT.bstrVal;
              dblValue = 0;
              intValue = 0;
              break;
       case VT_DISPATCH:                                                                                                                      // variant VT_DISPATCH类存储的是数字类型,这是最复杂的
              // Digital?                                                                                                                                   // 首先需要拿到数字类型表示的内容
              tmpDispatch = vT.pdispVal;
              hr =  tmpDispatch.QueryInterface(__uuidof(DigitalState),&tmpDigitalState);
              if (hr == S_OK) {
                     bstrValue = tmpDigitalState->Name;
                     intValue = tmpDigitalState->Code;
                     dblValue = intValue;
              }
              // Timestamp?                                                                                                                           // 然后然后获取数字类型值的时间戳
              hr =  tmpDispatch.QueryInterface(__uuidof(_PITime),&tmpPITime);
              if (hr == S_OK) {
                           tmpTS = tmpPITime->LocalDate;
                           bstrValue = (_bstr_t)tmpTS.Format(_T("%d %B %Y %H:%M:%S"));
                           intValue = 0;
                           dblValue = 0;
              }
              break;
       default :
              dblValue = 0.0;
              intValue = 0;
              bstrValue = "n/a";
              break;
       }
};

注释二:后续工作---指针清空,关闭COM

 

为了保证没有内存泄露的情况,在程序的最后,需要清空指针,还要进行:

 

::CoUninitialize();

 

用于关闭COM LIBARAY

 

以上是各个功能模块的介绍,下面是一个用PI SDK进行求和工作的完整程序,也是推荐的程序结构方式:

 

#include "stdafx.h"                                    
#include <iostream> 
#include <string>
#include "ATLComTime.h" //for COleDateTime

#import "C:\Program Files\PIPC\PISDK\PISDKCommon.dll" no_namespace
#import "C:\Program Files\PIPC\PISDK\PITimeServer.dll" no_namespace
#import "C:\Program Files\PIPC\PISDK\PISDK.dll" rename("Connected", "PISDKConnected") no_namespace
VOID WINAPI Sleep(_In_ DWORD dwMillisecons);                                                                                                                          // 以上为程序头文件

class MyPIValue                                                                                                                                                                                       // 建立一个PIValue的默认类
{
    _PIValuePtr spPIValue;
public:
    MyPIValue (_PIValuePtr);
    double dblValue;
    int intValue;
    _bstr_t bstrValue;
    _bstr_t bstrTimeStamp;
    COleDateTime codtTimeStamp;
    VARTYPE vt;

};

MyPIValue::MyPIValue (_PIValuePtr pv) {                                                                                                                                               // 建立一个翻译PIValue的类
       codtTimeStamp = pv->TimeStamp->LocalDate;
       bstrTimeStamp = (_bstr_t)codtTimeStamp.Format(_T("%d-%b-%Y %H:%M:%S"));
       DigitalStatePtr tmpDigitalState = NULL;
       IDispatchPtr    tmpDispatch = NULL;
       _PITimePtr      tmpPITime = NULL;
       COleDateTime    tmpTS;
       HRESULT         hr = E_FAIL;

       _variant_t vT = pv->Value;
       vt = vT.vt;

       switch (vT.vt) {
       case VT_I4:
              // Int32
              intValue = vT.lVal;
              dblValue = intValue;
              bstrValue = (_bstr_t)intValue;
              break;
       case VT_I2:
              // Int16
              intValue = vT.iVal;
              dblValue = intValue;
              bstrValue = (_bstr_t)intValue;
              break;
       case VT_R8:
              // Float64
              dblValue = vT.dblVal;
              intValue = (int)dblValue;
              bstrValue = (_bstr_t)dblValue;
              break;
       case VT_R4:
              // Float16/Float32
              dblValue = vT.fltVal;
              intValue = (int)dblValue;
              bstrValue = (_bstr_t)dblValue;
              break;
       case VT_BSTR:
              // String
              bstrValue = vT.bstrVal;
              dblValue = 0;
              intValue = 0;
              break;
       case VT_DISPATCH:
              // Digital?
              tmpDispatch = vT.pdispVal;
              hr =  tmpDispatch.QueryInterface(__uuidof(DigitalState),&tmpDigitalState);
              if (hr == S_OK) {
                     bstrValue = tmpDigitalState->Name;
                     intValue = tmpDigitalState->Code;
                     dblValue = intValue;
              }
              // Timestamp?
              hr =  tmpDispatch.QueryInterface(__uuidof(_PITime),&tmpPITime);
              if (hr == S_OK) {
                           tmpTS = tmpPITime->LocalDate;
                           bstrValue = (_bstr_t)tmpTS.Format(_T("%d %B %Y %H:%M:%S"));
                           intValue = 0;
                           dblValue = 0;
              }
              break;
       default :
              dblValue = 0.0;
              intValue = 0;
              bstrValue = "n/a";
              break;
       }
};



IPISDKPtr       spPISDK = NULL;            /* The PISDK */                                                                                              // 初始化所有需要用的指针
PISDKVersionPtr spSDKVersion = NULL;       /* PI SDK Version */
ServerPtr       spServer = NULL;           /* The Server */
PIPointPtr      spPIPoint = NULL;          /* The PI Point */
_PIValuePtr     spPIValue = NULL; 
_PIValuesPtr     spPIValues = NULL;        /* The PI value */
_PITimeFormatPtr spStartTime = NULL;
_PITimeFormatPtr spEndTime = NULL;

void GetSummariesValues(PIPointPtr spPIPoint, _variant_t vtStart, _variant_t vtEnd, _bstr_t interval)                                // 创建子函数
{
    IPIData2Ptr ipdata2 = (IPIData2Ptr)spPIPoint->Data; 
    _NamedValuesPtr summary = ipdata2->Summaries2(vtStart, vtEnd,interval, ArchiveSummariesTypeConstants::asTotal,CalculationBasisConstants::cbEventWeighted
        ,NULL);
    _variant_t reference = "Total";
    VARIANT vt_Item = reference;
    NamedValuePtr total = summary -> GetItem(&vt_Item);
    spPIValues = (_PIValuesPtr)total->Value;
    for (long i = 1; i <= spPIValues->Count; i++)
    {
        spPIValue = spPIValues->GetItem(i);
        MyPIValue t(spPIValue);
        std::cout << t.bstrTimeStamp << " ";
        std::cout << t.bstrValue << std::endl;
    }
     total.Release();
     summary.Release();
}


int _tmain(int argc, _TCHAR* argv[])
{
       // Initialize COM
       ::CoInitializeEx(NULL,COINIT_APARTMENTTHREADED);
       // Check the command line switches
       if (argc < 6) {
              std::cout << "Command Line:" << std::endl
                        << (_bstr_t)argv[0] << " SERVERNAME TAGNAME starttime endtime interval";
              return (1);
       }
       try                                   
       {
              // Create an instance of the PI SDK                                                                                              // 主函数中连接PI服务器,也可使用子函数调用的方式
              spPISDK.CreateInstance(__uuidof(PISDK));
              // Print out the PI SDK version
              spSDKVersion = spPISDK->PISDKVersion;
              std::cout << std::endl << "PI-SDK Version "
                        << spSDKVersion->Version << " Build "
                        << spSDKVersion->BuildID << std::endl;
              // get the PI Server
              spServer = spPISDK->GetServers()->GetItem((_bstr_t)argv[1]);                                                                    // 从输入参数1中获取PI服务器名
              spPIPoint = spServer->PIPoints->GetItem((_bstr_t)argv[2]);                                                                          // 从输入参数2中获取点名
              spStartTime.CreateInstance (__uuidof(PITimeFormat));
              spEndTime.CreateInstance (__uuidof(PITimeFormat));
              spStartTime->InputString = argv[3];                                                                                                                     // 从输入参数3中获取起始时间
              spEndTime->InputString = argv[4];                                                                                                                      // 从输入参数4中获取截止时间
              _bstr_t interval = argv[5];                                                                                                                                        // 从输入参数5中获取采样频率

              
              _variant_t vtStart;
              VariantInit (&vtStart);
              V_VT (&vtStart) = VT_DISPATCH;
              V_DISPATCH(&vtStart) = spStartTime;

              _variant_t vtEnd;
              VariantInit (&vtEnd);
              V_VT (&vtEnd) = VT_DISPATCH;
              V_DISPATCH(&vtEnd) = spEndTime;

              GetSummariesValues(spPIPoint, &vtStart, &vtEnd, interval);
              // You can use more than just one tagname
              /*for (int ii = 2; ii< argc; ii++) {
                     // Tagname
                     std::cout << (_bstr_t)argv[ii] << std::endl;
                     spPIPoint = spServer->PIPoints->GetItem((_bstr_t)argv[ii]);
                     // Snapshot
                     spPIValue = spPIPoint->Data->Snapshot;
                     MyPIValue mPV(spPIValue);
                     std::cout << mPV.bstrTimeStamp << " ";
                     std::cout << mPV.bstrValue << std::endl;
              }*/
              V_VT (&vtStart) = VT_EMPTY;
              spStartTime.Release();
              V_VT (&vtEnd) = VT_EMPTY;
              spEndTime.Release();                                                                                                                                   // 以下为指针释放,整个程序中最需要注意的部分

             

              spPIValue.Release();
              spPIValues.Release();
              spPIPoint.Release();
              spSDKVersion.Release();
              spPISDK.Release();

       }
       catch( _com_error Err )
       {
              std::cout << "Error: "
                        << Err.Description()
                        << " : "
                        << Err.Error()
                        << std::endl;
              return (1);
       }
       Sleep(5000);
       return 0;
}
stang

PI SDK 开发基础篇

Posted by stang Aug 19, 2016

: 为了更好的利用站内资源营造一个更好的中文开发资源空间,本文是转发修正帖,原作者为OSIsoft技术工程师王曦(Xi Wang),原帖地址:PI SDK 基础篇

 

本帖旨在介绍使用PI SDK进行开发之初的基本功能。如服务器连接,搜索PI点,读取快照值,读取归档值等。基本程序提供C++C#两种语言的编写方法。这两种语言都需调用PI SDK函数包中一些基本函数库:PISDKPISDKCommonPITimeServer。

说明:本帖中的程序段仅适用于功能性的介绍,不宜直接复制使用,因为程序段之中没有加入任何错误警告功能或抛出例外

说明:PI SDK 是过时的技术

 

 

1. 连PI接服务器

 

C++ 程序

 

#include "stdafx.h"
#include <iostream>
#include <string>
#include "ATLComTime.h"   //for COleDateTime

#import "C:\Program Files\PIPC\PISDK\PISDKCommon.dll" no_namespace
#import "C:\Program Files\PIPC\PISDK\PITimeServer.dll" no_namespace
#import "C:\Program Files\PIPC\PISDK\PISDK.dll" rename("Connected", "PISDKConnected") no_namespace

IPISDKPtr       spPISDK = NULL; //定义新的PISDK指针类
ServerPtr       spServer = NULL; //定义新的PI服务器指针类

// 定义PI服务器连接函数 --- PIServerConnet()

static ServerPtr PIServerConnect(_bstr_t servername)
{
    ::CoInitializeEx(NULL,COINIT_APARTMENTTHREADED); //初始化COM
    spPISDK.CreateInstance(__uuidof(PISDK)); //在COM中初始化新的PISDK指针类
    spServer = spPISDK->GetServers()->GetItem(servername);  //通过传递进来的服务器名来连接该服务器。   注:需要使用_bstr_t字符串类型参数
    return spServer; //返回PI服务器指针
}

int _tmain(int argc, _TCHAR* argv[])
{
    _bstr_t servername = "XWANG-KQ8HT8KU8"; //定义服务器名。
    spServer = PIServerConnect(servername); //接收返回的的PI服务器指针类型
    return 0;
}

 

C#程序

 

using System;
 using System.Collections.Generic;
 using System.Linq;
 using System.Text;
 using PISDK;
 using PISDKCommon;
 using PITimeServer;

namespace DemPISDK
 {
    class Program
    {
        static void Main(string[] args)
        {
            Server server = ConnectToServer("servername");  //获取返回的PI服务器类型
        }

         private static Server ConnectToServer(string servername)
         {
             PISDK.PISDK pisdk = new PISDK.PISDK();            //定义新的PISDK类
             Server server = null; //定义新的PI服务器类
             server = pisdk.Servers[servername]; //获取服务器名
            server.Open(); //连接PI数据库
             return server;      
         }
    }
}

 

以下所有的功能都将在连接上PI 服务器之后才能实现,因此,将省略PI服务器连接这一部分

 

2. 创建PI点

 

创建单点

 

C++ 程序

 

static PIPointPtr CreatePIPoint (ServerPtr spServer)
 {
    _NamedValuesPtr nvAttribues = NULL; // 定义PI点的属性
    return spServer->PIPoints->Add("test1","classic",PointTypeConstants::pttypFloat32,nvAttribues); // 创建PI点
 }

 

C# 程序

 

private static PIPoint CreatePIPoint ( Server server)
{
    NamedValues nvAttributes nvAttributes = new NamedValues(); // 定义PI点的属性
    return server.PIPoints.Add("test1", "classic", PointTypeConstants.pttypeFloat32, nvAttributes); // 创建PI点
}

创建多点

 

C++程序

 

static void PointsCreation (ServerPtr spServer)
{
    IPIPoints2Ptr spipipoints2 = (IPIPoints2Ptr)spServer->PIPoints; // 创建 IPIPoints2指针,并让其指向传入ServerPtr指针的那片区域

     _variant_t description = "test"; // 创建“描述”属性的variant类型
     _variant_t engunits = "m"; // 创建“工程单位”属性的variant类型
     _variant_t classtype = "classic"; // 创建“点的种类”属性的variant类型
     _variant_t pt = PointTypeConstants::pttypFloat32; // 创建“点的数据类型”属性的variant类型
 
     _NamedValuesPtr nvAttributes; // 创建一个指向点属性的指针
    nvAttributes.CreateInstance(__uuidof(NamedValues)); // 为这个指针创建一片空间,用于存储点的属性
    nvAttributes->Add("descriptor", &description); // 增加“描述”属性
    nvAttributes->Add("engunits", &engunits);
    nvAttributes->Add("ptclassName", &classtype);
    nvAttributes->Add("pointType", &pt);
 
     _variant_t var_nvAttributes; // 创建一个variant类型的指针
    VariantInit(&var_nvAttributes); // 初始化对于上面指针的二级指针为VT_EMPTY
     V_VT (&var_nvAttributes) = VT_DISPATCH; // 将这个二级指针转变为VT_DISPATCH类型
     V_DISPATCH(&var_nvAttributes) = nvAttributes; // 将这个二级指针指向点属相的指针
 
     _NamedValuesPtr nvPoints; // 创建一个定义PI点表的指针
    nvPoints.CreateInstance(__uuidof(NamedValues)); // 为该指针定义一片空间
     nvPoints->Add("test2", &var_nvAttributes); // 加入点名,及其属性
     nvPoints->Add("test3", &var_nvAttributes);
 
     _PIErrorsPtr Errors; // 创建一个PIError的指针
     Errors.CreateInstance(__uuidof(PIErrors)); // 为该指针定义一片空间
     _PIErrors **ErrorsPtr = &Errors; // 为该指针定义一个二级指针
 
     _PointListPtr PointList; // 创建一个PointList的指针
    PointList.CreateInstance(__uuidof(PointList)); // 为该指针定义一片空间
     _PointList **PointListPtr = &PointList; // 为该指针定义一个二级指针 
    spipipoints2->AddTags(nvPoints,ErrorsPtr,PointListPtr,NULL); // 使用之前定义的IPIPoints2类型的指针加入点表
}

这个程序相对较复杂,主要使用了C++中的标准DISPATCH接口类型

 

C#程序

 

private static PointList CreatePIPoints(Server server)
 {
    NamedValues nvTags = new NamedValues();
 
     NamedValues nvAttributes = new NamedValues();
 
    nvAttributes.Add("descriptor", "Test Description");
    nvAttributes.Add("ptclassname", "classic");
    nvAttributes.Add("pointsource", "L");
    nvAttributes.Add("pointtype", PointTypeConstants.pttypFloat32);
 
    nvTags.Add("testAddTag", nvAttributes);
    nvTags.Add("testAddTags001", nvAttributes);
    nvTags.Add("testAddTags002", nvAttributes);
    nvTags.Add("testAddTags003", nvAttributes);
 
     PIErrors errs = new PIErrors();
     PointList ptlist = new PointList();
     IPIPoints2 ipipoints2 = (IPIPoints2)server.PIPoints;
    ipipoints2.AddTags(nvTags, out errs, out ptlist);
 
     return ptlist;
 }

相比起C++程序,C#程序更为通俗

 

这两段程序值得注意的是,在点的创建过程中,点属性中的pointclass和pointtype是必须创建并设定的,如果没有,所有的点是不能被创建的

 

3. 搜点

 

C++程序

 

static PIPointPtr GetPIPointsByName(ServerPtr server, _bstr_t tagname)
 {
    return server->PIPoints->GetItem(tagname); // 返回一个PIPoint类型的指针
}

 

C#程序:

 

private static PIPoint GetPIPointByName(Server server, String tagname)
 {
    return server.PIPoints[tagname]; // 返回一个PIPoint类型的指针
 }

 

按条件搜点表


C++程序

 

static _PointListPtr SearchPIPoints(ServerPtr server, _bstr_t condition)
 {
    return server->GetPoints(condition, NULL);            //返回PointList指针类
 }

 

C#程序

 

private static PointList SearchPIPoints(Server server, String condition)
 {
    return server.GetPoints(condition);                   
 }

4. 编辑点

 

按编辑单点的特定属性

 

C++程序

 

static void TagEdit (ServerPtr spServer)
{
    _bstr_t tagname = "test2"; // 给出点名
     PIPointPtr spPoint; // 创建PIPointPtr类指针接收点的一切信息
     spPoint = spServer->PIPoints->GetItem(tagname); // 将点名传给spPoint指针
 
     _bstr_t tag_description = "descriptor"; // 定义需要调整的属性
     PointAttributePtr pa_attribute = spPoint->PointAttributes->GetItem(tag_description);   // 将属性指针指向之前定义的需要调整的属性
     spPoint->PointAttributes->ReadOnly = VARIANT_FALSE; // 将只读属性关闭
     pa_attribute->Value = "test for tag edit"; // 更改需要调整属性的值
     spPoint->PointAttributes->ReadOnly = VARIANT_TRUE; // 将只读属性打开
}

C# 程序

 

private static void EditPIPoint(PIPoint pt)
 {
     Server server = new Server;

     server.PIPoints[test2];

     PointAttribute attr = pt.PointAttributes["descriptor"];
    pt.PointAttributes.ReadOnly = false;
     attr.Value = "new description";
    pt.PointAttributes.ReadOnly = true;
 }

编辑一组点

 

C++程序

 

static void EditPoints (ServerPtr, spServer)
{
    _bstr_t condition = "tag='test*'"; // 给定编辑点的搜索条件
     _PointListPtr ptlist; // 创建一个点表指针
     ptlist = spServer->GetPoints(condition,NULL); // 将按条件搜索出的点存储到点表里
     _NamedValuesPtr nvTags; // 创建一个接收点表信息的指针
    nvTags.CreateInstance(__uuidof(NamedValues)); // 分配内存区域
     _NamedValuesPtr nvAttributes; // 创建一个接收点属性的指针
     nvAttributes.CreateInstance(__uuidof(NamedValues)); // 分配内存区域
     _variant_t descriptions = "test for points edit"; // 将需要更改的信息创建成 _variant_t类型
 
     nvAttributes->Add("descriptor", &descriptions); // 将修改的信息存储至之前创建的接收点属性的指针指向的区域
     _variant_t var_attributes; // 创建一个新的_variant_t类型参数
    VariantInit(&var_attributes); // 初始化_variant_t类型参数 
     V_VT(&var_attributes) = VT_DISPATCH; // 将_variant_t类型参数转变成VT_DISPATCH接口类型参数
     V_DISPATCH(&var_attributes) = nvAttributes; // 将VT_DISPATCH接口类型参数等同于之前存储属性的那片区域
 
     for (int i = 1; i <= ptlist->Count; i++) // 这个FOR循环是为将符合条件的所有的点的点名和属性加入到指向点表信息指针指向的内存区域
     {
         _variant_t vi = i;
         PIPointPtr spTag = ptlist->Item[&vi];
         nvTags->Add(spTag->Name, &var_attributes);
     }
 
     _PIErrorsPtr Errors; // 需要实例化一个PIErrors
     Errors.CreateInstance(__uuidof(PIErrors));
     _PIErrors **ErrorsPtr = &Errors; // 用一个二级指针指向这个实例
 
     IPIPoints2Ptr ipi_points2 = (IPIPoints2Ptr)spServer->PIPoints;  // 使用 IPIPoints2Ptr类型指针指向点表
     ipi_points2->EditTags(nvTags, &Errors, NULL); // 使用上述指针类里的编辑点的函数,将点表中所有的点的信息做更改
}

 

C#程序

 

private static void EditPIPoints(Server server, PointList ptlist)
 {
     NamedValues nvTags = new NamedValues();
     NamedValues nvAttributes = new NamedValues();
 
    nvAttributes.Add("descriptor", "edited description");

    foreach(PIPoint pt in ptlist)
     {
        nvTags.Add(pt.Name, nvAttributes);
     }
 
     PIErrors errs = new PIErrors();
 
     IPIPoints2 ipipoints2 = (IPIPoints2)server.PIPoints;
     ipipoints2.EditTags(nvTags, out errs);
 
     foreach (PIError err in errs)
     {
        Console.WriteLine(err.Description);
     }
 }

在C#程序中,没有写点表如何获得的,只是直接调用之前按条件搜索点表的程序,原理是一样的

 

以下内容为如何从PI服务器中取出点/点表的一些值。这些程序是基于点的操作,因此,将不再重复如何搜索点/点表。如果使用下述函数,请首先参看本帖第三部分---搜索点/点表

 

5. 取快照值

 

取单快照值

 

C++程序

 

static _PIValuePtr GetSnapshot(PIPointPtr pt)         // 传入点信息
 {
    return (_PIValuePtr)pt->Data->GetSnapshot();
 }

 

C#程序

 

private static PIValue GetSnapshot(PIPoint pt)
 {
    return pt.Data.Snapshot;
 }

取点表快照

 

C++程序

 

static PointValuesPtr GetSnapshot(_PointListPtr sppointlist) // 传入点表信息
 {
    PointValuesPtr ptValues = sppointlist->Data->GetSnapshot(NULL);
    return ptValues;
 }

 

C#程序

 

 

private static PointValues GetSnapshot(PointList ptlist)
 {
    NamedValues nvErrs = new NamedValues();
    PointValues ptvalues = ptlist.Data.get_Snapshot(out nvErrs);
 }

 

6. 取某时刻历史数据

单点某时数据

 

C++程序

 

static _PIValuePtr GetArchive(PIPointPtr pt)
 {
    _bstr_t time = "*-2h"; // 以下内容为将字符串时间转化为_variant_t 类型的时间
    _PITimeFormatPtr sptime;
    sptime.CreateInstance (__uuidof(PITimeFormat));
    sptime->InputString = time;
    _variant_t vtStart;
    VariantInit (&vtStart);
    V_VT (&vtStart) = VT_DISPATCH;
    V_DISPATCH(&vtStart) = sptime; 
    return (_PIValuePtr)pt->Data->ArcValue(vtStart, RetrievalTypeConstants::rtAuto, NULL);      // 将PI点指针类型的指针转换成PI Value类型的指针,并执行函数。
 }

C#程序

 

private static PIValue GetArchive(PIPoint pt)
 { 
    PITimeFormat time = new PITimeFormat();
    time.InputString = "*-2h";
    return pt.Data.ArcValue(time, RetrievalTypeConstants.rtAuto);
 }

这边文档翻译自pisquare相同名字的博客,想要看到更多信息可以参考pisquare上的相关内容。Coresight Squared

这个系列目前包括以下三个内容:

  1. windows Server核心版安装和配置<<您现在在这里
  2. PI Coresight安装
  3. Kerberos配置

 

Server核心版 - 安装和配置

 

Server核心版是安装Windows Server2012 R2时的默认设置:

 

第一次登陆您的Server Core机器 - 在欢迎界面只有一个命令行!

用服务器配置工具 (sconfig) 来重命名机器, 配置 DNS 设置, 加入一个Windows 域, 启用 Windows 更新, 启用Remote Management远程管理等等.

要使用这个工具, 在命令行中执行sconfig。使用sconfig很容易, 不过我建议按照如下方式进行:

 

1. 配置DNS设置

选择 Option 8 > select index of the Ethernet card(选择网卡的id) > 选择 Option 2 (Set DNS Servers)(选择DNS Server) > set preferred (and alternate) DNS server(s) (选择备用DNS Server)

2. 将电脑添加到Windows域当中

选择Option 1 > 选择 D 作为域 > 输入域名 > 确认并完成

3. 重命名电脑 - 这个选项在电脑加入Windows 域之后会自动弹出.

4. 重启 - 在sconfig中使用Option 13.

 

5. 启用Windows更新

选择 Option 5 > 选择 A 作为自动

6. 配置入站防火墙设置

使用Powershell, 启用文件和防火墙共享 进站规则以便将PI Coresight安装文件拷贝到这台机器上。这个规则在安装完Coresight之后可以被禁用

 

Enable-NetFirewallRule -DisplayGroup "File And Printer Sharing"  

 

为了更好的远程管理,启用如下防火墙规则

Enable-NetFirewallRule -DisplayGroup "Remote Event Log Management"  
Enable-NetFirewallRule -DisplayGroup "Remote Service Management"  
Enable-NetFirewallRule -DisplayGroup "Remote Volume Management"  

7. 激活所有PI Coresight需要的角色和功能

 

使用 CSRolesFeatures.ps1 (这个post的附件或者可以在 pastebin找到) 可以迅速完成这项工作。使用robocopy将此文件拷贝到核心版Server的机器上(命令行中有此工具)或者使用Windows Explorer的复制和粘贴功能。

 

比如,从本地D:\Downloads文件夹下将 CSRolesFeatures.ps1 拷贝到CORESQUAREDC:\Temp 使用 robocopy:

 

robocopy "D:\Downloads" "\\CORESQUARED\C$\Temp" CSRolesFeatures.ps1

 

 

在核心版服务器上打开PowerShell对话框 (在命令行中执行 powershell 命令) 并允许在当前session执行脚本,并运行此脚本。

Set-Executionpolicy RemoteSigned -Scope Process  
.\CSRolesFeatures.ps1 -Mode Install -IsCore $true  

 

当此脚本运行完成后,在命令行中用shutdown /r /t 0命令重启机器

 

Server 核心版 – 启用远程管理

 

使用sconfig > 选择 Option 4 > 选择 option 1 来启用远程管理。

 

使用远程管理来添加/删除Windows功能, 维护本地用户和组,查看事件日志等

 

remote IIS Management需要Web Server Management Service。用 PowerShell来 安装此服务并且设置相关的注册表配置:

Install-WindowsFeature Web-Mgmt-Service  
Set-ItemProperty -Path HKLM:\SOFTWARE\Microsoft\WebManagement\Server -Name EnableRemoteManagement -Value 1  

最后用 net start WMSVC启动Web Management service。您也可以将这个服务设为自动:sc config wmsvc start=auto

 

现在Server核心版可以完全被远程的workstation管理了(Server Manager 用于常用的管理, IIS Manager 用于IIS的管理)!

 

要远程连接Server核心版的IIS,在远程任意一台机器上打开IIS Manager,右键选择 Start Page 并选择 Connect to a Server... 选项:

“PI System新功能介绍” 在线研讨会已经圆满结束,我们希望您能觉得参加这次交流会是一次收获丰富的愉快经历,能够帮助你更好的了解最新发布的 PI System,让您在日后的工作中更好的使用 PI System,提高工作效率并推动创新。

 

您可以通过以下链接,下载本次会议的 PPT 资料:

 

 

 

如果您有任何问题,或是想进一步的咨询有关 PI System的产品信息,请在本帖留言或者通过以下电子邮件与我们保持联系 marketingcn@osisoft.com 。我们将为您做进一步的安排。

“如何让 PI AF 为您所用”在线研讨会已经圆满结束,我们希望您能觉得参加这次交流会是一次收获丰富的愉快经历,通过基于AF架构的案例分享,对您的日常工作能有所启发。

 

您可通过以下链接下载本次会议的资料:

 

  • 会议时间: 2016614日,星期二 时间:上午10 - 11
  • 会议录像:点此回看或是下载
  • 王普乐 《如何让PI
         AF
    为您所用》:点此下载PPT
  • 孙玉鹏 《蓝星PI
         AF
    应用案例分享》:点此下载PPT
  • 马天明 《南通星辰PI AF应用案例分享》:点此下载PPT

 

 

如果您有任何问题,或是想进一步的咨询有关 PI AF 的产品信息,请在本帖留言或者通过以下电子邮件与我们保持联系 marketingcn@osisoft.com 。我们将为您做进一步的安排。




PI Coresight 2016 在线研讨会已经圆满结束,我们希望您能觉得参加这次交流会是一次收获丰富的愉快经历,能够帮助你更好的了解 如何PI Coresight 实现 PI System 数据可视化。


您可通过以下链接下载本次会议的资料:

 

如果您有任何问题,或是想进一步的咨询有关 PI Coresight的产品信息,可以在本帖留言,或者通过以下电子邮件与我们保持联系 marketingcn@osisoft.com 。我们将为您做进一步的安排。




PI Coresight 2016 在线研讨会已经圆满结束,我们希望您能觉得参加这次交流会是一次收获丰富的愉快经历,让您对PI Coresight 2016 有了初步的了解。

您可通过以下链接下载本次会议的资料:

 

  • 会议时间:2016 年719日,星期二,上午10-11
  • 会议录像:点此回看或是下载
  • 徐初 PI Coresight
         2016
    介绍》:点此下载PPT
  • 张新桥《PI Coresight 应用初探》:点此下载PPT

 

 

如果您有任何问题,可以在本帖下留言,或是想进一步的咨询有关 PI Coresight2016 的产品信息,也可以通过以下电子邮件与我们保持联系marketingcn@osisoft.com 。我们将为您做进一步的安排。




PI Coresight 2016相比于之前版本有非常大的变化,其中一项重要的改进是允许用户自己添加自定义的图案。pisquare中已经有非常多相关的post,如添加谷歌地图,添加RSS种子添加时间轴等等,并且不断有新的post更新。相关的配置文档可以在此处找到,此外在github上有关于custom symbol比较详细的介绍,下面结合其中一个案例(单个值的图形),简单介绍一下创建custom symbol的基本方法,和一些配置参数。

在PI Coresight的安装文件夹下INSTALLATION_FOLDER\Scripts\app\editor\symbols\ext创建名为sym-simplevalue.js的文件。如果ext文件夹不存在,您需要手动创建此文件夹。

将如下代码添加到刚创建的js文件中,这会初始化用于创建custom symbol的结构。这个代码创建了一个IIFE(immediately invoked functional expression,立即执行函数),此函数将会取到将会被用来注册symbol的PI Coresight对象

(function (CS) {
})(window.Coresight);

创建一个定义对象,并注册。这里symbol catalog是一个我们用来注册和管理所有Coresight symbols。我们这样会创建一个空的对象,并将其传递到注册函数中。因为这是一个立即执行函数,一旦浏览器执行它,它将会运行这个注册的代码

(function (CS) {
    var definition = {};
    CS.symbolCatalog.register(definition);
})(window.Coresight);

接下来我们,开始添加一个新的图案中必须的部分:

typeName是PI Coresight注册时使用的一个内部名字。这个名字在所有Coresight的图案中必须是唯一的。

datasourceBehavior用来指定有多少搜索结果(None用来表示静态值,Single表示单个值,Multiple表示多个值。此处我们使用单个值,如果需要画自定义的trend,那就需要多个值,即multiple)可以被用来创建这个图案。

(function (CS) {
    var definition = {
        typeName: 'simplevalue',
        datasourceBehavior: CS.DatasourceBehaviors.Single
    };
    CS.symbolCatalog.register(definition);
})(window.Coresight);

接下来,我们将添加一些具体使用的信息:这里我们会添加getDefaultConfig属性。这个函数是用来指定一系列symbol形态的参数的。如这里我们指定datashape为Value,那我们会显示一个value的图案

(function (CS) {
   var definition = {
  typeName: 'simplevalue',
  datasourceBehavior: CS.DatasourceBehaviors.Single,
   getDefaultConfig: function() {
   return {
  DataShape: 'Value'
  };
  }
  };
   CS.symbolCatalog.register(definition);
})(window.Coresight);

在继续完善之前的代码之前,我们现在与之前js文件相同的文件夹下创建一个名为sym-simplevalue-template.html的函数,这里命名的规则是:sym-<图案类型名>-template.html。这是一个symbol框架会默认去寻找的名字,如果template路径没有在symbol中被指定的话(可以通过templateUrl来指定)。加入以下内容到HTML文件。这里现在只是一个占位符。

<div style="background: red">
    <div>Simple Value</div>
</div>

这里,为了让这个心得图案被PI Coresight 网页服务器接收到,需要运行IIS reset

接下来,打开Coresight的页面,搜索一个PI点或者AF属性,将该属性拖动到画布中。您会发现当您放下这个item之后,您还无法选择它。这是因为这个图案没有包括一个init函数。

为了修复这个问题,我们需要更新getDefaultConfig函数,让它返回高(Height)和宽(Width)。此外我们需要添加初始化(initialization)函数到definition对象中。init函数是在图案被添加到画布的时候被调用的。

(function (CS) {
    var definition = {
        typeName: 'simplevalue',
        datasourceBehavior: CS.DatasourceBehaviors.Single,
        getDefaultConfig: function() {
            return {
                DataShape: 'Value',
                Height: 150,
                Width: 150
            };
        },
        init: init
    };


    function init() {
    }


    CS.symbolCatalog.register(definition);
})(window.Coresight);

再在Coresight中添加新的图案。图案现在可以被选择、移动,并且可以使用Coresight中的撤销功能了。这样基础架构已经搭好了,为了给图案添加新的功能,我们需要扩展init函数。我们会添加一个新的参数到这个函数中scope。Scope是一个从AngularJS中借用的,是一个让页面和后台JS更方便互动的框架。init函数会有一个函数来处理当图案获得一个新的数据时。最终我们会添加一个返回函数到init函数中,让PI Coresight知道如何和图案交互。

function init(scope) {
    function onUpdate(data) {
    }
    return { dataUpdate: onUpdate };
}

上面这段代码告诉PI Coresight每当数据更新时去调用onUpdate函数。现在我们需要对onUpdate函数做一些扩展

用下面这段函数来添加一些变量到scope中:value,timelabel。这样可以让这些变量在HTML展示画面中使用。为了完整性,我们会检查data和Label这两个变量在被onUpdate函数使用时是否已经被定义了。

function init(scope) {
    function onUpdate(data) {
        if(data) {
            scope.value = data.Value;
            scope.time = data.Time;
            if(data.Label) {
                scope.label = data.Label;
            }
        }
    }
    return { dataUpdate: onUpdate };
}

现在我们可以更新HTML文件来显示这些值了。我们使用AngularJS的样式来标记{{}}。此外我们还在div中添加了一些背景颜色的style。

<div style="background: orange; color: black">
    <div>{{label}}</div>
    <div>{{value}}</div>
    <div>{{time}}</div>
</div>

重新尝试在Coresight中添加这个新的图案。

接下来我们介绍如何修改这个图案的颜色。首先我们需要添加一个内容菜单的选项到图案中,这是通过添加configOptions属性来实现的。configOptions是一个图案可用属性的一个函数,它会返回一个控制配置的数组。在这个案例中,我们返回了名为‘Format Symbol’的对象。在这里使用的‘mode’是用来指定配置类型的。这样当我们右键点击图案,选择配置图案时,我们将会打开右侧PI Coresight 配置画面。

var definition = {
    typeName: 'simplevalue',
    datasourceBehavior: CS.DatasourceBehaviors.Single,
    getDefaultConfig: function() {
        return {
            DataShape: 'Value',
            Height: 150,
            Width: 150
        };
    },
    configOptions: function () {
        return [{
            title: 'Format Symbol',
            mode: 'format'
        }];
    },
    init: init
};

接下来我们需要创建一个configurationHTML的画面。在相同文件夹下创建sym-simplevalue-config.html文件。命名规则是sym-<图案名>-config.html。同理,如果不按照这个规则命名,需要在configTemplateUrl参数中指定。下面这个例子中包含了两种配置:文字颜色和背景颜色。我们这里使用了format-color-picker,这是一个AngularJS的服务让Coresight可以给图案挑选颜色。format-color-picker有两个属性:property和config。property对应config对象中传递进来的属性,config是图案中的config对象。

<div class="c-side-pane t-toolbar">
    <span style="color:#fff; margin-left:15px">Text Color</span>
</div>
<format-color-picker id="textColor" property="TextColor" config="config"></format-color-picker>
<div class="c-side-pane t-toolbar">
    <span style="color:#fff; margin-left:15px">Background Color</span>
</div>
<format-color-picker id="backgroundColor" property="BackgroundColor" config="config"></format-color-picker>

我们也需要对原来的展示页面做一些修改,使得我们配置页面的属性也可以关联进来。这里我们需要用到一个AngularJS的辅助工具,ng-style

<div ng-style="{background: config.BackgroundColor, color: config.TextColor}">
    <div>{{label}}</div>
    <div>{{value}}</div>
    <div>{{time}}</div>
</div>

最后,我们还可以配置我们的图案,使之可以显示或隐藏一部分属性。要做到这点,我们需要更新getDefaultConfig函数,使之包含可以显示或者隐藏标题和时间的boolean形变。如下面的代码所示,默认我们是会显示标题,但不显示时间戳

getDefaultConfig: function() {
    return {
        DataShape: 'Value',
        Height: 150,
        Width: 150,
        BackgroundColor: 'rgb(255,0,0)',
        TextColor: 'rgb(0,255,0)',
        ShowLabel: true,
        ShowTime: false
    };
},

同时,展示的html画面也需要做一些修改,我们通过ng-show的辅助工具(同样也是angularJS的功能)可以控制是否显示相应的属性。当绑定的值为true是,将会显示这个元素,反之则隐藏这个元素。

<div ng-style="{background: config.BackgroundColor, color: config.TextColor}">
    <div ng-show="config.ShowLabel">{{label}}</div>
    <div>{{value}}</div>
    <div ng-show="config.ShowTime">{{time}}</div>
</div>

最后,我们对配置页面也需要做一些修改,使之可以选择是否显示时间或者标题。

<div class="c-side-pane t-toolbar">
    <span style="color:#fff; margin-left:15px">Text Color</span>
</div>
<format-color-picker id="textColor" property="TextColor" config="config"></format-color-picker>
<div class="c-side-pane t-toolbar">
    <span style="color:#fff; margin-left:15px">Background Color</span>
</div>
<format-color-picker id="backgroundColor" property="BackgroundColor" config="config"></format-color-picker>


<div class="c-side-pane t-toolbar">
    <span style="color:#fff; margin-left:15px">Show Options</span>
</div>
<div class="c-config-content">Show Label:
    <input type="checkbox" ng-model="config.ShowLabel">
</div>
<div class="c-config-content">Show Time:
    <input type="checkbox" ng-model="config.ShowTime">
</div>

这样基本的功能就完成了,下面我们修改一下配置信息使之可以显示multistate。要做到这一点,我们必须添加StateVariables到图案的definition对象。

var definition = {
    typeName: 'simplevalue',
    datasourceBehavior: CS.DatasourceBehaviors.Single,
    getDefaultConfig: function() {
        return {
            DataShape: 'Value',
            Height: 150,
            Width: 150,
            BackgroundColor: 'rgb(255,0,0)',
            TextColor: 'rgb(0,255,0)'
        };
    },
    StateVariables: [ 'MultistateColor' ],
    configOptions: function () {
        return [{
            title: 'Format Symbol',
            mode: 'format'
        }];
    },
    init: init
};

此外还需要对展示页面做一些修改,使得页面颜色可以使用multistate中定义的颜色。这里,如果multistate被定义了,那颜色就会用multistate的定义,如果没有定义,就用默认的颜色。

<div ng-style="{background: config.BackgroundColor, color: MultistateColor || config.TextColor}">
    <div ng-show="config.ShowLabel">{{label}}</div>
    <div>{{value}}</div>
    <div ng-show="config.ShowTime">{{time}}</div>
</div>

原文post在此链接How to customize the appearance of PI Coresight 2016  ,作者为KenjiJerome。以下为原文链接的翻译:

 

改变Coresight页面Tab的外观,如下

to

您能将“PI Coresight”的title改为任意内容,如此处所示,内容已被改为Kenji Coresight,有三处地方可以做这些修改

 

1. For the Homepage:

%PIHOME64%\Coresight\Views\Home\Index.cshtml

ViewBag.Title = "PI Coresight";

 

2. For a ProcessBook Page:%PIHOME64%\Coresight\Scripts\app\pbviewer\pbviewer.navigation.js

function setTitle(displayName) {
     var title = 'PI Coresight';

 

3 PI Coresight Display:%PIHOME64%\Coresight\Scripts\app\editor\display\coresight.display-controller.js

 function setTitle(displayName) {  
            var title = 'PI Coresight'; 

 

如果想改变移动端的展示,可以修改如下内容: %PIHOME64%\Coresight\Views\M\Index.cshtml

<title>PI Coresight</title>  
<div data-role="page" data-title="PI  Coresight" id="mostrecent" class="appBackground">  
<div data-role="page" data-title="PI Coresight" id="search" class="appBackground">  
<div data-role="page" data-title="PI Coresight" id="csdisplay" class="appBackground" data-add-back-btn="true">  
<div data-role="page" data-title="PI Coresight" id="pbdisplay" class="appBackground" data-add-back-btn="true">  
<div data-role="page" data-title="PI Coresight" id="element" class="appBackground unselectable" data-add-back-btn="true">  
<div data-role="page" data-title="PI Coresight" id="trend" class="appBackground unselectable" data-add-back-btn="true">  
<div data-role="page" data-title="PI Coresight" id="servicesandtools"> 

 

您也能改变site的网站图标,只要改变%PIHOME64%\Coresight\Images\logo.png文件即可

to

 

如果您想改变Help的内容,您可以在%PIHOME64%\Coresight\Scripts\app\editor\layout\coresight.cs-header-directive.js中修改,例如如果您将以下内容注释了,将会在Help中删除PI Live Library

  1. { id: 'HelpMenuOnLine', title: CS.Messages.HelpMenuOnLine, url: 'https://livelibrary.osisoft.com/LiveLibrary/content/' + lang + '/coresight-v7/GUID-7EF650C5-1235-4F8A-AC61-2EB1D2A3A5BF ' }, 

to

 

如果您不想让用户创建新的display

删除 在 %PIHOME64%\Coresight\Scripts\app\editor\layout\coresight.cs-header-directive.js中的div class="c-new-display"

You can delete all of the followings.

<div class="c-new-display t-display-content-font">  
            <div class="c-icon-display" ng-click="navCtrl.newDisplay()" title="{{::newDisplayTooltip}}">  
                <div class="c-new-display-rollover">  
                    <div>  
                        <svg id="new-display-icon" class="t-icon-fill" version="1.1" x="0px" y="0px"  
                             width="25px" height="25px" viewBox="0 -4 25 25" enable-background="new 0 0 25 25" xml:space="preserve">  
                        <path d="M9.677,0.823c-5.12,0-9.271,4.188-9.271,9.354c0,5.169,4.151,9.356,9.271,9.356  
                                    c5.119,0,9.271-4.188,9.271-9.356C18.948,5.012,14.796,0.823,9.677,0.823" />  
                        <polygon fill="#091d3a" points="15.553,8.831 10.982,8.831 10.982,4.114 8.37,4.114 8.37,8.831 3.8,8.831 3.8,11.527 8.37,11.527  
                                    8.37,16.243 10.982,16.243 10.982,11.527 15.553,11.527" />  
                        </svg>  
                    </div>  
                    <div class="t-font-color-white" style="text-decoration: none">{{::newDisplayLinkText}}</div>  
                </div>  
            </div>  
        </div>

 

这样所有用户都不能再创建新display了

但是您仍然可以手动通过如下url来创建新的display

https://ServerName/coresight/#/Displays/New/

 

如果您想保持所有display都是显示kiosk mode,您可以注释以下语句

%PIHOME64%\Coresight\Scripts\app\editor\display\coresight.displays-controller.js

 

// if (parms.mode === 'kiosk')  
setKioskMode(true);  

If you do this, all users/ all displays can be seen as Kiosk mode.We could not choose which users can see display without kiosk. So if you want to create/edit display, you need to change comments out again. (Found with Jerome Lefebvre)

 

PI Coresight 2016 Value object 会显示工具提示. 如果您不想显示

%PIHOME64%\Coresight\Scripts\app\editor\symbols\coresight.sym-value.js

//valueLabel.path = data.Path;  

 

如果您这样做,您将不会看到工具提示

在默认情况下,多状态(multi-state)将会改变背景颜色By default, Value object's Multi-State changes background color.

如果您想改变字体本身大小,需要修改 sym-value-template.html的"Fill ||”

%PIHOME64%\Coresight\Scripts\app\editor\symbols\sym-value-template.html

     
               
     
                         
     
               
 
 

这样您将可以改变文字颜色而不是背景色

 

为了改变画面的背景色,您可以修改t-display-container类

%PIHOME64%\Coresight\Content\css\theme.base-colors.css

contains the t-display-container.

.t-display-container {  
  background-color: white; } 

 

这样就显示白色的背景色了

PI Coresight 2016 可以使用自定义的图案,具体可以参考如下repository

GitHub - osisoft/PI-Coresight-Custom-Symbols: Learn how to add a custom symbol, created with JavaScript and HTML, to PI …

如果您不自己设置,默认您定义的custom symbol将会显示 图案.

您可以找自己想要的图案(png/jpg格式),或者直接截屏(注意将display背景色改为#48586b

将图案放置到 %PIHOME64%\Coresight\Images 文件夹下

在custom symbol的配置js文件中指定iconURL参数

 

var defintion = {  
typeName: 'liquidgauge',  
iconUrl: 'Images/liquid.png',  

效果如下图所示.

如果您点击这个item,您会发现这个图片是包含背景颜色的。当然您最好可以创建一个没有背景色的图案,但能用系统自带的画图工具来获得image总是比较简单的方法

第三方软件也是个不错的方案,例如

https://inkscape.org/en/

 

我还没有检查所有的item,但是看上去HTML5在修改了很多内容之后,仍然可以正常工作。当然这些并不是我们OSI官方的修改