Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision
Previous revision
75:workwithfiles [2020/09/01 19:13] – [Reviewing a file] aakr75:workwithfiles [2024/02/15 00:00] (current) – external edit 127.0.0.1
Line 1: Line 1:
 ====== Work with files ====== ====== Work with files ======
  
-In an instantiated project or a program, specific deliverables are consumed as well generated during the execution of an ''activity''. These deliverables files are part of the ''work product'' which has further information like description, ''guidance'', ''milestone'' and ''activity'' or ''workflow'' where it is used as input or output. +In an instantiated project or a program, specific deliverables are consumed as well generated during the execution of an ''activity''. These deliverables files are part of the ''work product'' which has further information like ''description'', ''guidance'', ''milestone'' and ''activity'' or ''workflow'' where it is used as input or output.
- +
-Though the ''work product'' is modeled in Stages, the files are stored in the configuration management system (CM) like Subversion or SharePoint. Users can avail some of the CM features from Stages itself. For example, users can check in and check out the document in Stages to lock the file while editing to avoid overlapping edits. They can also check the version history and change state of the file in Stages. +
- +
- +
-====== Work with files ====== +
- +
-In an instantiated project or a program, specific deliverables are consumed as well generated during the execution of an ''activity''. These deliverables files are part of the ''work product'' which has further information like description, ''guidance'', ''milestone'' and ''activity'' or ''workflow'' where it is used as input or output.+
  
 Though the ''work product'' is modeled in Stages, the files are stored in the configuration management system (CM) like Subversion or SharePoint. Users can avail some of the CM features from Stages itself. For example, users can check in and check out the document in Stages to lock the file while editing to avoid overlapping edits. They can also check the version history and change state of the file in Stages. Though the ''work product'' is modeled in Stages, the files are stored in the configuration management system (CM) like Subversion or SharePoint. Users can avail some of the CM features from Stages itself. For example, users can check in and check out the document in Stages to lock the file while editing to avoid overlapping edits. They can also check the version history and change state of the file in Stages.
Line 20: Line 13:
   - Linking an existing file [[https://doc.stagesasaservice.com/lib/exe/fetch.php?tok=7e6c58&media=https://doc.stagesasaservice.com/lib/plugins/ckgedit/fckeditor/userfiles/image/75/addnewfile.png|{{  https://doc.stagesasaservice.com/lib/plugins/ckgedit/fckeditor/userfiles/image/75/addnewfile.png?direct&800x517  }}]]   - Linking an existing file [[https://doc.stagesasaservice.com/lib/exe/fetch.php?tok=7e6c58&media=https://doc.stagesasaservice.com/lib/plugins/ckgedit/fckeditor/userfiles/image/75/addnewfile.png|{{  https://doc.stagesasaservice.com/lib/plugins/ckgedit/fckeditor/userfiles/image/75/addnewfile.png?direct&800x517  }}]]
  
-**1. Uploading a new file: **Easiest way to add a new file is by using the drag & drop function or browsing to the folder <font inherit/inherit;;#ffffff;;rgb(231, 76, 60)>**(1)**</font> and uploading the file. Alternatively, user can click on Add <font inherit/inherit;;#ffffff;;#e74c3c>**(2)**</font> and select the upload file from the widget. This uploads the file to configuration management system linked to Stages.+**1. Uploading a new file: **Easiest way to add a new file is by using the drag & drop function or browsing to the folder 
 + **(1)**  and uploading the file. Alternatively, user can click on Add 
 + **(2)**  and select the upload file from the widget. This uploads the file to configuration management system linked to Stages.
  
 [[https://doc.stagesasaservice.com/lib/exe/fetch.php?tok=4408eb&media=https://doc.stagesasaservice.com/lib/plugins/ckgedit/fckeditor/userfiles/image/73/drag_drop2.png|{{  https://doc.stagesasaservice.com/lib/plugins/ckgedit/fckeditor/userfiles/image/73/drag_drop2.png?direct&800x506  }}]] \\ **2. Using a template to add a new file: **In Stages, files can also be created using a template and this file can then be added in ''work product''. This simplifies document creation and also ensures consistency across the organization. [[https://doc.stagesasaservice.com/lib/exe/fetch.php?tok=4408eb&media=https://doc.stagesasaservice.com/lib/plugins/ckgedit/fckeditor/userfiles/image/73/drag_drop2.png|{{  https://doc.stagesasaservice.com/lib/plugins/ckgedit/fckeditor/userfiles/image/73/drag_drop2.png?direct&800x506  }}]] \\ **2. Using a template to add a new file: **In Stages, files can also be created using a template and this file can then be added in ''work product''. This simplifies document creation and also ensures consistency across the organization.
Line 35: Line 30:
  
 [[https://doc.stagesasaservice.com/lib/exe/fetch.php?tok=acef75&media=https://doc.stagesasaservice.com/lib/plugins/ckgedit/fckeditor/userfiles/image/75/linkfile.png|{{  https://doc.stagesasaservice.com/lib/plugins/ckgedit/fckeditor/userfiles/image/75/linkfile.png?direct&700x541  }}]] [[https://doc.stagesasaservice.com/lib/exe/fetch.php?tok=acef75&media=https://doc.stagesasaservice.com/lib/plugins/ckgedit/fckeditor/userfiles/image/75/linkfile.png|{{  https://doc.stagesasaservice.com/lib/plugins/ckgedit/fckeditor/userfiles/image/75/linkfile.png?direct&700x541  }}]]
- 
  
 ===== Checking in and out an existing file ===== ===== Checking in and out an existing file =====
  
-To work on an existing file, check it out by clicking on ''Download & lock''. This will prevent another user from downloading or checking in another version of the file. Alternatively, you can simply ''Lock'' the file to prevent another user from editing the file.+To work on an existing file, check it out by clicking on ''Download & lock''. This will prevent another user from downloading or checking in another version of the file. Alternatively, you can simply ''Lock''  the file to prevent another user from editing the file.
  
-Once you are ready to check-in the file, click on ''Upload'' to check the new version of the file. Using the ''Version History'', user can check all the version of the file along with other information like state, author and date and download the previous version if needed.+Once you are ready to check-in the file, click on ''Upload''  to check in the new version of the file.
  
 [[https://doc.stagesasaservice.com/lib/exe/fetch.php?tok=ca26bb&media=https://doc.stagesasaservice.com/lib/plugins/ckgedit/fckeditor/userfiles/image/75/checkinginandout.png|{{  https://doc.stagesasaservice.com/lib/plugins/ckgedit/fckeditor/userfiles/image/75/checkinginandout.png?direct&969x700  }}]] [[https://doc.stagesasaservice.com/lib/exe/fetch.php?tok=ca26bb&media=https://doc.stagesasaservice.com/lib/plugins/ckgedit/fckeditor/userfiles/image/75/checkinginandout.png|{{  https://doc.stagesasaservice.com/lib/plugins/ckgedit/fckeditor/userfiles/image/75/checkinginandout.png?direct&969x700  }}]]
  
 +===== Setting State of a File =====
  
-===== Reviewing a file ===== +In different phases of product development, reviews play an important part in ensuring defects are caught at the earliest and to improve the quality of the end deliverables. Stages offers two default lifecycle review options: ''Simple Document Review''  and ''Mandatory Document Review''. In addition, there is also an option to configure the review lifecycle to align with your own organization's document review lifecycle.
- +
-In different phases of product development, reviews play an important part in ensuring defects are caught at the earliest and to improve the quality of the end deliverables. Stages offers two default lifecycle review options: ''Simple Document Review'' and ''Mandatory Document Review''. In addition, there is also an option to configure the review lifecycle to align with your own organization's document review lifecycle.+
  
 In Simple Document Review, the file can be promoted from draft to release state. However, Mandatory Document Review has an additional state called 'review' between draft and released state requiring mandatory formal review of the file. In Simple Document Review, the file can be promoted from draft to release state. However, Mandatory Document Review has an additional state called 'review' between draft and released state requiring mandatory formal review of the file.
Line 54: Line 47:
 To set the state of the file, click on three dots next to the file name and select ''Set state.'' To set the state of the file, click on three dots next to the file name and select ''Set state.''
  
-''{{  https://doc.stagesasaservice.com/lib/plugins/ckgedit/fckeditor/userfiles/image/75/setstate_1.png?direct&700x354  }}''Enter comment and select ''Set State'' to save the state. The options in the dropdown would depend on review lifecycle set by project manager.+''[[https://doc.stagesasaservice.com/lib/exe/fetch.php?tok=4a0c84&media=https://doc.stagesasaservice.com/lib/plugins/ckgedit/fckeditor/userfiles/image/75/setstate_1.png|{{  https://doc.stagesasaservice.com/lib/plugins/ckgedit/fckeditor/userfiles/image/75/setstate_1.png?direct&700x354  }}]]''  Enter comment and select ''Set State''  to save the state. The options in the dropdown would depend on review lifecycle set by project manager
 + 
 +''[[https://doc.stagesasaservice.com/lib/exe/fetch.php?tok=d8a596&media=https://doc.stagesasaservice.com/lib/plugins/ckgedit/fckeditor/userfiles/image/75/setstate2.png|{{  https://doc.stagesasaservice.com/lib/plugins/ckgedit/fckeditor/userfiles/image/75/setstate2.png?direct&600x249  }}]]'' 
 + 
 +Once the state has been updated, the state icon on the work product will also get updated based on state of the file. In case there are multiple files, icon reflects the state of least mature file. 
 + 
 +''[[https://doc.stagesasaservice.com/lib/exe/fetch.php?tok=2d7beb&media=https://doc.stagesasaservice.com/lib/plugins/ckgedit/fckeditor/userfiles/image/75/setstateicon.png|{{  https://doc.stagesasaservice.com/lib/plugins/ckgedit/fckeditor/userfiles/image/75/setstateicon.png?direct&400x209  }}]]'' 
 + 
 +===== Version History ===== 
 + 
 +Using the version history, user can check all the version of the file along with other information like state, author and date and download the previous version if needed. To access version history, click on the three dots and select V''ersion History''
 + 
 +[[https://doc.stagesasaservice.com/lib/exe/fetch.php?tok=178652&media=https://doc.stagesasaservice.com/lib/plugins/ckgedit/fckeditor/userfiles/image/75/versionhistory1.png|{{  https://doc.stagesasaservice.com/lib/plugins/ckgedit/fckeditor/userfiles/image/75/versionhistory1.png?direct&900x455  }}]] 
 + 
 +Click or tap on the version number to download that version of the file. 
 + 
 +[[https://doc.stagesasaservice.com/lib/exe/fetch.php?tok=29322c&media=https://doc.stagesasaservice.com/lib/plugins/ckgedit/fckeditor/userfiles/image/75/versionhistory2_1.png|{{  https://doc.stagesasaservice.com/lib/plugins/ckgedit/fckeditor/userfiles/image/75/versionhistory2_1.png?direct&900x228  }}]] 
 + 
 +===== Using Refresh to sync with CM ===== 
 + 
 +When a user is working with a work product in Stages which has the file which is simultaneoulsy been updated in the CM system, ''Refresh''  can be used to access and update this latest information in Stages.
  
-''{{  https://doc.stagesasaservice.com/lib/plugins/ckgedit/fckeditor/userfiles/image/75/setstate2.png?direct&700x291  }}''+[[https://doc.stagesasaservice.com/lib/exe/fetch.php?tok=ffee08&media=https://doc.stagesasaservice.com/lib/plugins/ckgedit/fckeditor/userfiles/image/75/refresh.png|{{  https://doc.stagesasaservice.com/lib/plugins/ckgedit/fckeditor/userfiles/image/75/refresh.png?direct&900x455  }}]]