Jira comes with standard, built-in fields, like “Summary”, “Description”, and “Components” but you can also create additional Custom Fields to track more data.
Your instance starts out with 8-30 fields, on the “Custom Fields” page, depending on whether you have Cloud or Server. For example, Jira Server 7.7.1 comes with 8 custom fields. Installing Jira Service Desk on top of Jira Server adds 6 additional fields. More fields can be created by Jira, by application administrators, or by add-ons, plugins, and applications.
So how do you distinguish the standard fields from the ones created by applications and admins? Use this baseline list from a clean Jira install.
Standard Jira Fields
Default Fields & Functions
Project (On the “Create” screen)
Issue Type
Summary
Epic Name (For Epics)
Epic Link (For issues related to Epics)
Description
Component/s
Priority
Linked Issues
Attachment
Labels
Time Tracking (Includes Original Estimate and Remaining Estimate fields)
Log Work
Assignee
Reporter
Comments
Affects Version
Fix Version
Story Points
Sprint
Status (A workflow step)
Resolution
Created
Updated
Due Date
Default Fields on the “Custom Fields” Admin Page
From Jira Server 7.1.1
From Jira Cloud
From Jira Service Desk 3.12.2
The following fields are added when you create a support-type project and use the “Create sample data” option:
Approvals (Locked)
Approvers
CAB (Description: Change Advisory Board members)
Change completion date
Change managers
Change reason
Change risk
Change start date
Change type
Customer Request Type (Locked)
Flagged
Impact
Investigation reason
Operational categorization
Organizations (Locked)
Parent Link
Pending reason
Product categorization
Request participants (Locked)
Root cause
Satisfaction (Locked)
Team (Locked)
Time to approve normal change (Locked)
Time to close after resolution (Locked)
Time to first response (Locked)
Time to resolution (Locked)
Satisfaction date (Locked)
Urgency
Workaround
Clean Instance Worksheet
Use this default Jira setup worksheet to compare settings in your application and see how far you’ve strayed from the default. Use this template to document defaults in other versions.
Depending on where you are in the world, you may be smack in the middle of spring – as in time for Spring Cleaning. Even if it isn’t spring, it’s a good idea to occasionally audit your Jira installation, archive elements that aren’t being used and revisit your configuration to ensure that it’s optimized. Below are the basic steps you will need to perform a “Jira Clean-up.”
Jira Clean-up Step 1: Audit
The first step is taking stock of what you have. To do this, start with the “System info” page and note the number of projects, issues, custom fields, workflows, etc. Next, visit the Add-ons admin page and the admin area for each scheme and project asset.
Rachel Wright offers a worksheet for recording this information. Alternatively, you could use a spreadsheet or create a form in ProForma. The important thing is that you will want to track the number of Jira assets over time.
As you go through the admin pages, note assets that are unused (such as a field that doesn’t appear on any screens), duplicated (or perhaps similar enough in purpose that only one field is needed) or inactive.
Once you have a complete picture of your current application, you can set goals for your clean-up. Along with removing assets that aren’t being used, goals could include reducing the number of workflows for easier support and reducing the number of custom fields for better performance.
Jira Clean-up Step 2: Archive
Before you begin pruning out unnecessary elements, backup and verify your data. Also, make sure you have a rollback plan in case any of your changes cause unanticipated problems.
Elements
Go to the admin page for each element type and use the “identification” column to weed out unused items. The Jira Strategy Admin Workbook includes detailed instructions for easily identifying unused elements. In some cases (for example, if you are eliminating an issue type), you may need to migrate issues before deleting.
Deleting unused items is the first step. Depending on your goals, you may also want to consolidate custom fields or workflows. When consolidating fields, consider which field is more widely used, which has a better name, and which can be more easily deleted. Again, you may need to migrate data before you can delete.
Projects
Along with pruning down Jira elements, you should also check for stagnant projects. Use the Jira Strategy Admin worksheet or the ProForma form to identify projects that have an inactive project lead, few issues or no recently created issues.
You have several options for dispatching completed or stagnant projects:
Prevent new issues from being created
Mark the projects as read only
Hide the project
Archive the project
Export the project
Rachel Wright describes the appropriate use, as well as the implementation steps, for each method in the Jira Strategy Admin Workbook.
Users
Finally, you need to address users who have left the organization. Don’t users because you want to retain the history of their actions. Rather, set departed users to “inactive.” However, before doing so, Rachel recommends the following steps:
Move any not closed, assigned issues to the user’s supervisor
Move any not closed, reported issues to the user’s supervisor
Remove unshared custom dashboards, filters, filter subscriptions and boards
Remove favorite designations for dashboards
If a dashboard is used by others, move the dashboard to the supervisor or a generic user account
Remove favorite designations for filters
Move shared filters to the supervisor or a generic user account
Reassign project leads to the supervisor
Reassign component leads to the supervisor
Remove filter subscriptions
Remove draft workflows
Reassign agile boards to the supervisor
Check workflows for any auto assignment transition behaviors
Make the user account inactive
Making the time to regularly review and tidy up your application will make your ongoing admin duties easier and will keep your application clean, relevant and high-performing.
More than one Jira administrator has approached me about translating the Jira Strategy Admin Workbook into another language. But I only speak English and Jira Query Language! Enter wonderful Kerwin Chung, a Senior DevOps Consultant in China, who’s up to the task.
Kerwin’s translated the sample “Projects” chapter from Jira Strategy Admin Workbook into Chinese! You can download both the English and Chinese sample chapters for free. If you’re interested in a full Chinese or other language translation, let us know below! If there’s enough interest, we’ll translate the whole book!
About the Translator
Kerwin Chung, ACP-SW, ACP-JA Atlassian DevOps Senior Consultant at Cenoq in China
The reason why I love Jira is its expandability.
It is the best tool for the DevOps toolchain. Lots of companies in China use a lot of open source tools but they use only one commercial tool, which is Jira.
I am proud of being a Jira evangelist. I enjoyed using Jira to organize my own job and am very happy to introduce Jira to my customers and friends. Everyone loves it.
For most Jira Server users, an upgrade is a major activity that requires careful planning. What is your upgrade plan? How will you prepare? How will you ensure success? How often will you upgrade?
I approach upgrades as five high level steps:
Step 1: Research
Conduct all pre-upgrade “what changed” and compatibility research
This very important first step can determine the success of your upgrade. Start by reviewing the retrospective from the last upgrade so you can improve the upgrade process and plan for issues encountered in the last event. Also, it’s a good time to make sure your emergency rollback plan is still accurate.
Next, read all of Atlassian’s “Release Notes” and “Upgrade Notes” for every version between yours and the one you’re upgrading too.
TIP
Look for changes that might impact the application, users, or user behavior. Look for bugs you’ve been waiting for fixes for.
Finally, double-check that your license is valid through the upgrade testing period and you are not about to reach your license limit. You don’t want license issues to delay your upgrade.
Step 2: Pre-Upgrade Tasks (Test Environment)
Copy all production data to lower environments, update plugins, upgrade and test
RECOMMENDATION
Don’t have a test environment? Remedy that issue first! Ideally you’ll have a secondary server instance but if that’s not possible at least create a local instance on your personal computer. Make sure the resources powering your test environment match your production environment as much as possible. Make sure the software version and configuration are an exact copy of production.
RECOMMENDATION
Before upgrading your test environment, be sure to copy all of your production data to the environment. It’s not enough to test an upgrade on a vanilla instance; you need to test it with your specific configuration data!
By now you should know which version you’re able to upgrade to. Download the installer file, stop the application, and run the binary. Document the installation process, so you can repeat the steps in production. Review all configuration files, paths, custom files, and settings for accuracy. Also check the logs for major problems.
If all is well on startup, it’s time to update the Universal Plugin Manager, other add-ons, and re-index. After the re-index, start your regression testing. Make sure all basic application functions and new features are working as expected.
MISTAKE During testing, I discovered one of my heavily used plugins wasn’t compatible with the upgrade version and had moved from free to paid. I clicked the “Buy Now” button on the “Manage add-ons” page, assuming it would take me to a shopping cart with pricing information. Instead, it immediately installed an unlicensed version of the new plugin code! All of our workflows broke and I was inundated by reports of license errors from users. I had to quickly generate a free trial code to restore functionality and sheepishly contact the purchasing department to secure emergency funding for the new plugin. I did all this in production! #facepalm
Finally, contact your REST API and database users so they can verify all is well with their applications. Also, compile any “new features” documentation to share with end users. Conduct an end user and project-level admin demo if UI or feature changes are substantial.
Step 3: Upgrade Preparation
Line up support resources, schedule production upgrade activities, and announce plans
At this point, you are confident in the stability of your test environment and ready to schedule the production event. Start by identifying an upgrade team. Who will execute the upgrade? Who will “smoke test” the major functions? Who can you contact if there’s emergency?
After you have your team assembled, pick an upgrade time outside of peak use hours. Communicate the upgrade date, time, and expected duration to users and any support teams, like the company help desk or network operations center. Don’t surprise these teams with “Jira is down!” reports during the upgrade window!
TIP
Use Jira’s announcement banner function to communicate upgrade plans.
Sample Code: <div style=”border: 1px solid #9e1c1c; background-color: #fff; padding: 10px;”>Upgrade Outage
The upgrade will start on [day], [date] at [time] [timezone] and conclude before the start of business on [day], [date]. During the upgrade window: (1) you WILL NOT be able to login to JIRA, (2) any changes attempted WILL NOT be retained, (3) API calls will fail, and (4) issue creation via email will fail. For a list of new features and fixes, see our JIRA Upgrade notes.
Download sample wording for your entire upgrade process from the Strategy for Jira store.
Step 4: Upgrade Tasks (Production)
Backup production data, update add-ons, upgrade and test
RECOMMENDATION
Hopefully you’re already taking regular (automated) backups of your database and file system. But when’s the last time you verified that your most recent backup occurred and is actually usable? Do that before proceeding.
At last, you’ve planned as much as possible, know what to expect, and are ready for the upgrade event! It’s time to repeat the installation steps you practiced in your test environment including: installation, add-on updates, and regression testing. Use the notes you took in step 2 and be sure to address any differences that exist in the production environment.
Step 5: Communication
Announce upgrade and communicate changes and benefits to user base
Finally, it’s time to announce the upgrade to users and complete post-upgrade steps.
RECOMMENDATION
Use Jira’s announcement banner function to communicate the upgrade is complete. Include a link to the “new features” documentation you compiled in step 2.
Review any previous trouble reports, in case the upgrade remedied them, and be ready to respond to new reports. Check in with your REST API and database users, to make sure all is well with their apps.
Finish any outstanding tasks, compile your retrospective, and make any needed plan updates in preparation for the next upgrade. Also be sure to thank your upgrade team!
Detailed Upgrade Plan
A well-crafted plan can help ensure upgrade success. Download the sample upgrade plan worksheet. Customize it to fit your needs and environment. This worksheet may contain more or fewer steps than necessary for your situation, but it gives you a great starting point. Don’t forget to update and improve the plan after each upgrade.
A test instance and a healthy application are the foundation of a successful upgrade event. You’ll want to upgrade often for the newest features, fixes, and performance improvements. Happy upgrading!
If you’re on a software team, you probably use the default Jira workflow or something close to it. But what if you’re on a business team or the default options don’t fit the way you want to work? Then it’s time to create a custom workflow.
A workflow is a standard set of statuses (steps) and transitions (movement between steps) that each issue follows in its lifecycle. Statuses take an idea from “conception” to “completion”. Each Jira project can have its own workflow and each issue type within a project can have its own workflow as well. For example, the Legal team has a specific process for contract review and a general process for all “other” types of requests. Their Jira project might include issue types like the standard “Task” and a custom type like “Contract.”
The “Task” issue type has a very simple workflow, with the statues “To Do” and “Done.”
The “Contract” issue type requires additional statuses for approval and execution steps that occur in a contract review process.
RECOMMENDATION In the beginning, keep workflows as simple as possible, until you’ve uncovered a deficiency or process step that needs special attention.
Custom Workflow Tips
The steps below outline the best practices for creating a workflow:
Before creating a new custom workflow, have the user explain their real life process to you. The workflow should be as simple as possible.
First, draw (preferably on paper) a workflow to ensure it makes logical sense and all forward and back transitions are accounted for. You can use the “Custom Workflow Documentation” template in the Jira Strategy Admin Workbook or in ThinkTilt’s Process Template library as a way to communicate and document workflows.
After drawing the workflow, write the workflow out in words. This can uncover additional needs you may have neglected to draw or consider.
Include logical backwards transitions so users can self-manage issues.
Give users options to abandon or stop progress on issues at appropriate times.
Give project-level administrators appropriate options to fix improperly transitioned issues.
Example: Include a “reopen” transition button in the final status to address issues that were improperly closed.
Use transition conditions sparingly. If a condition is needed, set the restriction to a project role, rather than to an individual, for easy maintenance.
Use transition validators and post functions to minimize the amount of manual work a user has to do.
Automatically assign an issue to the reporter when moving to an “information needed” or “verification needed” type of status.
Automatically assign an issue to the Project Lead in a “triage” type of status.
Automatically move a parent issue to “In Progress” when a child issue starts progress.
Name your statuses:
Name statuses so they reflect the current state. Good status names immediately tell a user what is occurring and what state an issue is in the workflow process. For example, “Pending Review”, “In Review”, “Being Reviewed”, “Awaiting Review”, etc.
Make any status names short and easy to understand what is happening. Long, multi-word names are harder to query and may be truncated on certain screens.
Name your transitions:
A Transition name should be short and reflect an action taken.
Good transition names immediately tell a user what action to perform to progress an issue. Example: For an issue in “Pending Review” status, a good transition name would be: “Review Complete.” If you need a “pass/fail” situation, where an action must pass a test before a transition can occur, good transition names would be: simply “Pass” and “Fail.”
Bad transition names confuse the user about how to move forward. Example: “Review.” A transition button should signify the start or end of an action. The word “Review” is ambiguous. If a user clicks “Review,” does that mean they should start a review or that the review has already occurred?
It’s easy to customize workflows and therefore easy to go overboard, creating more structure than you really need.
Phased Approach
It’s certainly possible to capture every little step in your work process and build that into a complex and long Jira workflow. An alternative however, is a phased approach. Simply break your process into phases that represent a collection of smaller steps. The phases represent key decision points. An issue can’t be moved to another phase until the requirements of that phase have been satisfied. Your Jira status represents the entire phase, rather than a status for every small step in the phase.
Example: Your company is signing a partnership agreement
The contracts process requires a review of the contract by both parties and potential edits before final execution. It’s a predictable process requiring a short workflow like:
Open > In Review > In Execution > Closed
TIP A generically named status like “In Review” is better than a legal-specific name like “In Contract Review”. Other Jira projects can use the generic version regardless of what type of thing needs review. You want to share assets and schemes between projects as much as possible.
The Legal team is doing many things in the background that may not need to be reflected in the workflow. For example:
In the “In Review” phase, the Legal team is reviewing the contract, researching legal topics, communicating with internal teams, negotiating terms with the external company, etc.
In the “In Execution” status, the CEO is finding his favorite signing pen, both companies are trading paperwork, and your Legal team is entering the final result into their contracts database.
In the above example, is it useful to create a status for every step that occurs in the contracts process? Do you need to track how many times the contract was modified during the review process? Do you need to track which parties have signed the agreement so far? If the answer is “no” a phased approach may be more useful. Also, it might be more useful to track signature collection in a custom field.
RECOMMENDATION If you’re not going to report on something (ex: “How many contracts have been signed by us?” in the above example) that status or custom field may not be necessary or useful.
Don’t over-complicate your custom workflow with steps and statuses you don’t really need. Your end users will thank you for it.
I was recently asked: “If Jira project admins can now edit their own workflows and screens, what’s left for the application admin to do?” Plenty! Application admins are still very much needed, and their work extends way beyond managing a Jira project. Further, the new project admin abilities aren’t as liberating as they may sound. Let’s examine the types of admin users.
Types of Jira Admin Users
There are many different types of Jira admin users and responsibilities vary depending on the type. Admin users generally fall into one of the following categories:
System Level Administrators – Users with the ability to perform absolutely every Jira administration function
Application Level Administrators – Users with permissions to perform most Jira administration functions
Project Owners or Leads – A project’s single point of contact, often responsible for project strategy decisions
Project Level Administrators – Users with permissions to manage settings for individual Jira projects. (Example: Components, project users, etc.)
While the admin types have distinct abilities, a user can be multiple types of administrators at the same time. For example, an application administrator may also be the owner of a specific Jira project. An application administrator could be a system administrator as well if those roles have been combined. For the differences between application administrator and system administrator permissions, see the “Managing Global Permissions” documentation.
Jira Admin Responsibilities and Abilities
Each admin level has a distinct set of responsibilities. Below we’ll address the four admin types as two levels: system/application and project.
System Level Administrators & Application Level Administrators
These administrators need to consider the health of the application, impact to the application, and maintenance implications for each decision and change they make. These admins need to be chosen carefully, audited regularly, and approved by the application owner.
Application admins typically have the following responsibilities:
Assist the Jira Advisory Board in maintaining established standards
Communicate standards, procedures, changes, and maintenance outages to your Jira Ambassador team and end users
Assist end users with user-specific settings
Assist Project Level Administrators with managing settings and maintaining their projects
Complete approved customization requests or suggest alternative solutions within established standards
Manage users, groups, and access
Create and configure new projects, schemes, and assets
Remove projects, schemes, and assets when they are no longer needed
Perform application upgrades
Vet, install, and upgrade apps, plugins and integrations
Check logs for and address errors
Develop and maintain documentation and end user training materials
Monitor and ensure the overall health of the application
Each Jira project has a listed “Owner” or “Lead” who is sometimes also the default issue assignee. Additionally, individual projects can have an unlimited number of administrators. As such, there’s an opportunity to involve additional users in project-level maintenance and management.
Project admins typically have the following responsibilities:
Set and maintain Components, Versions, and other project-specific settings in accordance with established standards
Manage users and groups in the “Users and roles” area
Routinely triage (or appoint a triage person) to assign and review issues as they are created
Maintain the data and accuracy of data in the project space
Report any project issues or customization needs to the Jira Support team
Respond to questions or approvals requested by the Jira Support team
additional Editing Abilities
Additionally, project admins have limited workflow editing abilities in Jira version 7.3 and limited screen editing abilities in version 7.4. Also in 7.4 these abilities can be enabled or disabled through Permission schemes.
Project admins can only utilize assets that already exist. For example, they can add an existing status to their workflow or an existing custom field to a screen, but they cannot remove a status, create or rename statuses, or create new custom fields. They can modify transitions, but not edit transition screens or transition behaviors (properties, conditions, validators, or post functions). Further, these editing abilities only apply to projects where the workflow and the screens are not shared with other projects. If you’ve been sharing project configurations, as highly recommended in the Jira Strategy Admin Workbook, it’s possible that few or none of your project admins will have these new editing abilities. Additionally, the default workflow and default system screen still cannot be edited by anyone. Read more about these features in the 7.3 and 7.4 release notes.
How to check for Workflow Editing Abilities
Use the Admin UI
If you have few workflows, you can manually look for ones that are only used by one project. In the Jira Admin UI, visit Admin > Issues > Workflows. Click the “View” link next to each workflow. The following page will show how many projects use the workflow.
Use Atlassian’s Script (Jira Server Only)
Atlassian created an admin helper script to detect workflows and administrators impacted by the 7.3 change. The script requires node.js and you must be able to execute it on your server.
Use the Database (Jira Server Only)
This method is not perfect but it got me to the data I needed. Work with your database team to improve the sample queries or format them for your database type.
First, I counted the number of projects used by each workflow, looking for any that are not shared (those with a project count of 1.)
Sample Query: SELECT wse.workflow, count(p.pname) AS `Projects Using Workflow` FROM nodeassociation n INNER JOIN project p ON p.ID = n.source_node_ID INNER JOIN workflowscheme ws on ws.ID = n.SINK_NODE_ID INNER JOIN workflowschemeentity wse on wse.scheme = ws.ID WHERE n.source_node_entity = ‘Project’ and n.sink_node_entity = ‘WorkflowScheme’ GROUP BY wse.workflow ORDER BY `Projects Using Workflow`, workflow;
Next, I retrieved project details for each of the not shared workflows. I mainly wanted to know the project id, project name, and lead.
Sample Query: SELECT p.id AS project_id, p.pname AS project_name, p.lead AS project_lead, ws.name AS project_associated_workflow_scheme, wse.workflow AS workflow_scheme_associated_workflow FROM project p LEFT OUTER JOIN nodeassociation na ON na.source_node_id = p.id AND na.sink_node_entity = ‘WorkflowScheme’ LEFT OUTER JOIN workflowscheme ws ON ws.id = na.sink_node_id LEFT OUTER JOIN workflowschemeentity wse ON wse.scheme = ws.id LEFT OUTER JOIN jiraworkflows jw ON jw.workflowname = wse.workflow WHERE wse.workflow = ‘Workflow Name 1’ OR wse.workflow = ‘Workflow Name 2’ …
I put all the info into a spreadsheet for further analysis. From this abbreviated workflow and project list, I was able to examine individual project settings, like screens and permission schemes, to determine who would be able to take advantage of additional project admin features.
Deciding exactly what you want project admins to do may require experimentation as you adjust to the possibilities of Jira 7.3 and beyond. Ultimately, you’ll want to maintain a balance between providing ease and flexibility while still maintaining standards and control at the system/application level.
What other duties do application/system and project admins have at your company? What’s your strategy for communicating responsibilities to users? Can you improve any of the workflow editing ability detection methods? Add your thoughts to the comment section below.
Getting off to the right start is always the best way to go. It’s not always reality. We usually inherit things – business processes, Jira applications, our parents’ bad habits, etc. In her excellent resource, the Jira Strategy Admin Workbook, Rachel Wright recommends starting out by creating a Jira Advisory Board. If you’re starting from scratch, this is a great first step. If you’re already using Jira, now might be the time to put your Board in place, especially if you’re considering expanding Jira to other teams in your organization.
Different organizations have different ways of governing their processes. Rachel recommends that the role of the Advisory Board include:
Deciding what customizations to create and support in order to strike a balance between giving teams what they need and maintaining a manageable, high-performing application.
Setting standards for privacy, security, and storage and handling sensitive information.
Developing a process for providing support for teams’ Jira projects.
Determining what a successful Jira application looks like. What metrics will define success?
Who Should be on the Advisory Board?
When you consider how powerful and mission critical Jira can be for your organization, it’s clear that it shouldn’t be directed by just one person. But who else should be on your Board? Rachel recommends a group of about five people including:
An end user – techy-minded or not
A Jira Administrator who understands the application’s capabilities
A high level manager or VP who’s ultimately responsible for the work that gets done in Jira
A wildcard member to keep everyone on task
Consider having your end user or your wildcard member come from a non-technical business team.
Why Create a Jira Advisory Board Now?
You’re probably thinking, we’ve managed this long without a Board, why do we need one now? If that’s the case, one of two things is probably happening. Either your Jira Administrator is handling everything on their own, trying to please everybody, and relying on their own knowledge for deciding what should and shouldn’t be implemented. Or you do have a group of people who work together to set standards and support Jira users – you just don’t think of them as an Advisory Board.
If you don’t already have one, the moment of expanding Jira to business teams is an excellent time to establish a Board. Here’s why you need one now, even if you didn’t think you needed one before:
Expanding Jira to business teams will mean more requests for customizations; more custom fields, more screen schemes, more configurations. With each request, you will need to decide if it’s worth creating and supporting the new asset or whether an existing field, scheme or configuration can be shared. You’ll come to better decisions if you include multiple points of view.
You’ll also be collecting more sensitive information. Consider all the personal information HR keeps on employees. You need a policy to determine what kinds of sensitive information can be stored in Jira. Expanding to business teams also means you’re inheriting all of the privacy and security standards that apply to those teams. Again, you don’t want to be deciding how to navigate that alone.
Finally, teams may be skeptical as to how well a solution developed for IT can address their needs. That’s understandable. We’re all experts in our own areas. Having an Advisory Board that includes non-techies will help people feel more assured that their needs will be considered.
Easily Convert Business Teams to Jira
Expanding Jira to business teams is a great opportunity to bring a tool you already know, love and support to wider use in your organization. Teams from Finance to HR will love handling their requests in Jira, being able to measure and predict their workload using Jira’s reporting and knowing that their backsides are covered with Jira’s end to end traceability.
Along with making sure business teams’ conversion to Jira is done right (the reason you’re setting up that Advisory Board), it would also be nice to have it done easily. This is where ProForma Forms & Templates for Jira can help. ProForma offers a template library and an easy to use form builder that puts teams in control of collecting exactly the information they require, without the need for custom fields, screens and configurations. You may actually find yourself doing less Jira admin even as you bring more teams into Jira.
You can help your business teams have it all: a great tool, a well-governed application and an easy conversion.
You’ve decided to adopt JIRA. Congratulations! Use this 35 question planning checklist to help you make initial decisions and consider actions you should take to ensure a successful setup. Complete these items before, during, and after your install. Download the entire checklist from the Strategy for Jira Store.
Planning
1. Create an Internal JIRA Advisory Board Whether you’ve just started with JIRA or you’ve been using it for years, such a powerful and useful Application should not be directed by a single person. The people who set the strategy for JIRA use may be different from those who actually perform maintenance and administrative functions. You’ll want a governance or steering committee, who can establish standards and support both the application and the users.
See the “Establish an Advisory Board”, the “Ideal Board Makeup”, and the “Role of the Board” sections in the JIRA Strategy Admin Workbook.
2. Determine Usage Decide how JIRA will mainly be used. Will it be for software development only or will other, non-technical groups also utilize it to track tasks?
3. Determine Ownership Decide who is responsible for the application. Who will make initial and ongoing configuration changes? Who will maintain the application? Who will perform upgrades? (Server Version Only) Who will ensure application, server, database, and network stability? (Server Version Only)
Application Type
4. Choose an Application Type Decide which hosting environment is appropriate for your business and industry. Will you utilize a Cloud (hosted by Atlassian or a third party) or a Server (on premises) implementation?
5. Choose an Application Flavor Based on your usage, decide which JIRA product, or combination of JIRA products to use. Will you utilize JIRA Software (built for software developers and includes agile features), JIRA Core (built for business-type users), JIRA Service Desk (built for help desk and support-type functions), or a combination? Do you require the high availability, performance at scale, and disaster recovery features of JIRA Data Center?
6. Choose a License Tier Determine current and future licensing needs. How many users need to login to JIRA? Are license costs factored into the initial and ongoing budget?
7. Choose a Version (Server Version Only) Use the Atlassian release notes to determine which version to use. Will you install the latest version or the last major version?
16. Determine Data Import Needs Decide how to handle pre-JIRA data. Does existing data from another system need to be imported? What is the structure of the data and how will it be mapped to JIRA’s issue structure?
See the “Bulk Import” section of the JIRA Strategy Admin Workbook. Download a sample import file at: jirastrategy.com/link/bulk-import.
17. Determine Data Insertion Methods Decide which of the many ways new issues will be created. How will new information be added to JIRA? (Examples: Via the UI, via UI import, via email, via the API, via an Issue Collector (web form), etc.)
See the “Get Data into JIRA” section of the JIRA Strategy Admin Workbook. Download the “Worksheet: JIRA Issue Creation via Email Instructions” at: jirastrategy.com/link/creation-via-email.
Users
18. Create a User Management Strategy User management is more than just “adding new users” as they join the company. Your user list needs regular attention to remain accurate. You have to establish procedures on how to support new users as well as departing users. How will you handle and receive access requests and removals? How will you handle permissions related requests?
See the “User Access Strategies” and “User Management” sections of the JIRA Strategy Admin Workbook.
19. Determine Access and Credentials Decide how users will access the application. What credentials are needed for login? How does a new user securely receive credentials? Will access be local to the application or managed by Active Directory, Google Apps, Crowd (an Atlassian application), or another service? Is 2 Factor Authentication needed?
See the “User Management” and “Single Sign-On” sections of the JIRA Strategy Admin Workbook.
RECOMMENDATION
When the application grows to over 50 users, it’s time to consider a central user directory.
20. Select an Application Administration Team Create a strong, 2-5 person, admin team. Who will be responsible for new project configuration, customization, user access, and daily application management?
See the “Define Admin Users” section of the JIRA Strategy Admin Workbook. Download the “Worksheet: Application Administrator Responsibilities” at: jirastrategy.com/link/admin-responsibilities.
TIP: Need to train your team? Give your administrators their own copy of the JIRA Strategy Admin Workbook. Get the digital version at: jirastrategy.com/link/digital-workbook or the print version at: amzn.to/2fww6zh.
TIP: Have your admins prepare for and take the JIRA Certification exam. See the “Get Certified” and “How to Study” sections of the JIRA Strategy Admin Workbook.
RECOMMENDATION
Give your application admin team read-only access to the JIRA database. Understanding how the data is structured will solve a lot of mysteries and make them better admins. They’ll have the ability to access additional data that’s not available in the admin UI.
NOTE: Granting read only database access gives users access to protected data and may violate your company security policy.
21. Appoint Ambassadors In addition to your advisory board, you’ll want to enlist the help of other users to disseminate information, answer common questions, and serve as a liaison to your users. A small team of JIRA Ambassadors is a vital asset when you need to execute changes to your current application or communicate the change request process.
See the “Appoint Ambassadors” section of the JIRA Strategy Admin Workbook.
22. Determine an End User Training Strategy Determine your training needs and timeline. How will you train end users and encourage adoption?
See the “End User Training” and “Top 15 Things End Users Want to Know” sections of the JIRA Strategy Admin Workbook.
31. Set Up a Test Environment (Server Version Only) Always test major changes, large imports, upgrades, plugin installations, proof of concepts, and clean-up activities in a test environment first. Make sure the resources powering your test environment match your production environment as much as possible. Make sure the software version and configuration are an exact copy of production.
TIP: Disable email in the test environment to avoid notifying end users with duplicate or test data.
32. Establish a Plugin and Add-On Vetting Procedure There are a plethora of plugins and add-on features available in the Atlassian Marketplace. But haphazard installs and free trials can leave behind remnants that negatively impact the system after the trial ends. You should develop specific procedures for handling add-ons and customization requests. The procedure should include pre-installation vetting, installation and trial testing, and uninstall procedures to ensure system functionality and stability.
See the “Plugins and Add-ons” section in the JIRA Strategy Admin Workbook.
33. Determine Integrations and Connections Determine what connection points are initially needed and under what conditions new connections will be added. What other Atlassian or non-Atlassian applications will JIRA connect to? Will other internal applications be permitted to use the REST API or connect to the database?
See the “REST API and Database Users” section of the JIRA Strategy Admin Workbook.
34. Set Up Monitoring (Server Version Only) Set up additional software to routinely check the health of your application and database. Monitors and alerts help the admin team proactively maintain your application. Don’t let end users be the first or only source of trouble reports.
See the “Monitoring” section in the JIRA Strategy Admin Workbook.
35. Engage with the JIRA Community There’s an amazing community of experts, administrators, consultants, end users, and Atlassians publishing new information and providing assistance. Connect with others through your local Atlassian User Group, participate in the online community (answers.atlassian.com), and attend the annual user conference.
See the “Atlassian User Groups” and “Summit Annual User Conference” sections of the JIRA Strategy Admin Workbook.
This worksheet is a companion to the JIRA Strategy Admin Workbook. Get the book and additional materials at jirastrategy.com.
Is this workbook useful for JIRA Admin Certification preparation? The JIRA Strategy Admin workbook is about what admins should and shouldn’t do in their application. As part of the strategy recommendations, it covers admin concepts, which is what the JIRA Certification exam is about. When I started writing the book, there wasn’t a certification, so I definitely didn’t write it for that purpose. But I do think the book makes a great companion to the existing Atlassian documentation and certification study materials. There’s more info about the book and its contents here.
Why did you write this book? I wrote this because I knew I wasn’t the only person to inherit a messy configuration. I want to keep others out of what I call the “JIRA swamp” or, if you’re already in it, help dig you out.
What was the hardest part about writing the book? Certainly not writing about JIRA – I love talking about anything JIRA related! The hardest part was fighting with the Table of Contents and Index features of Microsoft Word. The initial drafts of the book were written in Confluence and progress was tracked in JIRA! The entire project (the book, materials, website, and store) took 2 years to create.
Where can I get the book? The digital version (a color PDF) is available for immediate download from the jirastrategy.com store. A print version (a black and white physical book) and a Kindle version is available on Amazon.
How do I schedule a speaking engagement, interview, or appearance? Please see the Press Kit page.
Store FAQ
What payment types are accepted? We accept major credit and debit cards (Visa, MasterCard, Discover, etc.) without needing to leave the store.
When will my book and files ship? All purchases from the jirastrategy.com website are in digital format and are available for download immediately. No items will be shipped to your physical or billing address.
How do I access downloadable files? After purchase, access to downloadable files is available in three places:
On the purchase confirmation page, click the grey order “Details” button.
In an email from info@jirastrategy.com with the subject line “The virtual product that you bought is available for download.”
On the “Order History” page, click the grey order “Details” button.
Image: Order History Details Button Image: Product Download Link Already purchased the book? Also see: Download Materials
Amazon FAQ
Do you offer a print version? Yes, you can order a printed, paperback, black & white version from Amazon. Simply login to your Amazon account (or create one) and they will ship a physical version to the mailing address you specify. After you receive the book, you can download the worksheets and materials from the Strategy for Jira website. Read more
Do you offer a Kindle version? Yes, you can order a Kindle version from Amazon. Simply login to your Amazon account (or create one) and they will deliver a Kindle version to your supported device. After you receive the book, you can download the worksheets and materials from the Strategy for Jira website. Read more
What Kindle versions are supported? You can see the list of supported devices on the Amazon product page. Visit https://amzn.to/2Ffv0qv and click the “Available on these devices” link below the product description. Also see Amazon’s list of compatible Kindle Cloud Reader browsers.