This is the fourth exercise of the Basic Level. The main goal of this exercise is to give you an idea of how to set up and manage Xporter for Jira Permission Schemes.
Permission schemes allow administrators to define which Projects, Issue Types, User Roles, and Groups will be available to use Xporter, as well as manage the templates allowed to be used on each of those available Issue Types.
For further information please check our documentation here. |
In order to perform the initial setup, navigate to Permission Schemes on the Xporter for Jira administration section Apps page of the Jira Administration and you'll see a warning informing you There are no Xporter for Jira Permissions Schemes configured, a + Add button and an empty grid below it. Once a Permission Scheme is configured, its entry will be displayed on that grid.
Right now the only option available to you is:
In order to perform this exercise properly, please create a Basic software development Project on your Jira instance, and name it as Academy. You'll need to have at least 2 templates installed too. Also, create a New Jira user named Arthur and let it be associated only with the jira-software-users Group (it will be by default). After that, on Jira Administration -> System, on the sidebar under Security, access Project roles and add a Project Role named King. Finally, go to the project Academy -> Project settings, and on the sidebar access Users and roles. Select Add users to a role, and on the dialog add the user Arthur to the role King. After all that is done, create a Bug issue, a Task issue and an Improvement issue for your Project. |
On the Permission Schemes on the Xporter for Jira administration section Apps page of the Jira Administration, click on + Add button and fill in the Name and Description of your Permission Scheme - name it Academy - and after clicking the Create button a Success! message will be displayed informing the Permission Scheme was successfully added.
It will be displayed with an entry on the Xporter for Jira Permission Schemes grid.
If the Permission Scheme name is the same of an existing Permission Scheme, an Error! message will be displayed when clicking the Create button, informing you of that conflict. |
On your newly created Permission Scheme entry, click the Edit button on the Operations column, and a pop-over dialog will be displayed.
Input a Description to your Permission and click the Update button, and now your Permission Scheme entry will have its description exhibited as well.
You can change the Name and Description of your Permission Scheme when editing it. |
On your created Permission Scheme entry, click the Permissions button on the Operations column, and will be redirected to the Permissions page, where you can define the permissions of the Permission Scheme.
Here you are able to define the:
As well as mapping issue types into corresponding templates, allowing that for specific issue types, only specific templates will be available.
Now, click the Assign on Issue Types allowed to be exported and on the pop-over dialog pick only Bug, Improvement and Task and click Assign. The previous warning No Issue Types assigned for this Permission Scheme will now be replaced with your picked choices.
Click the X next to Improvement and it will be removed.
Now, click the Assign on Roles allowed to use Xporter for Jira and on the pop-over dialog pick the select box next to Roles on the top of the list - all listed roles will be selected - and click Assign. The previous warning No Roles assigned for this Permission Scheme will now be replaced with your picked choices.
Click the X next to all the listed items except King.
Now, click the Assign on Groups allowed to use Xporter for Jira and on the pop-over dialog don't select any of the options and click Assign. The warning No Roles assigned for this Permission Scheme will still be displayed since no option was picked.
A Warning message will be displayed informing the permission scheme does not have associations between issue types and templates and as consequence Xporter for Jira will be unusable with the permission scheme.
We'll correct this by clicking the Assign Templates button on each issue type entry, and select a different template to assign to each Issue Type on the pop-over dialog.
All the templates will be available to be assigned on Issue Types, but their Scope settings are still respected - so, If you assign a template with only an Active Scope to Single Export, you won't be able to Bulk Export with it. |
Back on the Permission Schemes on the Xporter for Jira administration section Apps page of the Jira Administration, on our created Permission Scheme entry, click the Projects button on the Operations column, and a pop-over dialog will be displayed.
On the pop-over dialog pick the select box next to Projects on the top of the list - all listed Projects will be selected - and click Assign. A Success! message will be displayed and all Projects will now be listed under the column Projects of our created Permission Scheme entry.
If you click the Projects button on the Operations column again, a Warning! message will be displayed informing there are no projects to select.
Now, under the column Projects of our created Permission Scheme entry, click the X next to each listed project leaving only Academy.
On our created Permission Scheme entry, click the Copy button on the Operations column, and a Success! message will be displayed, along with a new entry that will be listed, named Academy (Copy).
Only the name, description and permissions are copied. |
On the Academy (Copy) Permission Scheme entry, click the Delete button on the Operations column, and a prompt dialog will be displayed asking if you're sure you want to delete the Permission Scheme. Click the Confirm button, and now that entry will be removed.
With all the Permission Schemes set up done, navigate to the Global Settings on the Xporter for Jira administration section Apps page of the Jira Administration, and on Enable Xporter for Jira for all projects and all users under Global Permissions tick Off and Save.
Also, make sure the Enable Xporter for Jira panel on Single Issue View is ticked On.
With this option set to Off, only the Projects, Issue types, User Roles, and Groups, as well as associated templates configured on the Permission Schemes are allowed to use Xporter |
On a new browser window, logged in as Arthur, navigate to the Improvement issue type of the project Academy, and you will notice the Xporter panel isn't displayed on the right sidebar. Click the Export drop-down menu, select Xporter for Jira and you will navigate to a page titled Export issues using Xporter for Jira where an Error! message will be displayed informing you are unable to export the selected issues. Clicking the Check Details button, an Error Reporting pop-over will be displayed, with an entry of the Issue Key you are trying to export, along with the description User has no permissions for using Xporter for Jira in current Permission Scheme.
Still logged in as Arthur, navigate to the Bug issue type of the project Academy, and you will notice the Xporter panel is displayed on the right sidebar. However, on the Template selector, the only available option will be the template you've set up on the Permission Scheme definition to that issue type. Using the Export drop-down menu, the same options will be listed.
Now try to bulk Export all the 3 issues from the project Academy, and an Error! message will be displayed informing you are unable to export the selected issues. Clicking the Check Details button, an Error Reporting pop-over will be displayed, with an entry of the Improvement Issue Key you are trying to export, along with the description Issue Type not assigned for the current Permission Scheme.
If you now try to bulk Export only the Bug and Task issues from the project Academy, an Error! message will still be displayed informing you are unable to export the selected issues. Clicking the Check Details button, an Error Reporting pop-over will be displayed, because they don't have a common template assigned on the permission scheme definitions.
With your user with Administration access, navigate to the Permission Schemes on the Xporter for Jira administration section Apps page of the Jira Administration, click Permissions under the Operations column of your entry, and map a common template to both the Bug and Task issue types.
Back on the browser using the user Arthur, try to bulk Export the Bug and Task issues from the project Academy again, and now you'll be able to complete the operation.
With your user with Administration access, navigate to the Permission Schemes on the Xporter for Jira administration section Apps page of the Jira Administration, click Permissions under the Operations column of your entry, click the Assign on Groups allowed to use Xporter for Jira and on the pop-over dialog select jira-administrators and click Assign. Also, click the X next to King under the Roles allowed to use Xporter for Jira.
Now, back to the browser using the user Arthur, try to bulk export the Bug and Task issues from the project Academy again, and an Error! message will be displayed informing you are unable to export the selected issues. Clicking the Check Details button, an Error Reporting pop-over will be displayed, with an entry informing your user doesn't have permissions.
This Exercise is now completed - move to Exercise 5 to learn how to manage your Xporter for Jira license.
If you like this exercise, please share your opinion on the page by just leaving a comment or a Thank you in advance. Enjoy our product. |
. Your opinion is very important to us.