Skip to content
Lynxwork

Lynxwork Azure DevOps OSLC Client - Installation and Usage Guide

Select the subsection that matches your Azure DevOps setup:

Installation

Install on Azure DevOps on-premises

HTTP Module for IIS

  1. First, install HTTP Module for IIS by copying the provided file AzureDevOpsSandboxModifier.dll to <AzureDevOpsInstallDir>\Application Tier\Web Services\bin. You can also add the provided *.pdb file in the same directory, which will facilitate debugging.

    • Replace <AzureDevOpsInstallDir> with the actual root folder where Azure DevOps Server is installed on your system (for example, C:\Program Files\Azure DevOps Server).
    First, install HTTP Module for IISby copying the provided file AzureDevOpsSandboxModifier.dll to <AzureDevOpsInstallDir>

  2. Edit the <AzureDevOpsInstallDir>\Application Tier\Web Services\web.config file and add the following module registration, under <system.webServer><modules>

    <add name="SandboxModificationModule"
         type="AzureDevOpsSandboxModifier.SandboxModificationModule, AzureDevOpsSandboxModifier"
         preCondition="managedHandler" />
    Edit the <AzureDevOpsInstallDir>\\Application Tier\\Web Services\\web.config file and add the following module registrat

  3. Restart IIS

Upload and install the extension

  1. Navigate to https://your_devops_server_url/_gallery/manage and Click Upload extension

    Navigate to the https://your_devops_server_url/_gallery/manage

  2. Select the provided extension file MakeLynxworkAB.devops-oslc-client-app-1.0.xxx.vsix and upload it

    Select the provided extension file MakeLynxworkAB.devops-oslc-client-app-1.0.xxx.vsix and upload it

  3. Go to your main DevOps Server Collection home page

    Go to your main DevOps Server Collection home page

  4. Click Collection Settings

    Click "Collection Settings"

  5. Select Extensions

    Select "Extensions"

  6. Select Browse local extensions

    Select "Browse local extensions"

  7. Select Lynx OSLC client extension

    Select "Lynx OSLC client" extension

  8. Select Get it free

    Select "Get it free"

  9. Select the collection where you want to install it to

    Select the collection where you want to install it to

  10. Click Install.

    You are now done with the installation for Azure DevOps Server. It is now time to configure your extension.

    Click "Install".

Install on Azure DevOps Cloud

Lynxwork will first share the extension to your Azure DevOps Organization

  1. Click at the Organization Settings

    Click at the 'Organization Settings'

  2. Under Extensions, select Shared

    Under 'Extensions', select 'Shared'

  3. Select Lynxwork Azure DevOps OSLC Client

    Select Lynxwork Azure DevOps OSLC Client

  4. Click Install

    Click 'Install'

  5. Click makelynxwork

    Click "makelynxwork"

Configuration

Preview field

Now it is time to configure the extension. You first configure it at the organisation level, then you make project-specific configurations.

Navigate to your Azure DevOps main page and select Organization settings

Now it is time to configure the extension. You first configure it at the organisation level, then you make project-speci

  1. Click Extensions

    Click "Extensions"

  2. Click Azure DevOps

    Click "Azure DevOps"

  3. Click Process

    Click "Process"

  4. Select the process you want to change. In this example makelynxwork Basic

    Select the process you want to change. In this example "makelynxwork Basic"

  5. Click Issue

    Click "Issue"

  6. Click Lynx item previews

    Click "Lynx item previews"

  7. Click New field

    Click "New field"

  8. Click Text (multiple lines)

    Click "Text (multiple lines)"

  9. Select Add field

    Select "Add field"

  10. Click Hide from layout

    Click "Hide from layout"

  11. Repeat the previous steps to configure all necessary work item types. Note that you can reuse the same custom field for all work item types.

License

Now it is time to configure the extension. Click on Lynxwork Azure DevOps OSLC Client (Global) and Active your license.

Now it is time to configure the extension. Click on Lynxwork Azure DevOps OSLC Client (Global)and Active your license.

Friends

Now you are ready to connect Azure DevOps to external applications. Select Friends > Add Friend

Now you are ready to connect Azure DevOps to external applications. Select Friends > Add Friend

  1. Fill required fields then select Discover & Add.

    For example, to become friends with Polarion, the Root Services URL has the form

    https://polarion.your-organisation.com/polarion/oslc/rootservices

    If Polarion is the Friend, also apply Polarion 2512.

    Fill required fields then select Discover & Add.

  2. Select Save Changes

    Select Save Changes

Relationships

Update the Relationships

The Relationships section defines link predicate that describe how resources are connected across different applications, such as Requirement oslc_rm:validatedBy TestCase. These predicates provide a shared, neutral vocabulary that enables both applications to understand and interpret the links between their resources in a consistent way.

The extension includes standard presets (example, Affects Requirement, Validates Requirement) marked with a Standard badge. You can use them as-is, customize them, or add your own by selecting Add Custom — providing a Label, Property URI, Inverse Property URI, and an optional Inverse Label. Changes are buffered until you select Save Changes.

Update the Relationships

Domains

Update the Domains

The Domains section manages namespace prefix definitions for CURIE (Compact URI) notation, turning long URIs into readable shorthand like oslc_cm:relatedChangeRequest. The extension ships with 9 standard prefixes covering core OSLC specs (oslc, oslc_cm, oslc_rm, oslc_qm, oslc_am, oslc_config, dcterms, rdf, rdfs). You can register additional namespaces via Add Custom by providing a Prefix and Namespace URI. Changes are buffered until you select Save Changes.

Update the Domains

Type Mappings

Update the Type Mappings

The Type Mappings section define how your platform’s work item types (such as Bug or User Story) correspond to OSLC resource type URIs (for example, oslc_cm:Defect). This mapping ensures that work items are interpreted consistently when exchanged between applications.

The extenstion provides standard presets for common types. If your organization uses custom work item types, select Add Custom to define additional mappings. Changes are buffered until you select Save Changes.

Update the Type Mappings

Update Backlinks

The Backlinks section configures automatic creation of reciprocal links. When a work item is linked to an OSLC resource in a friend application, the extension automatically creates a corresponding backlink on the remote server that points back to the original item.

If you desire this functionality, enable Enable automatic backlink creation on and enter the base URL for the Azure DevOps OSLC Server (referred to in the Server instructions as {connector_base_url}).

Update Backlinks

Project configuration

You are done with the configuration at the organisation level. Now, it’s time to do project-specific configurations.

You are done with the configuration at the organisation level. Now, it's time to do project-specific configurations.

  1. Go to your specific project.

  2. Select Project settings

    1. Go to your specific project.

  3. Click here.

    Click here.

  4. Double-click the Selected OSLC Links field.

    Double-click the "Selected OSLC Links" field.

  5. Click the Selection Dialog URL field.

    Click the "Selection Dialog URL" field.

Linking Configuration

Item Type

  1. The wizard opens with the Select Work Item Type step.

  2. Select the desired item type.

  3. Select Next

    Linking Configuration - Item Type

Authentication

  1. On the Authentication step, select how the extension will connect to the OSLC Friend

    • Basic Authentication — A simpler setup with a username and password (credentials are only saved in-memory)
    • OAuth 1.0a — secure token-based authentication, tokens stored encrypted in your browser.

  2. Select your preferred method, then select Next

  3. Select a registered Friend from the dropdown.

    • For Basic Auth, enter your Username and Password, then select Test Connection to verify — a success message shows the number of discovered providers.
    • For OAuth, complete the authentication flow in the popup that appears,
    • Select Discover Providers
    Linking Configuration - Authentication

Service Providers

After a successful connection, the wizard lists the discovered set of Friend projects (otherwise known as Service Providers.

  1. Select Use provider for the specific project you want to create links to.

  2. Select Next

    Linking Configuration - Service Providers

External Type

The wizard now displays the OSLC selection dialogs available from the chosen provider.

  1. Select Use dialog for the entry that matches the artifact type you want to link to (e.g., Requirements, Change Requests).

  2. Select Next

    Linking Configuration - External Type

Relationship Type

  1. Choose the relationship that defines how links from your work items connect to the external resources. A Link flow summary appears at the bottom showing the full path: your work item, the relationship, and the destination resource type.

  2. Select Next

    Linking Configuration - Relationship Type

Review

  1. Select Launch selection dialog to test your configuration, as well as allow the extention to determine some suitable settings.

  2. Review and fine-tune the settings such as Destination Resource Type.

  3. Select Review.

    Linking Configuration - Review

Summary

The wizard now shows all your choices in one view

  1. Review and select Apply Configuration to save the settings to your project.

  2. You can click Back at any time to adjust a previous step.

    Linking Configuration - Summary

Save your changes

  1. Save your changes.

    Linking Configuration - Save Your changes

  2. Repeat the above steps for every mapping of item types to types in the Friend application.

The extension configuration is complete. Now, it’s time to use this extension.

Usage Guide

Now, it’s time to use this extension. Open one of the issues under your project, by first selecting Boards

Now, it's time to use this extension. Open one of the issues under your project, by first selecting "Boards"

  1. Click This is the title of the issue

    Click "This is the title of the issue"

You can now see the Lynx Item Preview section. It’s position in the layout depends on the configuration choices you made earlier.

To create a link, select Add link…

You can now see the Lynx Item Preview section. It's position in the layout depends on the configuration choices you made

  1. Now the selection dialog from your external application appears. Search and select an item from the list.

    Now the selection dialog from your external application appears. Search and select an item from the list.

  2. Click this radio button.

    Click this radio button.

  3. Click Open DP-429

    Click "Open DP-429"

  4. Click this icon.

    Click this icon.