Spira 4.2 User Manual Help Viewer
In this mode, the main pane displays the list of documents, screenshots or web-links (URLs) that have been “attached” to the requirement. The documents can be in any format, though SpiraTeam® will only display the icon for certain known types.
The attachment list includes the filename/URL that was originally uploaded together with the file-size (in KB), name of the person who attached it and the date uploaded. In addition, if you position the pointer over the filename and hold it there for a few seconds, a detailed description is displayed as a tooltip:
To actually view the document, simply click on the filename hyperlink and a new web browser window will open. Depending on the type of file, this window will either display the document / web-page or prompt you for a place to save it on your local computer. To remove an existing attachment from a requirement, simply click the [Remove] button and the attachment will be removed from the list. Using the standard filter/sort options you can also sort and filter the list of attachments to make it more manageable.
If you are using SpiraPlan or SpiraTeam (but not SpiraTest) you can also choose to include file attachments stored in a linked version control system (e.g. Subversion, CVS, Perforce, etc.) by selecting the “Include Source Code Documents” option.
To attach a new document to the requirement, you need to first click the “Add New” link to display the new attachment dialog box:
There are three different types of item that can be attached to a requirement:
- To upload a file, choose “File” as the type and then click the Browse button and select the file from your local computer, optionally enter a detailed description then click the <Upload> button. The document will be copied from your computer and attached to the artifact.
- To attach a web-link (URL) to the artifact, you need to choose “URL” as the type and then enter the fully qualified URL (e.g. ), an optional description and then click the <Upload> button to attach the web-link.
- To attach a screenshot to the artifact, you need to choose “Screenshot” as the type and then copy the image to your computer’s clipboard (e.g. on Windows computers, the PRINT SCREEN button captures the current page and adds to the clipboard). Once the image is in the clipboard, paste it into the editor using CTRL+V (or the equivalent keystroke for your operating system) and the item will appear in the preview window. You can then fill in the other fields and click <Upload> to attach the image.
Note: If you are using a non-Windows® computer (e.g. Macintosh®) that doesn’t put file extensions on filenames (e.g. .xls for an Excel sheet) automatically, then you will need to manually add the file extension to the filename before uploading if you want it to be displayed with the correct icon in the attachment list.
You can also associate an existing document (that’s already stored in SpiraTeam) with the requirement. To do that, click on the “Add Existing” hyperlink to bring up the add file association dialog box:
You can then choose to either associate a document stored in the SpiraTeam Documents repository or (in the case of SpiraPlan/SpiraTeam but not SpiraTest) from the linked source code repository. In either case you first select the appropriate folder, and then pick the document(s) from the file list on the right. In the case of a source code file association you can also add a comment.