Secure JIRA Macro
Last modified by Admin on 2024/08/23 01:24
 | JIRA macro supporting user authentication |
| Type | XAR |
| Category | |
| Developed by | |
| Active Installs | 28 |
| Rating | |
| License | GNU Lesser General Public License 2.1 |
| Compatibility | 5.4+ |
Table of contents
- Description
- Usage
- Macro Configuration
- Parameters
- Examples
- Use JIRA Macro as Table with no columns defined, using the default hardcoded ones
- Use JIRA Macro as Table using custom columns
- Use JIRA Macro as List with no columns defined, using the default hardcoded ones
- Use JIRA Macro as List using custom columns
- Use JIRA Macro as Enum with no columns defined, using the default hardcoded ones
- Use JIRA Macro as Enum, using custom columns
- Use JIRA Macro as Table using JQL with no columns defined, using the default hardcoded ones
- Use JIRA Macro as Table using JQL with custom columns defined
- Prerequisites & Installation Instructions
Description
Fetches information from a JIRA server and displays them as a table, list or enumeration.
Usage
{{securejira style="..." columns="..." columnsNames="..." notes="..." url="..." }}
...content describing the JIRA issues to return...
{{/securejira}}
...content describing the JIRA issues to return...
{{/securejira}}
Macro Configuration
Go to "Administer Wiki" and in "Application" section you will find "Secure Jira Config" tab.
In the configuration you have to set your username, your password and the url to the JIRA instance.
Parameters
| Name | Optional | Allowed values | Description |
|---|---|---|---|
| style | yes | table/list/enum | Parameter which describes the way the macro should display the results. Available options: table, list, enumeration |
| notes | yes | true/false | Parameter which takes additional notes and puts them in a separate column. This information must be specified near the issue. This information is not taken from JIRA |
| url | yes | string | URL to the JIRA |
| columns | yes | Comma separated list | Parameter which describes the columns that will be displayed when using the table option. These values represent fields from JIRA like type, id, assignee, status |
| columnsNames | yes | Comma separated list | The name of the columns you want to be used in the table header. They must have the same order as in columns parameter |
| jql | yes | true/false | If true, it will interpret the macro content as a JQL Query |
Examples
Use JIRA Macro as Table with no columns defined, using the default hardcoded ones
{{securejira style="table" notes="true" url="https://jira.xwiki.org" }}
XWIKI-1000| HARD TO FIX
XWIKI-4356|EASY TO FIX
XWIKI-3677|This issue takes too long. Please find a solution ASAP
{{/securejira}}
XWIKI-1000| HARD TO FIX
XWIKI-4356|EASY TO FIX
XWIKI-3677|This issue takes too long. Please find a solution ASAP
{{/securejira}}
Use JIRA Macro as Table using custom columns
{{securejira style="table" columns="type,key, summary,status, assignee, created" columnsNames="Issue type,Issue Id, Short description,Issue Status, Person to Fix this, Creation Date" notes="true" url="https://jira.xwiki.org" }}
XWIKI-1000|HARD TO FIX
XWIKI-4356|EASY TO FIX
XWIKI-3677|This issue takes too long. Please find a solution ASAP
{{/securejira}}
XWIKI-1000|HARD TO FIX
XWIKI-4356|EASY TO FIX
XWIKI-3677|This issue takes too long. Please find a solution ASAP
{{/securejira}}
Use JIRA Macro as List with no columns defined, using the default hardcoded ones
{{securejira style="list" notes="true" url="https://jira.xwiki.org"}}
XWIKI-1000|Note 1
XWIKI-4356|Note 2
XWIKI-3677|Note 3
{{/securejira}}
XWIKI-1000|Note 1
XWIKI-4356|Note 2
XWIKI-3677|Note 3
{{/securejira}}
Use JIRA Macro as List using custom columns
{{{securejira style="list" columns="key, summary,type,status, assignee" columnsNames="Issue Id, Description, Issue type, Issue status, Who will fix it ?" notes="true" url="https://jira.xwiki.org"}}
XWIKI-1000|Note 1
XWIKI-4356|Note 2
XWIKI-3677|Note 3
{{/securejira}}
XWIKI-1000|Note 1
XWIKI-4356|Note 2
XWIKI-3677|Note 3
{{/securejira}}
Use JIRA Macro as Enum with no columns defined, using the default hardcoded ones
{{securejira style="enum" notes="false" url="https://jira.xwiki.org"}}
XWIKI-1000|Note 1
XWIKI-4356|Note 2
XWIKI-3677|Note 3
{{/securejira}}
XWIKI-1000|Note 1
XWIKI-4356|Note 2
XWIKI-3677|Note 3
{{/securejira}}
Use JIRA Macro as Enum, using custom columns
{{securejira style="enum" columns="key, status, type" columnsNames="Issue Id, Issue Status, What Type is this?" url="https://jira.xwiki.org"}}
XWIKI-1000|Note 1
XWIKI-4356|Note 2
XWIKI-3677|Note 3
{{/securejira}}
XWIKI-1000|Note 1
XWIKI-4356|Note 2
XWIKI-3677|Note 3
{{/securejira}}
Use JIRA Macro as Table using JQL with no columns defined, using the default hardcoded ones
{{securejira style="table" jql="true" url="https://jira.xwiki.org"}}
(project in (XWIKI) and fixVersion in ("3.2 M1", "3.2 M2", "3.2 M3", "3.2 RC1", "3.2") and resolution in ("Fixed")) or (project in (XE) and fixVersion in ("3.2 M1", "3.2 M2", "3.2 M3", "3.2 RC1", "3.2") and resolution in ("Fixed")) or (project in (XRENDERING) and fixVersion in ("3.2 M1", "3.2 M2", "3.2 M3", "3.2 RC1", "3.2") and resolution in ("Fixed")) or (project in (XCOMMONS) and fixVersion in ("3.2 M1", "3.2 M2", "3.2 M3", "3.2 RC1", "3.2") and resolution in ("Fixed")) or (project in (XEM) and fixVersion in ("3.2 M1", "3.2 M2", "3.2 M3", "3.2 RC1", "3.2"))
{{/securejira}}
(project in (XWIKI) and fixVersion in ("3.2 M1", "3.2 M2", "3.2 M3", "3.2 RC1", "3.2") and resolution in ("Fixed")) or (project in (XE) and fixVersion in ("3.2 M1", "3.2 M2", "3.2 M3", "3.2 RC1", "3.2") and resolution in ("Fixed")) or (project in (XRENDERING) and fixVersion in ("3.2 M1", "3.2 M2", "3.2 M3", "3.2 RC1", "3.2") and resolution in ("Fixed")) or (project in (XCOMMONS) and fixVersion in ("3.2 M1", "3.2 M2", "3.2 M3", "3.2 RC1", "3.2") and resolution in ("Fixed")) or (project in (XEM) and fixVersion in ("3.2 M1", "3.2 M2", "3.2 M3", "3.2 RC1", "3.2"))
{{/securejira}}
Use JIRA Macro as Table using JQL with custom columns defined
{{securejira style="table" columns="key, status, type, summary, key, key" columnsNames="Issue Id, What is the status ? , Issue type, The summary, key ONE, Same key again" jql="true" url="https://jira.xwiki.org"}}
(project in (XWIKI) and fixVersion in ("3.2 M1", "3.2 M2", "3.2 M3", "3.2 RC1", "3.2") and resolution in ("Fixed")) or (project in (XE) and fixVersion in ("3.2 M1", "3.2 M2", "3.2 M3", "3.2 RC1", "3.2") and resolution in ("Fixed")) or (project in (XRENDERING) and fixVersion in ("3.2 M1", "3.2 M2", "3.2 M3", "3.2 RC1", "3.2") and resolution in ("Fixed")) or (project in (XCOMMONS) and fixVersion in ("3.2 M1", "3.2 M2", "3.2 M3", "3.2 RC1", "3.2") and resolution in ("Fixed")) or (project in (XEM) and fixVersion in ("3.2 M1", "3.2 M2", "3.2 M3", "3.2 RC1", "3.2"))
{{/securejira}}
(project in (XWIKI) and fixVersion in ("3.2 M1", "3.2 M2", "3.2 M3", "3.2 RC1", "3.2") and resolution in ("Fixed")) or (project in (XE) and fixVersion in ("3.2 M1", "3.2 M2", "3.2 M3", "3.2 RC1", "3.2") and resolution in ("Fixed")) or (project in (XRENDERING) and fixVersion in ("3.2 M1", "3.2 M2", "3.2 M3", "3.2 RC1", "3.2") and resolution in ("Fixed")) or (project in (XCOMMONS) and fixVersion in ("3.2 M1", "3.2 M2", "3.2 M3", "3.2 RC1", "3.2") and resolution in ("Fixed")) or (project in (XEM) and fixVersion in ("3.2 M1", "3.2 M2", "3.2 M3", "3.2 RC1", "3.2"))
{{/securejira}}
Prerequisites & Installation Instructions
We recommend using the Extension Manager to install this extension (Make sure that the text "Installable with the Extension Manager" is displayed at the top right location on this page to know if this extension can be installed with the Extension Manager). Note that installing Extensions when being offline is currently not supported and you'd need to use some complex manual method.
You can also use the following manual method, which is useful if this extension cannot be installed with the Extension Manager or if you're using an old version of XWiki that doesn't have the Extension Manager:
- Log in the wiki with a user having Administration rights
- Go to the Administration page and select the Import category
- Follow the on-screen instructions to upload the downloaded XAR
- Click on the uploaded XAR and follow the instructions
- You'll also need to install all dependent Extensions that are not already installed in your wiki
