--- version: "v7.0" variant: "Data Center" language: "en" --- # Tag Cloud for Confluence Documentation ![pluginBanner-20230531-014605.png](https://documentation.appsbytng.com/__attachments/a_a53a7665ea897bc6de546f099b44e7e5f8e727743d671b834a1bff7966dae2a3/pluginBanner-20230531-014605.png?cb=b955ce342191af6ba69a730d548f0d7e) ## Why Tag Cloud for Confluence? Tag Cloud for Confluence is a great tool to create an interactive word cloud that helps to visualise tags in your Confluence space. Customise Tag Cloud to focus on your context and then let your creativity take over with hundreds of possible configurations! *** ** * ** *** ## Explore our Documentation Space * [Using the Tag Cloud Macro](https://documentation.appsbytng.com/tag-cloud-for-confluence/v7.0/Data-Center/using-the-tag-cloud-macro.md) * [Insert a Tag Cloud Macro](https://documentation.appsbytng.com/tag-cloud-for-confluence/v7.0/Data-Center/insert-the-tag-cloud-macro.md) * [Tag Cloud Configuration](https://documentation.appsbytng.com/tag-cloud-for-confluence/v7.0/Data-Center/tag-cloud-configuration.md) *** ** * ** *** ## Need more help? You can submit a request via our [Service Desk](https://tngtech.atlassian.net/servicedesk/customer/portals). --- version: "v7.0" variant: "Data Center" language: "en" --- # Insert a Tag Cloud Macro When editing a page, simply insert a macro, choose **Other macros**... ![Screenshot from 2024-04-08 16-29-05.png](https://documentation.appsbytng.com/__attachments/a_0af8aaae02a1472f9898110f104a65787e349bd15013ae6a8aa8142658d0c843/Screenshot%20from%202024-04-08%2016-29-05.png?cb=979b9ef00cb8176e5f44f8ee93c6ed8b) ... look for the **Tag Cloud** macro ... ![Screenshot from 2024-04-08 16-29-1.png](https://documentation.appsbytng.com/__attachments/a_aa29691674d322a212f9e8cb64bb1b11061805f9f7373012c62dad5de743ca58/Screenshot%20from%202024-04-08%2016-29-1.png?cb=80578268e41dd639cb1308fa2a00aae2) ... and before **inserting** it, [customize the macro settings](https://documentation.appsbytng.com/tag-cloud-for-confluence/v7.0/Data-Center/tag-cloud-configuration-filter-parameters.md). ![Screenshot from 2024-04-08 16-29-49.png](https://documentation.appsbytng.com/__attachments/a_a15c47ef3ee5adce42e301566c6ad867b9faebe561ffb578f7adbb41109f7859/Screenshot%20from%202024-04-08%2016-29-49.png?cb=662762ce22d6cd452a4dfb9c6f0eb9c9) --- version: "v7.0" variant: "Data Center" language: "en" --- # Tag Cloud Configuration * [Tag Cloud Configuration - Filter Parameters](https://documentation.appsbytng.com/tag-cloud-for-confluence/v7.0/Data-Center/tag-cloud-configuration-filter-parameters.md) * [Tag Cloud Configuration - Visualization Parameters](https://documentation.appsbytng.com/tag-cloud-for-confluence/v7.0/Data-Center/tag-cloud-configuration-visualization-parameters.md) * [Tag Cloud Configuration - Other parameters](https://documentation.appsbytng.com/tag-cloud-for-confluence/v7.0/Data-Center/tag-cloud-configuration-other-parameters.md) --- version: "v7.0" variant: "Data Center" language: "en" --- # Tag Cloud Configuration - Filter Parameters All parameters are optional and can be used in (almost) any combination. | Filter Parameters (storage name) | Default | Description | |-------------------------------------------------|---------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **Space(s)** (space/spaces) | @self | Choose spaces to be regarded. For multiple spaces, use comma as a separator. Allowed values: @self, @all, space keys Example: *foo,bar* | | **Include these Content Types only** (types) | *all* | Filter on content types (Page or BlogPost). Separate each type with a comma or single space. Allowed values: page, blogpost. If not specified, all content types are included. | | **Time period** (daysBack) | *no limitation* | Allow for activity tag clouds, reflecting only tags for content that has been touched within the last *daysBack* days counting from today (based on *LastModDate*). Allowed values: integer, -1 for no limitation. Example: *365* **Either** daysBack **or** startDate/endDate parameter can be used; If both are set, daysBack is used. | | **Start date / End date** (startDate / endDate) | *none* | Allow for historical tag clouds, reflecting only tags for content that has been touched within the specified time frame (based on *LastModDate* ). If only startDate is set, the range from startDate until today is considered. If only endDate is set, the range from 1990 until endDate is considered. Allowed values: date in format yyyy-MM-dd. Example: *2012-01-01 \| 2012-30-06* (**Either** daysBack **or** startDate/endDate parameter can be used; if both are set, daysBack is used.) | | **Cotag(s)** (cotag) | *none* | Display related tags to the given tag(s) only (determined by tag co-occurrence). Co-tags are tags that are assigned to the same page. Example: > Page 1 has the tags A, B > Page 2 has the tags B, C > Using cotag = A, only tags A and B are shown in the tag cloud, because tag A is only assigned to Page 1. For cotag = B all three tags A, B, C would be shown in the tag cloud since tags A and C occur together with tag B. For multiple cotags, use comma as a separator. Example: *foo,bar* | | **Display cotag in cloud?** (displayCotag) | yes (only in combination with **cotag**parameter) | Specify whether the cotag(s) is/are shown in the cloud. Allowed values: true, false | | **User** (user) | *none* | Show tags for content that **username** has contributed (created or edited). Example: *admin* | | **Max. number of tags** (maxResults / max) | 30 | Maximum number of tags to be displayed. Allowed values: integer, -1 for no limitation. Example: *50* | | **Exclude prefix(es)** (excludePrefix) | *none* | Exclude tag(s) that start with the passed string(s). Allowed values: comma separated strings. Example: *web,inter* | | **Exclude postfix(es)** (excludePostfix) | *none* | Exclude tag(s) that end with the passed string(s). Allowed values: comma separated strings. Example: *web* | --- version: "v7.0" variant: "Data Center" language: "en" --- # Tag Cloud Configuration - Other parameters | Other Parameters (storage name) | Default | Description | |------------------------------------|---------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **CSV page** (csvPage) | (empty) | Page the CSV file is attached to. Leave blank to use the page where the Tagcloud macro is inserted. To be used in combination with parameter "CSV attachment". | | **CSV attachment** (csvAttachment) | (empty) | Attachment file name on the page defined in parameter "CSV page". This renders the words from a CSV file, e.g. for testing purposes or displaying a cloud of static words. If the "CSV attachment" parameter is used, **no labels from Confluence are extracted** and most filter parameters are ignored (except maxResults, excludePrefix and excludePostfix). Example: {tagcloud:**csvPage** =spaceKey:Page Title \| **csvAttachment**=test-data.csv} The CSV file must conform to the following format (frequency, tagname): **Example** 30,Confluence 22,Jira 8,Bitbucket | --- version: "v7.0" variant: "Data Center" language: "en" --- # Tag Cloud Configuration - Visualization Parameters | Visualization Parameters (storage name) | Default | Description | |------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **Truncate tags after # characters** (truncate) | *none* | Defines the number of characters after a word is truncated and appended "...". Hovering the mouse over the tag shows the full tag name in a tooltip. Allowed values: integer Example: *20* | | **Tag size scaling** (scale) | logarithmic | Scaling algorithms are used to determine the font size (rank class) of each tag, depending on its absolute frequency and the given frequency distribution. Different scaling algorithms try to account for various frequency distributions, e.g. equally distributed frequencies, long-tail distributed frequencies. * **linear**: Shows the most realistic rendering of the frequency distribution. Often leads to large gaps in rank classes (many low rank classes, few high rank classes) with common tag frequency distributions. * **quadratic**: Tries to accommodate for the rank classes gap by redistributing the tag frequencies on the rank classes. * **logarithmic**: Similar to quadratic, but compresses the frequencies even more. | | **Tag sorting** (sort) | name | Choose how the tags in the cloud are sorted: * by **name**: Tags are sorted in alphabetical order. * by **rank**: Tags are sorted by absolute occurrence in descending order, starting with the most frequent tag. * **circular**: The most frequent tag is displayed in the center of the cloud, while all other tags are arranged around this tag in descending order. | | **Format** (format) | *cloud* | Format for rendering the tag cloud. * **cloud**: Classic tag cloud rendering, tags are displayed as normal text. Content is loaded asynchronously via an AJAX call to minimize Page load time. * **cloudStatic:** Same layout / style as 'cloud', but content is retrieved and rendered synchronously (before the Page is returned to the browser). This was the default rendering in v2.0 and earlier. * **cumulusCanvas**: Animated 3D tag cloud, tags are placed on a rotating sphere. * **wordcloud**: Fancy 2D tag cloud rendering | | **Width** (width) | 100% for format 'cloud', 'cloudStatic', 'wordcloud' 400px for formats 'cumulusCanvas' | Width of the tag cloud area in pixel. Example: *300* | | **Height** (height) | *undefined* (depends on displayed tags) for format 'cloud', 'cloudStatic' 400px for format 'cumulusCanvas', 'wordcloud' | Height of the tag cloud area in pixel. Example: *300* | | **Minimum font size / Maximum font size** (fontMinSize / fontMaxSize) | 9px / 25px | Defines a minimum and maximum value for the font size, which is used to scale the tags. Example: *12 \| 30* | | **Default tag color / Second tag color / Mouseover color / Rotation-Speed** (cumulusTColor / cumulusHiColor / cumulusTSpeed) | #001E3D / #990000 / 100 | Only for format=cumulusCanvas: Colors and rotation speed of cumulus | | **Rotate ratio** (wordcloudRotateRatio) | 0.5 | Only for format=wordcloud: Probability for the tag to rotate. Allowed values: float in the rage from 0 to 1. Set to 0 for no rotation (i.e. all tags are oriented horizontally), set to 1 to always rotate. | | **Shape** (shape) | circle | Only for format=wordcloud: The shape of the "cloud" to draw. Choose from: * circle * cardioid (apple or heart shape curve) * diamond * pentagon * star * triangle-forward * triangle-upright For appealing results with shapes, please try out different settings for fontMaxSize, truncate, maxResults, wordcloudRotateRatio and width/height. Rendering is known to be unclean for large fonts and long words. Better results can be achieved using Mask Images (see below). | | **Mask image page** (maskImagePage) | (empty) | Only for format "wordcloud": Page the mask image is attached to. Leave blank to use the page where the Tag Cloud macro is inserted. To be used in combination with parameter "Mask image attachment". | | **Mask image attachment** (maskImageAttachment) | (empty) | Only for format "wordcloud": Attachment file name on the page defined in parameter "Mask image page". If set, the words are rendered within the mask image shape. For best results, use a unicolored image where the "shape" has a dark color and the "background" has a bright color or is transparent. Example: *paceKey:Page Title \| mask.png* | | **Mask image fill color** (maskImageFillColor) | (none / transparent) | Only for format=wordcloud: Format #RRGGBB. If set, the mask image is visible as background image. Leave blank to keep the mask image invisible. To be used in combination with parameter "Mask image attachment". | --- version: "v7.0" variant: "Data Center" language: "en" --- # Using the Tag Cloud Macro The Tag Cloud Plugin is a fully-fledged replacement for the built-in Confluence tag cloud ("Popular Labels") implementation. It can be used instead of the *listlabels-heatmap.action* and the *popular-labels* macro featuring several useful additions compared to the default functionality. Especially, permissions are considered: only tags of content the user has access to are displayed. The implementation is based on a Lucene index to obtain scalability even for large tag collections. ![2.png](https://documentation.appsbytng.com/__attachments/a_d194518ba376bf94da548e13707f07cca25da3ea92d4f56f148bada7eb677c7e/2.png?cb=e1e6b9e29e0ae026a8e04ae334b9d535) ## Features \& Scenarios ### New Tag Cloud menu items New **Tags** menu items are available in the **Space Sidebar** and in the **Global Navigation** (Confluence header). These actions exceed just static tag clouds: Users can set different filters and options to generate and visualise individual tag clouds. ![Screenshot from 2024-04-15 12-00-11.png](https://documentation.appsbytng.com/__attachments/a_ce792a8f9653fd8e5384a8c061a62434b40fbc32988f8cd8e68da4bbd220f1f1/Screenshot%20from%202024-04-15%2012-00-11.png?cb=27f7dd4aded37a4c194807b62521a10b) #### The Tag Cloud macro is useful in the following scenarios and configurations Using different filter options, you can build specific tag clouds, e.g. for the following use cases: * In **dashboards** and **space homepages**: Space-specific and cross-space tag clouds, i.e. show tag clouds of one or multiple selected space(s) * In **user profiles** and **personal spaces**: User-specific tag clouds i.e. show tag clouds based on user contributions * In **overview pages** and **portals**: Topic-specific tag clouds, i.e. only show related tags in a tag cloud based on tag co-occurrence * To visualise **trends** and **active content**: Time-specific tag clouds, i.e. show tag clouds limited to a certain time range (based on Page's LastModDate, e.g. to see only recent content) #### The visualisation can be customised Powerful layout options allow you to customise the tag cloud visualisation. For the Tag Cloud macro, this is done using parameters. The Tag Cloud action shows a subset of the most important options in its menu panel. Check the customization options [here](https://documentation.appsbytng.com/tag-cloud-for-confluence/v7.0/Data-Center/tag-cloud-configuration-visualization-parameters.md). * Choose between multiple sorting algorithms (alphabetical, rank, circular) for different scenarios and information needs * Adjust font sizes using several scaling algorithms, always allowing for well proportioned clouds (based on tag frequency) * Automatically truncate long tags to improve readability and layout * Exclude specified tags from the cloud using pre and post fixes * Animated 3D presentation in Flash or HTML5 * Fancy 2D presentation * You can configure the look \& feel using CSS styles (via a Theme Plugin or a style macro embedded in the page) ![Screenshot from 2024-04-15 12-20-24.png](https://documentation.appsbytng.com/__attachments/a_dfe80b3d0cc73fadbe5acc6a5f975cc291350f2f35a99d695240495cf195a37e/Screenshot%20from%202024-04-15%2012-20-24.png?cb=07dae62e54b72baf93503b20abe2a5ec) 3D ball ![Screenshot from 2024-04-15 12-20-43.png](https://documentation.appsbytng.com/__attachments/a_cb47011b31890a9457ba2c7b026799d34f496c3765e648e3ce33a8c837403ab5/Screenshot%20from%202024-04-15%2012-20-43.png?cb=8fd38f1f889e41742e2a4ce74f27daf5) Word Cloud --- version: "v2.6" variant: "Data Center" language: "en" --- # Configuration Cleaner for Jira Documentation ![pluginBanner-20230531-015043.png](https://documentation.appsbytng.com/__attachments/a_474265800e672b41a1ff11d70dcfaa1ca5120037f6d3c41b962b76c7dca27c35/pluginBanner-20230531-015043.png?cb=53309f683e8a23aba94c3f9eb0399a1e) ## Why Configuration Cleaner for Jira? The Configuration Cleaner for Jira is a tool designed to enhance the management of your Jira configuration by identifying and optimizing unused, duplicate, and similar configuration elements. ### Features * Customizable Analysis Report - It identifies elements that serve identical functions (Duplicates) or share similarities (Similars). Additionally, it highlights elements that are not utilized in any project (Unuseds) * Detailed Information - The report provides detailed information about each identified element, listed in the following columns, such as projects or workflows. ### Supported configurations * Screens * Screen Schemes * Issue Type Screen Schemes * Transitions * Workflows * Workflow Schemes * Field Configurations * Field Configuration Schemes * Issue Security Schemes * Issue Type Schemes * Notification Schemes * Permission Schemes * Priority Schemes *** ** * ** *** ## Explore our Documentation Space * [Start an analysis](https://documentation.appsbytng.com/configuration-cleaner-for-jira/v2.6/Data-Center/start-an-analysis.md) * [Duplication](https://documentation.appsbytng.com/configuration-cleaner-for-jira/v2.6/Data-Center/duplication.md) * [Similarity](https://documentation.appsbytng.com/configuration-cleaner-for-jira/v2.6/Data-Center/similarity.md) * [Unused](https://documentation.appsbytng.com/configuration-cleaner-for-jira/v2.6/Data-Center/unused.md) * [Error case](https://documentation.appsbytng.com/configuration-cleaner-for-jira/v2.6/Data-Center/error-case.md) ### Need more help? You can submit a request via our [Service Desk](https://tngtech.atlassian.net/servicedesk/customer/portals). --- version: "v2.6" variant: "Data Center" language: "en" --- # Duplication ## What does duplication mean in Configuration Cleaner for Jira? Duplicate elements are those that operate identically due to their functionality. Transitive dependencies to other sub-elements are also taken into account. This means that even if two elements are not exactly the same, but their dependencies and operations lead to identical outcomes, they will still be flagged as duplicates. The name of the element is not important for this, but the sequence of possible representations or operations is. ### Cleanup Duplicates Clicking the `Cleanup Duplicates` button allows you to automatically merge selected items from the duplicate group. 1. First, select all items you want to merge: ![cleanup_duplicates_1.png](https://documentation.appsbytng.com/__attachments/a_2ba14a4aefec2d0d16a73dc700ad62c66b78b4e22c0d534f7b966ce916d6a6f0/cleanup_duplicates_1.png?cb=4f9092d2929f94a4e4e8a80a6024f7db) 2. Next, select the item you want to merge into - the target item. This will be the configuration item that will replace the selected items. Please note that if you selected a Jira default item as part of your merge selection, it will have to be the merge target, as it cannot be deleted. ![cleanup_duplicates_2.png](https://documentation.appsbytng.com/__attachments/a_a3e70cb6b9df6e019d0d12c2156850025e9d100622a02a02aa62da64070ffee5/cleanup_duplicates_2.png?cb=40103cef829d92f674089a25eb5bc47d) 3. Finally, a confirmation screen will be displayed summarizing the actions you are about to perform by clicking `Confirm cleanup`. Double check the information provided to ensure it is correct, then sit back, relax, and let the Configuration Cleaner do it's thing! It will return to an updated analysis page once cleanup is complete. ![cleanup_duplicates_3.png](https://documentation.appsbytng.com/__attachments/a_75b7ecaa0cf2f4b0439f555c69a319ad984d7bb68c3b5256cb233ace7b0be93e/cleanup_duplicates_3.png?cb=00875ecc6ef0040cb542e03445e2741c) --- version: "v2.6" variant: "Data Center" language: "en" --- # Error case In case you encounter an error with the Configuration Cleaner for Jira app, please proceed with the following steps: 1. As a Jira administrator, navigate to General Configuration \> System \> Logging and Profiling. 2. Click the **"Configure logging level for another package"** button and insert the following information: 1. Package name: "com.tngtech.jira.apps.ccfj" 2. Logging level: "DEBUG" 3. Return to the Configuration Cleaner analysis page and perform the analysis one more time. 4. Check your atlassian-jira.log file for any error messages regarding the above stated package name. We are happy to assist if you need help with the plugin or encounter any problems. Please open a ticket at our [service desk](https://tngtech.atlassian.net/servicedesk/customer/portals). --- version: "v2.6" variant: "Data Center" language: "en" --- # Similarity ## What does similarity mean in Configuration Cleaner for Jira? The similarity is to be seen as a generalization of the duplication. Equally, it is compared on the basis of functionality, but the order of representation is not taken into account. This means that two items that are similar have the same sub-components, but in a different order. ### Cleanup Similars Currently, automatic cleanup support for similar items is not provided, as these must be judged on a case-by-case basis whether their intended use is identical to the items they are similar to. To manage similar items, simply navigate to the configuration items in question by clicking on the name in the analysis results page, and judge for yourself which action is needed. Should you wish the similar items to be treated as duplicates, simply rearrange the order of the sub-items so they match, and Configuration Cleaner will detect and treat them as duplicates. --- version: "v2.6" variant: "Data Center" language: "en" --- # Start an analysis 1. Navigate to **Manage Apps** \>**Configuration Cleaner** \>**Analysis**. ![Screenshot_1.png](https://documentation.appsbytng.com/__attachments/a_9df5316d242df4cb72d721cc144dd43705b87ab4233e8c283481476724b89c02/Screenshot_1.png?cb=4fbbadda9af6f4d29ef453fc57a266d7) 2. Select the desired configuration items from the drop-down menu and click the "Start analysis" button. 3. That's it! The analysis is performed and the results are displayed in a few moments. If the analysis takes longer because of the size of your instance, copy the link and just come back later. The corresponding `taskId` in the URL will be tied to your analysis, and even if you close down the Analysis page, the job will continue on the background and and the link will contain the results of your analysis ![analysis_result.png](https://documentation.appsbytng.com/__attachments/a_ec35e053fbb90de735953fc54b053bdebf414208b1009e1e6a9e52da137a11c8/analysis_result.png?cb=a707470460825db5105df46b512d34fb) 4. Congratulations πŸŽ‰ Your analysis was successful. Have fun cleaning up! --- version: "v2.6" variant: "Data Center" language: "en" --- # Unused ## What does unused mean in Configuration Cleaner for Jira? An element is considered unused if it is not used in any project. Corresponding elements are not listed further in a list of possible duplicates. If a configuration element is only used in another configuration element that is unused, then both elements will be considered as an unused configuration element. These type of unused element are separated into their own section with the label `Only in Unused ${Parent_Configuration_Item_Type}`. ![Screenshot from 2024-04-11 16-52-03.png](https://documentation.appsbytng.com/__attachments/a_e0fdf7e8823bb1174c5f9324234a1a95507629a3c8360ee707f2a93bb131c13a/Screenshot%20from%202024-04-11%2016-52-03.png?cb=2e23d81535eddeae27e3dc366289dbab) Field Configuration 1 and Field Configuration 2 are both unused elements ![Screenshot from 2024-04-11 16-51-44.png](https://documentation.appsbytng.com/__attachments/a_97d61eed5383fa4b05e5881c7a0c5edf64710331ebff15e0c998a5544daf1071/Screenshot%20from%202024-04-11%2016-51-44.png?cb=afa455d7147aaa7737eefeb833e1a8da) Field Configuration 2 is used in an unused field configuration scheme, whereas Field Configuration 1 is not used in any scheme ### Cleanup Unused Clicking the `Cleanup Unused` button will guide you through the automatic removal process of the unused configuration items. Should you have selected a category with dependencies to other unused items, these will also be deleted as part of this action. 1. First, select the items you wish to delete: ![cleanup_unused_1.png](https://documentation.appsbytng.com/__attachments/a_4e731acb10e5cbc2402428078f4c540f8b187c0082bc86ed2250a1fe5fa27abb/cleanup_unused_1.png?cb=299b3ac8cb4fd13377576c37f68265ea) 2. In the case of unused items with dependencies to other unused items, you will now see a new stage where all the affected parent items will be displayed, and you can click on their names to get more information. ![cleanup_unused_2.png](https://documentation.appsbytng.com/__attachments/a_48ff8b643c826a87f757808752e1910eb6494cba630b55d11b308c334c6c3784/cleanup_unused_2.png?cb=aa0eee0b66990fadcd9df2ffd7996dc2) 3. Finally, all items that are to be deleted will be displayed again for you to confirm. Once you've acknowledged the selection, just click the `Confirm cleanup` button, and let the Configuration Cleaner bulk delete the problem items. ![cleanup_unused_3.png](https://documentation.appsbytng.com/__attachments/a_ba06a4aa85fd356fc3d8258262e502cad15fb92c585de395d4bc432465910b79/cleanup_unused_3.png?cb=748f4757fddf37dbcde3ea9c7453079e) --- version: "v3.0" variant: "Data Center" language: "en" --- # Webfonts for Confluence Documentation ![pluginBanner-20230531-014605.png](https://documentation.appsbytng.com/__attachments/a_8e58a0a4c7d03eb68f1d35f2bd91251c6e5a7905643b4b84af0b18f3635953ab/pluginBanner-20230531-014605.png?cb=299dc942568f67d36de00d8f5272ef78) ## Why Webfonts for Confluence? Webfonts for Confluence allows you to import and use webfonts directly in your Confluence. Adjust the font of text displayed on your Confluence pages by working with the Webfonts macro. Please note that only color, size, and line height will be retained when exporting a page to PDF. *** ** * ** *** ## Explore our Documentation Space * [Using the Fonts Macro](https://documentation.appsbytng.com/webfonts-for-confluence/v3.0/Data-Center/using-the-fonts-macro.md) * [Fonts Macro Configuration](https://documentation.appsbytng.com/webfonts-for-confluence/v3.0/Data-Center/fonts-macro-configuration.md) * [Toggle Inline Mode](https://documentation.appsbytng.com/webfonts-for-confluence/v3.0/Data-Center/draft-toggle-inline-mode.md) ### Need more help? You can submit a request via our [Service Desk](https://tngtech.atlassian.net/servicedesk/customer/portals). --- version: "v3.0" variant: "Data Center" language: "en" --- # Add Shadow to the Text It is possible to add a shadowing to your text with the configuration option "**Shadow (optional)".** You need to pass a quadruple separated by empty spaces such as `5pt 6pt 7pt #808080`, where entries correspond to horizontal offset, vertical offset, blur radius, and shadow color, respectively. ![Screenshot from 2024-04-04 21-34-13.png](https://documentation.appsbytng.com/__attachments/a_e2afa599fa4b84b3ec1cf9c10c742f751714459f7b895367b835ed8159a5be86/Screenshot%20from%202024-04-04%2021-34-13.png?cb=dd95501ceeabd677364288ed0221676f) Passing the value `5pt 6pt 7pt #808080` sets the vertical offset to `5pt` horizontal offset to `6pt`, blur radius to `7pt`, and shadow color to `#808080`. --- version: "v3.0" variant: "Data Center" language: "en" --- # Adjust Font Size The font size of the text wrapped in a Fonts macro can be adjusted by providing a value in the "**Size (optional)"** textbox. You can pass any value that is allowed by the CSS property `font-size`, e.g. `40px`, `40pt`, `250%` or `2.5em`. ![Screenshot from 2024-04-04 21-17-53.png](https://documentation.appsbytng.com/__attachments/a_8955e6d90af002428a5592b367d524306e56c112b8b257a295890ae93f1f01b9/Screenshot%20from%202024-04-04%2021-17-53.png?cb=789f360fb6ed25c1419d7e10e15dfcac) --- version: "v3.0" variant: "Data Center" language: "en" --- # Adjust Line Height The height of the line that contains the Fonts macro can be adjusted by providing a value in the "**Line Height (optional)"** textbox. You can pass any value that is allowed by the CSS property `line-height`, e.g. `1.5`, `150%` `18pt` or `18px`. ![info](https://documentation.appsbytng.com/__attachments/a_09dda5056cd66013c976ec14745615fbdd5a79134fe4485436b0e23397e232ff/atlassian-info?cb=feab5cd71111204d6b52545f3027dd0c) The default line height is 1. ![Screenshot from 2024-04-04 21-20-53.png](https://documentation.appsbytng.com/__attachments/a_745860873de68a28b6ac9c471d1d495a44234b441ff4992151cde21de9a03304/Screenshot%20from%202024-04-04%2021-20-53.png?cb=0174c56daf38be4ee4b8a10bc45274fe) --- version: "v3.0" variant: "Data Center" language: "en" --- # Change the Font Color The Fonts macro allows for font color specification in two ways: either by selecting a font included with Webfonts for Confluence or by providing a special color as Hex value. ## Using Predefined Font Colors If you would like to use a predefined color, then you can choose a font from the "**Color"** drop-down in the Fonts macro configuration. ![Screenshot from 2024-04-04 16-07-25.png](https://documentation.appsbytng.com/__attachments/a_b1564d93de039215dbc10d0d73c78ec74f814658168f3d034501f41ec6d1c65c/Screenshot%20from%202024-04-04%2016-07-25.png?cb=d715f5e17f83cb143bf8fba7fc28f3f3) Selecting a predefined color Options: * *White* * *Silver* * *Yellow* * *Orange* * *Pink* * *Lime* * *Green* * *Teal* * *Aqua* * *Blue* * *Navy* * *Red* * *Purple* * *Fuchsia* * *Grey* * *Black* ### Specifying a Color via Hex Value If you would like to use a custom color, then you do so by specifying its Hex value in the "**Special color (optional)"**textbox in the Fonts macro configuration. ![Screenshot from 2024-04-04 16-12-41.png](https://documentation.appsbytng.com/__attachments/a_9e987be7b9fed753f9b7d6b35491e5f9ba93d384060077646a8a3ab5d2c7f769/Screenshot%20from%202024-04-04%2016-12-41.png?cb=964d0340df26c448d79ae045215b4f2f) Providing the Hex value of grey(#808080) If "**Special color(optional)"** parameter is set, the parameter "**Color**" will be ignored. --- version: "v3.0" variant: "Data Center" language: "en" --- # Change the Font Type The Fonts macro allows for font type specification in two ways: either by selecting a font included with Webfonts for Confluence or by providing a URL to a font file. ## Using Pre-defined Webfonts If you would like to use a predefined font, then you can choose a font from the **Webfont** drop-down in the Fonts macro configuration. ![Screenshot from 2024-04-04 15-30-01.png](https://documentation.appsbytng.com/__attachments/a_bf32c0d743a4da39d95255d7d132a46b7f76d12737e8fe2e376d0d57958b60c1/Screenshot%20from%202024-04-04%2015-30-01.png?cb=1651b6e76ff8cf39878208f58da76b77) Selecting a predefined font type. Options: * `AguafinaScript-Regular` * `AnticDidone-Regular` * `BilboSwashCaps-Regular` * `Cagliostro-Regular` * `Gudea-Regular` * `IMFeFCsc28P` * `JacquesFrancois-Regular` * `Limelight-Regular` * `Lustria-Regular` * `MeieScript-Regular` * `Monofett` * `Oranienbaum-Regular` * `Orienta-Regular` * `Parisienne-Regular` * `PetitFormalScript-Regular` * `Ranchers-Regular` * `Romanesco-Regular` * `Syncopate-Regular` * `Tangerine-Regular` * `Unna-Regular` ### Providing a Webfont via URL Alternatively, you can provide a link in the **"URL(optional)"** textbox to any font file accepted by HTML such as, but not limited to: `*.tff`, `*.otf`, `*.woff`,`*.woff2`. ![Screenshot from 2024-04-04 18-02-19.png](https://documentation.appsbytng.com/__attachments/a_d2feadfa82d8bdca48bea4277e1b8d442dfc152757962aa3b46b35a090504309/Screenshot%20from%202024-04-04%2018-02-19.png?cb=9718b071809a46eac06e8f5018032793) Providing a font type via URL If you provide a link to a font in **URL(optional)** , then the choice in the **Webfont** drop-downwill be ignored. --- version: "v3.0" variant: "Data Center" language: "en" --- # Toggle Inline Mode Fonts macro allows for displaying the text content within its body both inline and in a new line. When a Fonts macro is created, it will be inlined by default. ![Screenshot from 2024-04-04 16-45-57.png](https://documentation.appsbytng.com/__attachments/a_ba3750febaefee99e047b8d5b265c208ec96431044ecb6b8c1b17e2407c1ca0a/Screenshot%20from%202024-04-04%2016-45-57.png?cb=b13e0e2d102be53509a27699acae640d) Adding a Fonts macro between the words "before" and "after". ![Screenshot from 2024-04-04 16-46-11.png](https://documentation.appsbytng.com/__attachments/a_b21b754a64ae60059e351bbc08dfac2c5af10f0d7baf3bcda353339934b3a46c/Screenshot%20from%202024-04-04%2016-46-11.png?cb=32e1a3be23b2833b48005975741fa337) The Fonts macro is inlined. ## Toggling the Inline mode off and on 1. Visit the page containing the Fonts macro in edit mode. 2. Click on the Fonts macro to open the toolbar. ![Screenshot from 2024-04-04 16-48-25.png](https://documentation.appsbytng.com/__attachments/a_1996a9dc0cf67ea12381d24d16012941709b8820794df3ba68d95e0af39c8fad/Screenshot%20from%202024-04-04%2016-48-25.png?cb=b55f1b04fbf69996da4a8fdb42e80234) 3. Click on the button "**Display on new line**" ![adjusted.png](https://documentation.appsbytng.com/__attachments/a_4b23c719db8be9c7cc6e4fe6e9049548bf437f0588d0bffdcc1ae4a71dc46651/adjusted.png?cb=0ecb3fa7b06d361ad2edc6924cc84989) 4. Save the page. 5. Congratulations! πŸŽ‰ You have successfully toggled off the inline mode. ![Screenshot from 2024-04-04 16-57-36.png](https://documentation.appsbytng.com/__attachments/a_2066d4c42b5b48033f69fcd4c1cb762f12957975627a6c4af5107b893f211220/Screenshot%20from%202024-04-04%2016-57-36.png?cb=4afdfacd0165ba6bb543d9edd19514b2) ![info](https://documentation.appsbytng.com/__attachments/a_09dda5056cd66013c976ec14745615fbdd5a79134fe4485436b0e23397e232ff/atlassian-info?cb=feab5cd71111204d6b52545f3027dd0c) You can toggle the inline mode on again by following the steps above, but clicking "**Display inline"**button at the Step 3. --- version: "v3.0" variant: "Data Center" language: "en" --- # Fonts Macro Configuration To configure the Fonts macro, please navigate to the page that contains the macro and enter edit mode. Next, select the Fonts macro and click on the "Edit" button. ![Screenshot from 2024-04-04 17-52-12.png](https://documentation.appsbytng.com/__attachments/a_7a38f46f820b78d8cf5d3eb9fa89f7c837a53ffec1ee3bd183abaa418ac279e7/Screenshot%20from%202024-04-04%2017-52-12.png?cb=e6c290267add9e40769164a27c2b802c) This opens a modal where you can adjust the configuration of your Fonts macro. ![Screenshot from 2024-04-04 17-52-47.png](https://documentation.appsbytng.com/__attachments/a_de5584756e053548ceb6103bec5f2e63e724d18b537f2d71a034ed073b3877ff/Screenshot%20from%202024-04-04%2017-52-47.png?cb=19ad713c174c34bfca5ef9c1c95532ec) Beneath this page you can find the possible configuration options for a Fonts macro. * [Change the Font Type](https://documentation.appsbytng.com/webfonts-for-confluence/v3.0/Data-Center/change-the-font-type.md) * [Change the Font Color](https://documentation.appsbytng.com/webfonts-for-confluence/v3.0/Data-Center/change-the-font-color.md) * [Adjust Line Height](https://documentation.appsbytng.com/webfonts-for-confluence/v3.0/Data-Center/adjust-line-height.md) * [Adjust Font Size](https://documentation.appsbytng.com/webfonts-for-confluence/v3.0/Data-Center/adjust-font-size.md) * [Add Shadow to the Text](https://documentation.appsbytng.com/webfonts-for-confluence/v3.0/Data-Center/add-shadow-to-the-text.md) --- version: "v3.0" variant: "Data Center" language: "en" --- # Using the Fonts Macro Webfonts for Confluence provides you with the Fonts macro, which allows you to adjust the font of the text inserted in the macro body. ## Getting Started 1. Create a new page or edit an existing page to adjust the Font. Click on the "+" icon in the toolbar and select "Other macros", or use the shortcut `CTRL+Shift+A`. 2. Type "fonts" into the search field and select the Fonts macro to add it to the page. ![Screenshot from 2024-04-04 14-21-41.png](https://documentation.appsbytng.com/__attachments/a_ca962f9eacbeab74fa73726a03b3f7430be14896777776916286fb678bef4cef/Screenshot%20from%202024-04-04%2014-21-41.png?cb=39f74790fc10f4c81a007cc7d46dbb81) 3. A new dialog box appears allowing you to configure the Fonts Macro. You have to provide a "**Webfont"** and a "**Color** ", and the rest of the configurations are optional. [Learn more about optional Fonts macro configurations](https://documentation.appsbytng.com/webfonts-for-confluence/v3.0/Data-Center/fonts-macro-configuration.md). ![Screenshot from 2024-04-04 14-22-23.png](https://documentation.appsbytng.com/__attachments/a_5078cf14485cbe3c5cc9dd0d92353b49da94bce9c6c3d44bcd3c8a8473dfab48/Screenshot%20from%202024-04-04%2014-22-23.png?cb=442d95475508330d3685d31d5ceadbf1) 4. Click "Insert" to insert the Fonts macro. 5. Insert some text to the body of the Fonts macro. ![Screenshot from 2024-04-04 14-23-04.png](https://documentation.appsbytng.com/__attachments/a_1d179bdf8e813909d5d5c1eab9c37601737f1ca12a0e38642e658b537afb886c/Screenshot%20from%202024-04-04%2014-23-04.png?cb=7f1a6a71c90bd11decb4e07ab4978500) 6. Save the page. 7. Congratulations! πŸŽ‰ You have successfully adjusted your first Font. ![Screenshot from 2024-04-04 14-23-28.png](https://documentation.appsbytng.com/__attachments/a_e49ce353bef5b6dc50b206dffd4831958b84b9c88f0a32027ad67395408e58c3/Screenshot%20from%202024-04-04%2014-23-28.png?cb=bebac1cd7d2d616afa2d6ecd2f557a23) --- version: "latest" variant: "Cloud" language: "en" --- # Rock Your Sprint Review Documentation ![pluginBanner.png](https://documentation.appsbytng.com/__attachments/a_ce9a58a5eafdf9bab0921610f443450e9973caa3bfe8a12b959557485a7fd185/pluginBanner.png?cb=aa8a3b38d75cd946ad163b370097cb90) ## Why Rock your Sprint Review? Streamline your Sprint Review process by using AI to generate a slide deck for you based on the stories you completed in a selected sprint. Spend more time working on tasks for the sprint review, not the task of the sprint review. Winner of the Responsible AI prize at the 2023 Codegeist Unleashed hackathon. *** ** * ** *** ## Explore our Documentation Space * [Key Features](https://documentation.appsbytng.com/rock-your-sprint-review-for-jira/latest/Cloud/key-features.md) * [Selecting Issues For Your Presentation](https://documentation.appsbytng.com/rock-your-sprint-review-for-jira/latest/Cloud/selecting-issues-for-your-presentation.md) * [Using the App with Rovo](https://documentation.appsbytng.com/rock-your-sprint-review-for-jira/latest/Cloud/using-the-app-with-rovo.md) * [Using the App with OpenAI](https://documentation.appsbytng.com/rock-your-sprint-review-for-jira/latest/Cloud/generating-a-presentation.md) * [Presentation Settings](https://documentation.appsbytng.com/rock-your-sprint-review-for-jira/latest/Cloud/setting-panel.md) * [Saved Presentations](https://documentation.appsbytng.com/rock-your-sprint-review-for-jira/latest/Cloud/saved-presentations.md) * [Scopes \& Permissions](https://documentation.appsbytng.com/rock-your-sprint-review-for-jira/latest/Cloud/scopes-permissions.md) ### Need more help? You can submit a request via our [Service Desk](https://tngtech.atlassian.net/servicedesk/customer/portals). --- version: "latest" variant: "Cloud" language: "en" --- # Custom Slide Template You are able to upload a custom template (pptx) to be used to generate the slides. 1. Click on the gear button ![Screenshot from 2024-04-18 10-49-41.png](https://documentation.appsbytng.com/__attachments/a_3091e92bc9ffa1cb16f82168ae81265e021c1d785d9decc1f203632885381dd9/Screenshot%20from%202024-04-18%2010-49-41.png?cb=44c6e2dc49dd15239b6298c5c3876cfb) , next to Generate Slides button. ![image-20260602-062530.png](https://documentation.appsbytng.com/__attachments/a_a78c77e7ec00cd8503b67451aaaba69cb661f6793fb9444f0eed8326c50fc88e/image-20260602-062530.png?cb=0c9c27c329db375412252fb83a2801c4) 2. Select the *Custom Template* option 3. Click on *Select* and add your template 4. Optional: Use the *Preview*button to preview the result with some pre-filled data 5. Click the *Save* button to save the changes ## Template Structure The template must contain 2 parts: a title slide and content slides. ### Title Slide The first slide of the template file must be the title slide, which must contain at least 1 textbox. Add the placeholder text below to the textbox to assign its function. Please make sure the placeholder text is the only content in the textbox. The placeholder is: * `{title}` ### Content slides The rest of the slides are considered as content slides. There must be at least 2 textboxes on each slide with the following placeholders: * `{headline}` * `{content}` It is recommended to remove the bullet points and numbering from the placeholder textboxes to avoid redundancy, as the template engine will automatically reapply them. The content slides in the template will be cloned and cycled through, so the number of content slides does not need to match that in the final presentation. #### Images You are able to specify an image placeholder, to specify the location of the AI generated images. To do so, please open the selection panel in PowerPoint, and double-click the image item, then rename it to `{image}`. You will need to do that on all content slides. This placeholder is not necessary if the *Include DALL-E Image* option is disabled. ## Example template Below is an example template, which contains all the features mentioned above. [template.pptx](https://documentation.appsbytng.com/__attachments/a_0827412ffa836fa9d71b8acaff5425bd332dded74fc9afb74c3a101351144c0d/template.pptx.md?cb=4b5fa4d94a0fa6ce82e1345d0e1ba1be) --- version: "latest" variant: "Cloud" language: "en" --- # Data sent to OpenAI We use OpenAI to power the app's AI functionality. To do this, the relevant data shown below must be sent to OpenAI. The data is sent only when the **Generate Slides** button is clicked, and for issue specific data, only includes the issues selected to be part of the presentation. * Sprint parameters (eg Sprint Name, Sprint Goal) * Issue fields (eg Summary, Description). Comments and Subtasks are only sent if the corresponding option is enabled in the settings. --- version: "latest" variant: "Cloud" language: "en" --- # FAQ ## How many tokens does generating a presentation use? The number of tokens used depends significantly on the number of issues selected, and the content of the issue (summary, description, comment length), as these are all passed to ChatGPT. Below are estimates for how many tokens you can expect to use: **Without Image Generation:** * Input Tokens: \~650 base + \~415 per issue submitted * Output Tokens: \~80 base + \~65 per issue submitted **With image Generation:** * Input Tokens: \~650 base + 625 per issue submitted * Output Tokens: \~80 base + \~125 per issue submitted + image generation cost ($0.016 for DALLΒ·E 2 256x256 image) ## How do I prevent sensitive information from reaching OpenAI? If you have an issue that contains sensitive information you do not want to send to OpenAI, simply ensure that it is not selected when you click the **Generate Slides** button. Only issues you have selected will be sent to OpenAI. --- version: "latest" variant: "Cloud" language: "en" --- # Using the App with OpenAI To use the app with OpenAI, you will need to [set up your own OpenAI API key](https://documentation.appsbytng.com/rock-your-sprint-review-for-jira/latest/Cloud/setting-your-openai-api-key.md) first. If this method is not suitable for you, the app also comes with a custom [Rovo](https://www.atlassian.com/software/rovo) agent that allows you to [generate presentations using Atlassian's AI systems](https://documentation.appsbytng.com/rock-your-sprint-review-for-jira/latest/Cloud/using-the-app-with-rovo.md), though this requires an active Rovo subscription with Atlassian. ## Select the sprint and issues to use Before generating slides with OpenAI, you will first need to [select issues for your presentation](https://documentation.appsbytng.com/rock-your-sprint-review-for-jira/latest/Cloud/selecting-issues-for-your-presentation.md). ## Generate Slides Clicking the *Generate Slides with OpenAI* button will start the automatic slide generation process. To adjust how the slides are generated and what data is sent, click on the gear button ![Screenshot from 2024-04-18 10-49-41.png](https://documentation.appsbytng.com/__attachments/a_d0d2f7530b63144c334017d7af184f0320e6d03a2b050b456afa04af976fafc4/Screenshot%20from%202024-04-18%2010-49-41.png?cb=44c6e2dc49dd15239b6298c5c3876cfb) to open the settings menu. A list of available settings can be found [here](https://documentation.appsbytng.com/rock-your-sprint-review-for-jira/latest/Cloud/setting-panel.md). If any of your selected issues do not contain enough information to make it onto a slide, a warning will appear a few seconds into the process, indicating that these issues have been dropped from the presentation. ![image-20260304-234530.png](https://documentation.appsbytng.com/__attachments/a_acf6ec8598b215911e8e9c30432fc257ecc464c6e3d7996e0808c1c1458cc715/image-20260304-234530.png?cb=abf0f8820a38570757b00e9a0c968e72) At this point, you can either let the process finish, or abort the generation and expand the issue summary or description with more information. Note that you will have to reload the issues from Jira for your changes to take effect. ## Download Slides Once the generation process is finished (this typically takes about a few minutes), you can download your slides in .pptx format by clicking the Download slides link, which will automatically start your download process. --- version: "latest" variant: "Cloud" language: "en" --- # Generating an OpenAI API Key ## Generate an OpenAI API Key Rock your Sprint Review relies on ChatGPT. Therefore you need an OpenAI API key for the App to work. 1. Sign in to your OpenAI account at 2. Navigate to the OpenAI Dashboard. 3. Find the "API Keys" section and click "Create new secret key". 4. Generate your API key and securely store it. Remember to keep your API keys safe and refer to OpenAI's guidelines for usage instructions. --- version: "latest" variant: "Cloud" language: "en" --- # Key Features * **Automatic Slide Generation:** * Our AI algorithms analyze your sprint issues and create presentation slides for you. * Slides are generated based on the issue's summary, description, subtasks, comments, and estimation, ensuring comprehensive coverage. * You can use Atlassian's Rovo or OpenAI (through your own API key) as the AI system * **AI decides how to group the issues onto slides** * The application intelligently groups together related issues, providing a structured and coherent presentation. * The application automatically includes all completed issues, but it also empowers you to select and group specific issues, allowing you to customize the presentation to serve your audience's preferences and requirements. * **Content Condensation:** * Rock your Sprint Review condenses all relevant information into easily digestible points, ensuring your presentation remains concise and to the point. * **Seamless Integration with Jira:** * Rock your Sprint Review seamlessly integrates with your existing Jira workflow, making it easy to access and utilize within your project management environment. * If you use the App's Rovo Agent, none of your data will leave your Atlassian ecosystem. * **Use your own pptx Template** * You can upload your own pptx template, so that the presentation is generated directly in the style that you want. --- version: "latest" variant: "Cloud" language: "en" --- # Saved Presentations When you generate a presentation through Rovo or OpenAI, it will be saved and accessible from the app's presentation page. This page is accessible from anywhere in Jira by clicking on "**Apps"** in the Jira navigation menu, followed by selecting "**Rock your Sprint Review for Jira"** in the ensuing drop down menu. This will navigate you to the app page, from where you can view your saved presentations in the "Download Slides" tab. ![Download_Slides.png](https://documentation.appsbytng.com/__attachments/a_1bc9891bd9446348b072c0d47c8948f65c17fbe9c649da511ff33e774623d5eb/Download_Slides.png?cb=502851430b64135ef11a48b2aa2d1855) From here, you can generate and download pptx slides of your presentations by clicking on the title, or the "more actions" button that shows up when you hover over a presentation. You can change the style of the generated slides through the settings menu, accessible through the gear icon on the top right. This allows you to select the same slide-style options available elsewhere, including [your own custom template](https://documentation.appsbytng.com/rock-your-sprint-review-for-jira/latest/Cloud/custom-slide-template.md). ![image-20260602-062254.png](https://documentation.appsbytng.com/__attachments/a_dd7dbd023d77ae0b6a075e4e52a6c03196e36ea614a5bb82dc02f6bdadf2a5a2/image-20260602-062254.png?cb=ddc0f7c277323f3d724703a221cff177) Please note: only the 10 most recent presentations are saved per user. When a user generates a presentation with a full storage, the oldest saved presentation will be deleted automatically --- version: "latest" variant: "Cloud" language: "en" --- # Scopes & Permissions ## External domains: * `https://api.openai.com`: Required to send Chat Completion and Image Generation API calls to OpenAI to generate the presentation. An API key must be input for this domain to be called. ### Scopes: These are the scopes defined for our app. Please note that their representation in the "Allow Access" dialog can differ. * `storage:app`: Required to store the OpenAI API key. OpenAI API key is stored as a secret object. * `read:sprint:jira-software`: Required to get sprints and sprint details * `read:epic:jira-software`: Required to get Epics to generate epic summary * `read:issue-details:jira`: Required to get issue details to use for presentation * `read:jql:jira`: Required to perform JQL search for issues and sprints * `read:jira-work`: Required to get Jira project and issue data * `read:issue:jira-software`: Required to get issues from selected sprint * `read:issue-details:jira`: Required to get details for issues from selected sprint * `read:board-scope:jira-software`: Required to get boards in project * `read:board-scope.admin:jira-software`: Required to get board estimation configuration * `read:project:jira`: Required to get project key the app is used on * `read:jira-user`: Required by interface to choose users and groups to give access permissions --- version: "latest" variant: "Cloud" language: "en" --- # Selecting Issues For Your Presentation ## Navigate to the App tab To use Rock your Sprint Review to generate a presentation, simply head over to any of your spaces you want to use the app on, and go to the Rock your Sprint Review app tab in the Space view navigation panel. ![2026-02-27_09-37-20260226-223750.png](https://documentation.appsbytng.com/__attachments/a_e997e495b23b958f2d78769043cd073f21b34443ce3aef9ac2c43b851bca5ac8/2026-02-27_09-37-20260226-223750.png?cb=62e7e74fb72e63797aa12276b6e0c343) ## Select the sprint and issues to use Rock your Sprint Review allows you to generate a summary presentation for any sprints that appear on any boards within the currently selected project. 1. Select the sprint(s) you would like to analyze from the drop down menu, then click *Find Issues*. 2. After the loading of the issues finished, you can select all issues that you would like to include in the presentation by clicking the checkbox. All closed issues are pre-selected by default. 3. Clicking the checkbox in the header of a sprint box will cycle through the 3 states: 1. all issues selected 2. no issues selected 3. all closed issues selected 4. Note that all issues in the sprint(s) will be used to calculate the sprint metrics such as story points completed, but only selected issues will be interpreted by the AI and presented in the slides. ![image-20260304-234352.png](https://documentation.appsbytng.com/__attachments/a_8e3330def10ecaf099a9f839577b0eb3f8ad57760f82bfa0b65306df84f4024c/image-20260304-234352.png?cb=8ea0c56f9d7cd4df157d62665d20f2fe) ## Generate a presentation You are now ready to generate a Sprint Review Presentation! This can be done either through [Atlassian's built in AI system Rovo](https://documentation.appsbytng.com/rock-your-sprint-review-for-jira/latest/Cloud/using-the-app-with-rovo.md), or through [an external connection to OpenAI](https://documentation.appsbytng.com/rock-your-sprint-review-for-jira/latest/Cloud/generating-a-presentation.md). --- version: "latest" variant: "Cloud" language: "en" --- # Presentation Settings When generating a presentation, you can specify content-specific settings, such as language or target audience, as well as slide-style-specific settings, such as background or template. ## Settings Panel You can open the setting panel by clicking the gear icon, on the top right of the saved presentation page, or near the *Generate Slides* button in the *Rock Your Sprint Review* tab within your Space. ![ksnip_20250307-114758.png](https://documentation.appsbytng.com/__attachments/a_96058080c351e52a531ae2ee7df42f4baece6aad0270e45a5af415a0ee38c3fd/ksnip_20250307-114758.png?cb=545b7472fba37ee0379d341ae05482c3) Saved Presentation Page ![tabSettings-20260602-064140.png](https://documentation.appsbytng.com/__attachments/a_f2f19b10a8e66ae8b736c1fb452c2004fb8494b6430b478134368abb2db7da05/tabSettings-20260602-064140.png?cb=dcf69dd7ed93314bab659290b8a97f41) Rock Your Sprint Review Tab Within the *Rock Your Sprint Review* tab, there are 5 parts in the setting panel. On the saved presentations page, only the last part (Slide style settings) can be adjusted. ![image-20260602-062623.png](https://documentation.appsbytng.com/__attachments/a_0e914e8a37d3f6356280b456460eea2117b95d0fb604fdd88b32794b25963878/image-20260602-062623.png?cb=604ee2c8062eaf46f6d6ac59f499e492) ## Language Settings You can set in which language the generated presentation should be. Rock Your Sprint Review supports all languages available for Atlassian. ## Data Settings To provide the AI with more information, you can choose to send also comments and subtasks of your issues. By default, only the issue titles and descriptions are sent. ## Content Settings You can turn on the *Include DALL-E Images* option to add AI generated images to the slides. This will slightly increase the time and cost of the generating. Note that this feature is only available when using OpenAI, and is not supported by Rovo. ## Audience Settings You can specify a target audience for your slides which will modify the way the slides are written. If left empty the audience will default to a non-technical stakeholder ## Slide style settings This section controls the style of the generated slides. There are currently 4 options. * **Theme** The Theme option lets you style your presentation with a cohesive set of colors. It's the default slide style and produces professional-looking slides suitable for business meetings. * **Preset Themes** Select Theme in the Slide style settings to see a list of predefined themes. Each theme applies six coordinated colors across your slides --- for title text, body text, background, and accents. Simply select one to apply it. * **Custom Theme** If none of the presets suit your needs, select Custom to define your own colors for each of the six slots. This is useful for matching your organization's branding. * **Preview** Use the Preview button to see how your chosen theme looks on a sample slide before generating the full presentation. * **Custom template** : use your own slide template. Please see [(Working) Custom Slide Template](https://documentation.appsbytng.com/rock-your-sprint-review-for-jira/latest/Cloud/custom-slide-template.md) for details. * **Custom background** : customize background images and font colors on a pre-defined slide template. You can use the *Preview*button to review the slide customization with some pre-filled data. * **AI Image Background**: allow the AI to choose between the pre-defined slide templates based on the slide content. * **Simple**: generate the slides with only text and white background. You can then customize it. --- version: "latest" variant: "Cloud" language: "en" --- # Setting your OpenAI API key ## Data Privacy Disclaimer The Rock your Sprint Review app works by sending your Jira issue content directly to OpenAI. Even though we don't save any of this data ourselves, it is highly advisable to be careful with issues that contain sensitive or classified information as they will be sent to OpenAI. **This page is for Jira Administrators** ### Adding an OpenAI API key For Rock your Sprint Review to generate your slide deck, you will need to provide your OpenAI API Key. This can be done by visiting the app's admin page. As an admin go to **Settings \> Apps** and select **Rock Your Sprint Review** in the sidebar. (Please note that the key requires GPT-4o and DALL-E functionality) ![Screenshot 2023-10-20 163630.png](https://documentation.appsbytng.com/__attachments/a_c20609f83fd4d3ec565c1125396b5794bf4a0c30ba1b31d432fd215ae092a225/Screenshot%202023-10-20%20163630.png?cb=d8768f95f2020b21acf55c7558ca8d9e) Adding your OpenAI API key ### Managing your OpenAI API key Once your OpenAI API key is set, you are also able to edit or reset the key if needed. ![Screenshot 2023-10-20 162848.png](https://documentation.appsbytng.com/__attachments/a_a81ce8881bc06fdcf03f74db1d5946e2039bd92251d3a9e765e9407436df9a45/Screenshot%202023-10-20%20162848.png?cb=f75c31791fca6f52c27d3fa80116085b) Managing your OpenAI API key Congratulations, your Rock your Sprint Review is now ready to roll! --- version: "latest" variant: "Cloud" language: "en" --- # Troubleshoot Template Settings This documentation contains necessary information to fix the warnings and errors in the setting panel. ## The size of the template/background file is too large The template files and background files are saved in your browser's internal storage. If your file is larger than your browser's allowed internal storage size per item, the file cannot be saved, which is the reason why this error appears. In this case, you are still able to generate the slides with the template/background, but it will not be saved and will be gone upon refreshing the page. To reduce the size of your template you can try compress the background image or the images in the template file. ## Some of the slides do not have an image placeholder In order to add AI generated images, all content slides in the template must have an image placeholder. If this is not the case, a warning will be displayed indicating which slides do not contain an image placeholder.. You can still use the template to generate a presentation, but you must toggle the AI image generation off. You can find information on how to set up an image placeholder in our template file [documentation](https://documentation.appsbytng.com/rock-your-sprint-review-for-jira/latest/Cloud/custom-slide-template.md). ## Image file type not supported The file type of the background image you provided is not fully supported. Currently, only `.png`, `.jpeg`, `.jpg`, and `.webp` are fully supported. You can still use other file types to generate a presentation, but there might be some issues, for example, a warning that the file needs to be fixed upon opening the resulting Powerpoint. ## Your template file is not valid The template file is not in the correct format. Please refer to the [documentation](https://documentation.appsbytng.com/rock-your-sprint-review-for-jira/latest/Cloud/custom-slide-template.md) to fix the template. --- version: "latest" variant: "Cloud" language: "en" --- # Using the App with Rovo [Rovo](https://www.atlassian.com/software/rovo) is Atlassian's agentic AI system that comes with a number of useful Agents out of the box, but requires a separate subscription. With a Rovo subscription active, you will be able to use the Rock your Sprint Review agent to create presentations using Atlassian's own AI systems. If you don't have a Rovo subscription, you can still use the [app with your own OpenAI API key](https://documentation.appsbytng.com/rock-your-sprint-review-for-jira/latest/Cloud/generating-a-presentation.md). There are two ways of using Rock Your Sprint Review with Rovo: * Generating presentations from selected sprints and issues from the App Tab * Generating presentations from the sprint board directly ## Generating presentations from the App Tab This method allows you to select specific issues from multiple sprints to be included within your presentation. First, you need to [navigate to the App Tab and select issues for your presentation](https://documentation.appsbytng.com/rock-your-sprint-review-for-jira/latest/Cloud/selecting-issues-for-your-presentation.md). Once you have selected the issues you would like to include within your sprint review presentation, simply click on the *Save issues to Rovo*button. This will store these issues for the next time you ask Rovo to generate a presentation for you. ![image-20260305-011008.png](https://documentation.appsbytng.com/__attachments/a_4aac6c0e2dec04fdbb66122446b7f62cb8a2137a19df1d94d2e3ed4aea96f1f9/image-20260305-011008.png?cb=3e556b38f9b65d659951b4805b80f6d5) Once the issues are saved to Rovo, simply [open the Rovo chat interface](https://support.atlassian.com/rovo/docs/accessing-chat/) at the top right of your Jira instance, then click on "Switch to another agent", search for "Rock your Sprint Review" among the available agents, and select the one from our app. ![image-20260305-013233.png](https://documentation.appsbytng.com/__attachments/a_6e4bfc046497bf47a5980612df8b7ad56a8bf3a607e10bf7bc36a9979484da16/image-20260305-013233.png?cb=8e851f58a4758478a37bbb077e61aa2e) Next, click on "Generate a presentation for the saved issues" And Rovo will automatically generate a link to the app page where you can download your presentation. ![image-20260305-014308.png](https://documentation.appsbytng.com/__attachments/a_6c04820d83a41c4fc9f790b4ae667b8a8994617dab2cc4c20bce079bf083c21d/image-20260305-014308.png?cb=80387ef440ec682a2c2d5ad777174c76) ## Generating a presentation for a sprint Our agent is built in such a way that, if you access the agent from a project, you can ask it to directly generate a presentation for you of the current sprint, and Rovo will fetch the required information for you, so that you end up with your presentation straight away. ![image-20260305-014531.png](https://documentation.appsbytng.com/__attachments/a_a36e164ccf8670dd91d7426d85129c61de92c38e571ef4ed6ae8f326dc6e2a72/image-20260305-014531.png?cb=574ed414f4d5e349e714a56c47a8394c) Alternatively, you can also ask the agent to list the boards or sprints available in your instance or project, and tell it which of these you want to use for your presentation. ## Configuring the AI settings By default, Rovo will use the settings specified directly from the [settings panel](https://documentation.appsbytng.com/rock-your-sprint-review-for-jira/latest/Cloud/setting-panel.md). You can also make once off changes to the settings by asking it directly. For example, to change the language or target audience of the presentation, simply add this information to your prompt, for example: `Generate a presentation for the current sprint in French, targeted at a manager who loves sports`. Rovo is unable to give you a download link directly. Instead, the presentation will be saved and downloadable from our [app page](https://documentation.appsbytng.com/rock-your-sprint-review-for-jira/latest/Cloud/saved-presentations.md). Settings like the pptx template you want to use are accessible from there. After it has finished generating a presentation, our Rovo agent will provide you with a handy link directly to the saved presentations page. Simply follow it, and download the appropriate presentation. --- version: "v3.1" variant: "Data Center" language: "en" --- # Issue Printer for Jira Documentation ![image-20240206-061612.png](https://documentation.appsbytng.com/__attachments/a_e89e396caa44c7661e7501bb47b7a18d5bcb19fbd4c2bc1938c8ee7488cbf68a/image-20240206-061612.png?cb=78a2819cbc8ee44c3aebe21777e9f1a5) ## Why Issue Printer for Jira? Print your issues for your agile wallboard - use the full power and freedom of HTML and CSS to design custom templates *** ** * ** *** ## Explore our Documentation Space * [Manage Templates](https://documentation.appsbytng.com/issue-printer-for-jira/v3.1/Data-Center/manage-templates.md) * [Design Guide](https://documentation.appsbytng.com/issue-printer-for-jira/v3.1/Data-Center/unlimited-design.md) * [Print Issues](https://documentation.appsbytng.com/issue-printer-for-jira/v3.1/Data-Center/print-issues.md) * [Troubleshooting articles](https://documentation.appsbytng.com/issue-printer-for-jira/v3.1/Data-Center/troubleshooting-articles.md) *** ** * ** *** ## Need more help? You can submit a request via our [Service Desk](https://tngtech.atlassian.net/servicedesk/customer/portals). --- version: "v3.1" variant: "Data Center" language: "en" --- # App upgrade crashes Datacenter Node / Jira Server ## Problem Upgrading / disabling / uninstalling Issue Printer - Print Agile Board Card crashes the whole Datacenter node or Jira Server instance. ## Details Version 2.0.0 introduced a cache to improve template rendering performance. Upon disabling the app, e.g. as part of an upgrade, the Jira Server instance or a single Datacenter node can crash. The crash is caused by shutting down Jira's internal caches as a result of . The logfile contains exceptions with the following error: Cache is not alive (STATUS_SHUTDOWN) ## Solution The following provides a step-by-step solution: 1. Shutdown Jira or the corresponding Datacenter node. 2. Uninstall the app. Follow the official knowledgebase article at 3. Start Jira or the corresponding Datacenter node. 4. Install a fixed version (2.1.3 or newer). It is possible that uninstalling the app via the user interface is not possible. The linked knowledgebase article describes an additional way of manually removing the jar file. --- version: "v3.1" variant: "Data Center" language: "en" --- # Manage Templates ## Global Templates vs. Project Templates You can use **global** or **project templates**to print your issues. Managing and accessing the templates requires different permissions. ![manage_templates_access.png](https://documentation.appsbytng.com/__attachments/a_3a52cf8ddd48fb84c6c12db998cda6b94d46fe3e4617f30b35ec679e12b68f11/manage_templates_access.png?cb=0036d68ab4f6cb91f0c38be9364fdc9e) Access **template management** via "Print issue" | | **Global Templates** | **Project Templates** | |----------------|--------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | Availability | * available for all users | * available for users with "Browse Project" permission of respective project | | Administration | * requires global Jira administrator permission | * requires Jira or Project administrator permission of respective project * Jira administrators must first [grant project admins editing rights for Project Templates](https://documentation.appsbytng.com/issue-printer-for-jira/v3.1/Data-Center/manage-templates.md#Grant-Project-Admins-Editing-Rights-for-Project-Templates) | | Access | * Print issue β†’ Edit button on template * global administration β†’ Manage Apps β†’ Issue Printer for Jira β†’ Global Settings | * Print issue β†’ Edit button on template * Project settings β†’ Print Templates | ### Grant Project Admins Editing Rights for Project Templates By default, Jira project admins are not allowed to edit Project Templates of Issue Printer. Since the template editor allows raw HTML editing, grant this permission only to trusted project admins. Jira administrators can enable Project Templates as follows: * Go to Global administration β†’ Manage apps β†’ Issue Printer for Jira β†’ Global settings * Turn on the toggle **Enable template access for Jira project admins** ![Screenshot 2026-03-11 at 20.16.01.png](https://documentation.appsbytng.com/__attachments/a_34c956d815073578b46f9836e69b35838747d6f18247002f52332cbb962758ce/Screenshot%202026-03-11%20at%2020.16.01.png?cb=e135b19d5157588c95e2be0e1eb9d54b) **Allow** Project Admins to edit templates ## Create a new Template You can create new templates by clicking the **+** button and then select **Create.** Please enter a name and select a design to start with. ![Print Templates section in project configuration. A dropdown is open after clicking the plus button, with the 'Create' option highlighted.](https://documentation.appsbytng.com/__attachments/a_6bb2efdee7c3dd15dbcf3280d7923906d2534041ca1759440c28ed890845d153/CreateNewTemplate.png?cb=6fdfa3c0c1e35a12876846ec39f3bedf) Create **new template** ![Create New Template dialog with 'Enter a name' text field, and a 'Start with' dropdown menu open showing 'Basic' as the selected option. The dialog includes 'Continue' and 'Cancel' buttons.](https://documentation.appsbytng.com/__attachments/a_0f3190648fba49a920daa79e90de879edbc104a4d476cd59c1a7d5978210903a/CreateNewTemplateDialog.png?cb=8f071dbefb138dfb24e4ecfbe4c2a645) Enter **name** and **starting** design ## Rename a Template You may rename your template at any time. However, you cannot choose a name from an already existing template. ![rename_template.png](https://documentation.appsbytng.com/__attachments/a_7db453ac38679f0bb49b92b1910ac0149a5ad7de71ccd86334bdfe6cde5dbcc5/rename_template.png?cb=00e0b20f873ea6c3d2eb7da48c247c30) **Rename** a template ## Copy a Template You can copy templates by clicking the **+** button and then select **Copy.** After selecting a source project (this can also be the same project) you can select one or more templates to copy. If you select just one template to copy you may also enter a new name for the template. Otherwise, the template name is simply copied without any change. ![Copy Template dialog. Description reads Choose project and template(s). The first dropdown allows selecting a single project. Below it, a multi-select dropdown for templates is open, with the option Black and White currently highlighted. The dialog includes Continue and Cancel buttons.](https://documentation.appsbytng.com/__attachments/a_93307bc3105b4d7191af75b8eeb4013bd5379913d46ab021305ebb6119185d2f/CopyTemplateDialog.png?cb=3d9cd138e970aee39bd529139a5239e4) **Copy** a template If you have already a template with the same name you will be asked to overwrite the existing template(s). To prevent your templates from being overwritten, rename or copy your templates first. ## Set a Default Template You can set one template as the default template for the project. The default template will be selected first when printing your issues. You can always change the template on the preview page. ![set_default_template.png](https://documentation.appsbytng.com/__attachments/a_1e5c58e497ad0cf09e3bfa1950b9e3ebe80fcb121b3b2abf2c9d328ce72cdcd6/set_default_template.png?cb=94e17aeb54c1dc9bd5e2b18aecf1e68c) Set the **default template** of a project ## Delete a Template You may also delete a template. ![delete_template.png](https://documentation.appsbytng.com/__attachments/a_d0f4c5ece9e4efddc11a46f779f556012cf3af7e1b40ef73f62f7b4a9ad55deb/delete_template.png?cb=2745b10569e9bda1b35d48d19e6b2a5b) **Delete**a template There is no trash so be careful. A deleted template cannot be recovered. --- version: "v3.1" variant: "Data Center" language: "en" --- # Print Issues ## Select Issues to Print You can select the issues for printing from Jira boards, issue search or issue view. ### Print Issues from Agile Board Print **sprint**from the backlog ![print_sprint_from_backlog.png](https://documentation.appsbytng.com/__attachments/a_7f3d9fd02c9e547dc069df1aeacfc07c84d53ca2066a0cb9c61ac921026879d7/print_sprint_from_backlog.png?cb=cb97b9a8fd1da13f1a9c441766b7e901) Print **selected issues** ... ![print_selected_issues_board.png](https://documentation.appsbytng.com/__attachments/a_41691c190a5bd2e61c463630f504013af2c980330d11a161be1e606a32f17654/print_selected_issues_board.png?cb=2892f1d90469b8441471fb7906e9a13e) ... from the board ![print_selected_issues_backlog.png](https://documentation.appsbytng.com/__attachments/a_173558cc3303dabc373fb77c83a1b0f3f0a8af9af02b53739164abbaefecf7b5/print_selected_issues_backlog.png?cb=50d01d87dd404a29c4f9964b898726de) ...from the backlog Print**issues in column** ![print_issues_in_column.png](https://documentation.appsbytng.com/__attachments/a_ef40ca050c6ca1f002123c220cf67ab450fc996ec27ffd16bcd7eb1380aa4b75/print_issues_in_column.png?cb=cf5c4c7624b341f2ac3ea64380b6cbd6) ### Issue Search Print issues from any **search** or **filter** ![issue_search.png](https://documentation.appsbytng.com/__attachments/a_15d9b45864dca8057434d38bcda92af49d96099641b01763593e0ef90b803914/issue_search.png?cb=fc5f8034172c453f6ea0e82e9b782396) ### Issue View Print a**single issue** ![issue_view.png](https://documentation.appsbytng.com/__attachments/a_b5c702219a59caa97049aed11763850a3baf98b362e2d6018b529039334e1ca1/issue_view.png?cb=406e88bc4bf5b158b382cb24c40a1fd9) Print all **sub-tasks** of an issue ![issue_view_subtasks.png](https://documentation.appsbytng.com/__attachments/a_02871d7e7ce18623e892c992bfa5198793d3595d87fea69bbd8c441f06decdb1/issue_view_subtasks.png?cb=34977433d7e0a3e850caeef7c27c45bc) ## Select a Template and Print After you have clicked on the print icon or the print menu item, you are redirected to the print preview page. You can print the issues using the default template or select any other template from the list. To access project templates from other projects, change the project in the upper left corner. The preview is updated immediately. Click the **Print** button or use the browser menu to print your issues. ![templates.png](https://documentation.appsbytng.com/__attachments/a_ffea409d6a022b76b716005d5850f5a41bf74baaeb83b4d81f4a3fbf55e248d1/templates.png?cb=73fbc5b4af496053d163915a275405ee) Select a **template** and **print** Please ensure in the print dialog of your browser that margins, format and orientation are configured correctly. You may also deactivate the printing of the header and footer of the page. --- version: "v3.1" variant: "Data Center" language: "en" --- # Troubleshooting articles * [App upgrade crashes Datacenter Node / Jira Server](https://documentation.appsbytng.com/issue-printer-for-jira/v3.1/Data-Center/app-upgrade-crashes-datacenter-node-jira-server.md) --- version: "v3.1" variant: "Data Center" language: "en" --- # Design Guide ## Format the Page Safari does not support issue template format settings. You have to configure format, orientation or margins in the print dialog of Safari. You can store page format settings in your template. The page format is used for preview and printing. ![Screenshot from 2025-02-10 10-36-00-20250210-093600.png](https://documentation.appsbytng.com/__attachments/a_e3289396054509f1f76453ae913682e35a1f3758eab664c68fe0a5ad5cad589f/Screenshot%20from%202025-02-10%2010-36-00-20250210-093600.png?cb=d42b82856762c448056b1fa76e2eb9a5) Adjust **page format settings** You can choose from a selection of standard paper formats or select the **Custom** option to specify your own custom paper dimensions. ![Screenshot from 2025-02-10 10-36-57-20250210-093657.png](https://documentation.appsbytng.com/__attachments/a_98a25d12520516e2402181ca1682dd1227c6924302ff6352224c41ec286ff648/Screenshot%20from%202025-02-10%2010-36-57-20250210-093657.png?cb=c7f6267432d2dc944db8b8e4d73dadab) Specify your own width and height in millimeters. ## Change the Size of Your Card To change the size of a predefined template you only have to change the style attribute of the outermost division in the template like shown below. ![size_of_card.png](https://documentation.appsbytng.com/__attachments/a_194c23c2251c51450b157244941bd80b845b052cf967552eed3b2c48715f398d/size_of_card.png?cb=030398c4659bf1d42d209f88e1dee989) ## Adding Fields to Your Card You can put almost every field onto your card, even custom fields. Most fields are rendered as in the browser by JIRA. Therefore, you may also print your nicely formatted descriptions. You can see a list of available fields in the Help section on the right. ![Screenshot from 2024-04-09 16-42-58.png](https://documentation.appsbytng.com/__attachments/a_61fe17b6e9376b7f14e9ec0fbd501a1aaa7af53145f42e313c9c6a4cdcbaa261/Screenshot%20from%202024-04-09%2016-42-58.png?cb=e164842f7efb09e22151fdeb415b8d3c) All JIRA system fields are available under the variable `issue`. All custom fields can be accessed by `issue.customfield`. If a field exists its value is never null but empty. You can check for field existence by using an **if**-clause. This is only necessary for custom fields if you want to prevent your template to fail when the custom field is renamed or deleted. | **Examples** || |-------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------| | {$issue.summary} | Prints the summary of the issue. | | ${issue.customfield.sprint} | Prints the value of the custom field "**Sprint**". Note that the field must exist, otherwise an error will be thrown. | | {if $issue.customfield.storyPoints} {$issue.customfield.storyPoints} SP {/if} | Prints the value of the custom field "**Story Points**" if such a field exists. | | {$issue.description|noAutoescape} | If your rendered field contains any html you need to set the `noAutoescape` print directive to correctly render your field | ## Change the Border of Your Card To change the border of a predefined template you need to adjust the border-division of the card. You may also change the appropriate CSS style at the beginning of the template for more advanced borders. ![Screenshot from 2024-04-09 16-44-58.png](https://documentation.appsbytng.com/__attachments/a_866ed986cfe857b68a931956aac0383190f7370b3168950736414b06c0f42dcb/Screenshot%20from%202024-04-09%2016-44-58.png?cb=03b201ba3292cb671735dc8b21382d05) If the border should depend on any value of the issue like the priority or the issue type just use the following: 1. Give the division a new attribute like "issue-type" and use the appropriate value: XML
2. Write some CSS rules that depend on the attribute value: div[issue-type='Story'] {lb} border-color:#ffd500; {rb} div[issue-type='Bug'] {lb} border-color:#CC0000; {rb} div[issue-type='New Feature'] {lb} border-color:#ff9933; {rb} div[issue-type='Epic'] {lb} border-color:#888620; {rb} div[issue-type='Task'] {lb} border-color:#bfe4ff; {rb} div[issue-type='Sub-task'] {lb} border-color:#009999; {rb} div[issue-type='Improvement'] {lb} border-color:#009900; {rb} div[issue-type='Technical task'] {lb} border-color:#cc0000; {rb} Note that you have to use `{lb}` and `{rb}` instead of `{` and `}`, because `{` and `}` cannot be used directly as these are reserved characters in[Closure Templates](https://developers.google.com/closure/templates/). ## Starting from Scratch If you want to start from scratch, create a new template based on the **Blank** design. This design only defines some important CSS rules as well as the outermost division. You always need one outermost division with the CSS-class **ip-card**, otherwise, template rendering will fail. When designing your template, please be aware that browsers cannot be controlled completely via CSS for printing. You may have to configure the following settings in your browsers print dialog: * print background colors * do not print header/footer of a page * you can also format the page The template language is[Closure Templates](https://developers.google.com/closure/templates/) so you may do anything that is possible via this template language. Look at the useful snippets below or the predefined templates to get an idea of possible designs. ## Useful Snippets ### Card sizing Wherever you have boxes for content with padding or borders you should apply the following CSS-rule to make it easier to ensure that the card is not enlarged by your border or padding: box-sizing: border-box; -moz-box-sizing: border-box; -webkit-box-sizing: border-box; ### Layout If you want to place content next to each other, tables are the easiest way: ...
Left column Middle column Right column
--- version: "v4.0" variant: "Data Center" language: "en" --- # User Switcher for Jira Documentation ![pluginBanner-20230531-014605.png](https://documentation.appsbytng.com/__attachments/a_523839c79338e95001edaacf800b530ba91d244cf2f3b4a9e820e7a995c0b628/pluginBanner-20230531-014605.png?cb=764fb0072aa3a608ebd043a1a88217f9) ## Why User Switcher for Jira? User Switcher for Jira allows administrators to quickly change users to test workflows or give support. Press **xx** on any screen to switch your session to a different user. This allows you to view Jira from their perspective. To revert to your original view, simply switch back once you've located the issues. *** ** * ** *** ## Explore our Documentation Space * [Usage](https://documentation.appsbytng.com/user-switcher-for-jira/v4.0/Data-Center/usage.md) * [Configuration](https://documentation.appsbytng.com/user-switcher-for-jira/v4.0/Data-Center/configuration.md) * [Enable toolbar / disable who command](https://documentation.appsbytng.com/user-switcher-for-jira/v4.0/Data-Center/enable-toolbar-disable-who-command.md) ### Need more help? You can submit a request via our [Service Desk](https://tngtech.atlassian.net/servicedesk/customer/portals). --- version: "v4.0" variant: "Data Center" language: "en" --- # Configuration Go to **Manage apps** and search for the **User Switcher for Jira** . Expand it and click on **Configure**: ![configure_app.png](https://documentation.appsbytng.com/__attachments/a_91558b3d4df7a8e763b95c818a0bfa469dc1e46c9a4e59a1e8d96a8e80229d55/configure_app.png?cb=512f3659f9f7539d0d11c53df50b2629) Use the two input fields to restrict plugin usage to specific groups. The following options determine how this restriction is applied: ## Allow only users of a certain group to switch users Specify a group of users that are allowed to switch the user other than JIRA system administrators. **Default:** users with system administrator privileges ![configure_app_2.png](https://documentation.appsbytng.com/__attachments/a_34b87d52d2220861526e97de548b85413b0be7fd850b0276afe3a7332c576670/configure_app_2.png?cb=01c7204be0c1b29b3b6bd1727fcdf47a) ## Only allow a user switch to a certain group This setting restrict the list of possible users a user can switch to. E.g. you can restrict the switch to test users only. **Default:** any user ![configure_app_3.png](https://documentation.appsbytng.com/__attachments/a_885eb54ab5a5aff34f878d86f352b29dd0d3c396ca6aae6c6b21a1710872970b/configure_app_3.png?cb=6220deb7e587860144d469f7fbaa98e8) --- version: "v4.0" variant: "Data Center" language: "en" --- # Enable toolbar / disable who command ## En-/Disabling modules of the app For enabling the toolbar or disabling the who command, go to **Manage apps** , search for **User Switcher for Jira** and click on **Configure**(see above). On the right, click on "31 out of 33 modules enabled" (or similar) to unfold the module overview. Here you can enable and disable modules of the app. ![grafik-20241118-114942.png](https://documentation.appsbytng.com/__attachments/a_3b8396b87ee1aea1e518800708f6dcbb0d461fe09d35c9799b50970fafab9f3d/grafik-20241118-114942.png?cb=130dead95e907b8fece029455ccd2213) ## Enabling Toolbar By default the toolbar is disabled for performance reasons. [On activation, it is recommended to configure a group with users that you can switch to.](https://documentation.appsbytng.com/user-switcher-for-jira/v4.0/Data-Center/configuration.md)This group should not contain more than 10-20 users. The toolbar is enabled by the modules: * *User Switch Toolbar* * *entrypoint-quickSwitchBar* ## Disabling who command By default the **who** command is *enabled*. It is deactivated by the module: * *Who am I?* --- version: "v4.0" variant: "Data Center" language: "en" --- # Usage By default only users that have system administration privileges may switch the user. [Here we explain how to modify this behavior.](https://documentation.appsbytng.com/user-switcher-for-jira/v4.0/Data-Center/configuration.md) ## Basic Usage On your keyboard, type **xx** on any screen to show a popup dialog in which you can search for users. You can select the user to switch to: ![xx.png](https://documentation.appsbytng.com/__attachments/a_986e5b2710c5169fa85ab0f7a5a14528b00fb6cd6b9ba2977f46c23437c2ce5b/xx.png?cb=4465863c35bb26d6524531360b3db950) The action of switching users is recorded in [the audit log](https://confluence.atlassian.com/adminjiraserver/auditing-in-jira-938847740.html). ## Toolbar Usage The toolbar is disabled by default, because it needs special configuration. [Please see here for details and how to enable it.](https://documentation.appsbytng.com/user-switcher-for-jira/v4.0/Data-Center/enable-toolbar-disable-who-command.md) On your keyboard, type **qq** on any screen to show the toolbar. You can click on a button to switch the user: ![qq.png](https://documentation.appsbytng.com/__attachments/a_2daae2b267f6e4e122113880d9c6d4726f58798fb90c04064ca899e10aa235d9/qq.png?cb=31a4dc2d79d64329dc1daca4841322ae) ## Who am I (right now)? On your keyboard, type **who** on any screen to check your current acting and login user. Note that other plugins using 'w' as a shortcut may conflict with the **who** command. [See here to find out how you can disable it.](https://documentation.appsbytng.com/user-switcher-for-jira/v4.0/Data-Center/enable-toolbar-disable-who-command.md) ![grafik-20241115-090248.png](https://documentation.appsbytng.com/__attachments/a_d26961e92adcdc2a63f87d057146fee84ee0e45b7c51b955f1c0efba0ee2b883/grafik-20241115-090248.png?cb=2348610a8445e1a711fd8a99705b675a) --- version: "v3.0" variant: "Data Center" language: "en" --- # PDF Macros for Confluence Documentation ![pluginBanner-20230531-014605.png](https://documentation.appsbytng.com/__attachments/a_cdd99891fb8ee01d08dccf6ad3251a1caced90f61305d1e8395f748a641d7a59/pluginBanner-20230531-014605.png?cb=fa06246a7bba738982f4f8979dcf76de) ## Why PDF Macros for Confluence? PDF Macros for Confluence allows you to easily customize your PDF exports with an entire set of macros. We provide macros to add page breaks, avoid page breaks, display pages in landscape mode, hide content either in the web view or the export, insert the current date and time or change the font size. You can configure your exports by adding the respective macros to the page. *** ** * ** *** ## Explore our Documentation Space * [Macros](https://documentation.appsbytng.com/pdf-macros-for-confluence/v3.0/Data-Center/macros.md) ### Need more help? * [Service Desk](https://tngtech.atlassian.net/servicedesk/customer/portals) --- version: "v3.0" variant: "Data Center" language: "en" --- # Macros ## Included Macros | Name | Description | |------------------------------|---------------------------------------------------------------------| | `PDF: Force Page Break` | Forces a page break in the exported PDF. | | `PDF: Avoid Page Break` | Avoids a page break in the exported PDF. | | `PDF: Landscape` | Export this section in landscape format. | | `PDF: Hide in PDF Export` | Only show in web view. | | `PDF: Hide in Web View` | Only show in PDF export. | | `PDF: Current Date and Time` | Embeds the current date and time in the exported PDF. | | `PDF: Font Size` | Gives the ability to use a different font size in the exported PDF. | --- version: "v8.0" variant: "Cloud" language: "en" --- # Bar Charts for Jira Documentation ![b4a948cf-7d3c-46b5-b3d6-96bfe3f0dd41.png](https://documentation.appsbytng.com/__attachments/a_7244a9b5f80ce905ab88fe39a85259366c316aef8fbfb3460f0dd0b136ada6e5/b4a948cf-7d3c-46b5-b3d6-96bfe3f0dd41.png?cb=dbd3f89be3d07f953b623b881a3e4bac) ## Why Bar Charts for Jira? Bar Charts for Jira allows you to display a generic bar chart on your dashboard. Bar Charts for Jira allows you to display a fully configurable bar chart on your dashboard. You can adjust the size and x-axis of the chart, display a table showing the data of the chart, and create a stacked bar chart by grouping according to a different field. *** ** * ** *** ## Explore our Documentation Space [Using the Bar Charts gadget](https://documentation.appsbytng.com/bar-charts-for-jira/v8.0/Cloud/using-the-bar-charts-gadget.md) * [Bar Charts configuration](https://documentation.appsbytng.com/bar-charts-for-jira/v8.0/Cloud/bar-charts-configuration.md) [Migration (Server / Data Center β†’ Cloud)](https://documentation.appsbytng.com/bar-charts-for-jira/v8.0/Cloud/migration-server-data-center-cloud.md) [AI features](https://documentation.appsbytng.com/bar-charts-for-jira/v8.0/Cloud/ai-features.md) [Troubleshooting](https://documentation.appsbytng.com/bar-charts-for-jira/v8.0/Cloud/troubleshooting.md) * [Scopes \& Permissions](https://documentation.appsbytng.com/bar-charts-for-jira/v8.0/Cloud/scopes-permissions.md) *** ** * ** *** ### Need more help? You can submit a request via our [Service Desk](https://tngtech.atlassian.net/servicedesk/customer/portals). --- version: "v8.0" variant: "Cloud" language: "en" --- # AI features The added AI features in Bar Charts are optional and they can be enabled by the admin. To activate them, the admin needs an OpenAI API. If you use the AI features, relevant data must be sent to OpenAI. Remember to keep your API keys safe and refer to OpenAI's guidelines for usage instructions. [Next Page](https://documentation.appsbytng.com/llms-full.txt/1)