...

Code Block

breakoutMode	wide
language	yaml

genoslcToolServiceVersionOverride: ""

global:
  domain: "example.com" 
  oidc:
    clientId: ""
    clientSecret: ""
  cert:
    overrideTruststorePassword: "changeit"
    secretName: ""
    crtFullChain: ""
    key: ""
  identity:
    OIDC_ISSUER: ""
  hosts:
    genoslc:
      subdomain: "genoslc-octane"  
      port: ""
env:
  tool:
    type: "octane"
    adaptedToolApiUri: ""
    adaptedToolRootUri: ""
    adaptedToolTechnicalUserAuthorizationHeader: ""
  configuration:
    administrators: []
    oauth10aEncryptionKey: ""  
  oidc:
    clientId: ""
    clientSecret: ""
    secretName: ""
  userNameAttribute: "preferred_username"
  clientAuthenticationScheme: "client_secret_basic" 
  userInfoAuthenticationMethod: "header" 
  clientScope: "openid"
  pkceEnabled: true
  publicUri: ""  
  pluginUri: ""
  allowedCorsOrigins: ""
  knownContextRoots: ""
  globalConfigurationProvider: ""
  linkValidityProvider: ""
  trsEnabled: false
  oslcSchemaMwhId: ""
  oslcSchemaSources: ""
  oslcSchemaSourcesUri: ""
  
  containerPort: "8443"
  port: "8443"
  debugPortToolService: ""
  
  # Defines a proxy used by the OSLC Connector for Octane. 
  proxy:
    https:
      # The URL of the https proxy server
      host: "" 
      # The port of the https proxy server
      port: ""
      # A list of IP addresses or URLs devided by the pipe sign '|'
      nonProxyHosts: "" 

  # Sets the logging level in the application
  # valid values are: INFO, ERROR, DEBUG, TRACE
  loggingLevelSpringFramework: "INFO" 


ingress:
  enabled: true
  className: ""
  annotations: {}
  tls:
    secretName: ""


  # ----------------------------------------------------------------
  # ------------------------- Library ------------------------------
  # ----------------------------------------------------------------

# Special certtool configuration
certtool:
  # certtool should only be activated on the first deployment and after a certificate update
  enabled: true
  
mongodb
  # Deployes a mongodb container inside the pod that the OSLC Connector will use
  enabled: true

...

Use genoslcToolServiceVersionOverride to change the default version set in the helm chart for the tool service. Overwrite the default value when you want to switch to another version, other than the one set as default via the helm chart

Code Block

language	yaml

genoslcToolServiceVersionOverride: "2024.07.4"

SSL certificates

Code Block

language	yaml

# SSL certificatesglobal:
  cert:
    overrideTruststorePassword: "changeit"
    secretName: ""
    crtFullChain: ""
    key: ""

...

After configuring the OIDC client in your SSO provider you must set the OIDC client ID and client secret.

Code Block

language	yaml

env:
  oidc:
    clientId: octaneClient
    clientSecret: e932235d-2349-fd26-bcdb-93hw3f43aab9

...

There are two URLs that must be set before a integration with the API and UI of Octane can be achieved. The first one is adaptedToolRootUri and it represents the base URL of your Octane instance. The second one is adaptedToolApiUri and represents the API URL of Octane. This usually follows the following path formats:

...

:

...

https://<octane instance URL>/cb/api/v3/

Code Block

language	yaml

env:
  tool:
    adaptedToolApiUri: "https://octane.com"
    adaptedToolRootUri: "https://octane.com"

...

Code Block

language	yaml

env:
  trsEnabled: false

Install the OSLC Connector for Octane

Execute the Installation

Enter the following command to execute the Installation:

...

Using link types from Smartfacts

To use Smartfacts as the provider and control for link types you must configure the following values:

Code Block

language	yaml

  oslcSchemaMwhId: ""
  oslcSchemaSources: ""
  oslcSchemaSourcesUri: ""

oslcSchemaMwhIdrepresents the ID of the Smartfacts model warehouse in which the link types are defined. Only one mwhId is currently supported.

oslcSchemaSourcesaccepts two options:

internal-fixed - default value, use it when there is no external link type service provider
external - use this to load link types from Smartfacts

oslcSchemaSourcesUri identifies the Smartfacts API URL (https://<smartfacts-url>/platform)

Install the OSLC Connector for Octane

Execute the Installation

Enter the following command to execute the Installation:

Code Block

language	bash

sudo helm upgrade --install genoslc-octane library/genoslc -f values-genoslc-octane.yaml --version 3.0.1 -n genoslc-octane --create-namespace

Enabling the plugin in Octane

To enable the OSLC Connector for Octane as an UI panel in Octane you need to navigate to Settings → External action editor.

Note
You must replace `<genoslc-octane-url>` with the correct URL of your OSLC Connector for Octane.

In the following code sample two external actions have been configured - one for work items and one for requirements.

Code Block

breakoutMode	full-width
language	json

[
  {
      "name": "smartfacts_details_sidepanel_cm",
      "title": "Smartfacts",
      "entity_type": [
        "work_item"
      ],
      "views": [
        "list"
      ],
      "icon": "details",
      "url": "https://<genoslc-octane-url>/spa?mode=query&componentId={shared_space}-{workspace}-cm&artifactId={entity_ids}&label={entity_name}&domain=http%3A%2F%2Fopen-services.net%2Fns%2Fcm%23ChangeRequest",
      "mode": {
        "name": "side_panel",
        "modules": [
          "backlog"
        ]
      },
      "single_entity": true
    },
    {
      "name": "smartfacts_details_sidepanel_rm",
      "title": "Smartfacts",
      "entity_type": [
        "requirement"
      ],
      "views": [
        "list"
      ],
      "icon": "details",
      "url": "https://<genoslc-octane-url>/spa?mode=query&componentId={shared_space}-{workspace}-rm&artifactId={entity_ids}&label={entity_name}&domain=http:%2F%2Fopen-services.net%2Fns%2Frm%23Requirement",
      "mode": {
        "name": "side_panel",
        "modules": [
          "requirements"
        ]
      },
      "single_entity": true
    },
    {
      "name": "smartfacts_details_sidepanel_qm",
      "title": "Smartfacts",
      "entity_type": [
        "test_suites"
      ],
      "views": [
        "list"
      ],
      "icon": "details",
      "url": "https://<genoslc-octane-url>/spa?mode=query&componentId={shared_space}-{workspace}-rm&artifactId={entity_ids}&label={entity_name}&domain=http:%2F%2Fopen-services.net%2Fns%2Fqm%23TestCase",
      "mode": {
        "name": "side_panel",
        "modules": [
          "quality",
          "backlog",
          "team_backlog"
        ]
      },
      "single_entity": true
    }
  ]

For more details on how to create custom external actions check the Octane documentation.

OSLC Links field

OSLC Links could be stored in the Octane item. A field needs to be configured in the Octane space where the items that own the links exist.

To setup the OSLC Links field follow the steps:

Navigate to the space you want to configure
Image Added
Select an entity to which you want to add the custom field
Image Added
Navigate to the Fields tab and press on + Field
Image Added
Add the OSLC Links field as a Long String field

...

Add the has_oslc_links field

...

Version	Old Version 2	New Version Current
Changes made by	Marius Balaban	Marius Balaban
Saved on	Sep 02, 2024	Apr 04, 2025

Content Comparison

Versions Compared

Key

SSL certificates

Install the OSLC Connector for Octane

Execute the Installation

Using link types from Smartfacts

Install the OSLC Connector for Octane

Execute the Installation

Enabling the plugin in Octane

OSLC Links field