Configuration¶
The plugin works without any configuration, using sensible defaults. Adjusting them mainly pays off when procuring a TSE takes you longer than 30 days; in that case, raise the thresholds.
Settings¶
All settings are plugin properties of the POS (plugin ID
TseExpiryWarningPlugin):
| Property | Default | Meaning |
|---|---|---|
tseexpiry.banner.days |
30 |
How many days before expiry the notice appears on the login screen |
tseexpiry.dialog.days |
14 |
How many days before expiry the dialog appears after login |
tseexpiry.refresh.hours |
6 |
How often the plugin queries the TSE for the expiry date |
An invalid value (text instead of a number, say) is ignored; the plugin falls back to the default and records this in the log.
Maintaining the values¶
How plugin properties reach your POS systems depends on how your
installation is managed. Usually the partner or IT team that
distributes the rest of your POS configuration takes care of this.
Installations that use the Customer Checkout configuration import store
the values as a properties file TseExpiryWarningPlugin.properties,
for example:
tseexpiry.banner.days=45
tseexpiry.dialog.days=21
tseexpiry.refresh.hours=6
When changes take effect¶
- The plugin re-reads the two thresholds (
banner.days,dialog.days) every time it displays a warning; they take effect as soon as the values have arrived on the POS. - The plugin reads the refresh interval (
refresh.hours) only at startup; a change takes effect after the next restart of the POS.