Advanced JIRA configuration with jira-application.properties

All Versions

JIRA 4.0 Beta Documentation

Index

In JIRA, most commonly accessed configuration items are editable from Administration -> Global Settings -> General Configuration. The default values here are set in the file WEB-INF/classes/jira-application.properties. In addition, jira-application.properties contains other properties which are not editable from the web interface. Usually these are of little interest to most users, but sometimes you may wish to edit them.

A sample jira-application.properties file is available here.

Making changes to jira-application.properties

The process of changing this file depends on whether you are running JIRA Standalone (JIRA deployed as an 'open' webapp) or JIRA deployed as a packed '.war' file deployed in an app server.

JIRA Standalone

The file is located in atlassian-jira/WEB-INF/classes/jira-application.properties. Edit the file here, and then restart JIRA by running bin\shutdown.bat and bin\startup.bat (or .sh equivalents).

JIRA as a webapp

If you have downloaded the .WAR/Webapp distribution of JIRA:

  1. Copy webapp/WEB-INF/classes/jira-application.properties to edit-webapp/WEB-INF/classes/jira-application.properties
  2. Make your changes in edit-webapp/WEB-INF/classes/jira-application.properties
  3. In the root directory, run build.bat or build.sh to regenerate the webapp (.war file)
  4. Redeploy the new .war file in your app server.

See also

Setting properties and options on startup — for changes like setting available memory, disabling email, enabling Jelly, etc.
Enter labels to add to this page:
Please wait 
Looking for a label? Just start typing.

Comments (12)

 

  1. Aug 14, 2006

    Karl-Koenig Koenigsson says:

    It would be splendid with some elaboration on the different properties that can ...

    It would be splendid with some elaboration on the different properties that can be set this way.

    I am, in particular, interested in Project Key Pattern, and want to know what caveats there are if I change this. I have requests from the developers to try to make the project key better reflect the particual branch of the code they apply to and am considering changing this to include underscore and digits, and perhaps even allowing lower case characters.

     I realise that there might be problems involved with this but I can not forsee them all, hence the need for some best-practices here, I suppose.

    1. Aug 17, 2006

      Nick Menere says:

      Hi, you should be able to use most ASCII characters without a problem. It usuall...

      Hi, you should be able to use most ASCII characters without a problem.
      It usually best practice to keep the keys, short and memorable. I have seen numbers work well as well.
      Lower case will not work as we upper a lot of the keys. All keys are case insensitive.

      Cheers,
      Nick

  2. Nov 14, 2006

    Harry Saddler says:

    Is it possible to specify the component in the project key? For example, for iss...

    Is it possible to specify the component in the project key? For example, for issues in project "Foo" and component "Bar", then the pattern might be something like "Foo$Bar", and the keys would be FooBar1, FooBar2, etc.

    1. Nov 14, 2006

      Harry Saddler says:

      Oops... what I meant was "Foo$component" produces FooBar1, FooBar2, etc.

      Oops... what I meant was "Foo$component" produces FooBar1, FooBar2, etc.

      1. Nov 16, 2006

        Lee Kay Nny says:

        I doubt this idea will ever be implemented. An issue is tracked under a project ...

        I doubt this idea will ever be implemented. An issue is tracked under a project with the possibility of being under multiple components of it.

        I can't imagine how complex the key name will turn out to be due to multiple components or component name changes.

        Cheers,
        Kay Nny

        1. Nov 17, 2006

          Harry Saddler says:

          The rationale for this is that the issue number is a commonly-used term in discu...

          The rationale for this is that the issue number is a commonly-used term in discussion, e.g. "who's dealing with FOO-UE-289?" In this example, I know it's a user experience issue.

          1. Jan 31, 2007

            George Zhang says:

            I don't think it is a good idea to specify the component in a key.  You kno...

            I don't think it is a good idea to specify the component in a key.  You know some issues are caused by a defect in system design and we cannot simply say that they are in a single component. 

            What's more, I even doubt the fact that an issue's key is associated with the project key.  A project will be closed but the product will exist.  Not all issue, or bugs found in a project will necessarily be fixed before the project is closed.  Later you will start a new project to improve the product, those issues not fixed should be reused instead of creating some issues same as those not fixed before. 

            In short, a bug is found in, as a negative feature of, a product, a release, a build, or a work product. It is not a feature of a project. Its ID or key should be maintained automatically by the bug tracking system and independently of any projects.

            You know what. I don't like many phrases and terms used in JIRA. For example, project component is very confusing. A product component, or simply a component, is more reasonable.

        2. Jan 31, 2007

          George Zhang says:

          I agree with you on an issue possibly being in multiple components. A...

          I agree with you on an issue possibly being in multiple components.

          And also we thought an issue was in component A and now we know it is in component Z in fact. Change its key? Yes! But you will find the references to it become rubbish!! A key should not be changed at will!!!

  3. Aug 13, 2007

    Royce Wong says:

    For jira.subtask.quickcreateform.fields, the comment says "The values must be va...

    For jira.subtask.quickcreateform.fields, the comment says "The values must be valid issue field ids (see IssueFieldConstants class)". I looked at IssueFieldConstants (http://docs.atlassian.com/software/jira/docs/api/3.10/com/atlassian/jira/issue/IssueFieldConstants.html), I found summary,assignee but not issuetype. Maybe the comment need to be corrected?

  4. Jan 30, 2008

    luke crouch says:

    how would I add "Original Estimate" to the subtask quick-form? I tried using the...

    how would I add "Original Estimate" to the subtask quick-form? I tried using the value specified in (http://docs.atlassian.com/software/jira/docs/api/3.12/constant-values.html#com.atlassian.jira.issue.IssueFieldConstants.TIME_ORIGINAL_ESTIMATE):

    jira.subtask.quickcreateform.fields = summary, issuetype=7, assignee, timeoriginalestimate

    when I try to submit the quick subtask form. stacktrace below: 

    java.lang.NullPointerException
    at com.atlassian.jira.issue.fields.screen.issuetype.DefaultIssueTypeScreenSchemeManager.getFieldScreenScheme(DefaultIssueTypeScreenSchemeManager.java:126)
    at com.atlassian.jira.issue.fields.screen.FieldScreenRendererImpl.(FieldScreenRendererImpl.java:50)
    at com.atlassian.jira.issue.fields.screen.FieldScreenRendererFactoryImpl.getFieldScreenRenderer(FieldScreenRendererFactoryImpl.java:35)
    at com.atlassian.jira.web.action.issue.IssueCreationHelperBeanImpl.createFieldScreenRenderer(IssueCreationHelperBeanImpl.java:167)
    at com.atlassian.jira.web.action.issue.CreateIssue.getFieldScreenRenderer(CreateIssue.java:228)
    at com.atlassian.jira.web.action.issue.CreateSubTaskIssueDetails.getFieldScreenRenderer(CreateSubTaskIssueDetails.java:133)
    at com.atlassian.jira.web.action.issue.CreateSubTaskIssueDetails.hasMandatoryFields(CreateSubTaskIssueDetails.java:142)
    at com.atlassian.jira.web.action.issue.CreateSubTaskIssueDetails.doValidation(CreateSubTaskIssueDetails.java:78)
    at webwork.action.ActionSupport.validate(ActionSupport.java:373)
    at webwork.action.ActionSupport.execute(ActionSupport.java:150)
    at com.atlassian.jira.action.JiraActionSupport.execute(JiraActionSupport.java:54)
    at webwork.dispatcher.GenericDispatcher.executeAction(GenericDispatcher.java:132)
    at com.atlassian.jira.web.dispatcher.JiraServletDispatcher.service(JiraServletDispatcher.java:211)
    at javax.servlet.http.HttpServlet.service(HttpServlet.java:802)
    at org.apache.catalina.core.ApplicationFilterChain.internalDoFilter(ApplicationFilterChain.java:252)
    at org.apache.catalina.core.ApplicationFilterChain.doFilter(ApplicationFilterChain.java:173)
    at com.atlassian.jira.web.filters.AccessLogFilter.doFilter(AccessLogFilter.java:73)
    at org.apache.catalina.core.ApplicationFilterChain.internalDoFilter(ApplicationFilterChain.java:202)
    at org.apache.catalina.core.ApplicationFilterChain.doFilter(ApplicationFilterChain.java:173)
    at com.opensymphony.module.sitemesh.filter.PageFilter.parsePage(PageFilter.java:119)
    at com.opensymphony.module.sitemesh.filter.PageFilter.doFilter(PageFilter.java:55)
    at com.atlassian.jira.web.filters.SitemeshExcludePathFilter.doFilter(SitemeshExcludePathFilter.java:38)
    at org.apache.catalina.core.ApplicationFilterChain.internalDoFilter(ApplicationFilterChain.java:202)
    at org.apache.catalina.core.ApplicationFilterChain.doFilter(ApplicationFilterChain.java:173)
    at com.atlassian.seraph.filter.SecurityFilter.doFilter(SecurityFilter.java:192)
    at org.apache.catalina.core.ApplicationFilterChain.internalDoFilter(ApplicationFilterChain.java:202)
    at org.apache.catalina.core.ApplicationFilterChain.doFilter(ApplicationFilterChain.java:173)
    at com.atlassian.seraph.filter.TrustedApplicationsFilter.doFilter(TrustedApplicationsFilter.java:114)
    at org.apache.catalina.core.ApplicationFilterChain.internalDoFilter(ApplicationFilterChain.java:202)
    at org.apache.catalina.core.ApplicationFilterChain.doFilter(ApplicationFilterChain.java:173)
    at com.atlassian.seraph.filter.BaseLoginFilter.doFilter(BaseLoginFilter.java:110)
    at org.apache.catalina.core.ApplicationFilterChain.internalDoFilter(ApplicationFilterChain.java:202)
    at org.apache.catalina.core.ApplicationFilterChain.doFilter(ApplicationFilterChain.java:173)
    at com.atlassian.util.profiling.filters.ProfilingFilter.doFilter(ProfilingFilter.java:132)
    at com.atlassian.jira.web.filters.JIRAProfilingFilter.doFilter(JIRAProfilingFilter.java:16)
    at org.apache.catalina.core.ApplicationFilterChain.internalDoFilter(ApplicationFilterChain.java:202)
    at org.apache.catalina.core.ApplicationFilterChain.doFilter(ApplicationFilterChain.java:173)
    at com.atlassian.jira.web.filters.ActionCleanupDelayFilter.doFilter(ActionCleanupDelayFilter.java:43)
    at org.apache.catalina.core.ApplicationFilterChain.internalDoFilter(ApplicationFilterChain.java:202)
    at org.apache.catalina.core.ApplicationFilterChain.doFilter(ApplicationFilterChain.java:173)
    at com.atlassian.jira.web.filters.RequestCleanupFilter.doFilter(RequestCleanupFilter.java:50)
    at org.apache.catalina.core.ApplicationFilterChain.internalDoFilter(ApplicationFilterChain.java:202)
    at org.apache.catalina.core.ApplicationFilterChain.doFilter(ApplicationFilterChain.java:173)
    at com.atlassian.johnson.filters.AbstractJohnsonFilter.doFilter(AbstractJohnsonFilter.java:72)
    at org.apache.catalina.core.ApplicationFilterChain.internalDoFilter(ApplicationFilterChain.java:202)
    at org.apache.catalina.core.ApplicationFilterChain.doFilter(ApplicationFilterChain.java:173)
    at org.tuckey.web.filters.urlrewrite.UrlRewriteFilter.doFilter(UrlRewriteFilter.java:350)
    at org.apache.catalina.core.ApplicationFilterChain.internalDoFilter(ApplicationFilterChain.java:202)
    at org.apache.catalina.core.ApplicationFilterChain.doFilter(ApplicationFilterChain.java:173)
    at com.atlassian.gzipfilter.GzipFilter.doFilter(GzipFilter.java:89)
    at org.apache.catalina.core.ApplicationFilterChain.internalDoFilter(ApplicationFilterChain.java:202)
    at org.apache.catalina.core.ApplicationFilterChain.doFilter(ApplicationFilterChain.java:173)
    at com.atlassian.core.filters.AbstractEncodingFilter.doFilter(AbstractEncodingFilter.java:37)
    at org.apache.catalina.core.ApplicationFilterChain.internalDoFilter(ApplicationFilterChain.java:202)
    at org.apache.catalina.core.ApplicationFilterChain.doFilter(ApplicationFilterChain.java:173)
    at com.atlassian.jira.appconsistency.db.DatabaseCompatibilityEnforcerFilter.doFilter(DatabaseCompatibilityEnforcerFilter.java:39)
    at org.apache.catalina.core.ApplicationFilterChain.internalDoFilter(ApplicationFilterChain.java:202)
    at org.apache.catalina.core.ApplicationFilterChain.doFilter(ApplicationFilterChain.java:173)
    at org.apache.catalina.core.StandardWrapperValve.invoke(StandardWrapperValve.java:213)
    at org.apache.catalina.core.StandardContextValve.invoke(StandardContextValve.java:178)
    at org.apache.catalina.core.StandardHostValve.invoke(StandardHostValve.java:126)
    at org.apache.catalina.valves.ErrorReportValve.invoke(ErrorReportValve.java:105)
    at org.apache.catalina.core.StandardEngineValve.invoke(StandardEngineValve.java:107)
    at org.apache.catalina.valves.AccessLogValve.invoke(AccessLogValve.java:541)
    at org.apache.catalina.connector.CoyoteAdapter.service(CoyoteAdapter.java:148)
    at org.apache.coyote.http11.Http11Processor.process(Http11Processor.java:869)
    at org.apache.coyote.http11.Http11BaseProtocol$Http11ConnectionHandler.processConnection(Http11BaseProtocol.java:664)
    at org.apache.tomcat.util.net.PoolTcpEndpoint.processSocket(PoolTcpEndpoint.java:527)
    at org.apache.tomcat.util.net.LeaderFollowerWorkerThread.runIt(LeaderFollowerWorkerThread.java:80)
    at org.apache.tomcat.util.threads.ThreadPool$ControlRunnable.run(ThreadPool.java:684)
    at java.lang.Thread.run(Thread.java:619)

    1. Feb 23, 2008

      Francis Martens says:

      Same problem here.

      Same problem here.

    2. Feb 27, 2008

      Ian Daniel [Atlassian] says:

      Hi Luke and Francis, The solution to this is to use "timetracking" instead of "...

      Hi Luke and Francis,

      The solution to this is to use "timetracking" instead of "timeoriginalestimate". See JRA-14542. As documented there, I was able to reproduce that the field didn't appear if you used "timeoriginalestimate", but not your NullPointerException.

      If using "timetracking" doesn't fix it for you, can you please create a case in our support system, https://support.atlassian.com.

      Kind regards,
      Ian

      —
      Ian Daniel
      JIRA Support Lead
      ATLASSIAN - http://www.atlassian.com
      Tried our new products yet? http://www.atlassian.com/software

Add Comment


Except where otherwise noted, content in this space is licensed under a Creative Commons Attribution 2.5 Australia License.