Page tree

Documentation for Structure version 5.0 and patch releases. Version Index

Skip to end of metadata
Go to start of metadata

To avoid unnecessary high resource consumption, Structure moderates generation time for every structure by limiting it to a fixed value. If a structure is not generated within the existing time limit, the generation process is paused and a structure is marked as timed out.

A timed out structure’s Generators stop working and all their content is removed, leaving only a structure’s skeleton visible. The notification banner will be shown to a user in that case:

If a timed out structure is addressed in the ‘structure()’ JQL function, the JQL search of that query will return an error message.

Resuming Automation

Automation is paused due to one or several Generators, that for some reason can’t add all of their requested content in time. To restore Automation, those Generators need to be deleted or edited. To find out which of Generators are working too slow, click More on the notification banner and additional info will be shown, displaying the overall percentage of time that each Generator took before Automation was paused. The highest number will indicate the slowest Generator.

After a Generator is deleted or edited, click Resume on the banner to resume Automation. If a structure still takes too long to generate, Automation will not be resumed and the notification banner will update the ‘More’ section with a relevant percentage. More actions from a user will be required, until all of the existing Generators will work within the time limit.

Deleting a Generator from a structure itself doesn’t resume Automation, only when the ‘Resume’ button is clicked. So you can perform multiple actions before that if needed.

When Automation is resumed, a structure will be updated with content and the banner’s message will be changed accordingly. You can close the banner after that.

If Automation is paused by a Generator that you consider being configured reasonably, you can increase the default time limit of 30 seconds and let a structure generate for a longer time period.

Changing Allowed Generation Time for a Structure

The setting for the Automation time limit is located at Structure | Manage Structures| Configure. If Automation is paused in a structure, you will also notice that the ‘Paused automation’ indicator is shown for that structure. 

It is also possible to search for structures with paused Automation by selecting the ‘Paused’ filter on the left.

After a new time limit is set, click Update to apply it.

A few things to keep in mind:

  • A generation time limit can’t be less than 5 seconds and more than a system-wide hard limit;
  • Although the value is entered in seconds, it can be of several minutes;
  • ‘Control’ structure permission is required to change the time limit.

Changing Default Generation Time Limit

To change default structure generation time for all structures, go to Administration | Structure | Defaults and click Change in the Structure Automation Defaults section.

Only Jira administrators can change that setting.

If the time limit was manually set for a specific structure, it will not be changed to a default one. Only existing structures with default time limit settings will be affected.

System-Wide Hard Limit

The system-wide generation time limit is initially set for 10 minutes. It can be adjusted by using Script Runner or other similar tools or by changing the structure.gfs.generationTimeHardLimit system property, which accepts integer number of seconds. 

The generation time limit in a structure is only taken into account if it is less than the system-wide hard limit, otherwise it is ignored and the system-wide hard limit is used instead.