--- language: "en" --- # GitHub for Miro GitHub for Miro will enable you to integrate both platforms and streamline your workflows. By leveraging the strengths of these apps in a cohesive working space, you'll be able to improve efficiency and collaboration. ![GFM General dashboard 20240822.jpg](https://apps-docs.servicerocket.com/__attachments/a_93463a5c745686dd84d84a6bc97d5f9c31c97aa4be0e4b502bf40737e68801cf/GFM%20General%20dashboard%2020240822.jpg?cb=6f1e4340ab24b9b0dd009d06a66f646f) ## Key features GitHub for Miro allows you to: * Import issues from GitHub and place them in Miro as app cards. * Create GitHub issues from Miro. * Convert Miro sticky notes into GitHub issues using app cards. ## Installing GitHub for Miro Any user can install GitHub for Miro to a Miro team. However, admins can restrict non-admins from adding apps if they're on Miro's Business or Enterprise Plan. To learn more, you can check out [Can non-administrators install apps?](https://apps-docs.servicerocket.com/mg/can-non-administrators-install-this-app.md) 1. Go to [Miro Marketplace](https://miro.com/marketplace/) and search for "GitHub for Miro". 2. Select the app and click **Connect.** 3. Next, allow permissions for GitHub for Miro by clicking **Allow**. ## Authorizing GitHub for Miro 1. Open a Miro board in your team space. At the toolbar menu, search for "GitHub for Miro" and click on the icon. 2. On the consent form, Check **Yes, I understand and agree** to both options and click **Continue**. 3. Finally, select the GitHub account you'd like to connect to and click **Save changes**. That's it! The GitHub connection is now authorized. ## Importing GitHub issues 1. Click on the GitHub for Miro icon on the toolbar. 2. Open the **Import** tab and click on the **+Import GitHub issues**button. 3. Select the repository and then the issues you'd like to import, and click the **Import**button. 4. The GitHub issues will now appear as Miro app cards. 5. You can expand the app card to view or edit the issue's details. Once you've edited the issue, click **Update issue on GitHub** or click **Back** to return to the Miro board. ![GFM View issue 20240830.jpg](https://apps-docs.servicerocket.com/__attachments/a_111338883c870ee72454275d1ab2af76499d8cd6dc54b17fd9aa1b627ef1831a/GFM%20View%20issue%2020240830.jpg?cb=e96476f1ce51371d75e6f26e1dc523c3) ## Creating GitHub issues 1. Click on the GitHub for Miro icon on the toolbar. 2. Open the **Create**tab. 3. Fill out the form with the relevant information: 1. **Repository -** The repository to house this issue. ![info](/__attachments/a_9c0a0e56e62eac722da8d0773912b85bdfa7b6c4d29f062d4af46b6eb4ebd696/atlassian-info?cb=feab5cd71111204d6b52545f3027dd0c) The repositories listed in the dropdown menu will be associated with the default GitHub organization you've chosen when configuring the app. 2. **Issue title -**The title of the issue. 3. **Assignees -**The users you want to assign the issue to. 4. **Labels -**The issue's associated labels. 5. **Milestone -**The issue's current milestone. 6. **Description -**What the issue is about. 4. Once you've completed the form, click **Create issue**. 5. An app card will be created in Miro and a corresponding issue will be created in GitHub. ## Converting Miro sticky notes into GitHub issues 1. Create a sticky note on your Miro board and select it. 2. Click on the GitHub for Miro icon from the toolbar and then click on the **Convert** tab. 3. If you have multiple repositories connected, select one where the issue will be created. 4. Fill out the form with the relevant information: 1. **Repository -** The repository you want to push this Miro card to. ![info](/__attachments/a_9c0a0e56e62eac722da8d0773912b85bdfa7b6c4d29f062d4af46b6eb4ebd696/atlassian-info?cb=feab5cd71111204d6b52545f3027dd0c) The repositories listed in the dropdown menu will be associated with the default GitHub organization you've chosen when configuring the app. 2. **Issue title -**The text from the Miro app card will be automatically included here. 3. **Assignees -**The users you want to assign the issue to. 4. **Labels -**The issue's associated labels. 5. **Milestone -**The issue's current milestone. 6. **Description -**What the issue is about. 5. Click **Convert issue to GitHub** once you've completed the form. 6. The sticky note will be converted into an app card and a GitHub issue will be created in GitHub. 7. You can visit the related GitHub issue by clicking on the link in the detailed view of the app card. To see more detailed information on the Miro app card, click the expand icon on the top right of the card. You can also convert multiple issues by selecting multiple sticky notes at once and clicking on the **Convert**tab. However, the app cards and GitHub issues created will share the same information that you've filled out in the form in Step 3 and 4. ## Security statement ServiceRocket is committed to the protection and security of our customers' information. Learn more about GitHub for Miro's security practices in our [security statement](https://apps-docs.servicerocket.com/mg/security-statement.md). ## Knowledge base Have questions? Check out our [knowledge base](https://apps-docs.servicerocket.com/mg/faq.md) for quick answers and helpful tips! --- language: "en" --- # Backlog planning ## Using the template 1. Search for the "Backlog Planning with GitHub" template in [Miroverse](https://miro.com/miroverse/) and click **Use template**. 2. Choose your team and the Miro board will open with the template's content loaded. For more information on using templates, please read Miro's [templates guide](https://help.miro.com/hc/en-us/articles/360017572134-Templates#h_01FJEYFB7WSNGG9KMBSBGKQR00). ## What is backlog planning? **The backlog** is a list of all work items (features, bugs, tasks) that need to be done for a product. **Refinement** involves breaking down large items into smaller, more manageable tasks and estimating their effort. 💡 Connect GitHub and Miro effortlessly. Import or create [Github issues](https://github.com/features/issues), or turn Miro stickies into GitHub tasks for smoother, smarter collaboration! ## Overview You can use this template to streamline backlog planning by integrating Miro with GitHub, turning brainstorming ideas into actionable tasks, categorizing them by priority, and syncing updates in real-time ---all without the need to switch platforms ### Brainstorm ideas * Use sticky notes on your Miro board to jot down any ideas or problems that need to be addressed. * Utilize dot voting or polling features to gauge team consensus on which items should be prioritized. * Drag relevant ideas from brainstorming sessions into your product roadmap for a clearer picture of what's next. ### Create and prioritize tasks * Use the GitHub for Miro app to instantly turn sticky notes from brainstorming sessions into GitHub issues or Miro cards for your backlog. * Drag issues from your product roadmap and categorize them based on urgency and importance, deciding whether to address them now or in future sprints. ### Sync real-time with Github * Break down larger items into smaller, more manageable tasks and estimate their effort for more effective backlog management. * Sync your Miro board with GitHub issues, ensuring that your tasks are always up-to-date and aligned across platforms. * Edit descriptions, milestones, and other fields within Miro to keep your tasks accurate. ## Who should be involved? Backlog planning is typically done by a team of product managers, scrum masters, and development teams rather than a single person. This ensures that all relevant perspectives are considered and that the plan is aligned with the overall product development strategy. ### Product managers Responsible for defining the product vision, strategy, and roadmap. ### Development teams Development teams can contribute to the backlog refinement, estimate tasks and provide technical feedback. ### Scrum masters Facilitate backlog refinement sessions and ensure the team has a clear understanding of upcoming work. ## Why use this template? Through effective backlog planning, your team should streamline task management, ensure alignment with strategic priorities, and tailor your workflow to optimize efficiency and collaboration. **Streamlined Task Management:** * Efficient backlog planning helps organize and manage all work items, from features to bugs, ensuring nothing is overlooked. **Improved Prioritization:** * By categorizing tasks based on urgency and importance, your team can focus on high-priority items that align with strategic goals. **Seamless Integration with GitHub:** * Syncing your Miro board with GitHub issues eliminates redundant work and keeps all stakeholders up-to-date with real-time status updates. **Enhanced Efficiency:** * Using a consolidated board for managing issues and planning sprints saves time by reducing context-switching and integrating all necessary information in one place. ## Step 1: Brainstorming Brainstorming is a crucial step in tackling complex issues like enhancing user profile customization, refining the bug reporting process, or optimizing payment gateway integrations. It allows the team to generate innovative ideas collaboratively, helping break down large tasks into manageable actions. For instance, when considering ways to improve the onboarding flow, brainstorming sessions can reveal fresh perspectives on what first-time users find intuitive or challenging. Similarly, exploring ideas for implementing survey functionality within transactions can inspire unique ways to gather user feedback. By setting aside time to brainstorm each of these issues, teams can evaluate multiple solutions, outline potential challenges, and refine approaches before translating ideas into structured backlog items or GitHub-ready tasks. This collaborative process fuels a shared understanding and sets a clear direction for effective problem-solving. The video below has the steps showing this. [ConvertStickyToIssue.mp4](https://apps-docs.servicerocket.com/__attachments/a_9a77549f697153bb81b83e340597cc496ae476791f3ec79d05be1637cc05a729/ConvertStickyToIssue.mp4.md?cb=e4a55670456dbe510b31ab5ec6bb089f) ## Step 2: Backlog definition and sprint movement To manage our tasks effectively, we start by creating each issue in the backlog column of our Miro board. This allows us to capture high-priority items, such as fixing critical bugs, implementing user profile customization, integrating a payment gateway, and improving UX ability, in one central location for easy reference. By adding these issues to the backlog first, we can prioritize and discuss their requirements before assigning them to a specific sprint. Once each issue has been reviewed and scoped, it's either moved to the "This Sprint" column for immediate attention or assigned to the "Next Sprint" column if it's a future priority. This organized flow from backlog to sprint columns ensures our team remains focused on immediate tasks while maintaining visibility into upcoming work. ![image-20241028-211758.png](https://apps-docs.servicerocket.com/__attachments/a_f3108c8303de4df346a07b8f532d04fd9e58205fec129c866838477809bbe588/image-20241028-211758.png?cb=06638461cd75b1c885dac48c096a72cd) --- language: "en" --- # Can non-administrators install this app? Miro users on any plan can add Connector for Github and Miro to their team. However, users on Miro's Business or Enterprise plans can restrict non-admin users from installing apps. For more information, read Miro's documentation on documentation on [app management](https://help.miro.com/hc/en-us/articles/4404659741458). --- language: "en" --- # Knowledge base You have issues, we have answers. Before contacting us for support, consult our knowledge base which compiles frequently asked questions and solutions to more complex problems. * [Who can install GitHub for Miro?](https://apps-docs.servicerocket.com/mg/who-can-install-github-for-miro.md) * [Can non-administrators install this app?](https://apps-docs.servicerocket.com/mg/can-non-administrators-install-this-app.md) * [How do we restrict users from installing apps on Miro?](https://apps-docs.servicerocket.com/mg/how-do-we-restrict-users-from-installing-apps-on-m.md) * [What happens when I run out of boards on my current plan?](https://apps-docs.servicerocket.com/mg/what-happens-when-i-run-out-of-boards-on-my-curren.md) * [Why are my HTML tags missing from the app card title?](https://apps-docs.servicerocket.com/mg/why-are-my-html-tags-missing-from-the-app-card-tit.md) * [Why can't I connect GitHub for Miro to my GitHub account?](https://apps-docs.servicerocket.com/mg/why-can-t-i-connect-github-for-miro-to-my-github-a.md) --- language: "en" --- # How do we restrict users from installing apps on Miro? Administrators on Miro's Business or Enterprise plans can restrict non-admin users from installing apps. For detailed instructions, refer to Miro's documentation on [app management](https://help.miro.com/hc/en-us/articles/4404659741458). --- language: "en" --- # Product roadmapping with GitHub ## Using the template 1. Search for the "Product Roadmapping with GitHub" template in [Miroverse](https://miro.com/miroverse/) and click **Use template**. 2. Choose your team and the Miro board will open with the template's content loaded. For more information on using templates, please read Miro's [templates guide](https://help.miro.com/hc/en-us/articles/360017572134-Templates#h_01FJEYFB7WSNGG9KMBSBGKQR00). ## What is a product roadmap? **A product roadmap is a**visual representation of a product's journey over time. It helps align teams, prioritize features, and ensure that development efforts are focused on the most impactful goals 💡 Connect GitHub and Miro effortlessly. Import or create [Github issues](https://github.com/features/issues), or turn Miro stickies into GitHub tasks for smoother, smarter collaboration! ## Overview You can use this template to turn your sticky notes into actionable roadmap tasks in a few simple steps: convert notes to cards, sync details with GitHub, and align your team on future plans, backlogs, and sprints. ### Plan your roadmap * Turn your sticky notes into cards and start planning what your future roadmap will look like * Add any additional information required in the description ### Create actionable items * Make this even faster by using the [GitHub for Miro](https://miro.com/marketplace/github-for-miro/) app * Instantly convert your sticky notes to app cards * Update description, milestones and other fields to have it sync with GitHub * Keep your engineers, product managers, and stakeholders on the same page ### Get aligned * This is just the start! * Now that you have your roadmap, work with your teams to plan the backlog, future work, and sprint plan. * Check out our ++Backlog planning++ template and ++Sprint planning++ template. ## Who should be involved? Roadmap planning is typically done by a team of product managers, product owners, and stakeholders rather than a single person. This ensures that all relevant perspectives are considered and that the plan is aligned with the overall product vision and strategy. ### Product managers Responsible for defining the product vision, strategy, and roadmap. ### Product owners Manage the product backlog, prioritize features, and ensure alignment with the product vision. ### Executives/stakeholders A product roadmap is an excellent place for executives and stakeholders to get a high-level overview of timelines \& prioritizations. ## Why use this template? Through collaborative roadmap planning, your team should align on the product vision and priorities and tailor the roadmap to meet strategic goals accordingly. **Alignment on Product Vision:** * Roadmap planning helps ensure that all team members and stakeholders are aligned on the product vision, providing a unified direction for future development. **Effective Prioritization:** * By turning ideas into actionable cards and prioritizing features, your team can focus on the most impactful tasks that align with strategic goals. **Seamless Integration with GitHub:** * Utilizing the GitHub for Miro app allows for real-time synchronization of tasks, keeping engineers, product managers, and stakeholders on the same page without duplicating efforts. **Strategic Planning for Future Work:** * With a clear roadmap in place, your team can efficiently plan the backlog, future work, and sprints, ensuring that all upcoming tasks are in line with the overall product strategy. ## Step 1: Determine key goals What are some of your goals or epics for this year? Narrow it down to some key objectives. You can see an example at the diagram below: ![image-20241028-190725.png](https://apps-docs.servicerocket.com/__attachments/a_a8129aa87150c7a4f5818ab94bdcfbcc00c40674e0845738ce6c1fc856ee5043/image-20241028-190725.png?cb=30baec0271134a0faee1a425bfa78e5a) ## Step 2: Determine some objective breakdowns You can achieve the goal of increasing active user engagement and retention rates by breaking down your goals into actionable tasks. Here, we show you how to create objectives for the first goal of **user growth and retention**. In the example below, we connect to a GitHub repository and create issues of the 5 planned objectives. You can also see how interaction can be done at GitHub using comments. [ConnectGithubCreateIssues.mp4](https://apps-docs.servicerocket.com/__attachments/a_2dc899e37756b92a1b73ff0b2903a79bf29a23b6c780e5bb2ab25cfbdac11577/ConnectGithubCreateIssues.mp4.md?cb=9b877162861e21d3943fcffcb44ba2c7) ## Step 3: Product roadmap planning Start by transforming your sticky notes into individual cards, organizing them as actionable items in your roadmap. Add relevant details for each card in the description to ensure everyone understands the context and requirements. Once the cards are set up, begin adding them to the roadmap table on Miro, aligning each one within the quarterly timeline. This visual arrangement helps outline priorities and ensures a clear view of what's planned for each quarter. As you populate the roadmap, categorize each card based on the type of task (e.g., feature development, UX improvements, bug fixes) and specify dependencies or blockers where applicable. By structuring the roadmap this way, you'll create a cohesive plan that keeps the team aligned and focused on quarterly goals. Here's an example of how the team has planned to complete the key objectives shown previously. ![image-20241028-194501.png](https://apps-docs.servicerocket.com/__attachments/a_c4cf659b66695370b8bee15de01c6d1cb686ba59b31f3ab1b5d09ddf5afcec2e/image-20241028-194501.png?cb=b2b82fab1b0eb2d4a7a2f53547fc32bd) --- language: "en" --- # Release notes ## 6 January 2025 ### Bug fixes * Fixed issue where the card titles could potentially exceed the 256-character limit. ## 3 October 2024 ### Improvements * Improved error messaging when third-party cookies are blocked. ## 19 September 2024 ### New features * A button to close the new tab when being redirected after authorizing with Miro and GitHub #### Bug fixes * Fixed the limitation on the number of GitHub Labels, Milestones and Projects that get displayed ## 21 August 2024 ### New features * Imported issues are now being placed at the user's current screen location, making them easier to find * A 'Back' button has been added to the issue update page, allowing users to easily return to the landing page. #### Improvements * Improved the visibility of description fields in issue creation and update form. #### Bug fixes * Added a search assignee feature and fixed the issue of incomplete assignee lists. * Fixed the issue of selecting multiple app cards when clicking on the expand icon. ## 15 August 2024 ### New features * Issues can now be created without selecting sticky notes. There is now a new tab to create issues. * Issue creation and update forms now save your progress in case you click away or click between sticky notes or app cards. #### Improvements * Improved overall app card syncing reliability. * Improved the performance of syncing when there are a lot of app cards on the board. * Improved repository fetching load times. ## 5 August 2024 ### Introducing GitHub for Miro's pricing plans We are thrilled to introduce GitHub for Miro's new tiered plans. You can now choose the right plan based on the number of boards that you need. Subscribe to any of these plans at any time through the app settings. For more information, please visit our [pricing page](https://www.servicerocket.com/miro/miro-apps/github-for-miro#pricing). If you're not sure which plan will meet your requirements, [reach out to our team](https://www.servicerocket.com/miro/contact-us) so that we can help you identify the right plan. ## 1 August 2024 ### New features * A banner has been added to inform users about GitHub for Miro's upcoming pricing plans. #### Improvements * The 'Contact us' button now takes users straight to our Miro apps support portal. ## 25 July 2024 ### Improvements * Improved scope permissioning between Miro teams. * Improved board sync reliability. ## 18 July 2024 ### Bug fixes * Removed automatic coloring of app cards based on the issue's status to respect users' custom color schemes on their boards. ## 10 July 2024 ### Bug fixes * Fixed issue with text input data in create issue form and update issue form. ## 8 July 2024 ### Bug fixes * Fixed create issue form UI. ## 4 July 2024 ### Improvements * Added improved error messaging for Miro OAuth flow. * Added loading messages to UI. * Improved initial app load time. #### Bug fixes * Fixed bug related to token revocation. ## 31 May 2024 ### New features * Initial app release. --- language: "en" --- # Security statement ## Overview This page explains how we prioritize and manage your data security and privacy, including our protocols for data transfer, access, and compliance with industry standards. For more details on ServiceRocket's cloud products, read our [terms of service](https://www.servicerocket.com/legaldocs/servicerocket-cloud-products-terms-of-service). ## Data We prioritize your data security and privacy. Here's how we handle your information: * GitHub for Miro facilitates the transfer and synchronization of data between GitHub and Miro using intermediary servers owned by ServiceRocket at [https://github-miro.servicerocket.io](https://github-miro.servicerocket.io/) and [https://marketplace.servicerocket.io](https://marketplace.servicerocket.io/). They are securely hosted on AWS infrastructure. * The data you pull from GitHub into Miro is the only data that is accessed (data is processed but not written to disk) and transferred. * The data is not encrypted, but it uses HTTPS and JWT as user validation. ## Access * GitHub for Miro uses OAuth 2.0 as the authorization framework to allow access to resources on GitHub securely. * We securely authenticate connections to GitHub and Miro. * We never store any GitHub or Miro data on our servers except for authentication credentials. * We track users' activities to enhance their experience. ## Privacy To get the most recent information on the security, privacy, and compliance of our products and services, review [ServiceRocket Legal Documents](https://www.servicerocket.com/legal/documents). Click the links below to learn more: * [GDPR](https://www.servicerocket.com/legaldocs/gdpr-frequently-asked-questions) * [Privacy Policy](https://www.servicerocket.com/legaldocs/privacy-policy) * [Data Processing Addendum](https://www.servicerocket.com/legaldocs/data-processing-addendum-for-servicerocket-apps) Additionally, we are SOC2 Type 2 compliant. You may request a copy of our SOC2 Report by contacting us at [support@servicerocket.com](mailto:support@servicerocket.com). --- language: "en" --- # Sprint Planning with GitHub ## Using the template 1. Search for the "Sprint Planning with GitHub" template in [Miroverse](https://miro.com/miroverse/) and click **Use template**. 2. Choose your team and the Miro board will open with the template's content loaded. For more information on using templates, please read Miro's [templates guide](https://help.miro.com/hc/en-us/articles/360017572134-Templates#h_01FJEYFB7WSNGG9KMBSBGKQR00). ## What is sprint planning? **Sprint planning is a**detailed, short-term planning session where teams focus on the specific goals and tasks for the upcoming sprint (a fixed-length iteration). Sprint planning involves breaking down larger features into smaller, manageable tasks and estimating the effort required to complete them. 💡 Connect GitHub and Miro effortlessly. Import or create [Github issues](https://github.com/features/issues), or turn Miro stickies into GitHub tasks for smoother, smarter collaboration! ## Overview You can use this template to break down your sprint planning into clear steps: bringing tasks into Miro, assigning them, syncing with GitHub for real-time updates, tracking progress, and reviewing completed work for continuous improvement. ### Plan your sprint * Bring your current sprint tasks into your Miro board to get started * Assign tasks to team members directly on the cards. These assignments can be [++synced with GitHub++](https://miro.com/marketplace/github-for-miro/) for real-time visibility. * Use Miro's built-in estimation tool to assign story points and prioritize tasks based on complexity and value. * Move cards through your board's columns (e.g., To Do, In Progress, Done) to track progress and ensure timely completion. ### Syncing with GitHub * Connect development teams with the bigger picture. * Keeping your issues on Miro with the latest updated status means all your Miro users can have a big picture view of your project. * Using [GitHub for Miro](https://miro.com/marketplace/github-for-miro/) allows you to sync Miro with GitHub to make this possible. ### Review \& retrospect * After the week wraps up, take a look at the issues you finished. Make sure they're all done right and jot down any things you need to do next. * It's also a good idea to have a quick chat with your team to talk about what went well, what didn't, and how we can do things better in the future. ## Who should be involved? Sprint planning is typically done by a team of product managers, development teams, and scrum masters rather than a single person. This ensures that all relevant perspectives are considered and that the plan is aligned with the overall product strategy. ### Product managers Responsible for defining the product vision, strategy, and roadmap. ### Development teams Development teams can contribute to the backlog refinement, estimate tasks and provide technical feedback. ### Scrum masters Facilitate backlog refinement sessions and ensure the team has a clear understanding of upcoming work. ## Why use this template? Through collaborative sprint planning, your team should gain a clear understanding of task priorities and tailor workload distribution accordingly. **Enhanced Task Visibility** * Bringing sprint tasks into your Miro board provides a clear view of all tasks and their current status, helping the team stay aligned and focused. **Efficient Workload Distribution:** * Assigning tasks directly on Miro cards and syncing with GitHub ensures that everyone knows their responsibilities and can adjust as needed for optimal productivity. **Accurate Task Estimation:** * Using Miro's estimation tools allows the team to assign story points, prioritize tasks based on complexity and value, and plan sprints more effectively. **Improved Progress Tracking:** * Moving tasks through Miro's columns (To Do, In Progress, Done) enables the team to monitor progress in real-time, ensuring timely completion and easy identification of any bottlenecks. ## Step 1: Create a quick highlight of your resources and tools This Miro board template enables the sprint manager and team members to assess overall resources and identify key focus areas at the start of each sprint planning session. Using this template, users can input specific week numbers, sprint dates, and goals, creating a clear and organized record for each sprint. This setup not only supports efficient resource planning but also enhances visibility and accountability across sprints. Image below shows an example, of this resource planning and relevant tools overview. ![image-20241028-201921.png](https://apps-docs.servicerocket.com/__attachments/a_9a495b11534d5747d8c48a64a0c064e34247357058cd4f8437cb3a7783be52b4/image-20241028-201921.png?cb=2e9a1d309e25ff71def8efa513f902ff) ## Step 2: Sprint planning tasks setup Next, bring your current sprint tasks into your Miro board to kickstart the process. Assign these tasks to team members directly on each card, ensuring clarity on responsibilities. With Miro's integration capabilities, task assignments sync seamlessly with GitHub, providing real-time visibility across both platforms. Utilize Miro's estimation tool to add story points, which helps prioritize tasks according to their complexity and overall value. As your team progresses, move each task through the board's workflow columns (e.g., To Do, In Progress, Done) to monitor status and ensure smooth, timely completion. This workflow provides a clear view of each sprint's progress, while the GitHub sync allows all Miro users to stay connected with the project's latest updates. Integrating GitHub with Miro not only bridges communication between development teams but also ensures a cohesive, big-picture perspective that keeps everyone aligned on shared project goals. ![image-20241028-202455.png](https://apps-docs.servicerocket.com/__attachments/a_7e73152bfb32846f67adefc9912b259ae720108e6721a63734cc38640454c45b/image-20241028-202455.png?cb=7cf38d35d0c6bead2fce0e98b59d76d0) ## Step 3: Retrospective After each sprint wraps up, reviewing completed issues is essential. Confirm that tasks are fully finished and meet quality standards, noting anything that needs further action. Team discussions will highlight what went well, where challenges emerged, and how to refine processes for future sprints. You can see an example below. ![image-20241028-203634.png](https://apps-docs.servicerocket.com/__attachments/a_a869884cb4319c61ef36a4501e2e0ce9729566a308e0d3702bf3785df3e58f2a/image-20241028-203634.png?cb=f126064463d05bb9c71d73e21db2a729) --- language: "en" --- # Use cases This section provides step-by-step guides on Salesforce for Miro features and functions. * [Backlog planning](https://apps-docs.servicerocket.com/mg/backlog-planning.md) * [Product roadmapping with GitHub](https://apps-docs.servicerocket.com/mg/product-roadmapping-with-github.md) * [Sprint Planning with GitHub](https://apps-docs.servicerocket.com/mg/sprint-planning-with-github.md) --- language: "en" --- # What happens when I run out of boards on my current plan? When you reach the maximum number of boards in your current plan, you can't activate new boards. To continue creating and managing more boards, upgrade to a higher plan. ## Upgrading your plan To upgrade your plan, follow these steps: 1. Click on the GitHub for Miro logo in the Miro toolbar. 2. Click on the gear icon (**⚙** ) \> **Settings** \> **Subscriptions**. 3. If you're on the Lite plan, click **Upgrade plan**. You will be directed to the pricing page to subscribe to a new plan. 4. If you're on an existing paid subscription, click **Contact us** and our support or licensing team will assist you with the upgrade. Have more questions about the plans and billing? Learn more at the [product page](https://www.servicerocket.com/miro/miro-apps/github-for-miro#pricing). --- language: "en" --- # Who can install GitHub for Miro? Any Miro user, regardless of their plan, can install GitHub for Miro for their team. --- language: "en" --- # Why are my HTML tags missing from the app card title? ## Background I've named the app card's issue title with the italics HTML tag: "New \app card\". After the app card is created, the title only shows "New". The word "app card" is missing. ## Answer When users create Miro app cards, any unsupported HTML tags in the title are automatically stripped. For supported HTML tags, refer to this [Miro documentation](https://engineering.miro.com/docs/websdk-reference-app-card). --- language: "en" --- # Why can't I connect GitHub for Miro to my GitHub account? ## Background When connecting GitHub for Miro to my GitHub account, I get the following error, "Could not find state cookie. If your browser blocks third-party cookies, please enable them to access GitHub for Miro." ![gfm-error.png](https://apps-docs.servicerocket.com/__attachments/a_6cd804bc9668de060ae21c4e4678341c21fa2f56f58239fab8989589e503fb31/gfm-error.png?cb=1ec6835087c22727e681ff80b036263f) ## Answer This solution also works for the "Could not find Miro state cookie" variation of the error message. The error is often caused by browser settings, especially when cookies are blocked. To resolve it, enable cookies in your browser. To learn how to do so for your browser, click on the links below: | **Browser** | **What to do** | |-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | Safari | [Allow all cookies](https://support.apple.com/en-my/guide/safari/ibrw850f6c51/mac#:~:text=In%20the%20Safari%20app%20on,other%20data%20on%20your%20Mac.) | | Chrome | [Allow third party cookies](https://support.google.com/chrome/answer/95647?hl=en&co=GENIE.Platform%3DDesktop#zippy=%2Callow-or-block-third-party-cookies) | | Edge | [Allow third party cookies](https://support.microsoft.com/en-us/windows/manage-cookies-in-microsoft-edge-view-allow-block-delete-and-use-168dab11-0753-043d-7c16-ede5947fc64d) | | Firefox | [Allow third party cookies](https://support.mozilla.org/en-US/kb/third-party-cookies-firefox-tracking-protection) | After adjusting these settings, restart your Miro board and try reinstalling GitHub for Miro. --- language: "en" --- # Space Manager for Confluence Visualize, plan, and manage Confluence space structures effortlessly. We'd love to [get your feedback](https://servicerocket.typeform.com/to/Olyjke32) on how to improve your experience with Space Manager for Confluence. * [Overview](https://apps-docs.servicerocket.com/space-manager-for-confluence/key-concepts.md) * [Installation guide](https://apps-docs.servicerocket.com/space-manager-for-confluence/installing-space-manager-for-confluence.md) [Administrator guide](https://apps-docs.servicerocket.com/space-manager-for-confluence/administrator-guide.md) [Knowledge base](https://apps-docs.servicerocket.com/space-manager-for-confluence/knowledge-base.md) * [Release notes](https://apps-docs.servicerocket.com/space-manager-for-confluence/release-notes-1.md) --- language: "en" --- # Administrator guide These comprehensive administrator guides document all features intended for administrators of Space Manager for Confluence: * [Viewing and organizing space structures](https://apps-docs.servicerocket.com/space-manager-for-confluence/viewing-and-organizing-space-structures.md) * [Managing pages with built-in actions](https://apps-docs.servicerocket.com/space-manager-for-confluence/managing-pages-with-built-in-actions.md) * [Moving and deleting pages in bulk](https://apps-docs.servicerocket.com/space-manager-for-confluence/moving-and-deleting-pages-in-bulk.md) --- language: "en" --- # Are whiteboard, database, and smart link features compatible with Space Manager for Confluence? Check out these documents for a more comprehensive understanding of the features: * [Create and edit whiteboards](https://support.atlassian.com/confluence-cloud/docs/create-and-edit-whiteboards/) * [Confluence Databases](https://www.atlassian.com/software/confluence/databases) * [Smart Links in Confluence](https://support.atlassian.com/confluence-cloud/docs/insert-links-and-anchors/) ![SMFC-database-smartlink-310124.png](https://apps-docs.servicerocket.com/__attachments/a_18005cc7f726d640b0dc43b0cd63125a291c7239eededa6e1ad503e4b31227fc/SMFC-database-smartlink-310124.png?cb=56caaea9ad114fe5b42381bf9f6fdb3c) Due to Confluence limitations, these features will only be visible in the app when certain conditions are met. The table below outlines those scenarios: | **Parent** | **Child** | **Visibility in Space Manager for Confluence** | |------------|----------------------------------|------------------------------------------------| | Whiteboard | N/A | Not visible | | Whiteboard | Whiteboard, database, smart link | Not visible | | Whiteboard | Page | Visible | | Database | N/A | Not visible | | Database | Whiteboard, database, smart link | Not visible | | Database | Page | Visible | | Smart link | N/A | Not visible | | Smart link | Whiteboard, database, smart link | Not visible | | Smart link | Page | Visible | --- language: "en" --- # Installation guide 1. Log in to [Atlassian admin](https://admin.atlassian.com/). 2. Click on **Products**at the top menu. 3. On the left column menu, scroll down to **Sites and products** and select your site. 4. Next, click on **Connected apps**on the left column menu. 5. Click on the **Discover new apps**button at the top right of the page. 6. You will be brought to the [Atlassian Marketplace](https://marketplace.atlassian.com/). Search for "*Space Manager for Confluence"* and click on the app tile. 7. Click **Try it free**to start installing your app. That's it, you're set! --- language: "en" --- # Overview We'd love to [get your feedback](https://servicerocket.typeform.com/to/Olyjke32) on how to improve your experience with Space Manager for Confluence. Space Manager for Confluence will help you visualize, plan, and manage Confluence space structures effortlessly. ## Key features * Visualize and comprehensively understand your Confluence space through a mind map. * Organize pages, adjust content positioning, and effortlessly structure Confluence spaces using the intuitive drag-and-drop feature. * Add labels and attachments, edit, delete, and create child pages---all in one view. --- language: "en" --- # Knowledge base You have issues, we have answers. Before contacting us for support, consult our knowledge base which compiles frequently asked questions and solutions to more complex problems. * [Are whiteboard, database, and smart link features compatible with Space Manager for Confluence?](https://apps-docs.servicerocket.com/space-manager-for-confluence/are-whiteboard-database-and-smart-link-compatible-.md) --- language: "en" --- # Managing pages with built-in actions Take charge of the pages and unleash the built-in actions without stepping out of the app! ![SMFC-built-in-actions-130524.png](https://apps-docs.servicerocket.com/__attachments/a_1936027739ae49947cba9b19f8d1e14f7c17a5a2a9d3f96c5ec88b7a5c496ef5/SMFC-built-in-actions-130524.png?cb=e27b006338ccfac6f65c928fa2f205ad) ## Creating a child page 1. Select a page on the mind map for which you'd like to create a child page. (A menu will appear from the left side of the screen.) 2. Click on the ellipses (**...** ) \> **Create child page**. 3. Type the title of the page and select **Create**. ## Editing a page 1. Select a page you'd like to edit on the mindmap. (A menu will appear from the left side of the screen.) 2. Click on the ellipses (**...** ) \> **Edit page**. 3. Type the title of the page in the**Title** field and select **Update**. The **+Add label** feature uses the same interface as the **Edit page**function. ## Moving a page 1. Select a page you want to move on the mind map. (A menu will appear from the left side of the screen.) 2. Click on the ellipses (**...** ) \> **Move page**. 3. Locate the parent page to which you'd like to move the page and select the corresponding radio button. Alternatively, you can use the search bar to search for the page. 4. Once the parent page is confirmed, click **Move**. You can only move pages within the existing space. ## Deleting a page 1. Select a page you want to delete on the mind map. (A menu will appear from the left side of the screen.) 2. Click on the ellipses (**...** ) \> **Delete page**. 3. Click **Delete**to confirm your deletion. ## Adding a label 1. Select a page you'd like to add a label to on the mind map. (A menu will appear from the left side of the screen.) 2. Click **+Add label**. 3. Type the name of the label in the field. Then, select **Create**(name of the label). You can add multiple labels in one go. 4. Once done, click **Update**. ## Adding an attachment to a page 1. Select a page you'd like to add an attachment to on the mind map. (A menu will appear from the left side of the screen.) 2. Then, click **+Add attachment**. 3. A new tab will open, loading the [Confluence attachment](https://support.atlassian.com/confluence-cloud/docs/upload-a-file/) page where you can add attachments. You can also leave comments for each uploaded attachment here. --- language: "en" --- # Moving and deleting pages in bulk Use Space Manager for Confluence to move and delete pages in bulk, saving time and organizing your space with ease. 1. Click the drop-down in the top left and navigate to the space of your choice. 2. Hold Shift on your keyboard and select the pages. 4. The **Move** and **Delete** button will appear when you multi-select the pages. 5. If you are moving pages in bulk, perform the following: 1. Click on the **Move**button. 2. Locate the parent page to which you'd like to move the pages and select the corresponding radio button. Alternatively, you can use the search bar to search for the page. 3. Once the parent page is confirmed, click **Move**. You can only move pages within the existing space. 4. If you are deleting pages in bulk, perform the following: 1. Click on the **Delete**button. 2. Click **Delete**again to confirm your deletion. --- language: "en" --- # Release notes ## 22 August 2024 ### Bug fixes * Fixed issues where the bulk action button would not show after selecting another space. ## 20 August 2024 ### Bug fixes * Fixed an issue where shift selection does not work on the initial load without user interaction in the react flow view. ## 19 August 2024 ### Improvement * Updated the bulk operation onboarding text. ## 13 August 2024 ### Improvement * Updated the Get Started page. #### Bug fixes * To restrict the bulk selection on space node. ## 7 August 2024 ### New features * A new entry for the app was added to the space navigation menu. * Added bulk operations onboarding. * Added support for deleting pages in bulk. * Added support for moving pages in bulk. ## 16 July 2024 ### New features * The page tree will be shown only when all pages have been loaded. ## 4 July 2024 ### New features * Revamped space selection UI. * Moved the feedback button into the 'Help' button. * Added the dismiss button for unsupported banners. ## 27 June 2024 ### New features * Added date range dropdown for last updated date. ## 26 June 2024 ### Bug fixes * Fixed issues with page graph not loading for space homepageId null. ## 20 June 2024 ### New features * Implemented support for whiteboard, smartlink \& database content as part of the tree. * Added ability to filter pages in space by last updated date. #### Improvement * Moved the default zoom button to the top of the page graph. ## 13 June 2024 ### Improvement * Updated the Get Started page. #### Bug fixes * Fixed issues with the ellipses menu stuck on the screen. ## 11 June 2024 ### Bug fixes * Fixed issues with the page graph not loading for collaboration and knowledge_base space types. ## 6 June 2024 ### New features * Added unsupported component banner. ## 30 May 2024 ### New features * Page graph rank direction is now structured from left to right and the alignment is now structured up to left ## 9 May 2024 ### New features * Implemented a help button with a link to support and documentation. #### Bug fixes * Fixed broken move page dialog. ## 8 May 2024 ### New features * Improved the page pill feature. --- language: "en" --- # Viewing and organizing space structures ## Viewing space structures 1. At the top navigation bar, click **Apps** \> **Space Manager for Confluence**. The app's main page will open. Alternatively, you can access Space Manager for Confluence from the **Apps** section in the left sidebar of your space. ![SMC-introtemplate2-09082024.png](https://apps-docs.servicerocket.com/__attachments/a_83b032f6fe60d72b6642f03116b28b2436d2c959567c658440a24e9e4e34ba68/SMC-introtemplate2-09082024.png?cb=b3c4faf3f3dd4e298c81bd94ca3863f6) ## Organizing space structures With Space Manager for Confluence, you can rearrange pages, move and place your content, and structure your space by dragging and dropping elements around the page. Drag and drop one page onto another to move the page's location. ![drag-n-drop-smc.gif](https://apps-docs.servicerocket.com/__attachments/a_b01bd75a4311e3d76fe9528c68838ca909e37d137a883d3ce4539f843eca5569/drag-n-drop-smc.gif?cb=ff1ae9faa89ec29d289975a7e88470ce) Yes, it's that simple! --- language: "en" --- # Support & CA Resources Get the help you need * [Getting help](https://apps-docs.servicerocket.com/support/getting-help.md) * [Support Service-level Agreement (SLA)](https://apps-docs.servicerocket.com/support/support-service-level-agreement-sla.md) * [End user license agreement](https://apps-docs.servicerocket.com/support/end-user-license-agreement.md) * [GDPR](https://apps-docs.servicerocket.com/support/gdpr.md) * [Product end of life](https://apps-docs.servicerocket.com/support/product-end-of-life.md) * [List of ServiceRocket products acquired by Appfire (Where is the page I am looking for?)](https://apps-docs.servicerocket.com/support/productsacquired.md) --- language: "en" --- # End user license agreement See --- language: "en" --- # GDPR The privacy and security of personal data are very important to us. We regularly review our systems and processes to address compliance with the GDPR. For more information, visit [GDPR Frequently Asked Questions](https://www.servicerocket.com/legaldocs/gdpr-frequently-asked-questions). --- language: "en" --- # Getting help ## Get in touch Get in touch via our support channels: * For issues with our apps, contact us via the [Support service desk](https://servicerocket-apps.atlassian.net/servicedesk). * For any general information, contact us via . ## Help us help you What to do when contacting us for help. 1. **Complete Description of the Issue**: * Clearly describe the problem you are experiencing. * Mention any error messages or codes displayed. 2. **Steps to Reproduce the Issue**: * List the exact steps you took before encountering the issue. * Include screenshots or screen recordings if possible. 3. **Expected vs. Actual Results**: * Explain what you expected to happen. * Describe what actually happened. 4. **Environment Details**: * Specify the software version you are using. * Include details about your operating system (e.g., Windows 10, macOS Catalina). * Mention the browser and version if it's a web application (e.g., Chrome 91, Firefox 89). 5. **Network Information**: * Provide information about your internet connection (e.g., Wi-Fi, Ethernet). * Mention any VPN or proxy services you are using. 6. **Account Information**: * Provide your account username or email address associated with the software. * Mention any specific roles or permissions you have within the application. 7. **Recent Changes or Updates**: * Note any recent changes you made to your system or the software. * Mention any recent updates or installations. 8. **Frequency and Patterns**: * Indicate how often the issue occurs (e.g., always, sometimes, rarely). * Mention any patterns or specific conditions under which the issue occurs. 9. **Log Files**: * Attach any relevant log files that might help diagnose the issue. * Provide details on where to find these logs if you are unsure. 10. **Error Reports**: * Include any crash reports or diagnostic information generated by the software. 11. **Screenshots and Screen Recordings**: * Provide visual evidence of the issue through screenshots or video recordings. 12. **Temporary Workarounds**: * Mention any temporary solutions or workarounds you have tried. * Explain whether they have partially resolved the issue or not. 13. **Impact on Work**: * Describe how the issue is affecting your work or productivity. * Indicate the urgency of the issue based on its impact. By providing these details, you give the support team a comprehensive view of the issue, which helps them diagnose and resolve it more efficiently. --- language: "en" --- # Product end of life Stay informed with up-to-date information about our product lifecycle statuses and scheduled shelf dates. We will keep updating this page to ensure you have the latest details. ## 31st December 2024 ### Retirement of Attendance Taker for Classroom Please note that this app will be retired from Google Workplace Marketplace and Zoom Marketplace on 31st December 2024, as we focus on enhancing our core product suite. Existing subscribers will have access to the app until their current subscription expires. We thank all current users for their support. ## 15th December 2024 ### Retirement of Security and Encryption for Coda Security and Encryption for Coda will be discontinued on 15th December 2024. After this date, the pack will no longer be accessible or functional within Coda docs. This decision is part of our commitment to focus on enhancing our core product offerings to better meet our users' evolving needs. We understand this may impact your workflows, and we're here to help with the transition. ### Retirement of HR Surveys for JSM Please note that HR Surveys for JSM will be discontinued as of 15th December 2024. This means the app will be removed from the Atlassian Marketplace and will no longer function after this date. Thank you for your understanding and continued support. ## 1 November 2024 ### Retirement of Whiteboards.io Importer for Miro Please note that this app will be retired on 1st November 2024. The app will no longer function after this date. We thank all current users for their support. ## 6 August 2024 ### End of Beta for Automatic Issue Links for Jira Please note that Automatic Issue Links for Jira will be discontinued as of 30th August 2024 after which the app will be removed from the Atlassian Marketplace and no longer function. We thank you all the current users for your understanding and support. ## 10 May 2024 ### End of Beta for Connector for Venafi and JSM Please note that the Beta for this app will conclude on 31 May 2024, after which the app will be removed from the Atlassian Marketplace and no longer function. We thank all current users for their support. ### End of Beta for Sentiment Analysis for JSM Please note that the Beta for this app will conclude on 31 May 2024, after which the app will be removed from the Atlassian Marketplace and no longer function. We thank all current users for their support. ### End of Beta for Support Dashboards and Reports for JSM Please note that the Beta for this app will conclude on 31 May 2024, after which the app will be removed from the Atlassian Marketplace and no longer function. We thank all current users for their support. --- language: "en" --- # List of ServiceRocket products acquired by Appfire (Where is the page I am looking for?) On January 11, 2023, Appfire acquired 20+ apps from ServiceRocket. For more details, visit [Appfire's news page](https://appfire.com/resource/appfire-news/were-bringing-servicerockets-best-selling-suite-of-apps-to-our-portfolio/). Our collaboration involves seamlessly transitioning all impacted products, including documentation, to [Appfire's new home](https://appfire.atlassian.net/wiki/spaces/APPFIRE/pages/518848762/Appfire+Documentation+-+All+Apps?mode=global). Identify affected products from the list below, and feel free to contact [Appfire support](https://appfire.com/contact)for more information. | ![warning](https://apps-docs.servicerocket.com/__attachments/a_1811cfa19d10f634adf6d1e457f9f629c9d604e47d0d107a2332b3db9fb89000/atlassian-warning?cb=14432459925d605e05cae2605cdfe666) If you navigated to this page through an in app link, you should upgrade to the ++**latest version**++, which have the updated content links. | |---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| |-------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [Classic Connector for Salesforce \& Jira (Server, DC)](https://appfire.atlassian.net/wiki/spaces/CFSJ) | | Composition Tabs for Confluence ([Cloud](https://appfire.atlassian.net/wiki/spaces/CTFCC), [Server, DC](https://appfire.atlassian.net/wiki/spaces/CTFCSM)) | | [Connector for Google Drive \& Confluence (Server, DC)](https://appfire.atlassian.net/wiki/spaces/CFGDCS) | | [Connector for Salesforce \& Confluence Cloud (Cloud)](https://appfire.atlassian.net/wiki/spaces/CCSFCONFC) | | [Connector for Salesforce \& Confluence Server and Data Center (Server, DC)](https://appfire.atlassian.net/wiki/spaces/CFSCS) | | [Connector for Salesforce \& Jira (Cloud, Server, DC)](https://appfire.atlassian.net/wiki/spaces/CSFJIRA) | | [Connector for Workplace and Jira (Cloud)](https://appfire.atlassian.net/wiki/spaces/WJCC) | | [Contact Views for Salesforce \& JSM (Cloud)](https://appfire.atlassian.net/wiki/spaces/SFJSDC) | | [Google Calendar for Confluence (Server)](https://appfire.atlassian.net/wiki/spaces/GCS) | | Google Data Studio for Jira (PREVIEW) (Cloud) | | Linking for Confluence ([Cloud](https://appfire.atlassian.net/wiki/spaces/LINC), [Server, DC](https://appfire.atlassian.net/wiki/spaces/LINS)) | | Page Approval for Confluence ([Cloud](https://appfire.atlassian.net/wiki/spaces/PAFC), [Server, DC](https://appfire.atlassian.net/wiki/spaces/PAFS)) | | [Pathways Lite for Confluence (Server)](https://appfire.atlassian.net/wiki/spaces/PATHS) | | [Pathways Pro for Confluence (Server)](https://appfire.atlassian.net/wiki/spaces/PATHS) | | [Publisher for Confluence Cloud to Salesforce (Cloud)](https://appfire.atlassian.net/wiki/spaces/SFPUBC) | | Redirection for Confluence ([Cloud](https://appfire.atlassian.net/wiki/spaces/REDC), [Server](https://appfire.atlassian.net/wiki/spaces/REDS)) | | Reporting for Confluence ([Cloud](https://appfire.atlassian.net/wiki/spaces/RFC), [Server, DC](https://appfire.atlassian.net/wiki/spaces/REPS)) | | Scaffolding Forms \& Templates for Confluence ([Cloud](https://appfire.atlassian.net/wiki/spaces/SCAFC), [Server, DC](https://appfire.atlassian.net/wiki/spaces/SCAFS)) | | Security \& Encryption for Confluence ([Cloud](https://appfire.atlassian.net/wiki/spaces/SECC), [Server, DC](https://appfire.atlassian.net/wiki/spaces/SECS)) | | [Tracking Access for Confluence (Server)](https://appfire.atlassian.net/wiki/spaces/TRACS/overview) | | Visibility for Confluence ([Cloud](https://appfire.atlassian.net/wiki/spaces/VISC), [Server, DC](https://appfire.atlassian.net/wiki/spaces/VISS)) | --- language: "en" --- # Support Service-level Agreement (SLA) ## SLA Response Times ### Commercial Apps Commercial app users with a valid app license in maintenance will receive a response to a support request within **12 hours during normal business hours**. #### Free Apps Free app users should expect a response to a support request within **24 hours during normal business hours.** ### Business Hours **24 hours, Monday - Friday** EDT ### Creating a Support Request The following support channel follow our SLA Response Time policies: * Create a support request at ServiceRocket [Support Service Desk](https://servicerocket-apps.atlassian.net/servicedesk/) (Registration is required) Additional channels outside our standard SLA policies: * Post a new topic at [Atlassian Community](https://community.atlassian.com/t5/forums/searchpage/tab/message?advanced=false&allow_punctuation=false&q=servicerocket) ### Standard Support Includes: * Help with licensing matters * Help with issues during installation * Help troubleshooting problems * Help identifying workarounds * Help with standard use cases ### Standard Support Exclusions: Given the nature of some of our products, some users may need extra help beyond what we can consider standard support. Examples of items excluded: * Install, configure, upgrade and administer ServiceRocket apps on the customer's behalf * Product training * Implementing and integrating ServiceRocket apps with other third-party apps * Migrating data from third-party apps to our apps * Troubleshoot customize APEX triggers * Creating or troubleshooting user-macro * Weekend standby or assistance needed over the weekend to help with app upgrades or migration. Talk to us if you need this service. These fall under a different offering. Please proceed to get a quote from our [managed services team](https://atlassian.servicerocket.com/solutions/managed-services). ## Requesting for Escalation If you are not getting enough attention through support requests (due to critical impacts on business or lack of timely response), you may request for an escalation by leaving a comment in the support request or use the "Escalate" option in the support ticket. ## Service Availability Ongoing status, announcements and incidents can be tracked at . --- language: "en" --- # Surveys for Jira Service Management **End-of-Life Notice:**Surveys for Jira Service Management will be discontinued on October 30, 2026. After this date, the app will be removed from the Atlassian Marketplace and will cease to function. To ensure a smooth transition, please export your survey data and explore alternative solutions before the sunset date. You can retrieve your survey responses [via API](https://apps-docs.servicerocket.com/surveys/developer-guide) or export from CES, CSAT and NPS reports via the [Export All Scales feature](https://apps-docs.servicerocket.com/surveys/how-do-we-use-the-export-all-scales-function). Measure and improve your ITSM workflow with customizable user satisfaction surveys and review process tools. * [Overview](https://apps-docs.servicerocket.com/surveys/benefits-key-features-and-use-cases.md) * [Quick start for JSM Survey Administrators](https://apps-docs.servicerocket.com/surveys/quick-start-for-jsm-survey-administrators.md) * [Installation guide](https://apps-docs.servicerocket.com/surveys/installation-guide.md) [Administrator guide](https://apps-docs.servicerocket.com/surveys/administrator-guide.md) [User guide](https://apps-docs.servicerocket.com/surveys/user-guide.md) * [Developer guide](https://apps-docs.servicerocket.com/surveys/developer-guide.md) * [Release notes](https://apps-docs.servicerocket.com/surveys/release-notes.md) [Knowledge base](https://apps-docs.servicerocket.com/surveys/knowledge-base.md) --- language: "en" --- # Administrator guide **End-of-Life Notice:**Surveys for Jira Service Management will be discontinued on October 30, 2026. After this date, the app will be removed from the Atlassian Marketplace and will cease to function. To ensure a smooth transition, please export your survey data and explore alternative solutions before the sunset date. You can retrieve your survey responses [via API](https://apps-docs.servicerocket.com/surveys/developer-guide) or export from CES, CSAT and NPS reports via the [Export All Scales feature](https://apps-docs.servicerocket.com/surveys/how-do-we-use-the-export-all-scales-function). These comprehensive administrator guides, document all features intended for administrators of Surveys for Jira Service Management: * [Setting Surveys for JSM as the default feedback tool](https://apps-docs.servicerocket.com/surveys/setting-surveys-for-jsm-as-the-default-feedback-to.md) * [Configuring issue and project level permission](https://apps-docs.servicerocket.com/surveys/configuring-issue-and-project-level-permission.md) * [Building the survey's questions and language](https://apps-docs.servicerocket.com/surveys/building-the-survey-s-questions-and-language.md) * [Customizing the look and feel of your survey](https://apps-docs.servicerocket.com/surveys/customizing-the-look-and-feel-of-your-survey.md) [Set up in-app automation triggers, goal evaluators, and custom fields](https://apps-docs.servicerocket.com/surveys/modifying-the-survey-configuration.md) * [Configuring email settings](https://apps-docs.servicerocket.com/surveys/configuring-email-settings.md) * [Alternative automation for Surveys for JSM](https://apps-docs.servicerocket.com/surveys/setting-up-the-survey-automation.md) * [Configuring SMTP server properties](https://apps-docs.servicerocket.com/surveys/configuring-smtp-server-properties.md) * [Setting permissions](https://apps-docs.servicerocket.com/surveys/setting-permissions.md) --- language: "en" --- # Overview **End-of-Life Notice:** Surveys for Jira Service Management will be discontinued on 2026-10-30. After this date, the app will be removed from the Atlassian Marketplace and will cease to function. To ensure a smooth transition, please export your survey data and explore alternative solutions before the sunset date. You can retrieve your survey responses [++via API++](https://apps-docs.servicerocket.com/surveys/developer-guide) or export from CES, CSAT and NPS reports via the [++Export All Scales feature++](https://apps-docs.servicerocket.com/surveys/how-do-we-use-the-export-all-scales-function). Measure and improve your ITSM workflow with user satisfaction surveys and review process tools. ## Benefits * Improve customer satisfaction, experience, and loyalty. * Develop an operational understanding of customer satisfaction. * Track agent performance and customer satisfaction trends. * Improve customer service skills. ## Key features * Automated NPS (Net Promoter Score), CSAT (Customer Satisfaction), and CES (Customer Effort Score) reporting within JSM. * Assign and comment field for internal case reviews. * Customizable survey questions. * View customer tickets and survey history. * REST API to extract data. ## Use cases * Customer help desk * ITSM service desk * Knowledge centered support (KCS) ## What's next * [Building the survey's questions and language](https://apps-docs.servicerocket.com/surveys/building-the-survey-s-questions-and-language.md) --- language: "en" --- # Building the survey's questions and language **End-of-Life Notice:**Surveys for Jira Service Management will be discontinued on October 30, 2026. After this date, the app will be removed from the Atlassian Marketplace and will cease to function. To ensure a smooth transition, please export your survey data and explore alternative solutions before the sunset date. You can retrieve your survey responses [via API](https://apps-docs.servicerocket.com/surveys/developer-guide) or export from CES, CSAT and NPS reports via the [Export All Scales feature](https://apps-docs.servicerocket.com/surveys/how-do-we-use-the-export-all-scales-function). [https://www.youtube.com/watch?v=2Z5FXB-it1c\&t=1s](https://www.youtube.com/watch?v=2Z5FXB-it1c&t=1s) We're continuously enhancing the JSM Survey app with features inspired by your valuable feedback. While we work on updating our videos to reflect these improvements, you may notice some differences in the steps shown. ## Configuring questions 1. Click **Project settings** \>select **Survey settings** in the sidebar. 2. Under the **Build** tab, in the **Questions** section, enable the required feedback questions. Toggle on **Multi-select**if you want to ask respondents to give feedback for giving a low or high score. ![SVJSM Multi-select 20241021.png](https://apps-docs.servicerocket.com/__attachments/a_3af083de7344eb6daf67c56f25686873eae378fca325290d054e20495e7ab9fc/SVJSM%20Multi-select%2020241021.png?cb=b6a2262cb826d60844479b991c737b55) 3. Click **Add open question**to add more questions to your survey. ![:light_bulb_on:](https://apps-docs.servicerocket.com/__attachments/a_c970bb5a2251c6c5becd14ad2ec68fec8930f78d9b4fe9a97b9ee310e0b1cd48/atlassian-light_bulb_on?cb=485b9fcaee6e0d0eefa559cab514727e) Drag and drop to reorder questions. The first question appears in the customer satisfaction email. ## Configuring languages 1. In the **Build** tab, scroll to the **Language**section. Select your language from the dropdown. Drag and drop to reorder the languages. 2. Click the downward arrow to expand the configuration for your selected language. ![SVJSM Expand language box 20241203.png](https://apps-docs.servicerocket.com/__attachments/a_1e6ef3ab29e3495830cff9945039c50e3f058e5b93684411f3ed7d42f8bcfd4e/SVJSM%20Expand%20language%20box%2020241203.png?cb=2e775dc1ba082b539805d57493e95d41) 3. The following content can be edited within the language form: 1. **Survey title** - Provide the survey title you want to create. 2. **Notification email body message** - Add the automated comment with a markdown that links to the survey within the email notification body. Edit the content of the email as needed. 3. **Email subject** - Set the subject for the email with the link to the survey that the customers receive. 4. **Questions**- Set the description for your survey's NPS, CSAT, CES, and multi-select options for low or high scores if you've toggled it on. 5. **Success message**- Set the success message to appear once the user has submitted the survey. 6. **Button labels** - Personalize and design the Submit button, Done button, and Done button URL. 4. Click **Preview**on the top right of the page to preview your changes. ## What's next * [Customizing the look and feel of your survey](https://apps-docs.servicerocket.com/surveys/customizing-the-look-and-feel-of-your-survey.md) --- language: "en" --- # CES report **End-of-Life Notice:**Surveys for Jira Service Management will be discontinued on October 30, 2026. After this date, the app will be removed from the Atlassian Marketplace and will cease to function. To ensure a smooth transition, please export your survey data and explore alternative solutions before the sunset date. You can retrieve your survey responses [via API](https://apps-docs.servicerocket.com/surveys/developer-guide) or export from CES, CSAT and NPS reports via the [Export All Scales feature](https://apps-docs.servicerocket.com/surveys/how-do-we-use-the-export-all-scales-function). ## Prerequisites Before you can generate or view the survey reports, an administrator or manager must first grant the proper permissions to you. ### Granting permissions You will need to have the Administrators project role. Refer to the [Manage service project role memberships](https://support.atlassian.com/jira-service-management-cloud/docs/manage-service-project-role-memberships/) documentation. ## Report summary Understanding customers' loyalty is vital to providing great customer service. The Customer Effort Score(CES) report allows you to measure how much effort a customer has to put in to resolve an issue. ## Report type Gauge chart, bar chart, and trend line graph ## Gauge chart metrics ![CES-Gauge.png](https://apps-docs.servicerocket.com/__attachments/a_9942bd7aa7d873786fe411a7d89be8ed8f282d1e1414e958c7dccb0a110610b1/CES-Gauge.png?cb=f1c7741cc2bd7fad45a780a612cf7094) | **Metric** | **Details** | |------------|----------------------------------------------------------------------------------------| | Score | The total score based on the average score of the accumulated survey answers received. | | Goal | The set goal of the team to measure the individual's/team's performance. | | Answered | The total number of surveys answered by the customers. | ## Responses by score metrics ![resp_by_score.png](https://apps-docs.servicerocket.com/__attachments/a_180c1c954b9af819457fb3950352d058e3a06b08807fcd20c92bad2a954bdf0d/resp_by_score.png?cb=751315181b52b541ade98e29063aa0c2) | **Metric** | **Details** | |---------------------|--------------------------------------------------------------------------------| | Value | The specific score given by the customer for a Jira Service Management survey. | | Number of responses | The total number of responses with the same score. | ## Score trend line metrics ![image2022-6-13_10-0-51.png](https://apps-docs.servicerocket.com/__attachments/a_acc61801ca3250b81a8b9284b87a6f265232c656f82bc1771cd7843ecd062579/image2022-6-13_10-0-51.png?cb=4bcd579ad3606e1d1339a15e1eb1fb3b) | **Metric** | **Details** | |------------|----------------------------------------------------------------| | Score | The total score accumulated over a specific duration. | | Responses | The total number of responses received on a specific duration. | ## Scenario You would like to know the Customer Effort Score (CES) of a service desk agent in a specific timeline. 1. Go to **Projects** \> Choose your Service Management project \> **Surveys report** 2. Configure the survey parameters with the following details, the page will load the results automatically: 1. **Assignee**- Choose a specific assignee to view their performance or choose all of the assignees to view the performance as a team. 2. **Question** - Choose the CES option. 3. **Survey Responded** - Set the duration for when a survey is responded to and collected. 3. The results and scores will be depicted in charts and graphs. The **Responses** section will include all issues used to tabulate the data. 4. You can export the data in the following ways: 1. **Export** :This will export the data as seen in the survey report screen. This option will only export the current scale. 2. **Export All**: This will export all data, regardless of the scale, for the selected timeframe. --- language: "en" --- # Common problems and solutions **End-of-Life Notice:**Surveys for Jira Service Management will be discontinued on October 30, 2026. After this date, the app will be removed from the Atlassian Marketplace and will cease to function. To ensure a smooth transition, please export your survey data and explore alternative solutions before the sunset date. You can retrieve your survey responses [via API](https://apps-docs.servicerocket.com/surveys/developer-guide) or export from CES, CSAT and NPS reports via the [Export All Scales feature](https://apps-docs.servicerocket.com/surveys/how-do-we-use-the-export-all-scales-function). Find solutions to common issues encountered when using the Surveys for JSM app. * [The survey bot is not posting comments and survey links](https://apps-docs.servicerocket.com/surveys/the-survey-bot-is-not-posting-comments-and-survey-.md) * [How do I disable internal Jira ticket comments when sending out the survey?](https://apps-docs.servicerocket.com/surveys/how-do-i-disable-internal-jira-ticket-comments-whe.md) --- language: "en" --- # Configuring email settings **End-of-Life Notice:**Surveys for Jira Service Management will be discontinued on October 30, 2026. After this date, the app will be removed from the Atlassian Marketplace and will cease to function. To ensure a smooth transition, please export your survey data and explore alternative solutions before the sunset date. You can retrieve your survey responses [via API](https://apps-docs.servicerocket.com/surveys/developer-guide) or export from CES, CSAT and NPS reports via the [Export All Scales feature](https://apps-docs.servicerocket.com/surveys/how-do-we-use-the-export-all-scales-function). ## Setting the SMTP server integration With the SMTP server integration, you can send surveys using your custom email domain. For more details, check out: [Configuring SMTP server properties](https://apps-docs.servicerocket.com/surveys/configuring-smtp-server-properties.md). ## Setting the survey recipient If the survey recipient is different from the reporter, configure the relevant issue field to retrieve the email address. 1. Click the dropdown under **Survey recipient** and select the field of your choice. The survey will be sent to the email address in the field you have set. ## Setting the sender's name 1. Type the sender name in the field under **Sender configuration**. Your customers will receive emails from the sender whose name you have configured. ## Configuring performance email notifications 1. Under the **Performance notifications** section, insert the name or email address of the users that you want to notify. 2. The users are listed with their name, email address, and choice of notifications. ![notifcation-new.png](https://apps-docs.servicerocket.com/__attachments/a_88e0b7f1ad569e4f3a80327d5a8ca4c31b527b64c5da4479a9b92a83dbf6d709/notifcation-new.png?cb=c16cba9df9c546cf93079cbb020b5fe2) 3. If the **Survey filled**checkbox is ticked, you will receive an email notification detailing the survey response when a customer fills out the survey. 4. If the **Low score** checkbox is ticked, every time the NPS score of a survey goes below 6 (5 or less), an internal comment is added to the issue with your user mentioned. 5. The users listed in the **Performance notifications** section will be added as [watchers](https://support.atlassian.com/jira-software-cloud/docs/watch-share-and-comment-on-an-issue/) on the issue. ## Enabling internal comments for surveys Manage whether internal comments should be added automatically when a survey is sent. By default, this setting is toggled on. 1. Turn off ![Frame(1).png](https://apps-docs.servicerocket.com/__attachments/a_407471258e9cea061a3e93dc0ebcad7f9116b9e2b378be5655f6368883a24e11/Frame(1).png?cb=1609c478871da19a31cc32ca558a1efd) the **Add internal comment** toggle to stop adding an internal comment when a survey is sent. ## Setting survey reply reminders 1. Enable the toggle for **Send reminder** under the **Survey reply reminders** section. A reminder email will be sent to the user who leaves the survey unanswered. 2. You can set when the survey reminder email should be triggered. ## What's next * [Setting Surveys for JSM as the default feedback tool](https://apps-docs.servicerocket.com/surveys/setting-surveys-for-jsm-as-the-default-feedback-to.md) * [How will the emails informing customers about the survey look like?](https://apps-docs.servicerocket.com/surveys/what-does-the-email-for-the-customer-satisfaction-.md) --- language: "en" --- # Configuring issue and project level permission **End-of-Life Notice:**Surveys for Jira Service Management will be discontinued on October 30, 2026. After this date, the app will be removed from the Atlassian Marketplace and will cease to function. To ensure a smooth transition, please export your survey data and explore alternative solutions before the sunset date. You can retrieve your survey responses [via API](https://apps-docs.servicerocket.com/surveys/developer-guide) or export from CES, CSAT and NPS reports via the [Export All Scales feature](https://apps-docs.servicerocket.com/surveys/how-do-we-use-the-export-all-scales-function). ## Setting issue security level permission Follow this guide if you have configured an [issue security scheme](https://support.atlassian.com/jira-cloud-administration/docs/configure-issue-security-schemes/) for your JSM project. To avoid any issues where internal comments are not being added to the issues due to a lack of permissions, it's recommended to add Surveys for JSM in the issue security level to guarantee the expected behavior. 1. In Jira, click **Settings** (**⚙** gear icon) \> **Issues**. 2. In the left sidebar, under **Issue Attributes** , select**Issue security schemes**. 3. Click the scheme name or the **Security Levels** link in the **Actions** column. 4. Choose the appropriate security level and click the **Add** link in the **Actions** column. 5. Select the **Single user** radio button. Enter "Surveys for JSM", then click the **Add** button. ## Setting project permission 1. In Jira, click **Projects** \> select your JSM project. 2. In the left sidebar, click **Project settings** \> **Permissions**. 3. Click **Actions** \> **Edit permissions**. 4. Scroll to **Add Comments**permission. 5. If you have neither "atlassian-addons-project-access" nor "Surveys for JSM". Ensure that either one is added. You can add "atlassian-addons-project-access" as a project role or "Surveys for JSM" as a single user. --- language: "en" --- # Configuring SMTP server properties **End-of-Life Notice:**Surveys for Jira Service Management will be discontinued on October 30, 2026. After this date, the app will be removed from the Atlassian Marketplace and will cease to function. To ensure a smooth transition, please export your survey data and explore alternative solutions before the sunset date. You can retrieve your survey responses [via API](https://apps-docs.servicerocket.com/surveys/developer-guide) or export from CES, CSAT and NPS reports via the [Export All Scales feature](https://apps-docs.servicerocket.com/surveys/how-do-we-use-the-export-all-scales-function). This is a global configuration. By integrating an SMTP server, all surveys sent from the Atlassian instance, regardless of the project, will be dispatched through the same SMTP server. 1. In JSM, click **Apps** \> **Manage Apps**. 2. In the left sidebar, scroll to **Surveys for JSM** and click **SMTP connection**. 3. You can enable or disable the SMTP connection without deleting the server properties by switching the **Enable SMTP**toggle. 4. Fill in the following server properties to connect to the SMTP server: 1. **SMTP server name** - Enter the hostname or IP address of the SMTP server. 2. **SMTP port** - (Optional) Enter the port number or leave it blank. 3. **Username**- Enter the username to authenticate with the SMTP server. 4. **Password**- Enter the password to authenticate with the SMTP server. 5. **From email**- Enter the email used as the sender's email address. 6. **Encryption** - Check this if the mail server requires encryption security. Choose from (TLS, SSL, or no encryption). 5. Click **Test Connection** to test your connection. You will receive a success message confirming the connection. 6. Click **Save changes**to build your connection. --- language: "en" --- # Creating alert notifications based on feedback scores **End-of-Life Notice:**Surveys for Jira Service Management will be discontinued on October 30, 2026. After this date, the app will be removed from the Atlassian Marketplace and will cease to function. To ensure a smooth transition, please export your survey data and explore alternative solutions before the sunset date. You can retrieve your survey responses [via API](https://apps-docs.servicerocket.com/surveys/developer-guide) or export from CES, CSAT and NPS reports via the [Export All Scales feature](https://apps-docs.servicerocket.com/surveys/how-do-we-use-the-export-all-scales-function). You can use feedback custom fields to create alerts when you receive a certain feedback scores. Here's how to do this: ## Prerequisites * You have enabled feedback custom fields. Refer to this documentation: [Enabling feedback custom fields](https://apps-docs.servicerocket.com/surveys/modifying-the-survey-configuration.md). * You have added the feedback custom fields to the [issue view and issue edit screen](https://support.atlassian.com/jira-cloud-administration/docs/add-a-custom-field-to-a-screen/). In this guide you will learn how to create * Scheduled alert notifications * Time-sensitive alert notifications ## Creating a scheduled alert notification If you need to set up scheduled notifications follow these steps: 1. [Create a filter](https://servicerocket-apps.atlassian.net/wiki/display/SURVEYSC/How+can+we+filter+issues+based+on+the+feedback+scores+collected+from+our+surveys%3F) for the feedback scores you want to monitor. 2. Navigate to the filter that you just created and click on (**...** ) \> **More Actions** \> **Manage Subscriptions**. You can then: 1. Select the users or group to receive the alert. 2. Set the schedule for the alert. (For example, daily or weekly.) 3. Select if you want to send an email notification. 3. Click **Subscribe**. ## Creating a time-sensitive alert notification You can also create an alert notification that will send you an email the moment a user submits feedback scores you're monitoring. 1. Create a filter using JQL. (Refer to the article, [Save your search as a custom filter](https://support.atlassian.com/jira-service-management-cloud/docs/save-your-search-as-a-custom-filter/), to learn how to do so.) 2. Navigate to the filter that you just created and click on (**...** ) \> **More Actions** \> **Manage Subscriptions**. You can then: 1. Select the users or group to receive the alert. 2. Set the schedule for the alert. (For example, daily or weekly.) 3. Select if you want to send an email notification. 3. Click **Subscribe**. ## What's next Explore this tutorial to further understand how to use feedback customized fields: [How to use feedback custom fields to build automation, JQL queries, filters, and dashboards](https://apps-docs.servicerocket.com/surveys/how-to-use-feedback-custom-fields-to-build-jql-que.md) --- language: "en" --- # CSat report **End-of-Life Notice:**Surveys for Jira Service Management will be discontinued on October 30, 2026. After this date, the app will be removed from the Atlassian Marketplace and will cease to function. To ensure a smooth transition, please export your survey data and explore alternative solutions before the sunset date. You can retrieve your survey responses [via API](https://apps-docs.servicerocket.com/surveys/developer-guide) or export from CES, CSAT and NPS reports via the [Export All Scales feature](https://apps-docs.servicerocket.com/surveys/how-do-we-use-the-export-all-scales-function). ## Prerequisites Before you can generate or view the survey reports, an administrator or manager must first grant the proper permissions to you. ### Granting permissions You will need to have the Administrators project role. Refer to the [Manage service project role memberships](https://support.atlassian.com/jira-service-management-cloud/docs/manage-service-project-role-memberships/) documentation. ## Report summary Understanding customers' satisfaction with your organization's service or products is a key marker in the service industry business. The Customer Satisfaction (CSat) report allows you to measure how satisfied a customer is with the service you have provided. ## Report type Gauge chart, bar chart, and trend line graph ### Gauge chart metrics ![CSAT_Gauge.png](https://apps-docs.servicerocket.com/__attachments/a_b56adcee138bb169c802d1e930629768cd03dc628d38e0eae9885ec3dfb51cd0/CSAT_Gauge.png?cb=9ba25fd268d8ebb22677539851357215) | **Metric** | **Details** | |------------|----------------------------------------------------------------------------------------| | Score | The total score based on the average score of the accumulated survey answers received. | | Goal | The set goal of the team to measure the individual's/team's performance. | | Answered | The total number of surveys answered by the customers. | ## Responses by score metrics ![resp_by_score.png](https://apps-docs.servicerocket.com/__attachments/a_bb4a2f8be046ff156dbbe57b337208d454a3215bbe1f9ed4e010fba5aa590d63/resp_by_score.png?cb=184ee813b07dbbd36413d479d170f398) | **Metric** | **Details** | |---------------------|--------------------------------------------------------------------------------| | Value | The specific score given by the customer for a Jira Service Management survey. | | Number of responses | The total number of responses with the same score. | ## Score trend line metrics ![image2022-6-13_9-57-1.png](https://apps-docs.servicerocket.com/__attachments/a_2cb4de15f595a1f018e577d97f4daad21ab94a04f45a95877b5cdeb5b5782f32/image2022-6-13_9-57-1.png?cb=7a017311fc96b4d273e4eeabec5e2ab8) | **Metric** | **Details** | |------------|----------------------------------------------------------------| | Score | The total score accumulated over a specific duration. | | Responses | The total number of responses received on a specific duration. | ## Scenario You would like to know the Customer Satisfaction (CSat) of a service desk agent in a specific timeline. 1. Go to **Projects** \> Choose your Service Management project \> **Surveys report** 2. Configure the survey parameters with the following details, the page will load the results automatically: 1. **Assignee**- Choose a specific assignee to view their performance or choose all of the assignees to view the performance as a team. 2. **Question** - Choose the CSat option. 3. **Survey Responded** - Set the duration for when a survey is responded to and collected. 3. The results and scores will be depicted in charts and graphs. The **Responses** section will include all issues used to tabulate the data. 4. You can export the data in the following ways: 1. **Export** :This will export the data as seen in the survey report screen. This option will only export the current scale. 2. **Export All**: This will export all data, regardless of the scale, for the selected timeframe. --- language: "en" --- # Customizing the look and feel of your survey **End-of-Life Notice:**Surveys for Jira Service Management will be discontinued on October 30, 2026. After this date, the app will be removed from the Atlassian Marketplace and will cease to function. To ensure a smooth transition, please export your survey data and explore alternative solutions before the sunset date. You can retrieve your survey responses [via API](https://apps-docs.servicerocket.com/surveys/developer-guide) or export from CES, CSAT and NPS reports via the [Export All Scales feature](https://apps-docs.servicerocket.com/surveys/how-do-we-use-the-export-all-scales-function). Survey customization allows you to deliver a consistent brand experience to your customers. By customizing the icons, logo, banner color, and success message, you can design the survey's look and feel. [https://www.youtube.com/watch?v=Oq1pV9VcrWE\&t=2s](https://www.youtube.com/watch?v=Oq1pV9VcrWE&t=2s) ## Choosing the scale and icon set for the survey 1. Click **Project settings** \> **Survey settings** \> select the **Customize**tab. 2. Under the **Scale and icons** section, choose a scale to match the icon set from the dropdown box for **Scale** and **Icons** . ![info](https://apps-docs.servicerocket.com/__attachments/a_9c0a0e56e62eac722da8d0773912b85bdfa7b6c4d29f062d4af46b6eb4ebd696/atlassian-info?cb=feab5cd71111204d6b52545f3027dd0c) The larger the scale number, the more icons will be displayed. ![image-20231115-144005.png](https://apps-docs.servicerocket.com/__attachments/a_9d97df230978c16dd0fcf39341edce2a691f36c77f224684d3b80b280a5898a0/image-20231115-144005.png?cb=8409743b6e5745751cb2218b5dfb3cb8) While you can customize the icons in the survey, the icons that appear in the emails sent to customers to fill up the survey will default to the star icon (☆). For more information, read our [FAQ about these emails](https://apps-docs.servicerocket.com/surveys/what-does-the-email-for-the-customer-satisfaction-.md). ## Inserting a logo within the survey 1. Under the **Logo** section, click **Update**, and a window will pop up. 2. Click **Upload/Edit Image** to upload the logo. Next, click **Save** to complete the changes. ![image-20231115-144029.png](https://apps-docs.servicerocket.com/__attachments/a_ed8c9a646a8f0cd9126553868ad3c1329259a957f9fa3d71faf672aa44082090/image-20231115-144029.png?cb=31dd38f19b4b800ce35f0e6e6c7cbaa5) The customization of the logo is applicable to both the survey content and email notifications. ## Changing the color of the banner 1. Under the **Logo** section, click **Choose Color**. 2. Pick a color from the color palette or insert your own color code. ![image-20231115-144233.png](https://apps-docs.servicerocket.com/__attachments/a_80a18938af422420deaebf42c86d2bc65fecd9184d5567e98c55812646aac4f2/image-20231115-144233.png?cb=b2eb0c9d689ff8f6649a157752ac102f) ## Enabling the success message 1. Click the **Show success image** button to toggle the switch to ![check mark](https://apps-docs.servicerocket.com/__attachments/a_0381e707b229507c920d4f03a634e2f24d289ff1de2869e7fa1ec5a6a172de1f/atlassian-check_mark?cb=a10212e1c1021c5194f7535b6843f955) . ![image-20231115-144256.png](https://apps-docs.servicerocket.com/__attachments/a_49aba06611cf89f65366661d98f59112687de1767fc40465f171430143ee8685/image-20231115-144256.png?cb=db57bac6514d2a63baf304f23639aa35) ## What's next * [Modifying the survey configuration](https://apps-docs.servicerocket.com/surveys/modifying-the-survey-configuration.md) We're continuously enhancing the JSM Survey app with features inspired by your valuable feedback. While we work on updating our videos to reflect these improvements, you may notice some differences in the steps shown. --- language: "en" --- # Developer guide **End-of-Life Notice:**Surveys for Jira Service Management will be discontinued on October 30, 2026. After this date, the app will be removed from the Atlassian Marketplace and will cease to function. To ensure a smooth transition, please export your survey data and explore alternative solutions before the sunset date. You can retrieve your survey responses [via API](https://apps-docs.servicerocket.com/surveys/developer-guide) or export from CES, CSAT and NPS reports via the [Export All Scales feature](https://apps-docs.servicerocket.com/surveys/how-do-we-use-the-export-all-scales-function). Here's how to access the results of surveys answered by customers. ## Prerequisites * You must be able to administer Jira [global permission](https://confluence.atlassian.com/x/x4dKLg) as mentioned in [the Jira Cloud platform REST API documentation](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issues/). * You have generated an API key. ## Authentication The Surveys for JSM REST API uses the same authentication as the Jira API authentication. For more information, check out [Atlassian Developers documentation](https://developer.atlassian.com/cloud/jira/platform/basic-auth-for-rest-apis/). ## Accessing the endpoint 1. Enable the API in the **Configure** tab of your survey settings, for more information read, [Set up in-app automation triggers, goal evaluators, and custom fields](https://apps-docs.servicerocket.com/surveys/modifying-the-survey-configuration.md). 2. Add the 'x-api-key' to your header with the generated API key. ![SURVJSM-devapi-101023.png](https://apps-docs.servicerocket.com/__attachments/a_502f7a055bbcfb68d07223574762f37ff9b4edfeb37dca3a127302456a87c4c0/SURVJSM-devapi-101023.png?cb=8cfb0f7512a4ed4afb85e9d26ed62639) 3. Access endpoint via `curl H "x-api-key:" ` or via API Platform tools such as [Postman](https://www.postman.com/), [WSO2](https://wso2.com/), and others. ## GET Method ### Retrieving Surveys for JSM results Surveys for JSM REST API return the survey results when requested with the endpoint parameters below. https://surveys-jsm.servicerocket.io/surveys?projectKey=my-project-key&responded=true This example shows the results returned by the API call. In this scenario, there is one block of data as the total number of surveys in that month was one. { "issue_surveys": [{ "ces_response": 10, "comment_response": "Cool", "created": "2022-04-04T06:09:58", "issue_assignee": null, "issue_assignee_id": null, "issue_creation_date": 1649051994467, "issue_id": 10010, "issue_key": "LEV-11", "issue_reporter": "Team Lead Jane", "modified": "2022-04-04T06:14:26", "nps_response": 10, "project_key": "LEV", "response_date": "2022-04-04T06:13:57", "reviewer": "Mark Roberts", "reviewer_notes": "Approved", "scale_response": 9, "survey_id": "bb86cb87-332d-4f62-97ee-0896eb74792b-LEV" }], "total_surveys": 1, "total_surveys_responded": 1 } ![info](https://apps-docs.servicerocket.com/__attachments/a_9c0a0e56e62eac722da8d0773912b85bdfa7b6c4d29f062d4af46b6eb4ebd696/atlassian-info?cb=feab5cd71111204d6b52545f3027dd0c) By default, the endpoint parameter returns only one month's worth of results. Use the "from" and "to" parameter to control the range of the results. For example: https://survey-jsm.servicerocket.io/surveys?projectKey=my-project-key&responded=false&from=2023-02-02&to=2023-04-29 ## Endpoint Parameters | **key** | **required** | **content type** | **value** | |-------------|--------------|------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | projectKey | yes | string | The project that is associated with the surveys. | | from | no | string | The starting date range of the surveys. Default: If no value is passed, there will be a 30-day cut-off point for the endpoint. Both `from` and `to `values must be used together to specify a date range; otherwise, the operation will not work. | | to | no | string | The ending date range of the surveys. Default: If no value is passed, there will be a 30-day cut-off point for the endpoint. Both `from `and `to` values must be used together to specify a date range; otherwise, the operation will not work. | | assignee_id | no | string | Filter the results by the assignee_id. Default: If no value is passed, the results won't be filtered by the assignee. | | responded | no | boolean | This parameter specifies whether the data should be searched based on the response date (`responded` = `true`) or the creation date (`responded` = `false` or `absent`) Default: `false` or `absent` | ## Response Code | **Code** | **Definition** | |----------|-------------------------------------------------| | 200 | Returned if the request is successful. | | 400 | Access is not enabled or the API key is invalid | --- language: "en" --- # Do you have a quick video on steps to setup JSM Survey? **End-of-Life Notice:** Surveys for Jira Service Management will be discontinued on October 30, 2026. After this date, the app will be removed from the Atlassian Marketplace and will cease to function. To ensure a smooth transition, please export your survey data and explore alternative solutions before the sunset date. You can retrieve your survey responses [++via API++](https://apps-docs.servicerocket.com/surveys/developer-guide) or export from CES, CSAT and NPS reports via the [++Export All Scales feature++](https://apps-docs.servicerocket.com/surveys/how-do-we-use-the-export-all-scales-function). Yes we do, check out the page [Quick start for JSM Survey Administrators](https://apps-docs.servicerocket.com/surveys/quick-start-for-jsm-survey-administrators.md) . Here's an example: --- language: "en" --- # Features and functionalities **End-of-Life Notice:** Surveys for Jira Service Management will be discontinued on 2026-10-30. After this date, the app will be removed from the Atlassian Marketplace and will cease to function. To ensure a smooth transition, please export your survey data and explore alternative solutions before the sunset date. You can retrieve your survey responses [++via API++](https://apps-docs.servicerocket.com/surveys/developer-guide) or export from CES, CSAT and NPS reports via the [++Export All Scales feature++](https://apps-docs.servicerocket.com/surveys/how-do-we-use-the-export-all-scales-function). Explore the commonly-asked questions about configuring, customizing, and setting up Surveys for JSM: * [How to use JQL condition to filter which issues/projects trigger a survey for selected closed tickets?](https://apps-docs.servicerocket.com/surveys/how-to-trigger-survey-only-for-selected-closed-tic.md) * [Do you have a quick video on steps to setup JSM Survey?](https://apps-docs.servicerocket.com/surveys/do-you-have-a-quick-video-on-steps-to-setup-jsm-su.md) * [How to use feedback custom fields to build automation, JQL queries, filters, and dashboards](https://apps-docs.servicerocket.com/surveys/how-to-use-feedback-custom-fields-to-build-jql-que.md) * [How to schedule a survey trigger?](https://apps-docs.servicerocket.com/surveys/how-to-schedule-a-survey-trigger.md) * [How do we use the export all scales function?](https://apps-docs.servicerocket.com/surveys/how-do-we-use-the-export-all-scales-function.md) * [What is the difference between the export and export all scales function?](https://apps-docs.servicerocket.com/surveys/what-is-the-difference-between-the-export-and-expo.md) * [How does the scale correlate with the metric scores?](https://apps-docs.servicerocket.com/surveys/how-does-the-scale-correlate-with-the-metric-score.md) --- language: "en" --- # Filtering issues by feedback scores Once you have [enabled custom fields](https://apps-docs.servicerocket.com/surveys/modifying-the-survey-configuration.md), you can use it to filter issues that have feedback scores, whether it be CES, NPS or CSAT. ## Prerequisites * You have enabled the feedback custom field. Refer to this documentation: [Enabling feedback custom fields](https://apps-docs.servicerocket.com/surveys/modifying-the-survey-configuration.md). * You have added the feedback custom fields to the [issue view and issue edit screen](https://support.atlassian.com/jira-cloud-administration/docs/add-a-custom-field-to-a-screen/). ## Filtering issues using the basic method 1. Log in to Jira. 2. Click **Filters** \> **View all issues**. 3. Click on **More +** \> **Show more**and select your preferred score such as CES, NPS or CSAT. 4. Enter the feedback score you'd like to filter and click **Update**. 5. Save the filter by clicking **Save filter**. ## Filtering issues using JQL If you need to build more complex filters, you can also filter issues Jira Query Language (JQL). 1. Log in to Jira. 2. Click **Filters** \> **View all issues** 3. Click on **JQL**tab at the far right of the page. 4. Enter your JQL formula. ## What's next? * [Creating alert notifications based on feedback scores](https://apps-docs.servicerocket.com/surveys/creating-alert-notifications-based-on-feedback-sco.md) * Follow this tutorial to further understand how to use feedback custom fields: [How to use feedback custom fields to build automation, JQL queries, filters, and dashboards](https://apps-docs.servicerocket.com/surveys/how-to-use-feedback-custom-fields-to-build-jql-que.md). --- language: "en" --- # General FAQs **End-of-Life Notice:** Surveys for Jira Service Management will be discontinued on October 30, 2026. After this date, the app will be removed from the Atlassian Marketplace and will cease to function. To ensure a smooth transition, please export your survey data and explore alternative solutions before the sunset date. You can retrieve your survey responses [++via API++](https://apps-docs.servicerocket.com/surveys/developer-guide) or export from CES, CSAT and NPS reports via the [++Export All Scales feature++](https://apps-docs.servicerocket.com/surveys/how-do-we-use-the-export-all-scales-function). Here are the general questions asked about Surveys for JSM: * [What does the email for the customer satisfaction survey look like?](https://apps-docs.servicerocket.com/surveys/what-does-the-email-for-the-customer-satisfaction-.md) * [What are the intent and limitations of the Surveys for JSM app?](https://apps-docs.servicerocket.com/surveys/what-are-the-intent-and-limitations-of-the-surveys.md) --- language: "en" --- # How do I disable internal Jira ticket comments when sending out the survey? **End-of-Life Notice:**Surveys for Jira Service Management will be discontinued on October 30, 2026. After this date, the app will be removed from the Atlassian Marketplace and will cease to function. To ensure a smooth transition, please export your survey data and explore alternative solutions before the sunset date. You can retrieve your survey responses [via API](https://apps-docs.servicerocket.com/surveys/developer-guide) or export from CES, CSAT and NPS reports via the [Export All Scales feature](https://apps-docs.servicerocket.com/surveys/how-do-we-use-the-export-all-scales-function). ## Background When the survey is sent out and an automated comment is added to the Jira ticket, this causes it to be reopened. How can I turn off the internal comment to the ticket? ## Answer An internal comment will be added to a Jira ticket to notify agents that a survey email request has been sent. This is a default feature. In some cases, this may reopen tickets, depending on existing automation. Currently, Surveys for JSM lacks a feature to disable internal comments when surveys are sent out. As a workaround, you can review your Jira workflows and disable the reopening of Jira issues when making an internal comment. We are currently working on a new Surveys for JSM feature that will enable or disable comments in Jira tickets. --- language: "en" --- # How do we use the export all scales function? **End-of-Life Notice:** Surveys for Jira Service Management will be discontinued on October 30, 2026. After this date, the app will be removed from the Atlassian Marketplace and will cease to function. To ensure a smooth transition, please export your survey data and explore alternative solutions before the sunset date. You can retrieve your survey responses [++via API++](https://apps-docs.servicerocket.com/surveys/developer-guide) or export from CES, CSAT and NPS reports via the [++Export All Scales feature++](https://apps-docs.servicerocket.com/surveys/how-do-we-use-the-export-all-scales-function). Surveys for JSM users can export data from CES, CSAT and NPS reports via the **Export all scales** feature, which enables users to download data from reports at all scales. Before using the feature, it is important to understand the difference between using the **Export** and **Export all scales**feature. * The **Export** feature will download data only from the latest scale settings. * The **Export all scales** feature will download data regardless of the scale settings. For more information, read our FAQ, [What is the difference between the export and export all scales function?](https://apps-docs.servicerocket.com/surveys/what-is-the-difference-between-the-export-and-expo.md) ## Downloading data using export all scales ![SVJSM FAQ Export all scales steps 20240223.png](https://apps-docs.servicerocket.com/__attachments/a_a6ef7e7b78bd0b4022fd28e8e5ce4cdd8faa8b1ad5f35f964365b2ee8b944706/SVJSM%20FAQ%20Export%20all%20scales%20steps%2020240223.png?cb=0458c7fa65ef54f2ff86b2ea9bb1cbd0) 1. Go to your Jira Service Management project. On the left column menu, select **Surveys report**. 2. Select the **Assignee** and **Question**from the dropdown menus. 3. Select **Export all scales**. 4. Your data will be downloaded in CSV format. Please note that it may take the file some time to start downloading. If you do not have any data to export, clicking on the **Export all scales**button will result in an error. [Next Page](https://apps-docs.servicerocket.com/llms-full.txt/1)