Informação para Departamentos de TI

Embora a instalação e o uso do Altium On-Prem Enterprise Server e de seus serviços relacionados estejam detalhados em outras 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 para encontrar respostas para perguntas normalmente feitas sobre essa 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 seções a seguir fornecem respostas detalhadas para estas e outras perguntas, incluindo uma visão geral de alto nível da arquitetura e dos fluxos de dados.

Configuração do IIS

Como parte da configuração do IIS, o recurso ISAPI Extensions é habilitado. Esse recurso pode ser encontrado na seção \Internet Information Services\World Wide Web Services\Application Development Features da caixa de diálogo Windows Features – acessada pela janela Programs and Features do Windows.

A instalação do Enterprise Server habilita o recurso ISAPI Extensions do Windows, parte da configuração do IIS.

Suporte ao Protocolo HTTPS

O Enterprise Server oferece comunicação segura em redes usando o protocolo HTTPS para proteger a privacidade e a integridade dos dados.

Configurando um Certificado

Ao instalar o Enterprise Server, você tem a capacidade de configurar um certificado SSL (learn more). Embora seja possível criar um certificado autoassinado, recomenda-se gerar seu próprio certificado (usando suas ferramentas padrão/preferidas) e depois configurar esse certificado no IIS por motivos de segurança. Você pode criar uma solicitação de certificado e enviá-la para uma autoridade certificadora (CA) conhecida, como VeriSign ou GeoTrust, ou obter um certificado de uma CA online em seu domínio de intranet. Consulte a página How to Set Up SSL on IIS 7 or later na documentação da Microsoft para saber mais.

Configurando HTTPS

A configuração e os vínculos do servidor para o Enterprise Server podem ser acessados pelo 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 a guia Features View.

Acesse as configurações de configuração e de vínculo do servidor para o Enterprise Server.

As portas disponíveis e os nomes de servidor para o Enterprise Server são mostrados como links selecionáveis no painel Actions. Use os links para anotar e testar os protocolos de conexão do servidor, ou acesse os vínculos atuais de nome/porta selecionando o link Bindings na seção Edit Site do painel.

Um Binding, incluindo seu número de porta de protocolo, pode ser editado na caixa de diálogo Site Bindings por meio do botão Edit .

Configure os bindings pela caixa de diálogo Site Bindings.

Observe que o nome do servidor localhost se aplica apenas à máquina local, portanto os PCs other aquele que está hospedando o Enterprise Server precisam usar o nome real (do servidor) dessa máquina host para se conectar.

Para confirmar o nome do PC host no qual o Enterprise Server está instalado e em execução, nessa máquina vá para Control Panel\System and Security\System e anote tanto o Computer name quanto o Full computer name (seu nome de domínio totalmente qualificado) – este último será usado pelo Enterprise Server para conexões seguras pela rede.

Se você editou os vínculos de site do Enterprise Server para usar um número de Porta diferente do valor padrão, essa alteração também precisará ser refletida no arquivo LocalVault.ini do Enterprise Server. Isso ocorre porque suas referências de porta são acessadas quando conexões são feitas ao Enterprise Server pelo Altium Designer. O arquivo LocalVault.ini pode ser encontrado na pasta raiz da instalação do Enterprise Server – normalmente Program Files (x86)\Altium\Altium365.

Por exemplo, se você alterou o vínculo de site do Enterprise Server para usar a porta padrão 443 para conexões HTTPS, atualize a linha HttpsPort=9785 correspondente no arquivo LocalVault.ini para HttpsPort=443.

Ao Reconfigurar os Vínculos do Site

Se você adicionou um novo Site Binding do IIS para o Enterprise Server, ou editou uma entrada de Site Binding existente (veja acima), o PC do servidor deve ser reiniciado para estabelecer corretamente a nova configuração. Alterações típicas de Site Binding podem incluir editar o número da Porta para uma entrada de host, ou adicionar um novo binding para um alias de domínio.

Quando não for prático reiniciar a máquina host 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).

Acesso por HTTPS

Para estabelecer uma conexão segura com o Enterprise Server:

• No Altium Designer – use um endereço de servidor com prefixo HTTPS e a porta HTTPS configurada. Por padrão, isso é https://<computername>:9785 (onde [computername] é o Nome do Computador da máquina host ou o nome de domínio totalmente qualificado).

  O Altium Designer inclui o suporte de segurança necessário para aceitar uma conexão HTTPS com o Enterprise Server sem intervenção.

• Em um navegador – insira o endereço do serviço de nome do computador host (https://<computername>:9785).

  Se você optou por manter o Certificado de Identidade autoassinado gerado para o Enterprise Server, seu navegador avisará que a conexão não é segura/privada. Você pode optar por aceitar no navegador para prosseguir. Alguns navegadores (por exemplo, Firefox) oferecem a opção de aceitar permanentemente o certificado para que nenhuma ação adicional seja necessária.

Rede

Portas Padrão

Os seguintes números de porta de comunicação padrão são usados pelo Enterprise Server:

• HTTP Port – 9780

• HTTPS Port – 9785

• LDAP Synchronisation Service Port – 9791

  A porta do serviço LDAP não é, na prática, utilizada. Para LDAP padrão (com URL ldap://), é usada a porta dessa URL. Para LDAP seguro (com URL ldaps://), é usada a porta 636.

• Websocket Port – 4649

  Observe que /websocket/WebService.asmx é um endpoint SOAP HTTP para chamadas de API, portanto, como outros endpoints de API, usa a porta HTTPS (9785 por padrão).

• Firebird Server Port – 3050

• SVN Port – 3690

• Elasticsearch Ports – 9200 e 9300

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.

Ao escolher uma porta, observe que ela não deve entrar em conflito com portas usadas por outros aplicativos – se uma porta estiver em uso no momento, você será notificado pelo instalador.

Veja informações sobre portas e endereços IP para software de design Altium.

Protocolo Usado para Comunicações entre Serviços

SOAP sobre HTTP.

Conexão com o Subsistema de Identidade AltiumLive

As conexões com o subsistema de Identidade AltiumLive são realizadas por HTTPS por padrão, e a entrada IdentityCloudServiceUrl no arquivo LocalVault.ini (localizado na pasta C:\Program Files (x86)\Altium\Altium365 para a instalação padrão) é https://ids.api.altium.com/ids?cls=soap por padrão.

Configurando a API da Plataforma

Algumas respostas da API da Plataforma retornam URLs com base no WebsiteDomain definido durante a configuração inicial. Em casos raros (por exemplo, se seu servidor estiver atrás de um balanceador de carga ou proxy), essas URLs podem não funcionar. Para corrigir isso, atualize a entrada FilesServiceUrl na seção [PublicServices] do arquivo LocalVault.ini (localizado na pasta C:\Program Files (x86)\Altium\Altium365 para a instalação padrão). O valor da entrada deve ser definido como <PubliclyAccessibleUrl>/napi/files, onde <PubliclyAccessibleUrl> é a URL externa que pode ser acessada de fora do Enterprise Server.

Cenários de Proxy Reverso e Balanceador de Carga

Um servidor proxy reverso pode ser usado para interceptar a conexão inbound do mundo externo para o Enterprise Server. Nesse contexto, um balanceador de carga desempenharia a mesma função.

A seguir estão os principais parâmetros que podem ser configurados na seção [General] do arquivo LocalVault.ini (localizado na pasta C:\Program Files (x86)\Altium\Altium365 para a instalação padrão).

• PreferredProtocol – o valor pode ser HTTP ou HTTPS, dependendo do cenário escolhido (HTTPS é recomendado).

• WebsiteDomain – este é um FQDN e porta voltados ao público, conforme vistos pelos clientes (endereço do proxy reverso). Do not include the scheme – por exemplo, use aes.example.com:443, não https://aes.example.com:443.

• HttpsPort – ao usar HTTPS, o valor deve corresponder à porta em WebsiteDomain.

• Port – esta é a porta HTTP de escuta do IIS. Em cenários de acesso direto, ela corresponde a WebsiteDomain . Em cenários de proxy reverso, esta é a porta HTTP interna na qual o Enterprise Server escuta.

[General]
WebsiteDomain=aes.example.com:443
HttpsPort=443
PreferredProtocol=HTTPS
Port=9780

[General]
WebsiteDomain=aes.example.com:443
HttpsPort=443
PreferredProtocol=HTTPS
Port=9780

[General]
WebsiteDomain=aes.example.com:443
HttpsPort=443
Port=9780
PreferredProtocol=HTTPS
[Services]
UnifiedLoginUrl=https://aes.example.com/unifiedlogin
IIS binding: <http://*:9780>

Referência Rápida

Caminhos de Instalação Padrão

A seguir está uma lista de caminhos de instalação padrão 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.

Arquitetura de Serviço – Visão Geral

O Enterprise Server instala vários serviços principais, assim como consoles de gerenciamento baseados em navegador e um Explorer (também baseado em navegador). Para acessar qualquer um desses serviços, a identidade de um usuário deve ser reconhecida e autenticada. O Enterprise Server vem com um usuário predefinido (Username: admin, Password: admin). A página Users da interface baseada em navegador do Workspace do Enterprise Server pode ser usada para adicionar e gerenciar mais usuários. Não há limite para o número de usuários que podem ser registrados para acessar e usar o Enterprise Server, mas há um limite de conexões simultâneas, conforme determinado e imposto pelo licenciamento necessário.

O Altium Designer usa um canal não criptografado (SOAP sobre HTTP) para se comunicar com os seguintes serviços:

• Applications Registry Service (quando o Network Installation Service estiver sendo usado como fonte 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 (por meio do protocolo SVN://)

• Tasks Service

• Team Configuration Service (TC2)

• Vault Service

Todos os outros serviços se comunicam entre si.

A maioria dos serviços requer acesso ao mesmo banco de dados do Enterprise Server, no qual armazenar dados aplicáveis a eles. A seguir estão exemplos dos dados armazenados por alguns desses serviços:

• Part Catalog Service – armazena itens de fornecedor e fabricante, alterações no histórico de preço e quantidade etc...

• Identity Service – armazena usuários, grupos, configuração de licenciamento e informações de sessão.

• Vault Service – armazena sua estrutura (pastas, itens, revisões, tipos de conteúdo, estados de ciclo de vida etc...).

Os documentos reais são armazenados no sistema de arquivos, na pasta Revisions (\ProgramData\Altium\Altium365Data\Revisions).

Os seguintes aplicativos baseados em navegador usam a API SOAP para se comunicar com os serviços aplicáveis – eles não exigem acesso ao banco de dados do Enterprise Server, nem quaisquer outros arquivos são necessários para que funcionem:

• User Management – o aplicativo por trás da página Users e subpáginas na interface de navegador do Workspace do Enterprise Server.

• Vault Explorer – o aplicativo por trás da página Explorer da interface de navegador do Workspace do Enterprise Server.

• Catalog Management – o aplicativo por trás da página Part Providers da interface de navegador do Workspace do Enterprise Server.

• Projects Management – o aplicativo por trás da página Projects da interface de navegador do Workspace do Enterprise Server.

• TC2 Console – o aplicativo por trás da página Configurations da interface de navegador do Workspace do Enterprise Server.

Operações

Backup/Restauração de Dados do Servidor

O backup e a restauração dos dados do seu Enterprise Server são realizados pela linha de comando, de forma automatizada, usando a ferramenta dedicada Backup & Restore Tool. Essa ferramenta – avbackup.exe – pode ser encontrada na pasta \Program Files (x86)\Altium\Altium365\Tools\BackupTool\ (para uma instalação padrão do Enterprise Server).

Consulte a página Backing up & Restoring Your Installation para saber mais.

Reindexação do Conteúdo do Servidor após a Migração de Dados

Para reindexar o conteúdo do Enterprise Server, por exemplo após a migração de dados:

1. Interrompa todos os pools de aplicativos do IIS associados ao Enterprise Server.

2. Interrompa o serviço Elasticsearch (AltiumElasticSearch). Isso é feito no painel do Windows Services – acessado pela janela Administrative Tools do Windows.

3. Exclua o conteúdo da pasta SearchData, que contém os dados de indexação de pesquisa (\ProgramData\Altium\Altium365Data\SearchData para uma instalação padrão).

4. Reinicie o serviço Elasticsearch (AltiumElasticSearch).

5. Reinicie os pools de aplicativos do IIS associados ao Enterprise Server.

Ao encontrar a pasta SearchData vazia, o Enterprise Server reindexará seu conteúdo assim que iniciar.

Aumentando o Tamanho do Heap do Java

Um tamanho insuficiente do heap do Java pode comprometer o índice de pesquisa de componentes e tornar os dados dos componentes indisponíveis no Altium Designer. Se você tiver problemas com o índice de pesquisa (o Health Monitor Status Report apresenta erros do SearchService Schema not found: 'vault1ex2_04 nos logs), considere aumentar o tamanho do heap do Java.

O tamanho atual do heap do Java pode ser verificado abrindo http://localhost:9200/_cat/nodes?h=heap*&v na máquina que hospeda o Enterprise Server. Se o valor de heap.max estiver em torno de 1 GB, aumente esse valor conforme descrito abaixo.

1. Execute o Prompt de Comando em modo de administrador.

2. Execute o seguinte comando:

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

3. Na guia Java da caixa de diálogo que se abre, faça as seguintes alterações:

   • No campo Java Options, remova as entradas -Xms1g e -Xmx1g.

   • Atualize os valores nos campos Initial memory pool e Maximum memory pool com 4096.

     Ao aumentar o tamanho do heap do Java para um valor diferente de 4 GB, altere as opções Initial memory pool e Maximum memory pool de forma correspondente (por exemplo, especifique 6144 se estiver aumentando o tamanho para 6 GB).

   

4. Clique em Apply e OK na caixa de diálogo.

5. No painel Services do Windows (acessado pela janela Administrative Tools do Windows), reinicie o serviço AltiumElasticsearch .

6. 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.

Configuração do Número Máximo de Valores de Parâmetros de Componentes por Categoria de Filtro

O arquivo LocalVault.ini inclui a opção de configuração MaxHitsPerFacet na seção [Search]. O valor especificado limita o número de entradas individuais (com caixas de seleção) apresentadas por categoria no painel Filters do painel Components panel do Altium Designer, ao pesquisar um componente. Como Administrador, reduzir esse valor diminui os resultados por categoria de filtro, reduzindo significativamente a carga no serviço de pesquisa e aumentando o desempenho da pesquisa.

Aumentando o Comprimento Permitido do Segmento de URL

Para usar a funcionalidade Release & Publish to PLM no Altium Designer (saiba mais), é necessária uma atualização do registro no Windows na máquina em que o Enterprise Server está instalado. Em uma janela de Comando do Windows (CMD) com privilégios de Administrador, execute o seguinte:

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

Essa alteração aumenta o comprimento permitido do segmento de URL, o que é necessário para oferecer suporte aos recursos do sistema. Observe que, após aplicar essa alteração, você deverá reiniciar o computador para que a modificação entre em vigor.