ScriptRunner listener: Load checklist template

Reno_pdzcjo

Hello,

I use this Checklists Plugin and I am setting up a listener as they describe here to update the checklist based on the value of another attribute.

The updateValue(CustomField, Issue, Collection<ChecklistItem>) method needs a collection of items to load, and in the proposed solution that collection is built within the script.

I have created templates in the custom field and I am wondering if it would be possible to load them directly instead of building the item collection.

Do any of you know how? Any other proposal?

Thank you in advance!

Maxime Lefebvre _Okapya_

Hi Reno,

We have not yet made the templates API public, so at the moment there is no documentation on how to use a template within scripts.

The current ways we have made templates useable in your processes are by:

- Using the template as "Default Local Items"

- Using the template in a workflow post function

---

This said, if your use-case is more specific and requires scripting, I can definitely help you with that! Just keep in mind that our APIs are not public so they can change in any update.

Importing a template essentially requires you to load the template, convert the template items into checklist items, and update the checklist with those items.

Here's a modified version of our documentation that does exactly that. The main difference with the default documentation is the `createItemsFromTemplate` function.

import com.onresolve.scriptrunner.runner.customisers.WithPlugin;
import com.atlassian.jira.component.ComponentAccessor;
import com.atlassian.jira.issue.MutableIssue;
@WithPlugin("com.okapya.jira.checklist")
import com.okapya.jira.customfields.*;

import java.util.stream.Collectors;
import com.okapya.jira.customfields.configuration.*;
import org.codehaus.jackson.type.TypeReference;

def Collection<ChecklistItem> createItemsFromTemplate(ChecklistCFType cfType, int templateId) {
    TemplatesManager templatesManager = cfType.templatesManager;
    Template template = templatesManager.getTemplate(templateId);
    return ChecklistItem.mapper.readValue(template.getItems().toJson(), new TypeReference<ArrayList<ChecklistItem>>() {});
}

// Retrieve the Custom Field Type for the Checklist Custom Field
def customFieldManager = ComponentAccessor.getCustomFieldManager();
def checklistCustomField = customFieldManager.getCustomFieldObject("customfield_10203");
def checklistCustomFieldType = (ChecklistCFType) checklistCustomField.getCustomFieldType();

// Create a new checklist
def Collection<ChecklistItem> newChecklistValue = createItemsFromTemplate(checklistCustomFieldType, 29);

// Update the issue with the new checklist
def issue = (MutableIssue) event.issue;
checklistCustomFieldType.updateValue(checklistCustomField, issue, newChecklistValue);

The sample script has hard-coded the ID of the template (29). In order to know the ID of the desired template in you system, I suggest you to edit the template in your browser with the developer console open (F12), and retrieve the ID from the network tab.

---

We will be looking in the future to add an friendlier API to use templates in scripts, and also to find the template's ID.

I hope this helps! Don't hesitate to ask if you have any additional questions.

Kind regards
Max