Quickfix
From time to time it is necessary to make special adjustments for individual customers, which will be incorporated into the product, but cannot be tested extensively in a variety of scenarios.
For this purpose we have created the "Quickfix" facility: Customizations or early stage features are shipped so that they are completely disabled until the associated "Quickfix" is activated.
The Quickfix is an ID. Each affected customer will be personally notified of their Quickfix ID.
No Quickfix may be activated without a corresponding request!!
However, due to our transparency promise, we will openly describe here how a Quickfix is activated. However, we will not describe what quickfixes already embedded in the program do.
Quickfixes are activated using system-wide environment variables. User-specific environment variables are never used!
A quickfix can be enabled for all kenaflow instances on the current server, or only for one or more instances.
The format for the environment variables for all instances is:
kenaflow_quickfix_<id>
where <id>
is replaced by a number starting from 1.
The format for the environment variable for one instance is:
kenaflow_<instance-id>_quickfix_<id>
where <instance-id>
is replaced by the unique kenaflow instance id and <id>
is replaced by a number starting from 1.
For the environment variable for all instances (e.g. kenaflow_quickfix_3
), the following values are allowed:
- an integer less than or equal to
-2
. - the number
-1
- the number 0
- the number
1
- an integer greater than or equal to
2
.
The following values are allowed for the environment variable for one instances (e.g. kenaflow_515eca7f-7ff9-4e0a-95b2-b7ed1a21e0d1_quickfix_3
):
- an integer less than or equal to
-1
- the number 0
- an integer greater than or equal to
1
.
Whether a quickfix is active for a kenaflow instance is determined by BOTH values.
If the value for all instances is <= -2
then the quickfix is forcibly disabled. The setting for one instance is ignored.
If the value for all instances is >= 2
then the quickfix is forcibly enabled. The setting for the one instance is ignored.
If the value for all instances is = -1
then it is suggested that the quickfix is disabled, but the setting for one instance may override this. However, if the value for one instance is 0
or no value, then this setting is used.
If the value for all instances is = 1
then it is suggested that the quickfix is enabled, but the setting for one instance may override this. However, if the value for one instance is 0
or no value, then this setting is used.
If the value for all instances is = 0
, then this value is ignored, as well as if the environment variable does not exist at all.
Then the value for one instance is evaluated, but only if the quickfix is not forcibly disabled or enabled.
If the value for the one instance is <= -1
then the quickfix is disabled.
If the value for the one inscance is >= 1
then the quickfix is activated.
If the value for the one instance is = 0
, then this value is ignored, also if the environment variable does not exist at all.
If both values are 0
or do not exist, then the quickfix remains disabled.
After changing such an environment variable or activating or deactivating a Quickfix by using --setquickfix
or --deletequickfix
all running kenaflow processes must be restarted to "see" the change. This is not done automatically. Especially debuggers - like VS Code or Powershell ISE - has to be restarted.