Templates and prepopulation

Templates

JEditor Templates is a feature that lets you control the structure of the document and preserve consistency across multiple documents (such as tasks, bugs etc). Templates are pre-defined, ready-made document forms with layout, text formatting and styling as well as other elements.

To use one of the templates created in JEditor Configuration > Templates, press the Template button on the toolbar. The dialog lists templates that are available for the current project.

The standard installation of JEditor contains four basic templates visible from any project. However, this list may be expanded/configured as needed. Since creating and adding new templates is available in JEditor Configuration, please contact your system administrator if you need to add or edit a template.

The Templates dialog window contains only one configuration option: Replace actual contents. Leaving it checked means that the inserted template would also replace the content entered previously into the JEditor window, deleting it in the process. This is a potentially destructive operation, so if you unintentionally remove the text using this option, you can revert this action by pressing the Back button on the toolbar or the Ctrl+Z shortcut on your keyboard. If you leave the Replace actual contents option unchecked, the template will be inserted in the current position of the cursor in the document.

The order in which the templates appear in the Templates dialog can be configured in JEditor Configuration > Templates. Drag and drop templates in the list to change their order.

Prepopulation

It's possible to prepopulate any JEditor-enabled field with a template.

To prepopulate a JEditor-enabled field on the create issue screen with a template do the following:

  1. Go to JEditor Configuration > Prepopulation
  2. Select Project Name / Category, Issue Type, Field Name and Template Name for your new prepopulation scheme
  3. Click Save

Prepopulation on edit/workflow screens

It's possible to force JEditor to prepopulate fields on screens other than the Create Screen:

  1. Go to JEditor Configuration > Settings
  2. Under Miscellaneous locate the Prepopulate screens parameter
  3. Change it to All screens
  4. Save

Prepopulation of fields not visible on the Create Issue screen

By default, JEditor will prepopulate all fields visible on the Create Issue screen (if according prepopulation schemes are configured). Sometimes it's required to prepopulate fields that are not shown to a user on the Create Issue screen. It's also needed when issues are created via Jira API. In this case you need to enable the server-side prepopulation:

  1. Go to JEditor Configuration > Settings
  2. Under Miscellaneous enable the Prepopulate blank fields parameter
  3. Save

Note that users will not be able to override the template with empty value. If a user removes the template from a field leaving it blank JEditor will populate it again using the configured template (this time on the server-side).

Checkboxes

JEditor will automatically generate random ids for any input elements that have the jeditorControl class.

When using server-side prepopulation it's required to use a reserved word: _je_rand_id_

For example:

<input class="jeditorControl" id="_je_rand_id_" name="test" type="checkbox" value="test" />

Comment field

It's not possible to prepopulate the Comment field on any Jira screen.

Settings cache

Sometimes you can notice that new templates and prepopulation schemes don't appear instantly on the client-side. This can happen because JEditor caches settings to lower the load on Jira's DB.

Usually it takes 1-10 minutes for JEditor to propagate new settings, however it depends on the server load and may take longer.

If you want JEditor to update the settings instantly do the following:

  1. Go to Jira administration > Add-ons > Manage add-ons
  2. Locate JEditor and expand its list of modules
  3. Enable the JEditor Settings Cache (strict mode) module
  4. Return to a Jira page and refresh it 

 

Have more questions? Submit a request

0 Comments

Article is closed for comments.
Powered by Zendesk