Document Manager
 |
Hash symbols (#) are not allowed in document names, including file attachments uploaded to Codebeamer. When creating a new document, hash symbols (#) in the document name are automatically converted to dash characters (-).
|
When downloading files on Windows OS, the following rules apply:
• The hash symbol (#) is replaced with a dash (-) character.
• Any HTML markup in the file name is removed. For example, < a >.
When downloading on Windows OS, the following characters are replaced with an underscore (_):
• ”
• *
• /
• :
• <
• >
• ?
• |
Introduction to the Document Manager
The Document Manager provides a secure, role-based document access where you can share, upload, download, browse, version, approve, and track documents.
The main features are the following:
• Baselining with Electronic Signature - When you create a new baseline, a snapshot of your documents is saved for audit and traceability purposes.
• Role-based Access Control - Control which documents can be read or written by users having various roles or custom roles.
• Version Control - Track document versions and prevent accidental document deletion or overwriting.
• Document Delivery and Notification - Users can create and download folders for software delivery as well as organize secure document distribution with access notification and access audit trail.
• User Access Audit Trail - Tracks how and when documents are accessed by users. Regulatory compliance may require a permanent record of document access such as: read, modify or delete.
• Search and Indexing - Full text search and indexing on Microsoft Word, RTF, PDF, HTML, Wiki and Text documents.
• Folders and Sub-folders - Users can create folders and sub-folders and store and organize documents.
• Comments, Tags, and Attachments - Users can add comments, tags, and attachments to documents.
• WebDAV access - With the WebDAV Web based Distributed Authoring and Versioning protocol, users can access documents directly from Microsoft Office and other WebDAV compliant applications.
Access the Document Manager from the Codebeamer main page by selecting a Project. Then click on the Documents Tab, across the top.
Adding a Document and Bulk Uploads with Zip files
You can add (upload) single or multiple documents to the document manager. To add documents, click > > and select a file. Then click the blue Upload button.
You can add multiple documents at the same time by packing the documents into a Zip (or Gzip or Tar) file, and then automatically unpacking the contents of the uploaded Zip, Tar or Gzip documents. To unpack at upload, check the Unpack archive files with .zip, .tar, .tar.gz or .tgz extension box. When the Unpack archive files with .zip, .tar, .tar.gz or .tgz extension box is checked, the server unpacks the document from the Zip archive after uploading, preserving the directory structure.
Upload Limit - Maximum File Size
The default maximum size of a document upload in Codebeamer is 5Gb.
 |
If you need to change this limit, please ask your system administrator, or see Post-installation Configuration
|
Search Documents
Full text search is provided on Microsoft Word, RTF, PDF, HTML, PPT Wiki and Text documents. More information on Searching
Adding New Wiki Notes
Wiki Notes are Wiki documents stored and referenced under the Document Manager. You can use Wiki notes as a notebook to record ideas, memoranda, to-do lists, etc. To create a new note click New and select Wiki Noteoption. You can use the Wiki formatting, link and macro features. See the on-line Wiki Markup and Plugins for details.
Adding New Diagram
You can create new diagrams under documents. Click 
and select the Diagram option.
and select the Diagram option.The diagram editor window opens. Diagrams created under documents can be inserted to tracker item descriptions, comments etc. using the insert button of the WYSIWYG editor.
Working with Documents
You can organize documents within a directory by Status, Description, Name, Version, Last modified, by, and Size by clicking on their respective headings. You can also organize by Tag.
Editing Properties
To modify the properties of a documents, click Edit Properties. The Edit Properties window is shown. In this window, you can edit the Name, Owner, Status, Description, and Max. Versions fields of the selected document.
Adding Comments and Attachments
You can leave your questions or comments with attachments regarding a document by opening the Comments & Attachments tab. To add an Attachment, click Add Comment, then in the comment editing pane, click Upload File.
Associating Document with other Artifacts
You can associate artifacts to other documents, items, and wiki pages by opening the Associations tab. Associations function in both directions: if a document is associated with a tracker item, the tracker item is also associated with the document.
Tagging Documents
Directories and documents can be classified using tags. Fore more information, see Taxonomy:
Categorizing Content with Tags.
Accessing Documents from MS Office And Windows with WebDAV (Webfolder)
A complete set of document management functionality is accessible directly from the Microsoft Office toolbar and the Microsoft Windows Explorer using the WebDAV protocol. From the Windows desktop you can use copy/paste to access documents.
For more information, see MS Office And Windows Integration With WebDAV
Restore Deleted Document from Trash
When a document is deleted, it is archived in the document trash. The project administrator can restore deleted documents from the trash. Only the system administrator can empty the document trash.