Комментирование

Комментирование - это чат пользователей внутри платформы, которое поддерживает отметку пользователей и прикрепление файлов.

Настроить отчёт комментирования

Для того, чтобы настроить отчёт нужно создать справочник со следующими атрибутами:

Код	Тип	Описание
NAME	Строка	Текст комментария.
ORD	Целое число	Системный атрибут.
PARENT_ID	Целое число	Системный атрибут.
CREATOR_ID	Строка	Задание правила вывода элементов.
CREATOR_NAME	Строка	Имя и фамилия пользователя.
CREATE_DATE	Дата	Дата и время добавления комментария (отображение даты в зависимости от системных настроек).
FILE_LINK	Файл	Прикреплённый к комментарию.
WAS_CHANGED	Логический флаг	Флаг, менялся ли комментарий.
WAS_DELETED	Логический флаг	Флаг, удалили ли комментарий.
WHOM_TO_NOTIFY	Строка	Кому отправлены уведомления.
WHOM_TO_NOTIFY_EMAIL	Строка	E-mail отмеченный пользователей.
IS_INTERNAL	Строка	Флаг, прочитано ли сообщение.
BLOCK_ID	Элемент справочника	Идентификатор блока, куда относятся комментарии, если комментариев несколько на форме. Необязательное поле.
LINK_TO_SOURCE	Строка	Ссылка на карточку, в которой отмечен пользователь.

На созданном справочнике следует создать отчёт через кнопку в выпадающем меню "Сохранить как".

Настроить список пользователей для упоминания

В функционале комментирования подключена возможность упоминания пользователей. В большинстве случаев пользователю должен быть разрешен отдельный пул пользователей для упоминания, для этого следует настроить отчёт на внешнем справочнике.

Создать соединение с источником

Чтобы настроить внешний справочник требуется создать Соединение с источником на источнике /subjects/api/SubjectsDataSource/.

JSON объекта Соединение

1 {
2   "dbType": "Web",
3   "connectionString": "https://.../subjects/api/SubjectsDataSource/",
4   "id": 1,
5   "name": "Соединение с серверными субъектами"
6 }

Настроить внешний справочник

После создания соединения с источником следует выбрать его в качестве соединения в конструкторе внешнего справочника и задать идентификатор объекта "User".

Создать и настроить отчёт

После создания внешнего справочника следует создать отчёт, где в боковик отдать созданный внешний справочник и настроить фильтрация на отображение его строк. Более подробно о фильтрации в отчёте можно прочитать здесь

Подключить комментирование на форму

Для того, чтобы подключить комментирование на форму следует настроить действие ShowCommentsAction и подключить его к кнопке, которая будет вызывать панель комментирования.

Пример использования

Кейс: настройка комментирования на кнопку в форме с настройкой упоминания пользователей.

Создать и настроить отчёт, содержащий комментарии

По инструкции выше создать отчёт, который используется для хранения комментариев.

Создать и настроить отчёт, содержащий список пользователей

По инструкции выше создать отчёт, который используется для фильтрации пользователей, доступных для упоминания. Для того, чтобы были доступны только актуальные пользователи на стенде study.3v-cloud.com, следует настроить следующую фильтрацию:

Настроить кнопку с действием

Создать кнопку и задать ей идентификатор действия. Действие следует настроить следующим образом

 1 {
 2  "mentionsObjectCode": "Report_USERS_FOR_COMMENTS",
 3  "mentionsObjectParameters": [],
 4  "useMentions": false,
 5  "metaObjectId": 763,
 6  "parameters": [
 7   {
 8    "id": 1,
 9    "expressionId": null,
10    "value": 1,
11    "hasMultipleValues": false,
12    "dataType": "Undefined"
13   }
14  ],
15  "discriminator": "ShowCommentsAction",
16  "comment": null,
17  "enableExpressionId": null,
18  "id": 1,
19  "name": "Показать комментарии",
20  "code": null
21 }

, где metaObjectId - это идентификатор настроенного отчёта, содержащего комментарий, а mentionsObjectCode - это код отчёта, содержащего список пользователей.