1 HOW TO CUSTOMIZE REDMINE Hirotaka Nishimiya 2014/10/16
2 PURPOSE • Purpose • To enable people to customize Redmine as you like. • Remarks • During this presentation, I recommend you to operate our Redmine.
3 THE ENTRANCE TO CUSTOMIZATION • Login as Admin user • Click “Administration” on the top menu bar
4 THE ENTRANCE TO CUSTOMIZATION • Administration menu is shown. Out of scope for today. Please check by yourself if you want.
5 1. PROJECTS • You can create and maintain projects and sub-projects. Create new projects Closed/ Archived projects will be shown if you filter with Status: All.
6 1. PROJECTS • To create a new project, you need Name and Identifier. Identifier is the ID of projects. It cannot be changed after creation, but it will be rarely shown for users.
7 1. PROJECTS • You can assign parent-project and select modules, trackers and custom fields to be used in this project.
8 1. PROJECTS • You can change settings for existing (sub-)projects. • You can also access to this setting pages from “Settings” on the module bar. Plugins might add tabs in this setting page
9 1. PROJECTS • You can add/ maintain versions in Version tab. You can set the status as “closed”, then the version will not be shown in ticket page. It is also possible to reopen closed versions. Versions can be shared with other (sub-)projects. “Sharing” field determines the scope to share each version.
10 2. USERS • In Users, you can check users’ status and maintain them.
11 2. USERS • You can lock/ delete every users. • You can also reset each user’s password. There is an automatically-transmitted email function. If Administrator authorization is given, user can; - use all the “Administration” functions, which is instructed in this document. - access all projects - use all the functions, which will be customized in “permissions” page (later discussion) Plugins might add tabs in this setting page
12 2. USERS • You can assign groups and projects and roles in each projects to users. Roles can also be assigned to users in other setting pages, i.e. “Settings” on the module bar.
13 3. GROUPS • In Groups, you can maintain who are in each groups. • Like as individual users, you can assign groups to projects. Then users in that group will be assigned to that project.
14 4. ROLES AND PERMISSIONS • You can create roles, which can be assigned to users. • You can select permissions to be granted to a role, such as “create project”. • Permission report is useful to check what permissions are added to which roles, cross-sectionally. “Non member” and “Anonymous” are the default users, which cannot be deleted. - Non member: users who are not a member of the project. - Anonymous: users who does not login. Plugins might add new permissions in this page
15 5. TRACKERS • You can choose fields to be used with a tracker. • Like as permission report, Summary page is useful. You can assign trackers to projects. As explained, it is also possible in Projects setting page.
16 6. ISSUE STATUSES • You can add/ maintain issue statuses.
17 6. ISSUE STATUSES • Only one issue status can be “default value”, then it will be always shown first when issuing a new ticket.
18 6. ISSUE STATUSES • Some issue statuses need to be “issue closed”. Tickets with an “issue closed” status will not be shown when you query issues with “open” in status filter.
19 6. ISSUE STATUSES • Issue statuses and completeness of tickets (% complete) can be linked to each other. • If you break the link, members need to maintain the “% complete ” field separately from the status field. Below customization is in “Administration” -> “Settings” -> “Issue Tracking”
20 7. WORKFLOW • In Workflow customization page, there are two tabs, “Status transition” and “Fields permission”.
21 7. WORKFLOW • In “Status transitions” tab, you need to select “Role” and “Tracker” to be maintained first and then click “Edit” button. The as-is customization which indicates whether a user with the role can move “from which status to which status” First, select Role and Tracker to be maintained, then press Edit button. If you also want to maintain new statuses, uncheck “Only display statuses that are used by this tracker”.
22 7. WORKFLOW • You can change the authorizations by checking/ unchecking each cell. • You can also allow additional combinations only when a user is the author or assignee of the ticket. Users can move the status from New to In Progress, but cannot from In Progress to New.
23 7. WORKFLOW • In “Fields permissions” tab, you can mark “Read-only” or “Required” in each cell. Tracker cannot be changed when users move the status to Pending Users cannot move the status to Closed when assignee field is blank
24 7. WORKFLOW • You can see how many paths are defined for each combination of Tracker and Role in Summary.
25 8. CUSTOM FIELDS • Redmine allows you to add some custom fields. New custom filed will be added. Sort order of fields can be changed but All custom fields are always listed under the default fields.
26 8. CUSTOM FIELDS • Each custom field have description and some setting fields. “Description” will be shown when users mouse-overed on the field name. Based on the “Format” chosen, there will be some setting field. You can use regular expression （正規表現） to regulate values to be set.
27 8. CUSTOM FIELDS • Each custom field have description and some setting fields. Always required when raising/ maintaining tickets. All projects have this custom field. You can select this custom field as a filter field when searching tickets. Who can see this custom field. Which trackers will be used this custom field. Which projects will be used this custom field. * This setting will be disabled when “For all projects” is checked.
28 9. SETTINGS • More and more settings are available in “Settings”. #of tickets listed when searching Host name will be used for link URL in e-mail notification.
29 9. SETTINGS • More and more settings are available in “Settings”. Redmine’s look & feel can be changed. Below internet resource shows the instruction. http://redmine.jp/glossary/t/the me/
30 9. SETTINGS • More and more settings are available in “Settings”. Enable/ disable REST service. The mass-updating tool “Redmineチケット ★一括★” uses REST service.
31 9. SETTINGS • More and more settings are available in “Settings”. Associate an issue with another issue in another project? Associate an issue as a child with another issue in another project? Assign a ticket to a group (not to individuals)? Link % complete and status field? (as instructed in page #19) How many ticket you can export when exporting ticket list to CVS etc. file.
32 9. SETTINGS • More and more settings are available in “Settings”. Triggers to send emails. Email’s header and footer can be customized.