Setup Instructions

  1. Login to Spira and go to the main SpiraApps system administrator page inside Spira:
  2. Go to the Inflectra SpiraApps download marketplace. Download the QVscribe SpiraApp package (it should be a file with extension .spab):

    Save the downloaded file to your local computer.
  3. Now back inside Spira, scroll down to the section that lets you upload and install the SpiraApp package:

    Browse to the downloaded package and choose Install SpiraApp.
     
  4. You should now see QVscribe listed in the applications:
  5. Click on the Activate button. You should now see a green tick/check next to the application:
  6. Go into the SpiraApp system settings (cog icon) and enter in your QVscribe API Key:
  7. Next, go to the Spira product that you want to use QVscribe with and Enable the SpiraApp for this product:
  8. Then, for this same product, make sure you have the following 3 custom properties defined:

    Score = Integer
    Results = Text, Rich Text = Yes
    Markup = Test, Rich  Text = Yes
  9. Then go back to the SpiraApp product settings for QVscribe and you will see the following screen:
  10. On this page, change the settings to enable use of Artifact Descriptions, enable Populate tags, and map the custom properties you have just created:
  11. You are now ready to use the QVscribe SpiraApp.
  12. Go to the Planning Requirements section and add a new requirement:
  13. Now click on the QVscribe button to analyze this requirement:
  14. The system will analyze the requirement and provide back the feedback and Score:

    Any identified nouns will be displayed as requirement Tags.
  15. The detailed feedback and markup is displayed beneath in the two rich text fields:
  16. To analyze multiple requirements, simply go to the requirement list page. Then select the checkboxes of the items you wish to analyze and click ‘Analyze Requirements’ from the QVscribe menu:
  17. That will analyze the requirements and assign a Score value. To display the Score value, use the Show/Hide columns feature to show the Score values:
  18. Finally, to add the Score summary widget to your Product dashboard, go to the Product Home page for your Spira product:
  19. Click the “+” button and add the Requirements Analysis Summary widget to your dashboard:
  20. Now when you reload the page, you will see the new analysis summary widget: