用户手册旧版（即将停止维护）

1.概述

插件支持附件下载信息的即时记录，支持管理用户进行查询、导出，支持空间管理员进一步设置附件下载、导出Pdf或Word、页面复制或移动等权限。

2. 页面入口

2.1."附件下载记录"页面和"配置项"页面

管理员权限的用户登录后点击右上角的设置图标，点击 管理应用 或 插件。

进入插件管理页面后，在左侧菜单中可以找到菜单项 附件下载记录 和 配置项。

点击 附件下载记录 进入页面如下：

点击 配置项 进入页面如下：

2.2."更多页面权限"页面

空间管理员可以在空间内页面打开左下角 空间管理 菜单，点击 权限 菜单项。

点击 更多页面权限 Tab页，进入页面如下：

3. 操作说明

3.1.条件查询

在 附件下载记录 页面，可以将用户名和附件名称作为筛选条件查询下载记录，点击 查询 按钮查看结果。

3.2.导出

在 附件下载记录 页面，点击 导出 ，选择 导出CSV 选项，可以将下载记录数据导出为CSV格式文件。页面中的查询筛选条件会影响导出数据的结果。

3.3.下载记录开关

在 配置项 页面，可以控制下载记录开关状态。开启：附件下载时记录数据，关闭：附件下载时不记录数据。 默认：开启。

3.4.数据过期清理

在 配置项 页面，可以控制保留数据记录的天数。清理程序每天执行一次，将超出保留天数的数据清除。如果设置为不限制，将不会清除数据。 默认：30天。

3.5.更多页面权限控制

在 更多页面权限 页面，可以设置是否保留组、用户、匿名用户进行附件下载、页面内容选中复制、导出为Pdf、导出为Word、页面复制、页面移动操作的权限。

注意：本页面所有权限是在全局和空间权限的基础上进一步设置的。对于用户来说，全局或空间禁用相关权限的情况下，这里的设置将会无效，插件不会越过全局或空间设置的权限开放某个权限。

如果同一个用户的权限在组和用户列表中被多次设置，取保留权限的并集作为最终的权限设置结果。

常见问题：禁用了用户或组的权限，为什么没效果？ ——请检查匿名设置是否开放了对应权限，如需禁用内部用户权限，请先关闭匿名用户对应权限

可以点击 初始化设置 按钮一键初始化空间下所有更多页面权限的设置，将空间权限设置中的所有组和用户自动添加过来，默认保留全部权限。

点击页面中的 编辑权限 按钮进入编辑视图，取消勾选组、用户、匿名用户的对应权限，即禁用了该操作权限，勾选则保留该操作权限。

可以搜索并添加组或用户，再对其进行相关权限设置。可以点击组或用户设置行中的 删除 ，去掉该行设置。

设置完成后，需要点击 保存所有 按钮，使权限设置修改生效。

4. REST API

4.1.数据提取

说明：

一次性获取当前留存的全部附件下载记录信息。

路径：

GET {BaseUrl}/rest/attachmentListener/latest/downloadHistory/queryAllDownload

返回结果：

[
    {
        "id": 5,
        "downloadDate": "2021-01-23 11:05:38",
        "userName": "userName 10",
        "userKey": "admin",
        "spaceKey": "ds",
        "spaceName": "Demonstration Space",
        "pageId": 65546,
    	"pageName": "spaceName 82389",
        "attachmentId": 0,
        "attachmentName": "Attachment Name2A",
    	"url": "http://localhost:1990/confluence/ds/65546"
    },
    {
        "id": 23,
        "downloadDate": "2021-01-23 12:22:13",
        "userName": "Poppy",
        "userKey": "1",
        "spaceKey": "123",
        "spaceName": "spaceName 12345",
        "pageId": 82389,
        "pageName": "spaceName 82389",
        "attachmentId": 82389,
        "attachmentName": "Attachment Name2A",
        "url": "http://localhost:1990/confluence/ds/65546"
    }
]

4.2.添加附件下载记录

说明：

插件不监控第三方插件实现的附件下载行为。本接口允许使用POST的方式添加附件下载记录。

路径：

POST {BaseUrl}/rest/attachmentListener/latest/downloadHistory/addRecord

Post JSON:    

{
    "userKey": "1",
    "userName": "Poppy",
    "spaceKey": "123",
    "spaceName": "spaceName 12345",
    "pageId": "82389",
    "pageName": "spaceName 82389",
    "attachmentId": "82389",
    "attachmentName": "Attachment Name2A",
    "url": "http://localhost:1990/confluence/ds/65546"
}

参数说明：

返回结果：