DI‐Portal‐GF‐009 Relevance of API‐Processor Versions

Design Item ID: DI-Portal-GF-009
Design Item Name: Relevance of API-Processor Versions
Related Design Items:
Related API:
Revision History:

Date	Description

---

Assumptions:

1. The requirements are applicable to both packages and dashboards; further using the word package will mean both packages and dashboards.
2. Actual builder version can be "unknown"
3. Currently, there are cases when new builder version was released, but no migration was performed. So in this case builder version of builded revision will not the same as actual one. Therefore, it was decided to perform migration every time when new version of api-processor released.
   • However, to ensure this, it is needed to implement pre-requisite with speeding-up migration process.
4. Current story consider cases when downgrade of builder version is possible.
5. The requirements are applicable only to the state when migration is not running.

Cases with api-processor versions:

1. Case 1: "client builder version = be builder version" & "revision api-processor version < client api-processor version" & "client api-processor version = be api-processor version"

   revision api-processor version	client api-processor version	be api-processor version
   1	2	2

   • Error message for package version: "The data in the version may be incorrect, as the data has not been processed according to the latest system rules. Please republish the version and if this does not help, contact the system administrators."
   • Blocking error message for publish popups:

2. Case 2: "client builder version = be builder version" & "revision api-processor version > client api-processor version" & "client api-processor version = be api-processor version"

   revision api-processor version	client api-processor version	be api-processor version
   2	1	1

   • Error message for package version: "The data in the version may be incorrect, please contact the system administrators."
   • Blocking error message for publish popups:

3. Case 3: "client builder version = be builder version" & "revision builder version = client builder version" & "client builder version = be builder version" => No errors

   revision api-processor version	client api-processor version	be api-processor version
   1	1	1

   • Error message for package version: none
   • Blocking error message for publish popups: none

4. Case 4: client builder version < be builder version

   • Error message for package version: "The data in the version may be incorrect, as the data has not been processed according to the latest system rules. Please clear your browser caches and if this does not help, contact the system administrators."
   • Blocking error message for publish popups:

5. Case 5: client builder version > be builder version

   • Error message for package version: "The data in the version may be incorrect, as the data has not been processed according to the latest system rules. Please clear your browser caches and if this does not help, contact the system administrators."
   • Blocking error message for publish popups: