Workflow / Editor board / Add search configuration to display draft, approved record or both (geonetwork#7477)

* Workflow / Editor board / Display draft instead of approved records.

When using the workflow, if a published and approved record is edited, a
working copy is created. Users have difficulties to find the
corresponding working copies because the searches show the approved
records with a link to the copies but does not search directly for
working copies.

This change propose to have:
* the search app to search for records without draft and approved records
* the editor board app to search for records without draft and drafts.

In the editor board, sorting by last updates will properly list last
updated draft records and will facilitate editing works. The draft will
provide a link to the corresponding approved records (instead of
approved record linking to the working copy). It also makes more sense
to list draft here as user clicking edit button will edit the draft
record.

* Update web-ui/src/main/resources/catalog/components/search/resultsview/partials/viewtemplates/editor.html

Co-authored-by: joachimnielandt <[email protected]>

* Update web-ui/src/main/resources/catalog/components/search/resultsview/partials/viewtemplates/editor.html

Co-authored-by: joachimnielandt <[email protected]>

* Update web-ui/src/main/resources/catalog/components/utility/partials/draftvalidationwidget.html

Co-authored-by: joachimnielandt <[email protected]>

* Workflow / Editor board / Configure which type of record to promote in search - draft, approved or both.

* Workflow / Editor board / Configure which type of record to promote in search / Admin config.

* Workflow / Editor board / Prettier.

* Workflow / Editor board / Display approved status in badge.

* Workflow / Editor board / Configuration / Improve description.

---------

Co-authored-by: joachimnielandt <[email protected]>

Author: fxprunayre

services/src/main/java/org/fao/geonet/api/es/EsHTTPProxy.java

@@ -463,7 +463,9 @@ private void addFilterToQuery(ServiceContext context,
         // Build filter node
         String esFilter = buildQueryFilter(context,
             "",
-            esQuery.toString().contains("\"draft\":"));
+            esQuery.toString().contains("\"draft\":")
+                || esQuery.toString().contains("+draft:")
+                || esQuery.toString().contains("-draft:"));
         JsonNode nodeFilter = objectMapper.readTree(esFilter);
 
         JsonNode queryNode = esQuery.get("query");

web-ui/src/main/resources/catalog/components/admin/uiconfig/partials/uiconfig.html

@@ -202,7 +202,7 @@ <h2>{{('ui-mod-' + m) | translate}}</h2>
 
                 <div
                   class="row"
-                  data-ng-switch-when="autocompleteConfig|moreLikeThisConfig|facetConfig|relatedFacetConfig|filters|scoreConfig|queryBaseOptions|collectionTableConfig|distributionConfig|topCustomMenu|wpsSource"
+                  data-ng-switch-when="autocompleteConfig|moreLikeThisConfig|facetConfig|relatedFacetConfig|filters|scoreConfig|queryBaseOptions|collectionTableConfig|distributionConfig|topCustomMenu|wpsSource|workflowSearchRecordTypes"
                   data-ng-switch-when-separator="|"
                 >
                   <div class="col-lg-5 gn-nopadding-left">

web-ui/src/main/resources/catalog/components/search/resultsview/partials/viewtemplates/editor.html

@@ -25,7 +25,7 @@
               <a
                 href=""
                 data-ng-show="md.isTemplate != 's'"
-                data-ng-href="catalog.search#/{{(md.draft == 'y')?'metadraf':'metadata'}}/{{md.uuid}}"
+                data-ng-href="catalog.search#/{{(md.draft == 'y') ? 'metadraf' : 'metadata'}}/{{md.uuid}}"
                 title="{{md.resourceAbstract}}"
                 class="gn-break"
               >
@@ -53,8 +53,14 @@
                     class="text-muted gn-status"
                     data-ng-class="{'text-success': md.mdStatus == 2, 'text-warning': md.mdStatus == 4}"
                     data-ng-if="md.mdStatus < 50 && isMdWorkflowEnable"
-                    >{{::md.statusWorkflow | getStatusLabel}}</small
                   >
+                    <span data-ng-if="md.draft === 'e' || md.draft === 'n'"
+                      >{{::md.statusWorkflow | getStatusLabel}}</span
+                    >
+                    <span data-ng-if="md.draft === 'y'"
+                      >{{::'status-' + md.mdStatus | translate}}</span
+                    >
+                  </small>
 
                   <small
                     class="text-muted gn-status"
@@ -68,8 +74,8 @@
             </div>
           </div>
           <gn-draft-validation-widget
-            data-ng-if="md.draft == 'e'"
-            metadata="md"
+            data-ng-if="md.draft == 'e' || md.draft == 'y'"
+            data-metadata="md"
           ></gn-draft-validation-widget>
         </div>
         <div class="col-lg-4 col-md-4 gn-nopadding-right">

web-ui/src/main/resources/catalog/components/utility/DraftValidationWidget.js

@@ -37,30 +37,37 @@
           metadata: "="
         },
         link: function (scope) {
+          if (!scope.metadata) {
+            return;
+          }
+          scope.type = scope.metadata.draft === "e" ? "y" : "e";
           var query = {
             _source: {
               includes: ["id", "uuid", "draft", "isTemplate", "valid"]
             },
-            size: 10,
+            size: 1,
             query: {
               bool: {
                 must: [
                   { terms: { uuid: [scope.metadata.uuid] } },
                   { terms: { isTemplate: ["y", "n"] } },
-                  { terms: { draft: ["y"] } }
+                  { terms: { draft: [scope.type] } }
                 ]
               }
             }
           };
 
           $http.post("../api/search/records/_search", query).then(function (r) {
             r.data.hits.hits.forEach(function (r) {
-              scope.draft = new Metadata(r);
+              scope.record = new Metadata(r);
+              scope.recordIsDraft = scope.record.draft === "y";
+              scope.label = scope.recordIsDraft ? "seeDraft" : "seeNoDraft";
+              scope.title = scope.recordIsDraft ? "draft" : "approvedRecord";
             });
           });
         },
         templateUrl:
-          "../../catalog/components/utility/" + "partials/draftvalidationwidget.html"
+          "../../catalog/components/utility/partials/draftvalidationwidget.html"
       };
     }
   ]);

web-ui/src/main/resources/catalog/components/utility/UtilityDirective.js

@@ -2245,6 +2245,9 @@
     "$translate",
     function ($translate) {
       return function (workflowStatus) {
+        if (!workflowStatus) {
+          return;
+        }
         var split = workflowStatus.split("-");
         // the status of the record
         var metadataStatus = $translate.instant("status-" + split[0]);

web-ui/src/main/resources/catalog/components/utility/partials/draftvalidationwidget.html

@@ -1,20 +1,25 @@
 <a
+  data-ng-show="record"
   href=""
-  data-ng-href="catalog.search#/{{(draft.draft == 'y')?'metadraf':'metadata'}}/{{metadata.uuid}}"
+  data-ng-href="catalog.search#/{{recordIsDraft ? 'metadraf' : 'metadata'}}/{{record.uuid}}"
   class="see-draft-pill"
 >
   <small>
     <small
-      class="valid-status{{draft.valid}} md-type-{{draft.isTemplate}}"
-      title="{{(('draft') | translate)}}: {{(('validStatus-' + draft.valid) | translate)}}"
-      ng-switch="draft.isTemplate"
+      class="valid-status{{record.valid}} md-type-{{record.isTemplate}}"
+      title="{{(title | translate)}}: {{(('validStatus-' + record.valid) | translate)}}"
+      ng-switch="record.isTemplate"
     >
       <i class="fa fa-fw fa-file" ng-switch-when="y" />
-      <i class="fa fa-fw fa-pencil" ng-switch-when="n" />
+      <i
+        class="fa fa-fw"
+        data-ng-class="{'fa-pencil':recordIsDraft, 'fa-file-text-o':!recordIsDraft}"
+        ng-switch-when="n"
+      />
       <i class="fa fa-fw fa-bookmark" ng-switch-when="s" />
       <i class="fa fa-fw fa-bookmark-o" ng-switch-when="t" />
       <i class="fa fa-fw fa-question" ng-switch-default />
     </small>
-    <label title="{{'seeDraft' | translate}}">{{(('draft') | translate)}}</label>
+    <label title="{{label | translate}}">{{title | translate}}</label>
   </small>
 </a>

web-ui/src/main/resources/catalog/js/CatController.js

@@ -948,6 +948,7 @@
             createPageTpl: "../../catalog/templates/editor/new-metadata-horizontal.html",
             editorIndentType: "",
             allowRemoteRecordLink: true,
+            workflowSearchRecordTypes: ["n", "e"],
             facetConfig: {
               resourceType: {
                 terms: {
@@ -1287,6 +1288,7 @@
           "distributionConfig",
           "collectionTableConfig",
           "queryBaseOptions",
+          "workflowSearchRecordTypes",
           "workflowAssistApps"
         ],
         current: null,

web-ui/src/main/resources/catalog/js/edit/EditorBoardController.js

@@ -71,6 +71,7 @@
       $scope.isFilterTagsDisplayed =
         gnGlobalSettings.gnCfg.mods.editor.isFilterTagsDisplayed;
       $scope.modelOptions = angular.copy(gnGlobalSettings.modelOptions);
+
       $scope.defaultSearchObj = {
         permalink: true,
         sortbyValues: gnSearchSettings.sortbyValues,
@@ -82,6 +83,10 @@
           sortBy: "dateStamp",
           sortOrder: "desc",
           isTemplate: ["y", "n"],
+          draft: gnGlobalSettings.gnCfg.mods.editor.workflowSearchRecordTypes || [
+            "n",
+            "e"
+          ],
           resultType: $scope.facetsSummaryType,
           from: 1,
           to: 20
@@ -90,6 +95,10 @@
           sortBy: "dateStamp",
           sortOrder: "desc",
           isTemplate: ["y", "n"],
+          draft: gnGlobalSettings.gnCfg.mods.editor.workflowSearchRecordTypes || [
+            "n",
+            "e"
+          ],
           resultType: $scope.facetsSummaryType,
           from: 1,
           to: 20

web-ui/src/main/resources/catalog/locales/en-admin.json

@@ -1078,6 +1078,8 @@
     "git.build.time": "Timestamp of the build",
     "testClientConfig": "Test client configuration",
     "resetDefaultConfig": "Reset configuration",
+    "ui-workflowSearchRecordTypes": "Workflow / Search / Display draft, approved or both",
+    "ui-workflowSearchRecordTypes-help": "Define what to display in <strong>editor board search panel</strong>:<ul><li>[\"n\", \"e\"] display approved version (default)</li><li>[\"n\", \"y\"] will show draft</li><li>[\"n\", \"e\", \"y\"] will show both draft and approved</li></ul>. \"n\" is for record without draft, \"e\" for approved record and \"y\" for draft record.",
     "ui-mod-header": "Top toolbar",
     "ui-mod-footer": "Footer",
     "ui-mod-cookieWarning": "Cookie warning",

web-ui/src/main/resources/catalog/locales/en-core.json

@@ -551,6 +551,7 @@
     "cancelWorkingCopy": "Cancel working copy",
     "deleteWorkingCopyRecordConfirm": "Do you really want to remove the working copy '{{resourceTitle}}'?",
     "workingCopy": "Working copy",
+    "approvedRecord": "Approved record",
     "onTheWeb": "More online information",
     "pdfReportTocTitle": "Contents",
     "metadataValidated": "Metadata validated.",