Настройка пользовательских кнопок

• JS-функция. Укажите наименование функции на языке JavaScript, которую необходимо запустить при выполнении действия кнопки. Сигнатура для ввода наименования функции:

javascript:<Наименование функции (пользовательские параметры, callback, args)>

Примечание. Наличие угловых скобок при указании наименования функции с параметрами обязательно.

Параметры:

пользовательские параметры. Значения пользовательских параметров в соответствии с сигнатурой вызываемой функции. Необязательный параметр;

callback. Функция обратного вызова. Обязательный параметр;

args. Аргументы функции, генерируемые платформой. Необязательный параметр, позволяет получить доступ к объекту, из которого была выполнена JS-функция.

Примеры указания наименования функции:

javascript:<Test(callback)> - вызов простой JS-функции без передачи каких-либо параметров в неё.

javascript:<CalculateAB(100, "200", callback)> - вызов JS-функции с передачей двух значений различных типов.

javascript:<Check(callback, args)> - вызов JS-функции с возможностью доступа к объекту, из которого она вызвана.

Если указаны JS-функция и Fore-функция, то сначала выполняется Fore-функция, затем JS-функция.

Для вызова JS-функции, файл, в котором она реализована, требуется предварительно подключить через поле externalJs в файле config.json, например:

"externalJs": [

{"src": "./assets/js/calculate.js"},

{"src": "./assets/js/settings.js"}

]

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

Параметр args имеет поле moduleId, которое возвращает уникальный идентификатор открытого экземпляра объекта, из которого вызывается JS-функция. Данный идентификатор используется с методами объекта Platform.Managers, описание которого представлено ниже.

1. Platform.Bi - объект, содержащий методы для взаимодействия с BI-сервером посредством Json-запросов. Список методов и их сигнатура:

• execMethod('ID репозитория', 'ID сборки', 'Метод', ['Параметр 1','Параметр 2',…]) - для выполнения запросов с помощью операции ForeExec.

• sendRequest({параметры}, Json-запрос 1, Json-запрос 2,…) - для выполнения пакета Json-запросов. Каждый отдельный запрос осуществляет выполнение одной из доступных операций BI-сервера. В качестве параметров в текущей реализации может быть указан параметр batched: boolean, указывающий необходимость выполнения указанных запросов в виде одного пакета.

• putBin('моникёр', FormData) - для загрузки изображения в документ с помощью операции PutBin.

• getBin('моникёр', признак загрузки, 'имя файла') - для получения изображения из документа с помощью операции GetBin.

2. Platform.Notification - объект, содержащий методы для вывода уведомлений, стилизованных под оформление платформы. Список методов и их сигнатура:

• error('Заголовок', 'Текст'). Вывод сообщения об ошибке.

• warning('Заголовок', 'Текст'). Вывод предупреждающего сообщения.

• success('Заголовок', 'Текст'). Вывод сообщения об успешном событии.

• info('Заголовок', 'Текст'). Вывод информационного сообщения.

3. Platform.Managers - объект, предоставляющий доступ к открытым объектам репозитория, из которых вызываются JS-функции. В текущей реализации у данного объекта реализованы объекты Prx и DataEntryForm, предоставляющие доступ к регламентному отчёту и форме ввода соответственно. Для получения доступа к экземпляру объекта, из которого вызывается JS-функция, передайте в конструктор указанных объектов уникальный идентификатор moduleId. Каждый объект имеет два поля:

• selectors. Содержит селекторы для получения информации об открытом объекте:

1. name() - имя объекта;

2. key() - ключ объекта;

3. id() - идентификатор объекта;

4. openId(): - моникёр открытого экземпляра объекта.

• actions. Содержит метод refresh() для обновления открытого объекта.

Примеры функций:

// Вывод различных уведомлений
async function showNotifications(callback) {
  Platform.Notification.error('Ошибка', 'Ошибка сохранения данных. Неверный тип значения.');
  Platform.Notification.warning('Предупреждение', 'Выполнение расчёта может занять длительное время.');
  Platform.Notification.success('Успешно', 'Расчёт завершён.');
  Platform.Notification.info('Информация', 'Появилась новая версия отчёта.');
  callback();
}
// Обновление регламентного отчёта
async function refreshPrx(callback, args) {
  const { moduleId } = args;
  const refresh = Platform.Managers.Prx(moduleId).actions.refresh();
  callback();
}
// Отправка JSON-запроса
async function closeControlPanel(callback, args) {
  const { moduleId } = args;
  const openId = Platform.Managers.Prx(moduleId).selectors.openId();
  const closeControlPanel = {
    request: {
      SetPrxMeta: {
        mon: openId,
        tArg: {
          meta: {
            options: {
              controlPanelVisible: false,
            },
          },
        },
      },
    },
    handleResult: (response) => response?.SetPrxMetaResult,
  };
  const response = await Platform.Bi.sendRequest({}, closeControlPanel);
  callback();
}
// Пакетное выполнение запросов
async function batchRequests(callback, args) {
  // Запросы 
  const request1 = {
    request: {
      // Первый запрос
    },
  };
  const request2 = {
    request: {
      // Второй запрос
      },
    },
  };
  const response = await Platform.Bi.sendRequest({batched: true}, request1, request2);
  callback();
}
// Получение имени формы ввода
async function getName(callback, args) {
  const { moduleId } = args;
  const openId = Platform.Managers.Prx(moduleId).selectors.openId();
  const metadata = await Platform.Bi.execMethod('ASM_WEB_METHODS', 'GetMetadata', [openId]);
  callback(metadata.Name);
}

• JS-функция. Укажите наименование функции на языке JavaScript, которую необходимо запустить при выполнении действия кнопки. Сигнатура для ввода наименования функции:

javascript:<Наименование функции (пользовательские параметры, callback, args)>

Примечание. Наличие угловых скобок при указании наименования функции с параметрами обязательно.

Параметры:

пользовательские параметры. Значения пользовательских параметров в соответствии с сигнатурой вызываемой функции. Необязательный параметр;

callback. Функция обратного вызова. Обязательный параметр;

args. Аргументы функции, генерируемые платформой. Необязательный параметр, позволяет получить доступ к объекту, из которого была выполнена JS-функция.

Примеры указания наименования функции:

javascript:<Test(callback)> - вызов простой JS-функции без передачи каких-либо параметров в неё.

javascript:<CalculateAB(100, "200", callback)> - вызов JS-функции с передачей двух значений различных типов.

javascript:<Check(callback, args)> - вызов JS-функции с возможностью доступа к объекту, из которого она вызвана.

Если указаны JS-функция и Fore-функция, то сначала выполняется Fore-функция, затем JS-функция.

Для вызова JS-функции, файл, в котором она реализована, требуется предварительно подключить через поле externalJs в файле config.json, например:

"externalJs": [

{"src": "./assets/js/calculate.js"},

{"src": "./assets/js/settings.js"}

]

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

Параметр args имеет поле moduleId, которое возвращает уникальный идентификатор открытого экземпляра объекта, из которого вызывается JS-функция. Данный идентификатор используется с методами объекта Platform.Managers, описание которого представлено ниже.

1. Platform.Bi - объект, содержащий методы для взаимодействия с BI-сервером посредством Json-запросов. Список методов и их сигнатура:

• execMethod('ID репозитория', 'ID сборки', 'Метод', ['Параметр 1','Параметр 2',…]) - для выполнения запросов с помощью операции ForeExec.

• sendRequest({параметры}, Json-запрос 1, Json-запрос 2,…) - для выполнения пакета Json-запросов. Каждый отдельный запрос осуществляет выполнение одной из доступных операций BI-сервера. В качестве параметров в текущей реализации может быть указан параметр batched: boolean, указывающий необходимость выполнения указанных запросов в виде одного пакета.

• putBin('моникёр', FormData) - для загрузки изображения в документ с помощью операции PutBin.

• getBin('моникёр', признак загрузки, 'имя файла') - для получения изображения из документа с помощью операции GetBin.

2. Platform.Notification - объект, содержащий методы для вывода уведомлений, стилизованных под оформление платформы. Список методов и их сигнатура:

• error('Заголовок', 'Текст'). Вывод сообщения об ошибке.

• warning('Заголовок', 'Текст'). Вывод предупреждающего сообщения.

• success('Заголовок', 'Текст'). Вывод сообщения об успешном событии.

• info('Заголовок', 'Текст'). Вывод информационного сообщения.

3. Platform.Managers - объект, предоставляющий доступ к открытым объектам репозитория, из которых вызываются JS-функции. В текущей реализации у данного объекта реализованы объекты Prx и DataEntryForm, предоставляющие доступ к регламентному отчёту и форме ввода соответственно. Для получения доступа к экземпляру объекта, из которого вызывается JS-функция, передайте в конструктор указанных объектов уникальный идентификатор moduleId. Каждый объект имеет два поля:

• selectors. Содержит селекторы для получения информации об открытом объекте:

1. name() - имя объекта;

2. key() - ключ объекта;

3. id() - идентификатор объекта;

4. openId(): - моникёр открытого экземпляра объекта.

• actions. Содержит метод refresh() для обновления открытого объекта.

Примеры функций:

// Вывод различных уведомлений
async function showNotifications(callback) {
  Platform.Notification.error('Ошибка', 'Ошибка сохранения данных. Неверный тип значения.');
  Platform.Notification.warning('Предупреждение', 'Выполнение расчёта может занять длительное время.');
  Platform.Notification.success('Успешно', 'Расчёт завершён.');
  Platform.Notification.info('Информация', 'Появилась новая версия отчёта.');
  callback();
}
// Обновление регламентного отчёта
async function refreshPrx(callback, args) {
  const { moduleId } = args;
  const refresh = Platform.Managers.Prx(moduleId).actions.refresh();
  callback();
}
// Отправка JSON-запроса
async function closeControlPanel(callback, args) {
  const { moduleId } = args;
  const openId = Platform.Managers.Prx(moduleId).selectors.openId();
  const closeControlPanel = {
    request: {
      SetPrxMeta: {
        mon: openId,
        tArg: {
          meta: {
            options: {
              controlPanelVisible: false,
            },
          },
        },
      },
    },
    handleResult: (response) => response?.SetPrxMetaResult,
  };
  const response = await Platform.Bi.sendRequest({}, closeControlPanel);
  callback();
}
// Пакетное выполнение запросов
async function batchRequests(callback, args) {
  // Запросы 
  const request1 = {
    request: {
      // Первый запрос
    },
  };
  const request2 = {
    request: {
      // Второй запрос
      },
    },
  };
  const response = await Platform.Bi.sendRequest({batched: true}, request1, request2);
  callback();
}
// Получение имени формы ввода
async function getName(callback, args) {
  const { moduleId } = args;
  const openId = Platform.Managers.Prx(moduleId).selectors.openId();
  const metadata = await Platform.Bi.execMethod('ASM_WEB_METHODS', 'GetMetadata', [openId]);
  callback(metadata.Name);
}

• JS-функция. Укажите наименование функции на языке JavaScript, которую необходимо запустить при выполнении действия кнопки. Сигнатура для ввода наименования функции:

javascript:<Наименование функции (пользовательские параметры, callback, args)>

Примечание. Наличие угловых скобок при указании наименования функции с параметрами обязательно.

Параметры:

пользовательские параметры. Значения пользовательских параметров в соответствии с сигнатурой вызываемой функции. Необязательный параметр;

callback. Функция обратного вызова. Обязательный параметр;

args. Аргументы функции, генерируемые платформой. Необязательный параметр, позволяет получить доступ к объекту, из которого была выполнена JS-функция.

Примеры указания наименования функции:

javascript:<Test(callback)> - вызов простой JS-функции без передачи каких-либо параметров в неё.

javascript:<CalculateAB(100, "200", callback)> - вызов JS-функции с передачей двух значений различных типов.

javascript:<Check(callback, args)> - вызов JS-функции с возможностью доступа к объекту, из которого она вызвана.

Если указаны JS-функция и Fore-функция, то сначала выполняется Fore-функция, затем JS-функция.

Для вызова JS-функции, файл, в котором она реализована, требуется предварительно подключить через поле externalJs в файле config.json, например:

"externalJs": [

{"src": "./assets/js/calculate.js"},

{"src": "./assets/js/settings.js"}

]

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

Параметр args имеет поле moduleId, которое возвращает уникальный идентификатор открытого экземпляра объекта, из которого вызывается JS-функция. Данный идентификатор используется с методами объекта Platform.Managers, описание которого представлено ниже.

1. Platform.Bi - объект, содержащий методы для взаимодействия с BI-сервером посредством Json-запросов. Список методов и их сигнатура:

• execMethod('ID репозитория', 'ID сборки', 'Метод', ['Параметр 1','Параметр 2',…]) - для выполнения запросов с помощью операции ForeExec.

• sendRequest({параметры}, Json-запрос 1, Json-запрос 2,…) - для выполнения пакета Json-запросов. Каждый отдельный запрос осуществляет выполнение одной из доступных операций BI-сервера. В качестве параметров в текущей реализации может быть указан параметр batched: boolean, указывающий необходимость выполнения указанных запросов в виде одного пакета.

• putBin('моникёр', FormData) - для загрузки изображения в документ с помощью операции PutBin.

• getBin('моникёр', признак загрузки, 'имя файла') - для получения изображения из документа с помощью операции GetBin.

2. Platform.Notification - объект, содержащий методы для вывода уведомлений, стилизованных под оформление платформы. Список методов и их сигнатура:

• error('Заголовок', 'Текст'). Вывод сообщения об ошибке.

• warning('Заголовок', 'Текст'). Вывод предупреждающего сообщения.

• success('Заголовок', 'Текст'). Вывод сообщения об успешном событии.

• info('Заголовок', 'Текст'). Вывод информационного сообщения.

3. Platform.Managers - объект, предоставляющий доступ к открытым объектам репозитория, из которых вызываются JS-функции. В текущей реализации у данного объекта реализованы объекты Prx и DataEntryForm, предоставляющие доступ к регламентному отчёту и форме ввода соответственно. Для получения доступа к экземпляру объекта, из которого вызывается JS-функция, передайте в конструктор указанных объектов уникальный идентификатор moduleId. Каждый объект имеет два поля:

• selectors. Содержит селекторы для получения информации об открытом объекте:

1. name() - имя объекта;

2. key() - ключ объекта;

3. id() - идентификатор объекта;

4. openId(): - моникёр открытого экземпляра объекта.

• actions. Содержит метод refresh() для обновления открытого объекта.

Примеры функций:

// Вывод различных уведомлений
async function showNotifications(callback) {
  Platform.Notification.error('Ошибка', 'Ошибка сохранения данных. Неверный тип значения.');
  Platform.Notification.warning('Предупреждение', 'Выполнение расчёта может занять длительное время.');
  Platform.Notification.success('Успешно', 'Расчёт завершён.');
  Platform.Notification.info('Информация', 'Появилась новая версия отчёта.');
  callback();
}
// Обновление регламентного отчёта
async function refreshPrx(callback, args) {
  const { moduleId } = args;
  const refresh = Platform.Managers.Prx(moduleId).actions.refresh();
  callback();
}
// Отправка JSON-запроса
async function closeControlPanel(callback, args) {
  const { moduleId } = args;
  const openId = Platform.Managers.Prx(moduleId).selectors.openId();
  const closeControlPanel = {
    request: {
      SetPrxMeta: {
        mon: openId,
        tArg: {
          meta: {
            options: {
              controlPanelVisible: false,
            },
          },
        },
      },
    },
    handleResult: (response) => response?.SetPrxMetaResult,
  };
  const response = await Platform.Bi.sendRequest({}, closeControlPanel);
  callback();
}
// Пакетное выполнение запросов
async function batchRequests(callback, args) {
  // Запросы 
  const request1 = {
    request: {
      // Первый запрос
    },
  };
  const request2 = {
    request: {
      // Второй запрос
      },
    },
  };
  const response = await Platform.Bi.sendRequest({batched: true}, request1, request2);
  callback();
}
// Получение имени формы ввода
async function getName(callback, args) {
  const { moduleId } = args;
  const openId = Platform.Managers.Prx(moduleId).selectors.openId();
  const metadata = await Platform.Bi.execMethod('ASM_WEB_METHODS', 'GetMetadata', [openId]);
  callback(metadata.Name);
}