Opcenter Research, Development and Laboratory V8.1 ODATA使用说明

前言

使用环境为(Opcenter RD&L) V8.1.
本指南适用于负责系统配置的Opcenter RD&L V8.1用户,例如应用程序管理器和系统集成商(顾问)。为了能够理解本指南中讨论的概念和示例,读者至少应该接受过Opcenter RD&L基础培训。

目的

本文档介绍有关Opcenter RD&L与其他应用程序或系统之间的集成选项的信息。

相关文件

相关文档都可以在Opcenter RD&L产品库(SIT_DOC_ENG.htm)中找到,该库是访问整个产品文档的全面且用户友好的界面。此外,我们强烈建议您查阅发行说明文档。安装DVD上提供了Opcenter RD&L产品库,其中所有文档均为PDF格式。

西门子培训中心

西门子提供了许多培训课程,以使您熟悉MOM产品线,包括Opcenter RD&L。为了成功实现这一目标,培训包括理论和实践课程。根据计划,该课程全年举行,该课程在预定的第一届会议之前发布。我们进行课程的基础材料反映了多年的过程,LIMS,质量控制和生产管理经验的结果。所有课程均由了解我们产品套件的发展和创新的专家人员举办。

MOM产品支持

适用于所有MOM产品的全面软件维护计划,包括Opcenter RD&L。软件维护包括以下服务:•软件更新服务(SUS):自动分发升级和Service Pack前言Opcenter研究,开发和实验室V8.1 A5E50027839-AA vi•产品支持单元(PSU):支持西门子技术问题PLM软件和所有其他Siemens MOM产品(标准支持和其他可选服务)。可以使用Siemens PLM GTAC网站联系该部门:https://www.plm.automation.siemens.com/en_us/support/gtac/index.shtml。 •在线支持:Siemens PLM GTAC网站(https://www.plm.automation.siemens.com/en_us/support/gtac/index.shtml),提供诸如技术文章和官方产品文档之类的信息

软件更新服务(SUS)

该服务提供发布时下载新的Siemens PLM Software产品软件版本和Service Pack的权利。

产品支持部门(PSU)

西门子为Siemens PLM Software和所有其他MOM产品提供了专门的产品支持团队,可以通过https://www.plm.automation.siemens.com/en_us/support/gtac/index.shtml与他联系。提供以下选项:青铜支持:9小时/天,5天/周银支持:24小时/天,5天/周黄金支持:24小时/天,7天/周Siemens PLM软件的主要语言热线是英文。软件维护计划涵盖的客户有权直接访问Siemens PLM GTAC网站。

访问PSU

为了能够访问PSU,客户需要在Siemens PLM GTAC网站上注册为用户。

在线支持

注册GTAC用户的客户可以访问Siemens PLM GTAC网站,其中包含以下技术信息:•Siemens PLM Software技术文章•Siemens PLM Software官方更新(修补程序集合)和可以下载的发行说明•Siemens可以下载的PLM软件产品文档

SWAC

通过使用SWAC(西门子Web应用程序协作)库,Opcenter RD&L将某些应用程序功能公开给其他集成的Web应用程序。 SWAC概念包含两个主要部分:▪SWAC组件▪SWAC容器容器由托管Web应用程序表示,并且可以管理Opcenter RD&L的一个或多个SWAC组件。这些组件展示了RD&L的某些功能,例如:▪信息卡▪参数结果▪方法表

部件

组件可以通过其源URL进行初始化,该源URL包含显示特定信息卡,参数组或给定父对象的方法所需的所有必要信息。下面以示例的形式显示了示例信息卡的源URL:https:// localhost / OpcenterRDnL / Wizards / OpenSampleWizard?taskId = 6&taskType = sclist&shortDescription = Basic Task&page = 2&filter = [{“ field”:“ SC @ RndvSc” ,“ operator”:“ =”,“ value”:“ 2282”}]]&selectedObjects = [{“ objectType”:“ InfoCar d”,“ ID”:“ 191”,“ node”:“ 2000000”}]&swacObject = {“ theme”:“ light”,“ swacControl”:“ Sample”,“ database”:“ Test”}请注意,URL的第一部分与应用程序用来显示广告的信息卡的部分相同。使用“打开样品”向导时的样品。它包含适当的向导和任务数据,用于标识父对象的过滤条件数组(样本)以及要显示的选定子对象的数组(信息卡)。 URL的第二个粗体部分用于让Opcenter RD&L知道所显示的网页将用作SWAC控件。 SWAC对象的属性如下:
主题——应用于组件的自定义CSS样式表的名称;样式表动态托管在以下路径下:inetpub\wwwroot\OpcenterRDnL/Content/themes/SWAC
swacControl –它可以具有以下值之一:Sample,Request,Specification和Worksheet;此值确定调用SWAC操作时要使用的父对象的类型(请参见“操作”一章),它对应于所使用向导的类型
数据库–要使用的OpcenterRDnLBackend web.config连接字符串的名称;根据连接字符串确定要连接到数据库的用户,但是强烈建议使用Windows身份验证(有关更多详细信息,请参阅身份验证一章)

信息卡

可与以下父对象一起使用:样本,请求,规范和工作表。 selectedObjects数组必须仅包含一个项目,因为Component仅支持单个Info Card的呈现。所选对象的属性是:
objectType –将InfoCard作为值•ID –要显示的信息卡的ID•node –要显示的信息卡的节点

Example:

https://localhost/OpcenterRDnL/Wizards/OpenSampleWizard?taskId=6&taskType=sclist&shortDescription=Basic 
Task&page=2&filter=[{"field":"SC@RndvSc","operator":"=","value":"2282"}]&selectedObjects=[{"objectType":"InfoCar
d","ID":"191","node":"2000000"}]&swacObject={"theme":"light","swacControl":"Sample","database":"Test"} 

参数结果

仅与Sample父对象一起使用,selectedObjects数组可以包含一项或多项。所选对象的属性为:
objectType –将ParameterGroup作为值•ID –要选择的参数组的ID•node –要选择的参数组的节点
Example:

https://localhost/OpcenterRDnL/Wizards/OpenSampleWizard?taskId=6&taskType=sclist&shortDescription=Basic 
Task&page=2&filter=[{"field":"SC@RndvSc","operator":"=","value":"2282"}]&selectedObjects=[{"objectType":"Param
eterGroup","ID":"76","node":"1000000"},{"objectType":"ParameterGroup","ID":"107","node":"3000000"}]&swacObject
={"theme":"light","swacControl":"Sample","database":"Test"} 

方法表

仅与Sample父对象一起使用,并且可以一次显示单个Method的详细信息。所选对象的属性是:
•objectType –将方法作为值•ID –要打开的方法的ID•node –要打开的方法的节点•ParameterGroupID –参数组父级的ID•ParameterGroupNode –参数组父级的节点•ParameterID –参数父级的ID•ParameterNode –参数父级的节点
Example:

https://localhost/OpcenterRDnL/Wizards/OpenSampleWizard?taskId=6&taskType=sclist&shortDescription=Basic 
Task&page=2&filter=[{"field":"SC@RndvSc","operator":"=","value":"2282"}]&selectedObjects=[{"objectType":"Metho
d","ID":"59","node":"1000000","ParameterGroupID":"76","ParameterGroupNode":"1000000","ParameterID":"90","Par
ameterNode":"4000000"}]&swacObject={"theme":"light","swacControl":"Sample","database":"Test"}

行动

上面的每个SWAC组件都公开了以下两个集成操作:
saveChanges()–用于保存SWAC组件中所做的更改。调用时,它将返回一个promise,该promise可以具有以下结果之一:
True – the save was successful
▪ False – the swacControl property of the swacObject is invalid
▪ Error – returns the error context in case of unknown issues

component = SWAC.Container.get({ name: 'MethodSheetContainer' });  
defer = component.proxy.saveChanges(); 
defer.then(function(e) { 
    console.log(e); 
},function(e) { 
    console.log(e); 
});

changeObject()–允许更改对象选择的可能性;调用时,具有以下属性的对象用作参数,由子对象的类型确定:
objectID – the ID of the new parent object, which replaces the ID value given
in the URL’s filter parameter
▪ infoCardId – the ID of the new Info Card
▪ infoCardNode – the node of the new Info Card
▪ parameterGroupId – the ID of the new Parameter Group
▪ parameterGroupNode – the node of the new Parameter Group
▪ parameterId – the ID of the new Parameter
▪ parameterNode – the node of the new Parameter
▪ methodId – the ID of the new Method
▪ methodNode – the node of the new Method

component = SWAC.Container.get({ name: 'ParameterResults' });   
var data = {} 
data.objectId = 34 
data.parameterGroupId = 5  
data.parameterGroupNode = 1000000 
component.proxy.changeObject(data)

重要

对于changeObject()函数,必须指定新父对象的ID,同时,它必须与当前父ID不同。换句话说,该功能的目的是更改父级并显示其子级对象之一,并保持相同的类型(例如Request-InfoCard,Sample-ParameterGroup等)。对于参数组,changeObject()只能显示一个参数组的内容。在创建SWAC组件期间,只能通过URL提供多个参数组。
如果在方法上使用changeObject(),则必须提供所有主键,以便SWAC屏幕正确呈现新方法。

验证

根据《安全指南》,Opcenter RD&L目前仅支持Windows身份验证来访问Web应用程序和SQL Server。为了从Windows上的浏览器向Web应用程序进行身份验证,系统会自动使用当前用户的Windows凭据(请参阅启用该凭据的浏览器配置)。这意味着SWAC控件的用户必须全部具有创建的OpcenterRD&L用户,并且这些用户必须对显示的对象具有功能访问(FAR)。

容器

在用作SWAC容器的网页必须:•引用SWAC库•创建SWAC组件•初始化组件承载SWAC控件所需的文件(swac-base.min.js和swaccontainer.min.js) )部署在以下Web路径下:https:// localhost / OpcenterRDnL / Scripts / SWAC / SWAC组件声明是一个JavaScript对象,其组成如下:

var myComponent = { 
    name: 'name of the component', 
    type: 'type of the component', 
    source: 'url of the component', 
    parent: component_parent_element, 
    settings:{         
        left : 'left position ',         
        top : 'top position',         
        width : 'width size',         
        height :'height size',         
        flavor : 'ui'    
    } 
} 

可以根据组件的名称来标识组件,并且可以通过其来源来定义它。设置对象用于设置控件的限制。要在SWAC容器内初始化SWAC组件,必须订阅onReady事件。在onReady事件中,您可以获取Component的ready实例,这是容器生命周期中所有Component接口可用的第一个事件。 onReady事件可用于初始化Component或预设其外观;例如:

SWAC.Container.onReady.subscribe(function (event) { 
    var myComp = SWAC.Container.get({ name: event.data.name }); 
    myComp.proxy.setBackgroundColor(Color.blue); 
    myComp.beginShow(true); 
});

GIL

通用集成层(GIL)是一组HTTP API。这些API允许使用HTTP / 1.1标准将Opcenter RD&L与其他应用程序集成。 Opcenter RD&L的数据层已公开,可以使用OData语法查询实体。此时,获取的数据(OData实体集)是只读的。这些OData实体由API接收作为输入,然后可以执行诸如对象创建,状态更改,创建示例等操作。还可以更新OData实体的可编辑属性。所有操作都通过应用程序的业务层进行;例如,保存“方法单元”值还将执行值格式化,计算,值传播等。没有直接针对数据层执行任何操作。以下是系统提供的API的完整列表(这些操作和功能也可以在RD&L OData元数据文档中找到):
Operations against Samples
GetNextAvailableStatuses (function)
ChangeStatus
AddAttribute
RemoveAttribute
UpdateAttribute
Update
CreateSampleBySampleTypeId
CreateSampleByShortDescription
• Operations against Sample Info Cards
GetNextAvailableStatuses (function)
ChangeStatus
AddAttribute
RemoveAttribute
UpdateAttribute
Update
• Operations against Sample Info Fields
Update
UploadExistingDocuments
UploadNewDocuments
• Operations against Sample Parameter Groups
GetNextAvailableStatuses (function)
GIL
Container
Opcenter Research, Development and Laboratory V8.1 8
A5E50027839-AA
ChangeStatus
AddAttribute
RemoveAttribute
UpdateAttribute
Update
• Operations against Sample Parameters
GetNextAvailableStatuses (function)
ChangeStatus
AddAttribute
RemoveAttribute
UpdateAttribute
Update
• Operations against Sample Methods
GetNextAvailableStatuses (function)
ChangeStatus
Update
AddAttribute
UpdateAttribute
RemoveAttribute
• Operations against Method Cells
Update
• Operations against Requests
CreateRequestByRequestTypeId
CreateRequestByRequestTypeShortDescription
GetNextAvailableStatuses (function)
ChangeStatus
AddAttribute
RemoveAttribute
UpdateAttribute
AssignRequest
UnassignRequest
AssignSample
UnassignSample
AssignSpecification
UnassignSpecification
AssignPhantomSpecification
Update
GIL
Container
Opcenter Research, Development and Laboratory V8.1 9
A5E50027839-AA
• Operations against Request Info Cards
GetNextAvailableStatuses (function)
ChangeStatus
AddAttribute
RemoveAttribute
UpdateAttribute
• Operations against Request Info Fields
Update
UploadExistingDocuments
UploadNewDocuments
• Operations against Materials
CreateMaterial
• Operations against Specifications
CreateSpecification
CreateNewVersion
Update
GetNextAvailableStatuses (function)
ChangeStatus
AddAttribute
RemoveAttribute
UpdateAttribute
• Operations against Specification Info Cards
GetNextAvailableStatuses (function)
ChangeStatus
AddAttribute
RemoveAttribute
UpdateAttribute
Update
• Operations against Request Info Fields
Update
UploadExistingDocuments
UploadNewDocuments
• Operations against Documents
AddAttribute
UpdateAttribute
RemoveAttribute

先决条件

要使GIL正常运行,必须满足以下先决条件:▪Opcenter RD&L的有效安装。 ▪与Opcenter RD&L集成在一起的应用程序的有效安装

安装与配置

GIL是Opcenter RD&L的组成部分,由安装程序部署。有关Opcenter RD&L安装说明,请参阅《 Opcenter RD&L安装指南》。 GIL web.config appSettings部分中可以默认使用以下两个配置选项:1. DefaultConnectionStringName使用此设置,可以设置默认数据库。此属性的值必须是现有的连接字符串名称。 2. DefaultDataLanguageName使用此设置,可以设置默认的数据语言。此属性的值必须是基于HTML规范RFC 3066(例如en-US)的语言环境ID。

验证

•Windows身份验证GIL支持基本身份验证方法。使用此身份验证方法,用户可以通过在HTTP请求的授权标头中传递有效的应用程序用户名和密码来进行身份验证。该用户必须是有效的应用程序用户(DOMAIN /用户名-密码)。 •集成用户可以使用集成用户帐户(IntegrationUser)来访问GIL API,该帐户的作用类似于有效的应用程序用户。为了获得最大的安全性,我们建议对GIL的通信进行加密(使用TLS)。这样可以确保传输中数据的完整性和机密性。另请参阅《安全指南》>“ GIL密码加密”一章。

验证

分配给授权用户的功能访问权限(FAR)和数据访问权限(DAR)适用于使用GIL执行的操作。没有必要的FAR的用户将无法执行某些API。例如,如果没有创建样品的权利(例如,样品管理中没有FAR-创建新样品),则用户将无法使用CreateSampleByShortDescription API创建样品。他们将收到“ 401未经授权”作为回应。没有必要的DAR的用户将看不到他们无权查看的数据。 GIL使用GIL Opcenter研究,开发和实验室V8.1 11 A5E50027839-AA 3.5使用GIL GIL基于OData v4标准(http://docs.oasis-open.org/odata/odata-csdlxml/v4 .01 / odata-csdl-xml-v4.01.html)。它提供了通过OData API访问和读取应用程序数据并执行某些操作的可能性。可通过OData访问的可用实体列表可在以下位置访问:HTTPGET GIL_BASE_URL / odata:

在这里插入图片描述

此API返回可在OData中注册的可用实体集。通过执行HTTPGET GIL_BASE_URL / odata / $ metadata命令,可以访问OData元数据服务文档。这包含有关已注册实体集,其属性和可对XML格式的实体执行的动作(操作)的详细信息。可以在OData v4的限制内查询实体的属性
例如:
在这里插入图片描述
在这里插入图片描述
元数据文档包含有关以下各项的所有必要信息:
•实体集
•实体集属性和类型
•OData操作及其输入/输出参数
•OData函数及其输入/输出参数

API行动

OData操作是HTTP POST调用。这些操作用于修改数据,针对系统,针对实体执行操作。例如:状态更改,创建新的样本,更新属性。 OData操作具有两种类型:绑定和未绑定。
A.绑定动作要了解绑定动作的概念,请参见以下示例:
在这里插入图片描述
这是RndvScIc实体的“更新”操作。这是一个绑定动作(IsBound =“ true”),这意味着要执行此动作,必须在URL中标识相应的实体。这是通过按实体的定义顺序使用键来完成的。在这种情况下,RndvScIc具有三个关键属性:SC,IC和ICNODE,标识如下所示:
在这里插入图片描述
动作参数必须在JSON格式描述的HTTP Post请求正文中发送。确切的属性可以在GIL.Models.UpdateIcArguments中看到:
在这里插入图片描述
内容看起来像这样
在这里插入图片描述
B.未绑定动作未绑定动作不绑定到任何实体集,因此不需要在URL中标识任何实体。例如
在这里插入图片描述

API方法

OData函数与OData操作非常相似。主要区别在于这些调用是HTTP GET调用,并且它们不修改数据。这些功能的目的是例如检索有关某些内容的其他信息。这些功能也可以绑定和解除绑定。
在这里插入图片描述

配件

OData支持批处理请求。使用批处理,您可以将多个请求组合在一起,并在单个HTTP调用中执行它们。在Opcenter RD&L中,批处理请求中的请求在同一事务中执行,因此,如果其中一个请求失败,则其他请求所做的修改也将被还原。在Opcenter RD&L中,API之间存在一定的依赖性,因此批处理只能用于多次执行相同类型的动作,例如,信息字段值的大量更新,填充多个方法单元格,属性的大量更新等。这样,可以减少不同API调用的次数,从而减少通信通道的拥挤程度。有关OData批处理的更多信息,请参见:https://www.odata.org/documentation/odata-version-3-0/batch-processing/

请求标题

与GIL配合使用时,可以使用许多HTTP请求标头,以使系统更加灵活。

数据库

通过在HTTP请求标头中指定此选项,可以覆盖默认的连接字符串选项以使用特定的数据库。此属性的值必须是GIL web.config文件中的有效连接字符串名称。
在这里插入图片描述

事件管理器

在这里插入图片描述

数据语言

通过在HTTP请求标头中指定此语言,可以更改使用的数据语言。默认情况下,系统以默认系统语言返回_TRANSLATED属性。此属性的值必须是基于HTML规范RFC 3066(例如en-US)的语言环境ID。另请参阅:配置手册>数据本地化。

连接字符串

web.config中的连接字符串部分允许您配置不同的数据库连接。请参阅《 GIL》一章的“安装指南”>“连接字符串”中有关此部分的更多信息

总结

在这里插入图片描述
这是比较重要的括号里面是这个EntityType的主键,然后执行update,body里面传json的数据,内容为UpdateScMeCellArguments的内容,Arguments是表示你可以传什么样的参数进去

  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 打赏
    打赏
  • 1
    评论
评论 1
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

因为有你更精彩

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付:¥1
获取中
扫码支付

您的余额不足,请更换扫码支付或充值

打赏作者

实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值