XStudio User guide

The documents




XStudio includes a document management module. Documents are versioned and protected by a locking mechanism preventing 2 users simultaneously editing the same document (hence avoiding conflicts). Any object in XStudio (requirements, tests etc.) can also have some attached files handled with the same great features.

Add an attachment

To add an attachment:
  • click on the Create attachment button
  • a dialog box is displayed
  • pick a file and submit

Download/Open an attachment

To download/open an attachment:
  • select an item in the list
  • click on the Download attachment download attachment no focus or Open attachment button

Open and lock an attachment

When a user needs to modify a document, nobody on the network should be able to modify it at the same time. This is the role of the locking system. When the user locks a document, the file is still accessible and readable by the other users but it cannot be committed to the repository. Hence, the locking mechanism prevents any editing conflicts.
To lock and modify an attachment:
  • select an item in the list
  • click on the Open and lock attachment button
  • the file opens using the default program associated to the file extension
  • the file can be edited and saved (it's only saved on the local disk in a temporary folder at this point)

Commit and unlock an attachment

When your modification on a document is finished, you just need to save it and commit it to the repository. In addition, you'll need to unlock it again to let someone else edit it, if necessary.
To commit and unlock an attachment:
  • select an item in the list
  • click on the Commit and unlock attachment button
  • the file being edited (and which has been saved locally) is committed to the XStudio database

Delete an attachment

To delete an attachment:
  • click on the delete attachment button
  • a dialog box is displayed to confirm the deletion
  • Submit