管理搜索服务定义
搜索服务定义是工业数据检索能力的基础配置单元,涵盖服务基本信息、索引规则、实体映射等核心内容。在设备资产管理、质量追溯、物料查询等场景中,随着业务需求迭代(如新增检索维度、调整数据模型、优化检索策略),您需要对已创建的搜索服务定义进行全生命周期管理,包括编辑、修订、查询、标签管理及状态变更等操作。
本文指导您在应用运行态中,对搜索服务定义进行各项管理操作。
前提条件
已登录应用运行态。
编辑搜索服务定义
当“状态”处于“正在工作”的搜索服务定义需要调整基本信息、索引规则或实体映射时,可执行编辑操作。
- 在左侧导航栏中,选择,进入“搜索服务定义”页面。
- 找到目标搜索服务定义,单击
,进入编辑页面。 - 根据业务需求,在以下页签中进行配置调整:
- “服务定义”页签:修改API名称、描述、标签、责任人等基础元数据。
- “索引定义”页签:对索引进行添加、修改或删除。具体操作请参见为搜索服务定义配置索引规则、管理索引定义。
- “服务配置”页签:对实体进行添加、修改或删除。具体操作请参见为搜索服务定义配置服务实体、管理服务配置。
- 完成修改后,单击底部“当前页签”中的“保存”。
修订搜索服务定义
当已发布的搜索服务定义需要调整配置(如扩展检索字段、优化分词策略、调整实体映射)且不能中断线上服务时,可通过修订功能创建新版本进行编辑,待验证通过后再发布替换旧版本。
- 在左侧导航栏中,选择,进入“搜索服务定义”页面。
- 找到目标搜索服务定义,单击
。 - 在弹出的提示框中,单击“确定”。
- 根据业务需求,在以下页签中进行配置调整:
- “服务定义”页签:修改API名称、描述、标签、责任人等基础元数据。
- “索引定义”页签:对索引进行添加、修改或删除。具体操作请参见为搜索服务定义配置索引规则、管理索引定义。
- “服务配置”页签:对实体进行添加、修改或删除。具体操作请参见为搜索服务定义配置服务实体、管理服务配置。
- 完成修改后,单击底部“当前页签”中的“保存”。
更新引用对象
当搜索服务引用的业务实体模型发生变更时(如实体字段扩展、属性类型调整、分类体系重构、字段命名变更等),搜索服务定义的编码右侧会自动显示
。
您可在应用运行态通过“更新引用对象”功能,将搜索服务的数据模型与最新实体结构保持同步,确保检索规则持续贴合业务数据现状,避免因模型不一致导致的检索异常或数据缺失。
- 在左侧导航栏中,选择,进入“搜索服务定义”页面。
- 找到目标搜索服务定义,单击其“编码”右侧的
。 图1 更新引用对象
- 在展开的页面,系统将自动拉取该搜索服务引用的所有实体及其版本对比信息,逐项核对待更新的实体信息。
- 确认变更内容符合业务预期后,单击“更新”。 图2 更新列表
- 在弹出的提示框中,单击“确定”。
更新引用对象后,实体结构可能已发生变化。为确保检索功能持续可用,建议您重新检查索引映射的有效性、服务配置的完整性,并进行检索功能验证。
批量标签管理
在工业数据检索平台中,随着搜索服务定义数量增长,需要对服务进行系统化归类管理。批量标签管理支持为多个搜索服务定义统一添加或清除标签,便于按产线、项目、业务域或责任团队进行服务归类,实现权限管控、批量筛选与生命周期管理。更多标签管理详情请参见标签。
- 在左侧导航栏中,选择,进入“搜索服务定义”页面。
- 勾选需要批量操作的搜索服务定义。
- 根据业务需求,执行如下操作:
- 批量添加标签:
- 选择列表上方的。
- 在弹出的窗口中,选择需要关联的标签,单击“确定”。
所选标签将批量应用到勾选的搜索服务定义。
- 批量清除标签:
- 选择列表上方的。
- 在弹出的窗口中,勾选需要清除的标签,单击清除标签。
- 在弹出的提示框中,单击“确定”完成清除。
- 批量添加标签:
查看搜索服务定义详情
当您需要审阅搜索服务定义的配置信息、排查检索问题、进行版本追溯或协助开发联调时,可通过详情页面查看服务的完整配置信息与运行状态。
详情页面以结构化页签形式展示搜索服务的全维度信息,包括基础元数据、索引规则、实体映射、脚本代码、同步状态及修订历史,帮助您快速定位问题、评估影响或完成审计追溯。
- 在左侧导航栏中,选择,进入“搜索服务定义”页面。
- 找到目标搜索服务定义,单击其“编码”超链接,进入详情页面。
详情页共包含6个核心页签,各页签展示内容如下:
页签
展示内容
服务定义
- 基本信息:编码、状态(正在工作/已发布/已作废)、API 中英文名称、API 中英文描述、标签等。
- 修订记录:修订号、创建者、创建时间、更新者、更新时间。
索引定义
- 索引列表:索引名称、索引描述、索引类型、运算符、分隔符、分词方法、分词选项等
- 添加、编辑、删除操作入口。
服务配置
- 实体关系图谱:可视化展示搜索服务关联的业务实体及其关系。
- 属性映射清单:实体名称、属性名称、描述、属性类型、映射信息。
脚本显示
- SQL脚本代码:系统自动生成的检索脚本,包含索引引用、过滤条件、分页逻辑等。
- 在线验证入口:“运行”按钮及参数输入区。
数据同步
- 同步任务列表:创建时间、完成时间、创建者、同步状态、同步类型等。
- 手动同步数据操作入口。
注意:已作废的搜索服务定义不支持查看。
修订记录
历史修订记录:修订号、API英文名称、API中文名称、API中文描述等。
查询搜索服务定义
当系统中存在大量搜索服务定义时,通过高效的筛选与查询功能,您可快速定位目标服务,提升配置管理、问题排查与协作沟通效率。
系统支持多维度组合筛选,包括编码、API名称、责任人、状态、标签、时间范围等条件,帮助您精准检索目标服务。查询结果列表展示关键字段摘要,支持排序、分页与批量操作,满足日常运维与审计追溯需求。
- 在左侧导航栏中,选择,进入“搜索服务定义”页面。
- 在“条件筛选”区域设置筛选条件,单击“搜索”。
结果列表将展示匹配的服务,包含关键字段:编码、API英文名称、API中文名称、API英文描述、API中文描述、状态、修订号、API责任人、创建者、创建时间等。
作废搜索服务定义
在工业数据检索平台的持续运营中,随着业务系统迭代升级(如产线改造、MES 系统切换、检索功能迁移至新服务),部分已发布的搜索服务定义可能不再适用。当某个“状态”为“已发布”的搜索服务定义确认下线时,可执行作废操作。作废后,该服务的API将立即停止响应,但配置信息(包括索引定义、服务配置、修订记录等)仍保留在系统中,便于后续审计追溯与历史版本比对。
作废搜索服务定义为不可逆操作,执行后无法恢复,请谨慎操作。
- 在左侧导航栏中,选择,进入“搜索服务定义”页面。
- 找到需要作废的目标搜索服务,单击其“编码”超链接,进入详情页面。
- 单击“作废”。
- 在弹出的提示框中,单击“确定”。
作废成功后:
- 该搜索服务的“状态”将变更为“已作废”。
- 在页面中,该服务的API详情将隐藏,不可查看。
- 所有外部调用该服务API的请求将返回服务不可用错误。
删除搜索服务定义
当处于“正在工作”状态的搜索服务定义因配置错误、需求变更、重复创建或项目取消等原因确认不再需要时,可执行删除操作彻底清理系统资源。删除后,该服务的所有配置信息(包括索引定义、服务配置、实体映射、修订记录等)将被永久清除,不可恢复。
- 在左侧导航栏中,选择,进入“搜索服务定义”页面。
- 勾选需要删除的目标搜索服务定义,单击“删除”。
- 在弹出的提示框中,单击“确定”。