How does the "Automatically restart workflow when source files are updated" feature work in XTM Cloud?
- 1 Introduction
- 2 How does the feature work?
- 3 Project Template – start the project automatically
- 3.1 General information
- 3.2 Automatically start the project and Automatically restart workflow when source files are updated – BOTH ENABLED
- 3.3 Automatically start the project and Automatically restart workflow when source files are updated – BOTH DISABLED
- 3.4 Automatically start the project ENABLED and Automatically restart workflow when source files are updated DISABLED
- 3.5 Automatically start the project DISABLED and Automatically restart workflow when source files are updated ENABLED
Introduction
By default, XTM Cloud restarts the whole workflow for a particular project’s job and sets it to “Not started” whenever the job’s source file is updated within the framework of a continuous project (to learn more about continuous projects, read this article: A continuous project and its outcome).
For this reason, you might sometimes mistakenly interpret what the Automatically restart workflow when source files are updated feature actually does. [Configuration → Settings → Workflow → Workflow options (administrative privileges required!)].
Whenever a source file is updated, this feature, if enabled, not only causes the job’s workflow to restart but also sets it to “Started”, in contrast to the default XTM Cloud behavior.
How does the feature work?
General information
Depending on whether the feature is enabled or not, the workflow restart after each source file update will behave differently.
Consider the following scenarios.
Feature DISABLED, continuous project update WITHOUT REANALYSIS
The workflow will be restarted without being activated automatically in the first step.
Feature DISABLED, continuous project update WITH REANALYSIS
The workflow will be restarted without being activated automatically in the first step.
The workflow will be restarted without being activated automatically in the first step.
Feature ENABLED, continuous project update WITHOUT REANALYSIS
The workflow will be restarted and will be activated automatically in the first step.
Feature ENABLED, continuous project update WITH REANALYSIS
The workflow will be restarted without being activated automatically in the first step.
Project Template – start the project automatically
General information
The Automatically restart workflow when source files are updated option can also be used simultaneously with this project template option: Automatically start the project. (For more information, see How to Set Up a Project to Start and Finish Automatically | Project template).
Depending on whether both features are enabled or not (or one is enabled and another is not), the restarting of the workflow after each source file update will behave differently. Consider the following scenarios:
Automatically start the project and Automatically restart workflow when source files are updated – BOTH ENABLED
Initial project analysis → workflow is restarted and activated,
Continuous project update → workflow is restarted and activated,
Continuous project update with reanalysis → workflow is restarted and activated.
Automatically start the project and Automatically restart workflow when source files are updated – BOTH DISABLED
Initial project analysis → workflow is started but not activated,
Continuous project update → workflow is restarted but not activated,
Continuous project update with reanalysis → workflow is restarted but not activated.
Automatically start the project ENABLED and Automatically restart workflow when source files are updated DISABLED
Initial project analysis → workflow is started and activated,
Continuous project update → workflow is restarted but not activated,
Continuous project update with reanalysis → workflow is restarted and activated.
Automatically start the project DISABLED and Automatically restart workflow when source files are updated ENABLED
Initial project analysis → workflow is started but not activated,
Continuous project update → workflow is restarted and activated if it was started earlier,
Continuous project update with reanalysis → workflow is restarted but not activated.