🚀 服务现在工具文档
本项目提供了与 ServiceNow 系统进行交互的工具和脚本，能有效解决与 ServiceNow 系统集成、管理和操作过程中的各类问题，为用户带来便捷、高效的使用体验。
🚀 快速开始
本项目提供了一系列与 ServiceNow 系统交互的工具和脚本，涵盖服务目录集成、变更管理等多个方面。以下是快速了解和使用项目的指引。
✨ 主要特性
- 服务目录集成：集成并管理 ServiceNow 服务目录。
- 目录优化：提供优化服务目录的功能。
- 变更管理：创建、管理和操作变更请求。
- 工作流管理：设计和执行工作流。
- 变更集管理：管理多个变更请求的集合。
- 知识库集成：集成和服务知识库文章。
- 用户管理：创建、更新和管理用户及组。
💻 使用示例
基础用法
项目包含演示脚本，展示如何使用工具：
# examples/catalog_optimization_example.py: 展示如何分析并改进ServiceNow服务目录
# examples/change_management_demo.py: 展示如何创建和管理变更请求
📦 安装指南
文档未提及安装步骤，故跳过此章节。
📚 详细文档
更多文档可在docs目录中找到：
- 服务目录集成 - 详细说明服务目录集成信息
- 目录优化计划 - 详细的目录优化功能规划
- 变更管理 - 详细说明变更管理工具
- 工作流管理 - 详细说明工作流管理工具
- 变更集管理 - 详细说明变更集管理工具
🔧 技术细节
认证方法
基本身份认证
SERVICENOW_AUTH_TYPE=basic
SERVICENOW_USERNAME=your-username
SERVICENOW_PASSWORD=your-password
OAuth 认证
SERVICENOW_AUTH_TYPE=oauth
SERVICENOW_CLIENT_ID=your-client-id
SERVICENOW_CLIENT_SECRET=your-client-secret
SERVICENOW_TOKEN_URL=https://your-instance.service-now.com/oauth_token.do
API 密钥认证
SERVICENOW_AUTH_TYPE=api_key
SERVICENOW_API_KEY=your-api-key
故障排除
变更管理工具常见错误
- 错误:
argument after ** must be a mapping, not CreateChangeRequestParams- 这个错误发生在将
CreateChangeRequestParams对象而不是字典传递给create_change_request函数时。 - 解决方案: 确保传递一个参数字典，而不是 Pydantic 模型对象。
- 注意: 变更管理工具已更新以自动处理此错误。函数现在会尝试自动拆解参数，即使它们被错误地包装或传递为 Pydantic 模型对象。
- 这个错误发生在将
- 错误:
缺少必需的'短描述'参数- 这个错误发生在未提供创建变更请求所需的所有参数时。
- 解决方案: 确保包含所有必需参数。对于
create_change_request，short_description和type都是必需的。
- 错误:
无效的'type'参数值- 这个错误发生在传递给
type参数的值无效时。 - 解决方案: 使用一个有效的值:"normal"、"standard"或"emergency"。
- 这个错误发生在传递给
- 错误:
无法在 auth_manager 或 server_config 中找到 get_headers 方法- 这个错误发生在认证配置不正确时。
- 解决方案: 检查并确保
auth_manager和server_config的配置正确。参考认证文档进行设置。
🤝 贡献指南
如何贡献代码
- 克隆仓库：使用 Git 克隆此仓库。
- 创建功能分支：为新功能或修复创建新的分支。
- 提交更改：提交您的更改并添加详细的提交信息。
- 推送请求：将分支推送到主仓库以发起合并请求。
如何报告问题
- 通过 Issues 页面报告问题，包括详细的问题描述和复现步骤。
📄 许可证
本项目遵循MIT 许可证。