Smart Checklist and Rule Automation

[CJ Messick]

Greetings All,

I recently discovered Smart Checklists for our Issues in JSM.  So I created one and found I can save it as a Template and then import it to any issue at will.  Then I wondered if it was possible to have the Checklists imported to the issue via a Rule Automation.  Yes, I know the Manage Templates screen (where I found my checklist has an ID of 78) shows a level of Automation wherein I can have the checklist show up by default for ALL of the Issues...but I don't want that.  The checklist should appear in the issue only if the issue meets certain criteria.

So I tried it.

When the Issue is Created...

If the Reporter is me...

If ... and I have a Match Condition

Then ... I edit one field to change the value

AND ... Set Entity Property

....wherein the Key Property is com.railsware.SmartChecklist.checklist

and the Property Value is 

{{project.properties."com.railsware.SmartChecklist.templateId.78"}}

I found the how to for the checklist via this Forum which pointed me to 

Add a Checklist Template on Issue Transition - Smart Checklist Cloud - Confluence

...and yes, I know it says Confluence.

The rule runs successfully.  It does everything it's supposed to except the very last part even though the Audit Log reports success.  The checklist is not showing up.

Any ideas?

[Olena Brazhko_TitanApps_ · Accepted solution]

Hi @CJ Messick 

Thank you for reporting! The Confluence link you shared has the correct steps to follow. But it is strange that the checklist does not show up in the end. 

Could you please share the JSON file of the Automation rule you have set up? This way we can check it on our side.

Also, if you feel it will be more convenient, feel free to reach out to our Support team directly via support@titanapps.io.

Best regards,

[CJ Messick]

How exactly do I even find the JSON for the Automation Rule?  My rights as a Project Admin are fairly limited and I don't have access to the server at all.

[CJ Messick]

Ah.....perhaps you meant to export it?

[Olena Brazhko_TitanApps_]

@CJ Messick yes, I meant to export the JSON file for us to be able to check your rule configuration on our side.

Thank!

[Matheus Souza Alves_TitanApps_]

Hi @CJ Messick ,

In addition to the JSON file containing the automation, could you please confirm if you are working on the DC or Cloud version?

Thanks!

[CJ Messick]

Well....if I click on the help and check the various options all I get is Data Center pages.  So Jira Software Data Center 9.17, JSM Data Center 5.17 is what I see.  But I'm also told it's hosted in our "cloud" hence my confusion.  :-)

[CJ Messick]

According to this post :

Mikael Sandberg     Community Leader    February 6, 2020

The easiest way to see if you are on Jira Cloud or Server is to look at the menu, if the main menu for Jira is on the left side with you avatar at the bottom you are on Jira Cloud. If the menus are at the top with your avatar on the right then you are on Jira Server.

My menus are at the top w/ avatar on the right...so not cloud.

[Matheus Souza Alves_TitanApps_]

Hi @CJ Messick

Thanks for clarifying that! Could you please give our DC guide a try and let us know how it works for you?

We would also appreciate if you could kindly share the json of your automation so we can review it further.

Thanks!

[CJ Messick]

I did find the steps for this via DC as well.  ScriptRunner and the JMWE are not available to me.  The webhook option has me asking security questions.  Then I jumped up to the "Automation for Jira" and the part on "Setting the Checklist on Issue Creation" seems to fit the bill.  But step 7(d) makes no sense regarding the Property Value.

[Matheus Souza Alves_TitanApps_]

Hi @CJ Messick ,

Could you please kindly clarify what do you mean by " makes no sense regarding the Property Value"?

Additionally, I'd like to understand what are you security questions about the webhook option so hopefully we can sort that out.

Thanks.

[CJ Messick]

Step 7(c) says to set the Property Key = com.railsware.SmartChecklist.checklist

Step 7(d) says "Add checklist template in Markdown formatting as the property value" ... and that's where it lost me.

#Bug verification checklist
- add steps to reproduce
- indicate reporter
- assign issue

Where in this example is the Checklist NAME? Where is the Checklist ID?

It looks like the first line is a comment showing this is a checklist.  Then the next 3 lines are the items in the checklist.  Why would I do that?  I already have a checklist, it's ID is 78, it has two items in it...this should be easy.  I suspect this creates a new checklist for every issue.  It may have the same "name" as it were...but will it have the same Checklist ID?  Would it even have an ID?  Will it show up in my Checklist Templates?  Might I end up with hundreds of Checklists in my Manage Templates list all w/ the same name but different IDs?

Whereas the "cloud" one was very direct....just give it the ID.

As for the webhook option, this relies on MY personal access token and if/when I leave and my account gets whacked...that token should invalidate and the whole thing breaks.  If it doesn't then, by rule, it would mean there is now an unauthorized Personal Access token being used to auto authenticate to a secured site based on an invalid account.

[Matheus Souza Alves_TitanApps_]

Hi @CJ Messick,

Thank you for sharing these additional insights!

We understand your points and agree that there are indeed differences between DC and cloud. We've also recorded your feedback for the Product team to review and consider.

Currently, the options available for importing a template are through Webhooks or by creating new checklists using the entity property.

Please let us know if there’s anything else we can assist you with!

Best regards,

[CJ Messick]

TY...after all the angst the client has decided this is "spinning rims" and not required.

[Tessa Tuteleers]

Hey @CJ Messick , 

I checked the documentation and if you follow their instructions, it does seem to work without an issue. 

What you can check is: Is the checklist in the correct scope (Global or that specific project)?

Please add screenshots of your work so we can check the configuration. 
- Tessa

[CJ Messick]

The template is clearly a Project Template.

[CJ Messick]

And the log shows :

Action details:

User condition

The following issues passed:

TICKETS-7091

If block

The following issues passed:

TICKETS-7091

Edit issue

Issues edited successfully

TICKETS-7091

Set entity property

Successfully set entity property.

[CJ Messick]

Might it be possible this is a rights issue?  If I go to Project Settings->Permissions there are multiple references to Smart Checklists and the Granted To column is blank.  Should that be the case, then I would have expected the checklist to not work at all let alone the "railsware" call to set the property.