Embora a instalação e a utilização do Altium On-Prem Enterprise Server e dos respetivos serviços relacionados estejam detalhadas noutras páginas deste site de documentação, o objetivo desta página é fornecer um recurso único e detalhado para o departamento de TI de uma organização. Um local onde encontrar respostas para perguntas frequentes sobre esta tecnologia, incluindo:
-
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?
As secções seguintes fornecem respostas detalhadas a estas e outras questões, incluindo uma visão geral de alto nível da arquitetura e dos fluxos de dados.
Para obter informações sobre requisitos do sistema, instalação e licenciamento, consulte as seguintes páginas:
Configuração do IIS
Como parte da configuração do IIS, a funcionalidade ISAPI Extensions é ativada. Esta funcionalidade pode ser encontrada na secção \Internet Information Services\World Wide Web Services\Application Development Features da caixa de diálogo Windows Features – acedida a partir da janela Programs and Features do Windows.
A instalação do Enterprise Server ativa a funcionalidade do Windows ISAPI Extensions, parte da configuração do IIS.
Application Pools Installed on IIS
A verificação de que o Enterprise Server está em execução pode ser efetuada no painel Internet Information Services (IIS) Manager do Windows – acedido a partir da janela Administrative Tools do Windows. Basta verificar e confirmar que cada um dos conjuntos de aplicações relacionados com o servidor se encontra no estado Started (como destacado na imagem seguinte).
Conjuntos de aplicações relacionados com o Enterprise Server em execução no servidor IIS.
Suporte do Protocolo HTTPS
O Enterprise Server permite comunicações seguras através de redes utilizando o protocolo HTTPS para proteger a privacidade e a integridade dos dados.
O número da porta utilizado para ligações seguras ao servidor é definido durante o processo de instalação, na página Altium On-Prem Enterprise Server Configuration do instalador. Utilize a porta predefinida (9785) ou introduza uma alternativa.
Configurar um Certificado
Numa nova instalação, o Enterprise Server disponibiliza um certificado autoassinado gerado e configurado no IIS. Por razões de segurança, recomenda-se que gere o seu próprio certificado (utilizando as suas ferramentas habituais/preferidas) e depois configure esse certificado no IIS. Pode criar um pedido de certificado e enviar esse pedido para uma autoridade de certificação (CA) conhecida, como a VeriSign ou a GeoTrust, ou obter um certificado de uma CA online no domínio da sua intranet. Consulte a página How to Set Up SSL on IIS 7 or later na documentação da Microsoft para saber mais.
Ao atualizar o Enterprise Server para uma versão posterior, tenha em atenção que a configuração do certi ficado será mantida.
Configurar HTTPS
A configuração e as associações do servidor para o Enterprise Server podem ser acedidas a partir do painel Internet Information Services (IIS) Manager do Windows – disponível na janela Administration Tools (Control Panel\System and Security\Administrative Tools). Selecione a entrada 'Altium On-Prem Enterprise Server' na lista Connections do painel e escolha o separador Features View.
Aceda às definições de configuração e de associação do servidor para o Enterprise Server.
As portas disponíveis e os nomes de servidor para o Enterprise Server são apresentados como ligações selecionáveis no painel Actions. Utilize as ligações para consultar e testar os protocolos de ligação ao servidor, ou aceda às associações atuais de nome/porta selecionando a ligação Bindings na secção Edit Site do painel.
Uma associação, incluindo o respetivo número de porta de protocolo, pode ser editada na caixa de diálogo Site Bindings através do botão Edit .
Configure as associações através da caixa de diálogo Site Bindings.
Tenha em atenção que o nome do servidor localhost só se aplica à máquina local, pelo que os PCs other do que aquele que aloja o Enterprise Server terão de utilizar o nome real (do servidor) dessa máquina anfitriã para estabelecer ligação.
Para confirmar o nome do PC anfitrião no qual o Enterprise Server está instalado e em execução, nessa máquina vá a Control Panel\System and Security\System e tome nota tanto do Computer name como do Full computer name (o respetivo nome de domínio qualificado) – este último será o utilizado pelo Enterprise Server para ligações seguras através da rede.
Para PCs que não fazem parte de um Domínio (configurados como PCs padrão de Grupo de Trabalho), o Computer name e o Full computer name serão iguais.
Se tiver editado as associações do site do Enterprise Server para utilizar um número de Porta diferente do valor predefinido, essa alteração também terá de ser refletida no ficheiro LocalVault.ini do Enterprise Server. Isto porque as referências de porta desse ficheiro são acedidas quando são feitas ligações ao Enterprise Server a partir do Altium Designer. O ficheiro LocalVault.ini pode ser encontrado na pasta raiz da instalação do Enterprise Server – tipicamente Program Files (x86)\Altium\Altium365.
Por exemplo, se alterou a associação do site do Enterprise Server para utilizar a porta 443 padrão para ligações HTTPS, atualize a linha HttpsPort=9785 correspondente no ficheiro LocalVault.ini para HttpsPort=443.
Ao Reconfigurar Associações do Site
Se tiver adicionado uma nova Associação de Site IIS para o Enterprise Server, ou editado uma entrada de Associação de Site existente (ver acima), o PC servidor deve ser reiniciado para estabelecer corretamente a nova configuração. Alterações típicas de Associação de Site podem incluir a edição do número da Porta para uma entrada de anfitrião, ou a adição de uma nova associação para um alias de domínio.
Quando não for prático reiniciar a máquina anfitriã do servidor, o processo alternativo é reiniciar o serviço do servidor na plataforma IIS – Restart em Manage Website – e também reiniciar o serviço Altium DXP App Server Pinger (um serviço do Windows).
Execute o processo de arranque acima se receber uma mensagem de erro SignalR Hub "healthmonitorHub" not found! ao tentar executar a funcionalidade Health Monitor do Enterprise Server.
Acesso por HTTPS
Para estabelecer uma ligação segura ao Enterprise Server:
-
No Altium Designer – utilize um endereço de servidor com o prefixo HTTPS e a porta HTTPS configurada. Por predefinição, isto é https://<computername>:9785 (em que [computername] é o Nome do Computador da máquina anfitriã ou o nome de domínio qualificado).
O Altium Designer inclui o suporte de segurança necessário para aceitar uma ligação HTTPS ao Enterprise Server sem intervenção.
-
Num navegador – introduza o endereço do serviço de nome do computador anfitrião (https://<computername>:9785).
Se optar por manter o Certificado de Identidade autoassinado gerado para o Enterprise Server, o seu navegador irá avisá-lo de que a ligação não é segura/privada. Pode optar por aceitar no navegador para prosseguir. Alguns navegadores (por exemplo, o Firefox) oferecem a opção de aceitar permanentemente o certificado, para que não sejam necessárias ações adicionais.
Rede
Portas Predefinidas
Os seguintes números de porta de comunicação predefinidos são utilizados pelo Enterprise Server:
A Porta do Serviço LDAP não é, na realidade, utilizada. Para LDAP padrão (com URL ldap://), é utilizada a porta desse URL. Para LDAP seguro (com URL ldaps://), é utilizada a porta 636.
Os três primeiros da lista podem ser configurados durante a instalação inicial, na página Altium On-Prem Enterprise Server Configuration do instalador.
Se uma porta já estiver a ser utilizada, o instalador procurará a próxima disponível e utilizará essa.
Ao escolher uma porta, tenha em atenção que não pode entrar em conflito com quaisquer portas utilizadas por outras aplicações – se uma porta estiver atualmente em utilização, será notificado pelo instalador.
O HTTP Port é servido pelo IIS e utilizado pelas aplicações do Enterprise Server. É a porta principal e deve estar sempre aberta. O Firebird Server Port é utilizado para, e pelo, Firebird RDBMS. Por predefinição, está associado apenas a localhost. Não SHOULD NOT ser exposto externamente, por razões de segurança. Os utilizadores não interagem diretamente com esta porta. Ambas as portas fornecem interação HTTP normal (pedido/resposta). Ambas as portas podem ser personalizadas. O HTTP Port pode ser alterado durante a instalação. Embora o Firebird Server Port possa ser alterado manualmente, não é recomendável fazê-lo.
No que diz respeito à porta de comunicações HTTP, se tiver tecnologia Vault legada (Altium Personal Vault ou Altium Satellite Vault) em execução no mesmo PC, certifique-se de que as portas de comunicação são únicas. Um Altium Personal Vault legado utiliza a porta 9680, enquanto um Altium Satellite Vault legado utiliza a porta 9880. O Enterprise Server não pode ser instalado em conjunto com um Altium Vault legado (3.0 e anteriores), Altium Concord Pro, Altium NEXUS Server, ou um Altium Infrastructure Server (ou seja, no mesmo PC). No caso dos três primeiros, pode atualizar para o Enterprise Server (como se estivesse a atualizar para uma versão posterior dessa entidade).
Consulte informações sobre portas e endereços IP para software de design da Altium.
Protocolo Utilizado para Comunicações Serviço-a-Serviço
SOAP sobre HTTP.
Armazenamento de Dados
Caminhos de Instalação Predefinidos
Segue-se uma lista dos caminhos de instalação predefinidos ao instalar o 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.
Repositório de Design SVN Local – Armazenamento
Um Repositório de Design criado através do serviço local de Controlo de Versões tem os seus dados internos armazenados numa subpasta correspondente na pasta \ProgramData\Altium\Altium365Data\Repository (para uma instalação predefinida do Enterprise Server).
-
Uma nova instalação do Enterprise Server disponibiliza um único repositório de design baseado em Git para alojar todos os projetos de design do seu Workspace — e é só isso! Isto evita qualquer configuração e complexidade relacionadas com o serviço local de Controlo de Versões do Enterprise Server. Tem um único repositório de design — Versioned Storage — para todos os seus designers acederem e efetuarem lançamentos. Como tal, a página VCS da interface do browser do Workspace do Enterprise Server passa a ser meramente informativa — não é possível adicionar um novo repositório, e o único repositório Git não pode ser modificado de forma alguma, nem eliminado.
-
A pasta \ProgramData\Altium\Altium365Data\Repository não deve ser acedida de forma alguma, exceto por pessoal de TI para efeitos de manutenção.
Arquitetura de Serviços – Visão Geral
O Enterprise Server instala vários serviços principais, bem como consolas de gestão baseadas no browser e um Explorer (também baseado no browser). Para aceder a qualquer um destes serviços, a identidade de um utilizador tem de ser reconhecida e autenticada. O Enterprise Server inclui um utilizador predefinido (Username: admin, Password: admin). A página Users da interface baseada no browser do Workspace do Enterprise Server pode ser utilizada para adicionar e gerir mais utilizadores. Não existe limite para o número de utilizadores que podem ser registados para aceder e utilizar o Enterprise Server, mas existe um limite para ligações simultâneas, conforme determinado e imposto pelo licenciamento necessário.
O mesmo utilizador pode estar a aceder ao Enterprise Server em simultâneo de diferentes formas (por exemplo, ligado através do Altium Designer AND e acedido através de um browser externo) e isso conta apenas como uma única ligação do ponto de vista do licenciamento, quando o acesso é feito a partir do mesmo PC. Se o mesmo utilizador aceder ao Enterprise Server a partir de PCs diferentes, cada acesso a partir de um PC diferente exigirá uma ligação separada (ou seja, um lugar adicional de uma Connector Access License).
O Altium Designer utiliza um canal não encriptado (SOAP sobre HTTP) para comunicar com os seguintes serviços:
-
Applications Registry Service (quando o Network Installation Service é utilizado como origem para extensões/atualizações)
-
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 (através do protocolo SVN://)
-
Tasks Service
-
Team Configuration Service (TC2)
-
Vault Service
Todos os outros serviços comunicam entre si.
A maioria dos serviços requer acesso à mesma base de dados do Enterprise Server, na qual armazenam dados que lhes são aplicáveis. Seguem-se exemplos dos dados armazenados por alguns destes serviços:
-
Part Catalog Service – armazena itens de fornecedores e fabricantes, alterações ao histórico de preço e quantidade, etc...
-
Identity Service – armazena utilizadores, grupos, configuração de licenciamento e informação de sessão.
-
Vault Service – armazena a respetiva estrutura (pastas, itens, revisões, tipos de conteúdo, estados do ciclo de vida, etc...).
Os documentos efetivos são armazenados no sistema de ficheiros, na pasta Revisions (\ProgramData\Altium\Altium365Data\Revisions).
O Part Catalog Service também requer uma ligação direta (sem proxy) à Internet, para atualizações de preços em tempo real.
As seguintes aplicações baseadas no browser utilizam a API SOAP para comunicar com os serviços aplicáveis — não requerem acesso à base de dados do Enterprise Server, nem são necessários quaisquer outros ficheiros para o seu funcionamento:
-
User Management – a aplicação por trás da página Users e das respetivas subpáginas na interface do browser do Workspace do Enterprise Server.
-
Vault Explorer – a aplicação por trás da página Explorer da interface do browser do Workspace do Enterprise Server.
-
Catalog Management – a aplicação por trás da página Part Providers da interface do browser do Workspace do Enterprise Server.
-
Projects Management – a aplicação por trás da página Projects da interface do browser do Workspace do Enterprise Server.
-
TC2 Console – a aplicação por trás da página Configurations da interface do browser do Workspace do Enterprise Server.
Operações
Cópia de Segurança/Restauro dos Dados do Servidor
A cópia de segurança e o restauro dos dados do seu Enterprise Server são realizados a partir da linha de comandos, de forma automatizada, utilizando a ferramenta dedicada Backup & Restore Tool. Esta ferramenta – avbackup.exe – pode ser encontrada na pasta \Program Files (x86)\Altium\Altium365\Tools\BackupTool\ (numa instalação predefinida do Enterprise Server).
Consulte a página Backing up & Restoring Your Installation para saber mais.
Reindexar Conteúdo do Servidor após Migração de Dados
Para reindexar conteúdo do Enterprise Server, por exemplo após uma migração de dados:
-
Pare todos os application pools do IIS associados ao Enterprise Server.
-
Pare o serviço Elasticsearch (AltiumElasticSearch). Isto é feito a partir do painel do Windows Services — acedido a partir da janela Administrative Tools do Windows.
-
Elimine o conteúdo da pasta SearchData, que contém os dados de indexação de pesquisa (\ProgramData\Altium\Altium365Data\SearchData numa instalação predefinida).
-
Reinicie o serviço Elasticsearch (AltiumElasticSearch).
-
Reinicie os application pools do IIS associados ao Enterprise Server.
Ao detetar a pasta SearchData vazia, o Enterprise Server reindexará o respetivo conteúdo assim que arrancar.
Aumentar o Tamanho do Heap Java
Um tamanho insuficiente do heap Java pode corromper o índice de pesquisa de componentes e tornar os dados dos componentes indisponíveis no Altium Designer. Se tiver problemas com o índice de pesquisa (o Health Monitor Status Report apresentar erros de SearchService Schema not found: 'vault1ex2_04 nos registos), considere aumentar o tamanho do heap Java.
O tamanho atual do heap Java pode ser verificado abrindo http://localhost:9200/_cat/nodes?h=heap*&v na máquina que aloja o Enterprise Server. Se o valor heap.max rondar 1 GB, aumente este valor conforme descrito abaixo.
-
O valor para o qual o tamanho do heap Java deve ser aumentado depende do tamanho da base de dados do Enterprise Server. A descrição abaixo mostra um exemplo de aumento do tamanho para 4 GB.
-
Antes de prosseguir com o aumento do tamanho do heap Java, certifique-se de que a máquina tem a quantidade adicional correspondente de memória física.
-
Execute a Linha de Comandos em modo de administrador.
-
Execute o seguinte comando:
"C:\Program Files (x86)\Altium\Altium365\Services\ElasticSearch\bin\service-nexus-server.bat" manager AltiumElasticsearch
-
No separador Java da caixa de diálogo que se abre, faça as seguintes alterações:
-
No campo Java Options, atualize -Xms1g para -Xms4g e atualize -Xmx1g para -Xmx4g.
-
Atualize os valores nos campos Initial memory pool e Maximum memory pool para 4096.
Ao aumentar o tamanho do heap Java para um valor diferente de 4 GB, altere as opções acima em conformidade (por exemplo, atualize as opções Java para -Xms6g e -Xmx6g e especifique 6144 para Initial memory pool e Maximum memory pool se estiver a aumentar o tamanho para 6 GB).
-
Clique em Apply e em OK na caixa de diálogo.
-
No painel Services do Windows (acedido a partir da janela Administrative Tools do Windows), reinicie o serviço AltiumElasticsearch .
-
Verifique se as alterações foram aplicadas abrindo http://localhost:9200/_cat/nodes?h=heap*&v e verificando o valor do parâmetro heap.max.
Localizado por IA