Maximo Script Helper - VSCode 插件

Maximo自动化脚本开发助手，为VSCode提供智能代码补全、语法提示等功能。

功能特性

• ✨ 智能代码补全：支持Maximo常用对象的API自动补全
• 📝 JSDoc 类型注释：通过 /** @type {ClassName} */ 获得精确的类型提示
• 🔗 链式调用支持：自动推断方法返回值类型，支持复杂链式调用
• 🔄 多版本支持：兼容Maximo 7.6和9.1
• 💡 实时提示：方法说明和参数提示
• 🚀 高性能缓存：智能缓存机制，提升补全速度
• ⚙️ 灵活配置：可启用/禁用 JSDoc 解析和类型推断功能
• 🎯 JavaScript 专属优化：针对 JavaScript 语言深度优化的补全体验
• 📦 脚本管理工具箱：批量导出、拉取、部署 Maximo 自动化脚本
• 📊 版本管理：自动追踪脚本版本历史，支持版本号递增
• 🏷️ 包路径支持：根据 IBM_PACKAGEPATH 自动创建目录结构

安装

方式一：从市场安装（待发布）

# 在VSCode扩展市场搜索 "Maximo Script Helper"

方式二：本地安装

# 1. 进入插件目录
cd maximo-script-vscode-plugin

# 2. 安装依赖
npm install

# 3. 编译插件
npm run compile

# 4. 打包插件
npm run package

# 5. 在VSCode中安装生成的 .vsix 文件

配置

打开配置面板

1. 点击状态栏的 Maximo配置 按钮
2. 或按 Ctrl+Shift+P (Windows/Linux) 或 Cmd+Shift+P (Mac)
3. 输入 Maximo Script: 打开配置
4. 或直接运行命令：maximoScript.showConfig

配置项说明

连接配置

• 服务器地址：Maximo服务器的完整URL（例如：http://localhost:9080/maximo）
• 认证方式：支持 MAXAUTH 或 API Key 两种认证方式
• API 类型：选择 OSLC 或 REST API
• Maximo版本：选择您的Maximo版本（7.6 或 9.1）
• 别名（Alias Name）：用于推送脚本时保存历史记录
• 脚本存放目录：配置拉取脚本的存储根目录（默认为 masscript）

补全设置

• 启用代码补全：开启/关闭智能补全功能
• 启用 JSDoc 类型注释解析：从 /** @type {ClassName} */ 注释中提取变量类型
• 启用返回值类型推断：支持链式调用的类型推导
• 本地API数据目录：指向包含 JSON API 反射数据的目录

获取MAXAUTH

// 在浏览器控制台执行
btoa('maxadmin:123456')
// 返回：bWF4YWRtaW46MTIzNDU2

使用方法

代码补全

插件专为 JavaScript 语言优化，在 .js 文件中提供智能补全。

1. 隐式变量补全

Maximo 脚本中的默认变量无需声明即可使用：

// 输入 mbo. 后会显示MBO相关方法
mbo.getString("assetnum")
mbo.setValue("description", "Test")

// 输入 mboset. 后会显示集合操作方法
mboset.moveFirst()
mboset.count()

// 输入 service. 后会显示可用的方法
service.log("Test message")
service.getMboSet("ASSET", userInfo)

2. JSDoc 类型注释补全（新功能）✨

通过 JSDoc 注释为变量指定类型，获得精确的方法补全：

/** @type {psdi.mbo.MboRemote} */
var assetMbo = mbo;

// 现在输入 assetMbo. 会显示 MboRemote 的所有方法
assetMbo.getString("assetnum");
assetMbo.getInt("priority");

支持的格式：

• 标准多行注释：/** @type {ClassName} */\nvar variable;
• 单行注释：/** @type {ClassName} */ var variable;
• 多变量声明：/** @type {ClassName} */ var var1, var2;
• 表达式映射：/** @type {ClassName} b3.getMbo(\d) */

详见：JSDoc 补全功能使用指南

3. 链式调用支持（新功能）✨

插件会自动推断方法返回值类型，支持复杂的链式调用：

/** @type {psdi.mbo.MboRemote} */
var assetMbo = mbo;

// 自动推断 locationSet 为 MboSetRemote
var locationSet = assetMbo.getMboSet("LOCATIONS");

// 输入 locationSet. 会显示 MboSetRemote 的方法
locationSet.moveFirst();
locationSet.count();

// 自动推断 firstLocation 为 MboRemote
var firstLocation = locationSet.moveFirst();
firstLocation.getString("location");

4. 本地 API 数据补全

1. 获取 API 数据：

   • 访问 Gitee 仓库：https://gitee.com/shoukaiseki/maximo-script-editor/tree/master/reflection-data
   • 下载或克隆 reflection-data 目录到本地
   • 例如保存到：E:\maximo-reflection-data（或其他任意位置）

2. 配置本地 API 目录：

   • 打开配置面板（点击状态栏的 ⚙️ Maximo配置 按钮）
   • 切换到“补全设置”标签
   • 点击“选择目录”按钮
   • 选择你保存的 reflection-data 目录
   • 保存配置

3. 使用离线补全：

   • 插件会自动加载目录中的所有 JSON 文件
   • 支持智能匹配类名（如 MboRemote、MboSetRemote 等）
   • 提供完整的方法签名和参数提示

4. 已支持的类：

   • psdi.mbo.MboRemote - MBO 远程对象
   • psdi.mbo.MboSetRemote - MBO 集合远程对象
   • com.ibm.ism.script.ScriptService - 脚本服务
   • psdi.security.UserInfo - 用户信息
   • psdi.app.workorder.WORemote - 工单远程对象
   • psdi.app.workorder.WOSetRemote - 工单集合远程对象
   • java.lang.String - Java 字符串类
   • java.lang.Object - Java 对象基类
   • 等等...（共 15 个类）
   • 提供完整的方法签名、参数类型和异常信息
   • 无需连接 Maximo 服务器即可使用

5. 如何生成 reflection-data：

   • 如果你有 Maximo 环境，可以自行提取 API 数据
   • 查看详细说明：Reflection Data 提取指南
   • 支持从 Maximo JAR 包中自动提取所有类的方法信息

6. 支持的 API 文件格式：

   {
     "className": "psdi.mbo.MboRemote",
     "methods": [
       {
         "name": "getString",
         "returnType": "java.lang.String",
         "parameters": ["java.lang.String"],
         "description": "String getString(String)",
         "isPublic": true
       }
     ]
   }
   

脚本管理工具箱

打开配置面板后，切换到“工具箱”标签页，可以使用以下功能：

1. 批量导出脚本

• 点击“导出所有脚本”按钮
• 选择导出目录
• 插件会自动导出所有脚本的元数据（JSON）和源代码（JS/PY）
• 导出目录会以时间戳命名（例如：autoscript_backup_20260521_013000）

2. 拉取单个脚本

• 在脚本列表中点击“拉取”按钮
• 插件会根据 ibm_packagepath 字段自动创建目录结构
• 同时保存 JSON 配置文件和源代码文件
• 如果文件已存在，会提示是否覆盖

3. 推送脚本到 Maximo

• 在编辑器中打开 JavaScript 文件
• 右键点击编辑器 → “推送到 Maximo”
• 插件会：
  1. 自动保存历史记录（包含版本号、主机名、别名）
  2. 递增版本号（从 JSON 文件中读取并 +1）
  3. 将脚本推送到 Maximo 服务器

4. 查询脚本列表

• 点击“刷新”按钮
• 显示所有 Maximo 自动化脚本的列表
• 支持快速搜索和过滤

支持的补全对象

• service - 脚本服务对象
• mbo - MBO对象
• mboSet - MBO集合对象
• userInfo - 用户信息对象

开发

项目结构

maximo-script-vscode-plugin/
├── src/
│   ├── extension.ts          # 插件入口
│   ├── completionProvider.ts # 代码补全提供者
│   └── configPanel.ts        # 配置面板
├── package.json              # 插件配置
├── tsconfig.json             # TypeScript配置
└── webpack.config.js         # Webpack配置

开发流程

# 1. 安装依赖
npm install

# 2. 启动开发模式（自动编译）
npm run watch

# 3. 在VSCode中按 F5 启动调试

构建发布

# 生产环境编译
npm run compile

# 打包插件
npm run package

# 发布到市场（需要配置publisher）
npm run publish

技术栈

• TypeScript - 主要开发语言
• VSCode API - 插件开发框架
• Webpack - 模块打包工具
• Axios - HTTP请求库

常见问题

Q: 代码补全不工作？

A: 请检查：

1. 是否在设置中启用了代码补全
2. 是否配置了正确的服务器地址
3. 文件类型是否为 .js 或 .py

Q: 如何更新补全数据？

A: 修改配置后会自动刷新缓存，或者重启VSCode

Q: 支持哪些Maximo版本？

A: 目前支持Maximo 7.6和9.1

许可证

MIT License

相关资源

• Reflection Data 提取指南 - 如何从 Maximo JAR 包中提取 API 数据
• JSDoc 补全功能使用指南 - 详细的 JSDoc 类型注释和智能补全使用说明
• 快速开始 - 5分钟快速上手指南
• Gitee 仓库 - Maximo Script Editor - Reflection Data JSON 生成工具和预生成的 API 数据

版本更新历史

v1.2.1 (2026-05-21)

新增功能：

• ✨ 脚本管理工具箱
  • 批量导出所有 Maximo 自动化脚本
  • 拉取单个脚本并自动创建包路径目录结构
  • 查询脚本列表并支持搜索过滤
• 📊 版本管理系统
  • 推送脚本时自动保存历史记录（SKS_AUTOSCRIPT_HISTORY_SAVE）
  • 自动递增版本号（从 JSON 文件读取并 +1）
  • 记录主机名、别名等信息
• 🏷️ IBM_PACKAGEPATH 支持
  • 根据 ibm_packagepath 字段自动创建目录结构
  • 支持点号转斜杠（例如：com.example.script → com/example/script）
• ⚙️ 配置项增强
  • 添加“别名（Alias Name）”配置，用于历史记录
  • 添加“脚本存放目录”配置，自定义存储根目录

修复问题：

• 🐛 修正 API 调用错误
  • 拉取脚本时使用正确的 API：SKS_GET_AUTOSCRIPTINFOBYNAME
  • 工具箱导出时使用正确的 API 和字段名（小写 ibm_packagepath）
• 🐛 删除重复的认证头设置
  • httpRequestToMaximo 已自动处理认证，无需在调用处重复设置
• 🐛 Base64 编码问题
  • 使用 Buffer.from().toString('base64') 替代浏览器 API atob()
• 🐛 代码重构
  • 统一推送逻辑，删除重复的 pushScriptToMaximo 函数
  • 优化版本号管理，避免重复读取 JSON 文件

改进：

• 🔧 优化 HTTP 请求模块
  • 简化 URL 拼接逻辑
  • 统一认证头处理方式
• 📝 完善日志输出
  • 添加详细的调试信息
  • 改进错误提示，显示完整响应数据

v1.1.1 (2026-05-17)

新增功能：

• ✨ 完善 Maximo 9.1 MXSCRIPT API 支持
  • 更新接口使用 POST + x-method-override: PATCH 方法
  • 更新时 URL 不能加 ?lean=1（避免静默失败）
  • Body 必须使用 spi: 前缀
  • 字段名必须小写（如 spi:description）

修复问题：

• 🐛 修正 SKILL.md 文档中 MXSCRIPT 更新接口的说明
• 🐛 优化 .vscodeignore 配置，排除不必要的开发文件
• 🐛 删除 webview-ui 目录下的重复嵌套目录

改进：

• 📝 更新自动化脚本 API 调用技能文档
• 🔧 优化插件打包流程，减小 VSIX 文件大小

v1.1.0 (之前版本)

主要功能：

• ✨ React Webview UI 重构
• ✨ 智能代码补全和 JSDoc 类型注释支持
• ✨ 链式调用类型推断
• ✨ 本地 API 数据离线补全
• ✨ Maximo 7.6 和 9.1 多版本支持

作者

shoukaiseki

反馈与建议

如有问题或建议，请提交Issue。