Introduction

Connect ALM systems to Sphinx-Needs.

Effective adoption of Engineering-as-Code requires seamless integration with established ALM solutions such as DOORS, Polarion, Codebeamer, Jama, as well as file formats like Excel, ReqIF, and SysMLv2.

ubConnect is designed to bridge these systems with Sphinx-Needs.

Get Started

About useblocks

Upcoming features can be found on our Roadmap.

Caution

ubConnect is in an early development stage.

We welcome your feedback!

If you don’t have a Github account, contact us via support.

Contents

Basics

• Introduction
• Installation
• License configuration
  • Proxies
  • Environmental variables
  • License handling
  • Caching
  • Offline licenses
• Usage
  • ubconnect
    • reqif
      • from-reqif
      • to-reqif
    • jama
      • from-jama
      • to-jama
      • list-types
      • check
    • csv
      • from-csv
      • to-csv
    • doors-ng
      • from-doors-ng
    • github
      • from-github
      • to-github
      • validate-issue-refs
      • sync-issue-refs
    • jira
      • from-jira
    • wizard
• Setup Wizard
  • Running the wizard
  • Editing an existing configuration
  • Non-interactive use
  • Options
  • Exit codes

Features

• ReqIF
  • Round-Trip Conversion
    • Round-trip fidelity
  • Sphinx-Needs to ReqIF
    • Configuration Overview
    • Basic Configuration
    • HTML Content Extraction (Sphinx HTML)
      • How it works
      • Limitations and fallbacks
      • Example configuration
    • ALM Tool Configuration
      • Supported ALM Tools
      • Examples
    • Mapping Configuration
      • Configuration Structure
      • Configuration Parameters
      • Supported Data Types
      • Value Map (Explicit Value Translation)
        • How it works
        • Configuration examples
        • Validation rules
      • Pre-defined Mappings
    • Section Configuration
      • Configuration Structure
      • ALM-Specific Defaults
      • How Sections Are Created
      • Custom Section Configuration
      • Minimal Configuration
      • Partial Configuration
    • Complete Export Configuration Examples
      • Example 1: Exporting to DOORS with Default Settings
      • Example 2: Exporting to Codebeamer with Custom Mappings
      • Example 3: Custom Section Configuration with DOORS
      • Example 4: Full Configuration with All Options
      • Example 5: Advanced Features – Template, Weblink/Editlink Pattern, and import_date
      • Example 6: Weblink Attribute with html_dir (No Template Required)
  • ReqIF to Sphinx-Needs
    • Configuration Overview
    • Basic Configuration
      • RST Output Format
      • RST Per-Section Hierarchy
      • Mapping with Value Translation
      • Attachments and Images (ReqIFZ)
        • Example for a Sphinx documentation project
        • Notes
    • Mapping Configuration
      • Configuration Structure
      • Configuration Parameters
      • Linking Back to the Original Source
    • Static Fields Configuration
    • Mapping vs. Static Fields — Precedence
    • Section Detection (Hierarchy)
      • Configuration Parameters
      • Operating Modes
      • Examples
        • Type-name-based detection (Mode 2 — sections discarded)
        • Attribute-value-based detection (Mode 2 — sections discarded)
        • Structural container detection (Mode 1)
        • Typed container detection (Mode 3)
        • Section hierarchy path as a field (Modes 2/3)
        • Hierarchy path without section detection (Mode 0)
    • Links Configuration
    • Complete Configuration Example
  • Performance Diagnostics
• Jama Connect
  • Round-Trip Synchronization
  • Sphinx-Needs to Jama Connect
    • Configuration Overview
    • Basic Configuration
    • Mapping Configuration
      • Configuration Structure
      • Pre-defined Mappings
    • Create Missing Item Types
    • Create Missing Picklist Option
    • Type Mapping Configuration
      • Configuration Structure
  • Jama Connect to Sphinx-Needs
    • Configuration Overview
    • Basic Configuration
    • Mapping Configuration
      • Configuration Structure
      • Pre-defined Mappings
    • Type Mapping Configuration
      • Configuration Structure
      • Static Fields
  • Utility Commands
    • List available item types
      • Examples
    • Check connection
      • Examples
• CSV
  • CSV to Sphinx-Needs
    • Configuration Overview
    • Basic Configuration
    • Field Mapping
  • Sphinx-Needs to CSV
    • Configuration Overview
    • Basic Configuration
    • Field Mapping
• IBM DOORS Next Generation (DNG)
  • Purpose
  • Supported directions
  • Limitations
  • CLI usage
  • DNG to Sphinx-Needs
    • Configuration overview
    • Basic configuration
      • Default mapping behavior
    • All configuration options
      • Connection options ([ubconnect.from_doors_ng.client])
      • Import/output options ([ubconnect.from_doors_ng])
      • Mapping options ([ubconnect.from_doors_ng.mapping.<name>])
    • Performance notes
    • Example configurations
      • Example 1: Minimal import (defaults)
      • Example 2: Fast import of selected artifact types
      • Example 3: Mapping with enumeration conversion and unmapped handling
      • Example 4: Skipping section/heading artifacts (flat export)
  • Sphinx-Needs to DNG
    • Expected scope (future)
• GitHub Issues
  • Authentication
  • from-github
    • Filter flags (from-github)
    • Configuration
  • Consuming the output in Sphinx-Needs
  • validate-issue-refs
    • Flags (validate-issue-refs)
    • Configuration
  • to-github
    • Flags (to-github)
    • Configuration
    • RST patching
  • sync-issue-refs
    • Flags (sync-issue-refs)
    • Configuration
  • :issue: field schema
• Jira connector
  • Quick start
  • Authentication
  • Type mapping defaults
  • Field mapping defaults
  • Audit extras
  • Link mapping
  • Markup conversion
  • JQL filtering
  • Status normalization
  • Visualizing imported issues
  • Configuration reference

Roadmap

• Roadmap

Contact

• Request a license
  • Proxies
  • Environmental variables
  • License handling
  • Caching
  • Offline licenses
• Report an issue

Development

• Changelog