门户工作室管理员和开发者指南 — OpsIQ

门户工作室管理员和开发者指南 — OpsIQ

概述 OpsIQ 门户工作室允许您构建、预览、管理、发布和扩展企业客户门户。此指南为管理员和开发者提供了有效利用门户工作室的基本信息。

关键特性

• 大胆构建，安全发布：了解工作室的所有权，并确保在深入构建之前做好准备。
• 页面和组件管理：创建页面和可重用部分，设计导航和页脚，并预览真实用户旅程。
• 帮助中心集成：在没有重复内容的情况下运营帮助中心，并配置安全的登录方法。

管理员指南

架构

• 所有权：门户工作室管理面向客户的外壳，包括页面、组件位置、品牌和导航。帮助中心管理内容，如语言和文章。
• 数据管理：工作室通过安全桥接使用帮助中心内容，避免创建重复的文章存储。

准备情况

• 准备步骤：确认规范门户地址，设置品牌元素，配置导航，并确保至少有一种登录方法处于活动状态。
• 质量保证：建立签名预览握手，并在解决所有阻塞项后创建第一个受管发布。

构建

• 页面和部分：使用构建菜单创建或选择页面，设置路由并管理组件。
• 可重用模式：实施可重用模式以保持一致的设计，同时允许品牌变体。

导航和页脚

• 设计：为所有路由创建统一的导航和页脚，确保可访问性和移动响应性。

预览

• 真实旅程：测试各种用户场景和设备断点，以确保跨平台的无缝体验。

帮助中心管理

• 内容创建：管理帮助中心内的类别、部分和文章，确保适当的语言和SEO配置。

身份和组织

• 登录配置：设置安全的登录方法并管理身份发现和SCIM配置。

工单旅程

• 支持旅程构成：设计具有各种入口点和配置的综合支持旅程。

审查和发布

• 受管发布流程：经历草稿、审查、批准和发布的各个阶段，确保所有关键元素都经过验证。

迁移和扩展

• 安全迁移：进行迁移时提供证据和回滚能力，确保当前发布不受干扰。

开发者扩展指南

架构

• 组件扩展：注册稳定的组件类型和架构，确保符合安全和性能标准。

组件合同

• 定义包：使用结构化格式定义组件包，包括版本控制和权限。

数据源和绑定

• DTO使用：实施权限安全的数据传输对象（DTO）进行数据管理，确保安全性和效率。

结论

本指南作为管理员和开发者使用 OpsIQ 门户工作室的全面资源。通过遵循概述的流程和最佳实践，您可以有效地构建和管理一个强大的客户门户。