Skip to content

Releases: Indicia-Team/client_helpers

v9.4.0

25 Sep 14:22
Compare
Choose a tag to compare
  • The Bulk Edit tool now supports a preview of changes to a sample of records. See
    BiologicalRecordsCentre/iRecord#1673.
  • New support for groups (iRecord Activities) being linked - a container group can contain multiple
    contained groups (in iRecord, the terminology will be Projects contain multiple Project
    Activities). A Container group is an administrative container for a collection of related
    projects, e.g. a larger project could be split into different teams on taxonomy, location or
    year. Containers have no data entry pages themselves but can have reports which collect all the
    records from the contained groups, and contained groups can automatically apply the filter of the
    container. See BiologicalRecordsCentre/iRecord#1678.
  • The "Create or edit a group" prebuilt form has been modified to support options for controlling
    container and contained groups plus the permissions required to allow blogging.
  • The Group Discovery tool now features a search and also allows viewing the list of groups
    (activities) you are a member of. See BiologicalRecordsCentre/iRecord#1681.
  • The Species Details 2 prebuilt form now supports a group_id parameter in the URL query string
    which filters the data shown to the data collected for a group/activity.
  • In the V2 importer, there is now code which prevents selection of conflicting fields. See
    BiologicalRecordsCentre/iRecord#1655.
  • Improves the layout of the filter panel Source tab - fixes
    BiologicalRecordsCentre/iRecord#1708.
  • Other minor layout improvements to the filter builder.
  • The Card Gallery component now supports a horizontal layout option.
  • The columns configuration tool on the Elasticsearch dataGrid component is now displayed in a
    FancyBox popup, fixing some display issues. See
    BiologicalRecordsCentre/iRecord#1672.
  • The Elasticsearch dataGrid control has some bug fixes to behaviour when there is HTML in a
    column template.
  • Aggregated Elasticsearch reports can now set a @shard_size option on the dataSource which can
    be used to increase the accuracy of aggregated data such as counts given in report results .
  • The Elasticsearch dataGrid control now displays an icon indicating when a location name has been
    witheld for privacy reasons. See BiologicalRecordsCentre/iRecord#1714.
  • Some restructuring of code, with a new PSR4 style class autoloader. As a result, any custom
    prebuilt forms should implement the IForm\prebuilt_forms\PrebuiltFormInterface interface and the
    getPageType() method in order to define whether a data entry, reporting or utility page.
  • Conversion functions such as helper_base::ago and verification status mapping functions having
    been moved to the IForm\IndiciaConversions class.
  • Some groundwork for removing the dependency on jQuery UI tabs.
  • The sitename special Elasticsearch output field is now fully supported in dataGrids, not just
    for download.
  • Bug fix so that downloads of Elasticsearch aggregated datasets now correctly show progress.
  • Elasticsearch aggregate dataset downloads can now specify a sort order for the downloaded data.
  • Fixes a bug that could result in the warning about verifying multiple records not appearing.
  • Elasticsearch verification has option to link to the original data entry form for records input
    on the same website, rather than always reverting to a generic form. Set the option
    @useLocalFormPaths=true on the [verificationButtons] control.
  • Update to use the latest BRC Charts code version.
  • Typo corrected for the licences selector on the report filter builder - CCO corrected to CC0.
    See BiologicalRecordsCentre/iRecord#1728.

v9.2.0

17 Jun 13:35
Compare
Choose a tag to compare
  • Experimental - a new bulk editor tool which can be added to Explore My Records pages. See
    BiologicalRecordsCentre/iRecord#1673 and
    https://indicia-docs.readthedocs.io/en/latest/site-building/iform/helpers/elasticsearch-report-helper.html#elasticsearchreporthelper-bulkeditor.
  • A new prebuilt form, Recording groups > Group discovery page, which provides a list of suggested,
    recent and active groups for a user according to their recording activity. See
    BiologicalRecordsCentre/iRecord#1681.
  • Leaflet/Elasticsearch reporting maps now have a new control for indicating the scale of records
    vs different opacity levels when drawing a grid map. See
    https://indicia-docs.readthedocs.io/en/latest/site-building/iform/helpers/elasticsearch-report-helper.html#elasticsearchreporthelper-gridsquareopacityscale.
  • Improved behaviour when selecting grid squares on a leaflet map to filter the grid to selected
    records.
  • Modifications to the required state of precise grid ref fields in species entry grids. See
    BiologicalRecordsCentre/iRecord#1540.
  • report_helper::freeform_report control now allows population of the report output using
    client-side AJAX rather than server-side PHP.
  • Fix projection used for Irish data from 29901 to 29903 - see
    Indicia-Team/warehouse#510.
  • Species details 2 prebuilt form now includes common names in the page title.
  • When using the Create a Filter tool on an Elasticsearch page, the map used for the Where panel
    now adopts the same viewport as the main reporting map.
  • Also when using the Create a Filter tool on an Elasticsearch page, filter boundaries are now
    shown on the map used for the main report output.
  • The v2 importer now supports custom plugins on the warehouse, so the user interface has been
    modified to allow the output of custom plugins to be shown to the user if there is a failure at
    the preprocessing stage.
  • On the Elasticsearch verification recordDetails control, the comments tab output has been
    improved to clarify which comment relates to the initial entry vs redeterminations.
  • Private/public key files used by the Indicia API for mobile apps and the rest of Indicia are now
    named consistently so 1 key file can serve all purposes.
  • New [misc_extensions.add_resource] extension allows dynamic pages to force the inclusion of one
    of the Indici resources, e.g. 'font_awesome'.

v9.0.0

26 Mar 15:35
Compare
Choose a tag to compare
  • Improvements to opacity of grid squares on Elasticsearch map outputs, so that grid squares should not completely obscure the background.
  • Improved edit behaviour when editing a form with a fixed list of taxa in the species checklist control is impacted by taxonomy changes. If a record was entered which was originally the preferred taxon but is later relegated by a taxonomy change, then when editing the preferred taxon is automatically ticked, but the original ID is preserved and the user notified with an explanation label.
  • The report filter builder [standard params] control now the following new options:
    • @layout=vertical displays the filter panes in a vertical layout.
    • @initialState=open displays the filter panel in it's open state (no need to click the Create a Filter button).
  • Fix to the Source filters on the report filter builder which didn't work for websites that are not able to view records from other websites.
  • Fix to Quality filters on the report filter builder, when displaying samples.
  • Option to set the label used for a group on the Group Edit prebuilt form, allowing the label for a group to be set to Project, Activity, or any other appropriate moniker.
  • On the Sectioned Transects Edit Transect prebuilt form, renaming a parent section now automatically updates the name of any child sections so that they stay in sync.
  • Fix the Timed Count recording form so that it matches the one used on UKBMS.
  • Fix a bug where linked list controls were broken by applying a query extra param option to the parent select.
  • Minor bugfixes.

v8.24.0

11 Jan 13:29
Compare
Choose a tag to compare
  • Standard parameters quality filters updated to support requirements for issue
    BiologicalRecordsCentre/iRecord#1493.
    • autocheck_rule and autochecks filter parameters merged. New code should use autochecks as a
      filter parameter name in preference to autocheck_rule.
    • addition of a certainty filter parameter.
    • addition of a licences filter paremeter.
    • addition of a coordinate_precision filter parameter.
    • switch from using match to term query where appropriate for slightly better performance.
  • Standard parameters who filters updated - see
    BiologicalRecordsCentre/iRecord#1492.
  • Fix to confidential=all filter parameters for Elasticsearch queries.
  • Add Licence (licence code) to the list of columns available for an Elasticsearch dataGrid.
  • New ElasticsearchReportHelper::mediaFilter control outputs a standalone control for filtering
    based on the presence of photos and other media, similar to on the Create a filter tool.
  • Enhancements to v2 importer - see BiologicalRecordsCentre/iRecord#1477.
    • Separates available fields for mapping into a standard set and an advanced set, making the
      tool easier to use for most scenarios.
    • Improves auto-matching of supplied column titles to database fields.
  • New [rss] control in the species_details_2 prebuilt form for displaying a list of associated
    recording schemes and societies.
  • Resources for visualisation with D3 added to the helper_base class.
  • Resources BRC's Atlas quality mapping added to the helper_base class.
  • IForm User UI Options module now puts its control at the bottom of the user form.
  • Updates required for PHP 8.2.
  • Bug fixes.

v8.23.0

20 Sep 11:34
Compare
Choose a tag to compare
  • Add multiselect functionality to the cardGallery control for photo-based verification.
    See BiologicalRecordsCentre/iRecord#1483.
  • cardGallery controls now expand to full width if they contain 3 or more images.
    See BiologicalRecordsCentre/iRecord#1518.
  • Support for comment templates for verification queries. See
    BiologicalRecordsCentre/iRecord#1460.
  • Fix some sort order issues when searching taxon names containing hyphens.
    See BiologicalRecordsCentre/iRecord#1511.
  • Support images attached to sub-samples in multiple places forms (see
    multiple_places_species_checklist control's samplePhotos option in data_entry_helper.php).
  • Multiple places forms - can now control the fields shown in the label for mapped points and point
    clusters (see multiple_places_species_checklist() in data_entry_helper -
    sampleMapLabelContents and sampleClusterButtonContents options).
  • Fixes issue where redeterminations lookup on the Elasticsearch verification page fails if the
    page has not been refreshed for a long time -
    BiologicalRecordsCentre/iRecord#697
  • Minor improvements to the filter builder's Create a filter section wording.
    See BiologicalRecordsCentre/iRecord#1488.
  • Improvements to the filter builder's When popup functionality -
    see BiologicalRecordsCentre/iRecord#1491.
  • Improvements to the filter builder's Source popup functionality -
    see BiologicalRecordsCentre/iRecord#1494.
  • Fixes upload of 3 separate date component columns on the version 2 imported - see
    BiologicalRecordsCentre/iRecord#1507.
  • Improves the text used on the version 2 importer - see
    BiologicalRecordsCentre/iRecord#1473.
  • Tidy appearance of verification multi-select buttons.
    See BiologicalRecordsCentre/iRecord#1525.
  • Standardisation of the names of Channel Islands grid systems.
    See BiologicalRecordsCentre/iRecord#1467.
  • Improvements to map display so large grid squares are less prone to dominating the map display.
    Also clicking on a map point queries to find all squares under the click point, not just the
    first one found. See BiologicalRecordsCentre/iRecord#990.
  • Ability to upload custom/local verification rules. This feature will be enabled on iRecord when
    documentation is ready,
    See BiologicalRecordsCentre/iRecord#1403.
  • Elasticsearch dataGrid and cardGallery - adds new ES special field for coalescing value from
    several fields (see https://indicia-docs.readthedocs.io/en/latest/site-building/iform/helpers/elasticsearch-report-helper.html#id5).
  • Elasticsearch dataGrid and cardGallery - adds new ES special field for a templated value from
    several fields (see https://indicia-docs.readthedocs.io/en/latest/site-building/iform/helpers/elasticsearch-report-helper.html#id5).
  • When verifying records in parent/child sample structures (e.g. transect walks), displays the
    number of records in the parent sample to be verified.
    See BiologicalRecordsCentre/iRecord#1274.
  • Image uploader now supports a larger maximum image dimension for resizing, so reducing the change
    that a very large image from a modern camera cannot be uploaded.
  • On the Elasticsearch verification record details pane, improves the display of the comments tab
    so that redeterminations and comments are clearly differentiated.
  • Improves the calculation of square size vs viewport size on Elasticsearch leafletMap controls
    with Geohash grid map layers.
  • Notifications Centre pages only show record details links alongside
    notifications if the record details page path option is set.
  • Species checklist control uploaded images now default to 1500px x 1500px max unless overridden.
  • Add support for the iform_custom_forms module, allowing project to keep any project specific
    forms separate to the main iform GitHub code repository.
  • Removes project specific UKBMS forms:
    • EBMS Location editor
    • EBMS Location allocator
    • Splash sample with occurrences form
    • UKBMS Location Assigner
    • UKBMS Section Plot
    • UKBMS Location Editor
    • UKBMS Sectioned Transects Sample Input
    • UKBMS Sectioned Transects Sample Input 2
    • UKBMS Year by Year Index Plot.
  • Fix inconsistency in labelling of media/file/image upload buttons.
  • Other minor bug fixes.

v8.16.0

17 Mar 10:21
Compare
Choose a tag to compare
  • Support for custom verification rules, allowing a verifier to define their own local rules and
    apply them to records they are verifying. For example, they can define phenology rules for when
    a species is likely to be found locally, or geography limits for where the species is likely or
    unlikely to be found. Sets of rules can be created by importing from spreadsheets and applied
    to the current set of verification records. To support this, the following new features are
    available:
    • A new [runCustomVerificationRulesets] control is available on pages of type "Elasticsearch
      outputs (customisable)". This adds a button allowing a user to access their rulesets, run
      them, or clear existing rule flags.
    • On verification pages supporting custom verification rules, set the following option on the
      [standardParams] control in order to enable filtering by presence or absence of custom
      rule check flags.
      @customRuleCheckFilters=true
      
      This adds extra options to the Quality filter pane.
    • A new Indicia page type "Custom verification ruleset edit form" under the "General Purpose
      Data Entry Forms" section. Allows a form to be created for editing or adding the metadata
      required for a set of custom verification rules.
    • A new Indicia page type "Custom verification rules upload tool" under the "Utilities" section
      which provides a tool for uploading rule definitions from spreadsheets.
  • Support for maintaining a website containing records that are private or for verification only
    and not shared with public reporting pages. Tools are available allowing the user who uploaded
    records into this website to publish them by repatriating them into the website containing public
    data. In order for this to work, survey datasets must be created on both websites with identical
    structures. To support this, the following new features are available:
    • A new [recordsMover] control is available on pages of type "Elasticsearch outputs
      (customisable)". This adds a button with a popup that facilitates moving the current filtered
      set of records, or a selection taken from this set, from the private website dataset to the
      public website dataset.
      See BiologicalRecordsCentre/iRecord#1396 for more info.
  • Support for verification of multiple records of the same species in a parent sample in one step.
    For example, a timed count or transect protocal may cause a number of records of the same taxon
    to be recorded so a verifier may wish to verify them all together. See
    BiologicalRecordsCentre/iRecord#1274 for more info.
  • Required dynamic attributes in a data_entry_helper::species_checklist control's columns will
    now have a "- please select -" option if they are select controls.
  • Support for filtering on import_guids, allowing a report to create a link which shows all the
    records for an import.
  • Support for adding an "Import Guid" column to the columns configuration for an Elasticsearch
    [dataGrid] control.
  • Data imports for occurrences now allow sample attributes linked to the selected sample type to be
    selected for import. Previously this only worked for imports of samples without attached
    occurrences.
  • Edit form for recording groups/activities now has the option to delete the group, rather than
    just set its expiry date.
  • Tidying of the handling of notification categories, with queries and redets now having their own
    categories. See BiologicalRecordsCentre/iRecord#1362.
  • Tidying of code in the Notifications Centre around the acknowledgement of notifications. Now
    affects the exact list of currently visible notifications. See
    BiologicalRecordsCentre/iRecord#1372 for more info.

v8.14.0

20 Jan 11:42
Compare
Choose a tag to compare
  • Elasticsearch verification buttons control now allows redetermination of records in bulk.
    See BiologicalRecordsCentre/iRecord#674.
  • Importer v2 has a new option to specify the default value for controls on the Import Settings
    page (e.g. a default survey or spatial reference system).
  • Importer v2 now allows a list of options on the Import Settings tab to be limited to a subset,
    for example a list of all surveys could be limited to a subset that are suitable for importing.
    Specifying a * option provides a button which the user can use to override the limited list and
    choose from the full list.
  • Improvements to the auto-matching of column names to database fields in Importer v2. Also some
    other minor improvements in Importer V2, e.g. wording. See
    BiologicalRecordsCentre/iRecord#1405

v8.10.0

19 Oct 12:58
Compare
Choose a tag to compare
  • New ElasticsearchReportHelper::locationSelect control for filtering against unindexed location
    boundaries. See
    https://indicia-docs.readthedocs.io/en/latest/site-building/iform/helpers/elasticsearch-report-helper.html#elasticsearchreporthelper-locationSelect
  • Fixes a bug when editing dynamic stage or other attributes in species_checklist controls.
  • Success messages shown after a save operation now indicate if updated or deleted.
  • Some changes for PHP 8.1 compatibility.
  • Elasticsearch now supports standard smp_id filter parameter.
  • Tidying shared code in the location, occurrence, sample or species details pages.
  • Details pages now have a [single attribute] control for individual attribute values in a block.
  • New extension controls [voting_comments.form], [voting_comments.summary] and
    [voting_comments.votes_list] allow voting/star ratings for the quality of a site, on the location
    details page.

v8.4.0

10 Aug 13:53
Compare
Choose a tag to compare
  • Importer version 2 code enhanced to allow saving and loading of import configuration templates.
  • New iform_dynamic_generic_edit form for editing the details of any warehouse entity that is set
    up for editing via data services.
  • group_locations form's locations list can now be filtered by location type.
  • Escaping fix on text input existing values.
  • Fixes a bug when a single client site uses multiple warehouses that caused an infinite loop.
  • helper_base::expireCacheEntry() method added, to allow cache to be cleared after saving
    something that affects a cached response.
  • Deletion of a site in My Sites has a confirmation popup.
  • Minor HTML change in HTML used for map's gridRefInFooter option.
  • Removes the project specific iform_dynamic_location_splash_squares and
    iform_plant_portal_user_data_importer forms.
  • Removes the project specific original_splash_extensions extension.
  • Improvements to sectioned_transects_edit_transect form for linking to a recording
    group/activity's sites list, plus bug-fixes.
  • Link controls in the misc_extensions.php file improved, with support for Drupal 9 and ability
    to get parameters from the URL.
  • Bug fix so the training flag is set correctly when recording associated occurrences via the
    extra_data_entry_controls.associated_occurrence control.
  • Small tidy of button layout on popup dialogs that use $.fancyDialog

v8.1.0

17 May 13:01
Compare
Choose a tag to compare
  • Fix grid reference hints on maps on multiple places recording forms.
  • Bug fixes to linked select controls: child controls respect parent custom filters and better
    error handling.
  • V1 importer now enables support for Excel file imports.
  • v2 Importer now supports fixed values that apply to every row in the import. Note this is still
    experimental work in progress.
  • Improved help text on v2 importer.
  • Bug fixes relating to displaying and zooming to a feature when a map initially loads if a Google
    layer is used by default.
  • Removes some project specific NPMS code.
  • Fixes Google map layer tilting behaviour.
  • Fixed column picker and filter popups for report grids to work correctly with new Fancybox
    version.