JIRA Administration
 | Admin UI for the JIRA Configuration |
| Type | XAR |
| Category | Application |
| Developed by | Vincent Massol, Simon Urli, Teodor Caras, XWiki Development Team |
| Support |
Community:
XWiki SAS
|
| Active Installs | 136 |
| Rating | |
| License | GNU Lesser General Public License 2.1 |
Table of contents
Description
Allows configuring JIRA instances (URL, ID, username/password) for your wiki. These configuration can the be used by other JIRA components such as the JIRA Macro or the JIRA Scripting API.
To use it, just go the Administration UI and click on "JIRA". You'll get the following screen in which you can add JIRA server configurations:
The Id field is a free-form field that you can fill with any name you wish for that JIRA instance. It can then be used, for example from the JIRA Macro such as in the screenshot example:
The Authentication type field define the type of authentication. Currently you can select either "No Authentication" or "Basic auth". When you select "Basic auth", the password field is either the user password or a user token (in Atlassian Cloud of JIRA Data Center). To create a token for Atlassian Cloud click here
{{jira id="xwikiorg"...}}...{{/jira}}JIRA 11.0.0+
Extending Authenticator
This application by default provide 2 type of authentication, "No Authentication" or "Basic auth" by default. This list can be extended this way.
For the frontend:
Create new UIX with theses parameters:
- config_id: An ID for the authenticator.
- translation_key: The translation key for the name of the authentication.
- config_displayer_reference: A displayer to show the parameters.
For this you can take as an example the basic auth authenticator UI
For the backend:
You will need to create a component of Role org.xwiki.contrib.jira.config.JIRAAuthenticatorFactory which will provide object of class JIRAAuthenticator. The component JIRAAuthenticatorFactory is expected to be named with the same ID than the ID on the UIX.
For this you can take as an example the BasicAuthJIRAAuthenticatorFactory class
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
Dependencies
Dependencies for this extension (org.xwiki.contrib.jira:jira-config-ui 11.1.0):
- org.xwiki.contrib.jira:jira-config-platform 11.1.0
