Technical
Former user (Deleted)
Raman Saravanakumar
1.Purpose:
This document purpose is to show implementation of Enhanced User Profile for Jira.
2.Introduction:
This JIRA plugin to help to create multiple users by the help of CSV format file. To create new user, we need four mandatory fields,
- User Name.
- Display Name.
- Email.
- password.
we can able to add additional profile details like,
- Supervisor.
- Email.
- Position.
- City.
- Business Phone.
- Company.
- Business Unit.
- Location.
- Cost Centre.
3.Scope:
Enhanced User Profile for Jirar application focused in upsert part. we can able to do update the profile to adding additional property name list.
4.Modules:
Here we are using three modules,
- Import User Profile: This page contains file upload button and submit button. we used JIRA AUI web components for file upload function.
here file upload accept only the ".csv" file format.
Validation:- File upload button have validation that it can accept only ".csv" file and others it will show error popup window
to show error message "only csv file accepted". - "Submit" button not allow to submit form null selection in file upload button.
- File upload button have validation that it can accept only ".csv" file and others it will show error popup window
- Fields Mapping: The purpose of field mapping is to read the csv file headers and map those header name to our default four field values.
this map help to read the related header name field data. Default fields are,- User Name.
- Display Name.
- Email.
- Group Name.
- User Profile.
- We have field selction validation for all dropdawn list. without selection we can't submit form.
- Email validation: if we select wrong field for email user will not create,
error message will show in imported users status page in remark column.
- Imported Users Status: This page contain table for showing user create status. we have following fields in table,
- User Name.
- Display Name.
- Email.
- Group Name.
- Properties.
- Status.
- Remark.
5.Process Flow Description:
5.1 Below steps to Import Users:
Step 1: Go to Administration page -> Click on Add-ons -> Go to Bulk Profile Importer section and click on “Import Users Profiles”.
Step 2: Choose file from your computer and click on next button.
Step 3: The file should be in a CSV format, there are 4 fields that are required for every import User name, Display name, Email ID and
User Profile, should be provided, group name is not mandatory. Use ";" to group name one to another.
Step 4: If you are using any other language except English please save file as a CSV UTF-8(Comma delimited) format file.
5.2 Below steps for map the csv file Header names with default header names:
Step 1: Map the JIRA user details with CSV file Header Name. If a field is mapped with field already, the same field should not be mapped again.
click on “Create Users” button.
Step 2: If user want assign default group names to user select "Don't map this field" option.
Step 3: Select multiple User Profile Names from multi selector.
5.2 Below steps for Imported user's status:
Step 1: Imported Users Status page will display status of user creation.
Step 2: Click on “User Management” button to see all newly created user names.
6. User Profile:
Hover Profile is a convenient popup balloon that provides quick access to key information about other JIRA users throughout the JIRA interface.
Here we can see our additional profile details which we have added in Fields Mapping Screen.
For editing user profile hover here, we used webresource configuration in pom.xml file. please check JIRA documentation for more details.
In our Enhanced User Profile for Jira, we are displaying edited user profile hover,
- Issue view page,
- User management page.
for this we need to give web resource configuration,
- jira.admin: Anywhere in the admin section.
- jira.view.issue: The view issue page in JIRA.
we need to configure java script page for add our property list in hover. here we created BPIUserProfil.js for override property details.
Menu:
AvailableVersions:
- v 1.0
- v 1.1