Local Synchronization Use Case
Note: Despite our best efforts, code can change without notice due to a variety of factors. If you encounter an issue in any of the code shown here and find that a specific block of code is not correct, or is causing errors, please check with the Community to find an updated version.
You can use local synchronization when you have two projects in one Jira. Let's take a look at the case when you have the following projects: DEVELOPER and TESTER.
There are two different scenarios:
- you create a task for the developer and send a task to the tester;
- you found a bug, create the failed test and after that send the task to the developer to fix it.
Let's take a look at the example for the first scenario.
- Create the task for the developer by clicking the Create button.
- When the developer starts working on a task, he will see the status 'IMPLEMENT'.
- After finishing the work, the developer sends it to the tester, and the developer's task changes to the 'IN TESTING' status. By the way, Exalate creates a test on the TESTER side with the status 'TO DO'.
- The tester starts working and his status becomes 'TESTING'.
- Then, the tester can move the task to 'OK' or 'FAILURE' depending on the test result. If he found a bug, he moves to 'FAILURE', and Exalate changed the developer's status to 'TO DO' again. After that, all the transitions repeat until the work is done. If the test is passed, the transition 'OK' leads to the status 'OK' and Exalate does its work to inform the developer that everything is finished by making the developer's status 'DONE'. The vice versa is very similar.
How does it work?
You need to create two projects in your Jira: DEVELOPER and TESTER.
To set up synchronization for the use case above you will need to configure your Jira instance and the Exalate application.
Workflows
Now you can start to create Workflows.
Add the DEVELOPER workflow for the DEVELOPER project and the TESTER workflow for TESTER. After that, create the statuses and transitions which you need.
In Jira click the status or transition to edit it.
Don't forget to add these workflows to your project and publish it every time you make changes.
Automatic Synchronization
In this step, if you try to create tasks, you will not have any synchronizations. First of all, when you click 'To testing', Exalate should create the test. To make it possible, you should add Triggers that will look like this:
It means that if you create a task on the developer's side when you send it on testing, your status is 'IN TESTING', Exalate starts its work and creates the test on another side.
The second trigger means that you created a test on the TESTER side. If the project is Tester and the status is Failure, then Exalate makes a task for the developer to fix bugs.
Hidden Transitions
If you look at the pictures above for a moment, you will see some transitions that the user should not see. As an example, the user cannot say that work is done, while his status is 'IN TESTING'. Only Exalate can do it.
So we should hide some transitions. To make it possible:
- Click the Done transition and add a condition on the right side.
- Select User Is In Group from the list and finds a group you need.
The same things you should do for transition 'Implement' in the DEVELOPER workflow and transition 'To Do' in the TESTER workflow in this case.
Local Connection
The last step for setting up Exalate is to add an Exalate Connection. You need to name it and choose the remote issue that you created, for example, DEV-TEST.
The Outgoing sync(Data Filter) should contain scripts to compose a message with data you want to send to the other side.
replica.key = issue.key replica.assignee = issue.assignee replica.reporter = issue.reporter replica.summary = issue.summary replica.description = issue.description replica.comments = issue.comments replica.resolution = issue.resolution replica.status = issue.status replica.attachments = issue.attachments replica.workLogs = issue.workLogs replica.project = issue.project replica.type = issue.type
The Incoming sync for new issues(Create Processor) will handle a message from the reporting node and create an issue on the second side the first time.
So Exalate would know that if the Task was created first, then it should be created a Test on the other side and vice versa.
if(replica.type.name == "Task") {
issue.projectKey = "TESTERS"
issue.typeName = "Test"
workflowHelper.transition(issue, "To Do")
}
else{
issue.projectKey = "DEVELOPERS"
issue.typeName = "Task"
}
issue.status = replica.status
issue.summary = replica.summary
issue.description = replica.description
issue.comments = commentHelper.mergeComments(issue, replica)
issue.attachments = attachmentHelper.mergeAttachments(issue, replica)
issue.workLogs = workLogHelper.mergeWorkLogs(issue, replica)The Incoming sync for existing issues(Change Processor can then process and update values. It contains something like:
if(replica.project.key == "TESTERS" && replica.status.name == "FAILURE"){
workflowHelper.transition(issue, "Implement")
}
if(replica.project.key == "DEVELOPERS" && replica.status.name == "IN TESTING"){
workflowHelper.transition(issue, "To Do")
}
if(replica.project.key == "TESTERS" && replica.status.name == "OK"){
workflowHelper.transition(issue, "Done")
}
issue.summary = replica.summary
issue.description = replica.description
issue.comments = commentHelper.mergeComments(issue, replica)
issue.attachments = attachmentHelper.mergeAttachments(issue, replica)
issue.workLogs = workLogHelper.mergeWorkLogs(issue, replica)