Skip to content
English
Contact Sales
  • There are no suggestions because the search field is empty.

Configuring Nooga Scale on Azure DevOps Server using XML process template

When using Azure DevOps Server with an XML process template (on-premise), manual configuration is required to set up Scale. This guide walks you through the process.

 

Note: This manual process is specific to Azure DevOps Server. If automation APIs become available for Azure DevOps Server in the future, this guide will be updated accordingly.

Understanding the Configuration

Scale uses a JSON file to define the process configuration of a project, including work item types and fields. The configuration file scale-safe.json is included in the scale-configuration package. Use the configuration as is or customize the mappings for work item types and fields. The id field is what keeps the config together so that's the one thing you should not change. The name field is most likely what you want to change if you prefer the work item types to be named differently.

Configuration File Details

  • id field: Critical identifier that maintains configuration integrity - do not modify
  • name field: Customizable to match your preferred work item type names
  • Work item types included: ART, PI, PI Objective, Risk

⚠️ Important: If you customize the name field in scale-safe.json, ensure you update the corresponding WORKITEMTYPE name in the XML file for that work item type.

Prerequisites

  • Visual Studio with Team Explorer installed (for witadmin.exe)
  • Personal Access Token with appropriate permissions to:
    • Read/write extension data
    • Modify work item type
  • Run the script from the directory containing the WIT XML files and scale-*.json config
  • The project needs a process template including the Feature work item type
  • You need to be a Project Collection Administrator to see the files

Required Setup Steps

Step 1: Install

If this is the first time using Scale, install Scale extension and start trial. If you are using Azure DevOps offline, reach out to your sales representative to obtain a license key. Continue to step 2 if you already have the extension installed.

Step 2: Go to project

Navigate to a project where Scale is to be used. Click on Nooga Scale extension. For a project needing configuration, you should be prompted to download the configuration package.

Step 3: Download Configuration Package

Download the scale-configuration package containing:

  • Work item type definitions (XML files):
    • ART
    • PI
    • PI Objective
    • Risk
  • scale-safe.json (process configuration saved to Scale project settings)
  • Configure-Scale.ps1 (configuration script)

Step 4: Run Configuration Script

Execute the PowerShell script with the following parameters:

-CollectionUrl "<COLLECTION-URL>"
-ProjectName "<PROJECT-NAME>"
-PersonalAccessToken "<PERSONAL-ACCESS-TOKEN"

Ensure you are running the script from the directory of the configuration package, see prerequisites.

Step 5: Verify Installation

  1. Refresh your browser
  2. Navigate to Scale for the project you have configured
  3. If the extension is loading without the previous prompt to configure, the configuration was successful

Need Help?

If you encounter issues during configuration, please ensure:

  • You have Visual Studio Team Explorer installed
  • Your Personal Access Token has sufficient permissions
  • You are running the script from the directory of the configuration package
  • All XML WORKITEMTYPE names match the names specified in scale-safe.json
  • The id of work item types in the scale-safe.json have not been altered
  • You have refreshed your browser after running the configuration script
  • The project process in use includes the Feature work item type

Optional Customization

1. Hide Custom Work Item Types

By default, all work item types are visible and can be created by users. To hide Scale's custom work item types, follow the steps below:

Export Current Categories

cmd

witadmin exportcategories /collection:https://your-tfs/collection /p:"some project" /f:categories.xml

Modify Categories File

Add Scale work item types to the Hidden Types Category:

xml

<CATEGORY refname="Microsoft.HiddenCategory" name="Hidden Types Category">
    <DEFAULTWORKITEMTYPE name="Code Review Request" />
    <WORKITEMTYPE name="Code Review Response" />
    <WORKITEMTYPE name="Feedback Request" />
    <WORKITEMTYPE name="Feedback Response" />
    <WORKITEMTYPE name="Shared Steps" />
    <WORKITEMTYPE name="Shared Parameter" />
    <WORKITEMTYPE name="Test Plan" />
    <WORKITEMTYPE name="Test Suite" />
    <WORKITEMTYPE name="Agile Release Train" />
    <WORKITEMTYPE name="Program Increment" />
</CATEGORY>

Import Updated Categories

cmd

witadmin importcategories /collection:https://your-tfs/collection /p:"some project" /f:categories.xml

2. Customize Work Item Type Icons

Modify work item type icons following Microsoft's documentation:

3. Customize Work Item Type Colors

Change work item type colors by following: