ubConnect

https://ubconnect.useblocks.com
Admin
ubConnect is a tool designed to bridge established ALM solutions like DOORS, Polarion, Jira, and...
Tokens:7,834
Snippets:74
Trust Score:7.1
Update:9 months ago
Show doc for...
Tokens:
Raw
### Complete ubConnect ReqIF Configuration Example

Source: https://ubconnect.useblocks.com/features/reqif

A comprehensive example illustrating all configurable options for ubConnect's ReqIF import, including file paths, ID prefixes, backlink settings, static fields, attribute mappings, and link configurations.

```ini
[ubconnect.from_reqif]
reqif_path = "./requirements.reqifz"
reqifz = true
outdir = "./docs/source"
id_prefix = "SYS_"
back_links = true

[ubconnect.from_reqif.static_fields]
type = "requirement"
status = "new"

[ubconnect.from_reqif.mapping]
id = "ReqIF.ForeignID"
title = "ReqIF.Name"
content = "ReqIF.Text"
reqif_type = "Type"
reqif_status = "Status"

[ubconnect.from_reqif.links]
links = ["<SpecRelationType1_ID>"]
```

--------------------------------

### Make Binaries Executable (Linux/macOS)

Source: https://ubconnect.useblocks.com/basics/installation

This snippet demonstrates how to grant execute permissions to ubConnect binaries on Linux and macOS systems. It uses the `chmod` command to modify file permissions, which is a prerequisite for running the downloaded executables directly.

```bash
chmod +x ubconnect-linux-x64-0.7.0
chmod +x ubconnect-linux-arm64-0.7.0
chmod +x ubconnect-darwin-arm64-0.7.0
```

--------------------------------

### Configure Static Fields for ReqIF Imports

Source: https://ubconnect.useblocks.com/features/reqif

This section demonstrates how to configure static fields that will be applied to all needs imported from a ReqIF file. It includes mandatory fields like 'type' and examples of additional static fields such as 'priority'.

```ini
[ubconnect.from_reqif.static_fields]
type = "req"                             # Type of needs (default: "req")
# additional static_fields
priority = "high"                        # Another additional field example
```

--------------------------------

### Configure Additional Mappings for ReqIF to Sphinx-Needs

Source: https://ubconnect.useblocks.com/features/reqif

These examples show how to define additional mappings for ReqIF attributes to Sphinx-Needs fields. These are used for attributes not covered by the mandatory mappings, allowing for custom field assignments in Sphinx-Needs.

```python
reqif_status = "Status"                  # Additional mapping example
reqif_resolution = "Resolution"          # Another additional mapping example
```

--------------------------------

### Configure from-ReqIF Mappings in ubConnect

Source: https://ubconnect.useblocks.com/features/reqif

Sets up the mapping of ReqIF attributes to Sphinx-Needs fields when importing data. Configuration is typically done in a TOML file under the '[ubconnect.from_reqif]' section and includes path settings, field values, and attribute mappings.

```toml
# All configuration can be defined in a TOML file under the section [ubconnect.from_reqif].
# Configuration consists of three main components:
# 1. Path Settings : Where to find and store files
# 2. Field Values : Applied values for all imported needs
# 3. Attribute Mappings : How ReqIF attributes map to need fields
```

--------------------------------

### Configure ReqIF Path for from-reqif in ubConnect v0.5.0+

Source: https://ubconnect.useblocks.com/development/changelog

Demonstrates the updated command-line usage for the `from-reqif` command in ubConnect version 0.5.0 and later, when a configuration file is used. This change aligns the CLI interface for better consistency and build system integration.

```bash
# Old usage (v0.4.0 and earlier)
ubconnect reqif from-reqif ./path/to/config.toml

# New usage (v0.5.0+) if ReqIF path is not specified in the config file
ubconnect reqif from-reqif ./path/to/file.reqif --config ./path/to/config.toml
```

--------------------------------

### Basic UBConnect ReqIF Import Configuration (TOML)

Source: https://ubconnect.useblocks.com/features/reqif

Defines the fundamental settings for importing ReqIF files with UBConnect. It includes the path to the ReqIF file, whether it's zipped, the output directory, ID prefix, and options for backlink and UUID generation. Paths are relative to the TOML file.

```toml
[ubconnect.from_reqif]
reqif_path = "./relative/path/to/your.reqif"      # Optional: Relative to the location of this TOML file
reqifz = false
outdir = "./output"                               # Optional: Output directory for generated files
id_prefix = "REQ_"                                # Prefix for need IDs (default: "REQ_")
back_links = false                                # Optional: Enable/disable backlink generation (default: false)
uuid_target = "reqif_uuid"                        # Optional: The target field for the UUID of ReqIF Spec-Object (default: "reqif_uuid")
origin_field = "origin"                          # Optional: The field to track the origin of the requirement (default: "origin")

```

--------------------------------

### Basic TOML Configuration for ReqIF Export

Source: https://ubconnect.useblocks.com/features/reqif

Configures the basic settings for exporting Sphinx-Needs to ReqIF format using ubconnect. This includes specifying input JSON paths, output directory, ReqIF specification name and prefix, grouping options, export format (.reqifz), and sources for UUIDs and origin tracking.

```toml
[ubconnect.to_reqif]
needsjson_path = "./relative/path/to/need.json"  # Optional: Path relative to this TOML file
outpath = "."                                    # Optional: Output .reqif(z) file path
name = "Custom Specification Name"               # Optional: ReqIFSpecification name (default: "Needs")
prefix = "all"                                   # Optional: Specification prefix (default: "all")
group_types = false                              # Optional: Group by need types (default: false)
reqifz = false                                   # Optional: Export as .reqifz (default: false)
uuid_source = "reqif_uuid"                       # Optional: The source for the UUID of ReqIF Spec-Object (default: "reqif_uuid")
origin_field = "origin"                          # Optional: The field to track the origin of the requirement (default: "origin")

```

--------------------------------

### Configure ubConnect License using TOML

Source: https://ubconnect.useblocks.com/basics/ublicense

This snippet shows the basic structure for configuring the license key and user email in the ubconnect.toml file. This is the primary method for license configuration.

```toml
[license]
key = "AAAAA-BBBBB-CCCCC-DDDDD"
user = "mail@example.com"

```

--------------------------------

### Configure to-ReqIF Mappings in ubConnect

Source: https://ubconnect.useblocks.com/features/reqif

Defines how Sphinx-Needs fields are mapped to ReqIF attributes when exporting data. Key parameters include 'source_field', 'target_attribute', and 'datatype'. Pre-defined mappings are available for common fields.

```python
# source_field = "result"                 # Optional: Sphinx-Needs field to read from (defaults to the mapping key "result" if not provided)
target_attribute = "need_result"          # ReqIF attribute to write to
# datatype = "string"                     # Optional: Defaults to "string" if not provided

## pre-defined mappings by ubConnect ##
# [ubconnect.to_reqif.mapping.id]
# source_field = "id"
# target_attribute = "need_id"
# datatype = "string"

# [ubconnect.to_reqif.mapping.title]
# source_field = "title"
# target_attribute = "ReqIF.Name"
# datatype = "xhtml"

# [ubconnect.to_reqif.mapping.content]
# source_field = "content"
# target_attribute = "ReqIF.Text"
# datatype = "xhtml"

# [ubconnect.to_reqif.mapping.status]
# source_field = "status"
# target_attribute = "need_status"
# datatype = "enum"

# [ubconnect.to_reqif.mapping.type]
# source_field = "type"
# target_attribute = "need_type"
# datatype = "enum"

# [ubconnect.to_reqif.mapping.prefix]
# source_field = "prefix"
# target_attribute = "ReqIF.Prefix"
# datatype = "string"
## pre-defined mappings by ubConnect ##
```

--------------------------------

### Set ubConnect License via Environment Variables

Source: https://ubconnect.useblocks.com/basics/ublicense

This snippet shows how to set ubConnect license and proxy configurations using environment variables in a command-line interface. These variables override settings in the TOML file.

```bash
# Example for setting license key and user
export UBCONNECT_LICENSE_KEY="AAAAA-BBBBB-CCCCC-DDDDD"
export UBCONNECT_LICENSE_USER="mail@example.com"

# Example for setting proxy
export UBCONNECT_HTTPS_PROXY="<proxy-domain-or-ip>"

```

--------------------------------

### Configure Offline ubConnect License using TOML

Source: https://ubconnect.useblocks.com/basics/ublicense

This snippet illustrates the configuration for offline licenses in ubconnect.toml. It requires a license file and a user email, but not a license key.

```toml
[license]
file = "ActivationFile.skm"
user = "mail@example.com"

```

--------------------------------

### Configure ubConnect Proxy using TOML

Source: https://ubconnect.useblocks.com/basics/ublicense

This snippet demonstrates how to configure an HTTPS proxy server within the ubconnect.toml file. ubConnect supports HTTP CONNECT proxies.

```toml
[proxy]
https = "<proxy-domain-or-ip>"

```

--------------------------------

### Custom ReqIF Mapping Configuration

Source: https://ubconnect.useblocks.com/features/reqif

Defines custom mappings between Sphinx-Needs fields and ReqIF attributes. This section allows users to specify how specific Sphinx-Needs fields, like 'priority', should be translated into ReqIF attributes, including their target attribute name and data type.

```toml
[ubconnect.to_reqif.mapping.priority]
source_field = "priority"                 # Sphinx-Needs field to read from
target_attribute = "need_priority"        # ReqIF attribute to write to
datatype = "enum"                         # Data type in ReqIF

```

```toml
[ubconnect.to_reqif.mapping.result]

```

--------------------------------

### UBConnect ReqIF Attribute to Sphinx-Needs Field Mapping (TOML)

Source: https://ubconnect.useblocks.com/features/reqif

Specifies how attributes from ReqIF files are mapped to corresponding Sphinx-Needs fields. This is crucial when ReqIF attributes have different names than expected by Sphinx-Needs, such as handling specific export formats like CodeBeamer's 'ReqIF.ForeignID' for IDs.

```toml
[ubconnect.from_reqif.mapping]
id = "ReqIF.ForeignID"                   # Maps to need ID (default: "ReqIF.ForeignID")
title = "ReqIF.Name"                     # Maps to need title (default: "ReqIF.Name")
content = "ReqIF.Text"                   # Maps to need content (default: "ReqIF.Text")
reqif_type = "Type"                      # Maps to reqif type (default: "Type")

```

--------------------------------

### Configure Link Mappings from ReqIF SpecRelations

Source: https://ubconnect.useblocks.com/features/reqif

This configuration specifies how ReqIF SpecRelationTypes map to Sphinx-Needs link fields. It allows for defining relationships like 'tests', 'depends_on', and 'implements' based on the IDs found in the ReqIF file.

```ini
[ubconnect.from_reqif.links]
tests = ["SpecRelationType1_ID"]           # Map SpecRelations typed by SpecRelationType1 to 'tests' field
depends_on = ["SpecRelationType2_ID"]      # Map SpecRelations typed by SpecRelationType2 to 'depends_on' field
implements = ["SpecRelationType3_ID"]      # Map SpecRelations typed by SpecRelationType3 to 'implements' field
```

--------------------------------

### ReqIF Relation Group Export with Group Types

Source: https://ubconnect.useblocks.com/development/changelog

Demonstrates the XML structure for a ReqIF relation group when the 'group-types' CLI option is enabled. This structure organizes relation groups based on Sphinx-Needs types, allowing for better organization of ReqIfRelationGroups.

```xml
<RELATION-GROUP IDENTIFIER="c433e5bf02895edf8a0e483ccc950779-team->person" LONG-NAME="relation_group-team->person">
    <SPEC-RELATIONS>
      <SPEC-RELATION-REF>ADAS-PETER</SPEC-RELATION-REF>
      <SPEC-RELATION-REF>ADAS-ALFRED</SPEC-RELATION-REF>
      <SPEC-RELATION-REF>ADAS-ROBERT</SPEC-RELATION-REF>
      <SPEC-RELATION-REF>ADAS-STEVEN</SPEC-RELATION-REF>
      <SPEC-RELATION-REF>ADAS-THOMAS</SPEC-RELATION-REF>
    </SPEC-RELATIONS>
    <TYPE>
      <RELATION-GROUP-TYPE-REF>8a936f750fbd5da39b3b4c183f223c3a</RELATION-GROUP-TYPE-REF>
    </TYPE>
    <SOURCE-SPECIFICATION>
      <SPECIFICATION-REF>dc65b98335a655e681bb3ff0809be03f-team</SPECIFICATION-REF>
    </SOURCE-SPECIFICATION>
    <TARGET-SPECIFICATION>
      <SPECIFICATION-REF>c22fb9b694e257dba67568b7bbc0c058-person</SPECIFICATION-REF>
    </TARGET-SPECIFICATION>
</RELATION-GROUP>
```

--------------------------------

### ReqIF Specification Hierarchy Export

Source: https://ubconnect.useblocks.com/development/changelog

Illustrates the XML representation of a ReqIF specification hierarchy, preserving the hierarchical structure of need items as defined in Sphinx-Needs. This includes nested SPEC-HIERARCHY elements reflecting sections and sub-sections.

```xml
<SPECIFICATION IDENTIFIER="c89706e0997b5dbc973cf6a0c90a9f2f-req" LONG-NAME="Needs-req">
  <TYPE>
    <SPECIFICATION-TYPE-REF>422a5efc4d1a570ebcd9d9b2324c2b1d</SPECIFICATION-TYPE-REF>
  </TYPE>
  <CHILDREN>
    <SPEC-HIERARCHY IDENTIFIER="e591ece906565ab8bc5ce637fae314d5-Sphinx-Needs objects" IS-EDITABLE="false" IS-TABLE-INTERNAL="false">
      <OBJECT>
        <SPEC-OBJECT-REF>req-Sphinx-Needs objects</SPEC-OBJECT-REF>
      </OBJECT>
      <CHILDREN>
        <SPEC-HIERARCHY IDENTIFIER="ae377f5f988a59c6b9d85f51cf4fd262-🧰 Basic Example" IS-EDITABLE="false" IS-TABLE-INTERNAL="false">
          <OBJECT>
            <SPEC-OBJECT-REF>req-🧰 Basic Example</SPEC-OBJECT-REF>
          </OBJECT>
          <CHILDREN>
            <SPEC-HIERARCHY IDENTIFIER="ef313f7ed42258aaac671a8bbfffd6dd-EX_REQ_001" IS-EDITABLE="false" IS-TABLE-INTERNAL="false">
              <OBJECT>
                <SPEC-OBJECT-REF>EX_REQ_001</SPEC-OBJECT-REF>
              </OBJECT>
              <CHILDREN>
              </CHILDREN>
            </SPEC-HIERARCHY>
          </CHILDREN>
        </SPEC-HIERARCHY>
      </CHILDREN>
    </SPEC-HIERARCHY>
  </CHILDREN>
</SPECIFICATION>
```
Tokens:
Raw