Объединение макросов в confluence
Перед каждым аналитиком возникает выбор представления и формирования информации. Конечно, хочется выбрать более легкий способ, но не всегда этот способ соответствует ожиданиям читающего. В данной статье я поделюсь проблемами, которые были решены в рамках формирования и сопровождения реальных требований. Надеюсь, моя статья вдохновит на использование более сложных инструментов confluence.
Динамический поиск по дочерним страницам
Пространство моего проекта содержит более 800 страниц требований. При использовании стандартного поиска confluence, я столкнулся с проблемой. Дело в том, что поиск выполняется по всему пространству и требует фильтрации для более узкой выборки. Дополнительно, поиск выполняется по содержимому страниц и названиям загруженных файлов. Это не всегда удобно, особенно если необходимо искать страницы в определённой области пространства. В результате была поставлена задача реализовать поиск только по названию страниц.
Для реализации необходимо определить область поиска. У меня это был раздел требований в котором содержались страницы следующей иерархии:
Создаем пустую страницу в любом месте пространства и добавляем макрос «Отображение дочерних»:
В настройках макроса указываем родительскую страницу. Это будет область нашего поиска. После сохранения на странице отобразятся все дочерние страницы каждого уровня иерархии. Кликаем правой кнопкой на странице и выбираем «Просмотр кода страницы». В коде страницы нам необходимо найти и скопировать все ссылки дочерних страниц в html. Так как на странице много кода, можно воспользоваться поиском по названию одной из страниц. Ссылки на странице размещены одной строкой и содержат лишние теги. С помощью инструментов форматирования html (для массового удаления лишних тегов используем word), код необходимо привести к виду:
Название страницы 1
Название страницы 2
Название страницы 3
……Вторым шагом создаем страницу, где будет размещаться наш поиск. На страницу добавляем макрос-рамку «HTML»:
Данный макрос выполнит код html, который мы разместим в рамку. В зависимости от ваших потребностей, вы можете разместить любые вспомогательные html-элементы на форме. Реализуем следующим образом:
1) Разместим два раскрывающихся списка (при выборе значения списка, текст подставляется в строку поиска):
2) Разместим поле для поиска и кнопку «очистить»:
3) Далее добавим ссылки из первого шага:
4) Добавляем скрипты для раскрывающихся списков, поиска и кнопки «очистить»:
5) Сохраняем страницу и пользуемся.
6*) Для более эстетичного отображения страницы, можно разместить макрос html в рамке макроса Aura Panel.
В результате мы реализовали возможность выполнять динамический поиск по заданной области пространства. Я не сомневаюсь, что разработчики и тестировщики оценят такую фичу и будут чаще читать ваши максимально «понятные» требования. Минус данного подхода: при добавлении новых страниц потребуется обновление набора ссылок. Но это займет всего 10 минут вашего времени.
Многоуровневые формы
Часто аналитику требуется объединять большие объёмы сложно читаемых данных. Для этого Сonfluence предоставляет большой набор макросов. Например, с помощью макросов Aura-Tab и Aura-Tab Group можно создать объект с табами. Макросы обладают гибкими настройками, но проблема заключается в одном уровне вложенности создаваемых форм. В результате была поставлена задача реализовать многоуровневую вложенность с помощью объединения макросов.
Давайте разберемся, как работают макросы Aura-Tab и Aura-Tab Group. Нам необходимо разместить макрос Aura-Tab Group, в котором будут размещены макросы Aura-Tab. Каждый Aura-Tab представляет собой таб для переключения между контентом, который вы разместите в рамку макроса. После сохранения мы получим одноуровневые формы с контентом.
Для добавления второго уровня вложенности нам потребуются макросы UI Tab и UI Tabs. Принцип работы макросов такой же, как у Aura.
Разместим макрос UI Tabs в рамке макроса Aura-Tab. В рамке UI Tabs разместим нужное количество табов UI Tab. Сохраняем и пользуемся.
С помощью объединения группы макросов нам удалось реализовать двухуровневый список табов. Данный способ отлично подходит для описания сложных объектов.
Динамическое объединение таблиц
В работе с требованиями, аналитики используют различные способы представления информации. Одним из популярных и доступных способов является табличное представление. Понимая данный факт, confluence предоставляет большой набор инструментов для работы с таблицами. В этот раз мы решим проблему динамического объединения таблиц. Наша задача создать таблицу, которая будет объединять несколько таблиц и предоставлять актуальные данные.
Допустим, у нас есть две таблицы, которые заполняются разными людьми из разных источников данных.
Для использования таблицы, нам необходимо разместить каждую таблицу в рамке макроса «Выборка таблицы». В настройках макроса нужно задать уникальное имя выборки.
Далее создаем страницу и добавляем макрос объединения таблиц Table Transformer.
Выбираем один из трех способов объединения, в нашем случае будет Lookup tables. Нажимаем кнопку вставить.
В рамку макроса размещаем два макроса «Вставка выборки из таблицы». В настройках выборки ссылаемся на уникальное имя, которые мы указывали в макросе «Выборка из таблицы».
В рамку макроса размещаем два макроса «Вставка выборки из таблицы». В настройках выборки, ссылаемся на уникальное имя которые мы указывали в макросе «Выборка из таблицы».
Возвращаемся в настройки макроса Table Transformer. И видим, что макрос самостоятельно определил ключ объединения таблиц (Паспорт).
Результат после сохранения страницы:
Таким образом, при изменении данных в исходных таблицах, данные в объединенной таблице будут обновляться. Для объединенной таблицы доступны стандартные функции фильтрации. В зависимости от потребностей, доступно кастомное объединение. Например, можно прописать SELECT * FROM T1 OUTER JOIN T2 ON T1.'Паспорт' = T2.'Паспорт' и получить такой же результат. T1 и T2 это соответственно первая и вторая таблица в рамке макроса. Отличная фича для экономии времени при работе с таблицами, главное не показывать свои «кастомные селекты» разработчикам sql.
Заключение
В данной статье описана лишь часть «необычных» объединений макросов. Не стоит забывать о гибкости и возможностях confluence. Попробуйте создать что-то новое в своей песочнице. Надеюсь данная статья поможет в написании реальных требований.
