The issue detail page is where you read and update information about an issue. You can open the issue detail page using any of these methods:
- Find a link to the issue on one of the lists on the Homepage.
- Conduct a search for the issue. On the search page, enter keywords and other criteria that the issue will match, including the Issue ID if you know it. Choose the link to your desired issue from the search results table.
- Click a link to the issue in an email sent to you by Squish.
- Depending on project and personal settings, Squish may send you e-mail when issues that are assigned to you or on your watch list are updated. This email will contain a link to the issue detail page. If your email software does not support links, you can copy the URL from the text of the e-mail and paste it into your browser window. If you are not already logged in to Squish, you will be prompted you for your username and password first, but you will go directly to the issue detail page once you enter them.
Issue Bar
These options allow you to interact with the whole issue, either by modifying it, following changes made to it, or by e-mailing other users in relation to it. The buttons and menus displayed on the issue bar will change depending on the role(s) the member viewing the issue has. The possible buttons and menus are:
| Button |
Description |
|
Top
|
Scrolls to the top of the issue. |
| Print |
Opens a printer-friendly version of the issue. When printed, the file name will be in the following format: [Project name] _ [Company name] _ [Issue number] [Issue title] - Print - Squish |
| Comment |
Click this button to take you directly to the open Post a Comment field. |
| Delete |
Only members who have roles that have manager permissions can delete issues.
- Click Delete and then Delete Issue to confirm to remove an issue permanently from the project. Click Back to Issue to not delete the issue.
- If other issues include the deleted issue number as a value for a field with an Issue Type of “Issue”, then it will be removed upon deletion. History of that field’s value is retained for reference.
|
| Watch/Unwatch |
Watch adds the issue to your watch list and Unwatch removes the issue from your watch list. |
| Email |
Click this button to send a message to other project members. The dialog that opens contains a checkbox to BCC email recipients, a free text message field, and a dropdown to select users and/or groups to email. A Group Members button opens another dialog where you can view the members of each group, if that group is configured to allow members to be viewed. |
| Hide History/Show History |
Click Hide History to not display the changes that have been recorded for the issue. Click Show History to display the changes that have been recorded for the issue. The changes are displayed beneath the user names. |
| Convert To |
Members who have roles that have manager permissions can change issues from one issue type to another. Select the appropriate issue type to change the current issue to. |
| Notifications |
If you would like to send an automatic e-mail when you update the issue, click Notify and enter names of the project members you would like to notify. The same people will be automatically notified each time you update that issue. You can remove selected members by clicking the "x" next to their name. |
| New Child |
If the Parent ID field is active and displayed, this option allows you to create a related (new) child issue from an existing issue.
- Select New Child, then select an issue type for the new issue. A new issue submit page will open.
- The Parent ID field on the new issue submit page will display the existing issue's ID by default.
|
| Update Issue |
Your changes will be saved and you will be returned to where you were when you accessed the issue. |
| Workflow |
If there are workflows associated with an issue, the Workflow will be available. The fields that are being prompted for will be displayed as well as a Comment field. Fill in any required fields, post any comments you have and click Update Issue. |
Project Fields
Project fields are displayed depending on the administrator configured settings, either on the right side of the screen, above the initial comment, or below the initial comment. The fields will vary depending on whether or not the member viewing the issue has a role with permission to view the fields. Fields will only be editable if the member has a role with permission to edit the fields.
Under the issue’s Subject and ID, several badges give a quick overview of the issue. The Issue Type, Status, Date Entered, and Date Modified values are displayed.
A link to Collapse Fields is available at the top of the field section on the right side of the screen. At the bottom of the same section is a Show Field History button, if there is any field history beyond the initial issue submit. Click the button to see a table of the changes that have occurred in the fields where history is recorded. Recording of history is set when adding or editing a field.
Additionally, there is a Show all Attachments button. Selecting the button opens a dialog which displays links to all attachments in the issue. From this dialog, you can select individual attachments to download them or use the Download All button to download a zip file containing all attachments. The zip file name will include the project name and issue number. Attachments uploaded in confidential comments will only be downloadable for users whose accounts are assigned the permission to view confidential comments.
Updating Issues
The main section of the screen contains the discussion on the issue. To save space on the screen, not all comments are displayed. To view all of the comments, click Show all __ comments.
- If history is recorded for fields and changes have been made to those fields, the information on what was changed will be displayed in the comment boxes. If things were changed for an issue, but no comment was made, the changes are listed without a comment.
You can preview how a comment will look by clicking the preview link at the top right of the Comments box. This will allow you to make sure that you used the formatting tags correctly. Click in the Comments box to turn off the preview.
To update an issue without leaving the page, hold the Shift keyboard key, then the Update Issue button will become the Save Issue button. Click Save Issue and your updates will be saved without leaving the issue.
Making Changes to Existing Comments
Individual comments can be manipulated in several ways. Clicking the timestamp link for an issue will update the page URL to specifically reference the corresponding comment. That comment will be displayed as close to the top of the screen as possible when using that link to view the page.
Several options are available under a comment's menu.
Delete a comment - You can delete your comment if it is the last one in the list. Click the Delete link to delete a comment. Click Delete to confirm your action. If you change your mind, you can cancel by clicking Back to Issue. Once you have updated the issue, the comment is permanently removed. If you have a role that has Manager permissions, you can delete the last comment entered no matter who entered it.
Edit a comment - You can only edit the comments that you entered. To edit a comment, click the Edit link. When editing a comment, you have the ability to remove and add attachments. To remove attachments, click the X next to the attachment(s) you want to remove. Click Update Issue when all changes have been made. If you change your mind, you can cancel by clicking Back to Issue. Once you have updated the issue, the changes are permanent. Updated comments have a link noting the number of times the comment has been updated. This link opens a dialog displaying a printable history of changes made to the comment. If you have a role that has Manager permissions, you can edit all comments.
Quote a comment - You can quote a previous comment in an issue by clicking the Quote link. The full comment will be inserted in the Post a Comment field with the [quote author= ] [/quote] formatting tags. You can remove parts of the quote manually if you do not want to include it in its entirety.
Pin a comment - A comment can be pinned via the Pin option. This will ensure the comment is always visible to users viewing the issue, even if comments are collapsed.
Direct link to a comment - The Copy Link option will copy a direct link to the selected comment. Navigating to this link will open the issue and automatically scroll to the comment.
If you have a role that has Manager permissions, you can edit all comments. If you do not have Manager permissions, you can only edit the comments that you entered. To edit a comment, click the Edit link. When editing a comment, you have the ability to remove and add attachments. To remove attachments, click the X next to the attachment(s) you want to remove. Click Update Issue when all changes have been made. If you change your mind, you can cancel by clicking Back to Issue. Once you have updated the issue, the changes are permanent.
You can quote a previous comment in an issue by clicking the Quote link. The full comment will be inserted in the Post a Comment field with the [quote author= ] [/quote] formatting tags. You can remove parts of the quote manually if you do not want to include it in its entirety.
A comment can be pinned via the Pin option. This will ensure the comment is always visible to users viewing the issue, even if comments are collapsed.
The Copy Link option will copy a direct link to the selected comment. Navigating to this link will open the issue and automatically scroll to the comment.
Changing Confidentiality of Comments
Comments that are marked as confidential will have a lock icon next to them. If a user cannot view confidential comments, the entire comment, including the lock icon, will not be visible.
If you edit a confidential comment, you can click the Keep this comment confidential checkbox to uncheck it. Click the Save Changes button to save the change to the comment.
Resolving issues
When submitting a new comment, or editing an existing comment, the Mark this comment as the resolution for the issue checkbox is available. Selecting this will highlight the comment in the issue and add a "Resolution" tag to the comment next to the date/time.