Altium Designer Documentation

Управляемые скрипты_AD

Последнее изменение: Pavel Demidov; 02.04.2020

Главная страница: Объекты сервера

Altium Designer в сочетании с сервером управляемых данных позволяет создавать объекты управляемых скриптов (Script Item) и управлять ими на этом сервере. Такие объекты могут быть созданы непосредственно на сервере путем выгрузки соответствующего проекта скрипта (*PrjScr) в ревизию целевого объекта. После того, как объект Script Item был создан (и в его ревизию были выпущены данные) и его состояние жизненного цикла задано на том уровне, при котором этот объект можно использовать при проектировании, объект можно повторно использовать на уровне проектирования плат.

От простых вспомогательных скриптов до скриптов, выполняющих сложные исходные операции, скрипты могут стать удобным и эффективным способом расширения функциональных возможностей Altium Designer. В Altium Designer, управляемые скрипты могут быть открыты непосредственно с сервера управляемых данных, загружены как постоянно доступные проекты и быть использованы в пользовательских командах меню.

Тип папки

При создании папки, в которой будут храниться объекты Script Item, вы можете указать тип этой папки. Это не имеет отношения к содержимому папки – выгрузка всегда осуществляется в соответствующий объект Script Item. Таким образом вы лишь обеспечиваете визуальную подсказку о том, что хранится в папке, что может быть полезными при поиске определенного содержимого на сервере. Чтобы указать, что папка используется в качестве контейнера для объектов Schematic Template Item, задайте ее тип (Folder Type) как Scripts при определении свойств папки в диалоговом окне Edit Folder.


Определение типа папки, т.е. ее планируемого использования, предоставляет визуальную индикацию содержимого этой папки при просмотре данных на сервере.

Другим важным аспектом родительской папки является используемая для нее схема именования объектов (Item Naming Scheme), которая определяет формат уникального идентификатора каждого объекта, создаваемого в этой папке. Доступны несколько примеров схем по умолчанию, использующих краткий код для папок каждого типа (ASC для каталога скриптов Altium) или для содержимого каждого типа (ASF для файла скрипта Altium):

  • $CONTENT_TYPE_CODE-001-{0000} – например, ASF-001-0001.
  • $CONTENT_TYPE_CODE-001-{A00} – например, ASF-001-A01.
  • $FOLDER_TYPE_CODE-001-{0000} – например, ASC-001-0001.
  • $FOLDER_TYPE_CODE-001-{A000} – например, ASC-001-A001.

Используя схему именования по умолчанию, система автоматически назначит следующий уникальный идентификатор на основе этой схемы, просканировав весь сервер и идентификаторы существующих объектов. Это может значительно сэкономить время при создании объектов скриптов вручную.

Для папки также можно определить пользовательскую схему путем ее ввода в поле, с переменной частью в фигурных скобках (например, SCRIPT-001-{0000}).


Схема именования объектов родительской папки применяется к уникальным идентификаторам всех объектов, которые создаются в этой папке.

Схему Item Naming Scheme, примененную к родительской папке, можно в любой момент изменить. Измененная схема будет применяться ко всем создаваемым далее в этой папке объектам.

Тип объекта

При создании целевого объекта Script Item, в котором будет храниться проект скрипта, убедитесь, что в диалоговом окне Create New Item тип содержимого этого объекта (Content Type) определен как Script. Если вы создаете объект в папке с типом Scripts, то объект этого типа будет доступен в контекстном меню при создании объекта.


Создание объекта Script Item в папке Scripts. Нужный тип содержимого (Content Type) доступен в контекстном меню.

При определении объекта Script Item, убедитесь, что указан тип управления жизненным циклом для его использования с этим объектом и схема именования ревизий этого объекта.

Управление тем, какие типы объектов могут использовать конкретное определение жизненных циклов или схему именования ревизий, осуществляется на глобальном уровне в диалоговом окне Content Types, при определении схемы. Схемами по умолчанию, которые назначаются объекту Script Item, являются Generic Lifecycle и 1-Level Revision Scheme.

После того, как файл был выгружен в начальную ревизию объекта Script Item, эти схемы не могут быть изменены для этого конкретного объекта.

Укажите нужные схемы в диалоговом окне Create New Item с помощью полей Lifecycle Definition и Revision Naming Scheme соответственно.

Если включен параметр для управления использованием определений жизненных циклов и схем именования ревизий по типу содержимого и для типа Script Item не задано использование конкретного определения/схемы, то это определение/схема будет не доступно в соответствующем выпадающем списке.


Выбор определения жизненного цикла и схемы именования ревизий для создаваемого вручную объекта.

Придерживаясь стандартных схем именования ревизий и определений жизненных циклов для различных типов проектных объектов на сервере управляемых данных, вы обеспечите понятное и надежное управление этими объектами.
Хорошей идеей является добавление названия и описания в определение объекта. Эта информация используется при поиске на сервере и позволяет быстро идентифицировать, что предлагает тот или иной объект Script Item.

Выгрузка проекта скрипта

До сих пор рассматривалась поддержка сервером объекта Script Item с точки зрения соответствующих типов папки и объекта. Выгрузка проекта скрипта в ревизию такого объекта может быть выполнена щелчком ПКМ по нужному объекту Script Item в панели Explorer и выбором команды Upload из контекстного меню. Будет открыто стандартное диалоговое окно Windows Open, с помощью которого вы можете найти нужный файл проекта скрипта (*.PrjScr).

Если у объекта нет запланированной ревизии, выгрузка будет произведена в следующую запланированную ревизию, созданную на лету в рамках процесса выгрузки.

Определение файла проекта скрипта для выгрузки в целевой объект Script Item.

Когда нужный файл выбран, начните выгрузку нажатием кнопки Open. Файл проекта и все файлы в той же папке будут выгружены в ревизию и станут доступны на вкладке аспектного вида Details этой ревизии в панели Explorer.

Выгруженный проект, а также все файлы в той же папке, появятся в списке на вкладке аспектного вида Details ревизии объекта Script Item.

Перетаскивание из Проводника Windows

Проект скрипта также можно выгрузить в новый объект Script Item перетащив выбранный файл проекта скрипта и связанных исходных файлов из исходной папки в Проводнике Windows в нужную папку в панели Explorer. Будет открыто диалоговое окно Create New Item, где этот файл будет отображен в списке области Sources. Названием (Name) объекта будут имена файлов с их расширениями (для множества файлов, записи будут разделены точкой с запятой). Описание (Description) объекта будет в формате Uploaded from <ИмяИПутьФайла>, Size <РазмерФайла>, Created on <ДатаСозданияФайла> (для множества файлов, записи будут разделены точкой с запятой). Измените эти поля нужным образом. Идентификатор Item ID будет задан в соответствии со схемой именования ревизий, заданной на уровне папки. Если папке не задана схема именования ревизий, будет использоваться схема $CONTENT_TYPE_CODE-001-{0000}.

Выгрузка проекта скрипта и связанных файлов в начальную ревизию нового объект Script Item путем перетаскивания мышью.

Повторное использование объекта Script Item

Связанная страница: Управление доступом к данным на сервере

После того, как проект скрипта был выпущен на сервер управляемых данных и состояние его жизненного цикла было задано на том уровне, при котором его можно использовать на уровне проекта, этот скрипт можно повторно использовать при создании проектов плат.

Когда вы вошли на сервер управляемых данных, вы можете беспрепятственно вручную использовать ревизии объектов Script Item, которые были опубликованы для вас.

Если вы не вошли на сервер управляемых данных, вы всё же можете работать в Altium Designer (под активной лицензией Altium Designer), но вы не сможете получить доступ к серверу управляемых данных организации и к его службам. Соответственно, вы не сможете повторно использовать объекты Script Item. Вы сможете использовать только файловые скрипты, определенные локально.

Запуск управляемого скрипта

Чтобы запустить доступный управляемый скрипт непосредственно в Altium Designer, выполните следующее:

  1. Выберите команду File » Run Script из главного меню.
  2. В диалоговом окне Select Item To Run нажмите кнопку  и выберите From server.
  3. Найдите и выберите нужную ревизию объекта Script Item в диалоговом окне Choose Item (по сути, аналог панели Explorer) и нажмите OK.
  4. Проект управляемого скрипта будет открыт в диалоговом окне Select Item To Run, где он может быть открыт обычным образом.

Выберите запуск скрипта с сервера управляемых данных вместо локального источника с помощью команды From server в диалоговом окне Select Item to Run.

Установка управляемого скрипта

Altium Designer позволяет на постоянной основе установить любое количество скриптов, чтобы их функциональные возможности были доступны всё время, во всех сеансах Altium Designer. Это доступно на странице Scripting System - Global Projects диалогового окна Preferences Altium Designer (щелкните мышью по элементу управления  вверху справа от рабочего пространства).

Чтобы установить проект скрипта с сервера управляемых данных, нажмите кнопку  и выберите команду Install from server из соответствующего меню. Выберите нужный объект управляемого скрипта в открывшемся диалоговом окне Choose Item (по сути, аналог панели Explorer) и нажмите OK, чтобы установить проект скрипта.

Настройка установленных скриптов, доступных в Altium Designer всегда, осуществляется на странице Scripting System - Global Projects диалогового окна Preferences.

Установленный проект скрипта будет доступен в Altium Designer при входе пользователя на сервер управляемых данных под подходящими учетными данными. Обратите внимание, что для установленного проекта скрипта отображается его положение или "путь" в структуре папок сервера и идентификатор объекта Script Item, содержащего в себе данные проекта скрипта.

Для управляемого скрипта, установленного с сервера управляемых данных, в списке приводится его серверный путь и Item ID.

Ссылки на сервер, созданные в настройках при установке управляемого проекта скрипта, сохраняются, и они, соответственно, будут включены в текущий набор настроек при их выпуске на сервер. При повторном использовании ревизии итогового управляемого объекта Design Preferences Item будет автоматически представлена ссылка на управляемый скрипт.

Создание команды управляемого скрипта

В Altium Designer, скрипт (будь то локальный или серверный) может быть применен к элементу меню за несколько простых шагов. Для этого скрипт должен быть постоянно доступен, т.е. он должен быть установлен через настройки системы скриптов (как описано выше).

Создание пользовательской команды из установленного скрипта осуществляется с помощью возможностей кастомизации. Сделайте редактор, в котором вы хотите использовать скрипт, активным (откройте документ нужного типа), затем дважды щелкните мышью справа от главного меню, чтобы открыть диалоговое окно Customizing. Здесь нажмите кнопку , чтобы создать новую команду, свойства которой задаются через диалоговое окно Edit Command.

Доступ к кастомизации для создания новой команды, которая будет запускать управляемый скрипт.

Это включает в себя определение нового действия (Action) на основе процесса (Process) скрипта (ScriptingSystem:RunScript) и его параметров (Parameters). Параметры команды определяют полный путь к скрипту и его целевой процедуре в формате ProjectName|ProcName>Process. Для типового локально сохраненного скрипта это может быть:

ProjectName=C:\Server Testing\Altium Scripts\HelloWorld.PRJSCR|ProcName=HelloWorld.pas>HelloWorld

Однако для управляемого скрипта, который содержится на сервере управляемых данных, путь и, соответственно, параметры команды должны указывать на корректное серверное расположение, основанное на GUID-ссылке объекта Script Item. Эту ссылку необходимо получить до создания новой команды скрипта.

Чтобы ввести корректные параметры для скрипта, установленного с сервера, откройте диалоговое окно Select Item To Run (File » Run Script), щелкните ПКМ по нужной процедуре в скрипте и выберите команду Copy script parameters из контекстного меню. Полный путь, имя процесса и процедура будут скопированы в буфер обмена.

Выберите нужный процесс/процедуру в управляемом проекте скрипта и скопируйте параметры скрипта.

В диалоговом окне Edit Command вставьте скопированные параметры скрипта в поле Parameters и заполните остальные поля (заголовок, изображение, сочетания клавиш) необходимым образом.

Вставьте скопированные параметры скрипта в поле Parameters и сделайте всё остальное по аналогии с созданием команды из локального скрипта.

Из диалогового окна Customizing сформированную команду скрипта можно перетащить в подходящее меню или панель инструментов Altium Designer.

Обратите внимание, что поскольку источником скрипта команды является сервер управляемых данных, она будет доступна только при входе пользователя на сервер под корректными учетными данными.

Команда меню, созданная из управляемого скрипта, работает, когда пользователь подключен к серверу.

Повторный выпуск объекта Script Item

В любой момент вы можете вернуться к ревизии объекта Script Item на сервере и напрямую отредактировать ее. Щелкните ПКМ по ревизии и выберите команду Edit из контекстного меню. Эта ревизия будет открыта в Altium Designer – внесите в нее необходимые изменения, затем выпустите в следующую ревизию с помощью команды Release to server (сочетание клавиш Alt+Ctrl+S), доступной в контекстном меню записи проекта в панели Projects.

Щелкните ПКМ по записи верхнего уровня самого объекта, чтобы изменить самую новую ревизию этого объекта.

Доступ к команде на запуск прямого редактирования существующей ревизии объекта Script Item.

Обновление объекта Script Item

Если необходимо изменить проект или связанные исходные данные, сохраненные в объекте Script Item, вы можете выгрузить эти файлы в этот объект – новые файлы будут сохранены в следующую ревизию этого объекта.

Загрузка файлов

Загрузку файлов (проекта и связанных исходных данных), которые хранятся в ревизии объекта Script Item, можно выполнить из панели Explorer следующими способами:

  • Щелкните ПКМ по этой ревизии и выберите команду Operations » Download из контекстного меню. Файлы будут загружены в подпапку выбранной директории, названную в соответствии с идентификатором ревизии объекта. Файлы можно найти здесь в папке Released.
    Запустите команду Download для записи верхнего уровня объекта Script Item, чтобы загрузить файлы, которые хранятся в самой новой ревизии этого объекта.
    Нажмите кнопку Explore в диалоговом окне Download from Server, чтобы быстро открыть папку загрузки.
  • Выберите один или множество исходных файлов, сохраненных в ревизии объекта, на ее вкладке аспектного вида Details, щелкните ПКМ и выберите команду Download из контекстного меню. В открывшемся диалоговом окне Browse For Folder укажите целевую папку для получения файлов.

Открытие исходного файла скрипта

Чтобы открыть файл проекта, который хранится в ревизии объекта Script Item, или один из связанных с ним исходных файлов, выберите этот файл на вкладке аспектного вида Details этой ревизии, затем щелкните ПКМ и выберите команду Open из контекстного меню. Проект (и все исходные файлы) или исходный файл будет открыт в Altium Designer.

Обнаружили проблему в этом документе? Выделите область и нажмите Ctrl+Enter, чтобы оповестить нас.

Связаться с нами

Связаться с нашими Представительствами напрямую

We're sorry to hear the article wasn't helpful to you.
Could you take a moment to tell us why?
200 characters remaining
Вы сообщаете о проблеме, связанной со следующим выделенным текстом
и/или изображением в активном документе:
Бесплатная пробная версия Altium Designer
Бесплатная пробная версия Altium Designer
Давайте приступим. Для начала, Вы или Ваше предприятие уже используете Altium Designer?

Если Вы хотите поговорить с представителем, пожалуйста, свяжитесь с местным офисом Altium.
Copyright © 2019 Altium Limited

В таком случае, для чего Вам необходима пробная лицензия?

Если Вы хотите поговорить с представителем, пожалуйста, свяжитесь с местным офисом Altium.
Copyright © 2019 Altium Limited

Вам для этого не нужна пробная лицензия.

Нажмите кнопку ниже, чтобы загрузить установщик самой новой версии Altium Designer

Загрузить установщик Altium Designer

Если Вы хотите поговорить с представителем, пожалуйста, свяжитесь с местным офисом Altium.
Copyright © 2019 Altium Limited

Пожалуйста, заполните форму ниже, чтобы получить ценовое предложение.

Нажимая [Получить бесплатнную пробную версию], Вы соглашаетесь с нашей Политикой конфиденциальности. Вам могут приходить сообщения от компании Altium, и Вы можете изменить настройки уведомлений в любой момент.

Если Ваша подписка Altium активна, у Вас нет необходимости в пробной лицензии.

Если у Вас нет активной подписки Altium, пожалуйста, заполните форму ниже, чтобы получить пробную версию.

Нажимая [Получить бесплатнную пробную версию], Вы соглашаетесь с нашей Политикой конфиденциальности. Вам могут приходить сообщения от компании Altium, и Вы можете изменить настройки уведомлений в любой момент.

Для чего Вы хотите попробовать Altium Designer?

Если Вы хотите поговорить с представителем, пожалуйста, свяжитесь с местным офисом Altium.
Copyright © 2019 Altium Limited

Вы нашли нужное место! Пожалуйста, заполните форму ниже, чтобы начать использование пробной версии.

Нажимая [Получить бесплатнную пробную версию], Вы соглашаетесь с нашей Политикой конфиденциальности. Вам могут приходить сообщения от компании Altium, и Вы можете изменить настройки уведомлений в любой момент.

Great News!

Valid students can get their very own 6-month Altium Designer Student License for FREE! Just fill out the form below to request your Student License today.

Нажимая [Получить бесплатнную пробную версию], Вы соглашаетесь с нашей Политикой конфиденциальности. Вам могут приходить сообщения от компании Altium, и Вы можете изменить настройки уведомлений в любой момент.

Вы можете загрузить бесплатную лицензию средства просмотра Altium Designer Viewer сроком действия 6 месяцев.

Пожалуйста, заполните форму ниже, чтобы запросить эту лицензию.

Нажимая [Получить бесплатнную пробную версию], Вы соглашаетесь с нашей Политикой конфиденциальности. Вам могут приходить сообщения от компании Altium, и Вы можете изменить настройки уведомлений в любой момент.

Замечательно! Создавать новое - отличное занятие. У нас есть превосходная программа для Вас.

Upverter - бесплатная платформа, разработанная специально для любителей проектирования.

Нажмите здесь, чтобы попробовать!

Если Вы хотите поговорить с представителем, пожалуйста, свяжитесь с местным офисом Altium.
Copyright © 2019 Altium Limited

Вы можете загрузить бесплатную лицензию средства просмотра Altium Designer Viewer сроком действия 6 месяцев.

Пожалуйста, заполните форму ниже, чтобы запросить эту лицензию.

Нажимая [Получить бесплатнную пробную версию], Вы соглашаетесь с нашей Политикой конфиденциальности. Вам могут приходить сообщения от компании Altium, и Вы можете изменить настройки уведомлений в любой момент.