From 012a87dcb70bdc880e6b3dd8a4c488be33c7570e Mon Sep 17 00:00:00 2001 From: Alexey Averikhin Date: Thu, 18 Jul 2024 21:09:28 +0200 Subject: [PATCH] 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 edb0d6e..a4b0896 100644 --- a/docs/licensing-models/subscription.md +++ b/docs/licensing-models/subscription.md @@ -106,3 +106,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.