Подключение сторонних скриптов


Если к инсталляции ADVANTA подключаются сторонние скрипты, размещенные на внешних ресурсах, то они будут работать только в том случае, если инсталляция ADVANTA не установлена в закрытом контуре, либо внешний ресурс (с которого подключается скрипт) доступен из корпоративной интрасети. При блокировке внешнего (не интранет) трафика такие сторонние скрипты работать не будут (Яндекс.Метрика, Google Analytics и другие).

Подключение скриптов – сугубо факультативно. Если у вас как у Администратора Системы нет потребности в их подключении, то вы можете смело игнорировать эти настройки.

Через интерфейс администрирования

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

По клику на имя с файлом скрипта можно изучить его содержимое.
Колонка "Раздел" соответствует блоку страницы, в который скрипт был подключен в файле ThirdPartyScripts.config

Через загрузку .xml-файла на web-сервер

Если вам нужно добавить какой-либо сторонний скрипт в Систему, и он не входит в список предложенных в интерфейсе, вы можете сформировать .xml-файл, который будет содержать нужные вам скрипты.

Где найти файл конфигурации

Работа с внешними скриптами настраивается через файл конфигурации ThirdPartyScripts.config, который должен находится в каталоге приложения Streamline\_Resources\Config\ThirdPartyScripts

  • По умолчанию этого файла в приложении нет – никакие дополнительные скрипты в страницы системы не вставляется.
  • В каталоге дистирубтива SL\Config\ThirdPartyScripts (в архиве с модулем обновления), либо в каталоге \Context_bkp\config\ThirdPartyScripts (в архиве первичного дистрибутива системы) есть тестовая конфигурация, а именно ThirdPartyScripts.config и script_*.js-файлы, на которые он ссылается. Их надо скопировать в каталог приложения Streamline\_Resources\Config\ThirdPartyScripts и перезапустить IIS либо пул приложения.
  • Если указанных файлов нет в каталоге дистрибутива, вы можете скачать их в виде архива.

Так выглядит файл конфигурации ThirdPartyScripts.config:

<?xml version="1.0"?>
<scripts>
  <include path="header" order="first">script_header_first.js</include>
  <include path="header" order="last">script_header_last.js</include>
  <include path="body">script_body.js</include>
  <include path="footer">script_footer.js</include>
</scripts>

include-записи описывают помещаемые в код страницы внешние скрипты, где:

  • значение path – место вставки.
    Возможные значения
    • header – в контейнер <head>
    • footer – в конец контейнера <footer>
    • body – в начало контейнера <body>
  • значение order – место вставки в контейнер. Только для path="header".
    Возможные значения:
    • first – в начало контейнера
    • last – в конец контейнера
  • текст (содержимое) тэга – название файла, расположенного в папке Streamline\_Resources\Config\ThirdPartyScripts, содержимое которого будет вставлено в страницу в указанном месте. При отсутствии указанного в конфиге js-файла на сервере - на страницы системы ничего не вставляется, ошибка не генерируется.

В результате в нужных местах страницы генерируется код.

Содержимое шаблонных script_*.js-файлов выглядят приблизительно так

<script>
// path="header" order="first"
</script>

то есть они просто содержат метки тэгов расположения из конфигурации. С ними удобно производить первоначальное тестирование механизма подключения скриптов. Для этого скопируте ThirdPartyScripts.config и файлы script_*.js в каталог Streamline\_Resources\Config\ThirdPartyScripts и перзапустите IIS либо пул приложения.

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

После тестирования и заполнения ThirdPartyScripts.config рабочими данными, если в нем ссылок на тестовые js-скрипты больше нет - то их можно удалить с сервера.

Загрузка скрипта в память веб-сервера

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

  1. Измените ссылки и параметры вставки в ThirdPartyScripts.config, сами фрагменты вставки в файлах.
  2. Нажмите в Администрировании → Общие настройки → Общие настройки → Настройка сторонних скриптов → "Перечитать".
  3. Обновите страницу, где предполагался скрипт, и проверьте его работоспособность.

Действия при обновлении системы

Если в системе используются сторонние скрипты, то при выполнении обновления воспользуйтесь описанием шагов по созданию резервной копии скриптов и их восстановлению, представленными в разделе Обновление системы