Stages Documentation

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
74:versions [2019/11/01 19:43] – emr74:versions [2024/02/15 00:00] (current) – external edit 127.0.0.1
Line 1: Line 1:
 ====== Manage Process Versions ====== ====== Manage Process Versions ======
  
-All process content should always be version controlled. In Stages, all process content can be versioned by workspace.+Stages processes can be baselined by using the process version feature. A modeler will always be making changes in the [[:general:workingversion|working version]] of the process, while the end users will typically only be shown the baselined [[:general:validversion|valid process version]].
  
-===== Use existing process versions ===== 
- 
-To manage process versions, go to ''Management > Process Versions''. All versions within the current workspace are listed there. 
- 
-TODO: screenshot 
- 
-Each version has a state, name, creator, and creation date. The currently [[:general:validversion|valid version]] is marked with "V", the [[:general:workingversion|working version]] is marked with "W". With the context menu on the right side, you can perform operations on that specific process version: 
- 
-  * **Check readiness**: run process consistency checks to see if the version is ready for a release **(only in Working Version)** 
-  * **Release as Valid Version**: mark this version as the [[:general:validversion|valid version]] **(only in non-Valid Version)** 
-  * **Set state**: change the state of the version 
-  * **Rename**: rename the version 
-  * **Replace Working Version**: revert the working version to the selected version **(only in non-Working Version)** 
-  * **Export**: export the version as a ZIP file. This ZIP file can be imported in another workspace or Stages server via Import. 
-  * **Export for Translation**: see [[:74:export_for_translation|]] for more details 
-  * **Create PDF**: see [[:74:export_pdf|]] for more details 
-  * **Delete**: delete the version 
 ===== Create a new version ===== ===== Create a new version =====
  
-Use the New version button to create a new version. Stages takes you through four steps to accomplish this.+To create a new process verisons, navigate to Management > Process version and click or tap on the ''Add Version'' button to create a new version. This baselines the entire workspace. Stages takes you through four steps to accomplish versioning.
  
-==== Check readiness ====+**1. Check readiness**
  
-Several process readiness checks are executed in parallel. See [[:doc.stagesasaservice.com:doku.php?id=:72:consistency|Check Process Consistency]] for more info.+Several process readiness checks are executed in parallel. See [[:72:consistency|]] for more info.
  
 If you are not interested to see the results, for example for a backup version, you can skip the readiness checks. If you are not interested to see the results, for example for a backup version, you can skip the readiness checks.
  
-==== Enter properties ====+**2. Enter properties**
  
-Enter the name and state of the new version here. To mark the new version immediately as valid, set the respective switch.+Enter the name and state of the new version here. To mark the new version as valid, set the respective switch.
  
-==== Create version ====+[[https://doc.stagesasaservice.com/lib/exe/fetch.php?tok=a649fb&media=https://doc.stagesasaservice.com/lib/plugins/ckgedit/fckeditor/userfiles/image/72/addversion.png|{{  https://doc.stagesasaservice.com/lib/plugins/ckgedit/fckeditor/userfiles/image/72/addversion.png?direct&800x409  }}]] 
 + 
 +**3. Create version**
  
 Stages creates the new version in the background. You can navigate to other pages and continue working while the version is being created. Stages creates the new version in the background. You can navigate to other pages and continue working while the version is being created.
  
-==== Summary ====+**4. Summary**
  
 A short summary of the version creation is shown here. A short summary of the version creation is shown here.
 +
 +===== Recommended practices for managing process versions =====
 +
 +It is highly recommended to **not set working version as valid**. When a process is newly created, the working version being the only version is set as valid by default. The process should be baselined and marked as valid so that the working version no longer continues to be the valid.
 +
 +{{  https://doc.stagesasaservice.com/lib/plugins/ckgedit/fckeditor/userfiles/image/74/workingversionasvalid_1.png?direct&800x254  }}
 +
 +End users should always view the released baseline of the process which is the valid version in Stages. If the working version is set as valid, users view the process which is still been updated by modelers and is not ready to be viewed or used.
  
 ===== Import versions or translations ===== ===== Import versions or translations =====
  
-TODO: screenshot+ZIP files created via the ''Export'' operation can be imported into Stages. The imported content replaces the current working version. If the current working version is not empty, a ''Backup working version'' is being created before the import.
  
-ZIP files created via the ''Export''  operation can be imported here. The imported content replaces the current working version. If the current working version is not empty, a ''Backup working version''  is being created before the import.+[[https://doc.stagesasaservice.com/lib/exe/fetch.php?tok=fa07f8&media=https://doc.stagesasaservice.com/lib/plugins/ckgedit/fckeditor/userfiles/image/74/importversion.png|{{  https://doc.stagesasaservice.com/lib/plugins/ckgedit/fckeditor/userfiles/image/74/importversion.png?direct&800x368  }}]]
  
-Process content that was translated via an automated translation system can also be imported here by using the ''Import translation''  operation. See [[:74:import_translation|]] for more details.+Process content that was translated via an automated translation system can also be imported here by using the ''Import translation'' operation. See [[:74:import_translation|]] for more details.
  
 ===== How to roll back the Working Version to a previous version ===== ===== How to roll back the Working Version to a previous version =====
  
-Open the menu of the process version you would like to roll back to. Then select ''Replace Working Version''+Open the menu of the process version you would like to roll back to. Then select ''Replace Working Version.'' 
 + 
 +[[https://doc.stagesasaservice.com/lib/exe/fetch.php?tok=a995ef&media=https://doc.stagesasaservice.com/lib/plugins/ckgedit/fckeditor/userfiles/image/74/replaceworkingversion_1.png|{{  https://doc.stagesasaservice.com/lib/plugins/ckgedit/fckeditor/userfiles/image/74/replaceworkingversion_1.png?direct&800x391  }}]] 
 + 
 +=====   =====