Информация для ИТ-отделов

Хотя установка и использование Altium On-Prem Enterprise Server и связанных с ним сервисов подробно описаны на других страницах этого сайта документации, цель данной страницы — предоставить единый подробный ресурс для ИТ-отдела организации. Это место, где можно найти ответы на часто задаваемые вопросы об этой технологии, включая:

• What are the hardware requirements to install the Enterprise Server?

• What is installed?

• What programs and processes are running?

• Where is the data stored?

• What ports are used?

• What protocol is used for communications?

• How is data backed up?

В следующих разделах приведены подробные ответы на эти и другие вопросы, включая общее описание архитектуры и потоков данных.

Конфигурация IIS

В рамках конфигурации IIS включается функция ISAPI Extensions. Эту функцию можно найти в разделе \Internet Information Services\World Wide Web Services\Application Development Features диалогового окна Windows Features, доступного из окна Programs and Features Windows.

При установке Enterprise Server включается функция Windows ISAPI Extensions, являющаяся частью конфигурации IIS.

Поддержка протокола HTTPS

Enterprise Server обеспечивает безопасную передачу данных по сети с использованием протокола HTTPS для защиты конфиденциальности и целостности данных.

Настройка сертификата

Для новой установки Enterprise Server предлагает самоподписанный сертификат, созданный и настроенный в IIS. В целях безопасности рекомендуется создать собственный сертификат (с помощью ваших стандартных/предпочитаемых инструментов), а затем настроить его в IIS. Вы можете либо создать запрос на сертификат и отправить его в известный центр сертификации (CA), такой как VeriSign или GeoTrust, либо получить сертификат от онлайн-CA в домене вашей интрасети. Подробнее см. на странице Microsoft documentation How to Set Up SSL on IIS 7 or later.

Настройка HTTPS

Конфигурацию и привязки сервера для Enterprise Server можно открыть на панели Windows Internet Information Services (IIS) Manager, доступной из окна Administration Tools (Control Panel\System and Security\Administrative Tools). Выберите запись 'Altium On-Prem Enterprise Server' в списке Connections панели и откройте вкладку Features View.

Получите доступ к параметрам конфигурации и привязки сервера для Enterprise Server.

Доступные порты и имена серверов для Enterprise Server отображаются как выбираемые ссылки в области Actions. Используйте эти ссылки, чтобы просмотреть и проверить протоколы подключения к серверу, либо откройте текущие привязки имени/порта, выбрав ссылку Bindings в разделе Edit Site этой области.

Привязку, включая номер ее протокольного порта, можно изменить в диалоговом окне Site Bindings с помощью кнопки Edit .

Настройте привязки через диалоговое окно Site Bindings.

Обратите внимание, что имя сервера localhost применяется только к локальной машине, поэтому ПК other, отличные от того, на котором размещен Enterprise Server, должны использовать фактическое имя (сервера) этой хост-машины для подключения.

Чтобы подтвердить имя хост-ПК, на котором установлен и работает Enterprise Server, на этой машине перейдите в Control Panel\System and Security\System и обратите внимание как на Computer name, так и на Full computer name (его полное доменное имя) — именно последнее используется Enterprise Server для защищенных сетевых подключений.

Если вы изменили привязки сайта Enterprise Server так, чтобы использовать номер порта, отличный от значения по умолчанию, это изменение также необходимо отразить в файле LocalVault.ini Enterprise Server. Это связано с тем, что ссылки на порт из него используются, когда Altium Designer подключается к Enterprise Server. Файл LocalVault.ini находится в корневой папке установки Enterprise Server — обычно Program Files (x86)\Altium\Altium365.

Например, если вы изменили привязку сайта Enterprise Server так, чтобы использовать стандартный порт 443 для подключений HTTPS, обновите соответствующую строку HttpsPort=9785 в файле LocalVault.ini до HttpsPort=443.

При перенастройке привязок сайта

Если вы добавили новую привязку сайта IIS для Enterprise Server или изменили существующую запись привязки сайта (см. выше), следует перезапустить серверный ПК, чтобы новая конфигурация была применена корректно. Типичные изменения привязок сайта включают изменение номера порта для записи хоста или добавление новой привязки для псевдонима домена.

Если перезапуск хост-машины сервера непрактичен, альтернативный вариант — перезапустить серверный сервис на платформе IIS — Restart в разделе Manage Website — а также перезапустить службу Altium DXP App Server Pinger (служба Windows).

Доступ по HTTPS

Чтобы установить безопасное соединение с Enterprise Server:

• Из Altium Designer — используйте адрес сервера с префиксом HTTPS и настроенный порт HTTPS. По умолчанию это https://<computername>:9785 (где [computername] — это имя компьютера хост-машины или ее полное доменное имя).

  Altium Designer включает необходимую поддержку безопасности, чтобы принимать HTTPS-подключение к Enterprise Server без дополнительных действий.

• Из браузера — введите адрес службы имен хост-компьютера (https://<computername>:9785).

  Если вы решили оставить самоподписанный сертификат Identity Certificate, созданный для Enterprise Server, браузер предупредит вас, что соединение не является безопасным/приватным. Вы можете принять предупреждение в браузере, чтобы продолжить. Некоторые браузеры (например, Firefox) предлагают возможность навсегда принять сертификат, чтобы в дальнейшем не требовались дополнительные действия.

Сеть

Порты по умолчанию

Enterprise Server использует следующие номера коммуникационных портов по умолчанию:

• HTTP Port – 9780

• HTTPS Port – 9785

• LDAP Synchronisation Service Port – 9791

  Порт службы LDAP фактически не используется. Для стандартного LDAP (с URL ldap://) используется порт из этого URL. Для защищенного LDAP (с URL ldaps://) используется порт 636.

• Websocket Port – 4649

  Обратите внимание, что /websocket/WebService.asmx представляет собой HTTP SOAP endpoint для API-вызовов, поэтому, как и другие API endpoint, он использует HTTPS-порт (9785 по умолчанию).

• Firebird Server Port – 3050

• SVN Port – 3690

• Elasticsearch Ports – 9200 и 9300

Первые три из списка можно настроить во время первоначальной установки на странице Altium On-Prem Enterprise Server Configuration установщика.

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

См. информацию о портах и IP-адресах для программного обеспечения Altium Design.

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

SOAP over HTTP.

Подключение к подсистеме идентификации AltiumLive

Подключения к подсистеме идентификации AltiumLive по умолчанию выполняются по HTTPS, и запись IdentityCloudServiceUrl в файле LocalVault.ini (расположенном в папке C:\Program Files (x86)\Altium\Altium365 при установке по умолчанию) по умолчанию имеет значение https://ids.api.altium.com/ids?cls=soap.

Настройка Platform API

Некоторые ответы Platform API возвращают URL-адреса на основе значения WebsiteDomain, заданного во время первоначальной настройки. В редких случаях (например, если ваш сервер находится за балансировщиком нагрузки или прокси-сервером) эти URL-адреса могут не работать. Чтобы это исправить, обновите запись FilesServiceUrl в разделе [PublicServices] файла LocalVault.ini (для установки по умолчанию он расположен в папке C:\Program Files (x86)\Altium\Altium365). Значение этой записи должно быть установлено в <PubliclyAccessibleUrl>/napi/files, где <PubliclyAccessibleUrl> — это внешний URL-адрес, доступный извне Enterprise Server.

Пути установки по умолчанию

Ниже приведен список путей установки по умолчанию при установке Enterprise Server:

• Enterprise Server Installation Folder – \Program Files (x86)\Altium\Altium365.

• Firebird Installation Folder – \Program Files\Firebird\Firebird_3_0.

• Firebird Database – \ProgramData\Altium\Altium365Data\DXPSERVER.DAT.

• Revision Files Folder – \ProgramData\Altium\Altium365Data\Revisions.

• Search Index Data Folder – \ProgramData\Altium\Altium365Data\SearchData.

Архитектура сервисов — обзор

Enterprise Server устанавливает ряд основных сервисов, а также браузерные консоли управления и Explorer (также на основе браузера). Для доступа к любому из этих сервисов личность пользователя должна быть распознана и аутентифицирована. Enterprise Server поставляется с одним предопределенным пользователем (Username: admin, Password: admin). Страница Users в браузерном интерфейсе Workspace Enterprise Server может использоваться для добавления новых пользователей и управления ими. Ограничений на количество пользователей, которые могут быть зарегистрированы для доступа и работы с Enterprise Server, нет, однако существует ограничение на число одновременных подключений, определяемое и контролируемое необходимым лицензированием.

Altium Designer использует незашифрованный канал (SOAP over HTTP) для связи со следующими сервисами:

• Applications Registry Service (когда Network Installation Service используется как источник расширений/обновлений)

• Collaboration Service

• Comments Service

• Data Acquisition Service

• Data Storage Service (DSS)

• Identity Service (IDS)

• Notifications Service

• Part Catalog Service

• Projects Service

• Simple Lock Service (SLS)

• SVN (через протокол SVN://)

• Tasks Service

• Team Configuration Service (TC2)

• Vault Service

Все остальные сервисы взаимодействуют друг с другом.

Большинству сервисов требуется доступ к одной и той же базе данных Enterprise Server, в которой хранятся относящиеся к ним данные. Ниже приведены примеры данных, хранимых некоторыми из этих сервисов:

• Part Catalog Service – хранит элементы поставщиков и производителей, историю изменений цен и количества и т. д.

• Identity Service – хранит пользователей, группы, конфигурацию лицензирования и информацию о сессиях.

• Vault Service – хранит свою структуру (папки, элементы, ревизии, типы содержимого, состояния жизненного цикла и т. д.).

Фактические документы хранятся в файловой системе, в папке Revision (\ProgramData\Altium\Altium365Data\Revisions).

Следующие браузерные приложения используют SOAP API для взаимодействия с соответствующими сервисами — им не требуется доступ к базе данных Enterprise Server, и для их работы не нужны какие-либо другие файлы:

• User Management – приложение, стоящее за страницей Users и ее подстраницами в браузерном интерфейсе Workspace Enterprise Server.

• Vault Explorer – приложение, стоящее за страницей Explorer в браузерном интерфейсе Workspace Enterprise Server.

• Catalog Management – приложение, стоящее за страницей Part Providers в браузерном интерфейсе Workspace Enterprise Server.

• Projects Management – приложение, стоящее за страницей Projects в браузерном интерфейсе Workspace Enterprise Server.

• TC2 Console – приложение, стоящее за страницей Configurations в браузерном интерфейсе Workspace Enterprise Server.

Операции

Резервное копирование/восстановление данных сервера

Резервное копирование и восстановление данных Enterprise Server выполняется из командной строки в автоматическом режиме с помощью специального инструмента Backup & Restore Tool. Этот инструмент — avbackup.exe — находится в папке \Program Files (x86)\Altium\Altium365\Tools\BackupTool\ (при установке Enterprise Server по умолчанию).

Подробнее см. на странице Резервное копирование и восстановление установки.

Повторная индексация содержимого сервера после миграции данных

Чтобы повторно проиндексировать содержимое Enterprise Server, например после миграции данных:

1. Остановите все пулы приложений IIS, связанные с Enterprise Server.

2. Остановите службу Elasticsearch (AltiumElasticSearch). Это выполняется из панели Windows Services, доступной из окна Administrative Tools в Windows.

3. Удалите содержимое папки SearchData, в которой находятся данные поисковой индексации (\ProgramData\Altium\Altium365Data\SearchData для установки по умолчанию).

4. Перезапустите службу Elasticsearch (AltiumElasticSearch).

5. Перезапустите пулы приложений IIS, связанные с Enterprise Server.

Обнаружив, что папка SearchData пуста, Enterprise Server повторно проиндексирует свое содержимое после запуска.

Увеличение размера кучи Java

Недостаточный размер кучи Java может нарушить индекс поиска компонентов и сделать данные компонентов недоступными из Altium Designer. Если у вас возникают проблемы с поисковым индексом (в Health Monitor Status Report в журналах присутствуют ошибки SearchService Schema not found: 'vault1ex2_04), рассмотрите возможность увеличения размера кучи Java.

Текущий размер кучи Java можно проверить, открыв http://localhost:9200/_cat/nodes?h=heap*&v на компьютере, на котором размещен Enterprise Server. Если значение heap.max составляет около 1 ГБ, увеличьте его, как описано ниже.

1. Запустите командную строку в режиме администратора.

2. Выполните следующую команду:

   "C:\Program Files (x86)\Altium\Altium365\Services\ElasticSearch\bin\service-nexus-server.bat" manager AltiumElasticsearch

3. На вкладке Java открывшегося диалогового окна внесите следующие изменения:

   • В поле Java Options удалите записи -Xms1g и -Xmx1g.

   • Обновите значения в полях Initial memory pool и Maximum memory pool, установив 4096.

     Если вы увеличиваете размер кучи Java до значения, отличного от 4 ГБ, соответственно измените параметры Initial memory pool и Maximum memory pool (например, укажите 6144, если увеличиваете размер до 6 ГБ).

   

4. Нажмите Apply и OK в диалоговом окне.

5. На панели Windows Services (доступной из окна Windows Administrative Tools) перезапустите службу AltiumElasticsearch .

6. Убедитесь, что изменения применились, открыв http://localhost:9200/_cat/nodes?h=heap*&v и проверив значение параметра heap.max.

Настройка максимального числа значений параметров компонентов для каждой категории фильтра

Вы можете добавить параметр конфигурации MaxHitsPerFacet в раздел [Search] файла LocalVault.ini. Указанное значение ограничивает количество отдельных записей (с флажками), отображаемых для каждой категории в области Filters панели Altium Designer Components panel при поиске компонента. Для администратора уменьшение этого значения сокращает число результатов в каждой категории фильтра, что значительно снижает нагрузку на службу поиска и повышает производительность поиска.

Увеличение Allowed URL Segment Length

Чтобы использовать функциональность Release & Publish to PLM в Altium Designer (подробнее), на компьютере, где установлен Enterprise Server, требуется обновить реестр Windows. В командной строке Windows (CMD), запущенной с правами администратора, выполните следующую команду:

reg add "HKLM\SYSTEM\CurrentControlSet\Services\HTTP\Parameters" /v UrlSegmentMaxLength /t REG_DWORD /d 2048

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