The Activity Feed module is intended to line up the communication process within the company between users and agents; in other words, between employees who set tasks and who handle them.
This functionality allows keeping an eye either on comments or work notes left within some record or tracking the record field changes (all record fields or a fieldset specified by the user).
Activity Feed can be used on objects of the Task type in both main interfaces (agent interface and Self-Service Portal), which allows using it by users without specific roles.
Using activity feed
Creating an activity feed
To use feed on forms, you need to configure the <activityFeed> widget first. For this, please complete the steps below:
- Navigate to Portal Structure → Widgets.
- Click New to create a new widget.
- Fill in the fields as described below.
- Click Save or Save and Exit to apply changes.
| Field | Mandatory | Description |
|---|---|---|
| Name | Y | Widget name (for example: "Activity feed widget"). |
| Description | Y | Widget brief description (for example: "Enabling activity feed on tasks"). |
| Active | Select this checkbox to activate a widget. Until the widget is not activated, it cannot be used within objects. | |
| Template | N | Fill in the widget template. The default template value is activityFeed <activityFeed/> Check the widget creation guide for more information about this field. |
| CSS | N | Specify CSS classes for the widget structure and style. |
| Client script | N | Fill in widget client logic if necessary. Check the widget creation guide for more information. Generally, no additional logic is required in the described case. |
| Server script | N | Fill in widget server logic if necessary. Check the widget creation guide for more information. Generally, no additional logic is required in the described case. |
| Demo data | N | Specify additional widget options if necessary. Check the widget creation guide for more information. |
| Tables | N | Specify tables (one or more) to enable activity feed functionality on their forms. In the case described, it's the Task table. |
| Inheritance | N | Select this checkbox if you want to make a widget available for adding to child tables' records. |
After saving the record, it will be available to add on the record form by the Form Layout functionality as described below.
Activity feed view
After adding a widget and submitting a form, scroll it down to find the activity feed view as shown below (this screenshot is given as an example; the production version in your application may differ from it).
By clicking on the tabs under the input field, you can filter out the displayed information.
| Section | Description |
|---|---|
| All | This section displays all field changes and all comments left to this record. |
| Work Notes | This section displays only work notes left to this record. |
| Additional Comments | This section displays only additional comments left to this record. |
| History | This section allows filtering out only record field changes. |
- To display changes of the specified fields in the History section instead of all fields changes, use the Available history fields handler functionality:
- Click on the three dots on the right to open the kebab menu.
- Click Available history fields item.
- Unselect fields changes of which should not be displayed in the activity feed.
- Click Apply.
Even if the field value changes are not displayed there, they are logged and can be reached in the History dictionary.
Adding an activity feed
Add an activity feed widget created in the previous step on the record form using the Form Layout functionality. For this, please complete the steps below:
- Open the hamburger menu on the top left of the form.
- Navigate to the Configure → Form → Layout item and click on it.
- Find the activity feed widget in the Available area and move it to the Selected area.
- Click Save to apply changes.
After this, your changes are displayed on the record form.
Perform these steps for every form on which you need to enable Activity feed functionality since it is not inherited, and every activity feed is related to the specified task object.
Configuring an activity feed
To add some more journal input fields in addition to default ones (Additional Comment and Work Notes), please complete the steps below:
- Navigate to System Definition → All Columns.
- Click New and fill in the fields.
- Click Save or Save and Exit to apply changes.
| Field | Mandatory | Description |
|---|---|---|
| Table | Y | Specify a table on which the activity feed widget was enabled (for example, the Task table). |
| Column type | Y | In this field, select the Journal input value. |
| Title | Y | Specify a column title for this additional field. It will be displayed on the record form and can be multilingual. |
| Name | Y | This field contains a system column name and is populated automatically once you have filled a column title. |
You can use available column attributes on this page for more precise configuration. For example, turn on the Mandatory attribute to make the field mandatory to fill in.
Также лента активности позволяет ознакомиться с историей изменения полей записи (кто, когда изменил и какое поле, какое было значение и какое стало).
Если менялось несколько значений - все фиксируются.
В ленте активности можно использовать фильтры:
- Отображать все изменения записи
- Отображать добавления воркнот
- Отображать добавления комментов
- Отображать изменения полей
Справа есть кебаб-меню, которое позволяет:
- Настроить, какие фильтры должны отображаться
- В случае выбора варианта 4 указать, изменения каких полей записи должны отображаться (Available History Fields).
Это фильтрация на уровне пользователя. А где на уровне администратора? Где сортировка? Пагинации пока не увидел.
Чтобы использовать активити фид, необходимо сначала вынести его на форму таблицы с помощью форм лейаут. Активити фид реализуется с помощью симплтега activityFeed.
Что с ACL, как они работают? Все ли сейчас, кто видит запись, могут видеть активити фид?
Кнопка SHow All показывает все записи, и Hide Information скрывает, оставляя только три последних.
Этап 1. Беседы в Activity Feed
1. Cоздан симпл-тэг/виджет, с помощью которого можно добавить и читать комментарий первого уровня, в т.ч. и для портала
Этап 2. История в AF
2. Можно ознакомится с историей изменения записи, отображаются секции с полями
Этап 3. Фильтрация, сортировка и пагинация.
3. Можно настраивать фильтрацию и сортировку на уровне пользователя, на уровне администратора
4. Работает пагинация (возможно отдельная цель)
Этап 5: Мгновенные сообщения в AF
6. Моментальная публикация комментария и автообновление ленты с комментариями.
Acceptance Criteria
1. Администратор может добавить на форму/портальную страницу виджет Activity Feed, указав в настройках виджета доступные для работы типы комментариев и доступные для вывода поля в истории
2. Пользователь в виджете Activity Feed может:
- оставить комментарий/рабочую заметку(либо любой другой доступны тип комментария)
- ознакомится с комментариями/рабочими заметками других пользователей
- ознакомится с историй изменения записи (изменением выбранных полей)
- выбрать поля вывода истории
- выбрать типы комментариев для ввода и отображения
3. К информации вводимой и выводимой в виджете применяются ACL
4. Информация в виджете обновляется моментально
