琴房助手3-后台管理系统-系统管理员用户文档
背景
文档面向用户
- 系统管理员（推荐使用电脑端浏览器，显示效果更佳；手机端浏览器也做了一定兼容）
编写目的
- 为系统管理员用户详细介绍管理后台的各部分功能。
- 解答可能出现的部分问题。
- 您可以直接在本文档下留言以提出问题。
使用说明
登录
登录口令（管理口令）
登录口令为六位随机字母+数字的组合。需要使用小程序生成，有效期为五分钟。
系统管理员在进入小程序后，如果没有加入社团，则会自动弹出登录口令提示如下：
如果已经加入社团，则通常会自动进入小程序，此时，可以点击 “我”选项卡 - 获取 passcode 按钮也可以获取登录口令，且会拷贝到剪贴板。
登录系统
进入后会要求您输入学号与登录口令。正确输入后，点击 Login 按钮，即可进入管理后台。
进入管理后台后，功能页面的标题下方通常会有当前页面功能的简单介绍，如有需要可以进行查阅
顶部导航栏
点击社团名称后，会弹出社团选择下拉列表，点击其中的项即可切换社团。点击其中的 “+” 即可转到新建社团页面。切换社团后，所有的修改都会基于该社团进行。
如果您或修改社团后，发现顶部导航栏的选项显示并没有被更新，则可以使用点击附近的刷新图标清除缓存。
点击您的头像后，会弹出下拉列表
- 系统设置与侧边导航栏的“系统参数”指向同一页面
- 登出选项可以清除登录状态，可用于切换账号
侧边导航栏
-
Dashboard 仪表盘，登录后进入的首个页面，显示当前社团的数据概要、日志等。
-
社团管理
-
基本信息：维护社团基本信息，包括
- 社团名称
- 签到限制：当前版本并无意义，可能之后会添加实际用途
- 可用社团经费：注意，只在发生异常状况（比如计算错误等）的情况下进行调整，如果发生了收支变化，建议使用社团收支功能
- 启用财务功能选项：关闭后财务相关功能仅限于管理员使用，并不在小程序中展示。
-
财务管理：维护社团经费收支记录，并显示当前的可用经费，属于数据表格。每一条数据项包含如下字段：
- 收支：收支变化的数值，可以为负数，负数时表示社团支出，正数表示社团收入
- 事由：产生该收支变化的原因
-
公告管理：您可以在这里发布公告，属于数据表格。每一条数据项包含如下字段：
- 标题：公告标题，给用户发通知时会带上公告标题
- 内容：公告详细内容
- 选项：是否为系统公告：系统公告会发送给全部用户，一般用于系统维护、停机的报告等；非系统公告只会发送给当前社团的全部成员，一般为社团安排的公告，比如活动室停用等
-
-
活动室管理
- 基本信息：维护活动室基本信息，包含如下字段：
- 活动室ID：这个不要填写，一般在添加后自动生成，如果一个活动室被多个社团共用时，后添加的社团需要填写前者生成的活动室 ID。
- 活动室名称
- 贡献值消耗：废弃的功能，暂时没有实际用途
- 周上限、日上限：用户在使用当前活动室时，每周、每天预约的最大时长，单位为小时
- 开放时间、关闭时间：活动室开放的时间区间，修改后即时生效。比如活动室只在下午1点可用则应该填写13时开放，14时关闭。
- 地理位置：废弃的功能，用于签到，暂时没有实际用途，留空即可。
- 选项：启用签到限制：废弃的功能，用于签到。暂时没有实际用途，保持未勾选状态即可。
- 选项：活动室是否开放：取消勾选后，活动室将无法进行预订。
- 新增活动室：在页面中的活动室下拉选框中选择 “添加活动室” 后，在表单中填写活动室信息，再点击提交后即可完成添加。
- 修改活动室：在页面中的活动室下拉选框中选择指定的活动室后，活动室的信息或自动填充到表单中，修改后点击提交即可完成修改。
- 删除活动室：在页面中的活动室下拉选框中选择指定的活动室后，点击表单下方的删除按钮，完成确认后即可完成删除。
- 预约管理：维护活动室的预约信息，功能解释如下：
- 颜色显示
- 黄色：过去的时间或者未来的时间，普通用户不可以预约
- 蓝色：被用户预约的时间
- 浅绿色：自己预约的时间
- 浓绿色（绿底白字）：选中的时段，下一次操作将基于这些操作进行
- 红色、冷渐变色、暖渐变色：已经禁用的时段，颜色仅用于区分
- 占用时段：通过点击选中一些时段后，点击占用时段并选择颜色即可禁用选中的时段。
- 清除时段：通过点击选中一些时段后，点击清除即可将相关时段还原为空白状态。
- 编辑显示：通过点击选中一些时段后，点击编辑显示并输入占位文本，即可将选中的时段的显示修改为指定的文本，但是只能针对已被占用、已禁用的时段进行操作。无法直接对空白时段执行该操作。
- 表格标题按钮：向前、向后按钮分别可以将表格切换为前一周、后一周。如果想返回当前周，可以点击表格标题的 “第XX周”
- 颜色显示
- 基本信息：维护活动室基本信息，包含如下字段：
-
成员管理
-
系统日志
该页面属于功能受限的数据表格
记录系统运行期间产生的各种事件，方便在系统出问题或者用户数据错误时定位问题、解决问题。（IP：源请求发起方的 IP，但是因部署后反向代理的限制，导致用户原 IP 丢失。如果本程序不经过代理直接提供服务则会记录 IP 信息）
- 系统参数
提供了系统运行期间可能发生调整的参数。
系统初始化
系统在新的环境上部署后，如果您可以直接操作数据库并明白如何导入用户数据，那么可以不用进行初始化。
否则，您需要执行下列步骤开始使用
- 首先登录小程序，用管理员的微信账号登录小程序绑定为学号为 "-1" 的用户。（注意，绑定了 -1 的微信号无法绑定到其他学号，如果想重新绑定到其他学号，需要通过数据库手动清除指定用户的 wxId 字段，非 -1 用户的重新绑定可以删除后重新添加）
- 绑定成功后，小程序会生成登录口令，此时打开后台管理入口，在学号一栏输入 -1，口令一栏输入生成的口令，此时您可以进入管理后台。
- 顶部导航栏的社团选项，点击下拉列表中的 "+" 进入新建社团页面，输入社团信息、并提交。此时您的初始社团即可完成创建
- 进入成员管理功能页面，添加您的社团管理员、社团成员后，整个系统即完成初始化，可以正常使用。
维护后台
功能
提供系统维护的部分功能，可以在整个系统因缓存问题完全瘫痪的情况下独立运行，用于紧急处理系统问题。
注意，因为在该功能模块进行的操作会对系统运行的稳定性造成一定影响，您的所有修改操作都会被记录。
登录
与管理后台使用同一个登录界面，您必须为系统管理员，且能直接访问数据库。您需要在学号一栏填写您的 id 在口令一栏填写您的 openId （即 wx_id）后登录维护后台。
运行日志
提供运行日志的查看功能，方便在 Web 端定位系统遇到的问题，但是在系统异常的情况下，生成的日志文件可能很大，有可能导致操作时间过长。此外，该操作对系统性能、带宽占用比较大，如果非必要，请不要随意查看。
缓存管理
本部分所指的缓存，如果未特殊指明，均指中间件缓存，它们独立于 Web 应用，不会因为 Web 应用崩溃而消失，本系统暂时使用 LevelDB 作为缓存中间件。
该部分提供缓存的增删改查功能，同样使用数据表格，读写缓存与数据库不同，常规的数据库读写过程自动对缓存进行了更新，如果直接操作缓存，则有可能造成数据不一致，进而导致系统错误、瘫痪。
通常的，在系统因缓存问题瘫痪时（用户无法使用很多功能，比如用户列表、登录失败等）可以清空系统缓存来救急。如果您很清楚应该清除哪条缓存，则推荐清除单条缓存，否则可以使用全部清除。
使用全部清除时，除了中间件缓存，一些未显示在缓存列表中的缓存（应用缓存）也会被清除，如果系统未发生重大问题，这个操作与重启程序效果相同，通常可以解决大部分问题。
补充说明
数据表格
数据表格为本程序中，用于数据增删改查的一种形式。有的表格可能做了限制，比如不能执行修改、删除、新建操作等
- 新增：通常在表格左上方会有一个 “新增” 按钮，点击后会弹出一个表单，正确填写后提交即可完成新建并刷新到数据表格中。
- 删除：点击表格中的数据行后，左上功能按钮中的删除按钮（如果有的话）会激活，此时您可以点击、根据提示确认操作后删除指定的数据项
- 修改：点击表格中的数据行后，左上功能按钮中的修改按钮（如果有的话）会激活，此时点击它即可弹出数据表单，您可以在其中修改可修改的项并提交。
- 搜索（查询）：数据表格的右上方有一个搜索框，您可以在其中输入您需要搜索的内容，表格会实时显示您的搜索结果。
废弃的功能
在设计初期认为有用的功能，在设计后期或编码阶段认为没必要而遗留下的功能接口。如果您认为相关功能有需求、有必要，可以在本文档下留言，如果需求较大，可能在后续的版本中推出相关功能。
用户角色
社团角色有如下三种
- 系统管理员：拥有系统的最高权限，具有所有数据（如系统参数、以及社团管理员的全部权限）的访问、修改权限。通常负责系统维护、日常管理。
- 社团管理员、管理员角色：拥有与某社团相关数据（如用户、预定、活动室等）的完全访问、修改权限。
- 普通用户：没有特殊权限，可以使用小程序提供的全部功能，访问全部开放数据。但无法访问管理后台。
琴房助手3-后台管理系统-系统管理员用户文档
https://mori.plus/s/key3-system-admin-doc
Comments