使用 XML 文件进行 PLM 集成

 

本页介绍通过手动编辑 PLM 配置 XML 文件,使用该手动流程为受支持的 PLM 系统建立与 Altium 365 工作区的连接。基于手动编辑 XML 文件的 PLM 接口可通过在工作区界面的 Admin – Settings – PLM Integration 页面取消勾选 Enable new PLM Configuration page 选项来启用。

当该选项处于勾选状态(其默认且推荐的设置)时,将使用在 PLM Integration 页面中所述的高级半自动用户界面。注意:该界面也允许通过其 XML Import/export 功能对 XML 配置文件进行手动操作。

 查阅 自动化的 PLM 集成界面

连接到您的 PLM 实例

通过工作区浏览器界面的 Admin – PLM Integration 页面连接到您的 PLM 实例。该过程包括上传适用的基于 XML 的配置文件和发布模板,并启用/配置将您的 PLM 器件与工作区中的器件进行同步。

若要创建一个新的 PLM 接口实例,点击   按钮。可根据需要定义任意多个实例,以便让您的工作区与不同的 PLM 实例对接。例如,您的器件可能位于一个 PLM 实例中,而已发布设计项目的生成输出位于另一个;或者不同部门正在使用不同的实例(同一或不同的 PLM 系统)。每个实例必须具有唯一名称、一个配置文件以及一个或多个已定义的发布模板。要测试某已定义实例的连接,点击   按钮——参见下文 Connection Validation

安装中提供了示例配置文件和发布模板——展开下列部分以获取更多信息:

当通过   按钮新增一个 PLM 条目时,使用   按钮浏览并应用已保存/修改好的 PLM 配置。

 

类似地,可在 Publish Template 选项卡下通过   按钮添加兼容的发布模板。在随后出现的 Publish Template 对话框中,使用   按钮浏览并选择正确的模板文件。

添加并配置与公司PLM系统的接口。建立有效连接后,您可以根据实例的有效发布模板,将项目发布数据(使用已定义的流程定义)发布到PLM系统,还可以安排PLM系统与工作区之间的器件同步。

如果不使用随附的配置文件来创建新的企业系统实例,可以使用工作区的内部配置生成器,生成一种基于工作区数据模型结构的适配配置。该生成器会请求连接信息(PLM 类型与 URL),随后读取工作区中已注册的器件类型(如 Capacitors、Diodes 等)及其匹配的器件模板,以构建一个基础配置文件。展开下方章节以了解更多信息。

在编辑并重新上传配置文件到 PLM 实例后,请务必进行连接测试(验证),以检测可能引入的问题——详见下文。

第三方 PLM 支持

Altium 365 工作区对第三方开发的“非原生”PLM 系统配置提供额外支持。该支持由 Altium 的 Generic Connector 启用,并需要 Altium 365 PLM Generic Connector Addon 许可证。

为此类系统添加工作区 PLM 实例时,按照上述方法,将第三方提供的预配置 XML 文件上传到该 PLM 实例的配置中。

若需申请 Altium 365 PLM Generic Connector Addon 许可证,请联系 sales.na@altium.com 或您的 Altium 客户经理。

连接验证

工作区提供完整的 PLM 实例连接验证检查,可在 Add/Edit Instance 页面通过  按钮使用。该检查会执行一系列配置兼容性校验,并立即报告结果。

运行连接验证报告时,工作区会分析当前配置与发布模板设置,检查其与工作区实例及目标企业系统数据的兼容性。诸如路径错误、器件类型定义与参数不匹配、Lifecycle 或 Revision 设置无效等问题都会被检测并在 Configuration Validation Report 对话框中报告。

如果报告了配置错误,导致总体状态为 ERROR(Status),则必须在创建新实例之前解决这些问题。WARNING 状态表示问题如:工作区中的某些器件类型未包含在配置中,或指定的属性在企业系统侧不可用,此时可保存并使用该已配置实例。

随后可在已应用的配置或发布文件中更正报告的错误与警告,或通过更改工作区或企业系统的设置进行修复。当实例成功定义后,请点击  按钮。该实例将出现在主 PLM Integration 页面上的已连接实例列表中。

当配置文件被编辑并重新上传到新实例后,请再次使用  按钮以检测可能引入的问题。

元件同步

Altium 365 工作区与已连接企业系统实例之间的元件同步(更具体地说是其参数化数据同步)基于 LibSync 流程工作流LibSync 流程在工作区中是预定义的,无法在 Admin - Processes 页面访问或编辑。但作为一种基于工作流的过程,您可以查看其同步结果并处理任何错误。

使用同步流程通常包括以下内容:

  • 为每种器件类型配置同步设置,实际包括:

    • 确定同步方向(到工作区或到 PLM)。

    • 确定参与的器件类型,以及新器件的创建位置。

    • 配置参数映射。

     

  • 如适用,配置器件选择数据映射。

  • 执行同步。

上述前两项由连接的企业系统实例(如 PLM)所使用的配置文件负责。同步可在工作区界面的 PLM Integration 页面按需执行,或按计划执行,即在配置 PLM 实例连接时定义的周期性自动同步。

同步配置

在配置文件中,与企业系统实例的连接定义在 Instance 标签之间,包含指定的 Driver 类型与目标 URL。若通过配置生成器创建该配置文件,其中包含的 Driver 与 URL 引用即为生成过程中在 Configuration Generator 对话框中所输入的值。

<Instance>
    <Driver>[Driver Type]</Driver>
    <Url>[PLM API URL]</Url>
</Instance>
  • 当配置文件中指定 Arena® 驱动时,可额外添加一项用于适配 Arena 用户账户下的可用工作区。该可选的多位 ID 引用属性添加在 Instance 章节的 context 标签之间,示例如下:

    •  

      <Instance>
          <Driver>Arena</Driver>
          <Url>https:∕∕api.arenasolutions.com/v1/</Url>
          <Context>12345678</Context>
          <!-- If a workspace ID is not defined, the PLM instance will work with Arena's default workspace for that account. -->
          <!-- The server will report an error if another PLM synchronization session is attempting to use a second workspace from the Arena user account. -->
      </Instance>

       

     

  • 当连接的系统为 PTC Windchill PLM 时,可能需要添加一行配置,以启用对数值读取的度量单位:

    • <Instance>
          <Driver>Windchill</Driver>
          <Url>URL</Url>
          <EnableUOMRead>true</EnableUOMRead>
      </Instance>

     

在配置文件的 Schema 章节中为各专用器件类型定义同步映射。在工作区侧,这里的元件类型由 altiumType 指定。其取值来自 Altium Designer 的 Preferences 对话框中 Data Management - Component Types page 可见的类型参数选项。在 PLM 侧,依据 PLM 系统中的取值创建 plmType 类型的部件。

该章节在文件中以 Entity 声明,例如电容器的写法如下:

<Entity altiumType="Capacitor" plmType="Capacitor">
  .
  .
</Entity>

plmType 的取值可能因所使用的具体 PLM 实例而异。

Entity 内部,有两个部分用于控制和配置工作区到PLM实例以及PLM实例到工作区的同步,从而实现单向或双向同步。请结合示例配置文件中的注释,阅读以下部分以了解更多信息。最终,配置文件中定义的内容将根据您的具体需求以及已连接的企业系统实例中定义的(PLM)属性而有所不同。

定义部件选择数据映射的部分位于示例(或生成的)配置文件的末尾。

  • 配置文件中包含的 Parameters、Attributes 与 Values 对大小写敏感。

  • 除通用的主同步键(如 PlmPartNumber)外,不建议在同一配置文件的 ToAltiumToPlm 两个部分中同时包含相同的元件属性/参数。双向同步的执行顺序为先从 PLM 到 Altium,因此在这种情况下 PLM 数据会占主导。

  • 有关将企业系统与工作区集成的设置,请参阅示例配置与发布文件

Enterprise Server 在配合 Altium Project ReleaserComponent Sync 流程时,支持对现有 Arena PLM 条目的更新。这使得 Altium 侧新发布的项目与元件数据可以推送到 Arena 中 BOM 部件条目的工作修订(包括 PCBA、FAB 与 Component 数据)。

当使用 Project Release with Publish to PLM 流程将 Altium 项目发布到 Arena PLM 时,之前已发布的 Arena 项目 BOM 修订将被更新,且新增的子部件更新会链接到该父级。在此情况下,PLM 日志会包含一条警告,说明某个工作修订已被更新,并且对应的 BOM 已添加有效修订。

执行元件同步

元件(库)同步既可通过工作区 PLM Integration 页面上某 PLM 实例条目的 Sync 操作按钮手动执行,也可按实例设置中指定的自动周期定时执行。单击与要同步的 PLM 实例关联的  控件,同步过程将依据相关配置文件的设置,按 LibSync 工作流推进。

控件会变为停止状态  。如需停止同步,点击   控件;随后将出现确认窗口,点击确认即可取消同步——已完成同步的元件将保持不变,但之后不会再继续同步。

工作区与所指示的 PLM 实例之间的元件同步正在进行中。工作区与所指示的 PLM 实例之间的元件同步正在进行中。

同步只涉及自上次同步运行以来发生过修改的元件(其时间戳晚于上次同步日期),且需满足配置文件中的同步条件。这称为增量同步。

运行元件同步时,LibSync 过程会按其预定义的工作流推进直至完成或遇到错误。刷新浏览器(F5)可查看同步过程的当前状态。要监控或回顾 LibSync 过程,请选择 Synchronization status 选项卡并切换到 Closed 列表——若流程仍在运行,将显示在 Active 列表中。 按钮(仅管理员可用)可用于下载所有已列出的同步活动的详细记录,以逗号分隔的格式 (Synchronisation status.csv) 。

该视图的子选项卡提供以下信息:

  • Diagram – 流程工作流的图形表示,并高亮当前步骤位置(完成或错误/失败状态)。

  • Data – 流程动作的信息摘要,包括各步骤的成功/失败情况以及日志化流程报告的链接。

  • History – 按时间顺序列出的主要工作区同步事件日志。

LibSync 过程结果也可在 Process Management 页面(Admin » Processes)下的 Browser 选项卡中查看。

 

Data 子选项卡中所选 LibSync 事件的详情会包含该事件的系统日志文件链接(PLM [date-number].log)。

若某次 LibSync 过程失败,系统会创建一个 Handle errors 任务,并附带错误数据(含摘要信息与流程图)。当前活动任务可在 Tasks Management 页面中查看,路径为主菜单的 Tasks

计划同步

您也可以设置自动同步。方法是编辑该 PLM 实例(在主 PLM Integration 页面点击实例名称或其关联控件),选择 Component Synchronisation 选项卡并启用 Synchronize PLM Components with server on schedule。然后使用 Synchronize every 控件按需设置自动同步计划。系统提供灵活的选项,可:

  • 每 15/30/45/60/75/90 分钟执行一次同步。

  • 按每 x 小时执行一次同步。

  • 按每日在指定时间执行一次同步。

所定义的计划会在主 PLM Integration 页面 Sync scheduled 列中体现。

设置同步计划的界面。设置同步计划的界面。

要设置计划同步,您需要提供有效的 PLM 用户凭据。通常在创建 PLM 实例时已注册凭据;若尚未注册,点击   按钮,在随后出现的 PLM Credentials 窗口中输入 User namePassword。没有有效凭据时,计划同步将保持为 OFF,且也无法进行按需同步。

您亦可按需运行同步过程。点击   按钮并选择所需的同步模式:

  • Incremental – 仅包含自上次同步以来发生修改且符合配置文件同步条件的元件,并相应传播变更。此模式为默认模式,与主 PLM Integration 页面上为某 PLM 实例点击   控件所运行的模式相同。

  • Full – 强制执行完整同步。凡符合配置文件同步条件的元件均会被纳入同步,并相应传播变更。

流程工作流

为支持 PLM 集成,工作区提供以下流程定义(及其底层工作流):

这些流程定义不能直接激活并使用,它们更像“模板”。您需要根据公司需求进行编辑、命名并保存为新的流程定义,然后方可与该主题下其他定义一起激活与使用。

  • Part Requests 流程主题:

    • Part Request with PLM Part Create – 支持在您的 PLM 实例中自动创建元件,并将生成的部件编号回传到工作区元件。其工作流图示如下。

     

需要注意:当您基于该示例定义创建自己的流程时,必须指定要在哪个 PLM 实例中创建部件。在工作流图中选择 Create Part in PLM 实体,并在 PLM Instance 字段的下拉菜单中选择 PLM 实例。该菜单列出当前已定义的所有 PLM 实例(在界面的 PLM Integration 页面中定义)。

► 有关流程工作流的更多信息,请参阅 Creating and Managing Processes

  • Project Activities流程主题:

  • Publish to PLM (User selects) – 将已发布的托管项目输出发布到已集成的 PLM 实例,用户可以精确选择要发布的输出。其工作流图如下。

  • Project Releaser with Publish – 作为 Project Releaser 的附加阶段,将发布内容推送到已集成的 PLM 实例。其工作流图如下。

  • Project Creations流程主题:

    • Project with initialise in PLM – 支持在您的 PLM 实例中自动创建部件编号,并将这些编号作为工作区设计项目的参数进行传播。其工作流图如下。

     

访问与 PLM 相关的流程

下列部分说明在何处访问已激活的 PLM 相关流程。由于示例流程不能直接使用,以下条目基于示例流程定义创建,仅用于说明:

  • PR with PLM Part Create – 源自示例流程定义: Part Request with PLM Part Create.

  • Publish to Company PLM – Choose Data – 源自示例流程定义:Publish to PLM (User selects).

  • Project Releaser with Publish to Company PLM – 源自示例流程定义:Project Releaser with Publish.

  • Create Project with PLM Initialise – 源自示例流程定义:Project with Initialise in PLM.

注意:工作区管理员可以在工作区界面 Processes 区域内相应流程主题的选项卡中点击   控件,直接启动任何已激活流程定义的新实例。

元件申请

在 Altium Designer 中,可从 Explorer 面板、在 Manufacturer Part Search 面板Details 区域,或在 Components 面板的元件列表底部的链接处访问该流程。

在工作区界面中,可在 Part Requests 页面右上角点击   按钮访问已激活的流程定义。

项目活动

从 Altium Designer 发布到工作区的项目设计数据,可以通过工作区的 Publish to PLM 流程以受控方式推送到 PLM。工作区流程定义了发布活动的接口与方法,而指定的 XML Publishing Template定义了文件数据如何传播到目标 PLM 系统。

有关发布流程的更详细信息,参见 Publishing to a PLM

标准发布流程

在设计端,可在 Altium Designer 的 Project » Project Activities 子菜单中访问活动项目的标准 Publish to PLM 流程。

与项目相关的流程也可通过 Projects 面板中设计项目条目的右键 Project Activities 上下文子菜单访问。

在工作区界面中,可在 Project Management 视图中点击   按钮访问已激活的流程定义。

通过 Project Releaser 进行发布

作为 Project Releaser 的一部分,发布到 PLM 实例的流程可在 Altium Designer 的 Project » Project Releaser 子菜单中访问。

与发布相关的流程也可通过 Projects 面板中设计项目条目的右键 Project Releaser 上下文子菜单访问。

打开 Project Releaser 后,会出现一个附加阶段——7: Publish to PLM。此外,在   按钮关联的菜单中提供了一个命令 Prepare & Release & Publish to PLM,用于在不暂停审阅生成数据与执行报告的情况下直接运行 Project Releaser。

如果您以标准 Prepare 命令运行 Project Releaser,在审阅并发布数据后,将在 Execution Report 阶段呈现   按钮。点击该按钮可继续流程的底层工作流,将数据发布到 PLM。此时会出现 Login Credentials 对话框;输入该 PLM 实例的 UsernamePassword,并选择要使用的 PLM Template(呈现形式为 <PLMInstance>:<PublishingTemplate>)。

如果选择 Prepare & Release & Publish to PLM 命令,则会直接呈现 Login Credentials 对话框;Project Releaser 不会在 Execution Report 阶段暂停,也不会呈现   按钮。

注意:该 PLM 实例的登录凭据仅在首次发布至该实例时需要,随后会存储在已连接的工作区中。之后再次将该项目发布到同一 PLM 实例时,将根据已定义的工作流与所选发布模板直接执行。

点击 Diagram 选项卡可查看该流程的底层工作流。

点击   按钮即可按照该工作流推进发布流程。

若您首次发布,且项目的托管信息尚未与 PLM 侧的部件编号建立关联,则这些部件编号会在 PLM 中创建,并在初次发布中关联到该项目。您也可以在发布操作中为工作区中的元件在 PLM 实例中定义元件条目,以在 PLM 中获得一份元件 BOM(可选,取决于发布到该 PLM 实例时所定义并使用的发布模板)。

在工作区界面中打开该项目的详细视图,选择 Activities 视图检查发布到 PLM 的流程状态。选择 Opened 查看流程运行中的状态,选择 Closed 查看流程完成后的状态信息。

 

在流程工作流的 Data 选项卡下,您可以看到创建内容的详细信息,例如在 PLM 实例中创建的部件编号。

项目创建

在设计端,可在 Altium Designer 的 File » New » Project in <workspace>子菜单中访问。

在工作区界面中,可在 Projects 视图中点击   按钮访问已激活的流程定义。

在克隆项目时,也可通过 Projects 视图中的  菜单按钮访问。

流程工作流将继续,系统会显示一个对话框,让您定义项目的 名称、描述、类型,以及在创建时应使用的 Project Template Item。点击 Start 后,会出现 Login Credentials 对话框;输入该 PLM 实例的 UsernamePassword,并选择要使用的 PLM Template(呈现形式为 <PLMInstance>:<PublishingTemplate>),然后点击 Submit 以继续工作流。

相关部件编号会在您的 PLM 实例中自动创建,并回传到工作区作为项目参数。这些参数可作为特殊字符串使用——在设计编辑器中选中已放置的文本字符串时,可在 Properties 面板访问。项目的工作区服务器参数也可在 Project Options 对话框的 Server Parameters 选项卡(Project » Project Options)中查看。

 

AI-LocalizedAI 翻译
如您发现任何问题,请选中相关文本/图片,并按 Ctrl + Enter 键向我们提交反馈。
功能可用性

您可使用的功能取决于您所选择的 Altium 解决方案 —— Altium DevelopAltium Agile(Agile Teams 或 Agile Enterprise 版本),或仍在有效订阅期内的 Altium Designer。

如果您在软件中未找到文中提及的功能,请联系 Altium 销售团队了解更多信息。

Content