SimpleSystem
Методы этого класса предназначены для получения информации о системе, текущем пользователе и других данных.
Этот класс не имеет конструктора, методы доступны через глобальный объект ss.
ss.addInfoMessage(message, params)
Используйте этот метод для отображения информационного сообщения на языке текущего пользователя в правом нижнем углу. Для этого в параметр message введите значение из таблицы Исходные сообщения (source_message) из категории app. Дополнительные сведения см. в разделе Локализация элементов интерфейса. Параметр params позволяет определить значения для динамических частей переведенного сообщения.
Параметры:
Name | Тип | Обязательный | Значе ние по умолчанию |
---|---|---|---|
message | String | Да | Нет |
params | Object | Нет | {} |
Возвращаемое значение:
Тип | Описание |
---|---|
Void | Метод не возвращает значение. |
Пример:
ss.addInfoMessage("Осталось три дня");
// или
ss.addInfoMessage("Осталось {count} {noun}", {"count": "три", "noun": "дня"});
ss.addErrorMessage(message, params)
Используйте этот метод для отображения сообщения об ошибке на языке текущего пользователя в нижнем правом углу. Для этого в параметр message введите значение из таблицы Исходные сообщения (source_message) из категории app. Дополнительные сведения см. в разделе Локализация элементов интерфейса. Параметр params позволяет определить значения для динамических частей переведенного сообщения.
Параметры:
Название | Тип | Обязательный | Значение по умолчанию |
---|---|---|---|
message | String | Да | Нет |
params | Object | Нет | {} |
Возвращаемое значение:
Тип | Описание |
---|---|
Void | Метод не возвращает значение. |
Пример:
ss.addErrorMessage('"Наименование" не может быть пустым');
// или
ss.addErrorMessage('"{title}" не может быть пустым', {title: "Наименование"});
ss.addSuccessMessage(message, params)
Используйте этот метод для отображения сообщения об успешно выполненном действии на языке текущего пользователя нижнем правом углу. Для этого в параметр message введите значение из таблицы Исходные сообщения (source_message) из категории app. Дополнительные сведения см. в разделе Локализация элементов интерфейса. Параметр params позволяет определить значения для динамических частей переведенного сообщения.
Параметры:
Название | Тип | Обязательный | Значение по умолчанию |
---|---|---|---|
message | String | Да | Нет |
params | Object | Нет | {} |
Возвращаемое значение:
Тип | Описание |
---|---|
Void | Метод не возвращает значение. |
Пример:
ss.addSuccessMessage('Успешно обновлено');
// или
ss.addSuccessMessage('Успешно {action_name}', {action_name: "обновлено"});
ss.info(message)
Используйте этот метод, чтобы добавить информационное сообщение в системный журнал, расположенный в таблице Основной журнал (sys_log).
Параметры:
Название | Тип | Обязательный | Значение по умолчанию |
---|---|---|---|
message | Any | Да | Нет |
Возвращаемое значение:
Тип | Описание |
---|---|
Void | Метод не возвращает значение. |
Пример:
const task = new SimpleRecord('task');
task.orderByDesc('sys_created_at');
task.setLimit(1);
task.selectAttributes('number');
task.query();
while(task.next()){
ss.info(task.number);
}
ss.debug(message)
Используйте этот метод, чтобы добавить сообщение об отладке в системный журнал, расположенный в таблице Основной журнал (sys_log).
Параметры:
Name | Тип | Обязательный | Значение по умолчанию |
---|---|---|---|
message | Any | Да | Нет |
Возвращаемое значение:
Тип | Описание |
---|---|
Void | Метод не возвращает значение. |
Пример:
const insertedID = inquiry.insert();
if (insertedID == '0') {
ss.debug(inquiry.getErrors());
} else {
ss.debug(`Создан запрос с ID ${insertedID}`)
}
ss.warning(message)
Используйте этот метод, чтобы добавить сообщение с предупреждением в системный журнал, расположенный в таблице Основной журнал (sys_log).
Параметры:
Название | Тип | Обязательный | Значение по умолчанию |
---|---|---|---|
message | Any | Да | Нет |
Возвращаемое значение:
Тип | Описание |
---|---|
Void | Метод не возвращает значение. |
Пример:
const task = new SimpleRecord('task');
task.query();
while(task.next()){
ss.warning(task.sys_id);
}
ss.error(message)
Используйте этот метод, чтобы добавить сообщение об ошибке в системный журнал, расположенный в таблице Основной журнал (sys_log).
Параметры:
Название | Тип | Обязательный | Значение по умолчанию |
---|---|---|---|
message | Any | Да | Нет |
Возвращаемое значение:
Тип | Описание |
---|---|
Void | Метод не возвращает значение. |
Пример:
(function executeRule(current, previous /*null when async*/ ) {
const nowDateTime = new SimpleDateTime();
const targetDateTime = new SimpleDateTime(current.appropriate_datetime);
const secondsLeft = targetDateTime.getNumericValue() - nowDateTime.getNumericValue();
if (secondsLeft < 1800) { // осталось меньше получаса
ss.addErrorMessage('Время начала проведения работ не может начаться ранее, чем через полчаса');
ss.error(`Срочный запрос: осталось ${secondsLeft} до начала работ`);
current.setAbortAction(true);
}
})(current, previous);
ss.eventQueue(name, current, param_1, param_2, param_3, param_4, param_5)
Используйте этот метод, чтобы поставить событие в очередь на основе его названия и дополнительных параметров.
Значение параметра name должно совпадать с наименованием записи Реестра событий (sys_event_register).
Таблица переданного текущего объекта должна совпадать с таблицей, указанной в записи Реестра событий (sys_event_register) или таблицей, расширенной от нее.
Параметры:
Название | Тип | Обязательный | Значение по умолчанию |
---|---|---|---|
name | String | Да | Нет |
current | SimpleRecord object | Да | Нет |
param_1 | String | Нет | null |
param_2 | String | Нет | null |
param_3 | String | Нет | null |
param_4 | String | Нет | null |
param_5 | String | Нет | null |
Возвращаемое значение:
Тип | Описание |
---|---|
Void | Метод не возвращает значение. |
Пример:
if (current.state != '10') { // Не закрыт
ss.eventQueue('incident.close', current, ss.getUserID());
}
ss.eventQueueScheduled(name, current, param_1, param_2, param_3, param_4, param_5)
Используйте этот метод, чтобы поставить событие в очередь для запуска в определенное время.
Значение параметра name должно совпадать с наименованием записи Реестра событий (sys_event_register).
Таблица переданного текущего объекта должна совпадать с таблицей, указанной в записи Реестра событий (sys_event_register) или таблицей, расширенной от нее.
Параметры:
Название | Тип | Обязательный | Значение по умолчанию |
---|---|---|---|
name | String | Да | Нет |
current | SimpleRecord object | Да | Нет |
process_started_at | SimpleDateTime object | Да | Нет |
param_1 | String | Нет | null |
param_2 | String | Нет | null |
param_3 | String | Нет | null |
param_4 | String | Нет | null |
param_5 | String | Нет | null |
Возвращаемое значение:
Тип | Описание |
---|---|
Void | Метод не возвращает значение. |
Пример:
if (current.state != '10') { // Не закрыт
const plusThreeDays = new SimpleDateTime(); // сейчас
plusThreeDays.addDays(3); // + 3 дня
ss.eventQueueScheduled('incident.autoclose', current, plusThreeDays, ss.getUserID());
}