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

Все сторонние скрипты могут работать только в том случае, если инсталляция ADVANTA не установлена в закрытом контуре (корпоративной интрасети).

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

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

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

  • Яндекс.Метрика
  • Google Analytics
  • Experrto

Для добавления этих трёх скриптов не требуется доступ к серверной части.

Для этого зайдите в Администрирование → Общие настройки → Общие настройки → Настройка сторонних скриптов

  1. Создайте новую запись (метрику, аккаунт, сценарий) на нужном вам сервисе.
  2. Найдите инструкции по установке.
  3. В скрипте, который сервис предлагает скопировать, найдите и скопируйте только ID этого скрипта.
  4. Вставьте его в соответствующее поле в настройках ADVANTA

Подробные инструкции о том, как именно создать учётные записи этих сервисов и откуда взять ID этих скриптов, доступны на этих сервисах.
На шаге, который обычно звучит как «Добавьте этот код на страницу», скопируйте из кода только идентификатор скрипта и вставьте в соответствующее поле настройки.

Например, так выглядит код Яндекс.Метрики, который сервис предлагает полностью скопировать: 

<!-- Yandex.Metrika counter -->
<script type="text/javascript" >
   (function(m,e,t,r,i,k,a){m[i]=m[i]||function(){(m[i].a=m[i].a||[]).push(arguments)};
   m[i].l=1*new Date();k=e.createElement(t),a=e.getElementsByTagName(t)[0],k.async=1,k.src=r,a.parentNode.insertBefore(k,a)})
   (window, document, "script", "https://mc.yandex.ru/metrika/tag.js", "ym");
 
   ym(43973525, "init", {
        clickmap:true,
        trackLinks:true,
        accurateTrackBounce:true,
        webvisor:true
   });
</script>
<noscript><div><img src="https://mc.yandex.ru/watch/61615363" style="position:absolute; left:-9999px;" alt="" /></div></noscript>
<!-- /Yandex.Metrika counter -->

Но нам нужен только ID – здесь это цифры 43973525.

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

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

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

Добавить скрипт может только системный администратор. Без доступа к серверу IIS добавить скрипт нельзя.
При возникновении вопросов, если вы хотите добавить какой-либо скрипт, обратитесь в службу тех.поддержки ADVANTA.

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

Работа с внешними скриптами настраивается через файл конфигурации 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-файла на сервере - на страницы системы ничего не вставляется, ошибка не генерируется.
Указанные в шаблоне файла конфигурации ThirdPartyScripts.config имена скриптов script_header_first.js, script_header_last.js, script_body.js, script_footer.js приведены для примера и не являются обязательными. Перечень, имена и содержимое файлов с подключаемыми js-скриптами определяется владельцем инсталляции на свое усмотрение и под его ответственность.

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

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

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

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

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

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

Загрузка скрипта в память IIS

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

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