工作区项目

您正在阅读的是 6.0. 版本。关于最新版本,请前往 工作区项目 阅读 8.0 版本
 

Parent page: Altium On-Prem Enterprise Server

Altium Designer 与 Enterprise Server Workspace 结合使用,可为 Workspace Projects 提供支持。Workspace 项目面向项目生命周期中的开发阶段,简化了受版本控制项目的创建与持续工作流程。由 Workspace 控制的集中式存储也使该功能能够作为其他协作服务的基础。

使用 Workspace 项目的一些关键优势包括:

  • 存储更简化。无需再决定存储位置。备份及其他基础服务都已处理妥当。
  • 为协作功能提供基础。
  • 强制版本控制。
  • 专用评论系统的优势。
  • 通知与状态。包括本地修改在内的文档状态对整个设计团队可见。
  • 并发 PCB 设计无需任何复杂设置。
  • 可通过 Web Viewer 与其他用户共享项目的只读、基于浏览器的交互式视图。
  • 一系列高级版本控制功能,例如交互式 Project History view

从技术角度看,Workspace 项目是存储在 Enterprise Server Workspace 上的元信息与 Workspace 自有的 Version Control service 的紧密集成组合。典型工作流程如下:

  1. 用户可通过 Altium Designer 的 Create Project 对话框 创建新的 Workspace 项目,也可通过 Make Available On Server 对话框将 现有本地项目转换 为 Workspace 项目,或在 Workspace 浏览器界面中创建(详见下文)。创建过程中,用户需要定义项目名称、描述以及设计仓库。
  2. 项目访问权限可在 Workspace 的浏览器界面中定义与管理,也可直接在 Altium Designer 中管理。
  3. 所有协作者选择打开该项目(可在 Altium Designer 内或在 Workspace 浏览器界面中操作)后,项目会自动以设计文件形式被检出。
Workspace 项目的一个主要优势是默认启用版本控制,并且可进行协同开发,无需再担心共享盘、服务器、约定等问题。

在创建新的 Workspace 项目或将现有本地项目提供给 Workspace 之前,请确保已存在用于存储该项目及未来所有项目的设计仓库。设计仓库作为 Enterprise Server Workspace 的一部分,通过其 Version Control 服务进行集中管理。全新安装的 Altium On-Prem Enterprise Server 会提供一个基于 Git 的设计仓库——Versioned Storage——用于容纳你的所有 Workspace 设计项目。

如果你是从更早的服务器产品(例如 Altium Vault 3.0)升级到 Altium On-Prem Enterprise Server,那么也会启用 SVN 仓库的使用,以便你继续沿用之前(且已建立)的设计流程。在这种情况下,你可以通过 Workspace 的 Version Control 服务(仅 SVN)创建额外仓库,或连接到外部仓库(SVN 或 Git)。

本文将介绍如何通过 Enterprise Server Workspace 的浏览器界面来处理项目。关于在设计软件中处理项目的信息,请参阅 Getting Familiar with the Altium Design Environment

创建新的 Workspace 项目

创建 Workspace 项目有多种方式:

要通过 Workspace 的浏览器界面直接创建 Workspace 项目:

  1. 登录界面并选择 Projects 菜单选项以进入 Designs 页面。此前创建的任何项目都会在此列出。
  2. 点击页面顶部的 按钮,然后选择 Create Project 菜单选项以打开 Create Project  窗口。

    如果存在任何针对“Project Creations”流程主题的活动 process definitions(在 Workspace 浏览器界面的 Processes 页面之 Project Creations 选项卡中定义),则 按钮菜单会以这些流程选项替代 Create Project 选项。选择所需条目以调用该流程工作流。
  3. 该窗口初始会以简化视图显示。输入所需的项目名称、描述(如需要),并从 Templates 下拉菜单中选择合适的 Project Template

    项目名称应以 A-Z、a-z 或 0-9 开头,并且可包含 A-Z、a-z 或 0-9。允许使用下划线、短横线和空格,但空格只能用于名称中间(开头和结尾的空格将被忽略)。不能使用以下词语:AUXCOM1-COM9LPT1-LPT9CONNULPRN。此外,名称不能包含以下字符:\ . / ? % * : | " < >
  4. 要访问更多控件,请点击 按钮。将显示以下字段:
    1. Parent Folder——用于指定在 Workspace 文件夹结构中创建项目文件夹的位置。默认值为 Projects\<ProjectName>。新项目的默认路径在 Workspace 的 Admin – Settings – Projects 页面中指定(位于 Workspace 的 browser interface)。
    2. Repository——此字段会列出通过 Workspace 本地 Version Control 服务管理、并已共享给你使用的所有设计仓库。选择用于存储新项目及其文件的仓库。默认会选择 Versioned Storage(基于 Git)的仓库。

      如果你从旧的服务器技术升级到 Enterprise Server,并仍可使用内部(SVN)和/或外部(SVN/Git)设计仓库,则会显示 Repository 字段。该字段列出通过 Workspace 本地 Version Control 服务管理、并已共享给你使用的所有设计仓库。选择用于存储新项目及其文件的仓库。如果选择基于 SVN 的仓库,则会显示 Repository Folder 字段。使用该字段指定仓库内用于容纳该项目及其相关文件的文件夹名称。默认将采用项目名称。

通过 Workspace 的浏览器界面直接定义新的 Workspace 项目。
通过 Workspace 的浏览器界面直接定义新的 Workspace 项目。

按需定义新项目后,点击  ——新项目将被创建。随后会返回到摘要级项目列表,此时你将看到新创建项目的条目。

通过浏览器界面创建的另一个 Workspace 项目。
通过浏览器界面创建的另一个 Workspace 项目。

项目初始会以读/写权限共享给创建该项目的设计人员以及 Administrators 角色组中的所有成员。同时也会共享给所有 Workspace 用户,但仅提供只读权限。关于配置项目访问权限的更多信息,请参阅 Sharing a Workspace Project

浏览 Workspace 项目

Workspace 浏览器界面中 Projects 页面的项目列表包含所有已与你共享的项目,并提供一系列控件以访问项目管理功能。使用  按钮将页面切换到项目预览(图形磁贴)模式,使用 按钮将页面切换到详细列表模式。

Workspace 浏览器界面的 Designs 页面——处理 Workspace 项目的指挥中心。此处显示的是页面的详细列表模式。将鼠标悬停在图像上可查看项目预览模式。
Workspace 浏览器界面的 Designs 页面——处理 Workspace 项目的指挥中心。此处显示的是页面的详细列表模式。将鼠标悬停在图像上可查看项目预览模式。

视图中的项目条目会按 Last modified 日期自动排序,最近修改的项目会最先显示在列表中。点击 按钮可改为按项目名称排序,再次点击可在升序与降序之间切换。

列表模式视图()可通过各列标题按 NameAuthorDate 排序。点击一次按升序排序,再次点击按降序排序。列名右侧的箭头会指示当前启用的排序方向。

Projects 视图会在右侧边栏窗格中提供与所选项目相关的 PropertiesActivities 数据。

 

边栏窗格信息包括:

  • Properties 选项卡:
    • Project——项目状态的高层摘要,包括电路板的 3D 视图(当该项目包含 PCB 时)。
    • Shared With ——可访问该项目的用户和/或角色。将鼠标悬停在条目上可查看用户/角色的全名。
    • Parameters ——从项目设计本身提取或计算得到的详细元数据。点击 Show More 控件可展开完整列表。
    • Where Used——包含该项目内容的其他项目列表,例如 Multi-board projects。点击某个条目会在新的浏览器标签页中打开并查看该项目。
    • Releases – 按时间顺序排列的项目发布列表。单击某个条目可在工作区的 Manufacturing Portal 中打开该发布。
  • Activity 选项卡 – 按时间顺序列出项目事件,例如 Commit、Release,或与该项目相关的已完成流程工作流。

对于每个项目,视图顶部的按钮还提供以下操作(并在后续链接章节中详细说明):

  •  Share – 用于配置项目访问权限的访问控制。
  • Functions – 访问项目功能的菜单。在预览模式下,也可通过所选项目的 按钮访问:
    • Open – 在以 CAD 为中心的详细视图中打开项目。等同于(预览模式下)单击或(列表模式下)双击项目名称条目。
    • Move – 将项目重新定位到工作区文件夹结构中的另一个父文件夹。
    • Edit – 从 NameDescription 以及工作区 Parameters 等方面编辑项目。
    • Clone – 创建一个重命名的、与原项目完全相同的副本。
    • Watch/Unwatch – 通过在项目的 Activitiy 选项卡中接收相关通知(更新、发布等),以及在启用 Email Notifications 时通过电子邮件接收通知,来关注/取消关注项目活动。
    • Delete – 通过将其结构和数据移动到工作区 Trash 来移除项目条目;之后可从工作区 中永久删除,或恢复到之前状态。

此外还包含一个项目 Search 功能,可按名称、作者、描述等一系列属性筛选项目列表。在浏览器界面顶部的字段中输入搜索字符串的任意部分,列表将更新为仅包含属性中包含该搜索字符串的项目条目。

要清除搜索筛选,可单击左侧导航窗格中的主 Projects 页面条目,或清空搜索字段并按下 Enter

搜索功能的示例用法:此处根据 Description 查找项目。

使用工作区文件夹

工作区还提供在其结构内创建和管理项目文件夹的能力。随后可在生成的文件夹层级结构中的任意文件夹内创建项目,或将项目移动到其中。

要在(默认)顶层 Project 文件夹下创建新文件夹,请从  按钮菜单中选择 Create Folder 选项。在随后出现的 Create Folder 窗口中,指定新文件夹名称、其父文件夹以及可选描述。新文件夹始终创建在当前选中的文件夹下,该文件夹将成为其父文件夹。

通过选择文件夹标题打开已创建的文件夹,并使用上方的面包屑导航返回上级层级。

使用 菜单选项可修改文件夹详细信息(Edit)、将文件夹重新定位到不同的父文件夹下(Move),或从工作区文件夹结构中移除该文件夹(Delete)。移动文件夹时,在 Move folder <folder> to 窗口的层级树中选择新的父文件夹。

上传项目

在 Altium Designer 中,Make Available on Server 命令会将本地项目上传到工作区,使其成为受版本控制的工作区项目。在工作区浏览器界面中,也可通过  按钮菜单中的 Upload Project 选项执行等效流程。浏览并选择本地项目的宿主文件夹,即可默认将该项目上传到当前选中的工作区文件夹;或者在 Upload Project 窗口的 Parent Folder 列表中使用 Change 选项,在文件夹层级结构中选择其他位置。

本地项目中任何现有的版本控制链接都会被忽略;上传后的项目将成为完全受版本控制的 工作区项目 – 本地源项目不会以任何方式被更改。

移动项目

要将项目重新定位到不同的工作区文件夹,请从 菜单下拉选项中选择 Move,并在 Move project <project> to 窗口的文件夹层级结构中选择新位置。通过 按钮确认后,所选项目将托管在新指定的父文件夹下。

共享工作区项目

当项目位于工作区中后,你需要确定哪些用户可以实际访问该项目。这通过共享项目来完成,更准确地说,是通过配置其访问权限。默认情况下,工作区项目会与以下对象共享:

  • 项目的 Owner,通常是创建该项目(或将其发布到工作区)的设计人员:完全(Read/Write)访问权限。
  • Administrators 角色组:完全(Read/Write)访问权限。
  • 工作区的所有成员:仅查看权限。

新项目的默认权限可在工作区浏览器界面的 Admin – Settings – Projects 页面中定义/更改。请注意,项目 Owner 天生就被赋予访问权限,因此不会出现在列表中。

访问权限的配置既可通过工作区的浏览器界面完成,也可 直接在 Altium Designer 内 完成。

要在工作区浏览器界面中配置项目访问权限,请在 Designs page(主菜单中的 Projects)上选择项目条目,然后单击  按钮以打开 Share:<project> 窗口;或使用与项目条目关联的 菜单中的 Share 选项。这里提供了将项目共享给其他用户或用户组(Roles)所需的全部控制项。

 当项目在工作区中集中管理后,与他人共享只需管理每个项目的权限即可。

Share <project> 窗口中:

  • 当启用 Can Edit 选项时,用户/角色拥有 Read/Write 访问权限;若禁用该选项,则仅有 Read 访问权限。
  • 可通过 Shared With 区域中 Workspace Members 条目的下拉菜单,将项目共享给工作区所有成员,并设置为只读(Can View)或读写(Can Edit)访问。
  • 要移除某个现有用户/角色对项目的共享访问权限,请在关联的下拉菜单中单击 Remove 选项。

需要注意的事项:

  • 默认情况下,所有工作区用户都能看到该项目。如果你希望将访问权限锁定为特定用户和/或用户组,必须先在 Workspace Members 条目的下拉菜单中选择 No access 。
  • 项目 Owner 永久拥有 Read/Write 访问权限。
  • 你也可以共享项目的直接链接。该链接可在 Sharing 窗口底部单击 Copy Link 控件获取。链接会被复制到剪贴板。使用该链接时,会在权限允许的情况下,为相应用户提供对项目详细管理页面的访问;该页面概览见 下一节
请注意,当项目在 Design View 中打开时,你也可以指定项目共享。

Workspace 项目活动

Workspace 提供一项独特能力:可对 Workspace 项目应用可配置的 Process Workflows,以执行定制化任务,例如进行设计评审和创建新项目。流程及其底层工作流由 Workspace 管理员创建并配置,启用后,将同时对 Altium Designer 和 Workspace 浏览器界面的用户可用。

► 更多信息请参阅 Creating & Managing Processes
► 关于这些流程在 Altium Designer 中的使用信息,请参阅 Performing Design Reviews

从用户角度看,Process Workflows 及其内在步骤被视为 Activities。用户可以发起可用活动,而被分配的用户可按任务序列完成其工作流步骤——这些任务可在 Tasks page 中获取。

Designs 页面(Projects)上选择 菜单,并从可用的 Processes 中选择一个,以为当前所选项目发起活动。在随后出现的流程表单窗口中填写所需字段和选项,然后启动流程()。根据所调用的 Process Workflow,可能还需要提交后续步骤()以准备评审数据。

随后会为被分配到该活动的一个或多个用户创建工作流任务。适用于当前登录用户的任务将显示在 Tasks page 中,用户可对其进行处理以将工作流推进到下一阶段。

请注意,如果某个活动被分配给一个角色组——例如 Engineers——则相关任务将对该组的所有成员可用,同时也对被单独分配到该活动的任何用户可用。在这种情况下,这些用户中的任何一位都可以完成评审步骤并提交结果()。

除了在活动准备期间可为其分配用户和组之外,还可以在 Process Workflow 配置本身中加入特定分配,从而使活动在准备之前就天然分配给特定用户/组。例如,可在 AdHoc_Review 工作流中将 Engineers 组预设为一个分配项。

► 更多信息请参阅 Defining a Process Workflow

Workspace 项目功能

与项目相关的功能操作可从 Designs page 上的 菜单中获取,包括打开、移动、编辑、克隆、关注以及移除 Workspace 项目。该菜单也可从所选项目条目的 按钮访问:

打开项目

从项目条目的 菜单或上方的 菜单中选择 Open 选项,以在面向制造、以 CAD 为中心的视图中打开项目——或者在预览模式()下,单击项目名称。该视图可通过导航窗格访问多个子视图:

  • Design – 浏览并与项目的设计文档交互、检查对象属性并放置评审评论。该视图适用于当前(最新)项目修订版,并使用 Web Viewer 界面。
  • Tasks – 查看并与一种流程型界面交互,该界面呈现适用于当前项目的所有 Tasks(活动作业)。
  • Releases – 查看当前项目所有 Releases 的摘要信息,每个 Release 都可在 Manufacturing Portal view 中打开。该视图进一步提供所选发布包中的文件、设计文档和供应数据等子视图。
  • Activities – 查看适用于当前项目的活动或已关闭的 Process workflow Activities
  • History – 浏览与项目相关的主要事件的渐进式时间线,包括创建、提交、发布和克隆。每当与项目相关的受支持事件发生时,该事件都会以专用磁贴的形式添加到时间线中,并在适用时支持多种操作(例如设计数据对比)。
在 Altium Designer 中,通过在 Projects panel 里右键单击某个项目条目并选择 Show in Web Browser 命令,可打开 Workspace 的 CAD-centric 项目视图。

► 更多信息请参阅 Management of a Specific Project

编辑项目

要编辑 Workspace 中现有项目的属性,请在 Designs 页面(Projects)上选择该项目条目,然后从其 菜单或上方的 菜单中选择 Edit 选项。在随后出现的 Project Editing 窗口中,你可以更改项目的 NameDescription,并管理 Workspace Parameters 条目。

Project Editing 窗口中单击 按钮,以显示从项目派生并随项目存储的附加属性数据。选择 Parameters 控件以访问并添加()、编辑或移除()参数 Name/Value 键值对。这些参数会与项目一起保存在 Workspace 中,并可在 Altium Designer 中作为 Special Strings 使用——在设计空间中选中已放置的文本对象后,可从 Properties panel 访问。相比之下,Project type 参数保存在项目文件(*.PrjPcb)中,并可在 Altium Designer 中编辑。

克隆项目

要克隆(复制)现有 Workspace 项目,请在 Designs 页面(Projects)上选择该项目条目,然后从其 菜单或上方的 菜单中选择 Clone 选项。使用 Clone Project 窗口为克隆项目设置名称和描述——默认情况下,将使用原项目名称并附加 - Copy 后缀。

单击 按钮以显示附加属性字段,其中包括目标父文件夹和 Repository 信息。目标文件夹设置会自动与项目名称一致,除非手动指定,或通过 Change 选项分配到不同的现有父文件夹。

 如果针对 Project Creations 流程主题存在任何可用的活动 process definitions(在 Workspace 浏览器界面的 Processes page 的 Project Creations 选项卡中定义),则 菜单将提供与可用流程工作流相对应的 Clone – process name 选项。

选择后,将使用该流程所定义的工作流来执行克隆过程。

在 Altium Designer 中,可通过 Explorer panel 的  菜单中的 Clone 选项克隆项目,或在 Projects panel 中右键单击项目名称并从上下文菜单中选择 Clone 选项。

按需设置字段后,单击 按钮确认。原项目将连同其组成文件和数据一起被克隆(复制),并作为新的项目条目添加到 Projects 页面列表中。

关注项目

要在 Workspace 中“关注”(接收通知)项目,请在 Designs 页面(Projects)上选择该项目条目,然后从其 菜单或上方的 菜单中选择 Watch 选项。

当你关注(watch)某个项目时,你将在界面右侧窗格的 Activities 选项卡下收到与该项目相关的通知(例如提交、发布以及属性更改消息)。项目创建者会被自动设置为关注该项目。启用后,该命令将变为 Unwatch——选择后将停止关注该项目,并停止接收与该项目相关事件的通知。

如果已配置并启用 Workspace Email NotificationsAdmin – Settings – Email Notifications),通知也会发送到你的电子邮箱。

► 更多信息请参见 Configuring Email Notifications

删除 Workspace 项目

要删除(移除)现有的 Workspace 项目,请在 Designs 页面(Projects)中选择该项目条目,然后从其 菜单或上方的 菜单中选择 Delete 选项。该操作本质上是“软删除”,即将项目仓库移动到 Workspace 的 Trash 区域。也可以在 Altium Designer 中通过 Explorer 面板里的  菜单 Delete 选项来删除项目。

在该视图中(从主菜单选择 Trash),可以将项目条目彻底移除(Permanently Delete)或撤销该操作(Restore)。请注意, 按钮会移除存储在 Workspace 回收站中的所有条目(在可能的情况下)。

  • Delete 选项仅对拥有所选项目写入权限(Write permission)的用户可用。
  • 此操作会使该项目在 Workspace 中不再存在。它只会从 Workspace 中移除——不会影响你的本地工作副本。
AI-LocalizedAI 翻译
如您发现任何问题,请选中相关文本/图片,并按 Ctrl + Enter 键向我们提交反馈。
Content