A new documentation is available for Squash TM 2.0 and later versions, check it here
A synchronization is the working unit of the Xsquash4Jira plug-in. It represents the set of JIRA issues defined by a dynamic perimeter which will be synchronised in Squash TM.
For example: all the issues of a given board, all the issues selected by a filter…
The notion of perimeter is key to understand the functioning of the plug-in. This perimeter represents the set of tickets synchronized from JIRA into Squash TM for a given synchronization. This perimeter is dynamic and is recalculated for each update.
The perimeter depends on the following values: the type of synchronization and the value of the selection. For the selection by "board", the field "additional JQL" and the option "Restrain to active sprint" enables you to fine-tune the perimeter.
To create a synchronization, you need to click the button [+] in the upper right corner of the Synchronizations block. A pop-up window opens up for you to create the synchronization.
Meaning of the fields :
Then, depending on the value chosen for "Selection by", different fields will be shown :
The following fields appear :
Only one field appears :
Only one field appears :
Once the synchronization was configured, an additional line appears in the synchronizations block.
For each update, all the requirements within the perimeter will be created or updated. If an error occurs during an update, no editing is made in Squash TM.
The status of every synchronization is shown on each line.
The periodical updates only update the synchronized requirements which were modified in JIRA since the last known successful update.
In the case where, for example the equivalence for field, or the correspondence of value in a list, has changed, it is necessary to re-synchronize all the requirements in Squash TM, even if nothing changed in JIRA.
The button [↓] allows to force the update of all the issues which are in the perimeter of the current synchronization.
A switch button allows to interrupt or reactivate a synchronization. Requirements will no longer be updated as they were modified in JIRA as well as the reporting fields. The synchronization can be reactived at any time and requirements be updated normally.
The button at the end of each line enables the deletion of a synchronization. In accordance with the policy of no deletion, the synchronized requirements will not be deleted, but not transformed into native requirements of Squash TM. They will no longer be updated as they were modified in JIRA, and will behave just like any other Squash TM requirement.
The same applies for all synchronized directories (target directories and sprints).
If the user wishes to delete these requirements and directories, they will need to do it per hand from the Requirement Workspace.