Jira Assistant allows you to control the behaviour of the extension by providing as many controllable configurations in settings module. As of now their are three major categorization of settings. They are User groups, Advanced settings and General settings. More detailed information is available below:
All the reports you pull from Jira would be in some way related to the users who is using Jira. Hence everywhere you would need to provide user list as input to reports. Moreover most of the users would be generating various reports for same set of users. Hence it makes sense to pull out the user list configuration as a separate page and reuse same list across reports. Hence you can configure the user list once and everywhere you can make use of the same list.
From any of the reports, if you make changes to the user list, it doesn't get saved permanently, hence, at times when you just wanted to pull reports for few set of uses, you can just remove other users and generate report. As the changes will not be saved, when you come back next time, still all the users will be available in the list for generating report. This is an alternate approach rather than providing checkbox for selection of users while generating report.
General settings page contains multiple configuration options categorized under 5 different tabs. Following are some of the details about the configurations available. But we suggest you to have a look at the settings page for a complete list as each configuration contains the help text explaining you what the configuration is used for.
- Display Date and Time format: Select your preferred date and time format to be displayed throughout the application.
- Working hours: Select your working hours range between 00:00 to 23:00 (24 hours format). This is mainly useful in focusing on the calendar as non working hours will not be shown in calendar.
- Working days: Select the days in week you would be working. This is defaulted from Monday to Friday
- Start of week: Select the starting day of your week. If nothing is selected then default will be taken.
Advanced settings contains configurations which would help you to control the technical nature of the extension. This page uses grid structure where rows represents the various configuration options available and columns represent the individual instances. Also, for some configurations, this page allows you to edit the default settings which would impact all the instances. Following are the list of configuration options available.
- Integrated on:This is for information purpose only. This field displays the date when individual instances of integrations are done. This field may not show appropriate date for very old installations where date is not captures in older versions.
- Jira Server Url: This is the base path url of the Jira server to access the API's. This should just contain the base path and should not point to any specific api or page.
- Jira User id: This is the user id in Jira. This is mostly used for display purpose in report, but some functionality may break if this is not matching with the user id in Jira. If user id is updated in Jira, it may not automatically reflect in the extension at all the times. Hence, sometimes it becomes necessary that you update it manually.
- Email id: This servers the same purpose as that of "Jira User id" configuration.
- Open tickets JQL: Currently "My Open Tickets" gadget uses this JQL to pull list of tickets from Jira. If you are not satisfied with the default JQL or if some of the statuses in Jira is renamed, then this query may cause issue while fetching the data. At those times you can manually modify the query from here.
- Ticket suggestions JQL: All the Jira ticket suggestions field you see in this extension like in Add Worklog, Settings, etc,. will make use of this query to fetch the list of suggestions. Once the list is pulled for the first time, it may be cached for performance reasons.
- Disable Jira issue updates: From v1.2 onwards you have an option to view the notifications for any changes happened in Jira for the tickets you are involved in. You can enable or disable that feature using this configuration.
- Jira updates JQL (used to fetch updates from Jira): This configuration is used to fetch the issues modified after you had last viewed it.
- Disable notifications from developer: As a developer, we would like to keep you posted about any issues or upcoming features in Jira Assistant. So that you can be prepared with necessary actions. Though we provide you an option to disable the feature using this configuration, we strongly suggest you not to disable it.
- For most of the cases, any changes you make to the configuration would reflect only the next time you revisit the extension or refreshing the extension by pressing "F5" key.
- Be cautious when modifying the settings available in Advance Settings page. Any misconfiguration may cause failures in various parts of the extension and leave it unstable / unusable.