Импорт требований

Вы можете быстро и легко загрузить имеющиеся данные требований в Requirements Portal с помощью Import Wizard доступного в Requirements Module.

AI Assisted Requirements Importer

Разработка требований часто начинается с подготовки требований заинтересованных сторон в документах, таких как PDF-файлы и таблицы Excel, где данные плохо структурированы. Извлечение данных требований вручную из таких неструктурированных документов может быть трудоемким и подверженным ошибкам, поэтому для ускорения процесса переноса требований в Requirements Portal можно использовать возможности ИИ для импорта требований из неструктурированных файлов PDF, Excel, Word и CSV.

Функциональность AI-assisted Importer в настоящее время находится на стадии Beta.

С помощью AI-assisted Importer в требования можно импортировать следующие поля:

  • Identifier

  • Text

  • Methods

  • Applicable Blocks

  • Title

  • Rationale

  • Parents

  • Children

  • Type

  • State

  • Compliance

  • Compliance comment

  • Owner

  • Tags

  • Path to Section

Доступ к Importer

AI Assisted Importer включен по умолчанию. При необходимости администратор Workspace может отключить его с помощью параметра External Provider на странице Settings – ValiAssistant (открывается нажатием значка  в правом верхнем углу, затем выбором пункта Settings в появившемся меню и далее выбором ValiAssistant в списке на левой панели) – .

Когда параметр External Provider отключен, доступен только legacy importer. Чтобы узнать больше о legacy importer, см. раздел Legacy Importer ниже.

Доступ к AI Assisted Importer можно получить из Requirements Module (), нажав кнопку  в левом верхнем углу страницы и выбрав Create Requirement в появившемся меню. Кроме того, если в открытой в данный момент спецификации нет требований, доступ к importer можно получить, нажав кнопку Import на странице.

Процесс импорта

После открытия importer отображается окно Document Import. Чтобы продолжить работу с AI Assisted Importer, нажмите кнопку .

В этом окне при желании можно выбрать legacy importer, щелкнув ссылку open the legacy importer here. Порядок использования legacy importer описан ниже на этой странице.

На следующем этапе можно загрузить файл поддерживаемого типа (*.pdf, *.docx, *.xlsx или .*csv). Для этого перетащите файл в соответствующую область окна или щелкните элемент управления select from your computer, чтобы выбрать файл на жестком диске.

Максимальный размер загружаемого файла — 100 МБ.

Хотя загружаемый файл может быть неструктурированным, вы можете воспользоваться ссылкой Excel template, чтобы скачать файл *.xlsx, который можно использовать для структурированного ввода требований. Также файл можно скачать по этой ссылке.

После успешной загрузки файла его запись появится в окне. Удалить файл из окна можно, щелкнув значок . Либо перетащите в окно другой файл, чтобы заменить существующий.

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

По умолчанию извлеченные требования будут импортированы в спецификацию, которая была открыта на момент запуска Importer. Вы можете выбрать нужную спецификацию в раскрывающемся списке в верхней части окна Importer или создать новую спецификацию, выбрав пункт As new (creates new specification) в раскрывающемся списке и задав имя новой спецификации в поле Specification name, которое появится в окне.

Нажмите кнопку , чтобы продолжить. После завершения импорта появится окно подтверждения.

Если importer обнаружит проблемы в импортированных требованиях, это будет указано в окне (). Щелкните ссылку, чтобы скачать отчет с подробным описанием причин обнаруженных проблем. 

Нажмите кнопку , чтобы вернуться к этапу загрузки файла в importer, или нажмите , чтобы выйти из importer.

Legacy Importer

При открытии Importer (подробнее) вы можете выбрать продолжение работы с legacy import tool для загрузки структурированных данных требований. Кроме того, legacy importer доступен только тогда, когда администратор отключил параметр External Provider в настройках Requirements Portal.

Процесс состоит из трех основных этапов: Specification, Upload и Review. После завершения импорта спецификации отображается сводка, а также предлагается выполнить дополнительные действия, например Valifying или импорт других файлов. Эти этапы и действия описаны в разделах ниже.

Specification

На этом этапе Import Wizard можно определить целевую спецификацию для импорта:

  • Используйте область Select a specification в левой части окна Import Requirements, чтобы выбрать существующую спецификацию и при необходимости ее раздел.

  • Используйте область Create a specification в правой части окна Import Requirements, чтобы создать новую спецификацию (а также задать аббревиатуру и блок, к которому она будет привязана), не выходя из мастера импорта.

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

 
  • Если Import Wizard запускается в контексте Specification или Section, этот вариант будет предварительно выбран как место назначения импорта.

  • Если существующих спецификаций нет, необходимо создать новую.

  • При задании имени новой Specification необходимо соблюдать правила именования — допускаются только буквенно-цифровые символы и специальный символ _ (подчеркивание).

Upload

На этом этапе Import Wizard можно загрузить файл поддерживаемого типа. Для этого перетащите файл в правую часть окна Import Requirements или щелкните элемент управления Drop file, чтобы выбрать файл на жестком диске. После успешной загрузки файла в окне появится уведомление.

 
  • Поддерживаются только файлы Excel (.xls, .xlsx) и Comma Separated Values (.csv). Файлы Excel Macro (.xlsm) не поддерживаются.

  • Если будет загружен неподдерживаемый файл, появится сообщение об ошибке.

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

Review

На этом этапе Import Wizard можно просмотреть результаты импорта данных из загруженного файла, настроить параметры файла и сопоставить данные из файла с полями требований.

Область Destination окна Import Requirements визуально показывает, куда именно будут импортированы данные (в какую спецификацию или раздел).

Область File options предоставляет следующие параметры:

  • Update requirements – если параметр включен, все существующие требования в целевой спецификации будут перезаписаны путем замены данных (данные из файла заменяют данные в спецификации).

    • Если параметр отключен и вы импортируете требования, чей Identifier уже существует в выбранной целевой спецификации, Requirements Portal добавит суффикс _import к идентификаторам импортируемых требований, чтобы их различать.

    • Если параметр отключен и вы импортируете требования, чьи Identifiers уже существуют в текущем проекте, но не в выбранной целевой спецификации, Requirements Portal добавит к идентификаторам значок предупреждения, сообщающий о дублирующемся идентификаторе в том же проекте.

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

  • Use header row – можно выбрать использование строки заголовков загруженного файла либо общей строки ссылочных заголовков, предоставляемой Requirements Portal (то есть заголовков столбцов A, B, C и т. д.).

    Requirements Portal рассматривает строку Header row как первую строку любого загруженного файла.

  • Sheet – если файл содержит несколько листов, можно выбрать лист, из которого следует выполнять импорт.

  • Starting row – можно выбрать, начиная с какой строки импортируемого файла следует собирать данные для вставки в Requirements Portal.

В таблице в нижней части окна Import Requirements отображается предварительный просмотр загруженного файла, и вы можете сопоставить его столбцы с полями в Requirements Portal. Это позволяет определить, как данные из файла будут соответствовать конкретным полям в Requirements Portal, выбирая подходящее поле в раскрывающемся списке Map To для каждого столбца. Если файл содержит заголовки, идентичные полям по умолчанию в Requirements Portal, эти поля будут сопоставлены автоматически. При необходимости это автоматическое сопоставление можно переопределить или скорректировать.

  • Для сопоставления можно выбрать следующие поля:

    • Идентификатор

    • Текст

    • Заголовок

    • Обоснование

    • Родительские элементы

    • Дочерние элементы

    • Путь к разделу

    • Тип

    • Состояние

    • Теги

    • Соответствие

    • Комментарий по соответствию

    • Методы V&V

    • Применимость

    • Применимые блоки

    • Владелец

    • Теги

    • Пользовательские столбцы

  • Для полей Children, V&V Methods, Applicability, Applicable Blocks и Tags можно импортировать более одного значения для каждого требования. Для этого каждое значение должно быть разделено запятой.

  • Если импортируемый метод верификации, применимый блок, тип требования, состояние, соответствие или тег в настоящий момент отсутствует в Requirements Portal, он будет автоматически создан во время импорта и добавлен к требованию.

  • Для Applicability составные типы блоков можно указывать с помощью /, например, block_A/block_B.

  • Для пользовательских столбцов доступны следующие типы: Select, Multiselect, Text, Date, Number.

  • Должен быть выбран как минимум столбец Identifier. В противном случае будет отображаться предупреждающее сообщение, пока это условие не будет выполнено ().

  • Следующие поля чувствительны к регистру:

    • Тип

    • Состояние

    • Соответствие

    • Теги

    Например, если тег TBD уже существует в Requirements Portal, а импортируется тег tbd, будет создан новый тег tbd и импортирован вместе с требованием.

Отчет о выполнении

После завершения процесса импорта, если он выполнен успешно, отображаются сообщение об успешном выполнении и внесенные изменения. Если импорт завершится неудачей, будет показано сообщение об ошибке. Пример успешного импорта приведен ниже.

Если имеются некритические ошибки, они также будут отображены (). Возможны следующие некритические ошибки:

  • Невозможно установить связь → идентификатор родительского или дочернего элемента не существует в проекте

  • Невозможно установить связь → идентификатор родительского или дочернего элемента дублируется в проекте

  • Утверждение о соответствии требования отсутствует в проекте

  • Тип требования отсутствует в проекте

  • Состояние требования отсутствует в проекте

  • Тег отсутствует в проекте

  • Условие применимости не существует

Независимо от того, был ли импорт успешным или нет, вы можете выполнить повторный импорт или начать новый импорт, нажав Import new file (успех) или Try again (ошибка), что вернет вас к этапу 1 (Specification).

После успешного импорта вы также можете запустить процесс Valify, нажав элемент управления Check now в верхней части окна. Этот процесс просканирует текст импортированных требований на наличие возможных количественно измеримых параметров для преобразования в Valis внутри требования.

Дополнительную информацию см. на странице Valify Requirements.

AI-LocalizedЛокализовано с помощью ИИ
Если вы обнаружили проблему, выделите текст/изображение и нажмитеCtrl + Enter, чтобы отправить нам свой отзыв.
Доступность функций

Доступные вам функции зависят от того, какое решение Altium вы используете: Altium Develop, Altium Agile Teams, Altium Agile Enterprise или Altium Designer (при активной подписке).

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

Content