@alanwang-merit/meritdata-platform-skill-package 1.0.8 → 1.0.10

package/skills/meritdata-platform-messaging/references/msg-center//346/224/273/347/225/245-12-/346/266/210/346/201/257/344/270/255/345/277/203-00_/346/200/273/350/247/210.md

@@ -0,0 +1,56 @@
+---
+name: 攻略-12-消息中心-00_总览
+description: 美林平台消息中心攻略（使用场景 / 页面功能 / 接口功能 / 附件）
+keywords: [消息中心, 消息管理, 消息提醒, 消息列表, 附件上传, 附件下载, 定时发送, 消息模板]
+use-cases: [消息中心页面使用, 消息发送 API, 附件上传下载, 定时消息]
+related: [cloud-system-manage / CloudFeignMessageClient]
+source: 应用开发平台-基础平台-使用攻略（十一）：消息中心.md
+---
+
+# 应用开发平台使用攻略（十一）：消息中心 — 总览
+
+**摘要**：美林平台消息中心攻略（使用场景 / 页面功能 / 接口功能 / 附件）
+
+**关联**：cloud-system-manage / CloudFeignMessageClient
+
+## 章节索引
+
+01. [消息中心使用场景](攻略-12-消息中心-章节01_消息中心使用场景.md) (原 1)
+02. [消息中心页面功能使用](攻略-12-消息中心-章节02_消息中心页面功能使用.md) (原 2)
+03. [消息中心接口功能使用](攻略-12-消息中心-章节03_消息中心接口功能使用.md) (原 3)
+04. [附：附件上传下载删除接口](攻略-12-消息中心-章节04_附：附件上传下载删除接口.md)
+
+
+## 📑 API 速查
+
+本攻略共 **2 个 API**（按章节排序）：
+
+| 章节 | API | 方法 | 路径/签名 | 类型 | 描述 |
+|------|------|------|----------|------|------|
+| 章节02_消息中心页面功能使用 | `list` | GET | `/api/announcement/list` | http | 消息列表查询（分页） |
+| 章节03_消息中心接口功能使用 | `addSendMessage` | POST | `/api/announcement/addSendMessage` | http | 发送消息（普通/定时/模板） |
+
+### JSON Schema 完整索引
+
+```json
+[
+  {
+    "chapter": "章节02_消息中心页面功能使用",
+    "apiName": "list",
+    "method": "GET",
+    "urlPattern": "/api/announcement/list",
+    "type": "http",
+    "signature": "",
+    "functionDesc": "消息列表查询（分页）"
+  },
+  {
+    "chapter": "章节03_消息中心接口功能使用",
+    "apiName": "addSendMessage",
+    "method": "POST",
+    "urlPattern": "/api/announcement/addSendMessage",
+    "type": "http",
+    "signature": "",
+    "functionDesc": "发送消息（普通/定时/模板）"
+  }
+]
+```

package/skills/meritdata-platform-messaging/references/msg-center//346/224/273/347/225/245-12-/346/266/210/346/201/257/344/270/255/345/277/203-/347/253/240/350/212/20201_/346/266/210/346/201/257/344/270/255/345/277/203/344/275/277/347/224/250/345/234/272/346/231/257.md

@@ -0,0 +1,12 @@
+---
+name: 攻略-12-消息中心-章节01_消息中心使用场景
+description: 消息中心使用场景 — 美林平台消息中心攻略（使用场景 / 页面功能 / 接口功能 / 附件）
+keywords: [消息中心, 消息管理, 消息提醒, 消息列表, 附件上传, 附件下载, 定时发送, 消息模板, 消息中心使用场景]
+use-cases: [消息中心页面使用, 消息发送 API, 附件上传下载, 定时消息]
+source-section: 1. 消息中心使用场景
+source-file: 应用开发平台-基础平台-使用攻略（十一）：消息中心.md
+---
+
+# 1.消息中心使用场景
+
+​			消息中心，顾名思义即通知信息的传达处理系统。目的是让用户需要得到的消息及提醒并进行处理。包括应用通知，系统通知，公告，私信，请求等种类。

package/skills/meritdata-platform-messaging/references/msg-center//346/224/273/347/225/245-12-/346/266/210/346/201/257/344/270/255/345/277/203-/347/253/240/350/212/20202_/346/266/210/346/201/257/344/270/255/345/277/203/351/241/265/351/235/242/345/212/237/350/203/275/344/275/277/347/224/250.md

@@ -0,0 +1,396 @@
+---
+name: 攻略-12-消息中心-章节02_消息中心页面功能使用
+description: 消息中心页面功能使用 — 美林平台消息中心攻略（使用场景 / 页面功能 / 接口功能 / 附件）
+keywords: [消息中心, 消息管理, 消息提醒, 消息列表, 附件上传, 附件下载, 定时发送, 消息模板, 消息中心页面功能使用]
+use-cases: [消息中心页面使用, 消息发送 API, 附件上传下载, 定时消息]
+source-section: 2. 消息中心页面功能使用
+source-file: 应用开发平台-基础平台-使用攻略（十一）：消息中心.md
+---
+
+# 2.消息中心页面功能使用
+
+## 📋 API 契约（机器可读）
+
+```json
+{
+  "apiName": "list",
+  "type": "http",
+  "method": "GET",
+  "urlPattern": "/api/announcement/list",
+  "functionDesc": "消息列表查询（分页）",
+  "module": "platform",
+  "requestBody": "application/json",
+  "responseType": "ResultBody<Object>",
+  "returnFields": [
+    "timestamp",
+    "status",
+    "message",
+    "data",
+    "success"
+  ],
+  "exceptionList": [
+    "HttpClientErrorException",
+    "HttpServerErrorException"
+  ],
+  "bestPractice": "捕获异常并通过 log.error 记录"
+}
+```
+
+### 2.1系统管理-基础配置-消息管理
+
+​	打开系统管理-基础配置-消息管理菜单，如下界面：
+
+​	[IMG: image-20210701141739262]
+
+消息管理页面板块分三大部分：
+
+一、顶部"**新增消息**"按钮
+
+​		[IMG: image-20210701142046404]
+
+点击"**新增消息**"按钮，进入"新增消息"页面，如下图：
+
+[IMG: image-20210701142721599]
+
+二、左边展示"消息列表"
+
+[IMG: image-20210701142211103]
+
+点击"已发送"，列表数据显示已发送列表。已发送列表包含：已发送的普通消息，已发送的定时消息。
+
+[IMG: image-20210701143835931]
+
+点击"草稿箱"，列表数据显示草稿列表。草稿列表包含：普通草稿，定时草稿。（带有时钟图标的是定时草稿，不带时钟图标是普通草稿）
+
+[IMG: image-20210701143958335]
+
+点击"**立即发送**"按钮，将定时草稿复制发信人，收信人，消息标题，消息内容和消息附件立即发送给定时草稿的收件人。
+
+点击"消息模板"，列表数据显示消息模板列表。模板列表显示消息模板数据。
+
+[IMG: image-20210701144114105]
+
+点击上图中的"**使用模板**"按钮，进入"使用模板"页面。如下图：
+
+[IMG: image-20210701150104575]	
+
+点击"定时发送"，列表数据显示定时发送列表。定时发送 列表包括：1、单次定时发送  （单次定时发送只执行一次发送）2、周期定时发送。 （周期定时发送执行多次发送任务。周期定时发送包括：按年发送、按月发送、按日发送、按周发送）
+
+[IMG: image-20210701150552597]
+
+三、右边展示"消息详情"
+
+[IMG: image-20210701142534584]
+
+#### 2.1.1发送普通消息（非定时发送消息，不点击**"定时发送"按钮**）
+
+​    点击"**插入模板**"按钮，将消息模板的标题、内容、附件以及其他相关内容填充到页面。
+
+[IMG: image-20210701151027059]
+
+​	点击"**收件人**"按钮，选择所需要发送的收件人。
+
+​	[IMG: image-20210701150830526]
+
+​	点击"**发送**"按钮，将消息立即发送给所选收件人（可在消息管理-消息列表中查看已发送消息）。
+
+​	点击"**存草稿**"按钮，将消息暂存入草稿（可在消息管理-草稿箱列表查看存入草稿的消息）。
+
+​	点击"**保存模板**"按钮，将消息存入模板（可在消息管理-模板列表查看存入的模板）。
+
+#### 2.1.2发送定时消息（点击"**定时发送**"按钮）
+
+​	点击"**定时发送**"按钮,选择发送周期类型（可选择单次发送和周期发送。单次发送只执行一次，周期发送在截止时间前多次发送）
+
+​	单次发送：
+
+​	[IMG: image-20210701151229124]
+
+​	周期发送：
+
+​	周期发送可选执行周期类型：每年、每月、每日、每周
+
+​    周期类型选择：
+
+​	（1）每年
+
+​			  选择所需要执行的月份、日期、以及小时和分钟之后，选择截止时间。				[IMG: 1-14]
+
+​	（2）每月
+
+​			 选择所需要执行的日期、以及小时和分钟之后，选择截止时间。			 [IMG: image-20210701151440629]
+
+​	（3）每日
+
+​			  选择所需要执行的小时和分钟之后，选择截止时间。				[IMG: image-20210701151518790]
+
+​	（4）每周
+
+​			 选择所需要执行星期日期、小时和分钟之后，选择截止时间。			[IMG: image-20210701151604456]
+
+​		同时生成提示信息。点击"**确定**"按钮，关闭时间选择弹窗，回到"**新增消息**"页面。。
+
+​	    悬浮"**插入模板**"按钮，点击模板标题，将消息模板的标题、内容、附件以及其他相关内容填充到页面。
+
+​		点击"**收件人**"按钮，选择所需要发送的收件人，输入消息标题和内容（同时可添加附件）。
+
+​		点击"**发送**"按钮，生成调度任务，在执行发送时间时发送消息（可在消息管理-定时发送列表中查看已发送消息）。
+
+​		点击"**存草稿**"按钮，将消息暂存入草稿（可在消息管理-草稿箱列表查看存入定时草稿的消息）。
+
+​		点击"**保存模板**"按钮，将消息存入模板（可在消息管理-模板列表查看存入的模板）。
+
+​		定时消息列表对不同周期类型分别显示"**按年**","**按月**","**按日**","**按周**"以及"**单次**"发送标识。
+
+#### 2.1.3 草稿箱-定时发送消息-立即发送
+
+[IMG: image-20210629172451906]		
+
+点击"**立即发送**"按钮，生成一条新的普通消息立即发送给用户。
+
+#### 2.1.3 定时发送-立即发送	
+
+[IMG: image-20210701151714886]
+
+点击"**立即发送**"按钮，生成一条新的普通消息立即发送给用户。
+
+#### 2.1.4消息编辑
+
+##### 2.1.4.1草稿箱-定时发送草稿编辑
+
+​			具体操作与    **2.1.2  发送定时消息 **   相同
+
+##### 2.1.4.2草稿箱-普通草稿编辑
+
+​       悬浮"**插入模板**"按钮，点击模板标题，将消息模板的标题、内容、附件以及其他相关内容填充到页面。
+
+​		点击"**收件人**"按钮，选择所需要发送的收件人，输入消息标题和内容（同时可添加附件）。
+
+​		点击"**发送**"按钮，将消息立即发送给所选收件人（可在消息管理-消息列表中查看已发送消息）。
+
+​		点击"**存草稿**"按钮，将消息暂存入草稿（可在消息管理-草稿箱列表查看存入草稿的消息）。
+
+​		点击"**保存模板**"按钮，将消息存入模板（可在消息管理-模板列表查看存入的模板）。
+
+##### 2.1.4.3消息模板-模板编辑
+
+​		可修改模板的标题、内容以及附件。
+
+##### 2.1.4.4定时发送-定时发送消息编辑
+
+​		具体操作与    **2.1.2 发送定时消息**  相同
+
+#### 2.1.5消息模板-使用模板
+
+[IMG: image-20210629172722696]
+
+​	点击"使用模板",进入"使用模板"页面。同时将消息模板的标题、内容、附件以及其他相关内容填充到页面。
+
+[IMG: image-20210629172759308]
+
+​		 点击"**插入模板**"按钮，将消息模板的标题、内容、附件以及其他相关内容填充到页面。
+
+​		点击"**收件人**"按钮，选择所需要发送的收件人，输入消息标题和内容（同时可添加附件）。
+
+​		点击"**发送**"按钮，将消息立即发送给所选收件人（可在消息管理-消息列表中查看已发送消息）。
+
+​		点击"**存草稿**"按钮，将消息暂存入草稿（可在消息管理-草稿箱列表查看存入草稿的消息）。
+
+​		点击"**保存模板**"按钮，将消息存入模板（可在消息管理-模板列表查看存入的模板）。
+
+#### 2.1.6消息管理-删除
+
+​		将已发送消息、草稿、模板、定时消息（同时删除定时调度任务）从列表中删除。
+
+### 2.2消息提醒
+
+鼠标悬浮铃铛，显示未读消息列表的标题。
+
+[IMG: image-20210701151845707]
+
+点击"**全部已读**"按钮，更改未读消息状态。
+
+点击未读消息标题，进入 未读消息列表。
+
+[IMG: image-20210701151930471]
+
+[IMG: image-20210701152013966]
+
+点击顶部"**全部已读**",更改未读消息状态。
+
+[IMG: image-20210701152050201]
+
+鼠标点击附件，可进行下载。
+
+[IMG: image-20210701152217786]
+
+#### 2.2.1消息提醒集成
+
+##### 2.2.1.1.消息提醒统计
+
+第一步、修改**cloud-system-portal**程序包中的**top-nav.vue**文件
+
+在下方代码块之前
+
+```vue
+	 <el-popover placement="bottom" width="270" trigger="hover">
+        <v-loginInfo></v-loginInfo>
+        <div id="logInfo" class="logInfo" slot="reference">
+          <span
+            :style="rigthMenubg"
+            class="tempo-api-right-menu-login-icon"
+          ></span>
+        </div>
+      </el-popover>
+```
+
+加入以下代码：
+
+```vue
+	<!--jumpMessageList为跳转页面函数-->
+    <div @click="jumpMessageList()" class="header-opt-infor item" style="">
+    <!--notReadCoun为统计数据-->
+        <el-badge
+          :value="this.notReadCount == 0 ? '' : this.notReadCount"
+          :max="99"
+          v-show="this.isAdmin == 0 ? true : false"
+          type="primary"
+          style="right: 16px;"
+        >
+        <!--v-messageList为未读列表组件-->
+          <el-popover placement="bottom" width="280" trigger="hover">
+            <v-messageList
+              :notRead="this.notReadCount"
+              v-show="this.notReadCount == 0 ? false : true"
+            ></v-messageList>
+            <i slot="reference" class="el-icon-message-solid" size="small"></i>
+          </el-popover>
+        </el-badge>
+      </div>
+```
+
+在<script></script>中引入des-utils，如下：
+
+```
+import DesUtils from "../../common/des-utils";
+```
+
+在data中加入
+
+```js
+	  //未读统计
+	  notReadCount: 0,
+      //定时轮询定时器
+      msgTimer: "",
+       //是否显示铃铛控制器
+      isAdmin: 0,
+      //定时轮询熔断机制
+      reqCountBool: true,
+      reqList: true
+```
+
+在method加入
+
+```js
+	//点击消息标题或提示铃铛，页面跳转函数
+	jumpMessageList() {
+      let routeUrl = this.$router.resolve({
+        path: "/system-manage/message/messageList/view"
+      });
+      window.open(routeUrl.href, "_blank");
+    },
+    //铃铛提示显示控制函数，判断权限
+     isTenancy(authoritiesIds) {
+      let _this = this;
+      let count = 0;
+      let roleList = authoritiesIds;
+      for (let i = 0; i < roleList.length; i++) {
+        if (roleList[i] === "TENANCYGLY") count++;
+      }
+      if (count === 0) {
+        _this.isAdmin = 0;
+        return false;
+      } else {
+        _this.isAdmin = 1;
+        return true;
+      }
+    },
+    //获取用户userId
+    //定时轮询查询未读统计个数
+    getSession() {
+      let _this = this;
+      axios["system-manager"].post("/api/ou/user/session").then(res => {
+        if (res.userId == "admin") _this.isAdmin = 1;
+        else if (this.isTenancy(res.authoritiesIds)) {
+        } else _this.isAdmin = 0;
+        _this.userName = res.name;
+        _this.code = DesUtils.strEnc(res.userId, "a1", "a2", "a3");
+        _this.reqCountBool = true;
+        _this.reqList = true;
+        _this.getCount();
+      });
+      _this.msgTimer = setInterval(function() {
+        if (_this.reqList) {
+          _this.getCount();
+        }
+      }, 10000);
+    },
+    //全部未读个数
+    getCount() {
+      let param = {
+        id: "",
+        code: this.code
+      };
+      if (this.reqCountBool) {
+        this.reqCountBool = false;
+        axios["system-manager"]
+          .post("/api/announcement/getMessageCount", param)
+          .then(res => {
+            this.notReadCount = res.notRead;
+            window.localStorage.setItem("notReadCoutData", this.notReadCount);
+            this.reqCountBool = true;
+          });
+      }
+    },
+```
+
+在css中加入基础样式（可根据项目需求定制修改样式）
+
+```css
+.header-opt-infor {
+  color: #adb5be;
+  cursor: pointer;
+  line-height: 60px;
+  padding-left: 16px;
+  padding-right: 16px;
+  font-size: 16px;
+  float: left;
+}
+.header-opt-infor:hover {
+  color: #fff;
+}
+.el-badge__content {
+  border: 0px solid #fff !important;
+}
+.header-opt .logInfo span {
+  display: inline-block;
+}
+```
+
+##### 2.2.1.2.消息提醒列表
+
+参考**cloud-system-portal**程序包中的**messageList.vue**文件
+
+### 2.3消息列表
+
+点击"全部消息"，显示已读和未读消息列表。
+
+[IMG: image-20210701152410689]
+
+点击"未读",显示未读消息列表。
+
+[IMG: image-20210701152454255]
+
+点击"已读",显示已读消息列表。	
+
+[IMG: image-20210701152542867]