Page tree
Skip to end of metadata
Go to start of metadata


One of the main Sofmobile Teleport for Jira strength is the Hold-Resume functionality. It helps create workflows that allowpause an issue, do some work and then resume to the previously paused step (i.e. back to the main workflow). And while the multi-transition approach is the answer for projects with "small" workflows, BPM platforms using extensive workflows struggle of functional impossibility. Aiming to answer these needs Sofmobile developed a tool that extends Jira main functionality and facilitate user experience in regards to the possibility of back-track movement. Sofmobile Teleport for Jira achieves this functionality with a set of post functions, conditions and administrative buttons.


This section will lead you though the path that makes possible back-track movement in your workflow.



Configure the workflow adding Hold-Resume sub-flow


1. Add Hold-Resume sub-flow to your project workflow.

  • First, access the workflow you need to edit. You can access workflows from the Jira Administration menu, or directly from a project.

  • Edit the workflow. In our example, we’re editing the Teleport Project workflow.

  • Then add HOLD and RESUME statuses /you can choose different names for these statuses, but for the purpose of this example we will use those names/.



2. Allow all statuses to transition to HOLD status.

  • Click HOLD status and then click Allow all statuses to transition . For our example, we click HOLD and select the check box to Allow all statuses to transition to this one.

  • Add the Sofmobile post function Set Teleport Resume Point .

  • When you are finished, you should see the post function added to the list of post functions associated with the transition. In our example, you can see that we successfully added the Creates a Teleport Resume Point so the issue can return back in the last saved status at a later stage post function.

  • Make sure that the post function is set to the first position.



  • Then add the Sofmobile condition Prevent multiple Restore Points to the same transition. Adding this condition you prevent the possibility once step on HOLD status to move on the same status again before exiting the Hold-Resume sub-flow. In other words, you will prevent a jump from one "Hold-Resume sub-flow" to "to another Hold-Resume sub-flow" in the same workflow. More for this case you can find in this example.   
  • When you are finished, you should see the condition added to the list of conditions associated with the transition. In our example, you can see that we successfully added the Condition to hide the transition if an active Restore Point already exist for the issue condition.
  • Before you move on make sure to Publish your workflow.



3. Create new transition in between the HOLD and RESUME statuses.

  • Enter the workflow’s edit mode. In our example, we’re editing the Teleport project workflow.
  • Click Add transition and create a transition that connects HOLD and RESUME statuses. Name it Resume /you can choose different name, but for the purpose of this example we will use this one/.
  • Click the transition you need to add a condition to, and then click Post functions. For our example, we click Resume.

  • Add the Sofmobile post function Return to Teleport Resume Point .

  • When you are finished, you should see the post function added to the list of post functions associated with the transition. In our example, you can see that we successfully added the Returns to the latest saved Teleport Resume Point post function.

  • Use the arrows to the right in the table to move the post function to the last position. In our case it would be the last position 6.



It is very important to position this function at the last position otherwise the restore will not work properly and might create inconsistency. Sofmobile Teleport for Jira will warn you if the position is not the last and the warning will disappear once the post function is positioned at the correct place.

  • Before you move on make sure to Publish your workflow.



4. In order to use the full potential of Hold - Resume functionality you can add more statuses /actions/ in their sub-flow.

  • For example, if you need an additional validation of particular information before moving back to the main workflow, you may add VALIDATED status between HOLD and Resume statuses.
  • Then add transition named Validate in between HOLD and VALIDATED and another one named Resume in between VALIDATED and RESUME statuses.
  • In this case the Sofmobile post function Return to Teleport Resume Point should also be added to the Resume transition. Validate transition does not need specific properties.
  • Make sure that the post functions have been set to the right position as already have been shown.
  • Publish your workflow before move on.





How to use


Now, when the workflow is completed you can test the Hold-Resume functionality. Opening an issue based on the already configured workflow you will see additional buttons in the command bar - in our example Hold /Resume.

  • Create an issue and Start the progress. The current status of the issue will be IN PROGRESS.
  • Then, in order to pause the main workflow, click HOLD button.



  • Now the issue current status will be Hold. The history of the issue will also be updated respectively. All transitions of the main workflow will not be accessible. 


Please note it is not a good practice to create link/transition between the sub-flow and the main workflow (usually Hold-Resume sub-flow is nicely isolated and not connected to the main flow in any way; such "transition" will be handled by the plugin itself by "Resume". However, should you still need to create such transition between the Hold-Resume sub-flow and the main workflow then make sure you properly configure and ideally call this transition only in special use cases with special user privileges if it is configured so. The created earlier restore point will either become orphan (and will be cleaned on later stage) or it will be overridden if Store Restore point Post function is called again. This is not a recommended configuration. Please check the Use cases and Examples sections. 

  • As soon as you decide that it is time return to the main flow of the issue click on RESUME to move back.



  • The issue will be resumed to the status when the same was paused, in our example IN PROGRESS and all other buttons of the main workflow will be available again.



NB! There are a few special cases when the issue will stop on RESUME status. This is not a malfunction but rather logical situation where resume is not possible (more information below). Teleport will still provide you enough tools in order to solve even those abnormal situations.

Case 1: The issue will as designed stop on RESUME status when there are no records about the previous restore point /the status prior to HOLD /. That can occur under the following situations:

- when the status prior to Hold has been replaced while the issue is put on HOLD ;

- when the status prior to Hold has been deleted while the issue is put on HOLD ;

- when an issue has been imported to on HOLD directly or on another status, part of the Hold-Resume sub-flow;

- when the issue has been moved (using the standard Jira Issue Move functionality) to another issue type or different workflow while being put on HOLD or on another status, part of the Hold-Resume sub-flow;



Important

In such situations when the restore transition could not be fulfilled because of a special situation as described above the status remain in Resume and the system will display "Ooops error message" on the view issue screen as shown on the screen shot below. Only Users who has been granted access to Teleport functionality will be able to recover the issue to a valid status unconditionally. All other Users will have to contact the Administrator.

In case you do not want to transition to another status temporally and you do not wish to display the "Ooops error message" you can clear/hide the error message by selecting Teleport clear error button from the command bar as shown on the screenshot bellow. This button will be visible only for the users with Teleport permissions for the particular project.

Issue Command barMoreTeleport clear errors


Case 2:  The issue as designed will not be able to enter in Hold-Resume sub-flow. That can occur under the following situations:

- In case you create a link/transition between the Hold-Resume sub-flow and the main workflow. In such case you can exit the sub-flow without calling the relevant Sofmobile resume post function. This will incorrectly led Teleport to think that the issue is still on Hold while in reality the issue is already back to main workflow without "letting the Teleport know". in this case natively the Teleport will prevent entering the a second Hold-Resume sub-flow. In order to recover this specific case you should call Teleport clear error button from the command bar as shown on the screenshot bellow. This button will be visible only for the users with Teleport permissions for the particular project.

Issue Command barMoreTeleport clear c rrors



Important

Usually Hold-Resume sub-flow is nicely isolated and not connected to the main flow in any way. Such "transition" will be handled by the plugin itself by "Resume". However, should you still need to create such transition between the Hold-Resume sub-flow and the main workflow then make sure you properly configure and ideally call this transition only in special use cases with special user privileges if it is configured so. The created earlier restore point will either become orphan (and will be cleaned on later stage) or it will be overridden if Store Restore point Post function is called again.

Please, note that creating such a transition is not a Good practice!



  • No labels