JIRA Issues Macro

Confluence 사이트가 JIRA 응용 프로그램에 연결되어 있으면 Confluence 페이지에서 JIRA 문제를 만들고 표시 할 수 있다. 

Confluence를 JIRA 소프트웨어 및 JIRA Service Desk를 포함한 JIRA 응용 프로그램에 연결할 수 있다. 

 

이 매크로를 사용하려면 먼저 Confluence와 JIRA 응용 프로그램이 응용 프로그램 링크를 통해 연결되어 있어야 한다. 

페이지를 보는 사람들은 JIRA 사이트에서 공개적으로 접근 가능한 이슈를 볼 수 있다. 

JIRA 사이트가 보기가 제한되어 있다면(즉, 사람들이 이슈를 볼 권한이 필요하다면) 제한된 이슈를 보기 전에 인증을 받아야 한다.

 

JIRA Issues Macro로 할 수 있는 일

JIRA Issues Macro를 사용하여 다음을 할 수 있다 :

  •  JQL(JIRA Query Language) 검색, 필터 또는 URL을 기반으로 페이지에 문제 목록을 표시
  • 단일 문제를 표시
  • 문제 수를 표시
  • Confluence를 종료하지 않고 새로운 쟁점을 만들고 페이지에 문제를 표시

 

JIRA Issues Macro 사용

JIRA Issues Macro를 페이지에 추가하려면 :

  1. Confluence 편집기에서 삽입 > 다른 매크로 선택
  2. 필요한 매크로 찾기 및 선택

자동 완성으로 매크로 항목 속도 향상 : 추천 매크로 목록을 보려면 {및 매크로 이름의 시작 부분을 입력.

기존 매크로 편집 : 매크로 자리 표시자를 클릭하고 편집 선택. 매크로 대화 상자 창이 열리고 매크로 매개변수를 편집할 수 있다.

 

Screenshot : Confluence 페이지에서 JIRA가 매크로를 발행하는 예


 

JQL(JIRA Query Language) 검색을 통해 문제점 표시

이 매크로를 사용하면 JQL(JIRA Query Language)을 사용한 검색 결과를 기반으로 페이지에 문제 목록을 표시 할 수 있다.

JQL은 SQL과 비슷한 간단한 쿼리 언어이다. 기본적인 JQL질의는 하나 이상의 값 또는 함수가 뒤따르는 연산자(예 : = 또는>)가 뒤따르는 필드로 구성된다.

예 :

  • 다음 쿼리는 'TEST'프로젝트의 모든 문제를 찾을 것이다.

    project = "TEST"
  • 다음 쿼리는 'CONF'프로젝트의 '문서'구성 요소에있는 모든 문제를 찾는다.

    project = CONF and component = documentation

JQL 구문에 대한 더 자세한 정보는 JIRA 소프트웨어 문서의 고급 검색을 참조.

 

JQL 검색을 기반으로 한 문제점 테이블을 표시하려면 :

  1. JIRA Issues 매크로를 Confluence 페이지에 삽입
  2. 검색 버튼 옆에있는 JIRA 서버를 선택
  3. 메시지가 나타나면 JIRA 서버에 로그인
  4. 검색 상자에 JQL 쿼리를 입력
  5. 검색 선택
  6. 디스플레이를 사용자 정의하려면 표시 옵션을 선택하고 문제점 표에 표시될 문제점 및 열 수를 조정
  7. 삽입 선택

Screenshot : JIRA 이슈 매크로 브라우저의 옵션을 표시합니다.

 

JIRA URL을 통한 이슈 표시

다음 JIRA 애플리케이션 URL중 하나를 JIRA Issues 매크로에 붙여 넣을 수 있다. Confluence는 즉시 URL을 JQL 검색으로 변환한다.

  • 문제 검색 또는 필터에 대한 URL
  • 단일 발행물의 URL
  • 검색 XML 뷰의 URL

자동 변환 : (매크로 브라우저를 불러 오지 않고) URL을 Confluence 편집기에 직접 붙여 넣을 수 있다. Confluence는 URL을 자동으로 JIRA Issues 매크로로 변환한다.

 

단일 발행물 또는 선택된 발행물 표시

단일 JIRA 문제를 표시하려면 다음 방법 중 하나를 선택 :

  • 문제의 URL을 Confluence 페이지에 직접 붙여넣기. (매크로 브라우저를 사용할 필요가 없다.) Confluence는 링크를 JIRA Issues 매크로로 자동 변환한다.
  • 또는 : JIRA 이슈 매크로를 페이지에 추가하고 최근에 열어본 페이지를 선택하여 최근 방문한 이슈를 확인. 문제점을 선택하고 삽입 선택
  • 또는 : JIRA 이슈 매크로를 페이지에 추가하고 이슈 URL을 매크로 브라우저의 검색 창에 붙여넣기
  • 또는 : JIRA 이슈 매크로를 페이지에 추가하고 JQL을 통해 매크로 브라우저에서 검색 조건을 정의한 다음 매크로 브라우저 내에서 검색 결과의 문제 옆에 있는 확인란 선택

이슈 키 또는 이슈 키와 요약만 표시하도록 선택할 수 있다. 매크로 자리 표시자를 선택하고 요약 표시 또는 요약 숨기기를 선택.

 

검색 결과에서 JIRA 이슈의 일부를 표시하려면 :

  1. JIRA 이슈 매크로를 페이지에 추가
  2. JQL을 통해 매크로 브라우저에서 검색 기준을 정의
  3. 매크로 브라우저에서 검색 결과의 필수 문제 옆에 있는 확인란 선택

스크린 샷 : 표시 할 문제의 하위 집합 선택

 

문제 수 표시

문제표 보다는 검색 결과로 표시되는 문제 수를 표시하도록 선택할 수 있다. JIRA Issues 매크로는 JIRA 어플리케이션의 검색과 링크된 문제의 개수를 표시한다.

Screenshot : Confluence 페이지에서 문제 수를 표시하는 JIRA Issues 매크로

문제 수를 표시하려면 :

  1. JIRA Issues 매크로를 페이지에 추가
  2. JQL을 통해 매크로 브라우저에서 검색 기준을 정의
  3. 표시 옵션 선택 매크로 브라우저에서 '표시 옵션'옆 총 문제 수 선택
  4. 삽입 선택

 

새 발행물 만들기 

Confluence 페이지를 편집하는 동안  Confluence 편집기에서 나오지 않고 JIRA에서 이슈를 생성하고 Confluence 페이지에 표시 할 수 있다.

 

이슈를 만들고 페이지에 추가하려면 :

  1. JIRA Issues 매크로를 페이지에 추가
  2. 신규 발행 생성 선택
  3. 메시지가 나타나면 JIRA 서버, 프로젝트 및 이슈에 관한 정보를 입력
  4. 삽입 선택

Confluence는 JIRA 애플리케이션에 요청을 보내서 이슈를 생성한 다음 새로 생성된 이슈를 페이지에 표시한다.

제한 사항

JIRA Issue 매크로는 선택된 프로젝트에서 이슈를 생성할 수 없다면 알려준다. 

프로젝트가 JIRA Issues 매크로에서 지원하지 않는 필수 필드, 필드 구성 또는 기타 사용자 정의를 가지고 있기 때문일 수 있다. 

이 경우 JIRA 응용 프로그램에서 직접 문제를 생성해야 한다.

 

제한된 문제를 표시하도록 응용 프로그램 링크 구성

이 매크로를 사용하려면 먼저 Confluence와 JIRA 사이트가 응용 프로그램 링크를 통해 연결되어 있어야 한다.

JIRA 사이트에서 익명 사용자가 문제를 볼 수 있도록 허용하려면 애플리케이션 링크를 구성해야하지만 JIRA 애플리케이션과 Confluence간에 수신 또는 발신 인증을 구성할 필요가 없다. 

Confluence 페이지를 보는 사람들은 공개적으로 접근 가능한 이슈들을 볼 수 있다.

JIRA 사이트의 보기가 제한되어 있거나 특정 프로젝트 또는 이슈가 특정 사람들만 볼 수 있도록 제한되어 있는 경우 제한된 문제를 보기 전에 로그인 및 승인하라는 메시지가 표시된다.

 

JIRA 애플리케이션에서 HTML 렌더링하기

Confluence에서 JIRA로의 애플리케이션 링크를 설정하면 JIRA의 포맷된 필드를 Confluence에 표시할 수 있다. 

그렇지 않으면, 포맷된 필드는 JIRA 이슈 매크로의 출력 내에서 사라진다. 이는 신뢰할 수 없는 JIRA 서버가 악의적인 HTML을 제공할 가능성을 방지하기 위한 것이다. 

이를 알 수 있는 가장 가능성있는 필드는 설명 필드에 있다.

 

이 예제는 JIRA에 description 칼럼을 어떻게 표시 할 수 있는지 보여준다 :

Description

This is

  • the description
  • of my issue

JIRA와 Confluence 사이에 응용 프로그램 링크가 없으면 JIRA Issue 매크로가 다음과 같이 나타난다 :

Description

<p>This is<ul><li>the description</li><li>of my issue</li></ul></p>

 

JIRA Issues 매크로 비활성화하기

이 기능은 'JIRA Macros'라는 부가 기능(플러그인)에 의해 제공된다. 사이트에서 매크로를 사용할 수 없게 하려면 추가 기능을 사용하지 않도록 설정하면 된다. 추가 기능 비활성화 및 활성화를 참조.

 

노트

HTTPS : JIRA Issues 매크로는 Confluence 서버가 JIRA SSL 인증서를 받아들이도록 설정되어 있으면 SSL 하에서 실행되는 JIRA 어플리케이션에 접근할 수 있다. 

SSL을 통해 LDAP 또는 JIRA 응용 프로그램 또는 기타 서비스에 연결 참조.

따옴표없이 필드의 이름을 사용하여 테이블에 사용자 지정 필드를 열로 추가할 수 있다. 이전 버전의 매크로에서는 사용자 정의 필드 ID를 사용해야했다. 예) customfield_10100


위키 마크 업 예제

이 예제는 편집기 외부에 매크로를 추가하려는 경우 (예 : 스페이스의 세로 막대, 머리글 또는 바닥 글에 사용자 지정 내용으로) 유용

매크로 이름 : jiraissues

매크로 본문 :  없음

이 예제는 JIRA 필터를 사용

{jiraissues:anonymous=true|url=https://jira.atlassian.com/issues/?filter=41225}


매크로 브라우저를 통해 사용할 수 없는 많은 추가 매개 변수는 저장소 형식 및 wiki 마크 업에서 사용할 수 있다.

 Click here to expand...

매개변수 이름

필수

기본값

매개변수 설명 및 허용된 값

anonymous

No

false

이 매개변수가 'true'로 설정되면 JIRA 애플리케이션은 무제한보기를 허용하는 이슈만 반환한다. 즉, 익명 사용자가 볼 수있는 이슈이다. 이 매개변수를 생략하거나 'false'로 설정하면 관리자가 JIRA 애플리케이션과 Confluence 간의 통신을 구성한 방법에 따라 결과가 달라진다. Confluence는 기본적으로 사용자가 볼 수 있는 권한만 표시한다.

참고 : 이 매개변수는 위키 마크 업을 통해 매크로를 삽입하거나 페이지의 저장 형식을 편집할 때만 사용할 수 있다. 매크로 브라우저는 이 매개변수를 제공하지 않는다.

baseurl

No

'url' 매개변수 값

'baseurl'을 지정하면 JIRA 애플리케이션을 가리키는 헤더의 링크는 'url' 매개변수의 값 대신 이 기본 URL을 사용한다. 이것은 Confluence가 다른 사용자가 사용하는 URL과 다른 URL로 JIRA에 연결할 때 유용하다.

columns

No

기본적으로 다음 열이 표시된다:

  • type
  • key
  • summary
  • assignee
  • reporter
  • priority
  • status
  • resolution
  • created
  • updated
  • due

세미콜론(;)으로 구분된 JIRA 컬럼 이름 목록. 커스텀 컬럼을 포함하여 JIRA 어플리케이션이 인식할 수 있는 많은 컬럼을 포함할 수 있다.

'작업 비율'또는 '해결 시간'과 같이 JIRA에서 계산해야 하는 것과 같은 일부 열은 Confluence에서 볼 수 없다.

count

No

false

이 매개 변수가 'true'로 설정되면, 이슈 목록에는 JIRA의 이슈 개수가 표시된다. 카운트는 JIRA 사이트에 링크된다.

cache

No

on

매크로는 JIRA 쿼리의 결과로 발생하는 이슈의 캐시를 유지한다. 'cache' 매개변수가 'off'로 설정되면, 매크로가 다시 로드될 때마다 캐시의 관련 부분이 지워진다.( 'false'값도 작동하며 'off'와 같은 효과를낸다.)

참고 : 이 매개변수는 위키 마크 업을 통해 매크로를 삽입하거나 페이지의 저장 형식을 편집할 때만 사용할 수 있다. 매크로 브라우저는 이 매개변수를 제공하지 않는다.

height

No

480 

(렌더링 모드가 동적인 경우)

이슈를 표시하는 테이블의 높이(픽셀 단위). 이 높이 지정은 다음 상황에서 무시된다.

  • 'renderMode' 매개변수가 'static(정적)'으로 설정된 경우
  • 문제가 PDF 또는 Word 문서, 전자 메일 메시지 또는 RSS 피드에 표시될 때

참고 : 이 매개변수는 위키 마크 업을 통해 매크로를 삽입하거나 페이지의 저장 형식을 편집할 때만 사용할 수 있다. 매크로 브라우저는 이 매개변수를 제공하지 않는다.

renderMode

No

static(정적)

값이 'dynamic(동적)'인 경우, JIRA Issues 매크로는 사람들이 다음과 같이 조작할 수 있는 대화형 디스플레이를 제공한다 :

  • 열 머리글을 클릭하여 출력을 정렬
  • 열을 다른 순서로 드래그 앤 드롭
  • 디스플레이에서 컬럼을 임시로 제거
  • 보다 빠른 응답 시간을 위해 한 번에 한 페이지씩 보기

'static(정적)' 값은 동적 디스플레이 기능을 비활성화한다.

참고 : 이 매개변수는 위키 마크 업을 통해 매크로를 삽입하거나 페이지의 저장 형식을 편집할 때만 사용할 수 있다. 매크로 브라우저는 이 매개변수를 제공하지 않는다.

title

No

JIRA Issues

이 매개 변수를 사용하여 이슈 테이블의 맨위에 있는 제목 텍스트를 사용자 정의 할 수 있다. 예를 들어 제목을 'Bugs-to-fix'로 설정하면 기본 'JIRA Issues'텍스트가 바뀐다. 이렇게하면 표시된 이슈 목록에 더 많은 컨텍스트를 제공 할 수 있다.

참고 : 이 매개변수는 위키 마크 업을 통해 매크로를 삽입하거나 페이지의 저장 형식을 편집할 때만 사용할 수 있다. 매크로 브라우저는 이 매개변수를 제공하지 않는다.

url

Yes

none

선택한 이슈에 대한 XML보기의 URL

참고 : 'url' 매개변수의 URL에 tempMax 인수가 없으면 tempMax 기본값은 500이다. JIRA 서버가 3.12 이하인 경우 JIRA Issues 매크로는 최대 500개의 이슈를 반환한다. JIRA 서버 버전이 3.13 이상이면 500값은 JIRA Issues 매크로가 페이지 당 최대 500 이슈를 반환함을 의미한다.

width

No

100%

문제를 표시하는 표의 너비를 백분율(%) 또는 픽셀(px)로 입력할 수 있다.

참고 : 이 매개변수는 위키 마크 업을 통해 매크로를 삽입하거나 페이지의 저장 형식을 편집할 때만 사용할 수 있다. 매크로 브라우저는 이 매개변수를 제공하지 않는다.