Руководство администратора

В системе можно настраивать три вида шаблонов для каждой категории:

•NTF — вызывается при создании новой задачи (NTF — сокращение от New Task Form),

•MTF — вызывается при просмотре задачи (MTF — сокращение от Main Task Form),

•Cell — используется для краткого отображения задачи в списке задач (cell — это ячейка).

Эти шаблоны назначаются в настройках категории, на вкладке Вид, по кнопке Шаблонизация. Для редактирования динамического шаблона можно использовать JSON-редактор.

Каждый вид шаблона имеет свои особенности — в нем могут быть допустимы или недопустимы отдельные ключи и настройки.

Структура шаблона

В базовом варианте динамический шаблон задачи — это JSON трехуровневой структуры: sections -> blocks -> elements. Также может присутствовать необязательный раздел настроек settings, как для всего шаблона, так и для отдельных элементов.

{
   "sections": [
       {
           "name": "...",
           "blocks": [
               {
                   "name": "...",
                   "isExpandable": false,
                   "defaultIsExpanded": true,
                   "footer": "",
                   "header": "",
                   "elements": [
                       {
                           "name": "...",
                           "type": "...",
                           "dataKey": "...",
                           "viewMode": "...",

                           "settings": {...}  
                       },
                         ...

                   ]
               }
           ]
       },

    ...

   ],

   "settings": {...}
}

В шаблоне MTF раздел Sections соответствует вертикальным вкладкам (секциям), раздел blocks — горизонтальным блокам, раздел elements - элементам. В настоящее время блок в секции может быть только один.

Структура шаблона задачи.

Если шаблон NTF включает несколько секций, то они будут отображаться пользователю не одновременно в виде вкладок, а последовательно в виде отдельных экранов, имитируя пошаговое создание задачи. На каждом таком экране будет отображаться кнопка Далее, на последнем экране — кнопка Готово.

Последовательный ввод — секции в карточке новой задачи.

Секции (sections)

Шаблон содержит одну или несколько секций.

Каждая секция (из массива sections) содержит ключи:

Пример шаблона с двумя секциями:

{
   "sections": [
     {
          "name": "Вкладка 1",
          "blocks": []
     },
     {
          "name": "Вкладка 2",
          "blocks": []
     }
   ]
}

Блоки (blocks)

Каждый блок (из массива blocks) может содержит ключи:

Пример массива блоков:

"blocks": [
            {
               "name": "Название блока",
               "isExpandable": false,
               "defaultIsExpanded": true,
               "footer": "",
               "header": "",
               "elements": [...]
            }
         ]

Элементы (elements)

Каждый элемент (из массива elements) может содержать ключи:

Пример настроенного шаблона с элементами:

[

 {
      "name": "Договор",
      "type": "mainParam",
      "dataKey": "taskText",
      "viewMode": "normal"
 },

 {
      "name": "От",
      "type": "mainParam",
      "dataKey": "owner",
      "viewMode": "normal"
 },

 {
      "name": "Участники встречи",
      "type": "exparam",
      "dataKey": "182",
      "viewMode": "normal"
 }

]

Настройки (settings)

Настройки можно описать с помощью раздела settings. Общие настройки для всего шаблона должны идти перед или после раздела sections. Собственные настройки могут быть у каждого элемента.

Значения settings по умолчанию:

•fontSize — 17px

•textColor — grey

•titleSize — 17px

•titleColor — black

•titleFontWeight — regular

•textItalic — false

•bgColor — пусто

•align — left

В разделе settings могут настраиваться следующие ключи:

Список действий (options)

В шаблоне для задачи доступно меню со списком доступных действий. Это меню настраивается с помощью подраздела options в разделе settings. Если такого подраздела в шаблоне нет, будут доступны все возможные действия (т.е. с помощью options список доступных действий можно сократить, но не расширить).

Пример настройки подраздела options:

 "settings": {

         ...        

         "options": {
                 "createSubtask": true,
                 "createLinkedTask": true,
                 "createNewTask": true,
                 "changeTaskText": true,
         }

         ...

 }

Возможные действия:

Настройка нажатия на задачу в представлении списке (onTap)

В шаблоне списка задач можно настроить действие, которое будет выполняться по нажатию на представление задачи вместо стандартного открытия карточки MTF. Действие настраивается через объект onTap в разделе settings шаблона.

Возможные действия:

Пример настройки подраздела onTap - по нажатию на задачу открывается не карточка задачи, а блок "Используется". Такая настройка позволяет реализовать многоуровневый каталог.

{
  "settings": {
      "viewMode": "flat",
      "showTaskFilter": false,
      "onTap": {
          "action": "openUsedBlock",
          "id": 111
      }
  }

}

где 111 — это ID таблицы в блоке "Используется".

Настройка меню действий через addButton

addButton — это список (массив) объектов onTap действий для создания задачи (openNewTask). Иными словами, с помощью addButton можно задать способы создания задачи, а именно в какие категории можно их поставить.

Данный параметр возможно настроить как в шаблоне cell категории, так и в элементе контейнера (например, toolbar’а).

Пример настройки в cell шаблоне:

"addButton": [

 {

         "action": "openNewTask",

         "id": 3020,

         "context": "cat+text"

 }

]

Настройка кнопок rightBarButton

rightBarButton — json строка onTap действий для настройки кнопок в верхней панели. Может быть настроен как в дин.шаблоне категории, так и в контейнерах.

В шаблоне МТФ настроенный rbb будет действовать на весь МТФ, на все вкладки формы. То есть, если в БИ настроен rbb, то он не будет отображаться, только rbb МТФ.

Пример кнопки rightBarButton

Пример настройки в шаблоне:

"rightBarButtons":[

 {"action":"openTaskSource",

  "icon":"Basket",

  "dataSourceUrl":"/app/v1.2/api/publications/action/mob-rest-basket"}

]

Настройка Cell шаблонов

       Ячейки задач с галереей фото

Шаблон многостраничного НТФ

В динамическом шаблоне может быть заполнено несколько секций для шаблона НТФ. В данном случае в МП будет открываться форма с несколькими страницами с указанными параметрами (см примеры ниже).

Для каждой секции (страницы) настройка и отображение остаются такими же, как и при настройке шаблона с одной секцией.

Навигация между секциями (страницами формы) осуществляется с помощью кнопок Назад и Далее.

       Пример динамического шаблона с несколькими секциями

Пример реализации

Агрегированные представления

До этого момента, все вышеописанное относится к динамическому формированию структуры. Но в МП также есть возможность использования фиксированных (статичных) представоений данных, неких трафаретов, описанных на уровне программного кода ПО. То есть, в этом случае нестандартный вертикальный рендеринг по описанному динамическому шаблону всех элементов секции, а вставка значений в некий трафарет.

Логика формирования

templateClass — это перечень фиксированных шаблонов

Наличие **templateClass** означает, что ячейка палитры будет заполняться значениями элементов с использованием связей через ключ **alias** в описании шаблона и ячейки.

В настоящее время приложения поддерживает представления — **календарь** (агрегирует задачи на дату), **карта** (агрегирует объекты по координатам в кластере) и **payment**.

Для них перед секциями добавляются еще два раздела: **templateClass** и **aggregate**.

Раздел **templateClass** задает тип представления — **calendar, map, payment**.

Раздел **aggregate** описывает параметр, по которому агрегируются данные (например, ДП), причем только ключи **type** и **dataKey** (без **name** и **viewMode**).

**aggregate** содержит element, который кратно описывает ДП или основной параметр для группировки

Пример шаблона с агрегацией:

"settings": {

      "templateClass": "calendar",

      "aggregate": {

          "element": {

              "type": "extparam",

              "dataKey": 1321

          },

          "userFilter": {

              "type": "mainParam",

              "dataKey": "owner"

          }

      }

  }

Так в примере задается агрегация по ДП 1321 (обычно это ДП типа дата/время, но может быть любой ДП, так как идет простое сравнение значений)

В случае агрегации по основному параметру срока будет выглядеть так:

"type": "mainParam",

"dataKey": "dueDate"

То есть здесь используются урезанные версии элементов шаблона.

Сама агрегация делается локально на клиенте. Запрошенные за период видимых на экране дат события раскладываются по датам. При выборе даты показываются релевантные.

В фильтр-запросе фидов используется параметр aggregate для задания ограничения дат на текущий месяц. Если, например, это дата создания задачи, то мы запросим с сервера все задачи с датой начала между датами+время, которые видны на текущем экране в календаре.

**userFilter** (тоже используется элемент шаблона) задает фильтрацию отдачи по юзеру и означает, что при запросе задач в апи будет включаться фильтр "я заказчик"

Также, например, может быть указана фильтрация по подписчику или исполнителю. Это влияет на конструкцию фильтра в запросе.

"type": "mainParam", 

"dataKey": "subscribers"

 

"type": "mainParam",

"dataKey": "performers"

       Payment представление

       Календарное представление

Полезные ссылки

Шаблонизация (шаблоны для категории)

Блок "Используется"