From 7af6ceb3e57ae19ee16036f6b943a3325c5de06e Mon Sep 17 00:00:00 2001 From: Alexey Averikhin Date: Wed, 22 May 2024 16:58:38 +0200 Subject: [PATCH 1/6] NLIC-2442 - prepare Warning Level documentation --- docs/warning-level.md | 70 +++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 70 insertions(+) create mode 100644 docs/warning-level.md diff --git a/docs/warning-level.md b/docs/warning-level.md new file mode 100644 index 0000000..35e3eb8 --- /dev/null +++ b/docs/warning-level.md @@ -0,0 +1,70 @@ +--- +layout: default +title: Warning Level +nav_order: 93 +description: "Labs64 NetLicensing warning level" +permalink: warning-level +--- + +{{ page.title }} +================ + +The NetLicensing Warning Level feature provides vendors with valuable metrics regarding the current licensing status of a specific customer. Represented as a traffic light, the Warning Level indicates whether a customer profile is fully licensed, approaching under-licensing, or has reached under-licensing. + +Important Clarifications +------------------------ + +- **Warning Level** vs. **Valid Parameter**: The Warning Level should not be confused with the `valid` parameter in the validation response. While the valid parameter represents the current validity of a specific licensing model for a given customer, the Warning Level offers an informative status of the licensing situation, highlighting potential or imminent under-licensing issues. +- **Purpose**: The Warning Level is designed to be an indicator of the licensee's health and is not intended to replace the validation response. It serves solely as a supplementary metric to provide insights into licensing status. + +Statuses +-------- + +The Warning Level is calculated during each validation request and is represented by the following statuses: +- GREEN – the customer is licensed for all configured product modules +- YELLOW – some licensing parameters are approaching under-licensed status +- RED – some licensing parameters have reached under-licensed status + +**Note:** The warning level status resets after a certain period, usually due to extended licensee inactivity or delayed validation requests. When this occurs, the customer status is shown as `GREY (undefined)`. You can force an update of the Warning Level by sending a validation request with the parameter `dryRun` set to `true`. + +Access +------ + +The Warning Level can be accessed via the following [RESTful API](restful-api) methods: + +### Validation + +The `warningLevel` parameter is included in the [validation results](licensee-services#validate-licensee) for each product module. + +**Example:** +```xml +GREEN +``` + +### Get Licensee + +The `warningLevel` parameter provides a combined [result](licensee-services#get-licensee) of all product modules and their respective warning level statuses. + +**Example:** +```xml + + {"RED":["M7W5JGF4D","MKFRA22H3"],"YELLOW":[],"GREEN":["MVA66EEE6"]} + +``` + +Rules +----- + +Every licensing model specify its own ruleset determining warning level. Please find below detailed description for each licensing model: + +| | GREEN | YELLOW | RED | +|:---------------|:------|:-------|:----| +| [Try & Buy](try-n-buy) | trialPeriodActive = true
AND
featureAquired = true | trialPeriodActive = true | trialPeriodActive = false
AND
featureAquired = false | +| [Subscription](subscription) | timeUsed < 80% | timeUsed >= 80% | timeUsed = 100% | +| [Pricing Table](pricing-table) | timeUsed < 80% | timeUsed >= 80% | timeUsed = 100% | +| [Rental](rental) | Time-volume not reached yellow threshold
AND
Time-volume not reached red threshold | Time-volume reached yellow threshold | No time-volume license associated with the feature license
OR
Time-volume license expired
OR
Time-volume reached red threshold | +| [Floating](floating) | sessionsUsed < 80% | sessionsTotal < 10 AND sessionsUsed >= sessionsTotal
OR
sessionsUsed >= 80% | sessionsTotal >= 10
AND
sessionsUsed >= sessionsTotal | +| [Multi-Feature](multi-feature) | always GREEN | N/A | N/A | +| [Pay-per-Use](pay-per-use) | remainingQuantity < 80% | remainingQuantity >= 80% | remainingQuantity = 100% | +| [Node-Locked](node-locked) | nodeSecretsUsed < 80% | nodeSecretsTotal < 10 AND nodeSecretsUsed >= nodeSecretsTotal
OR
nodeSecretsUsed >= 80% | nodeSecretsTotal >= 10
AND
nodeSecretsUsed >= nodeSecretsTotal | +| [Quota](quota) | totalQuota > 0 | N/A | totalQuota = 0 | From 139cad59d5aeb83d9ae31a6c02ab97947bb52b4f Mon Sep 17 00:00:00 2001 From: "R.Brown" Date: Wed, 17 Jul 2024 16:30:35 +0200 Subject: [PATCH 2/6] Update docs/warning-level.md Co-authored-by: Konstantin Korotkov --- docs/warning-level.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/warning-level.md b/docs/warning-level.md index 35e3eb8..83d537c 100644 --- a/docs/warning-level.md +++ b/docs/warning-level.md @@ -14,8 +14,8 @@ The NetLicensing Warning Level feature provides vendors with valuable metrics re Important Clarifications ------------------------ -- **Warning Level** vs. **Valid Parameter**: The Warning Level should not be confused with the `valid` parameter in the validation response. While the valid parameter represents the current validity of a specific licensing model for a given customer, the Warning Level offers an informative status of the licensing situation, highlighting potential or imminent under-licensing issues. -- **Purpose**: The Warning Level is designed to be an indicator of the licensee's health and is not intended to replace the validation response. It serves solely as a supplementary metric to provide insights into licensing status. +- **Warning Level** vs. **Valid Status**: The Warning Level should not be confused with the `valid` status in the validation response. While the `valid` status indicates the current validity of a specific product module for a given customer at the time of the request, the Warning Level value provides information about potential or imminent changes in the licensing situation, highlighting any forthcoming under-licensing issues. +- **Purpose**: The Warning Level is intended to act as an indicator of the licensee's health and is not meant to replace the validation response. It serves solely as a supplementary metric, providing an early warning if the customer's licensing situation is likely to change soon or requires immediate action. Statuses -------- From 63744f3395aab38e9cc33967ff830f9ed292ec22 Mon Sep 17 00:00:00 2001 From: "R.Brown" Date: Wed, 17 Jul 2024 16:30:51 +0200 Subject: [PATCH 3/6] Update docs/warning-level.md Co-authored-by: Konstantin Korotkov --- docs/warning-level.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/warning-level.md b/docs/warning-level.md index 83d537c..f0d2366 100644 --- a/docs/warning-level.md +++ b/docs/warning-level.md @@ -34,7 +34,7 @@ The Warning Level can be accessed via the following [RESTful API](restful-api) m ### Validation -The `warningLevel` parameter is included in the [validation results](licensee-services#validate-licensee) for each product module. +The `warningLevel` value is included in the [validation results](licensee-services#validate-licensee) for each product module. **Example:** ```xml From d2b10f88464f5286a74c68649b7f0a23d9c41116 Mon Sep 17 00:00:00 2001 From: "R.Brown" Date: Wed, 17 Jul 2024 16:31:05 +0200 Subject: [PATCH 4/6] Update docs/warning-level.md Co-authored-by: Konstantin Korotkov --- docs/warning-level.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/warning-level.md b/docs/warning-level.md index f0d2366..e893fd4 100644 --- a/docs/warning-level.md +++ b/docs/warning-level.md @@ -43,7 +43,7 @@ The `warningLevel` value is included in the [validation results](licensee-servic ### Get Licensee -The `warningLevel` parameter provides a combined [result](licensee-services#get-licensee) of all product modules and their respective warning level statuses. +The `warningLevel` value in the licensee object provides a combined [result](licensee-services#get-licensee) of all product modules and their respective warning levels. This is a cached value, and is not recalculated on the request - see the note in the "Supported Warning Levels" section above. **Example:** ```xml From f8e4cf7540f450a08415bb62ad03cc3f2d3b6612 Mon Sep 17 00:00:00 2001 From: "R.Brown" Date: Wed, 17 Jul 2024 16:32:18 +0200 Subject: [PATCH 5/6] Update docs/warning-level.md Co-authored-by: Konstantin Korotkov --- docs/warning-level.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/warning-level.md b/docs/warning-level.md index e893fd4..02bfe27 100644 --- a/docs/warning-level.md +++ b/docs/warning-level.md @@ -17,15 +17,15 @@ Important Clarifications - **Warning Level** vs. **Valid Status**: The Warning Level should not be confused with the `valid` status in the validation response. While the `valid` status indicates the current validity of a specific product module for a given customer at the time of the request, the Warning Level value provides information about potential or imminent changes in the licensing situation, highlighting any forthcoming under-licensing issues. - **Purpose**: The Warning Level is intended to act as an indicator of the licensee's health and is not meant to replace the validation response. It serves solely as a supplementary metric, providing an early warning if the customer's licensing situation is likely to change soon or requires immediate action. -Statuses +Supported Warning Levels -------- -The Warning Level is calculated during each validation request and is represented by the following statuses: -- GREEN – the customer is licensed for all configured product modules -- YELLOW – some licensing parameters are approaching under-licensed status -- RED – some licensing parameters have reached under-licensed status +The Warning Level can have one of the following values: +- **GREEN (Licensed):** The customer is licensed for all configured product modules. +- **YELLOW (Warning):** Some product modules are approaching under-licensed status. +- **RED (Underlicensed):** Some product modules have reached under-licensed status. -**Note:** The warning level status resets after a certain period, usually due to extended licensee inactivity or delayed validation requests. When this occurs, the customer status is shown as `GREY (undefined)`. You can force an update of the Warning Level by sending a validation request with the parameter `dryRun` set to `true`. +**Note:** The warning level is calculated with each validation request from the customer and cached for a period of time. The value may be evicted from cache due to extended inactivity (no validation requests) or license changes since the last validation. In such cases, the warning level is not returned via API and is shown as grey-colored `Unknown` in the UI. To force an update, send a validation request with the `dryRun` parameter set to `true` (or click refresh symbol in the UI). Be aware that some licenses only activate on the first non-dry validation request, which may cause the warning level to be incorrectly reported as RED or YELLOW if updated via a dry validation. Access ------ From 54781210bb0ed028d52eabc68885ee85ecb60bea Mon Sep 17 00:00:00 2001 From: Alexey Averikhin Date: Thu, 18 Jul 2024 21:09:28 +0200 Subject: [PATCH 6/6] Add warning levels descriptions to the specific licensing models --- docs/licensing-models/floating.md | 9 +++++++++ docs/licensing-models/multi-feature.md | 9 +++++++++ docs/licensing-models/node-locked.md | 9 +++++++++ docs/licensing-models/pay-per-use.md | 9 +++++++++ docs/licensing-models/pricing-table.md | 9 +++++++++ docs/licensing-models/quota.md | 9 +++++++++ docs/licensing-models/rental.md | 9 +++++++++ docs/licensing-models/subscription.md | 9 +++++++++ docs/licensing-models/try-n-buy.md | 9 +++++++++ docs/warning-level.md | 15 ++------------- 10 files changed, 83 insertions(+), 13 deletions(-) diff --git a/docs/licensing-models/floating.md b/docs/licensing-models/floating.md index 160d2fa..4ddb5a8 100644 --- a/docs/licensing-models/floating.md +++ b/docs/licensing-models/floating.md @@ -135,3 +135,12 @@ productModuleNumber0=Floating-DEMO&sessionId0=SampleSessionId&action0=checkIn ``` {: .ml-5 } + +Warning Levels +-------------- + +Below are the default [warning levels](warning-level) associated with this licensing model. + +| GREEN | YELLOW | RED | +|:------|:-------|:----| +| sessionsUsed < 80% | sessionsTotal < 10 AND sessionsUsed >= sessionsTotal
OR
sessionsUsed >= 80% | sessionsTotal >= 10
AND
sessionsUsed >= sessionsTotal | diff --git a/docs/licensing-models/multi-feature.md b/docs/licensing-models/multi-feature.md index 51448c5..8ccb9a9 100644 --- a/docs/licensing-models/multi-feature.md +++ b/docs/licensing-models/multi-feature.md @@ -52,3 +52,12 @@ Validation response example: ``` {: .ml-5 } + +Warning Levels +-------------- + +Below are the default [warning levels](warning-level) associated with this licensing model. + +| GREEN | YELLOW | RED | +|:------|:-------|:----| +| always GREEN | N/A | N/A | diff --git a/docs/licensing-models/node-locked.md b/docs/licensing-models/node-locked.md index 06c0fb3..f28d6f9 100644 --- a/docs/licensing-models/node-locked.md +++ b/docs/licensing-models/node-locked.md @@ -127,3 +127,12 @@ productModuleNumber0=MTEST-DEMO&nodeSecret0=HardwareOrGeneratedSecret ``` {: .ml-5 } + +Warning Levels +-------------- + +Below are the default [warning levels](warning-level) associated with this licensing model. + +| GREEN | YELLOW | RED | +|:------|:-------|:----| +| nodeSecretsUsed < 80% | nodeSecretsTotal < 10 AND nodeSecretsUsed >= nodeSecretsTotal
OR
nodeSecretsUsed >= 80% | nodeSecretsTotal >= 10
AND
nodeSecretsUsed >= nodeSecretsTotal | diff --git a/docs/licensing-models/pay-per-use.md b/docs/licensing-models/pay-per-use.md index 559ed04..7fa7a7a 100644 --- a/docs/licensing-models/pay-per-use.md +++ b/docs/licensing-models/pay-per-use.md @@ -275,3 +275,12 @@ productModuleNumber0=MTEST-DEMO&reserveQuantity0=20   ``` {: .ml-5 } + +Warning Levels +-------------- + +Below are the default [warning levels](warning-level) associated with this licensing model. + +| GREEN | YELLOW | RED | +|:------|:-------|:----| +| remainingQuantity < 80% | remainingQuantity >= 80% | remainingQuantity = 100% | diff --git a/docs/licensing-models/pricing-table.md b/docs/licensing-models/pricing-table.md index e86dbd7..2c568c6 100644 --- a/docs/licensing-models/pricing-table.md +++ b/docs/licensing-models/pricing-table.md @@ -204,3 +204,12 @@ Accept: application/xml ``` {: .ml-5 } + +Warning Levels +-------------- + +Below are the default [warning levels](warning-level) associated with this licensing model. + +| GREEN | YELLOW | RED | +|:------|:-------|:----| +| timeUsed < 80% | timeUsed >= 80% | timeUsed = 100% | diff --git a/docs/licensing-models/quota.md b/docs/licensing-models/quota.md index 16d07fc..7b565c2 100644 --- a/docs/licensing-models/quota.md +++ b/docs/licensing-models/quota.md @@ -83,3 +83,12 @@ Validation response example: ``` {: .ml-5 } + +Warning Levels +-------------- + +Below are the default [warning levels](warning-level) associated with this licensing model. + +| GREEN | YELLOW | RED | +|:------|:-------|:----| +| totalQuota > 0 | N/A | totalQuota = 0 | diff --git a/docs/licensing-models/rental.md b/docs/licensing-models/rental.md index 86c41c4..c669b70 100644 --- a/docs/licensing-models/rental.md +++ b/docs/licensing-models/rental.md @@ -269,3 +269,12 @@ The logic is simple: - When the amount of days remaining until expiration is more than "`yellowThreshold`", "`expirationWarningLevel`" == "`green`" - When the amount of days remaining until expiration is more than "`redThreshold`", but less then or equal to the "`yellowThreshold`", "`expirationWarningLevel`" == "`yellow`" - When the amount of days remaining until expiration is less then or equal to the "`redThreshold`", "`expirationWarningLevel`" == "`red`" + +Warning Levels +-------------- + +Below are the default [warning levels](warning-level) associated with this licensing model. + +| GREEN | YELLOW | RED | +|:------|:-------|:----| +| Time-volume not reached yellow threshold
AND
Time-volume not reached red threshold | Time-volume reached yellow threshold | No time-volume license associated with the feature license
OR
Time-volume license expired
OR
Time-volume reached red threshold | diff --git a/docs/licensing-models/subscription.md b/docs/licensing-models/subscription.md index 6b30b7c..d209a35 100644 --- a/docs/licensing-models/subscription.md +++ b/docs/licensing-models/subscription.md @@ -105,3 +105,12 @@ Accept: application/xml ``` {: .ml-5 } + +Warning Levels +-------------- + +Below are the default [warning levels](warning-level) associated with this licensing model. + +| GREEN | YELLOW | RED | +|:------|:-------|:----| +| timeUsed < 80% | timeUsed >= 80% | timeUsed = 100% | diff --git a/docs/licensing-models/try-n-buy.md b/docs/licensing-models/try-n-buy.md index d5f7b5f..521bf31 100644 --- a/docs/licensing-models/try-n-buy.md +++ b/docs/licensing-models/try-n-buy.md @@ -99,3 +99,12 @@ Accept: application/xml ``` {: .ml-5 } + +Warning Levels +-------------- + +Below are the default [warning levels](warning-level) associated with this licensing model. + +| GREEN | YELLOW | RED | +|:------|:-------|:----| +| trialPeriodActive = true
AND
featureAquired = true | trialPeriodActive = true | trialPeriodActive = false
AND
featureAquired = false | diff --git a/docs/warning-level.md b/docs/warning-level.md index 02bfe27..912dfe3 100644 --- a/docs/warning-level.md +++ b/docs/warning-level.md @@ -55,16 +55,5 @@ The `warningLevel` value in the licensee object provides a combined [result](lic Rules ----- -Every licensing model specify its own ruleset determining warning level. Please find below detailed description for each licensing model: - -| | GREEN | YELLOW | RED | -|:---------------|:------|:-------|:----| -| [Try & Buy](try-n-buy) | trialPeriodActive = true
AND
featureAquired = true | trialPeriodActive = true | trialPeriodActive = false
AND
featureAquired = false | -| [Subscription](subscription) | timeUsed < 80% | timeUsed >= 80% | timeUsed = 100% | -| [Pricing Table](pricing-table) | timeUsed < 80% | timeUsed >= 80% | timeUsed = 100% | -| [Rental](rental) | Time-volume not reached yellow threshold
AND
Time-volume not reached red threshold | Time-volume reached yellow threshold | No time-volume license associated with the feature license
OR
Time-volume license expired
OR
Time-volume reached red threshold | -| [Floating](floating) | sessionsUsed < 80% | sessionsTotal < 10 AND sessionsUsed >= sessionsTotal
OR
sessionsUsed >= 80% | sessionsTotal >= 10
AND
sessionsUsed >= sessionsTotal | -| [Multi-Feature](multi-feature) | always GREEN | N/A | N/A | -| [Pay-per-Use](pay-per-use) | remainingQuantity < 80% | remainingQuantity >= 80% | remainingQuantity = 100% | -| [Node-Locked](node-locked) | nodeSecretsUsed < 80% | nodeSecretsTotal < 10 AND nodeSecretsUsed >= nodeSecretsTotal
OR
nodeSecretsUsed >= 80% | nodeSecretsTotal >= 10
AND
nodeSecretsUsed >= nodeSecretsTotal | -| [Quota](quota) | totalQuota > 0 | N/A | totalQuota = 0 | +Each licensing model specifies its own ruleset for determining the warning level. +Please refer to the description of the particular [licensing model](licensing-models) to see its specific warning level ruleset.