Skip to main content

Creating Document 360 Tickets

QA Sphere allows you to integrate with Document 360 using the Custom Issue Tracker feature. This integration enables you to create Document 360 tickets directly while going through test cases in a test run, streamlining your workflow and ensuring efficient issue tracking within your documentation system.

Configuring Document 360 as a Custom Issue Tracker​

To integrate Document 360 into QA Sphere, follow these steps:

  1. Go to Settings by clicking the gear icon Settings wheel in the top right corner.

  2. Select Issue Trackers from the left sidebar.

  3. A list of all available projects will be displayed. Click the + button next to the appropriate project to add integration.

  4. Choose Custom from the list of available integrations.

  5. You'll be presented with a form to configure your Custom Issue Tracker. Fill it out as follows:

    • Issue Tracker Name: Enter "Document 360" or a name of your choice.
    • New Issue Link: Enter the URL for creating a new ticket in your Document 360 portal. For example: 
      https://[YOUR_PORTAL].document360.io/tickets/new
    • Title Extraction Rule: Enter the rule that matches your Document 360 ticket URL structure. For example: 
      https://[YOUR_PORTAL].document360.io/tickets/$(id:num)

  6. Click Save to add the Document 360 integration.

Understanding Title Extraction Rule​

The Title Extraction Rule helps QA Sphere pre-fill the Ticket Title based on the URL. For Document 360, you'll want to use $(id:num) as Document 360 uses numeric ticket IDs. The rule you enter should match the structure of your Document 360 ticket URLs.

Finding Your Portal URL​

To find your Document 360 Portal URL:

  1. Log into your Document 360 account
  2. Your portal name appears in the URL after logging in
  3. It can also be found in Portal Settings
  4. This name will be used in place of [YOUR_PORTAL] in your URLs

Using Document 360 Integration​

To create a Document 360 ticket during testing:

  1. Within your project, navigate to the Test Runs section.
  2. Select an existing test run or create a new one.
  3. Choose a test case within the run.
  4. When changing the status of the test case, click + Add Custom Issue.

A new browser tab will open with the Document 360 ticket creation interface. The ticket details will be pre-filled based on your extraction rule.

Complete the ticket details in Document 360 and submit the ticket. Once created, you can copy the ticket URL and paste it back into QA Sphere to link the ticket to your test case.

All tickets created for the test case will be saved under the Action History for this test run, providing a clear trail of documentation.

Benefits of Document 360 Integration​

  • Documentation Link: Directly connect issues with related documentation pages.
  • Version Control: Track issues across different documentation versions.
  • Category Management: Organize issues within Document 360's category structure.
  • Knowledge Base Integration: Link tickets to specific documentation articles.
  • Feedback Management: Connect user feedback with QA findings.

By leveraging this custom integration, your team can maintain a cohesive workflow between QA testing and documentation management, ensuring comprehensive issue tracking and resolution.

Best Practices​

  1. Category Structure: Create a dedicated category for QA-related tickets.
  2. Custom Fields: Set up custom fields to capture test-specific information.
  3. Version Tagging: Use consistent version tagging for documentation-related issues.
  4. Article Links: Include relevant documentation links in ticket descriptions.
  5. Feedback Integration: Connect user feedback with QA findings when applicable.

Troubleshooting​

If you encounter any issues with the integration:

  1. Double-check that your New Issue Link includes the correct portal name.
  2. Ensure your Title Extraction Rule correctly matches your Document 360 ticket URL structure.
  3. Verify that you have the necessary permissions in Document 360.
  4. Make sure you're logged into Document 360 in your browser for seamless ticket creation.
  5. Check that your portal settings allow external ticket creation.

For further assistance, contact your QA Sphere administrator or support team at [email protected].