Keyword Synching

Owned by Jonathan Muse
Last updated: Nov 19, 2024
3 min read

 

Initial Synchronization

 

When you first decide to use the JQL feature, you must trigger an initial synchronization. First, you need to decide what you need to index, projects / project categories or global. It’s recommended to index only what you need, so you may want to add projects/project categories for that:

image-20240312-093258.png

And then press the “Save & Synchronize” button.
If you need to synchronize the entire Jira, you should make sure that you don't have any project/project category added, then press the “Synchronize” button.

After you press it, the progress bar under the “Synchronize” button you’ll let you know the percentage of completion of the synchronization and the number of process issues from the total number of issues to be indexed.

 

image-20240312-093840.png

Depending on the number of issues and the complexity of your search scripts, this may take a while.

 

Automatic Synchronization

Since a JQL keyword is meta-data for an issue that has been evaluated and saved prior to a JQL search, there must be a way to keep those keywords up-to-date with the data contained in the issues. This is done automatically using system event listeners if the auto-synchronization is turned on . The keywords get updated when events are triggered for an issue, including here:

  • Issue created event

  • Issue updated event

  • Issue deleted event

  • Issue link created event

  • Issue link deleted event

  • Issue commented event

  • Issue comment updated event

  • Issue comment deleted event

For example, the issue link keywords will be updated when a issue link created/updated event is triggered. We try our best to keep the keywords up-to-date however keep in mind that Jira and Power scripts are 2 separate products with a whole network in between.

Manual Synchronization

 

Keywords may become unsynchronized and not reflecting reality if:

  • Network failure occurred between Jira and Power Scripts

  • Power Scripts was doing maintenance tasks (booting, reconfiguring , installing a new version, etc) when events were triggered by Jira, and therefore those events are lost

  • Jira was unavailable to publish the results of the keyword calculation, for any given reason, and therefore the updates Power Scripts is pushing are lost as well

It is therefore recommended to run a manual triggered synchronization (using the “Synchronize” button) from time to time, in order to avoid yielding incorrect results for your users. The update will not block users from doing their work, and Jira may continue operating normally. Updates are processed as they come on on Power Scripts side.

Peacock