Thông tin dành cho bộ phận CNTT

Trong khi việc cài đặt và sử dụng Altium On-Prem Enterprise Server cùng các dịch vụ liên quan của nó đã được mô tả chi tiết trên các trang khác trong bộ tài liệu này, mục đích của trang này là cung cấp một nguồn tham khảo duy nhất, chi tiết dành cho bộ phận CNTT của tổ chức. Đây là nơi để tìm câu trả lời cho các câu hỏi thường gặp về công nghệ này, bao gồm:

• 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?

Các phần sau đây cung cấp câu trả lời chi tiết cho những câu hỏi này và các câu hỏi khác, bao gồm phần tổng quan cấp cao về kiến trúc và luồng dữ liệu.

Cấu hình IIS

Là một phần của cấu hình IIS, tính năng ISAPI Extensions được bật. Tính năng này có thể được tìm thấy trong phần \Internet Information Services\World Wide Web Services\Application Development Features của hộp thoại Windows Features – được truy cập từ cửa sổ Programs and Features của Windows.

Việc cài đặt Enterprise Server sẽ bật tính năng Windows ISAPI Extensions, là một phần của cấu hình IIS.

Hỗ trợ giao thức HTTPS

Enterprise Server cung cấp khả năng giao tiếp an toàn qua mạng bằng giao thức HTTPS để bảo vệ quyền riêng tư và tính toàn vẹn của dữ liệu.

Cấu hình chứng chỉ

Khi cài đặt Enterprise Server, bạn có thể cấu hình chứng chỉ SSL (learn more). Mặc dù có thể tạo chứng chỉ tự ký, nhưng vì lý do bảo mật, bạn nên tự tạo chứng chỉ của riêng mình (bằng các công cụ tiêu chuẩn/ưu tiên của bạn) rồi cấu hình chứng chỉ này trong IIS. Bạn có thể tạo yêu cầu chứng chỉ và gửi yêu cầu đó tới một tổ chức chứng thực chứng chỉ (CA) uy tín như VeriSign hoặc GeoTrust, hoặc lấy chứng chỉ từ một CA trực tuyến trong miền intranet của bạn. Hãy tham khảo trang How to Set Up SSL on IIS 7 or later trong tài liệu Microsoft để tìm hiểu thêm.

Cấu hình HTTPS

Cấu hình và các server binding cho Enterprise Server có thể được truy cập từ bảng điều khiển Windows Internet Information Services (IIS) Manager – có sẵn từ cửa sổ Administration Tools (Control Panel\System and Security\Administrative Tools). Chọn mục 'Altium On-Prem Enterprise Server' trong danh sách Connections của bảng điều khiển, rồi chọn tab Features View.

Truy cập cấu hình và thiết lập server binding cho Enterprise Server.

Các cổng và tên máy chủ khả dụng cho Enterprise Server được hiển thị dưới dạng các liên kết có thể chọn trong khung Actions. Dùng các liên kết này để ghi nhận và kiểm tra các giao thức kết nối máy chủ, hoặc truy cập các binding tên/cổng hiện tại bằng cách chọn liên kết Bindings trong phần Edit Site của khung.

Một Binding, bao gồm cả số cổng giao thức của nó, có thể được chỉnh sửa từ hộp thoại Site Bindings thông qua nút Edit .

Cấu hình binding thông qua hộp thoại Site Bindings.

Lưu ý rằng tên máy chủ localhost chỉ áp dụng cho máy cục bộ, vì vậy các PC other máy đang lưu trữ Enterprise Server cần sử dụng tên thực tế của máy chủ đó để kết nối.

Để xác nhận tên của PC host nơi Enterprise Server được cài đặt và đang chạy, trên chính máy đó hãy đi tới Control Panel\System and Security\System và ghi lại cả Computer name lẫn Full computer name (tên miền đủ điều kiện của nó – FQDN); giá trị thứ hai sẽ là giá trị được Enterprise Server sử dụng cho các kết nối bảo mật qua mạng.

Nếu bạn đã chỉnh sửa site binding của Enterprise Server để dùng một số Port khác với giá trị mặc định, thay đổi đó cũng cần được phản ánh trong tệp LocalVault.ini của Enterprise Server. Lý do là vì các tham chiếu cổng trong đó sẽ được truy cập khi Altium Designer kết nối tới Enterprise Server. Tệp LocalVault.ini có thể được tìm thấy trong thư mục gốc của bản cài đặt Enterprise Server – thường là Program Files (x86)\Altium\Altium365.

Ví dụ: nếu bạn đã thay đổi site binding của Enterprise Server để sử dụng cổng 443 tiêu chuẩn cho các kết nối HTTPS, hãy cập nhật dòng HttpsPort=9785 tương ứng trong tệp LocalVault.ini thành HttpsPort=443.

Khi cấu hình lại Site Binding

Nếu bạn đã thêm Site Binding IIS mới cho Enterprise Server, hoặc chỉnh sửa một mục Site Binding hiện có (xem ở trên), PC máy chủ nên được khởi động lại để thiết lập cấu hình mới một cách chính xác. Những thay đổi Site Binding điển hình có thể là chỉnh sửa số Port cho một mục host, hoặc thêm một binding mới cho bí danh miền.

Khi việc khởi động lại máy chủ host không thực tế, quy trình thay thế là khởi động lại dịch vụ máy chủ trên nền tảng IIS – Restart trong Manage Website – đồng thời khởi động lại dịch vụ Altium DXP App Server Pinger (một dịch vụ Windows).

Truy cập qua HTTPS

Để thiết lập kết nối an toàn tới Enterprise Server:

• Từ Altium Designer – sử dụng địa chỉ máy chủ có tiền tố HTTPS và cổng HTTPS đã được cấu hình. Theo mặc định, đây là https://<computername>:9785 (trong đó [computername] là Computer Name hoặc tên miền đủ điều kiện của máy host).

  Altium Designer bao gồm sẵn hỗ trợ bảo mật cần thiết để chấp nhận kết nối HTTPS tới Enterprise Server mà không cần can thiệp thêm.

• Từ trình duyệt – nhập địa chỉ của dịch vụ tên máy tính host (https://<computername>:9785).

  Nếu bạn chọn giữ chứng chỉ nhận dạng tự ký được tạo cho Enterprise Server, trình duyệt của bạn sẽ cảnh báo rằng kết nối không an toàn/riêng tư. Bạn có thể chọn chấp nhận trong trình duyệt để tiếp tục. Một số trình duyệt (ví dụ: Firefox) cung cấp tùy chọn chấp nhận vĩnh viễn chứng chỉ để không cần thao tác thêm trong những lần sau.

Mạng

Các cổng mặc định

Các số cổng giao tiếp mặc định sau được Enterprise Server sử dụng:

• HTTP Port – 9780

• HTTPS Port – 9785

• LDAP Synchronisation Service Port – 9791

  Thực tế, cổng LDAP Service không được sử dụng. Với LDAP tiêu chuẩn (có URL ldap://), cổng từ URL này sẽ được dùng. Với LDAP bảo mật (có URL ldaps://), cổng 636 sẽ được dùng.

• Websocket Port – 4649

  Lưu ý rằng /websocket/WebService.asmx là một HTTP SOAP endpoint cho các lệnh gọi API, vì vậy, giống như các API endpoint khác, nó sử dụng cổng HTTPS (mặc định là 9785).

• Firebird Server Port – 3050

• SVN Port – 3690

• Elasticsearch Ports – 9200 và 9300

Ba mục đầu tiên trong danh sách có thể được cấu hình trong quá trình cài đặt ban đầu, trên trang Altium On-Prem Enterprise Server Configuration của trình cài đặt.

Khi chọn cổng, lưu ý rằng cổng đó không được xung đột với các cổng do ứng dụng khác sử dụng – nếu một cổng hiện đang được dùng, trình cài đặt sẽ thông báo cho bạn.

Xem thông tin về các cổng và địa chỉ IP cho phần mềm thiết kế Altium.

Giao thức dùng cho truyền thông service-to-service

SOAP over HTTP.

Kết nối tới hệ thống con AltiumLive Identity

Các kết nối tới hệ thống con AltiumLive Identity được thực hiện qua HTTPS theo mặc định, và mục IdentityCloudServiceUrl trong tệp LocalVault.ini (nằm trong thư mục C:\Program Files (x86)\Altium\Altium365 đối với cài đặt mặc định) mặc định là https://ids.api.altium.com/ids?cls=soap.

Cấu hình Platform API

Một số phản hồi từ Platform API trả về các URL dựa trên WebsiteDomain được thiết lập trong cấu hình ban đầu. Trong các trường hợp hiếm gặp (ví dụ: nếu máy chủ của bạn nằm sau load balancer hoặc proxy), những URL này có thể không hoạt động. Để khắc phục, hãy cập nhật mục FilesServiceUrl trong phần [PublicServices] của tệp LocalVault.ini (nằm trong thư mục C:\Program Files (x86)\Altium\Altium365 đối với cài đặt mặc định). Giá trị của mục này nên được đặt thành <PubliclyAccessibleUrl>/napi/files, trong đó <PubliclyAccessibleUrl> là URL bên ngoài có thể được truy cập từ bên ngoài Enterprise Server.

Các tình huống Reverse Proxy và Load Balancer

Một máy chủ reverse proxy có thể được dùng để chặn kết nối inbound từ thế giới bên ngoài vào Enterprise Server. Trong ngữ cảnh này, load balancer cũng sẽ đóng vai trò tương tự.

Sau đây là các tham số chính có thể được cấu hình trong phần [General] của tệp LocalVault.ini (nằm trong thư mục C:\Program Files (x86)\Altium\Altium365 đối với cài đặt mặc định).

• PreferredProtocol – giá trị có thể là HTTP hoặc HTTPS, tùy theo kịch bản được chọn (HTTPS được khuyến nghị).

• WebsiteDomain – đây là FQDN và cổng hướng công khai mà client nhìn thấy (địa chỉ reverse proxy). Do not include the scheme – ví dụ: dùng aes.example.com:443, không dùng https://aes.example.com:443.

• HttpsPort – khi dùng HTTPS, giá trị phải khớp với cổng trong WebsiteDomain.

• Port – đây là cổng lắng nghe HTTP của IIS. Trong các kịch bản truy cập trực tiếp, giá trị này khớp với WebsiteDomain . Trong các kịch bản reverse proxy, đây là cổng HTTP nội bộ mà Enterprise Server lắng nghe.

[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>

Tham chiếu nhanh

Đường dẫn cài đặt mặc định

Sau đây là danh sách các đường dẫn cài đặt mặc định khi cài đặt 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.

Kiến trúc dịch vụ – Tổng quan

Enterprise Server cài đặt một số dịch vụ cốt lõi, cũng như các console quản trị trên nền trình duyệt và Explorer (cũng chạy trên trình duyệt). Để truy cập bất kỳ dịch vụ nào trong số này, danh tính người dùng phải được nhận diện và xác thực. Enterprise Server đi kèm một người dùng được định nghĩa sẵn (Username: admin, Password: admin). Trang Users của giao diện Workspace trên trình duyệt của Enterprise Server có thể được dùng để thêm và quản lý nhiều người dùng hơn. Không có giới hạn về số lượng người dùng có thể được đăng ký để truy cập và sử dụng Enterprise Server, nhưng có giới hạn về số kết nối đồng thời, được xác định và thực thi theo giấy phép bắt buộc.

Altium Designer sử dụng một kênh không mã hóa (SOAP over HTTP) để giao tiếp với các dịch vụ sau:

• Applications Registry Service (khi Network Installation Service được dùng làm nguồn cho extension/cập nhật)

• 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 (thông qua giao thức SVN://)

• Tasks Service

• Team Configuration Service (TC2)

• Vault Service

Tất cả các dịch vụ khác giao tiếp với nhau.

Phần lớn các dịch vụ cần truy cập cùng một cơ sở dữ liệu Enterprise Server để lưu trữ dữ liệu áp dụng cho chúng. Sau đây là ví dụ về dữ liệu được một số dịch vụ lưu trữ:

• Part Catalog Service – lưu trữ các mặt hàng từ nhà cung cấp và nhà sản xuất, lịch sử thay đổi giá và số lượng, v.v...

• Identity Service – lưu trữ người dùng, nhóm, cấu hình cấp phép và thông tin phiên.

• Vault Service – lưu trữ cấu trúc của nó (thư mục, item, revision, content type, trạng thái vòng đời, v.v...).

Các tài liệu thực tế được lưu trên hệ thống tệp, trong thư mục Revisions (\ProgramData\Altium\Altium365Data\Revisions).

Các ứng dụng trên nền trình duyệt sau đây sử dụng SOAP API để giao tiếp với các dịch vụ tương ứng – chúng không cần truy cập cơ sở dữ liệu Enterprise Server, cũng không cần bất kỳ tệp nào khác để hoạt động:

• User Management – ứng dụng đứng sau trang Users và các trang con trong giao diện Workspace trên trình duyệt của Enterprise Server.

• Vault Explorer – ứng dụng đứng sau trang Explorer của giao diện Workspace trên trình duyệt của Enterprise Server.

• Catalog Management – ứng dụng đứng sau trang Part Providers của giao diện Workspace trên trình duyệt của Enterprise Server.

• Projects Management – ứng dụng đứng sau trang Projects của giao diện Workspace trên trình duyệt của Enterprise Server.

• TC2 Console – ứng dụng đứng sau trang Configurations của giao diện Workspace trên trình duyệt của Enterprise Server.

Vận hành

Sao lưu/Khôi phục dữ liệu máy chủ

Việc sao lưu và khôi phục dữ liệu Enterprise Server của bạn được thực hiện từ dòng lệnh, theo cách tự động, bằng công cụ chuyên dụng Backup & Restore Tool. Công cụ này – avbackup.exe – có thể được tìm thấy trong thư mục \Program Files (x86)\Altium\Altium365\Tools\BackupTool\ (đối với cài đặt Enterprise Server mặc định).

Hãy tham khảo trang Backing up & Restoring Your Installation để tìm hiểu thêm.

Lập chỉ mục lại nội dung máy chủ sau khi di chuyển dữ liệu

Để lập chỉ mục lại nội dung Enterprise Server, ví dụ sau khi di chuyển dữ liệu:

1. Dừng tất cả các IIS application pool liên kết với Enterprise Server.

2. Dừng dịch vụ Elasticsearch (AltiumElasticSearch). Việc này được thực hiện từ bảng điều khiển Windows Services – truy cập từ cửa sổ Administrative Tools của Windows.

3. Xóa nội dung của thư mục SearchData, nơi chứa dữ liệu lập chỉ mục tìm kiếm (\ProgramData\Altium\Altium365Data\SearchData đối với cài đặt mặc định).

4. Khởi động lại dịch vụ Elasticsearch (AltiumElasticSearch).

5. Khởi động lại các IIS application pool liên kết với Enterprise Server.

Khi phát hiện thư mục SearchData trống, Enterprise Server sẽ lập chỉ mục lại nội dung của nó ngay khi khởi động.

Tăng kích thước Java Heap

Kích thước Java heap không đủ có thể làm hỏng chỉ mục tìm kiếm linh kiện và khiến dữ liệu linh kiện không khả dụng từ Altium Designer. Nếu bạn gặp sự cố với chỉ mục tìm kiếm (báo cáo Health Monitor Status Report có lỗi SearchService Schema not found: 'vault1ex2_04 trong nhật ký), hãy cân nhắc tăng kích thước Java heap.

Có thể kiểm tra kích thước Java heap hiện tại bằng cách mở http://localhost:9200/_cat/nodes?h=heap*&v trên máy đang lưu trữ Enterprise Server. Nếu giá trị heap.max vào khoảng 1 GB, hãy tăng giá trị này như mô tả bên dưới.

1. Chạy Command Prompt ở chế độ quản trị viên.

2. Chạy lệnh sau:

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

3. Trên tab Java của hộp thoại mở ra, thực hiện các thay đổi sau:

   • Trong trường Java Options, xóa các mục -Xms1g và -Xmx1g.

   • Cập nhật các giá trị trong các trường Initial memory pool và Maximum memory pool thành 4096.

     Khi tăng kích thước Java heap lên giá trị khác 4 GB, hãy thay đổi các tùy chọn Initial memory pool và Maximum memory pool tương ứng (ví dụ: chỉ định 6144 nếu bạn đang tăng kích thước lên 6 GB).

   

4. Nhấp vào Apply và OK trong hộp thoại.

5. Từ bảng điều khiển Services của Windows (truy cập từ cửa sổ Administrative Tools của Windows), khởi động lại dịch vụ AltiumElasticsearch .

6. Xác minh rằng các thay đổi đã được áp dụng bằng cách mở http://localhost:9200/_cat/nodes?h=heap*&v và kiểm tra giá trị tham số heap.max.

Cấu hình số lượng tối đa giá trị tham số linh kiện trên mỗi danh mục bộ lọc

Tệp LocalVault.ini bao gồm tùy chọn cấu hình MaxHitsPerFacet trong phần [Search]. Giá trị được chỉ định giới hạn số lượng mục riêng lẻ (có hộp kiểm) được hiển thị cho mỗi danh mục trong ngăn Filters của bảng Components panel của Altium Designer khi tìm kiếm linh kiện. Với vai trò Quản trị viên, việc giảm giá trị này sẽ làm giảm số lượng kết quả trên mỗi danh mục bộ lọc, từ đó giảm đáng kể tải lên dịch vụ tìm kiếm và tăng hiệu suất tìm kiếm.

Tăng độ dài phân đoạn URL được phép

Để sử dụng chức năng Release & Publish to PLM trong Altium Designer (tìm hiểu thêm), cần cập nhật registry trong Windows trên máy nơi Enterprise Server được cài đặt. Trong cửa sổ Windows Command (CMD) có quyền Quản trị viên, hãy chạy lệnh sau:

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

Thay đổi này làm tăng độ dài phân đoạn URL được phép, điều cần thiết để hỗ trợ các tính năng của hệ thống. Lưu ý rằng sau khi áp dụng thay đổi này, bạn phải khởi động lại máy tính để sửa đổi có hiệu lực.