OpenCRVS - v1.6.0

Introduction

Read the release notes!

OpenCRVS v1.6.0 is a minor release which includes bug fixes, improvements and new functionality.
It is to be used in conjunction with a forked country configuration release v1.6.0

Improvements

• Fetch child identifier in view record

New features

• Certificate handlebar for registration fees registrationFees #6817

• Logged in user details handlebar loggedInUser #6529

• Supporting document fields can now be made required

• If there is only one option in the document uploader select, then it stays hidden and only the upload button is showed with the only option being selected by default

• Allow configuring the default search criteria for record search #6924

• Add checks to validate client and server are always on the same version. This prevents browsers with a cached or outdated client versions from making potentially invalid requests to the backend #6695

• Add http request creation ability to the form with a set of new form components (HTTP,BUTTON,REDIRECT) #7489

• ElasticSearch reindexing

  Allows reindexing ElasticSearch via a new search-service endpoint reindex. We're replacing the original ocrvs index with timestamped ones. This is done automatically when upgrading and migrating, but this is an important architectural change that should be noted. More details in #7033.

• Introduce a new certificate handlebar "preview" which can be used to conditionally render some svg element when previewing the certificate e.g. background image similar to security paper

Improvements

• Internally we were storing the family name field as a required property which was limiting what how you could capture the name of a person in the forms. Now we are storing it as an optional property which would make more flexible.
• Remove the leftover features from the application config pages, such as certificates and informant notification. #7156
• PDF page size The generated PDF used to be defaulted to A4 size. Now it respects the SVG dimensions if specified
• Support html content wrapped in foreignObject used in svg template in certificate PDF output

Bug fixes

• Custom form field validators from country config will work offline. #7478
• Registrar had to retry from outbox every time they corrected a record. #7583
• Local environment setup command (bash setup.sh) could fail in machines that didn't have a unrelated compose binary. Fixed to check for Docker Compose. #7609
• Fix date validation not working correctly in Firefox #7615
• Fix layout issue that was causing the edit button on the AdvancedSearch's date range picker to not show on mobile view. #7417
• Fix hardcoded placeholder copy of input when saving a query in advanced search
• Handle label params used in form inputs when rendering in action details modal
• Fix health facilities missing from dropdown after correcting a record address #7528
• "Choose a new password" form now allows the user to submit the form using the "Enter/Return" key #5502
• Dropdown options now flow to multiple rows in forms #7653
• Only render units/postfix when field has a value #7055
• Only show items with values in review #5192
• Fix prefix text overlap issue in form text inputs
• Staged files getting reset on precommit hook failure We were running lint-staged separately on each package using lerna which potentially created a race condition causing staged changes to get lost on failure. Now we are running lint-staged directly without depending on lerna. This is purely a DX improvement without affecting any functionality of the system
• Fix informantType missing in template object which prevented rendering informant relationship data in the certificates #5952
• Fix users hitting rate limit when multiple users authenticated the same time with different usernames #7728

Breaking changes

• Remove informant notification configuration from the UI and read notification configuration settings from record-notification endpoint in countryconfig
• Remove DEL /elasticIndex endpoint due reindexing changes.
• Gateways searchEvents API updated operationHistories only returns operationType & operatedOn due to the other fields being unused in OpenCRVS
• Config changes to review/preview and signatures Core used to provide review/preview section by default which are now removed and need to be provided from countryconfig. The signature field definitions (e.g. informant signature, bride signature etc.) were hard coded in core which also have now been removed. The signatures can now be added through the review/preview sections defined in countryconfig just like any other field. You can use the following section definition as the default which is without any additional fields. We highly recommend checking out our reference country repository which has the signature fields in its review/preview sections
• hasChildLocation query has been removed from gateway. We have created the query isLeafLevelLocation instead which is more descriptive on its intended use.

{
  id: 'preview',
  viewType: 'preview',
  name: {
    defaultMessage: 'Preview',
    description: 'Form section name for Preview',
    id: 'register.form.section.preview.name'
  },
  title: {
    defaultMessage: 'Preview',
    description: 'Form section title for Preview',
    id: 'register.form.section.preview.title'
  },
  groups: [
    {
      id: 'preview-view-group',
      fields: []
    }
  ]
}

New features

• Conditional filtering for document select options The select options for the DOCUMENT_UPLOADER_WITH_OPTION field can now be conditionally filtered similar to the SELECT_WITH_OPTIONS field using the optionCondition field

Bug fixes

• Fix wrong status shown in the Comparison View page of the duplicate record #7439