Интеграционный модуль справочных систем

Руководство по установке и настройке интеграционного модуля справочных систем
на компьютер под управлением ОС Windows
Общие сведения

Интеграционный модуль справочных систем обеспечивает взаимодействие с системами: ИС «Кодекс: 6 поколение», ИС «Техэксперт: 6 поколение», ИС «Кодекс: 6 поколение» Интранет, ИС «Техэксперт: 6 поколение» Интранет следующих приложений:

- MS Office (Word/Excel): 2003-2021;
- LibreOffice (Writer/Calc): 4.4 и выше (только 32-разрядные версии);
- МойОфис (Текст/Таблицы): 2022.01;
- Adobe Acrobat Pro: 9, X, XI, 2017, 2020, DC (2015-2021);
- AutoCAD: 2007-2022;
- КОМПАС-3D: v13-v20;
- nanoCAD Plus: 7.0 и выше;
- nanoCAD: 5.1 и выше;
- nanoCAD СПДС: 7.0 и выше;
- Siemens NX: 8.0, 8.5, 9, 10, 11;
- T-FLEX CAD: 14-17;
- SOLIDWORKS: 2013-2020;
- Autodesk Inventor: 2018-2021.
- Autodesk Revit 2018-2022

Модуль обеспечивает следующие возможности:

- Работая с текстом документа в информационной системе, выбрать команду контекстного меню «Копировать ссылку на документ», а затем требуемый тип ссылки. Ссылка на документ будет помещена в буфер обмена операционной системы. После этого ссылка может быть вставлена в редактируемый документ стороннего приложения (например, в документ MS Word). Модуль обеспечивает переход по этой ссылке в документ, размещенный в информационной системе.
- Добавление панели инструментов «Кодекс» или «Техэксперт» в приложения офисных пакетов MS Office, LibreOffice и МойОфис, в пакет программ Adobe Acrobat, в приложения систем КОМПАС-3D, nanoCAD, AutoCAD, Siemens NX, T-FLEX CAD, SOLIDWORKS, Autodesk Inventor. Панель инструментов предоставляет возможность:
  - открыть главную страницу информационной системы;
  - выполнить интеллектуальный поиск в информационной системе по введенному запросу;
  - выполнить расстановку сссылок на документы информационной системы;
  - выполнить проверку и актуализацию ранее установленных ссылок на документы информационной системы.

Интеграционный модуль справочных систем использует Sciter Engine ( http://sciter.com ), copyright Terra Informatica Software, Inc.

Модуль интеграции справочных систем работает в ОС Windows XP SP3, Vista, 7, 8, 10.

Модуль входит в состав служебного тома базы данных 7475.db6.

При работе в ИС «Кодекс: 6 поколение» (ИС «Техэксперт: 6 поколение») модуль будет установлен в папку %ProgramData%\kodeks\kassist и зарегистрирован на рабочем месте пользователя автоматически. Настройка модуля не требуется.

Если в качестве клиентского приложения ИС «Кодекс: 6 поколение» Интранет (ИС «Техэксперт: 6 поколение» Интранет) будет использоваться «Кодекс-клиент» («Техэксперт-клиент»), то модуль будет установлен в папку %ProgramData%\kodeks\kassist и зарегистрирован на рабочем месте пользователя автоматически. Настройка модуля не требуется.

Если в качестве клиентского приложения ИС «Кодекс: 6 поколение» Интранет (ИС «Техэксперт: 6 поколение» Интранет) будет использоваться любой из поддерживаемых браузеров, то регистрация модуля выполняется с помощью программы setup.exe, либо с помощью установочного пакета kassist.msi.

Установка модуля с помощью программы setup.exe

Для регистрации модуля следует выполнить следующие действия:

1. Открыть главную страницу серверной части ИС «Кодекс: 6 поколение» Интранет (ИС «Техэксперт: 6 поколение» Интранет), введя в адресной строке браузера ее адрес (например: http:⁄⁄172.16.0.16:8080).
   Внимание! В административном интерфейсе ИС «Кодекс: 6 поколение» Интранет (ИС «Техэксперт: 6 поколение» Интранет) должен быть установлен флажок «показывать ссылку для скачивания утилиты интеграции справочных систем».
2. Нажатием по баннеру «Установить утилиту интеграции справочных систем» скачать архив kАssist.zip.
3. Распаковать архив kАssist.zip, в котором содержатся файлы:
   - addins — каталог, содержащий каталоги и файлы динамически подключаемых библиотек. Эти библиотеки являются вспомогательными модулями, реализующими панель инструментов «Кодекс» или «Техэксперт» в приложениях офисных пакетов MS Office, LibreOffice и МойОфис, в пакете программ Adobe Acrobat, в приложениях систем КОМПАС-3D, nanoCAD, AutoCAD, Siemens NX, T-FLEX CAD, SOLIDWORKS, Autodesk Inventor;
   - sciter — каталог, содержащий 32- и 64-разрядную версию модуля построения интерфейса приложений;
   - setup.exe — программа регистрации и настройки утилиты;
   - readme.html — инструкция по регистрации и настройке утилиты;
   - link.exe — программа открывает универсальные ссылки на документы информационной системы;
   - core.dll, core64.dll — 32- и 64-разрядная версия модуля ядра интеграции;
   - kinterop.dll — модуль поддержки интеграции;
   - checklinks32.dll, checklinks64.dll — 32- и 64-разрядная версия модуля проверки ссылок;
   - comutils32.dll, comutils64.dll — 32- и 64-разрядная версия модуля COM-утилит интеграции.
4. Выполнить программу setup.exe.
   Внимание! Для настройки интеграции с Adobe Acrobat Pro, T-FLEX CAD, Siemens NX, nanoCAD 5.1, nanoCAD Plus 6.0, SOLIDWORKS требуется установка модуля в режиме "для всех пользователей". Для этого следует выполнить программу setup.exe от имени администратора. В окне «Утилита настройки интеграции справочных систем» режим установки "для текущего пользователя" изменить на режим установки "для всех пользователей".
5. На вкладке «Справочная система» окна «Утилита настройки интеграции справочных систем» изменить, при необходимости, значения следующих параметров:
   - «Приложение для просмотра» — выбрать клиентское приложение, в котором будет открываться информационная система.
   - «Список серверов со справочной системой» – указать настройки серверов, с которыми работает утилита интеграции. Информацию по настройке списка см. в разделе «Настройка списка серверов со справочной системой».
6. На вкладке «Приложения для интеграции» окна «Утилита настройки интеграции справочных систем» изменить, при необходимости, значение флажка «Включить интеграцию» (по умолчанию - установлен). Позволяет включить (флажок установлен) или выключить (флажок не установлен) интеграцию сторонних приложений с информационной системой. Если интеграция включена, то на вкладке «Приложения для интеграции» доступны флажки для включения (флажок установлен) или выключения (флажок не установлен) панели инструментов «Кодекс» («Техэксперт») для тех приложений, которые установлены в операционной системе.
7. На вкладке «Прокси-сервер» окна «Утилита настройки интеграции справочных систем» установить переключатель в требуемый режим:
   - «системные настройки» — использовать настройки прокси в операционной системе.
   - «без прокси-сервера» — соединение не использует прокси-сервер (данный режим действует по умолчанию).
   - «ручные настройки прокси-сервера» — после выбора данного режима ввести сетевой адрес, порт прокси-сервера, а также параметры авторизации на прокси-сервере.
8. На вкладке «Работа со ссылками» - указать настройки формата ссылок, которые будут использоваться при расстановке и актуализации ссылочных материалов. По умолчанию используется универсальная ссылка формата kodeks://link/. Подробнее см. в разделе «Настройка формата ссылок».
9. Закрыть окно «Утилита настройки интеграции справочных систем».

Если установка модуля выполнена в режиме "для текущего пользователя", то исполняемые файлы модуля (setup.exe, link.exe), конфигурационный файл (.kassist) и динамически подключаемые библиотеки размещаются, в зависимости от операционной системы, в следующем каталоге:

%USERPROFILE%\AppData\Roaming\Kodeks\kassist\ — Windows (Vista, 7, 8, 10)
%USERPROFILE%\Application Data\Kodeks\kassist\ — Windows XP

Если установка модуля выполнена в режиме "для всех пользователей", то исполняемые файлы модуля (setup.exe, link.exe), конфигурационный файл (.kassist) и динамически подключаемые библиотеки размещаются в каталоге %ProgramData%\kodeks\kassist.

При необходимости, вы можете менять настройки модуля c помощью окна «Утилита настройки интеграции справочных систем», которое открывается после выполнения программы setup.exe.

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

Обратите внимание! В случае обновления версии ИС «Кодекс: 6 поколение» Интранет (ИС «Техэксперт: 6 поколение» Интранет) следует выполнить регистрацию соответствующей ей версии модуля на рабочем месте локальной сети. Скачайте ее с главной страницы серверной части ИС «Кодекс: 6 поколение» Интранет (ИС «Техэксперт: 6 поколение» Интранет).

Важно! Во время установки/обновления модуля все приложения, с которыми возможна интеграция, должны быть закрыты.

Установка и настройка модуля возможна не только посредством графического интерфейса, но и с помощью командной строки. Программа setup.exe поддерживает следующие параметры:

- /update — обновление модуля. Параметр используется при первичной установке и при обновлении версии модуля. Если необходимо изменить только настройки модуля, параметр использовать не требуется;
- /enable — включить интеграцию со всеми доступными приложениями;
- /enable <addin> — включить интеграцию для приложения, где <addin> — название папки в \kassist\addins\;
- /disable — выключить интеграцию со всеми приложениями;
- /disable <addin> — выключить интеграцию для приложения, где <addin> — название папки в \kassist\addins\;
- /browser <path> — установить приложение как средство для просмотра, где <path> — путь до клиентского приложения (путь с пробелами в нем должен быть заключен в кавычки);
- /config <path> — импорт конфигурационного файла, где <path> — путь до конфигурационного файла (путь с пробелами в нем должен быть заключен в кавычки);
- /shared — выбор режима установки "для всех пользователей".

Команды выполняются в порядке их следования в командной строке, например:

D:\kassist\setup.exe /update /config "D:\client.ini" /enable autocad /shared /update /enable tflex

В примере setup.exe запускается в режиме установки/обновления, в качестве конфигурационного файла используется "D:\client.ini", для текущего пользователя включается интеграция с Autocad, для всех пользователей setup.exe также запускается в режиме установки/обновления, включается интеграция с T-FLEX CAD.

Чтобы включить/отключить интеграцию с несколькими приложениями, параметр /enable <addin>(/disable <addin>) следует использовать несколько раз, например:

D:\kassist\setup.exe /update /enable autocad /enable msoffice

Установка модуля с помощью установочного пакета kassist.msi

Установка модуля возможна с помощью установочного пакета kassist.msi. Обратите внимание, установочный пакет предоставляется по запросу.

Для установки необходимо:

1. запустить файл kassist.msi;
2. указать режим установки "для текущего пользователя"/"для всех пользователей";
3. выбрать справочную систему, выбрать приложение для просмотра и указать настройки прокси (при необходимости). Если в одной папке с kassist.msi находится файл client.ini от настроенного программного комплекса, адрес справочной системы будет настроен автоматически;
4. указать приложения, с которыми должна осуществляться интеграция;
5. настроить ярлыки (при необходимости).

Если установка модуля выполнена в режиме "для текущего пользователя", то исполняемые файлы модуля (setup.exe, link.exe), конфигурационный файл (.kassist) и динамически подключаемые библиотеки размещаются, в зависимости от операционной системы, в следующем каталоге:

%USERPROFILE%\AppData\Roaming\Kodeks\kassist\ — Windows (Vista, 7, 8, 10)
%USERPROFILE%\Application Data\Kodeks\kassist\ — Windows XP

Если установка модуля выполнена в режиме "для всех пользователей", то исполняемые файлы модуля (setup.exe, link.exe), конфигурационный файл (.kassist) и динамически подключаемые библиотеки размещаются в каталоге %ProgramData%\kodeks\kassist.

На рабочем столе и в меню «Пуск» будут созданы ярлыки на утилиту setup.exe (если при установке были отмечены соответствующие пункты). С их помощью можно открыть интерфейс настроек модуля и внести изменения в конфигурацию при необходимости.

Настройка списка серверов со справочной системой

Предусмотрена возможность работы kAssist с несколькими серверами справочных систем. Это может потребоваться в том случае, если на предприятии используется несколько справочных систем.

Чтобы добавить новый сервер к списку нужно нажать на кнопку «Добавить сервер». Чтобы отредактировать настройки существующего сервера, необходимо нажать на строку с ним. Откроется страница редактирования справочной системы со следующими настройками:

- Адрес справочной системы.
- Настройка авторизации (доступна только в режиме «Для текущего пользователя») – позволяет настроить авторизацию пользователя в виртуальном каталоге сервера. Подробнее см. в разделе «Настройка авторизации».
- Наименование сервера – позволяет ввести имя сервера для отображения в списке. Поле необязательно для заполнения.
- Источник данных для контроля актуальности – позволяет установить сервер, который будет использоваться по умолчанию. Пункт становится активным, когда в списке не меньше двух серверов.
- Удалить сервер – позволяет удалить сервер справочной системы из списка. Ссылка становится активной, когда в списке не меньше двух серверов.

Настройка авторизации

Если для доступа пользователя к документам ИС «Кодекс: 6 поколение» Интранет (ИС «Техэксперт: 6 поколение» Интранет) требуется авторизация, модуль также должен авторизоваться в ИС «Кодекс: 6 поколение» Интранет (ИС «Техэксперт: 6 поколение» Интранет). Настройка авторизации осуществляется на вкладке «Справочная система» окна «Утилита настройки интеграции справочных систем». Существует два способа авторизации — с помощью ключа доступа и по логину Windows. По умолчанию используется режим "С авторизацией по логину Windows".

Если на виртуальном каталоге серверной части ИС «Кодекс: 6 поколение» Интранет (ИС «Техэксперт: 6 поколение» Интранет), с которым работает пользователь, настроена авторизация "По базе пользователей", следует использовать режим "С авторизацией по ключу". Необходимо зайти в профиль пользователя на странице ИС «Кодекс: 6 поколение» Интранет (ИС «Техэксперт: 6 поколение» Интранет), от имени которого будет происходить авторизация, перейти на вкладку «Ключ доступа» и скопировать ключ. После этого перейти в окно «Утилита настройки интеграции справочных систем», выбрать значение "с авторизацией по ключу" и в появившееся поле вставить скопированный ключ.

Если на виртуальном каталоге серверной части ИС «Кодекс: 6 поколение» Интранет (ИС «Техэксперт: 6 поколение» Интранет), с которым работает пользователь, настроена авторизация "По домену", то на вкладке «Справочная система» окна «Утилита настройки интеграции справочных систем» выбрать режим "С авторизацией по логину Windows".

Настройка формата ссылок

kAssist позволяет устанавливать ссылки двух типов – универсальные и прямые.

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

- Формат kodeks://link/ - использует протокол kodeks, ссылка будет работать в приложениях, поддерживающих этот протокол, для открытия ссылок требуется наличие kAssist на рабочем месте.
- Формат https://link.online.kodeks.ru – использует протокол https, ссылка будет работать в любых приложениях, поддерживающих работу с гиперссылками. Для перехода по ссылкам требуется доступ к интернет-сайту https://link.online.kodeks.ru либо настройка DNS-сервера в локальной сети таким образом, чтобы запросы на этот адрес переадресовывались на сервер справочной системы предприятия.

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

Удаление утилиты

Если модуль был установлен с помощью программы setup.exe, необходимо:

1. запустить setup.exe;
2. на вкладке «Приложения для интеграции» снять флажок «Включить интеграцию»;
3. удалить каталог kassist.

Если модуль был установлен с помощью программы setup.exe, то удаление можно выполнить из командной строки:

1. выполнить команду setup.exe /disable;
2. удалить папку kassist.

Если модуль был установлен с помощью установочного пакета kassist.msi, необходимо:

1. запустить файл kassist.msi;
2. нажать кнопку «Удалить».

Также в этом случае интеграционный модуль можно удалить через «Удаление программ» в панели управления Windows.

Дата актуализации: 20.04.2022