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

Методы для работы с ДП и основными параметрами задачи

В карточке задачи вся бизнес-логика (проверка значений на корректность и т.п.) срабатывает при вызове метода save().

Вставки для работы с ДП оформляются следующим образом:

Если в JS-вставке для карточки задачи или для карточки создания новой задачи привязано событие change(), то callback-функция срабатывает на следующие пользовательские действия:

•установка значения через кнопку выбора;

•установка автодополнением (когда пользователь набирает в окне ввода часть значения и затем выбирает нужную запись из выпадающего списка, который автоматически предлагает ему система);

•установка через .val("abc"), когда значение назначается в самой JS-вставке;

•удаление значения с помощью значка удаления;

•вызов ep.change().

Обращение к основным параметрам

В JS вставках в карточке задачи можно обращаться к номеру задачи — taskId, и статусу задачи — StateID.

ID пользователя, от имени которого ведется работа, доступно в SessionUserID.

Методы для работы с ДП

Таблица совместимости методов и типов ДП в карточке задачи

Методы, не указанные в таблице совместимости, работают для всех ДП.

 

Объекты и методы для нового ДП "Таблица"

Таблица

object EpTable: {
  savedRowsCount: numeric,
  filteredRows: [ object Row ],
  multiWindow: object MultiWindow
}

Строка таблицы

object Row: {
  cells: [ object Cells ],
  id: number
}

Ячейка таблицы

object Cell: {
  columnId: numeric,
  columnValue: mixed,
  tooltip: function
}

Строки с учетом условий фильтра и пейджинга

filteredRows — строки, отобранные с учетом заданных условий фильтра (если фильтр включен), а также с учетом пейджинга (т.е. только на текущей странице, если пейджинг включен).

Множественный выбор

object MultiWindow: {
  filteredRows: [ object Row ]
}

 

Методы

Для таблицы:

•onTableLoaded — загрузка/перезагрузка страницы, переключение страниц таблицы.

•onTableRowAdded — добавление строки (передается объект строки).

•onTableRowChanged — изменение значения ячейки.

•onTableSaved — сохранение таблицы.

Для таблицы в режиме множественного выбора:

•onTableMWLoaded — загрузка/перезагрузка страницы, переключение страниц таблицы.

•onTableMWRowSelected — выбор строки (передается объект строки).

•onTableMWRowChanged — изменение значения ячейки.

•onTableMWClosed — закрытие окна множественного выбора.

Для ячейки:

•tooltip() — подсказка, всплывающая при наведении мыши на ячейку.

Пример

Методы для работы с пользователями

Изменение значения ДП

Для полной замены текущего значения ДП "Выбор пользователей" на новое значение в функцию ep.val() нужно передать JSON такого вида:

{"Users":[], "Groups":[], "OrgUnits":[]}

Например:

var ep123 = new ExtParam(123);
ep123.val('{"Users":[55,66], "Groups":[77], "OrgUnits":[]}');
ep123.save();

где 123 — ID ДП "Выбор пользователей".

Контроль изменений

При работе с ДП "Выбор пользователей" функция ep.val() возвращает JSON такого вида:

{"Users":{"Deleted":[],"Added":[],"Selected":[]},"Groups":{"Deleted":[],"Added":[],"Selected":[]},"OrgUnits":{"Deleted":[],"Added":[],"Selected":[]}}

Например:

// изменить

var ep123 = new ExtParam(123);
ep123.val('{"Users":[55,66], "Groups":[77], "OrgUnits":[]}');
ep123.save();

 

// посмотреть результат
console.log(ep123.val());

 

// получить ID пользователя, выбранного в ДП

var ep123 = new ExtParam(123);
obj = JSON.parse(ep123.val());
var userid = obj.Users.Selected[0];

где 123 — ID ДП "Выбор пользователей".

Текущий (сессионный) пользователь

Функция window.getSessionUserInfo() возвращает promise с ID текущего пользователя (userId), массив его групп (groups) и признак, является ли он администратором (isAdmin).

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

getSessionUserInfo().responseJSON.data.userId

Методы для работы с кнопками перехода

Методы для работы с порталами и виджетами

Для порталов flex

Подписка на событие загрузки виджета с ID = 123 оформляется следующим образом:

(window.firstForma.portal.block(123)).onLoaded(function(event){ });

В функцию подписки будет передан объект event, который содержит поля portal и block.

Объект portal относится к порталу в целом и имеет два свойства:

•id (число) — идентификатор портала,

•title (строка) — название портала.

Методы для портала не реализованы.

Объект block относится к виджетам на портале и имеет два свойства:

•id (число) — идентификатор виджета,

•title (строка) — название виджета.

Для порталов dashboard

Подписка на событие загрузки виджета с ID = 123 оформляется следующим образом:

(window.firstForma.portal.block(123)).onLoaded(function(event){ });

В функцию подписки будет передан объект event, который содержит объект data.

Получить идентификатор блока можно через event.data.blockId.

Информация о пользователе

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

Получить данные пользователя, который просматривает портал, можно с помощью функции getSessionUserInfo(). Функция возвращает ответ вызова метода /api/auth/info (Valhalla API версии 2.0).

В JS-вставках можно использовать переменную UserID, которая содержит ID пользователя.

Методы для виджетов

Методы для фильтров

Обращение к параметрам фильтра

Если для виджета настроен фильтр, а для наполнения виджета используется хранимая процедура, то из нее можно обращаться к параметрам фильтра через входящий параметр @XmlParam (см. пример).

Методы для работы с файлами

Из JS-вставок портала можно вызывать галерею для просмотра изображений:

Галерея изображений

Для вызова галереи используется функция window.firstForma.fileViewer(fileArray, fileIndex)

Примеры:

window.firstForma.fileViewer([{
url:'./GetAttachment.ashx?id=1234&versionId=1',
fileType:'video',
mime:'video/mp4'
}])

 

window.firstForma.fileViewer([{
url:'https://ru.1forma.ru/GetAttachment.ashx?id=569754',
fileType:'image',
name:'Свежая выпечка'
},
{
url:'https://ru.1forma.ru/GetAttachment.ashx?id=569753',
fileType:'image',
name:'Витрина'
}])

Полный пример настройки галереи на портале описан здесь.

Методы для работы с телефонией

Используются при настроенной интеграции с IP-телефонией.

Открыть окно вызова:

GetTopWindow().TCHeader.CallHistory.Open(1234)

где 1234 — короткий номер.

Если вызов используется в портальном блоке (например, по ссылке), то открыть окно вызова можно так:

window.parent.TCHeader.CallHistory.Open(1234)