Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Create a MS Teams template

Tip

MS teams template is currently available only for the ARNR Cloud app.

Navigate to the Templates tab >> click on Create button.

Template create.png

Select the MS Teams template

MS teams 4.png

This launches the the template builder/editor page where you can customize the template.

MS Teams template fields

Expand
titleMS Teams template fields
  • Template type

    • Here, MS Teams option is selected since we are creating an MS Teams type of template

  • Template name

    • This is for internal reference & doesn’t show up in the actual release notes in MS Teams.

  • Level

    • Local or Global - Determines whether the MS Teams template is available to be used in other projects across Jira.

    • Cross-project - For cross-project templates (which can be managed only from the cross-project ARNR screen), this field is disabled from editing & is set to cross-project by default.

  • ARNR branding - To define whether you wish to show ARNR branding in release notes.

    • For Free ARNR app it is default and cannot be unchecked

Customise the MS Teams template

MS Teams uses adaptive card blocks to build messages with text, images, buttons, and more. We have provided the same structure here. You can customize the order and appearance of each block, including elements within them. Below are some blocks that are supported to design MS Teams template in ARNR.

Tip

Reach out to our Service desk if you want us to add support for any specific block in the MS Teams template.

Ms teams template builder allows you to customize the template using different blocks like Header, Texbox, and JQL. You can use variables and custom variables in these blocks to fetch different data points from Jira issues. Let us see more details about these blocks -

Header

Expand
titleHeader
  • Add image - You can add a thumbnail image in the header of the release notes message

  • Image URL - Paste the URL of the image

  • Header text - Add the header text, this is typically the project name, heading of the announcement, etc.

  • Description - Description of the header

In the Header and Description text, you can use ARNR’s variables and custom variables.

Header.png

Textbox

Expand
titleTextbox

In the block, users can insert plain text along with ARN variables and custom variables.

text.png

JQL Section

Expand
titleJQL section
Insert excerpt
JQL section in different ARNR templates
JQL section in different ARNR templates
nameMS Teams JQL section

Variables

Expand
titleVariables

Insert excerpt
Customizing release notes content
Customizing release notes content
nameVariables
nopaneltrue

Custom variables

Expand
titleCustom variables

Insert excerpt
Customizing release notes content
Customizing release notes content
nameCustom variables
nopaneltrue

Preview MS Teams template

Once done with all the editing, you can preview the template to make sure everything is in place and Release notes are accuratly created before sending them to the end user.

MS teams 5.png

Clicking on Preview, brings you to the preview page. Choose inputs based on variables, custom variables used JQL/s or template body & click Preview. This will generate the template preview.

MS teams 10.png

Click on Copy to Clipboard and paste the code into  MS teams adaptive card builder to see the exact preview of your template in MS Teams.

In MS teams adaptive card builder click on +CARD PAYLOAD EDITOR at the bottom of the screen and paste the code copied from preview screen.

Verify the release note content and make necessary changes if needed. Once the template is all set it's time to set Rules and Actions. Rules are the same as it is for any other template. In case of the action read https://amoeboids.atlassian.net/wiki/spaces/ARN/pages/edit-v2/304807972#Send-to-MS-teams for more details.

In below image -

  • 1 - Containt coming Header block

  • 2 - Content coming from Text box block

  • 3 - Content fetched based on JQL section’s configurations with a tabular layout.

preview.png

Limitations

Since we have recently added the MS Teams integration, there are some limitations in the feature. We will gradullay work on these limitations and provide the best experience to our users. This list will be updated as we eliminate these limitation one by one -

  • 'Display as link' feature for issue key has not yet been added.

  • Attachments like PDF, Images, etc are not yet supported.

  • In the Logs tab, the view MS Teams message is not yet available

  • Wiki renderer styling for the text is not yet available.

On this page

Table of Contents
maxLevel6
minLevel2
outlinefalse
stylesquare
typelist
printablefalse

Iframe
scrollingauto
srchttps://form.typeform.com/to/loItQqk5#url=xxx
width350
frameborderhide
alignmiddle
height250

Request support👨‍💻

Leave us a review(green star)