Export data from Microsoft Word to ALM

After formatting your requirement or test plan data, you export the data to ALM.

When you export a new or existing requirement or test to ALM, it is created with the user name that you use to export it. For example, if you export a requirement to ALM with steve as the user name, the requirement’s history shows steve as the user that changed the requirement.

Note: You must have full create and modify permissions in ALM for requirements, the test plan tree, design steps, and subject folders.

Version control considerations

When you export data from Microsoft Word to a version control enabled project in ALM, consider the following:

  • When you export a new requirement or test, it is created in ALM, with a checked in status.

  • When you export an existing requirement or test that is checked in, it is automatically checked out during export. ALM adds a comment to the version history specifying that the requirement or test was updated by export from Word.

  • When you export an existing requirement or test that is checked out by you, the data is exported. If the requirement or test is checked out by another user, the export fails and an error message is displayed.

For more information on version control, see Version control.

Back to top

Export data to ALM

You export data to ALM from your Microsoft Word document.

To export data to ALM:

  1. Define the requirements or test plans in your document. For more information, see Format requirement data.

  2. Make sure that the ALM Common toolbar is displayed. For more information on displaying the ALM Common toolbar, see Microsoft Word add-in toolbars.

  3. To exclude marked data in your document from being exported, highlight the text area and click the Exclude Region button. A line is drawn through the selected text.

  4. Before you export data to ALM, you must download the ALM client. Navigate to the ALM login screen, and the appropriate files are downloaded to your machine. The download is done per server.

  5. Click the Export To ALM button. Type your ALM URL in the format of http://<ALM server name>[:port]/qcbin. Click Next.

    For single sign-on users, enable Add basic auth header mode.

    Note: Add basic authentication header mode is optional, and should only be enabled if you get an invalid server response message.

  6. For Single-Sign-On users: Perform the following steps and then click Next.

    1. If the user discovery page is displayed, add your user name or email address as specified in ALM. Click Submit.
    2. In the IDP page, add your IDP credentials. Click the log in button.
    3. The ALM Export Wizard - Step 3 of 5 dialog box opens. See Step 8.

  7. In the ALM Export Wizard - Step 2 of 5 dialog box, enter your ALM user name and password.

  8. In the ALM Export Wizard - Step 3 of 5 dialog box, select an ALM domain and project.

  9. Click Export.

  10. If an error occurs while exporting the document, the ALM Export Wizard - Scan Error Report dialog box opens.

    Review the errors. To save the errors as a text file, click the Launch Notepad button.

    Click Close to exit the wizard. Correct the errors and start again at step 1.

  11. If the data are exported successfully to ALM, the ALM Export Wizard - Step 5 of 5 dialog box opens. Click Finish.

  12. Refresh the view in ALM. Review the exported data and make the necessary additions and adjustments.

Back to top