| [ Index ] |
PHP Cross Reference of MantisBT |
[Summary view] [Print] [Text view]
1 <?xml version='1.0' encoding='utf-8' ?> 2 <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ 3 <!ENTITY % BOOK_ENTITIES SYSTEM "Admin_Guide.ent"> 4 %BOOK_ENTITIES; 5 ]> 6 <chapter id="admin.pages"> 7 <title>Page descriptions</title> 8 <section id="admin.pages.login"> 9 10 <title>Login page</title> 11 12 13 <para>Just enter your username and password and hit the login 14 button. There is also a Save Login checkbox to have the package 15 remember that you are logged in between browser sessions. You will 16 have to have cookies enabled to login.If the account doesn't exist, 17 the account is disabled, or the password is incorrect then you will 18 remain at the login page. An error message will be displayed.The 19 administrator may allow users to sign up for their own accounts. If 20 so, a link to Signup for your own account will be available.The 21 administrator may also have anonymous login allowed. Anonymous 22 users will be logged in under a common account.You will be allowed 23 to select a project to work in after logging in. You can make a 24 project your default selection from the Select Project screen or 25 from your Account Options.SignupHere you can signup for a new 26 account. You must supply a valid email address and select a unique 27 username. Your randomly generated password will be emailed to your 28 email account. If MantisBT is setup so that the email password is not 29 to be emailed, newly generated accounts will have an empty 30 password. 31 </para> 32 33 </section> 34 35 <section id="admin.pages.main"> 36 <title>Main page</title> 37 38 <para>This is the first page you see upon logging in. It shows you 39 the latest news updates for the bugtracker. This is a simple news 40 module (based off of work by Scott Roberts) and is to keep users 41 abreast of changes in the bugtracker or project. Some news postings 42 are specific to projects and others are global across the entire 43 bugtracker. This is set at the time of posting in the Edit News 44 section.The number of news posts is controlled by a global 45 variable. When the number of posts is more than the limit, a link 46 to show "older news" is displayed at the bottom. Similarly a "newer 47 news" is displayed when you have clicked on "older news".There is 48 an Archives option at the bottom of the page to view all 49 listings.ArchivesA title/date/poster listing of ALL past news 50 articles will be listed here. Clicking on the link will bring up 51 the specified article. This listing will also only display items 52 that are either global or specific to the selected project. 53 </para> 54 </section> 55 56 57 <section id="admin.pages.filter"> 58 <title>View Issues page</title> 59 60 <para>Here we can view the issue listings. The page has a set of 61 viewing filters at the top and the issues are listed below.FiltersThe 62 filters control the behavior of the issues list. The filters are saved 63 between browsing sessions but do not currently save sort order or 64 direction.If the number of issues exceeds the "Show" count in the 65 filter a set of navigation to go to "First", "Last", "Previous", 66 "Next" and specific page numbers are added.The Search field will 67 look for simple keyword matches in the summary, description, steps 68 to reproduce, additional information, issue id, or issue text id 69 fields. It does not search through issue notes. 70 71 Issue List - The issues are 72 listed in a table and the attributes are listed in the following 73 order: priority, id, number of issue notes, category, severity, 74 status, last updated, and summary. Each (except for number of 75 issue notes) can be clicked on to sort by that column. Clicking again 76 will reverse the direction of the sort. The default is to sort by 77 last modification time, where the last modified issue appears at the 78 top. The issue id is a link that leads to a more detailed report about 79 the issue. You can also add issue notes here. The number in the 80 issue note count column will be bold if an issue note has been 81 added in the specified time frame. The addition of an issue note 82 will make the issue note link of the issue appear in the unvisited 83 state. The text in the "Severity" column will be bold if the 84 severity is major, crash, or block and the issue not resolved. The 85 text in the "Updated" column will be bold if the issue has changed 86 in the last "Changed(hrs)" field which is specified in the viewing 87 filters. Each table row is color coded according to the issue 88 status. The colors can be customised through MantisBT configuration pages 89 (see <xref linkend="admin.config" /> for details). 90 91 Severities 92 block 93 - prevents further work/progress from being made 94 crash - crashes the application or blocking, 95 major - major issue, 96 minor - minor issue, 97 tweak - needs tweaking, 98 text - error in the text, 99 trivial - being nit picky, 100 feature - requesting new feature 101 - Status 102 new - new issue, 103 feedback - issue requires more information from reporter, 104 acknowledged - issue has been looked at but not confirmed or assigned, 105 confirmed - confirmed and reproducible (typically set by an 106 Updater or other Developer), 107 assigned - assigned to a Developer, 108 resolved - issue should be fixed, waiting on confirmation of fix, 109 closed - issue is closed, 110 Moving the mouse over the status text will 111 show the resolution as a title. This is rendered by some browsers 112 as a bubble and in others as a status line text. 113 </para> 114 115 </section> 116 117 <section id="admin.pages.issueview"> 118 119 <title>Issue View page</title> 120 121 122 <para>Here is the simple listing of the issue report. Most of the 123 fields are self-explanatory. "Assigned To" will contain the 124 developer assigned to handle the issue. Priority is fully functional 125 but currently does nothing of importance. Duplicate ID is used when 126 an issue is a duplicate of another. It links to the duplicate issue 127 which allows users to read up on the original issue report. Below the 128 issue report is a set of buttons that a user can select to work on 129 the issue. 130 </para> 131 <itemizedlist> 132 <listitem> 133 <para>Update Issue - brings up a page to edit all aspects of 134 the issue 135 </para> 136 </listitem> 137 <listitem> 138 <para>Assign to - in conjunction with the dropdown list next 139 top the button, this is a shortcut to change the assignment of an 140 issue 141 </para> 142 </listitem> 143 <listitem> 144 <para>Change Status to - in conjunction with the dropdown list 145 next top the button, this is a shortcut to change the status of an 146 issue. Another page (Change Status) will be presented to allow the 147 user to add notes or change relevant information 148 </para> 149 </listitem> 150 <listitem> 151 <para>Monitor / Unmonitor Issue - allows the user to monitor 152 any additions to the issue by email 153 </para> 154 </listitem> 155 <listitem> 156 <para>Create Clone - create a copy of the current issue. This 157 presents the user with a new issue reporting form with all of the 158 information in the current issue filled in. Upon submission, a new 159 issue, related to the current issue, will be created. 160 </para> 161 </listitem> 162 <listitem> 163 <para>Reopen Issue - Allows the user to re-open a resolved 164 issue 165 </para> 166 </listitem> 167 <listitem> 168 <para>Move Issue - allows the user to move the issue to another 169 project 170 </para> 171 </listitem> 172 <listitem> 173 <para>Delete Issue - Allows the user to delete the issue 174 permanently. It is recommended against deleting issues unless the 175 entry is frivolous. Instead issues should be set to resolved and an 176 appropriate resolution category chosen. 177 </para> 178 </listitem> 179 </itemizedlist> 180 <para> 181 A panel is provided to view and update the sponsorship of an 182 issue.Another panel is provided to view, delete and add 183 relationships for an issue. Issues can have a parent/child 184 relationship, where the user is warned about resolving a parent 185 issue before all of the children are resolved. A peer relationship 186 is also possible.Below this, there may be a form for uploading file 187 attachments. The Administrator needs to configure the bugtracker to 188 handle file uploads. If uploading to disk is selected, each project 189 needs to set its own upload path. Issue notes are shown at the bottom 190 of the issue report. A panel to add issue notes is also shown. 191 </para> 192 </section> 193 194 <section id="admin.pages.issuestatus"> 195 <title>Issue Change Status page</title> 196 197 <para>This page is used to change the status of an issue. A user 198 can add an issue note to describe the reason for change.In addition, 199 the following fields may be displayed for update: 200 <itemizedlist> 201 <listitem> 202 <para>Resolution and Duplicate ID - for issues being resolved 203 or closed 204 </para> 205 </listitem> 206 <listitem> 207 <para>Issue Handler (Assigned to)</para> 208 </listitem> 209 <listitem> 210 <para>any Custom Fields that are to be visible on update or 211 resolution 212 </para> 213 </listitem> 214 <listitem> 215 <para>Fixed in Version - for issues being resolved</para> 216 </listitem> 217 <listitem> 218 <para>Close Immediately - to immediately close a resolved 219 issue 220 </para> 221 </listitem> 222 </itemizedlist> 223 </para> 224 225 </section> 226 227 228 <section id="admin.pages.issueedit"> 229 230 <title>Issue Edit page</title> 231 232 <para>The layout of this page resembles the Simple Issue View 233 page, but here you can update various issue fields. The Reporter, 234 Category, Severity, and Reproducibility fields are editable but 235 shouldn't be unless there is a gross mis-categorization.Also 236 modifiable are the Assigned To, Priority, Projection, ETA, 237 Resolution, and Duplicate ID fields.As per version 0.18.0, the user 238 can also add an issue note as part of an issue update. 239 </para> 240 241 </section> 242 243 244 <section id="admin.pages.account"> 245 <title>My Account Page</title> 246 247 <para>This page changes user alterable parameters for the system. 248 These selections are user specific.My AccountThis allows the user 249 to change their password, screen name, and email address. It also 250 reports the user's access levels on the current and other 251 projects. 252 </para> 253 254 <section id="admin.pages.account.prefs"> 255 <title>Preferences</title> 256 <para> 257 This sets the following information: 258 <itemizedlist> 259 <listitem> 260 <para>Default project</para> 261 </listitem> 262 <listitem> 263 <para>whether the pages used for reporting, viewing, and 264 updating are the simple or advanced views 265 </para> 266 </listitem> 267 <listitem> 268 <para>the delay in minutes between refreshes of the view all 269 issues page 270 </para> 271 </listitem> 272 <listitem> 273 <para>the delay in seconds when redirecting from a confirmation 274 page to the display page 275 </para> 276 </listitem> 277 <listitem> 278 <para>the time order in which notes will be sorted</para> 279 </listitem> 280 <listitem> 281 <para>whether to filter email messages based on type of message 282 and severity 283 </para> 284 </listitem> 285 <listitem> 286 <para>the number of notes to append to notification 287 emails 288 </para> 289 </listitem> 290 <listitem> 291 <para>the default language for the system. The additional 292 setting of "auto" will use the browser's default language for the 293 system. 294 </para> 295 </listitem> 296 </itemizedlist> 297 </para> 298 299 </section> 300 <section id="admin.pages.account.profiles"> 301 <title>Profiles</title> 302 <para> 303 Profiles are shortcuts to define the values for Platform, 304 OS, and version. This page allows you to define and edit personal 305 shortcuts. 306 </para> 307 </section> 308 </section> 309 310 311 <section id="admin.pages.manage"> 312 <title>System Management Pages</title> 313 314 315 <para>A number of pages exist under the "Manage" link. These will 316 only be visible to those who have an appropriate access 317 level. 318 </para> 319 320 <section id="admin.pages.manage.users"> 321 <title>Manage Users</title> 322 323 324 <para>This page allow an administrator to manage the users in the 325 system.It essentially supplies a list of users defined in the 326 system. The user names are linked to a page where you can change 327 the user's name, access level, and projects to which they are 328 assigned. You can also reset their passwords through this page.At 329 the top, there is also a list of new users (who have created an 330 account in the last week), and accounts where the user has yet to 331 log in.New users are created using the "Create User" link above the 332 list of existing users. Note that the username must be unique in 333 the system. Further, note that the user's real name (as displayed 334 on the screen) cannot match another user's user name. 335 </para> 336 </section> 337 338 <section id="admin.pages.manage.projects"> 339 <title>Manage Projects Page</title> 340 341 342 <para>This page allows the user to manage the projects listed in 343 the system.Each project is listed along with a link to manage that 344 specific project. The specific project pages allow the user to 345 change: 346 <itemizedlist> 347 <listitem> 348 <para>the project name</para> 349 </listitem> 350 <listitem> 351 <para>the project description</para> 352 </listitem> 353 <listitem> 354 <para>its status</para> 355 </listitem> 356 <listitem> 357 <para>whether the project is public or private. Private 358 projects are only visible to users who are assigned to it or users 359 who have the access level to automatically have access to private 360 projects (eg: administrators). 361 </para> 362 </listitem> 363 <listitem> 364 <para>afile directory used to store attachments for issues and 365 documents associated with the project. This folder is located on 366 the webserver, it can be absolute path or path relative to the main 367 MantisBT folder. Note that this is only used if the files are stored 368 on disk or via FTP. In case of FTP, the cached version that is 369 saved on the webserver, is stored in the specified path. 370 </para> 371 </listitem> 372 <listitem> 373 <para>common subprojects. These are other projects who can be 374 considered a sub-project of this one. They can be shared amongst 375 multiple projects. For example, a "documentation" project may be 376 shared amongst several development projects. 377 </para> 378 </listitem> 379 <listitem> 380 <para>project categories. These are used to sub-divide the 381 issues stored in the system. 382 </para> 383 </listitem> 384 <listitem> 385 <para>project versions. These are used to create ChangeLog 386 reports and can be used to filter issues. They are used for both 387 the Found In and Fixed In versions. 388 </para> 389 </listitem> 390 <listitem> 391 <para>Custom Fields linked to this project</para> 392 </listitem> 393 <listitem> 394 <para>Users linked to this project. Here is the place where a 395 user's access level may be upgraded or downgraded depending on 396 their particular role in the project. 397 </para> 398 </listitem> 399 </itemizedlist> 400 </para> 401 </section> 402 403 <section id="admin.pages.manage.customfields"> 404 <title>Manage Custom Fields</title> 405 406 <para>This page is the base point for managing custom fields. It 407 lists the custom fields defined in the system. There is also a 408 place to enter a new field name to create a new field.The "Edit" 409 links take you to a page where you can define the details of a 410 custom field. These include it's name, type, value, and display 411 information. On the edit page, the following information is defined 412 to control the custom field: 413 <itemizedlist> 414 <listitem> 415 <para>name</para> 416 </listitem> 417 <listitem> 418 <para>type. Possible values are listed below.</para> 419 </listitem> 420 <listitem> 421 <para>Value constraints (Possible values, default value, 422 regular expression, minimum length, maximum length). 423 </para> 424 </listitem> 425 <listitem> 426 <para>Access (who can read and write the field based on their 427 access level). 428 </para> 429 </listitem> 430 <listitem> 431 <para>Display control (where the field will show up and must be 432 filled in 433 </para> 434 </listitem> 435 </itemizedlist> 436 </para> 437 <para> 438 All fields are compared in length to be greater than or equal to 439 the minimum length, and less than or equal to the minimum length, 440 unless these values are 0. If the values are 0, the check is 441 skipped. All fields are also compared against the regular 442 expression. If the value matches the expression, then the value is 443 stored. For example, the expression "/^-?([0-9])*$/" can be used to 444 constrain an integer.The table below describes the field types and 445 the value constraints. 446 </para> 447 <informaltable> 448 <tgroup cols="3"><tbody> 449 <row> 450 <entry>Type</entry> 451 <entry>Field Contents</entry> 452 <entry>Value Constraints</entry> 453 </row> 454 <row> 455 <entry>String</entry> 456 <entry>text string up to 255 characters</entry> 457 <entry></entry> 458 </row> 459 <row> 460 <entry>Numeric</entry> 461 <entry>an integer</entry> 462 <entry></entry> 463 </row> 464 <row> 465 <entry>Float</entry> 466 <entry>a floating point number</entry> 467 <entry></entry> 468 </row> 469 <row> 470 <entry>Enumeration</entry> 471 <entry>one of a list of text strings</entry> 472 <entry>Enter the list of text strings separated by "|" (pipe 473 character) in the Possible Values field. The Default value should 474 match one of these strings as well. This will be displayed as a 475 dropdown menu. 476 </entry> 477 </row> 478 <row> 479 <entry>Email</entry> 480 <entry>an email address string up to 255 characters</entry> 481 <entry>When displayed, the value will also be encapsulated in a 482 mailto: reference. 483 </entry> 484 </row> 485 <row> 486 <entry>Checkbox</entry> 487 <entry>zero or more of a list of text strings</entry> 488 <entry>Enter the list of text strings separated by "|" (pipe 489 character) in the Possible Values field. The Default value should 490 match one of these strings as well. This will be displayed as a 491 list of text strings with a checkbox beside them. 492 </entry> 493 </row> 494 <row> 495 <entry>List</entry> 496 <entry>one of a list of text strings</entry> 497 <entry>Enter the list of text strings separated by "|" (pipe 498 character) in the Possible Values field. The Default value should 499 match one of these strings as well. This will be displayed as a 500 multi-line dropdown menu. 501 </entry> 502 </row> 503 <row> 504 <entry>Multiselection List</entry> 505 <entry>zero or more of a list of text strings</entry> 506 <entry>Enter the list of text strings separated by "|" (pipe 507 character) in the Possible Values field. The Default value should 508 match one of these strings as well. This will be displayed as a 509 multi-line dropdown menu. 510 </entry> 511 </row> 512 <row> 513 <entry>Date</entry> 514 <entry>text string defining a date</entry> 515 <entry>This is displayed as a set of dropdown menus for day, month, 516 and year. Defaults should be defined in yyyy-mm-dd format. 517 </entry> 518 </row> 519 </tbody> 520 </tgroup> 521 </informaltable> 522 523 <para> 524 The display entries are used as follows: 525 <informaltable> 526 <tgroup cols="2"><tbody> 527 <row> 528 <entry>Entry</entry> 529 <entry>Meaning</entry> 530 </row> 531 <row> 532 <entry>Display Only On Advanced Page</entry> 533 <entry>If checked, the field will NOT be shown on the simple issue 534 displays 535 </entry> 536 </row> 537 <row> 538 <entry>Display When Reporting Issues</entry> 539 <entry>If checked, the field will be shown on the report issues 540 displays 541 </entry> 542 </row> 543 <row> 544 <entry>Display When Updating Issues</entry> 545 <entry>If checked, the field will NOT be shown on the update issue 546 and change status displays 547 </entry> 548 </row> 549 <row> 550 <entry>Display When Resolving Issues</entry> 551 <entry>If checked, the field will NOT be shown on the update issue 552 displays and change status displays, if the new status is 553 resolved. 554 </entry> 555 </row> 556 <row> 557 <entry>Display When Closing Issues</entry> 558 <entry>If checked, the field will NOT be shown on the update issue 559 displays and change status displays, if the new status is 560 closed. 561 </entry> 562 </row> 563 <row> 564 <entry>Required On Report</entry> 565 <entry>If checked, the field must be filled in on the issue 566 reports. 567 </entry> 568 </row> 569 <row> 570 <entry>Required On Update</entry> 571 <entry>If checked, the field must be filled in on the update issue 572 and change status displays. 573 </entry> 574 </row> 575 <row> 576 <entry>Required On Resolve</entry> 577 <entry>If checked, the field must be filled in on the update issue 578 and change status displays, if the new status is resolved. 579 </entry> 580 </row> 581 <row> 582 <entry>Required On Close</entry> 583 <entry>If checked, the field must be filled in on the update issue 584 and change status displays, if the new status is closed. 585 </entry> 586 </row> 587 </tbody> 588 </tgroup> 589 </informaltable> 590 </para> 591 592 <para>Notes on Display 593 <itemizedlist> 594 <listitem> 595 <para>Be careful not to set both a required attribute and show 596 only on advanced display. It may be possible to trigger a 597 validation error that the user cannot recover from (i.e., field is 598 not filled in). 599 </para> 600 </listitem> 601 </itemizedlist> 602 </para> 603 </section> 604 605 606 <section id="admin.pages.manage.profiles"> 607 <title>Manage Global Profiles</title> 608 609 <para>This page allows the definition of global profiles 610 accessible to all users of the system. It is similar to the user 611 definition of a profile consisting of Platform, OS and 612 Version. 613 </para> 614 </section> 615 616 617 <section id="admin.pages.manage.config"> 618 <title>Manage Configuration</title> 619 620 621 <para>This set of pages control the configuration of the MantisBT 622 system. Note that the configuration items displayed may be on a 623 project by project basis.These pages serve two purposes. First, 624 they will display the settings for the particular aspects of the 625 system. If authorized, they will allow a user to change the 626 parameters. They also have settings for what access level is 627 required to change these settings ON A PROJECT basis. In general, 628 this should be left alone, but administrators may want to delegate 629 some of these settings to managers. 630 </para> 631 632 <section id="admin.pages.manage.config.thresholds"> 633 634 <title>Workflow Thresholds</title> 635 636 637 <para>This page covers the adjustment of the settings for many of 638 the workflow related parameters. For most of these, the fields are 639 self explanatory and relate to a similarly named setting in the 640 configuration file. At the right of each row is a selector that 641 allows the administrator to lower the access level required to 642 change the particular parameter.The values changeable on this page 643 are: 644 </para> 645 646 <formalpara><title>Issues</title> 647 <para><informaltable> 648 <tgroup cols="3"><tbody> 649 <row> 650 <entry>Title</entry> 651 <entry>Variable</entry> 652 <entry>Description</entry> 653 </row> 654 <row> 655 <entry>Report an Issue</entry> 656 <entry>$g_report_bug_threshold</entry> 657 <entry>threshold to report an issue</entry> 658 </row> 659 <row> 660 <entry>Status to which a new issue is set</entry> 661 <entry>$g_bug_submit_status</entry> 662 <entry>status issue is set to when submitted</entry> 663 </row> 664 <row> 665 <entry>Update an Issue</entry> 666 <entry>$g_update_bug_threshold</entry> 667 <entry>threshold to update an issue</entry> 668 </row> 669 <row> 670 <entry>Allow Reporter to close an issue</entry> 671 <entry>$g_allow_reporter_close</entry> 672 <entry>allow reporter to close issues they reported</entry> 673 </row> 674 <row> 675 <entry>Monitor an issue</entry> 676 <entry>$g_monitor_bug_threshold</entry> 677 <entry>threshold to monitor an issue</entry> 678 </row> 679 <row> 680 <entry>Handle Issue</entry> 681 <entry>$g_handle_bug_threshold</entry> 682 <entry>threshold to handle (be assigned) an issue</entry> 683 </row> 684 <row> 685 <entry>Assign Issue</entry> 686 <entry>$g_update_bug_assign_threshold</entry> 687 <entry>threshold to be in the assign to list</entry> 688 </row> 689 <row> 690 <entry>Move Issue</entry> 691 <entry>$g_move_bug_threshold</entry> 692 <entry>threshold to move an issue to another project. This setting 693 is for all projects. 694 </entry> 695 </row> 696 <row> 697 <entry>Delete Issue</entry> 698 <entry>$g_delete_bug_threshold</entry> 699 <entry>threshold to delete an issue</entry> 700 </row> 701 <row> 702 <entry>Reopen Issue</entry> 703 <entry>$g_reopen_bug_threshold</entry> 704 <entry>threshold to reopen an issue</entry> 705 </row> 706 <row> 707 <entry>Allow reporter to reopen Issue</entry> 708 <entry>$g_allow_reporter_reopen</entry> 709 <entry>allow reporter to reopen issues they reported</entry> 710 </row> 711 <row> 712 <entry>Status to which a reopened Issue is set</entry> 713 <entry>$g_bug_reopen_status</entry> 714 <entry>status issue is set to when reopened</entry> 715 </row> 716 <row> 717 <entry>Resolution to which a reopened Issue is set</entry> 718 <entry>$g_bug_reopen_resolution</entry> 719 <entry>resolution issue is set to when reopened</entry> 720 </row> 721 <row> 722 <entry>Status where an issue is considered resolved</entry> 723 <entry>$g_bug_resolved_status_threshold</entry> 724 <entry>status where bug is resolved</entry> 725 </row> 726 <row> 727 <entry>Status where an issue becomes read-only</entry> 728 <entry>$g_bug_readonly_status_threshold</entry> 729 <entry>status where bug is read-only (see 730 update_readonly_bug_threshold) 731 </entry> 732 </row> 733 <row> 734 <entry>Update readonly issue</entry> 735 <entry>$g_update_readonly_bug_threshold</entry> 736 <entry>threshold to update an issue marked as read-only</entry> 737 </row> 738 <row> 739 <entry>Update Issue Status</entry> 740 <entry>$g_update_bug_status_threshold</entry> 741 <entry>threshold to update an issue's status</entry> 742 </row> 743 <row> 744 <entry>View Private Issues</entry> 745 <entry>$g_private_bug_threshold</entry> 746 <entry>threshold to view a private issue</entry> 747 </row> 748 <row> 749 <entry>Set View Status</entry> 750 <entry>$g_set_view_status_threshold</entry> 751 <entry>threshold to set an issue to Private/Public</entry> 752 </row> 753 <row> 754 <entry>Update View Status</entry> 755 <entry>$g_change_view_status_threshold</entry> 756 <entry>threshold needed to update the view status while updating an 757 issue or an issue note 758 </entry> 759 </row> 760 <row> 761 <entry>Show list of users monitoring issue</entry> 762 <entry>$g_show_monitor_list_threshold</entry> 763 <entry>threshold to see who is monitoring an issue</entry> 764 </row> 765 <row> 766 <entry>Set status on assignment of handler</entry> 767 <entry>$g_auto_set_status_to_assigned</entry> 768 <entry>change status when an issue is assigned</entry> 769 </row> 770 <row> 771 <entry>Status to set auto-assigned issues to</entry> 772 <entry>$g_bug_assigned_status</entry> 773 <entry>status issue is set to when assigned</entry> 774 </row> 775 <row> 776 <entry>Limit reporter's access to their own issues</entry> 777 <entry>$g_limit_reporters</entry> 778 <entry>reporters can see only issues they reported. This setting is 779 for all projects. 780 </entry> 781 </row> 782 </tbody> 783 </tgroup> 784 </informaltable></para> 785 </formalpara> 786 787 <formalpara><title>Notes</title> 788 <para> 789 <informaltable> 790 <tgroup cols="3"><tbody> 791 <row> 792 <entry>Title</entry> 793 <entry>Variable</entry> 794 <entry>Description</entry> 795 </row> 796 <row> 797 <entry>Add Notes</entry> 798 <entry>$g_add_bugnote_threshold</entry> 799 <entry>threshold to add an issue note</entry> 800 </row> 801 <row> 802 <entry>Update Others' Notes</entry> 803 <entry>$g_update_bugnote_threshold</entry> 804 <entry>threshold at which a user can edit issue notes created by other users</entry> 805 </row> 806 <row> 807 <entry>Update Own Notes</entry> 808 <entry>$g_bugnote_user_edit_threshold</entry> 809 <entry>threshold at which a user can edit issue notes created by themselves</entry> 810 </row> 811 <row> 812 <entry>Delete Others' Notes</entry> 813 <entry>$g_delete_bugnote_threshold</entry> 814 <entry>threshold at which a user can delete issue notes created by other users</entry> 815 </row> 816 <row> 817 <entry>Delete Own Notes</entry> 818 <entry>$g_bugnote_user_delete_threshold</entry> 819 <entry>threshold at which a user can delete issue notes created by themselves</entry> 820 </row> 821 <row> 822 <entry>View private notes</entry> 823 <entry>$g_private_bugnote_threshold</entry> 824 <entry>threshold to view a private issue note</entry> 825 </row> 826 <row> 827 <entry>Change view state of own notes</entry> 828 <entry>$g_bugnote_user_change_view_state_threshold</entry> 829 <entry>threshold at which a user can change the view state of issue notes created by themselves</entry> 830 </row> 831 </tbody> 832 </tgroup> 833 </informaltable></para> 834 </formalpara> 835 836 <formalpara> 837 <title>Others</title> 838 <para> 839 <informaltable> 840 <tgroup cols="3"><tbody> 841 <row> 842 <entry>View Change Log</entry> 843 <entry>$g_view_changelog_threshold</entry> 844 <entry>threshold to view the changelog</entry> 845 </row> 846 <row> 847 <entry>View Assigned To</entry> 848 <entry>$g_view_handler_threshold</entry> 849 <entry>threshold to see who is handling an issue</entry> 850 </row> 851 <row> 852 <entry>View Issue History</entry> 853 <entry>$g_view_history_threshold</entry> 854 <entry>threshold to view the issue history</entry> 855 </row> 856 <row> 857 <entry>Send Reminders</entry> 858 <entry>$g_bug_reminder_threshold</entry> 859 <entry>threshold to send a reminder</entry> 860 </row> 861 </tbody> 862 </tgroup> 863 </informaltable></para> 864 </formalpara> 865 866 </section> 867 868 <section id="admin.pages.manage.config.transitions"> 869 <title>Workflow Transitions</title> 870 871 <para>This page covers the status workflow. For most of these, the 872 fields are self explanatory and relate to a similarly named setting 873 in the configuration file. At the right of each row is a selector 874 that allows the administrator to lower the access level required to 875 change the particular parameter.The values changeable on this page 876 are: 877 </para> 878 <table> 879 <title>Issues</title> 880 <tgroup cols="3"><tbody> 881 <row> 882 <entry>Title</entry> 883 <entry>Variable</entry> 884 <entry>Description</entry> 885 </row> 886 <row> 887 <entry>Status to which a new issue is set</entry> 888 <entry>$g_bug_submit_status</entry> 889 <entry>status issue is set to when submitted</entry> 890 </row> 891 <row> 892 <entry>Status where an issue is considered resolved</entry> 893 <entry>$g_bug_resolved_status_threshold</entry> 894 <entry>status where issue is resolved</entry> 895 </row> 896 <row> 897 <entry>Status to which a reopened Issue is set</entry> 898 <entry>$g_bug_reopen_status</entry> 899 <entry>status issue is set to when reopened</entry> 900 </row> 901 </tbody> 902 </tgroup> 903 </table> 904 <para> 905 The matrix that follows has checkmarks where the transitions are 906 allowed from the status on the left edge to the status listed 907 across the top. This corresponds to the $g_enum_workflow array.At 908 the bottom, there is a list of access levels that are required to 909 change the status to the value listed across the top. This can be 910 used, for instance, to restrict those who can close an issue to a 911 specific level, say a manager. This corresponds to the 912 $g_set_status_threshold array and the $g_report_bug_threshold 913 setting. 914 </para> 915 </section> 916 917 918 <section id="admin.pages.manage.config.email"> 919 <title>Email Notifications</title> 920 921 <para>This page sets the system defaults for sending emails on 922 issue related events. MantisBT uses flags and a threshold system to 923 generate emails on events. For each new event, email is sent to: 924 <itemizedlist> 925 <listitem> 926 <para>the reporter</para> 927 </listitem> 928 <listitem> 929 <para>the handler (or Assigned to)</para> 930 </listitem> 931 <listitem> 932 <para>anyone monitoring the issue</para> 933 </listitem> 934 <listitem> 935 <para>anyone who has ever added a issue note the issue</para> 936 </listitem> 937 <listitem> 938 <para>anyone assigned to the project whose access level matches 939 a range 940 </para> 941 </listitem> 942 </itemizedlist> 943 From this list, those recipients who meet the following criteria 944 are eliminated: 945 <itemizedlist> 946 <listitem> 947 <para>the originator of the change, if $g_email_receive_own is 948 OFF 949 </para> 950 </listitem> 951 <listitem> 952 <para>the recipient either no longer exists, or is 953 disabled 954 </para> 955 </listitem> 956 <listitem> 957 <para>the recipient has turned their email_on_<new 958 status> preference OFF 959 </para> 960 </listitem> 961 <listitem> 962 <para>the recipient has no email address entered</para> 963 </listitem> 964 </itemizedlist> 965 The matrix on this page selects who will receive messages for each 966 of the events listed down the left hand side. The first four 967 columns correspond to the first four points listed above. The next 968 columns correspond to the access levels defined. Note that because 969 a minimum and maximum threshold are used, a discontinuous selection 970 is not allowed. 971 </para> 972 </section> 973 </section> 974 </section> 975 976 <section id="admin.pages.monitor"> 977 <title>Monitor Issue</title> 978 979 <para>The monitor issues feature allows users to subscribe to 980 certain issues and hence get copied on all notification emails that 981 are sent for these issues.Depending on the configuration, sending a 982 reminder to a user about an issue can add this issue to the user's 983 list of monitored issues. Users who reported the issue or are assigned 984 the issue typically don't need to monitor the issue to get the 985 notifications. This is because by default they get notified on 986 changes related to the issue anyway. However, administrators can 987 change the configuration to disable notifications to reporters or 988 handlers in specific scenarios. 989 </para> 990 </section> 991 992 <section id="admin.pages.reopen"> 993 <title>Reopen Issue</title> 994 995 <para>Re-open issue button is visible in the issue view pages if the 996 user has the appropriate access level and the issue is 997 resolved/closed. Re-opening a issue will allow users to enter 998 issue notes for the re-opening reason. The issue will automatically be 999 put into the Feedback status. 1000 </para> 1001 </section> 1002 1003 1004 <section id="admin.pages.delete"> 1005 <title>Delete Issue</title> 1006 1007 1008 <para>The delete issues button appears on the issue view pages for the 1009 users who have the appropriate access level. This allows you to 1010 delete an existing issue. This should only be used on frivolous or 1011 test issues. A confirmation screen will prompt you if you really want 1012 to delete the issue. Updaters, Developers, Managers, and 1013 Administrators can remove issues (you can also configure 1014 this). 1015 </para> 1016 </section> 1017 1018 1019 <section id="admin.pages.close"> 1020 <title>Close Issue</title> 1021 1022 <para>This is a button that appears on the issue view pages for 1023 users that are authorized to close issues. Depending on the 1024 configuration, users may be able to close issues without having to 1025 resolve them first, or may be able to only close resolved issues. 1026 After the button is clicked, the user is redirected to a page where 1027 an issue note maybe added. 1028 </para> 1029 </section> 1030 1031 1032 <section id="admin.pages.assigntome"> 1033 <title>Assign to Me</title> 1034 1035 <para>This button appears in the issue view pages in case of users 1036 with access level that is equal to handle_bug_threshold or higher. 1037 When this button is clicked the issue is assigned to the 1038 user. 1039 </para> 1040 </section> 1041 1042 <section id="admin.pages.resolve"> 1043 <title>Resolve Issue</title> 1044 1045 1046 <para>This option on the View Issues page allows you to resolve the 1047 issue. It will lead you to a page where you can set the resolution 1048 state and a duplicate id (if applicable). After choosing that the 1049 user can choose to enter an issue note detailing the reason for the 1050 closure. The issue is then set to the Resolved state. The reporter 1051 should check off on the issue by using the Close Issue button. 1052 </para> 1053 </section> 1054 1055 <section id="admin.pages.news"> 1056 1057 <title>News Syndication</title> 1058 1059 1060 <para>MantisBT supports news syndication using RSS v2.0 protocol. 1061 MantisBT also supports authenticated news feeds for private projects 1062 or installations where anonymous access is not enabled. Authenticated feeds takes a 1063 user name and a key token that are used to authenticate the user 1064 and generate the feed results in the context of the user's access 1065 rights (i.e. the same as what the user would see if they were to 1066 logged into MantisBT).To get access to the News RSS as anonymous 1067 user, visit the following 1068 page: http://www.example.com/mantisbt/news_rss.php While a 1069 user is logged in, the RSS links provided in the UI will always 1070 provide links to the authenticated feeds, if no user is logged in 1071 (i.e. anonymous), then anonymous links will be provided. 1072 </para> 1073 </section> 1074 </chapter>
title
Description
Body
title
Description
Body
title
Description
Body
title
Body
| Generated: Thu Jul 28 15:48:31 2011 | Cross-referenced by PHPXref 0.7 |