Releases: medic/cht-conf
v6.0.2
v6.0.1
v6.0.0
6.0.0 (2026-01-12)
- feat(#537)!: error when form internalId does not match file name (#776) (f921f1e)
- feat(#613)!: uplift pyxform to
v4.0.0-medic(#709) (d78296d)
BREAKING CHANGES
New bundled version of pyxform
Local pyxform installation is no longer required
Previously, the pyxform utility (required for converting form xlsx files to the xml xform format for upload) needed to be manually installed in the user's environment. Now pyxform (version v4.0.0-medic) is bundled with cht-conf and installed automatically when cht-conf is installed. The user simply needs Python 3.12+ available in their environment.
Existing cht-conf users can safely uninstall any local pyxform installation. cht-conf will only use the bundled instance of pyxform.
New pyxform version may require change to forms
The new version of pyxform brings with it a number of importiant changes that may require updating existing form xlsx files for compatibility. The known changes include:
Modified Functionality
- Attribute ordering in the generated XML file will now be deterministic.
- Re-converting an unmodified form should not result in any changes to the form's xml file.
- When converting a modified form, the only lines that will be changed in the form xml are ones that are directly related to the changes in the xlsx.
- Question fields are now required to have a label or hint. (Previously, pyxform would just print a warning if a question did not have a label or hint.)
- If you try to convert a form with a question field with an empty label (and no hint) it will fail with an error like:
The survey element named 'world' has no label or hint. - For fields that should not be displayed to the user, consider using the
caluculatetype when you have acalculationexpression or adefaultvalue. If the field value is not coming from thecalculationordefaultcolumns, thehiddentype can be used without a label/hint. This is particularly useful for input data fields or fields populated by the contact selector.
- If you try to convert a form with a question field with an empty label (and no hint) it will fail with an error like:
- Empty groups/repeats (without any child fields) now result in an error.
- Duplicate choice names now result in an error by default. However, support can be re-enabled via the
allow_choice_duplicatessetting. - pyxform will now warn when there are missing translation columns for any of the languages in the form.
Added functionality
triggercolumns are now supported, allowing for calculations to be automatically re-evaluated when an unrelated value changes!- You can now reference
${paths}in labels on thechoicessheet. - Support for randomizing choice order in select questions via the
randomize=trueparameter has been added.
Consistent naming of form identifier required
When there is a missmatch between the form_id in the xlsx, the file name for the xml, and the internalId from the properties file, cht-conf will now raise an error when you run the convert-*-forms action.
Now it is not required to specify the form identifier at all (in the xlsx, xml, or properties files). cht-conf will automatically set the form identifier based on the name of the xlsx file and the form type.
For cases where existing forms are now triggering an error:
contactforms - remove any custom identifiers specified in the xlsx or properties file forcontactforms.appforms - if a custom value (that does not match the xlsx file name) is currently specified as theform_idin the xlsx or theinternalIdin the properties file, the file name of the form's xlsx/xml file should be updated to match the custom identifier value.- The renamed form will be seen as a "new" form on the CHT instance (even though it will produce reports with the same
formvalue). So, be sure to remove the old version of the form from the instance before renaming and re-uploading the updated form. - Do not update the custom identifier value to match the form's file name. That will result in new reports being written with a different
formvalue and can produce data consistancy issues.
- The renamed form will be seen as a "new" form on the CHT instance (even though it will produce reports with the same
trainingforms - as with theappforms, if there is a missmatch in the identifier of atrainingform the file name of the training form xlsx/xml file should be updated to match the custom identifier.- Be sure to remove the old version of the form from the instance before renaming and re-uploading the updated form.
- Do not update the custom identifier value to match the form's file name. That will result in the form being treated as a totally new training and users would be prompted to redo the training even if they had previously completed it.