[]
        
(Showing Draft Content)

Pipeline Licensing

ComponentOne licensing is typically tied to a development machine. In pipeline environments such as CI/CD systems, Docker containers, or cloud-hosted build agents, licenses must be activated on the machine or container that performs the build.

If your pipeline uses dynamic agents (for example, Azure Pipelines with Microsoft-hosted agents), the license must be activated during the build process. Depending on the type of license you use, the license may also need to be deactivated after the build completes.

Choose the section below that matches your license type.

 

Using a Standard Developer License in Pipelines

A standard developer license can be used in pipeline environments, but it has limitations when used with dynamic agents.

Behavior and Limitations

  • The serial key must be activated before each build.

  • The license should be deactivated after each build so it can be reused by the next agent.

  • There is a daily limit on activations and deactivations (reactivations).

  • Reaching the reactivation limit may block subsequent builds.

If these limitations are problematic, consider using a pipeline license.

 

Activate and Deactivate in the Pipeline

Prerequisites

  • A valid ComponentOne serial key

  • Network access to the licensing service

  • The command-line licensing tool available on the agent

Install the tool if it is not already available:

dotnet tool install -g sa3client

Activate Before the Build

sa3client activate "<serial-key>"

Deactivate After the Build

sa3client deactivate "<serial-key-prefix>"

Use the serial key prefix to identify which license to deactivate:

  • If only one key shares the prefix, the product code (for example, C1S) is sufficient.

  • If multiple keys share the same prefix, include the product code and the next 8 digits

    (for example, C1S-1234-5678).


Notes for Standard Developer Licenses

  • Always attempt to deactivate the license even if the build fails.

  • If repeated deactivation failures occur, contact support to resolve the issue.

  • There is a daily limit on activations and deactivations (reactivations).

  • If deactivation becomes a recurring issue, upgrading to a pipeline license is strongly recommended.

  • The build environment must have network access to the licensing service.

 

Using a Pipeline License

A pipeline license is designed specifically for CI/CD and containerized build environments.

Key Characteristics

  • Supports dynamic build agents

  • Does not require deactivation after each build

  • Supports offline activation

  • Cannot be used for interactive design-time development

  • Intended exclusively for build and pipeline environments

Pipeline licenses are available by contacting sales.

 

Pipeline License Package Contents

A pipeline license includes:

  • Pipeline Serial Key

    Format: Prefix-0000-0000-0000-0000-200

  • Local Activation Package File

    Package_Prefix-XXXXXXXX.data

    (The prefix and first 8 digits match the serial key.)

  • Password(s)

    One or more passwords, optionally time-limited.

 

Activate a Pipeline License in the Pipeline

Install the Command-Line Tool

dotnet tool install -g sa3client

Prepare the Local Activation Package

Copy the local activation package file to a directory accessible by the build script (for example, a tools or working directory).

Activate Before the Build

sa3client local-activate "<serial-key>" "<password>" --path "<local-package-path>"

  • Use --path to specify the folder containing the activation package file.

  • If omitted, the current directory is used.

 Notes for Pipeline Licenses

  • Deactivation is not required after the build.

  • Activation works offline; network access is not required during the build.

  • The license must still be activated before each build.

  • Pipeline licenses are not valid for interactive development in Visual Studio.

Legacy Pipeline Licensing (GCLM)

Older versions of ComponentOne use the MESCIUS License Manager (GCLM). These instructions apply to environments that still rely on legacy licensing.

Standard Developer License (GCLM)

Behavior and Limitations

  • The serial key must be activated and deactivated for each build.

  • A single key can be activated/deactivated up to 9 times per day.

Install the License Manager

If any MESCIUS product is installed, the tool is already available at:

  • Windows:

    C:\ProgramData\GrapeCity\gclm

If not installed:

  • Windows:

    Download gclm_deploy.exe

  • Linux / macOS:

    dotnet tool install -g GrapeCity.LicenseManagerTool


Activate Before the Build

# Windows
C:\ProgramData\GrapeCity\gclm\gclm.exe "<product-id>" -a "<key>"
# Linux / macOS
gclm "<product-id>" -a "<key>"

Deactivate After the Build

# Windows
C:\ProgramData\GrapeCity\gclm\gclm.exe "<product-id>" -d
# Linux / macOS
gclm "<product-id>" -d

For a list of product IDs, see Activation by Command Line.

 

Pipeline License (GCLM)

A legacy pipeline license allows unlimited activations without deactivation.

Activate the License

  1. Install the License Manager.

  2. Copy the local activation package file to:

    • Windows:

      C:\ProgramData\GrapeCity\gclm

    • Linux / macOS:

      ~/.local/share/GrapeCity/gclm

  3. Activate using the serial key and password:

# Windows
C:\ProgramData\GrapeCity\gclm\gclm.exe "<product-id>" -a "<key>" "<password>"
# Linux / macOS
gclm "<product-id>" -a "<key>" "<password>"

Note

For legacy pipeline licenses, the product ID is always 331cf6cd-b73c-429f-ba79-fa2f85eebd68 (Studio Enterprise).