From d74649d498fd83f1651a1b39f474d530e822eba3 Mon Sep 17 00:00:00 2001 From: Bill Erickson Date: Fri, 25 Aug 2017 12:58:00 -0400 Subject: [PATCH] LP#1251394 Display fields release notes Signed-off-by: Bill Erickson Signed-off-by: Mike Rylander --- .../Administration/display-fields.adoc | 55 ++++++++++++++++++++++ 1 file changed, 55 insertions(+) create mode 100644 docs/RELEASE_NOTES_NEXT/Administration/display-fields.adoc diff --git a/docs/RELEASE_NOTES_NEXT/Administration/display-fields.adoc b/docs/RELEASE_NOTES_NEXT/Administration/display-fields.adoc new file mode 100644 index 0000000000..dbeeb9dab7 --- /dev/null +++ b/docs/RELEASE_NOTES_NEXT/Administration/display-fields.adoc @@ -0,0 +1,55 @@ +Configurable Bib Record Display Fields +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Admin -> Server Admin -> 'MARC Search/Facet Fields' have 2 new configuration +fields: 'Display Field?' and 'Display XPATH'. + +When 'Display Field' is set to true, data from the field will be extracted +from each record and added to a new table of display data for each bib +record. + +If a value is present in the 'Display XPATH' field, this XPATH will be +applied to the extracted data *after* the base XPATH (from the 'XPath' +field) is applied to each field. + +This data acts as a replacement for the various and sundry ways bib record +data is currently extracted, including inline XPATH in the TPAC, reporter +views, real-time 'MVR' compilation from MODS, etc. and will be available +to the user interface, notification templates, etc. for rendering bib +records. + +The browser client gets a new service 'egBibDisplay' which is capable +of translating the display field data from various formats into +data more suitable for JavaScript usage. + +The database gets 3 new VIEWs for representing display data in various +formats: + + * metabib.flat_display_entry + ** List of all display fields linked to their configuration. + * metabib.compressed_display_entry + ** Same as metabib.flat_display_entry except there's one row + per display field type, which 'mulit' rows compressed into + JSON arrays. Non-multi fields are represented as JSON + strings/numbers. + * metabib.wide_display_entry + ** Tabular view of display field data, one column per well-known + field. Values are represented JSON, consistent with + metabib.flat_display_entry. The view DOE NOT CONTAIN locally + configured dispaly fields, as each field must be encoded in + the view and IDL definition. This is essentially a replacement + for reporter.simple_record. + +Reingesting ++++++++++++ + +After making changes to display field configuration, it's possible to +reingest only display field data in the database using the following: + +[source,sql] +--------------------------------------------------------------------- +SELECT metabib.reingest_metabib_field_entries(id, TRUE, FALSE, TRUE, TRUE, + (SELECT ARRAY_AGG(id)::INT[] FROM config.metabib_field WHERE display_field)) + FROM biblio.record_entry WHERE NOT deleted AND id > 0; +--------------------------------------------------------------------- + -- 2.11.0