第十章 UI相关
作者：胡小根
邮箱：2317673705@qq.com
版本：0.0.1
1. 概述
本文档将UI、切图、前端html代码、前端JS代码、前端css代码、后台接口之间的关系进行了描述。相应的前端开发人员依据此文档进行开发即可。
2. 界面、素材和代码关系
2.1 APP界面
APP UI、切图、前端代码之间的关系如下：
| App页面 | 界面素材 | 前端ViewController代码 | 后台接口定义 | 后端接口是否已完成 |
|---|---|---|---|---|
| 1. 登录页 |
/account/login 登陆后同时需要调用接口： [12-15 21:43新增]用户详情：/account/info [12-15 21:43新增]组织结构：/departments |
是 | ||
| 2. 注册页 |
/account/register/get-captcha /account/register |
是 | ||
| 3. 修改密码页 | /account/password/reset | 是 | ||
| 4. 找回密码 | /account/password/forget-password/get-captcha | 是 | ||
| 5. 重设密码 | /account/password/forget-password/reset | 是 | ||
| 6. 我的 |
/account/info(默认情况下显示本地已经缓存的结果，但每次点击这个页面时需要更新数据) /account/logout |
是 | ||
| 7. 个人资料 |
/account/info(默认情况下显示本地已经缓存的结果，但每次点击这个页面时需要更新数据) /account/work_experiences /account/education_backgrounds |
否 | ||
| 8. 办公首页 |
公司名称取自组织架构(/departments)最顶层名称 /app/oa/banner-images /oa/menus |
是 | ||
| 9. 通讯录列表页 | /account/contacts /account/contact/edit /account/contact/delete | 是 | ||
| 10. 联系人详情页 | /user/{user_id}（有关用户部门的信息，需要从本地缓存的部门列表里面查找） | 否 | ||
| 11. 我的动态 |
以下接口的结果缓存下来，以向后续衍生页面提供数据： /user/{user_id}/dynamics /dynamic/{dynamic_id}/comments /dynamic/{dynamic_id}/transmit /dynamic/{dynamic_id}/comment /dynamic/{dynamic_id}/favor /dynamic/{dynamic_id}/delete |
是 | ||
| 12. CRM客户关系管理 |
/app/crm/banner-images /app/crm/menus |
是 | ||
| 13. 客户列表页 |
以下两个接口必须载入缓存到本地： /customer_column_definitions(过滤条件在这个返回结果里面定义了) /customer_table_definitions 以下可以选择性缓存，由App开发人员决定（建议缓存）： /account/customers 后端给出的接口需要根据表和字段的rank进行排序！前端省去排序的操作。 |
是 | ||
| 14. 动态转发 | /dynamic/{dynamic_id}/comment/create | 是 | ||
| 15. 工作报告 | /work_reports | 是 | ||
| 16. 新建工作报告 | /work_report/create | 是 | ||
| 17. 批阅工作报告 | /work_report/{id}/read | 是 | ||
| 18. 知识库 |
/kb/company(公司知识库) /kb/department(部门知识库) /kb/mine(我的知识库) |
是 | ||
| 19. 我的知识库 | /kb/mine | 是 | ||
| 20. 首页 |
/account/tasks(待办任务只需依次显示字段：流程实例标题（名称）、发起人名字、发起时间。) /account/attention/history（所有的关注都要显示是什么关注产生的历史——包括客户、物料、用户和自定义业务场景的名称，以及显示from_name。当为用户操作了某个文件时，还需要显示文件的信息。） /account/common_uses |
否 | ||
| 21. 物料列表页（页面和业务场景列表一致，但接口不一样） |
以下两个接口必须载入缓存到本地： /material_column_definitions(过滤条件在这个返回结果里面定义了) /material_table_definitions 以下可以选择性缓存，由App开发人员决定（建议缓存）： /account/materials 后端给出的接口需要根据表和字段的rank进行排序！前端省去排序的操作。列表页默认显示7个常用字段（如果不够7个常用字段，则空缺）。 |
否 | ||
| 22. 业务场景列表页 |
以下两个接口必须载入缓存到本地： /scene_column_definitions(过滤条件在这个返回结果里面定义了) /scene_table_definitions 以下可以选择性缓存，由App开发人员决定（建议缓存）： /account/scene_instances 后端给出的接口需要根据表和字段的rank进行排序！前端省去排序的操作。 |
是 |
2.2 Web界面
后台的静态代码、接口之间的关系如下：
| Web页面 | 后台接口定义 | 后台接口是否已完成 |
|---|---|---|
| 1.配置管理->配置数据源 |
/config/database /config/database/edit |
否 |
| 2.配置管理->配置SAP连接 |
/config/sap /config/sap/edit |
否 |
| 3.配置管理->配置计划任务（缺少创建计划任务的弹出框） |
/config/jobs /config/job/create |
否 |
| 4.用户权限管理->组织结构 |
/department_types /department_type/create /department_type/{department_type_id}/delete /department_type/{department_type_id}/department_column_definitions /department_column_definition/{id} /department_column_definition/create /department_column_definition/{id}/edit /department_column_definition/{id}/delete /departments /department/{department_id} /department/create /department/{department_id}/edit /department/{department_id}/delete |
是 |
| 5.用户权限管理->角色管理 |
/business_scene_definitions /roles /role/create /role/{role_id}/edit /role/{role_id}/delete /role/{role_id}/data-authorities /data-authority/{id} /data-authority/create /data-authority/{id}/delete /role/{role_id}/func-authorities /func-authority/{id} /func-authority/create /func-authority/{id}/delete /role/{role_id}/sns-authorities /sns-types /sns-authority/{id} /sns-authority/create /sns-authority/{id}/delete |
否 |
| 6.用户权限管理->用户管理 |
/account/{user_id} /account/{user_id}/edit /account/{user_id}/delete /user_table_definitions /user_table_definition/{user_table_definition_id} /user_table_definition/create /user_table_definition/{user_table_definition_id}/edit /user_table_definition/{user_table_definition_id}/delete /user_table_definition/{user_table_definition_id}/user_column_definitions /user_column_definition/{user_column_definition_id} /user_column_definition/create /user_column_definition/{user_column_definition_id}/edit /user_column_definition/{user_column_definition_id}/delete |
是 |
| 7.用户权限管理->菜单管理 |
/menus /menu/{menu_id}/update_order |
是 |
| 8.办公主数据->分类设置 |
/form-categories /form-category/{id} /form-category/create /form-category/{id}/edit /form-category/{id}/delete /form-definitions /form-definition/{id} /form-definition/create /form-definition/{id}/edit /form-definition/{id}/delete /process-categories /process-category/{id} /process-category/create /process-category/{id}/edit /process-category/{id}/delete /process-definitions /process-definition/{id} /process-definition/create /process-definition/{id}/edit /process-definition/{id}/delete |
否 |
| 9.办公主数据->表单管理 | 参见表单引擎接口设计 | 否 |
| 10. 配置管理 | 配置 | 否 |
前台的静态代码、接口之间的关系如下：
| Web页面 | 后台接口定义 | 后台接口是否已完成 |
|---|---|---|
| 框架相关 |
菜单相关接口： /menus /crm/menus /oa/menus 认证授权相关： /account/login /account/logout /account/edit |
是 |
| 1.首页 |
/account/tasks /task/{task_id} /task/{task_id/edit(可能用不到) /account/attention/history /account/common_uses 消息及通知相关接口 关注相关接口 |
否 |
| 2.CRM->客户 |
客户相关接口 |
否 |
| 3.CRM->物料 （页面和客户一致） |
物料相关接口 |
否 |
| 4.CRM->其他业务场景 （页面和客户一致） |
业务主数据相关接口 表单引擎接口（当业务场景采用流程管理方式管理时，需要用到此接口） 阶段引擎接口（当业务场景采用阶段管理方式管理时，需要用到此接口） |
否 |
| 5.办公->工作报告 |
工作报告相关接口 |
是 |
| 6.办公->通讯录 |
联系人相关接口 |
是 |
| 7.办公->知识库 |
知识库相关接口 |
是 |
| 8.办公->业务流程 |
流程管理 表单引擎相关 启动流程 流程代理 |
否 |