Главная страница: Объекты сервера
Altium Designer в сочетании с сервером управляемых данных позволяет создавать объекты управляемых шаблонов проектов (Project Template Item) и управлять ими на этом сервере. Такие объекты могут быть созданы с помощью прямого редактирования.
После того, как объект шаблона проекта был создан (и в его ревизию были выпущены данные) и его состояние жизненного цикла задано на том уровне, при котором этот объект можно использовать при проектировании, объект можно повторно использовать при создании проектов.
Объекты Project Template Item могут быть созданы для любых типов проектов, поддерживаемых Altium Designer.
Управляемые шаблоны проектов, сохраненные на сервере, могут включать в себя документы и файлы, составляющие проект, а также дополнительные справочные документы и файлы настроек.
Кроме того, объект управляемого шаблона компонента можно использовать как объект данных конфигурации в одной или нескольких заданных конфигурациях среды (Environment Configurations). Конфигурация среды используется, чтобы ограничить рабочую среду средства проектирования Altium NEXUS использованием только утвержденных компанией проектных элементов. Конфигурации среды определяются и хранятся в Team Configuration Center – службе, которая устанавливается вместе с NEXUS Server и которая отвечает за концепцию управления конфигурацией среды.
Тип папки
При создании папки, в которой будут храниться объекты Project Template Item, вы можете указать тип этой папки. Это не имеет отношения к содержимому папки – выпуск проекта в качестве шаблона всегда осуществляется в соответствующий объект Project Template Item. Таким образом вы лишь обеспечиваете визуальную подсказку о том, что хранится в папке, что может быть полезными при поиске определенного содержимого на сервере. Чтобы указать, что папка используется в качестве контейнера для объектов Project Template Item, задайте ее тип (Folder Type) как Project Templates при определении свойств папки в диалоговом окне Edit Folder.
Определение типа папки, т.е. ее планируемого использования, предоставляет визуальную индикацию содержимого этой папки при просмотре данных на сервере.
Схема именования объектов
Другим важным аспектом родительской папки является используемая для нее схема именования объектов (Item Naming Scheme), которая определяет формат уникального идентификатора каждого объекта, создаваемого в этой папке. Доступны несколько примеров схем по умолчанию, использующих краткий код для папок каждого типа (PRJT для шаблонов проектов) или для содержимого каждого типа (PRJT для шаблона проектов):
$CONTENT_TYPE_CODE-001-{0000} – например, PRJT-001-0001.$CONTENT_TYPE_CODE-001-{A00} – например, PRJT-001-A01.$FOLDER_TYPE_CODE-001-{0000} – например, PRJT-001-0001.$FOLDER_TYPE_CODE-001-{A000} – например, PRJT-001-A001.
Используя схему именования по умолчанию, система автоматически назначит следующий уникальный идентификатор на основе этой схемы, просканировав весь сервер и идентификаторы существующих объектов. Это может значительно сэкономить время при создании объектов шаблонов проектов вручную.
Для папки также можно определить пользовательскую схему путем ее ввода в поле, с переменной частью в фигурных скобках (например, PRJ-TMP-{0000}).
Схема именования объектов родительской папки применяется к уникальным идентификаторам всех объектов, которые создаются в этой папке.
Схему Item Naming Scheme, примененную к родительской папке, можно в любой момент изменить. Измененная схема будет применяться ко всем создаваемым далее в этой папке объектам.
Тип объекта
При создании целевого объекта Project Template Item, в котором будет храниться проект, убедитесь, что в диалоговом окне Create New Item определен соответствующий тип содержимого этого объекта (Content Type) определен как Project Template. Если вы создаете объект в папке с типом Project Templates, то объект этого типа будет доступен в контекстном меню при создании объекта.
Создание объекта Project Document Template Item в папке Project Templates. Нужный тип содержимого (Content Type) доступен в контекстном меню.
Определение жизненного цикла и именование ревизий
При определении объекта Project Template Item убедитесь, что указан тип управления жизненным циклом для его использования с этим объектом и схема именования ревизий этого объекта.
Управление тем, какие типы объектов могут использовать конкретное определение жизненных циклов или схему именования ревизий, осуществляется на глобальном уровне в диалоговом окне Content Types, при определении схемы. Схемами по умолчанию, которые назначаются объекту Project Template Item, являются Generic Lifecycle и 1-Level Revision Scheme.
После того, как файл был выгружен в начальную ревизию объекта Project Template Item, эти схемы не могут быть изменены для этого конкретного объекта.
Укажите нужные схемы в диалоговом окне Create New Item с помощью полей Lifecycle Definition и Revision Naming Scheme соответственно.
Если включен параметр для управления использованием определений жизненных циклов и схем именования ревизий по типу содержимого и для типа Project Template Item не задано использование конкретного определения/схемы, то это определение/схема будет не доступно в соответствующем выпадающем списке.
Выбор определения жизненного цикла и схемы именования ревизий для создаваемого вручную объекта.
Придерживаясь стандартных схем именования ревизий и определений жизненных циклов для различных типов проектных объектов на сервере управляемых данных, вы обеспечите понятное и надежное управление этими объектами.
Хорошей идеей является добавление названия и описания в определение объекта. Эта информация используется при поиске на сервере и позволяет быстро идентифицировать, что предлагает тот или иной объект Project Template Item.
Выпуск проекта в качестве шаблона
До сих пор рассматривалась поддержка сервером объекта Project Template Item с точки зрения соответствующих типов папки и объекта. Выгрузка существующего проекта в ревизию такого объекта может быть выполнена несколькими способами.
Прямое редактирование
Проект может быть отредактирован и выпущен в начальную ревизию нового объекта Project Template Item с помощью прямого редактирования, поддерживаемого сервером. Прямое редактирование избавляет от ограничений отдельных исходных данных под контролем версий. Вы можете просто изменить объект поддерживаемого типа с помощью временного редактора, в который загружена самая новая версия исходных данных непосредственно с сервера. По завершении редактирования, сущность выпускается (или выпускается повторно) в последующую запланированную ревизию родительского объекта, и временный редактор закрывается. Нет файлов на вашем жестком диске, не нужно задаваться вопросом о том, работаете ли вы с корректными и самыми новыми данными, нет необходимости в обслуживании отдельного программного обеспечения для контроля версий. Всем этим управляет сервер, с высокой степенью целостности, для значительного ускорения внесения изменений в данные.
После создания объекта Project Template Item вы можете изменить и выпустить проект в начальную ревизию этого объекта. Для этого включите параметр Open for editing after creation в нижней части диалогового окна Create New Item (параметр включен по умолчанию). Объект будет создан, и его начальная ревизия будет открыта в качестве редактируемого проекта в панели Projects (под записью сервера управляемых данных, к которому вы в данный момент подключены). Проект будет назван в соответствии с ревизией объекта, в формате <Объект><Ревизия> (например PRJT-0002-1).
Пример редактирования начальной ревизии объекта Project Template Item непосредственно с сервера управляемых данных. Временный редактируемый проект открыт в панели Projects для добавления в него документов и его настройки.
Задайте содержимое и настройки проекта необходимым образом, что его можно было использовать в качестве шаблона для будущих проектов.
При подготовке проекта к выпуску на сервер в качестве управляемого шаблона проектов следует отметить, что все главные файлы в этом проекте станут исходными файлами в шаблоне проекта. Это, в том числе, все проектные документы и объекты, которые содержатся в них, и прочие файлы, которые находятся в папке проекта, включая все общие неиспользуемые файлы. Поэтому стоит уделить время на проверку и настройку исходного проекта, чтобы итоговый шаблон проекта включал в себя только файлы, содержимое и настройки, необходимые для этого шаблона.
Преимуществом этого подхода является то, что шаблон при необходимости может содержать в себе полный набор общих проектных файлов (в том числе файлы Output Job) и утвержденные настройки проекта/документов, правила проектирования, параметры, настройки единиц измерения, основные надписи документов, настройки сеток и многое другое.
Документы, которые были сохранены в процессе редактирования шаблона, располагаются во временном хранилище, и они будут корректно включены в выпущенную ревизию шаблона.
Автоматизированное именование документов
Полезной возможностью, которая доступна в Altium Designer при использовании шаблона для нового проекта, является автоматизированное именование входящих в шаблон документов. Для этого включите строку [ProjectName] в названия документов шаблона. Она будет заменена на указанное название проекта при использовании этого шаблона для нового проекта.
Например, если документ схемы в шаблоне проекта назван [ProjectName].SchDoc и затем этот шаблон используется для нового проекта под названием Flux_Triangulator, то документ схемы, созданный в проекте будет назван Flux_Triangulator.SchDoc. Обратите внимание, что с этой строкой могут быть добавлены другие символы, и например, документ шаблона [ProjectName]_Top-Level-Structure.SchDoc станет проектным документом под названием Flux_Triangulator_Top-Level-Structure.SchDoc в новом проекте, который был назван Flux_Triangulator.
Чтобы использовать эту возможность при создании шаблона проекта, задайте соответствующие названия документов (при сохранении) перед выпуском проекта на сервер в качестве шаблона проекта (или если он лишь сохраняется локально). Либо откройте ревизию существующего объекта Project Template Item и измените названия документов, чтобы они включали в себя строку [ProjectName], и выпустите его на сервер в следующую ревизию этого объекта.
![Пример проекта, подготовленного в качестве шаблона, где используется строка [ProjectName] для автоматизированного именования документов, когда этот шаблон будет повторно использоваться.](/documentation/sites/default/files/wiki_attachments/301268/MCS_PRJTemplates_DefinedProjectwithAutomatedNaming_20_0.webp "Пример проекта, подготовленного в качестве шаблона, где используется строка [ProjectName] для автоматизированного именования документов, когда этот шаблон будет повторно использоваться.")
Пример проекта, подготовленного в качестве шаблона, где используется строка [ProjectName] для автоматизированного именования документов, когда этот шаблон будет повторно использоваться.
При прямом редактировании есть три элемента управления, доступные в контекстном меню записи проекта в панели Projects:
- Save Project (Сохранить проект) – используйте эту команду, чтобы сохранить все изменения проекта. Это позволит вам сохранить текущие изменения и позже вернуться к внесению дальнейших изменений перед выпуском на сервер управляемых данных.
- Release to server (Выпустить на сервер; сочетание клавиш Ctrl+Alt+S) – используйте эту команду, чтобы выпустить (по сути, сохранить и выпустить) проект на сервер управляемых данных в начальную (запланированную) ревизию целевого объекта Project Template Item. Будет открыто диалоговое окно Edit Revision, в котором вы можете изменить название и описание и добавить информацию о выпуске. После выпуска проект будет закрыт. Проект и все связанные исходные файлы будут сохранены в ревизию объекта.
- Cancel Edit (Отменить редактирование) – используйте эту команду, если вы хотите отменить редактирование. Проект будет закрыт, и в целевой объект Project Template Item ничего не будет выпущено.
Выпущенные данные, которые хранятся на сервере, состоят из самого файла проекта, файла структуры проекта и всех связанных исходных файлов. В панели Explorer, переключитесь на вкладку аспектного вида Preview, чтобы увидеть файлы шаблона.
Просмотр выпущенной ревизии объекта Project Template в панели Explorer. Переключитесь на вкладку аспектного вида Preview, чтобы увидеть файлы шаблона.
Отправка на сервер существующего проекта в качестве шаблона
Хотя прямое редактирование является предпочтительным подходом для большинства проектных объектов, которые хранятся на сервере управляемых данных, вы также можете отправить непосредственно на сервер существующий проект, который необходимо использовать в качестве шаблона. Для этого нужна запланированная ревизия существующего объекта Project Template Item, в которую этот проект будет выпущен. Процесс выглядит следующим образом:
- Создайте новый объект Project Template Item и его начальную запланированную ревизию либо создайте запланированную ревизию другого, существующего объекта.
- Откройте существующий проект в Altium Designer и откройте один из его исходных документов в качестве активного документа проекта.
- Внесите необходимые изменения, чтобы подготовить проекта для его использования в качестве шаблона. Может быть хорошей идеей создать отдельный проект и задать его содержимое и настройки специально для его использования в качестве шаблона проекта, но это не обязательно. Вы можете взять полностью заданный существующий проект и продолжить работу с ним, а отредактировать его настройки и содержимое позже.
- Выберите команду Project » Send to server as template из главного меню.
- Будет открыто диалоговое окно Select or create project item for release. Используйте его, чтобы выбрать целевую ревизию нужного объекта Project Template Item (которая должна быть в состоянии
Planned).
Если целевого объекта Project Template Item не существует, вы можете создать его на лету с помощью диалогового окна Select or create project item for release. В этом случае, отключите параметр Open for editing after creation (в диалоговом окне Create New Item), иначе вы перейдете в режим прямого редактирования.
- После нажатия OK, проект будет выпущен и сохранен в ревизию объекта.
Пример отправки существующего проекта на сервер управляемых данных, в который вы вошли. Выпуск должен быть осуществлен в существующую ревизию объекта Project Template Item, которая должна быть в состоянии Planned.
Повторное использование объекта Project Template Item
Связанная страница: Управление доступом к данным на сервере
После того, как шаблон проекта был выпущен на сервер управляемых данных и состояние его жизненного цикла было задано на том уровне, при котором его можно использовать на уровне проекта, этот шаблон можно повторно использовать при создании проектов плат.
Из Altium Designer
Когда вы вошли на сервер управляемых данных, использование доступных объектов Project Template Item в Altium Designer осуществляется автоматически. Если существуют выпущенные ревизии объектов Project Template Item, то только доступные шаблоны (те, которые были опубликованы для вас) будут представлены при создании нового проекта с помощью диалогового окна Create Project.
![При создании нового проекта выберите самую новую ревизию одного из опубликованных для вас объекта Project Template Item. В этом примере, новый управляемый проект платы создается с помощью одного из четырех доступных шаблонов проекта – PCB_TMPL_LITE (v.1). Обратите внимание, что некоторые документы нового проекта используют название проекта (Name), поскольку в названиях документов шаблона использовалась строка [ProjectName], как было описано ранее.](/documentation/sites/default/files/wiki_attachments/301268/MCS_PRJTemplates_ReuseEx_20_0.webp "При создании нового проекта выберите самую новую ревизию одного из опубликованных для вас объекта Project Template Item. В этом примере, новый управляемый проект платы создается с помощью одного из четырех доступных шаблонов проекта – PCB_TMPL_LITE (v.1). Обратите внимание, что некоторые документы нового проекта используют название проекта (Name), поскольку в названиях документов шаблона использовалась строка [ProjectName], как было описано ранее.")
При создании нового проекта выберите самую новую ревизию одного из опубликованных для вас объекта Project Template Item. В этом примере, новый управляемый проект платы создается с помощью одного из четырех доступных шаблонов проекта – PCB_TMPL_LITE (v.1). Обратите внимание, что некоторые документы нового проекта используют название проекта (Name), поскольку в названиях документов шаблона использовалась строка [ProjectName], как было описано ранее.
Если на сервере нет выпущенных ревизий объектов Project Template Item либо если вы вышли с сервера, вы сможете использовать локальные, файловые шаблоны.
Если вы не вошли на сервер управляемых данных, вы всё же можете работать в Altium Designer (под активной лицензией Altium Designer), но вы не сможете получить доступ к серверу управляемых данных организации и к его службам. Соответственно, вы не сможете повторно использовать объекты Project Template Item. Вы сможете использовать только файловые шаблоны, определенные локально.
Выпущенный шаблон проекта также можно использовать как объект данных конфигурации в одной или множестве конфигурациях среды (
Environment Configurations). Конфигурация среды используется для ограничения рабочей среды средства проектирования Altium NEXUS использованием только тех проектных элементов, которые утверждены компанией. Определение конфигураций среды и их хранение осуществляется в Team Configuration Center – службе, которая устанавливается вместе с NEXUS Server. После того, как вы вошли в NEXUS Server и выбрали доступную вам конфигурацию среды, в Altium NEXUS будет настроено соответствующее использование шаблонов проектов. Если в выбранной конфигурации среды задан один или множество объектов Project Template Item, то
только эти шаблоны будут доступны для использования. Если в выбранной конфигурации среды нет объектов Project Template Item либо если в ней задано
Do Not Control, то шаблоны останутся доступными для определения вручную, т.е. вы сможете использовать локальные, файловые шаблоны. Для получения более подробной информации перейдите на страницу
Управление конфигурацией среды.
Из веб-интерфейса сервера
Выпущенные ревизии объектов Project Template Item также можно повторно использовать непосредственно через веб-интерфейс сервера. При добавлении нового проекта (на странице Projects веб-интерфейса), доступные вам шаблоны будут представлены в открывшемся окне. Будут приведены все доступные объекты Project Template Item, для всех поддерживаемых типов проектов. Структура нового управляемого проекта, которую затем можно отредактировать в Altium Designer, основана на выбранном шаблоне проекта.
Выпущенные ревизии объектов Project Template Item также можно повторно использовать непосредственно через веб-интерфейс сервера. При добавлении нового проекта (на странице Projects веб-интерфейса), доступные вам шаблоны будут представлены в открывшемся окне. Будут приведены все доступные объекты Project Template Item, для всех поддерживаемых типов проектов. Структура нового управляемого проекта, которую затем можно отредактировать в Altium NEXUS, основана на выбранном шаблоне проекта.
Повторный выпуск объекта Project Template Item
В любой момент вы можете вернуться к ревизии объекта Project Template Item на сервере и напрямую отредактировать ее. Щелкните ПКМ по ревизии и выберите команду Edit из контекстного меню. Временный проект, доступный для редактирования, будет открыт в панели Projects. Внесите необходимые изменения, затем выпустите проект в следующую ревизию объекта.
Щелкните ПКМ по записи верхнего уровня самого объекта, чтобы изменить самую новую ревизию этого объекта.
Доступ к команде на запуск прямого редактирования существующей ревизии объекта Project Template Item.
Загрузка выпущенных данных
Чтобы загрузить данные, которые хранятся в ревизии объекта Project Template Item, щелкните ПКМ по этой ревизии и выберите команду Operations » Download из контекстного меню. Проект и связанные исходные файлы будут загружены в подпапку выбранной директории, названную в соответствии с идентификатором ревизии объекта. Этот файл можно найти здесь в папке Released.
Запустите команду Download для записи верхнего уровня объекта Project Template Item, чтобы загрузить проект и исходные файлы, которые хранятся в самой новой ревизии этого объекта.
Нажмите кнопку Explore в диалоговом окне Download from Server, чтобы быстро открыть папку загрузки.
Открытие файла шаблона проекта
Чтобы открыть файл шаблона проекта, который хранится в ревизии объекта Project Template Item, щелкните мышью по этому файлу на вкладке аспектного вида Preview ревизии. Файл будет открыт в Altium Designer.
