Перейти к основному содержимому

Настройка Atlassian Confluence

к сведению

Dispatch поставляется с плагинами хранилища и документов для Atlassian Confluence. На этой странице описаны доступные параметры этих плагинов.

Параметры настройки Dispatch для плагина хранилища​

API URL [обязательно]​

URL экземпляра Confluence. Для Cloud это корень сайта, например https://your-site.atlassian.net/; путь /wiki Dispatch добавляет сам, в том числе для сайта на собственном домене. Для Server/Data Center это URL экземпляра, включая context path, по которому он обслуживается, если такой есть.

Hosting Type [по умолчанию: cloud]​

cloud или server. К Confluence Cloud Dispatch обращается через REST v2 API, а к Confluence Server/Data Center — через REST v1. Это разные API, поэтому значение должно соответствовать вашей установке.

Username [обязательно]​

Имя пользователя для доступа к экземпляру Confluence. У этого пользователя должно быть право создавать страницы в пространстве.

Password [обязательно]​

API-токен для доступа к экземпляру Confluence. Как создать новый API-токен, описано по ссылке.

Root Incident Storage Page ID [обязательно]​

Идентификатор страницы, под которой создаётся собственная страница каждого инцидента. Его видно в URL страницы: /pages/<id>/<title>.

Это идентификатор страницы, а не ключ пространства, и это должна быть именно страница, а не папка Confluence Cloud. Документ не может лежать в папке Confluence, поэтому иерархия хранилища Dispatch — это страницы под страницами: страница инцидента под этой, а его подстраницы — под ней. Пространство определяется по этой странице, так что больше настраивать нечего; каждый инцидент попадает в это пространство, если только проект не направит его в другое место через тип тега хранилища.

Confluence требует, чтобы заголовки страниц в пространстве были уникальными, а Dispatch называет подпапки каждого инцидента по настройкам проекта storage_folder_one/storage_folder_two — одни и те же имена для всех инцидентов. Поэтому Dispatch добавляет к заголовку подстраницы префикс — заголовок страницы самого инцидента, и папка с именем Logs создаётся как INC-0001 - Logs. Имя, которое показывает Dispatch, при этом не меняется.

внимание

В прежних выпусках здесь указывался ключ пространства, а рядом было отдельное поле Parent ID of the pages. При обновлении идентификатор родительской страницы переносится в это поле, а старое удаляется, так что существующий экземпляр править не нужно. Опасен ручной ввод: ключ пространства нельзя прочитать как страницу, поэтому хранилище инцидента не создаётся, а каждая попытка пишет в лог Exception happened while creating page … under <space key>.

Open On Close [по умолчанию: false]​

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

примечание

Плагин Confluence пока этого не реализует: настройка принимается, но ни на что не влияет. При закрытии инцидента попытка записывается в лог как событие о сбое.

Readonly [по умолчанию: false]​

При закрытии инцидента документ инцидента будет помечен как доступный только для чтения. Участники по-прежнему смогут работать с документом, а остальные читатели — нет.

примечание

Плагин Confluence пока этого не реализует — так же, как и Open On Close выше.

Параметры настройки Dispatch для плагина документов​

API URL [обязательно]​

URL экземпляра Confluence. Для Cloud это корень сайта, например https://your-site.atlassian.net/; путь /wiki Dispatch добавляет сам, в том числе для сайта на собственном домене. Для Server/Data Center это URL экземпляра, включая context path, по которому он обслуживается, если такой есть.

Hosting Type [по умолчанию: cloud]​

cloud или server. К Confluence Cloud Dispatch обращается через REST v2 API, а к Confluence Server/Data Center — через REST v1. Это разные API, поэтому значение должно соответствовать вашей установке.

Username [обязательно]​

Имя пользователя для доступа к экземпляру Confluence. У этого пользователя должно быть право создавать страницы в пространстве.

Password [обязательно]​

API-токен для доступа к экземпляру Confluence. Как создать новый API-токен, описано по ссылке.