Updated Licensing Documentation Page using Code Studio

Document-Processing/Licensing/licensing-faq/CI-license-validation.md

@@ -1,7 +1,7 @@
 ---
 layout: post
 title: Overview of Syncfusion license validation in CI services - Syncfusion
-description: Learn here about how to register Syncfusion license key for Syncfusion application for license validation.
+description: Learn how to register and validate the Syncfusion license key for your application in CI services.
 platform: file-formats
 control: Essential Studio
 documentation: ug
@@ -17,15 +17,16 @@ margin-top: 1.5em;     margin-bottom: 1.5em;
 </style>
 
 
-# Syncfusion<sup>&reg;</sup> license key validation in CI services
+# Overview of Syncfusion license validation in CI services
 
-Syncfusion<sup>&reg;</sup> license key validation in CI services ensures that Syncfusion<sup>&reg;</sup> Essential Studio components are properly licensed during CI processes. Validating the license key at the CI level can prevent licensing errors during deployment. Set up the continuous integration process to fail in case the license key validation fails. Validate the passed parameters and the registered license key again to resolve the issue.
+Validating the Syncfusion<sup>&reg;</sup> license key as part of your CI pipeline ensures that Syncfusion<sup>&reg;</sup> Essential Studio components are properly licensed before deployment and helps prevent licensing errors in production. The following sections describe how to validate the license key in Azure Pipelines, GitHub Actions, and Jenkins, and how to validate it programmatically using the `ValidateLicense()` method or a unit test project.
 
 The following section shows how to validate the Syncfusion<sup>&reg;</sup> license key in CI services.
 
 * Download and extract the LicenseKeyValidator.zip utility from the following link: [LicenseKeyValidator](https://s3.amazonaws.com/files2.syncfusion.com/Installs/LicenseKeyValidation/LicenseKeyValidator.zip).
 
-* Open the LicenseKeyValidation.ps1 PowerShell script in a text\code editor as shown in the below example.
+* Open the LicenseKeyValidation.ps1 PowerShell script in a text or code editor as shown in the following example.
+
 
 {% tabs %}
 {% highlight c# tabtitle="PowerShell" %}
@@ -41,24 +42,26 @@ Write-Host $result
 
 * Update the parameters in the LicenseKeyValidation.ps1 script file as described below. 
 
-  **Platform:** Modify the value for /platform: to the actual platform "FileFormats". 
-
-  **Version:**  Change the value for /version: to the required version (e.g., "26.2.4").
-
-  **License Key:** Replace the value for /licensekey: with your actual license key (e.g., "Your License Key"). 
-
-  N> This feature is supported only from the 16.2.0.41 version of the Essential Studio<sup>&reg;</sup>.
+  **Platform:** Modify the value for `/platform:` to the platform you are using (for example, `FileFormats`).
+
+  **Version:** Change the value for `/version:` to the required version (for example, `26.2.4`).
+
+  **License Key:** Replace the value for `/licensekey:` with your actual license key (for example, `Your License Key`). To keep the key out of source control, store it as a CI secret and read it in the script (for example, `$env:SYNCFUSION_LICENSE_KEY`).
+
+  N> This feature is supported starting with version 16.2.0.41 of Essential Studio<sup>&reg;</sup>.
+
+  N> On Windows agents, if script execution is blocked by policy, run the script with `-ExecutionPolicy Bypass` (for example, `powershell -ExecutionPolicy Bypass -File .\LicenseKeyValidation.ps1`). The script returns a non-zero exit code when validation fails so the pipeline step fails.
 
 ## Azure Pipelines (YAML)
 
-* Create a new [User-defined Variable](https://learn.microsoft.com/en-us/azure/devops/pipelines/process/variables?view=azure-devops&tabs=yaml%2Cbatch#user-defined-variables) named `LICENSE_VALIDATION` in the Azure Pipeline. Use the path of the LicenseKeyValidation.ps1 script file as a value (e.g., D:\LicenseKeyValidator\LicenseKeyValidation.ps1).
+* Create a new [User-defined Variable](https://learn.microsoft.com/en-us/azure/devops/pipelines/process/variables?view=azure-devops&tabs=yaml%2Cbatch#user-defined-variables) named `LICENSE_VALIDATION` in the Azure Pipeline. Use the path of the LicenseKeyValidation.ps1 script file as the value (for example, `D:\LicenseKeyValidator\LicenseKeyValidation.ps1`).
 
-* Integrate the PowerShell task in the pipeline and execute the script to validate the license key. 
+Integrate the PowerShell task in the pipeline and execute the script to validate the license key. 
 
 The following example shows the syntax for Windows build agents.
 
 {% tabs %}
-{% highlight c# tabtitle="YAML" %}
+{% highlight yaml tabtitle="YAML" %}
 pool:
   vmImage: 'windows-latest'
 
@@ -75,21 +78,21 @@ steps:
 
 ## Azure Pipelines (Classic)
 
-* Create a new [User-defined Variable](https://learn.microsoft.com/en-us/azure/devops/pipelines/process/variables?view=azure-devops&tabs=yaml%2Cbatch#user-defined-variables) named `LICENSE_VALIDATION` in the Azure Pipeline. Use the path of the LicenseKeyValidation.ps1 script file as a value (e.g., D:\LicenseKeyValidator\LicenseKeyValidation.ps1).
+* Create a new [User-defined Variable](https://learn.microsoft.com/en-us/azure/devops/pipelines/process/variables?view=azure-devops&tabs=yaml%2Cbatch#user-defined-variables) named `LICENSE_VALIDATION` in the Azure Pipeline. Use the path of the LicenseKeyValidation.ps1 script file as the value (for example, `D:\LicenseKeyValidator\LicenseKeyValidation.ps1`). Store the license key as a secret variable (for example, `SYNCFUSION_LICENSE_KEY`).
 
-* Include the PowerShell task in the pipeline and execute the script to validate the license key. 
+* Add a PowerShell task that runs the script. Mark the build to fail when the script's exit code is non-zero so the pipeline reflects validation failures.
 
 ![LicenseKeyValidation script](licensing-images/license-validation-classic.png)
 
-## GitHub actions
+## GitHub Actions
 
-* To execute the script in PowerShell as part of a GitHub Actions workflow, include a step in the configuration file and update the path of the LicenseKeyValidation.ps1 script file (e.g., D:\LicenseKeyValidator\LicenseKeyValidation.ps1).
+* To execute the script in PowerShell as part of a GitHub Actions workflow, add a step in the workflow YAML file. Update the path of the LicenseKeyValidation.ps1 script file (for example, `./path/LicenseKeyValidator/LicenseKeyValidation.ps1`) and store the license key in a repository or organization secret named `SYNCFUSION_LICENSE_KEY`.
 
-The following example shows the syntax for validating the Syncfusion<sup>&reg;</sup> license key in GitHub actions.
+The following example shows the syntax for validating the Syncfusion<sup>&reg;</sup> license key in GitHub Actions.
 
 {% tabs %}
-{% highlight c# tabtitle="YAML" %}
-  steps:
+{% highlight yaml tabtitle="YAML" %}
+steps:
   - name: Syncfusion License Validation
     shell: pwsh
     run: |
@@ -99,9 +102,9 @@ The following example shows the syntax for validating the Syncfusion<sup>&reg;</
 
 ## Jenkins
 
-* Create an [Environment Variable](https://www.jenkins.io/doc/pipeline/tour/environment) named 'LICENSE_VALIDATION'. Use the path of the LicenseKeyValidation.ps1 script file as a value (e.g., D:\LicenseKeyValidator\LicenseKeyValidation.ps1).
+* Create an [Environment Variable](https://www.jenkins.io/doc/pipeline/tour/environment) named `LICENSE_VALIDATION`. Use the path of the LicenseKeyValidation.ps1 script file as the value (for example, `D:\LicenseKeyValidator\LicenseKeyValidation.ps1` on Windows agents or `/var/lib/jenkins/LicenseKeyValidator/LicenseKeyValidation.ps1` on Linux agents).
 
-* Include a stage in Jenkins to execute the LicenseKeyValidation.ps1 script in PowerShell. 
+* Add a stage that runs the `LicenseKeyValidation.ps1` script in PowerShell. The example below targets a Linux agent and uses the `sh` step; on Windows agents use the `bat` step with `pwsh`.
 
 The following example shows the syntax for validating the Syncfusion<sup>&reg;</sup> license key in the Jenkins pipeline.
 
@@ -125,46 +128,79 @@ pipeline {
 
 ## Validate the License Key By Using the ValidateLicense() Method
 
-* Register the license key properly by calling RegisterLicense("License Key") method with the license key. 
+* Register the license key by calling `SyncfusionLicenseProvider.RegisterLicense("YOUR LICENSE KEY")` before any Syncfusion control is instantiated.
 
-* Once the license key is registered, it can be validated by using the ValidateLicense("Platform.FileFormats") method. This ensures that the license key is valid for the platform and version you are using. For reference, please check the following example.
+* After registration, validate the key with `SyncfusionLicenseProvider.ValidateLicense(Platform.FileFormats)`, passing the `Platform` enum value that matches your application. This confirms the license is valid for the platform and version in use. The method returns `true` on success and `false` on failure; in overloads that include an `out string validationMessage` parameter, the message describes the failure reason. See the following examples for the correct signature by version.
 
 {% tabs %}
-{% highlight c# %}
+{% highlight csharp tabtitle="v34.1.29 and later" %}
+using Syncfusion.Licensing;
+
+// Register the Syncfusion license key
+SyncfusionLicenseProvider.RegisterLicense("YOUR LICENSE KEY");
+
+// Validate the registered license key.
+// The array overload allows validating against multiple platforms in a single call.
+bool isValid = SyncfusionLicenseProvider.ValidateLicense(new[] { Platform.FileFormats });
+{% endhighlight %}
+
+{% highlight csharp tabtitle="v31.1.17 to v33.2.3" %}
 using Syncfusion.Licensing;
 
-//Register Syncfusion license key 
-Syncfusion.Licensing.SyncfusionLicenseProvider.RegisterLicense("YOUR LICENSE KEY");
+// Register the Syncfusion license key
+SyncfusionLicenseProvider.RegisterLicense("YOUR LICENSE KEY");
 
-//Validate the registered license key
+// Validate the registered license key
+bool isValid = SyncfusionLicenseProvider.ValidateLicense(Platform.FileFormats);
+{% endhighlight %}
+
+{% highlight csharp tabtitle="Before v31.1.17" %}
+using Syncfusion.Licensing;
+
+// Register the Syncfusion license key
+SyncfusionLicenseProvider.RegisterLicense("YOUR LICENSE KEY");
+
+// Validate the registered license key
 bool isValid = SyncfusionLicenseProvider.ValidateLicense(Platform.FileFormats);
 {% endhighlight %}
 {% endtabs %}
 
-![LicenseKeyValidationMethod](licensing-images/license-validation-method.png)
+**v34.1.29 and later:**
+![License key validation - v34.1.29 and later](licensing-images/license-validation-method_v34.png)
+
+**v31.1.17 to v33.2.3:**
+![License key validation - v31.1.17 to v33.2.3](licensing-images/license-validation-method_v31.png)
+
+**Before v31.1.17:**
+![License key validation - Before v31.1.17](licensing-images/license-validation-method.png)
 
-* If the ValidateLicense() method returns true, registered license key is valid and can proceed with deployment.
+* If the `ValidateLicense()` method returns `true`, the registered license key is valid and the build can proceed with deployment.
 
-* If the ValidateLicense() method returns false, there will be invalid license errors in deployment due to either an invalid license key or an incorrect assembly or package version that is referenced in the project. Please ensure that all the referenced Syncfusion<sup>&reg;</sup> assemblies or NuGet packages are all on the same version as the license key’s version before deployment. 
+* If the `ValidateLicense()` method returns `false`, the build produces invalid license errors. Validation fails when the license key is invalid or the referenced Syncfusion assembly or package versions do not match the version of the license key. Ensure that all referenced Syncfusion<sup>&reg;</sup> assemblies or NuGet packages share the same version as the license key before deployment.
 
-## Validate the License Key By Using the Unit Test Project 
+## Validate the License Key By Using the Unit Test Project
 
-* To create a unit test project in Visual Studio, choose **File -> New -> Project** from the menu. This opens a new dialog for creating a new project. Filtering the project type by Test or typing Test as a keyword in the search option can help you to find available unit test projects. Select the appropriate test framework (such as MSTest, NUnit, or xUnit) that best suits your need.
+* To create a unit test project in Visual Studio, choose **File -> New -> Project** from the menu. This opens a new dialog for creating a new project. Filter the project type by Test, or type **Test** as a keyword in the search option, to find available unit test projects. Select the appropriate test framework (such as MSTest, NUnit, or xUnit) that best suits your need.
+
+* Add the required Syncfusion references to the test project. The example below uses NUnit, so install the NUnit and NUnit3TestAdapter NuGet packages, then add the `Syncfusion.Licensing` package and the File-Formats platform package (for example, `Syncfusion.PdfToPdfAConverter` or the platform package relevant to your project) at the same version as your license key.
 
 ![Unit Test Projects](licensing-images/unit-test-projects.png)
 
 * For more details on creating unit test projects in Visual Studio, refer to the [Getting Started with Unit Testing guide](https://learn.microsoft.com/en-us/visualstudio/test/getting-started-with-unit-testing?view=vs-2022&tabs=dotnet%2Cmstest#create-unit-tests).
 
-* Register the license key by calling the RegisterLicense("Your License Key") method with the license key in the unit test project.
+* Register the license key by calling `SyncfusionLicenseProvider.RegisterLicense("Your License Key")` in the unit test project. Register the key before any Syncfusion control is instantiated so the validation reflects the runtime configuration.
 
-N> * Place the license key between double quotes. Also, ensure that Syncfusion.Licensing.dll is referenced in your project where the license key is being registered.
+N> Enclose the license key in double quotes. Also, ensure that `Syncfusion.Licensing` (the `Syncfusion.Licensing.dll` assembly) is referenced in the project where the license key is registered. For .NET Core/5+ projects, add the `Syncfusion.Licensing` NuGet package; for .NET Framework projects, reference `Syncfusion.Licensing.dll` from the installed Essential Studio assemblies.
 
-* Once the license key is registered, it can be validated by using the ValidateLicense("Platform.FileFormats", out var validationMessage) method. This ensures that the license key is valid for the platform and version you are using.
+* Once the license key is registered, it can be validated by using the `ValidateLicense(Platform.FileFormats, out string validationMessage)` method. The `validationMessage` out parameter describes the failure reason when the result is `false`, which makes troubleshooting easier in unit-test output.
 
 * For reference, please check the following example that demonstrates how to register and validate the license key in the unit test project.
 
 {% tabs %}
 {% highlight c# %}
+using NUnit.Framework;
+using Syncfusion.Licensing;
+
 public void TestSyncfusionFileFormatsLicense()
 {
 	var platform = Platform.FileFormats;
@@ -183,12 +219,12 @@ public void TestSyncfusionFileFormatsLicense()
 {% endhighlight %}
 {% endtabs %}
 
-* Once the unit test is executed, if the license key validation passes for the specified platform, the output similar to the following will be displayed in the Test Explorer window.
+* Once the unit test is executed, if the license key validation passes for the specified platform, output similar to the following is displayed in the **Test Explorer** window.
 
 ![License Validation Success Message](licensing-images/unit-test-success-message.png)
 
-* If the license validation fails during unit testing, the following output will be displayed in the Test Explorer window.
+* If the license validation fails during unit testing, output similar to the following is displayed in the **Test Explorer** window.
 
 ![License Validation Failure Message](licensing-images/unit-test-failure-message.png)
 
-* License validation fails due to either an invalid license key or an incorrect assembly or package version that is referenced in the project. In such cases, verify that you are using the valid license key for the platform, and ensure the assembly or package versions referenced in the project match the version of the license key.
+* Validation fails when the license key is invalid or the referenced Syncfusion assembly or package versions do not match the version of the license key. Verify that you are using a valid key for the platform and that all referenced Syncfusion packages share the same version as the license key.