混合代理集成

创建时间：2023 年 4 月 2 日 |更新时间：2023 年 12 月 11 日

Note

可用的功能取决于您的 Altium 产品访问级别。如果您在软件中未看到讨论的功能， 请联系 Altium 销售部门 了解更多信息。

父页面： PLM 集成

混合集成适用于以下情况：使用 Altium 365 的公司希望将其工作区与托管在公司网络内部的 PLM 系统集成，该系统没有公共 IP 地址 - 不会暴露在互联网上。

为了实现这一点，需在企业内部运行了一个名为工作区混合代理 的程序。该程序通过 HTTPS 加密的方式将数据包在 Altium 365 工作区 和 PLM 系统之间传递，出站流量需打开标准 的 HTTPS 端口443。

注意：

• 使用混合集成需要特殊的 Altium 工作区 许可证。
• 如果您正在设置与西门子 Teamcenter ^® PLM（需要混合代理）的集成，请首先参考Teamcenter 的附加安装和设置页面。

设置混合集成

可以从 Altium 365 工作区 工作区混合代理页面获取 工作区混合代理 安装包，该页面可从PLM 管理页面（管理员 - PLM 集成）顶部的工作区混合代理选项卡选项打开。

下载代理存档 ( ) 并将其内容解压到已知位置。它包含一个 Java 应用程序 ( hybrid-agent.jar )，需要在公司网络内的机器上运行，从该机器可以访问本地 PLM 系统和 Altium 365。如果贵公司有互联网访问限制，需放开该机器访问Altium 365 域名的流量，方可连接到贵公司使用的 Altium 365 工作区。

• 请注意，混合代理不必需在托管 PLM 系统的机器上运行，尽管这样的设置不会造成问题。
• 混合代理应用程序包括基于 Linux 的系统的等效 shell 脚本文件（例如agent.sh）——用于代替*.bat下面代理设置说明中的 Windows 文件。

混合代理需要Java 开发工具包(JDK) 11 或更高版本。

安装 JDK

可以使用Oracle JDK或OpenJDK。使用 Oracle JDK 时请确保您拥有有效的许可证。

如果从普通存档（而不是安装程序可执行文件）安装 JDK，则需要添加其路径环境变量。对于 Windows 计算机/VM，这些通常是：

• PATH– 指向安装的bin文件夹。
• JAVA_HOME– 指向安装文件夹本身。

通过运行命令测试对 Java 可执行文件的访问Java -version。

一旦混合代理应用程序到位：

1. 在 Altium 365 工作区 工作区混合代理页面中生成 API 密钥（ ）。

2. 创建一个HYBRID_AGENT_API_KEY以 API 密钥作为其值的环境变量。

3. 使用以下命令上下文运行agent.bat，其中 URL 参数应为 Altium 365 工作区 的URL：
   agent.bat https://acme.365.altium.com

当激活时，混合代理将在应用程序的hybrid-agent\logs文件夹中生成一个日志文件。

请注意，工作区一次只能有一个有效的 API 密钥，并且只能运行一个混合代理实例。如果两个 PLM 系统都托管在同一个封闭网络中，则代理将支持多个 PLM 配置实例。

强烈建议在生产环境中将混合代理作为Windows 服务运行，而不是直接在终端中运行，尽管后者可用于测试。

使用NSSM服务管理器将混合代理作为 Windows 服务运行的示例方法：

1. 运行命令：nssm install HybridAgent。

2. 在 NSSM 对话框窗口（在应用程序选项卡下）中，在径路agent.bat字段中输入文件路径，在参数字段中输入工作区 URL ，然后单击安装服务。

   1. 您可以使用NSSM 对话框的“详细信息”选项卡下的“启动类型”选项设置服务启动行为。如果需要，请运行nssm edit HybridAgent以进行此类更改。
   2. 作为为 Java 创建标准PATH和JAVA_HOME环境变量的替代方法，可以在 NSSM环境选项卡下添加它们。使用此方法，变量仅在HybridAgent服务运行时才有效。

   3. 与上面类似，该HYBRID_AGENT_API_KEY变量也可以移动到 NSSM 环境设置，以便在服务运行时处于活动状态。

3. HybridAgent使用 Windows服务管理工具或 NSSM 命令启动服务： nssm start HybridAgent。如果服务设置为自动启动，则不需要执行此操作（PC 重启后）。
4. 确保该HybridAgent服务正在 Windows服务管理工具中运行，或使用 NSSM 命令运行：nssm status HybridAgent。

一旦混合代理连接到您的 Altium 365 工作区（刷新浏览器窗口以检查其状态），您就可以继续在 Altium 365 工作区中配置 PLM 集成。在添加配置页面中，启用混合代理连接选项，并在URL字段中输入您的内部 PLM 的 URL（如在封闭网络中看到的）。

可以使用关联的Revoke命令取消当前 API 密钥。在这种情况下，需要生成新的 API 密钥，并HYBRID_AGENT_API_KEY使用新的密钥值更新环境变量。

重新启动混合代理以使用新密钥 – 通过 NSSM 启动 nssm restart HybridAgent 命令，或在 Windows服务中停止/启动 HybridAgent服务。