Добавление страницы конфигурации доски

В этом учебнике вы создадите страницу конфигурации доски для своего приложения Jira Software Server. Мы не будем вдаваться в подробности добавления настроек на страницу, но этот учебник станет хорошей отправной точкой, если вы хотите, чтобы ваше приложение имело отдельные конфигурации на доску.

Чтобы создать страницу конфигурации этой доски, вы создадите новую веб-панель, расположенную в файле jira.agile.board.configuration, а затем добавьте код для отображения веб-панели. Это оно!

Вот как это будет выглядеть:

РИСУНОК

Об этих инструкциях

Вы можете использовать любую поддерживаемую комбинацию операционной системы и IDE для создания этого приложения. Эти инструкции были написаны с использованием IntelliJ IDEA 2017.3 на macOS Sierra. Если вы используете другую операционную систему или комбинацию IDE, вы должны использовать эквивалентные операции для своей конкретной среды.

Этот учебник был последний раз проверен с помощью Jira 7.10.0 с использованием Atlassian Plugin SDK 6.3.10.

Шаг 1. Добавьте веб-панель с параметрами контекста доски

Чтобы создать страницу конфигурации доски:

  1. Создайте web-panel с label.
  2. Установите расположение web-panel в jira.agile.board.tools.
  3. Сошлитесь на свойства i18n из ресурсного модуля.
  4. Создайте шаблон Soy и поместите ссылку в модуль плагина web-resource.

Полный вид atlassian-plugin.xml:


<atlassian-plugin key="${atlassian.plugin.key}" name="${project.name}" plugins-version="2">
    <plugin-info>
        <description>${project.description}</description>
        <version>${project.version}</version>
        <vendor name="${project.organization.name}" url="${project.organization.url}" />
    </plugin-info>
 
    <resource type="i18n" name="i18n" location="custom-board-tool-section"/>
 
    <web-resource key="soy" name="custom-board-tool-section Web Resources">
        <resource type="soy" location="/soy/configuration-board.soy" name="My.addOn.tpl.board.config.myConfigurationPage"/>
        <context>custom-board-tool-section</context>
    </web-resource>
 
    <web-panel key="my-configuration-page" location="jira.agile.board.configuration" weight="1">
        <label key="my.configuration.page.label">My Configuration Page</label>
        <resource type="soy" name="view" location=":soy/My.addOn.tpl.board.config.myConfigurationPage" />
    </web-panel>
</atlassian-plugin>

Дополнительные сведения о дескрипторе приложения см. в разделе Настройка страницы файла дескриптора приложения.

  1. В custom -board-tool-section.properties, на которые мы ссылаемся, из дескриптора добавьте следующее:

my.configuration.page.label=My Configuration Page

Шаг 2. Добавьте код для рендеринга веб-панели

В следующем примере показано, как отображать веб-панель с использованием шаблонов Soy.

Файл configuration.board.soy помещается в каталог src / main / resources / soy /. Если хотите, вы можете использовать шаблоны Velocity.

Обратите внимание, что в шаблоне доступны два контекстных параметра: $ board.id и $ board.type.

Вы можете увидеть указанные параметры в следующем примере:


{namespace My.addOn.tpl.board.config}
 
/**
    Custom configuration page.
    @param board
*/
{template .myConfigurationPage}
    My first config page for board: {$board.id} with type: {$board.type}.
{/template}

Поздравления! Вы только что создали страницу конфигурации доски для своего приложения Jira Software P2.

Следующие шаги

  • Если вы хотите где-то сохранить информацию о конфигурации, используйте свойства доски.
  • Ваше приложение может определять пользовательские разрешения проекта или глобальные разрешения. Это может быть полезно, если вы хотите ограничить доступ к странице конфигурации доски вашего приложения.
  • Подробнее о добавлении пунктов меню в Jira.
  • Узнайте о модуле веб-панели.

По материалам Atlassian JIRA  Server Developer Adding a board configuration page