华为云用户手册

License配置 数据建模引擎运行SDK的运行由License进行授权控制。当您已完成“通用SDK”基础版数据建模引擎的购买并获取License文件之后，可参考如下配置说明绑定License。 如果您当前暂未申请License，且获取的SDK包处于免费使用期，可跳过此配置。 配置参数 是否必选 参数说明 示例 xdm.license.licenseFile 否 License文件的绝对路径。 /root/deploytest/test.dat xdm.license.deployType 是 数据建模引擎运行SDK部署位置。 HostMachine：宿主机。 Container：容器。 HostMachine

特性开关配置 您可以通过如下配置说明，自主控制是否开启/关闭某个xDM-F的功能。 配置参数 是否必选 参数说明 示例 OPEN_SECOND_LEVEL_CACHE 否 设置是否开启二级缓存功能。 true：开启二级缓存，默认为true。 false：关闭二级缓存。 关于二级缓存的介绍请参见数据建模引擎支持哪些层级的缓存？。 false THIRD_LEVEL_REDIS_CLOSED 否 设置是否开启三级缓存功能。 true：关闭三级缓存。 false：开启三级缓存，默认为false。 关于三级缓存的介绍请参见数据建模引擎支持哪些层级的缓存？。 true DYNAMIC_DATASOURCE_ENABLED 否 设置是否开启多数据源功能。 true：开启多数据源。 false：关闭多数据源，默认为false。 false

APIG配置 如果您已在数据建模引擎运行SDK资源规划中规划了APIG服务，并希望通过APIG对应用运行态的全量数据服务API进行统一监控、管理、配置、流控等，可参考如下说明进行配置。 配置参数 是否必选 参数说明 示例 APIG_HOST 是 承载APIG服务的服务器 域名 或IP地址。 https://apig.cn-north-4.myhuaweicloud.com APIG_INSTANCE_ID 是 APIG的实例ID。 123456 APIG_DEFAULT_GROUP_HOST 是 APIG服务默认组的IP地址。 http://127.0.0.1/ APIG_DEFAULT_GROUP_ID 是 APIG服务默认组的ID。 123456 APIG_ENDPOINT 是 承载APIG服务终端的服务器域名或IP地址。 https://2c3cffb0f7174591a37f40bf5415546e.apic.cn-north-4.myhuaweicloud.com

WSF配置 数据建模引擎运行SDK的运行时默认启用Huawei WSF安全校验，包括参数校验、文件上传校验等。您可以通过如下配置说明，自定义配置WSF校验规则。 如果您希望精细化管理安全校验，开启dme-WSF组件后，您可以通过自定义配置参数校验、文件上传校验、多文件上传解释器、 CS RF防护过滤器、WSF参数校验文件路径、WSF文件上传配置信息路径等参数实现。 为了避免文件上传校验异常，开启/关闭WSF的文件上传校验时，须同时开启/关闭WSF的多文件上传解释器。即，“dme.wsf.upload.check.enable”和“dme.wsf.multipart.check.enable”同时配置为“true”或“false”。 如需自定义参数校验规则，请遵循WSF组件规则定义对应的XML配置信息。 如果您想使用其他安全防护资源进行安全校验，需要关闭WSF安全校验时，请同时关闭dme-WSF组件和WSF组件。即，“dme.wsf.enable”和“devspore.security.wsf.enable”均配置为“false”。关闭WSF安全校验后，数据建模引擎运行SDK上的数据将不再受保护，请谨慎操作。 配置参数 是否必选 参数说明 示例 dme.wsf.enable 否 dme-WSF组件是iDME基于WSF封装的组件。 如果不配置或配置为true，则开启dme-WSF组件；如果配置为false，则关闭dme-WSF组件。 true devspore.security.wsf.enable 否 WSF自带组件。 如果不配置或配置为true，则开启WSF自带组件；如果配置为false，则关闭WSF组件。 true dme.wsf.param.check.enable 否 WSF的参数校验。 如果不配置或配置为true，则开启参数校验；如果配置为false，则关闭参数校验。 仅当“dme.wsf.enable”为“true”时，此配置参数才有效。 true dme.wsf.param.config.path 否 自定义WSF参数校验规则的文件夹路径。 如果不配置，默认读取当前SDK类路径下“validate”文件夹中的配置。 仅当“dme.wsf.param.check.enable”为“true”时，此配置参数才有效。 /root/deploytest/validate dme.wsf.upload.check.enable 否 WSF的文件上传校验。 如果不配置或配置为true，则开启文件上传校验；如果配置为false，则关闭文件上传校验。 仅当“dme.wsf.enable”为“true”时，此配置参数才有效。 true dme.wsf.multipart.check.enable 否 WSF的多文件上传解释器。 如果不配置或配置为true，则开启多文件上传解释器；如果配置为false，则关闭多文件上传解释器。 仅当“dme.wsf.enable”为“true”时，此配置参数才有效。 true dme.wsf.upload.config.path 否 自定义WSF文件上传校验规则的文件路径。 如果不配置，默认使用iDME配置文件路径。 仅当“dme.wsf.upload.check.enable”为“true”时，此配置参数才有效。 /root/deploytest/CustomUploadFileConfig.properties dme.wsf.csrf.check.enable 否 CSRF防护过滤器。 如果不配置或配置为true，则开启CSRF防护过滤器；如果配置为false，则关闭CSRF防护过滤器。 仅当“dme.wsf.enable”为“true”时，此配置参数才有效。 true

Token配置 如果您希望可以通过Token认证调用应用运行态的全量数据服务API，可参考如下说明进行配置。 配置参数 是否必选 参数说明 示例 OPEN_ IAM _TOKEN_VALIDATION 否 设置是否开启Token认证。 true：开启Token认证。 false：关闭Token认证，默认为false。 false IAM_END_POINT 是 承载IAM服务验证Token的服务器域名或IP地址。 https://iam.cn-north-4.myhuaweicloud.com

Elasticsearch配置 如果您已在数据建模引擎运行SDK资源规划中规划了Elasticsearch的资源/云服务，并希望使用xDM-F的“搜索服务管理”功能，可参考如下说明进行配置。 配置参数 是否必选 参数说明 示例 ES_URL 是 Elasticsearch的连接串。 127.0.0.1:9200 ES_PORT 是 Elasticsearch的端口号。 9200 ES_USERNAME 是 Elasticsearch的用户名。 admin ES_PASSWORD 是 Elasticsearch的密码。 admin ES_SCHEMA 是 Elasticsearch的类型。 http

Kafka配置 如果您已在数据建模引擎运行SDK资源规划中规划了Kafka的资源/云服务，并希望使用xDM-F的“同步至LinkX-F”功能，可参考如下说明进行配置。 配置参数 是否必选 参数说明 示例 kafka.init 否 设置是否开启Kafka。 true：开启Kafka，默认为true。开启后，需要设置“KAFKA_BOOTSTRAP_SERVERS”参数。 false：关闭Kafka。 true KAFKA_BOOTSTRAP_SERVERS 仅当“kafka.init”为“true”时，此配置参数必选。 Kafka的连接地址。 127.0.0.1:9094

单点登录配置 如果您希望通过单点登录的方式访问应用运行态，可参考如下说明进行配置。xDM-F的SDK部署模式当前支持如下两种单点登录方式，请根据实际的数据建模引擎运行SDK资源规划进行配置。 IAM服务的单点登录 此方式的单点登录依赖于华为云IAM服务，请确认已规划对应资源。 配置参数 是否必选 参数说明 示例 ssf.sysmgr.sessionfilter.loginUrl 是 IAM服务的单点登录地址。 格式为： https://{IAM_ LOG IN_ENDPOINT}/authui/login.action?service={ssf.login.cas.serviceUrl} https://auth.huaweicloud.com/authui/login.action?service=http://127.0.0.1:8003/rdm_123456_app/services/v1/cas/login ssf.sysmgr.sessionfilter.ignorePattern 是 忽略会话校验的URL格式。 /v1/cas/login;/v1/health;/wopi/files/\d{18};/wopi/files/\d{18}/contents;/v1/oauth2/login ssf.login.loginSuccessRedirectUrl 是 登录应用运行态后的默认主页。 格式为： http://{数据建模引擎运行SDK部署服务器的IP地址}:{数据建模引擎运行SDK部署服务器的端口号}/rdm_{应用ID}_app/services/index.html http://127.0.0.1:8003/rdm_123456_app/services/index.html ssf.login.cas.serviceUrl 是 应用运行态的单点登录地址。 格式为： http://{数据建模引擎运行SDK部署服务器的IP地址}:{数据建模引擎运行SDK部署服务器的端口号}/rdm_{应用ID}_app/services/v1/cas/login http://127.0.0.1:8003/rdm_123456_app/services/v1/cas/login ssf.login.logoutUri 是 IAM服务的单点登出地址。 格式为： https://{IAM_LOGIN_ENDPOINT}/authui/logout https://auth.huaweicloud.com/authui/logout ssf.login.cas.validateUrl 是 IAM验签地址。 格式为： https://{IAM_LOGIN_ENDPOINT}/authui/serviceValidate https://auth.huaweicloud.com/authui/serviceValidate IAM_LOGIN_ENDPOINT 是 承载IAM服务的服务器域名或IP地址。 https://auth.huaweicloud.com LOGIN_URL 是 IAM服务的单点登录地址。 格式为： https://{IAM_LOGIN_ENDPOINT}/authui/login.action https://auth.huaweicloud.com/authui/login.action LOGOUT_URL 是 应用运行态的单点登出地址。 格式为： https://{IAM_LOGIN_ENDPOINT}/authui/logout https://auth.huaweicloud.com/authui/logout XDM_SDK_DEPLOY_ENABLE 是 表示当前部署方式是否为SDK部署。 true：是SDK部署方式，默认为true。 false：不是SDK部署方式。 true ssf.sysmgr.sessionfilter.enabled 否 设置是否开启会话认证。 true：开启会话认证，默认为true。 false：关闭会话认证。 true 本地环境的单点登录 配置此方式的单点登录之前，您需要先在数据建模引擎运行SDK资源规划的数据库资源中创建一个schema，其schema名称格式为{应用运行态的schema名称}_ssf；然后在schema中执行如下命令，更新配置信息。 set global log_bin_trust_function_creators=true; 配置参数 是否必选 参数说明 示例 XDM_LOGIN_TYPE 是 应用运行态的登录类型，配置为“LOCAL”。 LOCAL ssf.sysmgr.sessionfilter.loginUrl 是 本地环境的单点登录地址。 LOCAL ssf.sysmgr.sessionfilter.ignorePattern 是 设置忽略请求格式。 /getIndexUrl;/v1/health;/v1/login/login;/v1/login/logout;/v1/login/verifycode;/v1/firstlogin/users;/v1/firstlogin/userpasswords:PUT;/static/**;/index.html;/HuaweiLog.ico;/HuaweiLog.png ssf.login.logoutUri 是 本地环境的单点登出地址。 格式为： https://{数据建模引擎运行SDK部署服务器的IP地址}:{数据建模引擎运行SDK部署服务器的端口号}/rdm_{应用ID}_app/services/index.html http://127.0.0.1:8003/rdm_123456_app/services/index.html OPEN_IAM_TOKEN_VALIDATION 是 设置是否开启Token认证。 true：开启Token认证。开启后，您还需要进行Token配置。 false：关闭Token认证，默认为FALSE。 FALSE RUNTIME_ENV_TYPE 是 设置应用运行态的运行环境，配置为“IES”。 IES SSF_RDS_TYPE 否 本地环境单点登录的数据库类型，默认为“mariadb”。 请根据实际的数据建模引擎运行SDK资源规划进行设置。 如果是MySQL类型数据库，设置为“mariadb”。 如果是PostgreSQL类型数据库，设置为“postgresql”。 mariadb SSF_DRIVER 否 本地环境单点登录的数据库驱动，默认为“org.mariadb.jdbc.Driver”。请根据实际的数据建模引擎运行SDK资源规划进行设置。 如果是MySQL类型数据库，设置为“org.mariadb.jdbc.Driver”。 如果是PostgreSQL类型数据库，设置为“org.postgresql.Driver”。 org.mariadb.jdbc.Driver XDM_SDK_DEPLOY_ENABLE 是 表示当前部署方式是否为SDK部署。 true：是SDK部署方式，默认为true。 false：不是SDK部署方式。 true ssf.sysmgr.sessionfilter.enabled 否 设置是否开启会话认证。 true：开启会话认证，默认为true。 false：关闭会话认证。 true

MongoDB配置 如果您已在数据建模引擎运行SDK资源规划中规划了MongoDB的资源/云服务，并希望使用xDM-F的“系统版本”功能，可参考如下说明进行配置。 配置参数 是否必选 参数说明 示例 mongodb.init 否 设置是否开启MongoDB。 true：开启MongoDB。开启后，需要设置“MONGODB_URI”和“MONGODB_DATABASE”参数。 false：关闭MongoDB，默认为false。 true MONGODB_URI 仅当“mongodb.init”为“true”时，此配置参数必选。 MongoDB的连接串。 mongodb://rwuser:admin@127.0.0.1:8635/test?authSource=admin MONGODB_DATABASE 仅当“mongodb.init”为“true”时，此配置参数必选。 MongoDB的库名。 test

IAM机机认证配置 流程引擎的机机认证默认使用JSON Web Token（JWT）进行校验，如果您已在流程引擎流程SDK资源规划中规划了IAM服务，并希望使用IAM机机认证，可参考如下说明进行配置。 配置参数 是否必选 参数说明 示例 basic.auth.iam.machine.enable 否 设置是否开启IAM服务的机机认证。 true：开启IAM服务的机机认证。 false：关闭IAM服务的机机认证。 true basic.iam.token.validDomainId 仅当“basic.auth.iam.machine.enable”为“true”时，此配置项必选。 当前IAM的租户ID。 如需添加多个租户ID，请用英文逗号隔开。 123456,456789

其他配置 其他配置包括是否开启限流降级、WSF防护等，您可以根据实际业务需求进行配置。 配置参数 是否必选 参数说明 示例 xdmf.init 否 设置是否开启xDM-F数据库表单初始化。 首次启动时，必须为true，后续可根据实际业务需求进行修改。 true：开启xDM-F数据库表单初始化，默认为true。 false：关闭xDM-F数据库表单初始化。 true olc.app.switch 否 设置是否开启OLC（Overload Control）限流降级。 true：开启OLC限流降级。 false：关闭OLC限流降级，默认为false。 false basic.wsf.enabled 否 设置是否开启WSF参数校验，用于防护XSS攻击、SQL注入攻击，以及DOC攻击。 true：开启WSF参数校验，默认为true。 false：关闭WSF参数校验。 true

本地登录认证配置 如果您希望通过本地登录认证的方式访问流程引擎，可参考如下说明进行配置。 配置参数 是否必选 参数说明 示例 basic.login.type 是 流程引擎的登录类型，配置为“LOCAL”。 LOCAL basic.auth.loginUrl 是 本地环境的登录地址。 LOCAL basic.local.login.falway 否 设置是否执行本地登录flaway脚本。 true：执行本地登录flaway脚本。 false：不执行本地登录flaway脚本，默认为false。 false ssf.login.logoutUri 是 本地环境的登出地址。 格式为： https://{流程引擎流程SDK部署服务器的IP地址}:{流程引擎流程SDK部署服务器的端口号}/definitionmicro/index.html http://127.0.0.1:8003/definitionmicro/index.html ssf.flyway.locations 否 本地环境登录的数据库信息。 classpath:ssf/migration/postgresql spring.datasource.ssf.url 是 本地环境登录数据库连接URL。 格式为： jdbc:{SSF_RDS_TYPE}://{RDS_IP}:{RDS_PORT}/{RDS_DATABASE}_ssf?sslmode=require&stringtype=unspecified 其中，“RDS_IP”、“RDS_PORT”和“RDS_DATABASE”字段需与部署数据建模引擎运行SDK时配置数据库的配置参数保存一致，“SSF_RDS_TYPE”字段需与部署数据建模引擎运行SDK时配置本地环境的单点登录的配置参数保存一致。 jdbc:mariadb://127.0.0.1:5432/test_ssf?sslmode=require&stringtype=unspecified spring.datasource.ssf.driverClassName 是 本地环境登录数据库连接类。 此配置参数需与部署数据建模引擎运行SDK时配置本地环境的单点登录的“SSF_DRIVER”配置参数保存一致。 org.mariadb.jdbc.Driver spring.datasource.ssf.username 是 本地环境登录数据库用户。 admin spring.datasource.ssf.password 是 本地环境登录数据库密码。 admin spring.datasource.ssf.mapperLocations 否 本地环境登录数据库脚本的存放地址。 classpath*:ssf/mapper_postgresql/**/*.xml ssf.sysmgr.sessionfilter.enabled 否 设置是否开启本地环境登录Session过滤器。 true：开启本地环境登录Session过滤器，默认为true。 false：关闭本地环境登录Session过滤器。 true ssf.cookie-filter.enabled 否 设置是否开启本地环境登录Cookie过滤器。 true：开启本地环境登录Cookie过滤器。 false：关闭本地环境登录Cookie过滤器，默认为false。 false ssf.csrf-filter.enabled 否 设置是否开启本地环境登录CSRF（Cross-Site Request Forgery，跨站请求伪造漏洞）过滤器。 true：开启本地环境登录CSRF过滤器。 false：关闭本地环境登录CSRF过滤器，默认为false。 false ssf.firstlogin.isRestPassWord 否 设置首次登录流程引擎时是否需要重置密码。 true：首次登录流程引擎时需要重置密码。 false：首次登录流程引擎时不需要重置密码，默认为false。 false

单点登录配置 如果您希望通过单点登录的方式访问流程引擎，可参考如下说明进行配置。流程引擎的SDK部署模式当前支持如下两种单点登录方式，请根据实际的流程引擎流程SDK资源规划进行配置。 IAM服务的单点登录 此方式的单点登录依赖于华为云IAM服务，请确认已规划对应资源。 配置参数 是否必选 参数说明 示例 basic.auth.iam.enable 是 设置是否开启IAM服务的单点登录。 true：开启IAM服务的单点登录。 false：关闭IAM服务的单点登录。 true OrgID的单点登录 此方式的单点登录依赖于华为云OrgID服务，请确认已规划对应资源。 配置参数 是否必选 参数说明 示例 basic.auth.orgId.enable 是 设置是否开启OrgID的单点登录。 true：开启OrgID的单点登录。 false：关闭OrgID的单点登录。 true ssf.login.oauth2.client-id 是 OrgID的Client ID。 获取方法请参见获取组织凭证。 abc123 ssf.login.oauth2.client-secret 是 OrgID的Client Secret。 获取方法请参见获取组织凭证。 abc123 basic.runtime.org.code 是 OrgID给用户颁发的code。 获取方法请参见快速开始。 abc123 完成单点登录配置后，您可以根据如下登录地址，分别登录流程编排服务和流程运行服务。 流程编排服务登录地址： http://{承载流程编排服务的服务器域名或IP地址}:{流程编排服务的端口号}/{流程编排服务文根}/index.html?#/processApplicationForm?tenantId={租户ID}&applicationId={应用ID} 流程运行服务登录地址： http://{承载流程编排服务的服务器域名或IP地址}:{流程运行服务的端口号}/{流程运行服务文根}/wfAdminIndex.html#/process-tasks?tenantId={租户ID}&applicationId={应用ID} 其中，租户ID和应用ID为部署xDM-F SDK时公共信息配置中的TENANT_DOMAIN_ID和APP_IDENTIFIER。

SDK列表 表1 SDK列表 SDK分类 功能 支持的组件 支持的语言 数据建模引擎运行SDK 数据建模引擎运行SDK是对访问xDM-F应用运行态提供的REST API进行的封装，以简化用户的开发工作。 用户直接调用数据建模引擎运行SDK提供的接口函数即可实现使用xDM-F业务能力的目的。 通用组件 基础数据服务 权限管理 分类管理 数据分类管理 扩展属性 扩展类型 文件夹管理 所有者管理 安全受控 版本服务 失效管理 业务编码生成器 标签管理 生命周期管理 多维视图和多维分支 关系实体服务 树形结构 可选组件 依赖实际的数据建模引擎运行SDK资源规划，详情请参见数据建模引擎运行SDK资源规划。 Java 流程引擎流程SDK 流程引擎流程SDK是对访问xDM-F的流程引擎特性提供的REST API进行的封装，以简化用户的开发工作。 用户直接调用流程引擎流程SDK提供的接口函数即可实现使用流程引擎业务能力的目的。 通用组件 流程元模板管理 流程服务编排 流程实例管理 流程任务 可选组件 依赖实际的数据建模引擎运行SDK资源规划，详情请参见流程引擎流程SDK资源规划。

约束与限制 目前流程引擎流程SDK仅支持在通用服务器中部署，不支持容器化部署。 为了满足用户对xDM-F SDK的了解和使用，iDME支持免费使用xDM-F SDK。即：每个应用下，自首次生成SDK成功之日起，用户可以免费使用30天的数据建模引擎运行SDK或流程引擎流程SDK。 例如，2024年06月01日生成数据建模引擎运行SDK，其有效时间为2024年06月01日 - 2024年06月30日。免费使用到期后，数据建模引擎运行SDK将触发停服，该运行SDK不可使用。 xDM-F SDK的运行由License进行授权控制，购买“通用SDK”基础版数据建模引擎成功后，请及时申请License。 License授权有效期：License授权自申请License之日起即激活，授权有效期为下单购买“通用SDK”基础版数据建模引擎的购买时长。 License授权宽限期：为确保您的xDM-F SDK正常使用以及License授权到期前后有充足时间进行调整，在License授权到期后将进入30天的宽限期。宽限期内您的xDM-F SDK依旧可以正常使用，宽限期后如果您未进行续费将无法使用xDM-F SDK。 一个License只能配置一个应用ID，且至多可配置八台本地通用服务器。即，一个xDM-F SDK至多可部署在八台不同的本地通用服务器中，且实际部署的本地通用服务器需与License文件配置的本地通用服务器保持一致，否则会部署失败。 购买“通用SDK”基础版数据建模引擎，并将xDM-F SDK部署至本地通用服务器/容器之后，系统会自动与现有存量用户进行匹配。如果现有存量用户大于已购买“通用SDK”的用户数，现有存量用户不影响使用，新增用户仅支持查看，不支持操作。

SDK列表 在开始使用之前，请确保您安装的是最新版本的SDK。使用过时的版本可能会导致兼容性问题或无法使用最新功能。您可以在 SDK中心 查询版本信息。 表1提供了iDME管理面支持的SDK列表，您可以在GitHub仓库查看SDK更新历史、获取安装包以及查看指导文档。 表1 SDK列表 编程语言 Github地址 参考文档 Java huaweicloud-sdk-java-v3 Java SDK使用指导 Python huaweicloud-sdk-python-v3 Python SDK使用指导 Go huaweicloud-sdk-go-v3 Go SDK使用指导

如何在本地通用服务器中部署流程运行服务依赖的Node.js环境？ 通过流程引擎的流程编排服务生成的流程元模板需要通过Node.js编译后，才能在流程运行服务中启动。如果您的本地通用服务器未部署Node.js，可以参考如下操作进行部署。 准备事项 操作系统：Linux 系统，本文以CentOS 7.6 64位操作系统为例。 Node.js：流程运行服务的运行环境，推荐安装Node.js 16.15.0或Node.js 16.20.2版本。 Python：Node.js的依赖环境，推荐安装Python 2.6或Python 2.7版本，不建议安装Python 3.0及以上版本。 操作步骤 登录Linux弹性云服务器。 执行如下命令，查看当前ECS是否已经安装Python 2.6或2.7版本。 不建议安装Python 3.0及以上版本。 python --version 如果未安装，则依次执行如下命令，安装Python。 wget http://www.python.org/ftp/python/2.6/Python-2.6.tgz 本步骤以下载Python 2.6安装包为例，您可以前往Node.js 官网获取更多安装信息。 tar -xzf Python-2.6.tgz cd Python-2.6 ./configure --prefix=/usr/local make && make install ln -sf /usr/local/bin/python2.6 /usr/bin/python2.6 如果已安装，则执行3。 执行如下命令，下载Node.js Linux 64位二进制安装包。 wget https://nodejs.org/dist/v16.20.2/node-v16.20.2-linux-x64.tar.xz 本步骤以下载Node.js 64位二进制安装包为例，请对应您实际云服务器的规格，前往Node.js 官网获取更多安装信息。 执行如下命令，解压安装包。 tar -xf node-v16.20.2-linux-x64.tar.xz 依次执行如下命令，创建软链接。 ln -sf /usr/local/node/node-v16.15.0-linux-x64/bin/npm /usr/local/bin/ ln -sf /usr/local/node/node-v16.15.0-linux-x64/bin/node /usr/local/bin/ 成功创建软链接后，即可在弹性云服务器任意目录下使用node及npm命令。 执行如下命令，查看Node.js及npm版本信息。 node -v npm -v 显示Node.js的版本信息，即表示部署成功。

如何生成jwt-token？ xDM-F在JSON Web Token（JWT）这种结构化令牌的基础上实现了一套基于用户体系对用户的API进行授权访问的机制，满足用户个性化安全设置的需求。xDM-F支持的jwt-token的加密算法为RSA非对称加密算法，密钥的加密位数推荐为3072。 您可以通过如下方式生成用于jwt-token生成与验证的私钥与公钥。其中，私钥用于授权服务签发JWT，公钥配置到JWT插件中用于API网关对请求验签。 在本地通用服务器中，执行如下命令，生成对应私钥与公钥。 # 生成一个3072位的RSA密钥对 openssl genpkey -algorithm RSA -out private.key -pkeyopt rsa_keygen_bits:3072 openssl rsa -pubout -in private.key -out public.key # 查看私钥 cat private.key # 查看公钥 cat public.key

什么时候需要更换License文件？ 当您存在如下变更场景时，需要更换License文件： 用户数变更 例如，您已购买500个用户的SDK服务，在使用过程中发现500个用户已无法满足您的业务诉求，重新购买1000个用户的SDK服务用以扩充用户数量。 更换绑定的应用 例如，您之前配置了A应用的信息，因业务调整，A应用不再使用，现在希望配置成其他应用。 机器部署范围变更 例如，您之前配置了4台部署机器，因业务调整，新增2台部署机器。 授权时长变更 例如，您申请的License文件将于2024年09月30日到期，您希望将此License文件延期至2026年09月30日。

下单后如何获取License文件，需要提供哪些信息？ 当您购买的“通用SDK”基础版数据建模引擎订单付款成功后，需要通过提交工单的方式申请License文件。在此之前，您需要提前准备如下相关信息： SDK所属应用的应用ID（License文件不支持跨应用使用）。 已支付订单中购买的用户数量。 已支付订单中订阅的时长。 SDK部署机器的信息。 如果SDK部署机器为本地通用服务器，则需要准备如下信息： Windows系统：提供机器MAC地址。 Linux系统：提供机器的UUID。 如果SDK部署机器为容器，则提供容器的ESN。

工业数字模型驱动引擎SDK简介 工业数字模型驱动引擎服务软件开发工具包（iDME SDK，Industrial Digital Model Engine Service Software Development Kit），目前提供了iDME Open API SDK包和数据建模引擎（xDM Foundation，简称xDM-F）SDK包两种开发包，功能和差异如表1所示，您可以根据您的使用场景进行选择。 表1 iDME不同SDK包对比 SDK包类型 功能 支持的组件 支持的语言 获取地址 iDME Open API SDK包 工业数字模型驱动引擎管理面SDK是基于iDME控制台封装的SDK包。 通过调用此SDK包提供的代码样例，即可通过API接口对iDME控制台的各组件进行相关操作。 应用管理 运行服务管理 Java Python Go Github代码仓，详情请参见SDK列表。 工业数字模型驱动引擎典型API体验SDK是基于数据建模引擎典型API封装的SDK包。 通过调用此SDK包提供的代码样例，即可通过API接口对数据建模引擎的各典型组件进行相关操作。 基础数据服务 版本服务 失效管理 业务编码生成器 标签管理 生命周期管理 多维视图和多维分支 关系实体服务 树形结构 Java Python Go Github代码仓，详情请参见SDK列表。 数据建模引擎SDK包 数据建模引擎运行SDK是基于xDM-F应用运行态封装的SDK包。 通过调用此SDK包提供的代码样例，即可通过API接口对应用运行态的各组件进行相关操作。 通用组件 基础数据服务 权限管理 分类管理 数据分类管理 扩展属性 扩展类型 文件夹管理 所有者管理 安全受控 版本服务 失效管理 业务编码生成器 标签管理 生命周期管理 多维视图和多维分支 关系实体服务 树形结构 可选组件 依赖实际的数据建模引擎运行SDK资源规划，详情请参见数据建模引擎运行SDK资源规划。 Java xDM-F应用设计态，详情请参见SDK列表。 流程引擎流程SDK是基于xDM-F的流程引擎特性封装的SDK包。 通过调用此SDK包提供的代码样例，即可通过API接口对流程引擎的各组件进行相关操作。 通用组件 流程元模板管理 流程服务编排 流程实例管理 流程任务 可选组件 依赖实际的数据建模引擎运行SDK资源规划，详情请参见流程引擎流程SDK资源规划。

SDK列表 在开始使用之前，请确保您安装的是最新版本的SDK。使用过时的版本可能会导致兼容性问题或无法使用最新功能。您可以在SDK中心查询版本信息。 表1提供了iDME典型API支持的SDK列表，您可以在GitHub仓库查看SDK更新历史、获取安装包以及查看指导文档。 表1 SDK列表 编程语言 Github地址 参考文档 Java huaweicloud-sdk-java-v3 Java SDK使用指导 Python huaweicloud-sdk-python-v3 Python SDK使用指导 Go huaweicloud-sdk-go-v3 Go SDK使用指导

异常处理 问题描述 服务正常启动，但调用任何接口都返回如下错误信息： { "result": "FAIL", "timestamp": "2024-12-04 10:33:04", "error_code": "LIC.60007023", "error_msg": "No access rights. Please check license config or file.", "trance_id": null } 可能原因 此错误信息表示当前SDK未正常运行，无法提供服务。可能存在如下原因： 当前SDK服务的免费使用时间已到期。 当前SDK服务未配置License。 当前SDK服务配置的License已过期。 当前SDK服务配置License的信息填写不正确。 处理步骤 在容器环境中，调用如下接口，获取容器的ESN。 http://{容器的IP地址}:{SDK服务的端口号}/rdm_{应用的唯一标识}_app/services/rdm/basic/api/v1/runtime/sdk/esn 记录显示结果中的“data”信息。 { "result": "SUC CES S", "data": [ "ESN" ], "errors": [] } 将1记录的“data”信息提供给运维工程师，获取License文件。 在配置文件（例如“application.properties”）中添加License配置信息。

数据库配置 如下为MySQL、PostgreSQL和 GaussDB 类型数据库所需要的配置项。 分别在流程编排服务和流程运行服务配置文件中配置数据库信息时，其数据库类型（即“application.dbType”参数）需要保持一致，数据库连接串（即“datasource.url.1”参数）的DATABASE和SCHEMA不能相同。 如果您使用的是MySQL类型数据库，其Schema编码字符集推荐设置为utf8mb4，排序规则推荐设置为utf8mb4_general_ci。如果使用其他字符集，可能会存在语法不兼容问题。 配置参数 是否必选 参数说明 示例 application.dbType 是 数据库类型。 mysql：MySQL数据库 pgsql：PostgreSQL数据库 gaussdb： GaussDB数据库 mysql datasource.jdbcDriverClass.1 是 数据库驱动名称。 org.mariadb.jdbc.Driver datasource.user.1 是 数据库用户名。 admin datasource.password.1 是 数据库密码。 admin datasource.url.1 是 数据库连接串格式。 jdbc:mariadb://{IP}:{PORT}/{DATABASE}?allowMultiQueries=true&targetServerType=master&stringtype=unspecified&serverTimezone=Asia/Shanghai rdm.hibernate.dialect 是 Hibernate数据库方言。 com.huawei.it.rdm.configuration.XdmMySqlDialect rdm.dbType 是 Hibernate数据库方言对应的数据库类型。 mysql

Redis配置 分别在流程编排服务和流程运行服务配置文件中配置Redis时，其配置信息建议保持一致，以便实现Session登录共享。 配置参数 是否必选 参数说明 示例 spring.redis.host 是 Redis地址。 127.0.0.1 spring.redis.port 是 Redis端口。 6379 spring.redis.password 是 Redis密码。 admin spring.redis.type 是 Redis服务类型，支持如下两种模式。 SINGLE：单点模式或主备模式 CLUSTER：集群模式 SINGLE spring.redis.master.enable 仅当“spring.redis.type”为“SINGLE”时，此配置项必选。 设置是否开启Redis的主备模式。 true：开启Redis的主备模式。开启后，需要设置“spring.redis.master.slaves”参数。 false：关闭Redis的主备模式，默认为false。 true spring.redis.master.slaves 仅当“spring.redis.master.enable”为“true”时，此配置项必选。 Redis备节点地址。 127.0.0.1:7002,127.0.0.1:7003 redis.redisClusterConfiguration.clusters 仅当“spring.redis.type”为“CLUSTER”时，此配置项必选。 Redis集群地址。 127.0.0.1:6379,127.0.0.1:6380

数据建模引擎运行SDK资源规划 将数据建模引擎运行SDK部署至本地通用服务器/容器，您需要规划其他云平台或本地资源的数量、名称以及主要参数等信息，资源规划详情如表1所示。 表1 数据建模引擎运行SDK资源规划详情 资源/云服务 是否必须 推荐规格 说明 物理机 虚拟机 弹性云服务器（ECS） 是 4U8G*2 用于部署数据建模引擎运行SDK。 数据库 云数据库 RDS 是 规格：4U8G 版本： MySQL 5.x MySQL 8.x PostgreSQL 13.x PostgreSQL 14.x 用于持久化实例数据。 Redis 分布式缓存服务（DCS） 是 规格：8G 版本： Redis 5.x Redis 6.x 用于缓存数据，提高查询效率。 MongoDB 文档数据库服务（DDS） 否 如果不选取，应用运行态将不支持“系统版本”功能。 规格：4U8G 版本：MongoDB 4.x 用于持久化非结构化JSON数据。 Elasticsearch 云搜索服务 （ CSS ） 否 如果不选取，应用运行态将不支持“搜索服务”功能。 规格：4U8G 版本：Elasticsearch7.10.2 用于语义搜索、分词搜索等操作。 Kafka 分布式消息服务Kafka版 否 如果不选取，应用运行态将不支持“同步至LinkX-F”功能。 规格：4U8G(cluster) 版本：kafka2.7 用于同步数据至LinkX-F。 物理磁盘 对象存储（OBS） 否 如果不选取，应用运行态的所有文件将存储在部署的服务器中。 按需配置 用于存储文件。 xDM-F的上传文件、导入/导出、离线同步等操作的文件可能会占用较大的本地磁盘空间，推荐选择OBS服务。 统一身份认证 （IAM） 否 如果不选取，应用运行态将无法使用IAM登录和token认证。 - 用于单点登录应用运行态页面。 用于应用运行态接口的token认证鉴权。 应用运维管理 （ AOM ） 否 如果不选取，应用运行态将不支持“系统日志”功能。 - 用于应用运行态日志上报。 用于全量数据服务接口异常的告警上报。 API网关（APIG） 否 如果不选取，应用运行态将无法使用API监控、管理、配置、流控等。 - 用于支持API监控、管理、配置、流控等。 数据加密 服务（DEW） 否 如果不选取，应用运行态将不支持“属性的值加密”功能。 - 用于加解密数据库存储的敏感数据，以密文形式存储。

流程引擎流程SDK资源规划 将流程引擎流程SDK部署至本地通用服务器，您需要规划其他云平台或本地资源的数量、名称以及主要参数等信息，资源规划详情如表2所示。 表2 流程引擎流程SDK资源规划详情 资源/云服务 是否必须 推荐规格 说明 物理机 虚拟机 弹性云服务器（ECS） 是 4U8G*2 用于部署流程引擎流程SDK。 数据库 云数据库 RDS 是 规格：4U8G 版本： MySQL 5.x MySQL 8.x PostgreSQL 13.x PostgreSQL 14.x TaurusDB 2.x 用于持久化实例数据。 Redis 分布式缓存服务（DCS） 是 规格：8G 版本： Redis 5.x Redis 6.x 用于缓存数据，提高查询效率。 支持单点、主备和集群。 物理磁盘 对象存储（OBS） 是 按需配置 用于存储文件。 统一身份认证（IAM） 否 如果不选取，流程引擎将无法使用IAM登录和token认证。 - 用于单点登录流程引擎页面。 用于流程引擎接口的token认证鉴权。 组织成员账号（OrgID） 否 如果不选取，流程引擎将无法使用OrgID登录。 - 用于单点登录流程引擎页面。 应用运维管理（AOM） 否 如果不选取，流程引擎将不支持“系统日志”功能。 - 用于流程引擎日志上报。 用于流程引擎接口异常的告警上报。 API网关（APIG） 否 如果不选取，流程引擎将无法使用API监控、管理、配置、流控等。 - 用于流程引擎支持API监控、管理、配置、流控等。

数据管理流程 数据管理功能可以协助用户快速建立数据模型，为后续的脚本和作业开发提供数据实体。通过数据管理，您可以： 支持管理DWS、 MRS Hive、MRS Spark、 DLI 等多种 数据湖 。 支持可视化和DDL方式管理数据库表。 注意，在MRS API连接方式下，不支持通过可视化方式查看与管理该连接下的数据库、数据表和字段。 单击可以查看数据连接目录树下的数据库、数据表以及字段信息。DWS SQL、DLI SQL、MRS Hive SQL、MRS Spark SQL代理模式均支持查看目录树，其他数据连接均不支持。 如果您在使用数据开发前，已创建了数据连接和对应的数据库和数据表，则可跳过数据管理操作，直接进入脚本开发或作业开发。 数据管理的使用流程如下： 图1 数据管理流程 创建数据连接，连接相关数据湖底座服务。具体请参见新建数据连接。 基于相应服务，新建数据库。具体请参见新建数据库。 如果是DWS连接，则需要新建数据库模式；否则直接新建数据表。具体请参见（可选）新建数据库模式。 新建数据表。具体请参见新建数据表。 父主题： 数据管理

解决方法 按照以下说明，在没有任何业务的机器，或创建临时机器，使用bash命令安装修补版本的GmSSL。 请使用没有任何业务的机器，或创建临时机器执行以下操作。 以root用户完成以下操作步骤，以确保您对使用此命令的目录和二进制文件拥有正确的权限。 sudo su - 记住从下载页面(https://www.github.com/guanzhi/GmSSL/)下载的最新GmSSL版本。 使用以下命令下载并解压缩二进制文件。 下载最新版本的GmSSL版本。 curl -LO https://github.com/guanzhi/GmSSL/archive/master.zip unzip master.zip cd GmSSL-master 复制并粘贴此数据块，然后在您的设备上选择输入。 sed -i "/BIO_get_cipher_ctx(benc, &ctx);/a\ EVP_CIPHER_CTX_set_flags(ctx, EVP_CIPHER_CTX_FLAG_WRAP_ALLOW);" apps/enc.c 重新编译并安装GmSSL。 ./config && make && make install 如果执行GmSSL命令报如下错误。gmssl: relocation error: gmssl: symbol PBEPA RAM _it, version OPENSSL_xxxx not defined in file libcrypto.so.1.1 with link time reference 执行如下命令： ldd /usr/local/bin/gmssl mv libcrypto.so.1.1 /usr/lib64/libcrypto.so.1.1 mv libssl.so.1.1 /usr/lib64/libssl.so.1.1

数据合规处理说明 UGO在完成其功能的过程中需要接触您的数据，包括数据库连接相关信息和源数据库结构信息，具体包括： 数据库连接相关信息：数据库IP、端口、数据库用户名、密码、SSL认证证书及证书密码等。 源数据库结构信息：UGO仅会访问和获取您的源库结构信息，不会获取源库表数据，这些结构信息会如实地反映到操作界面中。 这些信息是完成业务功能所必须的信息，UGO会对上述信息采取认证鉴权、加密存储、内部数据隔离等安全措施，保障数据安全。另外，请依据您所在组织的数据安全策略，完成迁移后及时删除相关项目，UGO会在您触发项目删除后删除和该项目相关的数据。