Создание задач с использованием импортера CSV

Если у пользователя JIRA есть разрешение проекта «Создать задачу» (Create Issue) и глобальное разрешение «Массовое изменение» (Bulk Change) для соответствующих проектов, он может создавать задачи массовыми, используя файл со значениями отделенными запятыми (CSV). CSV-файлы представляют собой текстовые файлы, представляющие табличные данные, и поддерживаются большинством систем, которые обрабатывают табличные данные, такие как электронные таблицы (MS Excel, Numbers) и базы данных.

Импортер CSV позволяет импортировать данные из внешних систем, которые могут экспортировать свои данные в табличном формате. Он также позволяет вам создавать свой собственный файл CSV для выполнения  создания и обновления массовых задач.

 

 

Существует два способа использования импортера CSV и дополнительный третий шаг:

1. Подготовка файла CSV,

2. Запуск мастера импорта CSV и

3. Сохранение конфигурации для будущего использования.

Подготовка файла CSV

Плагин JIRA Importers предполагает, что ваш CSV-файл основан на стандартном CSV- файле Microsoft Excel. Поля разделяются запятыми, и любое содержимое, которое должно обрабатываться буквально, например запятые и новые строки / «возврат каретки», заключены в кавычки.

 Для Microsoft Excel и OpenOffice нет необходимости указывать значения в ячейках, так как эти приложения обрабатывают это автоматически.

Требования к файлам CSV

В дополнение к тому, чтобы быть «хорошо сформированным», файлы CSV имеют следующие требования:

Каждый файл CSV должен иметь строку заголовка с кратким столбцом.

Мастер импорта файлов CSV использует строку заголовка CSV-файла, чтобы определить, как сопоставить данные из 2-й строки  CSV-файла к полям в JIRA.

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

Строка заголовка должна содержать столбец для данных «Резюме» (Summary).

Запятые (как разделители столбцов и полей) не могут быть опущены.

Например, это действительно:


Summary, Assignee, Reporter, Issue Type, Description, Priority
"Test issue", admin, admin, 1, ,

... но это недействительно:


Summary, Assignee, Reporter, Issue Type, Description, Priority
"Test issue", admin, admin, 1

Инкапсулирование структуры данных JIRA в файл CSV

Захват данных, охватывающих несколько строк

Используйте двойные кавычки (") в файле CSV для захвата данных, которые охватывают несколько строк. Например, при импорте JIRA будет рассматривать следующее как действительный файл CSV с одной записью:


Summary, Description, Status
"Login fails", "This is on
a new line", Open

Обработка специальных символов буквально

Используйте двойные кавычки (") вокруг раздела текста, чтобы обрабатывать любые специальные символы в этом разделе буквально. После того, как эти данные будут импортированы в JIRA, эти специальные символы будут сохранены как часть данных поля JIRA. Примеры специальных символов включают в себя каретку возвращает / вводит символы (как показано в примере выше), запятые и т. д.

Чтобы обработать знак двойной кавычки буквально, вы можете «сбежать» с помощью другого символа метки двойной кавычки.

Следовательно, значение CSV:

  • Нажатие кнопки ««Добавить»» приводит к  странице с не найденной ошибкой

       после импорта, будет храниться в JIRA как:

  • Нажатие кнопки «Добавить» приводит к  странице с не найденной ошибкой

Объединение нескольких значений в отдельные поля JIRA

Вы можете импортировать несколько значений в поле JIRA, которое принимает несколько значений (например, Исправление(для) версии, Влияние на версию, компонент, Метки). Для этого файл CSV должен указывать одно и то же имя столбца для каждого значения, которое вы хотите объединить, в отображаемое поле JIRA. Количество указанных имен столбцов должно соответствовать максимальному количеству значений, которые должны быть объединены в отображаемое поле. Например:


IssueType, Summary, FixVersion, FixVersion, FixVersion, Component, Component
bug, "First issue", v1, , , Component1,
bug, "Second issue", v2, , , Component1, Component2
bug, "Third issue", v1, v2, v3, Component1,

В приведенном выше примере поле Component второй задачи и поле Fix Version третьей задачи генерируют несколько значений в соответствующих полях JIRA при импорте.

Помните, что только ограниченное количество полей JIRA поддерживает несколько значений. Импортер CSV не позволит вам импортировать объединенные данные в поля JIRA, которые поддерживают только одно значение.

Импорт вложений

Вы можете прикреплять файлы к задачам, созданным из файла CSV. Для этого укажите URL- адрес вашего вложения в столбце «Вложения» (Attachments) в файле CSV.


Assignee, Summary, Description, Attachment, Comment
Admin, "Issue demonstrating the CSV attachment import", "Please check the attached image below.", "https://jira-server:8080/secure/attachment/image-name.png", "01/01/2012 10:10;Admin; This comment works"
Admin, "CSV attachment import with timestamp,author and filename", "Please check the attached image below.", "01/01/2012 13:10;Admin;image.png;file://image-name.png", "01/01/2012 10:10;Admin; This comment works"

 URL- адреса вложений поддерживают протоколы HTTP и HTTPS и могут быть любым местом, к которому должен иметь доступ JARA-сервер. Вы также можете использовать протокол FILE для доступа к файлам в подкаталоге import / attachments вашего домашнего каталога JIRA.

Импорт задач в несколько проектов JIRA

Вы можете импортировать задачи из своего CSV-файла в разные проекты JIRA через импорт файла CSV. Чтобы сделать это:

Для вашего CSV-файла требуются два дополнительных столбца, заголовки которых должны быть названы аналогично имени проекта и Project Key.

Убедитесь, что каждая задача, представленная в вашем файле CSV, содержит соответствующее имя и ключ в этих столбцах для проектов JIRA, в которые они будут импортированы.

Название проекта и ключевые данные - это минимальные данные проекта JIRA, необходимые для импорта задач из файла CSV в конкретные проекты JIRA.


IssueType, Summary, Project Name, Project Key
bug, "First issue", Sample, SAMP
bug, "Second issue", Sample, SAMP
task, "Third issue", Example, EXAM

В приведенном выше примере первая и вторая задачи будут импортированы в проект «Образец» (с ключом проекта «SAMP»), а третья задача будет импортирована в проект «Пример» (с ключом проекта «EXAM»), предполагая Вы сопоставляете поля «Название проекта» и «Ключ проекта» в CSV-файле с полями «Имя проекта» и «JARA» в имени проекта, соответственно, во время выполнения мастера импорта файлов CSV.

Импорт записей в журнал

Ваш CSV-файл может содержать записи в журнале. Например:


Summary,Worklog
Only time spent (one hour),3600
With a date and an author,2012-02-10 12:30:10;wseliga;120
With an additional comment,Testing took me 3 days;2012-02-10 12:30:10;wseliga;259200

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

Импортирование в несколько отдельных настраиваемых полей

Ваш CSV-файл может содержать несколько записей для одного множественного выбора настраиваемого поля. Например:


Summary,Multi Select,Multi Select,Multi Select
Sample issue,Value 1,Value 2,Value 3

Это заполнит Multi Select Custom Field (множественный выбор настраиваемого поля) несколькими значениями.

Импорт настраиваемых полей каскадного выбора

Вы можете импортировать значения в настраиваемое поле каскадного выбора, используя следующий синтаксис:


Summary, My Cascading Custom Field
Example Summary, Parent Value -> Child Value

Сепаратор '->' позволяет вам импортировать иерархию.

ПРИМЕЧАНИЕ. В настоящее время JIRA не поддерживает импорт многоуровневых каскадных полей выбора через CSV (JRASERVER-34202 - разрешить импорт CSV для поддержки открытия полей плагинов многоуровневого каскадного выбора).

Для того чтобы произвести  запуск мастера импорта файлов CSV, необходимо выполнить следующие шаги:

Прежде чем начать: Если ваша установка JIRA имеет существующие данные - создайте резервную копию существующих данных JIRA.

1. Выберите «Задачи» (Issues)> «Импортировать задачи из CSV» (Import Issues from CSV), чтобы открыть страницу «Настройка массового создания» (Bulk Create Setup). (Если у вас нет опции «Импортировать задачи из CSV» (Import issues from CSV), JIRA Admin должен обновить плагин JIRA Importers до версии 6.2.3 или выше).

2. На странице «Настройка» (Setup) выберите свой исходный CSV-файл.

Оставьте флажок «Использовать существующий файл конфигурации очищенным» (Use an existing configuration file), если у вас нет файла конфигурации или вы хотите создать новый файл конфигурации. Файлы конфигурации определяют сопоставление между именами столбцов в строке заголовка файла CSV и полях в вашей установке JIRA.

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

o   Если этот параметр не выбран, то в конце мастера импорта файлов CSV JIRA спросит вас, хотите ли вы создать файл конфигурации, который вы можете использовать для последующих импортных CSV-файлов.

3. Нажмите кнопку «Далее» (Next), чтобы перейти к шагу «Настройки» (Settings) мастера импорта файлов CSV. Заполните необходимые поля.

o   Если ваш CSV-файл использует другой разделительный символ, отличный от запятой, укажите этот символ в поле разделителя CSV. Если разделитель является «Tab», его можно ввести с использованием формата '/ t'.

4. Нажмите кнопку «Далее» (Next), чтобы перейти к шагу «Поля сопоставления» (Map fields) мастера импорта файлов CSV. Здесь вы можете сопоставить заголовки столбцов вашего CSV-файла с полями в выбранном проекте JIRA. Если вы хотите выбрать определенные значения полей JIRA для сопоставления значений CSV, поставьте галочку в поле «Значение поля сопоставления» (Map field value).

Примечание. Вы должны сопоставить с полем  резюме CSV  JIRA. Это гарантирует, что создаваемые задачи имеют резюме.

5. Нажмите кнопку «Далее» (Next), чтобы перейти к шагу «Значения сопоставления» (Map values) мастера импорта файлов CSV. На этом шаге мастера импорта вы можете выбрать, какие конкретные значения полей CSV вы хотите сопоставить, к какому конкретному значению поля JIRA. Например, ваши типы задач могут иметь значение поля CSV для «Задач функции», которое вы можете сопоставить с полем типа «Новая функция» JIRA

Пожалуйста, обратите внимание:

o   Любые поля, на которых были выбраны значения полей сопоставления, были отображены на предыдущем шаге мастера импорта файлов CSV на этой странице. Оставьте поле очищенным или очистите любой контент в нем, если вы хотите импортировать значение «как есть».

o   Если вы импортируете CSV-поле на основе имени пользователя (например, «Репортер» (Reporter) или «Представитель» (Assignee), и вы не выбираете значение поля сопоставления для этого поля на предыдущем шаге мастера импорта файлов CSV, тогда импортер автоматически отображает импортированные имена пользователей из CSV-файла в (нижнем регистре) именах JIRA.

Независимо от того, установлен ли флажок «Значение поля сопоставления» (Map field value), JIRA автоматически создаст имена пользователей на основе данных в вашем CSV-файле, если они еще не определены в JIRA.

6. Нажмите кнопку «Начать импорт» (Begin Import), когда вы готовы начать импортировать данные CSV в JIRA. Импортёр будет отображать обновления по мере продвижения импорта, а затем сообщение об успешном завершении, когда импорт будет завершен.

7. Если вы уверены, что ваш импорт правильно настроен, нажмите кнопку «Начать импорт» (Begin Import). Ваш импорт начнется и после его завершения вы будете проинформированы о любых ошибках. Если вы хотите сначала проверить свой импорт, нажмите кнопку «Проверить» (Validate), и JIRA проверит ваш импорт и сообщит вам о любых ожидаемых ошибках или предупреждениях. Затем вы можете вернуться и исправить их, прежде чем запускать полный импорт.

 Примечание:

o   Если у вас возникли проблемы с импортом (или вам интересно), нажмите кнопку загрузки подробной ссылки на журнал, чтобы просмотреть подробную информацию о процессе импорта файлов CSV.

o   Если вам нужно импортировать другой CSV-файл с теми же (или аналогичными) настройками в то, что вы использовали в этой процедуре, щелкните  ссылку  сохранение  конфигурации для загрузки файла конфигурации CSV, который вы можете использовать на первом этапе мастера импорта файла CSV. 

Поздравляем, вы успешно импортировали данные CSV в JIRA! Если у вас есть какие-либо вопросы или возникают какие-либо проблемы, обратитесь в службу поддержки Atlassian.

 Советы по импорту данных CSV в поля JIRA

Ниже приведены некоторые полезные советы при импорте данных из файла CSV в определенные поля JIRA:

 Поле JIRA

 Примечания импорта

 Проект  (Project)

Данные CSV импортируются на основе каждого проекта. Вы можете либо указать существующий проект (ы) JIRA в качестве цели, либо импортер автоматически создаст для вас новый проект (ы) во время импорта.

 

 Резюме (Summary)

Это единственное обязательное поле.

Компонент (ы)

(Component(s)

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

 Затронутые  версии

 (Affects  Version(s))

Вы можете импортировать версии с несколькими «Затронутые версии» (Affects Versions), введя каждую версию в отдельный столбец.

Исправленные версии

(Fix Version(s))

Вы можете импортировать проблемы с несколькими «Исправленные версии» (Affects Versions), введя каждую версию в отдельный столбец.

 Комментарий тела

 (Comment Body)

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

 Соответствие дате (срок)

 (Due Date)

Используйте формат даты, указанный на втором шаге мастера импорта CSV.

 Тип задач

 (Issue Type)

Если в вашем файле CSV не указано, импортированным задачам будет присвоено по умолчанию (то есть первый) тип задачи, как указано в вашей системе JIRA -  определение значений полей типа «Тип задач». Вы также можете создавать новые значения JIRA «на лету» во время процесса импорта.

Метки

(Labels)

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

 Приоритет

 (Priority)

Если в вашем CSV-файле не указано, импортированным проблемам будет присвоен приоритет по умолчанию (то есть первый), указанный в вашей системе JIRA, определяющий значения полей «Приоритет». Вы также можете создавать новые значения JIRA «на лету» во время процесса импорта.

Оригинальная оценка

(Original Estimate)

Значение этого поля должно быть указано как количество секунд.

 Оставшаяся оценка

 (Remaining Estimate)

Значение этого поля должно быть указано как количество секунд.

 Время потрачено

 (Time Spent)

Значение этого поля должно быть указано как количество секунд.

Пользователи

(Users)

  • Вы можете выбрать, чтобы импортер автоматически создавал пользователей JIRA для любых значений поля «Представителя» (Assignee) или «Репортера» (Reporter).
  • Пользователи будут созданы как активные в учетные записи в JIRA. Пользователи должны будут получить свои пароли, отправленные им по электронной почте, при первом входе в JIRA.
  • Пользователи, не имеющие реального имени, получат часть своего адреса электронной почты (имя пользователя) до символа «@» в качестве полного имени в JIRA.
  • Если вы используете внешнее управление пользователями, процесс импорта не сможет создавать пользователей JIRA; вместо этого импортер предоставит вам список новых пользователей, которые должны быть созданы. Перед началом импорта вам нужно будет создать пользователей во внешнем пользовательском репозитории.
  • Если у вас есть лицензия, ограниченная пользователем (например, личная лицензия), а количество требуемых пользователей превышает лимит, то импорт будет остановлен. Отобразится страница с указанием списка пользователей, которые не могут быть созданы.
  • Если «Представитель» (Assignee) и «Репортер» (Reporter) не сопоставлены, то имена пользователей не будут созданы.

 

 Другие поля

(Other fields)

Если вы хотите импортировать какие-либо другие поля, вы можете выбрать их сопоставление с определенными пользовательскими полями JIRA. Если ваши пользовательские поля еще не существуют в JIRA, импортер может автоматически создать их для вас. Если ваше настраиваемое поле является полем даты, используйте формат даты, указанный на втором этапе мастера импорта CSV.

По материалам Atlassian JIRA User's Guide: Creating issues using the CSV importer