Skip to content

Upgrading an Existing Installation

For most installations everything is upgraded automatically when you bump the version of the dependency to limepkg-kpi.

Upgrading to v1.4.0

Each configured target is now assigned a unique id (a 36 character uuid), and the target_name field on the kpi table stores that id instead of the target's name.

  1. Open the add-on configuration in Lime Admin and save it. This assigns an id to every target. The ids are generated automatically, so do not add them yourself.
  2. Check the length of the target_name field on the kpi table. It must be at least 36 characters to hold the uuid. If it is shorter, saving a target fails with an HTTP 500 error. Extend it to 64 using LISA or the database editor in Lime Admin, and publish the change.
  3. Ask users to set their targets again. Targets set before this version stored the target's name in target_name rather than its id, so those records are no longer matched and previously set targets are not shown. Alternatively, update target_name on the affected kpi records manually to the corresponding target id from the configuration.

Note

Every released version of limepkg-kpi creates target_name with a length of 64, so step 2 only applies to installations whose kpi table was created before the first release. Re-running the add-on installer does not correct it, because the installer only sets attributes when it creates a field and never alters existing ones.

Upgrading to v1.3.1

The configuration format changed. The measurement fields are now nested under kpi.target rather than sitting directly on kpi, and kpi.target.owner_property is required.

  1. Open the add-on configuration in Lime Admin and save it. If validation reports Unknown field. errors, the stored configuration is still in the old format and each target needs to be updated to the new structure.

Upgrading to v1.3.0

The lwc-limepkg-kpi-visualize-kpi-root component was removed. A limetype view that still references it renders an empty space without any error.

  1. Remove lwc-limepkg-kpi-visualize-kpi-root from the limetype view.
  2. Add a custom tab with the kpi-visualize-chart component to each owner limetype's card, as described in Configuration.