为前端项目配置数据源
数据源配置用于为UI引擎前端项目绑定各类数据服务,确保项目在运行态可稳定访问、调用生产相关接口,支撑设备监控、产线管理、数据报表等工业业务功能。只有完成绑定配置的数据源,才能在前端项目发布后完成注册,其接口调用功能方可正常生效。
UI引擎支持以下两种类型的数据源配置:
- 第三方API服务:用于绑定和调用外部提供的API服务接口。
- xDM-F模型服务:用于绑定由数据建模引擎(xDM Foundation,简称xDM-F)提供的标准化模型服务。
前提条件
- 已登录应用运行态,并具备UI引擎操作权限。
- 已创建至少一个项目,具体操作请参见使用UI引擎创建前端项目。
- 已根据需求,至少创建一个对应类型的数据源,具体操作请参见为UI引擎前端项目创建数据源。
为前端项目添加数据源
- 在左侧导航栏中,单击“UI引擎”,进入“UI引擎”。
- 在左侧导航栏中,选择,进入“前端项目”页面。
- 找到目标项目,单击“项目设置”,展开“项目设置”页面。
- 在“项目设置”页面,切换至“运行时数据源配置”页签,单击“新增关联”,弹出“新增运行时引用数据源的关联”窗口。
- 在弹出的窗口中,根据实际业务需求,设置如下信息。
图1 添加数据源
表1 第三方API服务数据源配置信息 参数名称
参数说明
数据源分类
标识当前配置的数据源类型。支持以下两种类型:
- 第三方API服务:对接外部系统开放接口。
- xDM-F模型服务:基于xDM-F提供的模型服务。
数据源名称
选择需要绑定的目标数据源。
如果没有可选择的数据源,需先前往“数据源管理”进行创建,具体操作请参见为UI引擎前端项目创建数据源。
xDM-F应用来源
仅当“数据源分类”选择“xDM-F模型服务”时显示。
系统根据所选“数据源名称”自动填充此配置项,值为“xDM-F设计态”或“自定义”,不可修改。
xDM-F应用
仅当“数据源分类”为“xDM-F模型服务”且“xDM-F应用来源”为“xDM-F设计态”时显示。
系统根据所选“数据源名称”自动填充,不可修改。
接口URL
当“数据源分类”为“第三方API服务”,或为“xDM-F模型服务”但“xDM-F应用来源”为“自定义”时显示。
系统根据所选“数据源名称”自动填充,您可根据实际业务需求进行修改。
支持“https://”或“http://”协议,其后需填写完整的域名或IP地址及路径。
填写的URL地址需要通过“连接测试”,才可保存。
请选择认证方式
选择接口的访问权限验证机制。系统根据所选“数据源名称”自动填充,您可根据实际业务需求进行修改。
如果数据源的“xDM-F应用来源”为“xDM-F设计态”,则此配置项不可修改。
- 无鉴权:无需身份验证即可调用接口。
- IAM鉴权:通过统一的IAM(身份与访问管理)服务校验用户身份。
- JWT鉴权:基于JSON Web Token标准进行用户身份验证。
鉴权配置
当认证方式选择“IAM鉴权”时显示。
系统根据所选“数据源名称”自动填充,可单击“重置鉴权配置”进行修改。
- 鉴权账号名:IAM用户所属账号。长度限制为1-64个字符,仅支持大小写字母、数字、下划线(_)和中横线(-)组成。
- 鉴权项目:服务所属项目ID(如cn-southwest-2)。长度限制为1-64个字符,仅支持大小写字母、数字、下划线(_)和中横线(-)组成。
- Access Key ID:访问密钥ID。长度不超过64个字符。
- Secret Access Key:与Access Key ID匹配的密钥。长度不超过64个字符。
认证请求头Name
当认证方式选择为“JWT鉴权”时,必须配置此项。
填写JWT Token在HTTP请求头(Header)中携带时所使用的字段名称。
长度限制为1-64个字符,仅支持大小写字母、数字、下划线(_)和中横线(-)组成。
认证请求头Value前缀
当认证方式选择为“JWT鉴权”时,可根据实际业务需求进行配置。
填写JWT Token值的前缀(如“Bearer”),以便匹配目标服务的认证规则。
长度限制为1-64个字符,仅支持大小写字母、数字、下划线(_)和中横线(-)组成。
JWT签名密钥
当认证方式选择为“JWT鉴权”时,必须配置此项。
选择用于对JWT令牌进行签名的密钥,以确保令牌的完整性和真实性。
如果没有可选择的密钥,请先前往“密钥管理”进行创建,具体操作请参见为UI引擎前端项目创建访问密钥。
JWT Payload
当认证方式选择为“JWT鉴权”时,必须配置此项。
以JSON格式定义令牌中携带的用户信息,如用户ID、角色、签发时间、过期时间等。
例如:
{ "domainId": "{{domainId}}", "userId": "{{userId}}" }自定义请求头
当需要为接口调用附加额外的HTTP Header时,可在此处配置。
每一对请求头包含“参数名”和“参数值”。
- 参数名:长度限制为1-128个字符,仅支持大小写字母、数字、下划线(_)和中横线(-)组成,且不能包含空白字符。
- 参数值:长度限制为1-2048个字符,仅允许非汉字字符组成,且不能包含空白字符。
描述
填写对该数据源的业务说明,例如用途、来源系统等,以便于后续管理和维护。
- 完成设置后,单击“保存”。