Мастер установки тиражного приложения

Когда приложения в первый раз устанавливается на Битрикс24, то Битрикс24, открывая слайдер приложения, сначала показывает во фрейме URL, который был указан в поле "Ссылка на установочное приложение".

Пользовательский интерфейс, реализованный в этом URL, представляет собой "мастер установки" приложения с любой необходимой бизнес-логикой. Это может быть форма настройки опция приложения, это может быть информационный интерфейс и т.д.

Кроме того, этот URL можно использовать для инициализации и создания нужных объектов в Битрикс24. Например, можно:

Иными словами, URL "мастера установки" можно использовать для выполнения одноразовых операций, связанных с установкой приложения на портал, поскольку после успешного добавления, URL, указанный в поле "Ссылка на установочное приложение", больше не будет вызываться. Вместо этого, пользователю будет показываться интерфейс из URL "Ссылка на приложение".

Однако, ваше приложение должно явным образом "сообщить" Битрикс24, что установка успешно состоялась. Для этого необходимо вызвать JS-метод BX24.installFinish(). Пока этот метод не был вызван, Битрикс24 считает, что приложение не установлено (не настроено пользователем) и при каждом переходе пользователя в приложение будет показывать в слайдере URL, указанный в поле "Ссылка на установочное приложение".

Особенности установки статичного приложения

Поскольку в случае загрузки статичного приложения, вы загружаете архив всего решения, а не указываете пути к собственному серверу, то в качестве URL для "мастера установки" Битрикс24 использует файл install.html из архива решения. В остальном, логика остаётся прежней - вы можете использовать JS-функции в этом файле для выполнения нужных вам запросов, а сообщить об успешном завершении "мастера" нужно, вызвав метод BX24.installFinish().

Если install.html в корне архива нет, то Битрикс24 считает, что процедура с "мастером установки" не нужна и сразу обращается к index.html из того же архива.