Skip to main content

Creating Nuclino Items

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

Configuring Nuclino as a Custom Issue Tracker​

To integrate Nuclino 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 "Nuclino" or a name of your choice.
    • New Issue Link: Enter the URL for creating a new item in your Nuclino workspace. For example: 
      https://app.nuclino.com/[TEAM]/[WORKSPACE]/New-Item
    • Title Extraction Rule: Enter the rule that matches your Nuclino item URL structure. For example: 
      https://app.nuclino.com/[TEAM]/[WORKSPACE]/$(title)-$(id)

  6. Click Save to add the Nuclino integration.

Understanding Title Extraction Rule​

The Title Extraction Rule helps QA Sphere pre-fill the Item Title based on the URL. For Nuclino, you'll want to use both $(title) and $(id) as Nuclino uses a combination of item title and unique identifier in URLs. The rule you enter should match the structure of your Nuclino item URLs.

Finding Your Team and Workspace Names​

To find your Nuclino identifiers:

  1. Log into your Nuclino account
  2. Navigate to your desired workspace
  3. Your team and workspace names appear in the URL
  4. The URL format is typically: app.nuclino.com/[TEAM]/[WORKSPACE]

Using Nuclino Integration​

To create a Nuclino item 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 Nuclino item creation interface. The item details will be pre-filled based on your extraction rule.

Complete the item details in Nuclino and create the item. Once created, you can copy the item URL and paste it back into QA Sphere to link the item to your test case.

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

Benefits of Nuclino Integration​

  • Real-time Collaboration: Work together on issue documentation in real-time.
  • Workspace Organization: Utilize Nuclino's flexible workspace structure.
  • Rich Text Formatting: Take advantage of Nuclino's markdown-based editor.
  • Item Relations: Create relationships between different QA items.
  • Graph Visualization: Visualize connections between related issues.

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

Best Practices​

  1. Workspace Structure: Create a dedicated workspace for QA-related items.
  2. Item Templates: Set up templates for common issue types.
  3. Tagging System: Implement consistent tags for different types of QA issues.
  4. Hierarchical Organization: Use Nuclino's tree structure for logical issue organization.
  5. Cross-linking: Utilize bi-directional linking between related items.

Troubleshooting​

If you encounter any issues with the integration:

  1. Double-check that your New Issue Link includes the correct team and workspace names.
  2. Ensure your Title Extraction Rule correctly matches your Nuclino item URL structure.
  3. Verify that you have the necessary permissions in your Nuclino workspace.
  4. Make sure you're logged into Nuclino in your browser for seamless item creation.
  5. Check that your workspace settings allow new item creation.

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