Add warning levels descriptions to the specific licensing models

Labs64 · Jul 25, 2024 · 012a87d · 012a87d
1 parent 38b18a7
commit 012a87d
Show file tree

Hide file tree

Showing 10 changed files with 83 additions and 13 deletions.
diff --git a/docs/licensing-models/floating.md b/docs/licensing-models/floating.md
@@ -135,3 +135,12 @@ productModuleNumber0=Floating-DEMO&sessionId0=SampleSessionId&action0=checkIn
 </netlicensing>
 ```
 {: .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<br>OR<br>sessionsUsed >= 80% | sessionsTotal >= 10<br>AND<br>sessionsUsed >= sessionsTotal |
diff --git a/docs/licensing-models/multi-feature.md b/docs/licensing-models/multi-feature.md
@@ -52,3 +52,12 @@ Validation response example:
 </ns2:netlicensing>
 ```
 {: .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
@@ -127,3 +127,12 @@ productModuleNumber0=MTEST-DEMO&nodeSecret0=HardwareOrGeneratedSecret
 </ns2:netlicensing>
 ```
 {: .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<br>OR<br>nodeSecretsUsed >= 80% | nodeSecretsTotal >= 10<br>AND<br>nodeSecretsUsed >= nodeSecretsTotal |
diff --git 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
 </netlicensing> 
 ```
 {: .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
@@ -204,3 +204,12 @@ Accept: application/xml
 </ns2:netlicensing>
 ```
 {: .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
@@ -83,3 +83,12 @@ Validation response example:
 </ns2:netlicensing>
 ```
 {: .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
@@ -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<br>AND<br>Time-volume not reached red threshold | Time-volume reached yellow threshold | No time-volume license associated with the feature license<br>OR<br>Time-volume license expired<br>OR<br>Time-volume reached red threshold |
diff --git a/docs/licensing-models/subscription.md b/docs/licensing-models/subscription.md
@@ -106,3 +106,12 @@ Accept: application/xml
 </netlicensing>
 ```
 {: .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
@@ -99,3 +99,12 @@ Accept: application/xml
 </ns2:netlicensing>
 ```
 {: .ml-5 }
+
+Warning Levels
+--------------
+
+Below are the default [warning levels](warning-level) associated with this licensing model.
+
+| GREEN | YELLOW | RED |
+|:------|:-------|:----|
+| trialPeriodActive = true<br>AND<br>featureAquired = true | trialPeriodActive = true | trialPeriodActive = false<br>AND<br>featureAquired = false |
diff --git 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<br>AND<br>featureAquired = true | trialPeriodActive = true | trialPeriodActive = false<br>AND<br>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<br>AND<br>Time-volume not reached red threshold | Time-volume reached yellow threshold | No time-volume license associated with the feature license<br>OR<br>Time-volume license expired<br>OR<br>Time-volume reached red threshold |
-| [Floating](floating) | sessionsUsed < 80% | sessionsTotal < 10 AND sessionsUsed >= sessionsTotal<br>OR<br>sessionsUsed >= 80% | sessionsTotal >= 10<br>AND<br>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<br>OR<br>nodeSecretsUsed >= 80% | nodeSecretsTotal >= 10<br>AND<br>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.