Odoo SKF Phoemix API Connector 用户使用手册

一、引言

Odoo SKF Phoemix API Connector 是一个 Odoo 扩展模块，其主要功能是给 Odoo 与 SKF Phoemix API 平台提供连接，以完成数据从 SKF Phoemix API 采集到 Odoo 平台。本手册将详细介绍该模块的功能及用户操作步骤。

二、前提条件

在使用本扩展模块之前，请确保已经安装了 Odoo 18，并且安装了该模块所依赖的其他模块，包括 base、mail、odoo_base、odoo_phoenix_base、maintenance 等。

三、模块功能概述

（一）Phoenix Token 获取

通过 PhoenixToken 模型，用户可以获取 PhoenixAPI 网关接口调用的 token。在获取 token 时，需要配置相关的请求参数，如后端请求类型、登录用户、登录密码、接口地址和端口等。

（二）设备目录树数据采集

通过 MaintenanceEquipment 模型的 action_equipment_from_phoenix 方法，模块可以从 PhoenixAPI 采集设备目录树数据。采集到的数据会进行处理，包括分类数据的处理和资产设备数据的新增或更新。

四、详细操作步骤

（一）配置 Phoenix Token

进入 Phoenix Token 配置界面
- 登录 Odoo 系统，在左侧菜单中找到“凤凰接口配置”菜单项（菜单项 ID 为 phoenix_token_meu），点击进入 Phoenix Token 配置界面。该菜单项位于“odoo_base.sub_interface_menu”下，只有具有 base.user_admin 权限组的用户才能看到。
配置请求内容
- 在 Phoenix Token 配置界面中，用户可以看到以下请求内容字段：
  - Auth 接口名称：默认为“获取 PhoenixAPI 网关接口调用 token”，一般不需要修改。
  - 后端请求类型：默认为 password，如果需要修改，请根据实际情况填写。
  - 登录用户：默认为 admin，请根据实际情况修改为 Observer 系统的登录用户。
  - 登录密码：默认为 admin，请根据实际情况修改为 Observer 系统的登录密码。
  - 接口地址：默认为 http://192.168.43.16，请根据实际情况修改为 PhoenixAPI 的接口地址。
  - 接口端口：默认为 14050，请根据实际情况修改为 PhoenixAPI 的接口端口。
获取 Token
- 配置好请求内容后，点击“获取 Token”按钮（对应 action_token_from_phoenix 方法）。模块会向 PhoenixAPI 发送请求，获取 token。
- 如果请求成功，系统会将获取到的 token 及相关信息显示在界面上，包括 access_token、token_type、expires_in、refresh_token 等，并显示最近更新时间。
- 如果请求失败，系统会在日志中记录错误信息，用户可以查看日志进行排查。

（二）采集设备目录树数据

进入设备目录树数据采集界面
- 在 Odoo 系统中，找到相关的设备管理界面（具体位置根据 Odoo 的菜单配置而定），在该界面中应该有一个触发设备目录树数据采集的按钮，该按钮对应的方法为 action_equipment_from_phoenix。
触发数据采集
- 点击数据采集按钮，模块会执行以下操作：
  - 首先，模块会根据之前配置的 Phoenix Token 信息，构建请求 URL 和请求头。
  - 然后，模块会向 PhoenixAPI 发送请求，获取设备目录树数据。
  - 如果请求成功，模块会对获取到的数据进行处理，包括提取节点的 name 和 path 等信息，并递归处理子节点。
  - 接着，模块会处理分类数据。对于每个节点的 type，模块会在 maintenance.equipment.category 模型中查找是否存在对应的分类。如果存在，则更新该分类的信息；如果不存在，则创建新的分类。
  - 最后，模块会处理资产设备数据。对于每个节点，模块会在 maintenance.equipment 模型中查找是否存在对应的设备。如果存在，则更新该设备的信息；如果不存在，则创建新的设备。
查看采集结果
- 数据采集完成后，用户可以在设备管理界面中查看采集到的设备信息，包括设备名称、路径、类型、状态等。

五、注意事项

（一）Token 超时问题

如果在采集设备目录树数据时，PhoenixAPI 网关 Token 已超时，系统会在日志中记录错误信息，并提示用户重新请求 Token。此时，用户需要回到 Phoenix Token 配置界面，重新获取 Token，然后再次尝试采集数据。

（二）数据处理问题

在处理分类数据和资产设备数据时，模块会根据节点的 type 和 id 等信息进行查找和更新操作。如果数据量较大，可能会影响系统性能。建议在数据采集前，先对数据进行清理和整理，避免重复数据的插入和更新。

六、常见问题解答

（一）为什么获取 Token 失败？

获取 Token 失败可能有以下原因：

配置的请求参数不正确，如登录用户、登录密码、接口地址和端口等。
PhoenixAPI 服务不可用，用户可以检查 PhoenixAPI 服务是否正常运行。
网络问题，用户可以检查网络连接是否正常。

（二）为什么采集设备目录树数据失败？

采集设备目录树数据失败可能有以下原因：

Token 已超时，用户需要重新获取 Token。
PhoenixAPI 服务不可用，用户可以检查 PhoenixAPI 服务是否正常运行。
数据格式不正确，用户可以检查 PhoenixAPI 返回的数据格式是否符合模块的要求。

七、总结

本扩展模块为 Odoo 与 SKF Phoemix API 平台提供了连接功能，通过配置 Phoenix Token 和采集设备目录树数据，用户可以将数据从 SKF Phoemix API 采集到 Odoo 平台。在使用过程中，用户需要注意 Token 超时问题和数据处理问题，遇到问题时可以参考常见问题解答进行排查。如果问题仍然存在，用户可以联系技术支持人员。

6.0KB Исходник Blame История